]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
Added a comment
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index 43804a8f2b38681112298058bab8f0b3e1360baa..6410a1c663ceba0b615a6d3959bb27c3dd20b609 100644 (file)
@@ -25,10 +25,13 @@ use File::Temp;
 use Memoize;
 use UNIVERSAL;
 
+my ($master_language_code, $master_language_name);
 my %translations;
 my @origneedsbuild;
 my %origsubs;
-my @slavelanguages; # orderer as in config po_slave_languages
+my @slavelanguages; # language codes ordered as in config po_slave_languages
+my %slavelanguages; # language code to name lookup
+my $language_code_pattern = '[a-zA-Z]+(?:_[a-zA-Z]+)?';
 
 memoize("istranslatable");
 memoize("_istranslation");
@@ -36,7 +39,8 @@ memoize("percenttranslated");
 
 sub import {
        hook(type => "getsetup", id => "po", call => \&getsetup);
-       hook(type => "checkconfig", id => "po", call => \&checkconfig);
+       hook(type => "checkconfig", id => "po", call => \&checkconfig,
+               last => 1);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);
        hook(type => "scan", id => "po", call => \&scan, last => 1);
        hook(type => "filter", id => "po", call => \&filter);
@@ -63,8 +67,11 @@ sub import {
                inject(name => "IkiWiki::urlto", call => \&myurlto);
                $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
                inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
-               $origsubs{'rootpage'}=\&IkiWiki::rootpage;
-               inject(name => "IkiWiki::rootpage", call => \&myrootpage);
+               if (IkiWiki->can('rootpage')) {
+                       $origsubs{'rootpage'}=\&IkiWiki::rootpage;
+                       inject(name => "IkiWiki::rootpage", call => \&myrootpage)
+                               if defined $origsubs{'rootpage'};
+               }
                $origsubs{'isselflink'}=\&IkiWiki::isselflink;
                inject(name => "IkiWiki::isselflink", call => \&myisselflink);
        }
