Merge commit 'upstream/master' into prv/po

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index 4608f59c7d2ffb8b1124e5f1e01133f5daf1be55..936fe3c491d34250ce1b46e5ca32101083df9435 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -19,11 +19,12 @@ use Memoize;
 my %translations;
 our %filtered;
 
 my %translations;
 our %filtered;
 

-## 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");
 memoize("_istranslation");
 memoize("percenttranslated");

+# FIXME: memoizing istranslatable() makes some test cases fail once every
+# two tries; this may be related to the artificial way the testsuite is
+# run, or not.
+# memoize("istranslatable");

 
 # backup references to subs that will be overriden
 my %origsubs;
 
 # backup references to subs that will be overriden
 my %origsubs;


@@ -37,7 +38,8 @@ sub import {
        hook(type => "needsbuild", id => "po", call => \&needsbuild);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "needsbuild", id => "po", call => \&needsbuild);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);

-       hook(type => "pagetemplate", id => "po", call => \&pagetemplate);
+       hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
+       hook(type => "editcontent", id => "po", call => \&editcontent);

        inject(name => "IkiWiki::bestlink", call => \&mybestlink);
        inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
        inject(name => "IkiWiki::bestlink", call => \&mybestlink);
        inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);


@@ -110,14 +112,16 @@ sub checkconfig () { #{{{
 sub potfile ($) { #{{{
        my $masterfile=shift;
        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 sub potfile ($) { #{{{
        my $masterfile=shift;
        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);

-       return File::Spec->catfile($dir, $name . ".pot");
+       $dir='' if $dir eq './';
+       return File::Spec->catpath('', $dir, $name . ".pot");

 } #}}}
 
 sub pofile ($$) { #{{{
        my $masterfile=shift;
        my $lang=shift;
        (my $name, my $dir, my $suffix) = fileparse($masterfile, qr/\.[^.]*/);
 } #}}}
 
 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");
+       $dir='' if $dir eq './';
+       return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");

 } #}}}
 
 sub refreshpot ($) { #{{{
 } #}}}
 
 sub refreshpot ($) { #{{{


@@ -134,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);
        # 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);
        # do the actual work
        $doc->parse;
        $doc->writepo($potfile);


