skeleton plugin: added the canrename and canremove hooks

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index cb5a517a107ea94007f00ae77436d76f69ddbdae..1c10417c389cf4aedc11d0f9d510eaa134ff8b32 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -7,7 +7,7 @@ package IkiWiki::Plugin::comments;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki 2.00;
+use IkiWiki 3.00;

 use Encode;
 use POSIX qw(strftime);
 
 use Encode;
 use POSIX qw(strftime);
 


@@ -16,6 +16,7 @@ use constant POST_COMMENT => "Post comment";
 use constant CANCEL => "Cancel";
 
 my $postcomment;
 use constant CANCEL => "Cancel";
 
 my $postcomment;

+my %commentstate;

 
 sub import {
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
 
 sub import {
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);


@@ -36,7 +37,7 @@ sub getsetup () {
                },
                comments_pagespec => {
                        type => 'pagespec',
                },
                comments_pagespec => {
                        type => 'pagespec',

-                       example => 'blog/* and *!/Discussion',
+                       example => 'blog/* and !*/Discussion',

                        description => 'PageSpec of pages where comments are allowed',
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        description => 'PageSpec of pages where comments are allowed',
                        link => 'ikiwiki/PageSpec',
                        safe => 1,


@@ -151,11 +152,27 @@ sub preprocess {
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;

-
+       my $commentopenid;

        if (defined $params{username}) {
                $commentuser = $params{username};
        if (defined $params{username}) {
                $commentuser = $params{username};

-               ($commentauthorurl, $commentauthor) =
-                       linkuser($params{username});
+
+               my $oiduser = eval { IkiWiki::openiduser($commentuser) };
+
+               if (defined $oiduser) {
+                       # looks like an OpenID
+                       $commentauthorurl = $commentuser;
+                       $commentauthor = $oiduser;
+                       $commentopenid = $commentuser;
+               }
+               else {
+                       $commentauthorurl = IkiWiki::cgiurl(
+                               do => 'commenter',
+                               page => (length $config{userdir}
+                                       ? "$config{userdir}/$commentuser"
+                                       : "$commentuser"));
+
+                       $commentauthor = $commentuser;
+               }

        }
        else {
                if (defined $params{ip}) {
        }
        else {
                if (defined $params{ip}) {


@@ -164,10 +181,11 @@ sub preprocess {
                $commentauthor = gettext("Anonymous");
        }
 
                $commentauthor = gettext("Anonymous");
        }
 

-       $pagestate{$page}{comments}{commentuser} = $commentuser;
-       $pagestate{$page}{comments}{commentip} = $commentip;
-       $pagestate{$page}{comments}{commentauthor} = $commentauthor;
-       $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
+       $commentstate{$page}{commentuser} = $commentuser;
+       $commentstate{$page}{commentopenid} = $commentopenid;
+       $commentstate{$page}{commentip} = $commentip;
+       $commentstate{$page}{commentauthor} = $commentauthor;
+       $commentstate{$page}{commentauthorurl} = $commentauthorurl;

        if (! defined $pagestate{$page}{meta}{author}) {
                $pagestate{$page}{meta}{author} = $commentauthor;
        }
        if (! defined $pagestate{$page}{meta}{author}) {
                $pagestate{$page}{meta}{author} = $commentauthor;
        }


@@ -180,8 +198,17 @@ sub preprocess {
                        $pagestate{$page}{meta}{author} = $params{claimedauthor};
                }
 
                        $pagestate{$page}{meta}{author} = $params{claimedauthor};
                }
 

-               if (defined $params{url} and safeurl($params{url})) {
-                       $pagestate{$page}{meta}{authorurl} = $params{url};
+               if (defined $params{url}) {
+                       my $url=$params{url};
+
+                       eval q{use URI::Heuristic}; 
+                       if (! $@) {
+                               $url=URI::Heuristic::uf_uristr($url);
+                       }
+
+                       if (safeurl($url)) {
+                               $pagestate{$page}{meta}{authorurl} = $url;
+                       }

                }
        }
        else {
                }
        }
        else {


@@ -193,12 +220,10 @@ sub preprocess {
                $pagestate{$page}{meta}{title} = $params{subject};
        }
 
                $pagestate{$page}{meta}{title} = $params{subject};
        }
 

-       my $baseurl = urlto($params{destpage}, undef, 1);
-       my $anchor = "";

        if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
        if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {

-               $anchor = $1;
+               $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
+                       "#".$params{page};

        }
        }

-       $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";

 
        eval q{use Date::Parse};
        if (! $@) {
 
        eval q{use Date::Parse};
        if (! $@) {


@@ -206,8 +231,6 @@ sub preprocess {
                $IkiWiki::pagectime{$page} = $time if defined $time;
        }
 
                $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;
 }
 
        return $content;
 }
 


@@ -240,27 +263,6 @@ sub linkcgi ($) {
        }
 }
 
        }
 }
 

