X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/741b26aa176b34d0359a2b89dd6d8293fcdf2b3d..da26603e0780b3079ee8e94ec3651fdc615cc3f9:/IkiWiki/Plugin/po.pm?ds=inline

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 5670f3608..7cec589ab 100644
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -1,14 +1,14 @@
 #!/usr/bin/perl
 # .po as a wiki page type
 # Licensed under GPL v2 or greater
-# Copyright (C) 2008 intrigeri <intrigeri@boum.org>
+# Copyright (C) 2008-2009 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;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 use Encode;
 use Locale::Po4a::Chooser;
 use Locale::Po4a::Po;
@@ -36,11 +36,15 @@ sub import {
 	hook(type => "htmlize", id => "po", call => \&htmlize);
 	hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
 	hook(type => "postscan", id => "po", call => \&postscan);
-	hook(type => "rename", id => "po", call => \&renamepages);
+	hook(type => "rename", id => "po", call => \&renamepages, first => 1);
 	hook(type => "delete", id => "po", call => \&mydelete);
 	hook(type => "change", id => "po", call => \&change);
+	hook(type => "cansave", id => "po", call => \&cansave);
 	hook(type => "canremove", id => "po", call => \&canremove);
+	hook(type => "canrename", id => "po", call => \&canrename);
 	hook(type => "editcontent", id => "po", call => \&editcontent);
+	hook(type => "formbuilder_setup", id => "po", call => \&formbuilder_setup, last => 1);
+	hook(type => "formbuilder", id => "po", call => \&formbuilder);
 
 	$origsubs{'bestlink'}=\&IkiWiki::bestlink;
 	inject(name => "IkiWiki::bestlink", call => \&mybestlink);
@@ -124,11 +128,12 @@ sub getsetup () {
 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));
