X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/a223f4540fee2d0c49523343a422315377bc0025..a460a01134a9e47308476d4830bfbe4ccf426011:/IkiWiki/Render.pm

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index df24fd568..d08653711 100644
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -1,59 +1,49 @@
+#!/usr/bin/perl
+
 package IkiWiki;
 
 use warnings;
 use strict;
-use File::Spec;
-
-sub linkify ($$) { #{{{
-	my $content=shift;
-	my $page=shift;
+use IkiWiki;
+use Encode;
 
-	$content =~ s{(\\?)$config{wiki_link_regexp}}{
-		$1 ? "[[$2]]" : htmllink($page, $2)
-	}eg;
-	
-	return $content;
-} #}}}
+my %backlinks;
+my $backlinks_calculated=0;
 
-sub htmlize ($$) { #{{{
-	my $type=shift;
-	my $content=shift;
-	
-	if (! $INC{"/usr/bin/markdown"}) {
-		no warnings 'once';
-		$blosxom::version="is a proper perl module too much to ask?";
-		use warnings 'all';
-		do "/usr/bin/markdown";
-	}
-	
-	if ($type eq '.mdwn') {
-		return Markdown::Markdown($content);
-	}
-	else {
-		error("htmlization of $type not supported");
+sub calculate_backlinks () { #{{{
+	return if $backlinks_calculated;
+	%backlinks=();
+	foreach my $page (keys %links) {
+		foreach my $link (@{$links{$page}}) {
+			my $bestlink=bestlink($page, $link);
+			if (length $bestlink && $bestlink ne $page) {
+				$backlinks{$bestlink}{$page}=1;
+			}
+		}
 	}
+	$backlinks_calculated=1;
 } #}}}
 
 sub backlinks ($) { #{{{
 	my $page=shift;
 
+	calculate_backlinks();
+
 	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));
+	return unless $backlinks{$page};
+	foreach my $p (keys %{$backlinks{$page}}) {
+		my $href=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, { url => $href, page => $p_trimmed };
-		}
+		# 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, { url => $href, page => pagetitle($p_trimmed) };
 	}
 
 	return sort { $a->{page} cmp $b->{page} } @links;
