Merge branch 'ready/autoindex-autofile' into HEAD

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 6c8952d4553deb99d1435beddd5de21aae76771c..d9183970d8b1525c34a69a68dcec57fa88eaf58e 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -7,7 +7,7 @@ package IkiWiki::Plugin::comments;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 use Encode;
 use POSIX qw(strftime);
 
 use Encode;
 use POSIX qw(strftime);
 


@@ -16,47 +16,52 @@ use constant POST_COMMENT => "Post comment";
 use constant CANCEL => "Cancel";
 
 my $postcomment;
 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 => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);

+       hook(type => "preprocess", id => 'comment', call => \&preprocess);
+       hook(type => "preprocess", id => 'commentmoderation', call => \&preprocess_moderation);
+       # here for backwards compatability with old comments

        hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);
        hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);

+       hook(type => "htmlize", id => "_comment_pending",
+               call => \&htmlize_pending);

        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        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");
        IkiWiki::loadplugin("inline");

-} # }}}
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
                plugin => {
                        safe => 1,
                        rebuild => 1,
        return
                plugin => {
                        safe => 1,
                        rebuild => 1,

+                       section => "web",

                },
                },

-               # Pages where comments are shown, but new comments are not
-               # allowed, will show "Comments are closed".
-               comments_shown_pagespec => {
+               comments_pagespec => {

                        type => '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,
                },
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },

-               comments_open_pagespec => {
+               comments_closed_pagespec => {

                        type => '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',
                        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
                        default => 'comment_',
                        description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
                        safe => 0, # manual page moving required


@@ -64,7 +69,6 @@ sub getsetup () { #{{{
                },
                comments_allowdirectives => {
                        type => 'boolean',
                },
                comments_allowdirectives => {
                        type => 'boolean',

-                       default => 0,

                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,
                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,


@@ -72,7 +76,6 @@ sub getsetup () { #{{{
                },
                comments_allowauthor => {
                        type => 'boolean',
                },
                comments_allowauthor => {
                        type => 'boolean',

-                       default => 0,

                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,


@@ -81,22 +84,40 @@ sub getsetup () { #{{{
                comments_commit => {
                        type => 'boolean',
                        example => 1,
                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,
                },
                        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};
        my %params = @_;
        return $params{content};

-} # }}}
+}
+
+sub htmlize_pending {
+       my %params = @_;
+       return sprintf(gettext("this comment needs %s"),
+               '<a href="'.
+               IkiWiki::cgiurl(do => "commentmoderation").'">'.
+               gettext("moderation").'</a>');
+}

 
 # FIXME: copied verbatim from meta
 
 # 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) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {


@@ -105,9 +126,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
        else {
                return 1;
        }

-} #}}}
+}

 
 

-sub preprocess { # {{{
+sub preprocess {

        my %params = @_;
        my $page = $params{page};
 
        my %params = @_;
        my $page = $params{page};
 


@@ -122,16 +143,14 @@ sub preprocess { # {{{
        }
        $content =~ s/\\"/"/g;
 
        }
        $content =~ s/\\"/"/g;
 

-       $content = IkiWiki::filter($page, $params{destpage}, $content);
-

        if ($config{comments_allowdirectives}) {
                $content = IkiWiki::preprocess($page, $params{destpage},
                        $content);
        }
 
        # no need to bother with htmlize if it's just HTML
        if ($config{comments_allowdirectives}) {
                $content = IkiWiki::preprocess($page, $params{destpage},
                        $content);
        }
 
        # 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->(
 
        IkiWiki::run_hooks(sanitize => sub {
                $content = shift->(


@@ -148,11 +167,26 @@ sub preprocess { # {{{
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;

-
+       my $commentopenid;

        if (defined $params{username}) {
                $commentuser = $params{username};
        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 = (defined $params{nickname} && length $params{nickname}) ? $params{nickname} : $oiduser;
+                       $commentopenid = $commentuser;
+               }
+               else {
+                       $commentauthorurl = IkiWiki::cgiurl(
+                               do => 'goto',
+                               page => IkiWiki::userpage($commentuser)
+                       );
+
+                       $commentauthor = $commentuser;
+               }

        }
        else {
                if (defined $params{ip}) {
        }
        else {
                if (defined $params{ip}) {


@@ -161,10 +195,11 @@ sub preprocess { # {{{
                $commentauthor = gettext("Anonymous");
        }
 
                $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;
        }
        if (! defined $pagestate{$page}{meta}{author}) {
                $pagestate{$page}{meta}{author} = $commentauthor;
        }


@@ -177,8 +212,17 @@ sub preprocess { # {{{
                        $pagestate{$page}{meta}{author} = $params{claimedauthor};
                }
 
                        $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 {
                }
        }
        else {


@@ -187,16 +231,15 @@ sub preprocess { # {{{
        }
 
        if (defined $params{subject}) {
        }
 
        if (defined $params{subject}) {

-               $pagestate{$page}{meta}{title} = $params{subject};
+               # decode title the same way meta does
+               eval q{use HTML::Entities};
+               $pagestate{$page}{meta}{title} = decode_entities($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})).
+                       "#".page_to_id($params{page});

        }
        }

-       $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";

 
        eval q{use Date::Parse};
        if (! $@) {
 
        eval q{use Date::Parse};
        if (! $@) {


@@ -204,75 +247,47 @@ sub preprocess { # {{{
                $IkiWiki::pagectime{$page} = $time if defined $time;
        }
 
                $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;
        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();
+sub preprocess_moderation {
+       my %params = @_;

 
 

-               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));
-               }
+       $params{desc}=gettext("Comment Moderation")
+               unless defined $params{desc};

 
 

-               exit;
+       if (length $config{cgiurl}) {
+               return '<a href="'.
+                       IkiWiki::cgiurl(do => 'commentmoderation').
+                       '">'.$params{desc}.'</a>';
+       }
+       else {
+               return $params{desc};

        }
 }
 
        }
 }
 

