11 $blosxom::version="is a proper perl module too much to ask?";
12 do "/usr/bin/markdown";
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?$)!;
23 my $default_pagetype=".mdwn";
32 die "usage: ikiwiki [options] source templates dest\n";
37 print "Content-type: text/html\n\n";
38 print misctemplate("Error", "<p>Error: @_</p>");
48 print "@_\n" if $verbose;
51 print STDERR "@_\n" if $verbose;
58 return (stat($page))[9];
61 sub possibly_foolish_untaint ($) { #{{{
63 my ($untainted)=$tainted=~/(.*)/;
67 sub basename ($) { #{{{
74 sub dirname ($) { #{{{
81 sub pagetype ($) { #{{{
84 if ($page =~ /\.mdwn$/) {
92 sub pagename ($) { #{{{
95 my $type=pagetype($file);
97 $page=~s/\Q$type\E*$// unless $type eq 'unknown';
101 sub htmlpage ($) { #{{{
104 return $page.".html";
107 sub readfile ($) { #{{{
111 open (IN, "$file") || error("failed to read $file: $!");
117 sub writefile ($$) { #{{{
121 my $dir=dirname($file);
124 foreach my $s (split(m!/+!, $dir)) {
127 mkdir($d) || error("failed to create directory $d: $!");
132 open (OUT, ">$file") || error("failed to write $file: $!");
137 sub findlinks ($) { #{{{
141 while ($content =~ /$wiki_link_regexp/g) {
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 ($$) { #{{{
158 $l.="/" if length $l;
161 if (exists $links{$l}) {
162 #debug("for $page, \"$link\", use $l");
165 } while $cwd=~s!/?[^/]+$!!;
167 #print STDERR "warning: page $page, broken link: $link\n";
171 sub isinlinableimage ($) { #{{{
174 $file=~/\.(png|gif|jpg|jpeg)$/;
180 my $noimagelink=shift;
182 my $bestlink=bestlink($page, $link);
184 return $link if $page eq $bestlink;
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
190 if (! grep { $_ eq $bestlink } values %renderedfiles) {
191 $bestlink=htmlpage($bestlink);
193 if (! grep { $_ eq $bestlink } values %renderedfiles) {
194 return "<a href=\"$cgiurl?do=create&page=$link&from=$page\">?</a>$link"
197 $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
199 if (! $noimagelink && isinlinableimage($bestlink)) {
200 return "<img src=\"$bestlink\">";
202 return "<a href=\"$bestlink\">$link</a>";
205 sub linkify ($$) { #{{{
209 $content =~ s/$wiki_link_regexp/htmllink(pagename($file), $1)/eg;
214 sub htmlize ($$) { #{{{
218 if ($type eq '.mdwn') {
219 return Markdown::Markdown($content);
222 error("htmlization of $type not supported");
226 sub backlinks ($) { #{{{
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));
235 # Trim common dir prefixes from both pages.
237 my $page_trimmed=$page;
239 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
241 $p_trimmed=~s/^\Q$dir\E// &&
242 $page_trimmed=~s/^\Q$dir\E//;
244 push @links, { url => $href, page => $p_trimmed };
248 return sort { $a->{page} cmp $b->{page} } @links;
251 sub parentlinks ($) { #{{{
258 foreach my $dir (reverse split("/", $page)) {
260 unshift @ret, { url => "$path$dir.html", page => $dir };
267 unshift @ret, { url => $path , page => $wikiname };
271 sub indexlink () { #{{{
272 return "<a href=\"$url\">$wikiname</a>";
275 sub finalize ($$) { #{{{
279 my $title=basename($page);
282 my $template=HTML::Template->new(blind_cache => 1,
283 filename => "$templatedir/page.tmpl");
285 if (length $cgiurl) {
286 $template->param(editurl => "$cgiurl?do=edit&page=$page");
288 $template->param(recentchangesurl => "$cgiurl?do=recentchanges");
292 if (length $historyurl) {
294 $u=~s/\[\[\]\]/$pagesources{$page}/g;
295 $template->param(historyurl => $u);
300 wikiname => $wikiname,
301 parentlinks => [parentlinks($page)],
303 backlinks => [backlinks($page)],
306 return $template->output;
309 sub render ($) { #{{{
312 my $type=pagetype($file);
313 my $content=readfile("$srcdir/$file");
314 if ($type ne 'unknown') {
315 my $page=pagename($file);
317 $links{$page}=[findlinks($content)];
319 $content=linkify($content, $file);
320 $content=htmlize($type, $content);
321 $content=finalize($content, $page);
323 writefile("$destdir/".htmlpage($page), $content);
324 $oldpagemtime{$page}=time;
325 $renderedfiles{$page}=htmlpage($page);
329 writefile("$destdir/$file", $content);
330 $oldpagemtime{$file}=time;
331 $renderedfiles{$file}=$file;
335 sub loadindex () { #{{{
336 open (IN, "$srcdir/.ikiwiki/index") || return;
338 $_=possibly_foolish_untaint($_);
340 my ($mtime, $file, $rendered, @links)=split(' ', $_);
341 my $page=pagename($file);
342 $pagesources{$page}=$file;
343 $oldpagemtime{$page}=$mtime;
344 $oldlinks{$page}=[@links];
345 $links{$page}=[@links];
346 $renderedfiles{$page}=$rendered;
351 sub saveindex () { #{{{
352 if (! -d "$srcdir/.ikiwiki") {
353 mkdir("$srcdir/.ikiwiki");
355 open (OUT, ">$srcdir/.ikiwiki/index") || error("cannot write to index: $!");
356 foreach my $page (keys %oldpagemtime) {
357 print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ".
358 join(" ", @{$links{$page}})."\n"
359 if $oldpagemtime{$page};
364 sub rcs_update () { #{{{
365 if (-d "$srcdir/.svn") {
366 if (system("svn", "update", "--quiet", $srcdir) != 0) {
367 warn("svn update failed\n");
372 sub rcs_commit ($) { #{{{
375 if (-d "$srcdir/.svn") {
376 if (system("svn", "commit", "--quiet", "-m",
377 possibly_foolish_untaint($message), $srcdir) != 0) {
378 warn("svn commit failed\n");
383 sub rcs_add ($) { #{{{
386 if (-d "$srcdir/.svn") {
387 my $parent=dirname($file);
388 while (! -d "$srcdir/$parent/.svn") {
390 $parent=dirname($file);
393 if (system("svn", "add", "--quiet", "$srcdir/$file") != 0) {
394 warn("svn add failed\n");
399 sub rcs_recentchanges ($) { #{{{
403 eval q{use Date::Parse};
404 eval q{use Time::Duration};
406 if (-d "$srcdir/.svn") {
407 my $info=`LANG=C svn info $srcdir`;
408 my ($svn_url)=$info=~/^URL: (.*)$/m;
410 # FIXME: currently assumes that the wiki is somewhere
411 # under trunk in svn, doesn't support other layouts.
412 my ($svn_base)=$svn_url=~m!(/trunk(?:/.*)?)$!;
414 my $div=qr/^--------------------+$/;
415 my $infoline=qr/^r(\d+)\s+\|\s+([^\s]+)\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
417 my ($rev, $user, $when, @pages, @message);
418 foreach (`LANG=C svn log -v '$svn_url'`) {
420 if ($state eq 'start' && /$div/) {
423 elsif ($state eq 'header' && /$infoline/) {
426 $when=concise(ago(time - str2time($3)));
428 elsif ($state eq 'header' && /^\s+[A-Z]\s+\Q$svn_base\E\/(.+)$/) {
429 push @pages, { link => htmllink("", pagename($1), 1) }
432 elsif ($state eq 'header' && /^$/) {
435 elsif ($state eq 'body' && /$div/) {
436 push @ret, { rev => $rev, user => $user,
437 when => $when, message => [@message],
438 pages => [@pages] } if @pages;
439 return @ret if @ret >= $num;
442 $rev=$user=$when=undef;
445 elsif ($state eq 'body') {
446 push @message, {line => $_},
458 my $dir=dirname($file);
459 while (rmdir($dir)) {
464 sub refresh () { #{{{
465 # Find existing pages.
471 if (/$wiki_file_prune_regexp/) {
472 $File::Find::prune=1;
475 my ($f)=/$wiki_file_regexp/; # untaint
477 warn("skipping bad filename $_\n");
480 $f=~s/^\Q$srcdir\E\/?//;
482 $exists{pagename($f)}=1;
490 # check for added or removed pages
492 foreach my $file (@files) {
493 my $page=pagename($file);
494 if (! $oldpagemtime{$page}) {
495 debug("new page $page");
498 $pagesources{$page}=$file;
502 foreach my $page (keys %oldpagemtime) {
503 if (! $exists{$page}) {
504 debug("removing old page $page");
505 push @del, $renderedfiles{$page};
506 prune($destdir."/".$renderedfiles{$page});
507 delete $renderedfiles{$page};
508 $oldpagemtime{$page}=0;
509 delete $pagesources{$page};
513 # render any updated files
514 foreach my $file (@files) {
515 my $page=pagename($file);
517 if (! exists $oldpagemtime{$page} ||
518 mtime("$srcdir/$file") > $oldpagemtime{$page}) {
519 debug("rendering changed file $file");
525 # if any files were added or removed, check to see if each page
526 # needs an update due to linking to them
527 # TODO: inefficient; pages may get rendered above and again here;
528 # problem is the bestlink may have changed and we won't know until
531 FILE: foreach my $file (@files) {
532 my $page=pagename($file);
533 foreach my $f (@add, @del) {
535 foreach my $link (@{$links{$page}}) {
536 if (bestlink($page, $link) eq $p) {
537 debug("rendering $file, which links to $p");
547 # handle backlinks; if a page has added/removed links, update the
549 # TODO: inefficient; pages may get rendered above and again here;
550 # problem is the backlinks could be wrong in the first pass render
554 foreach my $file (keys %rendered, @del) {
555 my $page=pagename($file);
556 if (exists $links{$page}) {
557 foreach my $link (@{$links{$page}}) {
558 $link=bestlink($page, $link);
560 ! exists $oldlinks{$page} ||
561 ! grep { $_ eq $link } @{$oldlinks{$page}}) {
562 $linkchanged{$link}=1;
566 if (exists $oldlinks{$page}) {
567 foreach my $link (@{$oldlinks{$page}}) {
568 $link=bestlink($page, $link);
570 ! exists $links{$page} ||
571 ! grep { $_ eq $link } @{$links{$page}}) {
572 $linkchanged{$link}=1;
577 foreach my $link (keys %linkchanged) {
578 my $linkfile=$pagesources{$link};
579 if (defined $linkfile) {
580 debug("rendering $linkfile, to update its backlinks");
587 # Generates a C wrapper program for running ikiwiki in a specific way.
588 # The wrapper may be safely made suid.
589 sub gen_wrapper ($$) { #{{{
590 my ($svn, $rebuild)=@_;
592 eval q{use Cwd 'abs_path'};
593 $srcdir=abs_path($srcdir);
594 $destdir=abs_path($destdir);
595 my $this=abs_path($0);
597 error("$this doesn't seem to be executable");
600 my @params=($srcdir, $templatedir, $destdir, "--wikiname=$wikiname");
601 push @params, "--verbose" if $verbose;
602 push @params, "--rebuild" if $rebuild;
603 push @params, "--nosvn" if !$svn;
604 push @params, "--cgi" if $cgi;
605 push @params, "--url=$url" if $url;
606 push @params, "--cgiurl=$cgiurl" if $cgiurl;
607 push @params, "--historyurl=$historyurl" if $historyurl;
608 push @params, "--anonok" if $anonok;
609 my $params=join(" ", @params);
611 foreach my $p ($this, $this, @params) {
617 push @envsave, qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
618 CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE
619 HTTP_COOKIE} if $cgi;
621 foreach my $var (@envsave) {
623 if ((s=getenv("$var")))
624 asprintf(&newenviron[i++], "%s=%s", "$var", s);
628 open(OUT, ">ikiwiki-wrap.c") || error("failed to write ikiwiki-wrap.c: $!");;
630 /* A wrapper for ikiwiki, can be safely made suid. */
637 extern char **environ;
639 int main (int argc, char **argv) {
640 /* Sanitize environment. */
642 char *newenviron[$#envsave+3];
645 newenviron[i++]="HOME=$ENV{HOME}";
649 if (argc == 2 && strcmp(argv[1], "--params") == 0) {
650 printf("$params\\n");
655 perror("failed to run $this");
660 if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) {
661 error("failed to compile ikiwiki-wrap.c");
663 unlink("ikiwiki-wrap.c");
664 print "successfully generated ikiwiki-wrap\n";
668 sub misctemplate ($$) { #{{{
672 my $template=HTML::Template->new(
673 filename => "$templatedir/misc.tmpl"
677 indexlink => indexlink(),
678 wikiname => $wikiname,
679 pagebody => $pagebody,
681 return $template->output;
684 sub cgi_recentchanges ($) { #{{{
687 my $template=HTML::Template->new(
688 filename => "$templatedir/recentchanges.tmpl"
691 title => "RecentChanges",
692 indexlink => indexlink(),
693 wikiname => $wikiname,
694 changelog => [rcs_recentchanges(100)],
696 print $q->header, $template->output;
699 sub cgi_signin ($$) { #{{{
703 eval q{use CGI::FormBuilder};
704 my $form = CGI::FormBuilder->new(
705 title => "$wikiname signin",
706 fields => [qw(do page name password confirm_password email)],
711 confirm_password => {
712 perl => q{eq $form->field("password")},
719 action => $q->request_uri,
721 template => (-e "$templatedir/signin.tmpl" ? "$templatedir/signin.tmpl" : "")
724 $form->field(name => "name", required => 0);
725 $form->field(name => "do", type => "hidden");
726 $form->field(name => "page", type => "hidden");
727 $form->field(name => "password", type => "password", required => 0);
728 $form->field(name => "confirm_password", type => "password", required => 0);
729 $form->field(name => "email", required => 0);
730 if ($session->param("name")) {
731 $form->field(name => "name", value => $session->param("name"));
733 if ($q->param("do") ne "signin") {
734 $form->text("You need to log in before you can edit pages.");
737 if ($form->submitted) {
738 # Set required fields based on how form was submitted.
740 "Login" => [qw(name password)],
741 "Register" => [qw(name password confirm_password email)],
742 "Mail Password" => [qw(name)],
744 foreach my $opt (@{$required{$form->submitted}}) {
745 $form->field(name => $opt, required => 1);
748 # Validate password differently depending on how form was
750 if ($form->submitted eq 'Login') {
754 # TODO get real user password
760 $form->field(name => "password", validate => 'VALUE');
764 # Comments only shown first time.
765 $form->field(name => "name", comment => "use FirstnameLastName");
766 $form->field(name => "confirm_password", comment => "(only needed");
767 $form->field(name => "email", comment => "for registration)");
770 if ($form->submitted && $form->validate) {
771 if ($form->submitted eq 'Login') {
772 $session->param("name", $form->field("name"));
773 if (defined $form->field("do") &&
774 $form->field("do") ne 'signin') {
776 "$cgiurl?do=".$form->field("do").
777 "&page=".$form->field("page"));
780 print $q->redirect($url);
783 elsif ($form->submitted eq 'Register') {
784 # TODO: save registration info
785 $form->field(name => "confirm_password", type => "hidden");
786 $form->field(name => "email", type => "hidden");
787 $form->text("Registration successful. Now you can Login.");
788 print $session->header();
789 print misctemplate($form->title, $form->render(submit => ["Login"]));
791 elsif ($form->submitted eq 'Mail Password') {
793 $form->text("Your password has been emailed to you.");
794 print $session->header();
795 print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
799 print $session->header();
800 print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
804 sub cgi_editpage ($$) { #{{{
808 eval q{use CGI::FormBuilder};
809 my $form = CGI::FormBuilder->new(
810 fields => [qw(do from page content comments)],
817 action => $q->request_uri,
819 template => "$templatedir/editpage.tmpl"
822 my ($page)=$form->param('page')=~/$wiki_file_regexp/;
823 if (! defined $page || ! length $page || $page ne $q->param('page') ||
824 $page=~/$wiki_file_prune_regexp/ || $page=~/^\//) {
825 error("bad page name");
829 $form->field(name => "do", type => 'hidden');
830 $form->field(name => "from", type => 'hidden');
831 $form->field(name => "page", value => "$page", force => 1);
832 $form->field(name => "comments", type => "text", size => 80);
833 $form->field(name => "content", type => "textarea", rows => 20,
836 if (! $form->submitted || ! $form->validate) {
837 if ($form->field("do") eq "create") {
838 if (exists $pagesources{lc($page)}) {
839 # hmm, someone else made the page in the
841 print $q->redirect("$url/".htmlpage($page));
846 my ($from)=$form->param('from')=~/$wiki_file_regexp/;
847 if (! defined $from || ! length $from ||
848 $from ne $form->param('from') ||
849 $from=~/$wiki_file_prune_regexp/ || $from=~/^\//) {
855 push @page_locs, $dir.$page;
856 push @page_locs, "$from/$page";
857 while (length $dir) {
859 push @page_locs, $dir.$page;
863 $form->tmpl_param("page_select", 1);
864 $form->field(name => "page", type => 'select',
865 options => \@page_locs);
866 $form->title("creating $page");
868 elsif ($form->field("do") eq "edit") {
870 if (exists $pagesources{lc($page)}) {
871 $content=readfile("$srcdir/$pagesources{lc($page)}");
872 $content=~s/\n/\r\n/g;
874 $form->tmpl_param("page_select", 0);
875 $form->field(name => "content", value => $content,
877 $form->field(name => "page", type => 'hidden');
878 $form->title("editing $page");
881 $form->tmpl_param("can_commit", $svn);
882 $form->tmpl_param("indexlink", indexlink());
883 print $form->render(submit => ["Save Page"]);
887 my $file=$page.$default_pagetype;
889 if (exists $pagesources{lc($page)}) {
890 $file=$pagesources{lc($page)};
894 my $content=$form->field('content');
895 $content=~s/\r\n/\n/g;
897 writefile("$srcdir/$file", $content);
899 my $message="web commit ";
900 if ($session->param("name")) {
901 $message.="by ".$session->param("name");
904 $message.="from $ENV{REMOTE_ADDR}";
906 if (length $form->field('comments')) {
907 $message.=": ".$form->field('comments');
914 # presumably the commit will trigger an update
916 rcs_commit($message);
922 print $q->redirect("$url/".htmlpage($page));
928 eval q{use CGI::Session};
932 my $do=$q->param('do');
933 if (! defined $do || ! length $do) {
934 error("\"do\" parameter missing");
937 # This does not need a session.
938 if ($do eq 'recentchanges') {
939 cgi_recentchanges($q);
943 CGI::Session->name("ikiwiki_session");
944 my $session = CGI::Session->new(undef, $q,
945 { Directory=> "$srcdir/.ikiwiki/sessions" });
947 # Everything below this point needs the user to be signed in.
948 if ((! $anonok && ! defined $session->param("name")) || $do eq 'signin') {
949 cgi_signin($q, $session);
953 if ($do eq 'create' || $do eq 'edit') {
954 cgi_editpage($q, $session);
957 error("unknown do parameter");
964 if (grep /^-/, @ARGV) {
965 eval {use Getopt::Long};
967 "wikiname=s" => \$wikiname,
968 "verbose|v" => \$verbose,
969 "rebuild" => \$rebuild,
970 "wrapper" => \$wrapper,
972 "anonok!" => \$anonok,
975 "cgiurl=s" => \$cgiurl,
976 "historyurl=s" => \$historyurl,
979 usage() unless @ARGV == 3;
980 ($srcdir) = possibly_foolish_untaint(shift);
981 ($templatedir) = possibly_foolish_untaint(shift);
982 ($destdir) = possibly_foolish_untaint(shift);
984 if ($cgi && ! length $url) {
985 error("Must specify url to wiki with --url when using --cgi");
988 gen_wrapper($svn, $rebuild) if $wrapper;
991 loadindex() unless $rebuild;
996 rcs_update() if $svn;