]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/comments.pm
fix bug I introduced
[git.ikiwiki.info.git] / IkiWiki / Plugin / comments.pm
index 3a0465dbb833fd0485d133bb39ee3ebc1daebf46..98f9f8b3de8ec224b0fa23a033b476e852a700a9 100644 (file)
@@ -25,7 +25,9 @@ sub import {
        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");
 }
 
@@ -134,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->(
@@ -166,7 +168,7 @@ sub preprocess {
                }
                else {
                        $commentauthorurl = IkiWiki::cgiurl(
-                               do => 'commenter',
+                               do => 'goto',
                                page => (length $config{userdir}
                                        ? "$config{userdir}/$commentuser"
                                        : "$commentuser"));
@@ -222,7 +224,7 @@ sub preprocess {
 
        if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
                $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
-                       "#".$params{page};
+                       "#".page_to_id($params{page});
        }
 
        eval q{use Date::Parse};
@@ -234,43 +236,24 @@ sub preprocess {
        return $content;
 }
 
-# This is exactly the same as recentchanges_link :-(
-sub linkcgi ($) {
+sub sessioncgi ($$) {
        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));
-               }
+       my $session=shift;
 
-               exit;
+       my $do = $cgi->param('do');
+       if ($do eq 'comment') {
+               editcomment($cgi, $session);
+       }
+       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};
@@ -343,8 +326,6 @@ sub sessioncgi ($$) {
                error(gettext("bad page name"));
        }
 
-       # 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"),
@@ -382,14 +363,7 @@ sub sessioncgi ($$) {
        IkiWiki::check_canedit($page, $cgi, $session);
        $postcomment=0;
 
-       # FIXME: rather a simplistic way to make the comments...
-       my $i = 0;
-       my $file;
-       my $location;
-       do {
-               $i++;
-               $location = "$page/$config{comments_pagename}$i";
-       } while (-e "$config{srcdir}/$location._comment");
+       my $location=unique_comment_location($page, $config{srcdir});
 
        my $content = "[[!_comment format=$type\n";
 
@@ -408,19 +382,19 @@ sub sessioncgi ($$) {
 
        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";
        }
@@ -440,41 +414,49 @@ 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($location, $page,
-                                       IkiWiki::preprocess($location, $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("comment.tmpl");
-               $template->param(content => $preview);
-               $template->param(title => $form->field('subject'));
-               $template->param(ctime => displaytime(time));
-
-               IkiWiki::run_hooks(pagetemplate => sub {
-                       shift->(page => $location,
-                               destpage => $page,
-                               template => $template);
+                       $preview = shift->(page => $page,
+                               content => $preview);
                });
-
-               $form->tmpl_param(page_preview => $template->output);
+               $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($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;
@@ -508,7 +490,8 @@ sub sessioncgi ($$) {
                # 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");
+               IkiWiki::redirect($cgi, urlto($page, undef, 1).
+                       "?updated#".page_to_id($location));
 
        }
        else {
@@ -519,10 +502,178 @@ sub sessioncgi ($$) {
        exit;
 }
 
+sub commentmoderation ($$) {
+       my $cgi=shift;
+       my $session=shift;
+
+       IkiWiki::needsignin($cgi, $session);
+       if (! IkiWiki::is_admin($session->param("name"))) {
+               error(gettext("you are not logged in as an admin"));
+       }
+
+       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=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;
+}
+
+sub formbuilder_setup (@) {
+       my %params=@_;
+
+       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;
+
+       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}*",
+       return ! pagespec_match($page, "internal(*/$config{comments_pagename}*)",
                                location => $page) &&
               pagespec_match($page, $config{comments_pagespec},
                              location => $page);
@@ -604,6 +755,16 @@ sub pagetemplate (@) {
                }
        }
 
+       # 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 =>
                        $commentstate{$page}{commentuser});
@@ -628,8 +789,42 @@ sub pagetemplate (@) {
                $template->param(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;
+}
+
+sub page_to_id ($) {
+       # Converts a comment page name into a unique, legal html id
+       # addtibute 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($page);
+}
+       
 package IkiWiki::PageSpec;
 
 sub match_postcomment ($$;@) {