comments: use global configuration for allow_directives, commit, and pagename

[ikiwiki.git] / IkiWiki / Plugin / comments.pm

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index f10400db1df4a1bdc5cedce5431d27a223c8c016..80469f503b4a8689cfcdba770f1ccb5a266b332f 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -18,6 +18,7 @@ sub import { #{{{
        hook(type => "preprocess", id => 'comments', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);
+       hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        IkiWiki::loadplugin("inline");
        IkiWiki::loadplugin("mdwn");
 } # }}}
@@ -32,17 +33,61 @@ 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,
+               },
 } #}}}
 
 # Somewhat based on IkiWiki::Plugin::inline blog posting support
 sub preprocess (@) { #{{{
        my %params=@_;
 
-       unless (length $config{cgiurl}) {
-               error(gettext("[[!comments plugin requires CGI enabled]]"));
-       }
+       return "";
 
        my $page = $params{page};
        $pagestate{$page}{comments}{comments} = defined $params{closed}
@@ -69,8 +114,8 @@ sub preprocess (@) { #{{{
 
        debug("page $params{page} => destpage $params{destpage}");
 
-       my $posts = '';
        unless (defined $params{inline} && !IkiWiki::yesno($params{inline})) {
+               my $posts = '';
                eval q{use IkiWiki::Plugin::inline};
                error($@) if ($@);
                my @args = (
@@ -89,10 +134,11 @@ sub preprocess (@) { #{{{
                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);
+               $posts = IkiWiki::preprocess_inline(@args);
+               $formtemplate->param("comments" => $posts);
        }
 
-       return $formtemplate->output . $posts;
+       return $formtemplate->output;
 } # }}}
 
 # FIXME: logic taken from editpage, should be common code?
@@ -105,6 +151,7 @@ sub getcgiuser ($) { # {{{
 } # }}}
 
 # FIXME: logic adapted from recentchanges, should be common code?
+# returns (author URL, pretty-printed version)
 sub linkuser ($) { # {{{
        my $user = shift;
        my $oiduser = eval { IkiWiki::openiduser($user) };
@@ -120,18 +167,6 @@ sub linkuser ($) { # {{{
        }
 } # }}}
 
-# 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."));
-               }
-       }
-} # }}}
-
 # Mostly cargo-culted from IkiWiki::plugin::editpage
 sub sessioncgi ($$) { #{{{
        my $cgi=shift;
@@ -185,10 +220,9 @@ sub sessioncgi ($$) { #{{{
                error(gettext("bad page name"));
        }
 
-       my $allow_directives = $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?
@@ -232,11 +266,11 @@ sub sessioncgi ($$) { #{{{
 
        unless ($allow_directives) {
                # don't allow new-style directives at all
-               $body =~ s/(^|[^\\])\[\[!/$1\\[[!/g;
+               $body =~ s/(^|[^\\])\[\[!/$1[[!/g;
 
                # don't allow [[ unless it begins an old-style
                # wikilink, if prefix_directives is off
-               $body =~ s/(^|[^\\])\[\[(?![^\n\s\]+]\]\])/$1\\[[!/g
+               $body =~ s/(^|[^\\])\[\[(?![^\n\s\]+]\]\])/$1[[!/g
                        unless $config{prefix_directives};
        }
 
@@ -300,7 +334,7 @@ sub sessioncgi ($$) { #{{{
                # Let's get posting. We don't check_canedit here because
                # that somewhat defeats the point of this plugin.
 
-               checksessionexpiry($session, $cgi->param('sid'));
+               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
 
                # FIXME: check that the wiki is locked right now, because
                # if it's not, there are mad race conditions!
@@ -355,6 +389,21 @@ sub sessioncgi ($$) { #{{{
        exit;
 } #}}}
 
+sub pagetemplate (@) { #{{{
+       my %params = @_;
+
+       my $page = $params{page};
+       my $template = $params{template};
+
+       if ($template->query(name => 'comments')) {
+               my $comments = undef;
+
+               if (defined $comments && length $comments) {
+                       $template->param(name => $comments);
+               }
+       }
+} # }}}
+
 package IkiWiki::PageSpec;
 
 sub match_postcomment ($$;@) {