-# 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);
+       }
+       elsif ($do eq 'commentsignin') {
+               IkiWiki::cgi_signin($cgi, $session);
+               exit;

        }
        }

-} # }}}
+}

 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage

-sub sessioncgi ($$) { #{{{
+sub editcomment ($$) {

        my $cgi=shift;
        my $session=shift;
 
        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};
        IkiWiki::decode_cgi_utf8($cgi);
 
        eval q{use CGI::FormBuilder};


@@ -286,12 +301,10 @@ sub sessioncgi ($$) { #{{{
                required => [qw{editcontent}],
                javascript => 0,
                params => $cgi,
                required => [qw{editcontent}],
                javascript => 0,
                params => $cgi,

-               action => $config{cgiurl},
+               action => IkiWiki::cgiurl(),

                header => 0,
                table => 0,
                header => 0,
                table => 0,

-               template => scalar IkiWiki::template_params('comments_form.tmpl'),
-               # wtf does this do in editpage?
-               wikiname => $config{wikiname},
+               template => { template('editcomment.tmpl') },

        );
 
        IkiWiki::decode_form_utf8($form);
        );
 
        IkiWiki::decode_form_utf8($form);


@@ -308,12 +321,15 @@ sub sessioncgi ($$) { #{{{
        else {
                $type = $config{default_pageext};
        }
        else {
                $type = $config{default_pageext};
        }

+
+

        my @page_types;
        if (exists $IkiWiki::hooks{htmlize}) {
        my @page_types;
        if (exists $IkiWiki::hooks{htmlize}) {

-               @page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
+               foreach my $key (grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}}) {
+                       push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
+               }

        }
        }

-
-       my $allow_author = $config{comments_allowauthor};
+       @page_types=sort @page_types;

 
        $form->field(name => 'do', type => 'hidden');
        $form->field(name => 'sid', type => 'hidden', value => $session->id,
 
        $form->field(name => 'do', type => 'hidden');
        $form->field(name => 'sid', type => 'hidden', value => $session->id,


@@ -326,7 +342,8 @@ sub sessioncgi ($$) { #{{{
 
        $form->tmpl_param(username => $session->param('name'));
 
 
        $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');
                $form->tmpl_param(allowauthor => 1);
                $form->field(name => 'author', type => 'text', size => '40');
                $form->field(name => 'url', type => 'text', size => '40');


@@ -339,36 +356,34 @@ sub sessioncgi ($$) { #{{{
                        force => 1);
        }
 
                        force => 1);
        }
 

+       if (! defined $session->param('name')) {
+               # Make signinurl work and return here.
+               $form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'commentsignin'));
+               $session->param(postsignin => $ENV{QUERY_STRING});
+               IkiWiki::cgi_savesession($session);
+       }
+

        # The untaint is OK (as in editpage) because we're about to pass
        # The untaint is OK (as in editpage) because we're about to pass