@@ -89,16 +96,13 @@ sub import {
 sub getsetup () {
        return
                plugin => {
-                       safe => 0,
+                       safe => 1,
                        rebuild => 1, # format plugin
                        section => "format",
                },
                po_master_language => {
                        type => "string",
-                       example => {
-                               'code' => 'en',
-                               'name' => 'English'
-                       },
+                       example => "en|English",
                        description => "master language (non-PO files)",
                        safe => 1,
                        rebuild => 1,
@@ -106,11 +110,11 @@ sub getsetup () {
                po_slave_languages => {
                        type => "string",
                        example => [
-                               'fr' => 'Français',
-                               'es' => 'Español',
-                               'de' => 'Deutsch'
+                               'fr|Français',
+                               'es|Español',
+                               'de|Deutsch'
                        ],
-                       description => "slave languages (PO files)",
+                       description => "slave languages (translated via PO files) format: ll|Langname",
                        safe => 1,
                        rebuild => 1,
                },
@@ -132,36 +136,49 @@ sub getsetup () {
 }
 
 sub checkconfig () {
-       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 (exists $config{po_master_language}) {
+               if (! ref $config{po_master_language}) {
+                       ($master_language_code, $master_language_name)=
+                               splitlangpair($config{po_master_language});
+               }
+               else {
+                       $master_language_code=$config{po_master_language}{code};
+                       $master_language_name=$config{po_master_language}{name};
+                       $config{po_master_language}=joinlangpair($master_language_code, $master_language_name);
                }
        }
+       if (! defined $master_language_code) {
+               $master_language_code='en';
+       }
+       if (! defined $master_language_name) {
+               $master_language_name='English';
+       }
 
        if (ref $config{po_slave_languages} eq 'ARRAY') {
-               my %slaves;
-               if (@{$config{po_slave_languages}} % 2 != 0) {
-                       error(sprintf(gettext("The %s field is invalid."), 'po_slave_languages'));
-                }
-               for (my $i=0; $i<@{$config{po_slave_languages}}; $i = $i + 2) {
-                       $slaves{$config{po_slave_languages}->[$i]} = $config{po_slave_languages}->[$i + 1];
-                       push @slavelanguages, $config{po_slave_languages}->[$i];
-                }
-               $config{po_slave_languages} = \%slaves;
-        }
+               foreach my $pair (@{$config{po_slave_languages}}) {
+                       my ($code, $name)=splitlangpair($pair);
+                       if (defined $code && ! exists $slavelanguages{$code}) {
+                               push @slavelanguages, $code;
+                               $slavelanguages{$code} = $name;
+                       }
+               }
+       }
        elsif (ref $config{po_slave_languages} eq 'HASH') {
+               %slavelanguages=%{$config{po_slave_languages}};
                @slavelanguages = sort {
                        $config{po_slave_languages}->{$a} cmp $config{po_slave_languages}->{$b};
-               } keys %{$config{po_slave_languages}};
-        }
+               } keys %slavelanguages;
+               $config{po_slave_languages}=[
+                       map { joinlangpair($_, $slavelanguages{$_}) } @slavelanguages
+               ]
+       }
 
-       delete $config{po_slave_languages}{$config{po_master_language}{code}};;
+       delete $slavelanguages{$master_language_code};
 
        map {
                islanguagecode($_)
                        or error(sprintf(gettext("%s is not a valid language code"), $_));
-       } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
+       } ($master_language_code, @slavelanguages);
 
        if (! exists $config{po_translatable_pages} ||
            ! defined $config{po_translatable_pages}) {
@@ -190,16 +207,16 @@ sub checkconfig () {
                next if $underlay=~/^locale\//;
 
                # Underlays containing the po files for slave languages.
-               foreach my $ll (keys %{$config{po_slave_languages}}) {
+               foreach my $ll (@slavelanguages) {
                        add_underlay("po/$ll/$underlay")
                                if -d "$config{underlaydirbase}/po/$ll/$underlay";
                }
        
-               if ($config{po_master_language}{code} ne 'en') {
+               if ($master_language_code ne 'en') {
                        # Add underlay containing translated source files
                        # for the master language.
-                       add_underlay("locale/$config{po_master_language}{code}/$underlay")
-                               if -d "$config{underlaydirbase}/locale/$config{po_master_language}{code}/$underlay";
+                       add_underlay("locale/$master_language_code/$underlay")
+                               if -d "$config{underlaydirbase}/locale/$master_language_code/$underlay";
                }
        }
 }
@@ -218,40 +235,65 @@ sub needsbuild () {
        foreach my $master (keys %translations) {
                map add_depends($_, $master), values %{otherlanguages_pages($master)};
        }
+
+       return $needsbuild;
 }
 
-# Massage the recorded state of internal links so that:
-# - it matches the actually generated links, rather than the links as written
-#   in the pages' source
-# - backlinks are consistent in all cases
 sub scan (@) {
        my %params=@_;
        my $page=$params{page};
        my $content=$params{content};
-
-       if (istranslation($page)) {
-               foreach my $destpage (@{$links{$page}}) {
-                       if (istranslatable($destpage)) {
-                               # replace the occurence of $destpage in $links{$page}
-                               for (my $i=0; $i<@{$links{$page}}; $i++) {
-                                       if (@{$links{$page}}[$i] eq $destpage) {
-                                               @{$links{$page}}[$i] = $destpage . '.' . lang($page);
-                                               last;
-                                       }
-                               }
+       my $run_by_po=$params{run_by_po};
+
+       # Massage the recorded state of internal links so that:
+       # - it matches the actually generated links, rather than the links as
+       #   written in the pages' source
+       # - backlinks are consistent in all cases
+
+       # A second scan pass is made over translation pages, so as an
+       # optimization, we only do so on the second pass in this case,
+       # i.e. when this hook is called by itself.
+       if ($run_by_po && istranslation($page)) {
+               # replace the occurence of $destpage in $links{$page}
+               my @orig_links = @{$links{$page}};
+               $links{$page} = [];
+               foreach my $destpage (@orig_links) {
+                       if (istranslatedto($destpage, lang($page))) {
+                               add_link($page, $destpage . '.' . lang($page));
+                       }
+                       else {
+                               add_link($page, $destpage);
                        }
                }
        }
-       elsif (! istranslatable($page) && ! istranslation($page)) {
+       # No second scan pass is done for a non-translation page, so
+       # links massaging must happen on first pass in this case.
+       elsif (! $run_by_po && ! istranslatable($page) && ! istranslation($page)) {
                foreach my $destpage (@{$links{$page}}) {
                        if (istranslatable($destpage)) {
                                # make sure any destpage's translations has
                                # $page in its backlinks
-                               push @{$links{$page}},
-                                       values %{otherlanguages_pages($destpage)};
+                               foreach my $link (values %{otherlanguages_pages($destpage)}) {
+                                       add_link($page, $link);
+                               }
                        }
                }
        }
+
+       # Re-run the preprocess hooks in scan mode, then the scan hooks,
+       # over the po-to-markup converted content
+       return if $run_by_po; # avoid looping endlessly
+       return unless istranslation($page);
+       $content = po_to_markup($page, $content);
+       require IkiWiki;
+       IkiWiki::preprocess($page, $page, $content, 1);
+       IkiWiki::run_hooks(scan => sub {
+               shift->(
+                       page => $page,
+                       content => $content,
+                       run_by_po => 1,
+               );
+       });
 }
 
 # We use filter to convert PO to the master page's format,
@@ -301,6 +343,13 @@ sub pagetemplate (@) {
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
        }
+       my $lang_code = istranslation($page) ? lang($page) : $master_language_code;
+       if ($template->query(name => "lang_code")) {
+               $template->param(lang_code => $lang_code);
+       }
+       if ($template->query(name => "lang_name")) {
+               $template->param(lang_name => languagename($lang_code));
+       }
        if ($template->query(name => "HOMEPAGEURL")) {
                $template->param(homepageurl => homepageurl($page));
        }
@@ -330,7 +379,8 @@ sub pagetemplate (@) {
            && $masterpage eq "index") {
                $template->param('parentlinks' => []);
        }
-       if (ishomepage($page) && $template->query(name => "title")) {
+       if (ishomepage($page) && $template->query(name => "title")
+           && !$template->param("title_overridden")) {
                $template->param(title => $config{wikiname});
        }
 }
@@ -381,41 +431,6 @@ sub mydelete (@) {
 sub change (@) {
        my @rendered=@_;
 
-       # All meta titles are first extracted at scan time, i.e. before we turn
-       # PO files back into translated markdown; escaping of double-quotes in
-       # PO files breaks the meta plugin's parsing enough to save ugly titles
-       # to %pagestate at this time.
-       #
-       # 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.
-       #
-       # On the one hand, such a corner case only happens on rebuild: on
-       # refresh, every rendered page is fixed to contain correct meta titles.
-       # On the other hand, it can take some time to get every page fixed.
-       # We therefore re-render every rendered page after a rebuild to fix them
-       # at once. As this more or less doubles the time needed to rebuild the
-       # wiki, we do so only when really needed.
-
-       if (@rendered
-           && exists $config{rebuild} && defined $config{rebuild} && $config{rebuild}
-           && UNIVERSAL::can("IkiWiki::Plugin::meta", "getsetup")
-           && exists $config{meta_overrides_page_title}
-           && defined $config{meta_overrides_page_title}
-           && $config{meta_overrides_page_title}) {
-               debug(sprintf(gettext("rebuilding all pages to fix meta titles")));
-               resetalreadyfiltered();
-               require IkiWiki::Render;
-               foreach my $file (@rendered) {
-                       IkiWiki::render($file, sprintf(gettext("building %s"), $file));
-               }
-       }
-
        my $updated_po_files=0;
 
        # Refresh/create POT and PO files as needed.
@@ -519,7 +534,7 @@ sub formbuilder_setup (@) {
        if ($form->field("do") eq "create") {
                # Warn the user: new pages must be written in master language.
                my $template=template("pocreatepage.tmpl");
-               $template->param(LANG => $config{po_master_language}{name});
+               $template->param(LANG => $master_language_name);
                $form->tmpl_param(message => $template->output);
        }
        elsif ($form->field("do") eq "edit") {
@@ -555,7 +570,7 @@ sub formbuilder (@) {
        # This cannot be done in the formbuilder_setup hook as the list of types is
        # computed later.
        if ($form->field("do") eq "create") {
-               foreach my $field ($form->field) {
+               foreach my $field ($form->field) {
                        next unless "$field" eq "type";
                        next unless $field->type eq 'select';
                        my $orig_value = $field->value;
@@ -594,7 +609,7 @@ sub mybestlink ($$) {
        my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
        my @caller = caller(1);
        if (length $res
-           && istranslatable($res)
+           && istranslatedto($res, lang($page))
            && istranslation($page)
            &&  !(exists $caller[3] && defined $caller[3]
                  && ($caller[3] eq "IkiWiki::PageSpec::match_link"))) {
@@ -608,32 +623,36 @@ sub mybeautify_urlpath ($) {
 
        my $res=$origsubs{'beautify_urlpath'}->($url);
        if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {
-               $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
+               $res =~ s!/\Qindex.$master_language_code.$config{htmlext}\E$!/!;
                $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
                map {
                        $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
-               } (keys %{$config{po_slave_languages}});
+               } @slavelanguages;
        }
        return $res;
 }
 
-sub mytargetpage ($$) {
+sub mytargetpage ($$;$) {
        my $page=shift;
        my $ext=shift;
+       my $filename=shift;
 
        if (istranslation($page) || istranslatable($page)) {
                my ($masterpage, $lang) = (masterpage($page), lang($page));
-               if (! $config{usedirs} || $masterpage eq 'index') {
+               if (defined $filename) {
+                       return $masterpage . "/" . $filename . "." . $lang . "." . $ext;
+               }
+               elsif (! $config{usedirs} || $masterpage eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }
-       return $origsubs{'targetpage'}->($page, $ext);
+       return $origsubs{'targetpage'}->($page, $ext, $filename);
 }
 
-sub myurlto ($$;$) {
+sub myurlto ($;$$) {
        my $to=shift;
        my $from=shift;
        my $absolute=shift;
@@ -642,7 +661,12 @@ sub myurlto ($$;$) {
        if (! length $to
            && $config{po_link_to} eq "current"
            && istranslatable('index')) {
-               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
+               if (defined $from) {
+                       return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
+               }
+               else {
+                       return $origsubs{'urlto'}->($to,$from,$absolute);
+               }
        }
        # avoid using our injected beautify_urlpath if run by cgi_editpage,
        # so that one is redirected to the just-edited page rather than to the
@@ -703,7 +727,7 @@ sub myisselflink ($$) {
        return 1 if $origsubs{'isselflink'}->($page, $link);
        if (istranslation($page)) {
                return $origsubs{'isselflink'}->(masterpage($page), $link);
-        }
+       }
        return;
 }
 
@@ -775,6 +799,15 @@ sub istranslatable ($) {
        return;
 }
 
+sub istranslatedto ($$) {
+       my $page=shift;
+       my $destlang = shift;
+
+       $page=~s#^/##;
+       return 0 unless istranslatable($page);
+       exists $pagesources{otherlanguage_page($page, $destlang)};
+}
+
 sub _istranslation ($) {
        my $page=shift;
 
@@ -786,11 +819,11 @@ sub _istranslation ($) {
                         && pagetype($file) eq 'po';
        return 0 if $file =~ /\.pot$/;
 
-       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+       my ($masterpage, $lang) = ($page =~ /(.*)[.]($language_code_pattern)$/);
        return 0 unless defined $masterpage && defined $lang
                         && length $masterpage && length $lang
                         && defined $pagesources{$masterpage}
-                        && defined $config{po_slave_languages}{$lang};
+                        && defined $slavelanguages{$lang};
 
        return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
                if istranslatable($masterpage);
@@ -822,20 +855,20 @@ sub lang ($) {
        if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
                return $lang;
        }
-       return $config{po_master_language}{code};
+       return $master_language_code;
 }
 
 sub islanguagecode ($) {
        my $code=shift;
 
-       return $code =~ /^[a-z]{2}$/;
+       return $code =~ /^$language_code_pattern$/;
 }
 
 sub otherlanguage_page ($$) {
        my $page=shift;
        my $code=shift;
 
-       return masterpage($page) if $code eq $config{po_master_language}{code};
+       return masterpage($page) if $code eq $master_language_code;
        return masterpage($page) . '.' . $code;
 }
 
@@ -849,9 +882,12 @@ sub otherlanguages_codes ($) {
        return \@ret unless istranslation($page) || istranslatable($page);
        my $curlang=lang($page);
        foreach my $lang
-               ($config{po_master_language}{code}, @slavelanguages) {
+               ($master_language_code, @slavelanguages) {
                next if $lang eq $curlang;
-               push @ret, $lang;
+               if ($lang eq $master_language_code ||
+                   istranslatedto(masterpage($page), $lang)) {
+                       push @ret, $lang;
+               }
        }
        return \@ret;
 }
@@ -859,7 +895,7 @@ sub otherlanguages_codes ($) {
 sub otherlanguages_pages ($) {
        my $page=shift;
 
-        my %ret;
+       my %ret;
        map {
                $ret{$_} = otherlanguage_page($page, $_)
        } @{otherlanguages_codes($page)};
@@ -887,7 +923,7 @@ sub pofile ($$) {
 sub pofiles ($) {
        my $masterfile=shift;
 
-       return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
+       return map pofile($masterfile, $_), @slavelanguages;
 }
 
 sub refreshpot ($) {
@@ -1003,10 +1039,10 @@ sub percenttranslated ($) {
 sub languagename ($) {
        my $code=shift;
 
-       return $config{po_master_language}{name}
-               if $code eq $config{po_master_language}{code};
-       return $config{po_slave_languages}{$code}
-               if defined $config{po_slave_languages}{$code};
+       return $master_language_name
+               if $code eq $master_language_code;
+       return $slavelanguages{$code}
+               if defined $slavelanguages{$code};
        return;
 }
 
@@ -1017,13 +1053,13 @@ sub otherlanguagesloop ($) {
        if (istranslation($page)) {
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),
-                       code => $config{po_master_language}{code},
-                       language => $config{po_master_language}{name},
+                       code => $master_language_code,
+                       language => $master_language_name,
                        master => 1,
                };
        }
        foreach my $lang (@{otherlanguages_codes($page)}) {
-               next if $lang eq $config{po_master_language}{code};
+               next if $lang eq $master_language_code;
                my $otherpage = otherlanguage_page($page, $lang);
                push @ret, {
                        url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
@@ -1045,7 +1081,7 @@ sub ishomepage ($) {
        my $page = shift;
 
        return 1 if $page eq 'index';
-       map { return 1 if $page eq 'index.'.$_ } keys %{$config{po_slave_languages}};
+       map { return 1 if $page eq 'index.'.$_ } @slavelanguages;
        return undef;
 }
 
@@ -1060,7 +1096,7 @@ sub deletetranslations ($) {
                if (-e $absfile && ! -l $absfile && ! -d $absfile) {
                        push @todelete, $file;
                }
-       } keys %{$config{po_slave_languages}};
+       } @slavelanguages;
 
        map {
                if ($config{rcs}) {
@@ -1191,7 +1227,7 @@ sub isvalidpo ($) {
        unlink $infile;
 
        if ($res) {
-           return IkiWiki::SuccessReason->new("valid gettext data");
+               return IkiWiki::SuccessReason->new("valid gettext data");
        }
        return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
                                        "to previous page to continue edit"));
@@ -1203,7 +1239,7 @@ sub po4a_type ($) {
        my $pagetype = pagetype($file);
        if ($pagetype eq 'html') {
                return 'xhtml';
-        }
+       }
        return 'text';
 }
 
@@ -1217,17 +1253,39 @@ sub po4a_options($) {
                # how to disable options is not consistent across po4a modules
                $options{includessi} = '';
                $options{includeexternal} = 0;
-        }
+               $options{ontagerror} = 'warn';
+       }
        elsif ($pagetype eq 'mdwn') {
                $options{markdown} = 1;
-        }
-        else {
+       }
+       else {
                $options{markdown} = 0;
-        }
+       }
 
        return %options;
 }
 
+sub splitlangpair ($) {
+       my $pair=shift;
+
+       my ($code, $name) = ( $pair =~ /^($language_code_pattern)\|(.+)$/ );
+       if (! defined $code || ! defined $name ||
+           ! length $code || ! length $name) {
+               # not a fatal error to avoid breaking if used with web setup
+               warn sprintf(gettext("%s has invalid syntax: must use CODE|NAME"),
+                       $pair);
+       }
+
+       return $code, $name;
+}
+
+sub joinlangpair ($$) {
+       my $code=shift;
+       my $name=shift;
+
+       return "$code|$name";
+}
+
 # ,----
 # | PageSpecs
 # `----
@@ -1262,7 +1320,7 @@ sub match_lang ($$;@) {
 
        my $regexp=IkiWiki::glob2re($wanted);
        my $lang=IkiWiki::Plugin::po::lang($page);
-       if ($lang !~ /^$regexp$/i) {
+       if ($lang !~ $regexp) {
                return IkiWiki::FailReason->new("file language is $lang, not $wanted");
        }
        else {
@@ -1298,11 +1356,11 @@ sub match_needstranslation ($$;@) {
                }
                elsif ($wanted > 100) {
                        return IkiWiki::FailReason->new("parameter is greater than 100");
-                }
-        }
-        else {
+               }
+       }
+       else {
                $wanted=100;
-        }
+       }
 
        my $percenttranslated=IkiWiki::Plugin::po::percenttranslated($page);
        if ($percenttranslated eq 'N/A') {
@@ -1310,7 +1368,7 @@ sub match_needstranslation ($$;@) {
        }
        elsif ($percenttranslated < $wanted) {
                return IkiWiki::SuccessReason->new("file has $percenttranslated translated");
-        }
+       }
        else {
                return IkiWiki::FailReason->new("file is translated enough");
        }