X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/85f865b5d98e0122934d11e3f3eb6703e4f4c620..a8105f68590c7aa56fc37ec62df854546a119060:/IkiWiki/Plugin/po.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index c529828d6..2dad3b60b 100644
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -27,7 +27,7 @@ memoize("istranslatable");
 memoize("_istranslation");
 memoize("percenttranslated");
 
-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);
@@ -39,6 +39,8 @@ sub import { #{{{
 	hook(type => "rename", id => "po", call => \&renamepages);
 	hook(type => "delete", id => "po", call => \&mydelete);
 	hook(type => "change", id => "po", call => \&change);
+	hook(type => "canremove", id => "po", call => \&canremove);
+	hook(type => "canrename", id => "po", call => \&canrename);
 	hook(type => "editcontent", id => "po", call => \&editcontent);
 
 	$origsubs{'bestlink'}=\&IkiWiki::bestlink;
@@ -51,7 +53,7 @@ sub import { #{{{
 	inject(name => "IkiWiki::urlto", call => \&myurlto);
 	$origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
 	inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);
-} #}}}
+}
 
 
 # ,----
@@ -69,7 +71,7 @@ sub import { #{{{
 # | Hooks
 # `----
 
-sub getsetup () { #{{{
+sub getsetup () {
 	return
 		plugin => {
 			safe => 0,
@@ -118,9 +120,9 @@ sub getsetup () { #{{{
 			safe => 1,
 			rebuild => 1,
 		},
-} #}}}
+}
 
-sub checkconfig () { #{{{
+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));
@@ -157,9 +159,9 @@ sub checkconfig () { #{{{
 		$config{po_translation_status_in_links}=1;
 	}
 	push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
-} #}}}
+}
 
-sub needsbuild () { #{{{
+sub needsbuild () {
 	my $needsbuild=shift;
 
 	# backup @needsbuild content so that change() can know whether
@@ -173,13 +175,13 @@ sub needsbuild () { #{{{
 	foreach my $master (keys %translations) {
 		map add_depends($_, $master), values %{otherlanguages($master)};
 	}
-} #}}}
+}
 
 # Massage the recorded state of internal links so that:
 # - it matches the actually generated links, rather than the links as written
 #   in the pages' source
 # - backlinks are consistent in all cases
-sub scan (@) { #{{{
+sub scan (@) {
 	my %params=@_;
 	my $page=$params{page};
 	my $content=$params{content};
@@ -212,11 +214,11 @@ sub scan (@) { #{{{
 			}
 		}
 	}
-} #}}}
+}
 
 # 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 (@) { #{{{
