X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/5aee8d937d694dc5ae43b85c6d81ce9d268d1626..c978c33da1ea9f68e22e9a310ef1bda9966ca40d:/IkiWiki/Plugin/attachment.pm

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index d2989bb8b..83dd120f6 100644
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -3,165 +3,391 @@ package IkiWiki::Plugin::attachment;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
-use CGI;
-$CGI::DISABLE_UPLOADS=0;
+use IkiWiki 3.00;
 
-# TODO move to admin prefs
-$config{valid_attachments}="(*.mp3 and maxsize(15mb)) or (!ispage() and maxsize(50kb))";
-
-sub import { #{{{
+sub import {
+	add_underlay("attachment");
+	add_underlay("javascript");
+	add_underlay("jquery");
+	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 => "formbuilder", id => "attachment", call => \&formbuilder, last => 1);
+	IkiWiki::loadplugin("filecheck");
+}
 
-sub formbuilder_setup { #{{{
-	my %params=@_;
-	my $form=$params{form};
+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,
+		},
+}
 
-	return if $form->field("do") ne "edit";
+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
 
-	$form->field(name => 'attachment', type => 'file');
-} #}}}
+	# 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));
+	}
 
-sub formbuilder (@) { #{{{
+	# 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 => $session->remote_addr(),
+		);
+	}
+
+	if (! $allowed) {
+		error(gettext("prohibited by allowed_attachments")." ($allowed)");
+	}
+	else {
+		return 1;
+	}
+}
+
+sub checkconfig () {
+	$config{cgi_disable_uploads}=0;
+}
+
+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" />');
 
-	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;
+		# Add all the javascript used by the attachments interface.
+		require IkiWiki::Plugin::toggle;
+		my $js=IkiWiki::Plugin::toggle::include_javascript($params{page});
+		$js.='<link rel="stylesheet" href="'.urlto("ikiwiki/jquery-ui.min.css", $params{page}).'" id="theme">'."\n";
+		my @jsfiles=qw{jquery.min jquery-ui.min
+			jquery.tmpl.min jquery.iframe-transport
+			jquery.fileupload jquery.fileupload-ui
+		};
+		foreach my $file (@jsfiles) {
+			$js.='<script src="'.urlto("ikiwiki/$file.js", $params{page}).
+			     '" type="text/javascript" charset="utf-8"></script>'."\n";
 		}
-		
-		# 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 (IkiWiki::file_pruned($filename, $config{srcdir})) {
-			error(gettext("bad attachment filename"));
+		$form->tmpl_param("javascript" => $js);
+
+		# 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");
 		}
 		
-		# 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)");
-			}
+		# Save attachments in holding area before previewing and
+		# saving.
+		if ($form->submitted eq "Preview" ||
+		    $form->submitted eq "Save Page") {
+			attachments_save($form, $params{session});
 		}
+	}
+}
 
-		# 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)) {
-			my $fh=$q->upload('attachment');
-			if (! defined $fh || ! ref $fh) {
-				error("failed to get filehandle");
-			}
-			binmode($fh);
-			writefile($filename, $config{srcdir}, undef, 1, sub {
-				IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
-			});
-		}
+sub formbuilder (@) {
+	my %params=@_;
+	my $form=$params{form};
+	my $q=$params{cgi};
 
-		# TODO add to vcs
-		
-		# TODO trigger a wiki build if there's no vcs
-	}
-} # }}}
+	return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;
 
-package IkiWiki::PageSpec;
+	my $filename=Encode::decode_utf8($q->param('attachment'));
+	if (defined $filename && length $filename) {
+		attachment_store($filename, $form, $q, $params{session});
+	}
 
-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;
+	if ($form->submitted eq "Save Page") {
+		attachments_save($form, $params{session});
 	}
