]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/CGI.pm
git: Skip over signed-off-by and similar lines in commit messages when generating...
[git.ikiwiki.info.git] / IkiWiki / CGI.pm
index 33e670eacbd7291b6cd1a30092b33f9b80e6bd93..5fccfb4741d4375760777a530916fa535e0273c2 100644 (file)
@@ -20,8 +20,8 @@ sub printheader ($) { #{{{
        }
 
 } #}}}
-       
-sub showform ($$$$) { #{{{
+
+sub showform ($$$$;@) { #{{{
        my $form=shift;
        my $buttons=shift;
        my $session=shift;
@@ -35,7 +35,7 @@ sub showform ($$$$) { #{{{
        }
 
        printheader($session);
-       print misctemplate($form->title, $form->render(submit => $buttons));
+       print misctemplate($form->title, $form->render(submit => $buttons), @_);
 }
 
 sub redirect ($$) { #{{{
@@ -60,12 +60,18 @@ sub check_canedit ($$$;$) { #{{{
        run_hooks(canedit => sub {
                return if defined $canedit;
                my $ret=shift->($page, $q, $session);
-               if (defined $ret && $ret eq "") {
-                       $canedit=1;
-               }
-               elsif (defined $ret) {
-                       $canedit=0;
-                       error($ret) unless $nonfatal;
+               if (defined $ret) {
+                       if ($ret eq "") {
+                               $canedit=1;
+                       }
+                       elsif (ref $ret eq 'CODE') {
+                               $ret->() unless $nonfatal;
+                               $canedit=0;
+                       }
+                       elsif (defined $ret) {
+                               error($ret) unless $nonfatal;
+                               $canedit=0;
+                       }
                }
        });
        return $canedit;
@@ -74,61 +80,13 @@ sub check_canedit ($$$;$) { #{{{
 sub decode_form_utf8 ($) { #{{{
        my $form = shift;
        foreach my $f ($form->field) {
-               next if Encode::is_utf8(scalar $form->field($f));
                $form->field(name  => $f,
-                            value => decode_utf8($form->field($f)),
-                            force => 1,
-                           );
+                            value => decode_utf8($form->field($f)),
+                            force => 1,
+               );
        }
 } #}}}
 
-sub cgi_recentchanges ($) { #{{{
-       my $q=shift;
-       
-       # Optimisation: building recentchanges means calculating lots of
-       # links. Memoizing htmllink speeds it up a lot (can't be memoized
-       # during page builds as the return values may change, but they
-       # won't here.)
-       eval q{use Memoize};
-       error($@) if $@;
-       memoize("htmllink");
-
-       eval q{use Time::Duration};
-       error($@) if $@;
-
-       my $changelog=[rcs_recentchanges(100)];
-       foreach my $change (@$changelog) {
-               $change->{when} = concise(ago($change->{when}));
-
-               $change->{user} = userlink($change->{user});
-
-               my $is_excess = exists $change->{pages}[10]; # limit pages to first 10
-               delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
-               $change->{pages} = [
-                       map {
-                               $_->{link} = htmllink("", "", $_->{page},
-                                       noimageinline => 1,
-                                       linktext => pagetitle($_->{page}));
-                               $_;
-                       } @{$change->{pages}}
-               ];
-               push @{$change->{pages}}, { link => '...' } if $is_excess;
-       }
-
-       my $template=template("recentchanges.tmpl"); 
-       $template->param(
-               title => "RecentChanges",
-               indexlink => indexlink(),
-               wikiname => $config{wikiname},
-               changelog => $changelog,
-               baseurl => baseurl(),
-       );
-       run_hooks(pagetemplate => sub {
-               shift->(page => "", destpage => "", template => $template);
-       });
-       print $q->header(-charset => 'utf-8'), $template->output;
-} #}}}
-
 # Check if the user is signed in. If not, redirect to the signin form and
 # save their place to return to later.
 sub needsignin ($$) { #{{{
@@ -137,9 +95,7 @@ sub needsignin ($$) { #{{{
 
        if (! defined $session->param("name") ||
            ! userinfo_get($session->param("name"), "regdate")) {
-               if (! defined $session->param("postsignin")) {
-                       $session->param(postsignin => $ENV{QUERY_STRING});
-               }
+               $session->param(postsignin => $ENV{QUERY_STRING});
                cgi_signin($q, $session);
                cgi_savesession($session);
                exit;
@@ -174,11 +130,11 @@ sub cgi_signin ($$) { #{{{
                force => 1);
        
        decode_form_utf8($form);
-       
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session,
                        buttons => $buttons);
        });
+       decode_form_utf8($form);
 
        if ($form->submitted) {
                $form->validate;
@@ -200,9 +156,7 @@ sub cgi_postsignin ($$) { #{{{
                exit;
        }
        else {
-               # This can occur, for example, if a user went to the signin
-               # url via a bookmark.
-               redirect($q, $config{url});
+               error(gettext("login failed, perhaps you need to turn on cookies?"));
        }
 } #}}}
 
@@ -211,6 +165,16 @@ sub cgi_prefs ($$) { #{{{
        my $session=shift;
 
        needsignin($q, $session);
+       
+       # The session id is stored on the form and checked to
+       # guard against CSRF.
+       my $sid=$q->param('sid');
+       if (! defined $sid) {
+               $q->delete_all;
+       }
+       elsif ($sid ne $session->id) {
+               error(gettext("Your login session has expired."));
+       }
 
        eval q{use CGI::FormBuilder};
        error($@) if $@;
@@ -236,19 +200,19 @@ sub cgi_prefs ($$) { #{{{
                ],
        );
        my $buttons=["Save Preferences", "Logout", "Cancel"];
-
+       
        decode_form_utf8($form);
-
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session,
                        buttons => $buttons);
        });
+       decode_form_utf8($form);
        
-       $form->field(name => "do", type => "hidden");
+       $form->field(name => "do", type => "hidden", value => "prefs",
+               force => 1);
+       $form->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);
        $form->field(name => "email", size => 50, fieldset => "preferences");
