po plugin: rebuild %translations after having created missing POT/PO files
[ikiwiki.git] / IkiWiki / Plugin / po.pm
1 #!/usr/bin/perl
2 # .po as a wiki page type
3 # inspired by the GPL'd po4a-translate,
4 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
5 package IkiWiki::Plugin::po;
6
7 use warnings;
8 use strict;
9 use IkiWiki 2.00;
10 use Encode;
11 use Locale::Po4a::Chooser;
12 use File::Basename;
13 use File::Copy;
14 use File::Spec;
15 use File::Temp;
16 use Memoize;
17
18 my %translations;
19 memoize("istranslatable");
20 memoize("_istranslation");
21 memoize("percenttranslated");
22
23 sub import {
24         hook(type => "getsetup", id => "po", call => \&getsetup);
25         hook(type => "checkconfig", id => "po", call => \&checkconfig);
26         hook(type => "needsbuild", id => "po", call => \&needsbuild);
27         hook(type => "targetpage", id => "po", call => \&targetpage);
28         hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
29         hook(type => "tweakbestlink", id => "po", call => \&tweakbestlink);
30         hook(type => "filter", id => "po", call => \&filter);
31         hook(type => "htmlize", id => "po", call => \&htmlize);
32         hook(type => "pagetemplate", id => "po", call => \&pagetemplate);
33 }
34
35 sub getsetup () { #{{{
36         return
37                 plugin => {
38                         safe => 0,
39                         rebuild => 1, # format plugin
40                 },
41                 po_master_language => {
42                         type => "string",
43                         example => {
44                                 'code' => 'en',
45                                 'name' => 'English'
46                         },
47                         description => "master language (non-PO files)",
48                         safe => 1,
49                         rebuild => 1,
50                 },
51                 po_slave_languages => {
52                         type => "string",
53                         example => {
54                                 'fr' => 'Fran├žais',
55                                 'es' => 'Castellano',
56                                 'de' => 'Deutsch'
57                         },
58                         description => "slave languages (PO files)",
59                         safe => 1,
60                         rebuild => 1,
61                 },
62                 po_translatable_pages => {
63                         type => "pagespec",
64                         example => "!*/Discussion",
65                         description => "PageSpec controlling which pages are translatable",
66                         link => "ikiwiki/PageSpec",
67                         safe => 1,
68                         rebuild => 1,
69                 },
70                 po_link_to => {
71                         type => "string",
72                         example => "current",
73                         description => "internal linking behavior (default/current/negotiated)",
74                         safe => 1,
75                         rebuild => 1,
76                 },
77 } #}}}
78
79 sub checkconfig () { #{{{
80         foreach my $field (qw{po_master_language po_slave_languages}) {
81                 if (! exists $config{$field} || ! defined $config{$field}) {
82                         error(sprintf(gettext("Must specify %s"), $field));
83                 }
84         }
85         if (! exists $config{po_link_to} ||
86             ! defined $config{po_link_to}) {
87             $config{po_link_to}="default";
88         }
89         if (! exists $config{po_translatable_pages} ||
90             ! defined $config{po_translatable_pages}) {
91             $config{po_translatable_pages}="";
92         }
93         if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
94                 error(gettext("po_link_to=negotiated requires usedirs to be set"));
95         }
96         push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
97 } #}}}
98
99 sub potfile ($) { #{{{
100         my $masterfile=shift;
101         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
102         return File::Spec->catfile($dir, $name . ".pot");
103 } #}}}
104
105 sub pofile ($$) { #{{{
106         my $masterfile=shift;
107         my $lang=shift;
108         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
109         return File::Spec->catfile($dir, $name . "." . $lang . ".po");
110 } #}}}
111
112 sub refreshpot ($) { #{{{
113         my $masterfile=shift;
114         my $potfile=potfile($masterfile);
115         my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
116         my $doc=Locale::Po4a::Chooser::new('text',%options);
117         $doc->read($masterfile);
118         $doc->{TT}{utf_mode} = 1;
119         $doc->{TT}{file_in_charset} = 'utf-8';
120         $doc->{TT}{file_out_charset} = 'utf-8';
121         $doc->parse;
122         $doc->writepo($potfile);
123 } #}}}
124
125 sub refreshpofiles ($@) { #{{{
126         my $masterfile=shift;
127         my @pofiles=@_;
128
129         my $potfile=potfile($masterfile);
130         error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
131
132         foreach my $pofile (@pofiles) {
133                 if (-e $pofile) {
134                         my $cmd = "msgmerge -U $pofile $potfile";
135                         system ($cmd) == 0
136                                 or error("[po/refreshpofiles:$pofile] failed to update");
137                 }
138                 else {
139                         File::Copy::syscopy($potfile,$pofile)
140                                 or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
141                 }
142         }
143 } #}}}
144
145 sub needsbuild () { #{{{
146         my $needsbuild=shift;
147
148         # build %translations, using istranslation's side-effect
149         foreach my $page (keys %pagesources) {
150                 istranslation($page);
151         }
152
153         # refresh/create POT and PO files as needed
154         foreach my $page (keys %pagesources) {
155                 my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;
156                 if (istranslatable($page)) {
157                         my $file=srcfile($pagesources{$page});
158                         if ($pageneedsbuild || ! -e potfile($file)) {
159                                 refreshpot($file);
160                         }
161                         my @pofiles;
162                         foreach my $lang (keys %{$config{po_slave_languages}}) {
163                                 my $pofile=pofile($file, $lang);
164                                 if ($pageneedsbuild || ! -e $pofile) {
165                                         push @pofiles, $pofile;
166                                 }
167                         }
168                         refreshpofiles($file, @pofiles) if (@pofiles);
169                 }
170         }
171
172         # refresh %translations, using istranslation's side-effect
173         # (not needed yet, but when newly created POT/PO files are
174         # added to %pagesources and other data structures, we'll need
175         # this)
176         foreach my $page (keys %pagesources) {
177                 istranslation($page);
178         }
179
180         # make existing translations depend on the corresponding master page
181         foreach my $master (keys %translations) {
182                 foreach my $slave (values %{$translations{$master}}) {
183                         add_depends($slave, $master);
184                 }
185         }
186 } #}}}
187
188 sub targetpage (@) { #{{{
189         my %params = @_;
190         my $page=$params{page};
191         my $ext=$params{ext};
192
193         if (istranslation($page)) {
194                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
195                 if (! $config{usedirs} || $page eq 'index') {
196                         return $masterpage . "." . $lang . "." . $ext;
197                 }
198                 else {
199                         return $masterpage . "/index." . $lang . "." . $ext;
200                 }
201         }
202         elsif (istranslatable($page)) {
203                 if (! $config{usedirs} || $page eq 'index') {
204                         return $page . "." . $config{po_master_language}{code} . "." . $ext;
205                 }
206                 else {
207                         return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
208                 }
209         }
210         return;
211 } #}}}
212
213 sub tweakurlpath ($) { #{{{
214         my %params = @_;
215         my $url=$params{url};
216         if ($config{po_link_to} eq "negotiated") {
217                 $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
218         }
219         return $url;
220 } #}}}
221
222 sub tweakbestlink ($$) { #{{{
223         my %params = @_;
224         my $page=$params{page};
225         my $link=$params{link};
226         if ($config{po_link_to} eq "current"
227             && istranslatable($link)
228             && istranslation($page)) {
229                 my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
230                 return $link . "." . $curlang;
231         }
232         return $link;
233 } #}}}
234
235 our %filtered;
236 # We use filter to convert PO to the master page's type,
237 # since other plugins should not work on PO files
238 sub filter (@) { #{{{
239         my %params = @_;
240         my $page = $params{page};
241         my $destpage = $params{destpage};
242         my $content = decode_utf8(encode_utf8($params{content}));
243
244         # decide if this is a PO file that should be converted into a translated document,
245         # and perform various sanity checks
246         if (! istranslation($page) || $filtered{$page}{$destpage}) {
247                 return $content;
248         }
249
250         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
251         my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page});
252         my $masterfile = srcfile($pagesources{$masterpage});
253         my (@pos,@masters);
254         push @pos,$file;
255         push @masters,$masterfile;
256         my %options = (
257                         "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
258                         );
259         my $doc=Locale::Po4a::Chooser::new('text',%options);
260         $doc->process(
261                 'po_in_name'    => \@pos,
262                 'file_in_name'  => \@masters,
263                 'file_in_charset'  => 'utf-8',
264                 'file_out_charset' => 'utf-8',
265         ) or error("[po/filter:$file]: failed to translate");
266         my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
267         my $tmpout = $tmpfh->filename;
268         $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
269         $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
270         $filtered{$page}{$destpage}=1;
271         return $content;
272 } #}}}
273
274 sub htmlize (@) { #{{{
275         my %params=@_;
276         my $page = $params{page};
277         my $content = $params{content};
278         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
279         my $masterfile = srcfile($pagesources{$masterpage});
280
281         # force content to be htmlize'd as if it was the same type as the master page
282         return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
283 } #}}}
284
285 sub percenttranslated ($) { #{{{
286         my $page=shift;
287         return "N/A" unless (istranslation($page));
288         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
289         my $file=srcfile($pagesources{$page});
290         my $masterfile = srcfile($pagesources{$masterpage});
291         my (@pos,@masters);
292         push @pos,$file;
293         push @masters,$masterfile;
294         my %options = (
295                         "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
296                         );
297         my $doc=Locale::Po4a::Chooser::new('text',%options);
298         $doc->process(
299                 'po_in_name'    => \@pos,
300                 'file_in_name'  => \@masters,
301                 'file_in_charset'  => 'utf-8',
302                 'file_out_charset' => 'utf-8',
303         ) or error("[po/percenttranslated:$file]: failed to translate");
304         my ($percent,$hit,$queries) = $doc->stats();
305         return $percent;
306 } #}}}
307
308 sub otherlanguages ($) { #{{{
309         my $page=shift;
310         my @ret;
311         if (istranslatable($page)) {
312                 foreach my $lang (sort keys %{$translations{$page}}) {
313                         my $translation = $translations{$page}{$lang};
314                         push @ret, {
315                                 url => urlto($translation, $page),
316                                 code => $lang,
317                                 language => $config{po_slave_languages}{$lang},
318                                 percent => percenttranslated($translation),
319                         };
320                 }
321         }
322         elsif (istranslation($page)) {
323                 my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
324                 push @ret, {
325                         url => urlto($masterpage, $page),
326                         code => $config{po_master_language}{code},
327                         language => $config{po_master_language}{name},
328                         master => 1,
329                 };
330                 foreach my $lang (sort keys %{$translations{$masterpage}}) {
331                         push @ret, {
332                                 url => urlto($translations{$masterpage}{$lang}, $page),
333                                 code => $lang,
334                                 language => $config{po_slave_languages}{$lang},
335                                 percent => percenttranslated($page),
336                         } unless ($lang eq $curlang);
337                 }
338         }
339         return @ret;
340 } #}}}
341
342 sub pagetemplate (@) { #{{{
343         my %params=@_;
344         my $page=$params{page};
345         my $template=$params{template};
346
347         if (istranslation($page) && $template->query(name => "percenttranslated")) {
348                 $template->param(percenttranslated => percenttranslated($page));
349         }
350         if ($template->query(name => "otherlanguages")) {
351                 $template->param(otherlanguages => [otherlanguages($page)]);
352         }
353 } # }}}
354
355 sub istranslatable ($) { #{{{
356         my $page=shift;
357         my $file=$pagesources{$page};
358
359         if (! defined $file
360             || (defined pagetype($file) && pagetype($file) eq 'po')
361             || $file =~ /\.pot$/) {
362                 return 0;
363         }
364         return pagespec_match($page, $config{po_translatable_pages});
365 } #}}}
366
367 sub _istranslation ($) { #{{{
368         my $page=shift;
369         my $file=$pagesources{$page};
370         if (! defined $file) {
371                 return IkiWiki::FailReason->new("no file specified");
372         }
373
374         if (! defined $file
375             || ! defined pagetype($file)
376             || ! pagetype($file) eq 'po'
377             || $file =~ /\.pot$/) {
378                 return 0;
379         }
380
381         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
382         if (! defined $masterpage || ! defined $lang
383             || ! (length($masterpage) > 0) || ! (length($lang) > 0)
384             || ! defined $pagesources{$masterpage}
385             || ! defined $config{po_slave_languages}{$lang}) {
386                 return 0;
387         }
388
389         return istranslatable($masterpage);
390 } #}}}
391
392 sub istranslation ($) { #{{{
393         my $page=shift;
394         if (_istranslation($page)) {
395                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
396                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
397                 return 1;
398         }
399         return 0;
400 } #}}}
401
402 package IkiWiki::PageSpec;
403 use warnings;
404 use strict;
405 use IkiWiki 2.00;
406
407 sub match_istranslation ($;@) { #{{{
408         my $page=shift;
409         if (IkiWiki::Plugin::po::istranslation($page)) {
410                 return IkiWiki::SuccessReason->new("is a translation page");
411         }
412         else {
413                 return IkiWiki::FailReason->new("is not a translation page");
414         }
415 } #}}}
416
417 sub match_istranslatable ($;@) { #{{{
418         my $page=shift;
419         if (IkiWiki::Plugin::po::istranslatable($page)) {
420                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
421         }
422         else {
423                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
424         }
425 } #}}}
426
427 sub match_lang ($$;@) { #{{{
428         my $page=shift;
429         my $wanted=shift;
430         my $regexp=IkiWiki::glob2re($wanted);
431         my $lang;
432         my $masterpage;
433
434         if (IkiWiki::Plugin::po::istranslation($page)) {
435                 ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
436         }
437         else {
438                 $lang = $config{po_master_language}{code};
439         }
440
441         if ($lang!~/^$regexp$/i) {
442                 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
443         }
444         else {
445                 return IkiWiki::SuccessReason->new("file language is $wanted");
446         }
447 } #}}}
448
449 sub match_currentlang ($$;@) { #{{{
450         my $page=shift;
451         shift;
452         my %params=@_;
453         my ($currentmasterpage, $currentlang, $masterpage, $lang);
454
455         return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
456
457         if (IkiWiki::Plugin::po::istranslation($params{location})) {
458                 ($currentmasterpage, $currentlang) = ($params{location} =~ /(.*)[.]([a-z]{2})$/);
459         }
460         else {
461                 $currentlang = $config{po_master_language}{code};
462         }
463
464         if (IkiWiki::Plugin::po::istranslation($page)) {
465                 ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
466         }
467         else {
468                 $lang = $config{po_master_language}{code};
469         }
470
471         if ($lang eq $currentlang) {
472                 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
473         }
474         else {
475                 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
476         }
477 } #}}}
478
479 1