-	elsif ($size=~/mb?$/i) {
-		$multiple=2**20;
+
+	if ($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\///;
+			if (IkiWiki::isinlinableimage($f) &&
+			    IkiWiki::Plugin::img->can("import")) {
+				$add.='[[!img '.$f.' align="right" size="" alt=""]]';
+			}
+			else {
+				$add.="[[$f]]";
+			}
+			$add.="\n";
+		}
+		$form->field(name => 'editcontent',
+			value => $form->field('editcontent')."\n\n".$add,
+			force => 1) if length $add;
 	}
-	elsif ($size=~/gb?$/i) {
-		$multiple=2**30;
+	
+	# Generate the attachment list only after having added any new
+	# attachments.
+	$form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
+}
+
+sub attachment_holding_location {
+	my $page=attachment_location(shift);
+
+	my $dir=$config{wikistatedir}."/attachments/".
+		IkiWiki::possibly_foolish_untaint(linkpage($page));
+	$dir=~s/\/$//;
+	return $dir;
+}
+
+sub is_held_attachment {
+	my $attachment=shift;
+
+	my $f=attachment_holding_location($attachment);
+	if (-f $f) {
+		return $f
 	}
-	elsif ($size=~/tb?$/i) {
-		$multiple=2**40;
+	else {
+		return undef;
 	}
-	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)");
+# Stores the attachment in a holding area, not yet in the wiki proper.
+sub attachment_store {
+	my $filename=shift;
+	my $form=shift;
+	my $q=shift;
+	my $session=shift;
+	
+	# 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) {
+		# 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");
+		}
 	}
 
