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