po plugin: slave pages link to the master's discussion page

[ikiwiki.git] / IkiWiki / Plugin / po.pm

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index f535ebd397d73b23042b522e1aa8cd2b8178e31c..9dda8c0db29d8116acb7e4417276865bbe462897 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -18,20 +18,29 @@ use Memoize;
 
 my %translations;
 our %filtered;
-memoize("istranslatable");
+
+## 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");
 
+# 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);
+       inject(name => "IkiWiki::bestlink", call => \&mybestlink);
+       inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
+       inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
 }
 
 sub getsetup () { #{{{
@@ -125,6 +134,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);
@@ -194,8 +204,8 @@ 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);
                }
@@ -210,14 +220,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 {
@@ -232,29 +241,45 @@ 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 "";
 } #}}}
 
 # We use filter to convert PO to the master page's type,
@@ -346,7 +371,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,
@@ -366,6 +391,7 @@ 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")) {
@@ -392,6 +418,24 @@ 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 ($) { #{{{