2 # .po as a wiki page type
3 # Licensed under GPL v2 or greater
4 # Copyright (C) 2008-2009 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 eval q{use Locale::Po4a::Common qw(nowrapi18n !/.*/)};
15 print STDERR gettext("warning: Old po4a detected! Recommend upgrade to 0.35.")."\n";
16 eval q{use Locale::Po4a::Common qw(!/.*/)};
19 use Locale::Po4a::Chooser;
31 my @slavelanguages; # language codes ordered as in config po_slave_languages
33 memoize("istranslatable");
34 memoize("_istranslation");
35 memoize("percenttranslated");
38 hook(type => "getsetup", id => "po", call => \&getsetup);
39 hook(type => "checkconfig", id => "po", call => \&checkconfig);
40 hook(type => "needsbuild", id => "po", call => \&needsbuild);
41 hook(type => "scan", id => "po", call => \&scan, last => 1);
42 hook(type => "rescan", id => "po", call => \&rescan);
43 hook(type => "filter", id => "po", call => \&filter);
44 hook(type => "htmlize", id => "po", call => \&htmlize);
45 hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
46 hook(type => "rename", id => "po", call => \&renamepages, first => 1);
47 hook(type => "delete", id => "po", call => \&mydelete);
48 hook(type => "change", id => "po", call => \&change);
49 hook(type => "checkcontent", id => "po", call => \&checkcontent);
50 hook(type => "canremove", id => "po", call => \&canremove);
51 hook(type => "canrename", id => "po", call => \&canrename);
52 hook(type => "editcontent", id => "po", call => \&editcontent);
53 hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
54 hook(type => "formbuilder", id => "po", call => \&formbuilder);
57 $origsubs{'bestlink'}=\&IkiWiki::bestlink;
58 inject(name => "IkiWiki::bestlink", call => \&mybestlink);
59 $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
60 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
61 $origsubs{'targetpage'}=\&IkiWiki::targetpage;
62 inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
63 $origsubs{'urlto'}=\&IkiWiki::urlto;
64 inject(name => "IkiWiki::urlto", call => \&myurlto);
65 $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
66 inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
67 $origsubs{'rootpage'}=\&IkiWiki::rootpage;
68 inject(name => "IkiWiki::rootpage", call => \&myrootpage);
69 $origsubs{'isselflink'}=\&IkiWiki::isselflink;
70 inject(name => "IkiWiki::isselflink", call => \&myisselflink);
80 # 2. Injected functions
81 # 3. Blackboxes for private data
94 rebuild => 1, # format plugin
97 po_master_language => {
103 description => "master language (non-PO files)",
107 po_slave_languages => {
114 description => "slave languages (PO files)",
118 po_translatable_pages => {
120 example => "* and !*/Discussion",
121 description => "PageSpec controlling which pages are translatable",
122 link => "ikiwiki/PageSpec",
128 example => "current",
129 description => "internal linking behavior (default/current/negotiated)",
136 foreach my $field (qw{po_master_language}) {
137 if (! exists $config{$field} || ! defined $config{$field}) {
138 error(sprintf(gettext("Must specify %s when using the %s plugin"),
143 if (ref $config{po_slave_languages} eq 'ARRAY') {
145 foreach my $pair (@{$config{po_slave_languages}}) {
146 my ($code, $name) = ( $pair =~ /^([a-z]{2})\|(.+)$/ );
147 if (!defined $code || !defined $name) {
148 error(sprintf(gettext("%s has invalid syntax: must use CODE|NAME"),
151 $slaves{$code} = $name;
152 push @slavelanguages, $code;
155 $config{po_slave_languages} = \%slaves;
157 elsif (ref $config{po_slave_languages} eq 'HASH') {
158 @slavelanguages = sort {
159 $config{po_slave_languages}->{$a} cmp $config{po_slave_languages}->{$b};
160 } keys %{$config{po_slave_languages}};
163 delete $config{po_slave_languages}{$config{po_master_language}{code}};;
167 or error(sprintf(gettext("%s is not a valid language code"), $_));
168 } ($config{po_master_language}{code}, @slavelanguages);
170 if (! exists $config{po_translatable_pages} ||
171 ! defined $config{po_translatable_pages}) {
172 $config{po_translatable_pages}="";
174 if (! exists $config{po_link_to} ||
175 ! defined $config{po_link_to}) {
176 $config{po_link_to}='default';
178 elsif ($config{po_link_to} !~ /^(default|current|negotiated)$/) {
179 warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
180 $config{po_link_to}));
181 $config{po_link_to}='default';
183 elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
184 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
185 $config{po_link_to}='default';
188 push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
190 # Translated versions of the underlays are added if available.
191 foreach my $underlay ("basewiki",
192 map { m/^\Q$config{underlaydirbase}\E\/*(.*)/ }
193 reverse @{$config{underlaydirs}}) {
194 next if $underlay=~/^locale\//;
196 # Underlays containing the po files for slave languages.
197 foreach my $ll (@slavelanguages) {
198 add_underlay("po/$ll/$underlay")
199 if -d "$config{underlaydirbase}/po/$ll/$underlay";
202 if ($config{po_master_language}{code} ne 'en') {
203 # Add underlay containing translated source files
204 # for the master language.
205 add_underlay("locale/$config{po_master_language}{code}/$underlay")
206 if -d "$config{underlaydirbase}/locale/$config{po_master_language}{code}/$underlay";
212 my $needsbuild=shift;
214 # backup @needsbuild content so that change() can know whether
215 # a given master page was rendered because its source file was changed
216 @origneedsbuild=(@$needsbuild);
219 buildtranslationscache();
221 # make existing translations depend on the corresponding master page
222 foreach my $master (keys %translations) {
223 map add_depends($_, $master), values %{otherlanguages_pages($master)};
227 # Massage the recorded state of internal links so that:
228 # - it matches the actually generated links, rather than the links as written
229 # in the pages' source
230 # - backlinks are consistent in all cases
233 my $page=$params{page};
234 my $content=$params{content};
236 if (istranslation($page)) {
237 foreach my $destpage (@{$links{$page}}) {
238 if (istranslatable($destpage)) {
239 # replace the occurence of $destpage in $links{$page}
240 for (my $i=0; $i<@{$links{$page}}; $i++) {
241 if (@{$links{$page}}[$i] eq $destpage) {
242 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
249 elsif (! istranslatable($page) && ! istranslation($page)) {
250 foreach my $destpage (@{$links{$page}}) {
251 if (istranslatable($destpage)) {
252 # make sure any destpage's translations has
253 # $page in its backlinks
254 push @{$links{$page}},
255 values %{otherlanguages_pages($destpage)};
261 # We use filter to convert PO to the master page's format,
262 # since the rest of ikiwiki should not work on PO files.
266 my $page = $params{page};
267 my $destpage = $params{destpage};
268 my $content = $params{content};
269 if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
270 $content = po_to_markup($page, $content);
271 setalreadyfiltered($page, $destpage);
276 # re-run the scan hooks and run the preprocess ones in scan
277 # mode on the po-to-markup converted content
280 my $page=$params{page};
281 my $content=$params{content};
283 return unless istranslation($page);
285 $content = po_to_markup($page, $content);
287 IkiWiki::run_hooks(scan => sub {
293 IkiWiki::preprocess($page, $page, $content, 1);
299 my $page = $params{page};
300 my $content = $params{content};
302 # ignore PO files this plugin did not create
303 return $content unless istranslation($page);
305 # force content to be htmlize'd as if it was the same type as the master page
306 return IkiWiki::htmlize($page, $page,
307 pagetype(srcfile($pagesources{masterpage($page)})),
311 sub pagetemplate (@) {
313 my $page=$params{page};
314 my $destpage=$params{destpage};
315 my $template=$params{template};
317 my ($masterpage, $lang) = istranslation($page);
319 if (istranslation($page) && $template->query(name => "percenttranslated")) {
320 $template->param(percenttranslated => percenttranslated($page));
322 if ($template->query(name => "istranslation")) {
323 $template->param(istranslation => scalar istranslation($page));
325 if ($template->query(name => "istranslatable")) {
326 $template->param(istranslatable => istranslatable($page));
328 if ($template->query(name => "HOMEPAGEURL")) {
329 $template->param(homepageurl => homepageurl($page));
331 if ($template->query(name => "otherlanguages")) {
332 $template->param(otherlanguages => [otherlanguagesloop($page)]);
333 map add_depends($page, $_), (values %{otherlanguages_pages($page)});
335 if ($config{discussion} && istranslation($page)) {
336 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
337 (length $config{cgiurl} ||
338 exists $links{$masterpage."/".lc($config{discussionpage})})) {
339 $template->param('discussionlink' => htmllink(
342 $masterpage . '/' . $config{discussionpage},
345 linktext => $config{discussionpage},
349 # Remove broken parentlink to ./index.html on home page's translations.
350 # It works because this hook has the "last" parameter set, to ensure it
351 # runs after parentlinks' own pagetemplate hook.
352 if ($template->param('parentlinks')
353 && istranslation($page)
354 && $masterpage eq "index") {
355 $template->param('parentlinks' => []);
357 if (ishomepage($page) && $template->query(name => "title")) {
358 $template->param(title => $config{wikiname});
362 # Add the renamed page translations to the list of to-be-renamed pages.
363 sub renamepages (@) {
366 my %torename = %{$params{torename}};
367 my $session = $params{session};
369 # Save the page(s) the user asked to rename, so that our
370 # canrename hook can tell the difference between:
371 # - a translation being renamed as a consequence of its master page
373 # - a user trying to directly rename a translation
374 # This is why this hook has to be run first, before the list of pages
375 # to rename is modified by other plugins.
377 @orig_torename=@{$session->param("po_orig_torename")}
378 if defined $session->param("po_orig_torename");
379 push @orig_torename, $torename{src};
380 $session->param(po_orig_torename => \@orig_torename);
381 IkiWiki::cgi_savesession($session);
383 return () unless istranslatable($torename{src});
386 my %otherpages=%{otherlanguages_pages($torename{src})};
387 while (my ($lang, $otherpage) = each %otherpages) {
390 srcfile => $pagesources{$otherpage},
391 dest => otherlanguage_page($torename{dest}, $lang),
392 destfile => $torename{dest}.".".$lang.".po",
402 map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
408 my $updated_po_files=0;
410 # Refresh/create POT and PO files as needed.
411 foreach my $file (grep {istranslatablefile($_)} @rendered) {
412 my $masterfile=srcfile($file);
413 my $page=pagename($file);
414 my $updated_pot_file=0;
416 # Avoid touching underlay files.
417 next if $masterfile ne "$config{srcdir}/$file";
419 # Only refresh POT file if it does not exist, or if
420 # the source was changed: don't if only the HTML was
421 # refreshed, e.g. because of a dependency.
422 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild) ||
423 ! -e potfile($masterfile)) {
424 refreshpot($masterfile);
428 foreach my $po (pofiles($masterfile)) {
429 next if ! $updated_pot_file && -e $po;
430 next if grep { $po=~/\Q$_\E/ } @{$config{underlaydirs}};
434 refreshpofiles($masterfile, @pofiles);
435 map { s/^\Q$config{srcdir}\E\/*//; IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
440 if ($updated_po_files) {
442 gettext("updated PO files"));
446 sub checkcontent (@) {
449 if (istranslation($params{page})) {
450 my $res = isvalidpo($params{content});
464 if (istranslation($params{page})) {
465 return gettext("Can not remove a translation. If the master page is removed, ".
466 "however, its translations will be removed as well.");
473 my $session = $params{session};
475 if (istranslation($params{src})) {
476 my $masterpage = masterpage($params{src});
477 # Tell the difference between:
478 # - a translation being renamed as a consequence of its master page
479 # being renamed, which is allowed
480 # - a user trying to directly rename a translation, which is forbidden
481 # by looking for the master page in the list of to-be-renamed pages we
482 # saved early in the renaming process.
483 my $orig_torename = $session->param("po_orig_torename");
484 unless (grep { $_ eq $masterpage } @{$orig_torename}) {
485 return gettext("Can not rename a translation. If the master page is renamed, ".
486 "however, its translations will be renamed as well.");
492 # As we're previewing or saving a page, the content may have
493 # changed, so tell the next filter() invocation it must not be lazy.
497 unsetalreadyfiltered($params{page}, $params{page});
498 return $params{content};
501 sub formbuilder_setup (@) {
503 my $form=$params{form};
506 return unless defined $form->field("do");
508 if ($form->field("do") eq "create") {
509 # Warn the user: new pages must be written in master language.
510 my $template=template("pocreatepage.tmpl");
511 $template->param(LANG => $config{po_master_language}{name});
512 $form->tmpl_param(message => $template->output);
514 elsif ($form->field("do") eq "edit") {
515 # Remove the rename/remove buttons on slave pages.
516 # This has to be done after the rename/remove plugins have added
517 # their buttons, which is why this hook must be run last.
518 # The canrename/canremove hooks already ensure this is forbidden
519 # at the backend level, so this is only UI sugar.
520 if (istranslation($form->field("page"))) {
522 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
523 if (@{$params{buttons}}[$i] eq $_) {
524 delete @{$params{buttons}}[$i];
533 sub formbuilder (@) {
535 my $form=$params{form};
538 return unless defined $form->field("do");
540 # Do not allow to create pages of type po: they are automatically created.
541 # The main reason to do so is to bypass the "favor the type of linking page
542 # on page creation" logic, which is unsuitable when a broken link is clicked
543 # on a slave (PO) page.
544 # This cannot be done in the formbuilder_setup hook as the list of types is
546 if ($form->field("do") eq "create") {
547 foreach my $field ($form->field) {
548 next unless "$field" eq "type";
549 next unless $field->type eq 'select';
550 my $orig_value = $field->value;
551 # remove po from the list of types
552 my @types = grep { $_->[0] ne 'po' } $field->options;
553 $field->options(\@types) if @types;
554 # favor the type of linking page's masterpage
555 if ($orig_value eq 'po') {
557 if (defined $form->field('from')) {
558 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
559 $from = masterpage($from);
561 if (defined $from && exists $pagesources{$from}) {
562 $type=pagetype($pagesources{$from});
564 $type=$config{default_pageext} unless defined $type;
565 $field->value($type) ;
572 # | Injected functions
575 # Implement po_link_to 'current' and 'negotiated' settings.
576 sub mybestlink ($$) {
580 return $origsubs{'bestlink'}->($page, $link)
581 if defined $config{po_link_to} && $config{po_link_to} eq "default";
583 my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
584 my @caller = caller(1);
586 && istranslatable($res)
587 && istranslation($page)
588 && !(exists $caller[3] && defined $caller[3]
589 && ($caller[3] eq "IkiWiki::PageSpec::match_link"))) {
590 return $res . "." . lang($page);
595 sub mybeautify_urlpath ($) {
598 my $res=$origsubs{'beautify_urlpath'}->($url);
599 if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {
600 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
601 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
603 $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
609 sub mytargetpage ($$) {
613 if (istranslation($page) || istranslatable($page)) {
614 my ($masterpage, $lang) = (masterpage($page), lang($page));
615 if (! $config{usedirs} || $masterpage eq 'index') {
616 return $masterpage . "." . $lang . "." . $ext;
619 return $masterpage . "/index." . $lang . "." . $ext;
622 return $origsubs{'targetpage'}->($page, $ext);
630 # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
632 && $config{po_link_to} eq "current"
633 && istranslatable('index')) {
634 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
636 # avoid using our injected beautify_urlpath if run by cgi_editpage,
637 # so that one is redirected to the just-edited page rather than to the
638 # negociated translation; to prevent unnecessary fiddling with caller/inject,
639 # we only do so when our beautify_urlpath would actually do what we want to
640 # avoid, i.e. when po_link_to = negotiated.
641 # also avoid doing so when run by cgi_goto, so that the links on recentchanges
642 # page actually lead to the exact page they pretend to.
643 if ($config{po_link_to} eq "negotiated") {
644 my @caller = caller(1);
646 $use_orig = 1 if (exists $caller[3] && defined $caller[3]
647 && ($caller[3] eq "IkiWiki::cgi_editpage" ||
648 $caller[3] eq "IkiWiki::Plugin::goto::cgi_goto")
650 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
652 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
653 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
658 return $origsubs{'urlto'}->($to,$from,$absolute)
665 # slave pages have no subpages
666 if (istranslation($params{'from'})) {
667 $params{'from'} = masterpage($params{'from'});
669 return $origsubs{'cgiurl'}->(%params);
676 if (exists $params{rootpage}) {
677 $rootpage=$origsubs{'bestlink'}->($params{page}, $params{rootpage});
678 if (!length $rootpage) {
679 $rootpage=$params{rootpage};
683 $rootpage=masterpage($params{page});
688 sub myisselflink ($$) {
692 return 1 if $origsubs{'isselflink'}->($page, $link);
693 if (istranslation($page)) {
694 return $origsubs{'isselflink'}->(masterpage($page), $link);
700 # | Blackboxes for private data
706 sub alreadyfiltered($$) {
710 return exists $filtered{$page}{$destpage}
711 && $filtered{$page}{$destpage} eq 1;
714 sub setalreadyfiltered($$) {
718 $filtered{$page}{$destpage}=1;
721 sub unsetalreadyfiltered($$) {
725 if (exists $filtered{$page}{$destpage}) {
726 delete $filtered{$page}{$destpage};
730 sub resetalreadyfiltered() {
739 sub maybe_add_leading_slash ($;$) {
742 $add=1 unless defined $add;
743 return '/' . $str if $add;
747 sub istranslatablefile ($) {
750 return 0 unless defined $file;
751 my $type=pagetype($file);
752 return 0 if ! defined $type || $type eq 'po';
753 return 0 if $file =~ /\.pot$/;
754 return 0 if ! defined $config{po_translatable_pages};
755 return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
759 sub istranslatable ($) {
763 return 1 if istranslatablefile($pagesources{$page});
767 sub _istranslation ($) {
770 $page='' unless defined $page && length $page;
771 my $hasleadingslash = ($page=~s#^/##);
772 my $file=$pagesources{$page};
773 return 0 unless defined $file
774 && defined pagetype($file)
775 && pagetype($file) eq 'po';
776 return 0 if $file =~ /\.pot$/;
778 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
779 return 0 unless defined $masterpage && defined $lang
780 && length $masterpage && length $lang
781 && defined $pagesources{$masterpage}
782 && defined $config{po_slave_languages}{$lang};
784 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
785 if istranslatable($masterpage);
788 sub istranslation ($) {
791 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
792 my $hasleadingslash = ($masterpage=~s#^/##);
793 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
794 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
802 if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
811 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
814 return $config{po_master_language}{code};
817 sub islanguagecode ($) {
820 return $code =~ /^[a-z]{2}$/;
823 sub otherlanguage_page ($$) {
827 return masterpage($page) if $code eq $config{po_master_language}{code};
828 return masterpage($page) . '.' . $code;
831 # Returns the list of other languages codes: the master language comes first,
832 # then the codes are ordered the same way as in po_slave_languages, if it is
833 # an array, or in the language name lexical order, if it is a hash.
834 sub otherlanguages_codes ($) {
838 return \@ret unless istranslation($page) || istranslatable($page);
839 my $curlang=lang($page);
841 ($config{po_master_language}{code}, @slavelanguages) {
842 next if $lang eq $curlang;
848 sub otherlanguages_pages ($) {
853 $ret{$_} = otherlanguage_page($page, $_)
854 } @{otherlanguages_codes($page)};
860 my $masterfile=shift;
862 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
863 $dir='' if $dir eq './';
864 return File::Spec->catpath('', $dir, $name . ".pot");
868 my $masterfile=shift;
871 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
872 $dir='' if $dir eq './';
873 return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
877 my $masterfile=shift;
879 return map pofile($masterfile, $_), @slavelanguages;
883 my $masterfile=shift;
885 my $potfile=potfile($masterfile);
886 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
887 po4a_options($masterfile));
888 $doc->{TT}{utf_mode} = 1;
889 $doc->{TT}{file_in_charset} = 'UTF-8';
890 $doc->{TT}{file_out_charset} = 'UTF-8';
891 $doc->read($masterfile);
892 # let's cheat a bit to force porefs option to be passed to
893 # Locale::Po4a::Po; this is undocument use of internal
894 # Locale::Po4a::TransTractor's data, compulsory since this module
895 # prevents us from using the porefs option.
896 $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
897 $doc->{TT}{po_out}->set_charset('UTF-8');
900 IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
901 $doc->writepo($potfile);
904 sub refreshpofiles ($@) {
905 my $masterfile=shift;
908 my $potfile=potfile($masterfile);
910 error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
913 foreach my $pofile (@pofiles) {
914 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
917 # If the po file exists in an underlay, copy it
919 my ($pobase)=$pofile=~/^\Q$config{srcdir}\E\/?(.*)$/;
920 foreach my $dir (@{$config{underlaydirs}}) {
921 if (-e "$dir/$pobase") {
922 File::Copy::syscopy("$dir/$pobase",$pofile)
923 or error("po(refreshpofiles) ".
924 sprintf(gettext("failed to copy underlay PO file to %s"),
931 system("msgmerge", "--previous", "-q", "-U", "--backup=none", $pofile, $potfile) == 0
932 or error("po(refreshpofiles) ".
933 sprintf(gettext("failed to update %s"),
937 File::Copy::syscopy($potfile,$pofile)
938 or error("po(refreshpofiles) ".
939 sprintf(gettext("failed to copy the POT file to %s"),
945 sub buildtranslationscache() {
946 # use istranslation's side-effect
947 map istranslation($_), (keys %pagesources);
950 sub resettranslationscache() {
954 sub flushmemoizecache() {
955 Memoize::flush_cache("istranslatable");
956 Memoize::flush_cache("_istranslation");
957 Memoize::flush_cache("percenttranslated");
960 sub urlto_with_orig_beautiful_urlpath($$) {
964 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
965 my $res=urlto($to, $from);
966 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
971 sub percenttranslated ($) {
975 return gettext("N/A") unless istranslation($page);
976 my $file=srcfile($pagesources{$page});
977 my $masterfile = srcfile($pagesources{masterpage($page)});
978 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
979 po4a_options($masterfile));
981 'po_in_name' => [ $file ],
982 'file_in_name' => [ $masterfile ],
983 'file_in_charset' => 'UTF-8',
984 'file_out_charset' => 'UTF-8',
985 ) or error("po(percenttranslated) ".
986 sprintf(gettext("failed to translate %s"), $page));
987 my ($percent,$hit,$queries) = $doc->stats();
988 $percent =~ s/\.[0-9]+$//;
992 sub languagename ($) {
995 return $config{po_master_language}{name}
996 if $code eq $config{po_master_language}{code};
997 return $config{po_slave_languages}{$code}
998 if defined $config{po_slave_languages}{$code};
1002 sub otherlanguagesloop ($) {
1006 if (istranslation($page)) {
1008 url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),
1009 code => $config{po_master_language}{code},
1010 language => $config{po_master_language}{name},
1014 foreach my $lang (@{otherlanguages_codes($page)}) {
1015 next if $lang eq $config{po_master_language}{code};
1016 my $otherpage = otherlanguage_page($page, $lang);
1018 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
1020 language => languagename($lang),
1021 percent => percenttranslated($otherpage),
1027 sub homepageurl (;$) {
1030 return urlto('', $page);
1033 sub ishomepage ($) {
1036 return 1 if $page eq 'index';
1037 map { return 1 if $page eq 'index.'.$_ } @slavelanguages;
1041 sub deletetranslations ($) {
1042 my $deletedmasterfile=shift;
1044 my $deletedmasterpage=pagename($deletedmasterfile);
1047 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
1048 my $absfile = "$config{srcdir}/$file";
1049 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
1050 push @todelete, $file;
1056 IkiWiki::rcs_remove($_);
1059 IkiWiki::prune("$config{srcdir}/$_");
1065 gettext("removed obsolete PO files"));
1069 sub commit_and_refresh ($) {
1073 IkiWiki::disable_commit_hook();
1074 IkiWiki::rcs_commit_staged(
1077 IkiWiki::enable_commit_hook();
1078 IkiWiki::rcs_update();
1080 # Reinitialize module's private variables.
1081 resetalreadyfiltered();
1082 resettranslationscache();
1083 flushmemoizecache();
1084 # Trigger a wiki refresh.
1085 require IkiWiki::Render;
1086 # without preliminary saveindex/loadindex, refresh()
1087 # complains about a lot of uninitialized variables
1088 IkiWiki::saveindex();
1089 IkiWiki::loadindex();
1091 IkiWiki::saveindex();
1094 sub po_to_markup ($$) {
1095 my ($page, $content) = (shift, shift);
1097 $content = '' unless defined $content;
1098 $content = decode_utf8(encode_utf8($content));
1099 # CRLF line terminators make poor Locale::Po4a feel bad
1100 $content=~s/\r\n/\n/g;
1102 # There are incompatibilities between some File::Temp versions
1103 # (including 0.18, bundled with Lenny's perl-modules package)
1104 # and others (e.g. 0.20, previously present in the archive as
1105 # a standalone package): under certain circumstances, some
1106 # return a relative filename, whereas others return an absolute one;
1107 # we here use this module in a way that is at least compatible
1108 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1109 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
1110 DIR => File::Spec->tmpdir,
1111 UNLINK => 1)->filename;
1112 my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
1113 DIR => File::Spec->tmpdir,
1114 UNLINK => 1)->filename;
1116 my $fail = sub ($) {
1117 my $msg = "po(po_to_markup) - $page : " . shift;
1118 error($msg, sub { unlink $infile, $outfile});
1121 writefile(basename($infile), File::Spec->tmpdir, $content)
1122 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1124 my $masterfile = srcfile($pagesources{masterpage($page)});
1125 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
1126 po4a_options($masterfile));
1128 'po_in_name' => [ $infile ],
1129 'file_in_name' => [ $masterfile ],
1130 'file_in_charset' => 'UTF-8',
1131 'file_out_charset' => 'UTF-8',
1132 ) or return $fail->(gettext("failed to translate"));
1133 $doc->write($outfile)
1134 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1136 $content = readfile($outfile);
1138 # Unlinking should happen automatically, thanks to File::Temp,
1139 # but it does not work here, probably because of the way writefile()
1140 # and Locale::Po4a::write() work.
1141 unlink $infile, $outfile;
1146 # returns a SuccessReason or FailReason object
1148 my $content = shift;
1150 # NB: we don't use po_to_markup here, since Po4a parser does
1151 # not mind invalid PO content
1152 $content = '' unless defined $content;
1153 $content = decode_utf8(encode_utf8($content));
1155 # There are incompatibilities between some File::Temp versions
1156 # (including 0.18, bundled with Lenny's perl-modules package)
1157 # and others (e.g. 0.20, previously present in the archive as
1158 # a standalone package): under certain circumstances, some
1159 # return a relative filename, whereas others return an absolute one;
1160 # we here use this module in a way that is at least compatible
1161 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1162 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1163 DIR => File::Spec->tmpdir,
1164 UNLINK => 1)->filename;
1166 my $fail = sub ($) {
1167 my $msg = '[po/isvalidpo] ' . shift;
1169 return IkiWiki::FailReason->new("$msg");
1172 writefile(basename($infile), File::Spec->tmpdir, $content)
1173 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1175 my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1177 # Unlinking should happen automatically, thanks to File::Temp,
1178 # but it does not work here, probably because of the way writefile()
1179 # and Locale::Po4a::write() work.
1183 return IkiWiki::SuccessReason->new("valid gettext data");
1185 return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
1186 "to previous page to continue edit"));
1192 my $pagetype = pagetype($file);
1193 if ($pagetype eq 'html') {
1199 sub po4a_options($) {
1203 my $pagetype = pagetype($file);
1205 if ($pagetype eq 'html') {
1206 # how to disable options is not consistent across po4a modules
1207 $options{includessi} = '';
1208 $options{includeexternal} = 0;
1210 elsif ($pagetype eq 'mdwn') {
1211 $options{markdown} = 1;
1214 $options{markdown} = 0;
1224 package IkiWiki::PageSpec;
1226 sub match_istranslation ($;@) {
1229 if (IkiWiki::Plugin::po::istranslation($page)) {
1230 return IkiWiki::SuccessReason->new("is a translation page");
1233 return IkiWiki::FailReason->new("is not a translation page");
1237 sub match_istranslatable ($;@) {
1240 if (IkiWiki::Plugin::po::istranslatable($page)) {
1241 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1244 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1248 sub match_lang ($$;@) {
1252 my $regexp=IkiWiki::glob2re($wanted);
1253 my $lang=IkiWiki::Plugin::po::lang($page);
1254 if ($lang !~ /^$regexp$/i) {
1255 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1258 return IkiWiki::SuccessReason->new("file language is $wanted");
1262 sub match_currentlang ($$;@) {
1267 return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1269 my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1270 my $lang=IkiWiki::Plugin::po::lang($page);
1272 if ($lang eq $currentlang) {
1273 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1276 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
1280 sub match_needstranslation ($$;@) {
1284 if (defined $wanted && $wanted ne "") {
1285 if ($wanted !~ /^\d+$/) {
1286 return IkiWiki::FailReason->new("parameter is not an integer");
1288 elsif ($wanted > 100) {
1289 return IkiWiki::FailReason->new("parameter is greater than 100");
1296 my $percenttranslated=IkiWiki::Plugin::po::percenttranslated($page);
1297 if ($percenttranslated eq 'N/A') {
1298 return IkiWiki::FailReason->new("file is not a translatable page");
1300 elsif ($percenttranslated < $wanted) {
1301 return IkiWiki::SuccessReason->new("file has $percenttranslated translated");
1304 return IkiWiki::FailReason->new("file is translated enough");