]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
avoid standalone -e or foo syntax
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index 236b5984fd2c75df6defe3ba1279e3878edbf2ca..be7a28722845ab099a09a8108f4af0b1c0ad23c0 100644 (file)
@@ -1,15 +1,25 @@
 #!/usr/bin/perl
 # .po as a wiki page type
 # Licensed under GPL v2 or greater
-# Copyright (C) 2008 intrigeri <intrigeri@boum.org>
+# Copyright (C) 2008-2009 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;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+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,10 +49,12 @@ 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);
+       hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
+       hook(type => "formbuilder", id => "po", call => \&formbuilder);
 
        $origsubs{'bestlink'}=\&IkiWiki::bestlink;
        inject(name => "IkiWiki::bestlink", call => \&mybestlink);
@@ -54,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);
 }
 
 
@@ -126,11 +140,13 @@ 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"), $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"));
+               error(gettext("At least one slave language must be defined ".
+                             "in po_slave_languages when using the po plugin"));
        }
        map {
                islanguagecode($_)
@@ -147,8 +163,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}) {
@@ -351,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 (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.
@@ -384,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;
                }
@@ -439,6 +491,67 @@ sub editcontent () {
        return $params{content};
 }
 
+sub formbuilder_setup (@) {
+       my %params=@_;
+       my $form=$params{form};
+       my $q=$params{cgi};
+
+       return unless defined $form->field("do");
+
+       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});
+               $form->tmpl_param(message => $template->output);
+       }
+       elsif ($form->field("do") eq "edit") {
+               # Remove the rename/remove buttons on slave pages.
+               # This has to be done after the rename/remove plugins have added
+               # their buttons, which is why this hook must be run last.
+               # The canrename/canremove hooks already ensure this is forbidden
+               # at the backend level, so this is only UI sugar.
+               if (istranslation($form->field("page"))) {
+                       map {
+                               for (my $i = 0; $i < @{$params{buttons}}; $i++) {
+                                       if (@{$params{buttons}}[$i] eq $_) {
+                                               delete  @{$params{buttons}}[$i];
+                                               last;
+                                       }
+                               }
+                       } qw(Rename Remove);
+               }
+       }
+}
+
+sub formbuilder (@) {
+       my %params=@_;
+       my $form=$params{form};
+       my $q=$params{cgi};
+
+       return unless defined $form->field("do");
+
+       # 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");
+                       }
+               }
+       }
+}
 
 # ,----
 # | Injected functions
@@ -528,7 +641,20 @@ sub mynicepagetitle ($;$) {
        my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
        return $res unless istranslation($page);
        return $res unless $config{po_translation_status_in_links};
-       return $res.' ('.percenttranslated($page).' %)';
+       my @caller = caller(1);
+       return $res if (exists $caller[3] && defined $caller[3]
+                       && $caller[3] eq "IkiWiki::Plugin::parentlinks::parentlinks");
+       return $res.' ('.percenttranslated($page).'&nbsp;%)';
+}
+
+sub mycgiurl (@) {
+       my %params=@_;
+
+       # slave pages have no subpages
+       if (istranslation($params{'from'})) {
+               $params{'from'} = masterpage($params{'from'});
+       }
+       return $origsubs{'cgiurl'}->(%params);
 }
 
 # ,----
@@ -585,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;
 }
@@ -600,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
@@ -723,17 +851,23 @@ sub refreshpofiles ($@) {
        my @pofiles=@_;
 
        my $potfile=potfile($masterfile);
-       error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $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));
                if (-e $pofile) {
                        system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
-                               or error("[po/refreshpofiles:$pofile] failed to update");
+                               or error("po(refreshpofiles) ".
+                                        sprintf(gettext("failed to update %s"),
+                                                $pofile));
                }
                else {
                        File::Copy::syscopy($potfile,$pofile)
-                               or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
+                               or error("po(refreshpofiles) ".
+                                        sprintf(gettext("failed to copy the POT file to %s"),
+                                                $pofile));
                }
        }
 }
@@ -780,8 +914,10 @@ sub percenttranslated ($) {
                'file_in_name'  => [ $masterfile ],
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
-       ) or error("[po/percenttranslated:$page]: failed to translate");
+       ) or error("po(percenttranslated) ".
+                  sprintf(gettext("failed to translate %s"), $page));
        my ($percent,$hit,$queries) = $doc->stats();
+       $percent =~ s/\.[0-9]+$//;
        return $percent;
 }
 
@@ -908,17 +1044,17 @@ sub po_to_markup ($$;$) {
                                     DIR => File::Spec->tmpdir,
                                     UNLINK => 1)->filename;
 
-       sub failure ($) {
-               my $msg = '[po/po_to_markup:'.$page.'] ' . shift;
+       my $fail = sub ($) {
+               my $msg = "po(po_to_markup) - $page : " . shift;
                if ($nonfatal) {
                        warn $msg;
                        return undef;
                }
                error($msg, sub { unlink $infile, $outfile});
-       }
+       };
 
        writefile(basename($infile), File::Spec->tmpdir, $content)
-               or return failure("failed to write $infile");
+               or return $fail->(sprintf(gettext("failed to write %s"), $infile));
 
        my $masterfile = srcfile($pagesources{masterpage($page)});
        my %options = (
@@ -930,10 +1066,12 @@ sub po_to_markup ($$;$) {
                'file_in_name'  => [ $masterfile ],
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
-       ) or return failure("failed to translate");
-       $doc->write($outfile) or return failure("could not write $outfile");
+       ) or return $fail->(gettext("failed to translate"));
+       $doc->write($outfile)
+               or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
 
-       $content = readfile($outfile) or return failure("could not read $outfile");
+       $content = readfile($outfile)
+               or return $fail->(sprintf(gettext("failed to read %s"), $outfile));
 
        # Unlinking should happen automatically, thanks to File::Temp,
        # but it does not work here, probably because of the way writefile()
@@ -963,16 +1101,16 @@ sub isvalidpo ($) {
                                    DIR => File::Spec->tmpdir,
                                    UNLINK => 1)->filename;
 
-       sub failure ($) {
+       my $fail = sub ($) {
                my $msg = '[po/isvalidpo] ' . shift;
                unlink $infile;
                return IkiWiki::FailReason->new("$msg");
-       }
+       };
 
        writefile(basename($infile), File::Spec->tmpdir, $content)
-               or return failure("failed to write $infile");
+               or return $fail->(sprintf(gettext("failed to write %s"), $infile));
 
-       my $res = (system("msgfmt", "--check", $infile) == 0);
+       my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
 
        # Unlinking should happen automatically, thanks to File::Temp,
        # but it does not work here, probably because of the way writefile()
@@ -982,7 +1120,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");
 }
 
 # ,----