@@ -66,10 +56,11 @@ sub parentlinks ($) { #{{{
 	my $pagelink="";
 	my $path="";
 	my $skip=1;
+	return if $page eq 'index'; # toplevel
 	foreach my $dir (reverse split("/", $page)) {
 		if (! $skip) {
 			$path.="../";
-			unshift @ret, { url => "$path$dir.html", page => $dir };
+			unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };
 		}
 		else {
 			$skip=0;
@@ -79,102 +70,131 @@ sub parentlinks ($) { #{{{
 	return @ret;
 } #}}}
 
-sub finalize ($$$) { #{{{
-	my $content=shift;
+sub genpage ($$$) { #{{{
 	my $page=shift;
+	my $content=shift;
 	my $mtime=shift;
 
-	my $title=pagetitle(basename($page));
-	
-	my $template=HTML::Template->new(blind_cache => 1,
-		filename => "$config{templatedir}/page.tmpl");
-	
+	my $template=template("page.tmpl", blind_cache => 1);
+	my $actions=0;
+
 	if (length $config{cgiurl}) {
-		$template->param(editurl => "$config{cgiurl}?do=edit&page=$page");
-		$template->param(prefsurl => "$config{cgiurl}?do=prefs");
+		$template->param(editurl => cgiurl(do => "edit", page => $page));
+		$template->param(prefsurl => cgiurl(do => "prefs"));
 		if ($config{rcs}) {
-			$template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
+			$template->param(recentchangesurl => cgiurl(do => "recentchanges"));
 		}
+		$actions++;
 	}
 
 	if (length $config{historyurl}) {
 		my $u=$config{historyurl};
 		$u=~s/\[\[file\]\]/$pagesources{$page}/g;
 		$template->param(historyurl => $u);
+		$actions++;
 	}
-	
+	if ($config{discussion}) {
+		$template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
+		$actions++;
+	}
+
+	if ($actions) {
+		$template->param(have_actions => 1);
+	}
+
 	$template->param(
-		title => $title,
+		title => $page eq 'index' 
+			? $config{wikiname} 
+			: pagetitle(basename($page)),
 		wikiname => $config{wikiname},
 		parentlinks => [parentlinks($page)],
 		content => $content,
 		backlinks => [backlinks($page)],
-		discussionlink => htmllink($page, "Discussion", 1, 1),
-		mtime => scalar(gmtime($mtime)),
+		mtime => displaytime($mtime),
+		baseurl => baseurl($page),
 	);
-	
-	return $template->output;
-} #}}}
 
-sub check_overwrite ($$) { #{{{
-	# Important security check. Make sure to call this before saving
-	# any files to the source directory.
-	my $dest=shift;
-	my $src=shift;
+	run_hooks(pagetemplate => sub {
+		shift->(page => $page, destpage => $page, template => $template);
+	});
 	
-	if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
-		error("$dest already exists and was rendered from ".
-			join(" ",(grep { $renderedfiles{$_} eq $dest } keys
-				%renderedfiles)).
-			", before, so not rendering from $src");
-	}
+	$content=$template->output;
+
+	run_hooks(format => sub {
+		$content=shift->(
+			page => $page,
+			content => $content,
+		);
+	});
+
+	return $content;
 } #}}}
 
 sub mtime ($) { #{{{
-	my $page=shift;
+	my $file=shift;
 	
-	return (stat($page))[9];
+	return (stat($file))[9];
 } #}}}
 
-sub findlinks ($$) { #{{{
-	my $content=shift;
-	my $page=shift;
+sub scan ($) { #{{{
+	my $file=shift;
 
-	my @links;
-	while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
-		push @links, lc($1);
+	my $type=pagetype($file);
+	if (defined $type) {
+		my $srcfile=srcfile($file);
+		my $content=readfile($srcfile);
+		my $page=pagename($file);
+		will_render($page, htmlpage($page), 1);
+
+		# Always needs to be done, since filters might add links
+		# to the content.
+		$content=filter($page, $content);
+
+		my @links;
+		while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
+			push @links, titlepage($2);
+		}
+		if ($config{discussion}) {
+			# Discussion links are a special case since they're
+			# not in the text of the page, but on its template.
+			push @links, "$page/discussion";
+		}
+		$links{$page}=\@links;
+		
+		# Preprocess in scan-only mode.
+		preprocess($page, $page, $content, 1);
+	}
+	else {
+		will_render($file, $file, 1);
 	}
-	# Discussion links are a special case since they're not in the text
-	# of the page, but on its template.
-	return @links, "$page/discussion";
 } #}}}
 
 sub render ($) { #{{{
 	my $file=shift;
 	
 	my $type=pagetype($file);
-	my $content=readfile("$config{srcdir}/$file");
-	if ($type ne 'unknown') {
+	my $srcfile=srcfile($file);
+	if (defined $type) {
+		my $content=readfile($srcfile);
 		my $page=pagename($file);
+		delete $depends{$page};
+		will_render($page, htmlpage($page), 1);
 		
-		$links{$page}=[findlinks($content, $page)];
-		
-		$content=linkify($content, $page);
-		$content=htmlize($type, $content);
-		$content=finalize($content, $page,
-			mtime("$config{srcdir}/$file"));
+		$content=filter($page, $content);
+		$content=preprocess($page, $page, $content);
+		$content=linkify($page, $page, $content);
+		$content=htmlize($page, $type, $content);
 		
-		check_overwrite("$config{destdir}/".htmlpage($page), $page);
-		writefile("$config{destdir}/".htmlpage($page), $content);
+		writefile(htmlpage($page), $config{destdir},
+			genpage($page, $content, mtime($srcfile)));
 		$oldpagemtime{$page}=time;
-		$renderedfiles{$page}=htmlpage($page);
 	}
 	else {
-		$links{$file}=[];
-		check_overwrite("$config{destdir}/$file", $file);
-		writefile("$config{destdir}/$file", $content);
+		my $content=readfile($srcfile, 1);
+		delete $depends{$file};
+		will_render($file, $file, 1);
+		writefile($file, $config{destdir}, $content, 1);
 		$oldpagemtime{$file}=time;
-		$renderedfiles{$file}=$file;
 	}
 } #}}}
 
@@ -193,13 +213,13 @@ sub refresh () { #{{{
 	my %exists;
 	my @files;
 	eval q{use File::Find};
+	error($@) if $@;
 	find({
 		no_chdir => 1,
 		wanted => sub {
+			$_=decode_utf8($_);
 			if (/$config{wiki_file_prune_regexp}/) {
-				no warnings 'once';
 				$File::Find::prune=1;
-				use warnings "all";
 			}
 			elsif (! -d $_ && ! -l $_) {
 				my ($f)=/$config{wiki_file_regexp}/; # untaint
@@ -214,6 +234,31 @@ sub refresh () { #{{{
 			}
 		},
 	}, $config{srcdir});
+	find({
+		no_chdir => 1,
+		wanted => sub {
+			$_=decode_utf8($_);
+			if (/$config{wiki_file_prune_regexp}/) {
+				$File::Find::prune=1;
+			}
+			elsif (! -d $_ && ! -l $_) {
+				my ($f)=/$config{wiki_file_regexp}/; # untaint
+				if (! defined $f) {
+					warn("skipping bad filename $_\n");
+				}
+				else {
+					# Don't add files that are in the
+					# srcdir.
+					$f=~s/^\Q$config{underlaydir}\E\/?//;
+					if (! -e "$config{srcdir}/$f" && 
+					    ! -l "$config{srcdir}/$f") {
+						push @files, $f;
+						$exists{pagename($f)}=1;
+					}
+				}
+			}
+		},
+	}, $config{underlaydir});
 
 	my %rendered;
 
@@ -222,10 +267,15 @@ sub refresh () { #{{{
 	foreach my $file (@files) {
 		my $page=pagename($file);
 		if (! $oldpagemtime{$page}) {
-			debug("new page $page");
 			push @add, $file;
-			$links{$page}=[];
+			$pagecase{lc $page}=$page;
 			$pagesources{$page}=$file;
+			if ($config{getctime} && -e "$config{srcdir}/$file") {
+				$pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
+			}
+			elsif (! exists $pagectime{$page}) {
+				$pagectime{$page}=mtime(srcfile($file));
+			}
 		}
 	}
 	my @del;
@@ -233,61 +283,81 @@ sub refresh () { #{{{
 		if (! $exists{$page}) {
 			debug("removing old page $page");
 			push @del, $pagesources{$page};
-			prune($config{destdir}."/".$renderedfiles{$page});
-			delete $renderedfiles{$page};
+			$links{$page}=[];
+			$renderedfiles{$page}=[];
 			$oldpagemtime{$page}=0;
+			prune($config{destdir}."/".$_)
+				foreach @{$oldrenderedfiles{$page}};
 			delete $pagesources{$page};
 		}
 	}
-	
-	# render any updated files
+
+	# scan changed and new files
+	my @changed;
 	foreach my $file (@files) {
 		my $page=pagename($file);
 		
 		if (! exists $oldpagemtime{$page} ||
-		    mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
-		    	debug("rendering changed file $file");
-			render($file);
-			$rendered{$file}=1;
+		    mtime(srcfile($file)) > $oldpagemtime{$page} ||
+	    	    $forcerebuild{$page}) {
+		    	debug("scanning $file");
+			push @changed, $file;
+			scan($file);
 		}
 	}
+	calculate_backlinks();
+
+	# render changed and new pages
+	foreach my $file (@changed) {
+		debug("rendering $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
+	# rebuild pages that link to added or removed pages
 	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;
-					}
-				}
+		foreach my $f (@add, @del) {
+			my $p=pagename($f);
+			foreach my $page (keys %{$backlinks{$p}}) {
+				my $file=$pagesources{$page};
+				next if $rendered{$file};
+		   		debug("rendering $file, which links to $p");
+				render($file);
+				$rendered{$file}=1;
 			}
 		}
 	}
 
-	# handle backlinks; 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 backlinks could be wrong in the first pass render
-	# above
-	if (%rendered) {
+	if (%rendered || @del) {
+		# rebuild dependant pages
+		foreach my $f (@files) {
+			next if $rendered{$f};
+			my $p=pagename($f);
+			if (exists $depends{$p}) {
+				foreach my $file (keys %rendered, @del) {
+					next if $f eq $file;
+					my $page=pagename($file);
+					if (pagespec_match($page, $depends{$p})) {
+						debug("rendering $f, which depends on $page");
+						render($f);
+						$rendered{$f}=1;
+						last;
+					}
+				}
+			}
+		}
+		
+		# handle backlinks; if a page has added/removed links,
+		# update the pages it links to
 		my %linkchanged;
 		foreach my $file (keys %rendered, @del) {
 			my $page=pagename($file);
+			
 			if (exists $links{$page}) {
 				foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
 					if (length $link &&
-					    ! exists $oldlinks{$page} ||
-					    ! grep { $_ eq $link } @{$oldlinks{$page}}) {
+					    (! exists $oldlinks{$page} ||
+					     ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) {
 						$linkchanged{$link}=1;
 					}
 				}
@@ -295,8 +365,8 @@ FILE:		foreach my $file (@files) {
 			if (exists $oldlinks{$page}) {
 				foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
 					if (length $link &&
-					    ! exists $links{$page} ||
-					    ! grep { $_ eq $link } @{$links{$page}}) {
+					    (! exists $links{$page} || 
+					     ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) {
 						$linkchanged{$link}=1;
 					}
 				}
@@ -305,11 +375,56 @@ FILE:		foreach my $file (@files) {
 		foreach my $link (keys %linkchanged) {
 		    	my $linkfile=$pagesources{$link};
 			if (defined $linkfile) {
+				next if $rendered{$linkfile};
 				debug("rendering $linkfile, to update its backlinks");
 				render($linkfile);
+				$rendered{$linkfile}=1;
+			}
+		}
+	}
+
+	# remove no longer rendered files
+	foreach my $src (keys %rendered) {
+		my $page=pagename($src);
+		foreach my $file (@{$oldrenderedfiles{$page}}) {
+			if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
+				debug("removing $file, no longer rendered by $page");
+				prune($config{destdir}."/".$file);
 			}
 		}
 	}
+
+	if (@del) {
+		run_hooks(delete => sub { shift->(@del) });
+	}
+	if (%rendered) {
+		run_hooks(change => sub { shift->(keys %rendered) });
+	}
+} #}}}
+
+sub commandline_render () { #{{{
+	loadplugins();
+	checkconfig();
+	lockwiki();
+	loadindex();
+	unlockwiki();
+
+	my $srcfile=possibly_foolish_untaint($config{render});
+	my $file=$srcfile;
+	$file=~s/\Q$config{srcdir}\E\/?//;
+
+	my $type=pagetype($file);
+	die "ikiwiki: cannot render $srcfile\n" unless defined $type;
+	my $content=readfile($srcfile);
+	my $page=pagename($file);
+	$pagesources{$page}=$file;
+	$content=filter($page, $content);
+	$content=preprocess($page, $page, $content);
+	$content=linkify($page, $page, $content);
+	$content=htmlize($page, $type, $content);
+
+	print genpage($page, $content, mtime($srcfile));
+	exit 0;
 } #}}}
 
 1