-# FIXME: basically the same logic as recentchanges
-# returns (author URL, pretty-printed version)
-sub linkuser ($) {
-       my $user = shift;
-       my $oiduser = eval { IkiWiki::openiduser($user) };
-
-       if (defined $oiduser) {
-               return ($user, $oiduser);
-       }
-       # FIXME: it'd be good to avoid having such a link for anonymous
-       # posts
-       else {
-               return (IkiWiki::cgiurl(
-                               do => 'commenter',
-                               page => (length $config{userdir}
-                                       ? "$config{userdir}/$user"
-                                       : "$user")
-                       ), $user);
-       }
-}
-

 # Mostly cargo-culted from IkiWiki::plugin::editpage
 sub sessioncgi ($$) {
        my $cgi=shift;
 # Mostly cargo-culted from IkiWiki::plugin::editpage
 sub sessioncgi ($$) {
        my $cgi=shift;


@@ -285,9 +287,7 @@ sub sessioncgi ($$) {
                action => $config{cgiurl},
                header => 0,
                table => 0,
                action => $config{cgiurl},
                header => 0,
                table => 0,

-               template => scalar IkiWiki::template_params('comments_form.tmpl'),
-               # wtf does this do in editpage?
-               wikiname => $config{wikiname},
+               template => scalar IkiWiki::template_params('editcomment.tmpl'),

        );
 
        IkiWiki::decode_form_utf8($form);
        );
 
        IkiWiki::decode_form_utf8($form);


@@ -441,8 +441,8 @@ sub sessioncgi ($$) {
 
        if ($form->submitted eq PREVIEW) {
                my $preview = IkiWiki::htmlize($location, $page, '_comment',
 
        if ($form->submitted eq PREVIEW) {
                my $preview = IkiWiki::htmlize($location, $page, '_comment',

-                               IkiWiki::linkify($page, $page,
-                                       IkiWiki::preprocess($page, $page,
+                               IkiWiki::linkify($location, $page,
+                                       IkiWiki::preprocess($location, $page,

                                                IkiWiki::filter($location,
                                                        $page, $content),
                                                0, 1)));
                                                IkiWiki::filter($location,
                                                        $page, $content),
                                                0, 1)));


@@ -451,11 +451,17 @@ sub sessioncgi ($$) {
                                        content => $preview);
                        });
 
                                        content => $preview);
                        });
 

-               my $template = template("comments_display.tmpl");
+               my $template = template("comment.tmpl");

                $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));
 