-       # it to file_pruned anyway
-       my $page = $form->field('page');
+       # it to file_pruned and wiki_file_regexp anyway.
+       my $page = $form->field('page')=~/$config{wiki_file_regexp}/;

        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||
        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||

-               IkiWiki::file_pruned($page, $config{srcdir})) {
+               IkiWiki::file_pruned($page)) {

                error(gettext("bad page name"));
        }
 
                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"),
        $form->title(sprintf(gettext("commenting on %s"),

-                       IkiWiki::pagetitle($page)));
+                       IkiWiki::pagetitle(IkiWiki::basename($page))));

 
        $form->tmpl_param('helponformattinglink',
                htmllink($page, $page, 'ikiwiki/formatting',
                        noimageinline => 1,
                        linktext => 'FormattingHelp'),
 
        $form->tmpl_param('helponformattinglink',
                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.
 
        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));
+               IkiWiki::redirect($cgi, urlto($page));

                exit;
        }
 
                exit;
        }
 


@@ -378,7 +393,7 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
                        $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"),
                location => $page)) {
                error(sprintf(gettext(
                        "comments on page '%s' are closed"),


@@ -391,63 +406,58 @@ sub sessioncgi ($$) { #{{{
        IkiWiki::check_canedit($page, $cgi, $session);
        $postcomment=0;
 
        IkiWiki::check_canedit($page, $cgi, $session);
        $postcomment=0;
 

-       my $editcontent = $form->field('editcontent') || '';
-       $editcontent =~ s/\r\n/\n/g;
-       $editcontent =~ s/\r/\n/g;
-
-       # FIXME: check that the wiki is locked right now, because
-       # if it's not, there are mad race conditions!
+       my $content = "[[!comment format=$type\n";

 
 

-       # 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}";
-
-       $editcontent =~ s/"/\\"/g;
-       my $content = "[[!_comment format=$type\n";
-
-       # FIXME: handling of double quotes probably wrong?

        if (defined $session->param('name')) {
                my $username = $session->param('name');
                $username =~ s/"/&quot;/g;
                $content .= " username=\"$username\"\n";
        }
        if (defined $session->param('name')) {
                my $username = $session->param('name');
                $username =~ s/"/&quot;/g;
                $content .= " username=\"$username\"\n";
        }

-       elsif (defined $ENV{REMOTE_ADDR}) {
-               my $ip = $ENV{REMOTE_ADDR};
+       if (defined $session->param('nickname')) {
+               my $nickname = $session->param('nickname');
+               $nickname =~ s/"/&quot;/g;
+               $content .= " nickname=\"$nickname\"\n";
+       }
+       elsif (defined $session->remote_addr()) {
+               my $ip = $session->remote_addr();

                if ($ip =~ m/^([.0-9]+)$/) {
                        $content .= " ip=\"$1\"\n";
                }
        }
 
                if ($ip =~ m/^([.0-9]+)$/) {
                        $content .= " ip=\"$1\"\n";
                }
        }
 

-       if ($allow_author) {
+       if ($config{comments_allowauthor}) {

                my $author = $form->field('author');
                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');
                        $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');
                        $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;
                $subject =~ s/"/&quot;/g;

-               $content .= " subject=\"$subject\"\n";

        }
        }

+       else {
+               $subject = "comment ".(num_comments($page, $config{srcdir}) + 1);
+       }
+       $content .= " subject=\"$subject\"\n";

 
        $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
 
        $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 

+       my $editcontent = $form->field('editcontent');
+       $editcontent="" if ! defined $editcontent;
+       $editcontent =~ s/\r\n/\n/g;
+       $editcontent =~ s/\r/\n/g;
+       $editcontent =~ s/"/\\"/g;

        $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 
        $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 

+       my $location=unique_comment_location($page, $content, $config{srcdir});
+

        # This is essentially a simplified version of editpage:
        # - the user does not control the page that's created, only the parent
        # - it's always a create operation, never an edit
        # This is essentially a simplified version of editpage:
        # - the user does not control the page that's created, only the parent
        # - it's always a create operation, never an edit


@@ -455,40 +465,60 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
        # - 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 {
                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) {
        }
        else {
                $form->tmpl_param(page_preview => "");
        }
 
        if ($form->submitted eq POST_COMMENT && $form->validate) {

-               my $file = "$location._comment";
+               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) {
+                       $location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");
+                       writefile("$location._comment_pending", $config{srcdir}, $content);
+
+                       # Refresh so anything that deals with pending
+                       # comments can be updated.
+                       require IkiWiki::Render;
+                       IkiWiki::refresh();
+                       IkiWiki::saveindex();

 
 

-               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+                       IkiWiki::printheader($session);
+                       print IkiWiki::cgitemplate($cgi, 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
 
                # 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;
 
                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')) {
                        my $message = gettext("Added a comment");
                        if (defined $form->field('subject') &&
                                length $form->field('subject')) {


@@ -499,8 +529,10 @@ sub sessioncgi ($$) { #{{{
 
                        IkiWiki::rcs_add($file);
                        IkiWiki::disable_commit_hook();
 
                        IkiWiki::rcs_add($file);
                        IkiWiki::disable_commit_hook();

-                       $conflict = IkiWiki::rcs_commit_staged($message,
-                               $session->param('name'), $ENV{REMOTE_ADDR});
+                       $conflict = IkiWiki::rcs_commit_staged(
+                               message => $message,
+                               session => $session,
+                       );

                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }
                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }


@@ -514,50 +546,247 @@ sub sessioncgi ($$) { #{{{
                # breaks it or something
                error($conflict) if defined $conflict;
 
                # 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).
+                       "?updated#".page_to_id($location));
+

        }
        else {
        }
        else {

-               IkiWiki::showform ($form, \@buttons, $session, $cgi,
-                       forcebaseurl => $baseurl);
+               IkiWiki::showform($form, \@buttons, $session, $cgi,
+                       page => $page);

        }
 
        exit;
        }
 
        exit;

-} #}}}
-
-sub pagetemplate (@) { #{{{
-       my %params = @_;
+}

 
 

-       my $page = $params{page};
-       my $template = $params{template};
+sub commentmoderation ($$) {
+       my $cgi=shift;
+       my $session=shift;

 
 

-       if ($template->query(name => 'comments')) {
-               my $comments = undef;
+       IkiWiki::needsignin($cgi, $session);
+       if (! IkiWiki::is_admin($session->param("name"))) {
+               error(gettext("you are not logged in as an admin"));
+       }

 
 

-               my $comments_pagename = $config{comments_pagename};
+       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 =~ /(.*)\._comment(?:_pending)?$/) {
+                               $id=decode_utf8($id);
+                               my $action=$cgi->param($id);
+                               next if $action eq 'Defer' && ! $rejectalldefer;
+
+                               # Make sure that the id is of a legal
+                               # pending comment.
+                               my ($f) = $id =~ /$config{wiki_file_regexp}/;
+                               if (! defined $f || ! length $f ||
+                                   IkiWiki::file_pruned($f)) {
+                                       error("illegal file");
+                               }
+
+                               my $page=IkiWiki::dirname($f);
+                               my $file="$config{srcdir}/$f";
+                               if (! -e $file) {
+                                       # old location
+                                       $file="$config{wikistatedir}/comments_pending/".$f;
+                               }
+
+                               if ($action eq 'Accept') {
+                                       my $content=eval { readfile($file) };
+                                       next if $@; # file vanished since form was displayed
+                                       my $dest=unique_comment_location($page, $content, $config{srcdir})."._comment";
+                                       writefile($dest, $config{srcdir}, $content);
+                                       if ($config{rcs} and $config{comments_commit}) {
+                                               IkiWiki::rcs_add($dest);
+                                       }
+                                       $added++;
+                               }
+
+                               require IkiWiki::Render;
+                               IkiWiki::prune($file);
+                       }
+               }

 
 

-               my $open = 0;
-               my $shown = pagespec_match($page,
-                       $config{comments_shown_pagespec},
-                       location => $page);
+               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 => $message,
+                                       session => $session,
+                               );
+                               IkiWiki::enable_commit_hook();
+                               IkiWiki::rcs_update();
+                       }
+               
+                       # Now we need a refresh
+                       require IkiWiki::Render;
+                       IkiWiki::refresh();
+                       IkiWiki::saveindex();
+               
+                       error($conflict) if defined $conflict;
+               }
+       }

 
 

