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