X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/85eb1abc6198f16f6f887e811186ea4a7c095e1d..6a7eb63ca534bdad7ab13f840cdee33ea391d9bf:/IkiWiki/Plugin/recentchanges.pm?ds=inline

diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 5727f9af1..fa851e466 100644
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -3,85 +3,140 @@ package IkiWiki::Plugin::recentchanges;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
-
-sub import { #{{{
-	hook(type => "checkconfig", id => "recentchanges",
-		call => \&checkconfig);
-	hook(type => "needsbuild", id => "recentchanges",
-		call => \&needsbuild);
-	hook(type => "preprocess", id => "recentchanges",
-		call => \&preprocess);
-	hook(type => "htmlize", id => "_change",
-		call => \&htmlize);
-} #}}}
-
-sub checkconfig () { #{{{
-	my @changes=IkiWiki::rcs_recentchanges(100);
-	updatechanges("*", "recentchanges", \@changes);
-} #}}}
-
-sub needsbuild () { #{{{
-	# TODO
-} #}}}
-
-sub preprocess (@) { #{{{
-	my %params=@_;
-
-	# TODO
+use IkiWiki 3.00;
+use Encode;
+use HTML::Entities;
+
+sub import {
+	hook(type => "getsetup", id => "recentchanges", call => \&getsetup);
+	hook(type => "checkconfig", id => "recentchanges", call => \&checkconfig);
+	hook(type => "refresh", id => "recentchanges", call => \&refresh);
+	hook(type => "pagetemplate", id => "recentchanges", call => \&pagetemplate);
+	hook(type => "htmlize", id => "_change", call => \&htmlize);
+	# Load goto to fix up links from recentchanges
+	IkiWiki::loadplugin("goto");
+}
+
+sub getsetup () {
+	return
+		plugin => {
+			safe => 1,
+			rebuild => 1,
+		},
+		recentchangespage => {
+			type => "string",
+			example => "recentchanges",
+			description => "name of the recentchanges page",
+			safe => 1,
+			rebuild => 1,
+		},
+		recentchangesnum => {
+			type => "integer",
+			example => 100,
+			description => "number of changes to track",
+			safe => 1,
+			rebuild => 0,
+		},
+}
+
+sub checkconfig () {
+	$config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
+	$config{recentchangesnum}=100 unless defined $config{recentchangesnum};
+}
+
+sub refresh ($) {
+	my %seen;
+
+	# add new changes
+	foreach my $change (IkiWiki::rcs_recentchanges($config{recentchangesnum})) {
+		$seen{store($change, $config{recentchangespage})}=1;
+	}
+	
+	# delete old and excess changes
+	foreach my $page (keys %pagesources) {
+		if ($pagesources{$page} =~ /\._change$/ && ! $seen{$page}) {
+			unlink($config{srcdir}.'/'.$pagesources{$page});
+		}
+	}
+}
 
-	return "";
-} #}}}
+# Enable the recentchanges link on wiki pages.
+sub pagetemplate (@) {
+	my %params=@_;
+	my $template=$params{template};
+	my $page=$params{page};
+
+	if (defined $config{recentchangespage} && $config{rcs} &&
+	    $page ne $config{recentchangespage} &&
+	    $template->query(name => "recentchangesurl")) {
+		$template->param(recentchangesurl => urlto($config{recentchangespage}, $page));
+		$template->param(have_actions => 1);
+	}
+}
 
 # Pages with extension _change have plain html markup, pass through.
-sub htmlize (@) { #{{{
+sub htmlize (@) {
 	my %params=@_;
 	return $params{content};
-} #}}}
+}
 