@@ -170,17 +175,22 @@ sub needsbuild () { #{{{
        # refresh/create POT and PO files as needed
        my $updated_po_files=0;
        foreach my $page (keys %pagesources) {
        # refresh/create POT and PO files as needed
        my $updated_po_files=0;
        foreach my $page (keys %pagesources) {

-               my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;

                if (istranslatable($page)) {
                if (istranslatable($page)) {

+                       my $pageneedsbuild = grep { $_ eq $pagesources{$page} } @$needsbuild;
+                       my $updated_pot_file=0;

                        my $file=srcfile($pagesources{$page});
                        if ($pageneedsbuild || ! -e potfile($file)) {
                                refreshpot($file);
                        my $file=srcfile($pagesources{$page});
                        if ($pageneedsbuild || ! -e potfile($file)) {
                                refreshpot($file);

+                               $updated_pot_file=1;

                        }
                        my @pofiles;
                        foreach my $lang (keys %{$config{po_slave_languages}}) {
                                my $pofile=pofile($file, $lang);
                        }
                        my @pofiles;
                        foreach my $lang (keys %{$config{po_slave_languages}}) {
                                my $pofile=pofile($file, $lang);

-                               if ($pageneedsbuild || ! -e $pofile) {
+                               my $pofile_rel=pofile($pagesources{$page}, $lang);
+                               if ($pageneedsbuild || $updated_pot_file || ! -e $pofile) {

                                        push @pofiles, $pofile;
                                        push @pofiles, $pofile;

+                                       push @$needsbuild, $pofile_rel
+                                         unless grep { $_ eq $pofile_rel } @$needsbuild;

                                }
                        }
                        if (@pofiles) {
                                }
                        }
                        if (@pofiles) {


@@ -191,7 +201,7 @@ sub needsbuild () { #{{{
                }
        }
 
                }
        }
 

-       # check staged changes in and trigger a wiki refresh.
+       # check staged changes in

        if ($updated_po_files) {
                if ($config{rcs}) {
                        IkiWiki::disable_commit_hook();
        if ($updated_po_files) {
                if ($config{rcs}) {
                        IkiWiki::disable_commit_hook();


@@ -200,17 +210,14 @@ sub needsbuild () { #{{{
                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }
                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }

-               IkiWiki::refresh();
-               IkiWiki::saveindex();

                # refresh module's private variables
                # refresh module's private variables

-               %filtered=undef;
-               %translations=undef;
+               undef %filtered;
+               undef %translations;

                foreach my $page (keys %pagesources) {
                        istranslation($page);
                }
        }
 
                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}}) {
        # make existing translations depend on the corresponding master page
        foreach my $master (keys %translations) {
                foreach my $slave (values %{$translations{$master}}) {


@@ -225,7 +232,7 @@ sub mytargetpage ($$) { #{{{
 
        if (istranslation($page)) {
                my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 
        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 {
                        return $masterpage . "." . $lang . "." . $ext;
                }
                else {


@@ -252,6 +259,17 @@ sub mybeautify_urlpath ($) { #{{{
        return $res;
 } #}}}
 
        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;
 sub mybestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;


@@ -270,25 +288,31 @@ sub mybestlink ($$) { #{{{
        return "";
 } #}}}
 
        return "";
 } #}}}
 

-# We use filter to convert PO to the master page's type,
-# since other plugins should not work on PO files
+# 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 (@) { #{{{
        my %params = @_;
        my $page = $params{page};
        my $destpage = $params{destpage};
        my $content = decode_utf8(encode_utf8($params{content}));
 
 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
-       if (! istranslation($page) || $filtered{$page}{$destpage}) {
-               return $content;
-       }
+       return $content if ( ! istranslation($page)
+                            || ( exists $filtered{$page}{$destpage}
+                                 && $filtered{$page}{$destpage} eq 1 ));
+
+       # CRLF line terminators make poor Locale::Po4a feel bad
+       $content=~s/\r\n/\n/g;
+
+       # Locale::Po4a needs an input file, and I'm too lazy to learn
+       # how to disguise a variable as a file
+       my $infile = File::Temp->new(TEMPLATE => "ikiwiki-po-filter-in.XXXXXXXXXX",
+                                    TMPDIR => 1)->filename;
+       writefile(basename($infile), File::Spec->tmpdir, $content);

 
        my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
 
        my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);

-       my $file=srcfile(exists $params{file} ? $params{file} : $IkiWiki::pagesources{$page});

        my $masterfile = srcfile($pagesources{$masterpage});
        my (@pos,@masters);
        my $masterfile = srcfile($pagesources{$masterpage});
        my (@pos,@masters);

-       push @pos,$file;
+       push @pos,$infile;

        push @masters,$masterfile;
        my %options = (
                        "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,
        push @masters,$masterfile;
        my %options = (
                        "markdown" => (pagetype($masterfile) eq 'mdwn') ? 1 : 0,


@@ -299,11 +323,11 @@ sub filter (@) { #{{{
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',
                'file_in_name'  => \@masters,
                'file_in_charset'  => 'utf-8',
                'file_out_charset' => 'utf-8',

-       ) or error("[po/filter:$file]: failed to translate");
-       my $tmpfh = File::Temp->new(TEMPLATE => "/tmp/ikiwiki-po-filter-out.XXXXXXXXXX");
-       my $tmpout = $tmpfh->filename;
-       $doc->write($tmpout) or error("[po/filter:$file] could not write $tmpout");
-       $content = readfile($tmpout) or error("[po/filter:$file] could not read $tmpout");
+       ) or error("[po/filter:$infile]: failed to translate");
+       my $tmpout = File::Temp->new(TEMPLATE => "ikiwiki-po-filter-out.XXXXXXXXXX",
+                                    TMPDIR => 1)->filename;
+       $doc->write($tmpout) or error("[po/filter:$infile] could not write $tmpout");
+       $content = readfile($tmpout) or error("[po/filter:$infile] could not read $tmpout");

        $filtered{$page}{$destpage}=1;
        return $content;
 } #}}}
        $filtered{$page}{$destpage}=1;
        return $content;
 } #}}}


@@ -359,7 +383,7 @@ sub otherlanguages ($) { #{{{
        elsif (istranslation($page)) {
                my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
                push @ret, {
        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,
                        code => $config{po_master_language}{code},
                        language => $config{po_master_language}{name},
                        master => 1,


@@ -378,8 +402,10 @@ sub otherlanguages ($) { #{{{
 
 sub pagetemplate (@) { #{{{
        my %params=@_;
 
 sub pagetemplate (@) { #{{{
        my %params=@_;

-        my $page=$params{page};
-        my $template=$params{template};
+       my $page=$params{page};
+       my $destpage=$params{destpage};
+       my $template=$params{template};
+       my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/) if istranslation($page);

 
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
                $template->param(percenttranslated => percenttranslated($page));
 
        if (istranslation($page) && $template->query(name => "percenttranslated")) {
                $template->param(percenttranslated => percenttranslated($page));


@@ -398,15 +424,47 @@ sub pagetemplate (@) { #{{{
                        }
                }
                elsif (istranslation($page)) {
                        }
                }
                elsif (istranslation($page)) {

-                       my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);

                        add_depends($page, $masterpage);
                        foreach my $translation (values %{$translations{$masterpage}}) {
                                add_depends($page, $translation);
                        }
                }
        }
                        add_depends($page, $masterpage);
                        foreach my $translation (values %{$translations{$masterpage}}) {
                                add_depends($page, $translation);
                        }
                }
        }

+       # 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)) {
+               $template->param('discussionlink' => htmllink(
+                                                       $page,
+                                                       $destpage,
+                                                       $masterpage . '/' . gettext("Discussion"),
+                                                       noimageinline => 1,
+                                                       forcesubpage => 0,
+                                                       linktext => gettext("Discussion"),
+                                                       ));
+       }
+       # remove broken parentlink to ./index.html on home page's translations
+       if ($template->param('parentlinks')
+           && istranslation($page)
+           && $masterpage eq "index") {
+               $template->param('parentlinks' => []);
+       }

 } # }}}
 
 } # }}}
 

+sub editcontent () { #{{{
+       my %params=@_;
+       # as we're previewing or saving a page, the content may have
+       # changed, so tell the next filter() invocation it must not be lazy
+       if (exists $filtered{$params{page}}{$params{page}}) {
+               delete $filtered{$params{page}}{$params{page}};
+       }
+       return $params{content};
+} #}}}
+

 sub istranslatable ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};
 sub istranslatable ($) { #{{{
        my $page=shift;
        my $file=$pagesources{$page};