]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
po: make the "backlinks involve dependencies" feature optional
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index 91bf8872f24b4054f423f1f3944463db3f777553..6f716a91f2a741253141b998e30aed74eb3fc83b 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;
@@ -79,7 +70,7 @@ sub import {
 # 2. Injected functions
 # 3. Blackboxes for private data
 # 4. Helper functions
-# 5. PageSpec's
+# 5. PageSpecs
 
 
 # ,----
@@ -135,6 +126,13 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
+               po_strictly_refresh_backlinks => {
+                       type => "boolean",
+                       example => 1,
+                       description => "refresh a page when a backlinked page is changed (can hit performance)",
+                       safe => 1,
+                       rebuild => 1,
+               },
 }
 
 sub checkconfig () {
@@ -175,6 +173,10 @@ sub checkconfig () {
            ! defined $config{po_translation_status_in_links}) {
                $config{po_translation_status_in_links}=1;
        }
+       if (! exists $config{po_strictly_refresh_backlinks} ||
+           ! defined $config{po_strictly_refresh_backlinks}) {
+               $config{po_strictly_refresh_backlinks}=1;
+       }
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 }
 
@@ -259,8 +261,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 +277,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 +298,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
@@ -316,8 +318,10 @@ sub pagetemplate (@) {
 
 sub postscan (@) {
        my %params = @_;
-       my $page = $params{page};
 
+       return unless $config{po_strictly_refresh_backlinks};
+
+       my $page = $params{page};
        # backlinks involve back-dependencies, so that nicepagetitle effects,
        # such as translation status displayed in links, are updated
        use IkiWiki::Render;
@@ -451,19 +455,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 +548,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");
-                       }
                }
        }
 }
@@ -668,8 +667,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($$) {
@@ -709,7 +708,7 @@ sub istranslatablefile ($) {
        my $file=shift;
 
        return 0 unless defined $file;
-       return 0 if (defined pagetype($file) && pagetype($file) eq 'po');
+       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});
@@ -727,19 +726,19 @@ sub istranslatable ($) {
 sub _istranslation ($) {
        my $page=shift;
 
-       $page='' unless (defined $page && length $page);
+       $page='' unless defined $page && length $page;
        my $hasleadingslash = ($page=~s#^/##);
        my $file=$pagesources{$page};
-       return 0 unless (defined $file
+       return 0 unless defined $file
                         && defined pagetype($file)
-                        && pagetype($file) eq 'po');
+                        && pagetype($file) eq 'po';
        return 0 if $file =~ /\.pot$/;
 
        my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-       return 0 unless (defined $masterpage && defined $lang
+       return 0 unless defined $masterpage && defined $lang
                         && length $masterpage && length $lang
                         && defined $pagesources{$masterpage}
-                        && defined $config{po_slave_languages}{$lang});
+                        && defined $config{po_slave_languages}{$lang};
 
        return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
                if istranslatable($masterpage);
@@ -777,7 +776,7 @@ sub lang ($) {
 sub islanguagecode ($) {
        my $code=shift;
 
-       return ($code =~ /^[a-z]{2}$/);
+       return $code =~ /^[a-z]{2}$/;
 }
 
 sub otherlanguage ($$) {
@@ -792,7 +791,7 @@ sub otherlanguages ($) {
        my $page=shift;
 
        my %ret;
-       return \%ret unless (istranslation($page) || istranslatable($page));
+       return \%ret unless istranslation($page) || istranslatable($page);
        my $curlang=lang($page);
        foreach my $lang
                ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
@@ -1125,13 +1124,10 @@ sub isvalidpo ($) {
 }
 
 # ,----
-# | PageSpec's
+# | PageSpecs
 # `----
 
 package IkiWiki::PageSpec;
-use warnings;
-use strict;
-use IkiWiki 2.00;
 
 sub match_istranslation ($;@) {
        my $page=shift;
@@ -1161,7 +1157,7 @@ sub match_lang ($$;@) {
 
        my $regexp=IkiWiki::glob2re($wanted);
        my $lang=IkiWiki::Plugin::po::lang($page);
-       if ($lang!~/^$regexp$/i) {
+       if ($lang !~ /^$regexp$/i) {
                return IkiWiki::FailReason->new("file language is $lang, not $wanted");
        }
        else {