fix default values for config settings

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 273561cadc29f186acfc68cf77a24f4e7956493b..83f67869c06b6d68b58050373ea3e26b9dd9aa00 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -17,7 +17,7 @@ use constant CANCEL => "Cancel";
 
 my $postcomment;
 
-sub import { #{{{
+sub import {
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);
        hook(type => "preprocess", id => '_comment', call => \&preprocess);
@@ -26,9 +26,9 @@ sub import { #{{{
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        hook(type => "cgi", id => "comments", call => \&linkcgi);
        IkiWiki::loadplugin("inline");
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
                plugin => {
                        safe => 1,
@@ -39,7 +39,6 @@ sub getsetup () { #{{{
                comments_shown_pagespec => {
                        type => 'pagespec',
                        example => 'blog/*',
-                       default => '',
                        description => 'PageSpec for pages where comments will be shown inline',
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
@@ -48,7 +47,6 @@ sub getsetup () { #{{{
                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,
@@ -56,7 +54,6 @@ sub getsetup () { #{{{
                },
                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
@@ -64,7 +61,6 @@ sub getsetup () { #{{{
                },
                comments_allowdirectives => {
                        type => 'boolean',
-                       default => 0,
                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,
@@ -72,7 +68,6 @@ sub getsetup () { #{{{
                },
                comments_allowauthor => {
                        type => 'boolean',
-                       default => 0,
                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
@@ -81,22 +76,32 @@ sub getsetup () { #{{{
                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_shown_pagespec} = ''
+               unless defined $config{comments_shown_pagespec};
+       $config{comments_open_pagespec} = ''
+               unless defined $config{comments_open_pagespec};
+       $config{comments_pagename} = 'comment_'
+               unless defined $config{comments_pagename};
+}
 
-sub htmlize { # {{{
+sub htmlize {
        my %params = @_;
        return $params{content};
-} # }}}
+}
 
 # FIXME: copied verbatim from meta
-sub safeurl ($) { #{{{
+sub safeurl ($) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
@@ -105,9 +110,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
-} #}}}
+}
 
-sub preprocess { # {{{
+sub preprocess {
        my %params = @_;
        my $page = $params{page};
 
@@ -192,8 +197,7 @@ sub preprocess { # {{{
 
        my $baseurl = urlto($params{destpage}, undef, 1);
        my $anchor = "";
-       my $comments_pagename = $config{comments_pagename};
-       if ($params{page} =~ m/\/(\Q${comments_pagename}\E\d+)$/) {
+       if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
                $anchor = $1;
        }
        $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";
@@ -207,16 +211,10 @@ sub preprocess { # {{{
        # FIXME: hard-coded HTML (although it's just to set an ID)
        return "<div id=\"$anchor\">$content</div>" if $anchor;
        return $content;
-} # }}}
-
-sub checkconfig () { #{{{
-       $config{comments_commit} = 1 unless defined $config{comments_commit};
-       $config{comments_pagename} = 'comment_'
-               unless defined $config{comments_pagename};
-} #}}}
+}
 
 # This is exactly the same as recentchanges_link :-(
-sub linkcgi ($) { #{{{
+sub linkcgi ($) {
        my $cgi=shift;
        if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 
@@ -246,7 +244,7 @@ sub linkcgi ($) { #{{{
 
 # FIXME: basically the same logic as recentchanges
 # returns (author URL, pretty-printed version)
-sub linkuser ($) { # {{{
+sub linkuser ($) {
        my $user = shift;
        my $oiduser = eval { IkiWiki::openiduser($user) };
 
@@ -263,10 +261,10 @@ sub linkuser ($) { # {{{
                                        : "$user")
                        ), $user);
        }
-} # }}}
+}
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;
 
@@ -313,8 +311,6 @@ sub sessioncgi ($$) { #{{{
                @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);
@@ -326,7 +322,8 @@ sub sessioncgi ($$) { #{{{
 
        $form->tmpl_param(username => $session->param('name'));
 
-       if ($allow_author and ! defined $session->param('name')) {
+       if ($config{comments_allowauthor} 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');
@@ -348,10 +345,6 @@ sub sessioncgi ($$) { #{{{
                error(gettext("bad page name"));
        }
 
-       my $allow_directives = $config{comments_allowdirectives};
-       my $commit_comments = $config{comments_commit};
-       my $comments_pagename = $config{comments_pagename};
-
        # 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);
@@ -363,7 +356,7 @@ sub sessioncgi ($$) { #{{{
                htmllink($page, $page, 'ikiwiki/formatting',
                        noimageinline => 1,
                        linktext => 'FormattingHelp'),
-                       allowdirectives => $allow_directives);
+                       allowdirectives => $config{allow_directives});
 
        if ($form->submitted eq CANCEL) {
                # bounce back to the page they wanted to comment on, and exit.
@@ -397,7 +390,7 @@ sub sessioncgi ($$) { #{{{
        my $location;
        do {
                $i++;
-               $location = "$page/${comments_pagename}${i}";
+               $location = "$page/$config{comments_pagename}$i";
        } while (-e "$config{srcdir}/$location._comment");
 
        my $content = "[[!_comment format=$type\n";
@@ -415,7 +408,7 @@ sub sessioncgi ($$) { #{{{
                }
        }
 
-       if ($allow_author) {
+       if ($config{comments_allowauthor}) {
                my $author = $form->field('author');
                if (length $author) {
                        $author =~ s/"/&quot;/g;
@@ -474,7 +467,7 @@ sub sessioncgi ($$) { #{{{
        if ($form->submitted eq POST_COMMENT && $form->validate) {
                my $file = "$location._comment";
 
-               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+               IkiWiki::checksessionexpiry($cgi, $session);
 
                # FIXME: could probably do some sort of graceful retry
                # on error? Would require significant unwinding though
@@ -482,7 +475,7 @@ sub sessioncgi ($$) { #{{{
 
                my $conflict;
 
-               if ($config{rcs} and $commit_comments) {
+               if ($config{rcs} and $config{comments_commit}) {
                        my $message = gettext("Added a comment");
                        if (defined $form->field('subject') &&
                                length $form->field('subject')) {
@@ -509,7 +502,7 @@ sub sessioncgi ($$) { #{{{
                error($conflict) if defined $conflict;
 
                # Bounce back to where we were, but defeat broken caches
-               my $anticache = "?updated=$page/${comments_pagename}${i}";
+               my $anticache = "?updated=$page/$config{comments_pagename}$i";
                IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
        }
        else {
@@ -518,9 +511,9 @@ sub sessioncgi ($$) { #{{{
        }
 
        exit;
-} #}}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params = @_;
 
        my $page = $params{page};
@@ -529,14 +522,12 @@ 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}*",
+               if (pagespec_match($page, "*/$config{comments_pagename}*",
                                location => $page)) {
                        $shown = 0;
                        $open = 0;
@@ -550,7 +541,7 @@ sub pagetemplate (@) { #{{{
 
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
-                               pages => "internal($page/${comments_pagename}*)",
+                               pages => "internal($page/$config{comments_pagename}*)",
                                template => 'comments_display',
                                show => 0,
                                reverse => 'yes',
@@ -591,7 +582,7 @@ sub pagetemplate (@) { #{{{
                $template->param(commentauthorurl =>
                        $pagestate{$page}{comments}{commentauthorurl});
        }
-} # }}}
+}
 
 package IkiWiki::PageSpec;