Merge commit 'origin'

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

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index a474f6e75f58b178b2b049fd1c4e590740a4d6f2..44781165cdaee4d6a0928d4dfe9ec5acc58cb066 100644 (file)
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -5,15 +5,87 @@ use warnings;
 use strict;
 use IkiWiki 2.00;
 
 use strict;
 use IkiWiki 2.00;
 

-# TODO move to admin prefs
-$config{valid_attachments}="(*.mp3 and maxsize(15mb)) or (!ispage() and maxsize(50kb))";
-

 sub import { #{{{
 sub import { #{{{

+       add_underlay("javascript");
+       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);
        hook(type => "checkconfig", id => "attachment", call => \&checkconfig);
        hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "attachment", call => \&formbuilder);

+       IkiWiki::loadplugin("filecheck");

 } # }}}
 
 } # }}}
 

+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
+               allowed_attachments => {
+                       type => "pagespec",
+                       example => "virusfree() and mimetype(image/*) and maxsize(50kb)",
+                       description => "enhanced PageSpec specifying what attachments are allowed",
+                       link => "ikiwiki/PageSpec/attachment",
+                       safe => 1,
+                       rebuild => 0,
+               },
+               virus_checker => {
+                       type => "string",
+                       example => "clamdscan -",
+                       description => "virus checker program (reads STDIN, returns nonzero if virus found)",
+                       safe => 0, # executed
+                       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 $IkiWiki::pagesources{$dest} &&
+           $IkiWiki::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;
 } #}}}
 sub checkconfig () { #{{{
        $config{cgi_disable_uploads}=0;
 } #}}}


@@ -21,68 +93,131 @@ sub checkconfig () { #{{{
 sub formbuilder_setup (@) { #{{{
        my %params=@_;
        my $form=$params{form};
 sub formbuilder_setup (@) { #{{{
        my %params=@_;
        my $form=$params{form};

+       my $q=$params{cgi};

 
 

-       return if $form->field("do") ne "edit";
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
+               # 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.
+               $form->tmpl_param("field-upload" => '<input name="_submit" type="submit" value="Upload Attachment" />');
+               $form->tmpl_param("field-link" => '<input name="_submit" type="submit" value="Insert Links" />');

 
 

-       $form->field(name => 'attachment', type => 'file');
+               # Add the toggle javascript; the attachments interface uses
+               # it to toggle visibility.
+               require IkiWiki::Plugin::toggle;
+               $form->tmpl_param("javascript" => IkiWiki::Plugin::toggle::include_javascript($params{page}, 1));
+               # Start with the attachments interface toggled invisible,
+               # but if it was used, keep it open.
+               if ($form->submitted ne "Upload Attachment" &&
+                   (! defined $q->param("attachment_select") ||
+                   ! length $q->param("attachment_select"))) {
+                       $form->tmpl_param("attachments-class" => "toggleable");
+               }
+               else {
+                       $form->tmpl_param("attachments-class" => "toggleable-open");
+               }
+       }
+       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 => "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) {
+                       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");
+                               }
+                       }
+               }
+       }

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

+       my $q=$params{cgi};

 
 

-       return if $form->field("do") ne "edit";
+       return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;

 
 

