rename function for clarity, formatting improvements

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

diff --git a/IkiWiki/Plugin/po.pm b/IkiWiki/Plugin/po.pm
index da5812ebdc9506f1a77a0988438d1d43d99a2936..f25beba7236c69c742686d0f7ade6daa0f24a25d 100644 (file)
--- a/IkiWiki/Plugin/po.pm
+++ b/IkiWiki/Plugin/po.pm
@@ -36,7 +36,6 @@ 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 => "filter", id => "po", call => \&filter);
        hook(type => "htmlize", id => "po", call => \&htmlize);
        hook(type => "pagetemplate", id => "po", call => \&pagetemplate, last => 1);

-       hook(type => "postscan", id => "po", call => \&postscan);

        hook(type => "rename", id => "po", call => \&renamepages, first => 1);
        hook(type => "delete", id => "po", call => \&mydelete);
        hook(type => "change", id => "po", call => \&change);
        hook(type => "rename", id => "po", call => \&renamepages, first => 1);
        hook(type => "delete", id => "po", call => \&mydelete);
        hook(type => "change", id => "po", call => \&change);


@@ -55,8 +54,6 @@ sub import {
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
        $origsubs{'urlto'}=\&IkiWiki::urlto;
        inject(name => "IkiWiki::urlto", call => \&myurlto);
        inject(name => "IkiWiki::targetpage", call => \&mytargetpage);
        $origsubs{'urlto'}=\&IkiWiki::urlto;
        inject(name => "IkiWiki::urlto", call => \&myurlto);

-       $origsubs{'nicepagetitle'}=\&IkiWiki::nicepagetitle;
-       inject(name => "IkiWiki::nicepagetitle", call => \&mynicepagetitle);

        $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
        inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
 }
        $origsubs{'cgiurl'}=\&IkiWiki::cgiurl;
        inject(name => "IkiWiki::cgiurl", call => \&mycgiurl);
 }


@@ -119,13 +116,6 @@ sub getsetup () {
                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },

-               po_translation_status_in_links => {
-                       type => "boolean",
-                       example => 1,
-                       description => "display translation status in links to translations",
-                       safe => 1,
-                       rebuild => 1,
-               },

 }
 
 sub checkconfig () {
 }
 
 sub checkconfig () {


@@ -162,10 +152,6 @@ sub checkconfig () {
                warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
                $config{po_link_to}='default';
        }
                warn(gettext('po_link_to=negotiated requires usedirs to be enabled, falling back to po_link_to=default'));
                $config{po_link_to}='default';
        }

-       if (! exists $config{po_translation_status_in_links} ||
-           ! defined $config{po_translation_status_in_links}) {
-               $config{po_translation_status_in_links}=1;
-       }

        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 }
 
        push @{$config{wiki_file_prune_regexps}}, qr/\.pot$/;
 }
 


@@ -266,7 +252,7 @@ sub pagetemplate (@) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {
                $template->param(percenttranslated => percenttranslated($page));
        }
        if ($template->query(name => "istranslation")) {

-               $template->param(istranslation => istranslation($page));
+               $template->param(istranslation => scalar istranslation($page));

        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));
        }
        if ($template->query(name => "istranslatable")) {
                $template->param(istranslatable => istranslatable($page));


@@ -305,48 +291,41 @@ sub pagetemplate (@) {
        }
 } # }}}
 
        }
 } # }}}
 

-sub postscan (@) {
-       my %params = @_;
-       my $page = $params{page};
-
-       # backlinks involve back-dependencies, so that nicepagetitle effects,
-       # such as translation status displayed in links, are updated
-       use IkiWiki::Render;
-       map add_depends($page, $_), keys %{$IkiWiki::backlinks{$page}};
-}
-

 # Add the renamed page translations to the list of to-be-renamed pages.
 # Add the renamed page translations to the list of to-be-renamed pages.

