ikiwiki

   1 #!/usr/bin/perl -T
   2
   3 use warnings;
   4 use strict;
   5 use File::Find;
   6 use Memoize;
   7 use File::Spec;
   8 use HTML::Template;
   9
  10 BEGIN {
  11         $blosxom::version="is a proper perl module too much to ask?";
  12         do "/usr/bin/markdown";
  13 }
  14
  15 $ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
  16 my ($srcdir, $templatedir, $destdir, %links, %oldlinks, %oldpagemtime,
  17     %renderedfiles, %pagesources);
  18 my $wiki_link_regexp=qr/\[\[([^\s]+)\]\]/;
  19 my $wiki_file_regexp=qr/(^[-A-Za-z0-9_.:\/+]+$)/;
  20 my $wiki_file_prune_regexp=qr!((^|/).svn/|\.\.|^\.|\/\.|\.html?$)!;
  21 my $verbose=0;
  22 my $wikiname="wiki";
  23 my $default_pagetype=".mdwn";
  24 my $cgi=0;
  25 my $url="";
  26 my $cgiurl="";
  27 my $historyurl="";
  28 my $svn=1;
  29 my $anonok=0;
  30
  31 sub usage { #{{{
  32         die "usage: ikiwiki [options] source templates dest\n";
  33 } #}}}
  34
  35 sub error ($) { #{{{
  36         if ($cgi) {
  37                 print "Content-type: text/html\n\n";
  38                 print misctemplate("Error", "<p>Error: @_</p>");
  39                 exit 1;
  40         }
  41         else {
  42                 die @_;
  43         }
  44 } #}}}
  45
  46 sub debug ($) { #{{{
  47         if (! $cgi) {
  48                 print "@_\n" if $verbose;
  49         }
  50         else {
  51                 print STDERR "@_\n" if $verbose;
  52         }
  53 } #}}}
  54
  55 sub mtime ($) { #{{{
  56         my $page=shift;
  57
  58         return (stat($page))[9];
  59 } #}}}
  60
  61 sub possibly_foolish_untaint ($) { #{{{
  62         my $tainted=shift;
  63         my ($untainted)=$tainted=~/(.*)/;
  64         return $untainted;
  65 } #}}}
  66
  67 sub basename ($) { #{{{
  68         my $file=shift;
  69
  70         $file=~s!.*/!!;
  71         return $file;
  72 } #}}}
  73
  74 sub dirname ($) { #{{{
  75         my $file=shift;
  76
  77         $file=~s!/?[^/]+$!!;
  78         return $file;
  79 } #}}}
  80
  81 sub pagetype ($) { #{{{
  82         my $page=shift;
  83
  84         if ($page =~ /\.mdwn$/) {
  85                 return ".mdwn";
  86         }
  87         else {
  88                 return "unknown";
  89         }
  90 } #}}}
  91
  92 sub pagename ($) { #{{{
  93         my $file=shift;
  94
  95         my $type=pagetype($file);
  96         my $page=$file;
  97         $page=~s/\Q$type\E*$// unless $type eq 'unknown';
  98         return $page;
  99 } #}}}
 100
 101 sub htmlpage ($) { #{{{
 102         my $page=shift;
 103
 104         return $page.".html";
 105 } #}}}
 106
 107 sub readfile ($) { #{{{
 108         my $file=shift;
 109
 110         local $/=undef;
 111         open (IN, "$file") || error("failed to read $file: $!");
 112         my $ret=<IN>;
 113         close IN;
 114         return $ret;
 115 } #}}}
 116
 117 sub writefile ($$) { #{{{
 118         my $file=shift;
 119         my $content=shift;
 120
 121         my $dir=dirname($file);
 122         if (! -d $dir) {
 123                 my $d="";
 124                 foreach my $s (split(m!/+!, $dir)) {
 125                         $d.="$s/";
 126                         if (! -d $d) {
 127                                 mkdir($d) || error("failed to create directory $d: $!");
 128                         }
 129                 }
 130         }
 131
 132         open (OUT, ">$file") || error("failed to write $file: $!");
 133         print OUT $content;
 134         close OUT;
 135 } #}}}
 136
 137 sub findlinks ($) { #{{{
 138         my $content=shift;
 139
 140         my @links;
 141         while ($content =~ /$wiki_link_regexp/g) {
 142                 push @links, lc($1);
 143         }
 144         return @links;
 145 } #}}}
 146
 147 # Given a page and the text of a link on the page, determine which existing
 148 # page that link best points to. Prefers pages under a subdirectory with
 149 # the same name as the source page, failing that goes down the directory tree
 150 # to the base looking for matching pages.
 151 sub bestlink ($$) { #{{{
 152         my $page=shift;
 153         my $link=lc(shift);
 154
 155         my $cwd=$page;
 156         do {
 157                 my $l=$cwd;
 158                 $l.="/" if length $l;
 159                 $l.=$link;
 160
 161                 if (exists $links{$l}) {
 162                         #debug("for $page, \"$link\", use $l");
 163                         return $l;
 164                 }
 165         } while $cwd=~s!/?[^/]+$!!;
 166
 167         #print STDERR "warning: page $page, broken link: $link\n";
 168         return "";
 169 } #}}}
 170
 171 sub isinlinableimage ($) { #{{{
 172         my $file=shift;
 173
 174         $file=~/\.(png|gif|jpg|jpeg)$/;
 175 } #}}}
 176
 177 sub htmllink { #{{{
 178         my $page=shift;
 179         my $link=shift;
 180         my $noimagelink=shift;
 181
 182         my $bestlink=bestlink($page, $link);
 183
 184         return $link if $page eq $bestlink;
 185
 186         # TODO BUG: %renderedfiles may not have it, if the linked to page
 187         # was also added and isn't yet rendered! Note that this bug is
 188         # masked by the bug mentioned below that makes all new files
 189         # be rendered twice.
 190         if (! grep { $_ eq $bestlink } values %renderedfiles) {
 191                 $bestlink=htmlpage($bestlink);
 192         }
 193         if (! grep { $_ eq $bestlink } values %renderedfiles) {
 194                 return "<a href=\"$cgiurl?do=create&page=$link&from=$page\">?</a>$link"
 195         }
 196
 197         $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
 198
 199         if (! $noimagelink && isinlinableimage($bestlink)) {
 200                 return "<img src=\"$bestlink\">";
 201         }
 202         return "<a href=\"$bestlink\">$link</a>";
 203 } #}}}
 204
 205 sub linkify ($$) { #{{{
 206         my $content=shift;
 207         my $file=shift;
 208
 209         $content =~ s/$wiki_link_regexp/htmllink(pagename($file), $1)/eg;
 210
 211         return $content;
 212 } #}}}
 213
 214 sub htmlize ($$) { #{{{
 215         my $type=shift;
 216         my $content=shift;
 217
 218         if ($type eq '.mdwn') {
 219                 return Markdown::Markdown($content);
 220         }
 221         else {
 222                 error("htmlization of $type not supported");
 223         }
 224 } #}}}
 225
 226 sub backlinks ($) { #{{{
 227         my $page=shift;
 228
 229         my @links;
 230         foreach my $p (keys %links) {
 231                 next if bestlink($page, $p) eq $page;
 232                 if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
 233                         my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
 234
 235                         # Trim common dir prefixes from both pages.
 236                         my $p_trimmed=$p;
 237                         my $page_trimmed=$page;
 238                         my $dir;
 239                         1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
 240                                 defined $dir &&
 241                                 $p_trimmed=~s/^\Q$dir\E// &&
 242                                 $page_trimmed=~s/^\Q$dir\E//;
 243
 244                         push @links, { url => $href, page => $p_trimmed };
 245                 }
 246         }
 247
 248         return sort { $a->{page} cmp $b->{page} } @links;
 249 } #}}}
 250
 251 sub parentlinks ($) { #{{{
 252         my $page=shift;
 253
 254         my @ret;
 255         my $pagelink="";
 256         my $path="";
 257         my $skip=1;
 258         foreach my $dir (reverse split("/", $page)) {
 259                 if (! $skip) {
 260                         unshift @ret, { url => "$path$dir.html", page => $dir };
 261                 }
 262                 else {
 263                         $skip=0;
 264                 }
 265                 $path.="../";
 266         }
 267         unshift @ret, { url => $path , page => $wikiname };
 268         return @ret;
 269 } #}}}
 270
 271 sub indexlink () { #{{{
 272         return "<a href=\"$url\">$wikiname</a>";
 273 } #}}}
 274
 275 sub finalize ($$) { #{{{
 276         my $content=shift;
 277         my $page=shift;
 278
 279         my $title=basename($page);
 280         $title=~s/_/ /g;
 281
 282         my $template=HTML::Template->new(blind_cache => 1,
 283                 filename => "$templatedir/page.tmpl");
 284
 285         if (length $cgiurl) {
 286                 $template->param(editurl => "$cgiurl?do=edit&page=$page");
 287                 if ($svn) {
 288                         $template->param(recentchangesurl => "$cgiurl?do=recentchanges");
 289                 }
 290         }
 291
 292         if (length $historyurl) {
 293                 my $u=$historyurl;
 294                 $u=~s/\[\[\]\]/$pagesources{$page}/g;
 295                 $template->param(historyurl => $u);
 296         }
 297
 298         $template->param(
 299                 title => $title,
 300                 wikiname => $wikiname,
 301                 parentlinks => [parentlinks($page)],
 302                 content => $content,
 303                 backlinks => [backlinks($page)],
 304         );
 305
 306         return $template->output;
 307 } #}}}
 308
 309 # Important security check. Make sure to call this before saving any files
 310 # to the source directory.
 311 sub check_overwrite ($$) { #{{{
 312         my $dest=shift;
 313         my $src=shift;
 314
 315         if (! exists $renderedfiles{$src} && -e $dest) {
 316                 error("$dest exists and was not rendered from $src before, not overwriting");
 317         }
 318 } #}}}
 319
 320 sub render ($) { #{{{
 321         my $file=shift;
 322
 323         my $type=pagetype($file);
 324         my $content=readfile("$srcdir/$file");
 325         if ($type ne 'unknown') {
 326                 my $page=pagename($file);
 327
 328                 $links{$page}=[findlinks($content)];
 329
 330                 $content=linkify($content, $file);
 331                 $content=htmlize($type, $content);
 332                 $content=finalize($content, $page);
 333
 334                 check_overwrite("$destdir/".htmlpage($page), $page);
 335                 writefile("$destdir/".htmlpage($page), $content);
 336                 $oldpagemtime{$page}=time;
 337                 $renderedfiles{$page}=htmlpage($page);
 338         }
 339         else {
 340                 $links{$file}=[];
 341                 check_overwrite("$destdir/$file", $file);
 342                 writefile("$destdir/$file", $content);
 343                 $oldpagemtime{$file}=time;
 344                 $renderedfiles{$file}=$file;
 345         }
 346 } #}}}
 347
 348 sub loadindex () { #{{{
 349         open (IN, "$srcdir/.ikiwiki/index") || return;
 350         while (<IN>) {
 351                 $_=possibly_foolish_untaint($_);
 352                 chomp;
 353                 my ($mtime, $file, $rendered, @links)=split(' ', $_);
 354                 my $page=pagename($file);
 355                 $pagesources{$page}=$file;
 356                 $oldpagemtime{$page}=$mtime;
 357                 $oldlinks{$page}=[@links];
 358                 $links{$page}=[@links];
 359                 $renderedfiles{$page}=$rendered;
 360         }
 361         close IN;
 362 } #}}}
 363
 364 sub saveindex () { #{{{
 365         if (! -d "$srcdir/.ikiwiki") {
 366                 mkdir("$srcdir/.ikiwiki");
 367         }
 368         open (OUT, ">$srcdir/.ikiwiki/index") || error("cannot write to index: $!");
 369         foreach my $page (keys %oldpagemtime) {
 370                 print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ".
 371                         join(" ", @{$links{$page}})."\n"
 372                                 if $oldpagemtime{$page};
 373         }
 374         close OUT;
 375 } #}}}
 376
 377 sub rcs_update () { #{{{
 378         if (-d "$srcdir/.svn") {
 379                 if (system("svn", "update", "--quiet", $srcdir) != 0) {
 380                         warn("svn update failed\n");
 381                 }
 382         }
 383 } #}}}
 384
 385 sub rcs_commit ($) { #{{{
 386         my $message=shift;
 387
 388         if (-d "$srcdir/.svn") {
 389                 if (system("svn", "commit", "--quiet", "-m",
 390                            possibly_foolish_untaint($message), $srcdir) != 0) {
 391                         warn("svn commit failed\n");
 392                 }
 393         }
 394 } #}}}
 395
 396 sub rcs_add ($) { #{{{
 397         my $file=shift;
 398
 399         if (-d "$srcdir/.svn") {
 400                 my $parent=dirname($file);
 401                 while (! -d "$srcdir/$parent/.svn") {
 402                         $file=$parent;
 403                         $parent=dirname($file);
 404                 }
 405
 406                 if (system("svn", "add", "--quiet", "$srcdir/$file") != 0) {
 407                         warn("svn add failed\n");
 408                 }
 409         }
 410 } #}}}
 411
 412 sub rcs_recentchanges ($) { #{{{
 413         my $num=shift;
 414         my @ret;
 415
 416         eval q{use Date::Parse};
 417         eval q{use Time::Duration};
 418
 419         if (-d "$srcdir/.svn") {
 420                 my $info=`LANG=C svn info $srcdir`;
 421                 my ($svn_url)=$info=~/^URL: (.*)$/m;
 422
 423                 # FIXME: currently assumes that the wiki is somewhere
 424                 # under trunk in svn, doesn't support other layouts.
 425                 my ($svn_base)=$svn_url=~m!(/trunk(?:/.*)?)$!;
 426
 427                 my $div=qr/^--------------------+$/;
 428                 my $infoline=qr/^r(\d+)\s+\|\s+([^\s]+)\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
 429                 my $state='start';
 430                 my ($rev, $user, $when, @pages, @message);
 431                 foreach (`LANG=C svn log -v '$svn_url'`) {
 432                         chomp;
 433                         if ($state eq 'start' && /$div/) {
 434                                 $state='header';
 435                         }
 436                         elsif ($state eq 'header' && /$infoline/) {
 437                                 $rev=$1;
 438                                 $user=$2;
 439                                 $when=concise(ago(time - str2time($3)));
 440                         }
 441                         elsif ($state eq 'header' && /^\s+[A-Z]\s+\Q$svn_base\E\/(.+)$/) {
 442                                 push @pages, { link => htmllink("", pagename($1), 1) }
 443                                         if length $1;
 444                         }
 445                         elsif ($state eq 'header' && /^$/) {
 446                                 $state='body';
 447                         }
 448                         elsif ($state eq 'body' && /$div/) {
 449                                 if (defined $message[0] &&
 450                                     $message[0]=~/^web commit by (\w+)(.*)/) {
 451                                         $user="$1 (web)";
 452                                         $message[0]=$2;
 453                                 }
 454
 455                                 push @ret, { rev => $rev, user => $user,
 456                                         when => $when, message => [@message],
 457                                         pages => [@pages] } if @pages;
 458                                 return @ret if @ret >= $num;
 459
 460                                 $state='header';
 461                                 $rev=$user=$when=undef;
 462                                 @pages=@message=();
 463                         }
 464                         elsif ($state eq 'body') {
 465                                 push @message, {line => $_},
 466                         }
 467                 }
 468         }
 469
 470         return @ret;
 471 } #}}}
 472
 473 sub prune ($) { #{{{
 474         my $file=shift;
 475
 476         unlink($file);
 477         my $dir=dirname($file);
 478         while (rmdir($dir)) {
 479                 $dir=dirname($dir);
 480         }
 481 } #}}}
 482
 483 sub refresh () { #{{{
 484         # Find existing pages.
 485         my %exists;
 486         my @files;
 487         find({
 488                 no_chdir => 1,
 489                 wanted => sub {
 490                         if (/$wiki_file_prune_regexp/) {
 491                                 $File::Find::prune=1;
 492                         }
 493                         elsif (! -d $_) {
 494                                 my ($f)=/$wiki_file_regexp/; # untaint
 495                                 if (! defined $f) {
 496                                         warn("skipping bad filename $_\n");
 497                                 }
 498                                 else {
 499                                         $f=~s/^\Q$srcdir\E\/?//;
 500                                         push @files, $f;
 501                                         $exists{pagename($f)}=1;
 502                                 }
 503                         }
 504                 },
 505         }, $srcdir);
 506
 507         my %rendered;
 508
 509         # check for added or removed pages
 510         my @add;
 511         foreach my $file (@files) {
 512                 my $page=pagename($file);
 513                 if (! $oldpagemtime{$page}) {
 514                         debug("new page $page");
 515                         push @add, $file;
 516                         $links{$page}=[];
 517                         $pagesources{$page}=$file;
 518                 }
 519         }
 520         my @del;
 521         foreach my $page (keys %oldpagemtime) {
 522                 if (! $exists{$page}) {
 523                         debug("removing old page $page");
 524                         push @del, $renderedfiles{$page};
 525                         prune($destdir."/".$renderedfiles{$page});
 526                         delete $renderedfiles{$page};
 527                         $oldpagemtime{$page}=0;
 528                         delete $pagesources{$page};
 529                 }
 530         }
 531
 532         # render any updated files
 533         foreach my $file (@files) {
 534                 my $page=pagename($file);
 535
 536                 if (! exists $oldpagemtime{$page} ||
 537                     mtime("$srcdir/$file") > $oldpagemtime{$page}) {
 538                         debug("rendering changed file $file");
 539                         render($file);
 540                         $rendered{$file}=1;
 541                 }
 542         }
 543
 544         # if any files were added or removed, check to see if each page
 545         # needs an update due to linking to them
 546         # TODO: inefficient; pages may get rendered above and again here;
 547         # problem is the bestlink may have changed and we won't know until
 548         # now
 549         if (@add || @del) {
 550 FILE:           foreach my $file (@files) {
 551                         my $page=pagename($file);
 552                         foreach my $f (@add, @del) {
 553                                 my $p=pagename($f);
 554                                 foreach my $link (@{$links{$page}}) {
 555                                         if (bestlink($page, $link) eq $p) {
 556                                                 debug("rendering $file, which links to $p");
 557                                                 render($file);
 558                                                 $rendered{$file}=1;
 559                                                 next FILE;
 560                                         }
 561                                 }
 562                         }
 563                 }
 564         }
 565
 566         # handle backlinks; if a page has added/removed links, update the
 567         # pages it links to
 568         # TODO: inefficient; pages may get rendered above and again here;
 569         # problem is the backlinks could be wrong in the first pass render
 570         # above
 571         if (%rendered) {
 572                 my %linkchanged;
 573                 foreach my $file (keys %rendered, @del) {
 574                         my $page=pagename($file);
 575                         if (exists $links{$page}) {
 576                                 foreach my $link (@{$links{$page}}) {
 577                                         $link=bestlink($page, $link);
 578                                         if (length $link &&
 579                                             ! exists $oldlinks{$page} ||
 580                                             ! grep { $_ eq $link } @{$oldlinks{$page}}) {
 581                                                 $linkchanged{$link}=1;
 582                                         }
 583                                 }
 584                         }
 585                         if (exists $oldlinks{$page}) {
 586                                 foreach my $link (@{$oldlinks{$page}}) {
 587                                         $link=bestlink($page, $link);
 588                                         if (length $link &&
 589                                             ! exists $links{$page} ||
 590                                             ! grep { $_ eq $link } @{$links{$page}}) {
 591                                                 $linkchanged{$link}=1;
 592                                         }
 593                                 }
 594                         }
 595                 }
 596                 foreach my $link (keys %linkchanged) {
 597                         my $linkfile=$pagesources{$link};
 598                         if (defined $linkfile) {
 599                                 debug("rendering $linkfile, to update its backlinks");
 600                                 render($linkfile);
 601                         }
 602                 }
 603         }
 604 } #}}}
 605
 606 # Generates a C wrapper program for running ikiwiki in a specific way.
 607 # The wrapper may be safely made suid.
 608 sub gen_wrapper ($$) { #{{{
 609         my ($svn, $rebuild)=@_;
 610
 611         eval q{use Cwd 'abs_path'};
 612         $srcdir=abs_path($srcdir);
 613         $destdir=abs_path($destdir);
 614         my $this=abs_path($0);
 615         if (! -x $this) {
 616                 error("$this doesn't seem to be executable");
 617         }
 618
 619         my @params=($srcdir, $templatedir, $destdir, "--wikiname=$wikiname");
 620         push @params, "--verbose" if $verbose;
 621         push @params, "--rebuild" if $rebuild;
 622         push @params, "--nosvn" if !$svn;
 623         push @params, "--cgi" if $cgi;
 624         push @params, "--url=$url" if $url;
 625         push @params, "--cgiurl=$cgiurl" if $cgiurl;
 626         push @params, "--historyurl=$historyurl" if $historyurl;
 627         push @params, "--anonok" if $anonok;
 628         my $params=join(" ", @params);
 629         my $call='';
 630         foreach my $p ($this, $this, @params) {
 631                 $call.=qq{"$p", };
 632         }
 633         $call.="NULL";
 634
 635         my @envsave;
 636         push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
 637                        CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
 638                        HTTP_COOKIE} if $cgi;
 639         my $envsave="";
 640         foreach my $var (@envsave) {
 641                 $envsave.=<<"EOF"
 642         if ((s=getenv("$var")))
 643                 asprintf(&newenviron[i++], "%s=%s", "$var", s);
 644 EOF
 645         }
 646
 647         open(OUT, ">ikiwiki-wrap.c") || error("failed to write ikiwiki-wrap.c: $!");;
 648         print OUT <<"EOF";
 649 /* A wrapper for ikiwiki, can be safely made suid. */
 650 #define _GNU_SOURCE
 651 #include <stdio.h>
 652 #include <unistd.h>
 653 #include <stdlib.h>
 654 #include <string.h>
 655
 656 extern char **environ;
 657
 658 int main (int argc, char **argv) {
 659         /* Sanitize environment. */
 660         char *s;
 661         char *newenviron[$#envsave+3];
 662         int i=0;
 663 $envsave
 664         newenviron[i++]="HOME=$ENV{HOME}";
 665         newenviron[i]=NULL;
 666         environ=newenviron;
 667
 668         if (argc == 2 && strcmp(argv[1], "--params") == 0) {
 669                 printf("$params\\n");
 670                 exit(0);
 671         }
 672
 673         execl($call);
 674         perror("failed to run $this");
 675         exit(1);
 676 }
 677 EOF
 678         close OUT;
 679         if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) {
 680                 error("failed to compile ikiwiki-wrap.c");
 681         }
 682         unlink("ikiwiki-wrap.c");
 683         print "successfully generated ikiwiki-wrap\n";
 684         exit 0;
 685 } #}}}
 686
 687 sub misctemplate ($$) { #{{{
 688         my $title=shift;
 689         my $pagebody=shift;
 690
 691         my $template=HTML::Template->new(
 692                 filename => "$templatedir/misc.tmpl"
 693         );
 694         $template->param(
 695                 title => $title,
 696                 indexlink => indexlink(),
 697                 wikiname => $wikiname,
 698                 pagebody => $pagebody,
 699         );
 700         return $template->output;
 701 }#}}}
 702
 703 sub cgi_recentchanges ($) { #{{{
 704         my $q=shift;
 705
 706         my $template=HTML::Template->new(
 707                 filename => "$templatedir/recentchanges.tmpl"
 708         );
 709         $template->param(
 710                 title => "RecentChanges",
 711                 indexlink => indexlink(),
 712                 wikiname => $wikiname,
 713                 changelog => [rcs_recentchanges(100)],
 714         );
 715         print $q->header, $template->output;
 716 } #}}}
 717
 718 sub userinfo_get ($$) { #{{
 719         my $user=shift;
 720         my $field=shift;
 721
 722         eval q{use Storable};
 723         my $userdata=eval{ Storable::lock_retrieve("$srcdir/.ikiwiki/userdb") };
 724         if (! defined $userdata || ! ref $userdata ||
 725             ! exists $userdata->{$user} || ! ref $userdata->{$user}) {
 726                 return "";
 727         }
 728         return $userdata->{$user}->{$field};
 729 } #}}
 730
 731 sub userinfo_set ($$) { #{{
 732         my $user=shift;
 733         my $info=shift;
 734
 735         eval q{use Storable};
 736         my $userdata=eval{ Storable::lock_retrieve("$srcdir/.ikiwiki/userdb") };
 737         if (! defined $userdata || ! ref $userdata) {
 738                 $userdata={};
 739         }
 740         $userdata->{$user}=$info;
 741         my $oldmask=umask(077);
 742         my $ret=Storable::lock_store($userdata, "$srcdir/.ikiwiki/userdb");
 743         umask($oldmask);
 744         return $ret;
 745 } #}}
 746
 747 sub cgi_signin ($$) { #{{{
 748         my $q=shift;
 749         my $session=shift;
 750
 751         eval q{use CGI::FormBuilder};
 752         my $form = CGI::FormBuilder->new(
 753                 title => "$wikiname signin",
 754                 fields => [qw(do page name password confirm_password email)],
 755                 header => 1,
 756                 method => 'POST',
 757                 validate => {
 758                         confirm_password => {
 759                                 perl => q{eq $form->field("password")},
 760                         },
 761                         email => 'EMAIL',
 762                 },
 763                 required => 'NONE',
 764                 javascript => 0,
 765                 params => $q,
 766                 action => $q->request_uri,
 767                 header => 0,
 768                 template => (-e "$templatedir/signin.tmpl" ? "$templatedir/signin.tmpl" : "")
 769         );
 770
 771         $form->field(name => "name", required => 0);
 772         $form->field(name => "do", type => "hidden");
 773         $form->field(name => "page", type => "hidden");
 774         $form->field(name => "password", type => "password", required => 0);
 775         $form->field(name => "confirm_password", type => "password", required => 0);
 776         $form->field(name => "email", required => 0);
 777         if ($q->param("do") ne "signin") {
 778                 $form->text("You need to log in before you can edit pages.");
 779         }
 780
 781         if ($form->submitted) {
 782                 # Set required fields based on how form was submitted.
 783                 my %required=(
 784                         "Login" => [qw(name password)],
 785                         "Register" => [qw(name password confirm_password email)],
 786                         "Mail Password" => [qw(name)],
 787                 );
 788                 foreach my $opt (@{$required{$form->submitted}}) {
 789                         $form->field(name => $opt, required => 1);
 790                 }
 791
 792                 # Validate password differently depending on how
 793                 # form was submitted.
 794                 if ($form->submitted eq 'Login') {
 795                         $form->field(
 796                                 name => "password",
 797                                 validate => sub {
 798                                         length $form->field("name") &&
 799                                         shift eq userinfo_get($form->field("name"), 'password');
 800                                 },
 801                         );
 802                         $form->field(name => "name", validate => '/^\w+$/');
 803                 }
 804                 else {
 805                         $form->field(name => "password", validate => 'VALUE');
 806                 }
 807                 # And make sure the entered name exists when logging
 808                 # in or sending email, and does not when registering.
 809                 if ($form->submitted eq 'Register') {
 810                         $form->field(
 811                                 name => "name",
 812                                 validate => sub {
 813                                         my $name=shift;
 814                                         length $name &&
 815                                         ! userinfo_get($name, "regdate");
 816                                 },
 817                         );
 818                 }
 819                 else {
 820                         $form->field(
 821                                 name => "name",
 822                                 validate => sub {
 823                                         my $name=shift;
 824                                         length $name &&
 825                                         userinfo_get($name, "regdate");
 826                                 },
 827                         );
 828                 }
 829         }
 830         else {
 831                 # First time settings.
 832                 $form->field(name => "name", comment => "use FirstnameLastName");
 833                 $form->field(name => "confirm_password", comment => "(only needed");
 834                 $form->field(name => "email",            comment => "for registration)");
 835                 if ($session->param("name")) {
 836                         $form->field(name => "name", value => $session->param("name"));
 837                 }
 838         }
 839
 840         if ($form->submitted && $form->validate) {
 841                 if ($form->submitted eq 'Login') {
 842                         $session->param("name", $form->field("name"));
 843                         if (defined $form->field("do") &&
 844                             $form->field("do") ne 'signin') {
 845                                 print $q->redirect(
 846                                         "$cgiurl?do=".$form->field("do").
 847                                         "&page=".$form->field("page"));
 848                         }
 849                         else {
 850                                 print $q->redirect($url);
 851                         }
 852                 }
 853                 elsif ($form->submitted eq 'Register') {
 854                         my $user_name=$form->field('name');
 855                         if (userinfo_set($user_name, {
 856                                            'email' => $form->field('email'),
 857                                            'password' => $form->field('password'),
 858                                            'regdate' => time
 859                                          })) {
 860                                 $form->field(name => "confirm_password", type => "hidden");
 861                                 $form->field(name => "email", type => "hidden");
 862                                 $form->text("Registration successful. Now you can Login.");
 863                                 print $session->header();
 864                                 print misctemplate($form->title, $form->render(submit => ["Login"]));
 865                         }
 866                         else {
 867                                 error("Error saving registration.");
 868                         }
 869                 }
 870                 elsif ($form->submitted eq 'Mail Password') {
 871                         my $user_name=$form->field("name");
 872                         my $template=HTML::Template->new(
 873                                 filename => "$templatedir/passwordmail.tmpl"
 874                         );
 875                         $template->param(
 876                                 user_name => $user_name,
 877                                 user_password => userinfo_get($user_name, "password"),
 878                                 wikiurl => $url,
 879                                 wikiname => $wikiname,
 880                                 REMOTE_ADDR => $ENV{REMOTE_ADDR},
 881                         );
 882
 883                         eval q{use Mail::Sendmail};
 884                         my ($fromhost) = $cgiurl =~ m!/([^/]+)!;
 885                         print STDERR "$< $> >>> $cgiurl ".(getpwuid($>))[0]."@".$fromhost."\n";
 886                         sendmail(
 887                                 To => userinfo_get($user_name, "email"),
 888                                 From => "$wikiname admin <".(getpwuid($>))[0]."@".$fromhost.">",
 889                                 Subject => "$wikiname information",
 890                                 Message => $template->output,
 891                         ) or error("Failed to send mail");
 892
 893                         $form->text("Your password has been emailed to you.");
 894                         $form->field(name => "name", required => 0);
 895                         print $session->header();
 896                         print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
 897                 }
 898         }
 899         else {
 900                 print $session->header();
 901                 print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
 902         }
 903 } #}}}
 904
 905 sub cgi_editpage ($$) { #{{{
 906         my $q=shift;
 907         my $session=shift;
 908
 909         eval q{use CGI::FormBuilder};
 910         my $form = CGI::FormBuilder->new(
 911                 fields => [qw(do from page content comments)],
 912                 header => 1,
 913                 method => 'POST',
 914                 validate => {},
 915                 required => [qw{}],
 916                 javascript => 0,
 917                 params => $q,
 918                 action => $q->request_uri,
 919                 table => 0,
 920                 template => "$templatedir/editpage.tmpl"
 921         );
 922
 923         my ($page)=$form->param('page')=~/$wiki_file_regexp/;
 924         if (! defined $page || ! length $page || $page ne $q->param('page') ||
 925             $page=~/$wiki_file_prune_regexp/ || $page=~/^\//) {
 926                 error("bad page name");
 927         }
 928         $page=lc($page);
 929
 930         $form->field(name => "do", type => 'hidden');
 931         $form->field(name => "from", type => 'hidden');
 932         $form->field(name => "page", value => "$page", force => 1);
 933         $form->field(name => "comments", type => "text", size => 80);
 934         $form->field(name => "content", type => "textarea", rows => 20,
 935                 cols => 80);
 936
 937         if (! $form->submitted || ! $form->validate) {
 938                 if ($form->field("do") eq "create") {
 939                         if (exists $pagesources{lc($page)}) {
 940                                 # hmm, someone else made the page in the
 941                                 # meantime?
 942                                 print $q->redirect("$url/".htmlpage($page));
 943                                 return;
 944                         }
 945
 946                         my @page_locs;
 947                         my ($from)=$form->param('from')=~/$wiki_file_regexp/;
 948                         if (! defined $from || ! length $from ||
 949                             $from ne $form->param('from') ||
 950                             $from=~/$wiki_file_prune_regexp/ || $from=~/^\//) {
 951                                 @page_locs=$page;
 952                         }
 953                         else {
 954                                 my $dir=$from."/";
 955                                 $dir=~s![^/]+/$!!;
 956                                 push @page_locs, $dir.$page;
 957                                 push @page_locs, "$from/$page";
 958                                 while (length $dir) {
 959                                         $dir=~s![^/]+/$!!;
 960                                         push @page_locs, $dir.$page;
 961                                 }
 962                         }
 963
 964                         $form->tmpl_param("page_select", 1);
 965                         $form->field(name => "page", type => 'select',
 966                                 options => \@page_locs);
 967                         $form->title("creating $page");
 968                 }
 969                 elsif ($form->field("do") eq "edit") {
 970                         my $content="";
 971                         if (exists $pagesources{lc($page)}) {
 972                                 $content=readfile("$srcdir/$pagesources{lc($page)}");
 973                                 $content=~s/\n/\r\n/g;
 974                         }
 975                         $form->tmpl_param("page_select", 0);
 976                         $form->field(name => "content", value => $content,
 977                                 force => 1);
 978                         $form->field(name => "page", type => 'hidden');
 979                         $form->title("editing $page");
 980                 }
 981
 982                 $form->tmpl_param("can_commit", $svn);
 983                 $form->tmpl_param("indexlink", indexlink());
 984                 print $form->render(submit => ["Save Page"]);
 985         }
 986         else {
 987                 # save page
 988                 my $file=$page.$default_pagetype;
 989                 my $newfile=1;
 990                 if (exists $pagesources{lc($page)}) {
 991                         $file=$pagesources{lc($page)};
 992                         $newfile=0;
 993                 }
 994
 995                 my $content=$form->field('content');
 996                 $content=~s/\r\n/\n/g;
 997                 $content=~s/\r/\n/g;
 998                 writefile("$srcdir/$file", $content);
 999
1000                 my $message="web commit ";
1001                 if ($session->param("name")) {
1002                         $message.="by ".$session->param("name");
1003                 }
1004                 else {
1005                         $message.="from $ENV{REMOTE_ADDR}";
1006                 }
1007                 if (defined $form->field('comments') &&
1008                     length $form->field('comments')) {
1009                         $message.=": ".$form->field('comments');
1010                 }
1011
1012                 if ($svn) {
1013                         if ($newfile) {
1014                                 rcs_add($file);
1015                         }
1016                         # presumably the commit will trigger an update
1017                         # of the wiki
1018                         rcs_commit($message);
1019                 }
1020                 else {
1021                         refresh();
1022                 }
1023
1024                 print $q->redirect("$url/".htmlpage($page));
1025         }
1026 } #}}}
1027
1028 sub cgi () { #{{{
1029         eval q{use CGI};
1030         eval q{use CGI::Session};
1031
1032         my $q=CGI->new;
1033
1034         my $do=$q->param('do');
1035         if (! defined $do || ! length $do) {
1036                 error("\"do\" parameter missing");
1037         }
1038
1039         # This does not need a session.
1040         if ($do eq 'recentchanges') {
1041                 cgi_recentchanges($q);
1042                 return;
1043         }
1044
1045         CGI::Session->name("ikiwiki_session");
1046
1047         my $oldmask=umask(077);
1048         my $session = CGI::Session->new("driver:db_file", $q,
1049                 { FileName => "$srcdir/.ikiwiki/sessions.db" });
1050         umask($oldmask);
1051
1052         # Everything below this point needs the user to be signed in.
1053         if ((! $anonok && ! defined $session->param("name") ||
1054                 ! userinfo_get($session->param("name"), "regdate")) || $do eq 'signin') {
1055                 cgi_signin($q, $session);
1056
1057                 # Force session flush with safe umask.
1058                 my $oldmask=umask(077);
1059                 $session->flush;
1060                 umask($oldmask);
1061
1062                 return;
1063         }
1064
1065         if ($do eq 'create' || $do eq 'edit') {
1066                 cgi_editpage($q, $session);
1067         }
1068         else {
1069                 error("unknown do parameter");
1070         }
1071 } #}}}
1072
1073 # main {{{
1074 my $rebuild=0;
1075 my $wrapper=0;
1076 if (grep /^-/, @ARGV) {
1077         eval {use Getopt::Long};
1078         GetOptions(
1079                 "wikiname=s" => \$wikiname,
1080                 "verbose|v" => \$verbose,
1081                 "rebuild" => \$rebuild,
1082                 "wrapper" => \$wrapper,
1083                 "svn!" => \$svn,
1084                 "anonok!" => \$anonok,
1085                 "cgi" => \$cgi,
1086                 "url=s" => \$url,
1087                 "cgiurl=s" => \$cgiurl,
1088                 "historyurl=s" => \$historyurl,
1089         ) || usage();
1090 }
1091 usage() unless @ARGV == 3;
1092 ($srcdir) = possibly_foolish_untaint(shift);
1093 ($templatedir) = possibly_foolish_untaint(shift);
1094 ($destdir) = possibly_foolish_untaint(shift);
1095
1096 if ($cgi && ! length $url) {
1097         error("Must specify url to wiki with --url when using --cgi");
1098 }
1099
1100 gen_wrapper($svn, $rebuild) if $wrapper;
1101 memoize('pagename');
1102 memoize('bestlink');
1103 loadindex() unless $rebuild;
1104 if ($cgi) {
1105         cgi();
1106 }
1107 else {
1108         rcs_update() if $svn;
1109         refresh();
1110         saveindex();
1111 }
1112 #}}}