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 exists $config{rebuild} && $config{rebuild};
284 return unless istranslation($page);
286 $content = po_to_markup($page, $content);
288 IkiWiki::run_hooks(scan => sub {
294 IkiWiki::preprocess($page, $page, $content, 1);
300 my $page = $params{page};
301 my $content = $params{content};
303 # ignore PO files this plugin did not create
304 return $content unless istranslation($page);
306 # force content to be htmlize'd as if it was the same type as the master page
307 return IkiWiki::htmlize($page, $page,
308 pagetype(srcfile($pagesources{masterpage($page)})),
312 sub pagetemplate (@) {
314 my $page=$params{page};
315 my $destpage=$params{destpage};
316 my $template=$params{template};
318 my ($masterpage, $lang) = istranslation($page);
320 if (istranslation($page) && $template->query(name => "percenttranslated")) {
321 $template->param(percenttranslated => percenttranslated($page));
323 if ($template->query(name => "istranslation")) {
324 $template->param(istranslation => scalar istranslation($page));
326 if ($template->query(name => "istranslatable")) {
327 $template->param(istranslatable => istranslatable($page));
329 if ($template->query(name => "HOMEPAGEURL")) {
330 $template->param(homepageurl => homepageurl($page));
332 if ($template->query(name => "otherlanguages")) {
333 $template->param(otherlanguages => [otherlanguagesloop($page)]);
334 map add_depends($page, $_), (values %{otherlanguages_pages($page)});
336 if ($config{discussion} && istranslation($page)) {
337 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
338 (length $config{cgiurl} ||
339 exists $links{$masterpage."/".lc($config{discussionpage})})) {
340 $template->param('discussionlink' => htmllink(
343 $masterpage . '/' . $config{discussionpage},
346 linktext => $config{discussionpage},
350 # Remove broken parentlink to ./index.html on home page's translations.
351 # It works because this hook has the "last" parameter set, to ensure it
352 # runs after parentlinks' own pagetemplate hook.
353 if ($template->param('parentlinks')
354 && istranslation($page)
355 && $masterpage eq "index") {
356 $template->param('parentlinks' => []);
358 if (ishomepage($page) && $template->query(name => "title")) {
359 $template->param(title => $config{wikiname});
363 # Add the renamed page translations to the list of to-be-renamed pages.
364 sub renamepages (@) {
367 my %torename = %{$params{torename}};
368 my $session = $params{session};
370 # Save the page(s) the user asked to rename, so that our
371 # canrename hook can tell the difference between:
372 # - a translation being renamed as a consequence of its master page
374 # - a user trying to directly rename a translation
375 # This is why this hook has to be run first, before the list of pages
376 # to rename is modified by other plugins.
378 @orig_torename=@{$session->param("po_orig_torename")}
379 if defined $session->param("po_orig_torename");
380 push @orig_torename, $torename{src};
381 $session->param(po_orig_torename => \@orig_torename);
382 IkiWiki::cgi_savesession($session);
384 return () unless istranslatable($torename{src});
387 my %otherpages=%{otherlanguages_pages($torename{src})};
388 while (my ($lang, $otherpage) = each %otherpages) {
391 srcfile => $pagesources{$otherpage},
392 dest => otherlanguage_page($torename{dest}, $lang),
393 destfile => $torename{dest}.".".$lang.".po",
403 map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
409 my $updated_po_files=0;
411 # Refresh/create POT and PO files as needed.
412 foreach my $file (grep {istranslatablefile($_)} @rendered) {
413 my $masterfile=srcfile($file);
414 my $page=pagename($file);
415 my $updated_pot_file=0;
417 # Avoid touching underlay files.
418 next if $masterfile ne "$config{srcdir}/$file";
420 # Only refresh POT file if it does not exist, or if
421 # the source was changed: don't if only the HTML was
422 # refreshed, e.g. because of a dependency.
423 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild) ||
424 ! -e potfile($masterfile)) {
425 refreshpot($masterfile);
429 foreach my $po (pofiles($masterfile)) {
430 next if ! $updated_pot_file && -e $po;
431 next if grep { $po=~/\Q$_\E/ } @{$config{underlaydirs}};
435 refreshpofiles($masterfile, @pofiles);
436 map { s/^\Q$config{srcdir}\E\/*//; IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
441 if ($updated_po_files) {
443 gettext("updated PO files"));
447 sub checkcontent (@) {
450 if (istranslation($params{page})) {
451 my $res = isvalidpo($params{content});
465 if (istranslation($params{page})) {
466 return gettext("Can not remove a translation. If the master page is removed, ".
467 "however, its translations will be removed as well.");
474 my $session = $params{session};
476 if (istranslation($params{src})) {
477 my $masterpage = masterpage($params{src});
478 # Tell the difference between:
479 # - a translation being renamed as a consequence of its master page
480 # being renamed, which is allowed
481 # - a user trying to directly rename a translation, which is forbidden
482 # by looking for the master page in the list of to-be-renamed pages we
483 # saved early in the renaming process.
484 my $orig_torename = $session->param("po_orig_torename");
485 unless (grep { $_ eq $masterpage } @{$orig_torename}) {
486 return gettext("Can not rename a translation. If the master page is renamed, ".
487 "however, its translations will be renamed as well.");
493 # As we're previewing or saving a page, the content may have
494 # changed, so tell the next filter() invocation it must not be lazy.
498 unsetalreadyfiltered($params{page}, $params{page});
499 return $params{content};
502 sub formbuilder_setup (@) {
504 my $form=$params{form};
507 return unless defined $form->field("do");
509 if ($form->field("do") eq "create") {
510 # Warn the user: new pages must be written in master language.
511 my $template=template("pocreatepage.tmpl");
512 $template->param(LANG => $config{po_master_language}{name});
513 $form->tmpl_param(message => $template->output);
515 elsif ($form->field("do") eq "edit") {
516 # Remove the rename/remove buttons on slave pages.
517 # This has to be done after the rename/remove plugins have added
518 # their buttons, which is why this hook must be run last.
519 # The canrename/canremove hooks already ensure this is forbidden
520 # at the backend level, so this is only UI sugar.
521 if (istranslation($form->field("page"))) {
523 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
524 if (@{$params{buttons}}[$i] eq $_) {
525 delete @{$params{buttons}}[$i];
534 sub formbuilder (@) {
536 my $form=$params{form};
539 return unless defined $form->field("do");
541 # Do not allow to create pages of type po: they are automatically created.
542 # The main reason to do so is to bypass the "favor the type of linking page
543 # on page creation" logic, which is unsuitable when a broken link is clicked
544 # on a slave (PO) page.
545 # This cannot be done in the formbuilder_setup hook as the list of types is
547 if ($form->field("do") eq "create") {
548 foreach my $field ($form->field) {
549 next unless "$field" eq "type";
550 next unless $field->type eq 'select';
551 my $orig_value = $field->value;
552 # remove po from the list of types
553 my @types = grep { $_->[0] ne 'po' } $field->options;
554 $field->options(\@types) if @types;
555 # favor the type of linking page's masterpage
556 if ($orig_value eq 'po') {
558 if (defined $form->field('from')) {
559 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
560 $from = masterpage($from);
562 if (defined $from && exists $pagesources{$from}) {
563 $type=pagetype($pagesources{$from});
565 $type=$config{default_pageext} unless defined $type;
566 $field->value($type) ;
573 # | Injected functions
576 # Implement po_link_to 'current' and 'negotiated' settings.
577 sub mybestlink ($$) {
581 return $origsubs{'bestlink'}->($page, $link)
582 if defined $config{po_link_to} && $config{po_link_to} eq "default";
584 my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
585 my @caller = caller(1);
587 && istranslatable($res)
588 && istranslation($page)
589 && !(exists $caller[3] && defined $caller[3]
590 && ($caller[3] eq "IkiWiki::PageSpec::match_link"))) {
591 return $res . "." . lang($page);
596 sub mybeautify_urlpath ($) {
599 my $res=$origsubs{'beautify_urlpath'}->($url);
600 if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {
601 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
602 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
604 $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
610 sub mytargetpage ($$) {
614 if (istranslation($page) || istranslatable($page)) {
615 my ($masterpage, $lang) = (masterpage($page), lang($page));
616 if (! $config{usedirs} || $masterpage eq 'index') {
617 return $masterpage . "." . $lang . "." . $ext;
620 return $masterpage . "/index." . $lang . "." . $ext;
623 return $origsubs{'targetpage'}->($page, $ext);
631 # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
633 && $config{po_link_to} eq "current"
634 && istranslatable('index')) {
635 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
637 # avoid using our injected beautify_urlpath if run by cgi_editpage,
638 # so that one is redirected to the just-edited page rather than to the
639 # negociated translation; to prevent unnecessary fiddling with caller/inject,
640 # we only do so when our beautify_urlpath would actually do what we want to
641 # avoid, i.e. when po_link_to = negotiated.
642 # also avoid doing so when run by cgi_goto, so that the links on recentchanges
643 # page actually lead to the exact page they pretend to.
644 if ($config{po_link_to} eq "negotiated") {
645 my @caller = caller(1);
647 $use_orig = 1 if (exists $caller[3] && defined $caller[3]
648 && ($caller[3] eq "IkiWiki::cgi_editpage" ||
649 $caller[3] eq "IkiWiki::Plugin::goto::cgi_goto")
651 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
653 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
654 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
659 return $origsubs{'urlto'}->($to,$from,$absolute)
666 # slave pages have no subpages
667 if (istranslation($params{'from'})) {
668 $params{'from'} = masterpage($params{'from'});
670 return $origsubs{'cgiurl'}->(%params);
677 if (exists $params{rootpage}) {
678 $rootpage=$origsubs{'bestlink'}->($params{page}, $params{rootpage});
679 if (!length $rootpage) {
680 $rootpage=$params{rootpage};
684 $rootpage=masterpage($params{page});
689 sub myisselflink ($$) {
693 return 1 if $origsubs{'isselflink'}->($page, $link);
694 if (istranslation($page)) {
695 return $origsubs{'isselflink'}->(masterpage($page), $link);
701 # | Blackboxes for private data
707 sub alreadyfiltered($$) {
711 return exists $filtered{$page}{$destpage}
712 && $filtered{$page}{$destpage} eq 1;
715 sub setalreadyfiltered($$) {
719 $filtered{$page}{$destpage}=1;
722 sub unsetalreadyfiltered($$) {
726 if (exists $filtered{$page}{$destpage}) {
727 delete $filtered{$page}{$destpage};
731 sub resetalreadyfiltered() {
740 sub maybe_add_leading_slash ($;$) {
743 $add=1 unless defined $add;
744 return '/' . $str if $add;
748 sub istranslatablefile ($) {
751 return 0 unless defined $file;
752 my $type=pagetype($file);
753 return 0 if ! defined $type || $type eq 'po';
754 return 0 if $file =~ /\.pot$/;
755 return 0 if ! defined $config{po_translatable_pages};
756 return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
760 sub istranslatable ($) {
764 return 1 if istranslatablefile($pagesources{$page});
768 sub _istranslation ($) {
771 $page='' unless defined $page && length $page;
772 my $hasleadingslash = ($page=~s#^/##);
773 my $file=$pagesources{$page};
774 return 0 unless defined $file
775 && defined pagetype($file)
776 && pagetype($file) eq 'po';
777 return 0 if $file =~ /\.pot$/;
779 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
780 return 0 unless defined $masterpage && defined $lang
781 && length $masterpage && length $lang
782 && defined $pagesources{$masterpage}
783 && defined $config{po_slave_languages}{$lang};
785 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
786 if istranslatable($masterpage);
789 sub istranslation ($) {
792 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
793 my $hasleadingslash = ($masterpage=~s#^/##);
794 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
795 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
803 if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
812 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
815 return $config{po_master_language}{code};
818 sub islanguagecode ($) {
821 return $code =~ /^[a-z]{2}$/;
824 sub otherlanguage_page ($$) {
828 return masterpage($page) if $code eq $config{po_master_language}{code};
829 return masterpage($page) . '.' . $code;
832 # Returns the list of other languages codes: the master language comes first,
833 # then the codes are ordered the same way as in po_slave_languages, if it is
834 # an array, or in the language name lexical order, if it is a hash.
835 sub otherlanguages_codes ($) {
839 return \@ret unless istranslation($page) || istranslatable($page);
840 my $curlang=lang($page);
842 ($config{po_master_language}{code}, @slavelanguages) {
843 next if $lang eq $curlang;
849 sub otherlanguages_pages ($) {
854 $ret{$_} = otherlanguage_page($page, $_)
855 } @{otherlanguages_codes($page)};
861 my $masterfile=shift;
863 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
864 $dir='' if $dir eq './';
865 return File::Spec->catpath('', $dir, $name . ".pot");
869 my $masterfile=shift;
872 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
873 $dir='' if $dir eq './';
874 return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
878 my $masterfile=shift;
880 return map pofile($masterfile, $_), @slavelanguages;
884 my $masterfile=shift;
886 my $potfile=potfile($masterfile);
887 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
888 po4a_options($masterfile));
889 $doc->{TT}{utf_mode} = 1;
890 $doc->{TT}{file_in_charset} = 'UTF-8';
891 $doc->{TT}{file_out_charset} = 'UTF-8';
892 $doc->read($masterfile);
893 # let's cheat a bit to force porefs option to be passed to
894 # Locale::Po4a::Po; this is undocument use of internal
895 # Locale::Po4a::TransTractor's data, compulsory since this module
896 # prevents us from using the porefs option.
897 $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
898 $doc->{TT}{po_out}->set_charset('UTF-8');
901 IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
902 $doc->writepo($potfile);
905 sub refreshpofiles ($@) {
906 my $masterfile=shift;
909 my $potfile=potfile($masterfile);
911 error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
914 foreach my $pofile (@pofiles) {
915 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
918 # If the po file exists in an underlay, copy it
920 my ($pobase)=$pofile=~/^\Q$config{srcdir}\E\/?(.*)$/;
921 foreach my $dir (@{$config{underlaydirs}}) {
922 if (-e "$dir/$pobase") {
923 File::Copy::syscopy("$dir/$pobase",$pofile)
924 or error("po(refreshpofiles) ".
925 sprintf(gettext("failed to copy underlay PO file to %s"),
932 system("msgmerge", "--previous", "-q", "-U", "--backup=none", $pofile, $potfile) == 0
933 or error("po(refreshpofiles) ".
934 sprintf(gettext("failed to update %s"),
938 File::Copy::syscopy($potfile,$pofile)
939 or error("po(refreshpofiles) ".
940 sprintf(gettext("failed to copy the POT file to %s"),
946 sub buildtranslationscache() {
947 # use istranslation's side-effect
948 map istranslation($_), (keys %pagesources);
951 sub resettranslationscache() {
955 sub flushmemoizecache() {
956 Memoize::flush_cache("istranslatable");
957 Memoize::flush_cache("_istranslation");
958 Memoize::flush_cache("percenttranslated");
961 sub urlto_with_orig_beautiful_urlpath($$) {
965 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
966 my $res=urlto($to, $from);
967 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
972 sub percenttranslated ($) {
976 return gettext("N/A") unless istranslation($page);
977 my $file=srcfile($pagesources{$page});
978 my $masterfile = srcfile($pagesources{masterpage($page)});
979 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
980 po4a_options($masterfile));
982 'po_in_name' => [ $file ],
983 'file_in_name' => [ $masterfile ],
984 'file_in_charset' => 'UTF-8',
985 'file_out_charset' => 'UTF-8',
986 ) or error("po(percenttranslated) ".
987 sprintf(gettext("failed to translate %s"), $page));
988 my ($percent,$hit,$queries) = $doc->stats();
989 $percent =~ s/\.[0-9]+$//;
993 sub languagename ($) {
996 return $config{po_master_language}{name}
997 if $code eq $config{po_master_language}{code};
998 return $config{po_slave_languages}{$code}
999 if defined $config{po_slave_languages}{$code};
1003 sub otherlanguagesloop ($) {
1007 if (istranslation($page)) {
1009 url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),
1010 code => $config{po_master_language}{code},
1011 language => $config{po_master_language}{name},
1015 foreach my $lang (@{otherlanguages_codes($page)}) {
1016 next if $lang eq $config{po_master_language}{code};
1017 my $otherpage = otherlanguage_page($page, $lang);
1019 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
1021 language => languagename($lang),
1022 percent => percenttranslated($otherpage),
1028 sub homepageurl (;$) {
1031 return urlto('', $page);
1034 sub ishomepage ($) {
1037 return 1 if $page eq 'index';
1038 map { return 1 if $page eq 'index.'.$_ } @slavelanguages;
1042 sub deletetranslations ($) {
1043 my $deletedmasterfile=shift;
1045 my $deletedmasterpage=pagename($deletedmasterfile);
1048 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
1049 my $absfile = "$config{srcdir}/$file";
1050 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
1051 push @todelete, $file;
1057 IkiWiki::rcs_remove($_);
1060 IkiWiki::prune("$config{srcdir}/$_");
1066 gettext("removed obsolete PO files"));
1070 sub commit_and_refresh ($) {
1074 IkiWiki::disable_commit_hook();
1075 IkiWiki::rcs_commit_staged(
1078 IkiWiki::enable_commit_hook();
1079 IkiWiki::rcs_update();
1081 # Reinitialize module's private variables.
1082 resetalreadyfiltered();
1083 resettranslationscache();
1084 flushmemoizecache();
1085 # Trigger a wiki refresh.
1086 require IkiWiki::Render;
1087 # without preliminary saveindex/loadindex, refresh()
1088 # complains about a lot of uninitialized variables
1089 IkiWiki::saveindex();
1090 IkiWiki::loadindex();
1092 IkiWiki::saveindex();
1095 sub po_to_markup ($$) {
1096 my ($page, $content) = (shift, shift);
1098 $content = '' unless defined $content;
1099 $content = decode_utf8(encode_utf8($content));
1100 # CRLF line terminators make poor Locale::Po4a feel bad
1101 $content=~s/\r\n/\n/g;
1103 # There are incompatibilities between some File::Temp versions
1104 # (including 0.18, bundled with Lenny's perl-modules package)
1105 # and others (e.g. 0.20, previously present in the archive as
1106 # a standalone package): under certain circumstances, some
1107 # return a relative filename, whereas others return an absolute one;
1108 # we here use this module in a way that is at least compatible
1109 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1110 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
1111 DIR => File::Spec->tmpdir,
1112 UNLINK => 1)->filename;
1113 my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
1114 DIR => File::Spec->tmpdir,
1115 UNLINK => 1)->filename;
1117 my $fail = sub ($) {
1118 my $msg = "po(po_to_markup) - $page : " . shift;
1119 error($msg, sub { unlink $infile, $outfile});
1122 writefile(basename($infile), File::Spec->tmpdir, $content)
1123 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1125 my $masterfile = srcfile($pagesources{masterpage($page)});
1126 my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
1127 po4a_options($masterfile));
1129 'po_in_name' => [ $infile ],
1130 'file_in_name' => [ $masterfile ],
1131 'file_in_charset' => 'UTF-8',
1132 'file_out_charset' => 'UTF-8',
1133 ) or return $fail->(gettext("failed to translate"));
1134 $doc->write($outfile)
1135 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1137 $content = readfile($outfile);
1139 # Unlinking should happen automatically, thanks to File::Temp,
1140 # but it does not work here, probably because of the way writefile()
1141 # and Locale::Po4a::write() work.
1142 unlink $infile, $outfile;
1147 # returns a SuccessReason or FailReason object
1149 my $content = shift;
1151 # NB: we don't use po_to_markup here, since Po4a parser does
1152 # not mind invalid PO content
1153 $content = '' unless defined $content;
1154 $content = decode_utf8(encode_utf8($content));
1156 # There are incompatibilities between some File::Temp versions
1157 # (including 0.18, bundled with Lenny's perl-modules package)
1158 # and others (e.g. 0.20, previously present in the archive as
1159 # a standalone package): under certain circumstances, some
1160 # return a relative filename, whereas others return an absolute one;
1161 # we here use this module in a way that is at least compatible
1162 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1163 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1164 DIR => File::Spec->tmpdir,
1165 UNLINK => 1)->filename;
1167 my $fail = sub ($) {
1168 my $msg = '[po/isvalidpo] ' . shift;
1170 return IkiWiki::FailReason->new("$msg");
1173 writefile(basename($infile), File::Spec->tmpdir, $content)
1174 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1176 my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1178 # Unlinking should happen automatically, thanks to File::Temp,
1179 # but it does not work here, probably because of the way writefile()
1180 # and Locale::Po4a::write() work.
1184 return IkiWiki::SuccessReason->new("valid gettext data");
1186 return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
1187 "to previous page to continue edit"));
1193 my $pagetype = pagetype($file);
1194 if ($pagetype eq 'html') {
1200 sub po4a_options($) {
1204 my $pagetype = pagetype($file);
1206 if ($pagetype eq 'html') {
1207 # how to disable options is not consistent across po4a modules
1208 $options{includessi} = '';
1209 $options{includeexternal} = 0;
1211 elsif ($pagetype eq 'mdwn') {
1212 $options{markdown} = 1;
1215 $options{markdown} = 0;
1225 package IkiWiki::PageSpec;
1227 sub match_istranslation ($;@) {
1230 if (IkiWiki::Plugin::po::istranslation($page)) {
1231 return IkiWiki::SuccessReason->new("is a translation page");
1234 return IkiWiki::FailReason->new("is not a translation page");
1238 sub match_istranslatable ($;@) {
1241 if (IkiWiki::Plugin::po::istranslatable($page)) {
1242 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1245 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1249 sub match_lang ($$;@) {
1253 my $regexp=IkiWiki::glob2re($wanted);
1254 my $lang=IkiWiki::Plugin::po::lang($page);
1255 if ($lang !~ /^$regexp$/i) {
1256 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1259 return IkiWiki::SuccessReason->new("file language is $wanted");
1263 sub match_currentlang ($$;@) {
1268 return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1270 my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1271 my $lang=IkiWiki::Plugin::po::lang($page);
1273 if ($lang eq $currentlang) {
1274 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1277 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
1281 sub match_needstranslation ($$;@) {
1285 if (defined $wanted && $wanted ne "") {
1286 if ($wanted !~ /^\d+$/) {
1287 return IkiWiki::FailReason->new("parameter is not an integer");
1289 elsif ($wanted > 100) {
1290 return IkiWiki::FailReason->new("parameter is greater than 100");
1297 my $percenttranslated=IkiWiki::Plugin::po::percenttranslated($page);
1298 if ($percenttranslated eq 'N/A') {
1299 return IkiWiki::FailReason->new("file is not a translatable page");
1301 elsif ($percenttranslated < $wanted) {
1302 return IkiWiki::SuccessReason->new("file has $percenttranslated translated");
1305 return IkiWiki::FailReason->new("file is translated enough");