whitespace
[ikiwiki.git] / IkiWiki / Plugin / comments.pm
index eb915b81312723c4ead07cce8cf9625ea26c70a6..6c8952d4553deb99d1435beddd5de21aae76771c 100644 (file)
@@ -9,15 +9,18 @@ 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 => 'comment', 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);
@@ -25,22 +28,96 @@ sub import { #{{{
        IkiWiki::loadplugin("inline");
 } # }}}
 
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1,
+               },
+               # Pages where comments are shown, but new comments are not
+               # allowed, will show "Comments are closed".
+               comments_shown_pagespec => {
+                       type => 'pagespec',
+                       example => 'blog/*',
+                       default => '',
+                       description => 'PageSpec for pages where comments will be shown inline',
+                       link => 'ikiwiki/PageSpec',
+                       safe => 1,
+                       rebuild => 1,
+               },
+               comments_open_pagespec => {
+                       type => 'pagespec',
+                       example => 'blog/* and created_after(close_old_comments)',
+                       default => '',
+                       description => 'PageSpec for pages where new comments can be posted',
+                       link => 'ikiwiki/PageSpec',
+                       safe => 1,
+                       rebuild => 1,
+               },
+               comments_pagename => {
+                       type => 'string',
+                       example => 'comment_',
+                       default => 'comment_',
+                       description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
+                       safe => 0, # manual page moving required
+                       rebuild => undef,
+               },
+               comments_allowdirectives => {
+                       type => 'boolean',
+                       default => 0,
+                       example => 0,
+                       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,
+               },
+               comments_commit => {
+                       type => 'boolean',
+                       example => 1,
+                       default => 1,
+                       description => 'commit comments to the VCS',
+                       # old uncommitted comments are likely to cause
+                       # confusion if this is changed
+                       safe => 0,
+                       rebuild => 0,
+               },
+} #}}}
+
 sub htmlize { # {{{
        my %params = @_;
        return $params{content};
 } # }}}
 
+# 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};
 
        my $format = $params{format};
-       if (defined $format && !exists $IkiWiki::hooks{htmlize}{$format}) {
+       if (defined $format && ! exists $IkiWiki::hooks{htmlize}{$format}) {
                error(sprintf(gettext("unsupported page format %s"), $format));
        }
 
        my $content = $params{content};
-       if (!defined $content) {
+       if (! defined $content) {
                error(gettext("comment must have content"));
        }
        $content =~ s/\\"/"/g;
@@ -64,30 +141,54 @@ sub preprocess { # {{{
                );
        });
 
-       # override any metadata
+       # set metadata, possibly overriding [[!meta]] directives from the
+       # comment itself
+
+       my $commentuser;
+       my $commentip;
+       my $commentauthor;
+       my $commentauthorurl;
 
        if (defined $params{username}) {
-               my ($authorurl, $author) = linkuser($params{username});
-               $pagestate{$page}{meta}{author} = $author;
-               $pagestate{$page}{meta}{authorurl} = $authorurl;
+               $commentuser = $params{username};
+               ($commentauthorurl, $commentauthor) =
+                       linkuser($params{username});
+       }
+       else {
+               if (defined $params{ip}) {
+                       $commentip = $params{ip};
+               }
+               $commentauthor = gettext("Anonymous");
+       }
+
+       $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;
        }
-       elsif (defined $params{ip}) {
-               $pagestate{$page}{meta}{author} = sprintf(
-                       gettext("Anonymous (IP: %s)"),
-                       $params{ip});
-               delete $pagestate{$page}{meta}{authorurl};
+
+       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} = gettext("Anonymous");
-               delete $pagestate{$page}{meta}{authorurl};
+               $pagestate{$page}{meta}{author} = $commentauthor;
+               $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
        }
 
        if (defined $params{subject}) {
                $pagestate{$page}{meta}{title} = $params{subject};
        }
-       else {
-               delete $pagestate{$page}{meta}{title};
-       }
 
        my $baseurl = urlto($params{destpage}, undef, 1);
        my $anchor = "";
@@ -108,60 +209,6 @@ sub preprocess { # {{{
        return $content;
 } # }}}
 
