po plugin: refresh PO files when a master page is updated

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 3546bef88a066bb747a3ea175e25a80718db515d..900ca90e4ba6c22b66d1b10a99538f6747a93766 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -9,14 +9,26 @@ use strict;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;

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

 use File::Temp;
 use File::Temp;

+use Memoize;
+
+my %translations;
+memoize("istranslatable");
+memoize("_istranslation");

 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
 
 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 => "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 => "filter", id => "po", call => \&filter);

-       hook(type => "preprocess", id => "translatable", call => \&preprocess_translatable);

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

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

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


@@ -37,14 +49,104 @@ sub getsetup () { #{{{
                },
                po_slave_languages => {
                        type => "string",
                },
                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,
                        rebuild => 1,
                },
                        },
                        description => "slave languages (PO files)",
                        safe => 1,
                        rebuild => 1,
                },

+               po_translatable_pages => {
+                       type => "pagespec",
+                       example => "!*/Discussion",
+                       description => "PageSpec controlling which pages are translatable",
+                       link => "ikiwiki/PageSpec",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               po_link_to => {
+                       type => "string",
+                       example => "current",
+                       description => "internal linking behavior (default/current/negotiated)",
+                       safe => 1,
+                       rebuild => 1,
+               },
+} #}}}
+
+sub checkconfig () { #{{{
+       foreach my $field (qw{po_master_language po_slave_languages}) {
+               if (! exists $config{$field} || ! defined $config{$field}) {
+                       error(sprintf(gettext("Must specify %s"), $field));
+               }
+       }
+       if (! exists $config{po_link_to} ||
+           ! defined $config{po_link_to}) {
+           $config{po_link_to}="default";
+       }
+       if (! exists $config{po_translatable_pages} ||
+           ! defined $config{po_translatable_pages}) {
+           $config{po_translatable_pages}="";
+       }
+       if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
+               error(gettext("po_link_to=negotiated requires usedirs to be set"));
+       }
+       push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
+} #}}}
+
+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 or error("[po/refreshpot:$masterfile]: failed to 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);
+
+       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);
+       }
+
+       foreach my $file (@$needsbuild) {
+               my $page=pagename($file);
+               refreshpot(srcfile($file)) if (istranslatable($page));
+               my @pofiles;
+               foreach my $lang (keys %{$translations{$page}}) {
+                       push @pofiles, $pagesources{$translations{$page}{$lang}};
+               }
+               refreshpofiles(srcfile($file), map { srcfile($_) } @pofiles);
+       }

 } #}}}
 
 sub targetpage (@) { #{{{
 } #}}}
 
 sub targetpage (@) { #{{{


@@ -52,7 +154,7 @@ sub targetpage (@) { #{{{
         my $page=$params{page};
         my $ext=$params{ext};
 
         my $page=$params{page};
         my $ext=$params{ext};
 

-       if (IkiWiki::PageSpec::match_istranslation($page, $page)) {
+       if (istranslation($page)) {

                my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                if (! $config{usedirs} || $page eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;
                my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                if (! $config{usedirs} || $page eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;


@@ -61,7 +163,7 @@ sub targetpage (@) { #{{{
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }

-       else {
+       elsif (istranslatable($page)) {

                if (! $config{usedirs} || $page eq 'index') {
                        return $page . "." . $config{po_master_language}{code} . "." . $ext;
                }
                if (! $config{usedirs} || $page eq 'index') {
                        return $page . "." . $config{po_master_language}{code} . "." . $ext;
                }


@@ -69,18 +171,43 @@ sub targetpage (@) { #{{{
                        return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
                }
        }
                        return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
                }
        }

+       return;
+} #}}}
+
+sub tweakurlpath ($) { #{{{
+       my %params = @_;
+       my $url=$params{url};
+       if ($config{po_link_to} eq "negotiated") {
+               $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
+       }
+       return $url;

 } #}}}
 
 } #}}}
 

+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;
+       }
+       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};
 # 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
        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 (! IkiWiki::PageSpec::match_istranslation($page, $page)) {
+       if (! istranslation($page) || $filtered{$page}{$destpage}) {

                return $content;
        }
 
                return $content;
        }
 


@@ -105,20 +232,10 @@ 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");
        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;
 } #}}}
 
        return $content;
 } #}}}
 

-sub preprocess_translatable (@) { #{{{
-       my %params = @_;
-       my $match = exists $params{match} ? $params{match} : $params{page};
-
-       $pagestate{$params{page}}{po_translatable}{$match}=1;
-
-       return "" if ($params{silent} && IkiWiki::yesno($params{silent}));
-       return sprintf(gettext("pages %s set as translatable"), $params{match});
-
-} #}}}
-

 sub htmlize (@) { #{{{
        my %params=@_;
        my $page = $params{page};
 sub htmlize (@) { #{{{
        my %params=@_;
        my $page = $params{page};


@@ -130,38 +247,119 @@ sub htmlize (@) { #{{{
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 

-package IkiWiki::PageSpec;
-
-sub match_istranslation ($;@) { #{{{
+sub otherlanguages ($) { #{{{

        my $page=shift;
        my $page=shift;

-       my $wanted=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 %params=@_;

-       my $file=exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page};
+        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};
+
+       if (! defined $file
+           || (defined pagetype($file) && pagetype($file) eq 'po')
+           || $file =~ /\.pot$/) {
+               return 0;
+       }
+       return pagespec_match($page, $config{po_translatable_pages});
+} #}}}
+
+sub _istranslation ($) { #{{{
+       my $page=shift;
+       my $file=$pagesources{$page};

        if (! defined $file) {
                return IkiWiki::FailReason->new("no file specified");
        }
 
        if (! defined $file) {
                return IkiWiki::FailReason->new("no file specified");
        }
 

-       if (! IkiWiki::pagetype($page) eq 'po') {
-               return IkiWiki::FailReason->new("is not a PO file");
+       if (! defined $file
+           || ! defined pagetype($file)
+           || ! pagetype($file) eq 'po'
+           || $file =~ /\.pot$/) {
+               return 0;

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

-           || ! (length($masterpage) > 0) || ! (length($lang) > 0)) {
-               return IkiWiki::FailReason->new("is not named like a translation file");
+           || ! (length($masterpage) > 0) || ! (length($lang) > 0)
+           || ! defined $pagesources{$masterpage}
+           || ! defined $config{po_slave_languages}{$lang}) {
+               return 0;

        }
 
        }
 

-       if (! defined $IkiWiki::pagesources{$masterpage}) {
-               return IkiWiki::FailReason->new("the master page does not exist");
-       }
+       return istranslatable($masterpage);
+} #}}}

 
 

-       if (! defined $IkiWiki::config{po_slave_languages}{$lang}) {
-               return IkiWiki::FailReason->new("language $lang is not supported");
+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;
+} #}}}

 
 

-       return IkiWiki::SuccessReason->new("page $page is a translation");
+package IkiWiki::PageSpec;
+use warnings;
+use strict;
+use IkiWiki 2.00;

 
 

+sub match_istranslation ($;@) { #{{{
+       my $page=shift;
+       if (IkiWiki::Plugin::po::istranslation($page)) {
+               return IkiWiki::SuccessReason->new("is a translation page");
+       }
+       else {
+               return IkiWiki::FailReason->new("is not a translation page");
+       }
+} #}}}
+
+sub match_istranslatable ($;@) { #{{{
+       my $page=shift;
+       if (IkiWiki::Plugin::po::istranslatable($page)) {
+               return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
+       }
+       else {
+               return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
+       }

 } #}}}
 
 1
 } #}}}
 
 1