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