-       if ($form->submitted eq "Upload") {
-               my $q=$params{cgi};
-               my $filename=$q->param('attachment');
-               if (! defined $filename || ! length $filename) {
-                       # no file, so do nothing
-                       return;
-               }
+       my $filename=$q->param('attachment');
+       if (defined $filename && length $filename &&
+            ($form->submitted eq "Upload Attachment" || $form->submitted eq "Save Page")) {
+               my $session=$params{session};

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

-               
-               # Put the attachment in a subdir of the page it's attached
-               # to, unless that page is an "index" page.
-               my $page=$form->field('page');
-               $page=~s/(^|\/)index//;
-               $filename=$page."/".IkiWiki::basename($filename);
-               
-               # To untaint the filename, escape any hazardous characters,
-               # and make sure it isn't pruned.
-               $filename=IkiWiki::titlepage(IkiWiki::possibly_foolish_untaint($filename));
+               if (! defined $tempfile || ! length $tempfile) {
+                       # 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=linkpage(IkiWiki::possibly_foolish_untaint(
+                               attachment_location($form->field('page')).
+                               IkiWiki::basename($filename)));

                if (IkiWiki::file_pruned($filename, $config{srcdir})) {
                        error(gettext("bad attachment filename"));
                }
                
                # Check that the user is allowed to edit a page with the
                # name of the attachment.
                if (IkiWiki::file_pruned($filename, $config{srcdir})) {
                        error(gettext("bad attachment filename"));
                }
                
                # Check that the user is allowed to edit a page with the
                # name of the attachment.

-               IkiWiki::check_canedit($filename, $q, $params{session}, 1);
-               
-               # Use a pagespec to test that the attachment is valid.
-               if (exists $config{valid_attachments} &&
-                   length $config{valid_attachments}) {
-                       my $result=pagespec_match($filename, $config{valid_attachments},
-                               file => $tempfile);
-                       if (! $result) {
-                               error(gettext("attachment rejected")." ($result)");
-                       }
-               }
+               IkiWiki::check_canedit($filename, $q, $session, 1);
+               # And that the attachment itself is acceptable.
+               check_canattach($session, $filename, $tempfile);

 
 

-               # Needed for fast_file_copy.
+               # Needed for fast_file_copy and for rendering below.

                require IkiWiki::Render;
 
                # Move the attachment into place.
                # Try to use a fast rename; fall back to copying.
                IkiWiki::prep_writefile($filename, $config{srcdir});
                unlink($config{srcdir}."/".$filename);
                require IkiWiki::Render;
 
                # Move the attachment into place.
                # Try to use a fast rename; fall back to copying.
                IkiWiki::prep_writefile($filename, $config{srcdir});
                unlink($config{srcdir}."/".$filename);

-               if (! rename($tempfile, $config{srcdir}."/".$filename)) {
+               if (rename($tempfile, $config{srcdir}."/".$filename)) {
+                       # The temp file has tight permissions; loosen up.
+                       chmod(0666 & ~umask, $config{srcdir}."/".$filename);
+               }
+               else {

                        my $fh=$q->upload('attachment');
                        if (! defined $fh || ! ref $fh) {
                        my $fh=$q->upload('attachment');
                        if (! defined $fh || ! ref $fh) {

-                               error("failed to get filehandle");
+                               # needed by old CGI versions
+                               $fh=$q->param('attachment');
+                               if (! defined $fh || ! ref $fh) {
+                                       # even that doesn't always work,
+                                       # fall back to opening the tempfile
+                                       $fh=undef;
+                                       open($fh, "<", $tempfile) || error("failed to open \"$tempfile\": $!");
+                               }

                        }
                        binmode($fh);
                        writefile($filename, $config{srcdir}, undef, 1, sub {
                        }
                        binmode($fh);
                        writefile($filename, $config{srcdir}, undef, 1, sub {


@@ -90,84 +225,68 @@ sub formbuilder (@) { #{{{
                        });
                }
 
                        });
                }
 

-               # TODO add to vcs
-               
-               # TODO trigger a wiki build if there's no vcs
-       }
-} # }}}
-
-package IkiWiki::PageSpec;
-
-sub parsesize { #{{{
-       my $size=shift;
-       no warnings;
-       my $base=$size+0; # force to number
-       use warnings;
-       my $multiple=1;
-       if ($size=~/kb?$/i) {
-               $multiple=2**10;
-       }
-       elsif ($size=~/mb?$/i) {
-               $multiple=2**20;
-       }
-       elsif ($size=~/gb?$/i) {
-               $multiple=2**30;
-       }
-       elsif ($size=~/tb?$/i) {
-               $multiple=2**40;
-       }
-       return $base * $multiple;
-} #}}}
-
-sub match_maxsize ($$;@) { #{{{
-       shift;
-       my $maxsize=eval{parsesize(shift)};
-       if ($@) {
-               return IkiWiki::FailReason->new("unable to parse maxsize (or number too large)");
+               # Check the attachment in and trigger a wiki refresh.
+               if ($config{rcs}) {
+                       IkiWiki::rcs_add($filename);
+                       IkiWiki::disable_commit_hook();
+                       IkiWiki::rcs_commit($filename, gettext("attachment upload"),
+                               IkiWiki::rcs_prepedit($filename),
+                               $session->param("name"), $ENV{REMOTE_ADDR});
+                       IkiWiki::enable_commit_hook();
+                       IkiWiki::rcs_update();
+               }
+               IkiWiki::refresh();
+               IkiWiki::saveindex();

        }
        }

-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
+       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',
+                       value => $form->field('editcontent')."\n\n".$add,
+                       force => 1) if length $add;

        }
        }

+       
+       # Generate the attachment list only after having added any new
+       # attachments.
+       $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
+} # }}}

 
 

-       if (-s $params{file} > $maxsize) {
-               return IkiWiki::FailReason->new("file too large");
-       }
-       else {
-               return IkiWiki::SuccessReason->new("file not too large");
-       }
+sub attachment_location ($) { #{{{
+       my $page=shift;
+       
+       # Put the attachment in a subdir of the page it's attached
+       # to, unless that page is an "index" page.
+       $page=~s/(^|\/)index//;
+       $page.="/" if length $page;
+       
+       return $page;

 } #}}}
 
 } #}}}
 

-sub match_minsize ($$;@) { #{{{
-       shift;
-       my $minsize=eval{parsesize(shift)};
-       if ($@) {
-               return IkiWiki::FailReason->new("unable to parse minsize (or number too large)");
-       }
-
-       my %params=@_;
-       if (! exists $params{file}) {
-               return IkiWiki::FailReason->new("no file specified");
-       }
+sub attachment_list ($) { #{{{
+       my $page=shift;
+       my $loc=attachment_location($page);

 
 

-       if (-s $params{file} < $minsize) {
-               return IkiWiki::FailReason->new("file too small");
-       }
-       else {
-               return IkiWiki::SuccessReason->new("file not too small");
+       my @ret;
+       foreach my $f (values %pagesources) {
+               if (! defined pagetype($f) &&
+                   $f=~m/^\Q$loc\E[^\/]+$/ &&
+                   -e "$config{srcdir}/$f") {
+                       push @ret, {
+                               "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
+                               link => htmllink($page, $page, $f, noimageinline => 1),
+                               size => IkiWiki::Plugin::filecheck::humansize((stat(_))[7]),
+                               mtime => displaytime($IkiWiki::pagemtime{$f}),
+                       };
+               }

        }
        }

-} #}}}

 
 

-sub match_ispage ($$;@) { #{{{
-       my $filename=shift;
-
-       if (defined IkiWiki::pagetype($filename)) {
-               return IkiWiki::SuccessReason->new("file is a wiki page");
-       }
-       else {
-               return IkiWiki::FailReason->new("file is not a wiki page");
-       }
+       # 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;

 } #}}}
 
 1
 } #}}}
 
 1