]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/po.pm
po plugin: create missing POT/PO files in needsbuild hook
[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         # make existing translations depend on the corresponding master page
173         foreach my $master (keys %translations) {
174                 foreach my $slave (values %{$translations{$master}}) {
175                         add_depends($slave, $master);
176                 }
177         }
178 } #}}}
179
180 sub targetpage (@) { #{{{
181         my %params = @_;
182         my $page=$params{page};
183         my $ext=$params{ext};
184
185         if (istranslation($page)) {
186                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
187                 if (! $config{usedirs} || $page eq 'index') {
188                         return $masterpage . "." . $lang . "." . $ext;
189                 }
190                 else {
191                         return $masterpage . "/index." . $lang . "." . $ext;
192                 }
193         }
194         elsif (istranslatable($page)) {
195                 if (! $config{usedirs} || $page eq 'index') {
196                         return $page . "." . $config{po_master_language}{code} . "." . $ext;
197                 }
198                 else {
199                         return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
200                 }
201         }
202         return;
203 } #}}}
204
205 sub tweakurlpath ($) { #{{{
206         my %params = @_;
207         my $url=$params{url};
208         if ($config{po_link_to} eq "negotiated") {
209                 $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
210         }
211         return $url;
212 } #}}}
213
214 sub tweakbestlink ($$) { #{{{
215         my %params = @_;
216         my $page=$params{page};
217         my $link=$params{link};
218         if ($config{po_link_to} eq "current"
219             && istranslatable($link)
220             && istranslation($page)) {
221                 my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
222                 return $link . "." . $curlang;
223         }
224         return $link;
225 } #}}}
226
227 our %filtered;
228 # We use filter to convert PO to the master page's type,
229 # since other plugins should not work on PO files
230 sub filter (@) { #{{{
231         my %params = @_;
232         my $page = $params{page};
233         my $destpage = $params{destpage};
234         my $content = decode_utf8(encode_utf8($params{content}));
235
236         # decide if this is a PO file that should be converted into a translated document,
237         # and perform various sanity checks
238         if (! istranslation($page) || $filtered{$page}{$destpage}) {
239                 return $content;
240         }
241
242         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
243         my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page});
244         my $masterfile = srcfile($pagesources{$masterpage});
245         my (@pos,@masters);
246         push @pos,$file;
247         push @masters,$masterfile;
248         my %options = (
249                         "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
250                         );
251         my $doc=Locale::Po4a::Chooser::new('text',%options);
252         $doc->process(
253                 'po_in_name'    => \@pos,
254                 'file_in_name'  => \@masters,
255                 'file_in_charset'  => 'utf-8',
256                 'file_out_charset' => 'utf-8',
257         ) or error("[po/filter:$file]: failed to translate");
258         my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
259         my $tmpout = $tmpfh->filename;
260         $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
261         $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
262         $filtered{$page}{$destpage}=1;
263         return $content;
264 } #}}}
265
266 sub htmlize (@) { #{{{
267         my %params=@_;
268         my $page = $params{page};
269         my $content = $params{content};
270         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
271         my $masterfile = srcfile($pagesources{$masterpage});
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, pagetype($masterfile), $content);
275 } #}}}
276
277 sub percenttranslated ($) { #{{{
278         my $page=shift;
279         return "N/A" unless (istranslation($page));
280         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
281         my $file=srcfile($pagesources{$page});
282         my $masterfile = srcfile($pagesources{$masterpage});
283         my (@pos,@masters);
284         push @pos,$file;
285         push @masters,$masterfile;
286         my %options = (
287                         "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
288                         );
289         my $doc=Locale::Po4a::Chooser::new('text',%options);
290         $doc->process(
291                 'po_in_name'    => \@pos,
292                 'file_in_name'  => \@masters,
293                 'file_in_charset'  => 'utf-8',
294                 'file_out_charset' => 'utf-8',
295         ) or error("[po/percenttranslated:$file]: failed to translate");
296         my ($percent,$hit,$queries) = $doc->stats();
297         return $percent;
298 } #}}}
299
300 sub otherlanguages ($) { #{{{
301         my $page=shift;
302         my @ret;
303         if (istranslatable($page)) {
304                 foreach my $lang (sort keys %{$translations{$page}}) {
305                         my $translation = $translations{$page}{$lang};
306                         push @ret, {
307                                 url => urlto($translation, $page),
308                                 code => $lang,
309                                 language => $config{po_slave_languages}{$lang},
310                                 percent => percenttranslated($translation),
311                         };
312                 }
313         }
314         elsif (istranslation($page)) {
315                 my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
316                 push @ret, {
317                         url => urlto($masterpage, $page),
318                         code => $config{po_master_language}{code},
319                         language => $config{po_master_language}{name},
320                         master => 1,
321                 };
322                 foreach my $lang (sort keys %{$translations{$masterpage}}) {
323                         push @ret, {
324                                 url => urlto($translations{$masterpage}{$lang}, $page),
325                                 code => $lang,
326                                 language => $config{po_slave_languages}{$lang},
327                                 percent => percenttranslated($page),
328                         } unless ($lang eq $curlang);
329                 }
330         }
331         return @ret;
332 } #}}}
333
334 sub pagetemplate (@) { #{{{
335         my %params=@_;
336         my $page=$params{page};
337         my $template=$params{template};
338
339         if (istranslation($page) && $template->query(name => "percenttranslated")) {
340                 $template->param(percenttranslated => percenttranslated($page));
341         }
342         if ($template->query(name => "otherlanguages")) {
343                 $template->param(otherlanguages => [otherlanguages($page)]);
344         }
345 } # }}}
346
347 sub istranslatable ($) { #{{{
348         my $page=shift;
349         my $file=$pagesources{$page};
350
351         if (! defined $file
352             || (defined pagetype($file) && pagetype($file) eq 'po')
353             || $file =~ /\.pot$/) {
354                 return 0;
355         }
356         return pagespec_match($page, $config{po_translatable_pages});
357 } #}}}
358
359 sub _istranslation ($) { #{{{
360         my $page=shift;
361         my $file=$pagesources{$page};
362         if (! defined $file) {
363                 return IkiWiki::FailReason->new("no file specified");
364         }
365
366         if (! defined $file
367             || ! defined pagetype($file)
368             || ! pagetype($file) eq 'po'
369             || $file =~ /\.pot$/) {
370                 return 0;
371         }
372
373         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
374         if (! defined $masterpage || ! defined $lang
375             || ! (length($masterpage) > 0) || ! (length($lang) > 0)
376             || ! defined $pagesources{$masterpage}
377             || ! defined $config{po_slave_languages}{$lang}) {
378                 return 0;
379         }
380
381         return istranslatable($masterpage);
382 } #}}}
383
384 sub istranslation ($) { #{{{
385         my $page=shift;
386         if (_istranslation($page)) {
387                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
388                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
389                 return 1;
390         }
391         return 0;
392 } #}}}
393
394 package IkiWiki::PageSpec;
395 use warnings;
396 use strict;
397 use IkiWiki 2.00;
398
399 sub match_istranslation ($;@) { #{{{
400         my $page=shift;
401         if (IkiWiki::Plugin::po::istranslation($page)) {
402                 return IkiWiki::SuccessReason->new("is a translation page");
403         }
404         else {
405                 return IkiWiki::FailReason->new("is not a translation page");
406         }
407 } #}}}
408
409 sub match_istranslatable ($;@) { #{{{
410         my $page=shift;
411         if (IkiWiki::Plugin::po::istranslatable($page)) {
412                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
413         }
414         else {
415                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
416         }
417 } #}}}
418
419 sub match_lang ($$;@) { #{{{
420         my $page=shift;
421         my $wanted=shift;
422         my $regexp=IkiWiki::glob2re($wanted);
423         my $lang;
424         my $masterpage;
425
426         if (IkiWiki::Plugin::po::istranslation($page)) {
427                 ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
428         }
429         else {
430                 $lang = $config{po_master_language}{code};
431         }
432
433         if ($lang!~/^$regexp$/i) {
434                 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
435         }
436         else {
437                 return IkiWiki::SuccessReason->new("file language is $wanted");
438         }
439 } #}}}
440
441 sub match_currentlang ($$;@) { #{{{
442         my $page=shift;
443         shift;
444         my %params=@_;
445         my ($currentmasterpage, $currentlang, $masterpage, $lang);
446
447         return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
448
449         if (IkiWiki::Plugin::po::istranslation($params{location})) {
450                 ($currentmasterpage, $currentlang) = ($params{location} =~ /(.*)[.]([a-z]{2})$/);
451         }
452         else {
453                 $currentlang = $config{po_master_language}{code};
454         }
455
456         if (IkiWiki::Plugin::po::istranslation($page)) {
457                 ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
458         }
459         else {
460                 $lang = $config{po_master_language}{code};
461         }
462
463         if ($lang eq $currentlang) {
464                 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
465         }
466         else {
467                 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
468         }
469 } #}}}
470
471 1