IkiWiki/Plugin/po.pm

   1 #!/usr/bin/perl
   2 # .po as a wiki page type
   3 # Licensed under GPL v2 or greater
   4 # Copyright (C) 2008-2009 intrigeri <intrigeri@boum.org>
   5 # inspired by the GPL'd po4a-translate,
   6 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
   7 package IkiWiki::Plugin::po;
   8
   9 use warnings;
  10 use strict;
  11 use IkiWiki 3.00;
  12 use Encode;
  13 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 => "postscan", id => "po", call => \&postscan);
  39         hook(type => "rename", id => "po", call => \&renamepages, first => 1);
  40         hook(type => "delete", id => "po", call => \&mydelete);
  41         hook(type => "change", id => "po", call => \&change);
  42         # hook(type => "cansave", id => "po", call => \&cansave);
  43         hook(type => "canremove", id => "po", call => \&canremove);
  44         hook(type => "canrename", id => "po", call => \&canrename);
  45         hook(type => "editcontent", id => "po", call => \&editcontent);
  46         hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
  47         hook(type => "formbuilder", id => "po", call => \&formbuilder);
  48
  49         $origsubs{'bestlink'}=\&IkiWiki::bestlink;
  50         inject(name => "IkiWiki::bestlink", call => \&mybestlink);
  51         $origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
  52         inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
  53         $origsubs{'targetpage'}=\&IkiWiki::targetpage;
  54         inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
  55         $origsubs{'urlto'}=\&IkiWiki::urlto;
  56         inject(name => "IkiWiki::urlto", call => \&myurlto);
  57         $origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
  58         inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);
  59 }
  60
  61
  62 # ,----
  63 # | Table of contents
  64 # `----
  65
  66 # 1. Hooks
  67 # 2. Injected functions
  68 # 3. Blackboxes for private data
  69 # 4. Helper functions
  70 # 5. PageSpec's
  71
  72
  73 # ,----
  74 # | Hooks
  75 # `----
  76
  77 sub getsetup () {
  78         return
  79                 plugin => {
  80                         safe => 0,
  81                         rebuild => 1,
  82                 },
  83                 po_master_language => {
  84                         type => "string",
  85                         example => {
  86                                 'code' => 'en',
  87                                 'name' => 'English'
  88                         },
  89                         description => "master language (non-PO files)",
  90                         safe => 1,
  91                         rebuild => 1,
  92                 },
  93                 po_slave_languages => {
  94                         type => "string",
  95                         example => {
  96                                 'fr' => 'Français',
  97                                 'es' => 'Castellano',
  98                                 'de' => 'Deutsch'
  99                         },
 100                         description => "slave languages (PO files)",
 101                         safe => 1,
 102                         rebuild => 1,
 103                 },
 104                 po_translatable_pages => {
 105                         type => "pagespec",
 106                         example => "!*/Discussion",
 107                         description => "PageSpec controlling which pages are translatable",
 108                         link => "ikiwiki/PageSpec",
 109                         safe => 1,
 110                         rebuild => 1,
 111                 },
 112                 po_link_to => {
 113                         type => "string",
 114                         example => "current",
 115                         description => "internal linking behavior (default/current/negotiated)",
 116                         safe => 1,
 117                         rebuild => 1,
 118                 },
 119                 po_translation_status_in_links => {
 120                         type => "boolean",
 121                         example => 1,
 122                         description => "display translation status in links to translations",
 123                         safe => 1,
 124                         rebuild => 1,
 125                 },
 126 }
 127
 128 sub checkconfig () {
 129         foreach my $field (qw{po_master_language po_slave_languages}) {
 130                 if (! exists $config{$field} || ! defined $config{$field}) {
 131                         error(sprintf(gettext("Must specify %s when using the %s plugin"),
 132                                       $field, 'po'));
 133                 }
 134         }
 135         if (! (keys %{$config{po_slave_languages}})) {
 136                 error(gettext("At least one slave language must be defined ".
 137                               "in po_slave_languages when using the po plugin"));
 138         }
 139         map {
 140                 islanguagecode($_)
 141                         or error(sprintf(gettext("%s is not a valid language code"), $_));
 142         } ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
 143         if (! exists $config{po_translatable_pages} ||
 144             ! defined $config{po_translatable_pages}) {
 145                 $config{po_translatable_pages}="";
 146         }
 147         if (! exists $config{po_link_to} ||
 148             ! defined $config{po_link_to}) {
 149                 $config{po_link_to}='default';
 150         }
 151         elsif (! grep {
 152                         $config{po_link_to} eq $_
 153                 } ('default', 'current', 'negotiated')) {
 154                 warn(sprintf(gettext('%s is not a valid value for po_link_to, falling back to po_link_to=default'),
 155                              $config{po_link_to}));
 156                 $config{po_link_to}='default';
 157         }
 158         elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
 159                 warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
 160                 $config{po_link_to}='default';
 161         }
 162         if (! exists $config{po_translation_status_in_links} ||
 163             ! defined $config{po_translation_status_in_links}) {
 164                 $config{po_translation_status_in_links}=1;
 165         }
 166         push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 167 }
 168
 169 sub needsbuild () {
 170         my $needsbuild=shift;
 171
 172         # backup @needsbuild content so that change() can know whether
 173         # a given master page was rendered because its source file was changed
 174         @origneedsbuild=(@$needsbuild);
 175
 176         flushmemoizecache();
 177         buildtranslationscache();
 178
 179         # make existing translations depend on the corresponding master page
 180         foreach my $master (keys %translations) {
 181                 map add_depends($_, $master), values %{otherlanguages($master)};
 182         }
 183 }
 184
 185 # Massage the recorded state of internal links so that:
 186 # - it matches the actually generated links, rather than the links as written
 187 #   in the pages' source
 188 # - backlinks are consistent in all cases
 189 sub scan (@) {
 190         my %params=@_;
 191         my $page=$params{page};
 192         my $content=$params{content};
 193
 194         return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
 195
 196         if (istranslation($page)) {
 197                 foreach my $destpage (@{$links{$page}}) {
 198                         if (istranslatable($destpage)) {
 199                                 # replace one occurence of $destpage in $links{$page}
 200                                 # (we only want to replace the one that was added by
 201                                 # IkiWiki::Plugin::link::scan, other occurences may be
 202                                 # there for other reasons)
 203                                 for (my $i=0; $i<@{$links{$page}}; $i++) {
 204                                         if (@{$links{$page}}[$i] eq $destpage) {
 205                                                 @{$links{$page}}[$i] = $destpage . '.' . lang($page);
 206                                                 last;
 207                                         }
 208                                 }
 209                         }
 210                 }
 211         }
 212         elsif (! istranslatable($page) && ! istranslation($page)) {
 213                 foreach my $destpage (@{$links{$page}}) {
 214                         if (istranslatable($destpage)) {
 215                                 # make sure any destpage's translations has
 216                                 # $page in its backlinks
 217                                 push @{$links{$page}},
 218                                         values %{otherlanguages($destpage)};
 219                         }
 220                 }
 221         }
 222 }
 223
 224 # We use filter to convert PO to the master page's format,
 225 # since the rest of ikiwiki should not work on PO files.
 226 sub filter (@) {
 227         my %params = @_;
 228
 229         my $page = $params{page};
 230         my $destpage = $params{destpage};
 231         my $content = $params{content};
 232         if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
 233                 $content = po_to_markup($page, $content);
 234                 setalreadyfiltered($page, $destpage);
 235         }
 236         return $content;
 237 }
 238
 239 sub htmlize (@) {
 240         my %params=@_;
 241
 242         my $page = $params{page};
 243         my $content = $params{content};
 244
 245         # ignore PO files this plugin did not create
 246         return $content unless istranslation($page);
 247
 248         # force content to be htmlize'd as if it was the same type as the master page
 249         return IkiWiki::htmlize($page, $page,
 250                                 pagetype(srcfile($pagesources{masterpage($page)})),
 251                                 $content);
 252 }
 253
 254 sub pagetemplate (@) {
 255         my %params=@_;
 256         my $page=$params{page};
 257         my $destpage=$params{destpage};
 258         my $template=$params{template};
 259
 260         my ($masterpage, $lang) = istranslation($page);
 261
 262         if (istranslation($page) && $template->query(name => "percenttranslated")) {
 263                 $template->param(percenttranslated => percenttranslated($page));
 264         }
 265         if ($template->query(name => "istranslation")) {
 266                 $template->param(istranslation => scalar istranslation($page));
 267         }
 268         if ($template->query(name => "istranslatable")) {
 269                 $template->param(istranslatable => istranslatable($page));
 270         }
 271         if ($template->query(name => "HOMEPAGEURL")) {
 272                 $template->param(homepageurl => homepageurl($page));
 273         }
 274         if ($template->query(name => "otherlanguages")) {
 275                 $template->param(otherlanguages => [otherlanguagesloop($page)]);
 276                 map add_depends($page, $_), (values %{otherlanguages($page)});
 277         }
 278         # Rely on IkiWiki::Render's genpage() to decide wether
 279         # a discussion link should appear on $page; this is not
 280         # totally accurate, though: some broken links may be generated
 281         # when cgiurl is disabled.
 282         # This compromise avoids some code duplication, and will probably
 283         # prevent future breakage when ikiwiki internals change.
 284         # Known limitations are preferred to future random bugs.
 285         if ($template->param('discussionlink') && istranslation($page)) {
 286                 $template->param('discussionlink' => htmllink(
 287                                                         $page,
 288                                                         $destpage,
 289                                                         $masterpage . '/' . gettext("Discussion"),
 290                                                         noimageinline => 1,
 291                                                         forcesubpage => 0,
 292                                                         linktext => gettext("Discussion"),
 293                                                         ));
 294         }
 295         # Remove broken parentlink to ./index.html on home page's translations.
 296         # It works because this hook has the "last" parameter set, to ensure it
 297         # runs after parentlinks' own pagetemplate hook.
 298         if ($template->param('parentlinks')
 299             && istranslation($page)
 300             && $masterpage eq "index") {
 301                 $template->param('parentlinks' => []);
 302         }
 303 } # }}}
 304
 305 sub postscan (@) {
 306         my %params = @_;
 307         my $page = $params{page};
 308
 309         # backlinks involve back-dependencies, so that nicepagetitle effects,
 310         # such as translation status displayed in links, are updated
 311         use IkiWiki::Render;
 312         map add_depends($page, $_), keys %{$IkiWiki::backlinks{$page}};
 313 }
 314
 315 # Add the renamed page translations to the list of to-be-renamed pages.
 316 sub renamepages($$$) {
 317         my ($torename, $cgi, $session) = (shift, shift, shift);
 318
 319         # copy the initial array, so that we can iterate on it AND
 320         # modify it at the same time, without iterating on the items we
 321         # pushed on it ourselves
 322         my @torename=@{$torename};
 323
 324         # Save the page(s) the user asked to rename, so that our
 325         # canrename hook can tell the difference between:
 326         #  - a translation being renamed as a consequence of its master page
 327         #    being renamed
 328         #  - a user trying to directly rename a translation
 329         # This is why this hook has to be run first, before @torename is modified
 330         # by other plugins.
 331         $session->param(po_orig_torename => [ @torename ]);
 332         IkiWiki::cgi_savesession($session);
 333
 334         foreach my $rename (@torename) {
 335                 next unless istranslatable($rename->{src});
 336                 my %otherpages=%{otherlanguages($rename->{src})};
 337                 while (my ($lang, $otherpage) = each %otherpages) {
 338                         push @{$torename}, {
 339                                 src => $otherpage,
 340                                 srcfile => $pagesources{$otherpage},
 341                                 dest => otherlanguage($rename->{dest}, $lang),
 342                                 destfile => $rename->{dest}.".".$lang.".po",
 343                                 required => 0,
 344                         };
 345                 }
 346         }
 347 }
 348
 349 sub mydelete(@) {
 350         my @deleted=@_;
 351
 352         map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
 353 }
 354
 355 sub change(@) {
 356         my @rendered=@_;
 357
 358         my $updated_po_files=0;
 359
 360         # Refresh/create POT and PO files as needed.
 361         foreach my $file (grep {istranslatablefile($_)} @rendered) {
 362                 my $page=pagename($file);
 363                 my $masterfile=srcfile($file);
 364                 my $updated_pot_file=0;
 365                 # Only refresh Pot file if it does not exist, or if
 366                 # $pagesources{$page} was changed: don't if only the HTML was
 367                 # refreshed, e.g. because of a dependency.
 368                 if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
 369                     || ! -e potfile($masterfile)) {
 370                         refreshpot($masterfile);
 371                         $updated_pot_file=1;
 372                 }
 373                 my @pofiles;
 374                 map {
 375                         push @pofiles, $_ if ($updated_pot_file || ! -e $_);
 376                 } (pofiles($masterfile));
 377                 if (@pofiles) {
 378                         refreshpofiles($masterfile, @pofiles);
 379                         map { IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
 380                         $updated_po_files=1;
 381                 }
 382         }
 383
 384         if ($updated_po_files) {
 385                 commit_and_refresh(
 386                         gettext("updated PO files"),
 387                         "IkiWiki::Plugin::po::change");
 388         }
 389 }
 390
 391 sub cansave ($$$$) {
 392         my ($page, $content, $cgi, $session) = (shift, shift, shift, shift);
 393
 394         if (istranslation($page)) {
 395                 my $res = isvalidpo($content);
 396                 if ($res) {
 397                         return undef;
 398                 }
 399                 else {
 400                         return "$res";
 401                 }
 402         }
 403         return undef;
 404 }
 405
 406 sub canremove ($$$) {
 407         my ($page, $cgi, $session) = (shift, shift, shift);
 408
 409         if (istranslation($page)) {
 410                 return gettext("Can not remove a translation. Removing the master page, ".
 411                                "though, removes its translations as well.");
 412         }
 413         return undef;
 414 }
 415
 416 sub canrename ($$@) {
 417         my ($cgi, $session) = (shift, shift);
 418         my %params = @_;
 419
 420         if (istranslation($params{src})) {
 421                 my $masterpage = masterpage($params{src});
 422                 # Tell the difference between:
 423                 #  - a translation being renamed as a consequence of its master page
 424                 #    being renamed, which is allowed
 425                 #  - a user trying to directly rename a translation, which is forbidden
 426                 # by looking for the master page in the list of to-be-renamed pages we
 427                 # saved early in the renaming process.
 428                 my $orig_torename = $session->param("po_orig_torename");
 429                 unless (scalar grep { $_->{src} eq $masterpage } @{$orig_torename}) {
 430                         return gettext("Can not rename a translation. Renaming the master page, ".
 431                                        "though, renames its translations as well.");
 432                 }
 433         }
 434         return undef;
 435 }
 436
 437 # As we're previewing or saving a page, the content may have
 438 # changed, so tell the next filter() invocation it must not be lazy.
 439 sub editcontent () {
 440         my %params=@_;
 441
 442         unsetalreadyfiltered($params{page}, $params{page});
 443         return $params{content};
 444 }
 445
 446 sub formbuilder_setup (@) {
 447         my %params=@_;
 448         my $form=$params{form};
 449         my $q=$params{cgi};
 450
 451         return unless defined $form->field("do");
 452
 453         if ($form->field("do") eq "create") {
 454                 # Warn the user: new pages must be written in master language.
 455                 my $template=template("pocreatepage.tmpl");
 456                 $template->param(LANG => $config{po_master_language}{name});
 457                 $form->tmpl_param(message => $template->output);
 458         }
 459         elsif ($form->field("do") eq "edit") {
 460                 # Remove the rename/remove buttons on slave pages.
 461                 # This has to be done after the rename/remove plugins have added
 462                 # their buttons, which is why this hook must be run last.
 463                 # The canrename/canremove hooks already ensure this is forbidden
 464                 # at the backend level, so this is only UI sugar.
 465                 if (istranslation($form->field("page"))) {
 466                         map {
 467                                 for (my $i = 0; $i < @{$params{buttons}}; $i++) {
 468                                         if (@{$params{buttons}}[$i] eq $_) {
 469                                                 delete  @{$params{buttons}}[$i];
 470                                                 last;
 471                                         }
 472                                 }
 473                         } qw(Rename Remove);
 474                 }
 475         }
 476 }
 477
 478 sub formbuilder (@) {
 479         my %params=@_;
 480         my $form=$params{form};
 481         my $q=$params{cgi};
 482
 483         return unless defined $form->field("do");
 484
 485         # Do not allow to create pages of type po: they are automatically created.
 486         # The main reason to do so is to bypass the "favor the type of linking page
 487         # on page creation" logic, which is unsuitable when a broken link is clicked
 488         # on a slave (PO) page.
 489         # This cannot be done in the formbuilder_setup hook as the list of types is
 490         # computed later.
 491         if ($form->field("do") eq "create") {
 492                 for my $field ($form->field) {
 493                         next unless "$field" eq "type";
 494                         if ($field->type eq 'select') {
 495                                 # remove po from the list of types
 496                                 my @types = grep { $_ ne 'po' } $field->options;
 497                                 $field->options(\@types) if scalar @types;
 498                         }
 499                         else {
 500                                 # make sure the default value is not po;
 501                                 # does this case actually happen?
 502                                 debug "po(formbuilder) ".gettext("type field is not select - not implemented yet");
 503                         }
 504                 }
 505         }
 506
 507         # Prevent invalid PO content to be saved.
 508         # This cannot be done in the formbuilder_setup hook as the editpage plugin
 509         # unconditionally sets the editcontent field's validate code later.
 510         elsif ($form->field("do") eq "edit") {
 511                 if (istranslation($form->field("page"))) {
 512                         $form->field(name => "editcontent", validate => \&isvalidpo);
 513                 }
 514         }
 515 }
 516
 517 # ,----
 518 # | Injected functions
 519 # `----
 520
 521 # Implement po_link_to 'current' and 'negotiated' settings.
 522 sub mybestlink ($$) {
 523         my $page=shift;
 524         my $link=shift;
 525
 526         my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
 527         if (length $res
 528             && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated")
 529             && istranslatable($res)
 530             && istranslation($page)) {
 531                 return $res . "." . lang($page);
 532         }
 533         return $res;
 534 }
 535
 536 sub mybeautify_urlpath ($) {
 537         my $url=shift;
 538
 539         my $res=$origsubs{'beautify_urlpath'}->($url);
 540         if ($config{po_link_to} eq "negotiated") {
 541                 $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
 542                 $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
 543                 map {
 544                         $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
 545                 } (keys %{$config{po_slave_languages}});
 546         }
 547         return $res;
 548 }
 549
 550 sub mytargetpage ($$) {
 551         my $page=shift;
 552         my $ext=shift;
 553
 554         if (istranslation($page) || istranslatable($page)) {
 555                 my ($masterpage, $lang) = (masterpage($page), lang($page));
 556                 if (! $config{usedirs} || $masterpage eq 'index') {
 557                         return $masterpage . "." . $lang . "." . $ext;
 558                 }
 559                 else {
 560                         return $masterpage . "/index." . $lang . "." . $ext;
 561                 }
 562         }
 563         return $origsubs{'targetpage'}->($page, $ext);
 564 }
 565
 566 sub myurlto ($$;$) {
 567         my $to=shift;
 568         my $from=shift;
 569         my $absolute=shift;
 570
 571         # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
 572         if (! length $to
 573             && $config{po_link_to} eq "current"
 574             && istranslatable('index')) {
 575                 return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
 576         }
 577         # avoid using our injected beautify_urlpath if run by cgi_editpage,
 578         # so that one is redirected to the just-edited page rather than to the
 579         # negociated translation; to prevent unnecessary fiddling with caller/inject,
 580         # we only do so when our beautify_urlpath would actually do what we want to
 581         # avoid, i.e. when po_link_to = negotiated
 582         if ($config{po_link_to} eq "negotiated") {
 583                 my @caller = caller(1);
 584                 my $run_by_editpage = 0;
 585                 $run_by_editpage = 1 if (exists $caller[3] && defined $caller[3]
 586                                          && $caller[3] eq "IkiWiki::cgi_editpage");
 587                 inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
 588                         if $run_by_editpage;
 589                 my $res = $origsubs{'urlto'}->($to,$from,$absolute);
 590                 inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath)
 591                         if $run_by_editpage;
 592                 return $res;
 593         }
 594         else {
 595                 return $origsubs{'urlto'}->($to,$from,$absolute)
 596         }
 597 }
 598
 599 sub mynicepagetitle ($;$) {
 600         my ($page, $unescaped) = (shift, shift);
 601
 602         my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
 603         return $res unless istranslation($page);
 604         return $res unless $config{po_translation_status_in_links};
 605         return $res.' ('.percenttranslated($page).'&nbsp;%)';
 606 }
 607
 608 # ,----
 609 # | Blackboxes for private data
 610 # `----
 611
 612 {
 613         my %filtered;
 614
 615         sub alreadyfiltered($$) {
 616                 my $page=shift;
 617                 my $destpage=shift;
 618
 619                 return ( exists $filtered{$page}{$destpage}
 620                          && $filtered{$page}{$destpage} eq 1 );
 621         }
 622
 623         sub setalreadyfiltered($$) {
 624                 my $page=shift;
 625                 my $destpage=shift;
 626
 627                 $filtered{$page}{$destpage}=1;
 628         }
 629
 630         sub unsetalreadyfiltered($$) {
 631                 my $page=shift;
 632                 my $destpage=shift;
 633
 634                 if (exists $filtered{$page}{$destpage}) {
 635                         delete $filtered{$page}{$destpage};
 636                 }
 637         }
 638
 639         sub resetalreadyfiltered() {
 640                 undef %filtered;
 641         }
 642 }
 643
 644 # ,----
 645 # | Helper functions
 646 # `----
 647
 648 sub maybe_add_leading_slash ($;$) {
 649         my $str=shift;
 650         my $add=shift;
 651         $add=1 unless defined $add;
 652         return '/' . $str if $add;
 653         return $str;
 654 }
 655
 656 sub istranslatablefile ($) {
 657         my $file=shift;
 658
 659         return 0 unless defined $file;
 660         return 0 if (defined pagetype($file) && pagetype($file) eq 'po');
 661         return 0 if $file =~ /\.pot$/;
 662         return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
 663         return;
 664 }
 665
 666 sub istranslatable ($) {
 667         my $page=shift;
 668
 669         $page=~s#^/##;
 670         return 1 if istranslatablefile($pagesources{$page});
 671         return;
 672 }
 673
 674 sub _istranslation ($) {
 675         my $page=shift;
 676
 677         my $hasleadingslash = ($page=~s#^/##);
 678         my $file=$pagesources{$page};
 679         return 0 unless (defined $file
 680                          && defined pagetype($file)
 681                          && pagetype($file) eq 'po');
 682         return 0 if $file =~ /\.pot$/;
 683
 684         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 685         return 0 unless (defined $masterpage && defined $lang
 686                          && length $masterpage && length $lang
 687                          && defined $pagesources{$masterpage}
 688                          && defined $config{po_slave_languages}{$lang});
 689
 690         return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
 691                 if istranslatable($masterpage);
 692 }
 693
 694 sub istranslation ($) {
 695         my $page=shift;
 696
 697         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
 698                 my $hasleadingslash = ($masterpage=~s#^/##);
 699                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
 700                 return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
 701         }
 702         return;
 703 }
 704
 705 sub masterpage ($) {
 706         my $page=shift;
 707
 708         if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
 709                 return $masterpage;
 710         }
 711         return $page;
 712 }
 713
 714 sub lang ($) {
 715         my $page=shift;
 716
 717         if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
 718                 return $lang;
 719         }
 720         return $config{po_master_language}{code};
 721 }
 722
 723 sub islanguagecode ($) {
 724         my $code=shift;
 725
 726         return ($code =~ /^[a-z]{2}$/);
 727 }
 728
 729 sub otherlanguage ($$) {
 730         my $page=shift;
 731         my $code=shift;
 732
 733         return masterpage($page) if $code eq $config{po_master_language}{code};
 734         return masterpage($page) . '.' . $code;
 735 }
 736
 737 sub otherlanguages ($) {
 738         my $page=shift;
 739
 740         my %ret;
 741         return \%ret unless (istranslation($page) || istranslatable($page));
 742         my $curlang=lang($page);
 743         foreach my $lang
 744                 ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
 745                 next if $lang eq $curlang;
 746                 $ret{$lang}=otherlanguage($page, $lang);
 747         }
 748         return \%ret;
 749 }
 750
 751 sub potfile ($) {
 752         my $masterfile=shift;
 753
 754         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 755         $dir='' if $dir eq './';
 756         return File::Spec->catpath('', $dir, $name . ".pot");
 757 }
 758
 759 sub pofile ($$) {
 760         my $masterfile=shift;
 761         my $lang=shift;
 762
 763         (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 764         $dir='' if $dir eq './';
 765         return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
 766 }
 767
 768 sub pofiles ($) {
 769         my $masterfile=shift;
 770
 771         return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
 772 }
 773
 774 sub refreshpot ($) {
 775         my $masterfile=shift;
 776
 777         my $potfile=potfile($masterfile);
 778         my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
 779         my $doc=Locale::Po4a::Chooser::new('text',%options);
 780         $doc->{TT}{utf_mode} = 1;
 781         $doc->{TT}{file_in_charset} = 'utf-8';
 782         $doc->{TT}{file_out_charset} = 'utf-8';
 783         $doc->read($masterfile);
 784         # let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
 785         # this is undocument use of internal Locale::Po4a::TransTractor's data,
 786         # compulsory since this module prevents us from using the porefs option.
 787         $doc->{TT}{po_out}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
 788         $doc->{TT}{po_out}->set_charset('utf-8');
 789         # do the actual work
 790         $doc->parse;
 791         IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
 792         $doc->writepo($potfile);
 793 }
 794
 795 sub refreshpofiles ($@) {
 796         my $masterfile=shift;
 797         my @pofiles=@_;
 798
 799         my $potfile=potfile($masterfile);
 800         (-e $potfile)
 801                 or error("po(refreshpofiles) ".sprintf(gettext("POT file (%s) does not exist"),
 802                                                        $potfile));
 803
 804         foreach my $pofile (@pofiles) {
 805                 IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
 806                 if (-e $pofile) {
 807                         system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
 808                                 or error("po(refreshpofiles) ".
 809                                          sprintf(gettext("failed to update %s"),
 810                                                  $pofile));
 811                 }
 812                 else {
 813                         File::Copy::syscopy($potfile,$pofile)
 814                                 or error("po(refreshpofiles) ".
 815                                          sprintf(gettext("failed to copy the POT file to %s"),
 816                                                  $pofile));
 817                 }
 818         }
 819 }
 820
 821 sub buildtranslationscache() {
 822         # use istranslation's side-effect
 823         map istranslation($_), (keys %pagesources);
 824 }
 825
 826 sub resettranslationscache() {
 827         undef %translations;
 828 }
 829
 830 sub flushmemoizecache() {
 831         Memoize::flush_cache("istranslatable");
 832         Memoize::flush_cache("_istranslation");
 833         Memoize::flush_cache("percenttranslated");
 834 }
 835
 836 sub urlto_with_orig_beautiful_urlpath($$) {
 837         my $to=shift;
 838         my $from=shift;
 839
 840         inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
 841         my $res=urlto($to, $from);
 842         inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
 843
 844         return $res;
 845 }
 846
 847 sub percenttranslated ($) {
 848         my $page=shift;
 849
 850         $page=~s/^\///;
 851         return gettext("N/A") unless istranslation($page);
 852         my $file=srcfile($pagesources{$page});
 853         my $masterfile = srcfile($pagesources{masterpage($page)});
 854         my %options = (
 855                 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
 856         );
 857         my $doc=Locale::Po4a::Chooser::new('text',%options);
 858         $doc->process(
 859                 'po_in_name'    => [ $file ],
 860                 'file_in_name'  => [ $masterfile ],
 861                 'file_in_charset'  => 'utf-8',
 862                 'file_out_charset' => 'utf-8',
 863         ) or error("po(percenttranslated) ".
 864                    sprintf(gettext("failed to translate %s"), $page));
 865         my ($percent,$hit,$queries) = $doc->stats();
 866         $percent =~ s/\.[0-9]+$//;
 867         return $percent;
 868 }
 869
 870 sub languagename ($) {
 871         my $code=shift;
 872
 873         return $config{po_master_language}{name}
 874                 if $code eq $config{po_master_language}{code};
 875         return $config{po_slave_languages}{$code}
 876                 if defined $config{po_slave_languages}{$code};
 877         return;
 878 }
 879
 880 sub otherlanguagesloop ($) {
 881         my $page=shift;
 882
 883         my @ret;
 884         my %otherpages=%{otherlanguages($page)};
 885         while (my ($lang, $otherpage) = each %otherpages) {
 886                 if (istranslation($page) && masterpage($page) eq $otherpage) {
 887                         push @ret, {
 888                                 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
 889                                 code => $lang,
 890                                 language => languagename($lang),
 891                                 master => 1,
 892                         };
 893                 }
 894                 else {
 895                         push @ret, {
 896                                 url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
 897                                 code => $lang,
 898                                 language => languagename($lang),
 899                                 percent => percenttranslated($otherpage),
 900                         }
 901                 }
 902         }
 903         return sort {
 904                         return -1 if $a->{code} eq $config{po_master_language}{code};
 905                         return 1 if $b->{code} eq $config{po_master_language}{code};
 906                         return $a->{language} cmp $b->{language};
 907                 } @ret;
 908 }
 909
 910 sub homepageurl (;$) {
 911         my $page=shift;
 912
 913         return urlto('', $page);
 914 }
 915
 916 sub deletetranslations ($) {
 917         my $deletedmasterfile=shift;
 918
 919         my $deletedmasterpage=pagename($deletedmasterfile);
 920         my @todelete;
 921         map {
 922                 my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
 923                 my $absfile = "$config{srcdir}/$file";
 924                 if (-e $absfile && ! -l $absfile && ! -d $absfile) {
 925                         push @todelete, $file;
 926                 }
 927         } keys %{$config{po_slave_languages}};
 928
 929         map {
 930                 if ($config{rcs}) {
 931                         IkiWiki::rcs_remove($_);
 932                 }
 933                 else {
 934                         IkiWiki::prune("$config{srcdir}/$_");
 935                 }
 936         } @todelete;
 937
 938         if (scalar @todelete) {
 939                 commit_and_refresh(
 940                         gettext("removed obsolete PO files"),
 941                         "IkiWiki::Plugin::po::deletetranslations");
 942         }
 943 }
 944
 945 sub commit_and_refresh ($$) {
 946         my ($msg, $author) = (shift, shift);
 947
 948         if ($config{rcs}) {
 949                 IkiWiki::disable_commit_hook();
 950                 IkiWiki::rcs_commit_staged($msg, $author, "127.0.0.1");
 951                 IkiWiki::enable_commit_hook();
 952                 IkiWiki::rcs_update();
 953         }
 954         # Reinitialize module's private variables.
 955         resetalreadyfiltered();
 956         resettranslationscache();
 957         flushmemoizecache();
 958         # Trigger a wiki refresh.
 959         require IkiWiki::Render;
 960         # without preliminary saveindex/loadindex, refresh()
 961         # complains about a lot of uninitialized variables
 962         IkiWiki::saveindex();
 963         IkiWiki::loadindex();
 964         IkiWiki::refresh();
 965         IkiWiki::saveindex();
 966 }
 967
 968 # on success, returns the filtered content.
 969 # on error, if $nonfatal, warn and return undef; else, error out.
 970 sub po_to_markup ($$;$) {
 971         my ($page, $content) = (shift, shift);
 972         my $nonfatal = shift;
 973
 974         $content = '' unless defined $content;
 975         $content = decode_utf8(encode_utf8($content));
 976         # CRLF line terminators make poor Locale::Po4a feel bad
 977         $content=~s/\r\n/\n/g;
 978
 979         # There are incompatibilities between some File::Temp versions
 980         # (including 0.18, bundled with Lenny's perl-modules package)
 981         # and others (e.g. 0.20, previously present in the archive as
 982         # a standalone package): under certain circumstances, some
 983         # return a relative filename, whereas others return an absolute one;
 984         # we here use this module in a way that is at least compatible
 985         # with 0.18 and 0.20. Beware, hit'n'run refactorers!
 986         my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
 987                                     DIR => File::Spec->tmpdir,
 988                                     UNLINK => 1)->filename;
 989         my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
 990                                      DIR => File::Spec->tmpdir,
 991                                      UNLINK => 1)->filename;
 992
 993         my $fail = sub ($) {
 994                 my $msg = "po(po_to_markup) - $page : " . shift;
 995                 if ($nonfatal) {
 996                         warn $msg;
 997                         return undef;
 998                 }
 999                 error($msg, sub { unlink $infile, $outfile});
1000         };
1001
1002         writefile(basename($infile), File::Spec->tmpdir, $content)
1003                 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1004
1005         my $masterfile = srcfile($pagesources{masterpage($page)});
1006         my %options = (
1007                 "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
1008         );
1009         my $doc=Locale::Po4a::Chooser::new('text',%options);
1010         $doc->process(
1011                 'po_in_name'    => [ $infile ],
1012                 'file_in_name'  => [ $masterfile ],
1013                 'file_in_charset'  => 'utf-8',
1014                 'file_out_charset' => 'utf-8',
1015         ) or return $fail->(gettext("failed to translate"));
1016         $doc->write($outfile)
1017                 or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
1018
1019         $content = readfile($outfile)
1020                 or return $fail->(sprintf(gettext("failed to read %s"), $outfile));
1021
1022         # Unlinking should happen automatically, thanks to File::Temp,
1023         # but it does not work here, probably because of the way writefile()
1024         # and Locale::Po4a::write() work.
1025         unlink $infile, $outfile;
1026
1027         return $content;
1028 }
1029
1030 # returns a SuccessReason or FailReason object
1031 sub isvalidpo ($) {
1032         my $content = shift;
1033
1034         # NB: we don't use po_to_markup here, since Po4a parser does
1035         # not mind invalid PO content
1036         $content = '' unless defined $content;
1037         $content = decode_utf8(encode_utf8($content));
1038
1039         # There are incompatibilities between some File::Temp versions
1040         # (including 0.18, bundled with Lenny's perl-modules package)
1041         # and others (e.g. 0.20, previously present in the archive as
1042         # a standalone package): under certain circumstances, some
1043         # return a relative filename, whereas others return an absolute one;
1044         # we here use this module in a way that is at least compatible
1045         # with 0.18 and 0.20. Beware, hit'n'run refactorers!
1046         my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-isvalidpo.XXXXXXXXXX",
1047                                     DIR => File::Spec->tmpdir,
1048                                     UNLINK => 1)->filename;
1049
1050         my $fail = sub ($) {
1051                 my $msg = '[po/isvalidpo] ' . shift;
1052                 unlink $infile;
1053                 return IkiWiki::FailReason->new("$msg");
1054         };
1055
1056         writefile(basename($infile), File::Spec->tmpdir, $content)
1057                 or return $fail->(sprintf(gettext("failed to write %s"), $infile));
1058
1059         my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
1060
1061         # Unlinking should happen automatically, thanks to File::Temp,
1062         # but it does not work here, probably because of the way writefile()
1063         # and Locale::Po4a::write() work.
1064         unlink $infile;
1065
1066         if ($res) {
1067             return IkiWiki::SuccessReason->new("valid gettext data");
1068         }
1069         return IkiWiki::FailReason->new("invalid gettext data");
1070 }
1071
1072 # ,----
1073 # | PageSpec's
1074 # `----
1075
1076 package IkiWiki::PageSpec;
1077 use warnings;
1078 use strict;
1079 use IkiWiki 2.00;
1080
1081 sub match_istranslation ($;@) {
1082         my $page=shift;
1083
1084         if (IkiWiki::Plugin::po::istranslation($page)) {
1085                 return IkiWiki::SuccessReason->new("is a translation page");
1086         }
1087         else {
1088                 return IkiWiki::FailReason->new("is not a translation page");
1089         }
1090 }
1091
1092 sub match_istranslatable ($;@) {
1093         my $page=shift;
1094
1095         if (IkiWiki::Plugin::po::istranslatable($page)) {
1096                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
1097         }
1098         else {
1099                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
1100         }
1101 }
1102
1103 sub match_lang ($$;@) {
1104         my $page=shift;
1105         my $wanted=shift;
1106
1107         my $regexp=IkiWiki::glob2re($wanted);
1108         my $lang=IkiWiki::Plugin::po::lang($page);
1109         if ($lang!~/^$regexp$/i) {
1110                 return IkiWiki::FailReason->new("file language is $lang, not $wanted");
1111         }
1112         else {
1113                 return IkiWiki::SuccessReason->new("file language is $wanted");
1114         }
1115 }
1116
1117 sub match_currentlang ($$;@) {
1118         my $page=shift;
1119         shift;
1120         my %params=@_;
1121
1122         return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
1123
1124         my $currentlang=IkiWiki::Plugin::po::lang($params{location});
1125         my $lang=IkiWiki::Plugin::po::lang($page);
1126
1127         if ($lang eq $currentlang) {
1128                 return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
1129         }
1130         else {
1131                 return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
1132         }
1133 }
1134
1135 1