update for rename of recentchanges.mdwn to json.tl.ph.mdwn

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

diff --git a/IkiWiki/Plugin/remove.pm b/IkiWiki/Plugin/remove.pm
index cf95026c871570358a00d9bc1027c9dc291d66ad..859c390663dd1ea605d135fa37a6bad1a0015005 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 => "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 () { #{{{
+sub getsetup () {

        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,

+                       section => "web",

                },
                },

-} #}}}
+}
+
+sub allowed_dirs {
+       no warnings 'once';
+       return grep { defined $_ } (
+               $config{srcdir},
+               $IkiWiki::Plugin::transient::transientdir,
+       );
+}

 
 

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

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


@@ -32,31 +41,58 @@ sub check_canremove ($$$) { #{{{
                        htmllink("", "", $page, noimageinline => 1)));
        }
 
                        htmllink("", "", $page, noimageinline => 1)));
        }
 

-       # Must exist on disk, and be a regular file.
+       # Must exist in either the srcdir or a suitable underlay (e.g.
+       # transient underlay), and be a regular file.

        my $file=$pagesources{$page};
        my $file=$pagesources{$page};

-       if (! -e "$config{srcdir}/$file") {
+       my $dir;
+
+       foreach my $srcdir (allowed_dirs()) {
+               if (-e "$srcdir/$file") {
+                       $dir = $srcdir;
+                       last;
+               }
+       }
+
+       if (! defined $dir) {

                error(sprintf(gettext("%s is not in the srcdir, so it cannot be deleted"), $file));
        }
                error(sprintf(gettext("%s is not in the srcdir, so it cannot be deleted"), $file));
        }

-       elsif (-l "$config{srcdir}/$file" && ! -f _) {
+       elsif (-l "$dir/$file" && ! -f _) {

                error(sprintf(gettext("%s is not a file"), $file));
        }
        
                error(sprintf(gettext("%s is not a file"), $file));
        }
        

-       # Must be editiable.
-       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")) {
        # 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);
+                       IkiWiki::Plugin::attachment::check_canattach($session, $page, "$dir/$file");

                }
                else {
                }
                else {

-                       error("renaming of attachments is not allowed");
+                       error("removal of attachments is not allowed");

                }
        }
                }
        }

-} #}}}

 
 

-sub formbuilder_setup (@) { #{{{
+       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;
+                       }
+               }
+       });
+       return defined $canremove ? $canremove : 1;
+}
+
+sub formbuilder_setup (@) {

        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};


@@ -67,9 +103,9 @@ sub formbuilder_setup (@) { #{{{
                push @{$params{buttons}}, "Remove" if $form->field("do") eq "edit";
                $form->tmpl_param("field-remove" => '<input name="_submit" type="submit" value="Remove Attachments" />');
        }
                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;
 
        my $q=shift;
        my $session=shift;
 


@@ -82,25 +118,43 @@ sub confirmation_form ($$) { #{{{
                method => 'POST',
                javascript => 0,
                params => $q,
                method => 'POST',
                javascript => 0,
                params => $q,

-               action => $config{cgiurl},
-               stylesheet => IkiWiki::baseurl()."style.css",
+               action => IkiWiki::cgiurl(),
+               stylesheet => 1,

                fields => [qw{do page}],
        );
        
                fields => [qw{do page}],
        );
        

+       $f->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);

        $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 ($$@) { #{{{
+sub removal_confirm ($$@) {

        my $q=shift;
        my $session=shift;
        my $attachment=shift;
        my @pages=@_;
        my $q=shift;
        my $session=shift;
        my $attachment=shift;
        my @pages=@_;

+               
+       # Special case for unsaved attachments.
+       foreach my $page (@pages) {
+               if ($attachment && IkiWiki::Plugin::attachment->can("is_held_attachment")) {
+                       my $f=IkiWiki::Plugin::attachment::is_held_attachment($page);
+                       if (defined $f) {
+                               require IkiWiki::Render;
+                               IkiWiki::prune($f, "$config{wikistatedir}/attachments");
+                       }
+               }
+       }
+       @pages=grep { exists $pagesources{$_} } @pages;
+       return unless @pages;

 
 

-       check_canremove($_, $q, $session) foreach @pages;
+       foreach my $page (@pages) {
+               IkiWiki::check_canedit($page, $q, $session);
+               check_canremove($page, $q, $session);
+       }

 
 

-       # Save current form state to allow returning to it later
+       # 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.)
        # without losing any edits.
        # (But don't save what button was submitted, to avoid
        # looping back to here.)


@@ -120,9 +174,9 @@ sub removal_confirm ($$@) { #{{{
 
        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;
 
        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;

-} #}}}
+}

 
 

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

        my $session=shift;
 
        # Load saved form state and return to edit form.
        my $session=shift;
 
        # Load saved form state and return to edit form.


@@ -130,9 +184,9 @@ sub postremove ($) { #{{{
        $session->clear("postremove");
        IkiWiki::cgi_savesession($session);
        IkiWiki::cgi($postremove, $session);
        $session->clear("postremove");
        IkiWiki::cgi_savesession($session);
        IkiWiki::cgi($postremove, $session);

-} #}}}
+}

 
 