-sub getsetup () { #{{{
-       return
-               plugin => {
-                       safe => 1,
-                       rebuild => 1,
-               },
-               # Pages where comments are shown, but new comments are not
-               # allowed, will show "Comments are closed".
-               comments_shown_pagespec => {
-                       type => 'pagespec',
-                       example => 'blog/*',
-                       default => '',
-                       description => 'PageSpec for pages where comments will be shown inline',
-                       link => 'ikiwiki/PageSpec',
-                       safe => 1,
-                       rebuild => 1,
-               },
-               comments_open_pagespec => {
-                       type => 'pagespec',
-                       example => 'blog/* and created_after(close_old_comments)',
-                       default => '',
-                       description => 'PageSpec for pages where new comments can be posted',
-                       link => 'ikiwiki/PageSpec',
-                       safe => 1,
-                       rebuild => 1,
-               },
-               comments_pagename => {
-                       type => 'string',
-                       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
-                       rebuild => undef,
-               },
-               comments_allowdirectives => {
-                       type => 'boolean',
-                       default => 0,
-                       example => 0,
-                       description => 'Allow directives in newly posted comments?',
-                       safe => 1,
-                       rebuild => 0,
-               },
-               comments_commit => {
-                       type => 'boolean',
-                       example => 1,
-                       default => 1,
-                       description => 'commit comments to the VCS',
-                       # old uncommitted comments are likely to cause
-                       # confusion if this is changed
-                       safe => 0,
-                       rebuild => 0,
-               },
-} #}}}
-
 sub checkconfig () { #{{{
        $config{comments_commit} = 1 unless defined $config{comments_commit};
        $config{comments_pagename} = 'comment_'
@@ -174,7 +221,7 @@ sub linkcgi ($) { #{{{
        if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 
                my $page=decode_utf8($cgi->param("page"));
-               if (!defined $page) {
+               if (! defined $page) {
                        error("missing page parameter");
                }
 
@@ -233,7 +280,7 @@ sub sessioncgi ($$) { #{{{
 
        my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
        my $form = CGI::FormBuilder->new(
-               fields => [qw{do sid page subject editcontent type}],
+               fields => [qw{do sid page subject editcontent type author url}],
                charset => 'utf-8',
                method => 'POST',
                required => [qw{editcontent}],
@@ -256,16 +303,18 @@ sub sessioncgi ($$) { #{{{
 
        my $type = $form->param('type');
        if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
-               $type = possibly_foolish_untaint($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}};
+               @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);
@@ -275,11 +324,26 @@ sub sessioncgi ($$) { #{{{
        $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"));
        }
@@ -321,7 +385,11 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
-       IkiWiki::check_canedit($page . "[postcomment]", $cgi, $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 $editcontent = $form->field('editcontent') || '';
        $editcontent =~ s/\r\n/\n/g;
@@ -342,7 +410,7 @@ sub sessioncgi ($$) { #{{{
        my $anchor = "${comments_pagename}${i}";
 
        $editcontent =~ s/"/\\"/g;
-       my $content = "[[!comment format=$type\n";
+       my $content = "[[!_comment format=$type\n";
 
        # FIXME: handling of double quotes probably wrong?
        if (defined $session->param('name')) {
@@ -357,11 +425,26 @@ sub sessioncgi ($$) { #{{{
                }
        }
 
+       if ($allow_author) {
+               my $author = $form->field('author');
+               if (length $author) {
+                       $author =~ s/"/"/g;
+                       $content .= " claimedauthor=\"$author\"\n";
+               }
+               my $url = $form->field('url');
+               if (length $url) {
+                       $url =~ s/"/"/g;
+                       $content .= " url=\"$url\"\n";
+               }
+       }
+
        my $subject = $form->field('subject');
-       $subject =~ s/"/"/g;
-       $content .= " subject=\"$subject\"\n";
+       if (length $subject) {
+               $subject =~ s/"/"/g;
+               $content .= " subject=\"$subject\"\n";
+       }
 
-       $content .= " date=\"" . IkiWiki::formattime(time, '%X %x') . "\"\n";
+       $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
        $content .= " content=\"\"\"\n$editcontent\n\"\"\"]]\n";
 
@@ -472,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) {
@@ -496,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;
@@ -504,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);