]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
Merge commit 'remotes/smcv/ready/remove-pagespec-merge'
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index da5812ebdc9506f1a77a0988438d1d43d99a2936..41490699914ef632647ab593da91a1aa90c648d0 100644 (file)
@@ -10,7 +10,12 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Encode;
-use Locale::Po4a::Common qw(nowrapi18n);
+eval q{use Locale::Po4a::Common qw(nowrapi18n !/.*/)};
+if ($@) {
+       print STDERR gettext("warning: Old po4a detected! Recommend upgrade to 0.35.")."\n";
+       eval q{use Locale::Po4a::Common qw(!/.*/)};
+       die $@ if $@;
+}
 use Locale::Po4a::Chooser;
 use Locale::Po4a::Po;
 use File::Basename;
@@ -32,11 +37,10 @@ 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 => "scan", id => "po", call => \&scan, last =>1);
+       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 => "postscan", id => "po", call => \&postscan);
        hook(type => "rename", id => "po", call => \&renamepages, first => 1);
        hook(type => "delete", id => "po", call => \&mydelete);
        hook(type => "change", id => "po", call => \&change);
@@ -55,8 +59,6 @@ sub import {
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
        $origsubs{'urlto'}=\&IkiWiki::urlto;
        inject(name => "IkiWiki::urlto", call => \&myurlto);
-       $origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
-       inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);
        $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
        inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
 }
