X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b0f5f37317242721765d463ad7785b995caee490..f38a64a9a7965f06b204d50e739db5b5a5cfe306:/IkiWiki/Plugin/po.pm

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 9dda8c0db..c8ec37c22 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;
@@ -17,37 +19,42 @@ use File::Temp;
 use Memoize;
 
 my %translations;
+my @origneedsbuild;
 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;
-$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);
 	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 => "change", id => "po", call => \&change);
+	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",
@@ -56,7 +63,7 @@ sub getsetup () { #{{{
 				'name' => 'English'
 			},
 			description => "master language (non-PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_slave_languages => {
@@ -67,7 +74,7 @@ sub getsetup () { #{{{
 				'de' => 'Deutsch'
 			},
 			description => "slave languages (PO files)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_translatable_pages => {
@@ -75,53 +82,78 @@ sub getsetup () { #{{{
 			example => "!*/Discussion",
 			description => "PageSpec controlling which pages are translatable",
 			link => "ikiwiki/PageSpec",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 		po_link_to => {
 			type => "string",
 			example => "current",
 			description => "internal linking behavior (default/current/negotiated)",
-			safe => 0,
+			safe => 1,
 			rebuild => 1,
 		},
 } #}}}
 
+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));
 		}
 	}
-	if (! exists $config{po_link_to} ||
-	    ! defined $config{po_link_to}) {
-	    $config{po_link_to}="default";
+	if (! (keys %{$config{po_slave_languages}})) {
+		error(gettext("At least one slave language must be defined in po_slave_languages"));
 	}
+	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_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"));
+	if (! exists $config{po_link_to} ||
+	    ! defined $config{po_link_to}) {
+		$config{po_link_to}='default';
+	}
+	elsif (! grep {
+			$config{po_link_to} eq $_
+		} ('default', 'current', 'negotiated')) {
+		warn(sprintf(gettext('po_link_to=%s is not a valid setting, falling back to po_link_to=default'),
+				$config{po_link_to}));
+		$config{po_link_to}='default';
+	}
+	elsif ($config{po_link_to} eq "negotiated" && ! $config{usedirs}) {
+		warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
+		$config{po_link_to}='default';
 	}
 	push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
 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 ($$) { #{{{
 	my $masterfile=shift;
 	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 ($) { #{{{
 	my $masterfile=shift;
+
 	my $potfile=potfile($masterfile);
 	my %options = ("markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0);
 	my $doc=Locale::Po4a::Chooser::new('text',%options);
@@ -137,6 +169,7 @@ sub refreshpot ($) { #{{{
 	$doc->{TT}{po_out}->set_charset('utf-8');
 	# do the actual work
 	$doc->parse;
+	IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
 	$doc->writepo($potfile);
 } #}}}
 
@@ -148,9 +181,9 @@ sub refreshpofiles ($@) { #{{{
 	error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
 	foreach my $pofile (@pofiles) {
+		IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
 		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 {
@@ -163,54 +196,12 @@ sub refreshpofiles ($@) { #{{{
 sub needsbuild () { #{{{
 	my $needsbuild=shift;
 
-	# build %translations, using istranslation's side-effect
-	foreach my $page (keys %pagesources) {
-		istranslation($page);
-	}
-
-	# 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 $file=srcfile($pagesources{$page});
-			if ($pageneedsbuild || ! -e potfile($file)) {
-				refreshpot($file);
-			}
-			my @pofiles;
-			foreach my $lang (keys %{$config{po_slave_languages}}) {
-				my $pofile=pofile($file, $lang);
-				if ($pageneedsbuild || ! -e $pofile) {
-					push @pofiles, $pofile;
-				}
-			}
-			if (@pofiles) {
-				refreshpofiles($file, @pofiles) ;
-				map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
-				$updated_po_files = 1;
-			}
-		}
-	}
-
-	# check staged changes in and trigger a wiki refresh.
-	if ($updated_po_files) {
-		if ($config{rcs}) {
-			IkiWiki::disable_commit_hook();
-			IkiWiki::rcs_commit_staged(gettext("updated PO files"),
-				"refreshpofiles", "127.0.0.1");
-			IkiWiki::enable_commit_hook();
-			IkiWiki::rcs_update();
-		}
-		IkiWiki::refresh();
-		IkiWiki::saveindex();
-		# refresh module's private variables
-		undef %filtered;
-		undef %translations;
-		foreach my $page (keys %pagesources) {
-			istranslation($page);
-		}
-	}
+	# backup @needsbuild content so that change() can know whether
+	# a given master page was rendered because its source file was changed
+	@origneedsbuild=(@$needsbuild);
 
+	# build %translations, using istranslation's side-effect
+	map istranslation($_), (keys %pagesources);
 
 	# make existing translations depend on the corresponding master page
 	foreach my $master (keys %translations) {
@@ -246,9 +237,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;
 } #}}}
@@ -267,6 +259,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"
@@ -282,46 +275,72 @@ 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 = @_;
+
 	my $page = $params{page};
 	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,
-			);
+		"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 $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");
+	) 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;
 } #}}}
 
 sub htmlize (@) { #{{{
 	my %params=@_;
+
 	my $page = $params{page};
 	my $content = $params{content};
 	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
@@ -333,7 +352,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});
@@ -341,8 +361,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,
@@ -356,6 +376,7 @@ sub percenttranslated ($) { #{{{
 
 sub otherlanguages ($) { #{{{
 	my $page=shift;
+
 	my @ret;
 	if (istranslatable($page)) {
 		foreach my $lang (sort keys %{$translations{$page}}) {
@@ -390,9 +411,11 @@ sub otherlanguages ($) { #{{{
 
 sub pagetemplate (@) { #{{{
 	my %params=@_;
-        my $page=$params{page};
-        my $destpage=$params{destpage};
-        my $template=$params{template};
+	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")) {
 		$template->param(percenttranslated => percenttranslated($page));
@@ -411,7 +434,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);
@@ -426,7 +448,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,
@@ -436,10 +457,75 @@ 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 change(@) { #{{{
+	my @rendered=@_;
+
+	my $updated_po_files=0;
+
+	# Refresh/create POT and PO files as needed.
+	foreach my $page (map pagename($_), @rendered) {
+		next unless istranslatable($page);
+		my $file=srcfile($pagesources{$page});
+		my $updated_pot_file=0;
+		if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
+		    || ! -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 ($updated_pot_file || ! -e $pofile) {
+				push @pofiles, $pofile;
+			}
+		}
+		if (@pofiles) {
+			refreshpofiles($file, @pofiles);
+			map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+			$updated_po_files=1;
+		}
+	}
+
+	if ($updated_po_files) {
+		# Check staged changes in.
+		if ($config{rcs}) {
+			IkiWiki::disable_commit_hook();
+			IkiWiki::rcs_commit_staged(gettext("updated PO files"),
+				"IkiWiki::Plugin::po::change", "127.0.0.1");
+			IkiWiki::enable_commit_hook();
+			IkiWiki::rcs_update();
+		}
+		# Reinitialize module's private variables.
+		undef %filtered;
+		undef %translations;
+		# Trigger a wiki refresh.
+		require IkiWiki::Render;
+		IkiWiki::refresh();
+		IkiWiki::saveindex();
+	}
+} #}}}
+
+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;
+
 	my $file=$pagesources{$page};
 
 	if (! defined $file
@@ -452,6 +538,7 @@ sub istranslatable ($) { #{{{
 
 sub _istranslation ($) { #{{{
 	my $page=shift;
+
 	my $file=$pagesources{$page};
 	if (! defined $file) {
 		return IkiWiki::FailReason->new("no file specified");
@@ -477,6 +564,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};
@@ -492,6 +580,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");
 	}
@@ -502,6 +591,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");
 	}
@@ -513,6 +603,7 @@ sub match_istranslatable ($;@) { #{{{
 sub match_lang ($$;@) { #{{{
 	my $page=shift;
 	my $wanted=shift;
+
 	my $regexp=IkiWiki::glob2re($wanted);
 	my $lang;
 	my $masterpage;
@@ -534,6 +625,7 @@ sub match_lang ($$;@) { #{{{
 
 sub match_currentlang ($$;@) { #{{{
 	my $page=shift;
+
 	shift;
 	my %params=@_;
 	my ($currentmasterpage, $currentlang, $masterpage, $lang);