X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/78b279c3d8c803391a5a4fc59ffd7855ce8bc5f5..e9a40c8716afd6076c630a140186ee7b2ec9cfb4:/IkiWiki/Render.pm

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 8657dc380..4fefadf09 100644
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -7,60 +7,44 @@ use strict;
 use IkiWiki;
 use Encode;
 
-sub linkify ($$$) { #{{{
-	my $lpage=shift; # the page containing the links
-	my $page=shift; # the page the link will end up on (different for inline)
-	my $content=shift;
-
-	$content =~ s{(\\?)$config{wiki_link_regexp}}{
-		$2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
-		   : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
-	}eg;
-	
-	return $content;
-} #}}}
-
-sub htmlize ($$) { #{{{
-	my $type=shift;
-	my $content=shift;
-	
-	if (exists $hooks{htmlize}{$type}) {
-		$content=$hooks{htmlize}{$type}{call}->($content);
-	}
-	else {
-		error("htmlization of $type not supported");
+my %backlinks;
+my $backlinks_calculated=0;
+
+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;
+			}
+		}
 	}
-
-	run_hooks(sanitize => sub {
-		$content=shift->($content);
-	});
-	
-	return $content;
+	$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=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 => pagetitle($p_trimmed) };
-		}
+	foreach my $p (keys %{$backlinks{$page}}) {
+		my $href=urlto($p, $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 => pagetitle($p_trimmed) };
 	}
-
-	return sort { $a->{page} cmp $b->{page} } @links;
+	return @links;
 } #}}}
 
 sub parentlinks ($) { #{{{
@@ -69,86 +53,34 @@ sub parentlinks ($) { #{{{
 	my @ret;
 	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.htmlpage($dir), page => pagetitle($dir) };
-		}
-		else {
-			$skip=0;
-		}
+	my $title=$config{wikiname};
+	
+	foreach my $dir (split("/", $page)) {
+		next if $dir eq 'index';
+		push @ret, { url => urlto($path, $page), page => $title };
+		$path.="/".$dir;
+		$title=pagetitle($dir);
 	}
-	unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
 	return @ret;
 } #}}}
 
-sub preprocess ($$$;$) { #{{{
-	my $page=shift; # the page the data comes from
-	my $destpage=shift; # the page the data will appear in (different for inline)
-	my $content=shift;
-	my $onlystrip=shift || 0; # strip directives without processing
-
-	my $handle=sub {
-		my $escape=shift;
-		my $command=shift;
-		my $params=shift;
-		if (length $escape) {
-			return "[[$command $params]]";
-		}
-		elsif ($onlystrip) {
-			return "";
-		}
-		elsif (exists $hooks{preprocess}{$command}) {
-			# Note: preserve order of params, some plugins may
-			# consider it significant.
-			my @params;
-			while ($params =~ /(?:(\w+)=)?(?:"([^"]+)"|(\S+))(?:\s+|$)/g) {
-				if (defined $1) {
-					push @params, $1, (defined $2 ? $2 : $3);
-				}
-				else {
-					push @params, (defined $2 ? $2 : $3), '';
-				}
-			}
-			return $hooks{preprocess}{$command}{call}->(
-				@params,
-				page => $page,
-				destpage => $destpage,
-			);
-		}
-		else {
-			return "[[$command not processed]]";
-		}
-	};
-	
-	$content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}eg;
-	return $content;
-} #}}}
-
-sub add_depends ($$) { #{{{
-	my $page=shift;
-	my $pagespec=shift;
-	
-	if (! exists $depends{$page}) {
-		$depends{$page}=$pagespec;
-	}
-	else {
-		$depends{$page}=pagespec_merge($depends{$page}, $pagespec);
-	}
-} # }}}
-
-sub genpage ($$$) { #{{{
+sub genpage ($$) { #{{{
 	my $page=shift;
 	my $content=shift;
-	my $mtime=shift;
 
-	my $template=template("page.tmpl", blind_cache => 1);
+	my $templatefile;
+	run_hooks(templatefile => sub {
+		return if defined $templatefile;
+		my $file=shift->(page => $page);
+		if (defined $file && defined template_file($file)) {
+			$templatefile=$file;
+		}
+	});
+	my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1);
 	my $actions=0;
 
 	if (length $config{cgiurl}) {
-		$template->param(editurl => cgiurl(do => "edit", page => $page));
+		$template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
 		$template->param(prefsurl => cgiurl(do => "prefs"));
 		if ($config{rcs}) {
 			$template->param(recentchangesurl => cgiurl(do => "recentchanges"));
@@ -163,14 +95,30 @@ sub genpage ($$$) { #{{{
 		$actions++;
 	}
 	if ($config{discussion}) {
-		$template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
-		$actions++;
+		my $discussionlink=gettext("discussion");
+		if ($page !~ /.*\/\Q$discussionlink\E$/ &&
+		   (length $config{cgiurl} ||
+		    exists $links{$page."/".$discussionlink})) {
+			$template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), noimageinline => 1, forcesubpage => 1));
+			$actions++;
+		}
 	}
 
 	if ($actions) {
 		$template->param(have_actions => 1);
 	}
 