-               if (pagespec_match($page, "*/${comments_pagename}*",
-                               location => $page)) {
-                       $shown = 0;
-                       $open = 0;
+       my @comments=map {
+               my ($id, $dir, $ctime)=@{$_};
+               my $content=readfile("$dir/$id");
+               my $preview=previewcomment($content, $id,
+                       $id, $ctime);
+               {
+                       id => $id,
+                       view => $preview,

                }
                }

+       } sort { $b->[2] <=> $a->[2] } comments_pending();
+
+       my $template=template("commentmoderation.tmpl");
+       $template->param(
+               sid => $session->id,
+               comments => \@comments,
+               cgiurl => IkiWiki::cgiurl(),
+       );
+       IkiWiki::printheader($session);
+       my $out=$template->output;
+       IkiWiki::run_hooks(format => sub {
+               $out = shift->(page => "", content => $out);
+       });
+       print IkiWiki::cgitemplate($cgi, gettext("comment moderation"), $out);
+       exit;
+}
+
+sub formbuilder_setup (@) {
+       my %params=@_;

 
 

-               if (length $config{cgiurl}) {
-                       $open = pagespec_match($page,
-                               $config{comments_open_pagespec},
-                               location => $page);
+       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 @ret;
+
+       eval q{use File::Find};
+       error($@) if $@;
+       eval q{use Cwd};
+       error($@) if $@;
+       my $origdir=getcwd();
+
+       my $find_comments=sub {
+               my $dir=shift;
+               my $extension=shift;
+               return unless -d $dir;
+
+               chdir($dir) || die "chdir $dir: $!";
+
+               find({
+                       no_chdir => 1,
+                       wanted => sub {
+                               my $file=decode_utf8($_);
+                               $file=~s/^\.\///;
+                               return if ! length $file || IkiWiki::file_pruned($file)
+                                       || -l $_ || -d _ || $file !~ /\Q$extension\E$/;
+                               my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+                               if (defined $f) {
+                                       my $ctime=(stat($_))[10];
+                                       push @ret, [$f, $dir, $ctime];
+                               }
+                       }
+               }, ".");
+
+               chdir($origdir) || die "chdir $origdir: $!";
+       };
+       
+       $find_comments->($config{srcdir}, "._comment_pending");
+       # old location
+       $find_comments->("$config{wikistatedir}/comments_pending/",
+               "._comment");
+
+       return @ret;
+}
+
+sub previewcomment ($$$) {
+       my $content=shift;
+       my $location=shift;
+       my $page=shift;
+       my $time=shift;

 
 

+       # Previewing a comment should implicitly enable comment posting mode.
+       my $oldpostcomment=$postcomment;
+       $postcomment=1;
+
+       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, undef, 1));
+       $template->param(html5 => $config{html5});
+
+       IkiWiki::run_hooks(pagetemplate => sub {
+               shift->(page => $location,
+                       destpage => $page,
+                       template => $template);
+       });
+
+       $template->param(have_actions => 0);
+
+       $postcomment=$oldpostcomment;
+
+       return $template->output;
+}
+
+sub commentsshown ($) {
+       my $page=shift;
+
+       return ! pagespec_match($page, "comment(*)",
+                               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(
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(

-                               pages => "internal($page/${comments_pagename}*)",
-                               template => 'comments_display',
+                               pages => "comment($page)",
+                               template => 'comment',

                                show => 0,
                                reverse => 'yes',
                                page => $page,
                                show => 0,
                                reverse => 'yes',
                                page => $page,


@@ -571,34 +800,135 @@ sub pagetemplate (@) { #{{{
                        $template->param(comments => $comments);
                }
 
                        $template->param(comments => $comments);
                }
 

-               if ($open) {
-                       my $commenturl = IkiWiki::cgiurl(do => 'comment',
-                               page => $page);
-                       $template->param(commenturl => $commenturl);
+               if ($shown && commentsopen($page)) {
+                       $template->param(addcommenturl => addcommenturl($page));
+               }
+       }
+
+       if ($shown) {
+               if ($template->query(name => 'commentsurl')) {
+                       $template->param(commentsurl =>
+                               urlto($page).'#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');

                }
                }

+
+               if ($template->query(name => 'commentslink')) {
+                       my $num=num_comments($page, $config{srcdir});
+                       my $link;
+                       if ($num > 0) {
+                               $link = htmllink($page, $params{destpage}, $page,
+                                       linktext => sprintf(ngettext("%i comment", "%i comments", $num), $num),
+                                       anchor => "comments",
+                                       noimageinline => 1
+                               );
+                       }
+                       elsif (commentsopen($page)) {
+                               $link = "<a href=\"".addcommenturl($page)."\">".
+                                       #translators: Here "Comment" is a verb;
+                                       #translators: the user clicks on it to
+                                       #translators: post a comment.
+                                       gettext("Comment").
+                                       "</a>";
+                       }
+                       $template->param(commentslink => $link)
+                               if defined $link;
+               }
+       }
+
+       # everything below this point is only relevant to the comments
+       # themselves
+       if (!exists $commentstate{$page}) {
+               return;
+       }
+       
+       if ($template->query(name => 'commentid')) {
+               $template->param(commentid => page_to_id($page));

        }
 
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
        }
 
        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 =>
        }
 
        if ($template->query(name => 'commentip')) {
                $template->param(commentip =>

-                       $pagestate{$page}{comments}{commentip});
+                       $commentstate{$page}{commentip});

        }
 
        if ($template->query(name => 'commentauthor')) {
                $template->param(commentauthor =>
        }
 
        if ($template->query(name => 'commentauthor')) {
                $template->param(commentauthor =>

-                       $pagestate{$page}{comments}{commentauthor});
+                       $commentstate{$page}{commentauthor});

        }
 
        if ($template->query(name => 'commentauthorurl')) {
                $template->param(commentauthorurl =>
        }
 
        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 addcommenturl ($) {
+       my $page=shift;
+
+       return IkiWiki::cgiurl(do => 'comment', page => $page);
+}
+
+sub num_comments ($$) {
+       my $page=shift;
+       my $dir=shift;
+
+       my @comments=glob("$dir/$page/$config{comments_pagename}*._comment");
+       return int @comments;
+}
+
+sub unique_comment_location ($$$$) {
+       my $page=shift;
+       eval q{use Digest::MD5 'md5_hex'};
+       error($@) if $@;
+       my $content_md5=md5_hex(Encode::encode_utf8(shift));
+       my $dir=shift;
+       my $ext=shift || "._comment";
+
+       my $location;
+       my $i = num_comments($page, $dir);
+       do {
+               $i++;
+               $location = "$page/$config{comments_pagename}${i}_${content_md5}";
+       } while (-e "$dir/$location$ext");
+
+       return $location;
+}
+
+sub page_to_id ($) {
+       # Converts a comment page name into a unique, legal html id
+       # attribute value, that can be used as an anchor to link to the
+       # comment.
+       my $page=shift;
+
+       eval q{use Digest::MD5 'md5_hex'};
+       error($@) if $@;
+
+       return "comment-".md5_hex(Encode::encode_utf8(($page)));
+}
+       

 package IkiWiki::PageSpec;
 
 sub match_postcomment ($$;@) {
 package IkiWiki::PageSpec;
 
 sub match_postcomment ($$;@) {


@@ -608,7 +938,41 @@ sub match_postcomment ($$;@) {
        if (! $postcomment) {
                return IkiWiki::FailReason->new("not posting a comment");
        }
        if (! $postcomment) {
                return IkiWiki::FailReason->new("not posting a comment");
        }

-       return match_glob($page, $glob);
+       return match_glob($page, $glob, @_);
+}
+
+sub match_comment ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+
+       if (! $postcomment) {
+               # To see if it's a comment, check the source file type.
+               # Deal with comments that were just deleted.
+               my $source=exists $IkiWiki::pagesources{$page} ?
+                       $IkiWiki::pagesources{$page} :
+                       $IkiWiki::delpagesources{$page};
+               my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+               if (! defined $type || $type ne "_comment") {
+                       return IkiWiki::FailReason->new("$page is not a comment");
+               }
+       }
+
+       return match_glob($page, "$glob/*", internal => 1, @_);
+}
+
+sub match_comment_pending ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+       
+       my $source=exists $IkiWiki::pagesources{$page} ?
+               $IkiWiki::pagesources{$page} :
+               $IkiWiki::delpagesources{$page};
+       my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+       if (! defined $type || $type ne "_comment_pending") {
+               return IkiWiki::FailReason->new("$page is not a pending comment");
+       }
+
+       return match_glob($page, "$glob/*", internal => 1, @_);

 }
 
 1
 }
 
 1