X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/abd233931247ef38f1b084afd5906619f02c13b6..295a08394f1f962459d26db06624ff5d17bc3008:/IkiWiki/Plugin/comments.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index ed75a6e46..d9183970d 100644
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -22,12 +22,16 @@ sub import {
 	hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
 	hook(type => "getsetup", id => 'comments',  call => \&getsetup);
 	hook(type => "preprocess", id => 'comment', call => \&preprocess);
+	hook(type => "preprocess", id => 'commentmoderation', call => \&preprocess_moderation);
 	# here for backwards compatability with old comments
 	hook(type => "preprocess", id => '_comment', call => \&preprocess);
 	hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
 	hook(type => "htmlize", id => "_comment", call => \&htmlize);
+	hook(type => "htmlize", id => "_comment_pending",
+		call => \&htmlize_pending);
 	hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
-	hook(type => "formbuilder_setup", id => "comments", call => \&formbuilder_setup);
+	hook(type => "formbuilder_setup", id => "comments",
+		call => \&formbuilder_setup);
 	# Load goto to fix up user page links for logged-in commenters
 	IkiWiki::loadplugin("goto");
 	IkiWiki::loadplugin("inline");
@@ -104,6 +108,14 @@ sub htmlize {
 	return $params{content};
 }
 
+sub htmlize_pending {
+	my %params = @_;
+	return sprintf(gettext("this comment needs %s"),
+		'<a href="'.
+		IkiWiki::cgiurl(do => "commentmoderation").'">'.
+		gettext("moderation").'</a>');
+}
+
 # FIXME: copied verbatim from meta
 sub safeurl ($) {
 	my $url=shift;
@@ -131,8 +143,6 @@ sub preprocess {
 	}
 	$content =~ s/\\"/"/g;
 
-	$content = IkiWiki::filter($page, $params{destpage}, $content);
-
 	if ($config{comments_allowdirectives}) {
 		$content = IkiWiki::preprocess($page, $params{destpage},
 			$content);
@@ -166,7 +176,7 @@ sub preprocess {
 		if (defined $oiduser) {
 			# looks like an OpenID
 			$commentauthorurl = $commentuser;
-			$commentauthor = $oiduser;
+			$commentauthor = (defined $params{nickname} && length $params{nickname}) ? $params{nickname} : $oiduser;
 			$commentopenid = $commentuser;
 		}
 		else {
@@ -227,7 +237,7 @@ sub preprocess {
 	}
 
 	if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {
-		$pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
+		$pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page})).
 			"#".page_to_id($params{page});
 	}
 
@@ -240,6 +250,22 @@ sub preprocess {
 	return $content;
 }
 
+sub preprocess_moderation {
+	my %params = @_;
+
+	$params{desc}=gettext("Comment Moderation")
+		unless defined $params{desc};
+
+	if (length $config{cgiurl}) {
+		return '<a href="'.
+			IkiWiki::cgiurl(do => 'commentmoderation').
+			'">'.$params{desc}.'</a>';
+	}
+	else {
+		return $params{desc};
+	}
+}
+
 sub sessioncgi ($$) {
 	my $cgi=shift;
 	my $session=shift;
@@ -251,6 +277,10 @@ sub sessioncgi ($$) {
 	elsif ($do eq 'commentmoderation') {
 		commentmoderation($cgi, $session);
 	}
+	elsif ($do eq 'commentsignin') {
+		IkiWiki::cgi_signin($cgi, $session);
+		exit;
+	}
 }
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
@@ -271,10 +301,10 @@ sub editcomment ($$) {
 		required => [qw{editcontent}],
 		javascript => 0,
 		params => $cgi,
-		action => $config{cgiurl},
+		action => IkiWiki::cgiurl(),
 		header => 0,
 		table => 0,
-		template => template('editcomment.tmpl'),
+		template => { template('editcomment.tmpl') },
 	);
 
 	IkiWiki::decode_form_utf8($form);
@@ -328,24 +358,22 @@ sub editcomment ($$) {
 
 	if (! defined $session->param('name')) {
 		# Make signinurl work and return here.
-		$form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'signin'));
+		$form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'commentsignin'));
 		$session->param(postsignin => $ENV{QUERY_STRING});
 		IkiWiki::cgi_savesession($session);
 	}
 
 	# The untaint is OK (as in editpage) because we're about to pass
-	# it to file_pruned anyway
-	my $page = $form->field('page');
+	# it to file_pruned and wiki_file_regexp anyway.
+	my $page = $form->field('page')=~/$config{wiki_file_regexp}/;
 	$page = IkiWiki::possibly_foolish_untaint($page);
 	if (! defined $page || ! length $page ||
 		IkiWiki::file_pruned($page)) {
 		error(gettext("bad page name"));
 	}
 
