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 2.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 => "sessioncgi", id => 'comment', call => \&sessioncgi);
  26         hook(type => "htmlize", id => "_comment", call => \&htmlize);
  27         hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
  28         hook(type => "cgi", id => "comments", call => \&linkcgi);
  29         IkiWiki::loadplugin("inline");
  30 }
  31
  32 sub getsetup () {
  33         return
  34                 plugin => {
  35                         safe => 1,
  36                         rebuild => 1,
  37                 },
  38                 comments_pagespec => {
  39                         type => 'pagespec',
  40                         example => 'blog/* and !*/Discussion',
  41                         description => 'PageSpec of pages where comments are allowed',
  42                         link => 'ikiwiki/PageSpec',
  43                         safe => 1,
  44                         rebuild => 1,
  45                 },
  46                 comments_closed_pagespec => {
  47                         type => 'pagespec',
  48                         example => 'blog/controversial or blog/flamewar',
  49                         description => 'PageSpec of pages where posting new comments is not allowed',
  50                         link => 'ikiwiki/PageSpec',
  51                         safe => 1,
  52                         rebuild => 1,
  53                 },
  54                 comments_pagename => {
  55                         type => 'string',
  56                         default => 'comment_',
  57                         description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
  58                         safe => 0, # manual page moving required
  59                         rebuild => undef,
  60                 },
  61                 comments_allowdirectives => {
  62                         type => 'boolean',
  63                         example => 0,
  64                         description => 'Interpret directives in comments?',
  65                         safe => 1,
  66                         rebuild => 0,
  67                 },
  68                 comments_allowauthor => {
  69                         type => 'boolean',
  70                         example => 0,
  71                         description => 'Allow anonymous commenters to set an author name?',
  72                         safe => 1,
  73                         rebuild => 0,
  74                 },
  75                 comments_commit => {
  76                         type => 'boolean',
  77                         example => 1,
  78                         description => 'commit comments to the VCS',
  79                         # old uncommitted comments are likely to cause
  80                         # confusion if this is changed
  81                         safe => 0,
  82                         rebuild => 0,
  83                 },
  84 }
  85
  86 sub checkconfig () {
  87         $config{comments_commit} = 1
  88                 unless defined $config{comments_commit};
  89         $config{comments_pagespec} = ''
  90                 unless defined $config{comments_pagespec};
  91         $config{comments_closed_pagespec} = ''
  92                 unless defined $config{comments_closed_pagespec};
  93         $config{comments_pagename} = 'comment_'
  94                 unless defined $config{comments_pagename};
  95 }
  96
  97 sub htmlize {
  98         my %params = @_;
  99         return $params{content};
 100 }
 101
 102 # FIXME: copied verbatim from meta
 103 sub safeurl ($) {
 104         my $url=shift;
 105         if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
 106             defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
 107                 return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
 108         }
 109         else {
 110                 return 1;
 111         }
 112 }
 113
 114 sub preprocess {
 115         my %params = @_;
 116         my $page = $params{page};
 117
 118         my $format = $params{format};
 119         if (defined $format && ! exists $IkiWiki::hooks{htmlize}{$format}) {
 120                 error(sprintf(gettext("unsupported page format %s"), $format));
 121         }
 122
 123         my $content = $params{content};
 124         if (! defined $content) {
 125                 error(gettext("comment must have content"));
 126         }
 127         $content =~ s/\\"/"/g;
 128
 129         $content = IkiWiki::filter($page, $params{destpage}, $content);
 130
 131         if ($config{comments_allowdirectives}) {
 132                 $content = IkiWiki::preprocess($page, $params{destpage},
 133                         $content);
 134         }
 135
 136         # no need to bother with htmlize if it's just HTML
 137         $content = IkiWiki::htmlize($page, $params{destpage}, $format,
 138                 $content) if defined $format;
 139
 140         IkiWiki::run_hooks(sanitize => sub {
 141                 $content = shift->(
 142                         page => $page,
 143                         destpage => $params{destpage},
 144                         content => $content,
 145                 );
 146         });
 147
 148         # set metadata, possibly overriding [[!meta]] directives from the
 149         # comment itself
 150
 151         my $commentuser;
 152         my $commentip;
 153         my $commentauthor;
 154         my $commentauthorurl;
 155         my $commentopenid;
 156         if (defined $params{username}) {
 157                 $commentuser = $params{username};
 158
 159                 my $oiduser = eval { IkiWiki::openiduser($commentuser) };
 160
 161                 if (defined $oiduser) {
 162                         # looks like an OpenID
 163                         $commentauthorurl = $commentuser;
 164                         $commentauthor = $oiduser;
 165                         $commentopenid = $commentuser;
 166                 }
 167                 else {
 168                         $commentauthorurl = IkiWiki::cgiurl(
 169                                 do => 'commenter',
 170                                 page => (length $config{userdir}
 171                                         ? "$config{userdir}/$commentuser"
 172                                         : "$commentuser"));
 173
 174                         $commentauthor = $commentuser;
 175                 }
 176         }
 177         else {
 178                 if (defined $params{ip}) {
 179                         $commentip = $params{ip};
 180                 }
 181                 $commentauthor = gettext("Anonymous");
 182         }
 183
 184         $commentstate{$page}{commentuser} = $commentuser;
 185         $commentstate{$page}{commentopenid} = $commentopenid;
 186         $commentstate{$page}{commentip} = $commentip;
 187         $commentstate{$page}{commentauthor} = $commentauthor;
 188         $commentstate{$page}{commentauthorurl} = $commentauthorurl;
 189         if (! defined $pagestate{$page}{meta}{author}) {
 190                 $pagestate{$page}{meta}{author} = $commentauthor;
 191         }
 192         if (! defined $pagestate{$page}{meta}{authorurl}) {
 193                 $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
 194         }
 195
 196         if ($config{comments_allowauthor}) {
 197                 if (defined $params{claimedauthor}) {
 198                         $pagestate{$page}{meta}{author} = $params{claimedauthor};
 199                 }
 200
 201                 if (defined $params{url} and safeurl($params{url})) {
 202                         $pagestate{$page}{meta}{authorurl} = $params{url};
 203                 }
 204         }
 205         else {
 206                 $pagestate{$page}{meta}{author} = $commentauthor;
 207                 $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
 208         }
 209
 210         if (defined $params{subject}) {
 211                 $pagestate{$page}{meta}{title} = $params{subject};
 212         }
 213
 214         if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
 215                 $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
 216                         "#".$params{page};
 217         }
 218
 219         eval q{use Date::Parse};
 220         if (! $@) {
 221                 my $time = str2time($params{date});
 222                 $IkiWiki::pagectime{$page} = $time if defined $time;
 223         }
 224
 225         return $content;
 226 }
 227
 228 # This is exactly the same as recentchanges_link :-(
 229 sub linkcgi ($) {
 230         my $cgi=shift;
 231         if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 232
 233                 my $page=decode_utf8($cgi->param("page"));
 234                 if (! defined $page) {
 235                         error("missing page parameter");
 236                 }
 237
 238                 IkiWiki::loadindex();
 239
 240                 my $link=bestlink("", $page);
 241                 if (! length $link) {
 242                         print "Content-type: text/html\n\n";
 243                         print IkiWiki::misctemplate(gettext(gettext("missing page")),
 244                                 "<p>".
 245                                 sprintf(gettext("The page %s does not exist."),
 246                                         htmllink("", "", $page)).
 247                                 "</p>");
 248                 }
 249                 else {
 250                         IkiWiki::redirect($cgi, urlto($link, undef, 1));
 251                 }
 252
 253                 exit;
 254         }
 255 }
 256
 257 # Mostly cargo-culted from IkiWiki::plugin::editpage
 258 sub sessioncgi ($$) {
 259         my $cgi=shift;
 260         my $session=shift;
 261
 262         my $do = $cgi->param('do');
 263         return unless $do eq 'comment';
 264
 265         IkiWiki::decode_cgi_utf8($cgi);
 266
 267         eval q{use CGI::FormBuilder};
 268         error($@) if $@;
 269
 270         my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
 271         my $form = CGI::FormBuilder->new(
 272                 fields => [qw{do sid page subject editcontent type author url}],
 273                 charset => 'utf-8',
 274                 method => 'POST',
 275                 required => [qw{editcontent}],
 276                 javascript => 0,
 277                 params => $cgi,
 278                 action => $config{cgiurl},
 279                 header => 0,
 280                 table => 0,
 281                 template => scalar IkiWiki::template_params('editcomment.tmpl'),
 282         );
 283
 284         IkiWiki::decode_form_utf8($form);
 285         IkiWiki::run_hooks(formbuilder_setup => sub {
 286                         shift->(title => "comment", form => $form, cgi => $cgi,
 287                                 session => $session, buttons => \@buttons);
 288                 });
 289         IkiWiki::decode_form_utf8($form);
 290
 291         my $type = $form->param('type');
 292         if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
 293                 $type = IkiWiki::possibly_foolish_untaint($type);
 294         }
 295         else {
 296                 $type = $config{default_pageext};
 297         }
 298         my @page_types;
 299         if (exists $IkiWiki::hooks{htmlize}) {
 300                 @page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
 301         }
 302
 303         $form->field(name => 'do', type => 'hidden');
 304         $form->field(name => 'sid', type => 'hidden', value => $session->id,
 305                 force => 1);
 306         $form->field(name => 'page', type => 'hidden');
 307         $form->field(name => 'subject', type => 'text', size => 72);
 308         $form->field(name => 'editcontent', type => 'textarea', rows => 10);
 309         $form->field(name => "type", value => $type, force => 1,
 310                 type => 'select', options => \@page_types);
 311
 312         $form->tmpl_param(username => $session->param('name'));
 313
 314         if ($config{comments_allowauthor} and
 315             ! defined $session->param('name')) {
 316                 $form->tmpl_param(allowauthor => 1);
 317                 $form->field(name => 'author', type => 'text', size => '40');
 318                 $form->field(name => 'url', type => 'text', size => '40');
 319         }
 320         else {
 321                 $form->tmpl_param(allowauthor => 0);
 322                 $form->field(name => 'author', type => 'hidden', value => '',
 323                         force => 1);
 324                 $form->field(name => 'url', type => 'hidden', value => '',
 325                         force => 1);
 326         }
 327
 328         # The untaint is OK (as in editpage) because we're about to pass
 329         # it to file_pruned anyway
 330         my $page = $form->field('page');
 331         $page = IkiWiki::possibly_foolish_untaint($page);
 332         if (! defined $page || ! length $page ||
 333                 IkiWiki::file_pruned($page, $config{srcdir})) {
 334                 error(gettext("bad page name"));
 335         }
 336
 337         # FIXME: is this right? Or should we be using the candidate subpage
 338         # (whatever that might mean) as the base URL?
 339         my $baseurl = urlto($page, undef, 1);
 340
 341         $form->title(sprintf(gettext("commenting on %s"),
 342                         IkiWiki::pagetitle($page)));
 343
 344         $form->tmpl_param('helponformattinglink',
 345                 htmllink($page, $page, 'ikiwiki/formatting',
 346                         noimageinline => 1,
 347                         linktext => 'FormattingHelp'),
 348                         allowdirectives => $config{allow_directives});
 349
 350         if ($form->submitted eq CANCEL) {
 351                 # bounce back to the page they wanted to comment on, and exit.
 352                 # CANCEL need not be considered in future
 353                 IkiWiki::redirect($cgi, urlto($page, undef, 1));
 354                 exit;
 355         }
 356
 357         if (not exists $pagesources{$page}) {
 358                 error(sprintf(gettext(
 359                         "page '%s' doesn't exist, so you can't comment"),
 360                         $page));
 361         }
 362
 363         if (pagespec_match($page, $config{comments_closed_pagespec},
 364                 location => $page)) {
 365                 error(sprintf(gettext(
 366                         "comments on page '%s' are closed"),
 367                         $page));
 368         }
 369
 370         # Set a flag to indicate that we're posting a comment,
 371         # so that postcomment() can tell it should match.
 372         $postcomment=1;
 373         IkiWiki::check_canedit($page, $cgi, $session);
 374         $postcomment=0;
 375
 376         # FIXME: rather a simplistic way to make the comments...
 377         my $i = 0;
 378         my $file;
 379         my $location;
 380         do {
 381                 $i++;
 382                 $location = "$page/$config{comments_pagename}$i";
 383         } while (-e "$config{srcdir}/$location._comment");
 384
 385         my $content = "[[!_comment format=$type\n";
 386
 387         # FIXME: handling of double quotes probably wrong?
 388         if (defined $session->param('name')) {
 389                 my $username = $session->param('name');
 390                 $username =~ s/"/&quot;/g;
 391                 $content .= " username=\"$username\"\n";
 392         }
 393         elsif (defined $ENV{REMOTE_ADDR}) {
 394                 my $ip = $ENV{REMOTE_ADDR};
 395                 if ($ip =~ m/^([.0-9]+)$/) {
 396                         $content .= " ip=\"$1\"\n";
 397                 }
 398         }
 399
 400         if ($config{comments_allowauthor}) {
 401                 my $author = $form->field('author');
 402                 if (length $author) {
 403                         $author =~ s/"/&quot;/g;
 404                         $content .= " claimedauthor=\"$author\"\n";
 405                 }
 406                 my $url = $form->field('url');
 407                 if (length $url) {
 408                         $url =~ s/"/&quot;/g;
 409                         $content .= " url=\"$url\"\n";
 410                 }
 411         }
 412
 413         my $subject = $form->field('subject');
 414         if (length $subject) {
 415                 $subject =~ s/"/&quot;/g;
 416                 $content .= " subject=\"$subject\"\n";
 417         }
 418
 419         $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 420
 421         my $editcontent = $form->field('editcontent') || '';
 422         $editcontent =~ s/\r\n/\n/g;
 423         $editcontent =~ s/\r/\n/g;
 424         $editcontent =~ s/"/\\"/g;
 425         $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 426
 427         # This is essentially a simplified version of editpage:
 428         # - the user does not control the page that's created, only the parent
 429         # - it's always a create operation, never an edit
 430         # - this means that conflicts should never happen
 431         # - this means that if they do, rocks fall and everyone dies
 432
 433         if ($form->submitted eq PREVIEW) {
 434                 my $preview = IkiWiki::htmlize($location, $page, '_comment',
 435                                 IkiWiki::linkify($page, $page,
 436                                         IkiWiki::preprocess($page, $page,
 437                                                 IkiWiki::filter($location,
 438                                                         $page, $content),
 439                                                 0, 1)));
 440                 IkiWiki::run_hooks(format => sub {
 441                                 $preview = shift->(page => $page,
 442                                         content => $preview);
 443                         });
 444
 445                 my $template = template("comment.tmpl");
 446                 $template->param(content => $preview);
 447                 $template->param(title => $form->field('subject'));
 448                 $template->param(ctime => displaytime(time));
 449
 450                 $form->tmpl_param(page_preview => $template->output);
 451         }
 452         else {
 453                 $form->tmpl_param(page_preview => "");
 454         }
 455
 456         if ($form->submitted eq POST_COMMENT && $form->validate) {
 457                 my $file = "$location._comment";
 458
 459                 IkiWiki::checksessionexpiry($cgi, $session);
 460
 461                 # FIXME: could probably do some sort of graceful retry
 462                 # on error? Would require significant unwinding though
 463                 writefile($file, $config{srcdir}, $content);
 464
 465                 my $conflict;
 466
 467                 if ($config{rcs} and $config{comments_commit}) {
 468                         my $message = gettext("Added a comment");
 469                         if (defined $form->field('subject') &&
 470                                 length $form->field('subject')) {
 471                                 $message = sprintf(
 472                                         gettext("Added a comment: %s"),
 473                                         $form->field('subject'));
 474                         }
 475
 476                         IkiWiki::rcs_add($file);
 477                         IkiWiki::disable_commit_hook();
 478                         $conflict = IkiWiki::rcs_commit_staged($message,
 479                                 $session->param('name'), $ENV{REMOTE_ADDR});
 480                         IkiWiki::enable_commit_hook();
 481                         IkiWiki::rcs_update();
 482                 }
 483
 484                 # Now we need a refresh
 485                 require IkiWiki::Render;
 486                 IkiWiki::refresh();
 487                 IkiWiki::saveindex();
 488
 489                 # this should never happen, unless a committer deliberately
 490                 # breaks it or something
 491                 error($conflict) if defined $conflict;
 492
 493                 # Jump to the new comment on the page.
 494                 IkiWiki::redirect($cgi, urlto($page, undef, 1)."#$location");
 495         }
 496         else {
 497                 IkiWiki::showform ($form, \@buttons, $session, $cgi,
 498                         forcebaseurl => $baseurl);
 499         }
 500
 501         exit;
 502 }
 503
 504 sub commentsshown ($) {
 505         my $page=shift;
 506
 507         return ! pagespec_match($page, "*/$config{comments_pagename}*",
 508                                 location => $page) &&
 509                pagespec_match($page, $config{comments_pagespec},
 510                               location => $page);
 511 }
 512
 513 sub commentsopen ($) {
 514         my $page = shift;
 515
 516         return length $config{cgiurl} > 0 &&
 517                (! length $config{comments_closed_pagespec} ||
 518                 ! pagespec_match($page, $config{comments_closed_pagespec},
 519                                  location => $page));
 520 }
 521
 522 sub pagetemplate (@) {
 523         my %params = @_;
 524
 525         my $page = $params{page};
 526         my $template = $params{template};
 527         my $shown = ($template->query(name => 'commentslink') ||
 528                      $template->query(name => 'comments')) &&
 529                     commentsshown($page);
 530
 531         if ($template->query(name => 'comments')) {
 532                 my $comments = undef;
 533                 if ($shown) {
 534                         $comments = IkiWiki::preprocess_inline(
 535                                 pages => "internal($page/$config{comments_pagename}*)",
 536                                 template => 'comment',
 537                                 show => 0,
 538                                 reverse => 'yes',
 539                                 page => $page,
 540                                 destpage => $params{destpage},
 541                                 feedfile => 'comments',
 542                                 emptyfeeds => 'no',
 543                         );
 544                 }
 545
 546                 if (defined $comments && length $comments) {
 547                         $template->param(comments => $comments);
 548                 }
 549
 550                 if ($shown && commentsopen($page)) {
 551                         my $addcommenturl = IkiWiki::cgiurl(do => 'comment',
 552                                 page => $page);
 553                         $template->param(addcommenturl => $addcommenturl);
 554                 }
 555         }
 556
 557         if ($template->query(name => 'commentslink')) {
 558                 # XXX Would be nice to say how many comments there are in
 559                 # the link. But, to update the number, blog pages
 560                 # would have to update whenever comments of any inlines
 561                 # page are added, which is not currently done.
 562                 if ($shown) {
 563                         $template->param(commentslink =>
 564                                 htmllink($page, $params{destpage}, $page,
 565                                         linktext => gettext("Comments"),
 566                                         anchor => "comments",
 567                                         noimageinline => 1));
 568                 }
 569         }
 570
 571         if ($template->query(name => 'commentuser')) {
 572                 $template->param(commentuser =>
 573                         $commentstate{$page}{commentuser});
 574         }
 575
 576         if ($template->query(name => 'commentopenid')) {
 577                 $template->param(commentopenid =>
 578                         $commentstate{$page}{commentopenid});
 579         }
 580
 581         if ($template->query(name => 'commentip')) {
 582                 $template->param(commentip =>
 583                         $commentstate{$page}{commentip});
 584         }
 585
 586         if ($template->query(name => 'commentauthor')) {
 587                 $template->param(commentauthor =>
 588                         $commentstate{$page}{commentauthor});
 589         }
 590
 591         if ($template->query(name => 'commentauthorurl')) {
 592                 $template->param(commentauthorurl =>
 593                         $commentstate{$page}{commentauthorurl});
 594         }
 595 }
 596
 597 package IkiWiki::PageSpec;
 598
 599 sub match_postcomment ($$;@) {
 600         my $page = shift;
 601         my $glob = shift;
 602
 603         if (! $postcomment) {
 604                 return IkiWiki::FailReason->new("not posting a comment");
 605         }
 606         return match_glob($page, $glob);
 607 }
 608
 609 1