X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/32dd388f8dbb1f52a46c40a2e0b9a00eca43f40e..7481329bdd11d81c4b3e85a446ab1e4bfcc298c8:/IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 0791e1e75..6da281999 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -5,26 +5,26 @@ package IkiWiki;
 use warnings;
 use strict;
 use Encode;
-use HTML::Entities;
 use URI::Escape q{uri_escape_utf8};
 use POSIX ();
 use Storable;
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
-	    %pagestate %wikistate %renderedfiles %oldrenderedfiles
-	    %pagesources %destsources %depends %depends_simple %hooks
-	    %forcerebuild %loaded_plugins %typedlinks %oldtypedlinks};
+	%pagestate %wikistate %renderedfiles %oldrenderedfiles
+	%pagesources %delpagesources %destsources %depends %depends_simple
+	@mass_depends %hooks %forcerebuild %loaded_plugins %typedlinks
+	%oldtypedlinks %autofiles};
 
 use Exporter q{import};
-our @EXPORT = qw(hook debug error template htmlpage deptype
-                 add_depends pagespec_match pagespec_match_list bestlink
-		 htmllink readfile writefile pagetype srcfile pagename
-		 displaytime will_render gettext ngettext urlto targetpage
-		 add_underlay pagetitle titlepage linkpage newpagefile
-		 inject add_link
-                 %config %links %pagestate %wikistate %renderedfiles
-                 %pagesources %destsources %typedlinks);
+our @EXPORT = qw(hook debug error htmlpage template template_depends
+	deptype add_depends pagespec_match pagespec_match_list bestlink
+	htmllink readfile writefile pagetype srcfile pagename
+	displaytime will_render gettext ngettext urlto targetpage
+	add_underlay pagetitle titlepage linkpage newpagefile
+	inject add_link add_autofile
+	%config %links %pagestate %wikistate %renderedfiles
+	%pagesources %destsources %typedlinks);
 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
