X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/5eed0fd97d3f1abcfce3288df9aeeed50967757c..da26603e0780b3079ee8e94ec3651fdc615cc3f9:/IkiWiki/Plugin/po.pm diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm index ae97a2f38..7cec589ab 100644 --- a/IkiWiki/Plugin/po.pm +++ b/IkiWiki/Plugin/po.pm @@ -1,14 +1,14 @@ #!/usr/bin/perl # .po as a wiki page type # Licensed under GPL v2 or greater -# Copyright (C) 2008 intrigeri +# Copyright (C) 2008-2009 intrigeri # 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; use Locale::Po4a::Chooser; use Locale::Po4a::Po; @@ -27,7 +27,7 @@ memoize("istranslatable"); memoize("_istranslation"); memoize("percenttranslated"); -sub import { #{{{ +sub import { hook(type => "getsetup", id => "po", call => \&getsetup); hook(type => "checkconfig", id => "po", call => \&checkconfig); hook(type => "needsbuild", id => "po", call => \&needsbuild); @@ -35,10 +35,16 @@ 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 => "renamepage", id => "po", call => \&renamepage); + 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 => "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); @@ -48,7 +54,9 @@ 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); +} # ,---- @@ -66,7 +74,7 @@ sub import { #{{{ # | Hooks # `---- -sub getsetup () { #{{{ +sub getsetup () { return plugin => { safe => 0, @@ -108,16 +116,24 @@ 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 () { #{{{ +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($_) @@ -142,10 +158,14 @@ 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$/; -} #}}} +} -sub needsbuild () { #{{{ +sub needsbuild () { my $needsbuild=shift; # backup @needsbuild content so that change() can know whether @@ -159,13 +179,13 @@ sub needsbuild () { #{{{ foreach my $master (keys %translations) { map add_depends($_, $master), values %{otherlanguages($master)}; } -} #}}} +} # Massage the recorded state of internal links so that: # - it matches the actually generated links, rather than the links as written # in the pages' source # - backlinks are consistent in all cases -sub scan (@) { #{{{ +sub scan (@) { my %params=@_; my $page=$params{page}; my $content=$params{content}; @@ -198,70 +218,24 @@ sub scan (@) { #{{{ } } } -} #}}} +} # We use filter to convert PO to the master page's format, # since the rest of ikiwiki should not work on PO files. -sub filter (@) { #{{{ +sub filter (@) { my %params = @_; my $page = $params{page}; my $destpage = $params{destpage}; - my $content = decode_utf8(encode_utf8($params{content})); - - return $content if ( ! istranslation($page) - || alreadyfiltered($page, $destpage) ); - - # CRLF line terminators make poor Locale::Po4a feel bad - $content=~s/\r\n/\n/g; - - # Implementation notes - # - # 1. Locale::Po4a reads/writes from/to files, and I'm too lazy - # to learn how to disguise a variable as a file. - # 2. There are incompatibilities between some File::Temp versions - # (including 0.18, bundled with Lenny's perl-modules package) - # and others (e.g. 0.20, previously present in the archive as - # a standalone package): under certain circumstances, some - # return a relative filename, whereas others return an absolute one; - # we here use this module in a way that is at least compatible - # with 0.18 and 0.20. Beware, hit'n'run refactorers! - my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX", - DIR => File::Spec->tmpdir, - UNLINK => 1)->filename; - my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX", - DIR => File::Spec->tmpdir, - UNLINK => 1)->filename; - - writefile(basename($infile), File::Spec->tmpdir, $content); - - my $masterfile = srcfile($pagesources{masterpage($page)}); - my (@pos,@masters); - push @pos,$infile; - push @masters,$masterfile; - my %options = ( - "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0, - ); - my $doc=Locale::Po4a::Chooser::new('text',%options); - $doc->process( - 'po_in_name' => \@pos, - 'file_in_name' => \@masters, - 'file_in_charset' => 'utf-8', - 'file_out_charset' => 'utf-8', - ) or error("[po/filter:$page]: failed to translate"); - $doc->write($outfile) or error("[po/filter:$page] could not write $outfile"); - $content = readfile($outfile) or error("[po/filter:$page] could not read $outfile"); - - # Unlinking should happen automatically, thanks to File::Temp, - # but it does not work here, probably because of the way writefile() - # and Locale::Po4a::write() work. - unlink $infile, $outfile; - - setalreadyfiltered($page, $destpage); + my $content = $params{content}; + if (istranslation($page) && ! alreadyfiltered($page, $destpage)) { + $content = po_to_markup($page, $content); + setalreadyfiltered($page, $destpage); + } return $content; -} #}}} +} -sub htmlize (@) { #{{{ +sub htmlize (@) { my %params=@_; my $page = $params{page}; @@ -274,9 +248,9 @@ sub htmlize (@) { #{{{ return IkiWiki::htmlize($page, $page, pagetype(srcfile($pagesources{masterpage($page)})), $content); -} #}}} +} -sub pagetemplate (@) { #{{{ +sub pagetemplate (@) { my %params=@_; my $page=$params{page}; my $destpage=$params{destpage}; @@ -327,49 +301,63 @@ sub pagetemplate (@) { #{{{ } } # }}} -# Save information about master page rename, so that: -# - our delete hook can ignore the translations not renamed already -# - our change hook can rename the translations accordingly. -# -# FIXME: -# This hook is called once per page linking to the old page, which -# means our delete hook won't know it should not delete a renamed orphan -# page's translation. -# -# Moreover, we can't recognize such pages at delete stage: -# existing links are fixed in the renaming process, so every -# renamed page's old location will be an orphan anyway at this time. -sub renamepage(@) { #{{{ - my %params=@_; - my $oldpage=$params{oldpage}; - my $newpage=$params{newpage}; +sub postscan (@) { + my %params = @_; + my $page = $params{page}; - setrenamed($oldpage, $newpage) if istranslatable($oldpage); - return $params{content}; -} #}}} + # 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}}; +} -sub mydelete(@) { #{{{ +# Add the renamed page translations to the list of to-be-renamed pages. +sub renamepages($$$) { + my ($torename, $cgi, $session) = (shift, shift, shift); + + # 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}; + + # 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 ]); + 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, + }; + } + } +} + +sub mydelete(@) { my @deleted=@_; - map { - deletetranslations($_); - } grep { istranslatablefile($_) && ! renamed(pagename($_))} @deleted; -} #}}} + map { deletetranslations($_) } grep istranslatablefile($_), @deleted; +} -sub change(@) { #{{{ +sub change(@) { my @rendered=@_; - my $eachrenamed=eachrenamed(); - while (my ($oldpage, $newpage) = $eachrenamed->()) { - renametranslations($oldpage, $newpage); - } - resetrenamed(); - my $updated_po_files=0; # Refresh/create POT and PO files as needed. - foreach my $file (@rendered) { - next unless istranslatablefile($file); + foreach my $file (grep {istranslatablefile($_)} @rendered) { my $page=pagename($file); my $masterfile=srcfile($file); my $updated_pot_file=0; @@ -387,51 +375,137 @@ sub change(@) { #{{{ } (pofiles($masterfile)); if (@pofiles) { refreshpofiles($masterfile, @pofiles); - map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs}); + map { IkiWiki::rcs_add($_) } @pofiles if $config{rcs}; $updated_po_files=1; } } if ($updated_po_files) { - # Check staged changes in. - if ($config{rcs}) { - IkiWiki::disable_commit_hook(); - IkiWiki::rcs_commit_staged(gettext("updated PO files"), - "IkiWiki::Plugin::po::change", "127.0.0.1"); - IkiWiki::enable_commit_hook(); - IkiWiki::rcs_update(); + commit_and_refresh( + gettext("updated PO files"), + "IkiWiki::Plugin::po::change"); + } +} + +sub cansave ($$$$) { + my ($page, $content, $cgi, $session) = (shift, shift, shift, shift); + + if (istranslation($page)) { + my $res = isvalidpo($content); + if ($res) { + return undef; + } + else { + return "$res"; + } + } + return undef; +} + +sub canremove ($$$) { + my ($page, $cgi, $session) = (shift, shift, shift); + + if (istranslation($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); + my %params = @_; + + if (istranslation($params{src})) { + my $masterpage = masterpage($params{src}); + # Tell the difference between: + # - a translation being renamed as a consequence of its master page + # being renamed, which is allowed + # - a user trying to directly rename a translation, which is forbidden + # 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}) { + return gettext("Can not rename a translation. Renaming the master page, ". + "though, renames its translations as well."); } - # Reinitialize module's private variables. - resetalreadyfiltered(); - resettranslationscache(); - flushmemoizecache(); - # Trigger a wiki refresh. - require IkiWiki::Render; - # without preliminary saveindex/loadindex, refresh() - # complains about a lot of uninitialized variables - IkiWiki::saveindex(); - IkiWiki::loadindex(); - IkiWiki::refresh(); - IkiWiki::saveindex(); - } -} #}}} + } + return undef; +} # As we're previewing or saving a page, the content may have # changed, so tell the next filter() invocation it must not be lazy. -sub editcontent () { #{{{ +sub editcontent () { my %params=@_; unsetalreadyfiltered($params{page}, $params{page}); 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); + } + } +} + +# 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. +sub formbuilder (@) { + my %params=@_; + my $form=$params{form}; + my $q=$params{cgi}; + + return unless (defined $form->field("do") && $form->field("do") eq "create"); + + for my $field ($form->field) { + next unless "$field" eq "type"; + if ($field->type eq 'select') { + # remove po from the types list + 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 sprintf("po(formbuilder) type field is not select - not implemented yet"); + } + } +} # ,---- # | Injected functions # `---- # Implement po_link_to 'current' and 'negotiated' settings. -sub mybestlink ($$) { #{{{ +sub mybestlink ($$) { my $page=shift; my $link=shift; @@ -443,9 +517,9 @@ sub mybestlink ($$) { #{{{ return $res . "." . lang($page); } return $res; -} #}}} +} -sub mybeautify_urlpath ($) { #{{{ +sub mybeautify_urlpath ($) { my $url=shift; my $res=$origsubs{'beautify_urlpath'}->($url); @@ -457,9 +531,9 @@ sub mybeautify_urlpath ($) { #{{{ } (keys %{$config{po_slave_languages}}); } return $res; -} #}}} +} -sub mytargetpage ($$) { #{{{ +sub mytargetpage ($$) { my $page=shift; my $ext=shift; @@ -473,9 +547,9 @@ sub mytargetpage ($$) { #{{{ } } return $origsubs{'targetpage'}->($page, $ext); -} #}}} +} -sub myurlto ($$;$) { #{{{ +sub myurlto ($$;$) { my $to=shift; my $from=shift; my $absolute=shift; @@ -486,9 +560,36 @@ sub myurlto ($$;$) { #{{{ && istranslatable('index')) { return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}"); } - return $origsubs{'urlto'}->($to,$from,$absolute); -} #}}} + # avoid using our injected beautify_urlpath if run by cgi_editpage, + # so that one is redirected to the just-edited page rather than to the + # negociated translation; to prevent unnecessary fiddling with caller/inject, + # we only do so when our beautify_urlpath would actually do what we want to + # avoid, i.e. when po_link_to = negotiated + if ($config{po_link_to} eq "negotiated") { + my @caller = caller(1); + my $run_by_editpage = 0; + $run_by_editpage = 1 if (exists $caller[3] && defined $caller[3] + && $caller[3] eq "IkiWiki::cgi_editpage"); + inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'}) + if $run_by_editpage; + my $res = $origsubs{'urlto'}->($to,$from,$absolute); + inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath) + if $run_by_editpage; + return $res; + } + else { + return $origsubs{'urlto'}->($to,$from,$absolute) + } +} + +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}; + return $res.' ('.percenttranslated($page).' %)'; +} # ,---- # | Blackboxes for private data @@ -497,77 +598,48 @@ sub myurlto ($$;$) { #{{{ { my %filtered; - sub alreadyfiltered($$) { #{{{ + sub alreadyfiltered($$) { my $page=shift; my $destpage=shift; return ( exists $filtered{$page}{$destpage} && $filtered{$page}{$destpage} eq 1 ); - } #}}} + } - sub setalreadyfiltered($$) { #{{{ + sub setalreadyfiltered($$) { my $page=shift; my $destpage=shift; $filtered{$page}{$destpage}=1; - } #}}} + } - sub unsetalreadyfiltered($$) { #{{{ + sub unsetalreadyfiltered($$) { my $page=shift; my $destpage=shift; if (exists $filtered{$page}{$destpage}) { delete $filtered{$page}{$destpage}; } - } #}}} + } - sub resetalreadyfiltered() { #{{{ + sub resetalreadyfiltered() { undef %filtered; - } #}}} -} - -{ - my %renamed; - - sub renamed ($) { #{{{ - my $page=shift; - - if (exists $renamed{$page} && - defined $renamed{$page}) { - return $renamed{$page}; - } - return; - } #}}} - - sub setrenamed ($$) { #{{{ - my $oldpage=shift; - my $newpage=shift; - - $renamed{$oldpage}=$newpage; - } #}}} - - sub resetrenamed () { #{{{ - undef %renamed; - } #}}} - - sub eachrenamed () { #{{{ - return sub { each %renamed }; - } #}}} + } } # ,---- # | Helper functions # `---- -sub maybe_add_leading_slash ($;$) { #{{{ +sub maybe_add_leading_slash ($;$) { my $str=shift; my $add=shift; $add=1 unless defined $add; return '/' . $str if $add; return $str; -} #}}} +} -sub istranslatablefile ($) { #{{{ +sub istranslatablefile ($) { my $file=shift; return 0 unless defined $file; @@ -575,17 +647,17 @@ sub istranslatablefile ($) { #{{{ return 0 if $file =~ /\.pot$/; return 1 if pagespec_match(pagename($file), $config{po_translatable_pages}); return; -} #}}} +} -sub istranslatable ($) { #{{{ +sub istranslatable ($) { my $page=shift; $page=~s#^/##; return 1 if istranslatablefile($pagesources{$page}); return; -} #}}} +} -sub _istranslation ($) { #{{{ +sub _istranslation ($) { my $page=shift; my $hasleadingslash = ($page=~s#^/##); @@ -603,9 +675,9 @@ sub _istranslation ($) { #{{{ return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang) if istranslatable($masterpage); -} #}}} +} -sub istranslation ($) { #{{{ +sub istranslation ($) { my $page=shift; if (1 < (my ($masterpage, $lang) = _istranslation($page))) { @@ -614,41 +686,41 @@ sub istranslation ($) { #{{{ return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang); } return; -} #}}} +} -sub masterpage ($) { #{{{ +sub masterpage ($) { my $page=shift; if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) { return $masterpage; } return $page; -} #}}} +} -sub lang ($) { #{{{ +sub lang ($) { my $page=shift; if (1 < (my ($masterpage, $lang) = _istranslation($page))) { return $lang; } return $config{po_master_language}{code}; -} #}}} +} -sub islanguagecode ($) { #{{{ +sub islanguagecode ($) { my $code=shift; return ($code =~ /^[a-z]{2}$/); -} #}}} +} -sub otherlanguage ($$) { #{{{ +sub otherlanguage ($$) { my $page=shift; my $code=shift; return masterpage($page) if $code eq $config{po_master_language}{code}; return masterpage($page) . '.' . $code; -} #}}} +} -sub otherlanguages ($) { #{{{ +sub otherlanguages ($) { my $page=shift; my %ret; @@ -660,32 +732,32 @@ sub otherlanguages ($) { #{{{ $ret{$lang}=otherlanguage($page, $lang); } return \%ret; -} #}}} +} -sub potfile ($) { #{{{ +sub potfile ($) { my $masterfile=shift; (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); $dir='' if $dir eq './'; return File::Spec->catpath('', $dir, $name . ".pot"); -} #}}} +} -sub pofile ($$) { #{{{ +sub pofile ($$) { my $masterfile=shift; my $lang=shift; (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); $dir='' if $dir eq './'; return File::Spec->catpath('', $dir, $name . "." . $lang . ".po"); -} #}}} +} -sub pofiles ($) { #{{{ +sub pofiles ($) { my $masterfile=shift; return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}}); -} #}}} +} -sub refreshpot ($) { #{{{ +sub refreshpot ($) { my $masterfile=shift; my $potfile=potfile($masterfile); @@ -698,51 +770,54 @@ sub refreshpot ($) { #{{{ # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po; # this is undocument use of internal Locale::Po4a::TransTractor's data, # compulsory since this module prevents us from using the porefs option. - my %po_options = ('porefs' => 'none'); - $doc->{TT}{po_out}=Locale::Po4a::Po->new(\%po_options); + $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' }); $doc->{TT}{po_out}->set_charset('utf-8'); # do the actual work $doc->parse; IkiWiki::prep_writefile(basename($potfile),dirname($potfile)); $doc->writepo($potfile); -} #}}} +} -sub refreshpofiles ($@) { #{{{ +sub refreshpofiles ($@) { my $masterfile=shift; my @pofiles=@_; my $potfile=potfile($masterfile); - error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile); + (-e $potfile) + or error(sprintf(gettext("po(refreshpofiles) 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(sprintf(gettext("po(refreshpofiles) failed to update %s"), + $pofile)); } else { File::Copy::syscopy($potfile,$pofile) - or error("[po/refreshpofiles:$pofile] failed to copy the POT file"); + or error(sprintf(gettext("po(refreshpofiles) failed to copy the POT file to %s"), + $pofile)); } } -} #}}} +} -sub buildtranslationscache() { #{{{ +sub buildtranslationscache() { # use istranslation's side-effect map istranslation($_), (keys %pagesources); -} #}}} +} -sub resettranslationscache() { #{{{ +sub resettranslationscache() { undef %translations; -} #}}} +} -sub flushmemoizecache() { #{{{ +sub flushmemoizecache() { Memoize::flush_cache("istranslatable"); Memoize::flush_cache("_istranslation"); Memoize::flush_cache("percenttranslated"); -} #}}} +} -sub urlto_with_orig_beautiful_urlpath($$) { #{{{ +sub urlto_with_orig_beautiful_urlpath($$) { my $to=shift; my $from=shift; @@ -751,32 +826,32 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{ inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath); return $res; -} #}}} +} -sub percenttranslated ($) { #{{{ +sub percenttranslated ($) { my $page=shift; + $page=~s/^\///; return gettext("N/A") unless istranslation($page); my $file=srcfile($pagesources{$page}); my $masterfile = srcfile($pagesources{masterpage($page)}); - my (@pos,@masters); - push @pos,$file; - push @masters,$masterfile; my %options = ( "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0, ); my $doc=Locale::Po4a::Chooser::new('text',%options); $doc->process( - 'po_in_name' => \@pos, - 'file_in_name' => \@masters, + 'po_in_name' => [ $file ], + 'file_in_name' => [ $masterfile ], 'file_in_charset' => 'utf-8', 'file_out_charset' => 'utf-8', - ) or error("[po/percenttranslated:$page]: failed to translate"); + ) or error(sprintf(gettext("po(percenttranslated) failed to translate %s"), + $page)); my ($percent,$hit,$queries) = $doc->stats(); + $percent =~ s/\.[0-9]+$//; return $percent; -} #}}} +} -sub languagename ($) { #{{{ +sub languagename ($) { my $code=shift; return $config{po_master_language}{name} @@ -784,9 +859,9 @@ sub languagename ($) { #{{{ return $config{po_slave_languages}{$code} if defined $config{po_slave_languages}{$code}; return; -} #}}} +} -sub otherlanguagesloop ($) { #{{{ +sub otherlanguagesloop ($) { my $page=shift; my @ret; @@ -814,29 +889,169 @@ sub otherlanguagesloop ($) { #{{{ return 1 if $b->{code} eq $config{po_master_language}{code}; return $a->{language} cmp $b->{language}; } @ret; -} #}}} +} -sub homepageurl (;$) { #{{{ +sub homepageurl (;$) { my $page=shift; return urlto('', $page); -} #}}} +} -# - do *not* implement this until the renamepage hook works -# - do *not* delete translations of pages that were orphans -# before being renamed (see renamepage hook comments above) -sub deletetranslations ($) { #{{{ +sub deletetranslations ($) { my $deletedmasterfile=shift; - debug "po(deletetranslations): TODO: delete translations of $deletedmasterfile"; -} #}}} + my $deletedmasterpage=pagename($deletedmasterfile); + my @todelete; + map { + my $file = newpagefile($deletedmasterpage.'.'.$_, 'po'); + my $absfile = "$config{srcdir}/$file"; + if (-e $absfile && ! -l $absfile && ! -d $absfile) { + push @todelete, $file; + } + } keys %{$config{po_slave_languages}}; -sub renametranslations (@) { #{{{ - my ($oldpage, $newpage)=shift; + map { + if ($config{rcs}) { + IkiWiki::rcs_remove($_); + } + else { + IkiWiki::prune("$config{srcdir}/$_"); + } + } @todelete; - debug "po(renametranslations): TODO: rename translations of $oldpage to $newpage"; -} #}}} + if (scalar @todelete) { + commit_and_refresh( + gettext("removed obsolete PO files"), + "IkiWiki::Plugin::po::deletetranslations"); + } +} +sub commit_and_refresh ($$) { + my ($msg, $author) = (shift, shift); + + if ($config{rcs}) { + IkiWiki::disable_commit_hook(); + IkiWiki::rcs_commit_staged($msg, $author, "127.0.0.1"); + IkiWiki::enable_commit_hook(); + IkiWiki::rcs_update(); + } + # Reinitialize module's private variables. + resetalreadyfiltered(); + resettranslationscache(); + flushmemoizecache(); + # Trigger a wiki refresh. + require IkiWiki::Render; + # without preliminary saveindex/loadindex, refresh() + # complains about a lot of uninitialized variables + IkiWiki::saveindex(); + IkiWiki::loadindex(); + IkiWiki::refresh(); + IkiWiki::saveindex(); +} + +# on success, returns the filtered content. +# on error, if $nonfatal, warn and return undef; else, error out. +sub po_to_markup ($$;$) { + my ($page, $content) = (shift, shift); + my $nonfatal = shift; + + $content = '' unless defined $content; + $content = decode_utf8(encode_utf8($content)); + # CRLF line terminators make poor Locale::Po4a feel bad + $content=~s/\r\n/\n/g; + + # There are incompatibilities between some File::Temp versions + # (including 0.18, bundled with Lenny's perl-modules package) + # and others (e.g. 0.20, previously present in the archive as + # a standalone package): under certain circumstances, some + # return a relative filename, whereas others return an absolute one; + # we here use this module in a way that is at least compatible + # with 0.18 and 0.20. Beware, hit'n'run refactorers! + my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX", + DIR => File::Spec->tmpdir, + UNLINK => 1)->filename; + my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX", + DIR => File::Spec->tmpdir, + UNLINK => 1)->filename; + + 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 $fail->(sprintf(gettext("failed to write %s"), $infile)); + + my $masterfile = srcfile($pagesources{masterpage($page)}); + my %options = ( + "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0, + ); + my $doc=Locale::Po4a::Chooser::new('text',%options); + $doc->process( + 'po_in_name' => [ $infile ], + 'file_in_name' => [ $masterfile ], + 'file_in_charset' => 'utf-8', + 'file_out_charset' => 'utf-8', + ) 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 $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() + # and Locale::Po4a::write() work. + unlink $infile, $outfile; + + return $content; +} + +# returns a SuccessReason or FailReason object +sub isvalidpo ($) { + my $content = shift; + + # NB: we don't use po_to_markup here, since Po4a parser does + # not mind invalid PO content + $content = '' unless defined $content; + $content = decode_utf8(encode_utf8($content)); + + # There are incompatibilities between some File::Temp versions + # (including 0.18, bundled with Lenny's perl-modules package) + # and others (e.g. 0.20, previously present in the archive as + # a standalone package): under certain circumstances, some + # return a relative filename, whereas others return an absolute one; + # we here use this module in a way that is at least compatible + # with 0.18 and 0.20. Beware, hit'n'run refactorers! + my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX", + DIR => File::Spec->tmpdir, + UNLINK => 1)->filename; + + my $fail = sub ($) { + my $msg = '[po/isvalidpo] ' . shift; + unlink $infile; + return IkiWiki::FailReason->new("$msg"); + }; + + writefile(basename($infile), File::Spec->tmpdir, $content) + or return $fail->(sprintf(gettext("failed to write %s"), $infile)); + + 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() + # and Locale::Po4a::write() work. + unlink $infile; + + if ($res) { + return IkiWiki::SuccessReason->new("valid gettext data"); + } + return IkiWiki::FailReason->new("invalid gettext data"); +} # ,---- # | PageSpec's @@ -847,7 +1062,7 @@ use warnings; use strict; use IkiWiki 2.00; -sub match_istranslation ($;@) { #{{{ +sub match_istranslation ($;@) { my $page=shift; if (IkiWiki::Plugin::po::istranslation($page)) { @@ -856,9 +1071,9 @@ sub match_istranslation ($;@) { #{{{ else { return IkiWiki::FailReason->new("is not a translation page"); } -} #}}} +} -sub match_istranslatable ($;@) { #{{{ +sub match_istranslatable ($;@) { my $page=shift; if (IkiWiki::Plugin::po::istranslatable($page)) { @@ -867,9 +1082,9 @@ sub match_istranslatable ($;@) { #{{{ else { return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages"); } -} #}}} +} -sub match_lang ($$;@) { #{{{ +sub match_lang ($$;@) { my $page=shift; my $wanted=shift; @@ -881,9 +1096,9 @@ sub match_lang ($$;@) { #{{{ else { return IkiWiki::SuccessReason->new("file language is $wanted"); } -} #}}} +} -sub match_currentlang ($$;@) { #{{{ +sub match_currentlang ($$;@) { my $page=shift; shift; my %params=@_; @@ -899,6 +1114,6 @@ sub match_currentlang ($$;@) { #{{{ else { return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang"); } -} #}}} +} 1