add ikiwiki-comment program
[ikiwiki.git] / IkiWiki / Plugin / comments.pm
1 #!/usr/bin/perl
2 # Copyright © 2006-2008 Joey Hess <joey@ikiwiki.info>
3 # Copyright © 2008 Simon McVittie <http://smcv.pseudorandom.co.uk/>
4 # Licensed under the GNU GPL, version 2, or any later version published by the
5 # Free Software Foundation
6 package IkiWiki::Plugin::comments;
7
8 use warnings;
9 use strict;
10 use IkiWiki 3.00;
11 use Encode;
12
13 use constant PREVIEW => "Preview";
14 use constant POST_COMMENT => "Post comment";
15 use constant CANCEL => "Cancel";
16
17 my $postcomment;
18 my %commentstate;
19
20 sub import {
21         hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
22         hook(type => "getsetup", id => 'comments',  call => \&getsetup);
23         hook(type => "preprocess", id => 'comment', call => \&preprocess,
24                 scan => 1);
25         hook(type => "preprocess", id => 'commentmoderation', call => \&preprocess_moderation);
26         # here for backwards compatability with old comments
27         hook(type => "preprocess", id => '_comment', call => \&preprocess);
28         hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
29         hook(type => "htmlize", id => "_comment", call => \&htmlize);
30         hook(type => "htmlize", id => "_comment_pending",
31                 call => \&htmlize_pending);
32         hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
33         hook(type => "formbuilder_setup", id => "comments",
34                 call => \&formbuilder_setup);
35         # Load goto to fix up user page links for logged-in commenters
36         IkiWiki::loadplugin("goto");
37         IkiWiki::loadplugin("inline");
38         IkiWiki::loadplugin("transient");
39 }
40
41 sub getsetup () {
42         return
43                 plugin => {
44                         safe => 1,
45                         rebuild => 1,
46                         section => "web",
47                 },
48                 comments_pagespec => {
49                         type => 'pagespec',
50                         example => 'blog/* and !*/Discussion',
51                         description => 'PageSpec of pages where comments are allowed',
52                         link => 'ikiwiki/PageSpec',
53                         safe => 1,
54                         rebuild => 1,
55                 },
56                 comments_closed_pagespec => {
57                         type => 'pagespec',
58                         example => 'blog/controversial or blog/flamewar',
59                         description => 'PageSpec of pages where posting new comments is not allowed',
60                         link => 'ikiwiki/PageSpec',
61                         safe => 1,
62                         rebuild => 1,
63                 },
64                 comments_pagename => {
65                         type => 'string',
66                         default => 'comment_',
67                         description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
68                         safe => 0, # manual page moving required
69                         rebuild => undef,
70                 },
71                 comments_allowdirectives => {
72                         type => 'boolean',
73                         example => 0,
74                         description => 'Interpret directives in comments?',
75                         safe => 1,
76                         rebuild => 0,
77                 },
78                 comments_allowauthor => {
79                         type => 'boolean',
80                         example => 0,
81                         description => 'Allow anonymous commenters to set an author name?',
82                         safe => 1,
83                         rebuild => 0,
84                 },
85                 comments_commit => {
86                         type => 'boolean',
87                         example => 1,
88                         description => 'commit comments to the VCS',
89                         # old uncommitted comments are likely to cause
90                         # confusion if this is changed
91                         safe => 0,
92                         rebuild => 0,
93                 },
94                 comments_allowformats => {
95                         type => 'string',
96                         default => '',
97                         example => 'mdwn txt',
98                         description => 'Restrict formats for comments to (no restriction if empty)',
99                         safe => 1,
100                         rebuild => 0,
101                 },
102
103 }
104
105 sub checkconfig () {
106         $config{comments_commit} = 1
107                 unless defined $config{comments_commit};
108         if (! $config{comments_commit}) {
109                 $config{only_committed_changes}=0;
110         }
111         $config{comments_pagespec} = ''
112                 unless defined $config{comments_pagespec};
113         $config{comments_closed_pagespec} = ''
114                 unless defined $config{comments_closed_pagespec};
115         $config{comments_pagename} = 'comment_'
116                 unless defined $config{comments_pagename};
117         $config{comments_allowformats} = ''
118                 unless defined $config{comments_allowformats};
119 }
120
121 sub htmlize {
122         my %params = @_;
123         return $params{content};
124 }
125
126 sub htmlize_pending {
127         my %params = @_;
128         return sprintf(gettext("this comment needs %s"),
129                 '<a href="'.
130                 IkiWiki::cgiurl(do => "commentmoderation").'">'.
131                 gettext("moderation").'</a>');
132 }
133
134 # FIXME: copied verbatim from meta
135 sub safeurl ($) {
136         my $url=shift;
137         if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
138             defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
139                 return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
140         }
141         else {
142                 return 1;
143         }
144 }
145
146 sub isallowed ($) {
147     my $format = shift;
148     return ! $config{comments_allowformats} || $config{comments_allowformats} =~ /\b$format\b/;
149 }
150
151 sub preprocess {
152         my %params = @_;
153         my $page = $params{page};
154
155         my $format = $params{format};
156         if (defined $format && (! exists $IkiWiki::hooks{htmlize}{$format} ||
157                                 ! isallowed($format))) {
158                 error(sprintf(gettext("unsupported page format %s"), $format));
159         }
160
161         my $content = $params{content};
162         if (! defined $content) {
163                 error(gettext("comment must have content"));
164         }
165         $content =~ s/\\"/"/g;
166
167         if (defined wantarray) {
168                 if ($config{comments_allowdirectives}) {
169                         $content = IkiWiki::preprocess($page, $params{destpage},
170                                 $content);
171                 }
172
173                 # no need to bother with htmlize if it's just HTML
174                 $content = IkiWiki::htmlize($page, $params{destpage}, $format, $content)
175                         if defined $format;
176
177                 IkiWiki::run_hooks(sanitize => sub {
178                         $content = shift->(
179                                 page => $page,
180                                 destpage => $params{destpage},
181                                 content => $content,
182                         );
183                 });
184         }
185         else {
186                 IkiWiki::preprocess($page, $params{destpage}, $content, 1);
187         }
188
189         # set metadata, possibly overriding [[!meta]] directives from the
190         # comment itself
191
192         my $commentuser;
193         my $commentip;
194         my $commentauthor;
195         my $commentauthorurl;
196         my $commentopenid;
197         if (defined $params{username}) {
198                 $commentuser = $params{username};
199
200                 my $oiduser = eval { IkiWiki::openiduser($commentuser) };
201
202                 if (defined $oiduser) {
203                         # looks like an OpenID
204                         $commentauthorurl = $commentuser;
205                         $commentauthor = (defined $params{nickname} && length $params{nickname}) ? $params{nickname} : $oiduser;
206                         $commentopenid = $commentuser;
207                 }
208                 else {
209                         $commentauthorurl = IkiWiki::cgiurl(
210                                 do => 'goto',
211                                 page => IkiWiki::userpage($commentuser)
212                         );
213
214                         $commentauthor = $commentuser;
215                 }
216         }
217         else {
218                 if (defined $params{ip}) {
219                         $commentip = $params{ip};
220                 }
221                 $commentauthor = gettext("Anonymous");
222         }
223
224         $commentstate{$page}{commentuser} = $commentuser;
225         $commentstate{$page}{commentopenid} = $commentopenid;
226         $commentstate{$page}{commentip} = $commentip;
227         $commentstate{$page}{commentauthor} = $commentauthor;
228         $commentstate{$page}{commentauthorurl} = $commentauthorurl;
229         $commentstate{$page}{commentauthoravatar} = $params{avatar};
230         if (! defined $pagestate{$page}{meta}{author}) {
231                 $pagestate{$page}{meta}{author} = $commentauthor;
232         }
233         if (! defined $pagestate{$page}{meta}{authorurl}) {
234                 $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
235         }
236
237         if ($config{comments_allowauthor}) {
238                 if (defined $params{claimedauthor}) {
239                         $pagestate{$page}{meta}{author} = $params{claimedauthor};
240                 }
241
242                 if (defined $params{url}) {
243                         my $url=$params{url};
244
245                         eval q{use URI::Heuristic}; 
246                         if (! $@) {
247                                 $url=URI::Heuristic::uf_uristr($url);
248                         }
249
250                         if (safeurl($url)) {
251                                 $pagestate{$page}{meta}{authorurl} = $url;
252                         }
253                 }
254         }
255         else {
256                 $pagestate{$page}{meta}{author} = $commentauthor;
257                 $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
258         }
259
260         if (defined $params{subject}) {
261                 # decode title the same way meta does
262                 eval q{use HTML::Entities};
263                 $pagestate{$page}{meta}{title} = decode_entities($params{subject});
264         }
265
266         if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {
267                 $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page})).
268                         "#".page_to_id($params{page});
269         }
270
271         eval q{use Date::Parse};
272         if (! $@) {
273                 my $time = str2time($params{date});
274                 $IkiWiki::pagectime{$page} = $time if defined $time;
275         }
276
277         return $content;
278 }
279
280 sub preprocess_moderation {
281         my %params = @_;
282
283         $params{desc}=gettext("Comment Moderation")
284                 unless defined $params{desc};
285
286         if (length $config{cgiurl}) {
287                 return '<a href="'.
288                         IkiWiki::cgiurl(do => 'commentmoderation').
289                         '">'.$params{desc}.'</a>';
290         }
291         else {
292                 return $params{desc};
293         }
294 }
295
296 sub sessioncgi ($$) {
297         my $cgi=shift;
298         my $session=shift;
299
300         my $do = $cgi->param('do');
301         if ($do eq 'comment') {
302                 editcomment($cgi, $session);
303         }
304         elsif ($do eq 'commentmoderation') {
305                 commentmoderation($cgi, $session);
306         }
307         elsif ($do eq 'commentsignin') {
308                 IkiWiki::cgi_signin($cgi, $session);
309                 exit;
310         }
311 }
312
313 # Mostly cargo-culted from IkiWiki::plugin::editpage
314 sub editcomment ($$) {
315         my $cgi=shift;
316         my $session=shift;
317
318         IkiWiki::decode_cgi_utf8($cgi);
319
320         eval q{use CGI::FormBuilder};
321         error($@) if $@;
322
323         my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
324         my $form = CGI::FormBuilder->new(
325                 fields => [qw{do sid page subject editcontent type author
326                         email url subscribe anonsubscribe}],
327                 charset => 'utf-8',
328                 method => 'POST',
329                 required => [qw{editcontent}],
330                 javascript => 0,
331                 params => $cgi,
332                 action => IkiWiki::cgiurl(),
333                 header => 0,
334                 table => 0,
335                 template => { template('editcomment.tmpl') },
336         );
337
338         IkiWiki::decode_form_utf8($form);
339         IkiWiki::run_hooks(formbuilder_setup => sub {
340                         shift->(title => "comment", form => $form, cgi => $cgi,
341                                 session => $session, buttons => \@buttons);
342                 });
343         IkiWiki::decode_form_utf8($form);
344
345         my $type = $form->param('type');
346         if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
347                 $type = IkiWiki::possibly_foolish_untaint($type);
348         }
349         else {
350                 $type = $config{default_pageext};
351         }
352
353
354         my @page_types;
355         if (exists $IkiWiki::hooks{htmlize}) {
356                 foreach my $key (grep { !/^_/ && isallowed($_) } keys %{$IkiWiki::hooks{htmlize}}) {
357                         push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
358                 }
359         }
360         @page_types=sort @page_types;
361
362         $form->field(name => 'do', type => 'hidden');
363         $form->field(name => 'sid', type => 'hidden', value => $session->id,
364                 force => 1);
365         $form->field(name => 'page', type => 'hidden');
366         $form->field(name => 'subject', type => 'text', size => 72);
367         $form->field(name => 'editcontent', type => 'textarea', rows => 10);
368         $form->field(name => "type", value => $type, force => 1,
369                 type => 'select', options => \@page_types);
370
371         my $username=$session->param('name');
372         $form->tmpl_param(username => $username);
373                 
374         $form->field(name => "subscribe", type => 'hidden');
375         $form->field(name => "anonsubscribe", type => 'hidden');
376         if (IkiWiki::Plugin::notifyemail->can("subscribe")) {
377                 if (defined $username) {
378                         $form->field(name => "subscribe", type => "checkbox",
379                                 options => [gettext("email replies to me")]);
380                 }
381                 elsif (IkiWiki::Plugin::passwordauth->can("anonuser")) {
382                         $form->field(name => "anonsubscribe", type => "checkbox",
383                                 options => [gettext("email replies to me")]);
384                 }
385         }
386
387         if ($config{comments_allowauthor} and
388             ! defined $session->param('name')) {
389                 $form->tmpl_param(allowauthor => 1);
390                 $form->field(name => 'author', type => 'text', size => '40');
391                 $form->field(name => 'email', type => 'text', size => '40');
392                 $form->field(name => 'url', type => 'text', size => '40');
393         }
394         else {
395                 $form->tmpl_param(allowauthor => 0);
396                 $form->field(name => 'author', type => 'hidden', value => '',
397                         force => 1);
398                 $form->field(name => 'email', type => 'hidden', value => '',
399                         force => 1);
400                 $form->field(name => 'url', type => 'hidden', value => '',
401                         force => 1);
402         }
403
404         if (! defined $session->param('name')) {
405                 # Make signinurl work and return here.
406                 $form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'commentsignin'));
407                 $session->param(postsignin => $ENV{QUERY_STRING});
408                 IkiWiki::cgi_savesession($session);
409         }
410
411         # The untaint is OK (as in editpage) because we're about to pass
412         # it to file_pruned and wiki_file_regexp anyway.
413         my ($page) = $form->field('page')=~/$config{wiki_file_regexp}/;
414         $page = IkiWiki::possibly_foolish_untaint($page);
415         if (! defined $page || ! length $page ||
416                 IkiWiki::file_pruned($page)) {
417                 error(gettext("bad page name"));
418         }
419
420         $form->title(sprintf(gettext("commenting on %s"),
421                         IkiWiki::pagetitle(IkiWiki::basename($page))));
422
423         $form->tmpl_param('helponformattinglink',
424                 htmllink($page, $page, 'ikiwiki/formatting',
425                         noimageinline => 1,
426                         linktext => 'FormattingHelp'),
427                         allowdirectives => $config{allow_directives});
428
429         if ($form->submitted eq CANCEL) {
430                 # bounce back to the page they wanted to comment on, and exit.
431                 IkiWiki::redirect($cgi, urlto($page));
432                 exit;
433         }
434
435         if (not exists $pagesources{$page}) {
436                 error(sprintf(gettext(
437                         "page '%s' doesn't exist, so you can't comment"),
438                         $page));
439         }
440
441         # There's no UI to get here, but someone might construct the URL,
442         # leading to a comment that exists in the repository but isn't
443         # shown
444         if (!pagespec_match($page, $config{comments_pagespec},
445                 location => $page)) {
446                 error(sprintf(gettext(
447                         "comments on page '%s' are not allowed"),
448                         $page));
449         }
450
451         if (pagespec_match($page, $config{comments_closed_pagespec},
452                 location => $page)) {
453                 error(sprintf(gettext(
454                         "comments on page '%s' are closed"),
455                         $page));
456         }
457
458         # Set a flag to indicate that we're posting a comment,
459         # so that postcomment() can tell it should match.
460         $postcomment=1;
461         IkiWiki::check_canedit($page, $cgi, $session);
462         $postcomment=0;
463
464         my $content = "[[!comment format=$type\n";
465
466         if (defined $session->param('name')) {
467                 my $username = $session->param('name');
468                 $username =~ s/"/&quot;/g;
469                 $content .= " username=\"$username\"\n";
470         }
471
472         if (defined $session->param('nickname')) {
473                 my $nickname = $session->param('nickname');
474                 $nickname =~ s/"/&quot;/g;
475                 $content .= " nickname=\"$nickname\"\n";
476         }
477
478         if (!(defined $session->param('name') || defined $session->param('nickname')) &&
479                 defined $session->remote_addr()) {
480                 $content .= " ip=\"".$session->remote_addr()."\"\n";
481         }
482
483         if ($config{comments_allowauthor}) {
484                 my $author = $form->field('author');
485                 if (defined $author && length $author) {
486                         $author =~ s/"/&quot;/g;
487                         $content .= " claimedauthor=\"$author\"\n";
488                 }
489                 my $url = $form->field('url');
490                 if (defined $url && length $url) {
491                         $url =~ s/"/&quot;/g;
492                         $content .= " url=\"$url\"\n";
493                 }
494         }
495
496         my $avatar=getavatar($session->param('name'));
497         if (defined $avatar && length $avatar) {
498                 $avatar =~ s/"/&quot;/g;
499                 $content .= " avatar=\"$avatar\"\n";
500         }
501
502         my $subject = $form->field('subject');
503         if (defined $subject && length $subject) {
504                 $subject =~ s/"/&quot;/g;
505         }
506         else {
507                 $subject = "comment ".(num_comments($page, $config{srcdir}) + 1);
508         }
509         $content .= " subject=\"$subject\"\n";
510         $content .= " " . commentdate() . "\n";
511
512         my $editcontent = $form->field('editcontent');
513         $editcontent="" if ! defined $editcontent;
514         $editcontent =~ s/\r\n/\n/g;
515         $editcontent =~ s/\r/\n/g;
516         $editcontent =~ s/"/\\"/g;
517         $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
518
519         my $location=unique_comment_location($page, $content, $config{srcdir});
520
521         # This is essentially a simplified version of editpage:
522         # - the user does not control the page that's created, only the parent
523         # - it's always a create operation, never an edit
524         # - this means that conflicts should never happen
525         # - this means that if they do, rocks fall and everyone dies
526
527         if ($form->submitted eq PREVIEW) {
528                 my $preview=previewcomment($content, $location, $page, time);
529                 IkiWiki::run_hooks(format => sub {
530                         $preview = shift->(page => $page,
531                                 content => $preview);
532                 });
533                 $form->tmpl_param(page_preview => $preview);
534         }
535         else {
536                 $form->tmpl_param(page_preview => "");
537         }
538
539         if ($form->submitted eq POST_COMMENT && $form->validate) {
540                 IkiWiki::checksessionexpiry($cgi, $session);
541
542                 if (IkiWiki::Plugin::notifyemail->can("subscribe")) {
543                         my $subspec="comment($page)";
544                         if (defined $username &&
545                             length $form->field("subscribe")) {
546                                 IkiWiki::Plugin::notifyemail::subscribe(
547                                         $username, $subspec);
548                         }
549                         elsif (length $form->field("email") &&
550                                length $form->field("anonsubscribe")) {
551                                 IkiWiki::Plugin::notifyemail::anonsubscribe(
552                                         $form->field("email"), $subspec);
553                         }
554                 }
555                 
556                 $postcomment=1;
557                 my $ok=IkiWiki::check_content(content => $form->field('editcontent'),
558                         subject => $form->field('subject'),
559                         $config{comments_allowauthor} ? (
560                                 author => $form->field('author'),
561                                 url => $form->field('url'),
562                         ) : (),
563                         page => $location,
564                         cgi => $cgi,
565                         session => $session,
566                         nonfatal => 1,
567                 );
568                 $postcomment=0;
569
570                 if (! $ok) {
571                         $location=unique_comment_location($page, $content, $IkiWiki::Plugin::transient::transientdir, "._comment_pending");
572                         writefile("$location._comment_pending", $IkiWiki::Plugin::transient::transientdir, $content);
573
574                         # Refresh so anything that deals with pending
575                         # comments can be updated.
576                         require IkiWiki::Render;
577                         IkiWiki::refresh();
578                         IkiWiki::saveindex();
579
580                         IkiWiki::printheader($session);
581                         print IkiWiki::cgitemplate($cgi, gettext(gettext("comment stored for moderation")),
582                                 "<p>".
583                                 gettext("Your comment will be posted after moderator review").
584                                 "</p>");
585                         exit;
586                 }
587
588                 # FIXME: could probably do some sort of graceful retry
589                 # on error? Would require significant unwinding though
590                 my $file = "$location._comment";
591                 writefile($file, $config{srcdir}, $content);
592
593                 my $conflict;
594
595                 if ($config{rcs} and $config{comments_commit}) {
596                         my $message = gettext("Added a comment");
597                         if (defined $form->field('subject') &&
598                                 length $form->field('subject')) {
599                                 $message = sprintf(
600                                         gettext("Added a comment: %s"),
601                                         $form->field('subject'));
602                         }
603
604                         IkiWiki::rcs_add($file);
605                         IkiWiki::disable_commit_hook();
606                         $conflict = IkiWiki::rcs_commit_staged(
607                                 message => $message,
608                                 session => $session,
609                         );
610                         IkiWiki::enable_commit_hook();
611                         IkiWiki::rcs_update();
612                 }
613
614                 # Now we need a refresh
615                 require IkiWiki::Render;
616                 IkiWiki::refresh();
617                 IkiWiki::saveindex();
618
619                 # this should never happen, unless a committer deliberately
620                 # breaks it or something
621                 error($conflict) if defined $conflict;
622
623                 # Jump to the new comment on the page.
624                 # The trailing question mark tries to avoid broken
625                 # caches and get the most recent version of the page.
626                 IkiWiki::redirect($cgi, urlto($page).
627                         "?updated#".page_to_id($location));
628
629         }
630         else {
631                 IkiWiki::showform($form, \@buttons, $session, $cgi,
632                         page => $page);
633         }
634
635         exit;
636 }
637
638 sub commentdate () {
639         "date=\"" . strftime_utf8('%Y-%m-%dT%H:%M:%SZ', gmtime) . "\"";
640 }
641
642 sub getavatar ($) {
643         my $user=shift;
644         return undef unless defined $user;
645
646         my $avatar;
647         eval q{use Libravatar::URL};
648         if (! $@) {
649                 my $oiduser = eval { IkiWiki::openiduser($user) };
650                 my $https=defined $config{url} && $config{url}=~/^https:/;
651
652                 if (defined $oiduser) {
653                         eval {
654                                 $avatar = libravatar_url(openid => $user, https => $https);
655                         }
656                 }
657                 if (! defined $avatar &&
658                     (my $email = IkiWiki::userinfo_get($user, 'email'))) {
659                         eval {
660                                 $avatar = libravatar_url(email => $email, https => $https);
661                         }
662                 }
663         }
664         return $avatar;
665 }
666
667
668 sub commentmoderation ($$) {
669         my $cgi=shift;
670         my $session=shift;
671
672         IkiWiki::needsignin($cgi, $session);
673         if (! IkiWiki::is_admin($session->param("name"))) {
674                 error(gettext("you are not logged in as an admin"));
675         }
676
677         IkiWiki::decode_cgi_utf8($cgi);
678         
679         if (defined $cgi->param('sid')) {
680                 IkiWiki::checksessionexpiry($cgi, $session);
681
682                 my $rejectalldefer=$cgi->param('rejectalldefer');
683
684                 my %vars=$cgi->Vars;
685                 my $added=0;
686                 foreach my $id (keys %vars) {
687                         if ($id =~ /(.*)\._comment(?:_pending)?$/) {
688                                 $id=decode_utf8($id);
689                                 my $action=$cgi->param($id);
690                                 next if $action eq 'Defer' && ! $rejectalldefer;
691
692                                 # Make sure that the id is of a legal
693                                 # pending comment.
694                                 my ($f) = $id =~ /$config{wiki_file_regexp}/;
695                                 if (! defined $f || ! length $f ||
696                                     IkiWiki::file_pruned($f)) {
697                                         error("illegal file");
698                                 }
699
700                                 my $page=IkiWiki::dirname($f);
701                                 my $filedir=$IkiWiki::Plugin::transient::transientdir;
702                                 my $file="$filedir/$f";
703                                 if (! -e $file) {
704                                         # old location
705                                         $file="$config{srcdir}/$f";
706                                         $filedir=$config{srcdir};
707                                         if (! -e $file) {
708                                                 # older location
709                                                 $file="$config{wikistatedir}/comments_pending/".$f;
710                                                 $filedir="$config{wikistatedir}/comments_pending";
711                                         }
712                                 }
713
714                                 if ($action eq 'Accept') {
715                                         my $content=eval { readfile($file) };
716                                         next if $@; # file vanished since form was displayed
717                                         my $dest=unique_comment_location($page, $content, $config{srcdir})."._comment";
718                                         writefile($dest, $config{srcdir}, $content);
719                                         if ($config{rcs} and $config{comments_commit}) {
720                                                 IkiWiki::rcs_add($dest);
721                                         }
722                                         $added++;
723                                 }
724
725                                 require IkiWiki::Render;
726                                 IkiWiki::prune($file, $filedir);
727                         }
728                 }
729
730                 if ($added) {
731                         my $conflict;
732                         if ($config{rcs} and $config{comments_commit}) {
733                                 my $message = gettext("Comment moderation");
734                                 IkiWiki::disable_commit_hook();
735                                 $conflict=IkiWiki::rcs_commit_staged(
736                                         message => $message,
737                                         session => $session,
738                                 );
739                                 IkiWiki::enable_commit_hook();
740                                 IkiWiki::rcs_update();
741                         }
742                 
743                         # Now we need a refresh
744                         require IkiWiki::Render;
745                         IkiWiki::refresh();
746                         IkiWiki::saveindex();
747                 
748                         error($conflict) if defined $conflict;
749                 }
750         }
751
752         my @comments=map {
753                 my ($id, $dir, $ctime)=@{$_};
754                 my $content=readfile("$dir/$id");
755                 my $preview=previewcomment($content, $id,
756                         $id, $ctime);
757                 {
758                         id => $id,
759                         view => $preview,
760                 }
761         } sort { $b->[2] <=> $a->[2] } comments_pending();
762
763         my $template=template("commentmoderation.tmpl");
764         $template->param(
765                 sid => $session->id,
766                 comments => \@comments,
767                 cgiurl => IkiWiki::cgiurl(),
768         );
769         IkiWiki::printheader($session);
770         my $out=$template->output;
771         IkiWiki::run_hooks(format => sub {
772                 $out = shift->(page => "", content => $out);
773         });
774         print IkiWiki::cgitemplate($cgi, gettext("comment moderation"), $out);
775         exit;
776 }
777
778 sub formbuilder_setup (@) {
779         my %params=@_;
780
781         my $form=$params{form};
782         if ($form->title eq "preferences" &&
783             IkiWiki::is_admin($params{session}->param("name"))) {
784                 push @{$params{buttons}}, "Comment Moderation";
785                 if ($form->submitted && $form->submitted eq "Comment Moderation") {
786                         commentmoderation($params{cgi}, $params{session});
787                 }
788         }
789 }
790
791 sub comments_pending () {
792         my @ret;
793
794         eval q{use File::Find};
795         error($@) if $@;
796         eval q{use Cwd};
797         error($@) if $@;
798         my $origdir=getcwd();
799
800         my $find_comments=sub {
801                 my $dir=shift;
802                 my $extension=shift;
803                 return unless -d $dir;
804
805                 chdir($dir) || die "chdir $dir: $!";
806
807                 find({
808                         no_chdir => 1,
809                         wanted => sub {
810                                 my $file=decode_utf8($_);
811                                 $file=~s/^\.\///;
812                                 return if ! length $file || IkiWiki::file_pruned($file)
813                                         || -l $_ || -d _ || $file !~ /\Q$extension\E$/;
814                                 my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
815                                 if (defined $f) {
816                                         my $ctime=(stat($_))[10];
817                                         push @ret, [$f, $dir, $ctime];
818                                 }
819                         }
820                 }, ".");
821
822                 chdir($origdir) || die "chdir $origdir: $!";
823         };
824         
825         $find_comments->($IkiWiki::Plugin::transient::transientdir, "._comment_pending");
826         # old location
827         $find_comments->($config{srcdir}, "._comment_pending");
828         # old location
829         $find_comments->("$config{wikistatedir}/comments_pending/",
830                 "._comment");
831
832         return @ret;
833 }
834
835 sub previewcomment ($$$) {
836         my $content=shift;
837         my $location=shift;
838         my $page=shift;
839         my $time=shift;
840
841         # Previewing a comment should implicitly enable comment posting mode.
842         my $oldpostcomment=$postcomment;
843         $postcomment=1;
844
845         my $preview = IkiWiki::htmlize($location, $page, '_comment',
846                         IkiWiki::linkify($location, $page,
847                         IkiWiki::preprocess($location, $page,
848                         IkiWiki::filter($location, $page, $content), 0, 1)));
849
850         my $template = template("comment.tmpl");
851         $template->param(content => $preview);
852         $template->param(ctime => displaytime($time, undef, 1));
853         $template->param(html5 => $config{html5});
854
855         IkiWiki::run_hooks(pagetemplate => sub {
856                 shift->(page => $location,
857                         destpage => $page,
858                         template => $template);
859         });
860
861         $template->param(have_actions => 0);
862
863         $postcomment=$oldpostcomment;
864
865         return $template->output;
866 }
867
868 sub commentsshown ($) {
869         my $page=shift;
870
871         return pagespec_match($page, $config{comments_pagespec},
872                 location => $page);
873 }
874
875 sub commentsopen ($) {
876         my $page = shift;
877
878         return length $config{cgiurl} > 0 &&
879                (! length $config{comments_closed_pagespec} ||
880                 ! pagespec_match($page, $config{comments_closed_pagespec},
881                                  location => $page));
882 }
883
884 sub pagetemplate (@) {
885         my %params = @_;
886
887         my $page = $params{page};
888         my $template = $params{template};
889         my $shown = ($template->query(name => 'commentslink') ||
890                      $template->query(name => 'commentsurl') ||
891                      $template->query(name => 'atomcommentsurl') ||
892                      $template->query(name => 'comments')) &&
893                     commentsshown($page);
894
895         if ($template->query(name => 'comments')) {
896                 my $comments = undef;
897                 if ($shown) {
898                         $comments = IkiWiki::preprocess_inline(
899                                 pages => "comment($page) and !comment($page/*)",
900                                 template => 'comment',
901                                 show => 0,
902                                 reverse => 'yes',
903                                 page => $page,
904                                 destpage => $params{destpage},
905                                 feedfile => 'comments',
906                                 emptyfeeds => 'no',
907                         );
908                 }
909
910                 if (defined $comments && length $comments) {
911                         $template->param(comments => $comments);
912                 }
913
914                 if ($shown && commentsopen($page)) {
915                         $template->param(addcommenturl => addcommenturl($page));
916                 }
917         }
918
919         if ($shown) {
920                 if ($template->query(name => 'commentsurl')) {
921                         $template->param(commentsurl =>
922                                 urlto($page).'#comments');
923                 }
924
925                 if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
926                         # This will 404 until there are some comments, but I
927                         # think that's probably OK...
928                         $template->param(atomcommentsurl =>
929                                 urlto($page).'comments.atom');
930                 }
931
932                 if ($template->query(name => 'commentslink')) {
933                         my $num=num_comments($page, $config{srcdir});
934                         my $link;
935                         if ($num > 0) {
936                                 $link = htmllink($page, $params{destpage}, $page,
937                                         linktext => sprintf(ngettext("%i comment", "%i comments", $num), $num),
938                                         anchor => "comments",
939                                         noimageinline => 1
940                                 );
941                         }
942                         elsif (commentsopen($page)) {
943                                 $link = "<a href=\"".addcommenturl($page)."\">".
944                                         #translators: Here "Comment" is a verb;
945                                         #translators: the user clicks on it to
946                                         #translators: post a comment.
947                                         gettext("Comment").
948                                         "</a>";
949                         }
950                         $template->param(commentslink => $link)
951                                 if defined $link;
952                 }
953         }
954
955         # everything below this point is only relevant to the comments
956         # themselves
957         if (!exists $commentstate{$page}) {
958                 return;
959         }
960         
961         if ($template->query(name => 'commentid')) {
962                 $template->param(commentid => page_to_id($page));
963         }
964
965         if ($template->query(name => 'commentuser')) {
966                 $template->param(commentuser =>
967                         $commentstate{$page}{commentuser});
968         }
969
970         if ($template->query(name => 'commentopenid')) {
971                 $template->param(commentopenid =>
972                         $commentstate{$page}{commentopenid});
973         }
974
975         if ($template->query(name => 'commentip')) {
976                 $template->param(commentip =>
977                         $commentstate{$page}{commentip});
978         }
979
980         if ($template->query(name => 'commentauthor')) {
981                 $template->param(commentauthor =>
982                         $commentstate{$page}{commentauthor});
983         }
984
985         if ($template->query(name => 'commentauthorurl')) {
986                 $template->param(commentauthorurl =>
987                         $commentstate{$page}{commentauthorurl});
988         }
989
990         if ($template->query(name => 'commentauthoravatar')) {
991                 $template->param(commentauthoravatar =>
992                         $commentstate{$page}{commentauthoravatar});
993         }
994
995         if ($template->query(name => 'removeurl') &&
996             IkiWiki::Plugin::remove->can("check_canremove") &&
997             length $config{cgiurl}) {
998                 $template->param(removeurl => IkiWiki::cgiurl(do => 'remove',
999                         page => $page));
1000                 $template->param(have_actions => 1);
1001         }
1002 }
1003
1004 sub addcommenturl ($) {
1005         my $page=shift;
1006
1007         return IkiWiki::cgiurl(do => 'comment', page => $page);
1008 }
1009
1010 sub num_comments ($$) {
1011         my $page=shift;
1012         my $dir=shift;
1013
1014         my @comments=glob("$dir/$page/$config{comments_pagename}*._comment");
1015         return int @comments;
1016 }
1017
1018 sub unique_comment_location ($$$;$) {
1019         my $page=shift;
1020         eval q{use Digest::MD5 'md5_hex'};
1021         error($@) if $@;
1022         my $content_md5=md5_hex(Encode::encode_utf8(shift));
1023         my $dir=shift;
1024         my $ext=shift || "._comment";
1025
1026         my $location;
1027         my $i = num_comments($page, $dir);
1028         do {
1029                 $i++;
1030                 $location = "$page/$config{comments_pagename}${i}_${content_md5}";
1031         } while (-e "$dir/$location$ext");
1032
1033         return $location;
1034 }
1035
1036 sub page_to_id ($) {
1037         # Converts a comment page name into a unique, legal html id
1038         # attribute value, that can be used as an anchor to link to the
1039         # comment.
1040         my $page=shift;
1041
1042         eval q{use Digest::MD5 'md5_hex'};
1043         error($@) if $@;
1044
1045         return "comment-".md5_hex(Encode::encode_utf8(($page)));
1046 }
1047         
1048 package IkiWiki::PageSpec;
1049
1050 sub match_postcomment ($$;@) {
1051         my $page = shift;
1052         my $glob = shift;
1053
1054         if (! $postcomment) {
1055                 return IkiWiki::FailReason->new("not posting a comment");
1056         }
1057         return match_glob($page, $glob, @_);
1058 }
1059
1060 sub match_comment ($$;@) {
1061         my $page = shift;
1062         my $glob = shift;
1063
1064         if (! $postcomment) {
1065                 # To see if it's a comment, check the source file type.
1066                 # Deal with comments that were just deleted.
1067                 my $source=exists $IkiWiki::pagesources{$page} ?
1068                         $IkiWiki::pagesources{$page} :
1069                         $IkiWiki::delpagesources{$page};
1070                 my $type=defined $source ? IkiWiki::pagetype($source) : undef;
1071                 if (! defined $type || $type ne "_comment") {
1072                         return IkiWiki::FailReason->new("$page is not a comment");
1073                 }
1074         }
1075
1076         return match_glob($page, "$glob/*", internal => 1, @_);
1077 }
1078
1079 sub match_comment_pending ($$;@) {
1080         my $page = shift;
1081         my $glob = shift;
1082         
1083         my $source=exists $IkiWiki::pagesources{$page} ?
1084                 $IkiWiki::pagesources{$page} :
1085                 $IkiWiki::delpagesources{$page};
1086         my $type=defined $source ? IkiWiki::pagetype($source) : undef;
1087         if (! defined $type || $type ne "_comment_pending") {
1088                 return IkiWiki::FailReason->new("$page is not a pending comment");
1089         }
1090
1091         return match_glob($page, "$glob/*", internal => 1, @_);
1092 }
1093
1094 1