-	my $baseurl = urlto($page, undef, 1);
-
 	$form->title(sprintf(gettext("commenting on %s"),
-			IkiWiki::pagetitle($page)));
+			IkiWiki::pagetitle(IkiWiki::basename($page))));
 
 	$form->tmpl_param('helponformattinglink',
 		htmllink($page, $page, 'ikiwiki/formatting',
@@ -355,8 +383,7 @@ sub editcomment ($$) {
 
 	if ($form->submitted eq CANCEL) {
 		# bounce back to the page they wanted to comment on, and exit.
-		# CANCEL need not be considered in future
-		IkiWiki::redirect($cgi, urlto($page, undef, 1));
+		IkiWiki::redirect($cgi, urlto($page));
 		exit;
 	}
 
@@ -381,14 +408,18 @@ sub editcomment ($$) {
 
 	my $content = "[[!comment format=$type\n";
 
-	# FIXME: handling of double quotes probably wrong?
 	if (defined $session->param('name')) {
 		my $username = $session->param('name');
 		$username =~ s/"/&quot;/g;
 		$content .= " username=\"$username\"\n";
 	}
-	elsif (defined $ENV{REMOTE_ADDR}) {
-		my $ip = $ENV{REMOTE_ADDR};
+	if (defined $session->param('nickname')) {
+		my $nickname = $session->param('nickname');
+		$nickname =~ s/"/&quot;/g;
+		$content .= " nickname=\"$nickname\"\n";
+	}
+	elsif (defined $session->remote_addr()) {
+		my $ip = $session->remote_addr();
 		if ($ip =~ m/^([.0-9]+)$/) {
 			$content .= " ip=\"$1\"\n";
 		}
@@ -418,7 +449,8 @@ sub editcomment ($$) {
 
 	$content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
-	my $editcontent = $form->field('editcontent') || '';
+	my $editcontent = $form->field('editcontent');
+	$editcontent="" if ! defined $editcontent;
 	$editcontent =~ s/\r\n/\n/g;
 	$editcontent =~ s/\r/\n/g;
 	$editcontent =~ s/"/\\"/g;
@@ -462,11 +494,17 @@ sub editcomment ($$) {
 		$postcomment=0;
 
 		if (! $ok) {
-			my $penddir=$config{wikistatedir}."/comments_pending";
-			$location=unique_comment_location($page, $content, $penddir);
-			writefile("$location._comment", $penddir, $content);
+			$location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");
+			writefile("$location._comment_pending", $config{srcdir}, $content);
+
+			# Refresh so anything that deals with pending
+			# comments can be updated.
+			require IkiWiki::Render;
+			IkiWiki::refresh();
+			IkiWiki::saveindex();
+
 			IkiWiki::printheader($session);
-			print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
+			print IkiWiki::cgitemplate($cgi, gettext(gettext("comment stored for moderation")),
 				"<p>".
 				gettext("Your comment will be posted after moderator review").
 				"</p>");
@@ -491,8 +529,10 @@ sub editcomment ($$) {
 
 			IkiWiki::rcs_add($file);
 			IkiWiki::disable_commit_hook();
-			$conflict = IkiWiki::rcs_commit_staged($message,
-				$session->param('name'), $ENV{REMOTE_ADDR});
+			$conflict = IkiWiki::rcs_commit_staged(
+				message => $message,
+				session => $session,
+			);
 			IkiWiki::enable_commit_hook();
 			IkiWiki::rcs_update();
 		}
@@ -509,13 +549,13 @@ sub editcomment ($$) {
 		# Jump to the new comment on the page.
 		# The trailing question mark tries to avoid broken
 		# caches and get the most recent version of the page.
-		IkiWiki::redirect($cgi, urlto($page, undef, 1).
+		IkiWiki::redirect($cgi, urlto($page).
 			"?updated#".page_to_id($location));
 
 	}
 	else {
-		IkiWiki::showform ($form, \@buttons, $session, $cgi,
-			forcebaseurl => $baseurl);
+		IkiWiki::showform($form, \@buttons, $session, $cgi,
+			page => $page);
 	}
 
 	exit;
@@ -540,21 +580,25 @@ sub commentmoderation ($$) {
 		my %vars=$cgi->Vars;
 		my $added=0;
 		foreach my $id (keys %vars) {
-			if ($id =~ /(.*)\Q._comment\E$/) {
+			if ($id =~ /(.*)\._comment(?:_pending)?$/) {
+				$id=decode_utf8($id);
 				my $action=$cgi->param($id);
 				next if $action eq 'Defer' && ! $rejectalldefer;
 
 				# Make sure that the id is of a legal
-				# pending comment before untainting.
-				my ($f)= $id =~ /$config{wiki_file_regexp}/;
+				# pending comment.
+				my ($f) = $id =~ /$config{wiki_file_regexp}/;
 				if (! defined $f || ! length $f ||
 				    IkiWiki::file_pruned($f)) {
 					error("illegal file");
 				}
 
-				my $page=IkiWiki::possibly_foolish_untaint(IkiWiki::dirname($1));
-				my $file="$config{wikistatedir}/comments_pending/".
-					IkiWiki::possibly_foolish_untaint($id);
+				my $page=IkiWiki::dirname($f);
+				my $file="$config{srcdir}/$f";
+				if (! -e $file) {
+					# old location
+					$file="$config{wikistatedir}/comments_pending/".$f;
+				}
 
 				if ($action eq 'Accept') {
 					my $content=eval { readfile($file) };
@@ -567,9 +611,6 @@ sub commentmoderation ($$) {
 					$added++;
 				}
 
-				# This removes empty subdirs, so the
-				# .ikiwiki/comments_pending dir will
-				# go away when all are moderated.
 				require IkiWiki::Render;
 				IkiWiki::prune($file);
 			}
@@ -580,8 +621,10 @@ sub commentmoderation ($$) {
 			if ($config{rcs} and $config{comments_commit}) {
 				my $message = gettext("Comment moderation");
 				IkiWiki::disable_commit_hook();
-				$conflict=IkiWiki::rcs_commit_staged($message,
-					$session->param('name'), $ENV{REMOTE_ADDR});
+				$conflict=IkiWiki::rcs_commit_staged(
+					message => $message,
+					session => $session,
+				);
 				IkiWiki::enable_commit_hook();
 				IkiWiki::rcs_update();
 			}
@@ -596,28 +639,28 @@ sub commentmoderation ($$) {
 	}
 
 	my @comments=map {
-		my ($id, $ctime)=@{$_};
-		my $file="$config{wikistatedir}/comments_pending/$id";
-		my $content=readfile($file);
+		my ($id, $dir, $ctime)=@{$_};
+		my $content=readfile("$dir/$id");
 		my $preview=previewcomment($content, $id,
-			IkiWiki::dirname($_), $ctime);
+			$id, $ctime);
 		{
 			id => $id,
 			view => $preview,
-		} 
-	} sort { $b->[1] <=> $a->[1] } comments_pending();
+		}
+	} sort { $b->[2] <=> $a->[2] } comments_pending();
 
 	my $template=template("commentmoderation.tmpl");
 	$template->param(
 		sid => $session->id,
 		comments => \@comments,
+		cgiurl => IkiWiki::cgiurl(),
 	);
 	IkiWiki::printheader($session);
 	my $out=$template->output;
 	IkiWiki::run_hooks(format => sub {
 		$out = shift->(page => "", content => $out);
 	});
-	print IkiWiki::misctemplate(gettext("comment moderation"), $out);
+	print IkiWiki::cgitemplate($cgi, gettext("comment moderation"), $out);
 	exit;
 }
 
@@ -635,26 +678,43 @@ sub formbuilder_setup (@) {
 }
 
 sub comments_pending () {
-	my $dir="$config{wikistatedir}/comments_pending/";
-	return unless -d $dir;
-
 	my @ret;
+
 	eval q{use File::Find};
 	error($@) if $@;
-	find({
-		no_chdir => 1,
-		wanted => sub {
-			my $file=decode_utf8($_);
-			$file=~s/^\Q$dir\E\/?//;
-			return if ! length $file || IkiWiki::file_pruned($file)
-				|| -l $_ || -d _ || $file !~ /\Q._comment\E$/;
-			my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
-			if (defined $f) {
-				my $ctime=(stat($_))[10];
-				push @ret, [$f, $ctime];
+	eval q{use Cwd};
+	error($@) if $@;
+	my $origdir=getcwd();
+
+	my $find_comments=sub {
+		my $dir=shift;
+		my $extension=shift;
+		return unless -d $dir;
+
+		chdir($dir) || die "chdir $dir: $!";
+
+		find({
+			no_chdir => 1,
+			wanted => sub {
+				my $file=decode_utf8($_);
+				$file=~s/^\.\///;
+				return if ! length $file || IkiWiki::file_pruned($file)
+					|| -l $_ || -d _ || $file !~ /\Q$extension\E$/;
+				my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+				if (defined $f) {
+					my $ctime=(stat($_))[10];
+					push @ret, [$f, $dir, $ctime];
+				}
 			}
-		}
-	}, $dir);
+		}, ".");
+
+		chdir($origdir) || die "chdir $origdir: $!";
+	};
+	
+	$find_comments->($config{srcdir}, "._comment_pending");
+	# old location
+	$find_comments->("$config{wikistatedir}/comments_pending/",
+		"._comment");
 
 	return @ret;
 }
@@ -665,6 +725,10 @@ sub previewcomment ($$$) {
 	my $page=shift;
 	my $time=shift;
 
+	# Previewing a comment should implicitly enable comment posting mode.
+	my $oldpostcomment=$postcomment;
+	$postcomment=1;
+
 	my $preview = IkiWiki::htmlize($location, $page, '_comment',
 			IkiWiki::linkify($location, $page,
 			IkiWiki::preprocess($location, $page,
@@ -672,7 +736,8 @@ sub previewcomment ($$$) {
 
 	my $template = template("comment.tmpl");
 	$template->param(content => $preview);
-	$template->param(ctime => displaytime($time));
+	$template->param(ctime => displaytime($time, undef, 1));
+	$template->param(html5 => $config{html5});
 
 	IkiWiki::run_hooks(pagetemplate => sub {
 		shift->(page => $location,
@@ -682,13 +747,15 @@ sub previewcomment ($$$) {
 
 	$template->param(have_actions => 0);
 
+	$postcomment=$oldpostcomment;
+
 	return $template->output;
 }
 
 sub commentsshown ($) {
 	my $page=shift;
 
-	return ! pagespec_match($page, "internal(*/$config{comments_pagename}*)",
+	return ! pagespec_match($page, "comment(*)",
 	                        location => $page) &&
 	       pagespec_match($page, $config{comments_pagespec},
 	                      location => $page);
@@ -718,7 +785,7 @@ sub pagetemplate (@) {
 		my $comments = undef;
 		if ($shown) {
 			$comments = IkiWiki::preprocess_inline(
-				pages => "internal($page/$config{comments_pagename}*)",
+				pages => "comment($page)",
 				template => 'comment',
 				show => 0,
 				reverse => 'yes',
@@ -741,14 +808,14 @@ sub pagetemplate (@) {
 	if ($shown) {
 		if ($template->query(name => 'commentsurl')) {
 			$template->param(commentsurl =>
-				urlto($page, undef, 1).'#comments');
+				urlto($page).'#comments');
 		}
 
 		if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
 			# This will 404 until there are some comments, but I
 			# think that's probably OK...
 			$template->param(atomcommentsurl =>
-				urlto($page, undef, 1).'comments.atom');
+				urlto($page).'comments.atom');
 		}
 
 		if ($template->query(name => 'commentslink')) {
@@ -829,24 +896,23 @@ sub num_comments ($$) {
 	my $dir=shift;
 
 	my @comments=glob("$dir/$page/$config{comments_pagename}*._comment");
-	return @comments;
+	return int @comments;
 }
 
-sub unique_comment_location ($$$) {
+sub unique_comment_location ($$$$) {
 	my $page=shift;
-
 	eval q{use Digest::MD5 'md5_hex'};
 	error($@) if $@;
 	my $content_md5=md5_hex(Encode::encode_utf8(shift));
-
 	my $dir=shift;
+	my $ext=shift || "._comment";
 
 	my $location;
 	my $i = num_comments($page, $dir);
 	do {
 		$i++;
 		$location = "$page/$config{comments_pagename}${i}_${content_md5}";
-	} while (-e "$dir/$location._comment");
+	} while (-e "$dir/$location$ext");
 
 	return $location;
 }
@@ -872,7 +938,41 @@ sub match_postcomment ($$;@) {
 	if (! $postcomment) {
 		return IkiWiki::FailReason->new("not posting a comment");
 	}
-	return match_glob($page, $glob);
+	return match_glob($page, $glob, @_);
+}
+
+sub match_comment ($$;@) {
+	my $page = shift;
+	my $glob = shift;
+
+	if (! $postcomment) {
+		# To see if it's a comment, check the source file type.
+		# Deal with comments that were just deleted.
+		my $source=exists $IkiWiki::pagesources{$page} ?
+			$IkiWiki::pagesources{$page} :
+			$IkiWiki::delpagesources{$page};
+		my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+		if (! defined $type || $type ne "_comment") {
+			return IkiWiki::FailReason->new("$page is not a comment");
+		}
+	}
+
+	return match_glob($page, "$glob/*", internal => 1, @_);
+}
+
+sub match_comment_pending ($$;@) {
+	my $page = shift;
+	my $glob = shift;
+	
+	my $source=exists $IkiWiki::pagesources{$page} ?
+		$IkiWiki::pagesources{$page} :
+		$IkiWiki::delpagesources{$page};
+	my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+	if (! defined $type || $type ne "_comment_pending") {
+		return IkiWiki::FailReason->new("$page is not a pending comment");
+	}
+
+	return match_glob($page, "$glob/*", internal => 1, @_);
 }
 
 1