first pass through comments documentation

[git.ikiwiki.info.git] / IkiWiki / Plugin / comments.pm

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 73f8d6140c7f2455ffd539153f09712438d40195..4ed696026c009f80db4857ee9b7829fa02afda21 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -8,6 +8,8 @@ package IkiWiki::Plugin::comments;
 use warnings;
 use strict;
 use IkiWiki 2.00;
 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 PREVIEW => "Preview";
 use constant POST_COMMENT => "Post comment";


@@ -16,18 +18,131 @@ use constant CANCEL => "Cancel";
 sub import { #{{{
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);
 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 => "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");
        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 { # {{{
 } # }}}
 
 sub htmlize { # {{{

-       eval q{use IkiWiki::Plugin::mdwn};
-       error($@) if ($@);
-       return IkiWiki::Plugin::mdwn::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}) {
+               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},
+                       content => $content,
+               );
+       });
+
+       # 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");
+       }
+
+       $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: hard-coded HTML (although it's just to set an ID)
+       return "<div id=\"$anchor\">$content</div>" if $anchor;
+       return $content;

 } # }}}
 
 sub getsetup () { #{{{
 } # }}}
 
 sub getsetup () { #{{{


@@ -68,7 +183,15 @@ sub getsetup () { #{{{
                        type => 'boolean',
                        default => 0,
                        example => 0,
                        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,
                },
                        safe => 1,
                        rebuild => 0,
                },


@@ -90,15 +213,6 @@ sub checkconfig () { #{{{
                unless defined $config{comments_pagename};
 } #}}}
 
                unless defined $config{comments_pagename};
 } #}}}
 

-# 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;
-} # }}}
-

 # This is exactly the same as recentchanges_link :-(
 sub linkcgi ($) { #{{{
        my $cgi=shift;
 # This is exactly the same as recentchanges_link :-(
 sub linkcgi ($) { #{{{
        my $cgi=shift;


@@ -143,9 +257,9 @@ sub linkuser ($) { # {{{
                return (IkiWiki::cgiurl(
                                do => 'commenter',
                                page => (length $config{userdir}
                return (IkiWiki::cgiurl(
                                do => 'commenter',
                                page => (length $config{userdir}

-                                       ? "$config{userdir}/"
-                                       : "")
-                       ).$user, $user);
+                                       ? "$config{userdir}/$user"
+                                       : "$user")
+                       ), $user);

        }
 } # }}}
 
        }
 } # }}}
 


@@ -164,10 +278,10 @@ sub sessioncgi ($$) { #{{{
 
        my @buttons = (POST_COMMENT, PREVIEW, CANCEL);
        my $form = CGI::FormBuilder->new(
 
        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',
                charset => 'utf-8',
                method => 'POST',

-               required => [qw{body}],
+               required => [qw{editcontent}],

                javascript => 0,
                params => $cgi,
                action => $config{cgiurl},
                javascript => 0,
                params => $cgi,
                action => $config{cgiurl},


@@ -185,13 +299,43 @@ sub sessioncgi ($$) { #{{{
                });
        IkiWiki::decode_form_utf8($form);
 
                });
        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 => '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
 
        # The untaint is OK (as in editpage) because we're about to pass
        # it to file_pruned anyway


@@ -241,22 +385,9 @@ sub sessioncgi ($$) { #{{{
 
        IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
 
 
        IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
 

-       my ($authorurl, $author) = linkuser(getcgiuser($session));
-
-       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!
 
        # FIXME: check that the wiki is locked right now, because
        # if it's not, there are mad race conditions!


@@ -272,27 +403,44 @@ sub sessioncgi ($$) { #{{{
 
        my $anchor = "${comments_pagename}${i}";
 
 
        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_tmpl->param(date => IkiWiki::formattime(time, "%X %x"));
+       $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
 
        # This is essentially a simplified version of editpage:
        # - the user does not control the page that's created, only the parent


@@ -301,7 +449,7 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
        # - 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,
                                IkiWiki::linkify($page, $page,
                                        IkiWiki::preprocess($page, $page,
                                                IkiWiki::filter($location,


@@ -316,8 +464,6 @@ sub sessioncgi ($$) { #{{{
                $template->param(content => $preview);
                $template->param(title => $form->field('subject'));
                $template->param(ctime => displaytime(time));
                $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);
        }
 
                $form->tmpl_param(page_preview => $template->output);
        }


@@ -413,6 +559,8 @@ sub pagetemplate (@) { #{{{
                                reverse => 'yes',
                                page => $page,
                                destpage => $params{destpage},
                                reverse => 'yes',
                                page => $page,
                                destpage => $params{destpage},

+                               feedfile => 'comments',
+                               emptyfeeds => 'no',

                        );
                        $comments = IkiWiki::preprocess_inline(@args);
                }
                        );
                        $comments = IkiWiki::preprocess_inline(@args);
                }


@@ -427,6 +575,26 @@ sub pagetemplate (@) { #{{{
                        $template->param(commenturl => $commenturl);
                }
        }
                        $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;
 } # }}}
 
 package IkiWiki::PageSpec;