]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/po.pm
the rename hook can now change the list of pages to rename
[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 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 2.00;
12 use Encode;
13 use Locale::Po4a::Chooser;
14 use Locale::Po4a::Po;
15 use File::Basename;
16 use File::Copy;
17 use File::Spec;
18 use File::Temp;
19 use Memoize;
20 use UNIVERSAL;
21
22 my %translations;
23 my @origneedsbuild;
24 my %origsubs;
25
26 memoize("istranslatable");
27 memoize("_istranslation");
28 memoize("percenttranslated");
29
30 sub import { #{{{
31         hook(type => "getsetup", id => "po", call => \&getsetup);
32         hook(type => "checkconfig", id => "po", call => \&checkconfig);
33         hook(type => "needsbuild", id => "po", call => \&needsbuild);
34         hook(type => "scan", id => "po", call => \&scan, last =>1);
35         hook(type => "filter", id => "po", call => \&filter);
36         hook(type => "htmlize", id => "po", call => \&htmlize);
37         hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
38         hook(type => "rename", id => "po", call => \&renamepages);
39         hook(type => "delete", id => "po", call => \&mydelete);
40         hook(type => "change", id => "po", call => \&change);
41         hook(type => "editcontent", id => "po", call => \&editcontent);
42
43         $origsubs{'bestlink'}=\&IkiWiki::bestlink;
44         inject(name => "IkiWiki::bestlink", call => \&mybestlink);
45         $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
46         inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
47         $origsubs{'targetpage'}=\&IkiWiki::targetpage;
48         inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
49         $origsubs{'urlto'}=\&IkiWiki::urlto;
50         inject(name => "IkiWiki::urlto", call => \&myurlto);
51 } #}}}
52
53
54 # ,----
55 # | Table of contents
56 # `----
57
58 # 1. Hooks
59 # 2. Injected functions
60 # 3. Blackboxes for private data
61 # 4. Helper functions
62 # 5. PageSpec's
63
64
65 # ,----
66 # | Hooks
67 # `----
68
69 sub getsetup () { #{{{
70         return
71                 plugin => {
72                         safe => 0,
73                         rebuild => 1,
74                 },
75                 po_master_language => {
76                         type => "string",
77                         example => {
78                                 'code' => 'en',
79                                 'name' => 'English'
80                         },
81                         description => "master language (non-PO files)",
82                         safe => 1,
83                         rebuild => 1,
84                 },
85                 po_slave_languages => {
86                         type => "string",
87                         example => {
88                                 'fr' => 'Fran├žais',
89                                 'es' => 'Castellano',
90                                 'de' => 'Deutsch'
91                         },
92                         description => "slave languages (PO files)",
93                         safe => 1,
94                         rebuild => 1,
95                 },
96                 po_translatable_pages => {
97                         type => "pagespec",
98                         example => "!*/Discussion",
99                         description => "PageSpec controlling which pages are translatable",
100                         link => "ikiwiki/PageSpec",
101                         safe => 1,
102                         rebuild => 1,
103                 },
104                 po_link_to => {
105                         type => "string",
106                         example => "current",
107                         description => "internal linking behavior (default/current/negotiated)",
108                         safe => 1,
109                         rebuild => 1,
110                 },
111 } #}}}
112
113 sub checkconfig () { #{{{
114         foreach my $field (qw{po_master_language po_slave_languages}) {
115                 if (! exists $config{$field} || ! defined $config{$field}) {
116                         error(sprintf(gettext("Must specify %s"), $field));
117                 }
118         }
119         if (! (keys %{$config{po_slave_languages}})) {
120                 error(gettext("At least one slave language must be defined in po_slave_languages"));
121         }
122         map {
123                 islanguagecode($_)
124                         or error(sprintf(gettext("%s is not a valid language code"), $_));
125         } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
126         if (! exists $config{po_translatable_pages} ||
127             ! defined $config{po_translatable_pages}) {
128                 $config{po_translatable_pages}="";
129         }
130         if (! exists $config{po_link_to} ||
131             ! defined $config{po_link_to}) {
132                 $config{po_link_to}='default';
133         }
134         elsif (! grep {
135                         $config{po_link_to} eq $_
136                 } ('default', 'current', 'negotiated')) {
137                 warn(sprintf(gettext('po_link_to=%s is not a valid setting, falling back to po_link_to=default'),
138                                 $config{po_link_to}));
139                 $config{po_link_to}='default';
140         }
141         elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
142                 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
143                 $config{po_link_to}='default';
144         }
145         push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
146 } #}}}
147
148 sub needsbuild () { #{{{
149         my $needsbuild=shift;
150
151         # backup @needsbuild content so that change() can know whether
152         # a given master page was rendered because its source file was changed
153         @origneedsbuild=(@$needsbuild);
154
155         flushmemoizecache();
156         buildtranslationscache();
157
158         # make existing translations depend on the corresponding master page
159         foreach my $master (keys %translations) {
160                 map add_depends($_, $master), values %{otherlanguages($master)};
161         }
162 } #}}}
163
164 # Massage the recorded state of internal links so that:
165 # - it matches the actually generated links, rather than the links as written
166 #   in the pages' source
167 # - backlinks are consistent in all cases
168 sub scan (@) { #{{{
169         my %params=@_;
170         my $page=$params{page};
171         my $content=$params{content};
172
173         return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
174
175         if (istranslation($page)) {
176                 foreach my $destpage (@{$links{$page}}) {
177                         if (istranslatable($destpage)) {
178                                 # replace one occurence of $destpage in $links{$page}
179                                 # (we only want to replace the one that was added by
180                                 # IkiWiki::Plugin::link::scan, other occurences may be
181                                 # there for other reasons)
182                                 for (my $i=0; $i<@{$links{$page}}; $i++) {
183                                         if (@{$links{$page}}[$i] eq $destpage) {
184                                                 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
185                                                 last;
186                                         }
187                                 }
188                         }
189                 }
190         }
191         elsif (! istranslatable($page) && ! istranslation($page)) {
192                 foreach my $destpage (@{$links{$page}}) {
193                         if (istranslatable($destpage)) {
194                                 # make sure any destpage's translations has
195                                 # $page in its backlinks
196                                 push @{$links{$page}},
197                                         values %{otherlanguages($destpage)};
198                         }
199                 }
200         }
201 } #}}}
202
203 # We use filter to convert PO to the master page's format,
204 # since the rest of ikiwiki should not work on PO files.
205 sub filter (@) { #{{{
206         my %params = @_;
207
208         my $page = $params{page};
209         my $destpage = $params{destpage};
210         my $content = decode_utf8(encode_utf8($params{content}));
211
212         return $content if ( ! istranslation($page)
213                              || alreadyfiltered($page, $destpage) );
214
215         # CRLF line terminators make poor Locale::Po4a feel bad
216         $content=~s/\r\n/\n/g;
217
218         # Implementation notes
219         #
220         # 1. Locale::Po4a reads/writes from/to files, and I'm too lazy
221         #    to learn how to disguise a variable as a file.
222         # 2. There are incompatibilities between some File::Temp versions
223         #    (including 0.18, bundled with Lenny's perl-modules package)
224         #    and others (e.g. 0.20, previously present in the archive as
225         #    a standalone package): under certain circumstances, some
226         #    return a relative filename, whereas others return an absolute one;
227         #    we here use this module in a way that is at least compatible
228         #    with 0.18 and 0.20. Beware, hit'n'run refactorers!
229         my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
230                                     DIR => File::Spec->tmpdir,
231                                     UNLINK => 1)->filename;
232         my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
233                                      DIR => File::Spec->tmpdir,
234                                      UNLINK => 1)->filename;
235
236         writefile(basename($infile), File::Spec->tmpdir, $content);
237
238         my $masterfile = srcfile($pagesources{masterpage($page)});
239         my (@pos,@masters);
240         push @pos,$infile;
241         push @masters,$masterfile;
242         my %options = (
243                 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
244         );
245         my $doc=Locale::Po4a::Chooser::new('text',%options);
246         $doc->process(
247                 'po_in_name'    => \@pos,
248                 'file_in_name'  => \@masters,
249                 'file_in_charset'  => 'utf-8',
250                 'file_out_charset' => 'utf-8',
251         ) or error("[po/filter:$page]: failed to translate");
252         $doc->write($outfile) or error("[po/filter:$page] could not write $outfile");
253         $content = readfile($outfile) or error("[po/filter:$page] could not read $outfile");
254
255         # Unlinking should happen automatically, thanks to File::Temp,
256         # but it does not work here, probably because of the way writefile()
257         # and Locale::Po4a::write() work.
258         unlink $infile, $outfile;
259
260         setalreadyfiltered($page, $destpage);
261         return $content;
262 } #}}}
263
264 sub htmlize (@) { #{{{
265         my %params=@_;
266
267         my $page = $params{page};
268         my $content = $params{content};
269
270         # ignore PO files this plugin did not create
271         return $content unless istranslation($page);
272
273         # force content to be htmlize'd as if it was the same type as the master page
274         return IkiWiki::htmlize($page, $page,
275                                 pagetype(srcfile($pagesources{masterpage($page)})),
276                                 $content);
277 } #}}}
278
279 sub pagetemplate (@) { #{{{
280         my %params=@_;
281         my $page=$params{page};
282         my $destpage=$params{destpage};
283         my $template=$params{template};
284
285         my ($masterpage, $lang) = istranslation($page);
286
287         if (istranslation($page) && $template->query(name => "percenttranslated")) {
288                 $template->param(percenttranslated => percenttranslated($page));
289         }
290         if ($template->query(name => "istranslation")) {
291                 $template->param(istranslation => scalar istranslation($page));
292         }
293         if ($template->query(name => "istranslatable")) {
294                 $template->param(istranslatable => istranslatable($page));
295         }
296         if ($template->query(name => "HOMEPAGEURL")) {
297                 $template->param(homepageurl => homepageurl($page));
298         }
299         if ($template->query(name => "otherlanguages")) {
300                 $template->param(otherlanguages => [otherlanguagesloop($page)]);
301                 map add_depends($page, $_), (values %{otherlanguages($page)});
302         }
303         # Rely on IkiWiki::Render's genpage() to decide wether
304         # a discussion link should appear on $page; this is not
305         # totally accurate, though: some broken links may be generated
306         # when cgiurl is disabled.
307         # This compromise avoids some code duplication, and will probably
308         # prevent future breakage when ikiwiki internals change.
309         # Known limitations are preferred to future random bugs.
310         if ($template->param('discussionlink') && istranslation($page)) {
311                 $template->param('discussionlink' => htmllink(
312                                                         $page,
313                                                         $destpage,
314                                                         $masterpage . '/' . gettext("Discussion"),
315                                                         noimageinline => 1,
316                                                         forcesubpage => 0,
317                                                         linktext => gettext("Discussion"),
318                                                         ));
319         }
320         # Remove broken parentlink to ./index.html on home page's translations.
321         # It works because this hook has the "last" parameter set, to ensure it
322         # runs after parentlinks' own pagetemplate hook.
323         if ($template->param('parentlinks')
324             && istranslation($page)
325             && $masterpage eq "index") {
326                 $template->param('parentlinks' => []);
327         }
328 } # }}}
329
330 # Add the renamed page translations to the list of to-be-renamed pages.
331 # Save information about master page rename, so that:
332 # - our delete hook can ignore the translations not renamed already
333 # - our change hook can rename the translations accordingly.
334 sub renamepages() { #{{{
335         my $torename=shift;
336         my @torename=@{$torename};
337
338         foreach my $rename (@torename) {
339                 next unless istranslatable($rename->{src});
340                 setrenamed($rename->{src}, $rename->{dest});
341                 my %otherpages=%{otherlanguages($rename->{src})};
342                 debug "bla".$rename->{src};
343                 while (my ($lang, $otherpage) = each %otherpages) {
344                         push @{$torename}, {
345                                 src => $otherpage,
346                                 srcfile => $pagesources{$otherpage},
347                                 dest => otherlanguage($rename->{dest}, $lang),
348                                 destfile => $rename->{dest}.".".$lang.".po",
349                                 required => 0,
350                         };
351                         debug "po(renamepages): pushed src=$otherpage, dest=".otherlanguage($rename->{dest}, $lang);
352                 }
353         }
354 } #}}}
355
356 sub mydelete(@) { #{{{
357         my @deleted=@_;
358
359         map {
360                 deletetranslations($_);
361         } grep { istranslatablefile($_) && ! renamed(pagename($_))} @deleted;
362 } #}}}
363
364 sub change(@) { #{{{
365         my @rendered=@_;
366
367         my $eachrenamed=eachrenamed();
368         while (my ($oldpage, $newpage) = $eachrenamed->()) {
369                 renametranslations($oldpage, $newpage);
370         }
371         resetrenamed();
372
373         my $updated_po_files=0;
374
375         # Refresh/create POT and PO files as needed.
376         foreach my $file (@rendered) {
377                 next unless istranslatablefile($file);
378                 my $page=pagename($file);
379                 my $masterfile=srcfile($file);
380                 my $updated_pot_file=0;
381                 # Only refresh Pot file if it does not exist, or if
382                 # $pagesources{$page} was changed: don't if only the HTML was
383                 # refreshed, e.g. because of a dependency.
384                 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
385                     || ! -e potfile($masterfile)) {
386                         refreshpot($masterfile);
387                         $updated_pot_file=1;
388                 }
389                 my @pofiles;
390                 map {
391                         push @pofiles, $_ if ($updated_pot_file || ! -e $_);
392                 } (pofiles($masterfile));
393                 if (@pofiles) {
394                         refreshpofiles($masterfile, @pofiles);
395                         map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
396                         $updated_po_files=1;
397                 }
398         }
399
400         if ($updated_po_files) {
401                 # Check staged changes in.
402                 if ($config{rcs}) {
403                         IkiWiki::disable_commit_hook();
404                         IkiWiki::rcs_commit_staged(gettext("updated PO files"),
405                                 "IkiWiki::Plugin::po::change", "127.0.0.1");
406                         IkiWiki::enable_commit_hook();
407                         IkiWiki::rcs_update();
408                 }
409                 # Reinitialize module's private variables.
410                 resetalreadyfiltered();
411                 resettranslationscache();
412                 flushmemoizecache();
413                 # Trigger a wiki refresh.
414                 require IkiWiki::Render;
415                 # without preliminary saveindex/loadindex, refresh()
416                 # complains about a lot of uninitialized variables
417                 IkiWiki::saveindex();
418                 IkiWiki::loadindex();
419                 IkiWiki::refresh();
420                 IkiWiki::saveindex();
421         }
422 } #}}}
423
424 # As we're previewing or saving a page, the content may have
425 # changed, so tell the next filter() invocation it must not be lazy.
426 sub editcontent () { #{{{
427         my %params=@_;
428
429         unsetalreadyfiltered($params{page}, $params{page});
430         return $params{content};
431 } #}}}
432
433
434 # ,----
435 # | Injected functions
436 # `----
437
438 # Implement po_link_to 'current' and 'negotiated' settings.
439 sub mybestlink ($$) { #{{{
440         my $page=shift;
441         my $link=shift;
442
443         my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
444         if (length $res
445             && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated")
446             && istranslatable($res)
447             && istranslation($page)) {
448                 return $res . "." . lang($page);
449         }
450         return $res;
451 } #}}}
452
453 sub mybeautify_urlpath ($) { #{{{
454         my $url=shift;
455
456         my $res=$origsubs{'beautify_urlpath'}->($url);
457         if ($config{po_link_to} eq "negotiated") {
458                 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
459                 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
460                 map {
461                         $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
462                 } (keys %{$config{po_slave_languages}});
463         }
464         return $res;
465 } #}}}
466
467 sub mytargetpage ($$) { #{{{
468         my $page=shift;
469         my $ext=shift;
470
471         if (istranslation($page) || istranslatable($page)) {
472                 my ($masterpage, $lang) = (masterpage($page), lang($page));
473                 if (! $config{usedirs} || $masterpage eq 'index') {
474                         return $masterpage . "." . $lang . "." . $ext;
475                 }
476                 else {
477                         return $masterpage . "/index." . $lang . "." . $ext;
478                 }
479         }
480         return $origsubs{'targetpage'}->($page, $ext);
481 } #}}}
482
483 sub myurlto ($$;$) { #{{{
484         my $to=shift;
485         my $from=shift;
486         my $absolute=shift;
487
488         # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
489         if (! length $to
490             && $config{po_link_to} eq "current"
491             && istranslatable('index')) {
492                 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
493         }
494         return $origsubs{'urlto'}->($to,$from,$absolute);
495 } #}}}
496
497
498 # ,----
499 # | Blackboxes for private data
500 # `----
501
502 {
503         my %filtered;
504
505         sub alreadyfiltered($$) { #{{{
506                 my $page=shift;
507                 my $destpage=shift;
508
509                 return ( exists $filtered{$page}{$destpage}
510                          && $filtered{$page}{$destpage} eq 1 );
511         } #}}}
512
513         sub setalreadyfiltered($$) { #{{{
514                 my $page=shift;
515                 my $destpage=shift;
516
517                 $filtered{$page}{$destpage}=1;
518         } #}}}
519
520         sub unsetalreadyfiltered($$) { #{{{
521                 my $page=shift;
522                 my $destpage=shift;
523
524                 if (exists $filtered{$page}{$destpage}) {
525                         delete $filtered{$page}{$destpage};
526                 }
527         } #}}}
528
529         sub resetalreadyfiltered() { #{{{
530                 undef %filtered;
531         } #}}}
532 }
533
534 {
535         my %renamed;
536
537         sub renamed ($) { #{{{
538                 my $page=shift;
539
540                 if (exists $renamed{$page} &&
541                     defined $renamed{$page}) {
542                         return $renamed{$page};
543                 }
544                 return;
545         } #}}}
546
547         sub setrenamed ($$) { #{{{
548                 my $oldpage=shift;
549                 my $newpage=shift;
550
551                 $renamed{$oldpage}=$newpage;
552         } #}}}
553
554         sub resetrenamed () { #{{{
555                 undef %renamed;
556         } #}}}
557
558         sub eachrenamed () { #{{{
559                 return sub { each %renamed };
560         } #}}}
561 }
562
563 # ,----
564 # | Helper functions
565 # `----
566
567 sub maybe_add_leading_slash ($;$) { #{{{
568         my $str=shift;
569         my $add=shift;
570         $add=1 unless defined $add;
571         return '/' . $str if $add;
572         return $str;
573 } #}}}
574
575 sub istranslatablefile ($) { #{{{
576         my $file=shift;
577
578         return 0 unless defined $file;
579         return 0 if (defined pagetype($file) && pagetype($file) eq 'po');
580         return 0 if $file =~ /\.pot$/;
581         return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
582         return;
583 } #}}}
584
585 sub istranslatable ($) { #{{{
586         my $page=shift;
587
588         $page=~s#^/##;
589         return 1 if istranslatablefile($pagesources{$page});
590         return;
591 } #}}}
592
593 sub _istranslation ($) { #{{{
594         my $page=shift;
595
596         my $hasleadingslash = ($page=~s#^/##);
597         my $file=$pagesources{$page};
598         return 0 unless (defined $file
599                          && defined pagetype($file)
600                          && pagetype($file) eq 'po');
601         return 0 if $file =~ /\.pot$/;
602
603         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
604         return 0 unless (defined $masterpage && defined $lang
605                          && length $masterpage && length $lang
606                          && defined $pagesources{$masterpage}
607                          && defined $config{po_slave_languages}{$lang});
608
609         return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
610                 if istranslatable($masterpage);
611 } #}}}
612
613 sub istranslation ($) { #{{{
614         my $page=shift;
615
616         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
617                 my $hasleadingslash = ($masterpage=~s#^/##);
618                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
619                 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
620         }
621         return;
622 } #}}}
623
624 sub masterpage ($) { #{{{
625         my $page=shift;
626
627         if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
628                 return $masterpage;
629         }
630         return $page;
631 } #}}}
632
633 sub lang ($) { #{{{
634         my $page=shift;
635
636         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
637                 return $lang;
638         }
639         return $config{po_master_language}{code};
640 } #}}}
641
642 sub islanguagecode ($) { #{{{
643         my $code=shift;
644
645         return ($code =~ /^[a-z]{2}$/);
646 } #}}}
647
648 sub otherlanguage ($$) { #{{{
649         my $page=shift;
650         my $code=shift;
651
652         return masterpage($page) if $code eq $config{po_master_language}{code};
653         return masterpage($page) . '.' . $code;
654 } #}}}
655
656 sub otherlanguages ($) { #{{{
657         my $page=shift;
658
659         my %ret;
660         return \%ret unless (istranslation($page) || istranslatable($page));
661         my $curlang=lang($page);
662         foreach my $lang
663                 ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
664                 next if $lang eq $curlang;
665                 $ret{$lang}=otherlanguage($page, $lang);
666         }
667         return \%ret;
668 } #}}}
669
670 sub potfile ($) { #{{{
671         my $masterfile=shift;
672
673         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
674         $dir='' if $dir eq './';
675         return File::Spec->catpath('', $dir, $name . ".pot");
676 } #}}}
677
678 sub pofile ($$) { #{{{
679         my $masterfile=shift;
680         my $lang=shift;
681
682         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
683         $dir='' if $dir eq './';
684         return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
685 } #}}}
686
687 sub pofiles ($) { #{{{
688         my $masterfile=shift;
689
690         return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
691 } #}}}
692
693 sub refreshpot ($) { #{{{
694         my $masterfile=shift;
695
696         my $potfile=potfile($masterfile);
697         my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
698         my $doc=Locale::Po4a::Chooser::new('text',%options);
699         $doc->{TT}{utf_mode} = 1;
700         $doc->{TT}{file_in_charset} = 'utf-8';
701         $doc->{TT}{file_out_charset} = 'utf-8';
702         $doc->read($masterfile);
703         # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
704         # this is undocument use of internal Locale::Po4a::TransTractor's data,
705         # compulsory since this module prevents us from using the porefs option.
706         my %po_options = ('porefs' => 'none');
707         $doc->{TT}{po_out}=Locale::Po4a::Po->new(\%po_options);
708         $doc->{TT}{po_out}->set_charset('utf-8');
709         # do the actual work
710         $doc->parse;
711         IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
712         $doc->writepo($potfile);
713 } #}}}
714
715 sub refreshpofiles ($@) { #{{{
716         my $masterfile=shift;
717         my @pofiles=@_;
718
719         my $potfile=potfile($masterfile);
720         error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
721
722         foreach my $pofile (@pofiles) {
723                 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
724                 if (-e $pofile) {
725                         system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
726                                 or error("[po/refreshpofiles:$pofile] failed to update");
727                 }
728                 else {
729                         File::Copy::syscopy($potfile,$pofile)
730                                 or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
731                 }
732         }
733 } #}}}
734
735 sub buildtranslationscache() { #{{{
736         # use istranslation's side-effect
737         map istranslation($_), (keys %pagesources);
738 } #}}}
739
740 sub resettranslationscache() { #{{{
741         undef %translations;
742 } #}}}
743
744 sub flushmemoizecache() { #{{{
745         Memoize::flush_cache("istranslatable");
746         Memoize::flush_cache("_istranslation");
747         Memoize::flush_cache("percenttranslated");
748 } #}}}
749
750 sub urlto_with_orig_beautiful_urlpath($$) { #{{{
751         my $to=shift;
752         my $from=shift;
753
754         inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
755         my $res=urlto($to, $from);
756         inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
757
758         return $res;
759 } #}}}
760
761 sub percenttranslated ($) { #{{{
762         my $page=shift;
763
764         return gettext("N/A") unless istranslation($page);
765         my $file=srcfile($pagesources{$page});
766         my $masterfile = srcfile($pagesources{masterpage($page)});
767         my (@pos,@masters);
768         push @pos,$file;
769         push @masters,$masterfile;
770         my %options = (
771                 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
772         );
773         my $doc=Locale::Po4a::Chooser::new('text',%options);
774         $doc->process(
775                 'po_in_name'    => \@pos,
776                 'file_in_name'  => \@masters,
777                 'file_in_charset'  => 'utf-8',
778                 'file_out_charset' => 'utf-8',
779         ) or error("[po/percenttranslated:$page]: failed to translate");
780         my ($percent,$hit,$queries) = $doc->stats();
781         return $percent;
782 } #}}}
783
784 sub languagename ($) { #{{{
785         my $code=shift;
786
787         return $config{po_master_language}{name}
788                 if $code eq $config{po_master_language}{code};
789         return $config{po_slave_languages}{$code}
790                 if defined $config{po_slave_languages}{$code};
791         return;
792 } #}}}
793
794 sub otherlanguagesloop ($) { #{{{
795         my $page=shift;
796
797         my @ret;
798         my %otherpages=%{otherlanguages($page)};
799         while (my ($lang, $otherpage) = each %otherpages) {
800                 if (istranslation($page) && masterpage($page) eq $otherpage) {
801                         push @ret, {
802                                 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
803                                 code => $lang,
804                                 language => languagename($lang),
805                                 master => 1,
806                         };
807                 }
808                 else {
809                         push @ret, {
810                                 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
811                                 code => $lang,
812                                 language => languagename($lang),
813                                 percent => percenttranslated($otherpage),
814                         }
815                 }
816         }
817         return sort {
818                         return -1 if $a->{code} eq $config{po_master_language}{code};
819                         return 1 if $b->{code} eq $config{po_master_language}{code};
820                         return $a->{language} cmp $b->{language};
821                 } @ret;
822 } #}}}
823
824 sub homepageurl (;$) { #{{{
825         my $page=shift;
826
827         return urlto('', $page);
828 } #}}}
829
830 sub deletetranslations ($) { #{{{
831         my $deletedmasterfile=shift;
832
833         debug "po(deletetranslations): TODO: delete translations of $deletedmasterfile";
834 } #}}}
835
836 sub renametranslations (@) { #{{{
837         my ($oldpage, $newpage)=(shift, shift);
838
839         # FIXME - not needed anymore : debug "po(renametranslations): TODO: rename translations of $oldpage to $newpage";
840         
841 } #}}}
842
843
844 # ,----
845 # | PageSpec's
846 # `----
847
848 package IkiWiki::PageSpec;
849 use warnings;
850 use strict;
851 use IkiWiki 2.00;
852
853 sub match_istranslation ($;@) { #{{{
854         my $page=shift;
855
856         if (IkiWiki::Plugin::po::istranslation($page)) {
857                 return IkiWiki::SuccessReason->new("is a translation page");
858         }
859         else {
860                 return IkiWiki::FailReason->new("is not a translation page");
861         }
862 } #}}}
863
864 sub match_istranslatable ($;@) { #{{{
865         my $page=shift;
866
867         if (IkiWiki::Plugin::po::istranslatable($page)) {
868                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
869         }
870         else {
871                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
872         }
873 } #}}}
874
875 sub match_lang ($$;@) { #{{{
876         my $page=shift;
877         my $wanted=shift;
878
879         my $regexp=IkiWiki::glob2re($wanted);
880         my $lang=IkiWiki::Plugin::po::lang($page);
881         if ($lang!~/^$regexp$/i) {
882                 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
883         }
884         else {
885                 return IkiWiki::SuccessReason->new("file language is $wanted");
886         }
887 } #}}}
888
889 sub match_currentlang ($$;@) { #{{{
890         my $page=shift;
891         shift;
892         my %params=@_;
893
894         return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
895
896         my $currentlang=IkiWiki::Plugin::po::lang($params{location});
897         my $lang=IkiWiki::Plugin::po::lang($page);
898
899         if ($lang eq $currentlang) {
900                 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
901         }
902         else {
903                 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
904         }
905 } #}}}
906
907 1