X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/942d5896cdf8467de52a4db8f4c959e6bb4a602b..e5ae4bbcf70dd5d642bbe85e88585c110e523670:/ikiwiki

diff --git a/ikiwiki b/ikiwiki
index 8ba324961..5b4972ab7 100755
--- a/ikiwiki
+++ b/ikiwiki
@@ -1,632 +1,141 @@
 #!/usr/bin/perl -T
+$ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
 
+package IkiWiki;
 use warnings;
 use strict;
-use File::Find;
-use Memoize;
-use File::Spec;
-
-$ENV{PATH}="/usr/local/bin:/usr/bin:/bin";
-
-BEGIN {
-	$blosxom::version="is a proper perl module too much to ask?";
-	do "/usr/bin/markdown";
-}
-
-my ($srcdir, $destdir, %links, %oldlinks, %oldpagemtime, %renderedfiles,
-    %pagesources);
-my $wiki_link_regexp=qr/\[\[([^\s]+)\]\]/;
-my $wiki_file_regexp=qr/(^[-A-Za-z0-9_.:\/+]+$)/;
-my $wiki_file_prune_regexp=qr!((^|/).svn/|\.\.)!;
-my $verbose=0;
-my $wikiname="wiki";
-my $default_pagetype=".mdwn";
-my $cgi=0;
-my $url="";
+use lib '.'; # For use without installation, removed by Makefile.
+use IkiWiki;
 
