Merge commit 'upstream/master' into pub/master

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

diff --git a/IkiWiki/Plugin/remove.pm b/IkiWiki/Plugin/remove.pm
index 98f2f9459ffe599b789d28e7ea550fc35aa6317d..c512b3b9793af3f489762ac8f4327daeb8361919 100644 (file)
--- a/IkiWiki/Plugin/remove.pm
+++ b/IkiWiki/Plugin/remove.pm
@@ -6,35 +6,76 @@ use strict;
 use IkiWiki 2.00;
 
 sub import { #{{{
 use IkiWiki 2.00;
 
 sub import { #{{{

+       hook(type => "getsetup", id => "remove", call => \&getsetup);

        hook(type => "formbuilder_setup", id => "remove", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "remove", call => \&formbuilder);
        hook(type => "sessioncgi", id => "remove", call => \&sessioncgi);
 
 } # }}}
 
        hook(type => "formbuilder_setup", id => "remove", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "remove", call => \&formbuilder);
        hook(type => "sessioncgi", id => "remove", call => \&sessioncgi);
 
 } # }}}
 

+sub getsetup () { #{{{
+       return 
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+} #}}}
+
+sub check_canremove ($$$) { #{{{
+       my $page=shift;
+       my $q=shift;
+       my $session=shift;
+
+       # Must be a known source file.
+       if (! exists $pagesources{$page}) {
+               error(sprintf(gettext("%s does not exist"),
+                       htmllink("", "", $page, noimageinline => 1)));
+       }
+
+       # Must exist on disk, and be a regular file.
+       my $file=$pagesources{$page};
+       if (! -e "$config{srcdir}/$file") {
+               error(sprintf(gettext("%s is not in the srcdir, so it cannot be deleted"), $file));
+       }
+       elsif (-l "$config{srcdir}/$file" && ! -f _) {
+               error(sprintf(gettext("%s is not a file"), $file));
+       }
+       
+       # Must be editable.
+       IkiWiki::check_canedit($page, $q, $session);
+
+       # If a user can't upload an attachment, don't let them delete it.
+       # This is sorta overkill, but better safe than sorry.
+       if (! defined pagetype($pagesources{$page})) {
+               if (IkiWiki::Plugin::attachment->can("check_canattach")) {
+                       IkiWiki::Plugin::attachment::check_canattach($session, $page, $file);
+               }
+               else {
+                       error("renaming of attachments is not allowed");
+               }
+       }
+} #}}}
+

 sub formbuilder_setup (@) { #{{{
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
 
 sub formbuilder_setup (@) { #{{{
        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")) {

                # Removal button for the page, and also for attachments.
                # Removal button for the page, and also for attachments.

-               push @{$params{buttons}}, "Remove";
+               push @{$params{buttons}}, "Remove" if $form->field("do") eq "edit";

                $form->tmpl_param("field-remove" => '<input name="_submit" type="submit" value="Remove Attachments" />');
        }
 } #}}}
 
                $form->tmpl_param("field-remove" => '<input name="_submit" type="submit" value="Remove Attachments" />');
        }
 } #}}}
 

