X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/903213e63fd6c409046f66e73881aba33c3926de..3867f038a79784119e67ad36a191b64d2f574a3b:/IkiWiki/Plugin/autoindex.pm

diff --git a/IkiWiki/Plugin/autoindex.pm b/IkiWiki/Plugin/autoindex.pm
index ef22ec8a3..78571b276 100644
--- a/IkiWiki/Plugin/autoindex.pm
+++ b/IkiWiki/Plugin/autoindex.pm
@@ -3,79 +3,137 @@ package IkiWiki::Plugin::autoindex;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 use Encode;
 
-sub import { #{{{
+sub import {
+	hook(type => "checkconfig", id => "autoindex", call => \&checkconfig);
 	hook(type => "getsetup", id => "autoindex", call => \&getsetup);
 	hook(type => "refresh", id => "autoindex", call => \&refresh);
-} # }}}
+	IkiWiki::loadplugin("transient");
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
 	return
 		plugin => {
 			safe => 1,
 			rebuild => 0,
 		},
-} #}}}
+		autoindex_commit => {
+			type => "boolean",
+			example => 1,
+			default => 1,
+			description => "commit autocreated index pages",
+			safe => 1,
+			rebuild => 0,
+		},
+}
 
-sub genindex ($) { #{{{
-	my $page=shift;
-	my $file=$page.".".$config{default_pageext};
-	my $template=template("autoindex.tmpl");
-	$template->param(page => $page);
-	writefile($file, $config{srcdir}, $template->output);
-	if ($config{rcs}) {
-		IkiWiki::rcs_add($file);
+sub checkconfig () {
+	if (! defined $config{autoindex_commit}) {
+		$config{autoindex_commit} = 1;
 	}
-} #}}}
+}
+
+sub genindex ($) {
+	my $page=shift;
+	my $file=newpagefile($page, $config{default_pageext});
+
+	add_autofile($file, "autoindex", sub {
+			my $message = sprintf(gettext("creating index page %s"),
+				$page);
+			debug($message);
 
-sub refresh () { #{{{
+			my $dir = $config{srcdir};
+			if (! $config{autoindex_commit}) {
+				$dir = $IkiWiki::Plugin::transient::transientdir;
+			}
+
+			my $template = template("autoindex.tmpl");
+			$template->param(page => $page);
+			writefile($file, $dir, $template->output);
+
+			if ($config{rcs} && $config{autoindex_commit}) {
+				IkiWiki::disable_commit_hook();
+				IkiWiki::rcs_add($file);
+				IkiWiki::rcs_commit_staged(message => $message);
+				IkiWiki::enable_commit_hook();
+			}
+		});
+}
+
+sub refresh () {
 	eval q{use File::Find};
 	error($@) if $@;
+	eval q{use Cwd};
+	error($@) if $@;
+	my $origdir=getcwd();
 
 	my (%pages, %dirs);
-	find({
-		no_chdir => 1,
-		wanted => sub {
-			$_=decode_utf8($_);
-			if (IkiWiki::file_pruned($_, $config{srcdir})) {
-				$File::Find::prune=1;
-			}
-			elsif (! -l $_) {
-				my ($f)=/$config{wiki_file_regexp}/; # untaint
-				return unless defined $f;
-				$f=~s/^\Q$config{srcdir}\E\/?//;
-				return unless length $f;
-				if (! -d _) {
-					$pages{pagename($f)}=1;
+	foreach my $dir ($config{srcdir}, @{$config{underlaydirs}}, $config{underlaydir}) {
+		next if $dir eq $IkiWiki::Plugin::transient::transientdir;
+		chdir($dir) || next;
+
+		find({
+			no_chdir => 1,
+			wanted => sub {
+				my $file=decode_utf8($_);
+				$file=~s/^\.\/?//;
+				return unless length $file;
+				if (IkiWiki::file_pruned($file)) {
+					$File::Find::prune=1;
 				}
-				else {
-					$dirs{$f}=1;
+				elsif (! -l $_) {
+					my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+					return unless defined $f;
+					return if $f =~ /\._([^.]+)$/; # skip internal page
+					if (! -d _) {
+						$pages{pagename($f)}=1;
+					}
+					elsif ($dir eq $config{srcdir}) {
+						$dirs{$f}=1;
+					}
 				}
 			}
-		}
-	}, $config{srcdir});
+		}, '.');
 
-	my @needed;
-	foreach my $dir (keys %dirs) {
-		if (! exists $pages{$dir}) {
-			push @needed, $dir;
-		}
+		chdir($origdir) || die "chdir $origdir: $!";
+	}
+
+	# Compatibility code.
+	#
+	# {deleted} contains pages that have been deleted at some point.
+	# This plugin used to delete from the hash sometimes, but no longer
+	# does; in [[todo/autoindex_should_use_add__95__autofile]] Joey
+	# thought the old behaviour was probably a bug.
+	#
+	# The effect of listing a page in {deleted} was to avoid re-creating
+	# it; we migrate these pages to {autofile} which has the same effect.
+	# However, {autofile} contains source filenames whereas {deleted}
+	# contains page names.
+	my %deleted;
+	if (ref $wikistate{autoindex}{deleted}) {
+		%deleted=%{$wikistate{autoindex}{deleted}};
+		delete $wikistate{autoindex}{deleted};
+	}
+        elsif (ref $pagestate{index}{autoindex}{deleted}) {
+		# an even older version
+		%deleted=%{$pagestate{index}{autoindex}{deleted}};
+		delete $pagestate{index}{autoindex};
 	}
-	
-	if (@needed) {
-		if ($config{rcs}) {
-			IkiWiki::disable_commit_hook();
+
+	if (keys %deleted) {
+		foreach my $dir (keys %deleted) {
+			my $file=newpagefile($dir, $config{default_pageext});
+			$wikistate{autoindex}{autofile}{$file} = 1;
 		}
-		genindex($_) foreach @needed;
-		if ($config{rcs}) {
-			IkiWiki::rcs_commit_staged(
-				gettext("automatic index generation"),
-				undef, undef);
-			IkiWiki::enable_commit_hook();
+	}
+
+	foreach my $dir (keys %dirs) {
+		if (! exists $pages{$dir} && grep /^$dir\/.*/, keys %pages) {
+			genindex($dir);
 		}
 	}
-} #}}}
+}
 
 1