IkiWiki/Plugin/map.pm

   1 #!/usr/bin/perl
   2 #
   3 # Produce a hierarchical map of links.
   4 #
   5 # by Alessandro Dotti Contra <alessandro@hyboria.org>
   6 #
   7 # Revision: 0.2
   8 package IkiWiki::Plugin::map;
   9
  10 use warnings;
  11 use strict;
  12 use IkiWiki 2.00;
  13
  14 sub import { #{{{
  15         hook(type => "preprocess", id => "map", call => \&preprocess);
  16 } # }}}
  17
  18 sub preprocess (@) { #{{{
  19         my %params=@_;
  20         $params{pages}="*" unless defined $params{pages};
  21
  22         my $common_prefix;
  23
  24         # Get all the items to map.
  25         my %mapitems;
  26         foreach my $page (keys %pagesources) {
  27                 if (pagespec_match($page, $params{pages}, location => $params{page})) {
  28                         $mapitems{$page}=1;
  29
  30                         # Check for a common prefix.
  31                         if (! defined $common_prefix) {
  32                                 $common_prefix=$page;
  33                         }
  34                         elsif (length $common_prefix &&
  35                                $page !~ /^\Q$common_prefix\E(\/|$)/) {
  36                                 my @a=split(/\//, $page);
  37                                 my @b=split(/\//, $common_prefix);
  38                                 $common_prefix="";
  39                                 while (@a && @b && $a[0] eq $b[0]) {
  40                                         $common_prefix.=shift(@a);
  41                                         shift @b;
  42                                 }
  43                         }
  44                 }
  45         }
  46
  47         # Common prefix should not be a page in the map.
  48         while (length $common_prefix && exists $mapitems{$common_prefix}) {
  49                 $common_prefix=IkiWiki::dirname($common_prefix);
  50         }
  51
  52         # Needs to update whenever a page is added or removed, so
  53         # register a dependency.
  54         add_depends($params{page}, $params{pages});
  55         # Explicitly add all currently shown pages, to detect when pages
  56         # are removed.
  57         add_depends($params{page}, join(" or ", keys %mapitems));
  58
  59         # Create the map.
  60         my $parent="";
  61         my $indent=0;
  62         my $openli=0;
  63         my $map = "<div class='map'>\n<ul>\n";
  64         foreach my $item (sort keys %mapitems) {
  65                 $item=~s/^\Q$common_prefix\E\/// if length $common_prefix;
  66                 my $depth = ($item =~ tr/\//\//) + 1;
  67                 my $baseitem=IkiWiki::dirname($item);
  68                 while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) {
  69                         $parent=IkiWiki::dirname($parent);
  70                         $indent--;
  71                         $map .= "</li>\n";
  72                         if ($indent > 0) {
  73                                 $map .= "</ul>\n";
  74                         }
  75                 }
  76                 while ($depth < $indent) {
  77                         $indent--;
  78                         $map .= "</li>\n";
  79                         if ($indent > 0) {
  80                                 $map .= "</ul>\n";
  81                         }
  82                 }
  83                 my @bits=split("/", $item);
  84                 my $p="";
  85                 $p.="/".shift(@bits) for 1..$indent;
  86                 while ($depth > $indent) {
  87                         $indent++;
  88                         if ($indent > 1) {
  89                                 $map .= "<ul>\n";
  90                         }
  91                         if ($depth > $indent) {
  92                                 $p.="/".shift(@bits);
  93                                 $map .= "<li>"
  94                                         .htmllink($params{page}, $params{destpage}, $p, class => "mapparent")
  95                                         ."\n";
  96                                 $openli=1;
  97                         }
  98                         else {
  99                                 $openli=0;
 100                         }
 101                 }
 102                 $map .= "</li>\n" if $openli;
 103                 $map .= "<li>"
 104                         .htmllink($params{page}, $params{destpage},
 105                                 "/".$common_prefix."/".$item, class => "mapitem")
 106                         ."\n";
 107                 $openli=1;
 108                 $parent=$item;
 109         }
 110         while ($indent > 0) {
 111                 $indent--;
 112                 $map .= "</li>\n</ul>\n";
 113         }
 114         $map .= "</div>\n";
 115         return $map;
 116 } # }}}
 117
 118 1