]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/remove.pm
skeleton plugin: added the canrename and canremove hooks
[git.ikiwiki.info.git] / IkiWiki / Plugin / remove.pm
index 4c73ed9e5a264a4ec7a39f6f41f1f1feedc3bf48..2e3614cca7dde3bfcffab25ffefe82591e4eafaa 100644 (file)
@@ -3,20 +3,28 @@ package IkiWiki::Plugin::remove;
 
 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);
 
-} # }}}
+}
+
+sub getsetup () {
+       return 
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+}
 
-sub check_canremove ($$$$) {
+sub check_canremove ($$$) {
        my $page=shift;
        my $q=shift;
        my $session=shift;
-       my $attachment=shift;
 
        # Must be a known source file.
        if (! exists $pagesources{$page}) {
@@ -33,30 +41,55 @@ sub check_canremove ($$$$) {
                error(sprintf(gettext("%s is not a file"), $file));
        }
        
-       # Must be editiable.
+       # Must be editable.
        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("renaming of attachments is not allowed");
+               }
        }
+
+       my $canremove;
+       IkiWiki::run_hooks(canremove => sub {
+               return if defined $canremove;
+               my $ret=shift->($page, $q, $session);
+               if (defined $ret) {
+                       if ($ret eq "") {
+                               $canremove=1;
+                       }
+                       elsif (ref $ret eq 'CODE') {
+                               $ret->();
+                               $canremove=0;
+                       }
+                       elsif (defined $ret) {
+                               error($ret);
+                               $canremove=0;
+                       }
+               }
+       });
+       return $canremove;
 }
 
-sub formbuilder_setup (@) { #{{{
+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.
-               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" />');
        }
-} #}}}
+}
 
-sub confirmation_form ($$) { #{{{ 
+sub confirmation_form ($$) {
        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"];
-} #}}}
+}
 
 sub removal_confirm ($$@) {
        my $q=shift;
@@ -85,7 +118,9 @@ sub removal_confirm ($$@) {
        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.
@@ -98,7 +133,7 @@ sub removal_confirm ($$@) {
        
        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",
@@ -119,15 +154,16 @@ sub postremove ($) {
        IkiWiki::cgi($postremove, $session);
 }
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
        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};
 
-               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") {
@@ -138,9 +174,9 @@ sub formbuilder (@) { #{{{
                        removal_confirm($q, $session, 1, @selected);
                }
        }
-} #}}}
+}
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
         my $q=shift;
 
        if ($q->param("do") eq 'remove') {
@@ -158,7 +194,7 @@ sub sessioncgi ($$) { #{{{
                        # 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
@@ -198,7 +234,7 @@ sub sessioncgi ($$) { #{{{
                                if (! exists $pagesources{$parent}) {
                                        $parent="index";
                                }
-                               IkiWiki::redirect($q, $config{url}."/".htmlpage($parent));
+                               IkiWiki::redirect($q, urlto($parent, '/', 1));
                        }
                }
                else {