]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/comments.pm
new wishlist item, patch included
[git.ikiwiki.info.git] / IkiWiki / Plugin / comments.pm
index 972d069d50605d22afed0e79e23a6a9df5fb8e51..ee53dbc91e4e0b6768e36d23705da64a02cf0e1b 100644 (file)
@@ -7,7 +7,7 @@ package IkiWiki::Plugin::comments;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 use Encode;
 use POSIX qw(strftime);
 
@@ -16,47 +16,45 @@ use constant POST_COMMENT => "Post comment";
 use constant CANCEL => "Cancel";
 
 my $postcomment;
+my %commentstate;
 
-sub import { #{{{
+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 => "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);
+       hook(type => "formbuilder_setup", id => "comments", call => \&formbuilder_setup);
+       # Load goto to fix up user page links for logged-in commenters
+       IkiWiki::loadplugin("goto");
        IkiWiki::loadplugin("inline");
-} # }}}
+}
 
-sub getsetup () { #{{{
+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 => {
+               comments_pagespec => {
                        type => 'pagespec',
-                       example => 'blog/*',
-                       default => '',
-                       description => 'PageSpec for pages where comments will be shown inline',
+                       example => 'blog/* and !*/Discussion',
+                       description => 'PageSpec of pages where comments are allowed',
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },
-               comments_open_pagespec => {
+               comments_closed_pagespec => {
                        type => 'pagespec',
-                       example => 'blog/* and created_after(close_old_comments)',
-                       default => '',
-                       description => 'PageSpec for pages where new comments can be posted',
+                       example => 'blog/controversial or blog/flamewar',
+                       description => 'PageSpec of pages where posting new comments is not allowed',
                        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 required
@@ -64,7 +62,6 @@ sub getsetup () { #{{{
                },
                comments_allowdirectives => {
                        type => 'boolean',
-                       default => 0,
                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,
@@ -72,7 +69,6 @@ sub getsetup () { #{{{
                },
                comments_allowauthor => {
                        type => 'boolean',
-                       default => 0,
                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
@@ -81,22 +77,32 @@ sub getsetup () { #{{{
                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 htmlize { # {{{
+sub checkconfig () {
+       $config{comments_commit} = 1
+               unless defined $config{comments_commit};
+       $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};
+}
+
+sub htmlize {
        my %params = @_;
        return $params{content};
-} # }}}
+}
 
 # FIXME: copied verbatim from meta
-sub safeurl ($) { #{{{
+sub safeurl ($) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
@@ -105,9 +111,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
-} #}}}
+}
 
-sub preprocess { # {{{
+sub preprocess {
        my %params = @_;
        my $page = $params{page};
 
@@ -130,8 +136,8 @@ sub preprocess { # {{{
        }
 
        # no need to bother with htmlize if it's just HTML
-       $content = IkiWiki::htmlize($page, $params{destpage}, $format,
-               $content) if defined $format;
+       $content = IkiWiki::htmlize($page, $params{destpage}, $format, $content)
+               if defined $format;
 
        IkiWiki::run_hooks(sanitize => sub {
                $content = shift->(
@@ -148,11 +154,27 @@ sub preprocess { # {{{
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;
-
+       my $commentopenid;
        if (defined $params{username}) {
                $commentuser = $params{username};
-               ($commentauthorurl, $commentauthor) =
-                       linkuser($params{username});
+
+               my $oiduser = eval { IkiWiki::openiduser($commentuser) };
+
+               if (defined $oiduser) {
+                       # looks like an OpenID
+                       $commentauthorurl = $commentuser;
+                       $commentauthor = $oiduser;
+                       $commentopenid = $commentuser;
+               }
+               else {
+                       $commentauthorurl = IkiWiki::cgiurl(
+                               do => 'goto',
+                               page => (length $config{userdir}
+                                       ? "$config{userdir}/$commentuser"
+                                       : "$commentuser"));
+
+                       $commentauthor = $commentuser;
+               }
        }
        else {
                if (defined $params{ip}) {
@@ -161,10 +183,11 @@ sub preprocess { # {{{
                $commentauthor = gettext("Anonymous");
        }
 
-       $pagestate{$page}{comments}{commentuser} = $commentuser;
-       $pagestate{$page}{comments}{commentip} = $commentip;
-       $pagestate{$page}{comments}{commentauthor} = $commentauthor;
-       $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
+       $commentstate{$page}{commentuser} = $commentuser;
+       $commentstate{$page}{commentopenid} = $commentopenid;
+       $commentstate{$page}{commentip} = $commentip;
+       $commentstate{$page}{commentauthor} = $commentauthor;
+       $commentstate{$page}{commentauthorurl} = $commentauthorurl;
        if (! defined $pagestate{$page}{meta}{author}) {
                $pagestate{$page}{meta}{author} = $commentauthor;
        }
@@ -177,8 +200,17 @@ sub preprocess { # {{{
                        $pagestate{$page}{meta}{author} = $params{claimedauthor};
                }
 
-               if (defined $params{url} and safeurl($params{url})) {
-                       $pagestate{$page}{meta}{authorurl} = $params{url};
+               if (defined $params{url}) {
+                       my $url=$params{url};
+
+                       eval q{use URI::Heuristic}; 
+                       if (! $@) {
+                               $url=URI::Heuristic::uf_uristr($url);
+                       }
+
+                       if (safeurl($url)) {
+                               $pagestate{$page}{meta}{authorurl} = $url;
+                       }
                }
        }
        else {
@@ -190,13 +222,10 @@ sub preprocess { # {{{
                $pagestate{$page}{meta}{title} = $params{subject};
        }
 
-       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;
+       if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
+               $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
+                       "#".$params{page};
        }
-       $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";
 
        eval q{use Date::Parse};
        if (! $@) {
@@ -204,75 +233,27 @@ sub preprocess { # {{{
                $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 checkconfig () { #{{{
-       $config{comments_commit} = 1 unless defined $config{comments_commit};
-       $config{comments_pagename} = 'comment_'
-               unless defined $config{comments_pagename};
-} #}}}
-
-# 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) };
+sub sessioncgi ($$) {
+       my $cgi=shift;
+       my $session=shift;
 
-       if (defined $oiduser) {
-               return ($user, $oiduser);
+       my $do = $cgi->param('do');
+       if ($do eq 'comment') {
+               editcomment($cgi, $session);
        }
-       # FIXME: it'd be good to avoid having such a link for anonymous
-       # posts
-       else {
-               return (IkiWiki::cgiurl(
-                               do => 'commenter',
-                               page => (length $config{userdir}
-                                       ? "$config{userdir}/$user"
-                                       : "$user")
-                       ), $user);
+       elsif ($do eq 'commentmoderation') {
+               commentmoderation($cgi, $session);
        }
-} # }}}
+}
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
-sub sessioncgi ($$) { #{{{
+sub editcomment ($$) {
        my $cgi=shift;
        my $session=shift;
 
-       my $do = $cgi->param('do');
-       return unless $do eq 'comment';
-
        IkiWiki::decode_cgi_utf8($cgi);
 
        eval q{use CGI::FormBuilder};
@@ -289,9 +270,7 @@ sub sessioncgi ($$) { #{{{
                action => $config{cgiurl},
                header => 0,
                table => 0,
-               template => scalar IkiWiki::template_params('comments_form.tmpl'),
-               # wtf does this do in editpage?
-               wikiname => $config{wikiname},
+               template => scalar IkiWiki::template_params('editcomment.tmpl'),
        );
 
        IkiWiki::decode_form_utf8($form);
@@ -313,8 +292,6 @@ sub sessioncgi ($$) { #{{{
                @page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
        }
 
-       my $allow_author = $config{comments_allowauthor};
-
        $form->field(name => 'do', type => 'hidden');
        $form->field(name => 'sid', type => 'hidden', value => $session->id,
                force => 1);
@@ -326,7 +303,8 @@ sub sessioncgi ($$) { #{{{
 
        $form->tmpl_param(username => $session->param('name'));
 
-       if ($allow_author and ! defined $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');
@@ -348,12 +326,6 @@ sub sessioncgi ($$) { #{{{
                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);
 
        $form->title(sprintf(gettext("commenting on %s"),
@@ -363,7 +335,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.
@@ -378,7 +350,7 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
-       if (not pagespec_match($page, $config{comments_open_pagespec},
+       if (pagespec_match($page, $config{comments_closed_pagespec},
                location => $page)) {
                error(sprintf(gettext(
                        "comments on page '%s' are closed"),
@@ -391,17 +363,7 @@ sub sessioncgi ($$) { #{{{
        IkiWiki::check_canedit($page, $cgi, $session);
        $postcomment=0;
 
-       # 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;
-       my $location;
-       do {
-               $i++;
-               $location = "$page/${comments_pagename}${i}";
-       } while (-e "$config{srcdir}/$location._comment");
+       my $location=unique_comment_location($page, $config{srcdir});
 
        my $content = "[[!_comment format=$type\n";
 
@@ -418,21 +380,21 @@ sub sessioncgi ($$) { #{{{
                }
        }
 
-       if ($allow_author) {
+       if ($config{comments_allowauthor}) {
                my $author = $form->field('author');
-               if (length $author) {
+               if (defined $author && length $author) {
                        $author =~ s/"/&quot;/g;
                        $content .= " claimedauthor=\"$author\"\n";
                }
                my $url = $form->field('url');
-               if (length $url) {
+               if (defined $url && length $url) {
                        $url =~ s/"/&quot;/g;
                        $content .= " url=\"$url\"\n";
                }
        }
 
        my $subject = $form->field('subject');
-       if (length $subject) {
+       if (defined $subject && length $subject) {
                $subject =~ s/"/&quot;/g;
                $content .= " subject=\"$subject\"\n";
        }
@@ -452,40 +414,54 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
-               my $preview = IkiWiki::htmlize($location, $page, '_comment',
-                               IkiWiki::linkify($page, $page,
-                                       IkiWiki::preprocess($page, $page,
-                                               IkiWiki::filter($location,
-                                                       $page, $content),
-                                               0, 1)));
+               my $preview=previewcomment($content, $location, $page, time);
                IkiWiki::run_hooks(format => sub {
-                               $preview = shift->(page => $page,
-                                       content => $preview);
-                       });
-
-               my $template = template("comments_display.tmpl");
-               $template->param(content => $preview);
-               $template->param(title => $form->field('subject'));
-               $template->param(ctime => displaytime(time));
-
-               $form->tmpl_param(page_preview => $template->output);
+                       $preview = shift->(page => $page,
+                               content => $preview);
+               });
+               $form->tmpl_param(page_preview => $preview);
        }
        else {
                $form->tmpl_param(page_preview => "");
        }
 
        if ($form->submitted eq POST_COMMENT && $form->validate) {
-               my $file = "$location._comment";
-
-               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+               IkiWiki::checksessionexpiry($cgi, $session);
+               
+               $postcomment=1;
+               my $ok=IkiWiki::check_content(content => $form->field('editcontent'),
+                       subject => $form->field('subject'),
+                       $config{comments_allowauthor} ? (
+                               author => $form->field('author'),
+                               url => $form->field('url'),
+                       ) : (),
+                       page => $location,
+                       cgi => $cgi,
+                       session => $session,
+                       nonfatal => 1,
+               );
+               $postcomment=0;
+
+               if (! $ok) {
+                       my $penddir=$config{wikistatedir}."/comments_pending";
+                       $location=unique_comment_location($page, $penddir);
+                       writefile("$location._comment", $penddir, $content);
+                       IkiWiki::printheader($session);
+                       print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
+                               "<p>".
+                               gettext("Your comment will be posted after moderator review").
+                               "</p>");
+                       exit;
+               }
 
                # FIXME: could probably do some sort of graceful retry
                # on error? Would require significant unwinding though
+               my $file = "$location._comment";
                writefile($file, $config{srcdir}, $content);
 
                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')) {
@@ -511,9 +487,11 @@ sub sessioncgi ($$) { #{{{
                # breaks it or something
                error($conflict) if defined $conflict;
 
-               # Bounce back to where we were, but defeat broken caches
-               my $anticache = "?updated=$page/${comments_pagename}${i}";
-               IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
+               # Jump to the new comment on the page.
+               # The trailing question mark tries to avoid broken
+               # caches and get the most recent version of the page.
+               IkiWiki::redirect($cgi, urlto($page, undef, 1)."?updated#$location");
+
        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,
@@ -521,40 +499,211 @@ sub sessioncgi ($$) { #{{{
        }
 
        exit;
-} #}}}
+}
 
-sub pagetemplate (@) { #{{{
-       my %params = @_;
+sub commentmoderation ($$) {
+       my $cgi=shift;
+       my $session=shift;
 
-       my $page = $params{page};
-       my $template = $params{template};
+       IkiWiki::needsignin($cgi, $session);
+       if (! IkiWiki::is_admin($session->param("name"))) {
+               error(gettext("you are not logged in as an admin"));
+       }
 
-       if ($template->query(name => 'comments')) {
-               my $comments = undef;
+       IkiWiki::decode_cgi_utf8($cgi);
+       
+       if (defined $cgi->param('sid')) {
+               IkiWiki::checksessionexpiry($cgi, $session);
+
+               my $rejectalldefer=$cgi->param('rejectalldefer');
+
+               my %vars=$cgi->Vars;
+               my $added=0;
+               foreach my $id (keys %vars) {
+                       if ($id =~ /(.*)\Q._comment\E$/) {
+                               my $action=$cgi->param($id);
+                               next if $action eq 'Defer' && ! $rejectalldefer;
+
+                               # Make sure that the id is of a legal
+                               # pending comment before untainting.
+                               my ($f)= $id =~ /$config{wiki_file_regexp}/;
+                               if (! defined $f || ! length $f ||
+                                   IkiWiki::file_pruned($f, $config{srcdir})) {
+                                       error("illegal file");
+                               }
+
+                               my $page=IkiWiki::possibly_foolish_untaint(IkiWiki::dirname($1));
+                               my $file="$config{wikistatedir}/comments_pending/".
+                                       IkiWiki::possibly_foolish_untaint($id);
+
+                               if ($action eq 'Accept') {
+                                       my $content=eval { readfile($file) };
+                                       next if $@; # file vanished since form was displayed
+                                       my $dest=unique_comment_location($page, $config{srcdir})."._comment";
+                                       writefile($dest, $config{srcdir}, $content);
+                                       if ($config{rcs} and $config{comments_commit}) {
+                                               IkiWiki::rcs_add($dest);
+                                       }
+                                       $added++;
+                               }
+
+                               # This removes empty subdirs, so the
+                               # .ikiwiki/comments_pending dir will
+                               # go away when all are moderated.
+                               require IkiWiki::Render;
+                               IkiWiki::prune($file);
+                       }
+               }
+
+               if ($added) {
+                       my $conflict;
+                       if ($config{rcs} and $config{comments_commit}) {
+                               my $message = gettext("Comment moderation");
+                               IkiWiki::disable_commit_hook();
+                               $conflict=IkiWiki::rcs_commit_staged($message,
+                                       $session->param('name'), $ENV{REMOTE_ADDR});
+                               IkiWiki::enable_commit_hook();
+                               IkiWiki::rcs_update();
+                       }
+               
+                       # Now we need a refresh
+                       require IkiWiki::Render;
+                       IkiWiki::refresh();
+                       IkiWiki::saveindex();
+               
+                       error($conflict) if defined $conflict;
+               }
+       }
 
-               my $comments_pagename = $config{comments_pagename};
+       my @comments=map {
+               my ($id, $ctime)=@{$_};
+               my $file="$config{wikistatedir}/comments_pending/$id";
+               my $content=readfile($file);
+               my $preview=previewcomment($content, $id,
+                       IkiWiki::dirname($_), $ctime);
+               {
+                       id => $id,
+                       view => $preview,
+               } 
+       } sort { $b->[1] <=> $a->[1] } comments_pending();
+
+       my $template=template("commentmoderation.tmpl");
+       $template->param(
+               sid => $session->id,
+               comments => \@comments,
+       );
+       IkiWiki::printheader($session);
+       my $out=$template->output;
+       IkiWiki::run_hooks(format => sub {
+               $out = shift->(page => "", content => $out);
+       });
+       print IkiWiki::misctemplate(gettext("comment moderation"), $out);
+       exit;
+}
 
-               my $open = 0;
-               my $shown = pagespec_match($page,
-                       $config{comments_shown_pagespec},
-                       location => $page);
+sub formbuilder_setup (@) {
+       my %params=@_;
 
-               if (pagespec_match($page, "*/${comments_pagename}*",
-                               location => $page)) {
-                       $shown = 0;
-                       $open = 0;
+       my $form=$params{form};
+       if ($form->title eq "preferences" &&
+           IkiWiki::is_admin($params{session}->param("name"))) {
+               push @{$params{buttons}}, "Comment Moderation";
+               if ($form->submitted && $form->submitted eq "Comment Moderation") {
+                       commentmoderation($params{cgi}, $params{session});
                }
+       }
+}
+
+sub comments_pending () {
+       my $dir="$config{wikistatedir}/comments_pending/";
+       return unless -d $dir;
 
-               if (length $config{cgiurl}) {
-                       $open = pagespec_match($page,
-                               $config{comments_open_pagespec},
-                               location => $page);
+       my @ret;
+       eval q{use File::Find};
+       error($@) if $@;
+       find({
+               no_chdir => 1,
+               wanted => sub {
+                       $_=decode_utf8($_);
+                       if (IkiWiki::file_pruned($_, $dir)) {
+                               $File::Find::prune=1;
+                       }
+                       elsif (! -l $_ && ! -d _) {
+                               $File::Find::prune=0;
+                               my ($f)=/$config{wiki_file_regexp}/; # untaint
+                               if (defined $f && $f =~ /\Q._comment\E$/) {
+                                       my $ctime=(stat($f))[10];
+                                       $f=~s/^\Q$dir\E\/?//;
+                                        push @ret, [$f, $ctime];
+                               }
+                       }
                }
+       }, $dir);
+
+       return @ret;
+}
+
+sub previewcomment ($$$) {
+       my $content=shift;
+       my $location=shift;
+       my $page=shift;
+       my $time=shift;
+
+       my $preview = IkiWiki::htmlize($location, $page, '_comment',
+                       IkiWiki::linkify($location, $page,
+                       IkiWiki::preprocess($location, $page,
+                       IkiWiki::filter($location, $page, $content), 0, 1)));
+
+       my $template = template("comment.tmpl");
+       $template->param(content => $preview);
+       $template->param(ctime => displaytime($time));
+
+       IkiWiki::run_hooks(pagetemplate => sub {
+               shift->(page => $location,
+                       destpage => $page,
+                       template => $template);
+       });
+
+       $template->param(have_actions => 0);
+
+       return $template->output;
+}
+
+sub commentsshown ($) {
+       my $page=shift;
+
+       return ! pagespec_match($page, "*/$config{comments_pagename}*",
+                               location => $page) &&
+              pagespec_match($page, $config{comments_pagespec},
+                             location => $page);
+}
+
+sub commentsopen ($) {
+       my $page = shift;
+
+       return length $config{cgiurl} > 0 &&
+              (! length $config{comments_closed_pagespec} ||
+               ! pagespec_match($page, $config{comments_closed_pagespec},
+                                location => $page));
+}
 
+sub pagetemplate (@) {
+       my %params = @_;
+
+       my $page = $params{page};
+       my $template = $params{template};
+       my $shown = ($template->query(name => 'commentslink') ||
+                    $template->query(name => 'commentsurl') ||
+                    $template->query(name => 'atomcommentsurl') ||
+                    $template->query(name => 'comments')) &&
+                   commentsshown($page);
+
+       if ($template->query(name => 'comments')) {
+               my $comments = undef;
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
-                               pages => "internal($page/${comments_pagename}*)",
-                               template => 'comments_display',
+                               pages => "internal($page/$config{comments_pagename}*)",
+                               template => 'comment',
                                show => 0,
                                reverse => 'yes',
                                page => $page,
@@ -568,33 +717,96 @@ sub pagetemplate (@) { #{{{
                        $template->param(comments => $comments);
                }
 
-               if ($open) {
-                       my $commenturl = IkiWiki::cgiurl(do => 'comment',
+               if ($shown && commentsopen($page)) {
+                       my $addcommenturl = IkiWiki::cgiurl(do => 'comment',
                                page => $page);
-                       $template->param(commenturl => $commenturl);
+                       $template->param(addcommenturl => $addcommenturl);
+               }
+       }
+
+       if ($template->query(name => 'commentsurl')) {
+               if ($shown) {
+                       $template->param(commentsurl =>
+                               urlto($page, undef, 1).'#comments');
+               }
+       }
+
+       if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
+               if ($shown) {
+                       # This will 404 until there are some comments, but I
+                       # think that's probably OK...
+                       $template->param(atomcommentsurl =>
+                               urlto($page, undef, 1).'comments.atom');
+               }
+       }
+
+       if ($template->query(name => 'commentslink')) {
+               # XXX Would be nice to say how many comments there are in
+               # the link. But, to update the number, blog pages
+               # would have to update whenever comments of any inlines
+               # page are added, which is not currently done.
+               if ($shown) {
+                       $template->param(commentslink =>
+                               htmllink($page, $params{destpage}, $page,
+                                       linktext => gettext("Comments"),
+                                       anchor => "comments",
+                                       noimageinline => 1));
                }
        }
 
+       # everything below this point is only relevant to the comments
+       # themselves
+       if (!exists $commentstate{$page}) {
+               return;
+       }
+
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
-                       $pagestate{$page}{comments}{commentuser});
+                       $commentstate{$page}{commentuser});
+       }
+
+       if ($template->query(name => 'commentopenid')) {
+               $template->param(commentopenid =>
+                       $commentstate{$page}{commentopenid});
        }
 
        if ($template->query(name => 'commentip')) {
                $template->param(commentip =>
-                       $pagestate{$page}{comments}{commentip});
+                       $commentstate{$page}{commentip});
        }
 
        if ($template->query(name => 'commentauthor')) {
                $template->param(commentauthor =>
-                       $pagestate{$page}{comments}{commentauthor});
+                       $commentstate{$page}{commentauthor});
        }
 
        if ($template->query(name => 'commentauthorurl')) {
                $template->param(commentauthorurl =>
-                       $pagestate{$page}{comments}{commentauthorurl});
+                       $commentstate{$page}{commentauthorurl});
+       }
+
+       if ($template->query(name => 'removeurl') &&
+           IkiWiki::Plugin::remove->can("check_canremove") &&
+           length $config{cgiurl}) {
+               $template->param(removeurl => IkiWiki::cgiurl(do => 'remove',
+                       page => $page));
+               $template->param(have_actions => 1);
        }
-} # }}}
+}
+
+sub unique_comment_location ($) {
+       my $page=shift;
+       my $dir=shift;
+
+       my $location;
+       my $i = 0;
+       do {
+               $i++;
+               $location = "$page/$config{comments_pagename}$i";
+       } while (-e "$dir/$location._comment");
+
+       return $location;
+}
 
 package IkiWiki::PageSpec;