X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9af0f04df3a9c589d63a4f8d95af06098f0474db..9b837fd5ed984f0947bc3e1f4478384b3b1691fd:/IkiWiki/Plugin/comments.pm?ds=sidebyside
diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 13ced6ffd..83f67869c 100644
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -9,39 +9,120 @@ 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("mdwn");
IkiWiki::loadplugin("inline");
-} # }}}
+}
+
+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/*',
+ 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)',
+ description => 'PageSpec for pages where new comments can be posted',
+ 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 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 ($) {
+ my $url=shift;
+ if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
+ defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
+ return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
+ }
+ 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;
@@ -65,35 +146,58 @@ sub preprocess { # {{{
);
});
- # override any metadata
+ # set metadata, possibly overriding [[!meta]] directives from the
+ # comment itself
+
+ my $commentuser;
+ my $commentip;
+ my $commentauthor;
+ my $commentauthorurl;
if (defined $params{username}) {
- my ($authorurl, $author) = linkuser($params{username});
- $pagestate{$page}{meta}{author} = $author;
- $pagestate{$page}{meta}{authorurl} = $authorurl;
+ $commentuser = $params{username};
+ ($commentauthorurl, $commentauthor) =
+ linkuser($params{username});
+ }
+ else {
+ if (defined $params{ip}) {
+ $commentip = $params{ip};
+ }
+ $commentauthor = gettext("Anonymous");
+ }
+
+ $pagestate{$page}{comments}{commentuser} = $commentuser;
+ $pagestate{$page}{comments}{commentip} = $commentip;
+ $pagestate{$page}{comments}{commentauthor} = $commentauthor;
+ $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
+ if (! defined $pagestate{$page}{meta}{author}) {
+ $pagestate{$page}{meta}{author} = $commentauthor;
+ }
+ if (! defined $pagestate{$page}{meta}{authorurl}) {
+ $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
}
- elsif (defined $params{ip}) {
- $pagestate{$page}{meta}{author} = sprintf(
- gettext("Anonymous (IP: %s)"),
- $params{ip});
- delete $pagestate{$page}{meta}{authorurl};
+
+ if ($config{comments_allowauthor}) {
+ if (defined $params{claimedauthor}) {
+ $pagestate{$page}{meta}{author} = $params{claimedauthor};
+ }
+
+ if (defined $params{url} and safeurl($params{url})) {
+ $pagestate{$page}{meta}{authorurl} = $params{url};
+ }
}
else {
- $pagestate{$page}{meta}{author} = gettext("Anonymous");
- delete $pagestate{$page}{meta}{authorurl};
+ $pagestate{$page}{meta}{author} = $commentauthor;
+ $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
}
if (defined $params{subject}) {
$pagestate{$page}{meta}{title} = $params{subject};
}
- else {
- delete $pagestate{$page}{meta}{title};
- }
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}";
@@ -107,84 +211,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 => 'Allow directives in newly posted comments?',
- 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};
-} #}}}
-
-# FIXME: logic taken from editpage, should be common code?
-sub getcgiuser ($) { # {{{
- my $session = shift;
- my $user = $session->param('name');
- $user = $ENV{REMOTE_ADDR} unless defined $user;
- debug("getcgiuser() -> $user");
- return $user;
-} # }}}
+}
# 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");
}
@@ -209,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) };
@@ -226,10 +261,10 @@ sub linkuser ($) { # {{{
: "$user")
), $user);
}
-} # }}}
+}
# Mostly cargo-culted from IkiWiki::plugin::editpage
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
my $cgi=shift;
my $session=shift;
@@ -243,10 +278,10 @@ sub sessioncgi ($$) { #{{{
my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
my $form = CGI::FormBuilder->new(
- fields => [qw{do sid page subject body}],
+ fields => [qw{do sid page subject editcontent type author url}],
charset => 'utf-8',
method => 'POST',
- required => [qw{body}],
+ required => [qw{editcontent}],
javascript => 0,
params => $cgi,
action => $config{cgiurl},
@@ -264,27 +299,52 @@ sub sessioncgi ($$) { #{{{
});
IkiWiki::decode_form_utf8($form);
+ my $type = $form->param('type');
+ if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
+ $type = IkiWiki::possibly_foolish_untaint($type);
+ }
+ else {
+ $type = $config{default_pageext};
+ }
+ my @page_types;
+ if (exists $IkiWiki::hooks{htmlize}) {
+ @page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
+ }
+
$form->field(name => 'do', type => 'hidden');
$form->field(name => 'sid', type => 'hidden', value => $session->id,
force => 1);
$form->field(name => 'page', type => 'hidden');
$form->field(name => 'subject', type => 'text', size => 72);
- $form->field(name => 'body', type => 'textarea', rows => 5,
- cols => 80);
+ $form->field(name => 'editcontent', type => 'textarea', rows => 10);
+ $form->field(name => "type", value => $type, force => 1,
+ type => 'select', options => \@page_types);
+
+ $form->tmpl_param(username => $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');
+ }
+ else {
+ $form->tmpl_param(allowauthor => 0);
+ $form->field(name => 'author', type => 'hidden', value => '',
+ force => 1);
+ $form->field(name => 'url', type => 'hidden', value => '',
+ force => 1);
+ }
# The untaint is OK (as in editpage) because we're about to pass
# 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);
@@ -296,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.
@@ -318,16 +378,11 @@ sub sessioncgi ($$) { #{{{
$page));
}
- IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
-
- my ($authorurl, $author) = linkuser(getcgiuser($session));
-
- my $body = $form->field('body') || '';
- $body =~ s/\r\n/\n/g;
- $body =~ 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;
@@ -335,13 +390,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}";
-
- $body =~ s/"/\\"/g;
- my $content = "[[!comment format=mdwn\n";
+ my $content = "[[!_comment format=$type\n";
# FIXME: handling of double quotes probably wrong?
if (defined $session->param('name')) {
@@ -356,13 +408,32 @@ sub sessioncgi ($$) { #{{{
}
}
+ if ($config{comments_allowauthor}) {
+ my $author = $form->field('author');
+ if (length $author) {
+ $author =~ s/"/"/g;
+ $content .= " claimedauthor=\"$author\"\n";
+ }
+ my $url = $form->field('url');
+ if (length $url) {
+ $url =~ s/"/"/g;
+ $content .= " url=\"$url\"\n";
+ }
+ }
+
my $subject = $form->field('subject');
- $subject =~ s/"/"/g;
- $content .= " subject=\"$subject\"\n";
+ if (length $subject) {
+ $subject =~ s/"/"/g;
+ $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";
- $content .= " content=\"\"\"\n$body\n\"\"\"]]\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:
# - the user does not control the page that's created, only the parent
@@ -371,7 +442,7 @@ sub sessioncgi ($$) { #{{{
# - this means that if they do, rocks fall and everyone dies
if ($form->submitted eq PREVIEW) {
- my $preview = IkiWiki::htmlize($location, $page, 'mdwn',
+ my $preview = IkiWiki::htmlize($location, $page, '_comment',
IkiWiki::linkify($page, $page,
IkiWiki::preprocess($page, $page,
IkiWiki::filter($location,
@@ -386,8 +457,6 @@ sub sessioncgi ($$) { #{{{
$template->param(content => $preview);
$template->param(title => $form->field('subject'));
$template->param(ctime => displaytime(time));
- $template->param(author => $author);
- $template->param(authorurl => $authorurl);
$form->tmpl_param(page_preview => $template->output);
}
@@ -398,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
@@ -406,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')) {
@@ -433,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 {
@@ -442,9 +511,9 @@ sub sessioncgi ($$) { #{{{
}
exit;
-} #}}}
+}
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
my %params = @_;
my $page = $params{page};
@@ -453,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;
@@ -473,18 +540,16 @@ sub pagetemplate (@) { #{{{
}
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) {
@@ -497,7 +562,27 @@ sub pagetemplate (@) { #{{{
$template->param(commenturl => $commenturl);
}
}
-} # }}}
+
+ if ($template->query(name => 'commentuser')) {
+ $template->param(commentuser =>
+ $pagestate{$page}{comments}{commentuser});
+ }
+
+ if ($template->query(name => 'commentip')) {
+ $template->param(commentip =>
+ $pagestate{$page}{comments}{commentip});
+ }
+
+ if ($template->query(name => 'commentauthor')) {
+ $template->param(commentauthor =>
+ $pagestate{$page}{comments}{commentauthor});
+ }
+
+ if ($template->query(name => 'commentauthorurl')) {
+ $template->param(commentauthorurl =>
+ $pagestate{$page}{comments}{commentauthorurl});
+ }
+}
package IkiWiki::PageSpec;
@@ -505,7 +590,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);