]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
first pass over code
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index fa250f3a4991c4b56798a9f775130324f9b68088..ac56041cfbe00f00e0c371ba3cd8b41cb3ed1637 100644 (file)
@@ -18,30 +18,37 @@ use Memoize;
 
 my %translations;
 our %filtered;
-my $origbestlink=\&bestlink;
+
 ## 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");
 
-sub import {
+# backup references to subs that will be overriden
+my %origsubs;
+
+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 => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate);
+
+       $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",
@@ -89,11 +96,11 @@ sub checkconfig () { #{{{
        }
        if (! exists $config{po_link_to} ||
            ! defined $config{po_link_to}) {
-           $config{po_link_to}="default";
+               $config{po_link_to}="default";
        }
        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"));
@@ -103,6 +110,7 @@ sub checkconfig () { #{{{
 
 sub potfile ($) { #{{{
        my $masterfile=shift;
+
        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
        return File::Spec->catfile($dir, $name . ".pot");
 } #}}}
@@ -110,12 +118,14 @@ sub potfile ($) { #{{{
 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");
 } #}}}
 
 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);
@@ -128,6 +138,7 @@ sub refreshpot ($) { #{{{
        # 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);
@@ -142,8 +153,7 @@ sub refreshpofiles ($@) { #{{{
 
        foreach my $pofile (@pofiles) {
                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 {
@@ -197,14 +207,13 @@ sub needsbuild () { #{{{
                IkiWiki::refresh();
                IkiWiki::saveindex();
                # refresh module's private variables
-               %filtered=undef;
-               %translations=undef;
+               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}}) {
@@ -213,14 +222,13 @@ sub needsbuild () { #{{{
        }
 } #}}}
 
-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 {
@@ -235,22 +243,35 @@ 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!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
        }
-       return $url;
+       return $res;
+} #}}}
+
+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=$origbestlink->($page, $link);
+
+       my $res=$origsubs{'bestlink'}->($page, $link);
        if (length $res) {
                if ($config{po_link_to} eq "current"
                    && istranslatable($res)
@@ -269,12 +290,13 @@ sub mybestlink ($$) { #{{{
 # since other plugins 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
+       # 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;
        }
@@ -286,8 +308,8 @@ sub filter (@) { #{{{
        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,
@@ -297,6 +319,7 @@ sub filter (@) { #{{{
        ) or error("[po/filter:$file]: failed to translate");
        my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
        my $tmpout = $tmpfh->filename;
+       # XXX is there any way to avoid the useless write to a temp file? --Joey
        $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
        $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
        $filtered{$page}{$destpage}=1;
@@ -305,6 +328,7 @@ sub filter (@) { #{{{
 
 sub htmlize (@) { #{{{
        my %params=@_;
+
        my $page = $params{page};
        my $content = $params{content};
        my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
@@ -316,7 +340,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});
@@ -324,8 +349,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,
@@ -339,6 +364,7 @@ sub percenttranslated ($) { #{{{
 
 sub otherlanguages ($) { #{{{
        my $page=shift;
+
        my @ret;
        if (istranslatable($page)) {
                foreach my $lang (sort keys %{$translations{$page}}) {
@@ -354,7 +380,7 @@ sub otherlanguages ($) { #{{{
        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,
@@ -374,6 +400,8 @@ sub otherlanguages ($) { #{{{
 sub pagetemplate (@) { #{{{
        my %params=@_;
         my $page=$params{page};
+
+        my $destpage=$params{destpage};
         my $template=$params{template};
 
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
@@ -400,10 +428,29 @@ sub pagetemplate (@) { #{{{
                        }
                }
        }
+       # 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)) {
+               my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               $template->param('discussionlink' => htmllink(
+                                                       $page,
+                                                       $destpage,
+                                                       $masterpage . '/' . gettext("Discussion"),
+                                                       noimageinline => 1,
+                                                       forcesubpage => 0,
+                                                       linktext => gettext("Discussion"),
+                                                       ));
+       }
 } # }}}
 
 sub istranslatable ($) { #{{{
        my $page=shift;
+
        my $file=$pagesources{$page};
 
        if (! defined $file
@@ -416,6 +463,7 @@ sub istranslatable ($) { #{{{
 
 sub _istranslation ($) { #{{{
        my $page=shift;
+
        my $file=$pagesources{$page};
        if (! defined $file) {
                return IkiWiki::FailReason->new("no file specified");
@@ -441,6 +489,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};
@@ -456,6 +505,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");
        }
@@ -466,6 +516,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");
        }
@@ -477,6 +528,7 @@ sub match_istranslatable ($;@) { #{{{
 sub match_lang ($$;@) { #{{{
        my $page=shift;
        my $wanted=shift;
+
        my $regexp=IkiWiki::glob2re($wanted);
        my $lang;
        my $masterpage;
@@ -498,6 +550,7 @@ sub match_lang ($$;@) { #{{{
 
 sub match_currentlang ($$;@) { #{{{
        my $page=shift;
+
        shift;
        my %params=@_;
        my ($currentmasterpage, $currentlang, $masterpage, $lang);