+               IkiWiki::run_hooks(pagetemplate => sub {
+                       shift->(page => $location,
+                               destpage => $page,
+                               template => $template);
+               });
+

                $form->tmpl_param(page_preview => $template->output);
        }
        else {
                $form->tmpl_param(page_preview => $template->output);
        }
        else {


@@ -499,9 +505,11 @@ sub sessioncgi ($$) {
                # breaks it or something
                error($conflict) if defined $conflict;
 
                # breaks it or something
                error($conflict) if defined $conflict;
 

-               # Bounce back to where we were, but defeat broken caches
-               my $anticache = "?updated=$page/$config{comments_pagename}$i";
-               IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
+               # Jump to the new comment on the page.
+               # The trailing question mark tries to avoid broken
+               # caches and get the most recent version of the page.
+               IkiWiki::redirect($cgi, urlto($page, undef, 1)."#$location?updated");
+

        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,
        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,


@@ -534,15 +542,18 @@ sub pagetemplate (@) {
 
        my $page = $params{page};
        my $template = $params{template};
 
        my $page = $params{page};
        my $template = $params{template};

+       my $shown = ($template->query(name => 'commentslink') ||
+                    $template->query(name => 'commentsurl') ||
+                    $template->query(name => 'atomcommentsurl') ||
+                    $template->query(name => 'comments')) &&
+                   commentsshown($page);

 
        if ($template->query(name => 'comments')) {
 
        if ($template->query(name => 'comments')) {

-               my $shown = commentsshown($page);
-

                my $comments = undef;
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
                                pages => "internal($page/$config{comments_pagename}*)",
                my $comments = undef;
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
                                pages => "internal($page/$config{comments_pagename}*)",

-                               template => 'comments_display',
+                               template => 'comment',

                                show => 0,
                                reverse => 'yes',
                                page => $page,
                                show => 0,
                                reverse => 'yes',
                                page => $page,


@@ -557,9 +568,25 @@ sub pagetemplate (@) {
                }
 
                if ($shown && commentsopen($page)) {
                }
 
                if ($shown && commentsopen($page)) {

-                       my $commenturl = IkiWiki::cgiurl(do => 'comment',
+                       my $addcommenturl = IkiWiki::cgiurl(do => 'comment',

                                page => $page);
                                page => $page);

-                       $template->param(commenturl => $commenturl);
+                       $template->param(addcommenturl => $addcommenturl);
+               }
+       }
+
+       if ($template->query(name => 'commentsurl')) {
+               if ($shown) {
+                       $template->param(commentsurl =>
+                               urlto($page, undef, 1).'#comments');
+               }
+       }
+
+       if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
+               if ($shown) {
+                       # This will 404 until there are some comments, but I
+                       # think that's probably OK...
+                       $template->param(atomcommentsurl =>
+                               urlto($page, undef, 1).'comments.atom');

                }
        }
 
                }
        }
 


@@ -568,7 +595,7 @@ sub pagetemplate (@) {
                # the link. But, to update the number, blog pages
                # would have to update whenever comments of any inlines
                # page are added, which is not currently done.
                # the link. But, to update the number, blog pages
                # would have to update whenever comments of any inlines
                # page are added, which is not currently done.

-               if (commentsshown($page)) {
+               if ($shown) {

                        $template->param(commentslink =>
                                htmllink($page, $params{destpage}, $page,
                                        linktext => gettext("Comments"),
                        $template->param(commentslink =>
                                htmllink($page, $params{destpage}, $page,
                                        linktext => gettext("Comments"),


@@ -579,22 +606,27 @@ sub pagetemplate (@) {
 
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
 
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>

-                       $pagestate{$page}{comments}{commentuser});
+                       $commentstate{$page}{commentuser});
+       }
+
+       if ($template->query(name => 'commentopenid')) {
+               $template->param(commentopenid =>
+                       $commentstate{$page}{commentopenid});

        }
 
        if ($template->query(name => 'commentip')) {
                $template->param(commentip =>
        }
 
        if ($template->query(name => 'commentip')) {
                $template->param(commentip =>

-                       $pagestate{$page}{comments}{commentip});
+                       $commentstate{$page}{commentip});

        }
 
        if ($template->query(name => 'commentauthor')) {
                $template->param(commentauthor =>
        }
 
        if ($template->query(name => 'commentauthor')) {
                $template->param(commentauthor =>

-                       $pagestate{$page}{comments}{commentauthor});
+                       $commentstate{$page}{commentauthor});

        }
 
        if ($template->query(name => 'commentauthorurl')) {
                $template->param(commentauthorurl =>
        }
 
        if ($template->query(name => 'commentauthorurl')) {
                $template->param(commentauthorurl =>

-                       $pagestate{$page}{comments}{commentauthorurl});
+                       $commentstate{$page}{commentauthorurl});

        }
 }
 
        }
 }