X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/225e21f6c5da40f3beea27e084515daf83471d95..419de149a6b4c1cf598f33f0c96a2a21104528ec:/IkiWiki/Plugin/po.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 936fe3c49..3b92583a1 100644
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -1,5 +1,7 @@
 #!/usr/bin/perl
 # .po as a wiki page type
+# Licensed under GPL v2 or greater
+# Copyright (C) 2008 intrigeri <intrigeri@boum.org>
 # inspired by the GPL'd po4a-translate,
 # which is Copyright 2002, 2003, 2004 by Martin Quinson (mquinson#debian.org)
 package IkiWiki::Plugin::po;
@@ -28,11 +30,8 @@ memoize("percenttranslated");
 
 # backup references to subs that will be overriden
 my %origsubs;
-$origsubs{'bestlink'}=\&IkiWiki::bestlink;
-$origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
-$origsubs{'targetpage'}=\&IkiWiki::targetpage;
 
-sub import {
+sub import { #{{{
 	hook(type => "getsetup", id => "po", call => \&getsetup);
 	hook(type => "checkconfig", id => "po", call => \&checkconfig);
 	hook(type => "needsbuild", id => "po", call => \&needsbuild);
@@ -40,16 +39,20 @@ sub import {
 	hook(type => "htmlize", id => "po", call => \&htmlize);
 	hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
 	hook(type => "editcontent", id => "po", call => \&editcontent);
+
+	$origsubs{'bestlink'}=\&IkiWiki::bestlink;
 	inject(name => "IkiWiki::bestlink", call => \&mybestlink);
+	$origsubs{'beautify_urlpath'}=\&IkiWiki::beautify_urlpath;
 	inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+	$origsubs{'targetpage'}=\&IkiWiki::targetpage;
 	inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
-}
+} #}}}
 
 sub getsetup () { #{{{
 	return
 		plugin => {
 			safe => 0,
-			rebuild => 1, # format plugin
+			rebuild => 1, # format plugin & changes html filenames
 		},
 		po_master_language => {
 			type => "string",
@@ -58,7 +61,7 @@ sub getsetup () { #{{{
 				'name' => 'English'
 			},
 			description => "master language (non-PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_slave_languages => {
@@ -69,7 +72,7 @@ sub getsetup () { #{{{
 				'de' => 'Deutsch'
 			},
 			description => "slave languages (PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_translatable_pages => {
@@ -77,7 +80,7 @@ sub getsetup () { #{{{
 			example => "!*/Discussion",
 			description => "PageSpec controlling which pages are translatable",
 			link => "ikiwiki/PageSpec",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_link_to => {
@@ -89,19 +92,28 @@ sub getsetup () { #{{{
 		},
 } #}}}
 
+sub islanguagecode ($) { #{{{
+    my $code=shift;
+    return ($code =~ /^[a-z]{2}$/);
+} #}}}
+
 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));
 		}
 	}
+	map {
+		islanguagecode($_)
+		    or error(sprintf(gettext("%s is not a valid language code"), $_));
+	} ($config{po_master_language}{code}, keys %{$config{po_slave_languages}});
 	if (! exists $config{po_link_to} ||
 	    ! defined $config{po_link_to}) {
-	    $config{po_link_to}="default";
+		$config{po_link_to}="default";
 	}
 	if (! exists $config{po_translatable_pages} ||
 	    ! defined $config{po_translatable_pages}) {
-	    $config{po_translatable_pages}="";
+		$config{po_translatable_pages}="";
 	}
 	if ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
 		error(gettext("po_link_to=negotiated requires usedirs to be set"));
