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