X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/bab8fec52468b780485bdf96a37a593bd033c7e3..c9f8fef594e3d820ce4251737e3152e4ffaae528:/IkiWiki.pm?ds=sidebyside

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 6d2f4dac3..11cfcdfd2 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 %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,
@@ -355,7 +356,7 @@ sub getsetup () {
 	},
 	wiki_file_prune_regexps => {
 		type => "internal",
-		default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
+		default => [qr/(^|\/)\.\.(\/|$)/, qr/^\//, qr/^\./, qr/\/\./,
 			qr/\.x?html?$/, qr/\.ikiwiki-new$/,
 			qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
 			qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
@@ -440,10 +441,9 @@ sub getsetup () {
 		safe => 0,
 		rebuild => 0,
 	},
-	getctime => {
+	gettime => {
 		type => "internal",
-		default => 0,
-		description => "running in getctime mode",
+		description => "running in gettime mode",
 		safe => 0,
 		rebuild => 0,
 	},
@@ -998,10 +998,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' : '').
+			'>'.$time.'</time>';
+	}
+	else {
+		return '<span class="date">'.$time.'</span>';
+	}
 }
 
 sub formattime ($;$) {
@@ -1017,6 +1025,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;
 
@@ -1087,14 +1105,16 @@ sub htmllink ($$$;@) {
 		$bestlink=htmlpage($bestlink);
 
 		if (! $destsources{$bestlink}) {
-			return $linktext unless length $config{cgiurl};
-			return "<span class=\"createlink\"><a href=\"".
-				cgiurl(
-					do => "create",
-					page => lc($link),
-					from => $lpage
-				).
-				"\" rel=\"nofollow\">?</a>$linktext</span>"
+			my $cgilink = "";
+			if (length $config{cgiurl}) {
+				$cgilink = "<a href=\"".
+					cgiurl(
+						do => "create",
+						page => lc($link),
+						from => $lpage
+					)."\" rel=\"nofollow\">?</a>";
+			}
+			return "<span class=\"createlink\">$cgilink$linktext</span>"
 		}
 	}
 	
@@ -1381,10 +1401,6 @@ sub filter ($$$) {
 	return $content;
 }
 
-sub indexlink () {
-	return "<a href=\"$config{url}\">$config{wikiname}</a>";
-}
-
 sub check_canedit ($$$;$) {
 	my $page=shift;
 	my $q=shift;
@@ -1512,6 +1528,7 @@ sub loadindex () {
 			open ($in, "<", "$config{wikistatedir}/indexdb") || return;
 		}
 		else {
+			$config{gettime}=1; # first build
 			return;
 		}
 	}
@@ -1535,8 +1552,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}) {
@@ -1656,57 +1673,90 @@ sub saveindex () {
 }
 
 sub template_file ($) {
-	my $template=shift;
+	my $name=shift;
+	
+	my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
+	if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
+		$tpage=$pagesources{$tpage};
+		$name.=".tmpl";
+	}
 
-	foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
-	                 "$installdir/share/ikiwiki/templates") {
-		return "$dir/$template" if -e "$dir/$template";
+	my $template=srcfile($tpage, 1);
+	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 $template=template("misc.tmpl");
+	my $template=template("page.tmpl");
+
+	run_hooks(pagetemplate => sub {
+		shift->(page => "", destpage => "", template => $template);
+	});
+
 	$template->param(
+		dynamic => 1,
+		have_actions => 0, # force off
 		title => $title,
-		indexlink => indexlink(),
 		wikiname => $config{wikiname},
-		pagebody => $pagebody,
+		content => $content,
 		baseurl => baseurl(),
+		html5 => $config{html5},
 		@_,
 	);
-	run_hooks(pagetemplate => sub {
-		shift->(page => "", destpage => "", template => $template);
-	});
+
 	return $template->output;
 }
 
@@ -1790,6 +1840,10 @@ sub rcs_getctime ($) {
 	$hooks{rcs}{rcs_getctime}{call}->(@_);
 }
 
+sub rcs_getmtime ($) {
+	$hooks{rcs}{rcs_getmtime}{call}->(@_);
+}
+
 sub rcs_receive () {
 	$hooks{rcs}{rcs_receive}{call}->();
 }
@@ -1812,10 +1866,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;
@@ -1839,15 +1895,8 @@ sub deptype (@) {
 }
 
 my $file_prune_regexp;
