]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/po.pm
remove redundant use
[ikiwiki.git] / IkiWiki / Plugin / po.pm
index a050d2b71ce789b33fcfc7b494e5fe1255b60e74..659350ea01d05537481c684fbea4ca244105d875 100644 (file)
@@ -10,6 +10,7 @@ use warnings;
 use strict;
 use IkiWiki 3.00;
 use Encode;
+use Locale::Po4a::Common qw(nowrapi18n);
 use Locale::Po4a::Chooser;
 use Locale::Po4a::Po;
 use File::Basename;
@@ -39,7 +40,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);
@@ -69,7 +70,7 @@ sub import {
 # 2. Injected functions
 # 3. Blackboxes for private data
 # 4. Helper functions
-# 5. PageSpec's
+# 5. PageSpecs
 
 
 # ,----
@@ -249,8 +250,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 (@) {
@@ -265,7 +266,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));
@@ -286,13 +287,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
@@ -357,6 +358,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.
@@ -390,11 +427,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;
                }
@@ -428,7 +465,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.");
                }
@@ -491,17 +528,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");
                        }
                }
        }
@@ -622,8 +659,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($$) {
@@ -663,8 +700,9 @@ 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});
        return;
 }
@@ -680,18 +718,19 @@ 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
+       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);
@@ -705,7 +744,7 @@ sub istranslation ($) {
                $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
                return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
        }
-       return;
+       return "";
 }
 
 sub masterpage ($) {
@@ -729,7 +768,7 @@ sub lang ($) {
 sub islanguagecode ($) {
        my $code=shift;
 
-       return ($code =~ /^[a-z]{2}$/);
+       return $code =~ /^[a-z]{2}$/;
 }
 
 sub otherlanguage ($$) {
@@ -744,7 +783,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}}) {
@@ -803,9 +842,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));
@@ -941,7 +980,7 @@ sub deletetranslations ($) {
                }
        } @todelete;
 
-       if (scalar @todelete) {
+       if (@todelete) {
                commit_and_refresh(
                        gettext("removed obsolete PO files"),
                        "IkiWiki::Plugin::po::deletetranslations");
@@ -1077,13 +1116,10 @@ sub isvalidpo ($) {
 }
 
 # ,----
-# | PageSpec's
+# | PageSpecs
 # `----
 
 package IkiWiki::PageSpec;
-use warnings;
-use strict;
-use IkiWiki 2.00;
 
 sub match_istranslation ($;@) {
        my $page=shift;
@@ -1113,7 +1149,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 {