editpage, comment: Clean up title when editing or creating a page or comment.

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

diff --git a/IkiWiki/Plugin/editpage.pm b/IkiWiki/Plugin/editpage.pm
index 794548c6de933d03f1e2755ae3ad8cdefc2ca8a8..537b86ad1d12c1c507d2710a237051b7d4e3c91a 100644 (file)
--- a/IkiWiki/Plugin/editpage.pm
+++ b/IkiWiki/Plugin/editpage.pm
@@ -6,19 +6,20 @@ use strict;
 use IkiWiki;
 use open qw{:utf8 :std};
 
 use IkiWiki;
 use open qw{:utf8 :std};
 

-sub import { #{{{
+sub import {

        hook(type => "getsetup", id => "editpage", call => \&getsetup);
        hook(type => "refresh", id => "editpage", call => \&refresh);
         hook(type => "sessioncgi", id => "editpage", call => \&IkiWiki::cgi_editpage);
        hook(type => "getsetup", id => "editpage", call => \&getsetup);
        hook(type => "refresh", id => "editpage", call => \&refresh);
         hook(type => "sessioncgi", id => "editpage", call => \&IkiWiki::cgi_editpage);

-} # }}}
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
                plugin => {
                        safe => 1,
                        rebuild => 1,
        return
                plugin => {
                        safe => 1,
                        rebuild => 1,

+                       section => "core",

                },
                },

-} #}}}
+}

 
 sub refresh () {
        if (exists $wikistate{editpage} && exists $wikistate{editpage}{previews}) {
 
 sub refresh () {
        if (exists $wikistate{editpage} && exists $wikistate{editpage}{previews}) {


@@ -51,37 +52,10 @@ sub refresh () {
 
 # Back to ikiwiki namespace for the rest, this code is very much
 # internal to ikiwiki even though it's separated into a plugin,
 
 # Back to ikiwiki namespace for the rest, this code is very much
 # internal to ikiwiki even though it's separated into a plugin,

-# and other plugins use the functions below.
+# and other plugins use the function below.

 package IkiWiki;
 
 package IkiWiki;
 

-sub check_canedit ($$$;$) { #{{{
-       my $page=shift;
-       my $q=shift;
-       my $session=shift;
-       my $nonfatal=shift;
-       
-       my $canedit;
-       run_hooks(canedit => sub {
-               return if defined $canedit;
-               my $ret=shift->($page, $q, $session);
-               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;
-} #}}}
-
-sub cgi_editpage ($$) { #{{{
+sub cgi_editpage ($$) {

        my $q=shift;
        my $session=shift;
        
        my $q=shift;
        my $session=shift;
        


@@ -90,7 +64,7 @@ sub cgi_editpage ($$) { #{{{
 
        decode_cgi_utf8($q);
 
 
        decode_cgi_utf8($q);
 

-       my @fields=qw(do rcsinfo subpage from page type editcontent comments);
+       my @fields=qw(do rcsinfo subpage from page type editcontent editmessage);

        my @buttons=("Save Page", "Preview", "Cancel");
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my @buttons=("Save Page", "Preview", "Cancel");
        eval q{use CGI::FormBuilder};
        error($@) if $@;


@@ -101,11 +75,10 @@ sub cgi_editpage ($$) { #{{{
                required => [qw{editcontent}],
                javascript => 0,
                params => $q,
                required => [qw{editcontent}],
                javascript => 0,
                params => $q,

-               action => $config{cgiurl},
+               action => IkiWiki::cgiurl(),

                header => 0,
                table => 0,
                header => 0,
                table => 0,

-               template => scalar template_params("editpage.tmpl"),
-               wikiname => $config{wikiname},
+               template => { template("editpage.tmpl") },

        );
        
        decode_form_utf8($form);
        );
        
        decode_form_utf8($form);


@@ -119,13 +92,13 @@ sub cgi_editpage ($$) { #{{{
        # wiki_file_regexp.
        my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
        $page=possibly_foolish_untaint($page);
        # wiki_file_regexp.
        my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
        $page=possibly_foolish_untaint($page);

-       my $absolute=($page =~ s#^/+##);
+       my $absolute=($page =~ s#^/+##); # absolute name used to force location

        if (! defined $page || ! length $page ||
        if (! defined $page || ! length $page ||

-           file_pruned($page, $config{srcdir})) {
-               error("bad page name");
+           file_pruned($page)) {
+               error(gettext("bad page name"));

        }
 
        }
 

-       my $baseurl = urlto($page, undef, 1);
+       my $baseurl = urlto($page);

 
        my $from;
        if (defined $form->field('from')) {
 
        my $from;
        if (defined $form->field('from')) {


@@ -171,34 +144,34 @@ sub cgi_editpage ($$) { #{{{
        $form->field(name => "subpage", type => 'hidden');
        $form->field(name => "page", value => $page, force => 1);
        $form->field(name => "type", value => $type, force => 1);
        $form->field(name => "subpage", type => 'hidden');
        $form->field(name => "page", value => $page, force => 1);
        $form->field(name => "type", value => $type, force => 1);

-       $form->field(name => "comments", type => "text", size => 80);
+       $form->field(name => "editmessage", type => "text", size => 80);

        $form->field(name => "editcontent", type => "textarea", rows => 20,
                cols => 80);
        $form->tmpl_param("can_commit", $config{rcs});
        $form->field(name => "editcontent", type => "textarea", rows => 20,
                cols => 80);
        $form->tmpl_param("can_commit", $config{rcs});

-       $form->tmpl_param("indexlink", indexlink());

        $form->tmpl_param("helponformattinglink",
                htmllink($page, $page, "ikiwiki/formatting",
                        noimageinline => 1,
                        linktext => "FormattingHelp"));
        
        $form->tmpl_param("helponformattinglink",
                htmllink($page, $page, "ikiwiki/formatting",
                        noimageinline => 1,
                        linktext => "FormattingHelp"));
        

+       my $previewing=0;

        if ($form->submitted eq "Cancel") {
                if ($form->field("do") eq "create" && defined $from) {
        if ($form->submitted eq "Cancel") {
                if ($form->field("do") eq "create" && defined $from) {

-                       redirect($q, urlto($from, undef, 1));
+                       redirect($q, urlto($from));

                }
                elsif ($form->field("do") eq "create") {
                }
                elsif ($form->field("do") eq "create") {

-                       redirect($q, $config{url});
+                       redirect($q, baseurl(undef));

                }
                else {
                }
                else {

-                       redirect($q, urlto($page, undef, 1));
+                       redirect($q, $baseurl);

                }
                exit;
        }
        elsif ($form->submitted eq "Preview") {
                }
                exit;
        }
        elsif ($form->submitted eq "Preview") {

+               $previewing=1;
+

                my $new=not exists $pagesources{$page};
                my $new=not exists $pagesources{$page};

-               if ($new) {
-                       # temporarily record its type
-                       $pagesources{$page}=$page.".".$type;
-               }
+               # temporarily record its type
+               $pagesources{$page}=$page.".".$type if $new;

                my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
 
                my $content=$form->field('editcontent');
                my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
 
                my $content=$form->field('editcontent');


@@ -223,18 +196,17 @@ sub cgi_editpage ($$) { #{{{
                });
                $form->tmpl_param("page_preview", $preview);
                
                });
                $form->tmpl_param("page_preview", $preview);
                

-               if ($new) {
-                       delete $pagesources{$page};
-               }
-

                # Previewing may have created files on disk.
                # Keep a list of these to be deleted later.
                my %previews = map { $_ => 1 } @{$wikistate{editpage}{previews}};
                foreach my $f (@{$renderedfiles{$page}}) {
                        $previews{$f}=1 unless $wasrendered{$f};
                }
                # Previewing may have created files on disk.
                # Keep a list of these to be deleted later.
                my %previews = map { $_ => 1 } @{$wikistate{editpage}{previews}};
                foreach my $f (@{$renderedfiles{$page}}) {
                        $previews{$f}=1 unless $wasrendered{$f};
                }

+
+               # Throw out any other state changes made during previewing,
+               # and save the previews list.
+               loadindex();

                @{$wikistate{editpage}{previews}} = keys %previews;
                @{$wikistate{editpage}{previews}} = keys %previews;

-               $renderedfiles{$page}=[keys %wasrendered];

                saveindex();
        }
        elsif ($form->submitted eq "Save Page") {
                saveindex();
        }
        elsif ($form->submitted eq "Save Page") {


@@ -247,18 +219,18 @@ sub cgi_editpage ($$) { #{{{
                        my $best_loc;
                        if (! defined $from || ! length $from ||
                            $from ne $form->field('from') ||
                        my $best_loc;
                        if (! defined $from || ! length $from ||
                            $from ne $form->field('from') ||

-                           file_pruned($from, $config{srcdir}) ||
-                           $from=~/^\// || 
+                           file_pruned($from) ||

                            $absolute ||
                            $absolute ||

-                           $form->submitted eq "Preview") {
+                           $form->submitted) {

                                @page_locs=$best_loc=$page;
                        }
                        else {
                                my $dir=$from."/";
                                $dir=~s![^/]+/+$!!;
                                
                                @page_locs=$best_loc=$page;
                        }
                        else {
                                my $dir=$from."/";
                                $dir=~s![^/]+/+$!!;
                                

-                               if ((defined $form->field('subpage') && length $form->field('subpage')) ||
-                                   $page eq gettext('discussion')) {
+                               if ((defined $form->field('subpage') &&
+                                    length $form->field('subpage')) ||
+                                   $page eq lc($config{discussionpage})) {

                                        $best_loc="$from/$page";
                                }
                                else {
                                        $best_loc="$from/$page";
                                }
                                else {


@@ -272,8 +244,9 @@ sub cgi_editpage ($$) { #{{{
                                        push @page_locs, $dir.$page;
                                }
                        
                                        push @page_locs, $dir.$page;
                                }
                        

-                               push @page_locs, "$config{userdir}/$page"
-                                       if length $config{userdir};
+                               my $userpage=IkiWiki::userpage($page);
+                               push @page_locs, $userpage
+                                       if ! grep { $_ eq $userpage } @page_locs;

                        }
 
                        @page_locs = grep {
                        }
 
                        @page_locs = grep {


@@ -282,14 +255,14 @@ sub cgi_editpage ($$) { #{{{
                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?
                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?

-                               if ($form->submitted eq "Preview") {
+                               if ($previewing) {

                                        # let them go ahead with the edit
                                        # and resolve the conflict at save
                                        # time
                                        @page_locs=$page;
                                }
                                else {
                                        # let them go ahead with the edit
                                        # and resolve the conflict at save
                                        # time
                                        @page_locs=$page;
                                }
                                else {

-                                       redirect($q, urlto($page, undef, 1));
+                                       redirect($q, $baseurl);

                                        exit;
                                }
                        }
                                        exit;
                                }
                        }


@@ -298,15 +271,19 @@ sub cgi_editpage ($$) { #{{{
                                check_canedit($_, $q, $session, 1)
                        } @page_locs;
                        if (! @editable_locs) {
                                check_canedit($_, $q, $session, 1)
                        } @page_locs;
                        if (! @editable_locs) {

-                               # let it throw an error this time
-                               map { check_canedit($_, $q, $session) } @page_locs;
+                               # now let it throw an error, or prompt for
+                               # login
+                               map { check_canedit($_, $q, $session) }
+                                       ($best_loc, @page_locs);

                        }
                        
                        my @page_types;
                        if (exists $hooks{htmlize}) {
                        }
                        
                        my @page_types;
                        if (exists $hooks{htmlize}) {

-                               @page_types=grep { !/^_/ }
-                                       keys %{$hooks{htmlize}};
+                               foreach my $key (grep { !/^_/ } keys %{$hooks{htmlize}}) {
+                                       push @page_types, [$key, $hooks{htmlize}{$key}{longname} || $key];
+                               }

                        }
                        }

+                       @page_types=sort @page_types;

                        
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
                        
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',


@@ -314,7 +291,7 @@ sub cgi_editpage ($$) { #{{{
                                value => $best_loc);
                        $form->field(name => "type", type => 'select',
                                options => \@page_types);
                                value => $best_loc);
                        $form->field(name => "type", type => 'select',
                                options => \@page_types);

-                       $form->title(sprintf(gettext("creating %s"), pagetitle($page)));
+                       $form->title(sprintf(gettext("creating %s"), pagetitle(basename($page))));

                        
                }
                elsif ($form->field("do") eq "edit") {
                        
                }
                elsif ($form->field("do") eq "edit") {


@@ -332,24 +309,16 @@ sub cgi_editpage ($$) { #{{{
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');

-                       $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
+                       $form->title(sprintf(gettext("editing %s"), pagetitle(basename($page))));

                }
                
                }
                

-               showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
+               showform($form, \@buttons, $session, $q,
+                       forcebaseurl => $baseurl, page => $page);

        }
        else {
                # save page
                check_canedit($page, $q, $session);
        }
        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."));
-                       }
-               }
+               checksessionexpiry($q, $session, $q->param('sid'));

 
                my $exists=-e "$config{srcdir}/$file";
 
 
                my $exists=-e "$config{srcdir}/$file";
 


@@ -361,7 +330,8 @@ sub cgi_editpage ($$) { #{{{
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));

-                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl, page => $page);

                        exit;
                }
                elsif ($form->field("do") eq "create" && $exists) {
                        exit;
                }
                elsif ($form->field("do") eq "create" && $exists) {


@@ -375,11 +345,21 @@ sub cgi_editpage ($$) { #{{{
                                value => readfile("$config{srcdir}/$file").
                                         "\n\n\n".$form->field("editcontent"),
                                force => 1);
                                value => readfile("$config{srcdir}/$file").
                                         "\n\n\n".$form->field("editcontent"),
                                force => 1);

-                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl, page => $page);

                        exit;
                }
                        exit;
                }

+                       
+               my $message="";
+               if (defined $form->field('editmessage') &&
+                   length $form->field('editmessage')) {
+                       $message=$form->field('editmessage');
+               }

                
                my $content=$form->field('editcontent');
                
                my $content=$form->field('editcontent');

+               check_content(content => $content, page => $page,
+                       cgi => $q, session => $session,
+                       subject => $message);

                run_hooks(editcontent => sub {
                        $content=shift->(
                                content => $content,
                run_hooks(editcontent => sub {
                        $content=shift->(
                                content => $content,


@@ -407,18 +387,12 @@ sub cgi_editpage ($$) { #{{{
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
                        showform($form, \@buttons, $session, $q,
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
                        showform($form, \@buttons, $session, $q,

-                               forcebaseurl => $baseurl);
+                               forcebaseurl => $baseurl, page => $page);

                        exit;
                }
                
                my $conflict;
                if ($config{rcs}) {
                        exit;
                }
                
                my $conflict;
                if ($config{rcs}) {

-                       my $message="";
-                       if (defined $form->field('comments') &&
-                           length $form->field('comments')) {
-                               $message=$form->field('comments');
-                       }
-                       

                        if (! $exists) {
                                rcs_add($file);
                        }
                        if (! $exists) {
                                rcs_add($file);
                        }


@@ -427,9 +401,12 @@ sub cgi_editpage ($$) { #{{{
                        # signaling to it that it should not try to
                        # do anything.
                        disable_commit_hook();
                        # signaling to it that it should not try to
                        # do anything.
                        disable_commit_hook();

-                       $conflict=rcs_commit($file, $message,
-                               $form->field("rcsinfo"),
-                               $session->param("name"), $ENV{REMOTE_ADDR});
+                       $conflict=rcs_commit(
+                               file => $file,
+                               message => $message,
+                               token => $form->field("rcsinfo"),
+                               session => $session,
+                       );

                        enable_commit_hook();
                        rcs_update();
                }
                        enable_commit_hook();
                        rcs_update();
                }


@@ -452,16 +429,16 @@ sub cgi_editpage ($$) { #{{{
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
                        showform($form, \@buttons, $session, $q,
                        $form->field(name => "type", type => 'hidden');
                        $form->title(sprintf(gettext("editing %s"), $page));
                        showform($form, \@buttons, $session, $q,

-                               forcebaseurl => $baseurl);
+                               forcebaseurl => $baseurl, page => $page);

                }
                else {
                        # The trailing question mark tries to avoid broken
                        # caches and get the most recent version of the page.
                }
                else {
                        # The trailing question mark tries to avoid broken
                        # caches and get the most recent version of the page.

-                       redirect($q, urlto($page, undef, 1)."?updated");
+                       redirect($q, $baseurl."?updated");

                }
        }
 
        exit;
                }
        }
 
        exit;

-} #}}}
+}

 
 1
 
 1