-sub file_pruned ($;$) {
+sub file_pruned ($) {
 	my $file=shift;
-	if (@_) {
-		require File::Spec;
-		$file=File::Spec->canonpath($file);
-		my $base=File::Spec->canonpath(shift);
-		return if $file eq $base;
-		$file =~ s#^\Q$base\E/+##;
-	}
 
 	if (defined $config{include} && length $config{include}) {
 		return 0 if $file =~ m/$config{include}/;
@@ -1886,7 +1935,7 @@ sub define_gettext () {
 			return shift;
 		}
 	};
-  	*ngettext=sub {
+	*ngettext=sub {
 		$getobj->() if $getobj;
 		if ($gettext_obj) {
 			$gettext_obj->nget(@_);
@@ -1951,8 +2000,18 @@ sub add_link ($$;$) {
 	}
 }
 
-sub sortspec_translate ($) {
+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;
 
 	my $code = "";
 	my @data;
@@ -2007,6 +2066,10 @@ sub sortspec_translate ($) {
 		return sub { 0 };
 	}
 
+	if ($reverse) {
+		$code="-($code)";
+	}
+
 	no warnings;
 	return eval 'sub { '.$code.' }';
 }
@@ -2097,6 +2160,8 @@ sub pagespec_match_list ($$;@) {
 	my $sub=pagespec_translate($pagespec);
 	error "syntax error in pagespec \"$pagespec\""
 		if ! defined $sub;
+	my $sort=sortspec_translate($params{sort}, $params{reverse})
+		if defined $params{sort};
 
 	my @candidates;
 	if (exists $params{list}) {
@@ -2109,20 +2174,19 @@ sub pagespec_match_list ($$;@) {
 			? grep { ! $params{filter}->($_) } keys %pagesources
 			: keys %pagesources;
 	}
-
-	if (defined $params{sort}) {
-		@candidates = IkiWiki::SortSpec::sort_pages($params{sort},
-			@candidates);
-	}
-
-	@candidates=reverse(@candidates) if $params{reverse};
-	
-	$depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
 	
 	# clear params, remainder is passed to pagespec
+	$depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
 	my $num=$params{num};
 	delete @params{qw{num deptype reverse sort filter list}};
 	
+	# when only the top matches will be returned, it's efficient to
+	# sort before matching to pagespec,
+	if (defined $num && defined $sort) {
+		@candidates=IkiWiki::SortSpec::sort_pages(
+			$sort, @candidates);
+	}
+	
 	my @matches;
 	my $firstfail;
 	my $count=0;
@@ -2131,6 +2195,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;
@@ -2144,7 +2211,15 @@ sub pagespec_match_list ($$;@) {
 		$depends_simple{$page}{lc $k} |= $i->{$k};
 	}
 
-	return @matches;
+	# when all matches will be returned, it's efficient to
+	# sort after matching
+	if (! defined $num && defined $sort) {
+		return IkiWiki::SortSpec::sort_pages(
+			$sort, @matches);
+	}
+	else {
+		return @matches;
+	}
 }
 
 sub pagespec_valid ($) {
@@ -2208,7 +2283,7 @@ sub merge_influences {
 	my $anded=shift;
 
 	if (! $anded || (($this || %{$this->[1]}) &&
-	                ($other || %{$other->[1]}))) {
+	                 ($other || %{$other->[1]}))) {
 		foreach my $influence (keys %{$other->[1]}) {
 			$this->[1]{$influence} |= $other->[1]{$influence};
 		}
@@ -2219,6 +2294,13 @@ sub merge_influences {
 	}
 }
 
+sub remove_influence {
+	my $this=shift;
+	my $torm=shift;
+
+	delete $this->[1]{$torm};
+}
+
 package IkiWiki::ErrorReason;
 
 our @ISA = 'IkiWiki::FailReason';
@@ -2232,7 +2314,7 @@ sub derel ($$) {
 	if ($path =~ m!^\./!) {
 		$from=~s#/?[^/]+$## if defined $from;
 		$path=~s#^\./##;
-		$path="$from/$path" if length $from;
+		$path="$from/$path" if defined $from && length $from;
 	}
 
 	return $path;
@@ -2260,7 +2342,18 @@ 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 && ! defined IkiWiki::pagetype($IkiWiki::pagesources{$page})) {
+		return IkiWiki::FailReason->new("$page is not a page");
+	}
+	else {
+		return $match;
+	}
 }
 
 sub match_link ($$;@) {
@@ -2435,13 +2528,10 @@ sub match_ip ($$;@) {
 package IkiWiki::SortSpec;
 
 # This is in the SortSpec namespace so that the $a and $b that sort() uses
-# $IkiWiki::SortSpec::a and $IkiWiki::SortSpec::b, so that plugins' cmp
-# functions can access them easily.
-sub sort_pages
-{
-	my $f = IkiWiki::sortspec_translate(shift);
-
-	return sort $f @_;
+# are easily available in this namespace, for cmp functions to use them.
+sub sort_pages {
+	my $f=shift;
+	sort $f @_
 }
 
 sub cmp_title {