@@ -97,7 +99,7 @@ sub getsetup () {
                        type => "string",
                        example => {
                                'fr' => 'Français',
-                               'es' => 'Castellano',
+                               'es' => 'Español',
                                'de' => 'Deutsch'
                        },
                        description => "slave languages (PO files)",
@@ -106,7 +108,7 @@ sub getsetup () {
                },
                po_translatable_pages => {
                        type => "pagespec",
-                       example => "!*/Discussion",
+                       example => "* and !*/Discussion",
                        description => "PageSpec controlling which pages are translatable",
                        link => "ikiwiki/PageSpec",
                        safe => 1,
@@ -119,30 +121,21 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
-               po_translation_status_in_links => {
-                       type => "boolean",
-                       example => 1,
-                       description => "display translation status in links to translations",
-                       safe => 1,
-                       rebuild => 1,
-               },
 }
 
 sub checkconfig () {
-       foreach my $field (qw{po_master_language po_slave_languages}) {
+       foreach my $field (qw{po_master_language}) {
                if (! exists $config{$field} || ! defined $config{$field}) {
                        error(sprintf(gettext("Must specify %s when using the %s plugin"),
                                      $field, 'po'));
                }
        }
-       if (! (keys %{$config{po_slave_languages}})) {
-               error(gettext("At least one slave language must be defined ".
-                             "in po_slave_languages when using the po plugin"));
-       }
+
        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}="";
@@ -151,9 +144,7 @@ sub checkconfig () {
            ! defined $config{po_link_to}) {
                $config{po_link_to}='default';
        }
-       elsif (! grep {
-                       $config{po_link_to} eq $_
-               } ('default', 'current', 'negotiated')) {
+       elsif ($config{po_link_to} !~ /^(default|current|negotiated)$/) {
                warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
                             $config{po_link_to}));
                $config{po_link_to}='default';
@@ -162,11 +153,27 @@ sub checkconfig () {
                warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
                $config{po_link_to}='default';
        }
-       if (! exists $config{po_translation_status_in_links} ||
-           ! defined $config{po_translation_status_in_links}) {
-               $config{po_translation_status_in_links}=1;
-       }
+
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
+
+       # Translated versions of the underlays are added if available.
+       foreach my $underlay ("basewiki",
+                             map { m/^\Q$config{underlaydirbase}\E\/*(.*)/ }
+                                 reverse @{$config{underlaydirs}}) {
+               next if $underlay=~/^locale\//;
+
+               # Underlays containing the po files for slave languages.
+               foreach my $ll (keys %{$config{po_slave_languages}}) {
+                       add_underlay("po/$ll/$underlay")
+                               if -d "$config{underlaydirbase}/po/$ll/$underlay";
+               }
+       
+               if ($config{po_master_language}{code} ne 'en') {
+                       # Add underlay containing translated source files
+                       # for the master language.
+                       add_underlay("locale/$config{po_master_language}{code}/$underlay");
+               }
+       }
 }
 
 sub needsbuild () {
@@ -194,8 +201,6 @@ sub scan (@) {
        my $page=$params{page};
        my $content=$params{content};
 
-       return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
-
        if (istranslation($page)) {
                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
@@ -266,7 +271,7 @@ sub pagetemplate (@) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {
-               $template->param(istranslation => istranslation($page));
+               $template->param(istranslation => scalar istranslation($page));
        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
@@ -278,22 +283,19 @@ sub pagetemplate (@) {
                $template->param(otherlanguages => [otherlanguagesloop($page)]);
                map add_depends($page, $_), (values %{otherlanguages($page)});
        }
-       # Rely on IkiWiki::Render's genpage() to decide wether
-       # a discussion link should appear on $page; this is not
-       # totally accurate, though: some broken links may be generated
-       # when cgiurl is disabled.
-       # This compromise avoids some code duplication, and will probably
-       # prevent future breakage when ikiwiki internals change.
-       # Known limitations are preferred to future random bugs.
-       if ($template->param('discussionlink') && istranslation($page)) {
-               $template->param('discussionlink' => htmllink(
-                       $page,
-                       $destpage,
-                       $masterpage . '/' . gettext("Discussion"),
-                       noimageinline => 1,
-                       forcesubpage => 0,
-                       linktext => gettext("Discussion"),
+       if ($config{discussion} && istranslation($page)) {
+               if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
+                  (length $config{cgiurl} ||
+                   exists $links{$masterpage."/".lc($config{discussionpage})})) {
+                       $template->param('discussionlink' => htmllink(
+                               $page,
+                               $destpage,
+                               $masterpage . '/' . $config{discussionpage},
+                               noimageinline => 1,
+                               forcesubpage => 0,
+                               linktext => $config{discussionpage},
                ));
+               }
        }
        # Remove broken parentlink to ./index.html on home page's translations.
        # It works because this hook has the "last" parameter set, to ensure it
@@ -305,57 +307,50 @@ sub pagetemplate (@) {
        }
 } # }}}
 
-sub postscan (@) {
-       my %params = @_;
-       my $page = $params{page};
-
-       # backlinks involve back-dependencies, so that nicepagetitle effects,
-       # such as translation status displayed in links, are updated
-       use IkiWiki::Render;
-       map add_depends($page, $_), keys %{$IkiWiki::backlinks{$page}};
-}
-
 # Add the renamed page translations to the list of to-be-renamed pages.
-sub renamepages($$$) {
-       my ($torename, $cgi, $session) = (shift, shift, shift);
+sub renamepages (@) {
+       my %params = @_;
 
-       # copy the initial array, so that we can iterate on it AND
-       # modify it at the same time, without iterating on the items we
-       # pushed on it ourselves
-       my @torename=@{$torename};
+       my %torename = %{$params{torename}};
+       my $session = $params{session};
 
        # Save the page(s) the user asked to rename, so that our
        # canrename hook can tell the difference between:
        #  - a translation being renamed as a consequence of its master page
        #    being renamed
        #  - a user trying to directly rename a translation
-       # This is why this hook has to be run first, before @torename is modified
-       # by other plugins.
-       $session->param(po_orig_torename => [ @torename ]);
+       # This is why this hook has to be run first, before the list of pages
+       # to rename is modified by other plugins.
+       my @orig_torename;
+       @orig_torename=@{$session->param("po_orig_torename")}
+               if defined $session->param("po_orig_torename");
+       push @orig_torename, $torename{src};
+       $session->param(po_orig_torename => \@orig_torename);
        IkiWiki::cgi_savesession($session);
 
-       foreach my $rename (@torename) {
-               next unless istranslatable($rename->{src});
-               my %otherpages=%{otherlanguages($rename->{src})};
-               while (my ($lang, $otherpage) = each %otherpages) {
-                       push @{$torename}, {
-                               src => $otherpage,
-                               srcfile => $pagesources{$otherpage},
-                               dest => otherlanguage($rename->{dest}, $lang),
-                               destfile => $rename->{dest}.".".$lang.".po",
-                               required => 0,
-                       };
-               }
+       return () unless istranslatable($torename{src});
+
+       my @ret;
+       my %otherpages=%{otherlanguages($torename{src})};
+       while (my ($lang, $otherpage) = each %otherpages) {
+               push @ret, {
+                       src => $otherpage,
+                       srcfile => $pagesources{$otherpage},
+                       dest => otherlanguage($torename{dest}, $lang),
+                       destfile => $torename{dest}.".".$lang.".po",
+                       required => 0,
+               };
        }
+       return @ret;
 }
 
-sub mydelete(@) {
+sub mydelete (@) {
        my @deleted=@_;
 
        map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
 }
 
-sub change(@) {
+sub change (@) {
        my @rendered=@_;
 
        # All meta titles are first extracted at scan time, i.e. before we turn
@@ -363,14 +358,14 @@ sub change(@) {
        # PO files breaks the meta plugin's parsing enough to save ugly titles
        # to %pagestate at this time.
        #
-       # Then, at render time, every page's passes on row through the Great
+       # Then, at render time, every page passes in turn through the Great
        # Rendering Chain (filter->preprocess->linkify->htmlize), and the meta
        # plugin's preprocess hook is this time in a position to correctly
        # extract the titles from slave pages.
        #
-       # This is, unfortunately, too late: if the page A, linking to the page B,
-       # is rendered before B, it will display the wrongly-extracted meta title
-       # as the link text to B.
+       # This is, unfortunately, too late: if the page A, linking to the page
+       # B, is rendered before B, it will display the wrongly-extracted meta
+       # title as the link text to B.
        #
        # On the one hand, such a corner case only happens on rebuild: on
        # refresh, every rendered page is fixed to contain correct meta titles.
@@ -385,11 +380,11 @@ sub change(@) {
            && exists $config{meta_overrides_page_title}
            && defined $config{meta_overrides_page_title}
            && $config{meta_overrides_page_title}) {
-               debug(sprintf(gettext("re-rendering all pages to fix meta titles")));
+               debug(sprintf(gettext("rebuilding all pages to fix meta titles")));
                resetalreadyfiltered();
                require IkiWiki::Render;
                foreach my $file (@rendered) {
-                       debug(sprintf(gettext("rendering %s"), $file));
+                       debug(sprintf(gettext("building %s"), $file));
                        IkiWiki::render($file);
                }
        }
@@ -397,25 +392,29 @@ sub change(@) {
        my $updated_po_files=0;
 
        # Refresh/create POT and PO files as needed.
+       # (But avoid doing so if they are in an underlay directory.)
        foreach my $file (grep {istranslatablefile($_)} @rendered) {
-               my $page=pagename($file);
                my $masterfile=srcfile($file);
+               my $page=pagename($file);
                my $updated_pot_file=0;
-               # Only refresh Pot file if it does not exist, or if
+               # 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($masterfile)) {
+               if ($masterfile eq "$config{srcdir}/$file" &&
+                  ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
+                   || ! -e potfile($masterfile))) {
                        refreshpot($masterfile);
                        $updated_pot_file=1;
                }
                my @pofiles;
-               map {
-                       push @pofiles, $_ if ($updated_pot_file || ! -e $_);
-               } (pofiles($masterfile));
+               foreach my $po (pofiles($masterfile)) {
+                       next if ! $updated_pot_file && ! -e $po;
+                       next if grep { $po=~/\Q$_\E/ } @{$config{underlaydirs}};
+                       push @pofiles, $po;
+               }
                if (@pofiles) {
                        refreshpofiles($masterfile, @pofiles);
-                       map { IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
+                       map { s/^\Q$config{srcdir}\E\/*//; IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
                        $updated_po_files=1;
                }
        }
@@ -442,19 +441,19 @@ sub checkcontent (@) {
        return undef;
 }
 
-sub canremove ($$$) {
-       my ($page, $cgi, $session) = (shift, shift, shift);
+sub canremove (@) {
+       my %params = @_;
 
-       if (istranslation($page)) {
-               return gettext("Can not remove a translation. Removing the master page, ".
-                              "though, removes its translations as well.");
+       if (istranslation($params{page})) {
+               return gettext("Can not remove a translation. If the master page is removed, ".
+                              "however, its translations will be removed as well.");
        }
        return undef;
 }
 
-sub canrename ($$@) {
-       my ($cgi, $session) = (shift, shift);
+sub canrename (@) {
        my %params = @_;
+       my $session = $params{session};
 
        if (istranslation($params{src})) {
                my $masterpage = masterpage($params{src});
@@ -465,9 +464,9 @@ sub canrename ($$@) {
                # by looking for the master page in the list of to-be-renamed pages we
                # saved early in the renaming process.
                my $orig_torename = $session->param("po_orig_torename");
-               unless (grep { $_->{src} eq $masterpage } @{$orig_torename}) {
-                       return gettext("Can not rename a translation. Renaming the master page, ".
-                                      "though, renames its translations as well.");
+               unless (grep { $_ eq $masterpage } @{$orig_torename}) {
+                       return gettext("Can not rename a translation. If the master page is renamed, ".
+                                      "however, its translations will be renamed as well.");
                }
        }
        return undef;
@@ -621,18 +620,6 @@ sub myurlto ($$;$) {
        }
 }
 
-sub mynicepagetitle ($;$) {
-       my ($page, $unescaped) = (shift, shift);
-
-       my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
-       return $res unless istranslation($page);
-       return $res unless $config{po_translation_status_in_links};
-       my @caller = caller(1);
-       return $res if (exists $caller[3] && defined $caller[3]
-                       && $caller[3] eq "IkiWiki::Plugin::parentlinks::parentlinks");
-       return $res.' ('.percenttranslated($page).' %)';
-}
-
 sub mycgiurl (@) {
        my %params=@_;
 
@@ -695,9 +682,9 @@ sub istranslatablefile ($) {
        my $file=shift;
 
        return 0 unless defined $file;
-       return 0 if defined pagetype($file) && pagetype($file) eq 'po';
+       my $type=pagetype($file);
+       return 0 if ! defined $type || $type eq 'po';
        return 0 if $file =~ /\.pot$/;
-       return 0 unless -e "$config{srcdir}/$file"; # underlay dirs may be read-only
        return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
        return;
 }
@@ -821,9 +808,10 @@ sub refreshpot ($) {
        $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.
        $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
        $doc->{TT}{po_out}->set_charset('utf-8');
        # do the actual work
@@ -843,8 +831,23 @@ sub refreshpofiles ($@) {
 
        foreach my $pofile (@pofiles) {
                IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
+
+               if (! -e $pofile) {
+                       # If the po file exists in an underlay, copy it
+                       # from there.
+                       my ($pobase)=$pofile=~/^\Q$config{srcdir}\E\/?(.*)$/;
+                       foreach my $dir (@{$config{underlaydirs}}) {
+                               if (-e "$dir/$pobase") {
+                                       File::Copy::syscopy("$dir/$pobase",$pofile)
+                                               or error("po(refreshpofiles) ".
+                                                        sprintf(gettext("failed to copy underlay PO file to %s"),
+                                                                $pofile));
+                               }
+                       }
+               }
+
                if (-e $pofile) {
-                       system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
+                       system("msgmerge", "--previous", "-q", "-U", "--backup=none", $pofile, $potfile) == 0
                                or error("po(refreshpofiles) ".
                                         sprintf(gettext("failed to update %s"),
                                                 $pofile));
@@ -931,7 +934,7 @@ sub otherlanguagesloop ($) {
                                master => 1,
                        };
                }
-               else {
+               elsif (istranslation($otherpage)) {
                        push @ret, {
                                url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
                                code => $lang,
@@ -941,10 +944,10 @@ sub otherlanguagesloop ($) {
                }
        }
        return sort {
-                       return -1 if $a->{code} eq $config{po_master_language}{code};
-                       return 1 if $b->{code} eq $config{po_master_language}{code};
-                       return $a->{language} cmp $b->{language};
-               } @ret;
+               return -1 if $a->{code} eq $config{po_master_language}{code};
+               return 1 if $b->{code} eq $config{po_master_language}{code};
+               return $a->{language} cmp $b->{language};
+       } @ret;
 }
 
 sub homepageurl (;$) {
@@ -1106,8 +1109,8 @@ sub isvalidpo ($) {
        if ($res) {
            return IkiWiki::SuccessReason->new("valid gettext data");
        }
-       return IkiWiki::FailReason->new("invalid gettext data, go back ".
-                                       "to previous page to go on with edit");
+       return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
+                                       "to previous page to continue edit"));
 }
 
 # ,----