X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/22839215fbbafa51f69e3ce8d21cb3fa1fcc9d41..e2cb19ed9e107d89251655232649a6d2eb9c187b:/IkiWiki/Plugin/attachment.pm

diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm
index f49fe63f7..7f88010b5 100644
--- a/IkiWiki/Plugin/attachment.pm
+++ b/IkiWiki/Plugin/attachment.pm
@@ -3,34 +3,96 @@ 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);
-} # }}}
+	IkiWiki::loadplugin("filecheck");
+}
+
+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 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 => $session->remote_addr(),
+		);
+	}
+
+	if (! $allowed) {
+		error(gettext("prohibited by allowed_attachments")." ($allowed)");
+	}
+	else {
+		return 1;
+	}
+}
 
-sub checkconfig () { #{{{
+sub checkconfig () {
 	$config{cgi_disable_uploads}=0;
-} #}}}
+}
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
 	my %params=@_;
 	my $form=$params{form};
 	my $q=$params{cgi};
 
-	if (defined $form->field("do") && $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');
 		# 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" />');
 
-		# Add the javascript from the toggle plugin;
-		# the attachments interface uses it to toggle visibility.
+		# Add the toggle javascript; the attachments interface uses
+		# it to toggle visibility.
 		require IkiWiki::Plugin::toggle;
-		$form->tmpl_param("javascript" => $IkiWiki::Plugin::toggle::javascript);
+		$form->tmpl_param("javascript" => IkiWiki::Plugin::toggle::include_javascript($params{page}));
 		# Start with the attachments interface toggled invisible,
 		# but if it was used, keep it open.
 		if ($form->submitted ne "Upload Attachment" &&
@@ -42,133 +104,38 @@ sub formbuilder_setup (@) { #{{{
 			$form->tmpl_param("attachments-class" => "toggleable-open");
 		}
 	}
-	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/attachment", 
-					noimageinline => 1,
-					linktext => "Enhanced PageSpec",
-				).")"
-		);
-		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"));
-                }
-		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");
-			}
-		}
-	}
-} #}}}
+}
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
 	my %params=@_;
 	my $form=$params{form};
 	my $q=$params{cgi};
 
-	return if ! defined $form->field("do") || $form->field("do") ne "edit";
+	return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;
 
-	my $filename=$q->param('attachment');
+	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};
-		
-		# 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");
-		}
-
-		$filename=IkiWiki::titlepage(
-			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.
-		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)");
-		}
-
-		# 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);
-		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) {
-				# 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 {
-				IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
-			});
-		}
-
-		# 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();
+		attachment_store($filename, $form, $q, $params{session});
 	}
