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);
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 => "rename", id => "po", call => \&renamepages);
+ 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 => "canremove", id => "po", call => \&canremove);
+ hook(type => "canrename", id => "po", call => \&canrename);
hook(type => "editcontent", id => "po", call => \&editcontent);
$origsubs{'bestlink'}=\&IkiWiki::bestlink;
inject(name => "IkiWiki::urlto", call => \&myurlto);
$origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);
-} #}}}
+}
# ,----
# | Hooks
# `----
-sub getsetup () { #{{{
+sub getsetup () {
return
plugin => {
safe => 0,
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));
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
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};
}
}
}
-} #}}}
+}
# 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};
# 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!
+ # 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;
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,
+ 'po_in_name' => [ $infile ],
+ 'file_in_name' => [ $masterfile ],
'file_in_charset' => 'utf-8',
'file_out_charset' => 'utf-8',
) or error("[po/filter:$page]: failed to translate");
setalreadyfiltered($page, $destpage);
return $content;
-} #}}}
+}
-sub htmlize (@) { #{{{
+sub htmlize (@) {
my %params=@_;
my $page = $params{page};
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};
}
} # }}}
+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.
-# 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.
-sub renamepages() { #{{{
- my $torename=shift;
+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})};
};
}
}
-} #}}}
+}
-sub mydelete(@) { #{{{
+sub mydelete(@) {
my @deleted=@_;
- map {
- deletetranslations($_);
- } grep { istranslatablefile($_) } @deleted;
-} #}}}
+ map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
+}
-sub change(@) { #{{{
+sub change(@) {
my @rendered=@_;
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;
} (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;
}
}
gettext("updated PO files"),
"IkiWiki::Plugin::po::change");
}
-} #}}}
+}
+
+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.");
+ }
+ }
+ 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};
-} #}}}
+}
# ,----
# `----
# Implement po_link_to 'current' and 'negotiated' settings.
-sub mybestlink ($$) { #{{{
+sub mybestlink ($$) {
my $page=shift;
my $link=shift;
return $res . "." . lang($page);
}
return $res;
-} #}}}
+}
-sub mybeautify_urlpath ($) { #{{{
+sub mybeautify_urlpath ($) {
my $url=shift;
my $res=$origsubs{'beautify_urlpath'}->($url);
} (keys %{$config{po_slave_languages}});
}
return $res;
-} #}}}
+}
-sub mytargetpage ($$) { #{{{
+sub mytargetpage ($$) {
my $page=shift;
my $ext=shift;
}
}
return $origsubs{'targetpage'}->($page, $ext);
-} #}}}
+}
-sub myurlto ($$;$) { #{{{
+sub myurlto ($$;$) {
my $to=shift;
my $from=shift;
my $absolute=shift;
# avoid, i.e. when po_link_to = negotiated
if ($config{po_link_to} eq "negotiated") {
my @caller = caller(1);
- my $run_by_editpage = ($caller[3] eq "IkiWiki::cgi_editpage");
+ 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);
else {
return $origsubs{'urlto'}->($to,$from,$absolute)
}
-} #}}}
+}
-sub mynicepagetitle ($;$) { #{{{
+sub mynicepagetitle ($;$) {
my ($page, $unescaped) = (shift, shift);
my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
return $res unless istranslation($page);
- return $res." (".percenttranslated($page).")";
-} #}}}
+ return $res unless $config{po_translation_status_in_links};
+ return $res.' ('.percenttranslated($page).' %)';
+}
# ,----
# | Blackboxes for private data
{
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 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;
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#^/##);
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))) {
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;
$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);
# 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=@_;
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() { #{{{
+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;
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}
return $config{po_slave_languages}{$code}
if defined $config{po_slave_languages}{$code};
return;
-} #}}}
+}
-sub otherlanguagesloop ($) { #{{{
+sub otherlanguagesloop ($) {
my $page=shift;
my @ret;
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 ($) { #{{{
+sub deletetranslations ($) {
my $deletedmasterfile=shift;
my $deletedmasterpage=pagename($deletedmasterfile);
gettext("removed obsolete PO files"),
"IkiWiki::Plugin::po::deletetranslations");
}
-} #}}}
+}
-sub commit_and_refresh ($$) { #{{{
+sub commit_and_refresh ($$) {
my ($msg, $author) = (shift, shift);
if ($config{rcs}) {
IkiWiki::loadindex();
IkiWiki::refresh();
IkiWiki::saveindex();
-} #}}}
+}
# ,----
# | PageSpec's
use strict;
use IkiWiki 2.00;
-sub match_istranslation ($;@) { #{{{
+sub match_istranslation ($;@) {
my $page=shift;
if (IkiWiki::Plugin::po::istranslation($page)) {
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)) {
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;
else {
return IkiWiki::SuccessReason->new("file language is $wanted");
}
-} #}}}
+}
-sub match_currentlang ($$;@) { #{{{
+sub match_currentlang ($$;@) {
my $page=shift;
shift;
my %params=@_;
else {
return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
}
-} #}}}
+}
1