-sub formbuilder (@) { #{{{
+sub formbuilder (@) {

        my %params=@_;
        my $form=$params{form};
 
        my %params=@_;
        my $form=$params{form};
 


@@ -142,36 +196,42 @@ sub formbuilder (@) { #{{{
                my $session=$params{session};
 
                if ($form->submitted eq "Remove" && $form->field("do") eq "edit") {
                my $session=$params{session};
 
                if ($form->submitted eq "Remove" && $form->field("do") eq "edit") {

-                       removal_confirm($q, $session, 0, $form->field("page"));
+                       # deliberately taking multiple values of page
+                       my @pages = $form->field("page");
+                       removal_confirm($q, $session, 0, @pages);

                }
                elsif ($form->submitted eq "Remove Attachments") {
                }
                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 ($$) { #{{{
-        my $q=shift;
+sub sessioncgi ($$) {
+       my $q=shift;

 
        if ($q->param("do") eq 'remove') {
 
        if ($q->param("do") eq 'remove') {

-               my $session=shift;
+               my $session=shift;

                my ($form, $buttons)=confirmation_form($q, $session);
                IkiWiki::decode_form_utf8($form);
 
                my ($form, $buttons)=confirmation_form($q, $session);
                IkiWiki::decode_form_utf8($form);
 

+               # deliberately taking multiple values of page
+               my @pages = $form->field("page");
+

                if ($form->submitted eq 'Cancel') {
                        postremove($session);
                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {
                if ($form->submitted eq 'Cancel') {
                        postremove($session);
                }
                elsif ($form->submitted eq 'Remove' && $form->validate) {

-                       my @pages=$q->param("page");
-       
+                       IkiWiki::checksessionexpiry($q, $session);
+

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

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

                                check_canremove($page, $q, $session);
                                
                                # This untaint is safe because of the
                                check_canremove($page, $q, $session);
                                
                                # This untaint is safe because of the


@@ -184,19 +244,34 @@ sub sessioncgi ($$) { #{{{
                        require IkiWiki::Render;
                        if ($config{rcs}) {
                                IkiWiki::disable_commit_hook();
                        require IkiWiki::Render;
                        if ($config{rcs}) {
                                IkiWiki::disable_commit_hook();

-                               foreach my $file (@files) {
-                                       IkiWiki::rcs_remove($file);
+                       }
+                       my $rcs_removed = 1;
+
+                       foreach my $file (@files) {
+                               foreach my $srcdir (allowed_dirs()) {
+                                       if (-e "$srcdir/$file") {
+                                               if ($srcdir eq $config{srcdir} && $config{rcs}) {
+                                                       IkiWiki::rcs_remove($file);
+                                                       $rcs_removed = 1;
+                                               }
+                                               else {
+                                                       IkiWiki::prune("$srcdir/$file", $srcdir);
+                                               }
+                                       }

                                }
                                }

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

                        }
                        }

-                       else {
-                               foreach my $file (@files) {
-                                       IkiWiki::prune("$config{srcdir}/$file");
+
+                       if ($config{rcs}) {
+                               if ($rcs_removed) {
+                                       IkiWiki::rcs_commit_staged(
+                                               message => gettext("removed"),
+                                               session => $session,
+                                       );

                                }
                                }

+                               IkiWiki::enable_commit_hook();
+                               IkiWiki::rcs_update();

                        }
                        }

+

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


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

-                               IkiWiki::redirect($q, urlto($parent, '/', 1));
+                               IkiWiki::redirect($q, urlto($parent));

                        }
                }
                else {
                        }
                }
                else {

-                       IkiWiki::showform($form, $buttons, $session, $q);
+                       removal_confirm($q, $session, 0, @pages);

                }
 
                exit 0;
                }
 
                exit 0;