-	elsif ($form->submitted eq "Insert Links") {
+	if ($form->submitted eq "Save Page") {
+		attachments_save($form, $params{session});
+	}
+
+	if ($form->submitted eq "Insert Links") {
+		my $page=quotemeta(Encode::decode_utf8($q->param("page")));
 		my $add="";
 		foreach my $f ($q->param("attachment_select")) {
-			$add.="[[$f]]\n";
+			$f=Encode::decode_utf8($f);
+			$f=~s/^$page\///;
+			if (IkiWiki::isinlinableimage($f) &&
+			    UNIVERSAL::can("IkiWiki::Plugin::img", "import")) {
+				$add.='[[!img '.$f.' align="right" size="" alt=""]]';
+			}
+			else {
+				$add.="[[$f]]";
+			}
+			$add.="\n";
 		}
 		$form->field(name => 'editcontent',
 			value => $form->field('editcontent')."\n\n".$add,
@@ -178,7 +145,119 @@ sub formbuilder (@) { #{{{
 	# Generate the attachment list only after having added any new
 	# attachments.
 	$form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);
-} # }}}
+}
+
+sub attachment_holding_dir {
+	my $page=shift;
+
+	return $config{wikistatedir}."/attachments/".
+		IkiWiki::possibly_foolish_untaint(linkpage($page));
+}
+
+# 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");
+		}
+	}
+
+	$filename=IkiWiki::basename($filename);
+	$filename=~s/.*\\+(.+)/$1/; # hello, windows
+	$filename=IkiWiki::possibly_foolish_untaint(linkpage($filename));
+	
+	# Check that the user is allowed to edit the attachment.
+	my $final_filename=
+		linkpage(IkiWiki::possibly_foolish_untaint(
+			attachment_location($form->field('page')))).
+		$filename;
+	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);
+
+	# Move the attachment into holding directory.
+	# Try to use a fast rename; fall back to copying.
+	my $dest=attachment_holding_dir($form->field('page'));
+	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 {
+		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);
+		# Needed for fast_file_copy.
+		require IkiWiki::Render;
+		writefile($filename, $dest, undef, 1, sub {
+			IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);
+		});
+	}
+}
+
+# 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_dir($form->field('page'));
+	foreach my $filename (glob("$dir/*")) {
+		next unless -f $filename;
+		my $dest=$config{srcdir}."/".
+			linkpage(IkiWiki::possibly_foolish_untaint(
+				attachment_location($form->field('page')))).
+			$filename;
+		unlink($dest);
+		rename($filename, $dest);
+		push @attachments, $dest;
+	}
+	return unless @attachments;
+	rmdir($dir);
+
+	# 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;
@@ -195,237 +274,39 @@ sub attachment_list ($) {
 	my $page=shift;
 	my $loc=attachment_location($page);
 
-	my @ret;
+	# attachments already in the wiki
+	my %attachments;
 	foreach my $f (values %pagesources) {
-		if (! defined IkiWiki::pagetype($f) &&
-		    $f=~m/^\Q$loc\E[^\/]+$/ &&
-		    -e "$config{srcdir}/$f") {
-			push @ret, {
+		if (! defined pagetype($f) &&
+		    $f=~m/^\Q$loc\E[^\/]+$/) {
+			$attachments{$f}={
 				"field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
 				link => htmllink($page, $page, $f, noimageinline => 1),
-				size => humansize((stat(_))[7]),
+				size => IkiWiki::Plugin::filecheck::humansize((stat($f))[7]),
 				mtime => displaytime($IkiWiki::pagemtime{$f}),
 				mtime_raw => $IkiWiki::pagemtime{$f},
 			};
 		}
 	}
+	
+	# attachments in holding directory
+	my $dir=attachment_holding_dir($page);
+	foreach my $file (glob("$dir/*")) {
+		my $mtime=(stat($file))[9];
+		my $f=IkiWiki::basename($file);
+		$attachments{$f}={
+			"field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',
+			link => $f, # no link possible
+			size => IkiWiki::Plugin::filecheck::humansize((stat($file))[7]),
+			mtime => displaytime($mtime),
+			mtime_raw => $mtime,
+		}
+	}
 
 	# 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;
+	return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} }
+		values %attachments;
 }
 