-sub renamepages($$$) {
-       my ($torename, $cgi, $session) = (shift, shift, shift);
+sub renamepages(@) {
+       my %params = @_;

 
 

-       # copy the initial array, so that we can iterate on it AND
-       # modify it at the same time, without iterating on the items we
-       # pushed on it ourselves
-       my @torename=@{$torename};
+       my %torename = %{$params{torename}};
+       my $session = $params{session};

 
        # Save the page(s) the user asked to rename, so that our
        # canrename hook can tell the difference between:
        #  - a translation being renamed as a consequence of its master page
        #    being renamed
        #  - a user trying to directly rename a translation
 
        # Save the page(s) the user asked to rename, so that our
        # canrename hook can tell the difference between:
        #  - a translation being renamed as a consequence of its master page
        #    being renamed
        #  - a user trying to directly rename a translation

-       # This is why this hook has to be run first, before @torename is modified
-       # by other plugins.
-       $session->param(po_orig_torename => [ @torename ]);
+       # This is why this hook has to be run first, before the list of pages
+       # to rename is modified by other plugins.
+       my @orig_torename;
+       @orig_torename=@{$session->param("po_orig_torename")}
+               if defined $session->param("po_orig_torename");
+       push @orig_torename, $torename{src};
+       $session->param(po_orig_torename => \@orig_torename);

        IkiWiki::cgi_savesession($session);
 
        IkiWiki::cgi_savesession($session);
 

-       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,
-                       };
-               }
+       return () unless istranslatable($torename{src});
+
+       my @ret;
+       my %otherpages=%{otherlanguages($torename{src})};
+       while (my ($lang, $otherpage) = each %otherpages) {
+               push @ret, {
+                       src => $otherpage,
+                       srcfile => $pagesources{$otherpage},
+                       dest => otherlanguage($torename{dest}, $lang),
+                       destfile => $torename{dest}.".".$lang.".po",
+                       required => 0,
+               };

        }
        }

+       return @ret;

 }
 
 sub mydelete(@) {
 }
 
 sub mydelete(@) {


@@ -442,19 +421,19 @@ sub checkcontent (@) {
        return undef;
 }
 
        return undef;
 }
 

-sub canremove ($$$) {
-       my ($page, $cgi, $session) = (shift, shift, shift);
+sub canremove (@) {
+       my %params = @_;

 
 

-       if (istranslation($page)) {
+       if (istranslation($params{page})) {

                return gettext("Can not remove a translation. Removing the master page, ".
                               "though, removes its translations as well.");
        }
        return undef;
 }
 
                return gettext("Can not remove a translation. Removing the master page, ".
                               "though, removes its translations as well.");
        }
        return undef;
 }
 

-sub canrename ($$@) {
-       my ($cgi, $session) = (shift, shift);
+sub canrename (@) {

        my %params = @_;
        my %params = @_;

+       my $session = $params{session};

 
        if (istranslation($params{src})) {
                my $masterpage = masterpage($params{src});
 
        if (istranslation($params{src})) {
                my $masterpage = masterpage($params{src});


@@ -465,7 +444,7 @@ sub canrename ($$@) {
                # by looking for the master page in the list of to-be-renamed pages we
                # saved early in the renaming process.
                my $orig_torename = $session->param("po_orig_torename");
                # by looking for the master page in the list of to-be-renamed pages we
                # saved early in the renaming process.
                my $orig_torename = $session->param("po_orig_torename");

-               unless (grep { $_->{src} eq $masterpage } @{$orig_torename}) {
+               unless (grep { $_ eq $masterpage } @{$orig_torename}) {

                        return gettext("Can not rename a translation. Renaming the master page, ".
                                       "though, renames its translations as well.");
                }
                        return gettext("Can not rename a translation. Renaming the master page, ".
                                       "though, renames its translations as well.");
                }


@@ -621,18 +600,6 @@ sub myurlto ($$;$) {
        }
 }
 
        }
 }
 

-sub mynicepagetitle ($;$) {
-       my ($page, $unescaped) = (shift, shift);
-
-       my $res = $origsubs{'nicepagetitle'}->($page, $unescaped);
-       return $res unless istranslation($page);
-       return $res unless $config{po_translation_status_in_links};
-       my @caller = caller(1);
-       return $res if (exists $caller[3] && defined $caller[3]
-                       && $caller[3] eq "IkiWiki::Plugin::parentlinks::parentlinks");
-       return $res.' ('.percenttranslated($page).' %)';
-}
-

 sub mycgiurl (@) {
        my %params=@_;
 
 sub mycgiurl (@) {
        my %params=@_;