X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/40af2fc96ce82eaa9b72d2a61cbfa1e4df33e673..ae0e6e816cd15dcadb88a8cf816d76b74a744ff3:/IkiWiki.pm?ds=inline

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 679ca716e..0af4a4fe9 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -18,7 +18,7 @@ our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
                  bestlink htmllink readfile writefile pagetype srcfile pagename
                  displaytime will_render gettext urlto targetpage
                  %config %links %renderedfiles %pagesources %destsources);
-our $VERSION = 1.02; # plugin interface version, next is ikiwiki version
+our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
@@ -31,14 +31,30 @@ memoize("file_pruned");
 sub defaultconfig () { #{{{
 	wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
 		qr/\.x?html?$/, qr/\.ikiwiki-new$/,
-		qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
-	wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]#]+)(?:#([^\s\]]+))?\]\]/,
+		qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
+		qr/\.dpkg-tmp$/],
+	wiki_link_regexp => qr{
+		\[\[			# beginning of link
+		(?:
+			([^\]\|]+)	# 1: link text
+			\|		# followed by '|'
+		)?			# optional
+
+		([^\s\]#]+)		# 2: page to link to
+		(?:
+			\#		# '#', beginning of anchor
+			([^\s\]]+)	# 3: anchor text
+		)?			# optional
+
+		\]\]			# end of link
+	}x,
 	wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
 	web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
 	verbose => 0,
 	syslog => 0,
 	wikiname => "wiki",
 	default_pageext => "mdwn",
+	htmlext => "html",
 	cgi => 0,
 	post_commit => 0,
 	rcs => '',
@@ -68,15 +84,17 @@ sub defaultconfig () { #{{{
 	setup => undef,
 	adminuser => undef,
 	adminemail => undef,
-	plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
+	plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit
 	              lockedit conditional}],
+	libdir => undef,
 	timeformat => '%c',
 	locale => undef,
 	sslcookie => 0,
 	httpauth => 0,
 	userdir => "",
-	usedirs => 0,
+	usedirs => 1,
 	numbacklinks => 10,
