correct variable scoping error in nils's patch
[ikiwiki.git] / 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 (defined $common_prefix && length $common_prefix &&
49                exists $mapitems{$common_prefix}) {
50                 $common_prefix=IkiWiki::dirname($common_prefix);
51         }
52
53         # Needs to update whenever a page is added or removed, so
54         # register a dependency.
55         add_depends($params{page}, $params{pages});
56         # Explicitly add all currently shown pages, to detect when pages
57         # are removed.
58         add_depends($params{page}, join(" or ", keys %mapitems));
59
60         # Create the map.
61         my $parent="";
62         my $indent=0;
63         my $openli=0;
64         my $dummy=0;
65         my $map = "<div class='map'>\n<ul>\n";
66         foreach my $item (sort keys %mapitems) {
67                 $item=~s/^\Q$common_prefix\E\///
68                         if defined $common_prefix && length $common_prefix;
69                 my $depth = ($item =~ tr/\//\//) + 1;
70                 my $baseitem=IkiWiki::dirname($item);
71                 while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) {
72                         $parent=IkiWiki::dirname($parent);
73                         last if !$dummy && length $parent && $baseitem =~ /^\Q$parent\E(\/|$)/;
74                         $indent--;
75                         $map .= "</li>\n";
76                         if ($indent > 0) {
77                                 $map .= "</ul>\n";
78                         }
79                 }
80                 $dummy=0;
81                 while ($depth < $indent) {
82                         $indent--;
83                         $map .= "</li>\n";
84                         if ($indent > 0) {
85                                 $map .= "</ul>\n";
86                         }
87                 }
88                 my @bits=split("/", $item);
89                 my $p="";
90                 $p.="/".shift(@bits) for 1..$indent;
91                 while ($depth > $indent) {
92                         $indent++;
93                         if ($indent > 1) {
94                                 $map .= "<ul>\n";
95                         }
96                         if ($depth > $indent) {
97                                 $dummy=1;
98                                 $p.="/".shift(@bits);
99                                 $map .= "<li>"
100                                         .htmllink($params{page}, $params{destpage},
101                                                  $p, class => "mapparent",
102                                                  noimageinline => 1)
103                                         ."\n";
104                                 $openli=1;
105                         }
106                         else {
107                                 $openli=0;
108                         }
109                 }
110                 $map .= "</li>\n" if $openli;
111                 $map .= "<li>"
112                         .htmllink($params{page}, $params{destpage}, 
113                                 "/".$common_prefix."/".$item,
114                                 class => "mapitem", noimageinline => 1)
115                         ."\n";
116                 $openli=1;
117                 $parent=$item;
118         }
119         while ($indent > 0) {
120                 $indent--;
121                 $map .= "</li>\n</ul>\n";
122         }
123         $map .= "</div>\n";
124         return $map;
125 } # }}}
126
127 1