X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f0e796d9a12d5f78fb89f312f138c1a0bb6f0141..f58cb48f1f5b718886109642ec2caed45709b5e7:/IkiWiki/Plugin/po.pm diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm index a8d9b9cd9..c8b5e8fde 100644 --- a/IkiWiki/Plugin/po.pm +++ b/IkiWiki/Plugin/po.pm @@ -8,7 +8,7 @@ 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; @@ -23,10 +23,11 @@ my %translations; my @origneedsbuild; my %origsubs; +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); @@ -34,8 +35,15 @@ 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 => "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); $origsubs{'bestlink'}=\&IkiWiki::bestlink; inject(name => "IkiWiki::bestlink", call => \&mybestlink); @@ -45,7 +53,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); +} # ,---- @@ -63,7 +73,7 @@ sub import { #{{{ # | Hooks # `---- -sub getsetup () { #{{{ +sub getsetup () { return plugin => { safe => 0, @@ -105,9 +115,16 @@ 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)); @@ -139,29 +156,34 @@ 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 # a given master page was rendered because its source file was changed @origneedsbuild=(@$needsbuild); + flushmemoizecache(); buildtranslationscache(); # make existing translations depend on the corresponding master page 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}; @@ -194,81 +216,39 @@ 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}; my $content = $params{content}; - my $masterfile = srcfile($pagesources{masterpage($page)}); + + # ignore PO files this plugin did not create + return $content unless istranslation($page); # force content to be htmlize'd as if it was the same type as the master page - return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content); -} #}}} + 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}; @@ -319,98 +299,194 @@ sub pagetemplate (@) { #{{{ } } # }}} -sub change(@) { #{{{ +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); + + # 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($_), @deleted; +} + +sub change(@) { my @rendered=@_; my $updated_po_files=0; # Refresh/create POT and PO files as needed. - foreach my $page (map pagename($_), @rendered) { - next unless istranslatable($page); - my $file=srcfile($pagesources{$page}); + foreach my $file (grep {istranslatablefile($_)} @rendered) { + my $page=pagename($file); + my $masterfile=srcfile($file); my $updated_pot_file=0; # Only refresh Pot file if it does not exist, or if # $pagesources{$page} was changed: don't if only the HTML was # refreshed, e.g. because of a dependency. if ((grep { $_ eq $pagesources{$page} } @origneedsbuild) - || ! -e potfile($file)) { - refreshpot($file); + || ! -e potfile($masterfile)) { + refreshpot($masterfile); $updated_pot_file=1; } my @pofiles; map { push @pofiles, $_ if ($updated_pot_file || ! -e $_); - } (pofiles($file)); + } (pofiles($masterfile)); if (@pofiles) { - refreshpofiles($file, @pofiles); - map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs}); + refreshpofiles($masterfile, @pofiles); + 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(); - # 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") && $form->field("do") eq "create"); + + my $template=template("pocreatepage.tmpl"); + $template->param(LANG => $config{po_master_language}{name}); + $form->tmpl_param(message => $template->output); +} # ,---- # | Injected functions # `---- -# Implement po_link_to=current -sub mybestlink ($$) { #{{{ +# Implement po_link_to 'current' and 'negotiated' settings. +sub mybestlink ($$) { my $page=shift; my $link=shift; - my $res=$origsubs{'bestlink'}->($page, $link); + my $res=$origsubs{'bestlink'}->(masterpage($page), $link); if (length $res - && $config{po_link_to} eq "current" + && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated") && istranslatable($res) && istranslation($page)) { return $res . "." . lang($page); } return $res; -} #}}} +} -sub mybeautify_urlpath ($) { #{{{ +sub mybeautify_urlpath ($) { my $url=shift; my $res=$origsubs{'beautify_urlpath'}->($url); if ($config{po_link_to} eq "negotiated") { $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!; + $res =~ s!/\Qindex.$config{htmlext}\E$!/!; + map { + $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!; + } (keys %{$config{po_slave_languages}}); } return $res; -} #}}} +} -sub mytargetpage ($$) { #{{{ +sub mytargetpage ($$) { my $page=shift; my $ext=shift; @@ -424,9 +500,9 @@ sub mytargetpage ($$) { #{{{ } } return $origsubs{'targetpage'}->($page, $ext); -} #}}} +} -sub myurlto ($$;$) { #{{{ +sub myurlto ($$;$) { my $to=shift; my $from=shift; my $absolute=shift; @@ -437,9 +513,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 @@ -448,56 +551,70 @@ 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; - } #}}} + } } - # ,---- # | Helper functions # `---- -sub istranslatable ($) { #{{{ - my $page=shift; +sub maybe_add_leading_slash ($;$) { + my $str=shift; + my $add=shift; + $add=1 unless defined $add; + return '/' . $str if $add; + return $str; +} - my $file=$pagesources{$page}; +sub istranslatablefile ($) { + my $file=shift; return 0 unless defined $file; return 0 if (defined pagetype($file) && pagetype($file) eq 'po'); return 0 if $file =~ /\.pot$/; - return pagespec_match($page, $config{po_translatable_pages}); -} #}}} + return 1 if pagespec_match(pagename($file), $config{po_translatable_pages}); + return; +} -sub _istranslation ($) { #{{{ +sub istranslatable ($) { my $page=shift; - my $file=$pagesources{$page}; + $page=~s#^/##; + return 1 if istranslatablefile($pagesources{$page}); + return; +} + +sub _istranslation ($) { + my $page=shift; + my $hasleadingslash = ($page=~s#^/##); + my $file=$pagesources{$page}; return 0 unless (defined $file && defined pagetype($file) && pagetype($file) eq 'po'); @@ -509,85 +626,91 @@ sub _istranslation ($) { #{{{ && defined $pagesources{$masterpage} && defined $config{po_slave_languages}{$lang}); - return ($masterpage, $lang) if istranslatable($masterpage); -} #}}} + 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))) { + my $hasleadingslash = ($masterpage=~s#^/##); $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang}; - return ($masterpage, $lang); + 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 otherlanguages($) { #{{{ +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 ($) { my $page=shift; my %ret; - if (istranslatable($page)) { - %ret = %{$translations{$page}}; - } - elsif (istranslation($page)) { - my $masterpage = masterpage($page); - $ret{$config{po_master_language}{code}} = $masterpage; - foreach my $lang (sort keys %{$translations{$masterpage}}) { - next if $lang eq lang($page); - $ret{$lang} = $translations{$masterpage}{$lang}; - } + return \%ret unless (istranslation($page) || istranslatable($page)); + my $curlang=lang($page); + foreach my $lang + ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) { + next if $lang eq $curlang; + $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); @@ -600,16 +723,15 @@ 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=@_; @@ -627,18 +749,24 @@ sub refreshpofiles ($@) { #{{{ or error("[po/refreshpofiles:$pofile] failed to copy the POT file"); } } -} #}}} +} -sub buildtranslationscache() { #{{{ +sub buildtranslationscache() { # use istranslation's side-effect map istranslation($_), (keys %pagesources); -} #}}} +} -sub resettranslationscache() { #{{{ +sub resettranslationscache() { undef %translations; -} #}}} +} + +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; @@ -647,32 +775,30 @@ 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"); my ($percent,$hit,$queries) = $doc->stats(); return $percent; -} #}}} +} -sub languagename ($) { #{{{ +sub languagename ($) { my $code=shift; return $config{po_master_language}{name} @@ -680,9 +806,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; @@ -698,7 +824,7 @@ sub otherlanguagesloop ($) { #{{{ } else { push @ret, { - url => urlto($otherpage, $page), + url => urlto_with_orig_beautiful_urlpath($otherpage, $page), code => $lang, language => languagename($lang), percent => percenttranslated($otherpage), @@ -710,13 +836,167 @@ 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); -} #}}} +} + +sub deletetranslations ($) { + my $deletedmasterfile=shift; + + 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}}; + + map { + if ($config{rcs}) { + IkiWiki::rcs_remove($_); + } + else { + IkiWiki::prune("$config{srcdir}/$_"); + } + } @todelete; + + 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; + + sub failure ($) { + 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 failure("failed to write $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 failure("failed to translate"); + $doc->write($outfile) or return failure("could not write $outfile"); + + $content = readfile($outfile) or return failure("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; + + 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; + + sub failure ($) { + my $msg = '[po/isvalidpo] ' . shift; + unlink $infile; + return IkiWiki::FailReason->new("$msg"); + } + + writefile(basename($infile), File::Spec->tmpdir, $content) + or return failure("failed to write $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 @@ -727,7 +1007,7 @@ use warnings; use strict; use IkiWiki 2.00; -sub match_istranslation ($;@) { #{{{ +sub match_istranslation ($;@) { my $page=shift; if (IkiWiki::Plugin::po::istranslation($page)) { @@ -736,9 +1016,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)) { @@ -747,9 +1027,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; @@ -761,9 +1041,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=@_; @@ -779,6 +1059,6 @@ sub match_currentlang ($$;@) { #{{{ else { return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang"); } -} #}}} +} 1