+sub filter (@) {
 	my %params = @_;
 
 	my $page = $params{page};
@@ -229,17 +231,13 @@ sub filter (@) { #{{{
 	# 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!
+	# 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;
@@ -250,16 +248,13 @@ sub filter (@) { #{{{
 	writefile(basename($infile), File::Spec->tmpdir, $content);
 
 	my $masterfile = srcfile($pagesources{masterpage($page)});
-	my (@pos,@masters);
-	push @pos,$infile;
-	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,
+		'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");
@@ -273,9 +268,9 @@ sub filter (@) { #{{{
 
 	setalreadyfiltered($page, $destpage);
 	return $content;
-} #}}}
+}
 
-sub htmlize (@) { #{{{
+sub htmlize (@) {
 	my %params=@_;
 
 	my $page = $params{page};
@@ -288,9 +283,9 @@ sub htmlize (@) { #{{{
 	return IkiWiki::htmlize($page, $page,
 				pagetype(srcfile($pagesources{masterpage($page)})),
 				$content);
-} #}}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
 	my %params=@_;
 	my $page=$params{page};
 	my $destpage=$params{destpage};
@@ -352,10 +347,7 @@ sub postscan (@) {
 }
 
 # Add the renamed page translations to the list of to-be-renamed pages.
-# Save information about master page rename, so that:
-# - our delete hook can ignore the translations not renamed already
-# - our change hook can rename the translations accordingly.
-sub renamepages() { #{{{
+sub renamepages() {
 	my $torename=shift;
 	my @torename=@{$torename};
 
@@ -372,24 +364,21 @@ sub renamepages() { #{{{
 			};
 		}
 	}
-} #}}}
+}
 
-sub mydelete(@) { #{{{
+sub mydelete(@) {
 	my @deleted=@_;
 
-	map {
-		deletetranslations($_);
-	} grep { istranslatablefile($_) } @deleted;
-} #}}}
+	map { deletetranslations($_) } grep istranslatablefile($_), @deleted;
+}
 
-sub change(@) { #{{{
+sub change(@) {
 	my @rendered=@_;
 
 	my $updated_po_files=0;
 
 	# Refresh/create POT and PO files as needed.
-	foreach my $file (@rendered) {
-		next unless istranslatablefile($file);
+	foreach my $file (grep {istranslatablefile($_)} @rendered) {
 		my $page=pagename($file);
 		my $masterfile=srcfile($file);
 		my $updated_pot_file=0;
@@ -407,7 +396,7 @@ sub change(@) { #{{{
 		} (pofiles($masterfile));
 		if (@pofiles) {
 			refreshpofiles($masterfile, @pofiles);
-			map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+			map { IkiWiki::rcs_add($_) } @pofiles if $config{rcs};
 			$updated_po_files=1;
 		}
 	}
@@ -417,16 +406,36 @@ sub change(@) { #{{{
 			gettext("updated PO files"),
 			"IkiWiki::Plugin::po::change");
 	}
-} #}}}
+}
+
+sub canremove ($$$) {
+	my ($page, $cgi, $session) = (shift, shift, shift);
+
+	if (istranslation($page)) {
+		return gettext("Can not remove a translation. Removing the master page,".
+			       "though, removes its translations as well.");
+	}
+	return undef;
+}
+
+sub canrename ($$$) {
+	my ($page, $cgi, $session) = (shift, shift, shift);
+
+	if (istranslation($page)) {
+		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 () { #{{{
+sub editcontent () {
 	my %params=@_;
 
 	unsetalreadyfiltered($params{page}, $params{page});
 	return $params{content};
-} #}}}
+}
 
 
 # ,----
@@ -434,7 +443,7 @@ sub editcontent () { #{{{
 # `----
 
 # Implement po_link_to 'current' and 'negotiated' settings.
-sub mybestlink ($$) { #{{{
+sub mybestlink ($$) {
 	my $page=shift;
 	my $link=shift;
 
@@ -446,9 +455,9 @@ sub mybestlink ($$) { #{{{
 		return $res . "." . lang($page);
 	}
 	return $res;
-} #}}}
+}
 
-sub mybeautify_urlpath ($) { #{{{
+sub mybeautify_urlpath ($) {
 	my $url=shift;
 
 	my $res=$origsubs{'beautify_urlpath'}->($url);
@@ -460,9 +469,9 @@ sub mybeautify_urlpath ($) { #{{{
 		} (keys %{$config{po_slave_languages}});
 	}
 	return $res;
-} #}}}
+}
 
-sub mytargetpage ($$) { #{{{
+sub mytargetpage ($$) {
 	my $page=shift;
 	my $ext=shift;
 
@@ -476,9 +485,9 @@ sub mytargetpage ($$) { #{{{
 		}
 	}
 	return $origsubs{'targetpage'}->($page, $ext);
-} #}}}
+}
 
-sub myurlto ($$;$) { #{{{
+sub myurlto ($$;$) {
 	my $to=shift;
 	my $from=shift;
 	my $absolute=shift;
@@ -496,7 +505,9 @@ sub myurlto ($$;$) { #{{{
 	# avoid, i.e. when po_link_to = negotiated
 	if ($config{po_link_to} eq "negotiated") {
 		my @caller = caller(1);
-		my $run_by_editpage = ($caller[3] eq "IkiWiki::cgi_editpage");
+		my $run_by_editpage = 0;
+		$run_by_editpage = 1 if (exists $caller[3] && defined $caller[3]
+					 && $caller[3] eq "IkiWiki::cgi_editpage");
 		inject(name => "IkiWiki::beautify_urlpath", call => $origsubs{'beautify_urlpath'})
 			if $run_by_editpage;
 		my $res = $origsubs{'urlto'}->($to,$from,$absolute);
@@ -507,16 +518,16 @@ sub myurlto ($$;$) { #{{{
 	else {
 		return $origsubs{'urlto'}->($to,$from,$absolute)
 	}
-} #}}}
+}
 
-sub mynicepagetitle ($;$) { #{{{
+sub mynicepagetitle ($;$) {
 	my ($page, $unescaped) = (shift, shift);
 
 	my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
 	return $res unless istranslation($page);
 	return $res unless $config{po_translation_status_in_links};
 	return $res.' ('.percenttranslated($page).' %)';
-} #}}}
+}
 
 # ,----
 # | Blackboxes for private data
@@ -525,48 +536,48 @@ sub mynicepagetitle ($;$) { #{{{
 {
 	my %filtered;
 
-	sub alreadyfiltered($$) { #{{{
+	sub alreadyfiltered($$) {
 		my $page=shift;
 		my $destpage=shift;
 
 		return ( exists $filtered{$page}{$destpage}
 			 && $filtered{$page}{$destpage} eq 1 );
-	} #}}}
+	}
 
-	sub setalreadyfiltered($$) { #{{{
+	sub setalreadyfiltered($$) {
 		my $page=shift;
 		my $destpage=shift;
 
 		$filtered{$page}{$destpage}=1;
-	} #}}}
+	}
 
-	sub unsetalreadyfiltered($$) { #{{{
+	sub unsetalreadyfiltered($$) {
 		my $page=shift;
 		my $destpage=shift;
 
 		if (exists $filtered{$page}{$destpage}) {
 			delete $filtered{$page}{$destpage};
 		}
-	} #}}}
+	}
 
-	sub resetalreadyfiltered() { #{{{
+	sub resetalreadyfiltered() {
 		undef %filtered;
-	} #}}}
+	}
 }
 
 # ,----
 # | Helper functions
 # `----
 
-sub maybe_add_leading_slash ($;$) { #{{{
+sub maybe_add_leading_slash ($;$) {
 	my $str=shift;
 	my $add=shift;
 	$add=1 unless defined $add;
 	return '/' . $str if $add;
 	return $str;
-} #}}}
+}
 
-sub istranslatablefile ($) { #{{{
+sub istranslatablefile ($) {
 	my $file=shift;
 
 	return 0 unless defined $file;
@@ -574,17 +585,17 @@ sub istranslatablefile ($) { #{{{
 	return 0 if $file =~ /\.pot$/;
 	return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
 	return;
-} #}}}
+}
 
-sub istranslatable ($) { #{{{
+sub istranslatable ($) {
 	my $page=shift;
 
 	$page=~s#^/##;
 	return 1 if istranslatablefile($pagesources{$page});
 	return;
-} #}}}
+}
 
-sub _istranslation ($) { #{{{
+sub _istranslation ($) {
 	my $page=shift;
 
 	my $hasleadingslash = ($page=~s#^/##);
@@ -602,9 +613,9 @@ sub _istranslation ($) { #{{{
 
 	return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
 		if istranslatable($masterpage);
-} #}}}
+}
 
-sub istranslation ($) { #{{{
+sub istranslation ($) {
 	my $page=shift;
 
 	if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
@@ -613,41 +624,41 @@ sub istranslation ($) { #{{{
 		return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
 	}
 	return;
-} #}}}
+}
 
-sub masterpage ($) { #{{{
+sub masterpage ($) {
 	my $page=shift;
 
 	if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
 		return $masterpage;
 	}
 	return $page;
-} #}}}
+}
 
-sub lang ($) { #{{{
+sub lang ($) {
 	my $page=shift;
 
 	if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
 		return $lang;
 	}
 	return $config{po_master_language}{code};
-} #}}}
+}
 
-sub islanguagecode ($) { #{{{
+sub islanguagecode ($) {
 	my $code=shift;
 
 	return ($code =~ /^[a-z]{2}$/);
-} #}}}
+}
 
-sub otherlanguage ($$) { #{{{
+sub otherlanguage ($$) {
 	my $page=shift;
 	my $code=shift;
 
 	return masterpage($page) if $code eq $config{po_master_language}{code};
 	return masterpage($page) . '.' . $code;
-} #}}}
+}
 
-sub otherlanguages ($) { #{{{
+sub otherlanguages ($) {
 	my $page=shift;
 
 	my %ret;
@@ -659,32 +670,32 @@ sub otherlanguages ($) { #{{{
 		$ret{$lang}=otherlanguage($page, $lang);
 	}
 	return \%ret;
-} #}}}
+}
 
-sub potfile ($) { #{{{
+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");
-} #}}}
+}
 
-sub pofile ($$) { #{{{
+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 pofiles ($) { #{{{
+sub pofiles ($) {
 	my $masterfile=shift;
 
 	return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
-} #}}}
+}
 
-sub refreshpot ($) { #{{{
+sub refreshpot ($) {
 	my $masterfile=shift;
 
 	my $potfile=potfile($masterfile);
@@ -697,16 +708,15 @@ sub refreshpot ($) { #{{{
 	# 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}=Locale::Po4a::Po->new({ 'porefs' => 'none' });
 	$doc->{TT}{po_out}->set_charset('utf-8');
 	# do the actual work
 	$doc->parse;
 	IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
 	$doc->writepo($potfile);
-} #}}}
+}
 
-sub refreshpofiles ($@) { #{{{
+sub refreshpofiles ($@) {
 	my $masterfile=shift;
 	my @pofiles=@_;
 
@@ -724,24 +734,24 @@ sub refreshpofiles ($@) { #{{{
 				or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
 		}
 	}
-} #}}}
+}
 
-sub buildtranslationscache() { #{{{
+sub buildtranslationscache() {
 	# use istranslation's side-effect
 	map istranslation($_), (keys %pagesources);
-} #}}}
+}
 
-sub resettranslationscache() { #{{{
+sub resettranslationscache() {
 	undef %translations;
-} #}}}
+}
 
-sub flushmemoizecache() { #{{{
+sub flushmemoizecache() {
 	Memoize::flush_cache("istranslatable");
 	Memoize::flush_cache("_istranslation");
 	Memoize::flush_cache("percenttranslated");
-} #}}}
+}
 
-sub urlto_with_orig_beautiful_urlpath($$) { #{{{
+sub urlto_with_orig_beautiful_urlpath($$) {
 	my $to=shift;
 	my $from=shift;
 
@@ -750,33 +760,30 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
 	inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
 
 	return $res;
-} #}}}
+}
 
-sub percenttranslated ($) { #{{{
+sub percenttranslated ($) {
 	my $page=shift;
 
 	$page=~s/^\///;
 	return gettext("N/A") unless istranslation($page);
 	my $file=srcfile($pagesources{$page});
 	my $masterfile = srcfile($pagesources{masterpage($page)});
-	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,
+		'po_in_name'	=> [ $file ],
+		'file_in_name'	=> [ $masterfile ],
 		'file_in_charset'  => 'utf-8',
 		'file_out_charset' => 'utf-8',
 	) or error("[po/percenttranslated:$page]: failed to translate");
 	my ($percent,$hit,$queries) = $doc->stats();
 	return $percent;
-} #}}}
+}
 
-sub languagename ($) { #{{{
+sub languagename ($) {
 	my $code=shift;
 
 	return $config{po_master_language}{name}
@@ -784,9 +791,9 @@ sub languagename ($) { #{{{
 	return $config{po_slave_languages}{$code}
 		if defined $config{po_slave_languages}{$code};
 	return;
-} #}}}
+}
 
-sub otherlanguagesloop ($) { #{{{
+sub otherlanguagesloop ($) {
 	my $page=shift;
 
 	my @ret;
@@ -814,15 +821,15 @@ sub otherlanguagesloop ($) { #{{{
 			return 1 if $b->{code} eq $config{po_master_language}{code};
 			return $a->{language} cmp $b->{language};
 		} @ret;
-} #}}}
+}
 
-sub homepageurl (;$) { #{{{
+sub homepageurl (;$) {
 	my $page=shift;
 
 	return urlto('', $page);
-} #}}}
+}
 
-sub deletetranslations ($) { #{{{
+sub deletetranslations ($) {
 	my $deletedmasterfile=shift;
 
 	my $deletedmasterpage=pagename($deletedmasterfile);
@@ -849,9 +856,9 @@ sub deletetranslations ($) { #{{{
 			gettext("removed obsolete PO files"),
 			"IkiWiki::Plugin::po::deletetranslations");
 	}
-} #}}}
+}
 
-sub commit_and_refresh ($$) { #{{{
+sub commit_and_refresh ($$) {
 	my ($msg, $author) = (shift, shift);
 
 	if ($config{rcs}) {
@@ -872,7 +879,7 @@ sub commit_and_refresh ($$) { #{{{
 	IkiWiki::loadindex();
 	IkiWiki::refresh();
 	IkiWiki::saveindex();
-} #}}}
+}
 
 # ,----
 # | PageSpec's
@@ -883,7 +890,7 @@ use warnings;
 use strict;
 use IkiWiki 2.00;
 
-sub match_istranslation ($;@) { #{{{
+sub match_istranslation ($;@) {
 	my $page=shift;
 
 	if (IkiWiki::Plugin::po::istranslation($page)) {
@@ -892,9 +899,9 @@ sub match_istranslation ($;@) { #{{{
 	else {
 		return IkiWiki::FailReason->new("is not a translation page");
 	}
-} #}}}
+}
 
-sub match_istranslatable ($;@) { #{{{
+sub match_istranslatable ($;@) {
 	my $page=shift;
 
 	if (IkiWiki::Plugin::po::istranslatable($page)) {
@@ -903,9 +910,9 @@ sub match_istranslatable ($;@) { #{{{
 	else {
 		return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
 	}
-} #}}}
+}
 
-sub match_lang ($$;@) { #{{{
+sub match_lang ($$;@) {
 	my $page=shift;
 	my $wanted=shift;
 
@@ -917,9 +924,9 @@ sub match_lang ($$;@) { #{{{
 	else {
 		return IkiWiki::SuccessReason->new("file language is $wanted");
 	}
-} #}}}
+}
 
-sub match_currentlang ($$;@) { #{{{
+sub match_currentlang ($$;@) {
 	my $page=shift;
 	shift;
 	my %params=@_;
@@ -935,6 +942,6 @@ sub match_currentlang ($$;@) { #{{{
 	else {
 		return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
 	}
-} #}}}
+}
 
 1