-sub confirmation_form ($$$) { #{{{ 
+sub confirmation_form ($$) { #{{{ 

        my $q=shift;
        my $session=shift;
        my $q=shift;
        my $session=shift;

-       my $page=shift;

 
        eval q{use CGI::FormBuilder};
        error($@) if $@;
 
        eval q{use CGI::FormBuilder};
        error($@) if $@;

-       my @fields=qw(do page);

        my $f = CGI::FormBuilder->new(
        my $f = CGI::FormBuilder->new(

-               title => sprintf(gettext("confirm removal of %s"),
-                       IkiWiki::pagetitle($page)),

                name => "remove",
                header => 0,
                charset => "utf-8",
                name => "remove",
                header => 0,
                charset => "utf-8",


@@ -43,40 +84,74 @@ sub confirmation_form ($$$) { #{{{
                params => $q,
                action => $config{cgiurl},
                stylesheet => IkiWiki::baseurl()."style.css",
                params => $q,
                action => $config{cgiurl},
                stylesheet => IkiWiki::baseurl()."style.css",

-               fields => \@fields,
+               fields => [qw{do page}],

        );
        
        $f->field(name => "do", type => "hidden", value => "remove", force => 1);
        );
        
        $f->field(name => "do", type => "hidden", value => "remove", force => 1);

-       $f->field(name => "page", type => "hidden", value => $page, force => 1);

 
        return $f, ["Remove", "Cancel"];
 } #}}}
 
 
        return $f, ["Remove", "Cancel"];
 } #}}}
 

+sub removal_confirm ($$@) { #{{{
+       my $q=shift;
+       my $session=shift;
+       my $attachment=shift;
+       my @pages=@_;
+
+       foreach my $page (@pages) {
+               check_canremove($page, $q, $session);
+       }
+
+       # Save current form state to allow returning to it later
+       # without losing any edits.
+       # (But don't save what button was submitted, to avoid
+       # looping back to here.)
+       # Note: "_submit" is CGI::FormBuilder internals.
+       $q->param(-name => "_submit", -value => "");
+       $session->param(postremove => scalar $q->Vars);
+       IkiWiki::cgi_savesession($session);
+       
+       my ($f, $buttons)=confirmation_form($q, $session);
+       $f->title(sprintf(gettext("confirm removal of %s"),
+               join(", ", map { pagetitle($_) } @pages)));
+       $f->field(name => "page", type => "hidden", value => \@pages, force => 1);
+       if (defined $attachment) {
+               $f->field(name => "attachment", type => "hidden",
+                       value => $attachment, force => 1);
+       }
+
+       IkiWiki::showform($f, $buttons, $session, $q);
+       exit 0;
+} #}}}
+
+sub postremove ($) { #{{{
+       my $session=shift;
+
+       # Load saved form state and return to edit form.
+       my $postremove=CGI->new($session->param("postremove"));
+       $session->clear("postremove");
+       IkiWiki::cgi_savesession($session);
+       IkiWiki::cgi($postremove, $session);
+} #}}}
+

 sub formbuilder (@) { #{{{
        my %params=@_;
        my $form=$params{form};
 
 sub formbuilder (@) { #{{{
        my %params=@_;
        my $form=$params{form};
 

-       if (defined $form->field("do") && $form->field("do") eq "edit") {
-               if ($form->submitted eq "Remove") {
-                       my $q=$params{cgi};
-                       my $session=$params{session};
-
-                       # Save current form state to allow returning to it later
-                       # without losing any edits.
-                       # (But don't save what button was submitted, to avoid
-                       # looping back to here.)
-                       # Note: "_submit" is CGI::FormBuilder internals.
-                       $q->param(-name => "_submit", -value => "");
-                       $session->param(postremove => scalar $q->Vars);
-                       IkiWiki::cgi_savesession($session);
-       
-                       # Display a small confirmation form.
-                       my ($f, $buttons)=confirmation_form($q, $session, $form->field("page"));
-                       IkiWiki::showform($f, $buttons, $session, $q);
-                       exit 0;
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
+               my $q=$params{cgi};
+               my $session=$params{session};
+
+               if ($form->submitted eq "Remove" && $form->field("do") eq "edit") {
+                       removal_confirm($q, $session, 0, $form->field("page"));

                }
                elsif ($form->submitted eq "Remove Attachments") {
                }
                elsif ($form->submitted eq "Remove Attachments") {

-                       
+                       my @selected=$q->param("attachment_select");
+                       if (! @selected) {
+                               error(gettext("Please select the attachments to remove."));
+                       }
+                       removal_confirm($q, $session, 1, @selected);

                }
        }
 } #}}}
                }
        }
 } #}}}


