X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/64370885cca3a37ee1f4a9e96673aca7ba5daae4..740c909abbe97151f14768de9476505c1f06badd:/IkiWiki/Plugin/comments.pm
diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index c00bf5275..edf5183a6 100644
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -35,6 +35,7 @@ sub import {
# Load goto to fix up user page links for logged-in commenters
IkiWiki::loadplugin("goto");
IkiWiki::loadplugin("inline");
+ IkiWiki::loadplugin("transient");
}
sub getsetup () {
@@ -90,17 +91,31 @@ sub getsetup () {
safe => 0,
rebuild => 0,
},
+ comments_allowformats => {
+ type => 'string',
+ default => '',
+ example => 'mdwn txt',
+ description => 'Restrict formats for comments to (no restriction if empty)',
+ safe => 1,
+ rebuild => 0,
+ },
+
}
sub checkconfig () {
$config{comments_commit} = 1
unless defined $config{comments_commit};
+ if (! $config{comments_commit}) {
+ $config{only_committed_changes}=0;
+ }
$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};
+ $config{comments_allowformats} = ''
+ unless defined $config{comments_allowformats};
}
sub htmlize {
@@ -111,7 +126,7 @@ sub htmlize {
sub htmlize_pending {
my %params = @_;
return sprintf(gettext("this comment needs %s"),
- ''.
gettext("moderation").'');
}
@@ -128,12 +143,18 @@ sub safeurl ($) {
}
}
+sub isallowed ($) {
+ my $format = shift;
+ return ! $config{comments_allowformats} || $config{comments_allowformats} =~ /\b$format\b/;
+}
+
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} ||
+ ! isallowed($format))) {
error(sprintf(gettext("unsupported page format %s"), $format));
}
@@ -177,7 +198,6 @@ sub preprocess {
$commentuser = $params{username};
my $oiduser = eval { IkiWiki::openiduser($commentuser) };
-
if (defined $oiduser) {
# looks like an OpenID
$commentauthorurl = $commentuser;
@@ -185,10 +205,17 @@ sub preprocess {
$commentopenid = $commentuser;
}
else {
- $commentauthorurl = IkiWiki::cgiurl(
- do => 'goto',
- page => IkiWiki::userpage($commentuser)
- );
+ my $emailuser = IkiWiki::emailuser($commentuser);
+ if (defined $emailuser) {
+ $commentuser=$emailuser;
+ }
+
+ if (length $config{cgiurl}) {
+ $commentauthorurl = IkiWiki::cgiurl(
+ do => 'goto',
+ page => IkiWiki::userpage($commentuser)
+ );
+ }
$commentauthor = $commentuser;
}
@@ -200,22 +227,9 @@ sub preprocess {
$commentauthor = gettext("Anonymous");
}
- $commentstate{$page}{commentuser} = $commentuser;
- $commentstate{$page}{commentopenid} = $commentopenid;
- $commentstate{$page}{commentip} = $commentip;
- $commentstate{$page}{commentauthor} = $commentauthor;
- $commentstate{$page}{commentauthorurl} = $commentauthorurl;
- $commentstate{$page}{commentauthoravatar} = $params{avatar};
- if (! defined $pagestate{$page}{meta}{author}) {
- $pagestate{$page}{meta}{author} = $commentauthor;
- }
- if (! defined $pagestate{$page}{meta}{authorurl}) {
- $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
- }
-
if ($config{comments_allowauthor}) {
if (defined $params{claimedauthor}) {
- $pagestate{$page}{meta}{author} = $params{claimedauthor};
+ $commentauthor = $params{claimedauthor};
}
if (defined $params{url}) {
@@ -227,12 +241,21 @@ sub preprocess {
}
if (safeurl($url)) {
- $pagestate{$page}{meta}{authorurl} = $url;
+ $commentauthorurl = $url;
}
}
}
- else {
+
+ $commentstate{$page}{commentuser} = $commentuser;
+ $commentstate{$page}{commentopenid} = $commentopenid;
+ $commentstate{$page}{commentip} = $commentip;
+ $commentstate{$page}{commentauthor} = $commentauthor;
+ $commentstate{$page}{commentauthorurl} = $commentauthorurl;
+ $commentstate{$page}{commentauthoravatar} = $params{avatar};
+ if (! defined $pagestate{$page}{meta}{author}) {
$pagestate{$page}{meta}{author} = $commentauthor;
+ }
+ if (! defined $pagestate{$page}{meta}{authorurl}) {
$pagestate{$page}{meta}{authorurl} = $commentauthorurl;
}
@@ -242,7 +265,7 @@ sub preprocess {
$pagestate{$page}{meta}{title} = decode_entities($params{subject});
}
- if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {
+ if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+/) {
$pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page})).
"#".page_to_id($params{page});
}
@@ -263,7 +286,7 @@ sub preprocess_moderation {
unless defined $params{desc};
if (length $config{cgiurl}) {
- return ''.$params{desc}.'';
}
@@ -332,8 +355,9 @@ sub editcomment ($$) {
my @page_types;
if (exists $IkiWiki::hooks{htmlize}) {
- foreach my $key (grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}}) {
- push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
+ foreach my $key (grep { !/^_/ && isallowed($_) } keys %{$IkiWiki::hooks{htmlize}}) {
+ push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key]
+ unless $IkiWiki::hooks{htmlize}{$key}{nocreate};
}
}
@page_types=sort @page_types;
@@ -417,6 +441,16 @@ sub editcomment ($$) {
$page));
}
+ # There's no UI to get here, but someone might construct the URL,
+ # leading to a comment that exists in the repository but isn't
+ # shown
+ if (!pagespec_match($page, $config{comments_pagespec},
+ location => $page)) {
+ error(sprintf(gettext(
+ "comments on page '%s' are not allowed"),
+ $page));
+ }
+
if (pagespec_match($page, $config{comments_closed_pagespec},
location => $page)) {
error(sprintf(gettext(
@@ -433,17 +467,20 @@ sub editcomment ($$) {
my $content = "[[!comment format=$type\n";
if (defined $session->param('name')) {
- my $username = $session->param('name');
+ my $username = IkiWiki::cloak($session->param('name'));
$username =~ s/"/"/g;
$content .= " username=\"$username\"\n";
}
+
if (defined $session->param('nickname')) {
my $nickname = $session->param('nickname');
$nickname =~ s/"/"/g;
$content .= " nickname=\"$nickname\"\n";
}
- elsif (defined $session->remote_addr()) {
- $content .= " ip=\"".$session->remote_addr()."\"\n";
+
+ if (!(defined $session->param('name') || defined $session->param('nickname')) &&
+ defined $session->remote_addr()) {
+ $content .= " ip=\"".IkiWiki::cloak($session->remote_addr())."\"\n";
}
if ($config{comments_allowauthor}) {
@@ -473,8 +510,7 @@ sub editcomment ($$) {
$subject = "comment ".(num_comments($page, $config{srcdir}) + 1);
}
$content .= " subject=\"$subject\"\n";
-
- $content .= " date=\"" . strftime_utf8('%Y-%m-%dT%H:%M:%SZ', gmtime) . "\"\n";
+ $content .= " date=\"" . commentdate() . "\"\n";
my $editcontent = $form->field('editcontent');
$editcontent="" if ! defined $editcontent;
@@ -521,11 +557,12 @@ sub editcomment ($$) {
}
$postcomment=1;
- my $ok=IkiWiki::check_content(content => $form->field('editcontent'),
- subject => $form->field('subject'),
+ my $ok=IkiWiki::check_content(
+ content => scalar $form->field('editcontent'),
+ subject => scalar $form->field('subject'),
$config{comments_allowauthor} ? (
- author => $form->field('author'),
- url => $form->field('url'),
+ author => scalar $form->field('author'),
+ url => scalar $form->field('url'),
) : (),
page => $location,
cgi => $cgi,
@@ -535,8 +572,8 @@ sub editcomment ($$) {
$postcomment=0;
if (! $ok) {
- $location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");
- writefile("$location._comment_pending", $config{srcdir}, $content);
+ $location=unique_comment_location($page, $content, $IkiWiki::Plugin::transient::transientdir, "._comment_pending");
+ writefile("$location._comment_pending", $IkiWiki::Plugin::transient::transientdir, $content);
# Refresh so anything that deals with pending
# comments can be updated.
@@ -565,7 +602,7 @@ sub editcomment ($$) {
length $form->field('subject')) {
$message = sprintf(
gettext("Added a comment: %s"),
- $form->field('subject'));
+ scalar $form->field('subject'));
}
IkiWiki::rcs_add($file);
@@ -602,6 +639,10 @@ sub editcomment ($$) {
exit;
}
+sub commentdate () {
+ strftime_utf8('%Y-%m-%dT%H:%M:%SZ', gmtime);
+}
+
sub getavatar ($) {
my $user=shift;
return undef unless defined $user;
@@ -661,12 +702,17 @@ sub commentmoderation ($$) {
}
my $page=IkiWiki::dirname($f);
- my $file="$config{srcdir}/$f";
- my $filedir=$config{srcdir};
+ my $filedir=$IkiWiki::Plugin::transient::transientdir;
+ my $file="$filedir/$f";
if (! -e $file) {
# old location
- $file="$config{wikistatedir}/comments_pending/".$f;
- $filedir="$config{wikistatedir}/comments_pending";
+ $file="$config{srcdir}/$f";
+ $filedir=$config{srcdir};
+ if (! -e $file) {
+ # older location
+ $file="$config{wikistatedir}/comments_pending/".$f;
+ $filedir="$config{wikistatedir}/comments_pending";
+ }
}
if ($action eq 'Accept') {
@@ -780,6 +826,8 @@ sub comments_pending () {
chdir($origdir) || die "chdir $origdir: $!";
};
+ $find_comments->($IkiWiki::Plugin::transient::transientdir, "._comment_pending");
+ # old location
$find_comments->($config{srcdir}, "._comment_pending");
# old location
$find_comments->("$config{wikistatedir}/comments_pending/",
@@ -873,16 +921,18 @@ sub pagetemplate (@) {
}
if ($shown) {
+ my $absolute = $template->param('wants_absolute_urls');
+
if ($template->query(name => 'commentsurl')) {
$template->param(commentsurl =>
- urlto($page).'#comments');
+ urlto($page, undef, $absolute).'#comments');
}
if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
# This will 404 until there are some comments, but I
# think that's probably OK...
$template->param(atomcommentsurl =>
- urlto($page).'comments.atom');
+ urlto($page, undef, $absolute).'comments.atom');
}
if ($template->query(name => 'commentslink')) {
@@ -896,7 +946,7 @@ sub pagetemplate (@) {
);
}
elsif (commentsopen($page)) {
- $link = "".
+ $link = "".
#translators: Here "Comment" is a verb;
#translators: the user clicks on it to
#translators: post a comment.
@@ -971,7 +1021,7 @@ sub num_comments ($$) {
return int @comments;
}
-sub unique_comment_location ($$$$) {
+sub unique_comment_location ($$$;$) {
my $page=shift;
eval q{use Digest::MD5 'md5_hex'};
error($@) if $@;