X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/6424d748a4da431c244d0775d4d4e839fdd3f671..3e0c52c524f4bb85ccd46832986dd447110cac4d:/IkiWiki/Plugin/po.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 900ca90e4..38fc7527b 100644
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -9,6 +9,7 @@ use strict;
 use IkiWiki 2.00;
 use Encode;
 use Locale::Po4a::Chooser;
+use Locale::Po4a::Po;
 use File::Basename;
 use File::Copy;
 use File::Spec;
@@ -16,19 +17,32 @@ use File::Temp;
 use Memoize;
 
 my %translations;
-memoize("istranslatable");
+our %filtered;
+
 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 {
 	hook(type => "getsetup", id => "po", call => \&getsetup);
 	hook(type => "checkconfig", id => "po", call => \&checkconfig);
 	hook(type => "needsbuild", id => "po", call => \&needsbuild);
-	hook(type => "targetpage", id => "po", call => \&targetpage);
-	hook(type => "tweakurlpath", id => "po", call => \&tweakurlpath);
-	hook(type => "tweakbestlink", id => "po", call => \&tweakbestlink);
 	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);
+	inject(name => "IkiWiki::bestlink", call => \&mybestlink);
+	inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+	inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
 }
 
 sub getsetup () { #{{{
@@ -44,7 +58,7 @@ sub getsetup () { #{{{
 				'name' => 'English'
 			},
 			description => "master language (non-PO files)",
-			safe => 1,
+			safe => 0,
 			rebuild => 1,
 		},
 		po_slave_languages => {
@@ -55,7 +69,7 @@ sub getsetup () { #{{{
 				'de' => 'Deutsch'
 			},
 			description => "slave languages (PO files)",
-			safe => 1,
+			safe => 0,
 			rebuild => 1,
 		},
 		po_translatable_pages => {
@@ -63,14 +77,14 @@ sub getsetup () { #{{{
 			example => "!*/Discussion",
 			description => "PageSpec controlling which pages are translatable",
 			link => "ikiwiki/PageSpec",
-			safe => 1,
+			safe => 0,
 			rebuild => 1,
 		},
 		po_link_to => {
 			type => "string",
 			example => "current",
 			description => "internal linking behavior (default/current/negotiated)",
-			safe => 1,
+			safe => 0,
 			rebuild => 1,
 		},
 } #}}}
@@ -95,17 +109,38 @@ sub checkconfig () { #{{{
 	push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 } #}}}
 
-sub refreshpot ($) { #{{{
+sub potfile ($) { #{{{
 	my $masterfile=shift;
 	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
-	my $potfile=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/\.[^.]*/);
+	$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);
 	$doc->read($masterfile);
 	$doc->{TT}{utf_mode} = 1;
 	$doc->{TT}{file_in_charset} = 'utf-8';
 	$doc->{TT}{file_out_charset} = 'utf-8';
-	$doc->parse or error("[po/refreshpot:$masterfile]: failed to parse");
+	# let's cheat a bit to force porefs option to be passed to Locale::Po4a::Po;
+	# this is undocument use of internal Locale::Po4a::TransTractor's data,
+	# compulsory since this module prevents us from using the porefs option.
+	my %po_options = ('porefs' => 'none');
+	$doc->{TT}{po_out}=Locale::Po4a::Po->new(\%po_options);
+	$doc->{TT}{po_out}->set_charset('utf-8');
+	# do the actual work
+	$doc->parse;
 	$doc->writepo($potfile);
 } #}}}
 
