]> scripts.mit.edu Git - www/ikiwiki.git/blobdiff - IkiWiki/Plugin/po.pm
po: delete translations of deleted master pages
[www/ikiwiki.git] / IkiWiki / Plugin / po.pm
index 7deddf9abad71cd053dbb7e3887ccda9d556885d..515809f70dfd99ad334cb32d32db7cc8d22c6fd5 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 => "rename", id => "po", call => \&renamepages);
+       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
@@ -262,10 +266,14 @@ sub htmlize (@) { #{{{
 
        my $page = $params{page};
        my $content = $params{content};
-       my $masterfile = srcfile($pagesources{masterpage($page)});
+
+       # ignore PO files this plugin did not create
+       return $content unless istranslation($page);
 
        # force content to be htmlize'd as if it was the same type as the master page
-       return IkiWiki::htmlize($page, $page, pagetype($masterfile), $content);
+       return IkiWiki::htmlize($page, $page,
+                               pagetype(srcfile($pagesources{masterpage($page)})),
+                               $content);
 } #}}}
 
 sub pagetemplate (@) { #{{{
@@ -285,6 +293,9 @@ sub pagetemplate (@) { #{{{
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
        }
+       if ($template->query(name => "HOMEPAGEURL")) {
+               $template->param(homepageurl => homepageurl($page));
+       }
        if ($template->query(name => "otherlanguages")) {
                $template->param(otherlanguages => [otherlanguagesloop($page)]);
                map add_depends($page, $_), (values %{otherlanguages($page)});
@@ -316,58 +327,79 @@ sub pagetemplate (@) { #{{{
        }
 } # }}}
 
+# Add the renamed page translations to the list of to-be-renamed pages.
+# 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.
+sub renamepages() { #{{{
+       my $torename=shift;
+       my @torename=@{$torename};
+
+       foreach my $rename (@torename) {
+               next unless istranslatable($rename->{src});
+               my %otherpages=%{otherlanguages($rename->{src})};
+               while (my ($lang, $otherpage) = each %otherpages) {
+                       push @{$torename}, {
+                               src => $otherpage,
+                               srcfile => $pagesources{$otherpage},
+                               dest => otherlanguage($rename->{dest}, $lang),
+                               destfile => $rename->{dest}.".".$lang.".po",
+                               required => 0,
+                       };
+               }
+       }
+} #}}}
+
+sub mydelete(@) { #{{{
+       my @deleted=@_;
+
+       map {
+               deletetranslations($_);
+       } grep { istranslatablefile($_) } @deleted;
+} #}}}
+
 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});
+       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;
                }
        }
 
        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.
-               resetalreadyfiltered();
-               resettranslationscache();
-               # Trigger a wiki refresh.
-               require IkiWiki::Render;
-               IkiWiki::refresh();
-               IkiWiki::saveindex();
+               commit_and_refresh(
+                       gettext("updated PO files"),
+                       "IkiWiki::Plugin::po::change");
        }
 } #}}}
 
+# As we're previewing or saving a page, the content may have
+# changed, so tell the next filter() invocation it must not be lazy.
 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
+
        unsetalreadyfiltered($params{page}, $params{page});
        return $params{content};
 } #}}}
@@ -377,22 +409,19 @@ sub editcontent () { #{{{
 # | Injected functions
 # `----
 
+# Implement po_link_to 'current' and 'negotiated' settings.
 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)) {
-                       return $res . "." . lang($page);
-               }
-               else {
-                       return $res;
-               }
+       my $res=$origsubs{'bestlink'}->(masterpage($page), $link);
+       if (length $res
+           && ($config{po_link_to} eq "current" || $config{po_link_to} eq "negotiated")
+           && istranslatable($res)
+           && istranslation($page)) {
+               return $res . "." . lang($page);
        }
