po plugin: bugfix - only refresh POT/PO for translatable pages
[ikiwiki.git] / IkiWiki / Plugin / po.pm
index d3ccd37e1a407bdd9684044fbf4970ba1b679253..ca26101b7c52c9a1a4d6b7ce38e0100196eccea0 100644 (file)
@@ -9,17 +9,26 @@ use strict;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;
+use File::Basename;
+use File::Copy;
+use File::Spec;
 use File::Temp;
+use Memoize;
+
+my %translations;
+memoize("istranslatable");
+memoize("_istranslation");
 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
        hook(type => "checkconfig", id => "po", call => \&checkconfig);
-       hook(type => "scan", id => "po", call => \&scan);
+       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);
 }
 
 sub getsetup () { #{{{
@@ -40,9 +49,10 @@ sub getsetup () { #{{{
                },
                po_slave_languages => {
                        type => "string",
-                       example => {'fr' => { 'name' => 'Français' },
-                                   'es' => { 'name' => 'Castellano' },
-                                   'de' => { 'name' => 'Deutsch' },
+                       example => {
+                               'fr' => 'Français',
+                               'es' => 'Castellano',
+                               'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",
                        safe => 1,
@@ -85,12 +95,61 @@ sub checkconfig () { #{{{
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
-sub scan (@) { #{{{
-       my %params=@_;
-       my $page=$params{page};
+sub refreshpot ($) { #{{{
+       my $masterfile=shift;
+       (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
+       my $potfile=File::Spec->catfile($dir, $name . ".pot");
+       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->parse;
+       $doc->writepo($potfile);
+} #}}}
+
+sub refreshpofiles ($@) { #{{{
+       my $masterfile=shift;
+       my @pofiles=@_;
+
+       (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
+       my $potfile=File::Spec->catfile($dir, $name . ".pot");
+       error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
-       # FIXME: cache (or memoize) the list of translatable/translation pages,
-       # and/or istranslation/istranslated results
+       foreach my $pofile (@pofiles) {
+               if (-e $pofile) {
+                       my $cmd = "msgmerge -U $pofile $potfile";
+                       system ($cmd) == 0
+                               or error("[po/refreshpofiles:$pofile] failed to update");
+               }
+               else {
+                       File::Copy::syscopy($potfile,$pofile)
+                               or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
+               }
+       }
+} #}}}
+
+sub needsbuild () { #{{{
+       my $needsbuild=shift;
+
+       # build %translations, using istranslation's side-effect
+       foreach my $page (keys %pagesources) {
+               istranslation($page);
+       }
+
+       # refresh POT and PO files as needed
+       foreach my $file (@$needsbuild) {
+               my $page=pagename($file);
+               if (istranslatable($page)) {
+                       refreshpot(srcfile($file));
+                       my @pofiles;
+                       foreach my $lang (keys %{$translations{$page}}) {
+                               push @pofiles, $pagesources{$translations{$page}{$lang}};
+                       }
+                       refreshpofiles(srcfile($file), map { srcfile($_) } @pofiles);
+               }
+       }
 } #}}}
 
 sub targetpage (@) { #{{{
@@ -140,16 +199,18 @@ sub tweakbestlink ($$) { #{{{
        return $link;
 } #}}}
 
+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 (@) { #{{{
        my %params = @_;
        my $page = $params{page};
+       my $destpage = $params{destpage};
        my $content = decode_utf8(encode_utf8($params{content}));
 
        # decide if this is a PO file that should be converted into a translated document,
        # and perform various sanity checks
-       if (! istranslation($page)) {
+       if (! istranslation($page) || $filtered{$page}{$destpage}) {
                return $content;
        }
 
@@ -174,6 +235,7 @@ sub filter (@) { #{{{
        my $tmpout = $tmpfh->filename;
        $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
        $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
+       $filtered{$page}{$destpage}=1;
        return $content;
 } #}}}
 
@@ -188,6 +250,49 @@ sub htmlize (@) { #{{{
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 
+sub otherlanguages ($) { #{{{
+       my $page=shift;
+       my @ret;
+       if (istranslatable($page)) {
+               foreach my $lang (sort keys %{$translations{$page}}) {
+                       push @ret, {
+                               url => urlto($translations{$page}{$lang}, $page),
+                               code => $lang,
+                               language => $config{po_slave_languages}{$lang},
+                               master => 0,
+                       };
+               }
+       }
+       elsif (istranslation($page)) {
+               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               push @ret, {
+                       url => urlto($masterpage, $page),
+                       code => $config{po_master_language}{code},
+                       language => $config{po_master_language}{name},
+                       master => 1,
+               };
+               foreach my $lang (sort keys %{$translations{$masterpage}}) {
+                       push @ret, {
+                               url => urlto($translations{$masterpage}{$lang}, $page),
+                               code => $lang,
+                               language => $config{po_slave_languages}{$lang},
+                               master => 0,
+                       } unless ($lang eq $curlang);
+               }
+       }
+       return @ret;
+} #}}}
+
+sub pagetemplate (@) { #{{{
+       my %params=@_;
+        my $page=$params{page};
+        my $template=$params{template};
+
+       if ($template->query(name => "otherlanguages")) {
+               $template->param(otherlanguages => [otherlanguages($page)]);
+       }
+} # }}}
+
 sub istranslatable ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};
@@ -200,7 +305,7 @@ sub istranslatable ($) { #{{{
        return pagespec_match($page, $config{po_translatable_pages});
 } #}}}
 
-sub istranslation ($) { #{{{
+sub _istranslation ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};
        if (! defined $file) {
@@ -225,6 +330,15 @@ sub istranslation ($) { #{{{
        return istranslatable($masterpage);
 } #}}}
 
+sub istranslation ($) { #{{{
+       my $page=shift;
+       if (_istranslation($page)) {
+               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
+               return 1;
+       }
+       return 0;
+} #}}}
 
 package IkiWiki::PageSpec;
 use warnings;