@@ -111,6 +123,7 @@ sub checkconfig () { #{{{
 
 sub potfile ($) { #{{{
 	my $masterfile=shift;
+
 	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 	$dir='' if $dir eq './';
 	return File::Spec->catpath('', $dir, $name . ".pot");
@@ -119,6 +132,7 @@ sub potfile ($) { #{{{
 sub pofile ($$) { #{{{
 	my $masterfile=shift;
 	my $lang=shift;
+
 	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 	$dir='' if $dir eq './';
 	return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
@@ -126,6 +140,7 @@ sub pofile ($$) { #{{{
 
 sub refreshpot ($) { #{{{
 	my $masterfile=shift;
+
 	my $potfile=potfile($masterfile);
 	my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
 	my $doc=Locale::Po4a::Chooser::new('text',%options);
@@ -153,8 +168,7 @@ sub refreshpofiles ($@) { #{{{
 
 	foreach my $pofile (@pofiles) {
 		if (-e $pofile) {
-			my $cmd = "msgmerge -U --backup=none $pofile $potfile";
-			system ($cmd) == 0
+			system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
 				or error("[po/refreshpofiles:$pofile] failed to update");
 		}
 		else {
@@ -252,9 +266,10 @@ sub mytargetpage ($$) { #{{{
 
 sub mybeautify_urlpath ($) { #{{{
 	my $url=shift;
+
 	my $res=$origsubs{'beautify_urlpath'}->($url);
 	if ($config{po_link_to} eq "negotiated") {
-		$res =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
+		$res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
 	}
 	return $res;
 } #}}}
@@ -273,6 +288,7 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
 sub mybestlink ($$) { #{{{
 	my $page=shift;
 	my $link=shift;
+
 	my $res=$origsubs{'bestlink'}->($page, $link);
 	if (length $res) {
 		if ($config{po_link_to} eq "current"
@@ -292,6 +308,7 @@ sub mybestlink ($$) { #{{{
 # since the rest of ikiwiki should not work on PO files.
 sub filter (@) { #{{{
 	my %params = @_;
+
 	my $page = $params{page};
 	my $destpage = $params{destpage};
 	my $content = decode_utf8(encode_utf8($params{content}));
@@ -303,10 +320,24 @@ sub filter (@) { #{{{
 	# CRLF line terminators make poor Locale::Po4a feel bad
 	$content=~s/\r\n/\n/g;
 
-	# Locale::Po4a needs an input file, and I'm too lazy to learn
-	# how to disguise a variable as a file
-	my $infile = File::Temp->new(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
-				     TMPDIR => 1)->filename;
+	# Implementation notes
+	#
+	# 1. Locale::Po4a reads/writes from/to files, and I'm too lazy
+	#    to learn how to disguise a variable as a file.
+	# 2. There are incompatibilities between some File::Temp versions
+	#    (including 0.18, bundled with Lenny's perl-modules package)
+	#    and others (e.g. 0.20, previously present in the archive as
+	#    a standalone package): under certain circumstances, some
+	#    return a relative filename, whereas others return an absolute one;
+	#    we here use this module in a way that is at least compatible
+	#    with 0.18 and 0.20. Beware, hit'n'run refactorers!
+	my $infile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
+				    DIR => File::Spec->tmpdir,
+				    UNLINK => 1)->filename;
+	my $outfile = new File::Temp(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
+				     DIR => File::Spec->tmpdir,
+				     UNLINK => 1)->filename;
+
 	writefile(basename($infile), File::Spec->tmpdir, $content);
 
 	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
@@ -315,8 +346,8 @@ sub filter (@) { #{{{
 	push @pos,$infile;
 	push @masters,$masterfile;
 	my %options = (
-			"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
-			);
+		"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
+	);
 	my $doc=Locale::Po4a::Chooser::new('text',%options);
 	$doc->process(
 		'po_in_name'	=> \@pos,
@@ -324,16 +355,21 @@ sub filter (@) { #{{{
 		'file_in_charset'  => 'utf-8',
 		'file_out_charset' => 'utf-8',
 	) or error("[po/filter:$infile]: failed to translate");
-	my $tmpout = File::Temp->new(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
-				     TMPDIR => 1)->filename;
-	$doc->write($tmpout) or error("[po/filter:$infile] could not write $tmpout");
-	$content = readfile($tmpout) or error("[po/filter:$infile] could not read $tmpout");
+	$doc->write($outfile) or error("[po/filter:$infile] could not write $outfile");
+	$content = readfile($outfile) or error("[po/filter:$infile] could not read $outfile");
+
+	# Unlinking should happen automatically, thanks to File::Temp,
+	# but it does not work here, probably because of the way writefile()
+	# and Locale::Po4a::write() work.
+	unlink $infile, $outfile;
+
 	$filtered{$page}{$destpage}=1;
 	return $content;
 } #}}}
 
 sub htmlize (@) { #{{{
 	my %params=@_;
+
 	my $page = $params{page};
 	my $content = $params{content};
 	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
@@ -345,7 +381,8 @@ sub htmlize (@) { #{{{
 
 sub percenttranslated ($) { #{{{
 	my $page=shift;
-	return "N/A" unless (istranslation($page));
+
+	return gettext("N/A") unless (istranslation($page));
 	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 	my $file=srcfile($pagesources{$page});
 	my $masterfile = srcfile($pagesources{$masterpage});
@@ -353,8 +390,8 @@ sub percenttranslated ($) { #{{{
 	push @pos,$file;
 	push @masters,$masterfile;
 	my %options = (
-			"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
-			);
+		"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
+	);
 	my $doc=Locale::Po4a::Chooser::new('text',%options);
 	$doc->process(
 		'po_in_name'	=> \@pos,
@@ -368,6 +405,7 @@ sub percenttranslated ($) { #{{{
 
 sub otherlanguages ($) { #{{{
 	my $page=shift;
+
 	my @ret;
 	if (istranslatable($page)) {
 		foreach my $lang (sort keys %{$translations{$page}}) {
@@ -405,6 +443,7 @@ sub pagetemplate (@) { #{{{
 	my $page=$params{page};
 	my $destpage=$params{destpage};
 	my $template=$params{template};
+
 	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/) if istranslation($page);
 
 	if (istranslation($page) && $template->query(name => "percenttranslated")) {
@@ -467,6 +506,7 @@ sub editcontent () { #{{{
 
 sub istranslatable ($) { #{{{
 	my $page=shift;
+
 	my $file=$pagesources{$page};
 
 	if (! defined $file
@@ -479,6 +519,7 @@ sub istranslatable ($) { #{{{
 
 sub _istranslation ($) { #{{{
 	my $page=shift;
+
 	my $file=$pagesources{$page};
 	if (! defined $file) {
 		return IkiWiki::FailReason->new("no file specified");
@@ -504,6 +545,7 @@ sub _istranslation ($) { #{{{
 
 sub istranslation ($) { #{{{
 	my $page=shift;
+
 	if (_istranslation($page)) {
 		my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 		$translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
@@ -519,6 +561,7 @@ use IkiWiki 2.00;
 
 sub match_istranslation ($;@) { #{{{
 	my $page=shift;
+
 	if (IkiWiki::Plugin::po::istranslation($page)) {
 		return IkiWiki::SuccessReason->new("is a translation page");
 	}
@@ -529,6 +572,7 @@ sub match_istranslation ($;@) { #{{{
 
 sub match_istranslatable ($;@) { #{{{
 	my $page=shift;
+
 	if (IkiWiki::Plugin::po::istranslatable($page)) {
 		return IkiWiki::SuccessReason->new("is set as translatable in po_translatable_pages");
 	}
@@ -540,6 +584,7 @@ sub match_istranslatable ($;@) { #{{{
 sub match_lang ($$;@) { #{{{
 	my $page=shift;
 	my $wanted=shift;
+
 	my $regexp=IkiWiki::glob2re($wanted);
 	my $lang;
 	my $masterpage;
@@ -561,6 +606,7 @@ sub match_lang ($$;@) { #{{{
 
 sub match_currentlang ($$;@) { #{{{
 	my $page=shift;
+
 	shift;
 	my %params=@_;
 	my ($currentmasterpage, $currentlang, $masterpage, $lang);