whitespace
[ikiwiki.git] / IkiWiki / Plugin / comments.pm
index 33d8ca8e212aaf4b907c922b6e75cc6897b6b86a..6c8952d4553deb99d1435beddd5de21aae76771c 100644 (file)
@@ -8,25 +8,24 @@ package IkiWiki::Plugin::comments;
 use warnings;
 use strict;
 use IkiWiki 2.00;
+use Encode;
+use POSIX qw(strftime);
 
 use constant PREVIEW => "Preview";
 use constant POST_COMMENT => "Post comment";
 use constant CANCEL => "Cancel";
 
+my $postcomment;
+
 sub import { #{{{
+       hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);
-       hook(type => "preprocess", id => 'comments', call => \&preprocess);
+       hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
+       hook(type => "cgi", id => "comments", call => \&linkcgi);
        IkiWiki::loadplugin("inline");
-       IkiWiki::loadplugin("mdwn");
-} # }}}
-
-sub htmlize { # {{{
-       eval q{use IkiWiki::Plugin::mdwn};
-       error($@) if ($@);
-       return IkiWiki::Plugin::mdwn::htmlize(@_)
 } # }}}
 
 sub getsetup () { #{{{
@@ -60,14 +59,22 @@ sub getsetup () { #{{{
                        example => 'comment_',
                        default => 'comment_',
                        description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
-                       safe => 0, # manual page moving will required
+                       safe => 0, # manual page moving required
                        rebuild => undef,
                },
                comments_allowdirectives => {
                        type => 'boolean',
                        default => 0,
                        example => 0,
-                       description => 'Allow directives in newly posted comments?',
+                       description => 'Interpret directives in comments?',
+                       safe => 1,
+                       rebuild => 0,
+               },
+               comments_allowauthor => {
+                       type => 'boolean',
+                       default => 0,
+                       example => 0,
+                       description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
                        rebuild => 0,
                },
@@ -83,74 +90,161 @@ sub getsetup () { #{{{
                },
 } #}}}
 
-# Somewhat based on IkiWiki::Plugin::inline blog posting support
-sub preprocess (@) { #{{{
-       my %params=@_;
+sub htmlize { # {{{
+       my %params = @_;
+       return $params{content};
+} # }}}
 
-       return "";
+# FIXME: copied verbatim from meta
+sub safeurl ($) { #{{{
+       my $url=shift;
+       if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
+           defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
+               return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
+       }
+       else {
+               return 1;
+       }
+} #}}}
 
