IkiWiki/Plugin/autoindex.pm

   1 #!/usr/bin/perl
   2 package IkiWiki::Plugin::autoindex;
   3
   4 use warnings;
   5 use strict;
   6 use IkiWiki 3.00;
   7 use Encode;
   8
   9 sub import {
  10         hook(type => "getsetup", id => "autoindex", call => \&getsetup);
  11         hook(type => "refresh", id => "autoindex", call => \&refresh);
  12         IkiWiki::loadplugin("transient");
  13 }
  14
  15 sub getsetup () {
  16         return
  17                 plugin => {
  18                         safe => 1,
  19                         rebuild => 0,
  20                 },
  21                 autoindex_commit => {
  22                         type => "boolean",
  23                         example => 1,
  24                         default => 1,
  25                         description => "commit autocreated index pages",
  26                         safe => 1,
  27                         rebuild => 0,
  28                 },
  29 }
  30
  31 sub genindex ($) {
  32         my $page=shift;
  33         my $file=newpagefile($page, $config{default_pageext});
  34
  35         add_autofile($file, "autoindex", sub {
  36                         my $message = sprintf(gettext("creating index page %s"),
  37                                 $page);
  38                         debug($message);
  39
  40                         my $dir = $config{srcdir};
  41                         if (! $config{autoindex_commit}) {
  42                                 $dir = $IkiWiki::Plugin::transient::transientdir;
  43                         }
  44
  45                         my $template = template("autoindex.tmpl");
  46                         $template->param(page => $page);
  47                         writefile($file, $dir, $template->output);
  48
  49                         if ($config{rcs} && $config{autoindex_commit}) {
  50                                 IkiWiki::disable_commit_hook();
  51                                 IkiWiki::rcs_add($file);
  52                                 IkiWiki::rcs_commit_staged(message => $message);
  53                                 IkiWiki::enable_commit_hook();
  54                         }
  55                 });
  56 }
  57
  58 sub refresh () {
  59         eval q{use File::Find};
  60         error($@) if $@;
  61         eval q{use Cwd};
  62         error($@) if $@;
  63         my $origdir=getcwd();
  64
  65         my (%pages, %dirs);
  66         foreach my $dir ($config{srcdir}, @{$config{underlaydirs}}, $config{underlaydir}) {
  67                 next if $dir eq $IkiWiki::Plugin::transient::transientdir;
  68                 chdir($dir) || next;
  69
  70                 find({
  71                         no_chdir => 1,
  72                         wanted => sub {
  73                                 my $file=decode_utf8($_);
  74                                 $file=~s/^\.\/?//;
  75                                 return unless length $file;
  76                                 if (IkiWiki::file_pruned($file)) {
  77                                         $File::Find::prune=1;
  78                                 }
  79                                 elsif (! -l $_) {
  80                                         my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
  81                                         return unless defined $f;
  82                                         return if $f =~ /\._([^.]+)$/; # skip internal page
  83                                         if (! -d _) {
  84                                                 $pages{pagename($f)}=1;
  85                                         }
  86                                         elsif ($dir eq $config{srcdir}) {
  87                                                 $dirs{$f}=1;
  88                                         }
  89                                 }
  90                         }
  91                 }, '.');
  92
  93                 chdir($origdir) || die "chdir $origdir: $!";
  94         }
  95
  96         # Compatibility code.
  97         #
  98         # {deleted} contains pages that have been deleted at some point.
  99         # This plugin used to delete from the hash sometimes, but no longer
 100         # does; in [[todo/autoindex_should_use_add__95__autofile]] Joey
 101         # thought the old behaviour was probably a bug.
 102         #
 103         # The effect of listing a page in {deleted} was to avoid re-creating
 104         # it; we migrate these pages to {autofile} which has the same effect.
 105         # However, {autofile} contains source filenames whereas {deleted}
 106         # contains page names.
 107         my %deleted;
 108         if (ref $wikistate{autoindex}{deleted}) {
 109                 %deleted=%{$wikistate{autoindex}{deleted}};
 110                 delete $wikistate{autoindex}{deleted};
 111         }
 112         elsif (ref $pagestate{index}{autoindex}{deleted}) {
 113                 # an even older version
 114                 %deleted=%{$pagestate{index}{autoindex}{deleted}};
 115                 delete $pagestate{index}{autoindex};
 116         }
 117
 118         if (keys %deleted) {
 119                 foreach my $dir (keys %deleted) {
 120                         my $file=newpagefile($dir, $config{default_pageext});
 121                         $wikistate{autoindex}{autofile}{$file} = 1;
 122                 }
 123         }
 124
 125         foreach my $dir (keys %dirs) {
 126                 if (! exists $pages{$dir} && grep /^$dir\/.*/, keys %pages) {
 127                         genindex($dir);
 128                 }
 129         }
 130 }
 131
 132 1