]> scripts.mit.edu Git - www/ikiwiki.git/blobdiff - IkiWiki/Plugin/po.pm
po(change): reset renamed pages status at a better time
[www/ikiwiki.git] / IkiWiki / Plugin / po.pm
index 5e2aea6911dfb9415f4c9db69abff5cc9788ce39..ae97a2f380bb9fbc0518ea865dda04bcccd5cae2 100644 (file)
@@ -23,6 +23,7 @@ my %translations;
 my @origneedsbuild;
 my %origsubs;
 
+memoize("istranslatable");
 memoize("_istranslation");
 memoize("percenttranslated");
 
@@ -34,6 +35,8 @@ sub import { #{{{
        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 => "renamepage", id => "po", call => \&renamepage);
+       hook(type => "delete", id => "po", call => \&mydelete);
        hook(type => "change", id => "po", call => \&change);
        hook(type => "editcontent", id => "po", call => \&editcontent);
 
@@ -149,6 +152,7 @@ sub needsbuild () { #{{{
        # a given master page was rendered because its source file was changed
        @origneedsbuild=(@$needsbuild);
 
+       flushmemoizecache();
        buildtranslationscache();
 
        # make existing translations depend on the corresponding master page
@@ -323,30 +327,66 @@ sub pagetemplate (@) { #{{{
        }
 } # }}}
 
+# Save information about master page rename, so that:
+# - our delete hook can ignore the translations not renamed already
+# - our change hook can rename the translations accordingly.
+#
+# FIXME:
+# This hook is called once per page linking to the old page, which
+# means our delete hook won't know it should not delete a renamed orphan
+# page's translation.
+#
+# Moreover, we can't recognize such pages at delete stage:
+# existing links are fixed in the renaming process, so every
+# renamed page's old location will be an orphan anyway at this time.
+sub renamepage(@) { #{{{
+       my %params=@_;
+       my $oldpage=$params{oldpage};
+       my $newpage=$params{newpage};
+
+       setrenamed($oldpage, $newpage) if istranslatable($oldpage);
+       return $params{content};
+} #}}}
+
+sub mydelete(@) { #{{{
+       my @deleted=@_;
+
+       map {
+               deletetranslations($_);
+       } grep { istranslatablefile($_) && ! renamed(pagename($_))} @deleted;
+} #}}}
+
 sub change(@) { #{{{
        my @rendered=@_;
 
+       my $eachrenamed=eachrenamed();
+       while (my ($oldpage, $newpage) = $eachrenamed->()) {
+               renametranslations($oldpage, $newpage);
+       }
+       resetrenamed();
+
        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});
+       foreach my $file (@rendered) {
+               next unless istranslatablefile($file);
+               my $page=pagename($file);
+               my $masterfile=srcfile($file);
                my $updated_pot_file=0;
                # Only refresh Pot file if it does not exist, or if
                # $pagesources{$page} was changed: don't if only the HTML was
                # refreshed, e.g. because of a dependency.
                if ((grep { $_ eq $pagesources{$page} } @origneedsbuild)
-                   || ! -e potfile($file)) {
-                       refreshpot($file);
+                   || ! -e potfile($masterfile)) {
+                       refreshpot($masterfile);
                        $updated_pot_file=1;
                }
                my @pofiles;
                map {
                        push @pofiles, $_ if ($updated_pot_file || ! -e $_);
-               } (pofiles($file));
+               } (pofiles($masterfile));
                if (@pofiles) {
-                       refreshpofiles($file, @pofiles);
+                       refreshpofiles($masterfile, @pofiles);
                        map { IkiWiki::rcs_add($_); } @pofiles if ($config{rcs});
                        $updated_po_files=1;
                }
@@ -486,6 +526,34 @@ sub myurlto ($$;$) { #{{{
        } #}}}
 }
 
