X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1698364da0699d1494ee305162e33f48746057c0..140c0bacbadc35de93cc685313123e9e51b45704:/IkiWiki/Plugin/comments.pm
diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 4fa82f467..6e257d1d9 100644
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -9,29 +9,97 @@ use warnings;
use strict;
use IkiWiki 2.00;
use Encode;
+use POSIX qw(strftime);
use constant PREVIEW => "Preview";
use constant POST_COMMENT => "Post comment";
use constant CANCEL => "Cancel";
-sub import { #{{{
+my $postcomment;
+
+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 => '_comment', call => \&preprocess);
hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
hook(type => "htmlize", id => "_comment", call => \&htmlize);
hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
hook(type => "cgi", id => "comments", call => \&linkcgi);
IkiWiki::loadplugin("inline");
-} # }}}
+}
+
+sub getsetup () {
+ return
+ plugin => {
+ safe => 1,
+ rebuild => 1,
+ },
+ comments_pagespec => {
+ type => 'pagespec',
+ example => 'blog/* and *!/Discussion',
+ description => 'PageSpec of pages where comments are allowed',
+ link => 'ikiwiki/PageSpec',
+ safe => 1,
+ rebuild => 1,
+ },
+ comments_closed_pagespec => {
+ type => 'pagespec',
+ 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',
+ default => 'comment_',
+ description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
+ safe => 0, # manual page moving required
+ rebuild => undef,
+ },
+ comments_allowdirectives => {
+ type => 'boolean',
+ example => 0,
+ description => 'Interpret directives in comments?',
+ safe => 1,
+ rebuild => 0,
+ },
+ comments_allowauthor => {
+ type => 'boolean',
+ example => 0,
+ description => 'Allow anonymous commenters to set an author name?',
+ safe => 1,
+ rebuild => 0,
+ },
+ comments_commit => {
+ type => 'boolean',
+ example => 1,
+ description => 'commit comments to the VCS',
+ # old uncommitted comments are likely to cause
+ # confusion if this is changed
+ safe => 0,
+ rebuild => 0,
+ },
+}
-sub htmlize { # {{{
+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 {
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) {
@@ -40,19 +108,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;
@@ -89,12 +157,10 @@ sub preprocess { # {{{
($commentauthorurl, $commentauthor) =
linkuser($params{username});
}
- elsif (defined $params{ip}) {
- $commentip = $params{ip};
- $commentauthor = sprintf(
- gettext("Anonymous (IP: %s)"), $params{ip});
- }
else {
+ if (defined $params{ip}) {
+ $commentip = $params{ip};
+ }
$commentauthor = gettext("Anonymous");
}
@@ -102,10 +168,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;
}
@@ -129,8 +195,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}";
@@ -144,83 +209,15 @@ sub preprocess { # {{{
# FIXME: hard-coded HTML (although it's just to set an ID)
return "
$content
" if $anchor;
return $content;
-} # }}}
-
-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 => {
- type => 'pagespec',
- example => 'blog/*',
- default => '',
- description => 'PageSpec for pages where comments will be shown inline',
- link => 'ikiwiki/PageSpec',
- safe => 1,
- rebuild => 1,
- },
- 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,
- 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 will required
- rebuild => undef,
- },
- comments_allowdirectives => {
- type => 'boolean',
- default => 0,
- example => 0,
- description => 'Interpret directives in comments?',
- safe => 1,
- rebuild => 0,
- },
- comments_allowauthor => {
- type => 'boolean',
- default => 0,
- example => 0,
- description => 'Allow anonymous commenters to set an author name?',
- safe => 1,
- rebuild => 0,
- },
- 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_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");
}
@@ -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;
@@ -309,11 +306,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);
@@ -325,7 +320,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');
@@ -342,15 +338,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);
@@ -362,7 +354,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.
@@ -377,21 +369,18 @@ 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"),
$page));
}
- IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
-
- 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!
+ # Set a flag to indicate that we're posting a comment,
+ # so that postcomment() can tell it should match.
+ $postcomment=1;
+ IkiWiki::check_canedit($page, $cgi, $session);
+ $postcomment=0;
# FIXME: rather a simplistic way to make the comments...
my $i = 0;
@@ -399,13 +388,10 @@ sub sessioncgi ($$) { #{{{
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";
+ my $content = "[[!_comment format=$type\n";
# FIXME: handling of double quotes probably wrong?
if (defined $session->param('name')) {
@@ -420,7 +406,7 @@ sub sessioncgi ($$) { #{{{
}
}
- if ($allow_author) {
+ if ($config{comments_allowauthor}) {
my $author = $form->field('author');
if (length $author) {
$author =~ s/"/"/g;
@@ -439,8 +425,12 @@ sub sessioncgi ($$) { #{{{
$content .= " subject=\"$subject\"\n";
}
- $content .= " date=\"" . IkiWiki::formattime(time, '%X %x') . "\"\n";
+ $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:
@@ -475,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
@@ -483,7 +473,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')) {
@@ -510,7 +500,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 {
@@ -519,9 +509,9 @@ sub sessioncgi ($$) { #{{{
}
exit;
-} #}}}
+}
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
my %params = @_;
my $page = $params{page};
@@ -530,38 +520,33 @@ 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);
+ my $shown = 0;
+ if (pagespec_match($page,
+ $config{comments_pagespec},
+ location => $page)) {
+ $shown = 1;
+ $open = length $config{cgiurl} > 0;
+ }
- if (pagespec_match($page, "*/${comments_pagename}*",
+ if (pagespec_match($page,
+ "$config{comments_closed_pagespec} or */$config{comments_pagename}*",
location => $page)) {
$shown = 0;
$open = 0;
}
- if (length $config{cgiurl}) {
- $open = pagespec_match($page,
- $config{comments_open_pagespec},
- location => $page);
- }
-
if ($shown) {
- eval q{use IkiWiki::Plugin::inline};
- error($@) if $@;
-
- my @args = (
- pages => "internal($page/${comments_pagename}*)",
+ $comments = IkiWiki::preprocess_inline(
+ pages => "internal($page/$config{comments_pagename}*)",
template => 'comments_display',
show => 0,
reverse => 'yes',
page => $page,
destpage => $params{destpage},
+ feedfile => 'comments',
+ emptyfeeds => 'no',
);
- $comments = IkiWiki::preprocess_inline(@args);
}
if (defined $comments && length $comments) {
@@ -594,7 +579,7 @@ sub pagetemplate (@) { #{{{
$template->param(commentauthorurl =>
$pagestate{$page}{comments}{commentauthorurl});
}
-} # }}}
+}
package IkiWiki::PageSpec;
@@ -602,7 +587,7 @@ sub match_postcomment ($$;@) {
my $page = shift;
my $glob = shift;
- unless ($page =~ s/\[postcomment\]$//) {
+ if (! $postcomment) {
return IkiWiki::FailReason->new("not posting a comment");
}
return match_glob($page, $glob);