@@ -113,13 +148,12 @@ sub refreshpofiles ($@) { #{{{
 	my $masterfile=shift;
 	my @pofiles=@_;
 
-	(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
-	my $potfile=File::Spec->catfile($dir, $name . ".pot");
+	my $potfile=potfile($masterfile);
 	error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
 
 	foreach my $pofile (@pofiles) {
 		if (-e $pofile) {
-			my $cmd = "msgmerge -U $pofile $potfile";
+			my $cmd = "msgmerge -U --backup=none $pofile $potfile";
 			system ($cmd) == 0
 				or error("[po/refreshpofiles:$pofile] failed to update");
 		}
@@ -138,25 +172,67 @@ sub needsbuild () { #{{{
 		istranslation($page);
 	}
 
-	foreach my $file (@$needsbuild) {
-		my $page=pagename($file);
-		refreshpot(srcfile($file)) if (istranslatable($page));
-		my @pofiles;
-		foreach my $lang (keys %{$translations{$page}}) {
-			push @pofiles, $pagesources{$translations{$page}{$lang}};
+	# refresh/create POT and PO files as needed
+	my $updated_po_files=0;
+	foreach my $page (keys %pagesources) {
+		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);
+				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) {
+				refreshpofiles($file, @pofiles) ;
+				map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+				$updated_po_files = 1;
+			}
+		}
+	}
+
+	# check staged changes in
+	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();
+		}
+		# refresh module's private variables
+		undef %filtered;
+		undef %translations;
+		foreach my $page (keys %pagesources) {
+			istranslation($page);
+		}
+	}
+
+	# make existing translations depend on the corresponding master page
+	foreach my $master (keys %translations) {
+		foreach my $slave (values %{$translations{$master}}) {
+			add_depends($slave, $master);
 		}
-		refreshpofiles(srcfile($file), map { srcfile($_) } @pofiles);
 	}
 } #}}}
 
