X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c9dbcd29e5fc244845434a7ccbf96067831315bb..e0c387c8d048107edf9549d0f353d23d313620b7:/IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 5ebec5d0b..168d800ba 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -7,16 +7,27 @@ use Encode;
 use HTML::Entities;
 use open qw{:utf8 :std};
 
+use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
+            %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
+	    %forcerebuild};
+
+use Exporter q{import};
+our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
+                 bestlink htmllink readfile writefile pagetype srcfile pagename
+                 displaytime
+                 %config %links %renderedfiles %pagesources);
+our $VERSION = 1.01; # plugin interface version
+
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
-            %renderedfiles %pagesources %depends %hooks %forcerebuild};
+my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
+our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 
 sub defaultconfig () { #{{{
-	wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$)},
+	wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$|\.atom$|.arch-ids/|{arch}/)},
 	wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
 	wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
 	verbose => 0,
@@ -32,6 +43,7 @@ sub defaultconfig () { #{{{
 	diffurl => '',
 	anonok => 0,
 	rss => 0,
+	atom => 0,
 	discussion => 1,
 	rebuild => 0,
 	refresh => 0,
@@ -44,14 +56,16 @@ sub defaultconfig () { #{{{
 	srcdir => undef,
 	destdir => undef,
 	pingurl => [],
-	templatedir => "/usr/share/ikiwiki/templates",
-	underlaydir => "/usr/share/ikiwiki/basewiki",
+	templatedir => "$installdir/share/ikiwiki/templates",
+	underlaydir => "$installdir/share/ikiwiki/basewiki",
 	setup => undef,
 	adminuser => undef,
 	adminemail => undef,
 	plugin => [qw{mdwn inline htmlscrubber}],
 	timeformat => '%c',
 	locale => undef,
+	sslcookie => 0,
+	httpauth => 0,
 } #}}}
    
 sub checkconfig () { #{{{
@@ -78,8 +92,8 @@ sub checkconfig () { #{{{
 	if ($config{cgi} && ! length $config{url}) {
 		error("Must specify url to wiki with --url when using --cgi\n");
 	}
-	if ($config{rss} && ! length $config{url}) {
-		error("Must specify url to wiki with --url when using --rss\n");
+	if (($config{rss} || $config{atom}) && ! length $config{url}) {
+		error("Must specify url to wiki with --url when using --rss or --atom\n");
 	}
 	
 	$config{wikistatedir}="$config{srcdir}/.ikiwiki"
@@ -250,12 +264,26 @@ sub writefile ($$$;$) { #{{{
 	close OUT;
 } #}}}
 
+sub will_render ($$;$) { #{{{
+	my $page=shift;
+	my $dest=shift;
+	my $clear=shift;
+
+	# Important security check.
+	if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
+	    ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
+		error("$config{destdir}/$dest independently created, not overwriting with version from $page");
+	}
+
+	if (! $clear) {
+		$renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
+	}
+	else {
+		$renderedfiles{$page}=[$dest];
+	}
+} #}}}
+
 sub bestlink ($$) { #{{{
-	# 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.
 	my $page=shift;
 	my $link=shift;
 	
@@ -316,7 +344,7 @@ sub baseurl (;$) { #{{{
 sub abs2rel ($$) { #{{{
 	# Work around very innefficient behavior in File::Spec if abs2rel
 	# is passed two relative paths. It's much faster if paths are
-	# absolute!
+	# absolute! (Debian bug #376658)
 	my $path="/".shift;
 	my $base="/".shift;
 
@@ -326,6 +354,16 @@ sub abs2rel ($$) { #{{{
 	return $ret;
 } #}}}
 
+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 htmllink ($$$;$$$) { #{{{
 	my $lpage=shift; # the page doing the linking
 	my $page=shift; # the page that will contain the link (different for inline)
@@ -350,10 +388,10 @@ sub htmllink ($$$;$$$) { #{{{
 	# 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 that makes all new files be rendered twice.
-	if (! grep { $_ eq $bestlink } values %renderedfiles) {
+	if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
 		$bestlink=htmlpage($bestlink);
 	}
-	if (! grep { $_ eq $bestlink } values %renderedfiles) {
+	if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
 		return "<span><a href=\"".
 			cgiurl(do => "create", page => lc($link), from => $page).
 			"\">?</a>$linktext</span>"
@@ -367,6 +405,117 @@ sub htmllink ($$$;$$$) { #{{{
 	return "<a href=\"$bestlink\">$linktext</a>";
 } #}}}
 
+sub htmlize ($$$) { #{{{
+	my $page=shift;
+	my $type=shift;
+	my $content=shift;
+
+	if (exists $hooks{htmlize}{$type}) {
+		$content=$hooks{htmlize}{$type}{call}->(
+			page => $page,
+			content => $content,
+		);
+	}
+	else {
+		error("htmlization of $type not supported");
+	}
+
+	run_hooks(sanitize => sub {
+		$content=shift->(
+			page => $page,
+			content => $content,
+		);
+	});
+
+	return $content;
+} #}}}
+
+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;
+} #}}}
+
+my %preprocessing;
+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 $handle=sub {
+		my $escape=shift;
+		my $command=shift;
+		my $params=shift;
+		if (length $escape) {
+			return "[[$command $params]]";
+		}
+		elsif (exists $hooks{preprocess}{$command}) {
+			# Note: preserve order of params, some plugins may
+			# consider it significant.
+			my @params;
+			while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
+				my $key=$1;
+				my $val;
+				if (defined $2) {
+					$val=$2;
+					$val=~s/\r\n/\n/mg;
+					$val=~s/^\n+//g;
+					$val=~s/\n+$//g;
+				}
+				elsif (defined $3) {
+					$val=$3;
+				}
+				elsif (defined $4) {
+					$val=$4;
+				}
+
+				if (defined $key) {
+					push @params, $key, $val;
+				}
+				else {
+					push @params, $val, '';
+				}
+			}
+			if ($preprocessing{$page}++ > 3) {
+				# Avoid loops of preprocessed pages preprocessing
+				# other pages that preprocess them, etc.
+				return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]";
+			}
+			my $ret=$hooks{preprocess}{$command}{call}->(
+				@params,
+				page => $page,
+				destpage => $destpage,
+			);
+			$preprocessing{$page}--;
+			return $ret;
+		}
+		else {
+			return "[[$command $params]]";
+		}
+	};
+	
+	$content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+	return $content;
+} #}}}
+
+sub filter ($$) {
+	my $page=shift;
+	my $content=shift;
+
+	run_hooks(filter => sub {
+		$content=shift->(page => $page, content => $content);
+	});
+
+	return $content;
+}
+
 sub indexlink () { #{{{
 	return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
@@ -402,6 +551,7 @@ sub loadindex () { #{{{
 		chomp;
 		my %items;
 		$items{link}=[];
+		$items{dest}=[];
 		foreach my $i (split(/ /, $_)) {
 			my ($item, $val)=split(/=/, $i, 2);
 			push @{$items{$item}}, decode_entities($val);
@@ -416,7 +566,8 @@ sub loadindex () { #{{{
 			$oldlinks{$page}=[@{$items{link}}];
 			$links{$page}=[@{$items{link}}];
 			$depends{$page}=$items{depends}[0] if exists $items{depends};
-			$renderedfiles{$page}=$items{dest}[0];
+			$renderedfiles{$page}=[@{$items{dest}}];
+			$oldrenderedfiles{$page}=[@{$items{dest}}];
 			$pagecase{lc $page}=$page;
 		}
 		$pagectime{$page}=$items{ctime}[0];
@@ -436,8 +587,8 @@ sub saveindex () { #{{{
 		next unless $oldpagemtime{$page};
 		my $line="mtime=$oldpagemtime{$page} ".
 			"ctime=$pagectime{$page} ".
-			"src=$pagesources{$page} ".
-			"dest=$renderedfiles{$page}";
+			"src=$pagesources{$page}";
+		$line.=" dest=$_" foreach @{$renderedfiles{$page}};
 		$line.=" link=$_" foreach @{$links{$page}};
 		if (exists $depends{$page}) {
 			$line.=" depends=".encode_entities($depends{$page}, " \t\n");
@@ -465,7 +616,7 @@ sub template ($;@) { #{{{
 	HTML::Template->new(template_params(@_));
 } #}}}
 
-sub misctemplate ($$) { #{{{
+sub misctemplate ($$;@) { #{{{
 	my $title=shift;
 	my $pagebody=shift;
 	
@@ -476,7 +627,11 @@ sub misctemplate ($$) { #{{{
 		wikiname => $config{wikiname},
 		pagebody => $pagebody,
 		baseurl => baseurl(),
+		@_,
 	);
+	run_hooks(pagetemplate => sub {
+		shift->(page => "", destpage => "", template => $template);
+	});
 	return $template->output;
 }#}}}
 
@@ -591,6 +746,18 @@ sub pagespec_translate ($) { #{{{
 	return $code;
 } #}}}
 
+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 pagespec_match ($$) { #{{{
 	my $page=shift;
 	my $spec=shift;