2 # .po as a wiki page type
3 # Licensed under GPL v2 or greater
4 # Copyright (C) 2008 intrigeri <intrigeri@boum.org>
5 # inspired by the GPL'd po4a-translate,
6 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
7 package IkiWiki::Plugin::po;
13 use Locale::Po4a::Chooser;
26 memoize("_istranslation");
27 memoize("percenttranslated");
30 hook(type => "getsetup", id => "po", call => \&getsetup);
31 hook(type => "checkconfig", id => "po", call => \&checkconfig);
32 hook(type => "needsbuild", id => "po", call => \&needsbuild);
33 hook(type => "scan", id => "po", call => \&scan, last =>1);
34 hook(type => "filter", id => "po", call => \&filter);
35 hook(type => "htmlize", id => "po", call => \&htmlize);
36 hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
37 hook(type => "change", id => "po", call => \&change);
38 hook(type => "editcontent", id => "po", call => \&editcontent);
40 $origsubs{'bestlink'}=\&IkiWiki::bestlink;
41 inject(name => "IkiWiki::bestlink", call => \&mybestlink);
42 $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
43 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
44 $origsubs{'targetpage'}=\&IkiWiki::targetpage;
45 inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
46 $origsubs{'urlto'}=\&IkiWiki::urlto;
47 inject(name => "IkiWiki::urlto", call => \&myurlto);
56 # 2. Injected functions
57 # 3. Blackboxes for private data
66 sub getsetup () { #{{{
72 po_master_language => {
78 description => "master language (non-PO files)",
82 po_slave_languages => {
89 description => "slave languages (PO files)",
93 po_translatable_pages => {
95 example => "!*/Discussion",
96 description => "PageSpec controlling which pages are translatable",
97 link => "ikiwiki/PageSpec",
103 example => "current",
104 description => "internal linking behavior (default/current/negotiated)",
110 sub checkconfig () { #{{{
111 foreach my $field (qw{po_master_language po_slave_languages}) {
112 if (! exists $config{$field} || ! defined $config{$field}) {
113 error(sprintf(gettext("Must specify %s"), $field));
116 if (! (keys %{$config{po_slave_languages}})) {
117 error(gettext("At least one slave language must be defined in po_slave_languages"));
121 or error(sprintf(gettext("%s is not a valid language code"), $_));
122 } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
123 if (! exists $config{po_translatable_pages} ||
124 ! defined $config{po_translatable_pages}) {
125 $config{po_translatable_pages}="";
127 if (! exists $config{po_link_to} ||
128 ! defined $config{po_link_to}) {
129 $config{po_link_to}='default';
132 $config{po_link_to} eq $_
133 } ('default', 'current', 'negotiated')) {
134 warn(sprintf(gettext('po_link_to=%s is not a valid setting, falling back to po_link_to=default'),
135 $config{po_link_to}));
136 $config{po_link_to}='default';
138 elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
139 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
140 $config{po_link_to}='default';
142 push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
145 sub needsbuild () { #{{{
146 my $needsbuild=shift;
148 # backup @needsbuild content so that change() can know whether
149 # a given master page was rendered because its source file was changed
150 @origneedsbuild=(@$needsbuild);
152 buildtranslationscache();
154 # make existing translations depend on the corresponding master page
155 foreach my $master (keys %translations) {
156 map add_depends($_, $master), values %{otherlanguages($master)};
160 # Massage the recorded state of internal links so that:
161 # - it matches the actually generated links, rather than the links as written
162 # in the pages' source
163 # - backlinks are consistent in all cases
166 my $page=$params{page};
167 my $content=$params{content};
169 return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
171 if (istranslation($page)) {
172 foreach my $destpage (@{$links{$page}}) {
173 if (istranslatable($destpage)) {
174 # replace one occurence of $destpage in $links{$page}
175 # (we only want to replace the one that was added by
176 # IkiWiki::Plugin::link::scan, other occurences may be
177 # there for other reasons)
178 for (my $i=0; $i<@{$links{$page}}; $i++) {
179 if (@{$links{$page}}[$i] eq $destpage) {
180 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
187 elsif (! istranslatable($page) && ! istranslation($page)) {
188 foreach my $destpage (@{$links{$page}}) {
189 if (istranslatable($destpage)) {
190 # make sure any destpage's translations has
191 # $page in its backlinks
192 push @{$links{$page}},
193 values %{otherlanguages($destpage)};
199 # We use filter to convert PO to the master page's format,
200 # since the rest of ikiwiki should not work on PO files.
201 sub filter (@) { #{{{
204 my $page = $params{page};
205 my $destpage = $params{destpage};
206 my $content = decode_utf8(encode_utf8($params{content}));
208 return $content if ( ! istranslation($page)
209 || alreadyfiltered($page, $destpage) );
211 # CRLF line terminators make poor Locale::Po4a feel bad
212 $content=~s/\r\n/\n/g;
214 # Implementation notes
216 # 1. Locale::Po4a reads/writes from/to files, and I'm too lazy
217 # to learn how to disguise a variable as a file.
218 # 2. There are incompatibilities between some File::Temp versions
219 # (including 0.18, bundled with Lenny's perl-modules package)
220 # and others (e.g. 0.20, previously present in the archive as
221 # a standalone package): under certain circumstances, some
222 # return a relative filename, whereas others return an absolute one;
223 # we here use this module in a way that is at least compatible
224 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
225 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
226 DIR => File::Spec->tmpdir,
227 UNLINK => 1)->filename;
228 my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
229 DIR => File::Spec->tmpdir,
230 UNLINK => 1)->filename;
232 writefile(basename($infile), File::Spec->tmpdir, $content);
234 my $masterfile = srcfile($pagesources{masterpage($page)});
237 push @masters,$masterfile;
239 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
241 my $doc=Locale::Po4a::Chooser::new('text',%options);
243 'po_in_name' => \@pos,
244 'file_in_name' => \@masters,
245 'file_in_charset' => 'utf-8',
246 'file_out_charset' => 'utf-8',
247 ) or error("[po/filter:$page]: failed to translate");
248 $doc->write($outfile) or error("[po/filter:$page] could not write $outfile");
249 $content = readfile($outfile) or error("[po/filter:$page] could not read $outfile");
251 # Unlinking should happen automatically, thanks to File::Temp,
252 # but it does not work here, probably because of the way writefile()
253 # and Locale::Po4a::write() work.
254 unlink $infile, $outfile;
256 setalreadyfiltered($page, $destpage);
260 sub htmlize (@) { #{{{
263 my $page = $params{page};
264 my $content = $params{content};
265 my $masterfile = srcfile($pagesources{masterpage($page)});
267 # force content to be htmlize'd as if it was the same type as the master page
268 return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
271 sub pagetemplate (@) { #{{{
273 my $page=$params{page};
274 my $destpage=$params{destpage};
275 my $template=$params{template};
277 my ($masterpage, $lang) = istranslation($page);
279 if (istranslation($page) && $template->query(name => "percenttranslated")) {
280 $template->param(percenttranslated => percenttranslated($page));
282 if ($template->query(name => "istranslation")) {
283 $template->param(istranslation => scalar istranslation($page));
285 if ($template->query(name => "istranslatable")) {
286 $template->param(istranslatable => istranslatable($page));
288 if ($template->query(name => "otherlanguages")) {
289 $template->param(otherlanguages => [otherlanguagesloop($page)]);
290 map add_depends($page, $_), (values %{otherlanguages($page)});
292 # Rely on IkiWiki::Render's genpage() to decide wether
293 # a discussion link should appear on $page; this is not
294 # totally accurate, though: some broken links may be generated
295 # when cgiurl is disabled.
296 # This compromise avoids some code duplication, and will probably
297 # prevent future breakage when ikiwiki internals change.
298 # Known limitations are preferred to future random bugs.
299 if ($template->param('discussionlink') && istranslation($page)) {
300 $template->param('discussionlink' => htmllink(
303 $masterpage . '/' . gettext("Discussion"),
306 linktext => gettext("Discussion"),
309 # Remove broken parentlink to ./index.html on home page's translations.
310 # It works because this hook has the "last" parameter set, to ensure it
311 # runs after parentlinks' own pagetemplate hook.
312 if ($template->param('parentlinks')
313 && istranslation($page)
314 && $masterpage eq "index") {
315 $template->param('parentlinks' => []);
322 my $updated_po_files=0;
324 # Refresh/create POT and PO files as needed.
325 foreach my $page (map pagename($_), @rendered) {
326 next unless istranslatable($page);
327 my $file=srcfile($pagesources{$page});
328 my $updated_pot_file=0;
329 # Only refresh Pot file if it does not exist, or if
330 # $pagesources{$page} was changed: don't if only the HTML was
331 # refreshed, e.g. because of a dependency.
332 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
333 || ! -e potfile($file)) {
339 push @pofiles, $_ if ($updated_pot_file || ! -e $_);
342 refreshpofiles($file, @pofiles);
343 map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
348 if ($updated_po_files) {
349 # Check staged changes in.
351 IkiWiki::disable_commit_hook();
352 IkiWiki::rcs_commit_staged(gettext("updated PO files"),
353 "IkiWiki::Plugin::po::change", "127.0.0.1");
354 IkiWiki::enable_commit_hook();
355 IkiWiki::rcs_update();
357 # Reinitialize module's private variables.
358 resetalreadyfiltered();
359 resettranslationscache();
360 # Trigger a wiki refresh.
361 require IkiWiki::Render;
363 IkiWiki::saveindex();
367 sub editcontent () { #{{{
369 # as we're previewing or saving a page, the content may have
370 # changed, so tell the next filter() invocation it must not be lazy
371 unsetalreadyfiltered($params{page}, $params{page});
372 return $params{content};
377 # | Injected functions
380 sub mybestlink ($$) { #{{{
384 my $res=$origsubs{'bestlink'}->($page, $link);
386 if ($config{po_link_to} eq "current"
387 && istranslatable($res)
388 && istranslation($page)) {
389 return $res . "." . lang($page);
398 sub mybeautify_urlpath ($) { #{{{
401 my $res=$origsubs{'beautify_urlpath'}->($url);
402 if ($config{po_link_to} eq "negotiated") {
403 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
408 sub mytargetpage ($$) { #{{{
412 if (istranslation($page)) {
413 my ($masterpage, $lang) = (masterpage($page), lang($page));
414 if (! $config{usedirs} || $masterpage eq 'index') {
415 return $masterpage . "." . $lang . "." . $ext;
418 return $masterpage . "/index." . $lang . "." . $ext;
421 elsif (istranslatable($page)) {
422 if (! $config{usedirs} || $page eq 'index') {
423 return $page . "." . $config{po_master_language}{code} . "." . $ext;
426 return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
429 return $origsubs{'targetpage'}->($page, $ext);
432 sub myurlto ($$;$) { #{{{
437 # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
439 && $config{po_link_to} eq "current"
440 && istranslation($from)
441 && istranslatable('index')) {
442 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
444 return $origsubs{'urlto'}->($to,$from,$absolute);
449 # | Blackboxes for private data
455 sub alreadyfiltered($$) { #{{{
459 return ( exists $filtered{$page}{$destpage}
460 && $filtered{$page}{$destpage} eq 1 );
463 sub setalreadyfiltered($$) { #{{{
467 $filtered{$page}{$destpage}=1;
470 sub unsetalreadyfiltered($$) { #{{{
474 if (exists $filtered{$page}{$destpage}) {
475 delete $filtered{$page}{$destpage};
479 sub resetalreadyfiltered() { #{{{
489 sub istranslatable ($) { #{{{
492 my $file=$pagesources{$page};
495 || (defined pagetype($file) && pagetype($file) eq 'po')
496 || $file =~ /\.pot$/) {
499 return pagespec_match($page, $config{po_translatable_pages});
502 sub _istranslation ($) { #{{{
505 my $file=$pagesources{$page};
506 if (! defined $file) {
507 return IkiWiki::FailReason->new("no file specified");
511 || ! defined pagetype($file)
512 || ! pagetype($file) eq 'po'
513 || $file =~ /\.pot$/) {
517 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
518 if (! defined $masterpage || ! defined $lang
519 || ! (length($masterpage) > 0) || ! (length($lang) > 0)
520 || ! defined $pagesources{$masterpage}
521 || ! defined $config{po_slave_languages}{$lang}) {
525 return ($masterpage, $lang) if istranslatable($masterpage);
528 sub istranslation ($) { #{{{
531 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
532 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
533 return ($masterpage, $lang);
538 sub masterpage ($) { #{{{
541 if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
550 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
553 return $config{po_master_language}{code};
556 sub islanguagecode ($) { #{{{
558 return ($code =~ /^[a-z]{2}$/);
561 sub otherlanguages($) { #{{{
565 if (istranslatable($page)) {
566 %ret = %{$translations{$page}};
568 elsif (istranslation($page)) {
569 my $masterpage = masterpage($page);
570 $ret{$config{po_master_language}{code}} = $masterpage;
571 foreach my $lang (sort keys %{$translations{$masterpage}}) {
572 next if $lang eq lang($page);
573 $ret{$lang} = $translations{$masterpage}{$lang};
579 sub potfile ($) { #{{{
580 my $masterfile=shift;
582 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
583 $dir='' if $dir eq './';
584 return File::Spec->catpath('', $dir, $name . ".pot");
587 sub pofile ($$) { #{{{
588 my $masterfile=shift;
591 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
592 $dir='' if $dir eq './';
593 return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
596 sub pofiles ($) { #{{{
597 my $masterfile=shift;
598 return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
601 sub refreshpot ($) { #{{{
602 my $masterfile=shift;
604 my $potfile=potfile($masterfile);
605 my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
606 my $doc=Locale::Po4a::Chooser::new('text',%options);
607 $doc->{TT}{utf_mode} = 1;
608 $doc->{TT}{file_in_charset} = 'utf-8';
609 $doc->{TT}{file_out_charset} = 'utf-8';
610 $doc->read($masterfile);
611 # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
612 # this is undocument use of internal Locale::Po4a::TransTractor's data,
613 # compulsory since this module prevents us from using the porefs option.
614 my %po_options = ('porefs' => 'none');
615 $doc->{TT}{po_out}=Locale::Po4a::Po->new(\%po_options);
616 $doc->{TT}{po_out}->set_charset('utf-8');
619 IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
620 $doc->writepo($potfile);
623 sub refreshpofiles ($@) { #{{{
624 my $masterfile=shift;
627 my $potfile=potfile($masterfile);
628 error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
630 foreach my $pofile (@pofiles) {
631 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
633 system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
634 or error("[po/refreshpofiles:$pofile] failed to update");
637 File::Copy::syscopy($potfile,$pofile)
638 or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
643 sub buildtranslationscache() { #{{{
644 # use istranslation's side-effect
645 map istranslation($_), (keys %pagesources);
648 sub resettranslationscache() { #{{{
652 sub urlto_with_orig_beautiful_urlpath($$) { #{{{
656 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
657 my $res=urlto($to, $from);
658 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
663 sub percenttranslated ($) { #{{{
666 return gettext("N/A") unless istranslation($page);
667 my $file=srcfile($pagesources{$page});
668 my $masterfile = srcfile($pagesources{masterpage($page)});
671 push @masters,$masterfile;
673 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
675 my $doc=Locale::Po4a::Chooser::new('text',%options);
677 'po_in_name' => \@pos,
678 'file_in_name' => \@masters,
679 'file_in_charset' => 'utf-8',
680 'file_out_charset' => 'utf-8',
681 ) or error("[po/percenttranslated:$page]: failed to translate");
682 my ($percent,$hit,$queries) = $doc->stats();
686 sub languagename ($) { #{{{
689 return $config{po_master_language}{name}
690 if $code eq $config{po_master_language}{code};
691 return $config{po_slave_languages}{$code}
692 if defined $config{po_slave_languages}{$code};
696 sub otherlanguagesloop ($) { #{{{
700 my %otherpages=%{otherlanguages($page)};
701 while (my ($lang, $otherpage) = each %otherpages) {
702 if (istranslation($page) && masterpage($page) eq $otherpage) {
704 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
706 language => languagename($lang),
712 url => urlto($otherpage, $page),
714 language => languagename($lang),
715 percent => percenttranslated($otherpage),
720 return -1 if $a->{code} eq $config{po_master_language}{code};
721 return 1 if $b->{code} eq $config{po_master_language}{code};
722 return $a->{language} cmp $b->{language};
731 package IkiWiki::PageSpec;
736 sub match_istranslation ($;@) { #{{{
739 if (IkiWiki::Plugin::po::istranslation($page)) {
740 return IkiWiki::SuccessReason->new("is a translation page");
743 return IkiWiki::FailReason->new("is not a translation page");
747 sub match_istranslatable ($;@) { #{{{
750 if (IkiWiki::Plugin::po::istranslatable($page)) {
751 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
754 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
758 sub match_lang ($$;@) { #{{{
762 my $regexp=IkiWiki::glob2re($wanted);
763 my $lang=IkiWiki::Plugin::po::lang($page);
764 if ($lang!~/^$regexp$/i) {
765 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
768 return IkiWiki::SuccessReason->new("file language is $wanted");
772 sub match_currentlang ($$;@) { #{{{
777 return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
779 my $currentlang=IkiWiki::Plugin::po::lang($params{location});
780 my $lang=IkiWiki::Plugin::po::lang($page);
782 if ($lang eq $currentlang) {
783 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
786 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");