po: clarify code with some comments

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 7861523dad8076122515dd688a3aac307692c288..9967e41586669b2860dfe8fbf2f3a0d88f8b5a9b 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -1,5 +1,7 @@
 #!/usr/bin/perl
 # .po as a wiki page type
 #!/usr/bin/perl
 # .po as a wiki page type

+# Licensed under GPL v2 or greater
+# Copyright (C) 2008 intrigeri <intrigeri@boum.org>

 # inspired by the GPL'd po4a-translate,
 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
 package IkiWiki::Plugin::po;
 # inspired by the GPL'd po4a-translate,
 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
 package IkiWiki::Plugin::po;


@@ -15,8 +17,10 @@ use File::Copy;
 use File::Spec;
 use File::Temp;
 use Memoize;
 use File::Spec;
 use File::Temp;
 use Memoize;

+use UNIVERSAL;

 
 my %translations;
 
 my %translations;

+my @origneedsbuild;

 our %filtered;
 
 memoize("_istranslation");
 our %filtered;
 
 memoize("_istranslation");


@@ -33,9 +37,11 @@ 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 => "getsetup", id => "po", call => \&getsetup);
        hook(type => "checkconfig", id => "po", call => \&checkconfig);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);

+       hook(type => "scan", id => "po", call => \&scan, last =>1);

        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);

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

        hook(type => "editcontent", id => "po", call => \&editcontent);
 
        $origsubs{'bestlink'}=\&IkiWiki::bestlink;
        hook(type => "editcontent", id => "po", call => \&editcontent);
 
        $origsubs{'bestlink'}=\&IkiWiki::bestlink;


@@ -44,6 +50,8 @@ sub import { #{{{
        inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
        $origsubs{'targetpage'}=\&IkiWiki::targetpage;
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
        inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
        $origsubs{'targetpage'}=\&IkiWiki::targetpage;
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);

+       $origsubs{'urlto'}=\&IkiWiki::urlto;
+       inject(name => "IkiWiki::urlto", call => \&myurlto);

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


@@ -59,7 +67,7 @@ sub getsetup () { #{{{
                                'name' => 'English'
                        },
                        description => "master language (non-PO files)",
                                'name' => 'English'
                        },
                        description => "master language (non-PO files)",

-                       safe => 0,
+                       safe => 1,

                        rebuild => 1,
                },
                po_slave_languages => {
                        rebuild => 1,
                },
                po_slave_languages => {


@@ -70,7 +78,7 @@ sub getsetup () { #{{{
                                'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",
                                'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",

-                       safe => 0,
+                       safe => 1,

                        rebuild => 1,
                },
                po_translatable_pages => {
                        rebuild => 1,
                },
                po_translatable_pages => {


@@ -78,34 +86,54 @@ 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 => 0,
+                       safe => 1,

                        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 => 0,
+                       safe => 1,

                        rebuild => 1,
                },
 } #}}}
 
                        rebuild => 1,
                },
 } #}}}
 

+sub islanguagecode ($) { #{{{
+    my $code=shift;
+    return ($code =~ /^[a-z]{2}$/);
+} #}}}
+

 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));
                }
        }
 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 (! (keys %{$config{po_slave_languages}})) {
+               error(gettext("At least one slave language must be defined in po_slave_languages"));

        }
        }

+       map {
+               islanguagecode($_)
+                       or error(sprintf(gettext("%s is not a valid language code"), $_));
+       } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});

        if (! exists $config{po_translatable_pages} ||
            ! defined $config{po_translatable_pages}) {
                $config{po_translatable_pages}="";
        }
        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"));
+       if (! exists $config{po_link_to} ||
+           ! defined $config{po_link_to}) {
+               $config{po_link_to}='default';
+       }
+       elsif (! grep {
+                       $config{po_link_to} eq $_
+               } ('default', 'current', 'negotiated')) {
+               warn(sprintf(gettext('po_link_to=%s is not a valid setting, falling back to po_link_to=default'),
+                               $config{po_link_to}));
+               $config{po_link_to}='default';
+       }
+       elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
+               warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
+               $config{po_link_to}='default';

        }
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
        }
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}


@@ -127,16 +155,21 @@ sub pofile ($$) { #{{{
        return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
 } #}}}
 
        return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
 } #}}}
 

