]> sipb.mit.edu Git - ikiwiki.git/commitdiff
Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
authorJoey Hess <joey@gnu.kitenet.net>
Sun, 25 Jan 2009 23:50:35 +0000 (18:50 -0500)
committerJoey Hess <joey@gnu.kitenet.net>
Sun, 25 Jan 2009 23:50:35 +0000 (18:50 -0500)
IkiWiki.pm
IkiWiki/Plugin/blogspam.pm
IkiWiki/Plugin/comments.pm
IkiWiki/Plugin/editpage.pm
debian/changelog
doc/news/code_swarm.mdwn
doc/plugins/comments.mdwn
doc/style.css
templates/commentmoderation.tmpl [new file with mode: 0644]

index 4d8415ffd6c67ef47d1e812e65596fd4550f6d0c..66fea4369b1326903f0bce26ed019a288e12788e 100644 (file)
@@ -174,7 +174,7 @@ sub getsetup () {
        verbose => {
                type => "boolean",
                example => 1,
-               description => "display verbose messages when building?",
+               description => "display verbose messages?",
                safe => 1,
                rebuild => 0,
        },
index 8552f3a1ba549d05cdd472e42bca8bfdf61fb007..cbd9859a533cf58dba27e1af20dc04368ab66e5e 100644 (file)
@@ -62,11 +62,11 @@ sub checkcontent (@) {
        }
 
        my $url=$defaulturl;
-       $url = $params{blogspam_server} if exists $params{blogspam_server};
+       $url = $config{blogspam_server} if exists $config{blogspam_server};
        my $client = RPC::XML::Client->new($url);
 
-       my @options = split(",", $params{blogspam_options})
-               if exists $params{blogspam_options};
+       my @options = split(",", $config{blogspam_options})
+               if exists $config{blogspam_options};
 
        # Allow short comments and whitespace-only edits, unless the user
        # has overridden min-words themselves.
index 6d0e45a97d29f49569f306b616aada1183f36510..388a983f70910f97ea3fc6084b8404036d16ce5a 100644 (file)
@@ -134,8 +134,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->(
@@ -263,13 +263,23 @@ sub linkcgi ($) {
        }
 }
 
-# Mostly cargo-culted from IkiWiki::plugin::editpage
 sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;
 
        my $do = $cgi->param('do');
-       return unless $do eq 'comment';
+       if ($do eq 'comment') {
+               editcomment($cgi, $session);
+       }
+       elsif ($do eq 'commentmoderation') {
+               commentmoderation($cgi, $session);
+       }
+}
+
+# Mostly cargo-culted from IkiWiki::plugin::editpage
+sub editcomment ($$) {
+       my $cgi=shift;
+       my $session=shift;
 
        IkiWiki::decode_cgi_utf8($cgi);
 
@@ -380,14 +390,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";
 
@@ -438,29 +441,8 @@ 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)));
-               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);
-               });
-
-               $form->tmpl_param(page_preview => $template->output);
+               $form->tmpl_param(page_preview => 
+                       previewcomment($content, $location, $page, time));
        }
        else {
                $form->tmpl_param(page_preview => "");
@@ -470,21 +452,34 @@ sub sessioncgi ($$) {
                IkiWiki::checksessionexpiry($cgi, $session);
                
                $postcomment=1;
-               IkiWiki::check_content(content => $form->field('editcontent'),
+               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
+                       cgi => $cgi,
+                       session => $session,
+                       nonfatal => 1,
                );
                $postcomment=0;
-               
-               my $file = "$location._comment";
+
+               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;
@@ -529,6 +524,158 @@ 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 %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';
+
+                               # 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=$_;
+               my $file="$config{wikistatedir}/comments_pending/$id";
+               my $content=readfile($file);
+               my $ctime=(stat($file))[10];
+               {
+                       id => $id,
+                       view => previewcomment($content, $id,
+                                       IkiWiki::dirname($_), $ctime),
+               } 
+       } comments_pending();
+
+       my $template=template("commentmoderation.tmpl");
+       $template->param(
+               sid => $session->id,
+               comments => \@comments,
+       );
+       IkiWiki::printheader($session);
+       print IkiWiki::misctemplate(gettext("comment moderation"), $template->output);
+       exit;
+}
+
+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$/) {
+                                       $f=~s/^\Q$dir\E\/?//;
+                                        push @ret, $f;
+                               }
+                       }
+               }
+       }, $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)));
+       IkiWiki::run_hooks(format => sub {
+                       $preview = shift->(page => $page,
+                               content => $preview);
+               });
+
+       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);
+       });
+
+       return $template->output;
+}
+
 sub commentsshown ($) {
        my $page=shift;
 
@@ -654,6 +801,20 @@ sub pagetemplate (@) {
        }
 }
 
