X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d2679de965a0300474341139871855bbccc61612..8ded9f57a12a27fa5fc1e272ec7b2d2a5aa28419:/IkiWiki.pm?ds=inline

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 7553ae3db..bab7b707a 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
-                 %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
@@ -121,7 +122,7 @@ sub getsetup () { #{{{
 		type => "internal",
 		default => [qw{mdwn link inline htmlscrubber passwordauth
 				openid signinedit lockedit conditional
-				recentchanges parentlinks}],
+				recentchanges parentlinks editpage}],
 		description => "plugins to enable by default",
 		safe => 0,
 		rebuild => 1,
@@ -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,
@@ -395,6 +410,13 @@ sub getsetup () { #{{{
 		safe => 0,
 		rebuild => 0,
 	},
+	allow_symlinks_before_srcdir => {
+		type => "boolean",
+		default => 0,
+		description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
+		safe => 0,
+		rebuild => 0,
+	},
 } #}}}
 
 sub defaultconfig () { #{{{
@@ -513,7 +535,11 @@ sub loadplugin ($) { #{{{
 	foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
 	                 "$installdir/lib/ikiwiki") {
 		if (defined $dir && -x "$dir/plugins/$plugin") {
-			require IkiWiki::Plugin::external;
+			eval { require IkiWiki::Plugin::external };
+			if ($@) {
+				my $reason=$@;
+				error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
+			}
 			import IkiWiki::Plugin::external "$dir/plugins/$plugin";
 			$loaded_plugins{$plugin}=1;
 			return 1;
@@ -607,17 +633,33 @@ sub pagename ($) { #{{{
 
 	my $type=pagetype($file);
 	my $page=$file;
-	$page=~s/\Q.$type\E*$// if defined $type;
+	$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;
 	}
 } #}}}
@@ -647,11 +689,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;
@@ -739,7 +782,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");
 	}
 
@@ -863,6 +906,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) {
@@ -1298,31 +1348,42 @@ sub loadindex () { #{{{
 			return;
 		}
 	}
-	my $ret=Storable::fd_retrieve($in);
-	if (! defined $ret) {
+
+	my $index=Storable::fd_retrieve($in);
+	if (! defined $index) {
 		return 0;
 	}
-	my %index=%$ret;
-	foreach my $src (keys %index) {
-		my %d=%{$index{$src}};
+
+	my $pages;
+	if (exists $index->{version} && ! ref $index->{version}) {
+		$pages=$index->{page};
+		%wikistate=%{$index->{state}};
+	}
+	else {
+		$pages=$index;
+		%wikistate=();
+	}
+
+	foreach my $src (keys %$pages) {
+		my $d=$pages->{$src};
 		my $page=pagename($src);
-		$pagectime{$page}=$d{ctime};
+		$pagectime{$page}=$d->{ctime};
 		if (! $config{rebuild}) {
 			$pagesources{$page}=$src;
-			$pagemtime{$page}=$d{mtime};
-			$renderedfiles{$page}=$d{dest};
-			if (exists $d{links} && ref $d{links}) {
-				$links{$page}=$d{links};
-				$oldlinks{$page}=[@{$d{links}}];
+			$pagemtime{$page}=$d->{mtime};
+			$renderedfiles{$page}=$d->{dest};
+			if (exists $d->{links} && ref $d->{links}) {
+				$links{$page}=$d->{links};
+				$oldlinks{$page}=[@{$d->{links}}];
 			}
-			if (exists $d{depends}) {
-				$depends{$page}=$d{depends};
+			if (exists $d->{depends}) {
+				$depends{$page}=$d->{depends};
 			}
-			if (exists $d{state}) {
-				$pagestate{$page}=$d{state};
+			if (exists $d->{state}) {
+				$pagestate{$page}=$d->{state};
 			}
 		}
-		$oldrenderedfiles{$page}=[@{$d{dest}}];
+		$oldrenderedfiles{$page}=[@{$d->{dest}}];
 	}
 	foreach my $page (keys %pagesources) {
 		$pagecase{lc $page}=$page;
@@ -1348,12 +1409,13 @@ 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};
 		my $src=$pagesources{$page};
 
-		$index{$src}={
+		$index{page}{$src}={
 			ctime => $pagectime{$page},
 			mtime => $pagemtime{$page},
 			dest => $renderedfiles{$page},
@@ -1361,17 +1423,26 @@ sub saveindex () { #{{{
 		};
 
 		if (exists $depends{$page}) {
-			$index{$src}{depends} = $depends{$page};
+			$index{page}{$src}{depends} = $depends{$page};
 		}
 
 		if (exists $pagestate{$page}) {
 			foreach my $id (@hookids) {
 				foreach my $key (keys %{$pagestate{$page}{$id}}) {
-					$index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
+					$index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
 				}
 			}
 		}
 	}
+
+	$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;
 	close $out || error("failed saving to $newfile: $!", $cleanup);
@@ -1511,6 +1582,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);
 
@@ -1603,6 +1678,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;
@@ -1697,7 +1797,7 @@ sub pagespec_valid ($) { #{{{
 	my $sub=pagespec_translate($spec);
 	return ! $@;
 } #}}}
-	
+
 sub glob2re ($) { #{{{
 	my $re=quotemeta(shift);
 	$re=~s/\\\*/.*/g;
@@ -1864,4 +1964,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