-	my %params=@_;
-	if (! exists $params{file}) {
-		return IkiWiki::FailReason->new("no file specified");
+	$filename=IkiWiki::basename($filename);
+	$filename=~s/.*\\+(.+)/$1/; # hello, windows
+	$filename=IkiWiki::possibly_foolish_untaint(linkpage($filename));
+	my $dest=attachment_holding_location($form->field('page'));
+	
+	# Check that the user is allowed to edit the attachment.
+	my $final_filename=
+		linkpage(IkiWiki::possibly_foolish_untaint(
+			attachment_location($form->field('page')))).
+		$filename;
+	eval {
+		if (IkiWiki::file_pruned($final_filename)) {
+			error(gettext("bad attachment filename"));
+		}
+		IkiWiki::check_canedit($final_filename, $q, $session);
+		# And that the attachment itself is acceptable.
+		check_canattach($session, $final_filename, $tempfile);
+	};
+	if ($@) {
+		json_response($q, $form, $dest."/".$filename, $@);
+		error $@;
 	}
 
-	if (-s $params{file} > $maxsize) {
-		return IkiWiki::FailReason->new("file too large");
+	# Move the attachment into holding directory.
+	# Try to use a fast rename; fall back to copying.
+	IkiWiki::prep_writefile($filename, $dest);
+	unlink($dest."/".$filename);
+	if (rename($tempfile, $dest."/".$filename)) {
+		# The temp file has tight permissions; loosen up.
+		chmod(0666 & ~umask, $dest."/".$filename);
 	}
 	else {
-		return IkiWiki::SuccessReason->new("file not too large");
+		my $fh=$q->upload('attachment');
+		if (! defined $fh || ! ref $fh) {
+			# 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);
+		require IkiWiki::Render; 
+		writefile($filename, $dest, undef, 1, sub {
+			IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
+		});
 	}
-} #}}}
 
-sub match_minsize ($$;@) { #{{{
-	shift;
-	my $minsize=eval{parsesize(shift)};
-	if ($@) {
-		return IkiWiki::FailReason->new("unable to parse minsize (or number too large)");
+	json_response($q, $form, $dest."/".$filename, stored_msg());
+}
+
+# Save all stored attachments for a page.
+sub attachments_save {
+	my $form=shift;
+	my $session=shift;
+
+	# Move attachments out of holding directory.
+	my @attachments;
+	my $dir=attachment_holding_location($form->field('page'));
+	foreach my $filename (glob("$dir/*")) {
+		$filename=Encode::decode_utf8($filename);
+		next unless -f $filename;
+		my $destdir=linkpage(IkiWiki::possibly_foolish_untaint(
+			attachment_location($form->field('page'))));
+		my $absdestdir=$config{srcdir}."/".$destdir;
+		my $destfile=IkiWiki::basename($filename);
+		my $dest=$absdestdir.$destfile;
+		unlink($dest);
+		IkiWiki::prep_writefile($destfile, $absdestdir);
+		rename($filename, $dest);
+		push @attachments, $destdir.$destfile;
 	}
+	return unless @attachments;
+	require IkiWiki::Render;
+	IkiWiki::prune($dir, $config{wikistatedir}."/attachments");
 
-	my %params=@_;
-	if (! exists $params{file}) {
-		return IkiWiki::FailReason->new("no file specified");
+	# Check the attachments in and trigger a wiki refresh.
+	if ($config{rcs}) {
+		IkiWiki::rcs_add($_) foreach @attachments;
+		IkiWiki::disable_commit_hook();
+		IkiWiki::rcs_commit_staged(
+			message => gettext("attachment upload"),
+			session => $session,
+		);
+		IkiWiki::enable_commit_hook();
+		IkiWiki::rcs_update();
 	}
+	IkiWiki::refresh();
+	IkiWiki::saveindex();
+}
+
+sub attachment_location ($) {
+	my $page=shift;
+	
+	# Put the attachment in a subdir of the page it's attached
+	# to, unless that page is the "index" page.
+	return "" if $page eq 'index';
+	$page.="/" if length $page;
+	
+	return $page;
+}
+
+sub attachment_list ($) {
+	my $page=shift;
+	my $loc=attachment_location($page);
+
+	my $std=sub {
+		my $file=shift;
+		my $mtime=shift;
+		my $date=shift;
+		my $size=shift;
+
+		name => $file,
+		size => IkiWiki::Plugin::filecheck::humansize($size),
+		mtime => $date,
+		mtime_raw => $mtime,
+	};
 
-	if (-s $params{file} < $minsize) {
-		return IkiWiki::FailReason->new("file too small");
+	# attachments already in the wiki
+	my %attachments;
+	foreach my $f (values %pagesources) {
+		if (! defined pagetype($f) &&
+		    $f=~m/^\Q$loc\E[^\/]+$/) {
+			$attachments{$f}={
+				$std->($f, $IkiWiki::pagemtime{$f}, displaytime($IkiWiki::pagemtime{$f}), (stat($f))[7]),
+				link => htmllink($page, $page, $f, noimageinline => 1),
+			};
+		}
 	}
-	else {
-		return IkiWiki::SuccessReason->new("file not too small");
+	
+	# attachments in holding directory
+	my $dir=attachment_holding_location($page);
+	my $heldmsg=gettext("this attachment is not yet saved");
+	foreach my $file (glob("$dir/*")) {
+		$file=Encode::decode_utf8($file);
+		next unless -f $file;
+		my $base=IkiWiki::basename($file);
+		my $f=$loc.$base;
+		$attachments{$f}={
+			$std->($f, (stat($file))[9]*2, stored_msg(), (stat(_))[7]),
+			link => $base,
+		}
 	}
-} #}}}
 
-sub match_ispage ($$;@) { #{{{
+	# Sort newer attachments to the end of the list.
+	return sort { $a->{mtime_raw} <=> $b->{mtime_raw} || $a->{link} cmp $b->{link} }
+		values %attachments;
+}
+
+sub stored_msg {
+	gettext("just uploaded");
+}
+
+sub json_response ($$$$) {
+	my $q=shift;
+	my $form=shift;
 	my $filename=shift;
+	my $stored_msg=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");
+	if (! defined $form->submitted ||
+	    $form->submitted ne "Upload Attachment") {
+		eval q{use JSON};
+		error $@ if $@;
+		print "Content-type: text/html\n\n";
+		my $size=-s $filename;
+		print to_json([
+			{
+				name => IkiWiki::basename($filename),
+				size => $size,
+				humansize => IkiWiki::Plugin::filecheck::humansize($size),
+				stored_msg => $stored_msg,
+				
+			}
+		]);
+		exit 0;
 	}
-} #}}}
+}
 
 1