po plugin: added and documented PERCENTTRANSLATED template variable

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index f29ad7a7976e69fb85e0348eaffadb6b9b181b81..98c070481978a560d328ecc107dac4396d3a341e 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -9,21 +9,27 @@ 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 Memoize;
 
 my %translations;
 memoize("istranslatable");
 memoize("_istranslation");
 use File::Temp;
 use Memoize;
 
 my %translations;
 memoize("istranslatable");
 memoize("_istranslation");

+memoize("percenttranslated");

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


@@ -44,9 +50,10 @@ 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,
                        },
                        description => "slave languages (PO files)",
                        safe => 1,


@@ -89,6 +96,70 @@ sub checkconfig () { #{{{
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
        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;
+       $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);
+       }
+
+       # 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);
+               }
+       }
+
+       # make existing translations depend on the corresponding master page
+       foreach my $master (keys %translations) {
+               foreach my $slave (values %{$translations{$master}}) {
+                       add_depends($slave, $master);
+               }
+       }
+} #}}}
+

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


@@ -167,7 +238,6 @@ sub filter (@) { #{{{
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
        ) or error("[po/filter:$file]: failed to translate");
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
        ) or error("[po/filter:$file]: failed to translate");

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

        my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
        my $tmpout = $tmpfh->filename;
        $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
        my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
        my $tmpout = $tmpfh->filename;
        $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");


@@ -187,6 +257,76 @@ sub htmlize (@) { #{{{
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 
        return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 

+sub percenttranslated ($) { #{{{
+       my $page=shift;
+       return "N/A" unless (istranslation($page));
+       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       my $file=srcfile($pagesources{$page});
+       my $masterfile = srcfile($pagesources{$masterpage});
+       my (@pos,@masters);
+       push @pos,$file;
+       push @masters,$masterfile;
+       my %options = (
+                       "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
+                       );
+       my $doc=Locale::Po4a::Chooser::new('text',%options);
+       $doc->process(
+               'po_in_name'    => \@pos,
+               'file_in_name'  => \@masters,
+               'file_in_charset'  => 'utf-8',
+               'file_out_charset' => 'utf-8',
+       ) or error("[po/percenttranslated:$file]: failed to translate");
+       my ($percent,$hit,$queries) = $doc->stats();
+       return $percent;
+} #}}}
+
+sub otherlanguages ($) { #{{{
+       my $page=shift;
+       my @ret;
+       if (istranslatable($page)) {
+               foreach my $lang (sort keys %{$translations{$page}}) {
+                       my $translation = $translations{$page}{$lang};
+                       push @ret, {
+                               url => urlto($translation, $page),
+                               code => $lang,
+                               language => $config{po_slave_languages}{$lang},
+                               percent => percenttranslated($translation),
+                       };
+               }
+       }
+       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},
+                               percent => percenttranslated($page),
+                       } unless ($lang eq $curlang);
+               }
+       }
+       return @ret;
+} #}}}
+
+sub pagetemplate (@) { #{{{
+       my %params=@_;
+        my $page=$params{page};
+        my $template=$params{template};
+
+       if (istranslation($page) && $template->query(name => "percenttranslated")) {
+               $template->param(percenttranslated => percenttranslated($page));
+       }
+       if ($template->query(name => "otherlanguages")) {
+               $template->param(otherlanguages => [otherlanguages($page)]);
+       }
+} # }}}
+

 sub istranslatable ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};
 sub istranslatable ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};


@@ -234,7 +374,6 @@ sub istranslation ($) { #{{{
        return 0;
 } #}}}
 
        return 0;
 } #}}}
 

-

 package IkiWiki::PageSpec;
 use warnings;
 use strict;
 package IkiWiki::PageSpec;
 use warnings;
 use strict;


@@ -260,4 +399,56 @@ sub match_istranslatable ($;@) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub match_lang ($$;@) { #{{{
+       my $page=shift;
+       my $wanted=shift;
+       my $regexp=IkiWiki::glob2re($wanted);
+       my $lang;
+       my $masterpage;
+
+       if (IkiWiki::Plugin::po::istranslation($page)) {
+               ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       }
+       else {
+               $lang = $config{po_master_language}{code};
+       }
+
+       if ($lang!~/^$regexp$/i) {
+               return IkiWiki::FailReason->new("file language is $lang, not $wanted");
+       }
+       else {
+               return IkiWiki::SuccessReason->new("file language is $wanted");
+       }
+} #}}}
+
+sub match_currentlang ($$;@) { #{{{
+       my $page=shift;
+       shift;
+       my %params=@_;
+       my ($currentmasterpage, $currentlang, $masterpage, $lang);
+
+       return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
+
+       if (IkiWiki::Plugin::po::istranslation($params{location})) {
+               ($currentmasterpage, $currentlang) = ($params{location} =~ /(.*)[.]([a-z]{2})$/);
+       }
+       else {
+               $currentlang = $config{po_master_language}{code};
+       }
+
+       if (IkiWiki::Plugin::po::istranslation($page)) {
+               ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       }
+       else {
+               $lang = $config{po_master_language}{code};
+       }
+
+       if ($lang eq $currentlang) {
+               return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
+       }
+       else {
+               return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
+       }
+} #}}}
+

 1
 1