X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/613a54a3cb48ff0bd00c02d44304ce08b6725343..d7855474fdf6002711ef3d0411ece375ce44015d:/IkiWiki/Plugin/comments.pm

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 1eb256da9..2ca2d0a1d 100644
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -17,7 +17,7 @@ use constant CANCEL => "Cancel";
 
 my $postcomment;
 
-sub import { #{{{
+sub import {
 	hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
 	hook(type => "getsetup", id => 'comments',  call => \&getsetup);
 	hook(type => "preprocess", id => '_comment', call => \&preprocess);
@@ -26,37 +26,32 @@ sub import { #{{{
 	hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
 	hook(type => "cgi", id => "comments", call => \&linkcgi);
 	IkiWiki::loadplugin("inline");
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
 	return
 		plugin => {
 			safe => 1,
 			rebuild => 1,
 		},
-		# Pages where comments are shown, but new comments are not
-		# allowed, will show "Comments are closed".
-		comments_shown_pagespec => {
+		comments_pagespec => {
 			type => 'pagespec',
-			example => 'blog/*',
-			default => '',
-			description => 'PageSpec for pages where comments will be shown inline',
+			example => 'blog/* and !*/Discussion',
+			description => 'PageSpec of pages where comments are allowed',
 			link => 'ikiwiki/PageSpec',
 			safe => 1,
 			rebuild => 1,
 		},
-		comments_open_pagespec => {
+		comments_closed_pagespec => {
 			type => 'pagespec',
-			example => 'blog/* and created_after(close_old_comments)',
-			default => '',
-			description => 'PageSpec for pages where new comments can be posted',
+			example => 'blog/controversial or blog/flamewar',
+			description => 'PageSpec of pages where posting new comments is not allowed',
 			link => 'ikiwiki/PageSpec',
 			safe => 1,
 			rebuild => 1,
 		},
 		comments_pagename => {
 			type => 'string',
-			example => 'comment_',
 			default => 'comment_',
 			description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
 			safe => 0, # manual page moving required
@@ -64,7 +59,6 @@ sub getsetup () { #{{{
 		},
 		comments_allowdirectives => {
 			type => 'boolean',
-			default => 0,
 			example => 0,
 			description => 'Interpret directives in comments?',
 			safe => 1,
@@ -72,7 +66,6 @@ sub getsetup () { #{{{
 		},
 		comments_allowauthor => {
 			type => 'boolean',
-			default => 0,
 			example => 0,
 			description => 'Allow anonymous commenters to set an author name?',
 			safe => 1,
@@ -81,22 +74,32 @@ sub getsetup () { #{{{
 		comments_commit => {
 			type => 'boolean',
 			example => 1,
-			default => 1,
 			description => 'commit comments to the VCS',
 			# old uncommitted comments are likely to cause
 			# confusion if this is changed
 			safe => 0,
 			rebuild => 0,
 		},
-} #}}}
+}
+
+sub checkconfig () {
+	$config{comments_commit} = 1
+		unless defined $config{comments_commit};
+	$config{comments_pagespec} = ''
+		unless defined $config{comments_pagespec};
+	$config{comments_closed_pagespec} = ''
+		unless defined $config{comments_closed_pagespec};
+	$config{comments_pagename} = 'comment_'
+		unless defined $config{comments_pagename};
+}
 
-sub htmlize { # {{{
+sub htmlize {
 	my %params = @_;
 	return $params{content};
-} # }}}
+}
 
 # FIXME: copied verbatim from meta
-sub safeurl ($) { #{{{
+sub safeurl ($) {
 	my $url=shift;
 	if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
 	    defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
@@ -105,9 +108,9 @@ sub safeurl ($) { #{{{
 	else {
 		return 1;
 	}
-} #}}}
+}
 
-sub preprocess { # {{{
+sub preprocess {
 	my %params = @_;
 	my $page = $params{page};
 
@@ -206,16 +209,10 @@ sub preprocess { # {{{
 	# FIXME: hard-coded HTML (although it's just to set an ID)
 	return "<div id=\"$anchor\">$content</div>" if $anchor;
 	return $content;
-} # }}}
-
-sub checkconfig () { #{{{
-	$config{comments_commit} = 1 unless defined $config{comments_commit};
-	$config{comments_pagename} = 'comment_'
-		unless defined $config{comments_pagename};
-} #}}}
+}
 
 # This is exactly the same as recentchanges_link :-(
-sub linkcgi ($) { #{{{
+sub linkcgi ($) {
 	my $cgi=shift;
 	if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 
@@ -245,7 +242,7 @@ sub linkcgi ($) { #{{{
 
 # FIXME: basically the same logic as recentchanges
 # returns (author URL, pretty-printed version)
-sub linkuser ($) { # {{{
+sub linkuser ($) {
 	my $user = shift;
 	my $oiduser = eval { IkiWiki::openiduser($user) };
 
@@ -262,10 +259,10 @@ sub linkuser ($) { # {{{
 					: "$user")
 			), $user);
 	}
-} # }}}
+}
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
 	my $cgi=shift;
 	my $session=shift;
 
@@ -372,7 +369,7 @@ sub sessioncgi ($$) { #{{{
 			$page));
 	}
 
-	if (not pagespec_match($page, $config{comments_open_pagespec},
+	if (pagespec_match($page, $config{comments_closed_pagespec},
 		location => $page)) {
 		error(sprintf(gettext(
 			"comments on page '%s' are closed"),
@@ -468,7 +465,7 @@ sub sessioncgi ($$) { #{{{
 	if ($form->submitted eq POST_COMMENT && $form->validate) {
 		my $file = "$location._comment";
 
-		IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+		IkiWiki::checksessionexpiry($cgi, $session);
 
 		# FIXME: could probably do some sort of graceful retry
 		# on error? Would require significant unwinding though
@@ -503,7 +500,8 @@ sub sessioncgi ($$) { #{{{
 		error($conflict) if defined $conflict;
 
 		# Bounce back to where we were, but defeat broken caches
-		my $anticache = "?updated=$page/$config{comments_pagename}$i";
+		# and jump to the comments anchor.
+		my $anticache = "?updated=$page/$config{comments_pagename}$i#comments";
 		IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
 	}
 	else {
@@ -512,34 +510,36 @@ sub sessioncgi ($$) { #{{{
 	}
 
 	exit;
-} #}}}
+}
+
+sub commentsshown ($) {
+	my $page=shift;
+
+	return ! pagespec_match($page, "*/$config{comments_pagename}*",
+	                        location => $page) &&
+	       pagespec_match($page, $config{comments_pagespec},
+	                      location => $page);
+}
+
+sub commentsopen ($) {
+	my $page = shift;
+
+	return length $config{cgiurl} > 0 &&
+	       (! length $config{comments_closed_pagespec} ||
+	        ! pagespec_match($page, $config{comments_closed_pagespec},
+	                         location => $page));
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
 	my %params = @_;
 
 	my $page = $params{page};
 	my $template = $params{template};
 
 	if ($template->query(name => 'comments')) {
-		my $comments = undef;
-
-		my $open = 0;
-		my $shown = pagespec_match($page,
-			$config{comments_shown_pagespec},
-			location => $page);
-
-		if (pagespec_match($page, "*/$config{comments_pagename}*",
-				location => $page)) {
-			$shown = 0;
-			$open = 0;
-		}
-
-		if (length $config{cgiurl}) {
-			$open = pagespec_match($page,
-				$config{comments_open_pagespec},
-				location => $page);
-		}
+		my $shown = commentsshown($page);
 
+		my $comments = undef;
 		if ($shown) {
 			$comments = IkiWiki::preprocess_inline(
 				pages => "internal($page/$config{comments_pagename}*)",
@@ -557,13 +557,27 @@ sub pagetemplate (@) { #{{{
 			$template->param(comments => $comments);
 		}
 
-		if ($open) {
+		if ($shown && commentsopen($page)) {
 			my $commenturl = IkiWiki::cgiurl(do => 'comment',
 				page => $page);
 			$template->param(commenturl => $commenturl);
 		}
 	}
 
+	if ($template->query(name => 'commentslink')) {
+		# XXX Would be nice to say how many comments there are in
+		# the link. But, to update the number, blog pages
+		# would have to update whenever comments of any inlines
+		# page are added, which is not currently done.
+		if (commentsshown($page)) {
+			$template->param(commentslink =>
+				htmllink($page, $params{destpage}, $page,
+					linktext => gettext("Comments"),
+					anchor => "comments",
+					noimageinline => 1));
+		}
+	}
+
 	if ($template->query(name => 'commentuser')) {
 		$template->param(commentuser =>
 			$pagestate{$page}{comments}{commentuser});
@@ -583,7 +597,7 @@ sub pagetemplate (@) { #{{{
 		$template->param(commentauthorurl =>
 			$pagestate{$page}{comments}{commentauthorurl});
 	}
-} # }}}
+}
 
 package IkiWiki::PageSpec;