@@ -151,18 +151,11 @@ sub getsetup () {
 	templatedir => {
 		type => "string",
 		default => "$installdir/share/ikiwiki/templates",
-		description => "location of template files",
+		description => "additional directory to search for template files",
 		advanced => 1,
 		safe => 0, # path
 		rebuild => 1,
 	},
-	templatedirs => {
-		type => "internal",
-		default => [],
-		description => "additional directories containing template files",
-		safe => 0,
-		rebuild => 0,
-	},
 	underlaydir => {
 		type => "string",
 		default => "$installdir/share/ikiwiki/basewiki",
@@ -241,6 +234,14 @@ sub getsetup () {
 		safe => 1,
 		rebuild => 1,
 	},
+	html5 => {
+		type => "boolean",
+		default => 0,
+		description => "generate HTML5? (experimental)",
+		advanced => 1,
+		safe => 1,
+		rebuild => 1,
+	},
 	sslcookie => {
 		type => "boolean",
 		default => 0,
@@ -440,6 +441,13 @@ sub getsetup () {
 		safe => 0,
 		rebuild => 0,
 	},
+	wrapper_background_command => {
+		type => "internal",
+		default => '',
+		description => "background shell command to run",
+		safe => 0,
+		rebuild => 0,
+	},
 	gettime => {
 		type => "internal",
 		description => "running in gettime mode",
@@ -591,10 +599,11 @@ sub loadplugins () {
 	return 1;
 }
 
-sub loadplugin ($) {
+sub loadplugin ($;$) {
 	my $plugin=shift;
+	my $force=shift;
 
-	return if grep { $_ eq $plugin} @{$config{disable_plugins}};
+	return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};
 
 	foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
 	                 "$installdir/lib/ikiwiki") {
@@ -814,6 +823,17 @@ sub prep_writefile ($$) {
 		if (-l "$destdir/$test") {
 			error("cannot write to a symlink ($test)");
 		}
+		if (-f _ && $test ne $file) {
+			# Remove conflicting file.
+			foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+				foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+					if ($f eq $test) {
+						unlink("$destdir/$test");
+						last;
+					}
+				}
+			}
+		}
 		$test=dirname($test);
 	}
 
@@ -867,10 +887,36 @@ sub will_render ($$;$) {
 	my $dest=shift;
 	my $clear=shift;
 
-	# Important security check.
+	# Important security check for independently created files.
 	if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
 	    ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
-		error("$config{destdir}/$dest independently created, not overwriting with version from $page");
+		my $from_other_page=0;
+	    	# Expensive, but rarely runs.
+		foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+			if (grep {
+				$_ eq $dest ||
+				dirname($_) eq $dest
+			    } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+				$from_other_page=1;
+				last;
+			}
+		}
+
+		error("$config{destdir}/$dest independently created, not overwriting with version from $page")
+			unless $from_other_page;
+	}
+
+	# If $dest exists as a directory, remove conflicting files in it
+	# rendered from other pages.
+	if (-d _) {
+		foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
+			foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
+				if (dirname($f) eq $dest) {
+					unlink("$config{destdir}/$f");
+					rmdir(dirname("$config{destdir}/$f"));
+				}
+			}
+		}
 	}
 
 	if (! $clear || $cleared{$page}) {
@@ -997,10 +1043,18 @@ sub abs2rel ($$) {
 	return $ret;
 }
 
-sub displaytime ($;$) {
+sub displaytime ($;$$) {
 	# Plugins can override this function to mark up the time to
 	# display.
-	return '<span class="date">'.formattime(@_).'</span>';
+	my $time=formattime($_[0], $_[1]);
+	if ($config{html5}) {
+		return '<time datetime="'.date_3339($_[0]).'"'.
+			($_[2] ? ' pubdate="pubdate"' : '').
+			'>'.$time.'</time>';
+	}
+	else {
+		return '<span class="date">'.$time.'</span>';
+	}
 }
 
 sub formattime ($;$) {
@@ -1016,6 +1070,16 @@ sub formattime ($;$) {
 	return decode_utf8(POSIX::strftime($format, localtime($time)));
 }
 
+sub date_3339 ($) {
+	my $time=shift;
+
+	my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
+	POSIX::setlocale(&POSIX::LC_TIME, "C");
+	my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
+	POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
+	return $ret;
+}
+
 sub beautify_urlpath ($) {
 	my $url=shift;
 
@@ -1054,6 +1118,15 @@ sub urlto ($$;$) {
 	return beautify_urlpath($link);
 }
 
+sub isselflink ($$) {
+	# Plugins can override this function to support special types
+	# of selflinks.
+	my $page=shift;
+	my $link=shift;
+
+        return $page eq $link;
+}
+
 sub htmllink ($$$;@) {
 	my $lpage=shift; # the page doing the linking
 	my $page=shift; # the page that will contain the link (different for inline)
@@ -1079,7 +1152,7 @@ sub htmllink ($$$;@) {
 	}
 	
 	return "<span class=\"selflink\">$linktext</span>"
-		if length $bestlink && $page eq $bestlink &&
+		if length $bestlink && isselflink($page, $bestlink) &&
 		   ! defined $opts{anchor};
 	
 	if (! $destsources{$bestlink}) {
@@ -1382,10 +1455,6 @@ sub filter ($$$) {
 	return $content;
 }
 
-sub indexlink () {
-	return "<a href=\"$config{url}\">$config{wikiname}</a>";
-}
-
 sub check_canedit ($$$;$) {
 	my $page=shift;
 	my $q=shift;
@@ -1527,6 +1596,12 @@ sub loadindex () {
 	if (exists $index->{version} && ! ref $index->{version}) {
 		$pages=$index->{page};
 		%wikistate=%{$index->{state}};
+		# Handle plugins that got disabled by loading a new setup.
+		if (exists $config{setupfile}) {
+			require IkiWiki::Setup;
+			IkiWiki::Setup::disabled_plugins(
+				grep { ! $loaded_plugins{$_} } keys %wikistate);
+		}
 	}
 	else {
 		$pages=$index;
@@ -1537,8 +1612,8 @@ sub loadindex () {
 		my $d=$pages->{$src};
 		my $page=pagename($src);
 		$pagectime{$page}=$d->{ctime};
+		$pagesources{$page}=$src;
 		if (! $config{rebuild}) {
-			$pagesources{$page}=$src;
 			$pagemtime{$page}=$d->{mtime};
 			$renderedfiles{$page}=$d->{dest};
 			if (exists $d->{links} && ref $d->{links}) {
@@ -1594,11 +1669,7 @@ sub loadindex () {
 sub saveindex () {
 	run_hooks(savestate => sub { shift->() });
 
-	my %hookids;
-	foreach my $type (keys %hooks) {
-		$hookids{$_}=1 foreach keys %{$hooks{$type}};
-	}
-	my @hookids=keys %hookids;
+	my @plugins=keys %loaded_plugins;
 
 	if (! -d $config{wikistatedir}) {
 		mkdir($config{wikistatedir});
@@ -1632,7 +1703,7 @@ sub saveindex () {
 		}
 
 		if (exists $pagestate{$page}) {
-			foreach my $id (@hookids) {
+			foreach my $id (@plugins) {
 				foreach my $key (keys %{$pagestate{$page}{$id}}) {
 					$index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
 				}
@@ -1641,7 +1712,8 @@ sub saveindex () {
 	}
 
 	$index{state}={};
-	foreach my $id (@hookids) {
+	foreach my $id (@plugins) {
+		$index{state}{$id}={}; # used to detect disabled plugins
 		foreach my $key (keys %{$wikistate{$id}}) {
 			$index{state}{$id}{$key}=$wikistate{$id}{$key};
 		}
@@ -1658,60 +1730,127 @@ sub saveindex () {
 }
 
 sub template_file ($) {
-	my $template=shift;
+	my $name=shift;
+	
+	my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
+	my $template;
+	if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
+		$template=srcfile($pagesources{$tpage}, 1);
+		$name.=".tmpl";
+	}
+	else {
+		$template=srcfile($tpage, 1);
+	}
 
-	foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
-	                 "$installdir/share/ikiwiki/templates") {
-		return "$dir/$template" if -e "$dir/$template";
+	if (defined $template) {
+		return $template, $tpage, 1 if wantarray;
+		return $template;
+	}
+	else {
+		$name=~s:/::; # avoid path traversal
+		foreach my $dir ($config{templatedir},
+		                 "$installdir/share/ikiwiki/templates") {
+			if (-e "$dir/$name") {
+				$template="$dir/$name";
+				last;
+			}
+		}
+		if (defined $template) {	
+			return $template, $tpage if wantarray;
+			return $template;
+		}
 	}
+
 	return;
 }
 
-sub template_params (@) {
-	my $filename=template_file(shift);
-
-	if (! defined $filename) {
-		return if wantarray;
-		return "";
+sub template_depends ($$;@) {
+	my $name=shift;
+	my $page=shift;
+	
+	my ($filename, $tpage, $untrusted)=template_file($name);
+	if (defined $page && defined $tpage) {
+		add_depends($page, $tpage);
 	}
 
-	my @ret=(
+	return unless defined $filename;
+
+	my @opts=(
 		filter => sub {
 			my $text_ref = shift;
 			${$text_ref} = decode_utf8(${$text_ref});
 		},
-		filename => $filename,
 		loop_context_vars => 1,
 		die_on_bad_params => 0,
-		@_
+		filename => $filename,
+		@_,
+		($untrusted ? (no_includes => 1) : ()),
 	);
-	return wantarray ? @ret : {@ret};
+	return @opts if wantarray;
+
+	require HTML::Template;
+	return HTML::Template->new(@opts);
 }
 
 sub template ($;@) {
-	require HTML::Template;
-	return HTML::Template->new(template_params(@_));
+	template_depends(shift, undef, @_);
 }
 
 sub misctemplate ($$;@) {
 	my $title=shift;
-	my $pagebody=shift;
+	my $content=shift;
+	my %params=@_;
 	
-	my $template=template("misc.tmpl");
+	my $template=template("page.tmpl");
+
+	my $page="";
+	if (exists $params{page}) {
+		$page=delete $params{page};
+	}
+	run_hooks(pagetemplate => sub {
+		shift->(
+			page => $page,
+			destpage => $page,
+			template => $template,
+		);
+	});
+	templateactions($template, "");
+
 	$template->param(
+		dynamic => 1,
 		title => $title,
-		indexlink => indexlink(),
 		wikiname => $config{wikiname},
-		pagebody => $pagebody,
+		content => $content,
 		baseurl => baseurl(),
-		@_,
+		html5 => $config{html5},
+		%params,
 	);
-	run_hooks(pagetemplate => sub {
-		shift->(page => "", destpage => "", template => $template);
-	});
+	
 	return $template->output;
 }
 
+sub templateactions ($$) {
+	my $template=shift;
+	my $page=shift;
+
+	my $have_actions=0;
+	my @actions;
+	run_hooks(pageactions => sub {
+		push @actions, map { { action => $_ } } 
+			grep { defined } shift->(page => $page);
+	});
+	$template->param(actions => \@actions);
+
+	if ($config{cgiurl} && exists $hooks{auth}) {
+		$template->param(prefsurl => cgiurl(do => "prefs"));
+		$have_actions=1;
+	}
+
+	if ($have_actions || @actions) {
+		$template->param(have_actions => 1);
+	}
+}
+
 sub hook (@) {
 	my %param=@_;
 	
@@ -1760,11 +1899,11 @@ sub rcs_prepedit ($) {
 	$hooks{rcs}{rcs_prepedit}{call}->(@_);
 }
 
-sub rcs_commit ($$$;$$) {
+sub rcs_commit (@) {
 	$hooks{rcs}{rcs_commit}{call}->(@_);
 }
 
-sub rcs_commit_staged ($$$) {
+sub rcs_commit_staged (@) {
 	$hooks{rcs}{rcs_commit_staged}{call}->(@_);
 }
 
@@ -1818,10 +1957,12 @@ sub add_depends ($$;$) {
 	foreach my $p (keys %pagesources) {
 		my $r=$sub->($p, location => $page);
 		my $i=$r->influences;
+		my $static=$r->influences_static;
 		foreach my $k (keys %$i) {
+			next unless $r || $static || $k eq $page;
 			$depends_simple{$page}{lc $k} |= $i->{$k};
 		}
-		last if $r->influences_static;
+		last if $static;
 	}
 
 	$depends{$page}{$pagespec} |= $deptype;
@@ -1885,7 +2026,7 @@ sub define_gettext () {
 			return shift;
 		}
 	};
-  	*ngettext=sub {
+	*ngettext=sub {
 		$getobj->() if $getobj;
 		if ($gettext_obj) {
 			$gettext_obj->nget(@_);
@@ -1950,6 +2091,15 @@ sub add_link ($$;$) {
 	}
 }
 
+sub add_autofile ($$$) {
+	my $file=shift;
+	my $plugin=shift;
+	my $generator=shift;
+	
+	$autofiles{$file}{plugin}=$plugin;
+	$autofiles{$file}{generator}=$generator;
+}
+
 sub sortspec_translate ($$) {
 	my $spec = shift;
 	my $reverse = shift;
@@ -2136,6 +2286,9 @@ sub pagespec_match_list ($$;@) {
 		my $r=$sub->($p, %params, location => $page);
 		error(sprintf(gettext("cannot match pages: %s"), $r))
 			if $r->isa("IkiWiki::ErrorReason");
+		unless ($r || $r->influences_static) {
+			$r->remove_influence($p);
+		}
 		$accum |= $r;
 		if ($r) {
 			push @matches, $p;
@@ -2232,6 +2385,13 @@ sub merge_influences {
 	}
 }
 
+sub remove_influence {
+	my $this=shift;
+	my $torm=shift;
+
+	delete $this->[1]{$torm};
+}
+
 package IkiWiki::ErrorReason;
 
 our @ISA = 'IkiWiki::FailReason';
@@ -2242,10 +2402,16 @@ sub derel ($$) {
 	my $path=shift;
 	my $from=shift;
 
-	if ($path =~ m!^\./!) {
-		$from=~s#/?[^/]+$## if defined $from;
-		$path=~s#^\./##;
-		$path="$from/$path" if defined $from && length $from;
+	if ($path =~ m!^\.(/|$)!) {
+		if ($1) {
+			$from=~s#/?[^/]+$## if defined $from;
+			$path=~s#^\./##;
+			$path="$from/$path" if defined $from && length $from;
+		}
+		else {
+			$path = $from;
+			$path = "" unless defined $path;
+		}
 	}
 
 	return $path;
@@ -2273,7 +2439,22 @@ sub match_glob ($$;@) {
 }
 
 sub match_internal ($$;@) {
-	return match_glob($_[0], $_[1], @_, internal => 1)
+	return match_glob(shift, shift, @_, internal => 1)
+}
+
+sub match_page ($$;@) {
+	my $page=shift;
+	my $match=match_glob($page, shift, @_);
+	if ($match) {
+		my $source=exists $IkiWiki::pagesources{$page} ?
+			$IkiWiki::pagesources{$page} :
+			$IkiWiki::delpagesources{$page};
+		my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+		if (! defined $type) {	
+			return IkiWiki::FailReason->new("$page is not a page");
+		}
+	}
+	return $match;
 }
 
 sub match_link ($$;@) {
@@ -2294,18 +2475,20 @@ sub match_link ($$;@) {
 		unless $links && @{$links};
 	my $bestlink = IkiWiki::bestlink($from, $link);
 	foreach my $p (@{$links}) {
+		next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
+
 		if (length $bestlink) {
-			if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && $bestlink eq IkiWiki::bestlink($page, $p)) {
+			if ($bestlink eq IkiWiki::bestlink($page, $p)) {
 				return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
 			}
 		}
 		else {
-			if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && match_glob($p, $link, %params)) {
+			if (match_glob($p, $link, %params)) {
 				return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
 			}
 			my ($p_rel)=$p=~/^\/?(.*)/;
 			$link=~s/^\///;
-			if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p_rel}) && match_glob($p_rel, $link, %params)) {
+			if (match_glob($p_rel, $link, %params)) {
 				return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
 			}
 		}
@@ -2360,7 +2543,7 @@ sub match_created_after ($$;@) {
 }
 
 sub match_creation_day ($$;@) {
-	if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+	if ((localtime($IkiWiki::pagectime{shift()}))[3] == shift) {
 		return IkiWiki::SuccessReason->new('creation_day matched');
 	}
 	else {
@@ -2369,7 +2552,7 @@ sub match_creation_day ($$;@) {
 }
 
 sub match_creation_month ($$;@) {
-	if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
+	if ((localtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
 		return IkiWiki::SuccessReason->new('creation_month matched');
 	}
 	else {
@@ -2378,7 +2561,7 @@ sub match_creation_month ($$;@) {
 }
 
 sub match_creation_year ($$;@) {
-	if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
+	if ((localtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
 		return IkiWiki::SuccessReason->new('creation_year matched');
 	}
 	else {