-sub targetpage (@) { #{{{
-	my %params = @_;
-        my $page=$params{page};
-        my $ext=$params{ext};
+sub mytargetpage ($$) { #{{{
+	my $page=shift;
+	my $ext=shift;
 
 	if (istranslation($page)) {
 		my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-		if (! $config{usedirs} || $page eq 'index') {
+		if (! $config{usedirs} || $masterpage eq 'index') {
 			return $masterpage . "." . $lang . "." . $ext;
 		}
 		else {
@@ -171,51 +247,86 @@ sub targetpage (@) { #{{{
 			return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
 		}
 	}
-	return;
+	return $origsubs{'targetpage'}->($page, $ext);
 } #}}}
 
-sub tweakurlpath ($) { #{{{
-	my %params = @_;
-	my $url=$params{url};
+sub mybeautify_urlpath ($) { #{{{
+	my $url=shift;
+	my $res=$origsubs{'beautify_urlpath'}->($url);
 	if ($config{po_link_to} eq "negotiated") {
-		$url =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
+		$res =~ s!/index.$config{po_master_language}{code}.$config{htmlext}$!/!;
 	}
-	return $url;
+	return $res;
 } #}}}
 
-sub tweakbestlink ($$) { #{{{
-	my %params = @_;
-	my $page=$params{page};
-	my $link=$params{link};
-	if ($config{po_link_to} eq "current"
-	    && istranslatable($link)
-	    && istranslation($page)) {
-		my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-		return $link . "." . $curlang;
+sub urlto_with_orig_beautiful_urlpath($$) { #{{{
+	my $to=shift;
+	my $from=shift;
+
+	inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'});
+	my $res=urlto($to, $from);
+	inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+
+	return $res;
+} #}}}
+
+sub mybestlink ($$) { #{{{
+	my $page=shift;
+	my $link=shift;
+	my $res=$origsubs{'bestlink'}->($page, $link);
+	if (length $res) {
+		if ($config{po_link_to} eq "current"
+		    && istranslatable($res)
+		    && istranslation($page)) {
+			my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+			return $res . "." . $curlang;
+		}
+		else {
+			return $res;
+		}
 	}
-	return $link;
+	return "";
 } #}}}
 
-our %filtered;
-# 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,
@@ -226,12 +337,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 ($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");
+	) 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;
 } #}}}
@@ -247,23 +361,47 @@ sub htmlize (@) { #{{{
 	return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
 } #}}}
 
+sub percenttranslated ($) { #{{{
+	my $page=shift;
+	return "N/A" unless (istranslation($page));
+	my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+	my $file=srcfile($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/percenttranslated:$file]: failed to translate");
+	my ($percent,$hit,$queries) = $doc->stats();
+	return $percent;
+} #}}}
+
 sub otherlanguages ($) { #{{{
 	my $page=shift;
 	my @ret;
 	if (istranslatable($page)) {
 		foreach my $lang (sort keys %{$translations{$page}}) {
+			my $translation = $translations{$page}{$lang};
 			push @ret, {
-				url => urlto($translations{$page}{$lang}, $page),
+				url => urlto($translation, $page),
 				code => $lang,
 				language => $config{po_slave_languages}{$lang},
-				master => 0,
+				percent => percenttranslated($translation),
 			};
 		}
 	}
 	elsif (istranslation($page)) {
 		my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 		push @ret, {
-			url => urlto($masterpage, $page),
+			url => urlto_with_orig_beautiful_urlpath($masterpage, $page),
 			code => $config{po_master_language}{code},
 			language => $config{po_master_language}{name},
 			master => 1,
@@ -273,7 +411,7 @@ sub otherlanguages ($) { #{{{
 				url => urlto($translations{$masterpage}{$lang}, $page),
 				code => $lang,
 				language => $config{po_slave_languages}{$lang},
-				master => 0,
+				percent => percenttranslated($translations{$masterpage}{$lang}),
 			} unless ($lang eq $curlang);
 		}
 	}
@@ -282,14 +420,69 @@ sub otherlanguages ($) { #{{{
 
 sub pagetemplate (@) { #{{{
 	my %params=@_;
-        my $page=$params{page};
-        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));
+	}
+	if ($template->query(name => "istranslation")) {
+		$template->param(istranslation => istranslation($page));
+	}
+	if ($template->query(name => "istranslatable")) {
+		$template->param(istranslatable => istranslatable($page));
+	}
 	if ($template->query(name => "otherlanguages")) {
 		$template->param(otherlanguages => [otherlanguages($page)]);
+		if (istranslatable($page)) {
+			foreach my $translation (values %{$translations{$page}}) {
+				add_depends($page, $translation);
+			}
+		}
+		elsif (istranslation($page)) {
+			add_depends($page, $masterpage);
+			foreach my $translation (values %{$translations{$masterpage}}) {
+				add_depends($page, $translation);
+			}
+		}
+	}
+	# Rely on IkiWiki::Render's genpage() to decide wether
+	# a discussion link should appear on $page; this is not
+	# totally accurate, though: some broken links may be generated
+	# when cgiurl is disabled.
+	# This compromise avoids some code duplication, and will probably
+	# prevent future breakage when ikiwiki internals change.
+	# Known limitations are preferred to future random bugs.
+	if ($template->param('discussionlink') && istranslation($page)) {
+		$template->param('discussionlink' => htmllink(
+							$page,
+							$destpage,
+							$masterpage . '/' . gettext("Discussion"),
+							noimageinline => 1,
+							forcesubpage => 0,
+							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;
 	my $file=$pagesources{$page};
@@ -362,4 +555,56 @@ sub match_istranslatable ($;@) { #{{{
 	}
 } #}}}
 
+sub match_lang ($$;@) { #{{{
+	my $page=shift;
+	my $wanted=shift;
+	my $regexp=IkiWiki::glob2re($wanted);
+	my $lang;
+	my $masterpage;
+
+	if (IkiWiki::Plugin::po::istranslation($page)) {
+		($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+	}
+	else {
+		$lang = $config{po_master_language}{code};
+	}
+
+	if ($lang!~/^$regexp$/i) {
+		return IkiWiki::FailReason->new("file language is $lang, not $wanted");
+	}
+	else {
+		return IkiWiki::SuccessReason->new("file language is $wanted");
+	}
+} #}}}
+
+sub match_currentlang ($$;@) { #{{{
+	my $page=shift;
+	shift;
+	my %params=@_;
+	my ($currentmasterpage, $currentlang, $masterpage, $lang);
+
+	return IkiWiki::FailReason->new("no location provided") unless exists $params{location};
+
+	if (IkiWiki::Plugin::po::istranslation($params{location})) {
+		($currentmasterpage, $currentlang) = ($params{location} =~ /(.*)[.]([a-z]{2})$/);
+	}
+	else {
+		$currentlang = $config{po_master_language}{code};
+	}
+
+	if (IkiWiki::Plugin::po::istranslation($page)) {
+		($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+	}
+	else {
+		$lang = $config{po_master_language}{code};
+	}
+
+	if ($lang eq $currentlang) {
+		return IkiWiki::SuccessReason->new("file language is the same as current one, i.e. $currentlang");
+	}
+	else {
+		return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
+	}
+} #}}}
+
 1