+sub preprocess { # {{{
+       my %params = @_;
        my $page = $params{page};
-       $pagestate{$page}{comments}{comments} = defined $params{closed}
-               ? (not IkiWiki::yesno($params{closed}))
-               : 1;
-       $pagestate{$page}{comments}{allowdirectives} = IkiWiki::yesno($params{allowdirectives});
-       $pagestate{$page}{comments}{commit} = defined $params{commit}
-               ? IkiWiki::yesno($params{commit})
-               : 1;
-
-       my $formtemplate = IkiWiki::template("comments_embed.tmpl",
-               blind_cache => 1);
-       $formtemplate->param(cgiurl => $config{cgiurl});
-       $formtemplate->param(page => $params{page});
-
-       if (not $pagestate{$page}{comments}{comments}) {
-               $formtemplate->param("disabled" =>
-                       gettext('comments are closed'));
-       }
-       elsif ($params{preview}) {
-               $formtemplate->param("disabled" =>
-                       gettext('not available during Preview'));
-       }
-
-       debug("page $params{page} => destpage $params{destpage}");
-
-       unless (defined $params{inline} && !IkiWiki::yesno($params{inline})) {
-               my $posts = '';
-               eval q{use IkiWiki::Plugin::inline};
-               error($@) if ($@);
-               my @args = (
-                       pages => "internal($params{page}/_comment_*)",
-                       template => "comments_display",
-                       show => 0,
-                       reverse => "yes",
-                       # special stuff passed through
-                       page => $params{page},
+
+       my $format = $params{format};
+       if (defined $format && ! exists $IkiWiki::hooks{htmlize}{$format}) {
+               error(sprintf(gettext("unsupported page format %s"), $format));
+       }
+
+       my $content = $params{content};
+       if (! defined $content) {
+               error(gettext("comment must have content"));
+       }
+       $content =~ s/\\"/"/g;
+
+       $content = IkiWiki::filter($page, $params{destpage}, $content);
+
+       if ($config{comments_allowdirectives}) {
+               $content = IkiWiki::preprocess($page, $params{destpage},
+                       $content);
+       }
+
+       # no need to bother with htmlize if it's just HTML
+       $content = IkiWiki::htmlize($page, $params{destpage}, $format,
+               $content) if defined $format;
+
+       IkiWiki::run_hooks(sanitize => sub {
+               $content = shift->(
+                       page => $page,
                        destpage => $params{destpage},
-                       preview => $params{preview},
+                       content => $content,
                );
-               push @args, atom => $params{atom} if defined $params{atom};
-               push @args, rss => $params{rss} if defined $params{rss};
-               push @args, feeds => $params{feeds} if defined $params{feeds};
-               push @args, feedshow => $params{feedshow} if defined $params{feedshow};
-               push @args, timeformat => $params{timeformat} if defined $params{timeformat};
-               push @args, feedonly => $params{feedonly} if defined $params{feedonly};
-               $posts = IkiWiki::preprocess_inline(@args);
-               $formtemplate->param("comments" => $posts);
+       });
+
+       # set metadata, possibly overriding [[!meta]] directives from the
+       # comment itself
+
+       my $commentuser;
+       my $commentip;
+       my $commentauthor;
+       my $commentauthorurl;
+
+       if (defined $params{username}) {
+               $commentuser = $params{username};
+               ($commentauthorurl, $commentauthor) =
+                       linkuser($params{username});
+       }
+       else {
+               if (defined $params{ip}) {
+                       $commentip = $params{ip};
+               }
+               $commentauthor = gettext("Anonymous");
        }
 
-       return $formtemplate->output;
-} # }}}
+       $pagestate{$page}{comments}{commentuser} = $commentuser;
+       $pagestate{$page}{comments}{commentip} = $commentip;
+       $pagestate{$page}{comments}{commentauthor} = $commentauthor;
+       $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
+       if (! defined $pagestate{$page}{meta}{author}) {
+               $pagestate{$page}{meta}{author} = $commentauthor;
+       }
+       if (! defined $pagestate{$page}{meta}{authorurl}) {
+               $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
+       }
+
+       if ($config{comments_allowauthor}) {
+               if (defined $params{claimedauthor}) {
+                       $pagestate{$page}{meta}{author} = $params{claimedauthor};
+               }
+
+               if (defined $params{url} and safeurl($params{url})) {
+                       $pagestate{$page}{meta}{authorurl} = $params{url};
+               }
+       }
+       else {
+               $pagestate{$page}{meta}{author} = $commentauthor;
+               $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
+       }
+
+       if (defined $params{subject}) {
+               $pagestate{$page}{meta}{title} = $params{subject};
+       }
+
+       my $baseurl = urlto($params{destpage}, undef, 1);
+       my $anchor = "";
+       my $comments_pagename = $config{comments_pagename};
+       if ($params{page} =~ m/\/(\Q${comments_pagename}\E\d+)$/) {
+               $anchor = $1;
+       }
+       $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";
+
+       eval q{use Date::Parse};
+       if (! $@) {
+               my $time = str2time($params{date});
+               $IkiWiki::pagectime{$page} = $time if defined $time;
+       }
 
-# FIXME: logic taken from editpage, should be common code?
-sub getcgiuser ($) { # {{{
-       my $session = shift;
-       my $user = $session->param('name');
-       $user = $ENV{REMOTE_ADDR} unless defined $user;
-       debug("getcgiuser() -> $user");
-       return $user;
+       # FIXME: hard-coded HTML (although it's just to set an ID)
+       return "<div id=\"$anchor\">$content</div>" if $anchor;
+       return $content;
 } # }}}
 
-# FIXME: logic adapted from recentchanges, should be common code?
+sub checkconfig () { #{{{
+       $config{comments_commit} = 1 unless defined $config{comments_commit};
+       $config{comments_pagename} = 'comment_'
+               unless defined $config{comments_pagename};
+} #}}}
+
+# This is exactly the same as recentchanges_link :-(
+sub linkcgi ($) { #{{{
+       my $cgi=shift;
+       if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
+
+               my $page=decode_utf8($cgi->param("page"));
+               if (! defined $page) {
+                       error("missing page parameter");
+               }
+
+               IkiWiki::loadindex();
+
+               my $link=bestlink("", $page);
+               if (! length $link) {
+                       print "Content-type: text/html\n\n";
+                       print IkiWiki::misctemplate(gettext(gettext("missing page")),
+                               "<p>".
+                               sprintf(gettext("The page %s does not exist."),
+                                       htmllink("", "", $page)).
+                               "</p>");
+               }
+               else {
+                       IkiWiki::redirect($cgi, urlto($link, undef, 1));
+               }
+
+               exit;
+       }
+}
+
+# FIXME: basically the same logic as recentchanges
 # returns (author URL, pretty-printed version)
 sub linkuser ($) { # {{{
        my $user = shift;
@@ -159,11 +253,15 @@ sub linkuser ($) { # {{{
        if (defined $oiduser) {
                return ($user, $oiduser);
        }
+       # FIXME: it'd be good to avoid having such a link for anonymous
+       # posts
        else {
-               my $page = bestlink('', (length $config{userdir}
-                               ? "$config{userdir}/"
-                               : "").$user);
-               return (urlto($page, undef, 1), $user);
+               return (IkiWiki::cgiurl(
+                               do => 'commenter',
+                               page => (length $config{userdir}
+                                       ? "$config{userdir}/$user"
+                                       : "$user")
+                       ), $user);
        }
 } # }}}
 
@@ -182,10 +280,10 @@ sub sessioncgi ($$) { #{{{
 
        my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
        my $form = CGI::FormBuilder->new(
-               fields => [qw{do sid page subject body}],
+               fields => [qw{do sid page subject editcontent type author url}],
                charset => 'utf-8',
                method => 'POST',
-               required => [qw{body}],
+               required => [qw{editcontent}],
                javascript => 0,
                params => $cgi,
                action => $config{cgiurl},
@@ -203,19 +301,49 @@ sub sessioncgi ($$) { #{{{
                });
        IkiWiki::decode_form_utf8($form);
 
+       my $type = $form->param('type');
+       if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
+               $type = IkiWiki::possibly_foolish_untaint($type);
+       }
+       else {
+               $type = $config{default_pageext};
+       }
+       my @page_types;
+       if (exists $IkiWiki::hooks{htmlize}) {
+               @page_types = grep { ! /^_/ } keys %{$IkiWiki::hooks{htmlize}};
+       }
+
+       my $allow_author = $config{comments_allowauthor};
+
        $form->field(name => 'do', type => 'hidden');
        $form->field(name => 'sid', type => 'hidden', value => $session->id,
                force => 1);
        $form->field(name => 'page', type => 'hidden');
        $form->field(name => 'subject', type => 'text', size => 72);
-       $form->field(name => 'body', type => 'textarea', rows => 5,
-               cols => 80);
+       $form->field(name => 'editcontent', type => 'textarea', rows => 10);
+       $form->field(name => "type", value => $type, force => 1,
+               type => 'select', options => \@page_types);
+
+       $form->tmpl_param(username => $session->param('name'));
+
+       if ($allow_author and ! defined $session->param('name')) {
+               $form->tmpl_param(allowauthor => 1);
+               $form->field(name => 'author', type => 'text', size => '40');
+               $form->field(name => 'url', type => 'text', size => '40');
+       }
+       else {
+               $form->tmpl_param(allowauthor => 0);
+               $form->field(name => 'author', type => 'hidden', value => '',
+                       force => 1);
+               $form->field(name => 'url', type => 'hidden', value => '',
+                       force => 1);
+       }
 
        # The untaint is OK (as in editpage) because we're about to pass
        # it to file_pruned anyway
        my $page = $form->field('page');
        $page = IkiWiki::possibly_foolish_untaint($page);
-       if (!defined $page || !length $page ||
+       if (! defined $page || ! length $page ||
                IkiWiki::file_pruned($page, $config{srcdir})) {
                error(gettext("bad page name"));
        }
@@ -257,25 +385,15 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
-       IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
-       IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
-
-       my ($authorurl, $author) = linkuser(getcgiuser($session));
+       # Set a flag to indicate that we're posting a comment,
+       # so that postcomment() can tell it should match.
+       $postcomment=1;
+       IkiWiki::check_canedit($page, $cgi, $session);
+       $postcomment=0;
 
-       my $body = $form->field('body') || '';
-       $body =~ s/\r\n/\n/g;
-       $body =~ s/\r/\n/g;
-       $body .= "\n" if $body !~ /\n$/;
-
-       unless ($allow_directives) {
-               # don't allow new-style directives at all
-               $body =~ s/(^|[^\\])\[\[!/$1&#91;&#91;!/g;
-
-               # don't allow [[ unless it begins an old-style
-               # wikilink, if prefix_directives is off
-               $body =~ s/(^|[^\\])\[\[(?![^\n\s\]+]\]\])/$1&#91;&#91;!/g
-                       unless $config{prefix_directives};
-       }
+       my $editcontent = $form->field('editcontent') || '';
+       $editcontent =~ s/\r\n/\n/g;
+       $editcontent =~ s/\r/\n/g;
 
        # FIXME: check that the wiki is locked right now, because
        # if it's not, there are mad race conditions!
@@ -291,26 +409,44 @@ sub sessioncgi ($$) { #{{{
 
        my $anchor = "${comments_pagename}${i}";
 
-       IkiWiki::run_hooks(sanitize => sub {
-               $body=shift->(
-                       page => $location,
-                       destpage => $location,
-                       content => $body,
-               );
-       });
+       $editcontent =~ s/"/\\"/g;
+       my $content = "[[!_comment format=$type\n";
+
+       # FIXME: handling of double quotes probably wrong?
+       if (defined $session->param('name')) {
+               my $username = $session->param('name');
+               $username =~ s/"/&quot;/g;
+               $content .= " username=\"$username\"\n";
+       }
+       elsif (defined $ENV{REMOTE_ADDR}) {
+               my $ip = $ENV{REMOTE_ADDR};
+               if ($ip =~ m/^([.0-9]+)$/) {
+                       $content .= " ip=\"$1\"\n";
+               }
+       }
+
+       if ($allow_author) {
+               my $author = $form->field('author');
+               if (length $author) {
+                       $author =~ s/"/&quot;/g;
+                       $content .= " claimedauthor=\"$author\"\n";
+               }
+               my $url = $form->field('url');
+               if (length $url) {
+                       $url =~ s/"/&quot;/g;
+                       $content .= " url=\"$url\"\n";
+               }
+       }
+
+       my $subject = $form->field('subject');
+       if (length $subject) {
+               $subject =~ s/"/&quot;/g;
+               $content .= " subject=\"$subject\"\n";
+       }
 
-       # In this template, the [[!meta]] directives should stay at the end,
-       # so that they will override anything the user specifies. (For
-       # instance, [[!meta author="I can fake the author"]]...)
-       my $content_tmpl = template('comments_comment.tmpl');
-       $content_tmpl->param(author => $author);
-       $content_tmpl->param(authorurl => $authorurl);
-       $content_tmpl->param(subject => $form->field('subject'));
-       $content_tmpl->param(body => $body);
-       $content_tmpl->param(anchor => "$anchor");
-       $content_tmpl->param(permalink => "$baseurl#$anchor");
+       $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
-       my $content = $content_tmpl->output;
+       $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 
        # This is essentially a simplified version of editpage:
        # - the user does not control the page that's created, only the parent
@@ -319,7 +455,7 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
-               my $preview = IkiWiki::htmlize($location, $page, 'mdwn',
+               my $preview = IkiWiki::htmlize($location, $page, '_comment',
                                IkiWiki::linkify($page, $page,
                                        IkiWiki::preprocess($page, $page,
                                                IkiWiki::filter($location,
@@ -334,8 +470,6 @@ sub sessioncgi ($$) { #{{{
                $template->param(content => $preview);
                $template->param(title => $form->field('subject'));
                $template->param(ctime => displaytime(time));
-               $template->param(author => $author);
-               $template->param(authorurl => $authorurl);
 
                $form->tmpl_param(page_preview => $template->output);
        }
@@ -346,6 +480,8 @@ sub sessioncgi ($$) { #{{{
        if ($form->submitted eq POST_COMMENT && $form->validate) {
                my $file = "$location._comment";
 
+               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+
                # FIXME: could probably do some sort of graceful retry
                # on error? Would require significant unwinding though
                writefile($file, $config{srcdir}, $content);
@@ -419,18 +555,16 @@ sub pagetemplate (@) { #{{{
                }
 
                if ($shown) {
-                       eval q{use IkiWiki::Plugin::inline};
-                       error($@) if $@;
-
-                       my @args = (
+                       $comments = IkiWiki::preprocess_inline(
                                pages => "internal($page/${comments_pagename}*)",
                                template => 'comments_display',
                                show => 0,
                                reverse => 'yes',
                                page => $page,
                                destpage => $params{destpage},
+                               feedfile => 'comments',
+                               emptyfeeds => 'no',
                        );
-                       $comments = IkiWiki::preprocess_inline(@args);
                }
 
                if (defined $comments && length $comments) {
@@ -443,6 +577,26 @@ sub pagetemplate (@) { #{{{
                        $template->param(commenturl => $commenturl);
                }
        }
+
+       if ($template->query(name => 'commentuser')) {
+               $template->param(commentuser =>
+                       $pagestate{$page}{comments}{commentuser});
+       }
+
+       if ($template->query(name => 'commentip')) {
+               $template->param(commentip =>
+                       $pagestate{$page}{comments}{commentip});
+       }
+
+       if ($template->query(name => 'commentauthor')) {
+               $template->param(commentauthor =>
+                       $pagestate{$page}{comments}{commentauthor});
+       }
+
+       if ($template->query(name => 'commentauthorurl')) {
+               $template->param(commentauthorurl =>
+                       $pagestate{$page}{comments}{commentauthorurl});
+       }
 } # }}}
 
 package IkiWiki::PageSpec;
@@ -451,7 +605,7 @@ sub match_postcomment ($$;@) {
        my $page = shift;
        my $glob = shift;
 
-       unless ($page =~ s/\[postcomment\]$//) {
+       if (! $postcomment) {
                return IkiWiki::FailReason->new("not posting a comment");
        }
        return match_glob($page, $glob);