]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/attachment.pm
hide deprecated values if empty after save
[ikiwiki.git] / IkiWiki / Plugin / attachment.pm
index f49fe63f770aef606ad8208bac4377a9e8c360e4..bd21ed1edd4549b2ba99ecbc85c620477b84b40c 100644 (file)
@@ -6,11 +6,83 @@ use strict;
 use IkiWiki 2.00;
 
 sub import { #{{{
+       hook(type => "getsetup", id => "attachment", call => \&getsetup);
        hook(type => "checkconfig", id => "attachment", call => \&checkconfig);
        hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "attachment", call => \&formbuilder);
 } # }}}
 
+sub getsetup () { #{{{
+       return
+               virus_checker => {
+                       type => "string",
+                       example => "clamdscan -",
+                       description => "virus checker program (reads STDIN, returns nonzero if virus found)",
+                       safe => 0, # executed
+                       rebuild => 0,
+               },
+               allowed_attachments => {
+                       type => "string",
+                       example => "mimetype(image/*) and maxsize(50kb)",
+                       description => "enhanced PageSpec specifying what attachments are allowed",
+                       description_html => htmllink("", "", 
+                               "ikiwiki/PageSpec/attachment", 
+                               noimageinline => 1,
+                               linktext => "enhanced PageSpec",
+                               )." specifying what attachments are allowed",
+                       safe => 1,
+                       rebuild => 0,
+               },
+} #}}}
+
+sub check_canattach ($$;$) { #{{{
+       my $session=shift;
+       my $dest=shift; # where it's going to be put, under the srcdir
+       my $file=shift; # the path to the attachment currently
+
+       # Don't allow an attachment to be uploaded with the same name as an
+       # existing page.
+       if (exists $pagesources{$dest} && $pagesources{$dest} ne $dest) {
+               error(sprintf(gettext("there is already a page named %s"), $dest));
+       }
+
+       # Use a special pagespec to test that the attachment is valid.
+       my $allowed=1;
+       if (defined $config{allowed_attachments} &&
+           length $config{allowed_attachments}) {
+               $allowed=pagespec_match($dest,
+                       $config{allowed_attachments},
+                       file => $file,
+                       user => $session->param("name"),
+                       ip => $ENV{REMOTE_ADDR},
+               );
+       }
+
+       # XXX deprecated, should be removed eventually
+       if ($allowed) {
+               foreach my $admin (@{$config{adminuser}}) {
+                       my $allowed_attachments=IkiWiki::userinfo_get($admin, "allowed_attachments");
+                       if (defined $allowed_attachments &&
+                           length $allowed_attachments) {
+                               $allowed=pagespec_match($dest,
+                                       $allowed_attachments,
+                                       file => $file,
+                                       user => $session->param("name"),
+                                       ip => $ENV{REMOTE_ADDR},
+                               );
+                               last if $allowed;
+                       }
+               }
+       }
+
+       if (! $allowed) {
+               error(gettext("prohibited by allowed_attachments")." ($allowed)");
+       }
+       else {
+               return 1;
+       }
+} #}}}
+
 sub checkconfig () { #{{{
        $config{cgi_disable_uploads}=0;
 } #}}}
