po plugin: force utf-8 encoding in POT files

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 716aa9151e873e1e838285c3c8c160e1ef4d74b3..59d938d821151a1f9f0ec3bac27c1a18f8c406ec 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;


@@ -17,20 +18,29 @@ use Memoize;
 
 my %translations;
 our %filtered;
 
 my %translations;
 our %filtered;

-memoize("istranslatable");
+
+## 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 () { #{{{


@@ -46,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 => {


@@ -57,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 => {


@@ -65,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,
                },
 } #}}}


@@ -119,6 +129,13 @@ sub refreshpot ($) { #{{{
        $doc->{TT}{utf_mode} = 1;
        $doc->{TT}{file_in_charset} = 'utf-8';
        $doc->{TT}{file_out_charset} = 'utf-8';
        $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);
 } #}}}


@@ -132,7 +149,7 @@ sub refreshpofiles ($@) { #{{{
 
        foreach my $pofile (@pofiles) {
                if (-e $pofile) {
 
        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");
                }


@@ -186,16 +203,14 @@ sub needsbuild () { #{{{
                }
                IkiWiki::refresh();
                IkiWiki::saveindex();
                }
                IkiWiki::refresh();
                IkiWiki::saveindex();

+               # refresh module's private variables

                %filtered=undef;
                %filtered=undef;

+               %translations=undef;
+               foreach my $page (keys %pagesources) {
+                       istranslation($page);
+               }

        }
 
        }
 

-       # refresh %translations, using istranslation's side-effect
-       # (not needed yet, but when newly created POT/PO files are
-       # added to %pagesources and other data structures, we'll need
-       # this)
-       foreach my $page (keys %pagesources) {
-               istranslation($page);
-       }

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


@@ -205,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 {


@@ -227,29 +241,45 @@ 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 "";

 } #}}}
 
 # We use filter to convert PO to the master page's type,
 } #}}}
 
 # We use filter to convert PO to the master page's type,


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


@@ -366,8 +396,26 @@ sub pagetemplate (@) { #{{{
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        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);
+                       }
+               }

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