IkiWiki/Plugin/po.pm

   1 #!/usr/bin/perl
   2 # .po as a wiki page type
   3 # inspired by the GPL'd po4a-translate,
   4 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
   5 package IkiWiki::Plugin::po;
   6
   7 use warnings;
   8 use strict;
   9 use IkiWiki 2.00;
  10 use Encode;
  11 use Locale::Po4a::Chooser;
  12 use File::Temp;
  13 use Memoize;
  14
  15 my %translations;
  16 memoize("istranslatable");
  17 memoize("_istranslation");
  18
  19 sub import {
  20         hook(type => "getsetup", id => "po", call => \&getsetup);
  21         hook(type => "checkconfig", id => "po", call => \&checkconfig);
  22         hook(type => "targetpage", id => "po", call => \&targetpage);
  23         hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
  24         hook(type => "tweakbestlink", id => "po", call => \&tweakbestlink);
  25         hook(type => "filter", id => "po", call => \&filter);
  26         hook(type => "htmlize", id => "po", call => \&htmlize);
  27 }
  28
  29 sub getsetup () { #{{{
  30         return
  31                 plugin => {
  32                         safe => 0,
  33                         rebuild => 1, # format plugin
  34                 },
  35                 po_master_language => {
  36                         type => "string",
  37                         example => {
  38                                 'code' => 'en',
  39                                 'name' => 'English'
  40                         },
  41                         description => "master language (non-PO files)",
  42                         safe => 1,
  43                         rebuild => 1,
  44                 },
  45                 po_slave_languages => {
  46                         type => "string",
  47                         example => {'fr' => { 'name' => 'Français' },
  48                                     'es' => { 'name' => 'Castellano' },
  49                                     'de' => { 'name' => 'Deutsch' },
  50                         },
  51                         description => "slave languages (PO files)",
  52                         safe => 1,
  53                         rebuild => 1,
  54                 },
  55                 po_translatable_pages => {
  56                         type => "pagespec",
  57                         example => "!*/Discussion",
  58                         description => "PageSpec controlling which pages are translatable",
  59                         link => "ikiwiki/PageSpec",
  60                         safe => 1,
  61                         rebuild => 1,
  62                 },
  63                 po_link_to => {
  64                         type => "string",
  65                         example => "current",
  66                         description => "internal linking behavior (default/current/negotiated)",
  67                         safe => 1,
  68                         rebuild => 1,
  69                 },
  70 } #}}}
  71
  72 sub checkconfig () { #{{{
  73         foreach my $field (qw{po_master_language po_slave_languages}) {
  74                 if (! exists $config{$field} || ! defined $config{$field}) {
  75                         error(sprintf(gettext("Must specify %s"), $field));
  76                 }
  77         }
  78         if (! exists $config{po_link_to} ||
  79             ! defined $config{po_link_to}) {
  80             $config{po_link_to}="default";
  81         }
  82         if (! exists $config{po_translatable_pages} ||
  83             ! defined $config{po_translatable_pages}) {
  84             $config{po_translatable_pages}="";
  85         }
  86         if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
  87                 error(gettext("po_link_to=negotiated requires usedirs to be set"));
  88         }
  89         push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
  90 } #}}}
  91
  92 sub targetpage (@) { #{{{
  93         my %params = @_;
  94         my $page=$params{page};
  95         my $ext=$params{ext};
  96
  97         if (istranslation($page)) {
  98                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
  99                 if (! $config{usedirs} || $page eq 'index') {
 100                         return $masterpage . "." . $lang . "." . $ext;
 101                 }
 102                 else {
 103                         return $masterpage . "/index." . $lang . "." . $ext;
 104                 }
 105         }
 106         elsif (istranslatable($page)) {
 107                 if (! $config{usedirs} || $page eq 'index') {
 108                         return $page . "." . $config{po_master_language}{code} . "." . $ext;
 109                 }
 110                 else {
 111                         return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
 112                 }
 113         }
 114         return;
 115 } #}}}
 116
 117 sub tweakurlpath ($) { #{{{
 118         my %params = @_;
 119         my $url=$params{url};
 120         if ($config{po_link_to} eq "negotiated") {
 121                 $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
 122         }
 123         return $url;
 124 } #}}}
 125
 126 sub tweakbestlink ($$) { #{{{
 127         my %params = @_;
 128         my $page=$params{page};
 129         my $link=$params{link};
 130         if ($config{po_link_to} eq "current"
 131             && istranslatable($link)
 132             && istranslation($page)) {
 133                 my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 134                 return $link . "." . $curlang;
 135         }
 136         return $link;
 137 } #}}}
 138
 139 our %filtered;
 140 # We use filter to convert PO to the master page's type,
 141 # since other plugins should not work on PO files
 142 sub filter (@) { #{{{
 143         my %params = @_;
 144         my $page = $params{page};
 145         my $destpage = $params{destpage};
 146         my $content = decode_utf8(encode_utf8($params{content}));
 147
 148         # decide if this is a PO file that should be converted into a translated document,
 149         # and perform various sanity checks
 150         if (! istranslation($page) || $filtered{$page}{$destpage}) {
 151                 return $content;
 152         }
 153
 154         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 155         my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page});
 156         my $masterfile = srcfile($pagesources{$masterpage});
 157         my (@pos,@masters);
 158         push @pos,$file;
 159         push @masters,$masterfile;
 160         my %options = (
 161                         "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
 162                         );
 163         my $doc=Locale::Po4a::Chooser::new('text',%options);
 164         $doc->process(
 165                 'po_in_name'    => \@pos,
 166                 'file_in_name'  => \@masters,
 167                 'file_in_charset'  => 'utf-8',
 168                 'file_out_charset' => 'utf-8',
 169         ) or error("[po/filter:$file]: failed to translate");
 170         my ($percent,$hit,$queries) = $doc->stats();
 171         my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
 172         my $tmpout = $tmpfh->filename;
 173         $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
 174         $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
 175         $filtered{$page}{$destpage}=1;
 176         return $content;
 177 } #}}}
 178
 179 sub htmlize (@) { #{{{
 180         my %params=@_;
 181         my $page = $params{page};
 182         my $content = $params{content};
 183         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 184         my $masterfile = srcfile($pagesources{$masterpage});
 185
 186         # force content to be htmlize'd as if it was the same type as the master page
 187         return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 188 } #}}}
 189
 190 sub istranslatable ($) { #{{{
 191         my $page=shift;
 192         my $file=$pagesources{$page};
 193
 194         if (! defined $file
 195             || (defined pagetype($file) && pagetype($file) eq 'po')
 196             || $file =~ /\.pot$/) {
 197                 return 0;
 198         }
 199         return pagespec_match($page, $config{po_translatable_pages});
 200 } #}}}
 201
 202 sub _istranslation ($) { #{{{
 203         my $page=shift;
 204         my $file=$pagesources{$page};
 205         if (! defined $file) {
 206                 return IkiWiki::FailReason->new("no file specified");
 207         }
 208
 209         if (! defined $file
 210             || ! defined pagetype($file)
 211             || ! pagetype($file) eq 'po'
 212             || $file =~ /\.pot$/) {
 213                 return 0;
 214         }
 215
 216         my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 217         if (! defined $masterpage || ! defined $lang
 218             || ! (length($masterpage) > 0) || ! (length($lang) > 0)
 219             || ! defined $pagesources{$masterpage}
 220             || ! defined $config{po_slave_languages}{$lang}) {
 221                 return 0;
 222         }
 223
 224         return istranslatable($masterpage);
 225 } #}}}
 226
 227 sub istranslation ($) { #{{{
 228         my $page=shift;
 229         if (_istranslation($page)) {
 230                 my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 231                 $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
 232                 return 1;
 233         }
 234         return 0;
 235 } #}}}
 236
 237
 238 package IkiWiki::PageSpec;
 239 use warnings;
 240 use strict;
 241 use IkiWiki 2.00;
 242
 243 sub match_istranslation ($;@) { #{{{
 244         my $page=shift;
 245         if (IkiWiki::Plugin::po::istranslation($page)) {
 246                 return IkiWiki::SuccessReason->new("is a translation page");
 247         }
 248         else {
 249                 return IkiWiki::FailReason->new("is not a translation page");
 250         }
 251 } #}}}
 252
 253 sub match_istranslatable ($;@) { #{{{
 254         my $page=shift;
 255         if (IkiWiki::Plugin::po::istranslatable($page)) {
 256                 return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
 257         }
 258         else {
 259                 return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
 260         }
 261 } #}}}
 262
 263 1