Merge commit 'upstream/master' into pub/master

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 98c070481978a560d328ecc107dac4396d3a341e..9dda8c0db29d8116acb7e4417276865bbe462897 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -9,6 +9,7 @@ use strict;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;

+use Locale::Po4a::Po;

 use File::Basename;
 use File::Copy;
 use File::Spec;
 use File::Basename;
 use File::Copy;
 use File::Spec;


@@ -16,20 +17,30 @@ use File::Temp;
 use Memoize;
 
 my %translations;
 use Memoize;
 
 my %translations;

-memoize("istranslatable");
+our %filtered;
+
+## FIXME: makes some test cases cry once every two tries; this may be
+## related to the artificial way the testsuite is run, or not.
+# memoize("istranslatable");

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

+# backup references to subs that will be overriden
+my %origsubs;
+$origsubs{'bestlink'}=\&IkiWiki::bestlink;
+$origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
+$origsubs{'targetpage'}=\&IkiWiki::targetpage;
+

 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
        hook(type => "checkconfig", id => "po", call => \&checkconfig);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
        hook(type => "checkconfig", id => "po", call => \&checkconfig);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);

-       hook(type => "targetpage", id => "po", call => \&targetpage);
-       hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
-       hook(type => "tweakbestlink", id => "po", call => \&tweakbestlink);

        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate);

+       inject(name => "IkiWiki::bestlink", call => \&mybestlink);
+       inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+       inject(name => "IkiWiki::targetpage", call => \&mytargetpage);

 }
 
 sub getsetup () { #{{{
 }
 
 sub getsetup () { #{{{


@@ -45,7 +56,7 @@ sub getsetup () { #{{{
                                'name' => 'English'
                        },
                        description => "master language (non-PO files)",
                                'name' => 'English'
                        },
                        description => "master language (non-PO files)",

-                       safe => 1,
+                       safe => 0,

                        rebuild => 1,
                },
                po_slave_languages => {
                        rebuild => 1,
                },
                po_slave_languages => {


@@ -56,7 +67,7 @@ sub getsetup () { #{{{
                                'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",
                                'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",

-                       safe => 1,
+                       safe => 0,

                        rebuild => 1,
                },
                po_translatable_pages => {
                        rebuild => 1,
                },
                po_translatable_pages => {


@@ -64,14 +75,14 @@ sub getsetup () { #{{{
                        example => "!*/Discussion",
                        description => "PageSpec controlling which pages are translatable",
                        link => "ikiwiki/PageSpec",
                        example => "!*/Discussion",
                        description => "PageSpec controlling which pages are translatable",
                        link => "ikiwiki/PageSpec",

-                       safe => 1,
+                       safe => 0,

                        rebuild => 1,
                },
                po_link_to => {
                        type => "string",
                        example => "current",
                        description => "internal linking behavior (default/current/negotiated)",
                        rebuild => 1,
                },
                po_link_to => {
                        type => "string",
                        example => "current",
                        description => "internal linking behavior (default/current/negotiated)",

-                       safe => 1,
+                       safe => 0,

                        rebuild => 1,
                },
 } #}}}
                        rebuild => 1,
                },
 } #}}}


