X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/61426a71868a6863115b0a4e0467756e97953092..c807d043aac28502e14becf3b126793d7a5ee20d:/IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 9a81c7da4..17e2a2a85 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -12,16 +12,17 @@ use Storable;
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
-	    %pagestate %renderedfiles %oldrenderedfiles %pagesources
-	    %destsources %depends %hooks %forcerebuild $gettext_obj
-	    %loaded_plugins};
+	    %pagestate %wikistate %renderedfiles %oldrenderedfiles
+	    %pagesources %destsources %depends %hooks %forcerebuild
+	    $gettext_obj %loaded_plugins};
 
 use Exporter q{import};
 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
-		 add_underlay pagetitle titlepage linkpage
-                 %config %links %pagestate %renderedfiles
+		 add_underlay pagetitle titlepage linkpage newpagefile
+		 inject
+                 %config %links %pagestate %wikistate %renderedfiles
                  %pagesources %destsources);
 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
@@ -119,7 +120,7 @@ sub getsetup () { #{{{
 	},
 	default_plugins => {
 		type => "internal",
-		default => [qw{mdwn link inline htmlscrubber passwordauth
+		default => [qw{mdwn link inline meta htmlscrubber passwordauth
 				openid signinedit lockedit conditional
 				recentchanges parentlinks editpage}],
 		description => "plugins to enable by default",
@@ -198,6 +199,13 @@ sub getsetup () { #{{{
 		safe => 0, # changing requires manual transition
 		rebuild => 1,
 	},
+	indexpages => {
+		type => "boolean",
+		default => 0,
+		description => "use page/index.mdwn source files",
+		safe => 1,
+		rebuild => 1,
+	},
 	discussion => {
 		type => "boolean",
 		default => 1,
@@ -374,6 +382,13 @@ sub getsetup () { #{{{
 		safe => 0,
 		rebuild => 0,
 	},
+	test_receive => {
+		type => "internal",
+		default => 0,
+		description => "running in receive test mode",
+		safe => 0,
+		rebuild => 0,
+	},
 	getctime => {
 		type => "internal",
 		default => 0,
@@ -388,6 +403,13 @@ sub getsetup () { #{{{
 		safe => 0,
 		rebuild => 0,
 	},
+	wikistatedir => {
+		type => "internal",
+		default => undef,
+		description => "path to the .ikiwiki directory holding ikiwiki state",
+		safe => 0,
+		rebuild => 0,
+	},
 	setupfile => {
 		type => "internal",
 		default => undef,
@@ -396,7 +418,7 @@ sub getsetup () { #{{{
 		rebuild => 0,
 	},
 	allow_symlinks_before_srcdir => {
-		type => "string",
+		type => "boolean",
 		default => 0,
 		description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
 		safe => 0,
@@ -452,7 +474,7 @@ sub checkconfig () { #{{{
 	}
 	
 	$config{wikistatedir}="$config{srcdir}/.ikiwiki"
-		unless exists $config{wikistatedir};
+		unless exists $config{wikistatedir} && defined $config{wikistatedir};
 
 	if (defined $config{umask}) {
 		umask(possibly_foolish_untaint($config{umask}));
@@ -619,16 +641,32 @@ sub pagename ($) { #{{{
 	my $type=pagetype($file);
 	my $page=$file;
 	$page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
+	if ($config{indexpages} && $page=~/(.*)\/index$/) {
+		$page=$1;
+	}
 	return $page;
 } #}}}
 
+sub newpagefile ($$) { #{{{
+	my $page=shift;
+	my $type=shift;
+
+	if (! $config{indexpages} || $page eq 'index') {
+		return $page.".".$type;
+	}
+	else {
+		return $page."/index.".$type;
+	}
+} #}}}
+
 sub targetpage ($$) { #{{{
 	my $page=shift;
 	my $ext=shift;
 	
-	if (! $config{usedirs} || $page =~ /^index$/ ) {
+	if (! $config{usedirs} || $page eq 'index') {
 		return $page.".".$ext;
-	} else {
+	}
+	else {
 		return $page."/index.".$ext;
 	}
 } #}}}
@@ -658,11 +696,12 @@ sub srcfile ($;$) { #{{{
 sub add_underlay ($) { #{{{
 	my $dir=shift;
 
-	if ($dir=~/^\//) {
-		unshift @{$config{underlaydirs}}, $dir;
+	if ($dir !~ /^\//) {
+		$dir="$config{underlaydir}/../$dir";
 	}
-	else {
-		unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
+
+	if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
+		unshift @{$config{underlaydirs}}, $dir;
 	}
 
 	return 1;
@@ -682,6 +721,10 @@ sub readfile ($;$$) { #{{{
 	binmode($in) if ($binary);
 	return \*$in if $wantfd;
 	my $ret=<$in>;
+	# check for invalid utf-8, and toss it back to avoid crashes
+	if (! utf8::valid($ret)) {
+		$ret=encode_utf8($ret);
+	}
 	close $in || error("failed to read $file: $!");
 	return $ret;
 } #}}}
@@ -750,7 +793,7 @@ sub will_render ($$;$) { #{{{
 
 	# Important security check.
 	if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
-	    ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
+	    ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
 		error("$config{destdir}/$dest independently created, not overwriting with version from $page");
 	}
 
@@ -874,6 +917,13 @@ sub abs2rel ($$) { #{{{
 } #}}}
 
 sub displaytime ($;$) { #{{{
+	# Plugins can override this function to mark up the time to
+	# display.
+	return '<span class="date">'.formattime(@_).'</span>';
+} #}}}
+
+sub formattime ($;$) { #{{{
+	# Plugins can override this function to format the time.
 	my $time=shift;
 	my $format=shift;
 	if (! defined $format) {
@@ -892,9 +942,9 @@ sub beautify_urlpath ($) { #{{{
 		$url =~ s!/index.$config{htmlext}$!/!;
 	}
 
-	# Ensure url is not an empty link, and
-	# if it's relative, make that explicit to avoid colon confusion.
-	if ($url !~ /^\//) {
+	# Ensure url is not an empty link, and if necessary,
+	# add ./ to avoid colon confusion.
+	if ($url !~ /^\// && $url !~ /^\.\.\//) {
 		$url="./$url";
 	}
 
@@ -1234,8 +1284,7 @@ sub indexlink () { #{{{
 
 my $wikilock;
 
-sub lockwiki (;$) { #{{{
-	my $wait=@_ ? shift : 1;
+sub lockwiki () { #{{{
 	# 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}) {
@@ -1243,25 +1292,14 @@ sub lockwiki (;$) { #{{{
 	}
 	open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
 		error ("cannot write to $config{wikistatedir}/lockfile: $!");
-	if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
-		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;
-		}
+	if (! flock($wikilock, 2)) { # LOCK_EX
+		error("failed to get lock");
 	}
 	return 1;
 } #}}}
 
 sub unlockwiki () { #{{{
+	POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
 	return close($wikilock) if $wikilock;
 	return;
 } #}}}
@@ -1318,9 +1356,11 @@ sub loadindex () { #{{{
 	my $pages;
 	if (exists $index->{version} && ! ref $index->{version}) {
 		$pages=$index->{page};
+		%wikistate=%{$index->{state}};
 	}
 	else {
 		$pages=$index;
+		%wikistate=();
 	}
 
 	foreach my $src (keys %$pages) {
@@ -1368,6 +1408,7 @@ sub saveindex () { #{{{
 	my $newfile="$config{wikistatedir}/indexdb.new";
 	my $cleanup = sub { unlink($newfile) };
 	open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
+
 	my %index;
 	foreach my $page (keys %pagemtime) {
 		next unless $pagemtime{$page};
@@ -1392,6 +1433,14 @@ sub saveindex () { #{{{
 			}
 		}
 	}
+
+	$index{state}={};
+	foreach my $id (@hookids) {
+		foreach my $key (keys %{$wikistate{$id}}) {
+			$index{state}{$id}{$key}=$wikistate{$id}{$key};
+		}
+	}
+	
 	$index{version}="3";
 	my $ret=Storable::nstore_fd(\%index, $out);
 	return if ! defined $ret || ! $ret;
@@ -1532,6 +1581,10 @@ sub rcs_getctime ($) { #{{{
 	$hooks{rcs}{rcs_getctime}{call}->(@_);
 } #}}}
 
+sub rcs_receive () { #{{{
+	$hooks{rcs}{rcs_receive}{call}->();
+} #}}}
+
 sub globlist_to_pagespec ($) { #{{{
 	my @globlist=split(' ', shift);
 
@@ -1624,6 +1677,31 @@ sub yesno ($) { #{{{
 	return (defined $val && lc($val) eq gettext("yes"));
 } #}}}
 
+sub inject { #{{{
+	# Injects a new function into the symbol table to replace an
+	# exported function.
+	my %params=@_;
+
+	# This is deep ugly perl foo, beware.
+	no strict;
+	no warnings;
+	if (! defined $params{parent}) {
+		$params{parent}='::';
+		$params{old}=\&{$params{name}};
+		$params{name}=~s/.*:://;
+	}
+	my $parent=$params{parent};
+	foreach my $ns (grep /^\w+::/, keys %{$parent}) {
+		$ns = $params{parent} . $ns;
+		inject(%params, parent => $ns) unless $ns eq '::main::';
+		*{$ns . $params{name}} = $params{call}
+			if exists ${$ns}{$params{name}} &&
+			   \&{${$ns}{$params{name}}} == $params{old};
+	}
+	use strict;
+	use warnings;
+} #}}}
+
 sub pagespec_merge ($$) { #{{{
 	my $a=shift;
 	my $b=shift;
@@ -1718,7 +1796,7 @@ sub pagespec_valid ($) { #{{{
 	my $sub=pagespec_translate($spec);
 	return ! $@;
 } #}}}
-	
+
 sub glob2re ($) { #{{{
 	my $re=quotemeta(shift);
 	$re=~s/\\\*/.*/g;
@@ -1815,6 +1893,10 @@ sub match_link ($$;@) { #{{{
 		else {
 			return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
 				if match_glob($p, $link, %params);
+			$p=~s/^\///;
+			$link=~s/^\///;
+			return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
+				if match_glob($p, $link, %params);
 		}
 	}
 	return IkiWiki::FailReason->new("$page does not link to $link");
@@ -1885,4 +1967,61 @@ sub match_creation_year ($$;@) { #{{{
 	}
 } #}}}
 
+sub match_user ($$;@) { #{{{
+	shift;
+	my $user=shift;
+	my %params=@_;
+	
+	if (! exists $params{user}) {
+		return IkiWiki::FailReason->new("no user specified");
+	}
+
+	if (defined $params{user} && lc $params{user} eq lc $user) {
+		return IkiWiki::SuccessReason->new("user is $user");
+	}
+	elsif (! defined $params{user}) {
+		return IkiWiki::FailReason->new("not logged in");
+	}
+	else {
+		return IkiWiki::FailReason->new("user is $params{user}, not $user");
+	}
+} #}}}
+
+sub match_admin ($$;@) { #{{{
+	shift;
+	shift;
+	my %params=@_;
+	
+	if (! exists $params{user}) {
+		return IkiWiki::FailReason->new("no user specified");
+	}
+
+	if (defined $params{user} && IkiWiki::is_admin($params{user})) {
+		return IkiWiki::SuccessReason->new("user is an admin");
+	}
+	elsif (! defined $params{user}) {
+		return IkiWiki::FailReason->new("not logged in");
+	}
+	else {
+		return IkiWiki::FailReason->new("user is not an admin");
+	}
+} #}}}
+
+sub match_ip ($$;@) { #{{{
+	shift;
+	my $ip=shift;
+	my %params=@_;
+	
+	if (! exists $params{ip}) {
+		return IkiWiki::FailReason->new("no IP specified");
+	}
+
+	if (defined $params{ip} && lc $params{ip} eq lc $ip) {
+		return IkiWiki::SuccessReason->new("IP is $ip");
+	}
+	else {
+		return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
+	}
+} #}}}
+
 1