-       $form->field(name => "subscriptions", size => 50,
-               fieldset => "preferences",
-               comment => "(".htmllink("", "", "ikiwiki/PageSpec", noimageinline => 1).")");
        $form->field(name => "banned_users", size => 50,
                fieldset => "admin");
        
@@ -260,8 +224,6 @@ sub cgi_prefs ($$) { #{{{
        if (! $form->submitted) {
                $form->field(name => "email", force => 1,
                        value => userinfo_get($user_name, "email"));
-               $form->field(name => "subscriptions", force => 1,
-                       value => userinfo_get($user_name, "subscriptions"));
                if (is_admin($user_name)) {
                        $form->field(name => "banned_users", force => 1,
                                value => join(" ", get_banned_users()));
@@ -278,11 +240,9 @@ sub cgi_prefs ($$) { #{{{
                return;
        }
        elsif ($form->submitted eq 'Save Preferences' && $form->validate) {
-               foreach my $field (qw(email subscriptions)) {
-                       if (defined $form->field($field) && length $form->field($field)) {
-                               userinfo_set($user_name, $field, $form->field($field)) ||
-                                       error("failed to set $field");
-                       }
+               if (defined $form->field('email')) {
+                       userinfo_set($user_name, 'email', $form->field('email')) ||
+                               error("failed to set email");
                }
                if (is_admin($user_name)) {
                        set_banned_users(grep { ! is_admin($_) }
@@ -299,10 +259,9 @@ sub cgi_prefs ($$) { #{{{
 sub cgi_editpage ($$) { #{{{
        my $q=shift;
        my $session=shift;
-
+       
        my @fields=qw(do rcsinfo subpage from page type editcontent comments);
        my @buttons=("Save Page", "Preview", "Cancel");
-       
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
@@ -310,9 +269,6 @@ sub cgi_editpage ($$) { #{{{
                fields => \@fields,
                charset => "utf-8",
                method => 'POST',
-               validate => {
-                       editcontent => '/.+/',
-               },
                required => [qw{editcontent}],
                javascript => 0,
                params => $q,
@@ -324,11 +280,11 @@ sub cgi_editpage ($$) { #{{{
        );
        
        decode_form_utf8($form);
-       
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session,
                        buttons => \@buttons);
        });
+       decode_form_utf8($form);
        
        # This untaint is safe because titlepage removes any problematic
        # characters.
@@ -338,6 +294,8 @@ sub cgi_editpage ($$) { #{{{
            file_pruned($page, $config{srcdir}) || $page=~/^\//) {
                error("bad page name");
        }
+
+       my $baseurl=$config{url}."/".htmlpage($page);
        
        my $from;
        if (defined $form->field('from')) {
@@ -349,20 +307,21 @@ sub cgi_editpage ($$) { #{{{
        if (exists $pagesources{$page} && $form->field("do") ne "create") {
                $file=$pagesources{$page};
                $type=pagetype($file);
-               if (! defined $type) {
+               if (! defined $type || $type=~/^_/) {
                        error(sprintf(gettext("%s is not an editable page"), $page));
                }
                if (! $form->submitted) {
                        $form->field(name => "rcsinfo",
                                value => rcs_prepedit($file), force => 1);
                }
+               $form->field(name => "editcontent", validate => '/.*/');
        }
        else {
                $type=$form->param('type');
                if (defined $type && length $type && $hooks{htmlize}{$type}) {
                        $type=possibly_foolish_untaint($type);
                }
-               elsif (defined $from) {
+               elsif (defined $from && exists $pagesources{$from}) {
                        # favor the type of linking page
                        $type=pagetype($pagesources{$from});
                }
@@ -371,9 +330,12 @@ sub cgi_editpage ($$) { #{{{
                if (! $form->submitted) {
                        $form->field(name => "rcsinfo", value => "", force => 1);
                }
+               $form->field(name => "editcontent", validate => '/.+/');
        }
 
        $form->field(name => "do", type => 'hidden');
+       $form->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);
        $form->field(name => "from", type => 'hidden');
        $form->field(name => "rcsinfo", type => 'hidden');
        $form->field(name => "subpage", type => 'hidden');
@@ -385,10 +347,9 @@ sub cgi_editpage ($$) { #{{{
        $form->tmpl_param("can_commit", $config{rcs});
        $form->tmpl_param("indexlink", indexlink());
        $form->tmpl_param("helponformattinglink",
-               htmllink("", "", "ikiwiki/formatting",
+               htmllink($page, $page, "ikiwiki/formatting",
                        noimageinline => 1,
                        linktext => "FormattingHelp"));
-       $form->tmpl_param("baseurl", baseurl());
        
        if ($form->submitted eq "Cancel") {
                if ($form->field("do") eq "create" && defined $from) {
@@ -403,7 +364,14 @@ sub cgi_editpage ($$) { #{{{
                return;
        }
        elsif ($form->submitted eq "Preview") {
+               my $new=not exists $pagesources{$page};
+               if ($new) {
+                       # temporarily record its type
+                       $pagesources{$page}=$page.".".$type;
+               }
+
                my $content=$form->field('editcontent');
+
                run_hooks(editcontent => sub {
                        $content=shift->(
                                content => $content,
@@ -414,9 +382,15 @@ sub cgi_editpage ($$) { #{{{
                });
                $form->tmpl_param("page_preview",
                        htmlize($page, $type,
-                       linkify($page, "",
+                       linkify($page, $page,
                        preprocess($page, $page,
                        filter($page, $page, $content), 0, 1))));
+       
+               if ($new) {
+                       delete $pagesources{$page};
+               }
+               # previewing may have created files on disk
+               saveindex();
        }
        elsif ($form->submitted eq "Save Page") {
                $form->tmpl_param("page_preview", "");
@@ -452,9 +426,10 @@ sub cgi_editpage ($$) { #{{{
                                        $dir=~s![^/]+/+$!!;
                                        push @page_locs, $dir.$page;
                                }
+                       
+                               push @page_locs, "$config{userdir}/$page"
+                                       if length $config{userdir};
                        }
-                       push @page_locs, "$config{userdir}/$page"
-                               if length $config{userdir};
 
                        @page_locs = grep {
                                ! exists $pagecase{lc $_}
@@ -462,8 +437,16 @@ sub cgi_editpage ($$) { #{{{
                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?
-                               redirect($q, "$config{url}/".htmlpage($page));
-                               return;
+                               if ($form->submitted eq "Preview") {
+                                       # let them go ahead with the edit
+                                       # and resolve the conflict at save
+                                       # time
+                                       @page_locs=$page;
+                               }
+                               else {
+                                       redirect($q, "$config{url}/".htmlpage($page));
+                                       return;
+                               }
                        }
 
                        my @editable_locs = grep {
@@ -476,7 +459,8 @@ sub cgi_editpage ($$) { #{{{
                        
                        my @page_types;
                        if (exists $hooks{htmlize}) {
-                               @page_types=keys %{$hooks{htmlize}};
+                               @page_types=grep { !/^_/ }
+                                       keys %{$hooks{htmlize}};
                        }
                        
                        $form->tmpl_param("page_select", 1);
@@ -506,24 +490,33 @@ sub cgi_editpage ($$) { #{{{
                        $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
                }
                
-               showform($form, \@buttons, $session, $q);
-               saveindex();
+               showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
        }
        else {
                # save page
                check_canedit($page, $q, $session);
+       
+               # The session id is stored on the form and checked to
+               # guard against CSRF. But only if the user is logged in,
+               # as anonok can allow anonymous edits.
+               if (defined $session->param("name")) {
+                       my $sid=$q->param('sid');
+                       if (! defined $sid || $sid ne $session->id) {
+                               error(gettext("Your login session has expired."));
+                       }
+               }
 
                my $exists=-e "$config{srcdir}/$file";
 
                if ($form->field("do") ne "create" && ! $exists &&
-                   ! eval { srcfile($file) }) {
+                   ! defined srcfile($file, 1)) {
                        $form->tmpl_param("page_gone", 1);
                        $form->field(name => "do", value => "create", force => 1);
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
-                       showform($form, \@buttons, $session, $q);
+                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
                        return;
                }
                elsif ($form->field("do") eq "create" && $exists) {
@@ -537,7 +530,7 @@ sub cgi_editpage ($$) { #{{{
                                value => readfile("$config{srcdir}/$file").
                                         "\n\n\n".$form->field("editcontent"),
                                force => 1);
-                       showform($form, \@buttons, $session, $q);
+                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
                        return;
                }
                
@@ -567,7 +560,8 @@ sub cgi_editpage ($$) { #{{{
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
-                       showform($form, \@buttons, $session, $q);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl);
                        return;
                }
                
@@ -585,7 +579,7 @@ sub cgi_editpage ($$) { #{{{
 
                        # Prevent deadlock with post-commit hook by
                        # signaling to it that it should not try to
-                       # do anything (except send commit mails).
+                       # do anything.
                        disable_commit_hook();
                        $conflict=rcs_commit($file, $message,
                                $form->field("rcsinfo"),
@@ -598,10 +592,6 @@ sub cgi_editpage ($$) { #{{{
                # may have been committed while the post-commit hook was
                # disabled.
                require IkiWiki::Render;
-               # Reload index, since the first time it's loaded is before
-               # the wiki is locked, and things may have changed in the
-               # meantime.
-               loadindex();
                refresh();
                saveindex();
 
@@ -615,7 +605,8 @@ sub cgi_editpage ($$) { #{{{
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
-                       showform($form, \@buttons, $session, $q);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl);
                        return;
                }
                else {
@@ -657,7 +648,9 @@ sub cgi (;$$) { #{{{
                eval q{use CGI};
                error($@) if $@;
        
+               binmode(STDIN);
                $q=CGI->new;
+               binmode(STDIN, ":utf8");
        
                run_hooks(cgi => sub { shift->($q) });
        }
@@ -673,14 +666,9 @@ sub cgi (;$$) { #{{{
                }
        }
        
-       # Things that do not need a session.
-       if ($do eq 'recentchanges') {
-               cgi_recentchanges($q);
-               return;
-       }
-
        # Need to lock the wiki before getting a session.
        lockwiki();
+       loadindex();
        
        if (! $session) {
                $session=cgi_getsession($q);
@@ -718,49 +706,18 @@ sub cgi (;$$) { #{{{
                cgi_signin($q, $session);
                cgi_savesession($session);
        }
-       elsif (defined $session->param("postsignin")) {
-               cgi_postsignin($q, $session);
-       }
        elsif ($do eq 'prefs') {
                cgi_prefs($q, $session);
        }
        elsif ($do eq 'create' || $do eq 'edit') {
                cgi_editpage($q, $session);
        }
-       elsif ($do eq 'postsignin') {
-               error(gettext("login failed, perhaps you need to turn on cookies?"));
+       elsif (defined $session->param("postsignin") || $do eq 'postsignin') {
+               cgi_postsignin($q, $session);
        }
        else {
                error("unknown do parameter");
        }
 } #}}}
 
-sub userlink ($) { #{{{
-       my $user=shift;
-
-       eval q{use CGI 'escapeHTML'};
-       error($@) if $@;
-       if ($user =~ m!^https?://! &&
-           eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
-               # Munge user-urls, as used by eg, OpenID.
-               my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
-               my $display=$oid->display;
-               # Convert "user.somehost.com" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^(.*?)\.([^.]+\.[a-z]+)$/$1 [$2]/;
-               }
-               # Convert "http://somehost.com/user" to "user [somehost.com]".
-               if ($display !~ /\[/) {
-                       $display=~s/^https?:\/\/(.+)\/([^\/]+)$/$2 [$1]/;
-               }
-               $display=~s!^https?://!!; # make sure this is removed
-               return "<a href=\"$user\">".escapeHTML($display)."</a>";
-       }
-       else {
-               return htmllink("", "", escapeHTML(
-                       length $config{userdir} ? $config{userdir}."/".$user : $user
-               ), noimageinline => 1);
-       }
-} #}}}
-
 1