urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

po: follow new coding style (removed Vim folding markers 

)
Signed-off-by: intrigeri <intrigeri@boum.org>
master
intrigeri 2008-12-31 23:54:21 +01:00
parent 85f865b5d9
commit 856de5734d
1 changed files with 99 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
IkiWiki/Plugin/po.pm
View File

@ -27,7 +27,7 @@ memoize("istranslatable");
memoize("_istranslation"); memoize("_istranslation");
memoize("percenttranslated"); memoize("percenttranslated");
sub import { #{{{ sub import {
hook(type => "getsetup", id => "po", call => \&getsetup); hook(type => "getsetup", id => "po", call => \&getsetup);
hook(type => "checkconfig", id => "po", call => \&checkconfig); hook(type => "checkconfig", id => "po", call => \&checkconfig);
hook(type => "needsbuild", id => "po", call => \&needsbuild); hook(type => "needsbuild", id => "po", call => \&needsbuild);
@ -51,7 +51,7 @@ sub import { #{{{
inject(name => "IkiWiki::urlto", call => \&myurlto); inject(name => "IkiWiki::urlto", call => \&myurlto);
$origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle; $origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle); inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);
} #}}} }
# ,---- # ,----
@ -69,7 +69,7 @@ sub import { #{{{
# | Hooks # | Hooks
# `---- # `----
sub getsetup () { #{{{ sub getsetup () {
return return
plugin => { plugin => {
safe => 0, safe => 0,
@ -118,9 +118,9 @@ sub getsetup () { #{{{
safe => 1, safe => 1,
rebuild => 1, rebuild => 1,
}, },
} #}}} }
sub checkconfig () { #{{{ sub checkconfig () {
foreach my $field (qw{po_master_language po_slave_languages}) { foreach my $field (qw{po_master_language po_slave_languages}) {
if (! exists $config{$field} || ! defined $config{$field}) { if (! exists $config{$field} || ! defined $config{$field}) {
error(sprintf(gettext("Must specify %s"), $field)); error(sprintf(gettext("Must specify %s"), $field));
@ -157,9 +157,9 @@ sub checkconfig () { #{{{
$config{po_translation_status_in_links}=1; $config{po_translation_status_in_links}=1;
} }
push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/; push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
} #}}} }
sub needsbuild () { #{{{ sub needsbuild () {
my $needsbuild=shift; my $needsbuild=shift;
# backup @needsbuild content so that change() can know whether # backup @needsbuild content so that change() can know whether
@ -173,13 +173,13 @@ sub needsbuild () { #{{{
foreach my $master (keys %translations) { foreach my $master (keys %translations) {
map add_depends($_, $master), values %{otherlanguages($master)}; map add_depends($_, $master), values %{otherlanguages($master)};
} }
} #}}} }
# Massage the recorded state of internal links so that: # Massage the recorded state of internal links so that:
# - it matches the actually generated links, rather than the links as written # - it matches the actually generated links, rather than the links as written
# in the pages' source # in the pages' source
# - backlinks are consistent in all cases # - backlinks are consistent in all cases
sub scan (@) { #{{{ sub scan (@) {
my %params=@_; my %params=@_;
my $page=$params{page}; my $page=$params{page};
my $content=$params{content}; my $content=$params{content};
@ -212,11 +212,11 @@ sub scan (@) { #{{{
} }
} }
} }
} #}}} }
# We use filter to convert PO to the master page's format, # We use filter to convert PO to the master page's format,
# since the rest of ikiwiki should not work on PO files. # since the rest of ikiwiki should not work on PO files.
sub filter (@) { #{{{ sub filter (@) {
my %params = @_; my %params = @_;
my $page = $params{page}; my $page = $params{page};
@ -273,9 +273,9 @@ sub filter (@) { #{{{
setalreadyfiltered($page, $destpage); setalreadyfiltered($page, $destpage);
return $content; return $content;
} #}}} }
sub htmlize (@) { #{{{ sub htmlize (@) {
my %params=@_; my %params=@_;
my $page = $params{page}; my $page = $params{page};
@ -288,9 +288,9 @@ sub htmlize (@) { #{{{
return IkiWiki::htmlize($page, $page, return IkiWiki::htmlize($page, $page,
pagetype(srcfile($pagesources{masterpage($page)})), pagetype(srcfile($pagesources{masterpage($page)})),
$content); $content);
} #}}} }
sub pagetemplate (@) { #{{{ sub pagetemplate (@) {
my %params=@_; my %params=@_;
my $page=$params{page}; my $page=$params{page};
my $destpage=$params{destpage}; my $destpage=$params{destpage};
@ -355,7 +355,7 @@ sub postscan (@) {
# Save information about master page rename, so that: # Save information about master page rename, so that:
# - our delete hook can ignore the translations not renamed already # - our delete hook can ignore the translations not renamed already
# - our change hook can rename the translations accordingly. # - our change hook can rename the translations accordingly.
sub renamepages() { #{{{ sub renamepages() {
my $torename=shift; my $torename=shift;
my @torename=@{$torename}; my @torename=@{$torename};
@ -372,17 +372,17 @@ sub renamepages() { #{{{
}; };
} }
} }
} #}}} }
sub mydelete(@) { #{{{ sub mydelete(@) {
my @deleted=@_; my @deleted=@_;
map { map {
deletetranslations($_); deletetranslations($_);
} grep { istranslatablefile($_) } @deleted; } grep { istranslatablefile($_) } @deleted;
} #}}} }
sub change(@) { #{{{ sub change(@) {
my @rendered=@_; my @rendered=@_;
my $updated_po_files=0; my $updated_po_files=0;
@ -417,16 +417,16 @@ sub change(@) { #{{{
gettext("updated PO files"), gettext("updated PO files"),
"IkiWiki::Plugin::po::change"); "IkiWiki::Plugin::po::change");
} }
} #}}} }
# As we're previewing or saving a page, the content may have # As we're previewing or saving a page, the content may have
# changed, so tell the next filter() invocation it must not be lazy. # changed, so tell the next filter() invocation it must not be lazy.
sub editcontent () { #{{{ sub editcontent () {
my %params=@_; my %params=@_;
unsetalreadyfiltered($params{page}, $params{page}); unsetalreadyfiltered($params{page}, $params{page});
return $params{content}; return $params{content};
} #}}} }
# ,---- # ,----
@ -434,7 +434,7 @@ sub editcontent () { #{{{
# `---- # `----
# Implement po_link_to 'current' and 'negotiated' settings. # Implement po_link_to 'current' and 'negotiated' settings.
sub mybestlink ($$) { #{{{ sub mybestlink ($$) {
my $page=shift; my $page=shift;
my $link=shift; my $link=shift;
@ -446,9 +446,9 @@ sub mybestlink ($$) { #{{{
return $res . "." . lang($page); return $res . "." . lang($page);
} }
return $res; return $res;
} #}}} }
sub mybeautify_urlpath ($) { #{{{ sub mybeautify_urlpath ($) {
my $url=shift; my $url=shift;
my $res=$origsubs{'beautify_urlpath'}->($url); my $res=$origsubs{'beautify_urlpath'}->($url);
@ -460,9 +460,9 @@ sub mybeautify_urlpath ($) { #{{{
} (keys %{$config{po_slave_languages}}); } (keys %{$config{po_slave_languages}});
} }
return $res; return $res;
} #}}} }
sub mytargetpage ($$) { #{{{ sub mytargetpage ($$) {
my $page=shift; my $page=shift;
my $ext=shift; my $ext=shift;
@ -476,9 +476,9 @@ sub mytargetpage ($$) { #{{{
} }
} }
return $origsubs{'targetpage'}->($page, $ext); return $origsubs{'targetpage'}->($page, $ext);
} #}}} }
sub myurlto ($$;$) { #{{{ sub myurlto ($$;$) {
my $to=shift; my $to=shift;
my $from=shift; my $from=shift;
my $absolute=shift; my $absolute=shift;
@ -507,16 +507,16 @@ sub myurlto ($$;$) { #{{{
else { else {
return $origsubs{'urlto'}->($to,$from,$absolute) return $origsubs{'urlto'}->($to,$from,$absolute)
} }
} #}}} }
sub mynicepagetitle ($;$) { #{{{ sub mynicepagetitle ($;$) {
my ($page, $unescaped) = (shift, shift); my ($page, $unescaped) = (shift, shift);
my $res = $origsubs{'nicepagetitle'}->($page, $unescaped); my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
return $res unless istranslation($page); return $res unless istranslation($page);
return $res unless $config{po_translation_status_in_links}; return $res unless $config{po_translation_status_in_links};
return $res.' ('.percenttranslated($page).' %)'; return $res.' ('.percenttranslated($page).' %)';
} #}}} }
# ,---- # ,----
# | Blackboxes for private data # | Blackboxes for private data
@ -525,48 +525,48 @@ sub mynicepagetitle ($;$) { #{{{
{ {
my %filtered; my %filtered;
sub alreadyfiltered($$) { #{{{ sub alreadyfiltered($$) {
my $page=shift; my $page=shift;
my $destpage=shift; my $destpage=shift;
return ( exists $filtered{$page}{$destpage} return ( exists $filtered{$page}{$destpage}
&& $filtered{$page}{$destpage} eq 1 ); && $filtered{$page}{$destpage} eq 1 );
} #}}} }
sub setalreadyfiltered($$) { #{{{ sub setalreadyfiltered($$) {
my $page=shift; my $page=shift;
my $destpage=shift; my $destpage=shift;
$filtered{$page}{$destpage}=1; $filtered{$page}{$destpage}=1;
} #}}} }
sub unsetalreadyfiltered($$) { #{{{ sub unsetalreadyfiltered($$) {
my $page=shift; my $page=shift;
my $destpage=shift; my $destpage=shift;
if (exists $filtered{$page}{$destpage}) { if (exists $filtered{$page}{$destpage}) {
delete $filtered{$page}{$destpage}; delete $filtered{$page}{$destpage};
} }
} #}}} }
sub resetalreadyfiltered() { #{{{ sub resetalreadyfiltered() {
undef %filtered; undef %filtered;
} #}}} }
} }
# ,---- # ,----
# | Helper functions # | Helper functions
# `---- # `----
sub maybe_add_leading_slash ($;$) { #{{{ sub maybe_add_leading_slash ($;$) {
my $str=shift; my $str=shift;
my $add=shift; my $add=shift;
$add=1 unless defined $add; $add=1 unless defined $add;
return '/' . $str if $add; return '/' . $str if $add;
return $str; return $str;
} #}}} }
sub istranslatablefile ($) { #{{{ sub istranslatablefile ($) {
my $file=shift; my $file=shift;
return 0 unless defined $file; return 0 unless defined $file;
@ -574,17 +574,17 @@ sub istranslatablefile ($) { #{{{
return 0 if $file =~ /\.pot$/; return 0 if $file =~ /\.pot$/;
return 1 if pagespec_match(pagename($file), $config{po_translatable_pages}); return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
return; return;
} #}}} }
sub istranslatable ($) { #{{{ sub istranslatable ($) {
my $page=shift; my $page=shift;
$page=~s#^/##; $page=~s#^/##;
return 1 if istranslatablefile($pagesources{$page}); return 1 if istranslatablefile($pagesources{$page});
return; return;
} #}}} }
sub _istranslation ($) { #{{{ sub _istranslation ($) {
my $page=shift; my $page=shift;
my $hasleadingslash = ($page=~s#^/##); my $hasleadingslash = ($page=~s#^/##);
@ -602,9 +602,9 @@ sub _istranslation ($) { #{{{
return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang) return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
if istranslatable($masterpage); if istranslatable($masterpage);
} #}}} }
sub istranslation ($) { #{{{ sub istranslation ($) {
my $page=shift; my $page=shift;
if (1 < (my ($masterpage, $lang) = _istranslation($page))) { if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
@ -613,41 +613,41 @@ sub istranslation ($) { #{{{
return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang); return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
} }
return; return;
} #}}} }
sub masterpage ($) { #{{{ sub masterpage ($) {
my $page=shift; my $page=shift;
if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) { if ( 1 < (my ($masterpage, $lang) = _istranslation($page))) {
return $masterpage; return $masterpage;
} }
return $page; return $page;
} #}}} }
sub lang ($) { #{{{ sub lang ($) {
my $page=shift; my $page=shift;
if (1 < (my ($masterpage, $lang) = _istranslation($page))) { if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
return $lang; return $lang;
} }
return $config{po_master_language}{code}; return $config{po_master_language}{code};
} #}}} }
sub islanguagecode ($) { #{{{ sub islanguagecode ($) {
my $code=shift; my $code=shift;
return ($code =~ /^[a-z]{2}$/); return ($code =~ /^[a-z]{2}$/);
} #}}} }
sub otherlanguage ($$) { #{{{ sub otherlanguage ($$) {
my $page=shift; my $page=shift;
my $code=shift; my $code=shift;
return masterpage($page) if $code eq $config{po_master_language}{code}; return masterpage($page) if $code eq $config{po_master_language}{code};
return masterpage($page) . '.' . $code; return masterpage($page) . '.' . $code;
} #}}} }
sub otherlanguages ($) { #{{{ sub otherlanguages ($) {
my $page=shift; my $page=shift;
my %ret; my %ret;
@ -659,32 +659,32 @@ sub otherlanguages ($) { #{{{
$ret{$lang}=otherlanguage($page, $lang); $ret{$lang}=otherlanguage($page, $lang);
} }
return \%ret; return \%ret;
} #}}} }
sub potfile ($) { #{{{ sub potfile ($) {
my $masterfile=shift; my $masterfile=shift;
(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
$dir='' if $dir eq './'; $dir='' if $dir eq './';
return File::Spec->catpath('', $dir, $name . ".pot"); return File::Spec->catpath('', $dir, $name . ".pot");
} #}}} }
sub pofile ($$) { #{{{ sub pofile ($$) {
my $masterfile=shift; my $masterfile=shift;
my $lang=shift; my $lang=shift;
(my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/); (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
$dir='' if $dir eq './'; $dir='' if $dir eq './';
return File::Spec->catpath('', $dir, $name . "." . $lang . ".po"); return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
} #}}} }
sub pofiles ($) { #{{{ sub pofiles ($) {
my $masterfile=shift; my $masterfile=shift;
return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}}); return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
} #}}} }
sub refreshpot ($) { #{{{ sub refreshpot ($) {
my $masterfile=shift; my $masterfile=shift;
my $potfile=potfile($masterfile); my $potfile=potfile($masterfile);
@ -704,9 +704,9 @@ sub refreshpot ($) { #{{{
$doc->parse; $doc->parse;
IkiWiki::prep_writefile(basename($potfile),dirname($potfile)); IkiWiki::prep_writefile(basename($potfile),dirname($potfile));
$doc->writepo($potfile); $doc->writepo($potfile);
} #}}} }
sub refreshpofiles ($@) { #{{{ sub refreshpofiles ($@) {
my $masterfile=shift; my $masterfile=shift;
my @pofiles=@_; my @pofiles=@_;
@ -724,24 +724,24 @@ sub refreshpofiles ($@) { #{{{
or error("[po/refreshpofiles:$pofile] failed to copy the POT file"); or error("[po/refreshpofiles:$pofile] failed to copy the POT file");
} }
} }
} #}}} }
sub buildtranslationscache() { #{{{ sub buildtranslationscache() {
# use istranslation's side-effect # use istranslation's side-effect
map istranslation($_), (keys %pagesources); map istranslation($_), (keys %pagesources);
} #}}} }
sub resettranslationscache() { #{{{ sub resettranslationscache() {
undef %translations; undef %translations;
} #}}} }
sub flushmemoizecache() { #{{{ sub flushmemoizecache() {
Memoize::flush_cache("istranslatable"); Memoize::flush_cache("istranslatable");
Memoize::flush_cache("_istranslation"); Memoize::flush_cache("_istranslation");
Memoize::flush_cache("percenttranslated"); Memoize::flush_cache("percenttranslated");
} #}}} }
sub urlto_with_orig_beautiful_urlpath($$) { #{{{ sub urlto_with_orig_beautiful_urlpath($$) {
my $to=shift; my $to=shift;
my $from=shift; my $from=shift;
@ -750,9 +750,9 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath); inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
return $res; return $res;
} #}}} }
sub percenttranslated ($) { #{{{ sub percenttranslated ($) {
my $page=shift; my $page=shift;
$page=~s/^\///; $page=~s/^\///;
@ -774,9 +774,9 @@ sub percenttranslated ($) { #{{{
) or error("[po/percenttranslated:$page]: failed to translate"); ) or error("[po/percenttranslated:$page]: failed to translate");
my ($percent,$hit,$queries) = $doc->stats(); my ($percent,$hit,$queries) = $doc->stats();
return $percent; return $percent;
} #}}} }
sub languagename ($) { #{{{ sub languagename ($) {
my $code=shift; my $code=shift;
return $config{po_master_language}{name} return $config{po_master_language}{name}
@ -784,9 +784,9 @@ sub languagename ($) { #{{{
return $config{po_slave_languages}{$code} return $config{po_slave_languages}{$code}
if defined $config{po_slave_languages}{$code}; if defined $config{po_slave_languages}{$code};
return; return;
} #}}} }
sub otherlanguagesloop ($) { #{{{ sub otherlanguagesloop ($) {
my $page=shift; my $page=shift;
my @ret; my @ret;
@ -814,15 +814,15 @@ sub otherlanguagesloop ($) { #{{{
return 1 if $b->{code} eq $config{po_master_language}{code}; return 1 if $b->{code} eq $config{po_master_language}{code};
return $a->{language} cmp $b->{language}; return $a->{language} cmp $b->{language};
} @ret; } @ret;
} #}}} }
sub homepageurl (;$) { #{{{ sub homepageurl (;$) {
my $page=shift; my $page=shift;
return urlto('', $page); return urlto('', $page);
} #}}} }
sub deletetranslations ($) { #{{{ sub deletetranslations ($) {
my $deletedmasterfile=shift; my $deletedmasterfile=shift;
my $deletedmasterpage=pagename($deletedmasterfile); my $deletedmasterpage=pagename($deletedmasterfile);
@ -849,9 +849,9 @@ sub deletetranslations ($) { #{{{
gettext("removed obsolete PO files"), gettext("removed obsolete PO files"),
"IkiWiki::Plugin::po::deletetranslations"); "IkiWiki::Plugin::po::deletetranslations");
} }
} #}}} }
sub commit_and_refresh ($$) { #{{{ sub commit_and_refresh ($$) {
my ($msg, $author) = (shift, shift); my ($msg, $author) = (shift, shift);
if ($config{rcs}) { if ($config{rcs}) {
@ -872,7 +872,7 @@ sub commit_and_refresh ($$) { #{{{
IkiWiki::loadindex(); IkiWiki::loadindex();
IkiWiki::refresh(); IkiWiki::refresh();
IkiWiki::saveindex(); IkiWiki::saveindex();
} #}}} }
# ,---- # ,----
# | PageSpec's # | PageSpec's
@ -883,7 +883,7 @@ use warnings;
use strict; use strict;
use IkiWiki 2.00; use IkiWiki 2.00;
sub match_istranslation ($;@) { #{{{ sub match_istranslation ($;@) {
my $page=shift; my $page=shift;
if (IkiWiki::Plugin::po::istranslation($page)) { if (IkiWiki::Plugin::po::istranslation($page)) {
@ -892,9 +892,9 @@ sub match_istranslation ($;@) { #{{{
else { else {
return IkiWiki::FailReason->new("is not a translation page"); return IkiWiki::FailReason->new("is not a translation page");
} }
} #}}} }
sub match_istranslatable ($;@) { #{{{ sub match_istranslatable ($;@) {
my $page=shift; my $page=shift;
if (IkiWiki::Plugin::po::istranslatable($page)) { if (IkiWiki::Plugin::po::istranslatable($page)) {
@ -903,9 +903,9 @@ sub match_istranslatable ($;@) { #{{{
else { else {
return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages"); return IkiWiki::FailReason->new("is not set as translatable in po_translatable_pages");
} }
} #}}} }
sub match_lang ($$;@) { #{{{ sub match_lang ($$;@) {
my $page=shift; my $page=shift;
my $wanted=shift; my $wanted=shift;
@ -917,9 +917,9 @@ sub match_lang ($$;@) { #{{{
else { else {
return IkiWiki::SuccessReason->new("file language is $wanted"); return IkiWiki::SuccessReason->new("file language is $wanted");
} }
} #}}} }
sub match_currentlang ($$;@) { #{{{ sub match_currentlang ($$;@) {
my $page=shift; my $page=shift;
shift; shift;
my %params=@_; my %params=@_;
@ -935,6 +935,6 @@ sub match_currentlang ($$;@) { #{{{
else { else {
return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang"); return IkiWiki::FailReason->new("file language is $lang, whereas current language is $currentlang");
} }
} #}}} }
1 1