Merge commit 'intrigeri/po' into po
commit
0d1593a201
|
@ -17,25 +17,20 @@ use File::Copy;
|
|||
use File::Spec;
|
||||
use File::Temp;
|
||||
use Memoize;
|
||||
use UNIVERSAL;
|
||||
|
||||
my %translations;
|
||||
my @origneedsbuild;
|
||||
our %filtered;
|
||||
my %origsubs;
|
||||
|
||||
memoize("_istranslation");
|
||||
memoize("percenttranslated");
|
||||
# FIXME: memoizing istranslatable() makes some test cases fail once every
|
||||
# two tries; this may be related to the artificial way the testsuite is
|
||||
# run, or not.
|
||||
# memoize("istranslatable");
|
||||
|
||||
# backup references to subs that will be overriden
|
||||
my %origsubs;
|
||||
|
||||
sub import { #{{{
|
||||
hook(type => "getsetup", id => "po", call => \&getsetup);
|
||||
hook(type => "checkconfig", id => "po", call => \&checkconfig);
|
||||
hook(type => "needsbuild", id => "po", call => \&needsbuild);
|
||||
hook(type => "scan", id => "po", call => \&scan, last =>1);
|
||||
hook(type => "filter", id => "po", call => \&filter);
|
||||
hook(type => "htmlize", id => "po", call => \&htmlize);
|
||||
hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
|
||||
|
@ -48,13 +43,31 @@ sub import { #{{{
|
|||
inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
|
||||
$origsubs{'targetpage'}=\&IkiWiki::targetpage;
|
||||
inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
|
||||
$origsubs{'urlto'}=\&IkiWiki::urlto;
|
||||
inject(name => "IkiWiki::urlto", call => \&myurlto);
|
||||
} #}}}
|
||||
|
||||
|
||||
# ,----
|
||||
# | Table of contents
|
||||
# `----
|
||||
|
||||
# 1. Hooks
|
||||
# 2. Injected functions
|
||||
# 3. Blackboxes for private data
|
||||
# 4. Helper functions
|
||||
# 5. PageSpec's
|
||||
|
||||
|
||||
# ,----
|
||||
# | Hooks
|
||||
# `----
|
||||
|
||||
sub getsetup () { #{{{
|
||||
return
|
||||
plugin => {
|
||||
safe => 0,
|
||||
rebuild => 1, # format plugin & changes html filenames
|
||||
rebuild => 1,
|
||||
},
|
||||
po_master_language => {
|
||||
type => "string",
|
||||
|
@ -94,11 +107,6 @@ sub getsetup () { #{{{
|
|||
},
|
||||
} #}}}
|
||||
|
||||
sub islanguagecode ($) { #{{{
|
||||
my $code=shift;
|
||||
return ($code =~ /^[a-z]{2}$/);
|
||||
} #}}}
|
||||
|
||||
sub checkconfig () { #{{{
|
||||
foreach my $field (qw{po_master_language po_slave_languages}) {
|
||||
if (! exists $config{$field} || ! defined $config{$field}) {
|
||||
|
@ -134,6 +142,428 @@ sub checkconfig () { #{{{
|
|||
push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
|
||||
} #}}}
|
||||
|
||||
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);
|
||||
|
||||
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 (@) { #{{{
|
||||
my %params=@_;
|
||||
my $page=$params{page};
|
||||
my $content=$params{content};
|
||||
|
||||
return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
|
||||
|
||||
if (istranslation($page)) {
|
||||
foreach my $destpage (@{$links{$page}}) {
|
||||
if (istranslatable($destpage)) {
|
||||
# replace one occurence of $destpage in $links{$page}
|
||||
# (we only want to replace the one that was added by
|
||||
# IkiWiki::Plugin::link::scan, other occurences may be
|
||||
# there for other reasons)
|
||||
for (my $i=0; $i<@{$links{$page}}; $i++) {
|
||||
if (@{$links{$page}}[$i] eq $destpage) {
|
||||
@{$links{$page}}[$i] = $destpage . '.' . lang($page);
|
||||
last;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
elsif (! istranslatable($page) && ! istranslation($page)) {
|
||||
foreach my $destpage (@{$links{$page}}) {
|
||||
if (istranslatable($destpage)) {
|
||||
# make sure any destpage's translations has
|
||||
# $page in its backlinks
|
||||
push @{$links{$page}},
|
||||
values %{otherlanguages($destpage)};
|
||||
}
|
||||
}
|
||||
}
|
||||
} #}}}
|
||||
|
||||
# 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 (@) { #{{{
|
||||
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);
|
||||
return $content;
|
||||
} #}}}
|
||||
|
||||
sub htmlize (@) { #{{{
|
||||
my %params=@_;
|
||||
|
||||
my $page = $params{page};
|
||||
my $content = $params{content};
|
||||
my $masterfile = srcfile($pagesources{masterpage($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);
|
||||
} #}}}
|
||||
|
||||
sub pagetemplate (@) { #{{{
|
||||
my %params=@_;
|
||||
my $page=$params{page};
|
||||
my $destpage=$params{destpage};
|
||||
my $template=$params{template};
|
||||
|
||||
my ($masterpage, $lang) = istranslation($page);
|
||||
|
||||
if (istranslation($page) && $template->query(name => "percenttranslated")) {
|
||||
$template->param(percenttranslated => percenttranslated($page));
|
||||
}
|
||||
if ($template->query(name => "istranslation")) {
|
||||
$template->param(istranslation => scalar istranslation($page));
|
||||
}
|
||||
if ($template->query(name => "istranslatable")) {
|
||||
$template->param(istranslatable => istranslatable($page));
|
||||
}
|
||||
if ($template->query(name => "HOMEPAGEURL")) {
|
||||
$template->param(homepageurl => homepageurl($page));
|
||||
}
|
||||
if ($template->query(name => "otherlanguages")) {
|
||||
$template->param(otherlanguages => [otherlanguagesloop($page)]);
|
||||
map add_depends($page, $_), (values %{otherlanguages($page)});
|
||||
}
|
||||
# Rely on IkiWiki::Render's genpage() to decide wether
|
||||
# a discussion link should appear on $page; this is not
|
||||
# totally accurate, though: some broken links may be generated
|
||||
# when cgiurl is disabled.
|
||||
# This compromise avoids some code duplication, and will probably
|
||||
# prevent future breakage when ikiwiki internals change.
|
||||
# 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"),
|
||||
));
|
||||
}
|
||||
# Remove broken parentlink to ./index.html on home page's translations.
|
||||
# It works because this hook has the "last" parameter set, to ensure it
|
||||
# runs after parentlinks' own pagetemplate hook.
|
||||
if ($template->param('parentlinks')
|
||||
&& istranslation($page)
|
||||
&& $masterpage eq "index") {
|
||||
$template->param('parentlinks' => []);
|
||||
}
|
||||
} # }}}
|
||||
|
||||
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});
|
||||
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);
|
||||
$updated_pot_file=1;
|
||||
}
|
||||
my @pofiles;
|
||||
map {
|
||||
push @pofiles, $_ if ($updated_pot_file || ! -e $_);
|
||||
} (pofiles($file));
|
||||
if (@pofiles) {
|
||||
refreshpofiles($file, @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();
|
||||
}
|
||||
# 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();
|
||||
}
|
||||
} #}}}
|
||||
|
||||
# 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 () { #{{{
|
||||
my %params=@_;
|
||||
|
||||
unsetalreadyfiltered($params{page}, $params{page});
|
||||
return $params{content};
|
||||
} #}}}
|
||||
|
||||
|
||||
# ,----
|
||||
# | Injected functions
|
||||
# `----
|
||||
|
||||
# Implement po_link_to=current
|
||||
sub mybestlink ($$) { #{{{
|
||||
my $page=shift;
|
||||
my $link=shift;
|
||||
|
||||
my $res=$origsubs{'bestlink'}->($page, $link);
|
||||
if (length $res
|
||||
&& $config{po_link_to} eq "current"
|
||||
&& istranslatable($res)
|
||||
&& istranslation($page)) {
|
||||
return $res . "." . lang($page);
|
||||
}
|
||||
return $res;
|
||||
} #}}}
|
||||
|
||||
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$!/!;
|
||||
}
|
||||
return $res;
|
||||
} #}}}
|
||||
|
||||
sub mytargetpage ($$) { #{{{
|
||||
my $page=shift;
|
||||
my $ext=shift;
|
||||
|
||||
if (istranslation($page) || istranslatable($page)) {
|
||||
my ($masterpage, $lang) = (masterpage($page), lang($page));
|
||||
if (! $config{usedirs} || $masterpage eq 'index') {
|
||||
return $masterpage . "." . $lang . "." . $ext;
|
||||
}
|
||||
else {
|
||||
return $masterpage . "/index." . $lang . "." . $ext;
|
||||
}
|
||||
}
|
||||
return $origsubs{'targetpage'}->($page, $ext);
|
||||
} #}}}
|
||||
|
||||
sub myurlto ($$;$) { #{{{
|
||||
my $to=shift;
|
||||
my $from=shift;
|
||||
my $absolute=shift;
|
||||
|
||||
# workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
|
||||
if (! length $to
|
||||
&& $config{po_link_to} eq "current"
|
||||
&& istranslatable('index')) {
|
||||
return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
|
||||
}
|
||||
return $origsubs{'urlto'}->($to,$from,$absolute);
|
||||
} #}}}
|
||||
|
||||
|
||||
# ,----
|
||||
# | Blackboxes for private data
|
||||
# `----
|
||||
|
||||
{
|
||||
my %filtered;
|
||||
|
||||
sub alreadyfiltered($$) { #{{{
|
||||
my $page=shift;
|
||||
my $destpage=shift;
|
||||
|
||||
return ( exists $filtered{$page}{$destpage}
|
||||
&& $filtered{$page}{$destpage} eq 1 );
|
||||
} #}}}
|
||||
|
||||
sub setalreadyfiltered($$) { #{{{
|
||||
my $page=shift;
|
||||
my $destpage=shift;
|
||||
|
||||
$filtered{$page}{$destpage}=1;
|
||||
} #}}}
|
||||
|
||||
sub unsetalreadyfiltered($$) { #{{{
|
||||
my $page=shift;
|
||||
my $destpage=shift;
|
||||
|
||||
if (exists $filtered{$page}{$destpage}) {
|
||||
delete $filtered{$page}{$destpage};
|
||||
}
|
||||
} #}}}
|
||||
|
||||
sub resetalreadyfiltered() { #{{{
|
||||
undef %filtered;
|
||||
} #}}}
|
||||
}
|
||||
|
||||
|
||||
# ,----
|
||||
# | Helper functions
|
||||
# `----
|
||||
|
||||
sub istranslatable ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
my $file=$pagesources{$page};
|
||||
|
||||
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});
|
||||
} #}}}
|
||||
|
||||
sub _istranslation ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
my $file=$pagesources{$page};
|
||||
|
||||
return 0 unless (defined $file
|
||||
&& defined pagetype($file)
|
||||
&& pagetype($file) eq 'po');
|
||||
return 0 if $file =~ /\.pot$/;
|
||||
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
return 0 unless (defined $masterpage && defined $lang
|
||||
&& length $masterpage && length $lang
|
||||
&& defined $pagesources{$masterpage}
|
||||
&& defined $config{po_slave_languages}{$lang});
|
||||
|
||||
return ($masterpage, $lang) if istranslatable($masterpage);
|
||||
} #}}}
|
||||
|
||||
sub istranslation ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
|
||||
$translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
|
||||
return ($masterpage, $lang);
|
||||
}
|
||||
return;
|
||||
} #}}}
|
||||
|
||||
sub masterpage ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
|
||||
return $masterpage;
|
||||
}
|
||||
return $page;
|
||||
} #}}}
|
||||
|
||||
sub lang ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
|
||||
return $lang;
|
||||
}
|
||||
return $config{po_master_language}{code};
|
||||
} #}}}
|
||||
|
||||
sub islanguagecode ($) { #{{{
|
||||
my $code=shift;
|
||||
|
||||
return ($code =~ /^[a-z]{2}$/);
|
||||
} #}}}
|
||||
|
||||
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;
|
||||
} #}}}
|
||||
|
||||
sub potfile ($) { #{{{
|
||||
my $masterfile=shift;
|
||||
|
||||
|
@ -151,16 +581,22 @@ sub pofile ($$) { #{{{
|
|||
return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
|
||||
} #}}}
|
||||
|
||||
sub pofiles ($) { #{{{
|
||||
my $masterfile=shift;
|
||||
|
||||
return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
|
||||
} #}}}
|
||||
|
||||
sub refreshpot ($) { #{{{
|
||||
my $masterfile=shift;
|
||||
|
||||
my $potfile=potfile($masterfile);
|
||||
my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
|
||||
my $doc=Locale::Po4a::Chooser::new('text',%options);
|
||||
$doc->read($masterfile);
|
||||
$doc->{TT}{utf_mode} = 1;
|
||||
$doc->{TT}{file_in_charset} = 'utf-8';
|
||||
$doc->{TT}{file_out_charset} = 'utf-8';
|
||||
$doc->read($masterfile);
|
||||
# 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.
|
||||
|
@ -193,56 +629,13 @@ sub refreshpofiles ($@) { #{{{
|
|||
}
|
||||
} #}}}
|
||||
|
||||
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);
|
||||
|
||||
# build %translations, using istranslation's side-effect
|
||||
sub buildtranslationscache() { #{{{
|
||||
# use istranslation's side-effect
|
||||
map istranslation($_), (keys %pagesources);
|
||||
|
||||
# make existing translations depend on the corresponding master page
|
||||
foreach my $master (keys %translations) {
|
||||
foreach my $slave (values %{$translations{$master}}) {
|
||||
add_depends($slave, $master);
|
||||
}
|
||||
}
|
||||
} #}}}
|
||||
|
||||
sub mytargetpage ($$) { #{{{
|
||||
my $page=shift;
|
||||
my $ext=shift;
|
||||
|
||||
if (istranslation($page)) {
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
if (! $config{usedirs} || $masterpage eq 'index') {
|
||||
return $masterpage . "." . $lang . "." . $ext;
|
||||
}
|
||||
else {
|
||||
return $masterpage . "/index." . $lang . "." . $ext;
|
||||
}
|
||||
}
|
||||
elsif (istranslatable($page)) {
|
||||
if (! $config{usedirs} || $page eq 'index') {
|
||||
return $page . "." . $config{po_master_language}{code} . "." . $ext;
|
||||
}
|
||||
else {
|
||||
return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
|
||||
}
|
||||
}
|
||||
return $origsubs{'targetpage'}->($page, $ext);
|
||||
} #}}}
|
||||
|
||||
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$!/!;
|
||||
}
|
||||
return $res;
|
||||
sub resettranslationscache() { #{{{
|
||||
undef %translations;
|
||||
} #}}}
|
||||
|
||||
sub urlto_with_orig_beautiful_urlpath($$) { #{{{
|
||||
|
@ -256,107 +649,12 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
|
|||
return $res;
|
||||
} #}}}
|
||||
|
||||
sub mybestlink ($$) { #{{{
|
||||
my $page=shift;
|
||||
my $link=shift;
|
||||
|
||||
my $res=$origsubs{'bestlink'}->($page, $link);
|
||||
if (length $res) {
|
||||
if ($config{po_link_to} eq "current"
|
||||
&& istranslatable($res)
|
||||
&& istranslation($page)) {
|
||||
my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
return $res . "." . $curlang;
|
||||
}
|
||||
else {
|
||||
return $res;
|
||||
}
|
||||
}
|
||||
return "";
|
||||
} #}}}
|
||||
|
||||
# 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 (@) { #{{{
|
||||
my %params = @_;
|
||||
|
||||
my $page = $params{page};
|
||||
my $destpage = $params{destpage};
|
||||
my $content = decode_utf8(encode_utf8($params{content}));
|
||||
|
||||
return $content if ( ! istranslation($page)
|
||||
|| ( exists $filtered{$page}{$destpage}
|
||||
&& $filtered{$page}{$destpage} eq 1 ));
|
||||
|
||||
# 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 ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
my $masterfile = srcfile($pagesources{$masterpage});
|
||||
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:$infile]: failed to translate");
|
||||
$doc->write($outfile) or error("[po/filter:$infile] could not write $outfile");
|
||||
$content = readfile($outfile) or error("[po/filter:$infile] 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;
|
||||
|
||||
$filtered{$page}{$destpage}=1;
|
||||
return $content;
|
||||
} #}}}
|
||||
|
||||
sub htmlize (@) { #{{{
|
||||
my %params=@_;
|
||||
|
||||
my $page = $params{page};
|
||||
my $content = $params{content};
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
my $masterfile = srcfile($pagesources{$masterpage});
|
||||
|
||||
# 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);
|
||||
} #}}}
|
||||
|
||||
sub percenttranslated ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
return gettext("N/A") unless (istranslation($page));
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
return gettext("N/A") unless istranslation($page);
|
||||
my $file=srcfile($pagesources{$page});
|
||||
my $masterfile = srcfile($pagesources{$masterpage});
|
||||
my $masterfile = srcfile($pagesources{masterpage($page)});
|
||||
my (@pos,@masters);
|
||||
push @pos,$file;
|
||||
push @masters,$masterfile;
|
||||
|
@ -369,209 +667,60 @@ sub percenttranslated ($) { #{{{
|
|||
'file_in_name' => \@masters,
|
||||
'file_in_charset' => 'utf-8',
|
||||
'file_out_charset' => 'utf-8',
|
||||
) or error("[po/percenttranslated:$file]: failed to translate");
|
||||
) or error("[po/percenttranslated:$page]: failed to translate");
|
||||
my ($percent,$hit,$queries) = $doc->stats();
|
||||
return $percent;
|
||||
} #}}}
|
||||
|
||||
sub otherlanguages ($) { #{{{
|
||||
sub languagename ($) { #{{{
|
||||
my $code=shift;
|
||||
|
||||
return $config{po_master_language}{name}
|
||||
if $code eq $config{po_master_language}{code};
|
||||
return $config{po_slave_languages}{$code}
|
||||
if defined $config{po_slave_languages}{$code};
|
||||
return;
|
||||
} #}}}
|
||||
|
||||
sub otherlanguagesloop ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
my @ret;
|
||||
if (istranslatable($page)) {
|
||||
foreach my $lang (sort keys %{$translations{$page}}) {
|
||||
my $translation = $translations{$page}{$lang};
|
||||
my %otherpages=%{otherlanguages($page)};
|
||||
while (my ($lang, $otherpage) = each %otherpages) {
|
||||
if (istranslation($page) && masterpage($page) eq $otherpage) {
|
||||
push @ret, {
|
||||
url => urlto($translation, $page),
|
||||
url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
|
||||
code => $lang,
|
||||
language => $config{po_slave_languages}{$lang},
|
||||
percent => percenttranslated($translation),
|
||||
language => languagename($lang),
|
||||
master => 1,
|
||||
};
|
||||
}
|
||||
}
|
||||
elsif (istranslation($page)) {
|
||||
my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
push @ret, {
|
||||
url => urlto_with_orig_beautiful_urlpath($masterpage, $page),
|
||||
code => $config{po_master_language}{code},
|
||||
language => $config{po_master_language}{name},
|
||||
master => 1,
|
||||
};
|
||||
foreach my $lang (sort keys %{$translations{$masterpage}}) {
|
||||
else {
|
||||
push @ret, {
|
||||
url => urlto($translations{$masterpage}{$lang}, $page),
|
||||
url => urlto($otherpage, $page),
|
||||
code => $lang,
|
||||
language => $config{po_slave_languages}{$lang},
|
||||
percent => percenttranslated($translations{$masterpage}{$lang}),
|
||||
} unless ($lang eq $curlang);
|
||||
}
|
||||
}
|
||||
return @ret;
|
||||
} #}}}
|
||||
|
||||
sub pagetemplate (@) { #{{{
|
||||
my %params=@_;
|
||||
my $page=$params{page};
|
||||
my $destpage=$params{destpage};
|
||||
my $template=$params{template};
|
||||
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/) if istranslation($page);
|
||||
|
||||
if (istranslation($page) && $template->query(name => "percenttranslated")) {
|
||||
$template->param(percenttranslated => percenttranslated($page));
|
||||
}
|
||||
if ($template->query(name => "istranslation")) {
|
||||
$template->param(istranslation => istranslation($page));
|
||||
}
|
||||
if ($template->query(name => "istranslatable")) {
|
||||
$template->param(istranslatable => istranslatable($page));
|
||||
}
|
||||
if ($template->query(name => "otherlanguages")) {
|
||||
$template->param(otherlanguages => [otherlanguages($page)]);
|
||||
if (istranslatable($page)) {
|
||||
foreach my $translation (values %{$translations{$page}}) {
|
||||
add_depends($page, $translation);
|
||||
}
|
||||
}
|
||||
elsif (istranslation($page)) {
|
||||
add_depends($page, $masterpage);
|
||||
foreach my $translation (values %{$translations{$masterpage}}) {
|
||||
add_depends($page, $translation);
|
||||
language => languagename($lang),
|
||||
percent => percenttranslated($otherpage),
|
||||
}
|
||||
}
|
||||
}
|
||||
# Rely on IkiWiki::Render's genpage() to decide wether
|
||||
# a discussion link should appear on $page; this is not
|
||||
# totally accurate, though: some broken links may be generated
|
||||
# when cgiurl is disabled.
|
||||
# This compromise avoids some code duplication, and will probably
|
||||
# prevent future breakage when ikiwiki internals change.
|
||||
# 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"),
|
||||
));
|
||||
}
|
||||
# remove broken parentlink to ./index.html on home page's translations
|
||||
if ($template->param('parentlinks')
|
||||
&& istranslation($page)
|
||||
&& $masterpage eq "index") {
|
||||
$template->param('parentlinks' => []);
|
||||
}
|
||||
} # }}}
|
||||
|
||||
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});
|
||||
my $updated_pot_file=0;
|
||||
if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
|
||||
|| ! -e potfile($file)) {
|
||||
refreshpot($file);
|
||||
$updated_pot_file=1;
|
||||
}
|
||||
my @pofiles;
|
||||
foreach my $lang (keys %{$config{po_slave_languages}}) {
|
||||
my $pofile=pofile($file, $lang);
|
||||
if ($updated_pot_file || ! -e $pofile) {
|
||||
push @pofiles, $pofile;
|
||||
}
|
||||
}
|
||||
if (@pofiles) {
|
||||
refreshpofiles($file, @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();
|
||||
}
|
||||
# Reinitialize module's private variables.
|
||||
undef %filtered;
|
||||
undef %translations;
|
||||
# Trigger a wiki refresh.
|
||||
require IkiWiki::Render;
|
||||
IkiWiki::refresh();
|
||||
IkiWiki::saveindex();
|
||||
}
|
||||
return sort {
|
||||
return -1 if $a->{code} eq $config{po_master_language}{code};
|
||||
return 1 if $b->{code} eq $config{po_master_language}{code};
|
||||
return $a->{language} cmp $b->{language};
|
||||
} @ret;
|
||||
} #}}}
|
||||
|
||||
sub editcontent () { #{{{
|
||||
my %params=@_;
|
||||
# as we're previewing or saving a page, the content may have
|
||||
# changed, so tell the next filter() invocation it must not be lazy
|
||||
if (exists $filtered{$params{page}}{$params{page}}) {
|
||||
delete $filtered{$params{page}}{$params{page}};
|
||||
}
|
||||
return $params{content};
|
||||
} #}}}
|
||||
|
||||
sub istranslatable ($) { #{{{
|
||||
sub homepageurl (;$) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
my $file=$pagesources{$page};
|
||||
|
||||
if (! defined $file
|
||||
|| (defined pagetype($file) && pagetype($file) eq 'po')
|
||||
|| $file =~ /\.pot$/) {
|
||||
return 0;
|
||||
}
|
||||
return pagespec_match($page, $config{po_translatable_pages});
|
||||
return urlto('', $page);
|
||||
} #}}}
|
||||
|
||||
sub _istranslation ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
my $file=$pagesources{$page};
|
||||
if (! defined $file) {
|
||||
return IkiWiki::FailReason->new("no file specified");
|
||||
}
|
||||
|
||||
if (! defined $file
|
||||
|| ! defined pagetype($file)
|
||||
|| ! pagetype($file) eq 'po'
|
||||
|| $file =~ /\.pot$/) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
if (! defined $masterpage || ! defined $lang
|
||||
|| ! (length($masterpage) > 0) || ! (length($lang) > 0)
|
||||
|| ! defined $pagesources{$masterpage}
|
||||
|| ! defined $config{po_slave_languages}{$lang}) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return istranslatable($masterpage);
|
||||
} #}}}
|
||||
|
||||
sub istranslation ($) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
if (_istranslation($page)) {
|
||||
my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
$translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
|
||||
return 1;
|
||||
}
|
||||
return 0;
|
||||
} #}}}
|
||||
# ,----
|
||||
# | PageSpec's
|
||||
# `----
|
||||
|
||||
package IkiWiki::PageSpec;
|
||||
use warnings;
|
||||
|
@ -605,16 +754,7 @@ sub match_lang ($$;@) { #{{{
|
|||
my $wanted=shift;
|
||||
|
||||
my $regexp=IkiWiki::glob2re($wanted);
|
||||
my $lang;
|
||||
my $masterpage;
|
||||
|
||||
if (IkiWiki::Plugin::po::istranslation($page)) {
|
||||
($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
}
|
||||
else {
|
||||
$lang = $config{po_master_language}{code};
|
||||
}
|
||||
|
||||
my $lang=IkiWiki::Plugin::po::lang($page);
|
||||
if ($lang!~/^$regexp$/i) {
|
||||
return IkiWiki::FailReason->new("file language is $lang, not $wanted");
|
||||
}
|
||||
|
@ -625,26 +765,13 @@ sub match_lang ($$;@) { #{{{
|
|||
|
||||
sub match_currentlang ($$;@) { #{{{
|
||||
my $page=shift;
|
||||
|
||||
shift;
|
||||
my %params=@_;
|
||||
my ($currentmasterpage, $currentlang, $masterpage, $lang);
|
||||
|
||||
return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
|
||||
|
||||
if (IkiWiki::Plugin::po::istranslation($params{location})) {
|
||||
($currentmasterpage, $currentlang) = ($params{location} =~ /(.*)[.]([a-z]{2})$/);
|
||||
}
|
||||
else {
|
||||
$currentlang = $config{po_master_language}{code};
|
||||
}
|
||||
|
||||
if (IkiWiki::Plugin::po::istranslation($page)) {
|
||||
($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
|
||||
}
|
||||
else {
|
||||
$lang = $config{po_master_language}{code};
|
||||
}
|
||||
my $currentlang=IkiWiki::Plugin::po::lang($params{location});
|
||||
my $lang=IkiWiki::Plugin::po::lang($page);
|
||||
|
||||
if ($lang eq $currentlang) {
|
||||
return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
then="This wiki has po support **enabled**."
|
||||
else="This wiki has po support **disabled**."]]
|
||||
|
||||
If the [[po|plugins/po]] plugin is enabled, the regular
|
||||
If the [po](plugins/po) plugin is enabled, the regular
|
||||
[[ikiwiki/PageSpec]] syntax is expanded with the following additional
|
||||
tests that can be used to improve user navigation in a multi-lingual
|
||||
wiki:
|
||||
|
|
|
@ -6,6 +6,8 @@ gettext, using [po4a](http://po4a.alioth.debian.org/).
|
|||
|
||||
It depends on the Perl `Locale::Po4a::Po` library (`apt-get install po4a`).
|
||||
|
||||
[[!toc levels=2]]
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
|
@ -127,6 +129,10 @@ Usage
|
|||
Templates
|
||||
---------
|
||||
|
||||
When `po_link_to` is not set to `negotiated`, one should replace some
|
||||
occurrences of `BASEURL` with `HOMEPAGEURL` to get correct links to
|
||||
the wiki homepage.
|
||||
|
||||
The `ISTRANSLATION` and `ISTRANSLATABLE` variables can be used to
|
||||
display things only on translatable or translation pages.
|
||||
|
||||
|
@ -215,10 +221,229 @@ TODO
|
|||
Security checks
|
||||
---------------
|
||||
|
||||
- Can any sort of directives be put in po files that will
|
||||
cause mischief (ie, include other files, run commands, crash gettext,
|
||||
whatever).
|
||||
- Any security issues on running po4a on untrusted content?
|
||||
### Security history
|
||||
|
||||
The only past security issues I could find in GNU gettext and po4a
|
||||
are:
|
||||
|
||||
- [CVE-2004-0966](http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2004-0966),
|
||||
*i.e.* [Debian bug #278283](http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=278283):
|
||||
the autopoint and gettextize scripts in the GNU gettext package
|
||||
1.14 and later versions, as used in Trustix Secure Linux 1.5
|
||||
through 2.1 and other operating systems, allows local users to
|
||||
overwrite files via a symlink attack on temporary files.
|
||||
- [CVE-2007-4462](http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2007-4462):
|
||||
`lib/Locale/Po4a/Po.pm` in po4a before 0.32 allows local users to
|
||||
overwrite arbitrary files via a symlink attack on the
|
||||
gettextization.failed.po temporary file.
|
||||
|
||||
**FIXME**: check whether this plugin would have been a possible attack
|
||||
vector to exploit these vulnerabilities.
|
||||
|
||||
Depending on my mood, the lack of found security issues can either
|
||||
indicate that there are none, or reveal that no-one ever bothered to
|
||||
find (and publish) them.
|
||||
|
||||
### PO file features
|
||||
|
||||
Can any sort of directives be put in po files that will cause mischief
|
||||
(ie, include other files, run commands, crash gettext, whatever)?
|
||||
|
||||
> No [documented](http://www.gnu.org/software/gettext/manual/gettext.html#PO-Files)
|
||||
> directive is supposed to do so. [[--intrigeri]]
|
||||
|
||||
### Running po4a on untrusted content
|
||||
|
||||
Are there any security issues on running po4a on untrusted content?
|
||||
|
||||
To say the least, this issue is not well covered, at least publicly:
|
||||
|
||||
- the documentation does not talk about it;
|
||||
- grep'ing the source code for `security` or `trust` gives no answer.
|
||||
|
||||
On the other hand, a po4a developer answered my questions in
|
||||
a convincing manner, stating that processing untrusted content was not
|
||||
an initial goal, and analysing in detail the possible issues.
|
||||
|
||||
#### Already checked
|
||||
|
||||
- the core (`Po.pm`, `Transtractor.pm`) should be safe
|
||||
- po4a source code was fully checked for other potential symlink
|
||||
attacks, after discovery of one such issue
|
||||
- the only external program run by the core is `diff`, in `Po.pm` (in
|
||||
parts of its code we don't use)
|
||||
- `Locale::gettext`: only used to display translated error messages
|
||||
- Nicolas François "hopes" `DynaLoader` is safe, and has "no reason to
|
||||
think that `Encode` is not safe"
|
||||
- Nicolas François has "no reason to think that `Encode::Guess` is not
|
||||
safe". The po plugin nevertheless avoids using it by defining the
|
||||
input charset (`file_in_charset`) before asking `Transtractor` to
|
||||
read any file. NB: this hack depends on po4a internals to stay
|
||||
the same.
|
||||
|
||||
#### To be checked
|
||||
|
||||
##### Locale::Po4a modules
|
||||
|
||||
The modules we want to use have to be checked, as not all are safe
|
||||
(e.g. the LaTeX module's behaviour is changed by commands included in
|
||||
the content); they may use regexps generated from the content.
|
||||
|
||||
`Chooser.pm` only loads the plugin we tell it too: currently, this
|
||||
means the `Text` module only.
|
||||
|
||||
`Text` module (I checked the CVS version):
|
||||
|
||||
- it does not run any external program
|
||||
- only `do_paragraph()` builds regexp's that expand untrusted
|
||||
variables; they seem safe to me, but someone more expert than me
|
||||
will need to check. Joey?
|
||||
|
||||
##### Text::WrapI18N
|
||||
|
||||
`Text::WrapI18N` can cause DoS (see the
|
||||
[Debian bug #470250](http://bugs.debian.org/470250)), but it is
|
||||
optional and we do not need the features it provides.
|
||||
|
||||
It is loaded if available by `Locale::Po4a::Common`; looking at the
|
||||
code, I'm not sure we can prevent this at all, but maybe some symbol
|
||||
table manipulation tricks could work; overriding
|
||||
`Locale::Po4a::Common::wrapi18n` may be easier. I'm no expert at all
|
||||
in this field. Joey? [[--intrigeri]]
|
||||
|
||||
> Update: Nicolas François suggests we add an option to po4a to
|
||||
> disable it. It would do the trick, but only for people running
|
||||
> a brand new po4a (probably too late for Lenny). Anyway, this option
|
||||
> would have to take effect in a `BEGIN` / `eval` that I'm not
|
||||
> familiar with. I can learn and do it, in case no Perl wizard
|
||||
> volunteers to provide the po4a patch. [[--intrigeri]]
|
||||
|
||||
##### Term::ReadKey
|
||||
|
||||
`Term::ReadKey` is not a hard dependency in our case, *i.e.* po4a
|
||||
works nicely without it. But the po4a Debian package recommends
|
||||
`libterm-readkey-perl`, so it will probably be installed on most
|
||||
systems using the po plugin.
|
||||
|
||||
If `$ENV{COLUMNS}` is not set, `Locale::Po4a::Common` uses
|
||||
`Term::ReadKey::GetTerminalSize()` to get the terminal size. How safe
|
||||
is this?
|
||||
|
||||
Part of `Term::ReadKey` is written in C. Depending on the runtime
|
||||
platform, this function use ioctl, environment, or C library function
|
||||
calls, and may end up running the `resize` command (without
|
||||
arguments).
|
||||
|
||||
IMHO, using Term::ReadKey has too far reaching implications for us to
|
||||
be able to guarantee anything wrt. security. Since it is anyway of no
|
||||
use in our case, I suggest we define `ENV{COLUMNS}` before loading
|
||||
`Locale::Po4a::Common`, just to be on the safe side. Joey?
|
||||
[[--intrigeri]]
|
||||
|
||||
> Update: adding an option to disable `Text::WrapI18N`, as Nicolas
|
||||
> François suggested, would as a bonus disable `Term::ReadKey`
|
||||
> as well. [[--intrigeri]]
|
||||
|
||||
### msgmerge
|
||||
|
||||
`refreshpofiles()` runs this external program. A po4a developer
|
||||
answered he does "not expect any security issues from it".
|
||||
|
||||
### Fuzzing input
|
||||
|
||||
I was not able to find any public information about gettext or po4a
|
||||
having been tested with a fuzzing program, such as `zzuf` or `fusil`.
|
||||
Moreover, some gettext parsers seem to be quite
|
||||
[easy to crash](http://fusil.hachoir.org/trac/browser/trunk/fuzzers/fusil-gettext),
|
||||
so it might be useful to bang msgmerge/po4a's heads against such
|
||||
a program in order to easily detect some of the most obvious DoS.
|
||||
[[--intrigeri]]
|
||||
|
||||
> po4a was not fuzzy-tested, but according to one of its developers,
|
||||
> "it would be really appreciated". [[--intrigeri]]
|
||||
|
||||
Test conditions:
|
||||
|
||||
- a 21M file containing 100 concatenated copies of all the files in my
|
||||
`/usr/share/common-licenses/`; I had no existing PO file or
|
||||
translated versions at hand, which renders these tests
|
||||
quite incomplete.
|
||||
- po4a was the Debian 0.34-2 package; the same tests were also run
|
||||
after replacing the `Text` module with the CVS one (the core was not
|
||||
changed in CVS since 0.34-2 was released), without any significant
|
||||
difference in the results.
|
||||
- Perl 5.10.0-16
|
||||
|
||||
#### po4a-gettextize
|
||||
|
||||
`po4a-gettextize` uses more or less the same po4a features as our
|
||||
`refreshpot` function.
|
||||
|
||||
Without specifying an input charset, zzuf'ed `po4a-gettextize` quickly
|
||||
errors out, complaining it was not able to detect the input charset;
|
||||
it leaves no incomplete file on disk.
|
||||
|
||||
So I had to pretend the input was in UTF-8, as does the po plugin.
|
||||
|
||||
Two ways of crashing were revealed by this command-line:
|
||||
|
||||
zzuf -vc -s 0:100 -r 0.1:0.5 \
|
||||
po4a-gettextize -f text -o markdown -M utf-8 -L utf-8 \
|
||||
-m LICENSES >/dev/null
|
||||
|
||||
They are:
|
||||
|
||||
Malformed UTF-8 character (UTF-16 surrogate 0xdcc9) in substitution iterator at /usr/share/perl5/Locale/Po4a/Po.pm line 1443.
|
||||
Malformed UTF-8 character (fatal) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443.
|
||||
|
||||
and
|
||||
|
||||
Malformed UTF-8 character (UTF-16 surrogate 0xdcec) in substitution (s///) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443.
|
||||
Malformed UTF-8 character (fatal) at /usr/share/perl5/Locale/Po4a/Po.pm line 1443.
|
||||
|
||||
Perl seems to exit cleanly, and an incomplete PO file is written on
|
||||
disk. I not sure whether if this is a bug in Perl or in `Po.pm`.
|
||||
|
||||
#### po4a-translate
|
||||
|
||||
`po4a-translate` uses more or less the same po4a features as our
|
||||
`filter` function.
|
||||
|
||||
Without specifying an input charset, same behaviour as
|
||||
`po4a-gettextize`, so let's specify UTF-8 as input charset as of now.
|
||||
|
||||
zzuf -cv \
|
||||
po4a-translate -d -f text -o markdown -M utf-8 -L utf-8 \
|
||||
-k 0 -m LICENSES -p LICENSES.fr.po -l test.fr
|
||||
|
||||
... prints tons of occurences of the following error, but a complete
|
||||
translated document is written (obviously with some weird chars
|
||||
inside):
|
||||
|
||||
Use of uninitialized value in string ne at /usr/share/perl5/Locale/Po4a/TransTractor.pm line 854.
|
||||
Use of uninitialized value in string ne at /usr/share/perl5/Locale/Po4a/TransTractor.pm line 840.
|
||||
Use of uninitialized value in pattern match (m//) at /usr/share/perl5/Locale/Po4a/Po.pm line 1002.
|
||||
|
||||
While:
|
||||
|
||||
zzuf -cv -s 0:10 -r 0.001:0.3 \
|
||||
po4a-translate -d -f text -o markdown -M utf-8 -L utf-8 \
|
||||
-k 0 -m LICENSES -p LICENSES.fr.po -l test.fr
|
||||
|
||||
... seems to lose the fight, at the `readpo(LICENSES.fr.po)` step,
|
||||
against some kind of infinite loop, deadlock, or any similar beast.
|
||||
It does not seem to eat memory, though.
|
||||
|
||||
Whatever format module is used does not change anything. This is thus
|
||||
probably a bug in po4a's core or in a lib it depends on.
|
||||
|
||||
The sub `read`, in `TransTractor.pm`, seems to be a good debugging
|
||||
starting point.
|
||||
|
||||
#### msgmerge
|
||||
|
||||
`msgmerge` is run in our `refreshpofiles` function. I did not manage
|
||||
to crash it with `zzuf`.
|
||||
|
||||
gettext/po4a rough corners
|
||||
--------------------------
|
||||
|
@ -227,37 +452,43 @@ gettext/po4a rough corners
|
|||
live in different directories): say bla.fr.po has been updated in
|
||||
repo2; pulling repo2 from repo1 seems to trigger a PO update, that
|
||||
changes bla.fr.po in repo1; then pushing repo1 to repo2 triggers
|
||||
a PO update, that changes bla.fr.po in repo2; etc.; fixed in
|
||||
`629968fc89bced6727981c0a1138072631751fee`?
|
||||
a PO update, that changes bla.fr.po in repo2; etc.; quickly fixed in
|
||||
`629968fc89bced6727981c0a1138072631751fee`, by disabling references
|
||||
in Pot files. Using `Locale::Po4a::write_if_needed` might be
|
||||
a cleaner solution. (warning: this function runs the external
|
||||
`diff` program, have to check security)
|
||||
- new translations created in the web interface must get proper
|
||||
charset/encoding gettext metadata, else the next automatic PO update
|
||||
removes any non-ascii chars; possible solution: put such metadata
|
||||
into the Pot file, and let it propagate; should be fixed in
|
||||
`773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell.
|
||||
|
||||
Misc. improvements
|
||||
------------------
|
||||
Page titles in links
|
||||
--------------------
|
||||
|
||||
### page titles
|
||||
To use the page titles set with the [meta](plugins/meta) plugin when
|
||||
rendering links would be very much nicer, than the current
|
||||
"filename.LL" format. This is actually a duplicate for
|
||||
[[bugs/pagetitle_function_does_not_respect_meta_titles]].
|
||||
|
||||
Use nice page titles from meta plugin in links, as inline already
|
||||
does. This is actually a duplicate for
|
||||
[[bugs/pagetitle_function_does_not_respect_meta_titles]], which might
|
||||
be fixed by something like [[todo/using_meta_titles_for_parentlinks]].
|
||||
Page formats
|
||||
------------
|
||||
|
||||
### backlinks
|
||||
Markdown is well supported, great, but what about others?
|
||||
|
||||
`po_link_to = negotiated`: if a given translatable `sourcepage.mdwn`
|
||||
links to \[[destpage]], `sourcepage.LL.po` also link to \[[destpage]],
|
||||
and the latter has the master page *and* all its translations listed
|
||||
in the backlinks.
|
||||
The [po](plugins/po) uses `Locale::Po4a::Text` for every page format;
|
||||
this can be expected to work out of the box with most other wiki-like
|
||||
formats supported by ikiwiki. Some of their ad-hoc syntax might be
|
||||
parsed in a strange way, but the worst problems I can imagine would be
|
||||
wrapping issues; e.g. there is code in po4a dedicated to prevent
|
||||
re-wrapping the underlined Markdown headers.
|
||||
|
||||
`po_link_to = current`: seems to work nicely
|
||||
While it would be easy to better support formats such as [[html]] or
|
||||
LaTeX, by using for each one the dedicated po4a module, this can be
|
||||
problematic from a security point of view.
|
||||
|
||||
### parentlinks
|
||||
|
||||
When `usedirs` is disabled and the home page is translatable, the
|
||||
parent link to the wiki home page is broken (`/index.html`).
|
||||
**TODO**: test the more popular formats and write proper documentation
|
||||
about it.
|
||||
|
||||
Translation quality assurance
|
||||
-----------------------------
|
||||
|
@ -270,3 +501,15 @@ A new `cansave` type of hook would be needed to implement this.
|
|||
|
||||
Note: committing to the underlying repository is a way to bypass
|
||||
this check.
|
||||
|
||||
Broken links
|
||||
------------
|
||||
|
||||
See [[contrib/po]].
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
Maybe write separate documentation depending on the people it targets:
|
||||
translators, wiki administrators, hackers. This plugin is maybe
|
||||
complex enough to deserve this.
|
||||
|
|
83
t/po.t
83
t/po.t
|
@ -2,7 +2,7 @@
|
|||
# -*- cperl-indent-level: 8; -*-
|
||||
use warnings;
|
||||
use strict;
|
||||
use File::Temp;
|
||||
use File::Temp qw{tempdir};
|
||||
|
||||
BEGIN {
|
||||
unless (eval { require Locale::Po4a::Chooser }) {
|
||||
|
@ -17,18 +17,21 @@ BEGIN {
|
|||
}
|
||||
}
|
||||
|
||||
use Test::More tests => 34;
|
||||
use Test::More tests => 58;
|
||||
|
||||
BEGIN { use_ok("IkiWiki"); }
|
||||
|
||||
my $msgprefix;
|
||||
|
||||
my $dir = tempdir("ikiwiki-test-po.XXXXXXXXXX",
|
||||
DIR => File::Spec->tmpdir,
|
||||
CLEANUP => 1);
|
||||
|
||||
### Init
|
||||
%config=IkiWiki::defaultconfig();
|
||||
$config{srcdir}=$config{destdir}="/dev/null";
|
||||
## will need this when more thorough tests are written
|
||||
# $config{srcdir} = "t/po/src";
|
||||
# $config{destdir} = File::Temp->newdir("ikiwiki-test-po.XXXXXXXXXX", TMPDIR => 1)->dirname;
|
||||
$config{srcdir} = "$dir/src";
|
||||
$config{destdir} = "$dir/dst";
|
||||
$config{discussion} = 0;
|
||||
$config{po_master_language} = { code => 'en',
|
||||
name => 'English'
|
||||
};
|
||||
|
@ -36,7 +39,7 @@ $config{po_slave_languages} = {
|
|||
es => 'Castellano',
|
||||
fr => "Français"
|
||||
};
|
||||
$config{po_translatable_pages}='index or test1 or test2';
|
||||
$config{po_translatable_pages}='index or test1 or test2 or translatable';
|
||||
$config{po_link_to}='negotiated';
|
||||
IkiWiki::loadplugins();
|
||||
IkiWiki::checkconfig();
|
||||
|
@ -45,6 +48,7 @@ ok(IkiWiki::loadplugin('po'), "po plugin loaded");
|
|||
### seed %pagesources and %pagecase
|
||||
$pagesources{'index'}='index.mdwn';
|
||||
$pagesources{'index.fr'}='index.fr.po';
|
||||
$pagesources{'index.es'}='index.es.po';
|
||||
$pagesources{'test1'}='test1.mdwn';
|
||||
$pagesources{'test1.fr'}='test1.fr.po';
|
||||
$pagesources{'test2'}='test2.mdwn';
|
||||
|
@ -52,6 +56,10 @@ $pagesources{'test2.es'}='test2.es.po';
|
|||
$pagesources{'test2.fr'}='test2.fr.po';
|
||||
$pagesources{'test3'}='test3.mdwn';
|
||||
$pagesources{'test3.es'}='test3.es.mdwn';
|
||||
$pagesources{'translatable'}='translatable.mdwn';
|
||||
$pagesources{'translatable.fr'}='translatable.fr.po';
|
||||
$pagesources{'translatable.es'}='translatable.es.po';
|
||||
$pagesources{'nontranslatable'}='nontranslatable.mdwn';
|
||||
foreach my $page (keys %pagesources) {
|
||||
$IkiWiki::pagecase{lc $page}=$page;
|
||||
}
|
||||
|
@ -61,12 +69,16 @@ foreach my $page (keys %pagesources) {
|
|||
# succeed once every two tries...
|
||||
ok(IkiWiki::Plugin::po::istranslatable('index'), "index is translatable");
|
||||
ok(IkiWiki::Plugin::po::istranslatable('index'), "index is translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.fr'), "index is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.fr'), "index is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.fr'), "index.fr is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.fr'), "index.fr is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.es'), "index.es is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslatable('index.es'), "index.es is not translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslation('index'), "index is not a translation");
|
||||
ok(! IkiWiki::Plugin::po::istranslation('index'), "index is not a translation");
|
||||
ok(IkiWiki::Plugin::po::istranslation('index.fr'), "index.fr is a translation");
|
||||
ok(IkiWiki::Plugin::po::istranslation('index.fr'), "index.fr is a translation");
|
||||
ok(IkiWiki::Plugin::po::istranslation('index.es'), "index.es is a translation");
|
||||
ok(IkiWiki::Plugin::po::istranslation('index.es'), "index.es is a translation");
|
||||
ok(IkiWiki::Plugin::po::istranslatable('test2'), "test2 is translatable");
|
||||
ok(IkiWiki::Plugin::po::istranslatable('test2'), "test2 is translatable");
|
||||
ok(! IkiWiki::Plugin::po::istranslation('test2'), "test2 is not a translation");
|
||||
|
@ -76,6 +88,48 @@ ok(! IkiWiki::Plugin::po::istranslatable('test3'), "test3 is not translatable");
|
|||
ok(! IkiWiki::Plugin::po::istranslation('test3'), "test3 is not a translation");
|
||||
ok(! IkiWiki::Plugin::po::istranslation('test3'), "test3 is not a translation");
|
||||
|
||||
### links
|
||||
require IkiWiki::Render;
|
||||
|
||||
sub refresh_n_scan(@) {
|
||||
my @masterfiles_rel=@_;
|
||||
foreach my $masterfile_rel (@masterfiles_rel) {
|
||||
my $masterfile=srcfile($masterfile_rel);
|
||||
IkiWiki::scan($masterfile_rel);
|
||||
next unless IkiWiki::Plugin::po::istranslatable(pagename($masterfile_rel));
|
||||
my @pofiles=IkiWiki::Plugin::po::pofiles($masterfile);
|
||||
IkiWiki::Plugin::po::refreshpot($masterfile);
|
||||
IkiWiki::Plugin::po::refreshpofiles($masterfile, @pofiles);
|
||||
map IkiWiki::scan(IkiWiki::abs2rel($_, $config{srcdir})), @pofiles;
|
||||
}
|
||||
}
|
||||
|
||||
writefile('index.mdwn', $config{srcdir}, '[[translatable]] [[nontranslatable]]');
|
||||
writefile('translatable.mdwn', $config{srcdir}, '[[nontranslatable]]');
|
||||
writefile('nontranslatable.mdwn', $config{srcdir}, '[[/]] [[translatable]]');
|
||||
|
||||
$config{po_link_to}='negotiated';
|
||||
$msgprefix="links (po_link_to=negotiated)";
|
||||
refresh_n_scan('index.mdwn', 'translatable.mdwn', 'nontranslatable.mdwn');
|
||||
is_deeply(\@{$links{'index'}}, ['translatable', 'nontranslatable'], "$msgprefix index");
|
||||
is_deeply(\@{$links{'index.es'}}, ['translatable.es', 'nontranslatable'], "$msgprefix index.es");
|
||||
is_deeply(\@{$links{'index.fr'}}, ['translatable.fr', 'nontranslatable'], "$msgprefix index.fr");
|
||||
is_deeply(\@{$links{'translatable'}}, ['nontranslatable'], "$msgprefix translatable");
|
||||
is_deeply(\@{$links{'translatable.es'}}, ['nontranslatable'], "$msgprefix translatable.es");
|
||||
is_deeply(\@{$links{'translatable.fr'}}, ['nontranslatable'], "$msgprefix translatable.fr");
|
||||
is_deeply(\@{$links{'nontranslatable'}}, ['/', 'translatable', 'translatable.fr', 'translatable.es'], "$msgprefix nontranslatable");
|
||||
|
||||
$config{po_link_to}='current';
|
||||
$msgprefix="links (po_link_to=current)";
|
||||
refresh_n_scan('index.mdwn', 'translatable.mdwn', 'nontranslatable.mdwn');
|
||||
is_deeply(\@{$links{'index'}}, ['translatable', 'nontranslatable'], "$msgprefix index");
|
||||
is_deeply(\@{$links{'index.es'}}, [ map bestlink('index.es', $_), ('translatable.es', 'nontranslatable')], "$msgprefix index.es");
|
||||
is_deeply(\@{$links{'index.fr'}}, [ map bestlink('index.fr', $_), ('translatable.fr', 'nontranslatable')], "$msgprefix index.fr");
|
||||
is_deeply(\@{$links{'translatable'}}, [bestlink('translatable', 'nontranslatable')], "$msgprefix translatable");
|
||||
is_deeply(\@{$links{'translatable.es'}}, ['nontranslatable'], "$msgprefix translatable.es");
|
||||
is_deeply(\@{$links{'translatable.fr'}}, ['nontranslatable'], "$msgprefix translatable.fr");
|
||||
is_deeply(\@{$links{'nontranslatable'}}, ['/', 'translatable', 'translatable.fr', 'translatable.es'], "$msgprefix nontranslatable");
|
||||
|
||||
### targetpage
|
||||
$config{usedirs}=0;
|
||||
$msgprefix="targetpage (usedirs=0)";
|
||||
|
@ -90,6 +144,17 @@ is(targetpage('test1.fr', 'html'), 'test1/index.fr.html', "$msgprefix test1.fr")
|
|||
is(targetpage('test3', 'html'), 'test3/index.html', "$msgprefix test3 (non-translatable page)");
|
||||
is(targetpage('test3.es', 'html'), 'test3.es/index.html', "$msgprefix test3.es (non-translatable page)");
|
||||
|
||||
### urlto -> index
|
||||
$config{po_link_to}='current';
|
||||
$msgprefix="urlto (po_link_to=current)";
|
||||
is(urlto('', 'index'), './index.en.html', "$msgprefix index -> ''");
|
||||
is(urlto('', 'nontranslatable'), './../index.en.html', "$msgprefix nontranslatable -> ''");
|
||||
is(urlto('', 'translatable.fr'), './../index.fr.html', "$msgprefix translatable.fr -> ''");
|
||||
$msgprefix="urlto (po_link_to=negotiated)";
|
||||
is(urlto('', 'index'), './index.en.html', "$msgprefix index -> ''");
|
||||
is(urlto('', 'nontranslatable'), './../index.en.html', "$msgprefix nontranslatable -> ''");
|
||||
is(urlto('', 'translatable.fr'), './../index.fr.html', "$msgprefix translatable.fr -> ''");
|
||||
|
||||
### bestlink
|
||||
$config{po_link_to}='current';
|
||||
$msgprefix="bestlink (po_link_to=current)";
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
../../../../doc/ikiwiki/pagespec/po.mdwn
|
Loading…
Reference in New Issue