+	my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
+	my ($backlinks, $more_backlinks);
+	if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) {
+		$backlinks=\@backlinks;
+		$more_backlinks=[];
+	}
+	else {
+		$backlinks=[@backlinks[0..$config{numbacklinks}-1]];
+		$more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
+	}
+
 	$template->param(
 		title => $page eq 'index' 
 			? $config{wikiname} 
@@ -178,8 +126,9 @@ sub genpage ($$$) { #{{{
 		wikiname => $config{wikiname},
 		parentlinks => [parentlinks($page)],
 		content => $content,
-		backlinks => [backlinks($page)],
-		mtime => displaytime($mtime),
+		backlinks => $backlinks,
+		more_backlinks => $more_backlinks,
+		mtime => displaytime($pagemtime{$page}),
 		baseurl => baseurl($page),
 	);
 
@@ -190,100 +139,99 @@ sub genpage ($$$) { #{{{
 	$content=$template->output;
 
 	run_hooks(format => sub {
-		$content=shift->($content);
+		$content=shift->(
+			page => $page,
+			content => $content,
+		);
 	});
 
 	return $content;
 } #}}}
 
-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;
-	
-	if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
-		error("$dest already exists and was not rendered from $src before");
-	}
-} #}}}
-
-sub displaytime ($) { #{{{
-	my $time=shift;
-
-	eval q{use POSIX};
-	# strftime doesn't know about encodings, so make sure
-	# its output is properly treated as utf8
-	return decode_utf8(POSIX::strftime(
-			$config{timeformat}, localtime($time)));
-} #}}}
-
 sub mtime ($) { #{{{
 	my $file=shift;
 	
 	return (stat($file))[9];
 } #}}}
 
-sub findlinks ($$) { #{{{
-	my $page=shift;
-	my $content=shift;
+sub scan ($) { #{{{
+	my $file=shift;
 
-	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.
-		return @links, "$page/discussion";
+	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, $page, $content);
+
+		my @links;
+		while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
+			push @links, linkpage($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."/".gettext("discussion");
+		}
+		$links{$page}=\@links;
+		
+		# Preprocess in scan-only mode.
+		preprocess($page, $page, $content, 1);
 	}
 	else {
-		return @links;
+		will_render($file, $file, 1);
 	}
 } #}}}
 
