]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/rename.pm
projects / git.ikiwiki.info.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Added a comment
[git.ikiwiki.info.git] / IkiWiki / Plugin / rename.pm
diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index 4ee377b86c5b5f500eb6acd1323fa174cf4ba709..8e32d41aecfd58934fc7353612c680162abd2914 100644 (file)
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -3,25 +3,26 @@ package IkiWiki::Plugin::rename;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 
-sub import { #{{{
+sub import {
        hook(type => "getsetup", id => "rename", call => \&getsetup);
        hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "rename", call => \&formbuilder);
        hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
        hook(type => "getsetup", id => "rename", call => \&getsetup);
        hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "rename", call => \&formbuilder);
        hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
+       hook(type => "rename", id => "rename", call => \&rename_subpages);
+}
 
 
-} # }}}
-
-sub getsetup () { #{{{
+sub getsetup () {
        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
+                       section => "web",
                },
                },
-} #}}}
+}
 
 
-sub check_canrename ($$$$$$) { #{{{
+sub check_canrename ($$$$$$) {
        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
@@ -29,7 +30,7 @@ sub check_canrename ($$$$$$) { #{{{
        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 
-       my $attachment=! defined IkiWiki::pagetype($pagesources{$src});
+       my $attachment=! defined pagetype($pagesources{$src});
 
        # Must be a known source file.
        if (! exists $pagesources{$src}) {
 
        # Must be a known source file.
        if (! exists $pagesources{$src}) {
@@ -49,7 +50,7 @@ sub check_canrename ($$$$$$) { #{{{
        IkiWiki::check_canedit($src, $q, $session);
        if ($attachment) {
                if (IkiWiki::Plugin::attachment->can("check_canattach")) {
        IkiWiki::check_canedit($src, $q, $session);
        if ($attachment) {
                if (IkiWiki::Plugin::attachment->can("check_canattach")) {
-                       IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
+                       IkiWiki::Plugin::attachment::check_canattach($session, $src, "$config{srcdir}/$srcfile");
                }
                else {
                        error("renaming of attachments is not allowed");
                }
                else {
                        error("renaming of attachments is not allowed");
@@ -62,9 +63,8 @@ sub check_canrename ($$$$$$) { #{{{
                        error(gettext("no change to the file name was specified"));
                }
 
                        error(gettext("no change to the file name was specified"));
                }
 
-               # Must be a legal filename, and not absolute.
-               if (IkiWiki::file_pruned($destfile, $config{srcdir}) || 
-                   $destfile=~/^\//) {
+               # Must be a legal filename.
+               if (IkiWiki::file_pruned($destfile)) {
                        error(sprintf(gettext("illegal name")));
                }
 
                        error(sprintf(gettext("illegal name")));
                }
 
@@ -84,12 +84,34 @@ sub check_canrename ($$$$$$) { #{{{
                if ($attachment) {
                        # Note that $srcfile is used here, not $destfile,
                        # because it wants the current file, to check it.
                if ($attachment) {
                        # Note that $srcfile is used here, not $destfile,
                        # because it wants the current file, to check it.
-                       IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
+                       IkiWiki::Plugin::attachment::check_canattach($session, $dest, "$config{srcdir}/$srcfile");
                }
        }
                }
        }
-} #}}}
 
 
-sub rename_form ($$$) { #{{{ 
+       my $canrename;
+       IkiWiki::run_hooks(canrename => sub {
+               return if defined $canrename;
+               my $ret=shift->(cgi => $q, session => $session,
+                       src => $src, srcfile => $srcfile,
+                       dest => $dest, destfile => $destfile);
+               if (defined $ret) {
+                       if ($ret eq "") {
+                               $canrename=1;
+                       }
+                       elsif (ref $ret eq 'CODE') {
+                               $ret->();
+                               $canrename=0;
+                       }
+                       elsif (defined $ret) {
+                               error($ret);
+                               $canrename=0;
+                       }
+               }
+       });
+       return defined $canrename ? $canrename : 1;
+}
+
+sub rename_form ($$$) {
        my $q=shift;
        my $session=shift;
        my $page=shift;
        my $q=shift;
        my $session=shift;
        my $page=shift;
@@ -98,32 +120,36 @@ sub rename_form ($$$) { #{{{
        error($@) if $@;
        my $f = CGI::FormBuilder->new(
                name => "rename",
        error($@) if $@;
        my $f = CGI::FormBuilder->new(
                name => "rename",
-               title => sprintf(gettext("rename %s"), IkiWiki::pagetitle($page)),
+               title => sprintf(gettext("rename %s"), pagetitle($page)),
                header => 0,
                charset => "utf-8",
                method => 'POST',
                javascript => 0,
                params => $q,
                header => 0,
                charset => "utf-8",
                method => 'POST',
                javascript => 0,
                params => $q,
-               action => $config{cgiurl},
-               stylesheet => IkiWiki::baseurl()."style.css",
+               action => IkiWiki::cgiurl(),
+               stylesheet => 1,
                fields => [qw{do page new_name attachment}],
        );
        
        $f->field(name => "do", type => "hidden", value => "rename", force => 1);
                fields => [qw{do page new_name attachment}],
        );
        
        $f->field(name => "do", type => "hidden", value => "rename", force => 1);
+       $f->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);
        $f->field(name => "page", type => "hidden", value => $page, force => 1);
        $f->field(name => "page", type => "hidden", value => $page, force => 1);
-       $f->field(name => "new_name", value => IkiWiki::pagetitle($page), size => 60);
+       $f->field(name => "new_name", value => pagetitle($page, 1), size => 60);
        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;
                if (exists $IkiWiki::hooks{htmlize}) {
        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;
                if (exists $IkiWiki::hooks{htmlize}) {
-                       @page_types=grep { !/^_/ }
-                               keys %{$IkiWiki::hooks{htmlize}};
+                       foreach my $key (grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}}) {
+                               push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
+                       }
                }
                }
+               @page_types=sort @page_types;
        
                # make sure the current extension is in the list
                my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
                if (! $IkiWiki::hooks{htmlize}{$ext}) {
        
                # make sure the current extension is in the list
                my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
                if (! $IkiWiki::hooks{htmlize}{$ext}) {
-                       unshift(@page_types, $ext);
+                       unshift(@page_types, [$ext, $ext]);
                }
        
                $f->field(name => "type", type => 'select',
                }
        
                $f->field(name => "type", type => 'select',
@@ -145,16 +171,23 @@ sub rename_form ($$$) { #{{{
        $f->field(name => "attachment", type => "hidden");
 
        return $f, ["Rename", "Cancel"];
        $f->field(name => "attachment", type => "hidden");
 
        return $f, ["Rename", "Cancel"];
-} #}}}
+}
 
 
-sub rename_start ($$$$) { #{{{
+sub rename_start ($$$$) {
        my $q=shift;
        my $session=shift;
        my $attachment=shift;
        my $page=shift;
 
        my $q=shift;
        my $session=shift;
        my $attachment=shift;
        my $page=shift;
 
-       check_canrename($page, $pagesources{$page}, undef, undef,
-               $q, $session);
+       # Special case for renaming held attachments; normal checks
+       # don't apply.
+       my $held=$attachment &&
+               IkiWiki::Plugin::attachment->can("is_held_attachment") &&
+               IkiWiki::Plugin::attachment::is_held_attachment($page);
+       if (! $held) {
+               check_canrename($page, $pagesources{$page}, undef, undef,
+                       $q, $session);
+       }
 
        # Save current form state to allow returning to it later
        # without losing any edits.
 
        # Save current form state to allow returning to it later
        # without losing any edits.
@@ -171,9 +204,9 @@ sub rename_start ($$$$) { #{{{
        my ($f, $buttons)=rename_form($q, $session, $page);
        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;
        my ($f, $buttons)=rename_form($q, $session, $page);
        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;
-} #}}}
+}
 
 
-sub postrename ($;$$$) { #{{{
+sub postrename ($;$$$) {
        my $session=shift;
        my $src=shift;
        my $dest=shift;
        my $session=shift;
        my $src=shift;
        my $dest=shift;
@@ -204,21 +237,23 @@ sub postrename ($;$$$) { #{{{
        }
 
        IkiWiki::cgi_editpage($postrename, $session);
        }
 
        IkiWiki::cgi_editpage($postrename, $session);
-} #}}}
+}
 
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
        my %params=@_;
        my $form=$params{form};
 
        my %params=@_;
        my $form=$params{form};
 
-       if (defined $form->field("do") && $form->field("do") eq "edit") {
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
+               IkiWiki::decode_form_utf8($form);
                my $q=$params{cgi};
                my $session=$params{session};
 
                my $q=$params{cgi};
                my $session=$params{session};
 
-               if ($form->submitted eq "Rename") {
+               if ($form->submitted eq "Rename" && $form->field("do") eq "edit") {
                        rename_start($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Rename Attachment") {
                        rename_start($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Rename Attachment") {
-                       my @selected=$q->param("attachment_select");
+                       my @selected=map { Encode::decode_utf8($_) } $q->param("attachment_select");
                        if (@selected > 1) {
                                error(gettext("Only one attachment can be renamed at a time."));
                        }
                        if (@selected > 1) {
                                error(gettext("Only one attachment can be renamed at a time."));
                        }
@@ -228,46 +263,47 @@ sub formbuilder (@) { #{{{
                        rename_start($q, $session, 1, $selected[0]);
                }
        }
                        rename_start($q, $session, 1, $selected[0]);
                }
        }
-} #}}}
+}
 
 my $renamesummary;
 
 
 my $renamesummary;
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
 
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
 
-       if (defined $form->field("do") && $form->field("do") eq "edit") {
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
                # Rename button for the page, and also for attachments.
                # Rename button for the page, and also for attachments.
-               push @{$params{buttons}}, "Rename";
+               push @{$params{buttons}}, "Rename" if $form->field("do") eq "edit";
                $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
 
                if (defined $renamesummary) {
                        $form->tmpl_param(message => $renamesummary);
                }
        }
                $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
 
                if (defined $renamesummary) {
                        $form->tmpl_param(message => $renamesummary);
                }
        }
-} #}}}
+}
 
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {
                my $session=shift;
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {
                my $session=shift;
-               my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
+               my ($form, $buttons)=rename_form($q, $session, Encode::decode_utf8($q->param("page")));
                IkiWiki::decode_form_utf8($form);
 
                if ($form->submitted eq 'Cancel') {
                        postrename($session);
                }
                elsif ($form->submitted eq 'Rename' && $form->validate) {
                IkiWiki::decode_form_utf8($form);
 
                if ($form->submitted eq 'Cancel') {
                        postrename($session);
                }
                elsif ($form->submitted eq 'Rename' && $form->validate) {
-                       # Queue of rename actions to perfom.
-                       my @torename;
+                       IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
 
                        # These untaints are safe because of the checks
                        # performed in check_canrename later.
 
                        # These untaints are safe because of the checks
                        # performed in check_canrename later.
-                       my $src=$q->param("page");
-                       my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
-                       my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name")));
+                       my $src=$form->field("page");
+                       my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src})
+                               if exists $pagesources{$src};
+                       my $dest=IkiWiki::possibly_foolish_untaint(titlepage($form->field("new_name")));
                        my $destfile=$dest;
                        if (! $q->param("attachment")) {
                                my $type=$q->param('type');
                        my $destfile=$dest;
                        if (! $q->param("attachment")) {
                                my $type=$q->param('type');
@@ -279,8 +315,21 @@ sub sessioncgi ($$) { #{{{
                                        $type=$ext;
                                }
                                
                                        $type=$ext;
                                }
                                
-                               $destfile.=".".$type;
+                               $destfile=newpagefile($dest, $type);
                        }
                        }
+               
+                       # Special case for renaming held attachments.
+                       my $held=$q->param("attachment") &&
+                               IkiWiki::Plugin::attachment->can("is_held_attachment") &&
+                               IkiWiki::Plugin::attachment::is_held_attachment($src);
+                       if ($held) {
+                               rename($held, IkiWiki::Plugin::attachment::attachment_holding_location($dest));
+                               postrename($session, $src, $dest, $q->param("attachment"))
+                                       unless defined $srcfile;
+                       }
+                       
+                       # Queue of rename actions to perfom.
+                       my @torename;
                        push @torename, {
                                src => $src,
                                srcfile => $srcfile,
                        push @torename, {
                                src => $src,
                                srcfile => $srcfile,
@@ -289,23 +338,13 @@ sub sessioncgi ($$) { #{{{
                                required => 1,
                        };
 
                                required => 1,
                        };
 
-                       # See if any subpages need to be renamed.
-                       if ($q->param("subpages") && $src ne $dest) {
-                               foreach my $p (keys %pagesources) {
-                                       if ($pagesources{$p}=~m/^\Q$src\E\//) {
-                                               my $d=$pagesources{$p};
-                                               $d=~s/^\Q$src\E\//$dest\//;
-                                               push @torename, {
-                                                       src => $p,
-                                                       srcfile => $pagesources{$p},
-                                                       dest => pagename($d),
-                                                       destfile => $d,
-                                                       required => 0,
-                                               };
-                                       }
-                               }
-                       }
-                       
+                       @torename=rename_hook(
+                               torename => \@torename,
+                               done => {},
+                               cgi => $q,
+                               session => $session,
+                       );
+
                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};
                        my %origpagesources=%pagesources;
                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};
                        my %origpagesources=%pagesources;
@@ -329,8 +368,9 @@ sub sessioncgi ($$) { #{{{
                                $pagesources{$rename->{src}}=$rename->{destfile};
                        }
                        IkiWiki::rcs_commit_staged(
                                $pagesources{$rename->{src}}=$rename->{destfile};
                        }
                        IkiWiki::rcs_commit_staged(
-                               sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
-                               $session->param("name"), $ENV{REMOTE_ADDR}) if $config{rcs};
+                               message => sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
+                               session => $session,
+                       ) if $config{rcs};
 
                        # Then link fixups.
                        foreach my $rename (@torename) {
 
                        # Then link fixups.
                        foreach my $rename (@torename) {
@@ -384,22 +424,8 @@ sub sessioncgi ($$) { #{{{
                                $template->param(error => $rename->{error});
                                if ($rename->{src} ne $rename->{dest}) {
                                        $template->param(brokenlinks_checked => 1);
                                $template->param(error => $rename->{error});
                                if ($rename->{src} ne $rename->{dest}) {
                                        $template->param(brokenlinks_checked => 1);
-                                       $template->param(brokenlinks => [
-                                               map {
-                                                       {
-                                                               page => htmllink($rename->{dest}, $rename->{dest}, $_,
-                                                                               noimageinline => 1)
-                                                       }
-                                               } @{$rename->{brokenlinks}}
-                                       ]);
-                                       $template->param(fixedlinks => [
-                                               map {
-                                                       {
-                                                               page => htmllink($rename->{dest}, $rename->{dest}, $_,
-                                                                               noimageinline => 1)
-                                                       }
-                                               } @{$rename->{fixedlinks}}
-                                       ]);
+                                       $template->param(brokenlinks => linklist($rename->{dest}, $rename->{brokenlinks}));
+                                       $template->param(fixedlinks => linklist($rename->{dest}, $rename->{fixedlinks}));
                                }
                                $renamesummary.=$template->output;
                        }
                                }
                                $renamesummary.=$template->output;
                        }
@@ -412,9 +438,59 @@ sub sessioncgi ($$) { #{{{
 
                exit 0;
        }
 
                exit 0;
        }
-} #}}}
+}
+
+# Add subpages to the list of pages to be renamed, if needed.
+sub rename_subpages (@) {
+       my %params = @_;
+
+       my %torename = %{$params{torename}};
+       my $q = $params{cgi};
+       my $src = $torename{src};
+       my $srcfile = $torename{src};
+       my $dest = $torename{dest};
+       my $destfile = $torename{dest};
+
+       return () unless ($q->param("subpages") && $src ne $dest);
+
+       my @ret;
+       foreach my $p (keys %pagesources) {
+               next unless $pagesources{$p}=~m/^\Q$src\E\//;
+               # If indexpages is enabled, the srcfile should not be confused
+               # with a subpage.
+               next if $pagesources{$p} eq $srcfile;
+
+               my $d=$pagesources{$p};
+               $d=~s/^\Q$src\E\//$dest\//;
+               push @ret, {
+                       src => $p,
+                       srcfile => $pagesources{$p},
+                       dest => pagename($d),
+                       destfile => $d,
+                       required => 0,
+               };
+       }
+       return @ret;
+}
 
 
-sub renamepage_hook ($$$$) { #{{{
+sub linklist {
+       # generates a list of links in a form suitable for FormBuilder
+       my $dest=shift;
+       my $list=shift;
+       # converts a list of pages into a list of links
+       # in a form suitable for FormBuilder.
+
+       [map {
+               {
+                       page => htmllink($dest, $dest, $_,
+                                       noimageinline => 1,
+                                       linktext => pagetitle($_),
+                               )
+               }
+       } @{$list}]
+}
+
+sub renamepage_hook ($$$$) {
        my ($page, $src, $dest, $content)=@_;
 
        IkiWiki::run_hooks(renamepage => sub {
        my ($page, $src, $dest, $content)=@_;
 
        IkiWiki::run_hooks(renamepage => sub {
@@ -427,9 +503,45 @@ sub renamepage_hook ($$$$) { #{{{
        });
 
        return $content;
        });
 
        return $content;
-}# }}}
-                       
-sub do_rename ($$$) { #{{{
+}
+
+sub rename_hook {
+       my %params = @_;
+
+       my @torename=@{$params{torename}};
+       my %done=%{$params{done}};
+       my $q=$params{cgi};
+       my $session=$params{session};
+
+       return () unless @torename;
+
+       my @nextset;
+       foreach my $torename (@torename) {
+               unless (exists $done{$torename->{src}} && $done{$torename->{src}}) {
+                       IkiWiki::run_hooks(rename => sub {
+                               push @nextset, shift->(
+                                       torename => $torename,
+                                       cgi => $q,
+                                       session => $session,
+                               );
+                       });
+                       $done{$torename->{src}}=1;
+               }
+       }
+
+       push @torename, rename_hook(
+               torename => \@nextset,
+               done => \%done,
+               cgi => $q,
+               session => $session,
+       );
+
+       # dedup
+       my %seen;
+       return grep { ! $seen{$_->{src}}++ } @torename;
+}
+
+sub do_rename ($$$) {
        my $rename=shift;
        my $q=shift;
        my $session=shift;
        my $rename=shift;
        my $q=shift;
        my $session=shift;
@@ -454,9 +566,9 @@ sub do_rename ($$$) { #{{{
                }
        }
 
                }
        }
 
-} # }}}
+}
 
 
-sub fixlinks ($$$) { #{{{
+sub fixlinks ($$$) {
        my $rename=shift;
        my $session=shift;
 
        my $rename=shift;
        my $session=shift;
 
@@ -473,6 +585,7 @@ sub fixlinks ($$$) { #{{{
                }
                if ($needfix) {
                        my $file=$pagesources{$page};
                }
                if ($needfix) {
                        my $file=$pagesources{$page};
+                       next unless -e $config{srcdir}."/".$file;
                        my $oldcontent=readfile($config{srcdir}."/".$file);
                        my $content=renamepage_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
                        if ($oldcontent ne $content) {
                        my $oldcontent=readfile($config{srcdir}."/".$file);
                        my $content=renamepage_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
                        if ($oldcontent ne $content) {
@@ -480,11 +593,10 @@ sub fixlinks ($$$) { #{{{
                                eval { writefile($file, $config{srcdir}, $content) };
                                next if $@;
                                my $conflict=IkiWiki::rcs_commit(
                                eval { writefile($file, $config{srcdir}, $content) };
                                next if $@;
                                my $conflict=IkiWiki::rcs_commit(
-                                       $file,
-                                       sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
-                                       $token,
-                                       $session->param("name"), 
-                                       $ENV{REMOTE_ADDR}
+                                       file => $file,
+                                       message => sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
+                                       token => $token,
+                                       session => $session,
                                );
                                push @fixedlinks, $page if ! defined $conflict;
                        }
                                );
                                push @fixedlinks, $page if ! defined $conflict;
                        }
@@ -492,6 +604,6 @@ sub fixlinks ($$$) { #{{{
        }
 
        return @fixedlinks;
        }
 
        return @fixedlinks;
-} #}}}
+}
 
 1
 
 1
Unnamed repository; edit this file 'description' to name the repository.