-       return "";
+       return $res;
 } #}}}
 
 sub mybeautify_urlpath ($) { #{{{
@@ -401,6 +430,10 @@ sub mybeautify_urlpath ($) { #{{{
        my $res=$origsubs{'beautify_urlpath'}->($url);
        if ($config{po_link_to} eq "negotiated") {
                $res =~ s!/\Qindex.$config{po_master_language}{code}.$config{htmlext}\E$!/!;
+               $res =~ s!/\Qindex.$config{htmlext}\E$!/!;
+               map {
+                       $res =~ s!/\Qindex.$_.$config{htmlext}\E$!/!;
+               } (keys %{$config{po_slave_languages}});
        }
        return $res;
 } #}}}
@@ -409,7 +442,7 @@ sub mytargetpage ($$) { #{{{
        my $page=shift;
        my $ext=shift;
 
-       if (istranslation($page)) {
+       if (istranslation($page) || istranslatable($page)) {
                my ($masterpage, $lang) = (masterpage($page), lang($page));
                if (! $config{usedirs} || $masterpage eq 'index') {
                        return $masterpage . "." . $lang . "." . $ext;
@@ -418,14 +451,6 @@ sub mytargetpage ($$) { #{{{
                        return $masterpage . "/index." . $lang . "." . $ext;
                }
        }
-       elsif (istranslatable($page)) {
-               if (! $config{usedirs} || $page eq 'index') {
-                       return $page . "." . $config{po_master_language}{code} . "." . $ext;
-               }
-               else {
-                       return $page . "/index." . $config{po_master_language}{code} . "." . $ext;
-               }
-       }
        return $origsubs{'targetpage'}->($page, $ext);
 } #}}}
 
@@ -437,7 +462,6 @@ sub myurlto ($$;$) { #{{{
        # workaround hard-coded /index.$config{htmlext} in IkiWiki::urlto()
        if (! length $to
            && $config{po_link_to} eq "current"
-           && istranslation($from)
            && istranslatable('index')) {
                return IkiWiki::beautify_urlpath(IkiWiki::baseurl($from) . "index." . lang($from) . ".$config{htmlext}");
        }
@@ -481,56 +505,63 @@ sub myurlto ($$;$) { #{{{
        } #}}}
 }
 
-
 # ,----
 # | Helper functions
 # `----
 
+sub maybe_add_leading_slash ($;$) { #{{{
+       my $str=shift;
+       my $add=shift;
+       $add=1 unless defined $add;
+       return '/' . $str if $add;
+       return $str;
+} #}}}
+
+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 1 if pagespec_match(pagename($file), $config{po_translatable_pages});
+       return;
+} #}}}
+
 sub istranslatable ($) { #{{{
        my $page=shift;
 
-       my $file=$pagesources{$page};
-
-       if (! defined $file
-           || (defined pagetype($file) && pagetype($file) eq 'po')
-           || $file =~ /\.pot$/) {
-               return 0;
-       }
-       return pagespec_match($page, $config{po_translatable_pages});
+       $page=~s#^/##;
+       return 1 if istranslatablefile($pagesources{$page});
+       return;
 } #}}}
 
 sub _istranslation ($) { #{{{
        my $page=shift;
 
+       my $hasleadingslash = ($page=~s#^/##);
        my $file=$pagesources{$page};
-       if (! defined $file) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
-
-       if (! defined $file
-           || ! defined pagetype($file)
-           || ! pagetype($file) eq 'po'
-           || $file =~ /\.pot$/) {
-               return 0;
-       }
+       return 0 unless (defined $file
+                        && defined pagetype($file)
+                        && pagetype($file) eq 'po');
+       return 0 if $file =~ /\.pot$/;
 
        my ($masterpage, $lang) = ($page =~ /(.*)[.]([a-z]{2})$/);
-       if (! defined $masterpage || ! defined $lang
-           || ! (length($masterpage) > 0) || ! (length($lang) > 0)
-           || ! defined $pagesources{$masterpage}
-           || ! defined $config{po_slave_languages}{$lang}) {
-               return 0;
-       }
+       return 0 unless (defined $masterpage && defined $lang
+                        && length $masterpage && length $lang
+                        && defined $pagesources{$masterpage}
+                        && defined $config{po_slave_languages}{$lang});
 
-       return ($masterpage, $lang) if istranslatable($masterpage);
+       return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang)
+               if istranslatable($masterpage);
 } #}}}
 
 sub istranslation ($) { #{{{
        my $page=shift;
 
        if (1 < (my ($masterpage, $lang) = _istranslation($page))) {
+               my $hasleadingslash = ($masterpage=~s#^/##);
                $translations{$masterpage}{$lang}=$page unless exists $translations{$masterpage}{$lang};
-               return ($masterpage, $lang);
+               return (maybe_add_leading_slash($masterpage, $hasleadingslash), $lang);
        }
        return;
 } #}}}
@@ -555,23 +586,28 @@ sub lang ($) { #{{{
 
 sub islanguagecode ($) { #{{{
        my $code=shift;
+
        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}};
-       }
-       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;
 } #}}}
@@ -595,6 +631,7 @@ sub pofile ($$) { #{{{
 
 sub pofiles ($) { #{{{
        my $masterfile=shift;
+
        return map pofile($masterfile, $_), (keys %{$config{po_slave_languages}});
 } #}}}
 
@@ -649,6 +686,12 @@ sub resettranslationscache() { #{{{
        undef %translations;
 } #}}}
 
+sub flushmemoizecache() { #{{{
+       Memoize::flush_cache("istranslatable");
+       Memoize::flush_cache("_istranslation");
+       Memoize::flush_cache("percenttranslated");
+} #}}}
+
 sub urlto_with_orig_beautiful_urlpath($$) { #{{{
        my $to=shift;
        my $from=shift;
@@ -709,7 +752,7 @@ sub otherlanguagesloop ($) { #{{{
                }
                else {
                        push @ret, {
-                               url => urlto($otherpage, $page),
+                               url => urlto_with_orig_beautiful_urlpath($otherpage, $page),
                                code => $lang,
                                language => languagename($lang),
                                percent => percenttranslated($otherpage),
@@ -723,6 +766,63 @@ sub otherlanguagesloop ($) { #{{{
                } @ret;
 } #}}}
 
+sub homepageurl (;$) { #{{{
+       my $page=shift;
+
+       return urlto('', $page);
+} #}}}
+
+sub deletetranslations ($) { #{{{
+       my $deletedmasterfile=shift;
+
+       my $deletedmasterpage=pagename($deletedmasterfile);
+       my @todelete;
+       map {
+               my $file = newpagefile($deletedmasterpage.'.'.$_, 'po');
+               my $absfile = "$config{srcdir}/$file";
+               if (-e $absfile && ! -l $absfile && ! -d $absfile) {
+                       push @todelete, $file;
+               }
+       } keys %{$config{po_slave_languages}};
+
+       map {
+               if ($config{rcs}) {
+                       IkiWiki::rcs_remove($_);
+               }
+               else {
+                       IkiWiki::prune("$config{srcdir}/$_");
+               }
+       } @todelete;
+
+       if (scalar @todelete) {
+               commit_and_refresh(
+                       gettext("removed obsolete PO files"),
+                       "IkiWiki::Plugin::po::deletetranslations");
+       }
+} #}}}
+
+sub commit_and_refresh ($$) { #{{{
+       my ($msg, $author) = (shift, shift);
+
+       if ($config{rcs}) {
+               IkiWiki::disable_commit_hook();
+               IkiWiki::rcs_commit_staged($msg, $author, "127.0.0.1");
+               IkiWiki::enable_commit_hook();
+               IkiWiki::rcs_update();
+       }
+       # Reinitialize module's private variables.
+       resetalreadyfiltered();
+       resettranslationscache();
+       flushmemoizecache();
+       # Trigger a wiki refresh.
+       require IkiWiki::Render;
+       # without preliminary saveindex/loadindex, refresh()
+       # complains about a lot of uninitialized variables
+       IkiWiki::saveindex();
+       IkiWiki::loadindex();
+       IkiWiki::refresh();
+       IkiWiki::saveindex();
+} #}}}
 
 # ,----
 # | PageSpec's