-my %units=(		# size in bytes
-	B		=> 1,
-	byte		=> 1,
-	KB		=> 2 ** 10,
-	kilobyte 	=> 2 ** 10,
-	K		=> 2 ** 10,
-	KB		=> 2 ** 10,
-	kilobyte 	=> 2 ** 10,
-	M		=> 2 ** 20,
-	MB		=> 2 ** 20,
-	megabyte	=> 2 ** 20,
-	G		=> 2 ** 30,
-	GB		=> 2 ** 30,
-	gigabyte	=> 2 ** 30,
-	T		=> 2 ** 40,
-	TB		=> 2 ** 40,
-	terabyte	=> 2 ** 40,
-	P		=> 2 ** 50,
-	PB		=> 2 ** 50,
-	petabyte	=> 2 ** 50,
-	E		=> 2 ** 60,
-	EB		=> 2 ** 60,
-	exabyte		=> 2 ** 60,
-	Z		=> 2 ** 70,
-	ZB		=> 2 ** 70,
-	zettabyte	=> 2 ** 70,
-	Y		=> 2 ** 80,
-	YB		=> 2 ** 80,
-	yottabyte	=> 2 ** 80,
-	# 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;
-
-	no warnings;
-	my $base=$size+0; # force to number
-	use warnings;
-	foreach my $unit (sort keys %units) {
-		if ($size=~/[0-9\s]\Q$unit\E$/i) {
-			return $base * $units{$unit};
-		}
-	}
-	return $base;
-} #}}}
-
-sub humansize ($) { #{{{
-	my $size=shift;
-
-	foreach my $unit (reverse sort { $units{$a} <=> $units{$b} || $b cmp $a } keys %units) {
-		if ($size / $units{$unit} > 0.25) {
-			return (int($size / $units{$unit} * 10)/10).$unit;
-		}
-	}
-	return $size; # near zero, or negative
-} #}}}
-
-package IkiWiki::PageSpec;
-
-sub match_maxsize ($$;@) { #{{{
-	shift;
-	my $maxsize=eval{IkiWiki::Plugin::attachment::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 (".(-s $params{file})." >  $maxsize)");
-	}
-	else {
-		return IkiWiki::SuccessReason->new("file not too large");
-	}
-} #}}}
-
-sub match_minsize ($$;@) { #{{{
-	shift;
-	my $minsize=eval{IkiWiki::Plugin::attachment::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");
-	}
-
-	if (-s $params{file} < $minsize) {
-		return IkiWiki::FailReason->new("file too small");
-	}
-	else {
-		return IkiWiki::SuccessReason->new("file not too small");
-	}
-} #}}}
-
-sub match_mimetype ($$;@) { #{{{
-	shift;
-	my $wanted=shift;
-
-	my %params=@_;
-	if (! exists $params{file}) {
-		return IkiWiki::FailReason->new("no file specified");
-	}
-
-	# Use ::magic to get the mime type, the idea is to only trust
-	# data obtained by examining the actual file contents.
-	eval q{use File::MimeInfo::Magic};
-	if ($@) {
-		return IkiWiki::FailReason->new("failed to load File::MimeInfo::Magic ($@); cannot check MIME type");
-	}
-	my $mimetype=File::MimeInfo::Magic::magic($params{file});
-	if (! defined $mimetype) {
-		$mimetype="unknown";
-	}
-
-	my $regexp=IkiWiki::glob2re($wanted);
-	if ($mimetype!~/^$regexp$/i) {
-		return IkiWiki::FailReason->new("file MIME type is $mimetype, not $wanted");
-	}
-	else {
-		return IkiWiki::SuccessReason->new("file MIME type is $mimetype");
-	}
-} #}}}
-
-sub match_virusfree ($$;@) { #{{{
-	shift;
-	my $wanted=shift;
-
-	my %params=@_;
-	if (! exists $params{file}) {
-		return IkiWiki::FailReason->new("no file specified");
-	}
-
-	if (! exists $IkiWiki::config{virus_checker} ||
-	    ! length $IkiWiki::config{virus_checker}) {
-		return IkiWiki::FailReason->new("no virus_checker configured");
-	}
-
-	# The file needs to be fed into the virus checker on stdin,
-	# because the file is not world-readable, and if clamdscan is
-	# used, clamd would fail to read it.
-	eval q{use IPC::Open2};
-	error($@) if $@;
-	open (IN, "<", $params{file}) || return IkiWiki::FailReason->new("failed to read file");
-	binmode(IN);
-	my $sigpipe=0;
-	$SIG{PIPE} = sub { $sigpipe=1 };
-	my $pid=open2(\*CHECKER_OUT, "<&IN", $IkiWiki::config{virus_checker}); 
-	my $reason=<CHECKER_OUT>;
-	chomp $reason;
-	1 while (<CHECKER_OUT>);
-	close(CHECKER_OUT);
-	waitpid $pid, 0;
-	$SIG{PIPE}="DEFAULT";
-	if ($sigpipe || $?) {
-		return IkiWiki::FailReason->new("file seems to contain a virus ($reason)");
-	}
-	else {
-		return IkiWiki::SuccessReason->new("file seems virusfree ($reason)");
-	}
-} #}}}
-
-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");
-	}
-} #}}}
-
-sub match_user ($$;@) { #{{{
-	shift;
-	my $user=shift;
-	my %params=@_;
-	
-	if (! exists $params{user}) {
-		return IkiWiki::FailReason->new("no user specified");
-	}
-
-	if (defined $params{user} && lc $params{user} eq lc $user) {
-		return IkiWiki::SuccessReason->new("user is $user");
-	}
-	else {
-		return IkiWiki::FailReason->new("user is $params{user}, not $user");
-	}
-} #}}}
-
-sub match_ip ($$;@) { #{{{
-	shift;
-	my $ip=shift;
-	my %params=@_;
-	
-	if (! exists $params{ip}) {
-		return IkiWiki::FailReason->new("no IP specified");
-	}
-
-	if (defined $params{ip} && lc $params{ip} eq lc $ip) {
-		return IkiWiki::SuccessReason->new("IP is $ip");
-	}
-	else {
-		return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
-	}
-} #}}}
-
 1