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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index ac56041cf..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;
@@ -19,11 +21,12 @@ use Memoize;
 my %translations;
 our %filtered;
 
-## FIXME: makes some test cases cry once every two tries; this may be
-## related to the artificial way the testsuite is run, or not.
-# memoize("istranslatable");
 memoize("_istranslation");
 memoize("percenttranslated");
+# FIXME: memoizing istranslatable() makes some test cases fail once every
+# two tries; this may be related to the artificial way the testsuite is
+# run, or not.
+# memoize("istranslatable");
 
 # backup references to subs that will be overriden
 my %origsubs;
@@ -34,7 +37,8 @@ sub import { #{{{
 	hook(type => "needsbuild", id => "po", call => \&needsbuild);
 	hook(type => "filter", id => "po", call => \&filter);
 	hook(type => "htmlize", id => "po", call => \&htmlize);
-	hook(type => "pagetemplate", id => "po", call => \&pagetemplate);
+	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);
@@ -57,7 +61,7 @@ sub getsetup () { #{{{
 				'name' => 'English'
 			},
 			description => "master language (non-PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_slave_languages => {
@@ -68,7 +72,7 @@ sub getsetup () { #{{{
 				'de' => 'Deutsch'
 			},
 			description => "slave languages (PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_translatable_pages => {
@@ -76,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 => {
@@ -88,12 +92,21 @@ 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";
@@ -112,7 +125,8 @@ sub potfile ($) { #{{{
 	my $masterfile=shift;
 
 	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
-	return File::Spec->catfile($dir, $name . ".pot");
+	$dir='' if $dir eq './';
+	return File::Spec->catpath('', $dir, $name . ".pot");
 } #}}}
 
 sub pofile ($$) { #{{{
@@ -120,7 +134,8 @@ sub pofile ($$) { #{{{
 	my $lang=shift;
 
 	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
-	return File::Spec->catfile($dir, $name . "." . $lang . ".po");
+	$dir='' if $dir eq './';
+	return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
 } #}}}
 
 sub refreshpot ($) { #{{{
@@ -174,17 +189,22 @@ sub needsbuild () { #{{{
 	# refresh/create POT and PO files as needed
 	my $updated_po_files=0;
 	foreach my $page (keys %pagesources) {
-		my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;
 		if (istranslatable($page)) {
+			my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;
+			my $updated_pot_file=0;
 			my $file=srcfile($pagesources{$page});
 			if ($pageneedsbuild || ! -e potfile($file)) {
 				refreshpot($file);
+				$updated_pot_file=1;
 			}
 			my @pofiles;
 			foreach my $lang (keys %{$config{po_slave_languages}}) {
 				my $pofile=pofile($file, $lang);
-				if ($pageneedsbuild || ! -e $pofile) {
+				my $pofile_rel=pofile($pagesources{$page}, $lang);
+				if ($pageneedsbuild || $updated_pot_file || ! -e $pofile) {
 					push @pofiles, $pofile;
+					push @$needsbuild, $pofile_rel
+					  unless grep { $_ eq $pofile_rel } @$needsbuild;
 				}
 			}
 			if (@pofiles) {
@@ -195,7 +215,7 @@ sub needsbuild () { #{{{
 		}
 	}
 
-	# check staged changes in and trigger a wiki refresh.
+	# check staged changes in
 	if ($updated_po_files) {
 		if ($config{rcs}) {
 			IkiWiki::disable_commit_hook();
@@ -204,8 +224,6 @@ sub needsbuild () { #{{{
 			IkiWiki::enable_commit_hook();
 			IkiWiki::rcs_update();
 		}
-		IkiWiki::refresh();
-		IkiWiki::saveindex();
 		# refresh module's private variables
 		undef %filtered;
 		undef %translations;
@@ -286,8 +304,8 @@ sub mybestlink ($$) { #{{{
 	return "";
 } #}}}
 
-# We use filter to convert PO to the master page's type,
-# since other plugins should not work on PO files
+# We use filter to convert PO to the master page's format,
+# since the rest of ikiwiki should not work on PO files.
 sub filter (@) { #{{{
 	my %params = @_;
 
@@ -295,17 +313,37 @@ sub filter (@) { #{{{
 	my $destpage = $params{destpage};
 	my $content = decode_utf8(encode_utf8($params{content}));
 
-	# decide if this is a PO file that should be converted into a
-	# translated document, and perform various sanity checks
-	if (! istranslation($page) || $filtered{$page}{$destpage}) {
-		return $content;
-	}
+	return $content if ( ! istranslation($page)
+			     || ( exists $filtered{$page}{$destpage}
+				  && $filtered{$page}{$destpage} eq 1 ));
+
+	# CRLF line terminators make poor Locale::Po4a feel bad
+	$content=~s/\r\n/\n/g;
+
+	# 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})$/);
-	my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page});
 	my $masterfile = srcfile($pagesources{$masterpage});
 	my (@pos,@masters);
-	push @pos,$file;
+	push @pos,$infile;
 	push @masters,$masterfile;
 	my %options = (
 		"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
@@ -316,12 +354,15 @@ sub filter (@) { #{{{
 		'file_in_name'	=> \@masters,
 		'file_in_charset'  => 'utf-8',
 		'file_out_charset' => 'utf-8',
-	) or error("[po/filter:$file]: failed to translate");
-	my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
-	my $tmpout = $tmpfh->filename;
-	# XXX is there any way to avoid the useless write to a temp file? --Joey
-	$doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
-	$content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
+	) or error("[po/filter:$infile]: failed to translate");
+	$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;
 } #}}}
@@ -399,10 +440,11 @@ sub otherlanguages ($) { #{{{
 
 sub pagetemplate (@) { #{{{
 	my %params=@_;
-        my $page=$params{page};
+	my $page=$params{page};
+	my $destpage=$params{destpage};
+	my $template=$params{template};
 
-        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")) {
 		$template->param(percenttranslated => percenttranslated($page));
@@ -421,7 +463,6 @@ sub pagetemplate (@) { #{{{
 			}
 		}
 		elsif (istranslation($page)) {
-			my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 			add_depends($page, $masterpage);
 			foreach my $translation (values %{$translations{$masterpage}}) {
 				add_depends($page, $translation);
@@ -436,7 +477,6 @@ sub pagetemplate (@) { #{{{
 	# prevent future breakage when ikiwiki internals change.
 	# Known limitations are preferred to future random bugs.
 	if ($template->param('discussionlink') && istranslation($page)) {
-		my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 		$template->param('discussionlink' => htmllink(
 							$page,
 							$destpage,
@@ -446,8 +486,24 @@ sub pagetemplate (@) { #{{{
 							linktext => gettext("Discussion"),
 							));
 	}
+	# remove broken parentlink to ./index.html on home page's translations
+	if ($template->param('parentlinks')
+	    && istranslation($page)
+	    && $masterpage eq "index") {
+		$template->param('parentlinks' => []);
+	}
 } # }}}
 
+sub editcontent () { #{{{
+	my %params=@_;
+	# as we're previewing or saving a page, the content may have
+	# changed, so tell the next filter() invocation it must not be lazy
+	if (exists $filtered{$params{page}}{$params{page}}) {
+		delete $filtered{$params{page}}{$params{page}};
+	}
+	return $params{content};
+} #}}}
+
 sub istranslatable ($) { #{{{
 	my $page=shift;