]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
remove useless uses of scalar
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index a307e5d6b4171308702b8030cc43b7865bcdd120..7dfa52f570c3cd21fa63234713b44316af3cae9c 100644 (file)
@@ -10,6 +10,16 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Encode;
+BEGIN {
+       eval 'use Locale::Po4a::Common qw(nowrapi18n)';
+       if ($@) {
+               warning(sprintf(gettext('%s is too old, can not disable %s; '.
+                                       'a denial of service can thus be '.
+                                       'triggered by malicious content'),
+                               'Locale::Po4a', 'Text::WrapI18N'));
+               eval 'use Locale::Po4a::Common';
+       }
+}
 use Locale::Po4a::Chooser;
 use Locale::Po4a::Po;
 use File::Basename;
@@ -39,7 +49,7 @@ sub import {
        hook(type => "rename", id => "po", call => \&renamepages, first => 1);
        hook(type => "delete", id => "po", call => \&mydelete);
        hook(type => "change", id => "po", call => \&change);
-       hook(type => "cansave", id => "po", call => \&cansave);
+       hook(type => "checkcontent", id => "po", call => \&checkcontent);
        hook(type => "canremove", id => "po", call => \&canremove);
        hook(type => "canrename", id => "po", call => \&canrename);
        hook(type => "editcontent", id => "po", call => \&editcontent);
@@ -56,6 +66,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);
 }
 
 
@@ -263,7 +275,7 @@ sub pagetemplate (@) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {
-               $template->param(istranslation => scalar istranslation($page));
+               $template->param(istranslation => istranslation($page));
        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
@@ -355,6 +367,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 (@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.
@@ -388,11 +436,11 @@ sub change(@) {
        }
 }
 
-sub cansave ($$$$) {
-       my ($page, $content, $cgi, $session) = (shift, shift, shift, shift);
+sub checkcontent (@) {
+       my %params=@_;
 
-       if (istranslation($page)) {
-               my $res = isvalidpo($content);
+       if (istranslation($params{page})) {
+               my $res = isvalidpo($params{content});
                if ($res) {
                        return undef;
                }
@@ -426,7 +474,7 @@ 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 (scalar grep { $_->{src} eq $masterpage } @{$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.");
                }
@@ -489,17 +537,17 @@ 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") {
-               for my $field ($form->field) {
+               foreach 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;
+                               $field->options(\@types) if @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");
+                               debug "po(formbuilder) ".gettext("type field is not selected - not implemented yet");
                        }
                }
        }
@@ -593,9 +641,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
 # `----
@@ -650,6 +711,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;
 }
@@ -665,6 +727,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
@@ -788,9 +851,9 @@ sub refreshpofiles ($@) {
        my @pofiles=@_;
 
        my $potfile=potfile($masterfile);
-       (-e $potfile)
-               or error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"),
-                                                      $potfile));
+       if (! -e $potfile) {
+               error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
+       }
 
        foreach my $pofile (@pofiles) {
                IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
@@ -926,7 +989,7 @@ sub deletetranslations ($) {
                }
        } @todelete;
 
-       if (scalar @todelete) {
+       if (@todelete) {
                commit_and_refresh(
                        gettext("removed obsolete PO files"),
                        "IkiWiki::Plugin::po::deletetranslations");