X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/18eeb068a6be7e45add2775a4014c85e3b41b465..9b837fd5ed984f0947bc3e1f4478384b3b1691fd:/IkiWiki/Plugin/comments.pm

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 4999c3f24..83f67869c 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,9 +26,9 @@ 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,
@@ -39,7 +39,6 @@ sub getsetup () { #{{{
 		comments_shown_pagespec => {
 			type => 'pagespec',
 			example => 'blog/*',
-			default => '',
 			description => 'PageSpec for pages where comments will be shown inline',
 			link => 'ikiwiki/PageSpec',
 			safe => 1,
@@ -48,7 +47,6 @@ sub getsetup () { #{{{
 		comments_open_pagespec => {
 			type => 'pagespec',
 			example => 'blog/* and created_after(close_old_comments)',
-			default => '',
 			description => 'PageSpec for pages where new comments can be posted',
 			link => 'ikiwiki/PageSpec',
 			safe => 1,
@@ -56,7 +54,6 @@ sub getsetup () { #{{{
 		},
 		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 +61,6 @@ sub getsetup () { #{{{
 		},
 		comments_allowdirectives => {
 			type => 'boolean',
-			default => 0,
 			example => 0,
 			description => 'Interpret directives in comments?',
 			safe => 1,
@@ -72,7 +68,6 @@ sub getsetup () { #{{{
 		},
 		comments_allowauthor => {
 			type => 'boolean',
-			default => 0,
 			example => 0,
 			description => 'Allow anonymous commenters to set an author name?',
 			safe => 1,
@@ -81,22 +76,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_shown_pagespec} = ''
+		unless defined $config{comments_shown_pagespec};
+	$config{comments_open_pagespec} = ''
+		unless defined $config{comments_open_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,19 +110,19 @@ sub safeurl ($) { #{{{
 	else {
 		return 1;
 	}
-} #}}}
+}
 
-sub preprocess { # {{{
+sub preprocess {
 	my %params = @_;
 	my $page = $params{page};
 
 	my $format = $params{format};
-	if (defined $format && !exists $IkiWiki::hooks{htmlize}{$format}) {
+	if (defined $format && ! exists $IkiWiki::hooks{htmlize}{$format}) {
 		error(sprintf(gettext("unsupported page format %s"), $format));
 	}
 
 	my $content = $params{content};
-	if (!defined $content) {
+	if (! defined $content) {
 		error(gettext("comment must have content"));
 	}
 	$content =~ s/\\"/"/g;
@@ -165,10 +170,10 @@ sub preprocess { # {{{
 	$pagestate{$page}{comments}{commentip} = $commentip;
 	$pagestate{$page}{comments}{commentauthor} = $commentauthor;
 	$pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
-	if (!defined $pagestate{$page}{meta}{author}) {
+	if (! defined $pagestate{$page}{meta}{author}) {
 		$pagestate{$page}{meta}{author} = $commentauthor;
 	}
-	if (!defined $pagestate{$page}{meta}{authorurl}) {
+	if (! defined $pagestate{$page}{meta}{authorurl}) {
 		$pagestate{$page}{meta}{authorurl} = $commentauthorurl;
 	}
 
@@ -192,8 +197,7 @@ sub preprocess { # {{{
 
 	my $baseurl = urlto($params{destpage}, undef, 1);
 	my $anchor = "";
-	my $comments_pagename = $config{comments_pagename};
-	if ($params{page} =~ m/\/(\Q${comments_pagename}\E\d+)$/) {
+	if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
 		$anchor = $1;
 	}
 	$pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";
@@ -207,21 +211,15 @@ 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") {
 
 		my $page=decode_utf8($cgi->param("page"));
-		if (!defined $page) {
+		if (! defined $page) {
 			error("missing page parameter");
 		}
 
@@ -246,7 +244,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) };
 
@@ -263,10 +261,10 @@ sub linkuser ($) { # {{{
 					: "$user")
 			), $user);
 	}
-} # }}}
+}
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
 	my $cgi=shift;
 	my $session=shift;
 
@@ -310,11 +308,9 @@ sub sessioncgi ($$) { #{{{
 	}
 	my @page_types;
 	if (exists $IkiWiki::hooks{htmlize}) {
-		@page_types = grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}};
+		@page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
 	}
 
-	my $allow_author = $config{comments_allowauthor};
-
 	$form->field(name => 'do', type => 'hidden');
 	$form->field(name => 'sid', type => 'hidden', value => $session->id,
 		force => 1);
@@ -326,7 +322,8 @@ sub sessioncgi ($$) { #{{{
 
 	$form->tmpl_param(username => $session->param('name'));
 
-	if ($allow_author and !defined $session->param('name')) {
+	if ($config{comments_allowauthor} and
+	    ! defined $session->param('name')) {
 		$form->tmpl_param(allowauthor => 1);
 		$form->field(name => 'author', type => 'text', size => '40');
 		$form->field(name => 'url', type => 'text', size => '40');
@@ -343,15 +340,11 @@ sub sessioncgi ($$) { #{{{
 	# it to file_pruned anyway
 	my $page = $form->field('page');
 	$page = IkiWiki::possibly_foolish_untaint($page);
-	if (!defined $page || !length $page ||
+	if (! defined $page || ! length $page ||
 		IkiWiki::file_pruned($page, $config{srcdir})) {
 		error(gettext("bad page name"));
 	}
 
-	my $allow_directives = $config{comments_allowdirectives};
-	my $commit_comments = $config{comments_commit};
-	my $comments_pagename = $config{comments_pagename};
-
 	# FIXME: is this right? Or should we be using the candidate subpage
 	# (whatever that might mean) as the base URL?
 	my $baseurl = urlto($page, undef, 1);
@@ -363,7 +356,7 @@ sub sessioncgi ($$) { #{{{
 		htmllink($page, $page, 'ikiwiki/formatting',
 			noimageinline => 1,
 			linktext => 'FormattingHelp'),
-			allowdirectives => $allow_directives);
+			allowdirectives => $config{allow_directives});
 
 	if ($form->submitted eq CANCEL) {
 		# bounce back to the page they wanted to comment on, and exit.
@@ -391,25 +384,15 @@ sub sessioncgi ($$) { #{{{
 	IkiWiki::check_canedit($page, $cgi, $session);
 	$postcomment=0;
 
-	my $editcontent = $form->field('editcontent') || '';
-	$editcontent =~ s/\r\n/\n/g;
-	$editcontent =~ s/\r/\n/g;
-
-	# FIXME: check that the wiki is locked right now, because
-	# if it's not, there are mad race conditions!
-
 	# FIXME: rather a simplistic way to make the comments...
 	my $i = 0;
 	my $file;
 	my $location;
 	do {
 		$i++;
-		$location = "$page/${comments_pagename}${i}";
+		$location = "$page/$config{comments_pagename}$i";
 	} while (-e "$config{srcdir}/$location._comment");
 
-	my $anchor = "${comments_pagename}${i}";
-
-	$editcontent =~ s/"/\\"/g;
 	my $content = "[[!_comment format=$type\n";
 
 	# FIXME: handling of double quotes probably wrong?
@@ -425,7 +408,7 @@ sub sessioncgi ($$) { #{{{
 		}
 	}
 
-	if ($allow_author) {
+	if ($config{comments_allowauthor}) {
 		my $author = $form->field('author');
 		if (length $author) {
 			$author =~ s/"/&quot;/g;
@@ -446,6 +429,10 @@ sub sessioncgi ($$) { #{{{
 
 	$content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
+	my $editcontent = $form->field('editcontent') || '';
+	$editcontent =~ s/\r\n/\n/g;
+	$editcontent =~ s/\r/\n/g;
+	$editcontent =~ s/"/\\"/g;
 	$content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 
 	# This is essentially a simplified version of editpage:
@@ -480,7 +467,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
@@ -488,7 +475,7 @@ sub sessioncgi ($$) { #{{{
 
 		my $conflict;
 
-		if ($config{rcs} and $commit_comments) {
+		if ($config{rcs} and $config{comments_commit}) {
 			my $message = gettext("Added a comment");
 			if (defined $form->field('subject') &&
 				length $form->field('subject')) {
@@ -515,7 +502,7 @@ sub sessioncgi ($$) { #{{{
 		error($conflict) if defined $conflict;
 
 		# Bounce back to where we were, but defeat broken caches
-		my $anticache = "?updated=$page/${comments_pagename}${i}";
+		my $anticache = "?updated=$page/$config{comments_pagename}$i";
 		IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
 	}
 	else {
@@ -524,9 +511,9 @@ sub sessioncgi ($$) { #{{{
 	}
 
 	exit;
-} #}}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
 	my %params = @_;
 
 	my $page = $params{page};
@@ -535,14 +522,12 @@ sub pagetemplate (@) { #{{{
 	if ($template->query(name => 'comments')) {
 		my $comments = undef;
 
-		my $comments_pagename = $config{comments_pagename};
-
 		my $open = 0;
 		my $shown = pagespec_match($page,
 			$config{comments_shown_pagespec},
 			location => $page);
 
-		if (pagespec_match($page, "*/${comments_pagename}*",
+		if (pagespec_match($page, "*/$config{comments_pagename}*",
 				location => $page)) {
 			$shown = 0;
 			$open = 0;
@@ -556,7 +541,7 @@ sub pagetemplate (@) { #{{{
 
 		if ($shown) {
 			$comments = IkiWiki::preprocess_inline(
-				pages => "internal($page/${comments_pagename}*)",
+				pages => "internal($page/$config{comments_pagename}*)",
 				template => 'comments_display',
 				show => 0,
 				reverse => 'yes',
@@ -597,7 +582,7 @@ sub pagetemplate (@) { #{{{
 		$template->param(commentauthorurl =>
 			$pagestate{$page}{comments}{commentauthorurl});
 	}
-} # }}}
+}
 
 package IkiWiki::PageSpec;