po: rewrote otherlanguagesloop()

[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 89bd9947028fb759ca7ee5d62b267bffa8d3c06d..1754260ed8867b8e5ab32bfc9fbac15333f72f94 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -21,7 +21,6 @@ use UNIVERSAL;
 
 my %translations;
 my @origneedsbuild;
 
 my %translations;
 my @origneedsbuild;

-our %filtered;

 
 memoize("_istranslation");
 memoize("percenttranslated");
 
 memoize("_istranslation");
 memoize("percenttranslated");


@@ -99,8 +98,8 @@ sub getsetup () { #{{{
 } #}}}
 
 sub islanguagecode ($) { #{{{
 } #}}}
 
 sub islanguagecode ($) { #{{{

-    my $code=shift;
-    return ($code =~ /^[a-z]{2}$/);
+       my $code=shift;
+       return ($code =~ /^[a-z]{2}$/);

 } #}}}
 
 sub checkconfig () { #{{{
 } #}}}
 
 sub checkconfig () { #{{{


@@ -138,6 +137,24 @@ sub checkconfig () { #{{{
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 

+sub otherlanguages($) { #{{{
+       my $page=shift;
+
+       my %ret;
+       if (istranslatable($page)) {
+               %ret = %{$translations{$page}};
+       }
+       elsif (istranslation($page)) {
+               my $masterpage = masterpage($page);
+               $ret{$config{po_master_language}{code}} = $masterpage;
+               foreach my $lang (sort keys %{$translations{$masterpage}}) {
+                       next if $lang eq lang($page);
+                       $ret{$lang} = $translations{$masterpage}{$lang};
+               }
+       }
+       return \%ret;
+} #}}}
+

 sub potfile ($) { #{{{
        my $masterfile=shift;
 
 sub potfile ($) { #{{{
        my $masterfile=shift;
 


@@ -166,10 +183,10 @@ sub refreshpot ($) { #{{{
        my $potfile=potfile($masterfile);
        my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
        my $doc=Locale::Po4a::Chooser::new('text',%options);
        my $potfile=potfile($masterfile);
        my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
        my $doc=Locale::Po4a::Chooser::new('text',%options);

-       $doc->read($masterfile);

        $doc->{TT}{utf_mode} = 1;
        $doc->{TT}{file_in_charset} = 'utf-8';
        $doc->{TT}{file_out_charset} = 'utf-8';
        $doc->{TT}{utf_mode} = 1;
        $doc->{TT}{file_in_charset} = 'utf-8';
        $doc->{TT}{file_out_charset} = 'utf-8';

+       $doc->read($masterfile);

        # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
        # this is undocument use of internal Locale::Po4a::TransTractor's data,
        # compulsory since this module prevents us from using the porefs option.
        # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
        # this is undocument use of internal Locale::Po4a::TransTractor's data,
        # compulsory since this module prevents us from using the porefs option.


@@ -202,6 +219,15 @@ sub refreshpofiles ($@) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub buildtranslationscache() { #{{{
+       # use istranslation's side-effect
+       map istranslation($_), (keys %pagesources);
+} #}}}
+
+sub resettranslationscache() { #{{{
+       undef %translations;
+} #}}}
+

 sub needsbuild () { #{{{
        my $needsbuild=shift;
 
 sub needsbuild () { #{{{
        my $needsbuild=shift;
 


@@ -209,14 +235,11 @@ sub needsbuild () { #{{{
        # a given master page was rendered because its source file was changed
        @origneedsbuild=(@$needsbuild);
 
        # a given master page was rendered because its source file was changed
        @origneedsbuild=(@$needsbuild);
 

-       # build %translations, using istranslation's side-effect
-       map istranslation($_), (keys %pagesources);
+       buildtranslationscache();

 
        # make existing translations depend on the corresponding master page
        foreach my $master (keys %translations) {
 
        # make existing translations depend on the corresponding master page
        foreach my $master (keys %translations) {

-               foreach my $slave (values %{$translations{$master}}) {
-                       add_depends($slave, $master);
-               }
+               map add_depends($_, $master), values %{otherlanguages($master)};

        }
 } #}}}
 
        }
 } #}}}
 


@@ -228,7 +251,6 @@ sub scan (@) { #{{{
        return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
 
        if (istranslation($page)) {
        return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
 
        if (istranslation($page)) {

-               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);

                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
                                # replace one occurence of $destpage in $links{$page}
                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
                                # replace one occurence of $destpage in $links{$page}


@@ -237,7 +259,7 @@ sub scan (@) { #{{{
                                # there for other reasons)
                                for (my $i=0; $i<@{$links{$page}}; $i++) {
                                        if (@{$links{$page}}[$i] eq $destpage) {
                                # there for other reasons)
                                for (my $i=0; $i<@{$links{$page}}; $i++) {
                                        if (@{$links{$page}}[$i] eq $destpage) {

-                                               @{$links{$page}}[$i] = $destpage . '.' . $curlang;
+                                               @{$links{$page}}[$i] = $destpage . '.' . lang($page);

                                                last;
                                        }
                                }
                                                last;
                                        }
                                }


@@ -260,7 +282,7 @@ sub mytargetpage ($$) { #{{{
        my $ext=shift;
 
        if (istranslation($page)) {
        my $ext=shift;
 
        if (istranslation($page)) {

-               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               my ($masterpage, $lang) = (masterpage($page), lang($page));

                if (! $config{usedirs} || $masterpage eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;
                }
                if (! $config{usedirs} || $masterpage eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;
                }


@@ -310,8 +332,7 @@ sub myurlto ($$;$) { #{{{
            && $config{po_link_to} eq "current"
            && istranslation($from)
            && istranslatable('index')) {
            && $config{po_link_to} eq "current"
            && istranslation($from)
            && istranslatable('index')) {

-               my ($masterpage, $curlang) = ($from =~ /(.*)[.]([a-z]{2})$/);
-               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . $curlang . ".$config{htmlext}");
+               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");

        }
        return $origsubs{'urlto'}->($to,$from,$absolute);
 } #}}}
        }
        return $origsubs{'urlto'}->($to,$from,$absolute);
 } #}}}


@@ -325,8 +346,7 @@ sub mybestlink ($$) { #{{{
                if ($config{po_link_to} eq "current"
                    && istranslatable($res)
                    && istranslation($page)) {
                if ($config{po_link_to} eq "current"
                    && istranslatable($res)
                    && istranslation($page)) {

-                       my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-                       return $res . "." . $curlang;
+                       return $res . "." . lang($page);

                }
                else {
                        return $res;
                }
                else {
                        return $res;


@@ -335,6 +355,39 @@ sub mybestlink ($$) { #{{{
        return "";
 } #}}}
 
        return "";
 } #}}}
 

+# blackbox for %filtered
+{
+       my %filtered;
+
+       sub alreadyfiltered($$) { #{{{
+               my $page=shift;
+               my $destpage=shift;
+
+               return ( exists $filtered{$page}{$destpage}
+                        && $filtered{$page}{$destpage} eq 1 );
+       } #}}}
+
+       sub setalreadyfiltered($$) { #{{{
+               my $page=shift;
+               my $destpage=shift;
+
+               $filtered{$page}{$destpage}=1;
+       } #}}}
+
+       sub unsetalreadyfiltered($$) { #{{{
+               my $page=shift;
+               my $destpage=shift;
+
+               if (exists $filtered{$page}{$destpage}) {
+                       delete $filtered{$page}{$destpage};
+               }
+       } #}}}
+
+       sub resetalreadyfiltered() { #{{{
+               undef %filtered;
+       } #}}}
+}
+

 # We use filter to convert PO to the master page's format,
 # since the rest of ikiwiki should not work on PO files.
 sub filter (@) { #{{{
 # We use filter to convert PO to the master page's format,
 # since the rest of ikiwiki should not work on PO files.
 sub filter (@) { #{{{


@@ -345,8 +398,7 @@ sub filter (@) { #{{{
        my $content = decode_utf8(encode_utf8($params{content}));
 
        return $content if ( ! istranslation($page)
        my $content = decode_utf8(encode_utf8($params{content}));
 
        return $content if ( ! istranslation($page)

-                            || ( exists $filtered{$page}{$destpage}
-                                 && $filtered{$page}{$destpage} eq 1 ));
+                            || alreadyfiltered($page, $destpage) );

 
        # CRLF line terminators make poor Locale::Po4a feel bad
        $content=~s/\r\n/\n/g;
 
        # CRLF line terminators make poor Locale::Po4a feel bad
        $content=~s/\r\n/\n/g;


@@ -371,8 +423,7 @@ sub filter (@) { #{{{
 
        writefile(basename($infile), File::Spec->tmpdir, $content);
 
 
        writefile(basename($infile), File::Spec->tmpdir, $content);
 

-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-       my $masterfile = srcfile($pagesources{$masterpage});
+       my $masterfile = srcfile($pagesources{masterpage($page)});

        my (@pos,@masters);
        push @pos,$infile;
        push @masters,$masterfile;
        my (@pos,@masters);
        push @pos,$infile;
        push @masters,$masterfile;


@@ -385,16 +436,16 @@ sub filter (@) { #{{{
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',

-       ) or error("[po/filter:$infile]: failed to translate");
-       $doc->write($outfile) or error("[po/filter:$infile] could not write $outfile");
-       $content = readfile($outfile) or error("[po/filter:$infile] could not read $outfile");
+       ) or error("[po/filter:$page]: failed to translate");
+       $doc->write($outfile) or error("[po/filter:$page] could not write $outfile");
+       $content = readfile($outfile) or error("[po/filter:$page] could not read $outfile");

 
        # Unlinking should happen automatically, thanks to File::Temp,
        # but it does not work here, probably because of the way writefile()
        # and Locale::Po4a::write() work.
        unlink $infile, $outfile;
 
 
        # Unlinking should happen automatically, thanks to File::Temp,
        # but it does not work here, probably because of the way writefile()
        # and Locale::Po4a::write() work.
        unlink $infile, $outfile;
 

-       $filtered{$page}{$destpage}=1;
+       setalreadyfiltered($page, $destpage);

        return $content;
 } #}}}
 
        return $content;
 } #}}}
 


@@ -403,8 +454,7 @@ sub htmlize (@) { #{{{
 
        my $page = $params{page};
        my $content = $params{content};
 
        my $page = $params{page};
        my $content = $params{content};

-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-       my $masterfile = srcfile($pagesources{$masterpage});
+       my $masterfile = srcfile($pagesources{masterpage($page)});

 
        # force content to be htmlize'd as if it was the same type as the master page
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 
        # force content to be htmlize'd as if it was the same type as the master page
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);


@@ -413,10 +463,9 @@ sub htmlize (@) { #{{{
 sub percenttranslated ($) { #{{{
        my $page=shift;
 
 sub percenttranslated ($) { #{{{
        my $page=shift;
 

-       return gettext("N/A") unless (istranslation($page));
-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       return gettext("N/A") unless istranslation($page);

        my $file=srcfile($pagesources{$page});
        my $file=srcfile($pagesources{$page});

-       my $masterfile = srcfile($pagesources{$masterpage});
+       my $masterfile = srcfile($pagesources{masterpage($page)});

        my (@pos,@masters);
        push @pos,$file;
        push @masters,$masterfile;
        my (@pos,@masters);
        push @pos,$file;
        push @masters,$masterfile;


@@ -429,44 +478,49 @@ sub percenttranslated ($) { #{{{
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',

-       ) or error("[po/percenttranslated:$file]: failed to translate");
+       ) or error("[po/percenttranslated:$page]: failed to translate");

        my ($percent,$hit,$queries) = $doc->stats();
        return $percent;
 } #}}}
 
        my ($percent,$hit,$queries) = $doc->stats();
        return $percent;
 } #}}}
 

-sub otherlanguages ($) { #{{{
+sub languagename ($) { #{{{
+       my $code=shift;
+
+       return $config{po_master_language}{name}
+               if $code eq $config{po_master_language}{code};
+       return $config{po_slave_languages}{$code}
+               if defined $config{po_slave_languages}{$code};
+       return;
+} #}}}
+
+sub otherlanguagesloop ($) { #{{{

        my $page=shift;
 
        my @ret;
        my $page=shift;
 
        my @ret;

-       if (istranslatable($page)) {
-               foreach my $lang (sort keys %{$translations{$page}}) {
-                       my $translation = $translations{$page}{$lang};
+       my %otherpages=%{otherlanguages($page)};
+       while (my ($lang, $otherpage) = each %otherpages) {
+               if (istranslation($page) && masterpage($page) eq $otherpage) {

                        push @ret, {
                        push @ret, {

-                               url => urlto($translation, $page),
+                               url => urlto_with_orig_beautiful_urlpath($otherpage, $page),

                                code => $lang,
                                code => $lang,

-                               language => $config{po_slave_languages}{$lang},
-                               percent => percenttranslated($translation),
+                               language => languagename($lang),
+                               master => 1,

                        };
                }
                        };
                }

-       }
-       elsif (istranslation($page)) {
-               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-               push @ret, {
-                       url => urlto_with_orig_beautiful_urlpath($masterpage, $page),
-                       code => $config{po_master_language}{code},
-                       language => $config{po_master_language}{name},
-                       master => 1,
-               };
-               foreach my $lang (sort keys %{$translations{$masterpage}}) {
+               else {

                        push @ret, {
                        push @ret, {

-                               url => urlto($translations{$masterpage}{$lang}, $page),
+                               url => urlto($otherpage, $page),

                                code => $lang,
                                code => $lang,

-                               language => $config{po_slave_languages}{$lang},
-                               percent => percenttranslated($translations{$masterpage}{$lang}),
-                       } unless ($lang eq $curlang);
+                               language => languagename($lang),
+                               percent => percenttranslated($otherpage),
+                       }

                }
        }
                }
        }

-       return @ret;
+       return sort {
+                       return -1 if $a->{code} eq $config{po_master_language}{code};
+                       return 1 if $b->{code} eq $config{po_master_language}{code};
+                       return $a->{language} cmp $b->{language};
+               } @ret;

 } #}}}
 
 sub pagetemplate (@) { #{{{
 } #}}}
 
 sub pagetemplate (@) { #{{{


@@ -475,30 +529,20 @@ sub pagetemplate (@) { #{{{
        my $destpage=$params{destpage};
        my $template=$params{template};
 
        my $destpage=$params{destpage};
        my $template=$params{template};
 

-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/) if istranslation($page);
+       my ($masterpage, $lang) = istranslation($page);

 
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {
 
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {

-               $template->param(istranslation => istranslation($page));
+               $template->param(istranslation => scalar istranslation($page));

        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
        }
        if ($template->query(name => "otherlanguages")) {
        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
        }
        if ($template->query(name => "otherlanguages")) {

-               $template->param(otherlanguages => [otherlanguages($page)]);
-               if (istranslatable($page)) {
-                       foreach my $translation (values %{$translations{$page}}) {
-                               add_depends($page, $translation);
-                       }
-               }
-               elsif (istranslation($page)) {
-                       add_depends($page, $masterpage);
-                       foreach my $translation (values %{$translations{$masterpage}}) {
-                               add_depends($page, $translation);
-                       }
-               }
+               $template->param(otherlanguages => [otherlanguagesloop($page)]);
+               map add_depends($page, $_), (values %{otherlanguages($page)});

        }
        # Rely on IkiWiki::Render's genpage() to decide wether
        # a discussion link should appear on $page; this is not
        }
        # Rely on IkiWiki::Render's genpage() to decide wether
        # a discussion link should appear on $page; this is not


@@ -517,7 +561,9 @@ sub pagetemplate (@) { #{{{
                                                        linktext => gettext("Discussion"),
                                                        ));
        }
                                                        linktext => gettext("Discussion"),
                                                        ));
        }

-       # remove broken parentlink to ./index.html on home page's translations
+       # Remove broken parentlink to ./index.html on home page's translations.
+       # It works because this hook has the "last" parameter set, to ensure it
+       # runs after parentlinks' own pagetemplate hook.

        if ($template->param('parentlinks')
            && istranslation($page)
            && $masterpage eq "index") {
        if ($template->param('parentlinks')
            && istranslation($page)
            && $masterpage eq "index") {


@@ -535,18 +581,18 @@ sub change(@) { #{{{
                next unless istranslatable($page);
                my $file=srcfile($pagesources{$page});
                my $updated_pot_file=0;
                next unless istranslatable($page);
                my $file=srcfile($pagesources{$page});
                my $updated_pot_file=0;

+               # Only refresh Pot file if it does not exist, or if
+               # $pagesources{$page} was changed: don't if only the HTML was
+               # refreshed, e.g. because of a dependency.

                if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
                    || ! -e potfile($file)) {
                        refreshpot($file);
                        $updated_pot_file=1;
                }
                my @pofiles;
                if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
                    || ! -e potfile($file)) {
                        refreshpot($file);
                        $updated_pot_file=1;
                }
                my @pofiles;

-               foreach my $lang (keys %{$config{po_slave_languages}}) {
-                       my $pofile=pofile($file, $lang);
-                       if ($updated_pot_file || ! -e $pofile) {
-                               push @pofiles, $pofile;
-                       }
-               }
+               map {
+                       push @pofiles, $_ if ($updated_pot_file || ! -e $_);
+               } (pofiles($file));

                if (@pofiles) {
                        refreshpofiles($file, @pofiles);
                        map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
                if (@pofiles) {
                        refreshpofiles($file, @pofiles);
                        map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});


@@ -564,8 +610,8 @@ sub change(@) { #{{{
                        IkiWiki::rcs_update();
                }
                # Reinitialize module's private variables.
                        IkiWiki::rcs_update();
                }
                # Reinitialize module's private variables.

-               undef %filtered;
-               undef %translations;
+               resetalreadyfiltered();
+               resettranslationscache();

                # Trigger a wiki refresh.
                require IkiWiki::Render;
                IkiWiki::refresh();
                # Trigger a wiki refresh.
                require IkiWiki::Render;
                IkiWiki::refresh();


@@ -577,9 +623,7 @@ sub editcontent () { #{{{
        my %params=@_;
        # as we're previewing or saving a page, the content may have
        # changed, so tell the next filter() invocation it must not be lazy
        my %params=@_;
        # as we're previewing or saving a page, the content may have
        # changed, so tell the next filter() invocation it must not be lazy

-       if (exists $filtered{$params{page}}{$params{page}}) {
-               delete $filtered{$params{page}}{$params{page}};
-       }
+       unsetalreadyfiltered($params{page}, $params{page});

        return $params{content};
 } #}}}
 
        return $params{content};
 } #}}}
 


@@ -619,18 +663,35 @@ sub _istranslation ($) { #{{{
                return 0;
        }
 
                return 0;
        }
 

-       return istranslatable($masterpage);
+       return ($masterpage, $lang) if istranslatable($masterpage);

 } #}}}
 
 sub istranslation ($) { #{{{
        my $page=shift;
 
 } #}}}
 
 sub istranslation ($) { #{{{
        my $page=shift;
 

-       if (_istranslation($page)) {
-               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       if (1 < (my ($masterpage, $lang) = _istranslation($page))) {

                $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
                $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};

-               return 1;
+               return ($masterpage, $lang);
+       }
+       return;
+} #}}}
+
+sub masterpage ($) { #{{{
+       my $page=shift;
+
+       if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
+               return $masterpage;
+       }
+       return $page;
+} #}}}
+
+sub lang ($) { #{{{
+       my $page=shift;
+
+       if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
+               return $lang;

        }
        }

-       return 0;
+       return $config{po_master_language}{code};

 } #}}}
 
 package IkiWiki::PageSpec;
 } #}}}
 
 package IkiWiki::PageSpec;