avoid stomping on inline's rootpage sub if it's not already present
[ikiwiki.git] / IkiWiki / Plugin / po.pm
1 #!/usr/bin/perl
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;
8
9 use warnings;
10 use strict;
11 use IkiWiki 3.00;
12 use Encode;
13 eval q{use Locale::Po4a::Common qw(nowrapi18n !/.*/)};
14 if ($@) {
15         print STDERR gettext("warning: Old po4a detected! Recommend upgrade to 0.35.")."\n";
16         eval q{use Locale::Po4a::Common qw(!/.*/)};
17         die $@ if $@;
18 }
19 use Locale::Po4a::Chooser;
20 use Locale::Po4a::Po;
21 use File::Basename;
22 use File::Copy;
23 use File::Spec;
24 use File::Temp;
25 use Memoize;
26 use UNIVERSAL;
27
28 my ($master_language_code, $master_language_name);
29 my %translations;
30 my @origneedsbuild;
31 my %origsubs;
32 my @slavelanguages; # language codes ordered as in config po_slave_languages
33 my %slavelanguages; # language code to name lookup
34
35 memoize("istranslatable");
36 memoize("_istranslation");
37 memoize("percenttranslated");
38
39 sub import {
40         hook(type => "getsetup", id => "po", call => \&getsetup);
41         hook(type => "checkconfig", id => "po", call => \&checkconfig,
42                 last => 1);
43         hook(type => "needsbuild", id => "po", call => \&needsbuild);
44         hook(type => "scan", id => "po", call => \&scan, last => 1);
45         hook(type => "filter", id => "po", call => \&filter);
46         hook(type => "htmlize", id => "po", call => \&htmlize);
47         hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
48         hook(type => "rename", id => "po", call => \&renamepages, first => 1);
49         hook(type => "delete", id => "po", call => \&mydelete);
50         hook(type => "change", id => "po", call => \&change);
51         hook(type => "checkcontent", id => "po", call => \&checkcontent);
52         hook(type => "canremove", id => "po", call => \&canremove);
53         hook(type => "canrename", id => "po", call => \&canrename);
54         hook(type => "editcontent", id => "po", call => \&editcontent);
55         hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
56         hook(type => "formbuilder", id => "po", call => \&formbuilder);
57
58         if (! %origsubs) {
59                 $origsubs{'bestlink'}=\&IkiWiki::bestlink;
60                 inject(name => "IkiWiki::bestlink", call => \&mybestlink);
61                 $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
62                 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
63                 $origsubs{'targetpage'}=\&IkiWiki::targetpage;
64                 inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
65                 $origsubs{'urlto'}=\&IkiWiki::urlto;
66                 inject(name => "IkiWiki::urlto", call => \&myurlto);
67                 $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
68                 inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
69                 if (IkiWiki->can('rootpage')) {
70                         $origsubs{'rootpage'}=\&IkiWiki::rootpage;
71                         inject(name => "IkiWiki::rootpage", call => \&myrootpage)
72                                 if defined $origsubs{'rootpage'};
73                 }
74                 $origsubs{'isselflink'}=\&IkiWiki::isselflink;
75                 inject(name => "IkiWiki::isselflink", call => \&myisselflink);
76         }
77 }
78
79
80 # ,----
81 # | Table of contents
82 # `----
83
84 # 1. Hooks
85 # 2. Injected functions
86 # 3. Blackboxes for private data
87 # 4. Helper functions
88 # 5. PageSpecs
89
90
91 # ,----
92 # | Hooks
93 # `----
94
95 sub getsetup () {
96         return
97                 plugin => {
98                         safe => 1,
99                         rebuild => 1, # format plugin
100                         section => "format",
101                 },
102                 po_master_language => {
103                         type => "string",
104                         example => "en|English",
105                         description => "master language (non-PO files)",
106                         safe => 1,
107                         rebuild => 1,
108                 },
109                 po_slave_languages => {
110                         type => "string",
111                         example => [
112                                 'fr|Français',
113                                 'es|Español',
114                                 'de|Deutsch'
115                         ],
116                         description => "slave languages (translated via PO files) format: ll|Langname",
117                         safe => 1,
118                         rebuild => 1,
119                 },
120                 po_translatable_pages => {
121                         type => "pagespec",
122                         example => "* and !*/Discussion",
123                         description => "PageSpec controlling which pages are translatable",
124                         link => "ikiwiki/PageSpec",
125                         safe => 1,
126                         rebuild => 1,
127                 },
128                 po_link_to => {
129                         type => "string",
130                         example => "current",
131                         description => "internal linking behavior (default/current/negotiated)",
132                         safe => 1,
133                         rebuild => 1,
134                 },
135 }
136
137 sub checkconfig () {
138         if (exists $config{po_master_language}) {
139                 if (! ref $config{po_master_language}) {
140                         ($master_language_code, $master_language_name)=
141                                 splitlangpair($config{po_master_language});
142                 }
143                 else {
144                         $master_language_code=$config{po_master_language}{code};
145                         $master_language_name=$config{po_master_language}{name};
146                         $config{po_master_language}=joinlangpair($master_language_code, $master_language_name);
147                 }
148         }
149         if (! defined $master_language_code) {
150                 $master_language_code='en';
151         }
152         if (! defined $master_language_name) {
153                 $master_language_name='English';
154         }
155
156         if (ref $config{po_slave_languages} eq 'ARRAY') {
157                 foreach my $pair (@{$config{po_slave_languages}}) {
158                         my ($code, $name)=splitlangpair($pair);
159                         if (defined $code && ! exists $slavelanguages{$code}) {
160                                 push @slavelanguages, $code;
161                                 $slavelanguages{$code} = $name;
162                         }
163                 }
164         }
165         elsif (ref $config{po_slave_languages} eq 'HASH') {
166                 %slavelanguages=%{$config{po_slave_languages}};
167                 @slavelanguages = sort {
168                         $config{po_slave_languages}->{$a} cmp $config{po_slave_languages}->{$b};
169                 } keys %slavelanguages;
170                 $config{po_slave_languages}=[
171                         map { joinlangpair($_, $slavelanguages{$_}) } @slavelanguages
172                 ]
173         }
174
175         delete $slavelanguages{$master_language_code};
176
177         map {
178                 islanguagecode($_)
179                         or error(sprintf(gettext("%s is not a valid language code"), $_));
180         } ($master_language_code, @slavelanguages);
181
182         if (! exists $config{po_translatable_pages} ||
183             ! defined $config{po_translatable_pages}) {
184                 $config{po_translatable_pages}="";
185         }
186         if (! exists $config{po_link_to} ||
187             ! defined $config{po_link_to}) {
188                 $config{po_link_to}='default';
189         }
190         elsif ($config{po_link_to} !~ /^(default|current|negotiated)$/) {
191                 warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
192                              $config{po_link_to}));
193                 $config{po_link_to}='default';
194         }
195         elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
196                 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
197                 $config{po_link_to}='default';
198         }
199
200         push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
201
202         # Translated versions of the underlays are added if available.
203         foreach my $underlay ("basewiki",
204                               map { m/^\Q$config{underlaydirbase}\E\/*(.*)/ }
205                                   reverse @{$config{underlaydirs}}) {
206                 next if $underlay=~/^locale\//;
207
208                 # Underlays containing the po files for slave languages.
209                 foreach my $ll (@slavelanguages) {
210                         add_underlay("po/$ll/$underlay")
211                                 if -d "$config{underlaydirbase}/po/$ll/$underlay";
212                 }
213         
214                 if ($master_language_code ne 'en') {
215                         # Add underlay containing translated source files
216                         # for the master language.
217                         add_underlay("locale/$master_language_code/$underlay")
218                                 if -d "$config{underlaydirbase}/locale/$master_language_code/$underlay";
219                 }
220         }
221 }
222
223 sub needsbuild () {
224         my $needsbuild=shift;
225
226         # backup @needsbuild content so that change() can know whether
227         # a given master page was rendered because its source file was changed
228         @origneedsbuild=(@$needsbuild);
229
230         flushmemoizecache();
231         buildtranslationscache();
232
233         # make existing translations depend on the corresponding master page
234         foreach my $master (keys %translations) {
235                 map add_depends($_, $master), values %{otherlanguages_pages($master)};
236         }
237
238         return $needsbuild;
239 }
240
241 sub scan (@) {
242         my %params=@_;
243         my $page=$params{page};
244         my $content=$params{content};
245         my $run_by_po=$params{run_by_po};
246
247         # Massage the recorded state of internal links so that:
248         # - it matches the actually generated links, rather than the links as
249         #   written in the pages' source
250         # - backlinks are consistent in all cases
251
252         # A second scan pass is made over translation pages, so as an
253         # optimization, we only do so on the second pass in this case,
254         # i.e. when this hook is called by itself.
255         if ($run_by_po && istranslation($page)) {
256                 # replace the occurence of $destpage in $links{$page}
257                 my @orig_links = @{$links{$page}};
258                 $links{$page} = [];
259                 foreach my $destpage (@orig_links) {
260                         if (istranslatedto($destpage, lang($page))) {
261                                 add_link($page, $destpage . '.' . lang($page));
262                         }
263                         else {
264                                 add_link($page, $destpage);
265                         }
266                 }
267         }
268         # No second scan pass is done for a non-translation page, so
269         # links massaging must happen on first pass in this case.
270         elsif (! $run_by_po && ! istranslatable($page) && ! istranslation($page)) {
271                 foreach my $destpage (@{$links{$page}}) {
272                         if (istranslatable($destpage)) {
273                                 # make sure any destpage's translations has
274                                 # $page in its backlinks
275                                 foreach my $link (values %{otherlanguages_pages($destpage)}) {
276                                         add_link($page, $link);
277                                 }
278                         }
279                 }
280         }
281
282         # Re-run the preprocess hooks in scan mode, then the scan hooks,
283         # over the po-to-markup converted content
284         return if $run_by_po; # avoid looping endlessly
285         return unless istranslation($page);
286         $content = po_to_markup($page, $content);
287         require IkiWiki;
288         IkiWiki::preprocess($page, $page, $content, 1);
289         IkiWiki::run_hooks(scan => sub {
290                 shift->(
291                         page => $page,
292                         content => $content,
293                         run_by_po => 1,
294                 );
295         });
296 }
297
298 # We use filter to convert PO to the master page's format,
299 # since the rest of ikiwiki should not work on PO files.
300 sub filter (@) {
301         my %params = @_;
302
303         my $page = $params{page};
304         my $destpage = $params{destpage};
305         my $content = $params{content};
306         if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
307                 $content = po_to_markup($page, $content);
308                 setalreadyfiltered($page, $destpage);
309         }
310         return $content;
311 }
312
313 sub htmlize (@) {
314         my %params=@_;
315
316         my $page = $params{page};
317         my $content = $params{content};
318
319         # ignore PO files this plugin did not create
320         return $content unless istranslation($page);
321
322         # force content to be htmlize'd as if it was the same type as the master page
323         return IkiWiki::htmlize($page, $page,
324                 pagetype(srcfile($pagesources{masterpage($page)})),
325                 $content);
326 }
327
328 sub pagetemplate (@) {
329         my %params=@_;
330         my $page=$params{page};
331         my $destpage=$params{destpage};
332         my $template=$params{template};
333
334         my ($masterpage, $lang) = istranslation($page);
335
336         if (istranslation($page) && $template->query(name => "percenttranslated")) {
337                 $template->param(percenttranslated => percenttranslated($page));
338         }
339         if ($template->query(name => "istranslation")) {
340                 $template->param(istranslation => scalar istranslation($page));
341         }
342         if ($template->query(name => "istranslatable")) {
343                 $template->param(istranslatable => istranslatable($page));
344         }
345         if ($template->query(name => "HOMEPAGEURL")) {
346                 $template->param(homepageurl => homepageurl($page));
347         }
348         if ($template->query(name => "otherlanguages")) {
349                 $template->param(otherlanguages => [otherlanguagesloop($page)]);
350                 map add_depends($page, $_), (values %{otherlanguages_pages($page)});
351         }
352         if ($config{discussion} && istranslation($page)) {
353                 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
354                    (length $config{cgiurl} ||
355                     exists $links{$masterpage."/".lc($config{discussionpage})})) {
356                         $template->param('discussionlink' => htmllink(
357                                 $page,
358                                 $destpage,
359                                 $masterpage . '/' . $config{discussionpage},
360                                 noimageinline => 1,
361                                 forcesubpage => 0,
362                                 linktext => $config{discussionpage},
363                 ));
364                 }
365         }
366         # Remove broken parentlink to ./index.html on home page's translations.
367         # It works because this hook has the "last" parameter set, to ensure it
368         # runs after parentlinks' own pagetemplate hook.
369         if ($template->param('parentlinks')
370             && istranslation($page)
371             && $masterpage eq "index") {
372                 $template->param('parentlinks' => []);
373         }
374         if (ishomepage($page) && $template->query(name => "title")
375             && !$template->param("title_overridden")) {
376                 $template->param(title => $config{wikiname});
377         }
378 }
379
380 # Add the renamed page translations to the list of to-be-renamed pages.
381 sub renamepages (@) {
382         my %params = @_;
383
384         my %torename = %{$params{torename}};
385         my $session = $params{session};
386
387         # Save the page(s) the user asked to rename, so that our
388         # canrename hook can tell the difference between:
389         #  - a translation being renamed as a consequence of its master page
390         #    being renamed
391         #  - a user trying to directly rename a translation
392         # This is why this hook has to be run first, before the list of pages
393         # to rename is modified by other plugins.
394         my @orig_torename;
395         @orig_torename=@{$session->param("po_orig_torename")}
396                 if defined $session->param("po_orig_torename");
397         push @orig_torename, $torename{src};
398         $session->param(po_orig_torename => \@orig_torename);
399         IkiWiki::cgi_savesession($session);
400
401         return () unless istranslatable($torename{src});
402
403         my @ret;
404         my %otherpages=%{otherlanguages_pages($torename{src})};
405         while (my ($lang, $otherpage) = each %otherpages) {
406                 push @ret, {
407                         src => $otherpage,
408                         srcfile => $pagesources{$otherpage},
409                         dest => otherlanguage_page($torename{dest}, $lang),
410                         destfile => $torename{dest}.".".$lang.".po",
411                         required => 0,
412                 };
413         }
414         return @ret;
415 }
416
417 sub mydelete (@) {
418         my @deleted=@_;
419
420         map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
421 }
422
423 sub change (@) {
424         my @rendered=@_;
425
426         my $updated_po_files=0;
427
428         # Refresh/create POT and PO files as needed.
429         foreach my $file (grep {istranslatablefile($_)} @rendered) {
430                 my $masterfile=srcfile($file);
431                 my $page=pagename($file);
432                 my $updated_pot_file=0;
433
434                 # Avoid touching underlay files.
435                 next if $masterfile ne "$config{srcdir}/$file";
436
437                 # Only refresh POT file if it does not exist, or if
438                 # the source was changed: don't if only the HTML was
439                 # refreshed, e.g. because of a dependency.
440                 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild) ||
441                     ! -e potfile($masterfile)) {
442                         refreshpot($masterfile);
443                         $updated_pot_file=1;
444                 }
445                 my @pofiles;
446                 foreach my $po (pofiles($masterfile)) {
447                         next if ! $updated_pot_file && -e $po;
448                         next if grep { $po=~/\Q$_\E/ } @{$config{underlaydirs}};
449                         push @pofiles, $po;
450                 }
451                 if (@pofiles) {
452                         refreshpofiles($masterfile, @pofiles);
453                         map { s/^\Q$config{srcdir}\E\/*//; IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
454                         $updated_po_files=1;
455                 }
456         }
457
458         if ($updated_po_files) {
459                 commit_and_refresh(
460                         gettext("updated PO files"));
461         }
462 }
463
464 sub checkcontent (@) {
465         my %params=@_;
466
467         if (istranslation($params{page})) {
468                 my $res = isvalidpo($params{content});
469                 if ($res) {
470                         return undef;
471                 }
472                 else {
473                         return "$res";
474                 }
475         }
476         return undef;
477 }
478
479 sub canremove (@) {
480         my %params = @_;
481
482         if (istranslation($params{page})) {
483                 return gettext("Can not remove a translation. If the master page is removed, ".
484                                "however, its translations will be removed as well.");
485         }
486         return undef;
487 }
488
489 sub canrename (@) {
490         my %params = @_;
491         my $session = $params{session};
492
493         if (istranslation($params{src})) {
494                 my $masterpage = masterpage($params{src});
495                 # Tell the difference between:
496                 #  - a translation being renamed as a consequence of its master page
497                 #    being renamed, which is allowed
498                 #  - a user trying to directly rename a translation, which is forbidden
499                 # by looking for the master page in the list of to-be-renamed pages we
500                 # saved early in the renaming process.
501                 my $orig_torename = $session->param("po_orig_torename");
502                 unless (grep { $_ eq $masterpage } @{$orig_torename}) {
503                         return gettext("Can not rename a translation. If the master page is renamed, ".
504                                        "however, its translations will be renamed as well.");
505                 }
506         }
507         return undef;
508 }
509
510 # As we're previewing or saving a page, the content may have
511 # changed, so tell the next filter() invocation it must not be lazy.
512 sub editcontent () {
513         my %params=@_;
514
515         unsetalreadyfiltered($params{page}, $params{page});
516         return $params{content};
517 }
518
519 sub formbuilder_setup (@) {
520         my %params=@_;
521         my $form=$params{form};
522         my $q=$params{cgi};
523
524         return unless defined $form->field("do");
525
526         if ($form->field("do") eq "create") {
527                 # Warn the user: new pages must be written in master language.
528                 my $template=template("pocreatepage.tmpl");
529                 $template->param(LANG => $master_language_name);
530                 $form->tmpl_param(message => $template->output);
531         }
532         elsif ($form->field("do") eq "edit") {
533                 # Remove the rename/remove buttons on slave pages.
534                 # This has to be done after the rename/remove plugins have added
535                 # their buttons, which is why this hook must be run last.
536                 # The canrename/canremove hooks already ensure this is forbidden
537                 # at the backend level, so this is only UI sugar.
538                 if (istranslation($form->field("page"))) {
539                         map {
540                                 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
541                                         if (@{$params{buttons}}[$i] eq $_) {
542                                                 delete  @{$params{buttons}}[$i];
543                                                 last;
544                                         }
545                                 }
546                         } qw(Rename Remove);
547                 }
548         }
549 }
550
551 sub formbuilder (@) {
552         my %params=@_;
553         my $form=$params{form};
554         my $q=$params{cgi};
555
556         return unless defined $form->field("do");
557
558         # Do not allow to create pages of type po: they are automatically created.
559         # The main reason to do so is to bypass the "favor the type of linking page
560         # on page creation" logic, which is unsuitable when a broken link is clicked
561         # on a slave (PO) page.
562         # This cannot be done in the formbuilder_setup hook as the list of types is
563         # computed later.
564         if ($form->field("do") eq "create") {
565                 foreach my $field ($form->field) {
566                         next unless "$field" eq "type";
567                         next unless $field->type eq 'select';
568                         my $orig_value = $field->value;
569                         # remove po from the list of types
570                         my @types = grep { $_->[0] ne 'po' } $field->options;
571                         $field->options(\@types) if @types;
572                         # favor the type of linking page's masterpage
573                         if ($orig_value eq 'po') {
574                                 my ($from, $type);
575                                 if (defined $form->field('from')) {
576                                         ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
577                                         $from = masterpage($from);
578                                 }
579                                 if (defined $from && exists $pagesources{$from}) {
580                                         $type=pagetype($pagesources{$from});
581                                 }
582                                 $type=$config{default_pageext} unless defined $type;
583                                 $field->value($type) ;
584                         }
585                 }
586         }
587 }
588
589 # ,----
590 # | Injected functions
591 # `----
592
593 # Implement po_link_to 'current' and 'negotiated' settings.
594 sub mybestlink ($$) {
595         my $page=shift;
596         my $link=shift;
597
598         return $origsubs{'bestlink'}->($page, $link)
599                 if defined $config{po_link_to} && $config{po_link_to} eq "default";
600
601         my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
602         my @caller = caller(1);
603         if (length $res
604             && istranslatedto($res, lang($page))
605             && istranslation($page)
606             &&  !(exists $caller[3] && defined $caller[3]
607                   && ($caller[3] eq "IkiWiki::PageSpec::match_link"))) {
608                 return $res . "." . lang($page);
609         }
610         return $res;
611 }
612
613 sub mybeautify_urlpath ($) {
614         my $url=shift;
615
616         my $res=$origsubs{'beautify_urlpath'}->($url);
617         if (defined $config{po_link_to} && $config{po_link_to} eq "negotiated") {
618                 $res =~ s!/\Qindex.$master_language_code.$config{htmlext}\E$!/!;
619                 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
620                 map {
621                         $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
622                 } @slavelanguages;
623         }
624         return $res;
625 }
626
627 sub mytargetpage ($$) {
628         my $page=shift;
629         my $ext=shift;
630
631         if (istranslation($page) || istranslatable($page)) {
632                 my ($masterpage, $lang) = (masterpage($page), lang($page));
633                 if (! $config{usedirs} || $masterpage eq 'index') {
634                         return $masterpage . "." . $lang . "." . $ext;
635                 }
636                 else {
637                         return $masterpage . "/index." . $lang . "." . $ext;
638                 }
639         }
640         return $origsubs{'targetpage'}->($page, $ext);
641 }
642
643 sub myurlto ($;$$) {
644         my $to=shift;
645         my $from=shift;
646         my $absolute=shift;
647
648         # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
649         if (! length $to
650             && $config{po_link_to} eq "current"
651             && istranslatable('index')) {
652                 if (defined $from) {
653                         return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
654                 }
655                 else {
656                         return $origsubs{'urlto'}->($to,$from,$absolute);
657                 }
658         }
659         # avoid using our injected beautify_urlpath if run by cgi_editpage,
660         # so that one is redirected to the just-edited page rather than to the
661         # negociated translation; to prevent unnecessary fiddling with caller/inject,
662         # we only do so when our beautify_urlpath would actually do what we want to
663         # avoid, i.e. when po_link_to = negotiated.
664         # also avoid doing so when run by cgi_goto, so that the links on recentchanges
665         # page actually lead to the exact page they pretend to.
666         if ($config{po_link_to} eq "negotiated") {
667                 my @caller = caller(1);
668                 my $use_orig = 0;
669                 $use_orig = 1 if (exists $caller[3] && defined $caller[3]
670                                  && ($caller[3] eq "IkiWiki::cgi_editpage" ||
671                                      $caller[3] eq "IkiWiki::Plugin::goto::cgi_goto")
672                                  );
673                 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
674                         if $use_orig;
675                 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
676                 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
677                         if $use_orig;
678                 return $res;
679         }
680         else {
681                 return $origsubs{'urlto'}->($to,$from,$absolute)
682         }
683 }
684
685 sub mycgiurl (@) {
686         my %params=@_;
687
688         # slave pages have no subpages
689         if (istranslation($params{'from'})) {
690                 $params{'from'} = masterpage($params{'from'});
691         }
692         return $origsubs{'cgiurl'}->(%params);
693 }
694
695 sub myrootpage (@) {
696         my %params=@_;
697
698         my $rootpage;
699         if (exists $params{rootpage}) {
700                 $rootpage=$origsubs{'bestlink'}->($params{page}, $params{rootpage});
701                 if (!length $rootpage) {
702                         $rootpage=$params{rootpage};
703                 }
704         }
705         else {
706                 $rootpage=masterpage($params{page});
707         }
708         return $rootpage;
709 }
710
711 sub myisselflink ($$) {
712         my $page=shift;
713         my $link=shift;
714
715         return 1 if $origsubs{'isselflink'}->($page, $link);
716         if (istranslation($page)) {
717                 return $origsubs{'isselflink'}->(masterpage($page), $link);
718         }
719         return;
720 }
721
722 # ,----
723 # | Blackboxes for private data
724 # `----
725
726 {
727         my %filtered;
728
729         sub alreadyfiltered($$) {
730                 my $page=shift;
731                 my $destpage=shift;
732
733                 return exists $filtered{$page}{$destpage}
734                          && $filtered{$page}{$destpage} eq 1;
735         }
736
737         sub setalreadyfiltered($$) {
738                 my $page=shift;
739                 my $destpage=shift;
740
741                 $filtered{$page}{$destpage}=1;
742         }
743
744         sub unsetalreadyfiltered($$) {
745                 my $page=shift;
746                 my $destpage=shift;
747
748                 if (exists $filtered{$page}{$destpage}) {
749                         delete $filtered{$page}{$destpage};
750                 }
751         }
752
753         sub resetalreadyfiltered() {
754                 undef %filtered;
755         }
756 }
757
758 # ,----
759 # | Helper functions
760 # `----
761
762 sub maybe_add_leading_slash ($;$) {
763         my $str=shift;
764         my $add=shift;
765         $add=1 unless defined $add;
766         return '/' . $str if $add;
767         return $str;
768 }
769
770 sub istranslatablefile ($) {
771         my $file=shift;
772
773         return 0 unless defined $file;
774         my $type=pagetype($file);
775         return 0 if ! defined $type || $type eq 'po';
776         return 0 if $file =~ /\.pot$/;
777         return 0 if ! defined $config{po_translatable_pages};
778         return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
779         return;
780 }
781
782 sub istranslatable ($) {
783         my $page=shift;
784
785         $page=~s#^/##;
786         return 1 if istranslatablefile($pagesources{$page});
787         return;
788 }
789
790 sub istranslatedto ($$) {
791         my $page=shift;
792         my $destlang = shift;
793
794         $page=~s#^/##;
795         return 0 unless istranslatable($page);
796         exists $pagesources{otherlanguage_page($page, $destlang)};
797 }
798
799 sub _istranslation ($) {
800         my $page=shift;
801
802         $page='' unless defined $page && length $page;
803         my $hasleadingslash = ($page=~s#^/##);
804         my $file=$pagesources{$page};
805         return 0 unless defined $file
806                          && defined pagetype($file)
807                          && pagetype($file) eq 'po';
808         return 0 if $file =~ /\.pot$/;
809
810         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
811         return 0 unless defined $masterpage && defined $lang
812                          && length $masterpage && length $lang
813                          && defined $pagesources{$masterpage}
814                          && defined $slavelanguages{$lang};
815
816         return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
817                 if istranslatable($masterpage);
818 }
819
820 sub istranslation ($) {
821         my $page=shift;
822
823         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
824                 my $hasleadingslash = ($masterpage=~s#^/##);
825                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
826                 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
827         }
828         return "";
829 }
830
831 sub masterpage ($) {
832         my $page=shift;
833
834         if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
835                 return $masterpage;
836         }
837         return $page;
838 }
839
840 sub lang ($) {
841         my $page=shift;
842
843         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
844                 return $lang;
845         }
846         return $master_language_code;
847 }
848
849 sub islanguagecode ($) {
850         my $code=shift;
851
852         return $code =~ /^[a-z]{2}$/;
853 }
854
855 sub otherlanguage_page ($$) {
856         my $page=shift;
857         my $code=shift;
858
859         return masterpage($page) if $code eq $master_language_code;
860         return masterpage($page) . '.' . $code;
861 }
862
863 # Returns the list of other languages codes: the master language comes first,
864 # then the codes are ordered the same way as in po_slave_languages, if it is
865 # an array, or in the language name lexical order, if it is a hash.
866 sub otherlanguages_codes ($) {
867         my $page=shift;
868
869         my @ret;
870         return \@ret unless istranslation($page) || istranslatable($page);
871         my $curlang=lang($page);
872         foreach my $lang
873                 ($master_language_code, @slavelanguages) {
874                 next if $lang eq $curlang;
875                 if ($lang eq $master_language_code ||
876                     istranslatedto(masterpage($page), $lang)) {
877                         push @ret, $lang;
878                 }
879         }
880         return \@ret;
881 }
882
883 sub otherlanguages_pages ($) {
884         my $page=shift;
885
886         my %ret;
887         map {
888                 $ret{$_} = otherlanguage_page($page, $_)
889         } @{otherlanguages_codes($page)};
890
891         return \%ret;
892 }
893
894 sub potfile ($) {
895         my $masterfile=shift;
896
897         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
898         $dir='' if $dir eq './';
899         return File::Spec->catpath('', $dir, $name . ".pot");
900 }
901
902 sub pofile ($$) {
903         my $masterfile=shift;
904         my $lang=shift;
905
906         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
907         $dir='' if $dir eq './';
908         return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
909 }
910
911 sub pofiles ($) {
912         my $masterfile=shift;
913
914         return map pofile($masterfile, $_), @slavelanguages;
915 }
916
917 sub refreshpot ($) {
918         my $masterfile=shift;
919
920         my $potfile=potfile($masterfile);
921         my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
922                                            po4a_options($masterfile));
923         $doc->{TT}{utf_mode} = 1;
924         $doc->{TT}{file_in_charset} = 'UTF-8';
925         $doc->{TT}{file_out_charset} = 'UTF-8';
926         $doc->read($masterfile);
927         # let's cheat a bit to force porefs option to be passed to
928         # Locale::Po4a::Po; this is undocument use of internal
929         # Locale::Po4a::TransTractor's data, compulsory since this module
930         # prevents us from using the porefs option.
931         $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
932         $doc->{TT}{po_out}->set_charset('UTF-8');
933         # do the actual work
934         $doc->parse;
935         IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
936         $doc->writepo($potfile);
937 }
938
939 sub refreshpofiles ($@) {
940         my $masterfile=shift;
941         my @pofiles=@_;
942
943         my $potfile=potfile($masterfile);
944         if (! -e $potfile) {
945                 error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"), $potfile));
946         }
947
948         foreach my $pofile (@pofiles) {
949                 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
950
951                 if (! -e $pofile) {
952                         # If the po file exists in an underlay, copy it
953                         # from there.
954                         my ($pobase)=$pofile=~/^\Q$config{srcdir}\E\/?(.*)$/;
955                         foreach my $dir (@{$config{underlaydirs}}) {
956                                 if (-e "$dir/$pobase") {
957                                         File::Copy::syscopy("$dir/$pobase",$pofile)
958                                                 or error("po(refreshpofiles) ".
959                                                          sprintf(gettext("failed to copy underlay PO file to %s"),
960                                                                  $pofile));
961                                 }
962                         }
963                 }
964
965                 if (-e $pofile) {
966                         system("msgmerge", "--previous", "-q", "-U", "--backup=none", $pofile, $potfile) == 0
967                                 or error("po(refreshpofiles) ".
968                                          sprintf(gettext("failed to update %s"),
969                                                  $pofile));
970                 }
971                 else {
972                         File::Copy::syscopy($potfile,$pofile)
973                                 or error("po(refreshpofiles) ".
974                                          sprintf(gettext("failed to copy the POT file to %s"),
975                                                  $pofile));
976                 }
977         }
978 }
979
980 sub buildtranslationscache() {
981         # use istranslation's side-effect
982         map istranslation($_), (keys %pagesources);
983 }
984
985 sub resettranslationscache() {
986         undef %translations;
987 }
988
989 sub flushmemoizecache() {
990         Memoize::flush_cache("istranslatable");
991         Memoize::flush_cache("_istranslation");
992         Memoize::flush_cache("percenttranslated");
993 }
994
995 sub urlto_with_orig_beautiful_urlpath($$) {
996         my $to=shift;
997         my $from=shift;
998
999         inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
1000         my $res=urlto($to, $from);
1001         inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
1002
1003         return $res;
1004 }
1005
1006 sub percenttranslated ($) {
1007         my $page=shift;
1008
1009         $page=~s/^\///;
1010         return gettext("N/A") unless istranslation($page);
1011         my $file=srcfile($pagesources{$page});
1012         my $masterfile = srcfile($pagesources{masterpage($page)});
1013         my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
1014                                            po4a_options($masterfile));
1015         $doc->process(
1016                 'po_in_name'    => [ $file ],
1017                 'file_in_name'  => [ $masterfile ],
1018                 'file_in_charset'  => 'UTF-8',
1019                 'file_out_charset' => 'UTF-8',
1020         ) or error("po(percenttranslated) ".
1021                    sprintf(gettext("failed to translate %s"), $page));
1022         my ($percent,$hit,$queries) = $doc->stats();
1023         $percent =~ s/\.[0-9]+$//;
1024         return $percent;
1025 }
1026
1027 sub languagename ($) {
1028         my $code=shift;
1029
1030         return $master_language_name
1031                 if $code eq $master_language_code;
1032         return $slavelanguages{$code}
1033                 if defined $slavelanguages{$code};
1034         return;
1035 }
1036
1037 sub otherlanguagesloop ($) {
1038         my $page=shift;
1039
1040         my @ret;
1041         if (istranslation($page)) {
1042                 push @ret, {
1043                         url => urlto_with_orig_beautiful_urlpath(masterpage($page), $page),
1044                         code => $master_language_code,
1045                         language => $master_language_name,
1046                         master => 1,
1047                 };
1048         }
1049         foreach my $lang (@{otherlanguages_codes($page)}) {
1050                 next if $lang eq $master_language_code;
1051                 my $otherpage = otherlanguage_page($page, $lang);
1052                 push @ret, {
1053                         url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
1054                         code => $lang,
1055                         language => languagename($lang),
1056                         percent => percenttranslated($otherpage),
1057                 }
1058         }
1059         return @ret;
1060 }
1061
1062 sub homepageurl (;$) {
1063         my $page=shift;
1064
1065         return urlto('', $page);
1066 }
1067
1068 sub ishomepage ($) {
1069         my $page = shift;
1070
1071         return 1 if $page eq 'index';
1072         map { return 1 if $page eq 'index.'.$_ } @slavelanguages;
1073         return undef;
1074 }
1075
1076 sub deletetranslations ($) {
1077         my $deletedmasterfile=shift;
1078
1079         my $deletedmasterpage=pagename($deletedmasterfile);
1080         my @todelete;
1081         map {
1082                 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
1083                 my $absfile = "$config{srcdir}/$file";
1084                 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
1085                         push @todelete, $file;
1086                 }
1087         } @slavelanguages;
1088
1089         map {
1090                 if ($config{rcs}) {
1091                         IkiWiki::rcs_remove($_);
1092                 }
1093                 else {
1094                         IkiWiki::prune("$config{srcdir}/$_");
1095                 }
1096         } @todelete;
1097
1098         if (@todelete) {
1099                 commit_and_refresh(
1100                         gettext("removed obsolete PO files"));
1101         }
1102 }
1103
1104 sub commit_and_refresh ($) {
1105         my $msg = shift;
1106
1107         if ($config{rcs}) {
1108                 IkiWiki::disable_commit_hook();
1109                 IkiWiki::rcs_commit_staged(
1110                         message => $msg,
1111                 );
1112                 IkiWiki::enable_commit_hook();
1113                 IkiWiki::rcs_update();
1114         }
1115         # Reinitialize module's private variables.
1116         resetalreadyfiltered();
1117         resettranslationscache();
1118         flushmemoizecache();
1119         # Trigger a wiki refresh.
1120         require IkiWiki::Render;
1121         # without preliminary saveindex/loadindex, refresh()
1122         # complains about a lot of uninitialized variables
1123         IkiWiki::saveindex();
1124         IkiWiki::loadindex();
1125         IkiWiki::refresh();
1126         IkiWiki::saveindex();
1127 }
1128
1129 sub po_to_markup ($$) {
1130         my ($page, $content) = (shift, shift);
1131
1132         $content = '' unless defined $content;
1133         $content = decode_utf8(encode_utf8($content));
1134         # CRLF line terminators make poor Locale::Po4a feel bad
1135         $content=~s/\r\n/\n/g;
1136
1137         # There are incompatibilities between some File::Temp versions
1138         # (including 0.18, bundled with Lenny's perl-modules package)
1139         # and others (e.g. 0.20, previously present in the archive as
1140         # a standalone package): under certain circumstances, some
1141         # return a relative filename, whereas others return an absolute one;
1142         # we here use this module in a way that is at least compatible
1143         # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1144         my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
1145                                     DIR => File::Spec->tmpdir,
1146                                     UNLINK => 1)->filename;
1147         my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
1148                                      DIR => File::Spec->tmpdir,
1149                                      UNLINK => 1)->filename;
1150
1151         my $fail = sub ($) {
1152                 my $msg = "po(po_to_markup) - $page : " . shift;
1153                 error($msg, sub { unlink $infile, $outfile});
1154         };
1155
1156         writefile(basename($infile), File::Spec->tmpdir, $content)
1157                 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1158
1159         my $masterfile = srcfile($pagesources{masterpage($page)});
1160         my $doc=Locale::Po4a::Chooser::new(po4a_type($masterfile),
1161                                            po4a_options($masterfile));
1162         $doc->process(
1163                 'po_in_name'    => [ $infile ],
1164                 'file_in_name'  => [ $masterfile ],
1165                 'file_in_charset'  => 'UTF-8',
1166                 'file_out_charset' => 'UTF-8',
1167         ) or return $fail->(gettext("failed to translate"));
1168         $doc->write($outfile)
1169                 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1170
1171         $content = readfile($outfile);
1172
1173         # Unlinking should happen automatically, thanks to File::Temp,
1174         # but it does not work here, probably because of the way writefile()
1175         # and Locale::Po4a::write() work.
1176         unlink $infile, $outfile;
1177
1178         return $content;
1179 }
1180
1181 # returns a SuccessReason or FailReason object
1182 sub isvalidpo ($) {
1183         my $content = shift;
1184
1185         # NB: we don't use po_to_markup here, since Po4a parser does
1186         # not mind invalid PO content
1187         $content = '' unless defined $content;
1188         $content = decode_utf8(encode_utf8($content));
1189
1190         # There are incompatibilities between some File::Temp versions
1191         # (including 0.18, bundled with Lenny's perl-modules package)
1192         # and others (e.g. 0.20, previously present in the archive as
1193         # a standalone package): under certain circumstances, some
1194         # return a relative filename, whereas others return an absolute one;
1195         # we here use this module in a way that is at least compatible
1196         # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1197         my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1198                                     DIR => File::Spec->tmpdir,
1199                                     UNLINK => 1)->filename;
1200
1201         my $fail = sub ($) {
1202                 my $msg = '[po/isvalidpo] ' . shift;
1203                 unlink $infile;
1204                 return IkiWiki::FailReason->new("$msg");
1205         };
1206
1207         writefile(basename($infile), File::Spec->tmpdir, $content)
1208                 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1209
1210         my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1211
1212         # Unlinking should happen automatically, thanks to File::Temp,
1213         # but it does not work here, probably because of the way writefile()
1214         # and Locale::Po4a::write() work.
1215         unlink $infile;
1216
1217         if ($res) {
1218                 return IkiWiki::SuccessReason->new("valid gettext data");
1219         }
1220         return IkiWiki::FailReason->new(gettext("invalid gettext data, go back ".
1221                                         "to previous page to continue edit"));
1222 }
1223
1224 sub po4a_type ($) {
1225         my $file = shift;
1226
1227         my $pagetype = pagetype($file);
1228         if ($pagetype eq 'html') {
1229                 return 'xhtml';
1230         }
1231         return 'text';
1232 }
1233
1234 sub po4a_options($) {
1235         my $file = shift;
1236
1237         my %options;
1238         my $pagetype = pagetype($file);
1239
1240         if ($pagetype eq 'html') {
1241                 # how to disable options is not consistent across po4a modules
1242                 $options{includessi} = '';
1243                 $options{includeexternal} = 0;
1244         }
1245         elsif ($pagetype eq 'mdwn') {
1246                 $options{markdown} = 1;
1247         }
1248         else {
1249                 $options{markdown} = 0;
1250         }
1251
1252         return %options;
1253 }
1254
1255 sub splitlangpair ($) {
1256         my $pair=shift;
1257
1258         my ($code, $name) = ( $pair =~ /^([a-z]{2})\|(.+)$/ );
1259         if (! defined $code || ! defined $name ||
1260             ! length $code || ! length $name) {
1261                 # not a fatal error to avoid breaking if used with web setup
1262                 warn sprintf(gettext("%s has invalid syntax: must use CODE|NAME"),
1263                         $pair);
1264         }
1265
1266         return $code, $name;
1267 }
1268
1269 sub joinlangpair ($$) {
1270         my $code=shift;
1271         my $name=shift;
1272
1273         return "$code|$name";
1274 }
1275
1276 # ,----
1277 # | PageSpecs
1278 # `----
1279
1280 package IkiWiki::PageSpec;
1281
1282 sub match_istranslation ($;@) {
1283         my $page=shift;
1284
1285         if (IkiWiki::Plugin::po::istranslation($page)) {
1286                 return IkiWiki::SuccessReason->new("is a translation page");
1287         }
1288         else {
1289                 return IkiWiki::FailReason->new("is not a translation page");
1290         }
1291 }
1292
1293 sub match_istranslatable ($;@) {
1294         my $page=shift;
1295
1296         if (IkiWiki::Plugin::po::istranslatable($page)) {
1297                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1298         }
1299         else {
1300                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1301         }
1302 }
1303
1304 sub match_lang ($$;@) {
1305         my $page=shift;
1306         my $wanted=shift;
1307
1308         my $regexp=IkiWiki::glob2re($wanted);
1309         my $lang=IkiWiki::Plugin::po::lang($page);
1310         if ($lang !~ $regexp) {
1311                 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1312         }
1313         else {
1314                 return IkiWiki::SuccessReason->new("file language is $wanted");
1315         }
1316 }
1317
1318 sub match_currentlang ($$;@) {
1319         my $page=shift;
1320         shift;
1321         my %params=@_;
1322
1323         return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1324
1325         my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1326         my $lang=IkiWiki::Plugin::po::lang($page);
1327
1328         if ($lang eq $currentlang) {
1329                 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1330         }
1331         else {
1332                 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
1333         }
1334 }
1335
1336 sub match_needstranslation ($$;@) {
1337         my $page=shift;
1338         my $wanted=shift;
1339
1340         if (defined $wanted && $wanted ne "") {
1341                 if ($wanted !~ /^\d+$/) {
1342                         return IkiWiki::FailReason->new("parameter is not an integer");
1343                 }
1344                 elsif ($wanted > 100) {
1345                         return IkiWiki::FailReason->new("parameter is greater than 100");
1346                 }
1347         }
1348         else {
1349                 $wanted=100;
1350         }
1351
1352         my $percenttranslated=IkiWiki::Plugin::po::percenttranslated($page);
1353         if ($percenttranslated eq 'N/A') {
1354                 return IkiWiki::FailReason->new("file is not a translatable page");
1355         }
1356         elsif ($percenttranslated < $wanted) {
1357                 return IkiWiki::SuccessReason->new("file has $percenttranslated translated");
1358         }
1359         else {
1360                 return IkiWiki::FailReason->new("file is translated enough");
1361         }
1362 }
1363
1364 1