]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
po/todo: take note of the commit that will need to be reverted later
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index 1955ac304fc0ce26a8150fdb12f81528321ba046..9a3df79ac2fd2498a56801c624f722a2f9d435b8 100644 (file)
@@ -10,16 +10,7 @@ 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::Common qw(nowrapi18n);
 use Locale::Po4a::Chooser;
 use Locale::Po4a::Po;
 use File::Basename;
@@ -45,7 +36,6 @@ sub import {
        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);
@@ -64,8 +54,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);
 }
@@ -79,7 +67,7 @@ sub import {
 # 2. Injected functions
 # 3. Blackboxes for private data
 # 4. Helper functions
-# 5. PageSpec's
+# 5. PageSpecs
 
 
 # ,----
@@ -128,13 +116,6 @@ 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 () {
@@ -171,10 +152,6 @@ 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$/;
 }
 
@@ -259,8 +236,8 @@ sub htmlize (@) {
 
        # force content to be htmlize'd as if it was the same type as the master page
        return IkiWiki::htmlize($page, $page,
-                               pagetype(srcfile($pagesources{masterpage($page)})),
-                               $content);
+               pagetype(srcfile($pagesources{masterpage($page)})),
+               $content);
 }
 
 sub pagetemplate (@) {
@@ -275,7 +252,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));
@@ -296,13 +273,13 @@ sub pagetemplate (@) {
        # 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"),
-                                                       ));
+                       $page,
+                       $destpage,
+                       $masterpage . '/' . gettext("Discussion"),
+                       noimageinline => 1,
+                       forcesubpage => 0,
+                       linktext => gettext("Discussion"),
+               ));
        }
        # Remove broken parentlink to ./index.html on home page's translations.
        # It works because this hook has the "last" parameter set, to ensure it
@@ -314,40 +291,31 @@ 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.
+       $session->param(po_orig_torename => \@torename);
        IkiWiki::cgi_savesession($session);
 
+       my @ret=@torename;
+       # iterate on @torename and push onto @ret, so that we don't iterate
+       # on the items we added ourselves
        foreach my $rename (@torename) {
                next unless istranslatable($rename->{src});
                my %otherpages=%{otherlanguages($rename->{src})};
                while (my ($lang, $otherpage) = each %otherpages) {
-                       push @{$torename}, {
+                       push @ret, {
                                src => $otherpage,
                                srcfile => $pagesources{$otherpage},
                                dest => otherlanguage($rename->{dest}, $lang),
@@ -356,6 +324,7 @@ sub renamepages($$$) {
                        };
                }
        }
+       return @ret;
 }
 
 sub mydelete(@) {
@@ -451,19 +420,19 @@ sub checkcontent (@) {
        return undef;
 }
 
-sub canremove ($$$) {
-       my ($page, $cgi, $session) = (shift, shift, shift);
+sub canremove (@) {
+       my %params = @_;
 
-       if (istranslation($page)) {
+       if (istranslation($params{page})) {
                return gettext("Can not remove a translation. Removing the master page, ".
                               "though, removes its translations 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});
@@ -544,11 +513,6 @@ sub formbuilder (@) {
                                my @types = grep { $_ ne 'po' } $field->options;
                                $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 selected - not implemented yet");
-                       }
                }
        }
 }
@@ -635,18 +599,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=@_;
 
@@ -668,8 +620,8 @@ sub mycgiurl (@) {
                my $page=shift;
                my $destpage=shift;
 
-               return exists $filtered{$page}{$destpage}
-                        && $filtered{$page}{$destpage} eq 1 );
+               return exists $filtered{$page}{$destpage}
+                        && $filtered{$page}{$destpage} eq 1;
        }
 
        sub setalreadyfiltered($$) {
@@ -777,7 +729,7 @@ sub lang ($) {
 sub islanguagecode ($) {
        my $code=shift;
 
-       return ($code =~ /^[a-z]{2}$/);
+       return $code =~ /^[a-z]{2}$/;
 }
 
 sub otherlanguage ($$) {
@@ -1125,13 +1077,10 @@ sub isvalidpo ($) {
 }
 
 # ,----
-# | PageSpec's
+# | PageSpecs
 # `----
 
 package IkiWiki::PageSpec;
-use warnings;
-use strict;
-use IkiWiki 2.00;
 
 sub match_istranslation ($;@) {
        my $page=shift;