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