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;
32 memoize("istranslatable");
33 memoize("_istranslation");
34 memoize("percenttranslated");
37 hook(type => "getsetup", id => "po", call => \&getsetup);
38 hook(type => "checkconfig", id => "po", call => \&checkconfig);
39 hook(type => "needsbuild", id => "po", call => \&needsbuild);
40 hook(type => "scan", id => "po", call => \&scan, last => 1);
41 hook(type => "filter", id => "po", call => \&filter);
42 hook(type => "htmlize", id => "po", call => \&htmlize);
43 hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
44 hook(type => "rename", id => "po", call => \&renamepages, first => 1);
45 hook(type => "delete", id => "po", call => \&mydelete);
46 hook(type => "change", id => "po", call => \&change);
47 hook(type => "checkcontent", id => "po", call => \&checkcontent);
48 hook(type => "canremove", id => "po", call => \&canremove);
49 hook(type => "canrename", id => "po", call => \&canrename);
50 hook(type => "editcontent", id => "po", call => \&editcontent);
51 hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
52 hook(type => "formbuilder", id => "po", call => \&formbuilder);
54 $origsubs{'bestlink'}=\&IkiWiki::bestlink;
55 inject(name => "IkiWiki::bestlink", call => \&mybestlink);
56 $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
57 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
58 $origsubs{'targetpage'}=\&IkiWiki::targetpage;
59 inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
60 $origsubs{'urlto'}=\&IkiWiki::urlto;
61 inject(name => "IkiWiki::urlto", call => \&myurlto);
62 $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
63 inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
72 # 2. Injected functions
73 # 3. Blackboxes for private data
88 po_master_language => {
94 description => "master language (non-PO files)",
98 po_slave_languages => {
105 description => "slave languages (PO files)",
109 po_translatable_pages => {
111 example => "* and !*/Discussion",
112 description => "PageSpec controlling which pages are translatable",
113 link => "ikiwiki/PageSpec",
119 example => "current",
120 description => "internal linking behavior (default/current/negotiated)",
127 foreach my $field (qw{po_master_language}) {
128 if (! exists $config{$field} || ! defined $config{$field}) {
129 error(sprintf(gettext("Must specify %s when using the %s plugin"),
136 or error(sprintf(gettext("%s is not a valid language code"), $_));
137 } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
139 if (! exists $config{po_translatable_pages} ||
140 ! defined $config{po_translatable_pages}) {
141 $config{po_translatable_pages}="";
143 if (! exists $config{po_link_to} ||
144 ! defined $config{po_link_to}) {
145 $config{po_link_to}='default';
147 elsif ($config{po_link_to} !~ /^(default|current|negotiated)$/) {
148 warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
149 $config{po_link_to}));
150 $config{po_link_to}='default';
152 elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
153 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
154 $config{po_link_to}='default';
157 push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
159 # Translated versions of the underlays are added if available.
160 foreach my $underlay ("basewiki",
161 map { m/^\Q$config{underlaydirbase}\E\/*(.*)/ }
162 reverse @{$config{underlaydirs}}) {
163 next if $underlay=~/^locale\//;
165 # Underlays containing the po files for slave languages.
166 foreach my $ll (keys %{$config{po_slave_languages}}) {
167 add_underlay("po/$ll/$underlay")
168 if -d "$config{underlaydirbase}/po/$ll/$underlay";
171 if ($config{po_master_language}{code} ne 'en') {
172 # Add underlay containing translated source files
173 # for the master language.
174 add_underlay("locale/$config{po_master_language}{code}/$underlay");
180 my $needsbuild=shift;
182 # backup @needsbuild content so that change() can know whether
183 # a given master page was rendered because its source file was changed
184 @origneedsbuild=(@$needsbuild);
187 buildtranslationscache();
189 # make existing translations depend on the corresponding master page
190 foreach my $master (keys %translations) {
191 map add_depends($_, $master), values %{otherlanguages($master)};
195 # Massage the recorded state of internal links so that:
196 # - it matches the actually generated links, rather than the links as written
197 # in the pages' source
198 # - backlinks are consistent in all cases
201 my $page=$params{page};
202 my $content=$params{content};
204 if (istranslation($page)) {
205 foreach my $destpage (@{$links{$page}}) {
206 if (istranslatable($destpage)) {
207 # replace one occurence of $destpage in $links{$page}
208 # (we only want to replace the one that was added by
209 # IkiWiki::Plugin::link::scan, other occurences may be
210 # there for other reasons)
211 for (my $i=0; $i<@{$links{$page}}; $i++) {
212 if (@{$links{$page}}[$i] eq $destpage) {
213 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
220 elsif (! istranslatable($page) && ! istranslation($page)) {
221 foreach my $destpage (@{$links{$page}}) {
222 if (istranslatable($destpage)) {
223 # make sure any destpage's translations has
224 # $page in its backlinks
225 push @{$links{$page}},
226 values %{otherlanguages($destpage)};
232 # We use filter to convert PO to the master page's format,
233 # since the rest of ikiwiki should not work on PO files.
237 my $page = $params{page};
238 my $destpage = $params{destpage};
239 my $content = $params{content};
240 if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
241 $content = po_to_markup($page, $content);
242 setalreadyfiltered($page, $destpage);
250 my $page = $params{page};
251 my $content = $params{content};
253 # ignore PO files this plugin did not create
254 return $content unless istranslation($page);
256 # force content to be htmlize'd as if it was the same type as the master page
257 return IkiWiki::htmlize($page, $page,
258 pagetype(srcfile($pagesources{masterpage($page)})),
262 sub pagetemplate (@) {
264 my $page=$params{page};
265 my $destpage=$params{destpage};
266 my $template=$params{template};
268 my ($masterpage, $lang) = istranslation($page);
270 if (istranslation($page) && $template->query(name => "percenttranslated")) {
271 $template->param(percenttranslated => percenttranslated($page));
273 if ($template->query(name => "istranslation")) {
274 $template->param(istranslation => scalar istranslation($page));
276 if ($template->query(name => "istranslatable")) {
277 $template->param(istranslatable => istranslatable($page));
279 if ($template->query(name => "HOMEPAGEURL")) {
280 $template->param(homepageurl => homepageurl($page));
282 if ($template->query(name => "otherlanguages")) {
283 $template->param(otherlanguages => [otherlanguagesloop($page)]);
284 map add_depends($page, $_), (values %{otherlanguages($page)});
286 if ($config{discussion} && istranslation($page)) {
287 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
288 (length $config{cgiurl} ||
289 exists $links{$masterpage."/".lc($config{discussionpage})})) {
290 $template->param('discussionlink' => htmllink(
293 $masterpage . '/' . $config{discussionpage},
296 linktext => $config{discussionpage},
300 # Remove broken parentlink to ./index.html on home page's translations.
301 # It works because this hook has the "last" parameter set, to ensure it
302 # runs after parentlinks' own pagetemplate hook.
303 if ($template->param('parentlinks')
304 && istranslation($page)
305 && $masterpage eq "index") {
306 $template->param('parentlinks' => []);
310 # Add the renamed page translations to the list of to-be-renamed pages.
311 sub renamepages (@) {
314 my %torename = %{$params{torename}};
315 my $session = $params{session};
317 # Save the page(s) the user asked to rename, so that our
318 # canrename hook can tell the difference between:
319 # - a translation being renamed as a consequence of its master page
321 # - a user trying to directly rename a translation
322 # This is why this hook has to be run first, before the list of pages
323 # to rename is modified by other plugins.
325 @orig_torename=@{$session->param("po_orig_torename")}
326 if defined $session->param("po_orig_torename");
327 push @orig_torename, $torename{src};
328 $session->param(po_orig_torename => \@orig_torename);
329 IkiWiki::cgi_savesession($session);
331 return () unless istranslatable($torename{src});
334 my %otherpages=%{otherlanguages($torename{src})};
335 while (my ($lang, $otherpage) = each %otherpages) {
338 srcfile => $pagesources{$otherpage},
339 dest => otherlanguage($torename{dest}, $lang),
340 destfile => $torename{dest}.".".$lang.".po",
350 map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
356 # All meta titles are first extracted at scan time, i.e. before we turn
357 # PO files back into translated markdown; escaping of double-quotes in
358 # PO files breaks the meta plugin's parsing enough to save ugly titles
359 # to %pagestate at this time.
361 # Then, at render time, every page passes in turn through the Great
362 # Rendering Chain (filter->preprocess->linkify->htmlize), and the meta
363 # plugin's preprocess hook is this time in a position to correctly
364 # extract the titles from slave pages.
366 # This is, unfortunately, too late: if the page A, linking to the page
367 # B, is rendered before B, it will display the wrongly-extracted meta
368 # title as the link text to B.
370 # On the one hand, such a corner case only happens on rebuild: on
371 # refresh, every rendered page is fixed to contain correct meta titles.
372 # On the other hand, it can take some time to get every page fixed.
373 # We therefore re-render every rendered page after a rebuild to fix them
374 # at once. As this more or less doubles the time needed to rebuild the
375 # wiki, we do so only when really needed.
378 && exists $config{rebuild} && defined $config{rebuild} && $config{rebuild}
379 && UNIVERSAL::can("IkiWiki::Plugin::meta", "getsetup")
380 && exists $config{meta_overrides_page_title}
381 && defined $config{meta_overrides_page_title}
382 && $config{meta_overrides_page_title}) {
383 debug(sprintf(gettext("rebuilding all pages to fix meta titles")));
384 resetalreadyfiltered();
385 require IkiWiki::Render;
386 foreach my $file (@rendered) {
387 debug(sprintf(gettext("building %s"), $file));
388 IkiWiki::render($file);
392 my $updated_po_files=0;
394 # Refresh/create POT and PO files as needed.
395 # (But avoid doing so if they are in an underlay directory.)
396 foreach my $file (grep {istranslatablefile($_)} @rendered) {
397 my $masterfile=srcfile($file);
398 my $page=pagename($file);
399 my $updated_pot_file=0;
400 # Only refresh POT file if it does not exist, or if
401 # $pagesources{$page} was changed: don't if only the HTML was
402 # refreshed, e.g. because of a dependency.
403 if ($masterfile eq "$config{srcdir}/$file" &&
404 ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
405 || ! -e potfile($masterfile))) {
406 refreshpot($masterfile);
410 foreach my $po (pofiles($masterfile)) {
411 next if ! $updated_pot_file && ! -e $po;
412 next if grep { $po=~/\Q$_\E/ } @{$config{underlaydirs}};
416 refreshpofiles($masterfile, @pofiles);
417 map { s/^\Q$config{srcdir}\E\/*//; IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
422 if ($updated_po_files) {
424 gettext("updated PO files"),
425 "IkiWiki::Plugin::po::change");
429 sub checkcontent (@) {
432 if (istranslation($params{page})) {
433 my $res = isvalidpo($params{content});
447 if (istranslation($params{page})) {
448 return gettext("Can not remove a translation. If the master page is removed, ".
449 "however, its translations will be removed as well.");
456 my $session = $params{session};
458 if (istranslation($params{src})) {
459 my $masterpage = masterpage($params{src});
460 # Tell the difference between:
461 # - a translation being renamed as a consequence of its master page
462 # being renamed, which is allowed
463 # - a user trying to directly rename a translation, which is forbidden
464 # by looking for the master page in the list of to-be-renamed pages we
465 # saved early in the renaming process.
466 my $orig_torename = $session->param("po_orig_torename");
467 unless (grep { $_ eq $masterpage } @{$orig_torename}) {
468 return gettext("Can not rename a translation. If the master page is renamed, ".
469 "however, its translations will be renamed as well.");
475 # As we're previewing or saving a page, the content may have
476 # changed, so tell the next filter() invocation it must not be lazy.
480 unsetalreadyfiltered($params{page}, $params{page});
481 return $params{content};
484 sub formbuilder_setup (@) {
486 my $form=$params{form};
489 return unless defined $form->field("do");
491 if ($form->field("do") eq "create") {
492 # Warn the user: new pages must be written in master language.
493 my $template=template("pocreatepage.tmpl");
494 $template->param(LANG => $config{po_master_language}{name});
495 $form->tmpl_param(message => $template->output);
497 elsif ($form->field("do") eq "edit") {
498 # Remove the rename/remove buttons on slave pages.
499 # This has to be done after the rename/remove plugins have added
500 # their buttons, which is why this hook must be run last.
501 # The canrename/canremove hooks already ensure this is forbidden
502 # at the backend level, so this is only UI sugar.
503 if (istranslation($form->field("page"))) {
505 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
506 if (@{$params{buttons}}[$i] eq $_) {
507 delete @{$params{buttons}}[$i];
516 sub formbuilder (@) {
518 my $form=$params{form};
521 return unless defined $form->field("do");
523 # Do not allow to create pages of type po: they are automatically created.
524 # The main reason to do so is to bypass the "favor the type of linking page
525 # on page creation" logic, which is unsuitable when a broken link is clicked
526 # on a slave (PO) page.
527 # This cannot be done in the formbuilder_setup hook as the list of types is
529 if ($form->field("do") eq "create") {
530 foreach my $field ($form->field) {
531 next unless "$field" eq "type";
532 if ($field->type eq 'select') {
533 # remove po from the list of types
534 my @types = grep { $_ ne 'po' } $field->options;
535 $field->options(\@types) if @types;
542 # | Injected functions
545 # Implement po_link_to 'current' and 'negotiated' settings.
546 sub mybestlink ($$) {
550 return $origsubs{'bestlink'}->($page, $link)
551 if $config{po_link_to} eq "default";
553 my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
555 && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated")
556 && istranslatable($res)
557 && istranslation($page)) {
558 return $res . "." . lang($page);
563 sub mybeautify_urlpath ($) {
566 my $res=$origsubs{'beautify_urlpath'}->($url);
567 if ($config{po_link_to} eq "negotiated") {
568 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
569 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
571 $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
572 } (keys %{$config{po_slave_languages}});
577 sub mytargetpage ($$) {
581 if (istranslation($page) || istranslatable($page)) {
582 my ($masterpage, $lang) = (masterpage($page), lang($page));
583 if (! $config{usedirs} || $masterpage eq 'index') {
584 return $masterpage . "." . $lang . "." . $ext;
587 return $masterpage . "/index." . $lang . "." . $ext;
590 return $origsubs{'targetpage'}->($page, $ext);
598 # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
600 && $config{po_link_to} eq "current"
601 && istranslatable('index')) {
602 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
604 # avoid using our injected beautify_urlpath if run by cgi_editpage,
605 # so that one is redirected to the just-edited page rather than to the
606 # negociated translation; to prevent unnecessary fiddling with caller/inject,
607 # we only do so when our beautify_urlpath would actually do what we want to
608 # avoid, i.e. when po_link_to = negotiated.
609 # also avoid doing so when run by cgi_goto, so that the links on recentchanges
610 # page actually lead to the exact page they pretend to.
611 if ($config{po_link_to} eq "negotiated") {
612 my @caller = caller(1);
614 $use_orig = 1 if (exists $caller[3] && defined $caller[3]
615 && ($caller[3] eq "IkiWiki::cgi_editpage" ||
616 $caller[3] eq "IkiWiki::Plugin::goto::cgi_goto")
618 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
620 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
621 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
626 return $origsubs{'urlto'}->($to,$from,$absolute)
633 # slave pages have no subpages
634 if (istranslation($params{'from'})) {
635 $params{'from'} = masterpage($params{'from'});
637 return $origsubs{'cgiurl'}->(%params);
641 # | Blackboxes for private data
647 sub alreadyfiltered($$) {
651 return exists $filtered{$page}{$destpage}
652 && $filtered{$page}{$destpage} eq 1;
655 sub setalreadyfiltered($$) {
659 $filtered{$page}{$destpage}=1;
662 sub unsetalreadyfiltered($$) {
666 if (exists $filtered{$page}{$destpage}) {
667 delete $filtered{$page}{$destpage};
671 sub resetalreadyfiltered() {
680 sub maybe_add_leading_slash ($;$) {
683 $add=1 unless defined $add;
684 return '/' . $str if $add;
688 sub istranslatablefile ($) {
691 return 0 unless defined $file;
692 my $type=pagetype($file);
693 return 0 if ! defined $type || $type eq 'po';
694 return 0 if $file =~ /\.pot$/;
695 return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
699 sub istranslatable ($) {
703 return 1 if istranslatablefile($pagesources{$page});
707 sub _istranslation ($) {
710 $page='' unless defined $page && length $page;
711 my $hasleadingslash = ($page=~s#^/##);
712 my $file=$pagesources{$page};
713 return 0 unless defined $file
714 && defined pagetype($file)
715 && pagetype($file) eq 'po';
716 return 0 if $file =~ /\.pot$/;
718 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
719 return 0 unless defined $masterpage && defined $lang
720 && length $masterpage && length $lang
721 && defined $pagesources{$masterpage}
722 && defined $config{po_slave_languages}{$lang};
724 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
725 if istranslatable($masterpage);
728 sub istranslation ($) {
731 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
732 my $hasleadingslash = ($masterpage=~s#^/##);
733 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
734 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
742 if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
751 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
754 return $config{po_master_language}{code};
757 sub islanguagecode ($) {
760 return $code =~ /^[a-z]{2}$/;
763 sub otherlanguage ($$) {
767 return masterpage($page) if $code eq $config{po_master_language}{code};
768 return masterpage($page) . '.' . $code;
771 sub otherlanguages ($) {
775 return \%ret unless istranslation($page) || istranslatable($page);
776 my $curlang=lang($page);
778 ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
779 next if $lang eq $curlang;
780 $ret{$lang}=otherlanguage($page, $lang);
786 my $masterfile=shift;
788 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
789 $dir='' if $dir eq './';
790 return File::Spec->catpath('', $dir, $name . ".pot");
794 my $masterfile=shift;
797 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
798 $dir='' if $dir eq './';
799 return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
803 my $masterfile=shift;
805 return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
809 my $masterfile=shift;
811 my $potfile=potfile($masterfile);
812 my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
813 my $doc=Locale::Po4a::Chooser::new('text',%options);
814 $doc->{TT}{utf_mode} = 1;
815 $doc->{TT}{file_in_charset} = 'utf-8';
816 $doc->{TT}{file_out_charset} = 'utf-8';
817 $doc->read($masterfile);
818 # let's cheat a bit to force porefs option to be passed to
819 # Locale::Po4a::Po; this is undocument use of internal
820 # Locale::Po4a::TransTractor's data, compulsory since this module
821 # prevents us from using the porefs option.
822 $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
823 $doc->{TT}{po_out}->set_charset('utf-8');
826 IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
827 $doc->writepo($potfile);
830 sub refreshpofiles ($@) {
831 my $masterfile=shift;
834 my $potfile=potfile($masterfile);
836 error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
839 foreach my $pofile (@pofiles) {
840 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
843 # If the po file exists in an underlay, copy it
845 my ($pobase)=$pofile=~/^\Q$config{srcdir}\E\/?(.*)$/;
846 foreach my $dir (@{$config{underlaydirs}}) {
847 if (-e "$dir/$pobase") {
848 File::Copy::syscopy("$dir/$pobase",$pofile)
849 or error("po(refreshpofiles) ".
850 sprintf(gettext("failed to copy underlay PO file to %s"),
857 system("msgmerge", "--previous", "-q", "-U", "--backup=none", $pofile, $potfile) == 0
858 or error("po(refreshpofiles) ".
859 sprintf(gettext("failed to update %s"),
863 File::Copy::syscopy($potfile,$pofile)
864 or error("po(refreshpofiles) ".
865 sprintf(gettext("failed to copy the POT file to %s"),
871 sub buildtranslationscache() {
872 # use istranslation's side-effect
873 map istranslation($_), (keys %pagesources);
876 sub resettranslationscache() {
880 sub flushmemoizecache() {
881 Memoize::flush_cache("istranslatable");
882 Memoize::flush_cache("_istranslation");
883 Memoize::flush_cache("percenttranslated");
886 sub urlto_with_orig_beautiful_urlpath($$) {
890 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
891 my $res=urlto($to, $from);
892 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
897 sub percenttranslated ($) {
901 return gettext("N/A") unless istranslation($page);
902 my $file=srcfile($pagesources{$page});
903 my $masterfile = srcfile($pagesources{masterpage($page)});
905 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
907 my $doc=Locale::Po4a::Chooser::new('text',%options);
909 'po_in_name' => [ $file ],
910 'file_in_name' => [ $masterfile ],
911 'file_in_charset' => 'utf-8',
912 'file_out_charset' => 'utf-8',
913 ) or error("po(percenttranslated) ".
914 sprintf(gettext("failed to translate %s"), $page));
915 my ($percent,$hit,$queries) = $doc->stats();
916 $percent =~ s/\.[0-9]+$//;
920 sub languagename ($) {
923 return $config{po_master_language}{name}
924 if $code eq $config{po_master_language}{code};
925 return $config{po_slave_languages}{$code}
926 if defined $config{po_slave_languages}{$code};
930 sub otherlanguagesloop ($) {
934 my %otherpages=%{otherlanguages($page)};
935 while (my ($lang, $otherpage) = each %otherpages) {
936 if (istranslation($page) && masterpage($page) eq $otherpage) {
938 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
940 language => languagename($lang),
944 elsif (istranslation($otherpage)) {
946 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
948 language => languagename($lang),
949 percent => percenttranslated($otherpage),
954 return -1 if $a->{code} eq $config{po_master_language}{code};
955 return 1 if $b->{code} eq $config{po_master_language}{code};
956 return $a->{language} cmp $b->{language};
960 sub homepageurl (;$) {
963 return urlto('', $page);
966 sub deletetranslations ($) {
967 my $deletedmasterfile=shift;
969 my $deletedmasterpage=pagename($deletedmasterfile);
972 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
973 my $absfile = "$config{srcdir}/$file";
974 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
975 push @todelete, $file;
977 } keys %{$config{po_slave_languages}};
981 IkiWiki::rcs_remove($_);
984 IkiWiki::prune("$config{srcdir}/$_");
990 gettext("removed obsolete PO files"),
991 "IkiWiki::Plugin::po::deletetranslations");
995 sub commit_and_refresh ($$) {
996 my ($msg, $author) = (shift, shift);
999 IkiWiki::disable_commit_hook();
1000 IkiWiki::rcs_commit_staged($msg, $author, "127.0.0.1");
1001 IkiWiki::enable_commit_hook();
1002 IkiWiki::rcs_update();
1004 # Reinitialize module's private variables.
1005 resetalreadyfiltered();
1006 resettranslationscache();
1007 flushmemoizecache();
1008 # Trigger a wiki refresh.
1009 require IkiWiki::Render;
1010 # without preliminary saveindex/loadindex, refresh()
1011 # complains about a lot of uninitialized variables
1012 IkiWiki::saveindex();
1013 IkiWiki::loadindex();
1015 IkiWiki::saveindex();
1018 # on success, returns the filtered content.
1019 # on error, if $nonfatal, warn and return undef; else, error out.
1020 sub po_to_markup ($$;$) {
1021 my ($page, $content) = (shift, shift);
1022 my $nonfatal = shift;
1024 $content = '' unless defined $content;
1025 $content = decode_utf8(encode_utf8($content));
1026 # CRLF line terminators make poor Locale::Po4a feel bad
1027 $content=~s/\r\n/\n/g;
1029 # There are incompatibilities between some File::Temp versions
1030 # (including 0.18, bundled with Lenny's perl-modules package)
1031 # and others (e.g. 0.20, previously present in the archive as
1032 # a standalone package): under certain circumstances, some
1033 # return a relative filename, whereas others return an absolute one;
1034 # we here use this module in a way that is at least compatible
1035 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1036 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
1037 DIR => File::Spec->tmpdir,
1038 UNLINK => 1)->filename;
1039 my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
1040 DIR => File::Spec->tmpdir,
1041 UNLINK => 1)->filename;
1043 my $fail = sub ($) {
1044 my $msg = "po(po_to_markup) - $page : " . shift;
1049 error($msg, sub { unlink $infile, $outfile});
1052 writefile(basename($infile), File::Spec->tmpdir, $content)
1053 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1055 my $masterfile = srcfile($pagesources{masterpage($page)});
1057 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
1059 my $doc=Locale::Po4a::Chooser::new('text',%options);
1061 'po_in_name' => [ $infile ],
1062 'file_in_name' => [ $masterfile ],
1063 'file_in_charset' => 'utf-8',
1064 'file_out_charset' => 'utf-8',
1065 ) or return $fail->(gettext("failed to translate"));
1066 $doc->write($outfile)
1067 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1069 $content = readfile($outfile)
1070 or return $fail->(sprintf(gettext("failed to read %s"), $outfile));
1072 # Unlinking should happen automatically, thanks to File::Temp,
1073 # but it does not work here, probably because of the way writefile()
1074 # and Locale::Po4a::write() work.
1075 unlink $infile, $outfile;
1080 # returns a SuccessReason or FailReason object
1082 my $content = shift;
1084 # NB: we don't use po_to_markup here, since Po4a parser does
1085 # not mind invalid PO content
1086 $content = '' unless defined $content;
1087 $content = decode_utf8(encode_utf8($content));
1089 # There are incompatibilities between some File::Temp versions
1090 # (including 0.18, bundled with Lenny's perl-modules package)
1091 # and others (e.g. 0.20, previously present in the archive as
1092 # a standalone package): under certain circumstances, some
1093 # return a relative filename, whereas others return an absolute one;
1094 # we here use this module in a way that is at least compatible
1095 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1096 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1097 DIR => File::Spec->tmpdir,
1098 UNLINK => 1)->filename;
1100 my $fail = sub ($) {
1101 my $msg = '[po/isvalidpo] ' . shift;
1103 return IkiWiki::FailReason->new("$msg");
1106 writefile(basename($infile), File::Spec->tmpdir, $content)
1107 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1109 my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1111 # Unlinking should happen automatically, thanks to File::Temp,
1112 # but it does not work here, probably because of the way writefile()
1113 # and Locale::Po4a::write() work.
1117 return IkiWiki::SuccessReason->new("valid gettext data");
1119 return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
1120 "to previous page to continue edit"));
1127 package IkiWiki::PageSpec;
1129 sub match_istranslation ($;@) {
1132 if (IkiWiki::Plugin::po::istranslation($page)) {
1133 return IkiWiki::SuccessReason->new("is a translation page");
1136 return IkiWiki::FailReason->new("is not a translation page");
1140 sub match_istranslatable ($;@) {
1143 if (IkiWiki::Plugin::po::istranslatable($page)) {
1144 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1147 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1151 sub match_lang ($$;@) {
1155 my $regexp=IkiWiki::glob2re($wanted);
1156 my $lang=IkiWiki::Plugin::po::lang($page);
1157 if ($lang !~ /^$regexp$/i) {
1158 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1161 return IkiWiki::SuccessReason->new("file language is $wanted");
1165 sub match_currentlang ($$;@) {
1170 return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1172 my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1173 my $lang=IkiWiki::Plugin::po::lang($page);
1175 if ($lang eq $currentlang) {
1176 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1179 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");