+sub pofiles ($) { #{{{
+       my $masterfile=shift;
+       return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
+} #}}}
+

 sub refreshpot ($) { #{{{
        my $masterfile=shift;
 
        my $potfile=potfile($masterfile);
        my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
        my $doc=Locale::Po4a::Chooser::new('text',%options);
 sub refreshpot ($) { #{{{
        my $masterfile=shift;
 
        my $potfile=potfile($masterfile);
        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->{TT}{utf_mode} = 1;
        $doc->{TT}{file_in_charset} = 'utf-8';
        $doc->{TT}{file_out_charset} = 'utf-8';

+       $doc->read($masterfile);

        # 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.
        # 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.


@@ -145,6 +178,7 @@ sub refreshpot ($) { #{{{
        $doc->{TT}{po_out}->set_charset('utf-8');
        # do the actual work
        $doc->parse;
        $doc->{TT}{po_out}->set_charset('utf-8');
        # do the actual work
        $doc->parse;

+       IkiWiki::prep_writefile(basename($potfile),dirname($potfile));

        $doc->writepo($potfile);
 } #}}}
 
        $doc->writepo($potfile);
 } #}}}
 


@@ -156,6 +190,7 @@ sub refreshpofiles ($@) { #{{{
        error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
        foreach my $pofile (@pofiles) {
        error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
        foreach my $pofile (@pofiles) {

+               IkiWiki::prep_writefile(basename($pofile),dirname($pofile));

                if (-e $pofile) {
                        system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
                                or error("[po/refreshpofiles:$pofile] failed to update");
                if (-e $pofile) {
                        system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
                                or error("[po/refreshpofiles:$pofile] failed to update");


@@ -170,61 +205,52 @@ sub refreshpofiles ($@) { #{{{
 sub needsbuild () { #{{{
        my $needsbuild=shift;
 
 sub needsbuild () { #{{{
        my $needsbuild=shift;
 

+       # backup @needsbuild content so that change() can know whether
+       # a given master page was rendered because its source file was changed
+       @origneedsbuild=(@$needsbuild);
+

        # build %translations, using istranslation's side-effect
        # build %translations, using istranslation's side-effect

-       foreach my $page (keys %pagesources) {
-               istranslation($page);
-       }
+       map istranslation($_), (keys %pagesources);

 
 

-       # refresh/create POT and PO files as needed
-       my $updated_po_files=0;
-       foreach my $page (keys %pagesources) {
-               if (istranslatable($page)) {
-                       my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;
-                       my $updated_pot_file=0;
-                       my $file=srcfile($pagesources{$page});
-                       if ($pageneedsbuild || ! -e potfile($file)) {
-                               refreshpot($file);
-                               $updated_pot_file=1;
-                       }
-                       my @pofiles;
-                       foreach my $lang (keys %{$config{po_slave_languages}}) {
-                               my $pofile=pofile($file, $lang);
-                               my $pofile_rel=pofile($pagesources{$page}, $lang);
-                               if ($pageneedsbuild || $updated_pot_file || ! -e $pofile) {
-                                       push @pofiles, $pofile;
-                                       push @$needsbuild, $pofile_rel
-                                         unless grep { $_ eq $pofile_rel } @$needsbuild;
-                               }
-                       }
-                       if (@pofiles) {
-                               refreshpofiles($file, @pofiles) ;
-                               map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
-                               $updated_po_files = 1;
-                       }
+       # make existing translations depend on the corresponding master page
+       foreach my $master (keys %translations) {
+               foreach my $slave (values %{$translations{$master}}) {
+                       add_depends($slave, $master);

                }
        }
                }
        }

+} #}}}

 
 

-       # check staged changes in
-       if ($updated_po_files) {
-               if ($config{rcs}) {
-                       IkiWiki::disable_commit_hook();
-                       IkiWiki::rcs_commit_staged(gettext("updated PO files"),
-                               "refreshpofiles", "127.0.0.1");
-                       IkiWiki::enable_commit_hook();
-                       IkiWiki::rcs_update();
-               }
-               # refresh module's private variables
-               undef %filtered;
-               undef %translations;
-               foreach my $page (keys %pagesources) {
-                       istranslation($page);
+sub scan (@) { #{{{
+       my %params=@_;
+       my $page=$params{page};
+       my $content=$params{content};
+
+       return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
+
+       if (istranslation($page)) {
+               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               foreach my $destpage (@{$links{$page}}) {
+                       if (istranslatable($destpage)) {
+                               # replace one occurence of $destpage in $links{$page}
+                               # (we only want to replace the one that was added by
+                               # IkiWiki::Plugin::link::scan, other occurences may be
+                               # there for other reasons)
+                               for (my $i=0; $i<@{$links{$page}}; $i++) {
+                                       if (@{$links{$page}}[$i] eq $destpage) {
+                                               @{$links{$page}}[$i] = $destpage . '.' . $curlang;
+                                               last;
+                                       }
+                               }
+                       }

                }
        }
                }
        }

-
-       # make existing translations depend on the corresponding master page
-       foreach my $master (keys %translations) {
-               foreach my $slave (values %{$translations{$master}}) {
-                       add_depends($slave, $master);
+       elsif (! istranslatable($page) && ! istranslation($page)) {
+               foreach my $destpage (@{$links{$page}}) {
+                       if (istranslatable($destpage)) {
+                               map {
+                                       push @{$links{$page}}, $destpage . '.' . $_;
+                               } (keys %{$config{po_slave_languages}});
+                       }

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


@@ -274,6 +300,22 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
        return $res;
 } #}}}
 
        return $res;
 } #}}}
 

+sub myurlto ($$;$) { #{{{
+       my $to=shift;
+       my $from=shift;
+       my $absolute=shift;
+
+       # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
+       if (! length $to
+           && $config{po_link_to} eq "current"
+           && istranslation($from)
+           && istranslatable('index')) {
+               my ($masterpage, $curlang) = ($from =~ /(.*)[.]([a-z]{2})$/);
+               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . $curlang . ".$config{htmlext}");
+       }
+       return $origsubs{'urlto'}->($to,$from,$absolute);
+} #}}}
+

 sub mybestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;
 sub mybestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;


@@ -454,7 +496,7 @@ sub pagetemplate (@) { #{{{
                elsif (istranslation($page)) {
                        add_depends($page, $masterpage);
                        foreach my $translation (values %{$translations{$masterpage}}) {
                elsif (istranslation($page)) {
                        add_depends($page, $masterpage);
                        foreach my $translation (values %{$translations{$masterpage}}) {

-                               add_depends($page, $translation);
+                               add_depends($page, $translation) unless $page eq $translation;

                        }
                }
        }
                        }
                }
        }


@@ -475,7 +517,9 @@ sub pagetemplate (@) { #{{{
                                                        linktext => gettext("Discussion"),
                                                        ));
        }
                                                        linktext => gettext("Discussion"),
                                                        ));
        }

-       # remove broken parentlink to ./index.html on home page's translations
+       # Remove broken parentlink to ./index.html on home page's translations.
+       # It works because this hook has the "last" parameter set, to ensure it
+       # runs after parentlinks' own pagetemplate hook.

        if ($template->param('parentlinks')
            && istranslation($page)
            && $masterpage eq "index") {
        if ($template->param('parentlinks')
            && istranslation($page)
            && $masterpage eq "index") {


@@ -483,6 +527,57 @@ sub pagetemplate (@) { #{{{
        }
 } # }}}
 
        }
 } # }}}
 

+sub change(@) { #{{{
+       my @rendered=@_;
+
+       my $updated_po_files=0;
+
+       # Refresh/create POT and PO files as needed.
+       foreach my $page (map pagename($_), @rendered) {
+               next unless istranslatable($page);
+               my $file=srcfile($pagesources{$page});
+               my $updated_pot_file=0;
+               # Only refresh Pot file if it does not exist, or if
+               # $pagesources{$page} was changed: don't if only the HTML was
+               # refreshed, e.g. because of a dependency.
+               if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
+                   || ! -e potfile($file)) {
+                       refreshpot($file);
+                       $updated_pot_file=1;
+               }
+               my @pofiles;
+               foreach my $lang (keys %{$config{po_slave_languages}}) {
+                       my $pofile=pofile($file, $lang);
+                       if ($updated_pot_file || ! -e $pofile) {
+                               push @pofiles, $pofile;
+                       }
+               }
+               if (@pofiles) {
+                       refreshpofiles($file, @pofiles);
+                       map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+                       $updated_po_files=1;
+               }
+       }
+
+       if ($updated_po_files) {
+               # Check staged changes in.
+               if ($config{rcs}) {
+                       IkiWiki::disable_commit_hook();
+                       IkiWiki::rcs_commit_staged(gettext("updated PO files"),
+                               "IkiWiki::Plugin::po::change", "127.0.0.1");
+                       IkiWiki::enable_commit_hook();
+                       IkiWiki::rcs_update();
+               }
+               # Reinitialize module's private variables.
+               undef %filtered;
+               undef %translations;
+               # Trigger a wiki refresh.
+               require IkiWiki::Render;
+               IkiWiki::refresh();
+               IkiWiki::saveindex();
+       }
+} #}}}
+

 sub editcontent () { #{{{
        my %params=@_;
        # as we're previewing or saving a page, the content may have
 sub editcontent () { #{{{
        my %params=@_;
        # as we're previewing or saving a page, the content may have