@@ -96,16 +107,35 @@ sub checkconfig () { #{{{
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 

-sub refreshpot ($) { #{{{
+sub potfile ($) { #{{{
+       my $masterfile=shift;
+       (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
+       return File::Spec->catfile($dir, $name . ".pot");
+} #}}}
+
+sub pofile ($$) { #{{{

        my $masterfile=shift;
        my $masterfile=shift;

+       my $lang=shift;

        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);

-       my $potfile=File::Spec->catfile($dir, $name . ".pot");
+       return File::Spec->catfile($dir, $name . "." . $lang . ".po");
+} #}}}
+
+sub refreshpot ($) { #{{{
+       my $masterfile=shift;
+       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';
        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';

+       # 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.
+       my %po_options = ('porefs' => 'none');
+       $doc->{TT}{po_out}=Locale::Po4a::Po->new(\%po_options);
+       $doc->{TT}{po_out}->set_charset('utf-8');
+       # do the actual work

        $doc->parse;
        $doc->writepo($potfile);
 } #}}}
        $doc->parse;
        $doc->writepo($potfile);
 } #}}}


@@ -114,13 +144,12 @@ sub refreshpofiles ($@) { #{{{
        my $masterfile=shift;
        my @pofiles=@_;
 
        my $masterfile=shift;
        my @pofiles=@_;
 

-       (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
-       my $potfile=File::Spec->catfile($dir, $name . ".pot");
+       my $potfile=potfile($masterfile);

        error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
        foreach my $pofile (@pofiles) {
                if (-e $pofile) {
        error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
        foreach my $pofile (@pofiles) {
                if (-e $pofile) {

-                       my $cmd = "msgmerge -U $pofile $potfile";
+                       my $cmd = "msgmerge -U --backup=none $pofile $potfile";

                        system ($cmd) == 0
                                or error("[po/refreshpofiles:$pofile] failed to update");
                }
                        system ($cmd) == 0
                                or error("[po/refreshpofiles:$pofile] failed to update");
                }


@@ -139,19 +168,50 @@ sub needsbuild () { #{{{
                istranslation($page);
        }
 
                istranslation($page);
        }
 

-       # refresh POT and PO files as needed
-       foreach my $file (@$needsbuild) {
-               my $page=pagename($file);
+       # refresh/create POT and PO files as needed
+       my $updated_po_files=0;
+       foreach my $page (keys %pagesources) {
+               my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;

                if (istranslatable($page)) {
                if (istranslatable($page)) {

-                       refreshpot(srcfile($file));
+                       my $file=srcfile($pagesources{$page});
+                       if ($pageneedsbuild || ! -e potfile($file)) {
+                               refreshpot($file);
+                       }

                        my @pofiles;
                        my @pofiles;

-                       foreach my $lang (keys %{$translations{$page}}) {
-                               push @pofiles, $pagesources{$translations{$page}{$lang}};
+                       foreach my $lang (keys %{$config{po_slave_languages}}) {
+                               my $pofile=pofile($file, $lang);
+                               if ($pageneedsbuild || ! -e $pofile) {
+                                       push @pofiles, $pofile;
+                               }

                        }
                        }

-                       refreshpofiles(srcfile($file), map { srcfile($_) } @pofiles);
+                       if (@pofiles) {
+                               refreshpofiles($file, @pofiles) ;
+                               map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+                               $updated_po_files = 1;
+                       }
+               }
+       }
+
+       # check staged changes in and trigger a wiki refresh.
+       if ($updated_po_files) {
+               if ($config{rcs}) {
+                       IkiWiki::disable_commit_hook();
+                       IkiWiki::rcs_commit_staged(gettext("updated PO files"),
+                               "refreshpofiles", "127.0.0.1");
+                       IkiWiki::enable_commit_hook();
+                       IkiWiki::rcs_update();
+               }
+               IkiWiki::refresh();
+               IkiWiki::saveindex();
+               # refresh module's private variables
+               undef %filtered;
+               undef %translations;
+               foreach my $page (keys %pagesources) {
+                       istranslation($page);

                }
        }
 
                }
        }
 

+

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


@@ -160,14 +220,13 @@ sub needsbuild () { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

-sub targetpage (@) { #{{{
-       my %params = @_;
-        my $page=$params{page};
-        my $ext=$params{ext};
+sub mytargetpage ($$) { #{{{
+       my $page=shift;
+       my $ext=shift;

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

-               if (! $config{usedirs} || $page eq 'index') {
+               if (! $config{usedirs} || $masterpage eq 'index') {

                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {
                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {


@@ -182,32 +241,47 @@ sub targetpage (@) { #{{{
                        return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
                }
        }
                        return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
                }
        }

-       return;
+       return $origsubs{'targetpage'}->($page, $ext);

 } #}}}
 
 } #}}}
 

-sub tweakurlpath ($) { #{{{
-       my %params = @_;
-       my $url=$params{url};
+sub mybeautify_urlpath ($) { #{{{
+       my $url=shift;
+       my $res=$origsubs{'beautify_urlpath'}->($url);

        if ($config{po_link_to} eq "negotiated") {
        if ($config{po_link_to} eq "negotiated") {

-               $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
+               $res =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;

        }
        }

-       return $url;
+       return $res;

 } #}}}
 
 } #}}}
 

-sub tweakbestlink ($$) { #{{{
-       my %params = @_;
-       my $page=$params{page};
-       my $link=$params{link};
-       if ($config{po_link_to} eq "current"
-           && istranslatable($link)
-           && istranslation($page)) {
-               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-               return $link . "." . $curlang;
+sub urlto_with_orig_beautiful_urlpath($$) { #{{{
+       my $to=shift;
+       my $from=shift;
+
+       inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
+       my $res=urlto($to, $from);
+       inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+
+       return $res;
+} #}}}
+
+sub mybestlink ($$) { #{{{
+       my $page=shift;
+       my $link=shift;
+       my $res=$origsubs{'bestlink'}->($page, $link);
+       if (length $res) {
+               if ($config{po_link_to} eq "current"
+                   && istranslatable($res)
+                   && istranslation($page)) {
+                       my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+                       return $res . "." . $curlang;
+               }
+               else {
+                       return $res;
+               }

        }
        }

-       return $link;
+       return "";

 } #}}}
 
 } #}}}
 

-our %filtered;

 # We use filter to convert PO to the master page's type,
 # since other plugins should not work on PO files
 sub filter (@) { #{{{
 # We use filter to convert PO to the master page's type,
 # since other plugins should not work on PO files
 sub filter (@) { #{{{


@@ -297,7 +371,7 @@ sub otherlanguages ($) { #{{{
        elsif (istranslation($page)) {
                my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                push @ret, {
        elsif (istranslation($page)) {
                my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                push @ret, {

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

                        code => $config{po_master_language}{code},
                        language => $config{po_master_language}{name},
                        master => 1,
                        code => $config{po_master_language}{code},
                        language => $config{po_master_language}{name},
                        master => 1,


@@ -307,7 +381,7 @@ sub otherlanguages ($) { #{{{
                                url => urlto($translations{$masterpage}{$lang}, $page),
                                code => $lang,
                                language => $config{po_slave_languages}{$lang},
                                url => urlto($translations{$masterpage}{$lang}, $page),
                                code => $lang,
                                language => $config{po_slave_languages}{$lang},

-                               percent => percenttranslated($page),
+                               percent => percenttranslated($translations{$masterpage}{$lang}),

                        } unless ($lang eq $curlang);
                }
        }
                        } unless ($lang eq $curlang);
                }
        }


@@ -317,13 +391,50 @@ sub otherlanguages ($) { #{{{
 sub pagetemplate (@) { #{{{
        my %params=@_;
         my $page=$params{page};
 sub pagetemplate (@) { #{{{
        my %params=@_;
         my $page=$params{page};

+        my $destpage=$params{destpage};

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

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

        if ($template->query(name => "otherlanguages")) {
                $template->param(otherlanguages => [otherlanguages($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)) {
+                       my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+                       add_depends($page, $masterpage);
+                       foreach my $translation (values %{$translations{$masterpage}}) {
+                               add_depends($page, $translation);
+                       }
+               }
+       }
+       # Rely on IkiWiki::Render's genpage() to decide wether
+       # a discussion link should appear on $page; this is not
+       # totally accurate, though: some broken links may be generated
+       # when cgiurl is disabled.
+       # This compromise avoids some code duplication, and will probably
+       # prevent future breakage when ikiwiki internals change.
+       # Known limitations are preferred to future random bugs.
+       if ($template->param('discussionlink') && istranslation($page)) {
+               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               $template->param('discussionlink' => htmllink(
+                                                       $page,
+                                                       $destpage,
+                                                       $masterpage . '/' . gettext("Discussion"),
+                                                       noimageinline => 1,
+                                                       forcesubpage => 0,
+                                                       linktext => gettext("Discussion"),
+                                                       ));

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