X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8441d3153506bc704d97def187c7a77c10fa7e3f..8496dd9fb405eda149995615ead0a94a83298b91:/IkiWiki/Plugin/attachment.pm?ds=inline diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm index 690b61cbc..8c3ff887a 100644 --- a/IkiWiki/Plugin/attachment.pm +++ b/IkiWiki/Plugin/attachment.pm @@ -3,134 +3,149 @@ package IkiWiki::Plugin::attachment; use warnings; use strict; -use IkiWiki 2.00; +use IkiWiki 3.00; -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); -} # }}} - -sub checkconfig () { #{{{ - $config{cgi_disable_uploads}=0; -} #}}} + IkiWiki::loadplugin("filecheck"); +} -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 getsetup () { + return + plugin => { + safe => 1, + rebuild => 0, + section => "web", + }, + 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 attachment_list ($) { - my $page=shift; - my $loc=attachment_location($page); +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 - my @ret; - foreach my $f (values %pagesources) { - if (! defined IkiWiki::pagetype($f) && - $f=~m/^\Q$loc\E[^\/]+$/ && - -e "$config{srcdir}/$f") { - push @ret, { - "field-select" => '', - link => htmllink($page, $page, $f, noimageinline => 1), - size => (stat(_))[7], - mtime => displaytime($IkiWiki::pagemtime{$f}), - }; - } + # 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)); } - return @ret; + # 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}, + ); + } + + if (! $allowed) { + error(gettext("prohibited by allowed_attachments")." ($allowed)"); + } + else { + return 1; + } +} + +sub checkconfig () { + $config{cgi_disable_uploads}=0; } -sub formbuilder_setup (@) { #{{{ +sub formbuilder_setup (@) { my %params=@_; my $form=$params{form}; + my $q=$params{cgi}; - if ($form->field("do") eq "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'); - $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]); - # These buttons are not put in the usual place, so - # is not added to the normal formbuilder button list. + # are not added to the normal formbuilder button list. $form->tmpl_param("field-upload" => ''); $form->tmpl_param("field-link" => ''); - } - elsif ($form->title eq "preferences") { - my $session=$params{session}; - my $user_name=$session->param("name"); - $form->field(name => "allowed_attachments", size => 50, - fieldset => "admin", - comment => "(".htmllink("", "", "ikiwiki/PageSpec", noimageinline => 1).")"); - if (! IkiWiki::is_admin($user_name)) { - $form->field(name => "allowed_attachments", type => "hidden"); + # 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"); } - if (! $form->submitted) { - $form->field(name => "allowed_attachments", force => 1, - value => IkiWiki::userinfo_get($user_name, "allowed_attachments")); - } - 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"); - } + else { + $form->tmpl_param("attachments-class" => "toggleable-open"); } } -} #}}} +} -sub formbuilder (@) { #{{{ +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" || $form->submitted eq "Save Page") { + my $filename=Encode::decode_utf8($q->param('attachment')); + if (defined $filename && length $filename && + ($form->submitted eq "Upload Attachment" || $form->submitted eq "Save Page")) { my $session=$params{session}; - - my $filename=$q->param('attachment'); - if (! defined $filename || ! length $filename) { - # no file, so do nothing - return; - } # 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); - - $filename=IkiWiki::titlepage( - IkiWiki::possibly_foolish_untaint( + 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})) { + if (IkiWiki::file_pruned($filename)) { 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, $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); - 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; @@ -139,10 +154,21 @@ sub formbuilder (@) { #{{{ # 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) { - 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 { @@ -164,88 +190,56 @@ sub formbuilder (@) { #{{{ IkiWiki::saveindex(); } elsif ($form->submitted eq "Insert Links") { + my $page=quotemeta(Encode::decode_utf8($q->param("page"))); my $add=""; foreach my $f ($q->param("attachment_select")) { + $f=Encode::decode_utf8($f); + $f=~s/^$page\///; $add.="[[$f]]\n"; } $form->field(name => 'editcontent', value => $form->field('editcontent')."\n\n".$add, - force => 1); - } -} # }}} - -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)"); - } - - my %params=@_; - if (! exists $params{file}) { - return IkiWiki::FailReason->new("no file specified"); - } - - if (-s $params{file} > $maxsize) { - return IkiWiki::FailReason->new("file too large"); + force => 1) if length $add; } - else { - return IkiWiki::SuccessReason->new("file not too large"); - } -} #}}} + + # Generate the attachment list only after having added any new + # attachments. + $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]); +} -sub match_minsize ($$;@) { #{{{ - shift; - my $minsize=eval{parsesize(shift)}; - if ($@) { - return IkiWiki::FailReason->new("unable to parse minsize (or number 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; +} - 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" => '', + link => htmllink($page, $page, $f, noimageinline => 1), + size => IkiWiki::Plugin::filecheck::humansize((stat(_))[7]), + mtime => displaytime($IkiWiki::pagemtime{$f}), + mtime_raw => $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