comments: Add some global configuration

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index a68026ebc9ec09359015366d5a90d06de5c4044c..892b4af266fd9da09feed75f769f03738e0e5321 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}
@@ -106,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) };
@@ -344,6 +390,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 ($$;@) {