-sub filter ($$) {
-	my $page=shift;
-	my $content=shift;
-
-	run_hooks(filter => sub {
-		$content=shift->(page => $page, content => $content);
-	});
-
-	return $content;
-}
-
 sub render ($) { #{{{
 	my $file=shift;
 	
 	my $type=pagetype($file);
 	my $srcfile=srcfile($file);
 	if (defined $type) {
-		my $content=readfile($srcfile);
 		my $page=pagename($file);
 		delete $depends{$page};
+		will_render($page, htmlpage($page), 1);
 		
-		$content=filter($page, $content);
-		
-		$links{$page}=[findlinks($page, $content)];
-		
-		$content=linkify($page, $page, $content);
-		$content=preprocess($page, $page, $content);
-		$content=htmlize($type, $content);
+		my $content=htmlize($page, $type,
+			linkify($page, $page,
+			preprocess($page, $page,
+			filter($page, $page,
+			readfile($srcfile)))));
 		
-		check_overwrite("$config{destdir}/".htmlpage($page), $page);
-		writefile(htmlpage($page), $config{destdir},
-			genpage($page, $content, mtime($srcfile)));
-		$oldpagemtime{$page}=time;
-		$renderedfiles{$page}=htmlpage($page);
+		my $output=htmlpage($page);
+		writefile($output, $config{destdir}, genpage($page, $content));
+		utime($pagemtime{$page}, $pagemtime{$page}, $config{destdir}."/".$output);
 	}
 	else {
-		my $content=readfile($srcfile, 1);
-		$links{$file}=[];
+		my $srcfd=readfile($srcfile, 1, 1);
 		delete $depends{$file};
-		check_overwrite("$config{destdir}/$file", $file);
-		writefile($file, $config{destdir}, $content, 1);
-		$oldpagemtime{$file}=time;
-		$renderedfiles{$file}=$file;
+		will_render($file, $file, 1);
+		writefile($file, $config{destdir}, undef, 1, sub {
+			my $destfd=shift;
+			my $cleanup=shift;
+
+			my $blksize = 16384;
+			my ($len, $buf, $written);
+			while ($len = sysread $srcfd, $buf, $blksize) {
+				if (! defined $len) {
+					next if $! =~ /^Interrupted/;
+					error("failed to read $srcfile: $!", $cleanup);
+				}
+				my $offset = 0;
+				while ($len) {
+					defined($written = syswrite $destfd, $buf, $len, $offset)
+						or error("failed to write $file: $!", $cleanup);
+					$len -= $written;
+					$offset += $written;
+				}
+			}
+		});
+		utime($pagemtime{$file}, $pagemtime{$file}, $config{destdir}."/".$file);
 	}
 } #}}}
 
@@ -298,21 +246,33 @@ sub prune ($) { #{{{
 } #}}}
 
 sub refresh () { #{{{
+	# security check, avoid following symlinks in the srcdir path
+	my $test=$config{srcdir};
+	while (length $test) {
+		if (-l $test) {
+			error("symlink found in srcdir path ($test)");
+		}
+		unless ($test=~s/\/+$//) {
+			$test=dirname($test);
+		}
+	}
+
 	# find existing pages
 	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}/) {
+			if (file_pruned($_, $config{srcdir})) {
 				$File::Find::prune=1;
 			}
 			elsif (! -d $_ && ! -l $_) {
 				my ($f)=/$config{wiki_file_regexp}/; # untaint
 				if (! defined $f) {
-					warn("skipping bad filename $_\n");
+					warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
 				}
 				else {
 					$f=~s/^\Q$config{srcdir}\E\/?//;
@@ -322,31 +282,37 @@ 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");
+	foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
+		find({
+			no_chdir => 1,
+			wanted => sub {
+				$_=decode_utf8($_);
+				if (file_pruned($_, $dir)) {
+					$File::Find::prune=1;
 				}
-				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;
+				elsif (! -d $_ && ! -l $_) {
+					my ($f)=/$config{wiki_file_regexp}/; # untaint
+					if (! defined $f) {
+						warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
+					}
+					else {
+						$f=~s/^\Q$dir\E\/?//;
+						# avoid underlaydir
+						# override attacks; see
+						# security.mdwn
+						if (! -e "$config{srcdir}/$f" && 
+						    ! -l "$config{srcdir}/$f") {
+						    	my $page=pagename($f);
+							if (! $exists{$page}) {
+								push @files, $f;
+								$exists{$page}=1;
+							}
+						}
 					}
 				}
-			}
-		},
-	}, $config{underlaydir});
+			},
+		}, $dir);
+	};
 
 	my %rendered;
 