@@ -86,49 +161,61 @@ sub sessioncgi ($$) { #{{{
 
        if ($q->param("do") eq 'remove') {
                my $session=shift;
 
        if ($q->param("do") eq 'remove') {
                my $session=shift;

-               my ($form, $buttons)=confirmation_form($q, $session, $session->param("page"));
+               my ($form, $buttons)=confirmation_form($q, $session);

                IkiWiki::decode_form_utf8($form);
 
                if ($form->submitted eq 'Cancel') {
                IkiWiki::decode_form_utf8($form);
 
                if ($form->submitted eq 'Cancel') {

-                       # Load saved form state and return to edit form.
-                       my $postremove=CGI->new($session->param("postremove"));
-                       $session->clear("postremove");
-                       IkiWiki::cgi_savesession($session);
-                       IkiWiki::cgi($postremove, $session);
+                       postremove($session);

                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {
                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {

-                       my $page=$form->field("page");
-                       my $file=$pagesources{$page};
+                       my @pages=$q->param("page");

        
                        # Validate removal by checking that the page exists,
                        # and that the user is allowed to edit(/remove) it.
        
                        # Validate removal by checking that the page exists,
                        # and that the user is allowed to edit(/remove) it.

-                       if (! exists $pagesources{$page}) {
-                               error(sprintf(gettext("%s does not exist"),
-                               htmllink("", "", $page, noimageinline => 1)));
+                       my @files;
+                       foreach my $page (@pages) {
+                               check_canremove($page, $q, $session);
+                               
+                               # This untaint is safe because of the
+                               # checks performed above, which verify the
+                               # page is a normal file, etc.
+                               push @files, IkiWiki::possibly_foolish_untaint($pagesources{$page});

                        }
                        }

-                       IkiWiki::check_canedit($page, $q, $session);

 
                        # Do removal, and update the wiki.
                        require IkiWiki::Render;
                        if ($config{rcs}) {
 
                        # Do removal, and update the wiki.
                        require IkiWiki::Render;
                        if ($config{rcs}) {

-                               IkiWiki::rcs_remove($file);

                                IkiWiki::disable_commit_hook();
                                IkiWiki::disable_commit_hook();

-                               IkiWiki::rcs_commit($file, gettext("removed"),
-                                       IkiWiki::rcs_prepedit($file),
+                               foreach my $file (@files) {
+                                       IkiWiki::rcs_remove($file);
+                               }
+                               IkiWiki::rcs_commit_staged(gettext("removed"),

                                        $session->param("name"), $ENV{REMOTE_ADDR});
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }
                                        $session->param("name"), $ENV{REMOTE_ADDR});
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }

-                       IkiWiki::prune("$config{srcdir}/$file");
+                       else {
+                               foreach my $file (@files) {
+                                       IkiWiki::prune("$config{srcdir}/$file");
+                               }
+                       }

                        IkiWiki::refresh();
                        IkiWiki::saveindex();
 
                        IkiWiki::refresh();
                        IkiWiki::saveindex();
 

-                       # Redirect to parent of the page.
-                       my $parent=IkiWiki::dirname($page);
-                       if (! exists $pagesources{$parent}) {
-                               $parent="index";
+                       if ($q->param("attachment")) {
+                               # Attachments were deleted, so redirect
+                               # back to the edit form.
+                               postremove($session);
+                       }
+                       else {
+                               # The page is gone, so redirect to parent
+                               # of the page.
+                               my $parent=IkiWiki::dirname($pages[0]);
+                               if (! exists $pagesources{$parent}) {
+                                       $parent="index";
+                               }
+                               IkiWiki::redirect($q, urlto($parent, '/', 1));

                        }
                        }

-                       IkiWiki::redirect($q, $config{url}."/".htmlpage($parent));

                }
                else {
                        IkiWiki::showform($form, $buttons, $session, $q);
                }
                else {
                        IkiWiki::showform($form, $buttons, $session, $q);