@@ -21,6 +93,8 @@ sub formbuilder_setup (@) { #{{{
        my $q=$params{cgi};
 
        if (defined $form->field("do") && $form->field("do") eq "edit") {
+               # Add attachment field, set type to multipart.
+               $form->enctype(&CGI::MULTIPART);
                $form->field(name => 'attachment', type => 'file');
                # These buttons are not put in the usual place, so
                # are not added to the normal formbuilder button list.
@@ -43,30 +117,35 @@ sub formbuilder_setup (@) { #{{{
                }
        }
        elsif ($form->title eq "preferences") {
+               # XXX deprecated, should remove eventually
                my $session=$params{session};
                my $user_name=$session->param("name");
 
                $form->field(name => "allowed_attachments", size => 50,
                        fieldset => "admin",
-                       comment => "(".
-                               htmllink("", "", 
-                                       "ikiwiki/PageSpec/attachment", 
-                                       noimageinline => 1,
-                                       linktext => "Enhanced PageSpec",
-                               ).")"
+                       comment => "deprecated; please move to allowed_attachments in setup file",
                );
                if (! IkiWiki::is_admin($user_name)) {
                        $form->field(name => "allowed_attachments", type => "hidden");
                }
                 if (! $form->submitted) {
-                       $form->field(name => "allowed_attachments", force => 1,
-                               value => IkiWiki::userinfo_get($user_name, "allowed_attachments"));
+                       my $value=IkiWiki::userinfo_get($user_name, "allowed_attachments");
+                       if (length $value) {
+                               $form->field(name => "allowed_attachments", force => 1,
+                                       value => IkiWiki::userinfo_get($user_name, "allowed_attachments"));
+                       }
+                       else {
+                               $form->field(name => "allowed_attachments", type => "hidden");
+                       }
                 }
                if ($form->submitted && $form->submitted eq 'Save Preferences') {
                        if (defined $form->field("allowed_attachments")) {
                                IkiWiki::userinfo_set($user_name, "allowed_attachments",
                                $form->field("allowed_attachments")) ||
                                        error("failed to set allowed_attachments");
+                               if (length $form->field("allowed_attachments")) {
+                                       $form->field(name => "allowed_attachments", type => "hidden");
+                               }
                        }
                }
        }
@@ -87,12 +166,20 @@ sub formbuilder (@) { #{{{
                # This is an (apparently undocumented) way to get the name
                # of the temp file that CGI writes the upload to.
                my $tempfile=$q->tmpFileName($filename);
-               
                if (! defined $tempfile || ! length $tempfile) {
-                       error("failed to determine tempfile name");
+                       # perl 5.8 needs an alternative, awful method
+                       if ($q =~ /HASH/ && exists $q->{'.tmpfiles'}) {
+                               foreach my $key (keys(%{$q->{'.tmpfiles'}})) {
+                                       $tempfile=$q->tmpFileName(\$key);
+                                       last if defined $tempfile && length $tempfile;
+                               }
+                       }
+                       if (! defined $tempfile || ! length $tempfile) {
+                               error("CGI::tmpFileName failed to return the uploaded file name");
+                       }
                }
 
-               $filename=IkiWiki::titlepage(
+               $filename=IkiWiki::linkpage(
                        IkiWiki::possibly_foolish_untaint(
                                attachment_location($form->field('page')).
                                IkiWiki::basename($filename)));
@@ -103,25 +190,8 @@ sub formbuilder (@) { #{{{
                # Check that the user is allowed to edit a page with the
                # name of the attachment.
                IkiWiki::check_canedit($filename, $q, $session, 1);
-               
-               # Use a special pagespec to test that the attachment is valid.
-               my $allowed=1;
-               foreach my $admin (@{$config{adminuser}}) {
-                       my $allowed_attachments=IkiWiki::userinfo_get($admin, "allowed_attachments");
-                       if (defined $allowed_attachments &&
-                           length $allowed_attachments) {
-                               $allowed=pagespec_match($filename,
-                                       $allowed_attachments,
-                                       file => $tempfile,
-                                       user => $session->param("name"),
-                                       ip => $ENV{REMOTE_ADDR},
-                               );
-                               last if $allowed;
-                       }
-               }
-               if (! $allowed) {
-                       error(gettext("attachment rejected")." ($allowed)");
-               }
+               # And that the attachment itself is acceptable.
+               check_canattach($session, $filename, $tempfile);
 
                # Needed for fast_file_copy and for rendering below.
                require IkiWiki::Render;
@@ -143,7 +213,7 @@ sub formbuilder (@) { #{{{
                                        # even that doesn't always work,
                                        # fall back to opening the tempfile
                                        $fh=undef;
-                                       open($fh, "<", $tempfile) || error("failed to open $tempfile: $!");
+                                       open($fh, "<", $tempfile) || error("failed to open \"$tempfile\": $!");
                                }
                        }
                        binmode($fh);
@@ -166,8 +236,10 @@ sub formbuilder (@) { #{{{
                IkiWiki::saveindex();
        }
        elsif ($form->submitted eq "Insert Links") {
+               my $page=quotemeta($q->param("page"));
                my $add="";
                foreach my $f ($q->param("attachment_select")) {
+                       $f=~s/^$page\///;
                        $add.="[[$f]]\n";
                }
                $form->field(name => 'editcontent',
@@ -180,7 +252,7 @@ sub formbuilder (@) { #{{{
        $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
 } # }}}
 
-sub attachment_location ($) {
+sub attachment_location ($) { #{{{
        my $page=shift;
        
        # Put the attachment in a subdir of the page it's attached
@@ -189,9 +261,9 @@ sub attachment_location ($) {
        $page.="/" if length $page;
        
        return $page;
-}
+} #}}}
 
-sub attachment_list ($) {
+sub attachment_list ($) { #{{{
        my $page=shift;
        my $loc=attachment_location($page);
 
@@ -213,9 +285,9 @@ sub attachment_list ($) {
        # Sort newer attachments to the top of the list, so a newly-added
        # attachment appears just before the form used to add it.
        return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;
-}
+} #}}}
 
-my %units=(            # size in bytes
+my %units=( #{{{       # size in bytes
        B               => 1,
        byte            => 1,
        KB              => 2 ** 10,
@@ -247,7 +319,7 @@ my %units=(         # size in bytes
        # ikiwiki, if you find you need larger data quantities, either modify
        # yourself to add them, or travel back in time to 2008 and kill me.
        #   -- Joey
-);
+); #}}}
 
 sub parsesize ($) { #{{{
        my $size=shift;
@@ -376,6 +448,9 @@ sub match_virusfree ($$;@) { #{{{
        waitpid $pid, 0;
        $SIG{PIPE}="DEFAULT";
        if ($sigpipe || $?) {
+               if (! length $reason) {
+                       $reason="virus checker $IkiWiki::config{virus_checker}; failed with no output";
+               }
                return IkiWiki::FailReason->new("file seems to contain a virus ($reason)");
        }
        else {
@@ -406,6 +481,9 @@ sub match_user ($$;@) { #{{{
        if (defined $params{user} && lc $params{user} eq lc $user) {
                return IkiWiki::SuccessReason->new("user is $user");
        }
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");
+       }
        else {
                return IkiWiki::FailReason->new("user is $params{user}, not $user");
        }