+			error(sprintf(gettext("Must specify %s when using the %s plugin"), $field, 'po'));
 		}
 	}
 	if (! (keys %{$config{po_slave_languages}})) {
-		error(gettext("At least one slave language must be defined in po_slave_languages"));
+		error(gettext("At least one slave language must be defined ".
+			      "in po_slave_languages when using the po plugin"));
 	}
 	map {
 		islanguagecode($_)
@@ -222,50 +227,11 @@ sub filter (@) {
 
 	my $page = $params{page};
 	my $destpage = $params{destpage};
-	my $content = decode_utf8(encode_utf8($params{content}));
-
-	return $content if ( ! istranslation($page)
-			     || alreadyfiltered($page, $destpage) );
-
-	# CRLF line terminators make poor Locale::Po4a feel bad
-	$content=~s/\r\n/\n/g;
-
-	# 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 $masterfile = srcfile($pagesources{masterpage($page)});
-	my %options = (
-		"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
-	);
-	my $doc=Locale::Po4a::Chooser::new('text',%options);
-	$doc->process(
-		'po_in_name'	=> [ $infile ],
-		'file_in_name'	=> [ $masterfile ],
-		'file_in_charset'  => 'utf-8',
-		'file_out_charset' => 'utf-8',
-	) or error("[po/filter:$page]: failed to translate");
-	$doc->write($outfile) or error("[po/filter:$page] could not write $outfile");
-	$content = readfile($outfile) or error("[po/filter:$page] 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;
-
-	setalreadyfiltered($page, $destpage);
+	my $content = $params{content};
+	if (istranslation($page) && ! alreadyfiltered($page, $destpage)) {
+		$content = po_to_markup($page, $content);
+		setalreadyfiltered($page, $destpage);
+	}
 	return $content;
 }
 
@@ -346,10 +312,24 @@ sub postscan (@) {
 }
 
 # Add the renamed page translations to the list of to-be-renamed pages.
-sub renamepages() {
-	my $torename=shift;
+sub renamepages($$$) {
+	my ($torename, $cgi, $session) = (shift, shift, shift);
+
+	# copy the initial array, so that we can iterate on it AND
+	# modify it at the same time, without iterating on the items we
+	# pushed on it ourselves
 	my @torename=@{$torename};
 
+	# Save the page(s) the user asked to rename, so that our
+	# canrename hook can tell the difference between:
+	#  - a translation being renamed as a consequence of its master page
+	#    being renamed
+	#  - a user trying to directly rename a translation
+	# This is why this hook has to be run first, before @torename is modified
+	# by other plugins.
+	$session->param(po_orig_torename => [ @torename ]);
+	IkiWiki::cgi_savesession($session);
+
 	foreach my $rename (@torename) {
 		next unless istranslatable($rename->{src});
 		my %otherpages=%{otherlanguages($rename->{src})};
@@ -407,16 +387,52 @@ sub change(@) {
 	}
 }
 
+sub cansave ($$$$) {
+	my ($page, $content, $cgi, $session) = (shift, shift, shift, shift);
+
+	if (istranslation($page)) {
+		my $res = isvalidpo($content);
+		if ($res) {
+			return undef;
+		}
+		else {
+			return "$res";
+		}
+	}
+	return undef;
+}
+
 sub canremove ($$$) {
 	my ($page, $cgi, $session) = (shift, shift, shift);
 
 	if (istranslation($page)) {
-		return gettext("Can not remove a translation. Removing the master page,".
+		return gettext("Can not remove a translation. Removing the master page, ".
 			       "though, removes its translations as well.");
 	}
 	return undef;
 }
 
+sub canrename ($$@) {
+	my ($cgi, $session) = (shift, shift);
+	my %params = @_;
+
+	if (istranslation($params{src})) {
+		my $masterpage = masterpage($params{src});
+		# Tell the difference between:
+		#  - a translation being renamed as a consequence of its master page
+		#    being renamed, which is allowed
+		#  - a user trying to directly rename a translation, which is forbidden
+		# by looking for the master page in the list of to-be-renamed pages we
+		# saved early in the renaming process.
+		my $orig_torename = $session->param("po_orig_torename");
+		unless (scalar grep { $_->{src} eq $masterpage } @{$orig_torename}) {
+			return gettext("Can not rename a translation. Renaming the master page, ".
+				       "though, renames its translations as well.");
+		}
+	}
+	return undef;
+}
+
 # As we're previewing or saving a page, the content may have
 # changed, so tell the next filter() invocation it must not be lazy.
 sub editcontent () {
@@ -426,6 +442,63 @@ sub editcontent () {
 	return $params{content};
 }
 
+sub formbuilder_setup (@) {
+	my %params=@_;
+	my $form=$params{form};
+	my $q=$params{cgi};
+
+	return unless defined $form->field("do");
+
+	if ($form->field("do") eq "create") {
+		# Warn the user: new pages must be written in master language.
+		my $template=template("pocreatepage.tmpl");
+		$template->param(LANG => $config{po_master_language}{name});
+		$form->tmpl_param(message => $template->output);
+	}
+	elsif ($form->field("do") eq "edit") {
+		# Remove the rename/remove buttons on slave pages.
+		# This has to be done after the rename/remove plugins have added
+		# their buttons, which is why this hook must be run last.
+		# The canrename/canremove hooks already ensure this is forbidden
+		# at the backend level, so this is only UI sugar.
+		if (istranslation($form->field("page"))) {
+			map {
+				for (my $i = 0; $i < @{$params{buttons}}; $i++) {
+					if (@{$params{buttons}}[$i] eq $_) {
+						delete  @{$params{buttons}}[$i];
+						last;
+					}
+				}
+			} qw(Rename Remove);
+		}
+	}
+}
+
+# Do not allow to create pages of type po: they are automatically created.
+# The main reason to do so is to bypass the "favor the type of linking page
+# on page creation" logic, which is unsuitable when a broken link is clicked
+# on a slave (PO) page.
+sub formbuilder (@) {
+	my %params=@_;
+	my $form=$params{form};
+	my $q=$params{cgi};
+
+	return unless (defined $form->field("do") && $form->field("do") eq "create");
+
+        for my $field ($form->field) {
+		next unless "$field" eq "type";
+		if ($field->type eq 'select') {
+			# remove po from the types list
+			my @types = grep { $_ ne 'po' } $field->options;
+			$field->options(\@types) if scalar @types;
+		}
+		else {
+			# make sure the default value is not po;
+			# does this case actually happen?
+			debug sprintf("po(formbuilder) type field is not select - not implemented yet");
+		}
+	}
+}
 
 # ,----
 # | Injected functions
@@ -515,7 +588,7 @@ sub mynicepagetitle ($;$) {
 	my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
 	return $res unless istranslation($page);
 	return $res unless $config{po_translation_status_in_links};
-	return $res.' ('.percenttranslated($page).' %)';
+	return $res.' ('.percenttranslated($page).'&nbsp;%)';
 }
 
 # ,----
@@ -710,17 +783,21 @@ sub refreshpofiles ($@) {
 	my @pofiles=@_;
 
 	my $potfile=potfile($masterfile);
-	error("[po/refreshpofiles] POT file ($potfile) does not exist") unless (-e $potfile);
+	(-e $potfile)
+		or error(sprintf(gettext("po(refreshpofiles) POT file (%s) does not exist"),
+				 $potfile));
 
 	foreach my $pofile (@pofiles) {
 		IkiWiki::prep_writefile(basename($pofile),dirname($pofile));
 		if (-e $pofile) {
 			system("msgmerge", "-U", "--backup=none", $pofile, $potfile) == 0
-				or error("[po/refreshpofiles:$pofile] failed to update");
+				or error(sprintf(gettext("po(refreshpofiles) failed to update %s"),
+						 $pofile));
 		}
 		else {
 			File::Copy::syscopy($potfile,$pofile)
-				or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
+				or error(sprintf(gettext("po(refreshpofiles) failed to copy the POT file to %s"),
+						 $pofile));
 		}
 	}
 }
@@ -767,8 +844,10 @@ sub percenttranslated ($) {
 		'file_in_name'	=> [ $masterfile ],
 		'file_in_charset'  => 'utf-8',
 		'file_out_charset' => 'utf-8',
-	) or error("[po/percenttranslated:$page]: failed to translate");
+	) or error(sprintf(gettext("po(percenttranslated) failed to translate %s"),
+			   $page));
 	my ($percent,$hit,$queries) = $doc->stats();
+	$percent =~ s/\.[0-9]+$//;
 	return $percent;
 }
 
@@ -870,6 +949,110 @@ sub commit_and_refresh ($$) {
 	IkiWiki::saveindex();
 }
 
+# on success, returns the filtered content.
+# on error, if $nonfatal, warn and return undef; else, error out.
+sub po_to_markup ($$;$) {
+	my ($page, $content) = (shift, shift);
+	my $nonfatal = shift;
+
+	$content = '' unless defined $content;
+	$content = decode_utf8(encode_utf8($content));
+	# CRLF line terminators make poor Locale::Po4a feel bad
+	$content=~s/\r\n/\n/g;
+
+	# 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;
+
+	my $fail = sub ($) {
+		my $msg = "po(po_to_markup) - $page : " . shift;
+		if ($nonfatal) {
+			warn $msg;
+			return undef;
+		}
+		error($msg, sub { unlink $infile, $outfile});
+	};
+
+	writefile(basename($infile), File::Spec->tmpdir, $content)
+		or return $fail->(sprintf(gettext("failed to write %s"), $infile));
+
+	my $masterfile = srcfile($pagesources{masterpage($page)});
+	my %options = (
+		"markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
+	);
+	my $doc=Locale::Po4a::Chooser::new('text',%options);
+	$doc->process(
+		'po_in_name'	=> [ $infile ],
+		'file_in_name'	=> [ $masterfile ],
+		'file_in_charset'  => 'utf-8',
+		'file_out_charset' => 'utf-8',
+	) or return $fail->(gettext("failed to translate"));
+	$doc->write($outfile)
+		or return $fail->(sprintf(gettext("failed to write %s"), $outfile));
+
+	$content = readfile($outfile)
+		or return $fail->(sprintf(gettext("failed to read %s"), $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;
+
+	return $content;
+}
+
+# returns a SuccessReason or FailReason object
+sub isvalidpo ($) {
+	my $content = shift;
+
+	# NB: we don't use po_to_markup here, since Po4a parser does
+	# not mind invalid PO content
+	$content = '' unless defined $content;
+	$content = decode_utf8(encode_utf8($content));
+
+	# 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-isvalidpo.XXXXXXXXXX",
+				    DIR => File::Spec->tmpdir,
+				    UNLINK => 1)->filename;
+
+	my $fail = sub ($) {
+		my $msg = '[po/isvalidpo] ' . shift;
+		unlink $infile;
+		return IkiWiki::FailReason->new("$msg");
+	};
+
+	writefile(basename($infile), File::Spec->tmpdir, $content)
+		or return $fail->(sprintf(gettext("failed to write %s"), $infile));
+
+	my $res = (system("msgfmt", "--check", $infile, "-o", "/dev/null") == 0);
+
+	# 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;
+
+	if ($res) {
+	    return IkiWiki::SuccessReason->new("valid gettext data");
+	}
+	return IkiWiki::FailReason->new("invalid gettext data");
+}
+
 # ,----
 # | PageSpec's
 # `----