]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/po.pm
po: implemented linking/backlinks specification for po_link_to=negotiated
[git.ikiwiki.info.git] / IkiWiki / Plugin / po.pm
index cfba839958d0be0569b3b2de9316f01f2e754899..acc133042829a609f1af26ac5041770e41a2247e 100644 (file)
@@ -17,8 +17,10 @@ use File::Copy;
 use File::Spec;
 use File::Temp;
 use Memoize;
+use UNIVERSAL;
 
 my %translations;
+my @origneedsbuild;
 our %filtered;
 
 memoize("_istranslation");
@@ -35,9 +37,11 @@ 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 => "scan", id => "po", call => \&scan, last =>1);
        hook(type => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);
+       hook(type => "change", id => "po", call => \&change);
        hook(type => "editcontent", id => "po", call => \&editcontent);
 
        $origsubs{'bestlink'}=\&IkiWiki::bestlink;
@@ -46,6 +50,8 @@ sub import { #{{{
        inject(name => "IkiWiki::beautify_urlpath", call => \&mybeautify_urlpath);
        $origsubs{'targetpage'}=\&IkiWiki::targetpage;
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
+       $origsubs{'urlto'}=\&IkiWiki::urlto;
+       inject(name => "IkiWiki::urlto", call => \&myurlto);
 } #}}}
 
 sub getsetup () { #{{{
@@ -103,6 +109,9 @@ sub checkconfig () { #{{{
                        error(sprintf(gettext("Must specify %s"), $field));
                }
        }
