remove unused editpage title
[ikiwiki.git] / IkiWiki / CGI.pm
1 #!/usr/bin/perl
2
3 use warnings;
4 use strict;
5 use IkiWiki;
6 use IkiWiki::UserInfo;
7 use open qw{:utf8 :std};
8 use Encode;
9
10 package IkiWiki;
11
12 sub printheader ($) { #{{{
13         my $session=shift;
14         
15         if ($config{sslcookie}) {
16                 print $session->header(-charset => 'utf-8',
17                         -cookie => $session->cookie(-secure => 1));
18         } else {
19                 print $session->header(-charset => 'utf-8');
20         }
21
22 } #}}}
23
24 sub showform ($$$$;@) { #{{{
25         my $form=shift;
26         my $buttons=shift;
27         my $session=shift;
28         my $cgi=shift;
29
30         if (exists $hooks{formbuilder}) {
31                 run_hooks(formbuilder => sub {
32                         shift->(form => $form, cgi => $cgi, session => $session,
33                                 buttons => $buttons);
34                 });
35         }
36
37         printheader($session);
38         print misctemplate($form->title, $form->render(submit => $buttons), @_);
39 }
40
41 sub redirect ($$) { #{{{
42         my $q=shift;
43         my $url=shift;
44         if (! $config{w3mmode}) {
45                 print $q->redirect($url);
46         }
47         else {
48                 print "Content-type: text/plain\n";
49                 print "W3m-control: GOTO $url\n\n";
50         }
51 } #}}}
52
53 sub check_canedit ($$$;$) { #{{{
54         my $page=shift;
55         my $q=shift;
56         my $session=shift;
57         my $nonfatal=shift;
58         
59         my $canedit;
60         run_hooks(canedit => sub {
61                 return if defined $canedit;
62                 my $ret=shift->($page, $q, $session);
63                 if (defined $ret) {
64                         if ($ret eq "") {
65                                 $canedit=1;
66                         }
67                         elsif (ref $ret eq 'CODE') {
68                                 $ret->() unless $nonfatal;
69                                 $canedit=0;
70                         }
71                         elsif (defined $ret) {
72                                 error($ret) unless $nonfatal;
73                                 $canedit=0;
74                         }
75                 }
76         });
77         return $canedit;
78 } #}}}
79
80 sub decode_cgi_utf8 ($) { #{{{
81         # decode_form_utf8 method is needed for 5.10
82         if ($] < 5.01) {
83                 my $cgi = shift;
84                 foreach my $f ($cgi->param) {
85                         $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f));
86                 }
87         }
88 } #}}}
89
90 sub decode_form_utf8 ($) { #{{{
91         if ($] >= 5.01) {
92                 my $form = shift;
93                 foreach my $f ($form->field) {
94                         $form->field(name  => $f,
95                                      value => decode_utf8($form->field($f)),
96                                      force => 1,
97                         );
98                 }
99         }
100 } #}}}
101
102 # Check if the user is signed in. If not, redirect to the signin form and
103 # save their place to return to later.
104 sub needsignin ($$) { #{{{
105         my $q=shift;
106         my $session=shift;
107
108         if (! defined $session->param("name") ||
109             ! userinfo_get($session->param("name"), "regdate")) {
110                 $session->param(postsignin => $ENV{QUERY_STRING});
111                 cgi_signin($q, $session);
112                 cgi_savesession($session);
113                 exit;
114         }
115 } #}}}  
116
117 sub cgi_signin ($$) { #{{{
118         my $q=shift;
119         my $session=shift;
120
121         decode_cgi_utf8($q);
122         eval q{use CGI::FormBuilder};
123         error($@) if $@;
124         my $form = CGI::FormBuilder->new(
125                 title => "signin",
126                 name => "signin",
127                 charset => "utf-8",
128                 method => 'POST',
129                 required => 'NONE',
130                 javascript => 0,
131                 params => $q,
132                 action => $config{cgiurl},
133                 header => 0,
134                 template => {type => 'div'},
135                 stylesheet => baseurl()."style.css",
136         );
137         my $buttons=["Login"];
138         
139         if ($q->param("do") ne "signin" && !$form->submitted) {
140                 $form->text(gettext("You need to log in first."));
141         }
142         $form->field(name => "do", type => "hidden", value => "signin",
143                 force => 1);
144         
145         decode_form_utf8($form);
146         run_hooks(formbuilder_setup => sub {
147                 shift->(form => $form, cgi => $q, session => $session,
148                         buttons => $buttons);
149         });
150         decode_form_utf8($form);
151
152         if ($form->submitted) {
153                 $form->validate;
154         }
155
156         showform($form, $buttons, $session, $q);
157 } #}}}
158
159 sub cgi_postsignin ($$) { #{{{
160         my $q=shift;
161         my $session=shift;
162         
163         # Continue with whatever was being done before the signin process.
164         if (defined $session->param("postsignin")) {
165                 my $postsignin=CGI->new($session->param("postsignin"));
166                 $session->clear("postsignin");
167                 cgi($postsignin, $session);
168                 cgi_savesession($session);
169                 exit;
170         }
171         else {
172                 error(gettext("login failed, perhaps you need to turn on cookies?"));
173         }
174 } #}}}
175
176 sub cgi_prefs ($$) { #{{{
177         my $q=shift;
178         my $session=shift;
179
180         needsignin($q, $session);
181         decode_cgi_utf8($q);
182         
183         # The session id is stored on the form and checked to
184         # guard against CSRF.
185         my $sid=$q->param('sid');
186         if (! defined $sid) {
187                 $q->delete_all;
188         }
189         elsif ($sid ne $session->id) {
190                 error(gettext("Your login session has expired."));
191         }
192
193         eval q{use CGI::FormBuilder};
194         error($@) if $@;
195         my $form = CGI::FormBuilder->new(
196                 title => "preferences",
197                 name => "preferences",
198                 header => 0,
199                 charset => "utf-8",
200                 method => 'POST',
201                 validate => {
202                         email => 'EMAIL',
203                 },
204                 required => 'NONE',
205                 javascript => 0,
206                 params => $q,
207                 action => $config{cgiurl},
208                 template => {type => 'div'},
209                 stylesheet => baseurl()."style.css",
210                 fieldsets => [
211                         [login => gettext("Login")],
212                         [preferences => gettext("Preferences")],
213                         [admin => gettext("Admin")]
214                 ],
215         );
216         my $buttons=["Save Preferences", "Logout", "Cancel"];
217         
218         decode_form_utf8($form);
219         run_hooks(formbuilder_setup => sub {
220                 shift->(form => $form, cgi => $q, session => $session,
221                         buttons => $buttons);
222         });
223         decode_form_utf8($form);
224         
225         $form->field(name => "do", type => "hidden", value => "prefs",
226                 force => 1);
227         $form->field(name => "sid", type => "hidden", value => $session->id,
228                 force => 1);
229         $form->field(name => "email", size => 50, fieldset => "preferences");
230         $form->field(name => "banned_users", size => 50,
231                 fieldset => "admin");
232         
233         my $user_name=$session->param("name");
234         if (! is_admin($user_name)) {
235                 $form->field(name => "banned_users", type => "hidden");
236         }
237
238         if (! $form->submitted) {
239                 $form->field(name => "email", force => 1,
240                         value => userinfo_get($user_name, "email"));
241                 if (is_admin($user_name)) {
242                         $form->field(name => "banned_users", force => 1,
243                                 value => join(" ", get_banned_users()));
244                 }
245         }
246         
247         if ($form->submitted eq 'Logout') {
248                 $session->delete();
249                 redirect($q, $config{url});
250                 return;
251         }
252         elsif ($form->submitted eq 'Cancel') {
253                 redirect($q, $config{url});
254                 return;
255         }
256         elsif ($form->submitted eq 'Save Preferences' && $form->validate) {
257                 if (defined $form->field('email')) {
258                         userinfo_set($user_name, 'email', $form->field('email')) ||
259                                 error("failed to set email");
260                 }
261                 if (is_admin($user_name)) {
262                         set_banned_users(grep { ! is_admin($_) }
263                                         split(' ',
264                                                 $form->field("banned_users"))) ||
265                                 error("failed saving changes");
266                 }
267                 $form->text(gettext("Preferences saved."));
268         }
269         
270         showform($form, $buttons, $session, $q);
271 } #}}}
272
273 sub cgi_editpage ($$) { #{{{
274         my $q=shift;
275         my $session=shift;
276         
277         decode_cgi_utf8($q);
278
279         my @fields=qw(do rcsinfo subpage from page type editcontent comments);
280         my @buttons=("Save Page", "Preview", "Cancel");
281         eval q{use CGI::FormBuilder};
282         error($@) if $@;
283         my $form = CGI::FormBuilder->new(
284                 fields => \@fields,
285                 charset => "utf-8",
286                 method => 'POST',
287                 required => [qw{editcontent}],
288                 javascript => 0,
289                 params => $q,
290                 action => $config{cgiurl},
291                 header => 0,
292                 table => 0,
293                 template => scalar template_params("editpage.tmpl"),
294                 wikiname => $config{wikiname},
295         );
296         
297         decode_form_utf8($form);
298         run_hooks(formbuilder_setup => sub {
299                 shift->(form => $form, cgi => $q, session => $session,
300                         buttons => \@buttons);
301         });
302         decode_form_utf8($form);
303         
304         # This untaint is safe because titlepage removes any problematic
305         # characters.
306         my ($page)=$form->field('page');
307         $page=titlepage(possibly_foolish_untaint($page));
308         if (! defined $page || ! length $page ||
309             file_pruned($page, $config{srcdir}) || $page=~/^\//) {
310                 error("bad page name");
311         }
312
313         my $baseurl=$config{url}."/".htmlpage($page);
314         
315         my $from;
316         if (defined $form->field('from')) {
317                 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
318         }
319         
320         my $file;
321         my $type;
322         if (exists $pagesources{$page} && $form->field("do") ne "create") {
323                 $file=$pagesources{$page};
324                 $type=pagetype($file);
325                 if (! defined $type || $type=~/^_/) {
326                         error(sprintf(gettext("%s is not an editable page"), $page));
327                 }
328                 if (! $form->submitted) {
329                         $form->field(name => "rcsinfo",
330                                 value => rcs_prepedit($file), force => 1);
331                 }
332                 $form->field(name => "editcontent", validate => '/.*/');
333         }
334         else {
335                 $type=$form->param('type');
336                 if (defined $type && length $type && $hooks{htmlize}{$type}) {
337                         $type=possibly_foolish_untaint($type);
338                 }
339                 elsif (defined $from && exists $pagesources{$from}) {
340                         # favor the type of linking page
341                         $type=pagetype($pagesources{$from});
342                 }
343                 $type=$config{default_pageext} unless defined $type;
344                 $file=$page.".".$type;
345                 if (! $form->submitted) {
346                         $form->field(name => "rcsinfo", value => "", force => 1);
347                 }
348                 $form->field(name => "editcontent", validate => '/.+/');
349         }
350
351         $form->field(name => "do", type => 'hidden');
352         $form->field(name => "sid", type => "hidden", value => $session->id,
353                 force => 1);
354         $form->field(name => "from", type => 'hidden');
355         $form->field(name => "rcsinfo", type => 'hidden');
356         $form->field(name => "subpage", type => 'hidden');
357         $form->field(name => "page", value => pagetitle($page, 1), force => 1);
358         $form->field(name => "type", value => $type, force => 1);
359         $form->field(name => "comments", type => "text", size => 80);
360         $form->field(name => "editcontent", type => "textarea", rows => 20,
361                 cols => 80);
362         $form->tmpl_param("can_commit", $config{rcs});
363         $form->tmpl_param("indexlink", indexlink());
364         $form->tmpl_param("helponformattinglink",
365                 htmllink($page, $page, "ikiwiki/formatting",
366                         noimageinline => 1,
367                         linktext => "FormattingHelp"));
368         
369         if ($form->submitted eq "Cancel") {
370                 if ($form->field("do") eq "create" && defined $from) {
371                         redirect($q, "$config{url}/".htmlpage($from));
372                 }
373                 elsif ($form->field("do") eq "create") {
374                         redirect($q, $config{url});
375                 }
376                 else {
377                         redirect($q, "$config{url}/".htmlpage($page));
378                 }
379                 return;
380         }
381         elsif ($form->submitted eq "Preview") {
382                 my $new=not exists $pagesources{$page};
383                 if ($new) {
384                         # temporarily record its type
385                         $pagesources{$page}=$page.".".$type;
386                 }
387
388                 my $content=$form->field('editcontent');
389
390                 run_hooks(editcontent => sub {
391                         $content=shift->(
392                                 content => $content,
393                                 page => $page,
394                                 cgi => $q,
395                                 session => $session,
396                         );
397                 });
398                 my $preview=htmlize($page, $page, $type,
399                         linkify($page, $page,
400                         preprocess($page, $page,
401                         filter($page, $page, $content), 0, 1)));
402                 run_hooks(format => sub {
403                         $preview=shift->(
404                                 page => $page,
405                                 content => $preview,
406                         );
407                 });
408                 $form->tmpl_param("page_preview", $preview);
409         
410                 if ($new) {
411                         delete $pagesources{$page};
412                 }
413                 # previewing may have created files on disk
414                 saveindex();
415         }
416         elsif ($form->submitted eq "Save Page") {
417                 $form->tmpl_param("page_preview", "");
418         }
419         $form->tmpl_param("page_conflict", "");
420         
421         if ($form->submitted ne "Save Page" || ! $form->validate) {
422                 if ($form->field("do") eq "create") {
423                         my @page_locs;
424                         my $best_loc;
425                         if (! defined $from || ! length $from ||
426                             $from ne $form->field('from') ||
427                             file_pruned($from, $config{srcdir}) ||
428                             $from=~/^\// ||
429                             $form->submitted eq "Preview") {
430                                 @page_locs=$best_loc=$page;
431                         }
432                         else {
433                                 my $dir=$from."/";
434                                 $dir=~s![^/]+/+$!!;
435                                 
436                                 if ((defined $form->field('subpage') && length $form->field('subpage')) ||
437                                     $page eq gettext('discussion')) {
438                                         $best_loc="$from/$page";
439                                 }
440                                 else {
441                                         $best_loc=$dir.$page;
442                                 }
443                                 
444                                 push @page_locs, $dir.$page;
445                                 push @page_locs, "$from/$page";
446                                 while (length $dir) {
447                                         $dir=~s![^/]+/+$!!;
448                                         push @page_locs, $dir.$page;
449                                 }
450                         
451                                 push @page_locs, "$config{userdir}/$page"
452                                         if length $config{userdir};
453                         }
454
455                         @page_locs = grep {
456                                 ! exists $pagecase{lc $_}
457                         } @page_locs;
458                         if (! @page_locs) {
459                                 # hmm, someone else made the page in the
460                                 # meantime?
461                                 if ($form->submitted eq "Preview") {
462                                         # let them go ahead with the edit
463                                         # and resolve the conflict at save
464                                         # time
465                                         @page_locs=$page;
466                                 }
467                                 else {
468                                         redirect($q, "$config{url}/".htmlpage($page));
469                                         return;
470                                 }
471                         }
472
473                         my @editable_locs = grep {
474                                 check_canedit($_, $q, $session, 1)
475                         } @page_locs;
476                         if (! @editable_locs) {
477                                 # let it throw an error this time
478                                 map { check_canedit($_, $q, $session) } @page_locs;
479                         }
480                         
481                         my @page_types;
482                         if (exists $hooks{htmlize}) {
483                                 @page_types=grep { !/^_/ }
484                                         keys %{$hooks{htmlize}};
485                         }
486                         
487                         $form->tmpl_param("page_select", 1);
488                         $form->field(name => "page", type => 'select',
489                                 options => [ map { pagetitle($_, 1) } @editable_locs ],
490                                 value => pagetitle($best_loc, 1));
491                         $form->field(name => "type", type => 'select',
492                                 options => \@page_types);
493                         $form->title(sprintf(gettext("creating %s"), pagetitle($page)));
494                         
495                 }
496                 elsif ($form->field("do") eq "edit") {
497                         check_canedit($page, $q, $session);
498                         if (! defined $form->field('editcontent') || 
499                             ! length $form->field('editcontent')) {
500                                 my $content="";
501                                 if (exists $pagesources{$page}) {
502                                         $content=readfile(srcfile($pagesources{$page}));
503                                         $content=~s/\n/\r\n/g;
504                                 }
505                                 $form->field(name => "editcontent", value => $content,
506                                         force => 1);
507                         }
508                         $form->tmpl_param("page_select", 0);
509                         $form->field(name => "page", type => 'hidden');
510                         $form->field(name => "type", type => 'hidden');
511                         $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
512                 }
513                 
514                 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
515         }
516         else {
517                 # save page
518                 check_canedit($page, $q, $session);
519         
520                 # The session id is stored on the form and checked to
521                 # guard against CSRF. But only if the user is logged in,
522                 # as anonok can allow anonymous edits.
523                 if (defined $session->param("name")) {
524                         my $sid=$q->param('sid');
525                         if (! defined $sid || $sid ne $session->id) {
526                                 error(gettext("Your login session has expired."));
527                         }
528                 }
529
530                 my $exists=-e "$config{srcdir}/$file";
531
532                 if ($form->field("do") ne "create" && ! $exists &&
533                     ! defined srcfile($file, 1)) {
534                         $form->tmpl_param("page_gone", 1);
535                         $form->field(name => "do", value => "create", force => 1);
536                         $form->tmpl_param("page_select", 0);
537                         $form->field(name => "page", type => 'hidden');
538                         $form->field(name => "type", type => 'hidden');
539                         $form->title(sprintf(gettext("editing %s"), $page));
540                         showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
541                         return;
542                 }
543                 elsif ($form->field("do") eq "create" && $exists) {
544                         $form->tmpl_param("creation_conflict", 1);
545                         $form->field(name => "do", value => "edit", force => 1);
546                         $form->tmpl_param("page_select", 0);
547                         $form->field(name => "page", type => 'hidden');
548                         $form->field(name => "type", type => 'hidden');
549                         $form->title(sprintf(gettext("editing %s"), $page));
550                         $form->field("editcontent", 
551                                 value => readfile("$config{srcdir}/$file").
552                                          "\n\n\n".$form->field("editcontent"),
553                                 force => 1);
554                         showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
555                         return;
556                 }
557                 
558                 my $content=$form->field('editcontent');
559                 run_hooks(editcontent => sub {
560                         $content=shift->(
561                                 content => $content,
562                                 page => $page,
563                                 cgi => $q,
564                                 session => $session,
565                         );
566                 });
567                 $content=~s/\r\n/\n/g;
568                 $content=~s/\r/\n/g;
569                 $content.="\n" if $content !~ /\n$/;
570
571                 $config{cgi}=0; # avoid cgi error message
572                 eval { writefile($file, $config{srcdir}, $content) };
573                 $config{cgi}=1;
574                 if ($@) {
575                         $form->field(name => "rcsinfo", value => rcs_prepedit($file),
576                                 force => 1);
577                         $form->tmpl_param("failed_save", 1);
578                         $form->tmpl_param("error_message", $@);
579                         $form->field("editcontent", value => $content, force => 1);
580                         $form->tmpl_param("page_select", 0);
581                         $form->field(name => "page", type => 'hidden');
582                         $form->field(name => "type", type => 'hidden');
583                         $form->title(sprintf(gettext("editing %s"), $page));
584                         showform($form, \@buttons, $session, $q,
585                                 forcebaseurl => $baseurl);
586                         return;
587                 }
588                 
589                 my $conflict;
590                 if ($config{rcs}) {
591                         my $message="";
592                         if (defined $form->field('comments') &&
593                             length $form->field('comments')) {
594                                 $message=$form->field('comments');
595                         }
596                         
597                         if (! $exists) {
598                                 rcs_add($file);
599                         }
600
601                         # Prevent deadlock with post-commit hook by
602                         # signaling to it that it should not try to
603                         # do anything.
604                         disable_commit_hook();
605                         $conflict=rcs_commit($file, $message,
606                                 $form->field("rcsinfo"),
607                                 $session->param("name"), $ENV{REMOTE_ADDR});
608                         enable_commit_hook();
609                         rcs_update();
610                 }
611                 
612                 # Refresh even if there was a conflict, since other changes
613                 # may have been committed while the post-commit hook was
614                 # disabled.
615                 require IkiWiki::Render;
616                 refresh();
617                 saveindex();
618
619                 if (defined $conflict) {
620                         $form->field(name => "rcsinfo", value => rcs_prepedit($file),
621                                 force => 1);
622                         $form->tmpl_param("page_conflict", 1);
623                         $form->field("editcontent", value => $conflict, force => 1);
624                         $form->field("do", "edit", force => 1);
625                         $form->tmpl_param("page_select", 0);
626                         $form->field(name => "page", type => 'hidden');
627                         $form->field(name => "type", type => 'hidden');
628                         $form->title(sprintf(gettext("editing %s"), $page));
629                         showform($form, \@buttons, $session, $q,
630                                 forcebaseurl => $baseurl);
631                         return;
632                 }
633                 else {
634                         # The trailing question mark tries to avoid broken
635                         # caches and get the most recent version of the page.
636                         redirect($q, "$config{url}/".htmlpage($page)."?updated");
637                 }
638         }
639 } #}}}
640
641 sub cgi_getsession ($) { #{{{
642         my $q=shift;
643
644         eval q{use CGI::Session};
645         error($@) if $@;
646         CGI::Session->name("ikiwiki_session_".encode_utf8($config{wikiname}));
647         
648         my $oldmask=umask(077);
649         my $session = CGI::Session->new("driver:DB_File", $q,
650                 { FileName => "$config{wikistatedir}/sessions.db" });
651         umask($oldmask);
652
653         return $session;
654 } #}}}
655
656 sub cgi_savesession ($) { #{{{
657         my $session=shift;
658
659         # Force session flush with safe umask.
660         my $oldmask=umask(077);
661         $session->flush;
662         umask($oldmask);
663 } #}}}
664
665 sub cgi (;$$) { #{{{
666         my $q=shift;
667         my $session=shift;
668
669         eval q{use CGI};
670         error($@) if $@;
671         $CGI::DISABLE_UPLOADS=1;
672
673         if (! $q) {
674                 binmode(STDIN);
675                 $q=CGI->new;
676                 binmode(STDIN, ":utf8");
677         
678                 run_hooks(cgi => sub { shift->($q) });
679         }
680
681         my $do=$q->param('do');
682         if (! defined $do || ! length $do) {
683                 my $error = $q->cgi_error;
684                 if ($error) {
685                         error("Request not processed: $error");
686                 }
687                 else {
688                         error("\"do\" parameter missing");
689                 }
690         }
691         
692         # Need to lock the wiki before getting a session.
693         lockwiki();
694         loadindex();
695         
696         if (! $session) {
697                 $session=cgi_getsession($q);
698         }
699         
700         # Auth hooks can sign a user in.
701         if ($do ne 'signin' && ! defined $session->param("name")) {
702                 run_hooks(auth => sub {
703                         shift->($q, $session)
704                 });
705                 if (defined $session->param("name")) {
706                         # Make sure whatever user was authed is in the
707                         # userinfo db.
708                         if (! userinfo_get($session->param("name"), "regdate")) {
709                                 userinfo_setall($session->param("name"), {
710                                         email => "",
711                                         password => "",
712                                         regdate => time,
713                                 }) || error("failed adding user");
714                         }
715                 }
716         }
717         
718         if (defined $session->param("name") &&
719             userinfo_get($session->param("name"), "banned")) {
720                 print $q->header(-status => "403 Forbidden");
721                 $session->delete();
722                 print gettext("You are banned.");
723                 cgi_savesession($session);
724         }
725
726         run_hooks(sessioncgi => sub { shift->($q, $session) });
727
728         if ($do eq 'signin') {
729                 cgi_signin($q, $session);
730                 cgi_savesession($session);
731         }
732         elsif ($do eq 'prefs') {
733                 cgi_prefs($q, $session);
734         }
735         elsif ($do eq 'create' || $do eq 'edit') {
736                 cgi_editpage($q, $session);
737         }
738         elsif (defined $session->param("postsignin") || $do eq 'postsignin') {
739                 cgi_postsignin($q, $session);
740         }
741         else {
742                 error("unknown do parameter");
743         }
744 } #}}}
745
746 1