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 3.00;
  13
  14 sub import {
  15         hook(type => "getsetup", id => "map", call => \&getsetup);
  16         hook(type => "preprocess", id => "map", call => \&preprocess);
  17 }
  18
  19 sub getsetup () {
  20         return
  21                 plugin => {
  22                         safe => 1,
  23                         rebuild => undef,
  24                 },
  25 }
  26
  27 sub preprocess (@) {
  28         my %params=@_;
  29         $params{pages}="*" unless defined $params{pages};
  30
  31         my $common_prefix;
  32
  33         # Get all the items to map.
  34         my %mapitems;
  35         foreach my $page (pagespec_match_list([keys %pagesources],
  36                                 $params{pages}, location => $params{page})) {
  37                 if (exists $params{show} &&
  38                     exists $pagestate{$page} &&
  39                     exists $pagestate{$page}{meta}{$params{show}}) {
  40                         $mapitems{$page}=$pagestate{$page}{meta}{$params{show}};
  41                 }
  42                 else {
  43                         $mapitems{$page}='';
  44                 }
  45                 # Check for a common prefix.
  46                 if (! defined $common_prefix) {
  47                         $common_prefix=$page;
  48                 }
  49                 elsif (length $common_prefix &&
  50                        $page !~ /^\Q$common_prefix\E(\/|$)/) {
  51                         my @a=split(/\//, $page);
  52                         my @b=split(/\//, $common_prefix);
  53                         $common_prefix="";
  54                         while (@a && @b && $a[0] eq $b[0]) {
  55                                 if (length $common_prefix) {
  56                                         $common_prefix.="/";
  57                                 }
  58                                 $common_prefix.=shift(@a);
  59                                 shift @b;
  60                         }
  61                 }
  62         }
  63
  64         # Common prefix should not be a page in the map.
  65         while (defined $common_prefix && length $common_prefix &&
  66                exists $mapitems{$common_prefix}) {
  67                 $common_prefix=IkiWiki::dirname($common_prefix);
  68         }
  69
  70         # Needs to update whenever a page is added or removed (or in some
  71         # cases, when its content changes, if show=title), so register a
  72         # dependency.
  73         add_depends($params{page}, $params{pages});
  74         # Explicitly add all currently shown pages, to detect when pages
  75         # are removed.
  76         add_depends($params{page}, join(" or ", keys %mapitems));
  77
  78         # Create the map.
  79         my $parent="";
  80         my $indent=0;
  81         my $openli=0;
  82         my $addparent="";
  83         my $map = "<div class='map'>\n";
  84
  85         # Return empty div if %mapitems is empty
  86         if (!scalar(keys %mapitems)) {
  87                 $map .= "</div>\n";
  88                 return $map;
  89         }
  90         else { # continue populating $map
  91                 $map .= "<ul>\n";
  92         }
  93
  94         foreach my $item (sort keys %mapitems) {
  95                 my @linktext = (length $mapitems{$item} ? (linktext => $mapitems{$item}) : ());
  96                 $item=~s/^\Q$common_prefix\E\///
  97                         if defined $common_prefix && length $common_prefix;
  98                 my $depth = ($item =~ tr/\//\//) + 1;
  99                 my $baseitem=IkiWiki::dirname($item);
 100                 while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) {
 101                         $parent=IkiWiki::dirname($parent);
 102                         last if length $addparent && $baseitem =~ /^\Q$addparent\E(\/|$)/;
 103                         $addparent="";
 104                         $indent--;
 105                         $map .= "</li>\n";
 106                         if ($indent > 0) {
 107                                 $map .= "</ul>\n";
 108                         }
 109                 }
 110                 while ($depth < $indent) {
 111                         $indent--;
 112                         $map .= "</li>\n";
 113                         if ($indent > 0) {
 114                                 $map .= "</ul>\n";
 115                         }
 116                 }
 117                 my @bits=split("/", $item);
 118                 my $p="";
 119                 $p.="/".shift(@bits) for 1..$indent;
 120                 while ($depth > $indent) {
 121                         $indent++;
 122                         if ($indent > 1) {
 123                                 $map .= "<ul>\n";
 124                         }
 125                         if ($depth > $indent) {
 126                                 $p.="/".shift(@bits);
 127                                 $addparent=$p;
 128                                 $addparent=~s/^\///;
 129                                 $map .= "<li>"
 130                                         .htmllink($params{page}, $params{destpage},
 131                                                  "/".$common_prefix.$p, class => "mapparent",
 132                                                  noimageinline => 1)
 133                                         ."\n";
 134                                 $openli=1;
 135                         }
 136                         else {
 137                                 $openli=0;
 138                         }
 139                 }
 140                 $map .= "</li>\n" if $openli;
 141                 $map .= "<li>"
 142                         .htmllink($params{page}, $params{destpage},
 143                                 "/".$common_prefix."/".$item,
 144                                 @linktext,
 145                                 class => "mapitem", noimageinline => 1)
 146                         ."\n";
 147                 $openli=1;
 148                 $parent=$item;
 149         }
 150         while ($indent > 0) {
 151                 $indent--;
 152                 $map .= "</li>\n</ul>\n";
 153         }
 154         $map .= "</div>\n";
 155         return $map;
 156 }
 157
 158 1