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 ca26101b7c52c9a1a4d6b7ce38e0100196eccea0..98c070481978a560d328ecc107dac4396d3a341e 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -18,6 +18,7 @@ use Memoize;
 my %translations;
 memoize("istranslatable");
 memoize("_istranslation");
 my %translations;
 memoize("istranslatable");
 memoize("_istranslation");

+memoize("percenttranslated");

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


@@ -150,6 +151,13 @@ sub needsbuild () { #{{{
                        refreshpofiles(srcfile($file), map { srcfile($_) } @pofiles);
                }
        }
                        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 (@) { #{{{
 } #}}}
 
 sub targetpage (@) { #{{{


@@ -230,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");


@@ -250,16 +257,40 @@ 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}}) {
 sub otherlanguages ($) { #{{{
        my $page=shift;
        my @ret;
        if (istranslatable($page)) {
                foreach my $lang (sort keys %{$translations{$page}}) {

+                       my $translation = $translations{$page}{$lang};

                        push @ret, {
                        push @ret, {

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

                                code => $lang,
                                language => $config{po_slave_languages}{$lang},
                                code => $lang,
                                language => $config{po_slave_languages}{$lang},

-                               master => 0,
+                               percent => percenttranslated($translation),

                        };
                }
        }
                        };
                }
        }


@@ -276,7 +307,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},

-                               master => 0,
+                               percent => percenttranslated($page),

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


@@ -288,6 +319,9 @@ sub pagetemplate (@) { #{{{
         my $page=$params{page};
         my $template=$params{template};
 
         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)]);
        }
        if ($template->query(name => "otherlanguages")) {
                $template->param(otherlanguages => [otherlanguages($page)]);
        }


@@ -365,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