+{
+       my %renamed;
+
+       sub renamed ($) { #{{{
+               my $page=shift;
+
+               if (exists $renamed{$page} &&
+                   defined $renamed{$page}) {
+                       return $renamed{$page};
+               }
+               return;
+       } #}}}
+
+       sub setrenamed ($$) { #{{{
+               my $oldpage=shift;
+               my $newpage=shift;
+
+               $renamed{$oldpage}=$newpage;
+       } #}}}
+
+       sub resetrenamed () { #{{{
+               undef %renamed;
+       } #}}}
+
+       sub eachrenamed () { #{{{
+               return sub { each %renamed };
+       } #}}}
+}
 
 # ,----
 # | Helper functions
@@ -499,16 +567,22 @@ sub maybe_add_leading_slash ($;$) { #{{{
        return $str;
 } #}}}
 
-sub istranslatable ($) { #{{{
-       my $page=shift;
-
-       $page=~s#^/##;
-       my $file=$pagesources{$page};
+sub istranslatablefile ($) { #{{{
+       my $file=shift;
 
        return 0 unless defined $file;
        return 0 if (defined pagetype($file) && pagetype($file) eq 'po');
        return 0 if $file =~ /\.pot$/;
-       return pagespec_match($page, $config{po_translatable_pages});
+       return 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
+       return;
+} #}}}
+
+sub istranslatable ($) { #{{{
+       my $page=shift;
+
+       $page=~s#^/##;
+       return 1 if istranslatablefile($pagesources{$page});
+       return;
 } #}}}
 
 sub _istranslation ($) { #{{{
@@ -537,8 +611,7 @@ sub istranslation ($) { #{{{
        if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
                my $hasleadingslash = ($masterpage=~s#^/##);
                $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
-               return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
-                       if istranslatable($masterpage);
+               return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
        }
        return;
 } #}}}
@@ -567,20 +640,24 @@ sub islanguagecode ($) { #{{{
        return ($code =~ /^[a-z]{2}$/);
 } #}}}
 
-sub otherlanguages($) { #{{{
+sub otherlanguage ($$) { #{{{
+       my $page=shift;
+       my $code=shift;
+
+       return masterpage($page) if $code eq $config{po_master_language}{code};
+       return masterpage($page) . '.' . $code;
+} #}}}
+
+sub otherlanguages ($) { #{{{
        my $page=shift;
 
        my %ret;
-       if (istranslatable($page)) {
-               %ret = %{$translations{$page}} if defined $translations{$page};
-       }
-       elsif (istranslation($page)) {
-               my $masterpage = masterpage($page);
-               $ret{$config{po_master_language}{code}} = $masterpage;
-               foreach my $lang (sort keys %{$translations{$masterpage}}) {
-                       next if $lang eq lang($page);
-                       $ret{$lang} = $translations{$masterpage}{$lang};
-               }
+       return \%ret unless (istranslation($page) || istranslatable($page));
+       my $curlang=lang($page);
+       foreach my $lang
+               ($config{po_master_language}{code}, keys %{$config{po_slave_languages}}) {
+               next if $lang eq $curlang;
+               $ret{$lang}=otherlanguage($page, $lang);
        }
        return \%ret;
 } #}}}
@@ -660,6 +737,7 @@ sub resettranslationscache() { #{{{
 } #}}}
 
 sub flushmemoizecache() { #{{{
+       Memoize::flush_cache("istranslatable");
        Memoize::flush_cache("_istranslation");
        Memoize::flush_cache("percenttranslated");
 } #}}}
@@ -744,6 +822,22 @@ sub homepageurl (;$) { #{{{
        return urlto('', $page);
 } #}}}
 
+# - do *not* implement this until the renamepage hook works
+# - do *not* delete translations of pages that were orphans
+#   before being renamed (see renamepage hook comments above)
+sub deletetranslations ($) { #{{{
+       my $deletedmasterfile=shift;
+
+       debug "po(deletetranslations): TODO: delete translations of $deletedmasterfile";
+} #}}}
+
+sub renametranslations (@) { #{{{
+       my ($oldpage, $newpage)=shift;
+
+       debug "po(renametranslations): TODO: rename translations of $oldpage to $newpage";
+} #}}}
+
+
 # ,----
 # | PageSpec's
 # `----