@@ -354,12 +320,10 @@ sub refresh () { #{{{
 	my @add;
 	foreach my $file (@files) {
 		my $page=pagename($file);
-		if (! $oldpagemtime{$page}) {
-			debug("new page $page") unless exists $pagectime{$page};
+		$pagesources{$page}=$file;
+		if (! $pagemtime{$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");
 			}
@@ -369,66 +333,76 @@ sub refresh () { #{{{
 		}
 	}
 	my @del;
-	foreach my $page (keys %oldpagemtime) {
+	foreach my $page (keys %pagemtime) {
 		if (! $exists{$page}) {
-			debug("removing old page $page");
+			debug(sprintf(gettext("removing old page %s"), $page));
 			push @del, $pagesources{$page};
-			prune($config{destdir}."/".$renderedfiles{$page});
-			delete $renderedfiles{$page};
-			$oldpagemtime{$page}=0;
+			$links{$page}=[];
+			$renderedfiles{$page}=[];
+			$pagemtime{$page}=0;
+			prune($config{destdir}."/".$_)
+				foreach @{$oldrenderedfiles{$page}};
 			delete $pagesources{$page};
+			foreach (keys %destsources) {
+				if ($destsources{$_} eq $page) {
+					delete $destsources{$_};
+				}
+			}
 		}
 	}
-	
-	# render any updated files
+
+	# find changed and new files
+	my @needsbuild;
 	foreach my $file (@files) {
 		my $page=pagename($file);
 		
-		if (! exists $oldpagemtime{$page} ||
-		    mtime(srcfile($file)) > $oldpagemtime{$page} ||
+		my $mtime=mtime(srcfile($file));
+		if (! exists $pagemtime{$page} ||
+		    $mtime > $pagemtime{$page} ||
 	    	    $forcerebuild{$page}) {
-		    	debug("rendering $file");
-			render($file);
-			$rendered{$file}=1;
+			$pagemtime{$page}=$mtime;
+			push @needsbuild, $file;
 		}
 	}
+	run_hooks(needsbuild => sub { shift->(\@needsbuild) });
+
+	# scan and render files
+	foreach my $file (@needsbuild) {
+		debug(sprintf(gettext("scanning %s"), $file));
+		scan($file);
+	}
+	calculate_backlinks();
+	foreach my $file (@needsbuild) {
+		debug(sprintf(gettext("rendering %s"), $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 or inlining 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(sprintf(gettext("rendering %s, which links to %s"), $file, $p));
+				render($file);
+				$rendered{$file}=1;
 			}
 		}
 	}
 
-	# Handle backlinks; if a page has added/removed links, update the
-	# pages it links to. Also handles rebuilding dependant pages.
-	# 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 || @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");
+					if (pagespec_match($page, $depends{$p}, location => $p)) {
+						debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page));
 						render($f);
 						$rendered{$f}=1;
 						last;
@@ -437,6 +411,8 @@ FILE:		foreach my $file (@files) {
 			}
 		}
 		
+		# 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);
@@ -463,13 +439,25 @@ FILE:		foreach my $file (@files) {
 		foreach my $link (keys %linkchanged) {
 		    	my $linkfile=$pagesources{$link};
 			if (defined $linkfile) {
-				debug("rendering $linkfile, to update its backlinks");
+				next if $rendered{$linkfile};
+				debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));
 				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(sprintf(gettext("removing %s, no longer rendered by %s"), $file, $page));
+				prune($config{destdir}."/".$file);
+			}
+		}
+	}
+
 	if (@del) {
 		run_hooks(delete => sub { shift->(@del) });
 	}
@@ -478,4 +466,30 @@ FILE:		foreach my $file (@files) {
 	}
 } #}}}
 
+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 sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type;
+	my $content=readfile($srcfile);
+	my $page=pagename($file);
+	$pagesources{$page}=$file;
+	$content=filter($page, $page, $content);
+	$content=preprocess($page, $page, $content);
+	$content=linkify($page, $page, $content);
+	$content=htmlize($page, $type, $content);
+	$pagemtime{$page}=mtime($srcfile);
+
+	print genpage($page, $content);
+	exit 0;
+} #}}}
+
 1