+	account_creation_password => "",
 } #}}}
    
 sub checkconfig () { #{{{
@@ -110,7 +128,7 @@ sub checkconfig () { #{{{
 		unless exists $config{wikistatedir};
 	
 	if ($config{rcs}) {
-		eval qq{require IkiWiki::Rcs::$config{rcs}};
+		eval qq{use IkiWiki::Rcs::$config{rcs}};
 		if ($@) {
 			error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
 		}
@@ -123,8 +141,12 @@ sub checkconfig () { #{{{
 } #}}}
 
 sub loadplugins () { #{{{
+	if (defined $config{libdir}) {
+		unshift @INC, $config{libdir};
+	}
+
 	loadplugin($_) foreach @{$config{plugin}};
-	
+
 	run_hooks(getopt => sub { shift->() });
 	if (grep /^-/, @ARGV) {
 		print STDERR "Unknown option: $_\n"
@@ -177,7 +199,7 @@ sub log_message ($$) { #{{{
 			$log_open=1;
 		}
 		eval {
-			Sys::Syslog::syslog($type, "%s", join(" ", @_));
+			Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
 		};
 	}
 	elsif (! $config{cgi}) {
@@ -190,7 +212,7 @@ sub log_message ($$) { #{{{
 
 sub possibly_foolish_untaint ($) { #{{{
 	my $tainted=shift;
-	my ($untainted)=$tainted=~/(.*)/;
+	my ($untainted)=$tainted=~/(.*)/s;
 	return $untainted;
 } #}}}
 
@@ -240,7 +262,7 @@ sub targetpage ($$) { #{{{
 sub htmlpage ($) { #{{{
 	my $page=shift;
 	
-	return targetpage($page, "html");
+	return targetpage($page, $config{htmlext});
 } #}}}
 
 sub srcfile ($) { #{{{
@@ -361,8 +383,14 @@ sub bestlink ($$) { #{{{
 		}
 	} while $cwd=~s!/?[^/]+$!!;
 
-	if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
-		return "$config{userdir}/".lc($link);
+	if (length $config{userdir}) {
+		my $l = "$config{userdir}/".lc($link);
+		if (exists $links{$l}) {
+			return $l;
+		}
+		elsif (exists $pagecase{lc $l}) {
+			return $pagecase{lc $l};
+		}
 	}
 
 	#print STDERR "warning: page $page, broken link: $link\n";
@@ -444,7 +472,7 @@ sub displaytime ($) { #{{{
 sub beautify_url ($) { #{{{
 	my $url=shift;
 
-	$url =~ s!/index.html$!/!;
+	$url =~ s!/index.$config{htmlext}$!/!;
 	$url =~ s!^$!./!; # Browsers don't like empty links...
 
 	return $url;
@@ -518,7 +546,12 @@ sub htmllink ($$$;@) { #{{{
 		$bestlink.="#".$opts{anchor};
 	}
 
-	return "<a href=\"$bestlink\">$linktext</a>";
+	my @attrs;
+	if (defined $opts{rel}) {
+		push @attrs, ' rel="'.$opts{rel}.'"';
+	}
+
+	return "<a href=\"$bestlink\"@attrs>$linktext</a>";
 } #}}}
 
 sub htmlize ($$$) { #{{{
@@ -584,14 +617,24 @@ sub preprocess ($$$;$$) { #{{{
 		my $command=shift;
 		my $params=shift;
 		if (length $escape) {
-			return "[[$command $params]]";
+			return "\\[[$command $params]]";
 		}
 		elsif (exists $hooks{preprocess}{$command}) {
 			return "" if $scan && ! $hooks{preprocess}{$command}{scan};
 			# Note: preserve order of params, some plugins may
 			# consider it significant.
 			my @params;
-			while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
+			while ($params =~ m{
+				(?:(\w+)=)?		# 1: named parameter key?
+				(?:
+					"""(.*?)"""	# 2: triple-quoted value
+				|
+					"([^"]+)"	# 3: single-quoted value
+				|
+					(\S+)		# 4: unquoted value
+				)
+				(?:\s+|$)		# delimiter to next param
+			}sgx) {
 				my $key=$1;
 				my $val;
 				if (defined $2) {
@@ -635,20 +678,42 @@ sub preprocess ($$$;$$) { #{{{
 			return $ret;
 		}
 		else {
-			return "[[$command $params]]";
+			return "\\[[$command $params]]";
 		}
 	};
 	
-	$content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+	$content =~ s{
+		(\\?)		# 1: escape?
+		\[\[		# directive open
+		(\w+)		# 2: command
+		\s+
+		(		# 3: the parameters..
+			(?:
+				(?:\w+=)?		# named parameter key?
+				(?:
+					""".*?"""	# triple-quoted value
+					|
+					"[^"]+"		# single-quoted value
+					|
+					[^\s\]]+	# unquoted value
+				)
+				\s*			# whitespace or end
+							# of directive
+			)
+		*)		# 0 or more parameters
+		\]\]		# directive closed
+	}{$handle->($1, $2, $3)}sexg;
 	return $content;
 } #}}}
 
-sub filter ($$) { #{{{
+sub filter ($$$) { #{{{
 	my $page=shift;
+	my $destpage=shift;
 	my $content=shift;
 
 	run_hooks(filter => sub {
-		$content=shift->(page => $page, content => $content);
+		$content=shift->(page => $page, destpage => $destpage, 
+			content => $content);
 	});
 
 	return $content;
@@ -658,7 +723,8 @@ sub indexlink () { #{{{
 	return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
 
-sub lockwiki () { #{{{
+sub lockwiki (;$) { #{{{
+	my $wait=@_ ? shift : 1;
 	# Take an exclusive lock on the wiki to prevent multiple concurrent
 	# run issues. The lock will be dropped on program exit.
 	if (! -d $config{wikistatedir}) {
@@ -667,15 +733,21 @@ sub lockwiki () { #{{{
 	open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
 		error ("cannot write to $config{wikistatedir}/lockfile: $!");
 	if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB
-		debug("wiki seems to be locked, waiting for lock");
-		my $wait=600; # arbitrary, but don't hang forever to 
-		              # prevent process pileup
-		for (1..$wait) {
-			return if flock(WIKILOCK, 2 | 4);
-			sleep 1;
+		if ($wait) {
+			debug("wiki seems to be locked, waiting for lock");
+			my $wait=600; # arbitrary, but don't hang forever to 
+			              # prevent process pileup
+			for (1..$wait) {
+				return if flock(WIKILOCK, 2 | 4);
+				sleep 1;
+			}
+			error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
+		}
+		else {
+			return 0;
 		}
-		error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
 	}
+	return 1;
 } #}}}
 
 sub unlockwiki () { #{{{
@@ -729,9 +801,9 @@ sub loadindex () { #{{{
 			$depends{$page}=$items{depends}[0] if exists $items{depends};
 			$destsources{$_}=$page foreach @{$items{dest}};
 			$renderedfiles{$page}=[@{$items{dest}}];
-			$oldrenderedfiles{$page}=[@{$items{dest}}];
 			$pagecase{lc $page}=$page;
 		}
+		$oldrenderedfiles{$page}=[@{$items{dest}}];
 		$pagectime{$page}=$items{ctime}[0];
 	}
 	close IN;
@@ -781,7 +853,6 @@ sub template_params (@) { #{{{
 		return "";
 	}
 
-	require HTML::Template;
 	my @ret=(
 		filter => sub {
 			my $text_ref = shift;
@@ -796,6 +867,7 @@ sub template_params (@) { #{{{
 } #}}}
 
 sub template ($;@) { #{{{
+	require HTML::Template;
 	HTML::Template->new(template_params(@_));
 } #}}}
 
@@ -960,7 +1032,21 @@ sub pagespec_translate ($) { #{{{
 
 	# Convert spec to perl code.
 	my $code="";
-	while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
+	while ($spec=~m{
+		\s*		# ignore whitespace
+		(		# 1: match a single word
+			\!		# !
+		|
+			\(		# (
+		|
+			\)		# )
+		|
+			\w+\([^\)]+\)	# command(params)
+		|
+			[^\s()]+	# any other text
+		)
+		\s*		# ignore whitespace
+	}igx) {
 		my $word=$1;
 		if (lc $word eq "and") {
 			$code.=" &&";
@@ -973,42 +1059,74 @@ sub pagespec_translate ($) { #{{{
 		}
 		elsif ($word =~ /^(\w+)\((.*)\)$/) {
 			if (exists $IkiWiki::PageSpec::{"match_$1"}) {
-				$code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \$from)";
+				$code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
 			}
 			else {
 				$code.=" 0";
 			}
 		}
 		else {
-			$code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";
+			$code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)";
 		}
 	}
 
 	return $code;
 } #}}}
 
-sub pagespec_match ($$;$) { #{{{
+sub pagespec_match ($$;@) { #{{{
 	my $page=shift;
 	my $spec=shift;
-	my $from=shift;
+	my @params=@_;
+
+	# Backwards compatability with old calling convention.
+	if (@params == 1) {
+		unshift @params, "location";
+	}
 
-	return eval pagespec_translate($spec);
+	my $ret=eval pagespec_translate($spec);
+	return IkiWiki::FailReason->new("syntax error") if $@;
+	return $ret;
 } #}}}
 
+package IkiWiki::FailReason;
+
+use overload ( #{{{
+	'""'	=> sub { ${$_[0]} },
+	'0+'	=> sub { 0 },
+	'!'	=> sub { bless $_[0], 'IkiWiki::SuccessReason'},
+	fallback => 1,
+); #}}}
+
+sub new { #{{{
+	bless \$_[1], $_[0];
+} #}}}
+
+package IkiWiki::SuccessReason;
+
+use overload ( #{{{
+	'""'	=> sub { ${$_[0]} },
+	'0+'	=> sub { 1 },
+	'!'	=> sub { bless $_[0], 'IkiWiki::FailReason'},
+	fallback => 1,
+); #}}}
+
+sub new { #{{{
+	bless \$_[1], $_[0];
+}; #}}}
+
 package IkiWiki::PageSpec;
 
-sub match_glob ($$$) { #{{{
+sub match_glob ($$;@) { #{{{
 	my $page=shift;
 	my $glob=shift;
-	my $from=shift;
-	if (! defined $from){
-		$from = "";
-	}
-
+	my %params=@_;
+	
+	my $from=exists $params{location} ? $params{location} : "";
+	
 	# relative matching
 	if ($glob =~ m!^\./!) {
-		$from=~s!/?[^/]+$!!;
-		$glob=~s!^\./!!;
+		$from=~s#/?[^/]+$##;
+		$glob=~s#^\./##;
 		$glob="$from/$glob" if length $from;
 	}
 
@@ -1017,72 +1135,121 @@ sub match_glob ($$$) { #{{{
 	$glob=~s/\\\*/.*/g;
 	$glob=~s/\\\?/./g;
 
-	return $page=~/^$glob$/i;
+	if ($page=~/^$glob$/i) {
+		return IkiWiki::SuccessReason->new("$glob matches $page");
+	}
+	else {
+		return IkiWiki::FailReason->new("$glob does not match $page");
+	}
 } #}}}
 
-sub match_link ($$$) { #{{{
+sub match_link ($$;@) { #{{{
 	my $page=shift;
 	my $link=lc(shift);
-	my $from=shift;
-	if (! defined $from){
-		$from = "";
-	}
+	my %params=@_;
+
+	my $from=exists $params{location} ? $params{location} : "";
 
 	# relative matching
 	if ($link =~ m!^\.! && defined $from) {
-		$from=~s!/?[^/]+$!!;
-		$link=~s!^\./!!;
+		$from=~s#/?[^/]+$##;
+		$link=~s#^\./##;
 		$link="$from/$link" if length $from;
 	}
 
 	my $links = $IkiWiki::links{$page} or return undef;
-	return 0 unless @$links;
+	return IkiWiki::FailReason->new("$page has no links") unless @$links;
 	my $bestlink = IkiWiki::bestlink($from, $link);
-	return 0 unless length $bestlink;
 	foreach my $p (@$links) {
-		return 1 if $bestlink eq IkiWiki::bestlink($page, $p);
+		if (length $bestlink) {
+			return IkiWiki::SuccessReason->new("$page links to $link")
+				if $bestlink eq IkiWiki::bestlink($page, $p);
+		}
+		else {
+			return IkiWiki::SuccessReason->new("$page links to page matching $link")
+				if match_glob($p, $link, %params);
+		}
 	}
-	return 0;
+	return IkiWiki::FailReason->new("$page does not link to $link");
 } #}}}
 
-sub match_backlink ($$$) { #{{{
-	match_link($_[1], $_[0], $_[3]);
+sub match_backlink ($$;@) { #{{{
+	match_link($_[1], $_[0], @_);
 } #}}}
 
-sub match_created_before ($$$) { #{{{
+sub match_created_before ($$;@) { #{{{
 	my $page=shift;
 	my $testpage=shift;
 
 	if (exists $IkiWiki::pagectime{$testpage}) {
-		return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};
+		if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
+			IkiWiki::SuccessReason->new("$page created before $testpage");
+		}
+		else {
+			IkiWiki::FailReason->new("$page not created before $testpage");
+		}
 	}
 	else {
-		return 0;
+		return IkiWiki::FailReason->new("$testpage has no ctime");
 	}
 } #}}}
 
-sub match_created_after ($$$) { #{{{
+sub match_created_after ($$;@) { #{{{
 	my $page=shift;
 	my $testpage=shift;
 
 	if (exists $IkiWiki::pagectime{$testpage}) {
-		return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};
+		if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
+			IkiWiki::SuccessReason->new("$page created after $testpage");
+		}
+		else {
+			IkiWiki::FailReason->new("$page not created after $testpage");
+		}
 	}
 	else {
-		return 0;
+		return IkiWiki::FailReason->new("$testpage has no ctime");
 	}
 } #}}}
 
-sub match_creation_day ($$$) { #{{{
-	return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
+sub match_creation_day ($$;@) { #{{{
+	if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+		return IkiWiki::SuccessReason->new("creation_day matched");
+	}
+	else {
+		return IkiWiki::FailReason->new("creation_day did not match");
+	}
 } #}}}
 
-sub match_creation_month ($$$) { #{{{
-	return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
+sub match_creation_month ($$;@) { #{{{
+	if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
+		return IkiWiki::SuccessReason->new("creation_month matched");
+	}
+	else {
+		return IkiWiki::FailReason->new("creation_month did not match");
+	}
 } #}}}
 
-sub match_creation_year ($$$) { #{{{
-	return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);
+sub match_creation_year ($$;@) { #{{{
+	if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
+		return IkiWiki::SuccessReason->new("creation_year matched");
+	}
+	else {
+		return IkiWiki::FailReason->new("creation_year did not match");
+	}
+} #}}}
+
+sub match_user ($$;@) { #{{{
+	shift;
+	my $user=shift;
+	my %params=@_;
+
+	return IkiWiki::FailReason->new("cannot match user") unless exists $params{user};
+	if ($user eq $params{user}) {
+		return IkiWiki::SuccessReason->new("user is $user")
+	}
+	else {
+		return IkiWiki::FailReason->new("user is not $user");
+	}
 } #}}}
 
 1