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