+       if (! (keys %{$config{po_slave_languages}})) {
+               error(gettext("At least one slave language must be defined in po_slave_languages"));
+       }
        map {
                islanguagecode($_)
                        or error(sprintf(gettext("%s is not a valid language code"), $_));
@@ -146,6 +155,11 @@ sub pofile ($$) { #{{{
        return File::Spec->catpath('', $dir, $name . "." . $lang . ".po");
 } #}}}
 
+sub pofiles ($) { #{{{
+       my $masterfile=shift;
+       return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
+} #}}}
+
 sub refreshpot ($) { #{{{
        my $masterfile=shift;
 
@@ -191,61 +205,53 @@ sub refreshpofiles ($@) { #{{{
 sub needsbuild () { #{{{
        my $needsbuild=shift;
 
+       # backup @needsbuild content so that change() can know whether
+       # a given master page was rendered because its source file was changed
+       @origneedsbuild=(@$needsbuild);
+
        # build %translations, using istranslation's side-effect
-       foreach my $page (keys %pagesources) {
-               istranslation($page);
-       }
+       map istranslation($_), (keys %pagesources);
 
-       # refresh/create POT and PO files as needed
-       my $updated_po_files=0;
-       foreach my $page (keys %pagesources) {
-               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);
-                               $updated_pot_file=1;
-                       }
-                       my @pofiles;
-                       foreach my $lang (keys %{$config{po_slave_languages}}) {
-                               my $pofile=pofile($file, $lang);
-                               my $pofile_rel=pofile($pagesources{$page}, $lang);
-                               if ($pageneedsbuild || $updated_pot_file || ! -e $pofile) {
-                                       push @pofiles, $pofile;
-                                       push @$needsbuild, $pofile_rel
-                                         unless grep { $_ eq $pofile_rel } @$needsbuild;
-                               }
-                       }
-                       if (@pofiles) {
-                               refreshpofiles($file, @pofiles);
-                               map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
-                               $updated_po_files = 1;
-                       }
+       # make existing translations depend on the corresponding master page
+       foreach my $master (keys %translations) {
+               foreach my $slave (values %{$translations{$master}}) {
+                       add_depends($slave, $master);
                }
        }
+} #}}}
 
-       # check staged changes in
-       if ($updated_po_files) {
-               if ($config{rcs}) {
-                       IkiWiki::disable_commit_hook();
-                       IkiWiki::rcs_commit_staged(gettext("updated PO files"),
-                               "refreshpofiles", "127.0.0.1");
-                       IkiWiki::enable_commit_hook();
-                       IkiWiki::rcs_update();
-               }
-               # refresh module's private variables
-               undef %filtered;
-               undef %translations;
-               foreach my $page (keys %pagesources) {
-                       istranslation($page);
+sub scan (@) { #{{{
+       my %params=@_;
+       my $page=$params{page};
+       my $content=$params{content};
+
+       return unless UNIVERSAL::can("IkiWiki::Plugin::link", "import");
+       return unless $config{'po_link_to'} eq 'negotiated';
+
+       if (istranslation($page)) {
+               my ($masterpage, $curlang) = ($page =~ /(.*)[.]([a-z]{2})$/);
+               foreach my $destpage (@{$links{$page}}) {
+                       if (istranslatable($destpage)) {
+                               # replace one occurence of $destpage in $links{$page}
+                               # (we only want to replace the one that was added by
+                               # IkiWiki::Plugin::link::scan, other occurences may be
+                               # there for other reasons)
+                               for (my $i=0; $i<@{$links{$page}}; $i++) {
+                                       if (@{$links{$page}}[$i] eq $destpage) {
+                                               @{$links{$page}}[$i] = $destpage . '.' . $curlang;
+                                               last;
+                                       }
+                               }
+                       }
                }
        }
-
-       # make existing translations depend on the corresponding master page
-       foreach my $master (keys %translations) {
-               foreach my $slave (values %{$translations{$master}}) {
-                       add_depends($slave, $master);
+       elsif (! istranslatable($page) && ! istranslation($page)) {
+               foreach my $destpage (@{$links{$page}}) {
+                       if (istranslatable($destpage)) {
+                               map {
+                                       push @{$links{$page}}, $destpage . '.' . $_;
+                               } (keys %{$config{po_slave_languages}});
+                       }
                }
        }
 } #}}}
@@ -295,6 +301,22 @@ sub urlto_with_orig_beautiful_urlpath($$) { #{{{
        return $res;
 } #}}}
 
+sub myurlto ($$;$) { #{{{
+       my $to=shift;
+       my $from=shift;
+       my $absolute=shift;
+
+       # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
+       if (! length $to
+           && $config{po_link_to} eq "current"
+           && istranslation($from)
+           && istranslatable('index')) {
+               my ($masterpage, $curlang) = ($from =~ /(.*)[.]([a-z]{2})$/);
+               return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . $curlang . ".$config{htmlext}");
+       }
+       return $origsubs{'urlto'}->($to,$from,$absolute);
+} #}}}
+
 sub mybestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;
@@ -504,6 +526,54 @@ sub pagetemplate (@) { #{{{
        }
 } # }}}
 
+sub change(@) { #{{{
+       my @rendered=@_;
+
+       my $updated_po_files=0;
+
+       # Refresh/create POT and PO files as needed.
+       foreach my $page (map pagename($_), @rendered) {
+               next unless istranslatable($page);
+               my $file=srcfile($pagesources{$page});
+               my $updated_pot_file=0;
+               if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
+                   || ! -e potfile($file)) {
+                       refreshpot($file);
+                       $updated_pot_file=1;
+               }
+               my @pofiles;
+               foreach my $lang (keys %{$config{po_slave_languages}}) {
+                       my $pofile=pofile($file, $lang);
+                       if ($updated_pot_file || ! -e $pofile) {
+                               push @pofiles, $pofile;
+                       }
+               }
+               if (@pofiles) {
+                       refreshpofiles($file, @pofiles);
+                       map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
+                       $updated_po_files=1;
+               }
+       }
+
+       if ($updated_po_files) {
+               # Check staged changes in.
+               if ($config{rcs}) {
+                       IkiWiki::disable_commit_hook();
+                       IkiWiki::rcs_commit_staged(gettext("updated PO files"),
+                               "IkiWiki::Plugin::po::change", "127.0.0.1");
+                       IkiWiki::enable_commit_hook();
+                       IkiWiki::rcs_update();
+               }
+               # Reinitialize module's private variables.
+               undef %filtered;
+               undef %translations;
+               # Trigger a wiki refresh.
+               require IkiWiki::Render;
+               IkiWiki::refresh();
+               IkiWiki::saveindex();
+       }
+} #}}}
+
 sub editcontent () { #{{{
        my %params=@_;
        # as we're previewing or saving a page, the content may have