X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/50f1fd43daf98cbd296dbb51bd6519ab7e97ee9a..e82c6b1908b21b5e4246767d6a87fe46245e5e29:/IkiWiki/Plugin/po.pm diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm index 58e184b9b..63be0e389 100644 --- a/IkiWiki/Plugin/po.pm +++ b/IkiWiki/Plugin/po.pm @@ -1,16 +1,23 @@ #!/usr/bin/perl # .po as a wiki page type +# inspired by the GPL'd po4a-translate, +# which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org) package IkiWiki::Plugin::po; use warnings; use strict; use IkiWiki 2.00; use Encode; +use Locale::Po4a::Chooser; +use File::Temp; sub import { hook(type => "getsetup", id => "po", call => \&getsetup); + hook(type => "checkconfig", id => "po", call => \&checkconfig); hook(type => "targetpage", id => "po", call => \&targetpage); + hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath); hook(type => "filter", id => "po", call => \&filter); + hook(type => "preprocess", id => "translatable", call => \&preprocess_translatable); hook(type => "htmlize", id => "po", call => \&htmlize); } @@ -20,52 +27,171 @@ sub getsetup () { #{{{ safe => 0, rebuild => 1, # format plugin }, - po_supported_languages => { + po_master_language => { type => "string", - example => { 'fr' => { 'name' => 'Français' }, + example => { + 'code' => 'en', + 'name' => 'English' + }, + description => "master language (non-PO files)", + safe => 1, + rebuild => 1, + }, + po_slave_languages => { + type => "string", + example => {'fr' => { 'name' => 'Français' }, 'es' => { 'name' => 'Castellano' }, 'de' => { 'name' => 'Deutsch' }, }, + description => "slave languages (PO files)", + safe => 1, + rebuild => 1, + }, + po_link_to_current_language => { + type => "boolean", + example => 1, + description => "internal links point to pages in the current language (useful if Content Negotiation is not supported)", safe => 1, rebuild => 1, }, } #}}} +sub checkconfig () { #{{{ + foreach my $field (qw{po_master_language po_slave_languages}) { + if (! exists $config{$field} || ! defined $config{$field}) { + error(sprintf(gettext("Must specify %s"), $field)); + } + } + if (! exists $config{po_link_to_current_language} || + ! defined $config{po_link_to_current_language}) { + $config{po_link_to_current_language}=0; + } +} #}}} + sub targetpage (@) { #{{{ my %params = @_; my $page=$params{page}; my $ext=$params{ext}; - my ($origpage, $lang) = ($page =~ /(.*)[.]([a-z]{2}$)/); - - if (defined $origpage && defined $lang - && (length($origpage) > 0) && (length($lang) > 0) - && defined $config{po_supported_languages}{$lang}) { + if (pagespec_match($page,"istranslation()")) { + my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); if (! $config{usedirs} || $page eq 'index') { - return $origpage.".".$ext.".".$lang; + return $masterpage . "." . $lang . "." . $ext; } else { - return $origpage."/index.".$ext.".".$lang; + return $masterpage . "/index." . $lang . "." . $ext; + } + } + else { + if (! $config{usedirs} || $page eq 'index') { + return $page . "." . $config{po_master_language}{code} . "." . $ext; } + else { + return $page . "/index." . $config{po_master_language}{code} . "." . $ext; + } + } +} #}}} + +sub tweakurlpath ($) { #{{{ + my %params = @_; + my $url=$params{url}; + if (! $config{po_link_to_current_language} && $config{usedirs}) { + $url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!; } + return $url; } #}}} -# We use filter to convert PO to HTML, since the other plugins might do harm to it. +# We use filter to convert PO to the master page's type, +# since other plugins should not work on PO files sub filter (@) { #{{{ my %params = @_; + my $page = $params{page}; my $content = decode_utf8(encode_utf8($params{content})); - if (defined $pagesources{$params{page}} && $pagesources{$params{page}} =~ /\.po$/) { - $content = "
" . $content . "
"; + # decide if this is a PO file that should be converted into a translated document, + # and perform various sanity checks + if (! pagespec_match($page, "istranslation()")) { + return $content; } + my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); + my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page}); + my $masterfile = srcfile($pagesources{$masterpage}); + my (@pos,@masters); + push @pos,$file; + push @masters,$masterfile; + my %options = ( + "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0, + ); + my $doc=Locale::Po4a::Chooser::new('text',%options); + $doc->process( + 'po_in_name' => \@pos, + 'file_in_name' => \@masters, + 'file_in_charset' => 'utf-8', + 'file_out_charset' => 'utf-8', + ) or error("[po/filter:$file]: failed to translate"); + my ($percent,$hit,$queries) = $doc->stats(); + my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX"); + my $tmpout = $tmpfh->filename; + $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout"); + $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout"); return $content; } #}}} -# We need this to register the .po file extension +sub preprocess_translatable (@) { #{{{ + my %params = @_; + my $match = exists $params{match} ? $params{match} : $params{page}; + + $pagestate{$params{page}}{po_translatable}{$match}=1; + + return "" if ($params{silent} && IkiWiki::yesno($params{silent})); + return sprintf(gettext("pages %s set as translatable"), $params{match}); + +} #}}} + sub htmlize (@) { #{{{ my %params=@_; - return $params{content}; + my $page = $params{page}; + my $content = $params{content}; + my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); + my $masterfile = srcfile($pagesources{$masterpage}); + + # force content to be htmlize'd as if it was the same type as the master page + return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content); +} #}}} + +package IkiWiki::PageSpec; + +sub match_istranslation ($;@) { #{{{ + my $page=shift; + my $wanted=shift; + + my %params=@_; + my $file=exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page}; + if (! defined $file) { + return IkiWiki::FailReason->new("no file specified"); + } + + if (! IkiWiki::pagetype($page) eq 'po') { + return IkiWiki::FailReason->new("is not a PO file"); + } + + my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/); + if (! defined $masterpage || ! defined $lang + || ! (length($masterpage) > 0) || ! (length($lang) > 0)) { + return IkiWiki::FailReason->new("is not named like a translation file"); + } + + if (! defined $IkiWiki::pagesources{$masterpage}) { + return IkiWiki::FailReason->new("the master page does not exist"); + } + + if (! defined $IkiWiki::config{po_slave_languages}{$lang}) { + return IkiWiki::FailReason->new("language $lang is not supported"); + } + + return IkiWiki::SuccessReason->new("page $page is a translation"); + } #}}} 1