X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cabd5140c4d6255afdcb527e7f6d7e7815e4aa43..cb1fe44f5d1b7154ee7d21f00fa6ecf4972815a7:/IkiWiki/Plugin/recentchanges.pm

diff --git a/IkiWiki/Plugin/recentchanges.pm b/IkiWiki/Plugin/recentchanges.pm
index 8f707afc4..3f70664ac 100644
--- a/IkiWiki/Plugin/recentchanges.pm
+++ b/IkiWiki/Plugin/recentchanges.pm
@@ -4,27 +4,72 @@ package IkiWiki::Plugin::recentchanges;
 use warnings;
 use strict;
 use IkiWiki 2.00;
+use Encode;
 
 sub import { #{{{
-	hook(type => "refresh", id => "recentchanges",
-		call => \&refresh);
-	hook(type => "preprocess", id => "recentchanges",
-		call => \&preprocess);
-	hook(type => "htmlize", id => "_change",
-		call => \&htmlize);
+	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);
+	hook(type => "cgi", id => "recentchanges", call => \&cgi);
 } #}}}
 
-sub refresh ($) { #{{{
-	my @changes=IkiWiki::rcs_recentchanges(100);
-	updatechanges("*", "recentchanges", \@changes);
+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 preprocess (@) { #{{{
-	my %params=@_;
+sub checkconfig () { #{{{
+	$config{recentchangespage}='recentchanges' unless defined $config{recentchangespage};
+	$config{recentchangesnum}=100 unless defined $config{recentchangesnum};
+} #}}}
+
+sub refresh ($) { #{{{
+	my %seen;
 
-	# TODO
+	# 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.
@@ -33,11 +78,43 @@ sub htmlize (@) { #{{{
 	return $params{content};
 } #}}}
 
-sub store ($$) { #{{{
+sub cgi ($) { #{{{
+	my $cgi=shift;
+	if (defined $cgi->param('do') && $cgi->param('do') eq "recentchanges_link") {
+		# This is a link from a change page to some
+		# other page. Since the change pages are only generated
+		# once, statically, links on them won't be updated if the
+		# page they link to is deleted, or newly created, or
+		# changes for whatever reason. So this CGI handles that
+		# dynamic linking stuff.
+		my $page=decode_utf8($cgi->param("page"));
+		if (!defined $page) {
+			error("missing page parameter");
+		}
+
+		IkiWiki::loadindex();
+
+		my $link=bestlink("", $page);
+		if (! length $link) {
+			print "Content-type: text/html\n\n";
+			print IkiWiki::misctemplate(gettext(gettext("missing page")),
+				"<p>".
+				sprintf(gettext("The page %s does not exist."),
+					htmllink("", "", $page)).
+				"</p>");
+		}
+		else {
+			IkiWiki::redirect($cgi, urlto($link, undef, 1));
+		}
+
+		exit;
+	}
+}
+
+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).
@@ -48,32 +125,41 @@ sub store ($$) { #{{{
 	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 => "recentchanges_link",
+						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;
 
 	# 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 => "recentchanges_link",
+			page => (length $config{userdir} ? "$config{userdir}/" : "").$change->{author},
+		);
 	}
 
-	# escape  wikilinks and preprocessor stuff in commit messages
+	# escape wikilinks and preprocessor stuff in commit messages
 	if (ref $change->{message}) {
 		foreach my $field (@{$change->{message}}) {
 			if (exists $field->{line}) {
@@ -89,9 +175,13 @@ 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});
 	});
 
 	my $file=$page."._change";
@@ -101,24 +191,4 @@ sub store ($$) { #{{{
 	return $page;
 } #}}}
 
-sub updatechanges ($$) { #{{{
-	my $pagespec=shift;
-	my $subdir=shift;
-	my @changes=@{shift()};
-	
-	my %seen;
-
-	# add new changes
-	foreach my $change (@changes) {
-		$seen{store($change, $subdir)}=1;
-	}
-	
-	# delete old and excess changes
-	foreach my $page (keys %pagesources) {
-		if ($page=~/^\Q$subdir\E\/change_/ && ! $seen{$page}) {
-			unlink($config{srcdir}.'/'.$pagesources{$page});
-		}
-	}
-} #}}}
-
 1