X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e6992480e2e0cf965650f84aa97e01fe0fa71544..d622da057be3fcd3c55ebf8f3651966f7dec668b:/IkiWiki/Plugin/po.pm?ds=inline diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm index 157575483..f25beba72 100644 --- a/IkiWiki/Plugin/po.pm +++ b/IkiWiki/Plugin/po.pm @@ -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; @@ -35,11 +36,10 @@ 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); - 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); @@ -54,8 +54,8 @@ 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); } @@ -67,7 +67,7 @@ sub import { # 2. Injected functions # 3. Blackboxes for private data # 4. Helper functions -# 5. PageSpec's +# 5. PageSpecs # ,---- @@ -116,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 () { @@ -159,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$/; } @@ -247,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 (@) { @@ -284,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 @@ -302,48 +291,41 @@ 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. + my @orig_torename; + @orig_torename=@{$session->param("po_orig_torename")} + if defined $session->param("po_orig_torename"); + push @orig_torename, $torename{src}; + $session->param(po_orig_torename => \@orig_torename); IkiWiki::cgi_savesession($session); - foreach my $rename (@torename) { - next unless istranslatable($rename->{src}); - my %otherpages=%{otherlanguages($rename->{src})}; - while (my ($lang, $otherpage) = each %otherpages) { - push @{$torename}, { - src => $otherpage, - srcfile => $pagesources{$otherpage}, - dest => otherlanguage($rename->{dest}, $lang), - destfile => $rename->{dest}.".".$lang.".po", - required => 0, - }; - } + return () unless istranslatable($torename{src}); + + my @ret; + my %otherpages=%{otherlanguages($torename{src})}; + while (my ($lang, $otherpage) = each %otherpages) { + push @ret, { + src => $otherpage, + srcfile => $pagesources{$otherpage}, + dest => otherlanguage($torename{dest}, $lang), + destfile => $torename{dest}.".".$lang.".po", + required => 0, + }; } + return @ret; } sub mydelete(@) { @@ -355,6 +337,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 +406,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; } @@ -403,19 +421,19 @@ sub cansave ($$$$) { 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}); @@ -426,7 +444,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 { $_ eq $masterpage } @{$orig_torename}) { return gettext("Can not rename a translation. Renaming the master page, ". "though, renames its translations as well."); } @@ -489,17 +507,12 @@ 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; - } - 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"); + $field->options(\@types) if @types; } } } @@ -587,16 +600,14 @@ sub myurlto ($$;$) { } } -sub mynicepagetitle ($;$) { - my ($page, $unescaped) = (shift, shift); +sub mycgiurl (@) { + my %params=@_; - 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).' %)'; + # slave pages have no subpages + if (istranslation($params{'from'})) { + $params{'from'} = masterpage($params{'from'}); + } + return $origsubs{'cgiurl'}->(%params); } # ,---- @@ -610,8 +621,8 @@ sub mynicepagetitle ($;$) { 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($$) { @@ -651,8 +662,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; } @@ -668,18 +680,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); @@ -693,7 +706,7 @@ sub istranslation ($) { $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang}; return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang); } - return; + return ""; } sub masterpage ($) { @@ -717,7 +730,7 @@ sub lang ($) { sub islanguagecode ($) { my $code=shift; - return ($code =~ /^[a-z]{2}$/); + return $code =~ /^[a-z]{2}$/; } sub otherlanguage ($$) { @@ -732,7 +745,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}}) { @@ -791,9 +804,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)); @@ -929,7 +942,7 @@ sub deletetranslations ($) { } } @todelete; - if (scalar @todelete) { + if (@todelete) { commit_and_refresh( gettext("removed obsolete PO files"), "IkiWiki::Plugin::po::deletetranslations"); @@ -1065,13 +1078,10 @@ sub isvalidpo ($) { } # ,---- -# | PageSpec's +# | PageSpecs # `---- package IkiWiki::PageSpec; -use warnings; -use strict; -use IkiWiki 2.00; sub match_istranslation ($;@) { my $page=shift; @@ -1101,7 +1111,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 {