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 use Locale::Po4a::Common qw(nowrapi18n);
14 use Locale::Po4a::Chooser;
27 memoize("istranslatable");
28 memoize("_istranslation");
29 memoize("percenttranslated");
32 hook(type => "getsetup", id => "po", call => \&getsetup);
33 hook(type => "checkconfig", id => "po", call => \&checkconfig);
34 hook(type => "needsbuild", id => "po", call => \&needsbuild);
35 hook(type => "scan", id => "po", call => \&scan, last => 1);
36 hook(type => "filter", id => "po", call => \&filter);
37 hook(type => "htmlize", id => "po", call => \&htmlize);
38 hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
39 hook(type => "rename", id => "po", call => \&renamepages, first => 1);
40 hook(type => "delete", id => "po", call => \&mydelete);
41 hook(type => "change", id => "po", call => \&change);
42 hook(type => "checkcontent", id => "po", call => \&checkcontent);
43 hook(type => "canremove", id => "po", call => \&canremove);
44 hook(type => "canrename", id => "po", call => \&canrename);
45 hook(type => "editcontent", id => "po", call => \&editcontent);
46 hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
47 hook(type => "formbuilder", id => "po", call => \&formbuilder);
49 $origsubs{'bestlink'}=\&IkiWiki::bestlink;
50 inject(name => "IkiWiki::bestlink", call => \&mybestlink);
51 $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
52 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
53 $origsubs{'targetpage'}=\&IkiWiki::targetpage;
54 inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
55 $origsubs{'urlto'}=\&IkiWiki::urlto;
56 inject(name => "IkiWiki::urlto", call => \&myurlto);
57 $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
58 inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
67 # 2. Injected functions
68 # 3. Blackboxes for private data
83 po_master_language => {
89 description => "master language (non-PO files)",
93 po_slave_languages => {
100 description => "slave languages (PO files)",
104 po_translatable_pages => {
106 example => "!*/Discussion",
107 description => "PageSpec controlling which pages are translatable",
108 link => "ikiwiki/PageSpec",
114 example => "current",
115 description => "internal linking behavior (default/current/negotiated)",
122 foreach my $field (qw{po_master_language po_slave_languages}) {
123 if (! exists $config{$field} || ! defined $config{$field}) {
124 error(sprintf(gettext("Must specify %s when using the %s plugin"),
128 if (! (keys %{$config{po_slave_languages}})) {
129 error(gettext("At least one slave language must be defined ".
130 "in po_slave_languages when using the po plugin"));
134 or error(sprintf(gettext("%s is not a valid language code"), $_));
135 } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
136 if (! exists $config{po_translatable_pages} ||
137 ! defined $config{po_translatable_pages}) {
138 $config{po_translatable_pages}="";
140 if (! exists $config{po_link_to} ||
141 ! defined $config{po_link_to}) {
142 $config{po_link_to}='default';
144 elsif ($config{po_link_to} !~ /^(default|current|negotiated)$/) {
145 warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
146 $config{po_link_to}));
147 $config{po_link_to}='default';
149 elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
150 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
151 $config{po_link_to}='default';
153 push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
157 my $needsbuild=shift;
159 # backup @needsbuild content so that change() can know whether
160 # a given master page was rendered because its source file was changed
161 @origneedsbuild=(@$needsbuild);
164 buildtranslationscache();
166 # make existing translations depend on the corresponding master page
167 foreach my $master (keys %translations) {
168 map add_depends($_, $master), values %{otherlanguages($master)};
172 # Massage the recorded state of internal links so that:
173 # - it matches the actually generated links, rather than the links as written
174 # in the pages' source
175 # - backlinks are consistent in all cases
178 my $page=$params{page};
179 my $content=$params{content};
181 if (istranslation($page)) {
182 foreach my $destpage (@{$links{$page}}) {
183 if (istranslatable($destpage)) {
184 # replace one occurence of $destpage in $links{$page}
185 # (we only want to replace the one that was added by
186 # IkiWiki::Plugin::link::scan, other occurences may be
187 # there for other reasons)
188 for (my $i=0; $i<@{$links{$page}}; $i++) {
189 if (@{$links{$page}}[$i] eq $destpage) {
190 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
197 elsif (! istranslatable($page) && ! istranslation($page)) {
198 foreach my $destpage (@{$links{$page}}) {
199 if (istranslatable($destpage)) {
200 # make sure any destpage's translations has
201 # $page in its backlinks
202 push @{$links{$page}},
203 values %{otherlanguages($destpage)};
209 # We use filter to convert PO to the master page's format,
210 # since the rest of ikiwiki should not work on PO files.
214 my $page = $params{page};
215 my $destpage = $params{destpage};
216 my $content = $params{content};
217 if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
218 $content = po_to_markup($page, $content);
219 setalreadyfiltered($page, $destpage);
227 my $page = $params{page};
228 my $content = $params{content};
230 # ignore PO files this plugin did not create
231 return $content unless istranslation($page);
233 # force content to be htmlize'd as if it was the same type as the master page
234 return IkiWiki::htmlize($page, $page,
235 pagetype(srcfile($pagesources{masterpage($page)})),
239 sub pagetemplate (@) {
241 my $page=$params{page};
242 my $destpage=$params{destpage};
243 my $template=$params{template};
245 my ($masterpage, $lang) = istranslation($page);
247 if (istranslation($page) && $template->query(name => "percenttranslated")) {
248 $template->param(percenttranslated => percenttranslated($page));
250 if ($template->query(name => "istranslation")) {
251 $template->param(istranslation => scalar istranslation($page));
253 if ($template->query(name => "istranslatable")) {
254 $template->param(istranslatable => istranslatable($page));
256 if ($template->query(name => "HOMEPAGEURL")) {
257 $template->param(homepageurl => homepageurl($page));
259 if ($template->query(name => "otherlanguages")) {
260 $template->param(otherlanguages => [otherlanguagesloop($page)]);
261 map add_depends($page, $_), (values %{otherlanguages($page)});
263 # Rely on IkiWiki::Render's genpage() to decide wether
264 # a discussion link should appear on $page; this is not
265 # totally accurate, though: some broken links may be generated
266 # when cgiurl is disabled.
267 # This compromise avoids some code duplication, and will probably
268 # prevent future breakage when ikiwiki internals change.
269 # Known limitations are preferred to future random bugs.
270 if ($template->param('discussionlink') && istranslation($page)) {
271 $template->param('discussionlink' => htmllink(
274 $masterpage . '/' . gettext("Discussion"),
277 linktext => gettext("Discussion"),
280 # Remove broken parentlink to ./index.html on home page's translations.
281 # It works because this hook has the "last" parameter set, to ensure it
282 # runs after parentlinks' own pagetemplate hook.
283 if ($template->param('parentlinks')
284 && istranslation($page)
285 && $masterpage eq "index") {
286 $template->param('parentlinks' => []);
290 # Add the renamed page translations to the list of to-be-renamed pages.
291 sub renamepages (@) {
294 my %torename = %{$params{torename}};
295 my $session = $params{session};
297 # Save the page(s) the user asked to rename, so that our
298 # canrename hook can tell the difference between:
299 # - a translation being renamed as a consequence of its master page
301 # - a user trying to directly rename a translation
302 # This is why this hook has to be run first, before the list of pages
303 # to rename is modified by other plugins.
305 @orig_torename=@{$session->param("po_orig_torename")}
306 if defined $session->param("po_orig_torename");
307 push @orig_torename, $torename{src};
308 $session->param(po_orig_torename => \@orig_torename);
309 IkiWiki::cgi_savesession($session);
311 return () unless istranslatable($torename{src});
314 my %otherpages=%{otherlanguages($torename{src})};
315 while (my ($lang, $otherpage) = each %otherpages) {
318 srcfile => $pagesources{$otherpage},
319 dest => otherlanguage($torename{dest}, $lang),
320 destfile => $torename{dest}.".".$lang.".po",
330 map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
336 # All meta titles are first extracted at scan time, i.e. before we turn
337 # PO files back into translated markdown; escaping of double-quotes in
338 # PO files breaks the meta plugin's parsing enough to save ugly titles
339 # to %pagestate at this time.
341 # Then, at render time, every page passes in turn through the Great
342 # Rendering Chain (filter->preprocess->linkify->htmlize), and the meta
343 # plugin's preprocess hook is this time in a position to correctly
344 # extract the titles from slave pages.
346 # This is, unfortunately, too late: if the page A, linking to the page
347 # B, is rendered before B, it will display the wrongly-extracted meta
348 # title as the link text to B.
350 # On the one hand, such a corner case only happens on rebuild: on
351 # refresh, every rendered page is fixed to contain correct meta titles.
352 # On the other hand, it can take some time to get every page fixed.
353 # We therefore re-render every rendered page after a rebuild to fix them
354 # at once. As this more or less doubles the time needed to rebuild the
355 # wiki, we do so only when really needed.
358 && exists $config{rebuild} && defined $config{rebuild} && $config{rebuild}
359 && UNIVERSAL::can("IkiWiki::Plugin::meta", "getsetup")
360 && exists $config{meta_overrides_page_title}
361 && defined $config{meta_overrides_page_title}
362 && $config{meta_overrides_page_title}) {
363 debug(sprintf(gettext("re-rendering all pages to fix meta titles")));
364 resetalreadyfiltered();
365 require IkiWiki::Render;
366 foreach my $file (@rendered) {
367 debug(sprintf(gettext("rendering %s"), $file));
368 IkiWiki::render($file);
372 my $updated_po_files=0;
374 # Refresh/create POT and PO files as needed.
375 foreach my $file (grep {istranslatablefile($_)} @rendered) {
376 my $page=pagename($file);
377 my $masterfile=srcfile($file);
378 my $updated_pot_file=0;
379 # Only refresh Pot file if it does not exist, or if
380 # $pagesources{$page} was changed: don't if only the HTML was
381 # refreshed, e.g. because of a dependency.
382 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
383 || ! -e potfile($masterfile)) {
384 refreshpot($masterfile);
389 push @pofiles, $_ if ($updated_pot_file || ! -e $_);
390 } (pofiles($masterfile));
392 refreshpofiles($masterfile, @pofiles);
393 map { IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
398 if ($updated_po_files) {
400 gettext("updated PO files"),
401 "IkiWiki::Plugin::po::change");
405 sub checkcontent (@) {
408 if (istranslation($params{page})) {
409 my $res = isvalidpo($params{content});
423 if (istranslation($params{page})) {
424 return gettext("Can not remove a translation. Removing the master page, ".
425 "though, removes its translations as well.");
432 my $session = $params{session};
434 if (istranslation($params{src})) {
435 my $masterpage = masterpage($params{src});
436 # Tell the difference between:
437 # - a translation being renamed as a consequence of its master page
438 # being renamed, which is allowed
439 # - a user trying to directly rename a translation, which is forbidden
440 # by looking for the master page in the list of to-be-renamed pages we
441 # saved early in the renaming process.
442 my $orig_torename = $session->param("po_orig_torename");
443 unless (grep { $_ eq $masterpage } @{$orig_torename}) {
444 return gettext("Can not rename a translation. Renaming the master page, ".
445 "though, renames its translations as well.");
451 # As we're previewing or saving a page, the content may have
452 # changed, so tell the next filter() invocation it must not be lazy.
456 unsetalreadyfiltered($params{page}, $params{page});
457 return $params{content};
460 sub formbuilder_setup (@) {
462 my $form=$params{form};
465 return unless defined $form->field("do");
467 if ($form->field("do") eq "create") {
468 # Warn the user: new pages must be written in master language.
469 my $template=template("pocreatepage.tmpl");
470 $template->param(LANG => $config{po_master_language}{name});
471 $form->tmpl_param(message => $template->output);
473 elsif ($form->field("do") eq "edit") {
474 # Remove the rename/remove buttons on slave pages.
475 # This has to be done after the rename/remove plugins have added
476 # their buttons, which is why this hook must be run last.
477 # The canrename/canremove hooks already ensure this is forbidden
478 # at the backend level, so this is only UI sugar.
479 if (istranslation($form->field("page"))) {
481 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
482 if (@{$params{buttons}}[$i] eq $_) {
483 delete @{$params{buttons}}[$i];
492 sub formbuilder (@) {
494 my $form=$params{form};
497 return unless defined $form->field("do");
499 # Do not allow to create pages of type po: they are automatically created.
500 # The main reason to do so is to bypass the "favor the type of linking page
501 # on page creation" logic, which is unsuitable when a broken link is clicked
502 # on a slave (PO) page.
503 # This cannot be done in the formbuilder_setup hook as the list of types is
505 if ($form->field("do") eq "create") {
506 foreach my $field ($form->field) {
507 next unless "$field" eq "type";
508 if ($field->type eq 'select') {
509 # remove po from the list of types
510 my @types = grep { $_ ne 'po' } $field->options;
511 $field->options(\@types) if @types;
518 # | Injected functions
521 # Implement po_link_to 'current' and 'negotiated' settings.
522 sub mybestlink ($$) {
526 my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
528 && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated")
529 && istranslatable($res)
530 && istranslation($page)) {
531 return $res . "." . lang($page);
536 sub mybeautify_urlpath ($) {
539 my $res=$origsubs{'beautify_urlpath'}->($url);
540 if ($config{po_link_to} eq "negotiated") {
541 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
542 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
544 $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
545 } (keys %{$config{po_slave_languages}});
550 sub mytargetpage ($$) {
554 if (istranslation($page) || istranslatable($page)) {
555 my ($masterpage, $lang) = (masterpage($page), lang($page));
556 if (! $config{usedirs} || $masterpage eq 'index') {
557 return $masterpage . "." . $lang . "." . $ext;
560 return $masterpage . "/index." . $lang . "." . $ext;
563 return $origsubs{'targetpage'}->($page, $ext);
571 # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
573 && $config{po_link_to} eq "current"
574 && istranslatable('index')) {
575 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
577 # avoid using our injected beautify_urlpath if run by cgi_editpage,
578 # so that one is redirected to the just-edited page rather than to the
579 # negociated translation; to prevent unnecessary fiddling with caller/inject,
580 # we only do so when our beautify_urlpath would actually do what we want to
581 # avoid, i.e. when po_link_to = negotiated
582 if ($config{po_link_to} eq "negotiated") {
583 my @caller = caller(1);
584 my $run_by_editpage = 0;
585 $run_by_editpage = 1 if (exists $caller[3] && defined $caller[3]
586 && $caller[3] eq "IkiWiki::cgi_editpage");
587 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
589 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
590 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
595 return $origsubs{'urlto'}->($to,$from,$absolute)
602 # slave pages have no subpages
603 if (istranslation($params{'from'})) {
604 $params{'from'} = masterpage($params{'from'});
606 return $origsubs{'cgiurl'}->(%params);
610 # | Blackboxes for private data
616 sub alreadyfiltered($$) {
620 return exists $filtered{$page}{$destpage}
621 && $filtered{$page}{$destpage} eq 1;
624 sub setalreadyfiltered($$) {
628 $filtered{$page}{$destpage}=1;
631 sub unsetalreadyfiltered($$) {
635 if (exists $filtered{$page}{$destpage}) {
636 delete $filtered{$page}{$destpage};
640 sub resetalreadyfiltered() {
649 sub maybe_add_leading_slash ($;$) {
652 $add=1 unless defined $add;
653 return '/' . $str if $add;
657 sub istranslatablefile ($) {
660 return 0 unless defined $file;
661 return 0 if defined pagetype($file) && pagetype($file) eq 'po';
662 return 0 if $file =~ /\.pot$/;
663 return 0 unless -e "$config{srcdir}/$file"; # underlay dirs may be read-only
664 return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
668 sub istranslatable ($) {
672 return 1 if istranslatablefile($pagesources{$page});
676 sub _istranslation ($) {
679 $page='' unless defined $page && length $page;
680 my $hasleadingslash = ($page=~s#^/##);
681 my $file=$pagesources{$page};
682 return 0 unless defined $file
683 && defined pagetype($file)
684 && pagetype($file) eq 'po';
685 return 0 if $file =~ /\.pot$/;
687 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
688 return 0 unless defined $masterpage && defined $lang
689 && length $masterpage && length $lang
690 && defined $pagesources{$masterpage}
691 && defined $config{po_slave_languages}{$lang};
693 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
694 if istranslatable($masterpage);
697 sub istranslation ($) {
700 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
701 my $hasleadingslash = ($masterpage=~s#^/##);
702 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
703 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
711 if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
720 if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
723 return $config{po_master_language}{code};
726 sub islanguagecode ($) {
729 return $code =~ /^[a-z]{2}$/;
732 sub otherlanguage ($$) {
736 return masterpage($page) if $code eq $config{po_master_language}{code};
737 return masterpage($page) . '.' . $code;
740 sub otherlanguages ($) {
744 return \%ret unless istranslation($page) || istranslatable($page);
745 my $curlang=lang($page);
747 ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
748 next if $lang eq $curlang;
749 $ret{$lang}=otherlanguage($page, $lang);
755 my $masterfile=shift;
757 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
758 $dir='' if $dir eq './';
759 return File::Spec->catpath('', $dir, $name . ".pot");
763 my $masterfile=shift;
766 (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
767 $dir='' if $dir eq './';
768 return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
772 my $masterfile=shift;
774 return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
778 my $masterfile=shift;
780 my $potfile=potfile($masterfile);
781 my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
782 my $doc=Locale::Po4a::Chooser::new('text',%options);
783 $doc->{TT}{utf_mode} = 1;
784 $doc->{TT}{file_in_charset} = 'utf-8';
785 $doc->{TT}{file_out_charset} = 'utf-8';
786 $doc->read($masterfile);
787 # let's cheat a bit to force porefs option to be passed to
788 # Locale::Po4a::Po; this is undocument use of internal
789 # Locale::Po4a::TransTractor's data, compulsory since this module
790 # prevents us from using the porefs option.
791 $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
792 $doc->{TT}{po_out}->set_charset('utf-8');
795 IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
796 $doc->writepo($potfile);
799 sub refreshpofiles ($@) {
800 my $masterfile=shift;
803 my $potfile=potfile($masterfile);
805 error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
808 foreach my $pofile (@pofiles) {
809 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
811 system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
812 or error("po(refreshpofiles) ".
813 sprintf(gettext("failed to update %s"),
817 File::Copy::syscopy($potfile,$pofile)
818 or error("po(refreshpofiles) ".
819 sprintf(gettext("failed to copy the POT file to %s"),
825 sub buildtranslationscache() {
826 # use istranslation's side-effect
827 map istranslation($_), (keys %pagesources);
830 sub resettranslationscache() {
834 sub flushmemoizecache() {
835 Memoize::flush_cache("istranslatable");
836 Memoize::flush_cache("_istranslation");
837 Memoize::flush_cache("percenttranslated");
840 sub urlto_with_orig_beautiful_urlpath($$) {
844 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
845 my $res=urlto($to, $from);
846 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
851 sub percenttranslated ($) {
855 return gettext("N/A") unless istranslation($page);
856 my $file=srcfile($pagesources{$page});
857 my $masterfile = srcfile($pagesources{masterpage($page)});
859 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
861 my $doc=Locale::Po4a::Chooser::new('text',%options);
863 'po_in_name' => [ $file ],
864 'file_in_name' => [ $masterfile ],
865 'file_in_charset' => 'utf-8',
866 'file_out_charset' => 'utf-8',
867 ) or error("po(percenttranslated) ".
868 sprintf(gettext("failed to translate %s"), $page));
869 my ($percent,$hit,$queries) = $doc->stats();
870 $percent =~ s/\.[0-9]+$//;
874 sub languagename ($) {
877 return $config{po_master_language}{name}
878 if $code eq $config{po_master_language}{code};
879 return $config{po_slave_languages}{$code}
880 if defined $config{po_slave_languages}{$code};
884 sub otherlanguagesloop ($) {
888 my %otherpages=%{otherlanguages($page)};
889 while (my ($lang, $otherpage) = each %otherpages) {
890 if (istranslation($page) && masterpage($page) eq $otherpage) {
892 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
894 language => languagename($lang),
900 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
902 language => languagename($lang),
903 percent => percenttranslated($otherpage),
908 return -1 if $a->{code} eq $config{po_master_language}{code};
909 return 1 if $b->{code} eq $config{po_master_language}{code};
910 return $a->{language} cmp $b->{language};
914 sub homepageurl (;$) {
917 return urlto('', $page);
920 sub deletetranslations ($) {
921 my $deletedmasterfile=shift;
923 my $deletedmasterpage=pagename($deletedmasterfile);
926 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
927 my $absfile = "$config{srcdir}/$file";
928 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
929 push @todelete, $file;
931 } keys %{$config{po_slave_languages}};
935 IkiWiki::rcs_remove($_);
938 IkiWiki::prune("$config{srcdir}/$_");
944 gettext("removed obsolete PO files"),
945 "IkiWiki::Plugin::po::deletetranslations");
949 sub commit_and_refresh ($$) {
950 my ($msg, $author) = (shift, shift);
953 IkiWiki::disable_commit_hook();
954 IkiWiki::rcs_commit_staged($msg, $author, "127.0.0.1");
955 IkiWiki::enable_commit_hook();
956 IkiWiki::rcs_update();
958 # Reinitialize module's private variables.
959 resetalreadyfiltered();
960 resettranslationscache();
962 # Trigger a wiki refresh.
963 require IkiWiki::Render;
964 # without preliminary saveindex/loadindex, refresh()
965 # complains about a lot of uninitialized variables
966 IkiWiki::saveindex();
967 IkiWiki::loadindex();
969 IkiWiki::saveindex();
972 # on success, returns the filtered content.
973 # on error, if $nonfatal, warn and return undef; else, error out.
974 sub po_to_markup ($$;$) {
975 my ($page, $content) = (shift, shift);
976 my $nonfatal = shift;
978 $content = '' unless defined $content;
979 $content = decode_utf8(encode_utf8($content));
980 # CRLF line terminators make poor Locale::Po4a feel bad
981 $content=~s/\r\n/\n/g;
983 # There are incompatibilities between some File::Temp versions
984 # (including 0.18, bundled with Lenny's perl-modules package)
985 # and others (e.g. 0.20, previously present in the archive as
986 # a standalone package): under certain circumstances, some
987 # return a relative filename, whereas others return an absolute one;
988 # we here use this module in a way that is at least compatible
989 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
990 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
991 DIR => File::Spec->tmpdir,
992 UNLINK => 1)->filename;
993 my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
994 DIR => File::Spec->tmpdir,
995 UNLINK => 1)->filename;
998 my $msg = "po(po_to_markup) - $page : " . shift;
1003 error($msg, sub { unlink $infile, $outfile});
1006 writefile(basename($infile), File::Spec->tmpdir, $content)
1007 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1009 my $masterfile = srcfile($pagesources{masterpage($page)});
1011 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
1013 my $doc=Locale::Po4a::Chooser::new('text',%options);
1015 'po_in_name' => [ $infile ],
1016 'file_in_name' => [ $masterfile ],
1017 'file_in_charset' => 'utf-8',
1018 'file_out_charset' => 'utf-8',
1019 ) or return $fail->(gettext("failed to translate"));
1020 $doc->write($outfile)
1021 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1023 $content = readfile($outfile)
1024 or return $fail->(sprintf(gettext("failed to read %s"), $outfile));
1026 # Unlinking should happen automatically, thanks to File::Temp,
1027 # but it does not work here, probably because of the way writefile()
1028 # and Locale::Po4a::write() work.
1029 unlink $infile, $outfile;
1034 # returns a SuccessReason or FailReason object
1036 my $content = shift;
1038 # NB: we don't use po_to_markup here, since Po4a parser does
1039 # not mind invalid PO content
1040 $content = '' unless defined $content;
1041 $content = decode_utf8(encode_utf8($content));
1043 # There are incompatibilities between some File::Temp versions
1044 # (including 0.18, bundled with Lenny's perl-modules package)
1045 # and others (e.g. 0.20, previously present in the archive as
1046 # a standalone package): under certain circumstances, some
1047 # return a relative filename, whereas others return an absolute one;
1048 # we here use this module in a way that is at least compatible
1049 # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1050 my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1051 DIR => File::Spec->tmpdir,
1052 UNLINK => 1)->filename;
1054 my $fail = sub ($) {
1055 my $msg = '[po/isvalidpo] ' . shift;
1057 return IkiWiki::FailReason->new("$msg");
1060 writefile(basename($infile), File::Spec->tmpdir, $content)
1061 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1063 my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1065 # Unlinking should happen automatically, thanks to File::Temp,
1066 # but it does not work here, probably because of the way writefile()
1067 # and Locale::Po4a::write() work.
1071 return IkiWiki::SuccessReason->new("valid gettext data");
1073 return IkiWiki::FailReason->new("invalid gettext data, go back ".
1074 "to previous page to go on with edit");
1081 package IkiWiki::PageSpec;
1083 sub match_istranslation ($;@) {
1086 if (IkiWiki::Plugin::po::istranslation($page)) {
1087 return IkiWiki::SuccessReason->new("is a translation page");
1090 return IkiWiki::FailReason->new("is not a translation page");
1094 sub match_istranslatable ($;@) {
1097 if (IkiWiki::Plugin::po::istranslatable($page)) {
1098 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1101 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1105 sub match_lang ($$;@) {
1109 my $regexp=IkiWiki::glob2re($wanted);
1110 my $lang=IkiWiki::Plugin::po::lang($page);
1111 if ($lang !~ /^$regexp$/i) {
1112 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1115 return IkiWiki::SuccessReason->new("file language is $wanted");
1119 sub match_currentlang ($$;@) {
1124 return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1126 my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1127 my $lang=IkiWiki::Plugin::po::lang($page);
1129 if ($lang eq $currentlang) {
1130 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1133 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");