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