-sub usage {
+sub usage () { #{{{
 	die "usage: ikiwiki [options] source dest\n";
-}
-
-sub error ($) {
-	if ($cgi) {
-		print "Content-type: text/html\n\n";
-		print "Error: @_\n";
-		exit 1;
-	}
-	else {
-		die @_;
-	}
-}
-
-sub debug ($) {
-	print "@_\n" if $verbose;
-}
-
-sub mtime ($) {
-	my $page=shift;
-	
-	return (stat($page))[9];
-}
-
-sub possibly_foolish_untaint ($) {
-	my $tainted=shift;
-	my ($untainted)=$tainted=~/(.*)/;
-	return $untainted;
-}
-
-sub basename {
-	my $file=shift;
-
-	$file=~s!.*/!!;
-	return $file;
-}
-
-sub dirname {
-	my $file=shift;
-
-	$file=~s!/?[^/]+$!!;
-	return $file;
-}
-
-sub pagetype ($) {
-	my $page=shift;
-	
-	if ($page =~ /\.mdwn$/) {
-		return ".mdwn";
-	}
-	else {
-		return "unknown";
-	}
-}
-
-sub pagename ($) {
-	my $file=shift;
-
-	my $type=pagetype($file);
-	my $page=$file;
-	$page=~s/\Q$type\E*$// unless $type eq 'unknown';
-	return $page;
-}
-
-sub htmlpage ($) {
-	my $page=shift;
-
-	return $page.".html";
-}
-
-sub readfile ($) {
-	my $file=shift;
-
-	local $/=undef;
-	open (IN, "$file") || error("failed to read $file: $!");
-	my $ret=<IN>;
-	close IN;
-	return $ret;
-}
-
-sub writefile ($$) {
-	my $file=shift;
-	my $content=shift;
-
-	my $dir=dirname($file);
-	if (! -d $dir) {
-		my $d="";
-		foreach my $s (split(m!/+!, $dir)) {
-			$d.="$s/";
-			if (! -d $d) {
-				mkdir($d) || error("failed to create directory $d: $!");
-			}
-		}
-	}
-	
-	open (OUT, ">$file") || error("failed to write $file: $!");
-	print OUT $content;
-	close OUT;
-}
-
-sub findlinks {
-	my $content=shift;
-
-	my @links;
-	while ($content =~ /$wiki_link_regexp/g) {
-		push @links, lc($1);
-	}
-	return @links;
-}
-
-# Given a page and the text of a link on the page, determine which existing
-# page that link best points to. Prefers pages under a subdirectory with
-# the same name as the source page, failing that goes down the directory tree
-# to the base looking for matching pages.
-sub bestlink ($$) {
-	my $page=shift;
-	my $link=lc(shift);
-	
-	my $cwd=$page;
-	do {
-		my $l=$cwd;
-		$l.="/" if length $l;
-		$l.=$link;
-
-		if (exists $links{$l}) {
-			#debug("for $page, \"$link\", use $l");
-			return $l;
-		}
-	} while $cwd=~s!/?[^/]+$!!;
-
-	#print STDERR "warning: page $page, broken link: $link\n";
-	return "";
-}
-
-sub isinlinableimage ($) {
-	my $file=shift;
-	
-	$file=~/\.(png|gif|jpg|jpeg)$/;
-}
-
-sub htmllink ($$) {
-	my $page=shift;
-	my $link=shift;
-
-	my $bestlink=bestlink($page, $link);
-
-	return $link if $page eq $bestlink;
-	
-	# TODO BUG: %renderedfiles may not have it, if the linked to page
-	# was also added and isn't yet rendered! Note that this bug is
-	# masked by the bug mentioned below that makes all new files
-	# be rendered twice.
-	if (! grep { $_ eq $bestlink } values %renderedfiles) {
-		$bestlink=htmlpage($bestlink);
-	}
-	if (! grep { $_ eq $bestlink } values %renderedfiles) {
-		return "<a href=\"?\">?</a>$link"
-	}
-	
-	$bestlink=File::Spec->abs2rel($bestlink, dirname($page));
-	
-	if (isinlinableimage($bestlink)) {
-		return "<img src=\"$bestlink\">";
-	}
-	return "<a href=\"$bestlink\">$link</a>";
-}
-
-sub linkify ($$) {
-	my $content=shift;
-	my $file=shift;
-
-	$content =~ s/$wiki_link_regexp/htmllink(pagename($file), $1)/eg;
-	
-	return $content;
-}
-
-sub htmlize ($$) {
-	my $type=shift;
-	my $content=shift;
-	
-	if ($type eq '.mdwn') {
-		return Markdown::Markdown($content);
-	}
-	else {
-		error("htmlization of $type not supported");
-	}
-}
-
-sub linkbacks ($$) {
-	my $content=shift;
-	my $page=shift;
-
-	my @links;
-	foreach my $p (keys %links) {
-		next if bestlink($page, $p) eq $page;
-		if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
-			my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
-			
-			# Trim common dir prefixes from both pages.
-			my $p_trimmed=$p;
-			my $page_trimmed=$page;
-			my $dir;
-			1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
-			        defined $dir &&
-			        $p_trimmed=~s/^\Q$dir\E// &&
-			        $page_trimmed=~s/^\Q$dir\E//;
-				       
-			push @links, "<a href=\"$href\">$p_trimmed</a>";
-		}
-	}
-
-	$content.="<hr><p>Links: ".join(" ", sort @links)."</p>\n" if @links;
-	return $content;
-}
-
-sub finalize ($$) {
-	my $content=shift;
-	my $page=shift;
-
-	my $title=basename($page);
-	$title=~s/_/ /g;
-	
-	my $pagelink="";
-	my $path="";
-	foreach my $dir (reverse split("/", $page)) {
-		if (length($pagelink)) {
-			$pagelink="<a href=\"$path$dir.html\">$dir</a>/ $pagelink";
-		}
-		else {
-			$pagelink=$dir;
-		}
-		$path.="../";
-	}
-	$path=~s/\.\.\/$/index.html/;
-	$pagelink="<a href=\"$path\">$wikiname</a>/ $pagelink";
-	
-	$content="<html>\n<head><title>$title</title></head>\n<body>\n".
-	          "<h1>$pagelink</h1>\n".
-	          $content.
-	          "</body>\n</html>\n";
-	
-	return $content;
-}
-
-sub render ($) {
-	my $file=shift;
-	
-	my $type=pagetype($file);
-	my $content=readfile("$srcdir/$file");
-	if ($type ne 'unknown') {
-		my $page=pagename($file);
-		
-		$links{$page}=[findlinks($content)];
-		
-		$content=linkify($content, $file);
-		$content=htmlize($type, $content);
-		$content=linkbacks($content, $page);
-		$content=finalize($content, $page);
-		
-		writefile("$destdir/".htmlpage($page), $content);
-		$oldpagemtime{$page}=time;
-		$renderedfiles{$page}=htmlpage($page);
-	}
-	else {
-		$links{$file}=[];
-		writefile("$destdir/$file", $content);
-		$oldpagemtime{$file}=time;
-		$renderedfiles{$file}=$file;
-	}
-}
-
-sub loadindex () {
-	open (IN, "$srcdir/.index") || return;
-	while (<IN>) {
-		$_=possibly_foolish_untaint($_);
-		chomp;
-		my ($mtime, $file, $rendered, @links)=split(' ', $_);
-		my $page=pagename($file);
-		$pagesources{$page}=$file;
-		$oldpagemtime{$page}=$mtime;
-		$oldlinks{$page}=[@links];
-		$links{$page}=[@links];
-		$renderedfiles{$page}=$rendered;
-	}
-	close IN;
-}	
-
-sub saveindex () {
-	open (OUT, ">$srcdir/.index") || error("cannot write to .index: $!");
-	foreach my $page (keys %oldpagemtime) {
-	print OUT "$oldpagemtime{$page} $pagesources{$page} $renderedfiles{$page} ".
-	          join(" ", @{$links{$page}})."\n"
-			if $oldpagemtime{$page};
-	}
-	close OUT;
-}
-
-sub update () {
-	if (-d "$srcdir/.svn") {
-		if (system("svn", "update", "--quiet", $srcdir) != 0) {
-			warn("svn update failed\n");
-		}
-	}
-}
-
-sub prune ($) {
-	my $file=shift;
-
-	unlink($file);
-	my $dir=dirname($file);
-	while (rmdir($dir)) {
-		$dir=dirname($dir);
-	}
-}
-
-sub refresh () {
-	# Find existing pages.
-	my %exists;
-	my @files;
-	find({
-		no_chdir => 1,
-		wanted => sub {
-			if (/$wiki_file_prune_regexp/) {
-				$File::Find::prune=1;
+} #}}}
+
+sub getconfig () { #{{{
+	if (! exists $ENV{WRAPPED_OPTIONS}) {
+		%config=(
+			wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
+			wiki_link_regexp => qr/\[\[(?:([^\s\]\|]+)\|)?([^\s\]]+)\]\]/,
+			wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
+			wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
+			verbose => 0,
+			wikiname => "wiki",
+			default_pageext => ".mdwn",
+			cgi => 0,
+			rcs => 'svn',
+			notify => 0,
+			url => '',
+			cgiurl => '',
+			historyurl => '',
+			diffurl => '',
+			anonok => 0,
+			rss => 0,
+			sanitize => 1,
+			rebuild => 0,
+			refresh => 0,
+			getctime => 0,
+			hyperestraier => 0,
+			wrapper => undef,
+			wrappermode => undef,
+			svnrepo => undef,
+			svnpath => "trunk",
+			srcdir => undef,
+			destdir => undef,
+			templatedir => "/usr/share/ikiwiki/templates",
+			underlaydir => "/usr/share/ikiwiki/basewiki",
+			setup => undef,
+			adminuser => undef,
+			adminemail => undef,
+			plugin => [qw{inline}],
+		);
+
+		eval q{use Getopt::Long};
+		GetOptions(
+			"setup|s=s" => \$config{setup},
+			"wikiname=s" => \$config{wikiname},
+			"verbose|v!" => \$config{verbose},
+			"rebuild!" => \$config{rebuild},
+			"refresh!" => \$config{refresh},
+			"getctime" => \$config{getctime},
+			"wrappermode=i" => \$config{wrappermode},
+			"rcs=s" => \$config{rcs},
+			"no-rcs" => sub { $config{rcs}="" },
+			"anonok!" => \$config{anonok},
+			"hyperestraier" => \$config{hyperestraier},
+			"rss!" => \$config{rss},
+			"cgi!" => \$config{cgi},
+			"notify!" => \$config{notify},
+			"sanitize!" => \$config{sanitize},
+			"url=s" => \$config{url},
+			"cgiurl=s" => \$config{cgiurl},
+			"historyurl=s" => \$config{historyurl},
+			"diffurl=s" => \$config{diffurl},
+			"svnrepo" => \$config{svnrepo},
+			"svnpath" => \$config{svnpath},
+			"adminemail=s" => \$config{adminemail},
+			"exclude=s@" => sub {
+				$config{wiki_file_prune_regexp}=qr/$config{wiki_file_prune_regexp}|$_[1]/;
+			},
+			"adminuser=s@" => sub {
+				push @{$config{adminuser}}, $_[1]
+			},
+			"templatedir=s" => sub {
+				$config{templatedir}=possibly_foolish_untaint($_[1])
+			},
+			"underlaydir=s" => sub {
+				$config{underlaydir}=possibly_foolish_untaint($_[1])
+			},
+			"wrapper:s" => sub {
+				$config{wrapper}=$_[1] ? $_[1] : "ikiwiki-wrap"
+			},
+			"plugin=s@" => sub {
+				push @{$config{plugin}}, $_[1];
 			}
-			elsif (! -d $_ && ! /\.html$/ && ! /\/\./) {
-				my ($f)=/$wiki_file_regexp/; # untaint
-				if (! defined $f) {
-					warn("skipping bad filename $_\n");
-				}
-				else {
-					$f=~s/^\Q$srcdir\E\/?//;
-					push @files, $f;
-					$exists{pagename($f)}=1;
-				}
-			}
-		},
-	}, $srcdir);
-
-	my %rendered;
+		) || usage();
 
-	# check for added or removed pages
-	my @add;
-	foreach my $file (@files) {
-		my $page=pagename($file);
-		if (! $oldpagemtime{$page}) {
-			debug("new page $page");
-			push @add, $file;
-			$links{$page}=[];
-			$pagesources{$page}=$file;
-		}
-	}
-	my @del;
-	foreach my $page (keys %oldpagemtime) {
-		if (! $exists{$page}) {
-			debug("removing old page $page");
-			push @del, $renderedfiles{$page};
-			prune($destdir."/".$renderedfiles{$page});
-			delete $renderedfiles{$page};
-			$oldpagemtime{$page}=0;
-			delete $pagesources{$page};
+		if (! $config{setup}) {
+			usage() unless @ARGV == 2;
+			$config{srcdir} = possibly_foolish_untaint(shift @ARGV);
+			$config{destdir} = possibly_foolish_untaint(shift @ARGV);
+			checkconfig();
 		}
 	}
-	
-	# render any updated files
-	foreach my $file (@files) {
-		my $page=pagename($file);
-		
-		if (! exists $oldpagemtime{$page} ||
-		    mtime("$srcdir/$file") > $oldpagemtime{$page}) {
-		    	debug("rendering changed file $file");
-			render($file);
-			$rendered{$file}=1;
-		}
-	}
-	
-	# if any files were added or removed, check to see if each page
-	# needs an update due to linking to them
-	# TODO: inefficient; pages may get rendered above and again here;
-	# problem is the bestlink may have changed and we won't know until
-	# now
-	if (@add || @del) {
-FILE:		foreach my $file (@files) {
-			my $page=pagename($file);
-			foreach my $f (@add, @del) {
-				my $p=pagename($f);
-				foreach my $link (@{$links{$page}}) {
-					if (bestlink($page, $link) eq $p) {
-		   				debug("rendering $file, which links to $p");
-						render($file);
-						$rendered{$file}=1;
-						next FILE;
-					}
-				}
-			}
-		}
-	}
-
-	# handle linkbacks; if a page has added/removed links, update the
-	# pages it links to
-	# TODO: inefficient; pages may get rendered above and again here;
-	# problem is the linkbacks could be wrong in the first pass render
-	# above
-	if (%rendered) {
-		my %linkchanged;
-		foreach my $file (keys %rendered, @del) {
-			my $page=pagename($file);
-			if (exists $links{$page}) {
-				foreach my $link (@{$links{$page}}) {
-					$link=bestlink($page, $link);
-					if (length $link &&
-					    ! exists $oldlinks{$page} ||
-					    ! grep { $_ eq $link } @{$oldlinks{$page}}) {
-						$linkchanged{$link}=1;
-					}
-				}
-			}
-			if (exists $oldlinks{$page}) {
-				foreach my $link (@{$oldlinks{$page}}) {
-					$link=bestlink($page, $link);
-					if (length $link &&
-					    ! exists $links{$page} ||
-					    ! grep { $_ eq $link } @{$links{$page}}) {
-						$linkchanged{$link}=1;
-					}
-				}
-			}
-		}
-		foreach my $link (keys %linkchanged) {
-		    	my $linkfile=$pagesources{$link};
-			if (defined $linkfile) {
-				debug("rendering $linkfile, to update its linkbacks");
-				render($linkfile);
-			}
-		}
-	}
-}
-
-# Generates a C wrapper program for running ikiwiki in a specific way.
-# The wrapper may be safely made suid.
-sub gen_wrapper ($$) {
-	my ($offline, $rebuild)=@_;
-
-	eval {use Cwd 'abs_path'};
-	$srcdir=abs_path($srcdir);
-	$destdir=abs_path($destdir);
-	my $this=abs_path($0);
-	if (! -x $this) {
-		error("$this doesn't seem to be executable");
-	}
-	
-	my $call=qq{"$this", "$this", "$srcdir", "$destdir", "--wikiname=$wikiname"};
-	$call.=', "--verbose"' if $verbose;
-	$call.=', "--rebuild"' if $rebuild;
-	$call.=', "--offline"' if $offline;
-	$call.=', "--cgi"' if $cgi;
-	$call.=', "--url='.$url.'"' if $url;
-	
-	# For CGI we need all these environment variables.
-	my @envsave=qw{REMOTE_ADDR QUERY_STRING REQUEST_METHOD REQUEST_URI
-	               CONTENT_TYPE CONTENT_LENGTH GATEWAY_INTERFACE};
-	my $envsave="";
-	foreach my $var (@envsave) {
-		$envsave.=<<"EOF"
-		if ((s=getenv("$var")))
-			asprintf(&newenviron[i++], "%s=%s", "$var", s);
-EOF
-	}
-	
-	open(OUT, ">ikiwiki-wrap.c") || error("failed to write ikiwiki-wrap.c: $!");;
-	print OUT <<"EOF";
-/* A wrapper for ikiwiki, can be safely made suid. */
-#define _GNU_SOURCE
-#include <stdio.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <string.h>
-
-extern char **environ;
-
-int main (void) {
-	/* Sanitize environment. */
-	if ($cgi) {
-		char *s;
-		char *newenviron[$#envsave+2];
-		int i=0;
-		$envsave;
-		newenviron[i]=NULL;
-		environ=newenviron;
-	}
 	else {
-		clearenv();
+		# wrapper passes a full config structure in the environment
+		# variable
+		eval possibly_foolish_untaint($ENV{WRAPPED_OPTIONS});
+		checkconfig();
 	}
+} #}}}
 
-	execl($call, NULL);
-	perror("failed to run $this");
-	exit(1);
-}
-EOF
-	close OUT;
-	if (system("gcc", "ikiwiki-wrap.c", "-o", "ikiwiki-wrap") != 0) {
-		error("failed to compile ikiwiki-wrap.c");
-	}
-	unlink("ikiwiki-wrap.c");
-	print "successfully generated ikiwiki-wrap\n";
-	exit 0;
-}
-
-sub cgi () {
-	eval q{use CGI};
-	my $q=CGI->new;
-
-	my $do=$q->param('do');
-	if (! defined $do || ! length $do) {
-		error("\"do\" parameter missing");
-	}
+sub main () { #{{{
+	getconfig();
 	
-	my ($page)=$q->param('page')=~/$wiki_file_regexp/; # untaint
-	if (! defined $page || ! length $page || $page ne $q->param('page') ||
-	    $page=~/$wiki_file_prune_regexp/ || $page=~/^\//) {
-		error("bad page name");
+	if ($config{cgi}) {
+		lockwiki();
+		loadindex();
+		require IkiWiki::CGI;
+		cgi();
 	}
-	
-	my $action=$q->request_uri;
-	$action=~s/\?.*//;
-	
-	if ($do eq 'edit') {
-		my $content="";
-		if (exists $pagesources{lc($page)}) {
-			$content=readfile("$srcdir/$pagesources{lc($page)}");
-			$content=~s/\n/\r\n/g;
-		}
-		$q->param("do", "save");
-		print $q->header,
-		      $q->start_html("$wikiname: Editing $page"),
-		      $q->h1("$wikiname: Editing $page"),
-		      $q->start_form(-action => $action),
-		      $q->hidden('do'),
-		      $q->hidden('page'),
-		      $q->textarea(-name => 'content',
-		               -default => $content,
-		               -rows => 20,
-		               -columns => 80),
-		      $q->p,
-		      $q->submit("Save Changes"),
-		      # TODO: Cancel button returns to page.
-		      # TODO: Preview button.
-		      # TODO: Commit message field.
-		      # TODO: Conflict prevention.
-		      $q->end_form,
-		      $q->end_html;
+	elsif ($config{setup}) {
+		require IkiWiki::Setup;
+		setup();
 	}
-	elsif ($do eq 'save') {
-		my $file=$page.$default_pagetype;
-		if (exists $pagesources{lc($page)}) {
-			$file=$pagesources{lc($page)};
-		}
-		
-		my $content=$q->param('content');
-		$content=~s/\r\n/\n/g;
-		$content=~s/\r/\n/g;
-		writefile("$srcdir/$file", $content);
-		
-		print $q->redirect("$url/".htmlpage($page));
+	elsif ($config{wrapper}) {
+		lockwiki();
+		require IkiWiki::Wrapper;
+		gen_wrapper();
 	}
 	else {
-		error("unknown do parameter");
-	}
-}
-
-my $rebuild=0;
-my $offline=0;
-my $wrapper=0;
-if (grep /^-/, @ARGV) {
-	eval {use Getopt::Long};
-	GetOptions(
-		"wikiname=s" => \$wikiname,
-		"verbose|v" => \$verbose,
-		"rebuild" => \$rebuild,
-		"wrapper" => \$wrapper,
-		"offline" => \$offline,
-		"cgi" => \$cgi,
-		"url=s" => \$url,
-	) || usage();
-}
-usage() unless @ARGV == 2;
-($srcdir) = possibly_foolish_untaint(shift);
-($destdir) = possibly_foolish_untaint(shift);
-
-if ($cgi && ! length $url) {
-	error("Must specify url to wiki with --url when using --cgi");
-}
-
-gen_wrapper($offline, $rebuild) if $wrapper;
-memoize('pagename');
-memoize('bestlink');
-loadindex() unless $rebuild;
-if ($cgi) {
-	cgi();
-}
-else {
-	update() unless $offline;
-	refresh();
-	saveindex();
-}
+		lockwiki();
+		loadindex();
+		require IkiWiki::Render;
+		rcs_update();
+		rcs_getctime() if $config{getctime};
+		refresh();
+		rcs_notify() if $config{notify};
+		saveindex();
+	}
+} #}}}
+
+main;