use warnings;
use strict;
use IkiWiki 2.00;
+use Encode;
use constant PREVIEW => "Preview";
use constant POST_COMMENT => "Post comment";
use constant CANCEL => "Cancel";
sub import { #{{{
+ hook(type => "checkconfig", id => 'comments', call => \&checkconfig);
hook(type => "getsetup", id => 'comments', call => \&getsetup);
- hook(type => "preprocess", id => 'comments', call => \&preprocess);
+ hook(type => "preprocess", id => 'comment', call => \&preprocess);
hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
- hook(type => "htmlize", id => "_comment",
- call => \&IkiWiki::Plugin::mdwn::htmlize);
- IkiWiki::loadplugin("inline");
+ 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 htmlize { # {{{
- eval { use IkiWiki::Plugin::mdwn; };
- error($@) if ($@);
- return IkiWiki::Plugin::mdwn::htmlize(@_)
+ my %params = @_;
+ return $params{content};
} # }}}
-sub getsetup () { #{{{
- return
- plugin => {
- safe => 1,
- rebuild => undef,
- },
-} #}}}
-
-# Somewhat based on IkiWiki::Plugin::inline blog posting support
-sub preprocess (@) { #{{{
- my %params=@_;
+sub preprocess { # {{{
+ my %params = @_;
+ my $page = $params{page};
- unless (length $config{cgiurl}) {
- error(gettext("[[!comments plugin requires CGI enabled]]"));
+ my $format = $params{format};
+ if (defined $format && !exists $IkiWiki::hooks{htmlize}{$format}) {
+ error(sprintf(gettext("unsupported page format %s"), $format));
}
- my $page = $params{page};
- $pagestate{$page}{comments}{comments} = defined $params{closed}
- ? (not IkiWiki::yesno($params{closed}))
- : 1;
- $pagestate{$page}{comments}{allowhtml} = IkiWiki::yesno($params{allowhtml});
- $pagestate{$page}{comments}{allowdirectives} = IkiWiki::yesno($params{allowdirectives});
- $pagestate{$page}{comments}{commit} = defined $params{commit}
- ? IkiWiki::yesno($params{commit})
- : 1;
-
- my $formtemplate = IkiWiki::template("comments_embed.tmpl",
- blind_cache => 1);
- $formtemplate->param(cgiurl => $config{cgiurl});
- $formtemplate->param(page => $params{page});
-
- if (not $pagestate{$page}{comments}{comments}) {
- $formtemplate->param("disabled" =>
- gettext('comments are closed'));
+ my $content = $params{content};
+ if (!defined $content) {
+ error(gettext("comment must have content"));
}
- elsif ($params{preview}) {
- $formtemplate->param("disabled" =>
- gettext('not available during Preview'));
+ $content =~ s/\\"/"/g;
+
+ $content = IkiWiki::filter($page, $params{destpage}, $content);
+
+ if ($config{comments_allowdirectives}) {
+ $content = IkiWiki::preprocess($page, $params{destpage},
+ $content);
}
- debug("page $params{page} => destpage $params{destpage}");
-
- my $posts = '';
- unless (defined $params{inline} && !IkiWiki::yesno($params{inline})) {
- eval { use IkiWiki::Plugin::inline; };
- error($@) if ($@);
- my @args = (
- pages => "internal($params{page}/_comment_*)",
- template => "comments_display",
- show => 0,
- reverse => "yes",
- # special stuff passed through
- page => $params{page},
+ # no need to bother with htmlize if it's just HTML
+ $content = IkiWiki::htmlize($page, $params{destpage}, $format,
+ $content) if defined $format;
+
+ IkiWiki::run_hooks(sanitize => sub {
+ $content = shift->(
+ page => $page,
destpage => $params{destpage},
- preview => $params{preview},
+ content => $content,
);
- push @args, atom => $params{atom} if defined $params{atom};
- push @args, rss => $params{rss} if defined $params{rss};
- push @args, feeds => $params{feeds} if defined $params{feeds};
- push @args, feedshow => $params{feedshow} if defined $params{feedshow};
- push @args, timeformat => $params{timeformat} if defined $params{timeformat};
- push @args, feedonly => $params{feedonly} if defined $params{feedonly};
- $posts = "\n" . IkiWiki::preprocess_inline(@args);
+ });
+
+ # override any metadata
+
+ if (defined $params{username}) {
+ my ($authorurl, $author) = linkuser($params{username});
+ $pagestate{$page}{meta}{author} = $author;
+ $pagestate{$page}{meta}{authorurl} = $authorurl;
+ }
+ elsif (defined $params{ip}) {
+ $pagestate{$page}{meta}{author} = sprintf(
+ gettext("Anonymous (IP: %s)"),
+ $params{ip});
+ delete $pagestate{$page}{meta}{authorurl};
+ }
+ else {
+ $pagestate{$page}{meta}{author} = gettext("Anonymous");
+ delete $pagestate{$page}{meta}{authorurl};
}
- return $formtemplate->output . $posts;
+ 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+)$/) {
+ $anchor = $1;
+ }
+ $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";
+
+ eval q{use Date::Parse};
+ if (! $@) {
+ my $time = str2time($params{date});
+ $IkiWiki::pagectime{$page} = $time if defined $time;
+ }
+
+ # FIXME: hard-coded HTML (although it's just to set an ID)
+ return "<div id=\"$anchor\">$content</div>" 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;
return $user;
} # }}}
-# FIXME: logic adapted from recentchanges, should be common code?
+# This is exactly the same as recentchanges_link :-(
+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) {
+ error("missing page parameter");
+ }
+
+ IkiWiki::loadindex();
+
+ my $link=bestlink("", $page);
+ if (! length $link) {
+ print "Content-type: text/html\n\n";
+ print IkiWiki::misctemplate(gettext(gettext("missing page")),
+ "<p>".
+ sprintf(gettext("The page %s does not exist."),
+ htmllink("", "", $page)).
+ "</p>");
+ }
+ else {
+ IkiWiki::redirect($cgi, urlto($link, undef, 1));
+ }
+
+ exit;
+ }
+}
+
+# FIXME: basically the same logic as recentchanges
+# returns (author URL, pretty-printed version)
sub linkuser ($) { # {{{
my $user = shift;
my $oiduser = eval { IkiWiki::openiduser($user) };
if (defined $oiduser) {
return ($user, $oiduser);
}
+ # FIXME: it'd be good to avoid having such a link for anonymous
+ # posts
else {
- my $page = bestlink('', (length $config{userdir}
- ? "$config{userdir}/"
- : "").$user);
- return (urlto($page, undef, 1), $user);
- }
-} # }}}
-
-# FIXME: taken from IkiWiki::Plugin::editpage, should be common?
-sub checksessionexpiry ($$) { # {{{
- my $session = shift;
- my $sid = shift;
-
- if (defined $session->param("name")) {
- if (! defined $sid || $sid ne $session->id) {
- error(gettext("Your login session has expired."));
- }
+ return (IkiWiki::cgiurl(
+ do => 'commenter',
+ page => (length $config{userdir}
+ ? "$config{userdir}/$user"
+ : "$user")
+ ), $user);
}
} # }}}
error(gettext("bad page name"));
}
- my $allow_directives = $pagestate{$page}{comments}{allowdirectives};
- my $allow_html = $pagestate{$page}{comments}{allowdirectives};
- my $commit_comments = defined $pagestate{$page}{comments}{commit}
- ? $pagestate{$page}{comments}{commit}
- : 1;
+ 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?
htmllink($page, $page, 'ikiwiki/formatting',
noimageinline => 1,
linktext => 'FormattingHelp'),
- allowhtml => $allow_html,
allowdirectives => $allow_directives);
+ 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));
+ exit;
+ }
+
if (not exists $pagesources{$page}) {
error(sprintf(gettext(
"page '%s' doesn't exist, so you can't comment"),
$page));
}
- if (not $pagestate{$page}{comments}{comments}) {
+
+ if (not pagespec_match($page, $config{comments_open_pagespec},
+ location => $page)) {
error(sprintf(gettext(
- "comments are not enabled on page '%s'"),
+ "comments on page '%s' are closed"),
$page));
}
- 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));
- exit;
- }
-
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;
- $body .= "\n" if $body !~ /\n$/;
- unless ($allow_directives) {
- # don't allow new-style directives at all
- $body =~ s/(^|[^\\])\[\[!/$1\\[[!/g;
+ # FIXME: check that the wiki is locked right now, because
+ # if it's not, there are mad race conditions!
- # don't allow [[ unless it begins an old-style
- # wikilink, if prefix_directives is off
- $body =~ s/(^|[^\\])\[\[(?![^\n\s\]+]\]\])/$1\\[[!/g
- unless $config{prefix_directives};
- }
+ # FIXME: rather a simplistic way to make the comments...
+ my $i = 0;
+ my $file;
+ my $location;
+ do {
+ $i++;
+ $location = "$page/${comments_pagename}${i}";
+ } while (-e "$config{srcdir}/$location._comment");
+
+ my $anchor = "${comments_pagename}${i}";
- unless ($allow_html) {
- $body =~ s/&(\w|#)/&$1/g;
- $body =~ s/</</g;
- $body =~ s/>/>/g;
+ $body =~ s/"/\\"/g;
+ my $content = "[[!comment format=mdwn\n";
+
+ # FIXME: handling of double quotes probably wrong?
+ if (defined $session->param('name')) {
+ my $username = $session->param('name');
+ $username =~ s/"/"/g;
+ $content .= " username=\"$username\"\n";
}
+ elsif (defined $ENV{REMOTE_ADDR}) {
+ my $ip = $ENV{REMOTE_ADDR};
+ if ($ip =~ m/^([.0-9]+)$/) {
+ $content .= " ip=\"$1\"\n";
+ }
+ }
+
+ my $subject = $form->field('subject');
+ $subject =~ s/"/"/g;
+ $content .= " subject=\"$subject\"\n";
- # In this template, the [[!meta]] directives should stay at the end,
- # so that they will override anything the user specifies. (For
- # instance, [[!meta author="I can fake the author"]]...)
- my $content_tmpl = template('comments_comment.tmpl');
- $content_tmpl->param(author => $author);
- $content_tmpl->param(authorurl => $authorurl);
- $content_tmpl->param(subject => $form->field('subject'));
- $content_tmpl->param(body => $body);
+ $content .= " date=\"" . IkiWiki::formattime(time, '%X %x') . "\"\n";
- my $content = $content_tmpl->output;
+ $content .= " content=\"\"\"\n$body\n\"\"\"]]\n";
# This is essentially a simplified version of editpage:
# - the user does not control the page that's created, only the parent
# - this means that if they do, rocks fall and everyone dies
if ($form->submitted eq PREVIEW) {
- # $fake is a location that has the same number of slashes
- # as the eventual location of this comment.
- my $fake = "$page/_comments_hypothetical";
- my $preview = IkiWiki::htmlize($fake, $page, 'mdwn',
+ my $preview = IkiWiki::htmlize($location, $page, 'mdwn',
IkiWiki::linkify($page, $page,
IkiWiki::preprocess($page, $page,
- IkiWiki::filter($fake, $page,
- $content),
+ IkiWiki::filter($location,
+ $page, $content),
0, 1)));
IkiWiki::run_hooks(format => sub {
$preview = shift->(page => $page,
}
if ($form->submitted eq POST_COMMENT && $form->validate) {
- # Let's get posting. We don't check_canedit here because
- # that somewhat defeats the point of this plugin.
-
- checksessionexpiry($session, $cgi->param('sid'));
+ my $file = "$location._comment";
- # 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;
- do {
- $i++;
- $file = "$page/_comment_${i}._comment";
- } while (-e "$config{srcdir}/$file");
+ IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
# FIXME: could probably do some sort of graceful retry
- # if I could be bothered
+ # on error? Would require significant unwinding though
writefile($file, $config{srcdir}, $content);
my $conflict;
my $message = gettext("Added a comment");
if (defined $form->field('subject') &&
length $form->field('subject')) {
- $message .= ": ".$form->field('subject');
+ $message = sprintf(
+ gettext("Added a comment: %s"),
+ $form->field('subject'));
}
IkiWiki::rcs_add($file);
error($conflict) if defined $conflict;
# Bounce back to where we were, but defeat broken caches
- my $anticache = "?updated=$page/_comment_$i";
+ my $anticache = "?updated=$page/${comments_pagename}${i}";
IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
}
else {
exit;
} #}}}
+sub pagetemplate (@) { #{{{
+ my %params = @_;
+
+ my $page = $params{page};
+ my $template = $params{template};
+
+ 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}*",
+ 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}*)",
+ template => 'comments_display',
+ show => 0,
+ reverse => 'yes',
+ page => $page,
+ destpage => $params{destpage},
+ );
+ $comments = IkiWiki::preprocess_inline(@args);
+ }
+
+ if (defined $comments && length $comments) {
+ $template->param(comments => $comments);
+ }
+
+ if ($open) {
+ my $commenturl = IkiWiki::cgiurl(do => 'comment',
+ page => $page);
+ $template->param(commenturl => $commenturl);
+ }
+ }
+} # }}}
+
package IkiWiki::PageSpec;
sub match_postcomment ($$;@) {