]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
po(change): re-render all rendered files in one corner case
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index 7cec589abf44d48f7ad1042cb03f3d86042b028b..f826f9503805a55da1548a1f1d124315ee0ddb06 100644 (file)
@@ -56,6 +56,8 @@ sub import {
        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);
 }
 
 
@@ -128,7 +130,8 @@ sub getsetup () {
 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 when using the %s plugin"), $field, 'po'));
+                       error(sprintf(gettext("Must specify %s when using the %s plugin"),
+                                     $field, 'po'));
                }
        }
        if (! (keys %{$config{po_slave_languages}})) {
@@ -150,8 +153,8 @@ sub checkconfig () {
        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}));
+               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';
        }
        elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
@@ -354,6 +357,42 @@ 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's passes on row 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 (scalar @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("re-rendering all pages to fix meta titles")));
+               resetalreadyfiltered();
+               require IkiWiki::Render;
+               foreach my $file (@rendered) {
+                       debug(sprintf(gettext("rendering %s"), $file));
+                       IkiWiki::render($file);
+               }
+       }
+
        my $updated_po_files=0;
 
        # Refresh/create POT and PO files as needed.
@@ -474,28 +513,32 @@ sub formbuilder_setup (@) {
        }
 }
 
-# Do not allow to create pages of type po: they are automatically created.
-# The main reason to do so is to bypass the "favor the type of linking page
-# on page creation" logic, which is unsuitable when a broken link is clicked
-# on a slave (PO) page.
 sub formbuilder (@) {
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
 
-       return unless (defined $form->field("do") && $form->field("do") eq "create");
+       return unless defined $form->field("do");
 
-        for my $field ($form->field) {
-               next unless "$field" eq "type";
-               if ($field->type eq 'select') {
-                       # remove po from the types list
-                       my @types = grep { $_ ne 'po' } $field->options;
-                       $field->options(\@types) if scalar @types;
-               }
-               else {
-                       # make sure the default value is not po;
-                       # does this case actually happen?
-                       debug sprintf("po(formbuilder) type field is not select - not implemented yet");
+       # Do not allow to create pages of type po: they are automatically created.
+       # The main reason to do so is to bypass the "favor the type of linking page
+       # on page creation" logic, which is unsuitable when a broken link is clicked
+       # on a slave (PO) page.
+       # This cannot be done in the formbuilder_setup hook as the list of types is
+       # computed later.
+       if ($form->field("do") eq "create") {
+               for my $field ($form->field) {
+                       next unless "$field" eq "type";
+                       if ($field->type eq 'select') {
+                               # remove po from the list of types
+                               my @types = grep { $_ ne 'po' } $field->options;
+                               $field->options(\@types) if scalar @types;
+                       }
+                       else {
+                               # make sure the default value is not po;
+                               # does this case actually happen?
+                               debug "po(formbuilder) ".gettext("type field is not select - not implemented yet");
+                       }
                }
        }
 }
@@ -588,9 +631,22 @@ sub mynicepagetitle ($;$) {
        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=@_;
+
+       # slave pages have no subpages
+       if (istranslation($params{'from'})) {
+               $params{'from'} = masterpage($params{'from'});
+       }
+       return $origsubs{'cgiurl'}->(%params);
+}
+
 # ,----
 # | Blackboxes for private data
 # `----
@@ -645,6 +701,7 @@ sub istranslatablefile ($) {
        return 0 unless defined $file;
        return 0 if (defined pagetype($file) && pagetype($file) 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;
 }
@@ -660,6 +717,7 @@ sub istranslatable ($) {
 sub _istranslation ($) {
        my $page=shift;
 
+       $page='' unless (defined $page && length $page);
        my $hasleadingslash = ($page=~s#^/##);
        my $file=$pagesources{$page};
        return 0 unless (defined $file
@@ -784,19 +842,21 @@ sub refreshpofiles ($@) {
 
        my $potfile=potfile($masterfile);
        (-e $potfile)
-               or error(sprintf(gettext("po(refreshpofiles) POT file (%s) does not exist"),
-                                $potfile));
+               or error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"),
+                                                      $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(sprintf(gettext("po(refreshpofiles) failed to update %s"),
+                               or error("po(refreshpofiles) ".
+                                        sprintf(gettext("failed to update %s"),
                                                 $pofile));
                }
                else {
                        File::Copy::syscopy($potfile,$pofile)
-                               or error(sprintf(gettext("po(refreshpofiles) failed to copy the POT file to %s"),
+                               or error("po(refreshpofiles) ".
+                                        sprintf(gettext("failed to copy the POT file to %s"),
                                                 $pofile));
                }
        }
@@ -844,8 +904,8 @@ sub percenttranslated ($) {
                'file_in_name'  => [ $masterfile ],
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
-       ) or error(sprintf(gettext("po(percenttranslated) failed to translate %s"),
-                          $page));
+       ) or error("po(percenttranslated) ".
+                  sprintf(gettext("failed to translate %s"), $page));
        my ($percent,$hit,$queries) = $doc->stats();
        $percent =~ s/\.[0-9]+$//;
        return $percent;
@@ -1050,7 +1110,8 @@ sub isvalidpo ($) {
        if ($res) {
            return IkiWiki::SuccessReason->new("valid gettext data");
        }
-       return IkiWiki::FailReason->new("invalid gettext data");
+       return IkiWiki::FailReason->new("invalid gettext data, go back ".
+                                       "to previous page to go on with edit");
 }
 
 # ,----