]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/comments.pm
comments: Save comments as a file with one big [[!comment]] directive.
[ikiwiki.git] / IkiWiki / Plugin / comments.pm
index 01ee481f596ae517ad06ddb1978a99501e8c4eca..13ced6ffd806d456e3549ca90d380dc7f36e56f8 100644 (file)
@@ -8,25 +8,105 @@ package IkiWiki::Plugin::comments;
 use warnings;
 use strict;
 use IkiWiki 2.00;
+use Encode;
 
 use constant PREVIEW => "Preview";
 use constant POST_COMMENT => "Post comment";
 use constant CANCEL => "Cancel";
 
 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);
-       IkiWiki::loadplugin("inline");
+       hook(type => "cgi", id => "comments", call => \&linkcgi);
        IkiWiki::loadplugin("mdwn");
+       IkiWiki::loadplugin("inline");
 } # }}}
 
 sub htmlize { # {{{
-       eval q{use IkiWiki::Plugin::mdwn};
-       error($@) if ($@);
-       return IkiWiki::Plugin::mdwn::htmlize(@_)
+       my %params = @_;
+       return $params{content};
+} # }}}
+
+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,
+               );
+       });
+
+       # override any metadata
+
+       if (defined $params{username}) {
+               my ($authorurl, $author) = linkuser($params{username});
+               $pagestate{$page}{meta}{author} = $author;
+               $pagestate{$page}{meta}{authorurl} = $authorurl;
+       }
+       elsif (defined $params{ip}) {
+               $pagestate{$page}{meta}{author} = sprintf(
+                       gettext("Anonymous (IP: %s)"),
+                       $params{ip});
+               delete $pagestate{$page}{meta}{authorurl};
+       }
+       else {
+               $pagestate{$page}{meta}{author} = gettext("Anonymous");
+               delete $pagestate{$page}{meta}{authorurl};
+       }
+
+       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 = "";
+       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 () { #{{{
@@ -83,63 +163,11 @@ sub getsetup () { #{{{
                },
 } #}}}
 
-# Somewhat based on IkiWiki::Plugin::inline blog posting support
-sub preprocess (@) { #{{{
-       my %params=@_;
-
-       return "";
-
-       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},
-                       destpage => $params{destpage},
-                       preview => $params{preview},
-               );
-               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);
-       }
-
-       return $formtemplate->output;
-} # }}}
+sub checkconfig () { #{{{
+       $config{comments_commit} = 1 unless defined $config{comments_commit};
+       $config{comments_pagename} = 'comment_'
+               unless defined $config{comments_pagename};
+} #}}}
 
 # FIXME: logic taken from editpage, should be common code?
 sub getcgiuser ($) { # {{{
@@ -150,7 +178,36 @@ sub getcgiuser ($) { # {{{
        return $user;
 } # }}}
 
-# FIXME: logic adapted from recentchanges, should be common code?
+# 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 +216,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);
        }
 } # }}}
 
@@ -257,7 +318,6 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
-       IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
        IkiWiki::check_canedit($page . "[postcomment]", $cgi, $session);
 
        my ($authorurl, $author) = linkuser(getcgiuser($session));
@@ -265,17 +325,6 @@ sub sessioncgi ($$) { #{{{
        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};
-       }
 
        # FIXME: check that the wiki is locked right now, because
        # if it's not, there are mad race conditions!
@@ -291,26 +340,29 @@ sub sessioncgi ($$) { #{{{
 
        my $anchor = "${comments_pagename}${i}";
 
-       IkiWiki::run_hooks(sanitize => sub {
-               $body=shift->(
-                       page => $location,
-                       destpage => $location,
-                       content => $body,
-               );
-       });
+       $body =~ s/"/\\"/g;
+       my $content = "[[!comment format=mdwn\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";
+               }
+       }
 
-       # 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");
+       my $subject = $form->field('subject');
+       $subject =~ s/"/&quot;/g;
+       $content .= " subject=\"$subject\"\n";
 
-       my $content = $content_tmpl->output;
+       $content .= " date=\"" . IkiWiki::formattime(time, '%X %x') . "\"\n";
+
+       $content .= " content=\"\"\"\n$body\n\"\"\"]]\n";
 
        # This is essentially a simplified version of editpage:
        # - the user does not control the page that's created, only the parent
@@ -346,6 +398,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);
@@ -399,8 +453,48 @@ sub pagetemplate (@) { #{{{
        if ($template->query(name => 'comments')) {
                my $comments = undef;
 
+               my $comments_pagename = $config{comments_pagename};
+
+               my $open = 0;
+               my $shown = pagespec_match($page,
+                       $config{comments_shown_pagespec},
+                       location => $page);
+
+               if (pagespec_match($page, "*/${comments_pagename}*",
+                               location => $page)) {
+                       $shown = 0;
+                       $open = 0;
+               }
+
+               if (length $config{cgiurl}) {
+                       $open = pagespec_match($page,
+                               $config{comments_open_pagespec},
+                               location => $page);
+               }
+
+               if ($shown) {
+                       eval q{use IkiWiki::Plugin::inline};
+                       error($@) if $@;
+
+                       my @args = (
+                               pages => "internal($page/${comments_pagename}*)",
+                               template => 'comments_display',
+                               show => 0,
+                               reverse => 'yes',
+                               page => $page,
+                               destpage => $params{destpage},
+                       );
+                       $comments = IkiWiki::preprocess_inline(@args);
+               }
+
                if (defined $comments && length $comments) {
-                       $template->param(name => $comments);
+                       $template->param(comments => $comments);
+               }
+
+               if ($open) {
+                       my $commenturl = IkiWiki::cgiurl(do => 'comment',
+                               page => $page);
+                       $template->param(commenturl => $commenturl);
                }
        }
 } # }}}