+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;
 
 sub match_postcomment ($$;@) {
index bba52e4fd322e8bbad5f63a13198ff5f491cdef5..c206d96a44f521200861271bd2256a03b49ccfa2 100644 (file)
@@ -105,11 +105,12 @@ sub check_content (@) {
                                $ok=1;
                        }
                        elsif (ref $ret eq 'CODE') {
-                               $ret->();
+                               $ret->() unless $params{nonfatal};
                                $ok=0;
                        }
                        elsif (defined $ret) {
-                               error($ret);
+                               error($ret) unless $params{nonfatal};
+                               $ok=0;
                        }
                }
 
index 7f6605fbf069151562ab184e68c4b4b190c289cb..c9ebcd1e995d69a566384cb148ab1a07d39e14ec 100644 (file)
@@ -2,8 +2,13 @@ ikiwiki (3.03) UNRELEASED; urgency=low
 
   * Avoid feeding decoded unicode to Term::ReadLine.
     Closes: 512169
-  * blogspam: Log spam info on failure.
+  * blogspam: Log spam info on failure in debug mode.
   * Remove nonstandard css. Closes: #512378
+  * blogspam: Fix use of blogspam_options and blogspam_server
+    config settings.
+  * comments: If comment content checks fail, store the comment
+    (in .ikiwiki/comments_pending) for moderator review.
+  * comments: Add a moderation web interface.
 
  -- Joey Hess <joeyh@debian.org>  Sun, 18 Jan 2009 14:50:57 -0500
 
index bdc37343225897f7aabd8b2b747a963afede97cf..09b68523eaddb1932dd0a19a1e82ede32004ad2e 100644 (file)
@@ -1,7 +1,7 @@
 I've produced a [code_swarm](http://vis.cs.ucdavis.edu/~ogawa/codeswarm/)
 visualization of the first 2+ years of ikiwiki's commit history. 
 
-[[!img screenshot.png size="480x360"]]
+[[!img screenshot.png size="480x360" alt="screenshot"]]
 
 * [15 mb avi](http://kitenet.net/~joey/screencasts/ikiwiki_swarm.avi)
 * [stream on vimeo](http://vimeo.com/1324348)
index 72b11af645a607711af4a3d16b39057d74ff9738..4cee3b9ad1d61ebcce952fc60a772f29b0a2370c 100644 (file)
@@ -41,3 +41,10 @@ There are some global options for the setup file:
   specify a name for themselves, and the \[[!meta author]] and
   \[[!meta authorurl]] directives will not be overridden by the comments
   plugin
+
+## comment moderation
+
+If you enable the [[blogspam]] plugin, comments that appear spammy will be
+held for moderation. These comments are stored in
+`.ikiwiki/comments_pending/`, and can be deleted, or moved into the
+wiki's srcdir to be posted.
index c61015890dbe72aacd2a8c697c2e3bef29ec5496..a6e6734e3124151829d585b2b566e5347df84c03 100644 (file)
@@ -23,6 +23,8 @@
        margin: 0;
        padding: 6px;
        list-style-type: none;
+}
+.pageheader .actions ul {
        border-bottom: 1px solid #000;
 }
 
diff --git a/templates/commentmoderation.tmpl b/templates/commentmoderation.tmpl
new file mode 100644 (file)
index 0000000..3dadb79
--- /dev/null
@@ -0,0 +1,23 @@
+<TMPL_IF NAME="COMMENTS">
+<br />
+<form action="<TMPL_VAR CGIURL>" method="post">
+<input type="hidden" name="do" value="commentmoderation" />
+<input type="hidden" name="sid" value="<TMPL_VAR SID>" />
+<TMPL_LOOP NAME="COMMENTS">
+<div>
+<div>
+<TMPL_VAR VIEW>
+</div>
+<input type="radio" value="Defer" name="<TMPL_VAR ID>" checked>Defer</input>
+<input type="radio" value="Accept" name="<TMPL_VAR ID>">Accept</input>
+<input type="radio" value="Reject" name="<TMPL_VAR ID>">Reject</input>
+</div>
+<br />
+</TMPL_LOOP>
+<input type="submit" value="Submit" />
+</form>
+<TMPL_ELSE>
+<p>
+No comments need moderation at this time.
+</p>
+</TMPL_IF>