]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/smcvpostcomment.pm
smcvpostcomment: allow inlining to be disabled, and pass through atom etc. better
[ikiwiki.git] / IkiWiki / Plugin / smcvpostcomment.pm
index cb55ff94fddf77c655a39a6b3835873b458017a1..6bd3b297000c1ad9e1ab50ca939a6ffd43232af7 100644 (file)
@@ -8,6 +8,7 @@ package IkiWiki::Plugin::smcvpostcomment;
 use warnings;
 use strict;
 use IkiWiki 2.00;
+use IkiWiki::Plugin::inline;
 use IkiWiki::Plugin::mdwn;
 use CGI 'escapeHTML';
 
@@ -38,9 +39,18 @@ sub preprocess (@) { #{{{
        my %params=@_;
 
        unless (length $config{cgiurl}) {
-               error("this plugin makes no sense if you have no CGI");
+               error(sprintf (gettext("[[!%s plugin requires CGI enabled]]"),
+                       PLUGIN));
        }
 
+       my $page = $params{page};
+       $pagestate{$page}{PLUGIN()}{comments} = 1;
+       $pagestate{$page}{PLUGIN()}{allowhtml} = IkiWiki::yesno($params{allowhtml});
+       $pagestate{$page}{PLUGIN()}{allowdirectives} = IkiWiki::yesno($params{allowdirectives});
+       $pagestate{$page}{PLUGIN()}{commit} = defined $params{commit}
+               ? IkiWiki::yesno($params{commit})
+               : 1;
+
        my $formtemplate = IkiWiki::template(PLUGIN . "_embed.tmpl",
                blind_cache => 1);
        $formtemplate->param(cgiurl => $config{cgiurl});
@@ -48,21 +58,33 @@ sub preprocess (@) { #{{{
 
        if ($params{preview}) {
                $formtemplate->param("disabled" =>
-                       'not available during Preview');
+                       gettext('not available during Preview'));
        }
 
-       debug("page $params{page} => destpage $params{page}");
+       debug("page $params{page} => destpage $params{destpage}");
 
-       # I'm reasonably sure that this counts as abuse of [[!inline]]
-       return $formtemplate->output . "\n" .
-               IkiWiki::preprocess_inline(
-                       pages => "internal(/$params{page}/comment_*)",
+       my $posts = '';
+       unless (defined $params{inline} && !IkiWiki::yesno($params{inline})) {
+               my @args = (
+                       pages => "internal($params{page}/_comment_*)",
                        template => PLUGIN . "_display",
                        show => 0,
                        reverse => "yes",
+                       # special stuff passed through
                        page => $params{page},
                        destpage => $params{destpage},
-                       preview => $params{preview});
+                       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 = "\n" . IkiWiki::preprocess_inline(@args);
+       }
+
+       return $formtemplate->output . $posts;
 } # }}}
 
 # FIXME: logic taken from editpage, should be common code?
@@ -110,11 +132,6 @@ sub sessioncgi ($$) { #{{{
        my $do = $cgi->param('do');
        return unless $do eq PLUGIN;
 
-       # These are theoretically configurable, but currently hard-coded
-       my $allow_wikilinks = 0;
-       my $allow_directives = 0;
-       my $commit_comments = 1;
-
        IkiWiki::decode_cgi_utf8($cgi);
 
        eval q{use CGI::FormBuilder};
@@ -147,7 +164,7 @@ sub sessioncgi ($$) { #{{{
        $form->field(name => 'sid', type => 'hidden', value => $session->id,
                force => 1);
        $form->field(name => 'page', type => 'hidden');
-       $form->field(name => 'subject', type => 'text', size => 80);
+       $form->field(name => 'subject', type => 'text', size => 72);
        $form->field(name => 'body', type => 'textarea', rows => 5,
                cols => 80);
 
@@ -157,9 +174,15 @@ sub sessioncgi ($$) { #{{{
        $page = IkiWiki::possibly_foolish_untaint($page);
        if (!defined $page || !length $page ||
                IkiWiki::file_pruned($page, $config{srcdir})) {
-               error ("bad page name");
+               error(gettext("bad page name"));
        }
 
+       my $allow_directives = $pagestate{$page}{PLUGIN()}{allowdirectives};
+       my $allow_html = $pagestate{$page}{PLUGIN()}{allowdirectives};
+       my $commit_comments = defined $pagestate{$page}{PLUGIN()}{commit}
+               ? $pagestate{$page}{PLUGIN()}{commit}
+               : 1;
+
        # FIXME: is this right? Or should we be using the candidate subpage
        # (whatever that might mean) as the base URL?
        my $baseurl = urlto($page, undef, 1);
@@ -170,10 +193,19 @@ sub sessioncgi ($$) { #{{{
        $form->tmpl_param('helponformattinglink',
                htmllink($page, $page, 'ikiwiki/formatting',
                        noimageinline => 1,
-                       linktext => 'FormattingHelp'));
+                       linktext => 'FormattingHelp'),
+                       allowhtml => $allow_html,
+                       allowdirectives => $allow_directives);
 
        if (not exists $pagesources{$page}) {
-               error ("page '$page' doesn't exist, so you can't comment");
+               error(sprintf(gettext(
+                       "page '%s' doesn't exist, so you can't comment"),
+                       $page));
+       }
+       if (not $pagestate{$page}{PLUGIN()}{comments}) {
+               error(sprintf(gettext(
+                       "comments are not enabled on page '%s'"),
+                       $page));
        }
 
        if ($form->submitted eq CANCEL) {
@@ -183,15 +215,30 @@ sub sessioncgi ($$) { #{{{
                exit;
        }
 
+       IkiWiki::check_canedit($page . "[" . PLUGIN . "]", $cgi, $session);
+
        my ($authorurl, $author) = linkuser(getcgiuser($session));
 
-       my $body = $form->field('body');
+       my $body = $form->field('body') || '';
        $body =~ s/\r\n/\n/g;
        $body =~ s/\r/\n/g;
-       $body .= "\n" if $body !~ /\n$/;
+       $body = "\n" if $body !~ /\n$/;
 
-       $body =~ s/\[\[([^!])/[[$1/g unless $allow_wikilinks;
-       $body =~ s/\[\[!/[[!/g unless $allow_directives;
+       unless ($allow_directives) {
+               # don't allow new-style directives at all
+               $body =~ s/(^|[^\\])\[\[!/$1\\[[!/g;
+
+               # don't allow [[ unless it begins an old-style
+               # wikilink, if prefix_directives is off
+               $body =~ s/(^|[^\\])\[\[(?![^\n\s\]+]\]\])/$1\\[[!/g
+                       unless $config{prefix_directives};
+       }
+
+       unless ($allow_html) {
+               $body =~ s/&(\w|#)/&$1/g;
+               $body =~ s/</&lt;/g;
+               $body =~ s/>/&gt;/g;
+       }
 
        # In this template, the [[!meta]] directives should stay at the end,
        # so that they will override anything the user specifies. (For
@@ -211,6 +258,8 @@ sub sessioncgi ($$) { #{{{
        # - this means that if they do, rocks fall and everyone dies
 
        if ($form->submitted eq PREVIEW) {
+               # $fake is a location that has the same number of slashes
+               # as the eventual location of this comment.
                my $fake = "$page/_" . PLUGIN . "hypothetical";
                my $preview = IkiWiki::htmlize($fake, $page, 'mdwn',
                                IkiWiki::linkify($page, $page,
@@ -250,7 +299,7 @@ sub sessioncgi ($$) { #{{{
                my $file;
                do {
                        $i++;
-                       $file = "$page/comment_${i}._" . PLUGIN;
+                       $file = "$page/_comment_${i}._" . PLUGIN;
                } while (-e "$config{srcdir}/$file");
 
                # FIXME: could probably do some sort of graceful retry
@@ -260,11 +309,10 @@ sub sessioncgi ($$) { #{{{
                my $conflict;
 
                if ($config{rcs} and $commit_comments) {
-                       my $message = "Added a comment";
+                       my $message = gettext("Added a comment");
                        if (defined $form->field('subject') &&
                                length $form->field('subject')) {
-                               $message = "Added a comment: " .
-                                       $form->field('subject');
+                               $message .= ": ".$form->field('subject');
                        }
 
                        IkiWiki::rcs_add($file);
@@ -285,7 +333,7 @@ sub sessioncgi ($$) { #{{{
                error($conflict) if defined $conflict;
 
                # Bounce back to where we were, but defeat broken caches
-               my $anticache = "?updated=$page/comment_$i";
+               my $anticache = "?updated=$page/_comment_$i";
                IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
        }
        else {
@@ -296,4 +344,16 @@ sub sessioncgi ($$) { #{{{
        exit;
 } #}}}
 
+package IkiWiki::PageSpec;
+
+sub match_smcvpostcomment ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+
+       unless ($page =~ s/\[smcvpostcomment\]$//) {
+               return IkiWiki::FailReason->new("not posting a comment");
+       }
+       return match_glob($page, $glob);
+}
+
 1