ref new tip from softwaresite page

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

diff --git a/IkiWiki/Plugin/remove.pm b/IkiWiki/Plugin/remove.pm
index d4f1c7d66e50d66b685794c143b86c6bf86db4dc..f59d0269e4cc747da68db81b56afd82cdc304cee 100644 (file)
--- a/IkiWiki/Plugin/remove.pm
+++ b/IkiWiki/Plugin/remove.pm
@@ -3,25 +3,34 @@ package IkiWiki::Plugin::remove;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 
 

-sub import { #{{{
+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,
+                       section => "web",
+               },
+}

 
 

-sub check_canremove ($$$$) {
+sub check_canremove ($$$) {

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

-       my $attachment=shift;

 
        # Must be a known source file.
        if (! exists $pagesources{$page}) {
                error(sprintf(gettext("%s does not exist"),
 
        # Must be a known source file.
        if (! exists $pagesources{$page}) {
                error(sprintf(gettext("%s does not exist"),

-               htmllink("", "", $page, noimageinline => 1)));
+                       htmllink("", "", $page, noimageinline => 1)));

        }
 
        # Must exist on disk, and be a regular file.
        }
 
        # Must exist on disk, and be a regular file.


@@ -33,30 +42,54 @@ sub check_canremove ($$$$) {
                error(sprintf(gettext("%s is not a file"), $file));
        }
        
                error(sprintf(gettext("%s is not a file"), $file));
        }
        

-       # Must be editiable.
+       # Must be editable.

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

-       # This is sorta overkill, but better safe
-       # than sorry. If a user can't upload an
-       # attachment, don't let them delete it.
-       if ($attachment) {
-               IkiWiki::Plugin::attachment::check_canattach($session, $page, $file);
+       # 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("removal of attachments is not allowed");
+               }

        }
        }

+
+       my $canremove;
+       IkiWiki::run_hooks(canremove => sub {
+               return if defined $canremove;
+               my $ret=shift->(page => $page, cgi => $q, session => $session);
+               if (defined $ret) {
+                       if ($ret eq "") {
+                               $canremove=1;
+                       }
+                       elsif (ref $ret eq 'CODE') {
+                               $ret->();
+                               $canremove=0;
+                       }
+                       elsif (defined $ret) {
+                               error($ret);
+                               $canremove=0;
+                       }
+               }
+       });

 }
 
 }
 

-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")) {

                # 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;
 


@@ -77,7 +110,7 @@ sub confirmation_form ($$) { #{{{
        $f->field(name => "do", type => "hidden", value => "remove", force => 1);
 
        return $f, ["Remove", "Cancel"];
        $f->field(name => "do", type => "hidden", value => "remove", force => 1);
 
        return $f, ["Remove", "Cancel"];

-} #}}}
+}

 
 sub removal_confirm ($$@) {
        my $q=shift;
 
 sub removal_confirm ($$@) {
        my $q=shift;


@@ -85,7 +118,9 @@ sub removal_confirm ($$@) {
        my $attachment=shift;
        my @pages=@_;
 
        my $attachment=shift;
        my @pages=@_;
 

-       check_canremove($_, $q, $session, $attachment) foreach @pages;
+       foreach my $page (@pages) {
+               check_canremove($page, $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.


@@ -98,7 +133,7 @@ sub removal_confirm ($$@) {
        
        my ($f, $buttons)=confirmation_form($q, $session);
        $f->title(sprintf(gettext("confirm removal of %s"),
        
        my ($f, $buttons)=confirmation_form($q, $session);
        $f->title(sprintf(gettext("confirm removal of %s"),

-               join(", ", map { IkiWiki::pagetitle($_) } @pages)));
+               join(", ", map { pagetitle($_) } @pages)));

        $f->field(name => "page", type => "hidden", value => \@pages, force => 1);
        if (defined $attachment) {
                $f->field(name => "attachment", type => "hidden",
        $f->field(name => "page", type => "hidden", value => \@pages, force => 1);
        if (defined $attachment) {
                $f->field(name => "attachment", type => "hidden",


@@ -119,28 +154,29 @@ sub postremove ($) {
        IkiWiki::cgi($postremove, $session);
 }
 
        IkiWiki::cgi($postremove, $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")) {

                my $q=$params{cgi};
                my $session=$params{session};
 
                my $q=$params{cgi};
                my $session=$params{session};
 

-               if ($form->submitted eq "Remove") {
+               if ($form->submitted eq "Remove" && $form->field("do") eq "edit") {

                        removal_confirm($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Remove Attachments") {
                        removal_confirm($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Remove Attachments") {

-                       my @selected=$q->param("attachment_select");
+                       my @selected=map { Encode::decode_utf8($_) } $q->param("attachment_select");

                        if (! @selected) {
                                error(gettext("Please select the attachments to remove."));
                        }
                        removal_confirm($q, $session, 1, @selected);
                }
        }
                        if (! @selected) {
                                error(gettext("Please select the attachments to remove."));
                        }
                        removal_confirm($q, $session, 1, @selected);
                }
        }

-} #}}}
+}

 
 

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

         my $q=shift;
 
        if ($q->param("do") eq 'remove') {
         my $q=shift;
 
        if ($q->param("do") eq 'remove') {


@@ -152,14 +188,17 @@ sub sessioncgi ($$) { #{{{
                        postremove($session);
                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {
                        postremove($session);
                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {

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

        
                        # Validate removal by checking that the page exists,
                        # and that the user is allowed to edit(/remove) it.
                        my @files;
                        foreach my $page (@pages) {
        
                        # Validate removal by checking that the page exists,
                        # and that the user is allowed to edit(/remove) it.
                        my @files;
                        foreach my $page (@pages) {

-                               check_canremove($page, $q, $session, $q->param("attachment"));
-
+                               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});
                        }
 
                                push @files, IkiWiki::possibly_foolish_untaint($pagesources{$page});
                        }
 


@@ -168,11 +207,10 @@ sub sessioncgi ($$) { #{{{
                        if ($config{rcs}) {
                                IkiWiki::disable_commit_hook();
                                foreach my $file (@files) {
                        if ($config{rcs}) {
                                IkiWiki::disable_commit_hook();
                                foreach my $file (@files) {

-                                       my $token=IkiWiki::rcs_prepedit($file);

                                        IkiWiki::rcs_remove($file);
                                        IkiWiki::rcs_remove($file);

-                                       IkiWiki::rcs_commit($file, gettext("removed"),
-                                               $token, $session->param("name"), $ENV{REMOTE_ADDR});

                                }
                                }

+                               IkiWiki::rcs_commit_staged(gettext("removed"),
+                                       $session->param("name"), $ENV{REMOTE_ADDR});

                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }


@@ -196,11 +234,11 @@ sub sessioncgi ($$) { #{{{
                                if (! exists $pagesources{$parent}) {
                                        $parent="index";
                                }
                                if (! exists $pagesources{$parent}) {
                                        $parent="index";
                                }

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

                        }
                }
                else {
                        }
                }
                else {

-                       IkiWiki::showform($form, $buttons, $session, $q);
+                       removal_confirm($q, $session, 0, $form->field("page"));

                }
 
                exit 0;
                }
 
                exit 0;