-sub store ($$) { #{{{
+sub store ($$$) {
 	my $change=shift;
-	my $subdir=shift;
-	
-	my $page="$subdir/change_".IkiWiki::titlepage($change->{rev});
+
+	my $page="$config{recentchangespage}/change_".titlepage($change->{rev});
 
 	# Optimisation to avoid re-writing pages. Assumes commits never
 	# change (or that any changes are not important).
-	return if exists $pagesources{$page} && ! $config{rebuild};
+	return $page if exists $pagesources{$page} && ! $config{rebuild};
 
 	# Limit pages to first 10, and add links to the changed pages.
 	my $is_excess = exists $change->{pages}[10];
 	delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
 	$change->{pages} = [
 		map {
-			if (length $config{url}) {
-				$_->{link} = "<a href=\"$config{url}/".
-					urlto($_->{page},"")."\">".
-					IkiWiki::pagetitle($_->{page})."</a>";
+			if (length $config{cgiurl}) {
+				$_->{link} = "<a href=\"".
+					IkiWiki::cgiurl(
+						do => "goto",
+						page => $_->{page}
+					).
+					"\" rel=\"nofollow\">".
+					pagetitle($_->{page}).
+					"</a>"
 			}
 			else {
-				$_->{link} = IkiWiki::pagetitle($_->{page});
+				$_->{link} = pagetitle($_->{page});
 			}
+			$_->{baseurl}="$config{url}/" if length $config{url};
+
 			$_;
 		} @{$change->{pages}}
 	];
 	push @{$change->{pages}}, { link => '...' } if $is_excess;
 
-	# Take the first line of the commit message as a summary.
-	#my $m=shift @{$change->{message}};
-	#$change->{summary}=$m->{line};
-	#delete $change->{message} unless @{$change->{message}};
-
 	# See if the committer is an openid.
-	my $oiduser=IkiWiki::openiduser($change->{user});
+	$change->{author}=$change->{user};
+	my $oiduser=eval { IkiWiki::openiduser($change->{user}) };
 	if (defined $oiduser) {
 		$change->{authorurl}=$change->{user};
 		$change->{user}=$oiduser;
 	}
-	elsif (length $config{url}) {
-		$change->{authorurl}="$config{url}/".
-			(length $config{userdir} ? "$config{userdir}/" : "").
-			$change->{user};
+	elsif (length $config{cgiurl}) {
+		$change->{authorurl} = IkiWiki::cgiurl(
+			do => "goto",
+			page => (length $config{userdir} ? "$config{userdir}/" : "").$change->{author},
+		);
+	}
+
+	if (ref $change->{message}) {
+		foreach my $field (@{$change->{message}}) {
+			if (exists $field->{line}) {
+				# escape html
+				$field->{line} = encode_entities($field->{line});
+				# escape links and preprocessor stuff
+				$field->{line} = encode_entities($field->{line}, '\[\]');
+			}
+		}
 	}
 
 	# Fill out a template with the change info.
@@ -91,23 +146,20 @@ sub store ($$) { #{{{
 		commitdate => displaytime($change->{when}, "%X %x"),
 		wikiname => $config{wikiname},
 	);
-	$template->param(baseurl => "$config{url}/") if length $config{url};
+	
+	$template->param(permalink => "$config{url}/$config{recentchangespage}/#change-".titlepage($change->{rev}))
+		if exists $config{url};
+	
 	IkiWiki::run_hooks(pagetemplate => sub {
-		shift->(page => $page, destpage => $page, template => $template);
+		shift->(page => $page, destpage => $page,
+			template => $template, rev => $change->{rev});
 	});
 
-	writefile($page."._change", $config{srcdir}, $template->output);
-	utime $change->{when}, $change->{when}, "$config{srcdir}/$page._change";
-} #}}}
+	my $file=$page."._change";
+	writefile($file, $config{srcdir}, $template->output);
+	utime $change->{when}, $change->{when}, "$config{srcdir}/$file";
 
-sub updatechanges ($$) { #{{{
-	my $pagespec=shift;
-	my $subdir=shift;
-	my @changes=@{shift()};
-	foreach my $change (@changes) {
-		store($change, $subdir);
-	}
-	# TODO: delete old
-} #}}}
+	return $page;
+}
 
 1