linkmap: Add option to omit disconnected pages from the map.

[git.ikiwiki.info.git] / IkiWiki / Plugin / map.pm

diff --git a/IkiWiki/Plugin/map.pm b/IkiWiki/Plugin/map.pm
index 429493b9ef4f9b61cd0fd354d25772cd155ecf7c..788b9682706c9e3a303b0920267e8ea20061305e 100644 (file)
--- a/IkiWiki/Plugin/map.pm
+++ b/IkiWiki/Plugin/map.pm
@@ -9,55 +9,58 @@ package IkiWiki::Plugin::map;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
        hook(type => "getsetup", id => "map", call => \&getsetup);
        hook(type => "preprocess", id => "map", call => \&preprocess);
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
                plugin => {
                        safe => 1,
                        rebuild => undef,
                },
-} #}}}
+}
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params=@_;
        $params{pages}="*" unless defined $params{pages};
        
+       # Needs to update whenever a page is added or removed (or in some
+       # cases, when its content changes, if show= is specified).
+       my $deptype=deptype(exists $params{show} ? "content" : "presence");
+       
        my $common_prefix;
 
        # Get all the items to map.
        my %mapitems;
-       foreach my $page (keys %pagesources) {
-               if (pagespec_match($page, $params{pages}, location => $params{page})) {
-                       if (exists $params{show} && 
-                           exists $pagestate{$page} &&
-                           exists $pagestate{$page}{meta}{$params{show}}) {
-                               $mapitems{$page}=$pagestate{$page}{meta}{$params{show}};
-                       }
-                       else {
-                               $mapitems{$page}='';
-                       }
-                       # Check for a common prefix.
-                       if (! defined $common_prefix) {
-                               $common_prefix=$page;
-                       }
-                       elsif (length $common_prefix &&
-                              $page !~ /^\Q$common_prefix\E(\/|$)/) {
-                               my @a=split(/\//, $page);
-                               my @b=split(/\//, $common_prefix);
-                               $common_prefix="";
-                               while (@a && @b && $a[0] eq $b[0]) {
-                                       if (length $common_prefix) {
-                                               $common_prefix.="/";
-                                       }
-                                       $common_prefix.=shift(@a);
-                                       shift @b;
+       foreach my $page (pagespec_match_list($params{page}, $params{pages},
+                                       deptype => $deptype)) {
+               if (exists $params{show} && 
+                   exists $pagestate{$page} &&
+                   exists $pagestate{$page}{meta}{$params{show}}) {
+                       $mapitems{$page}=$pagestate{$page}{meta}{$params{show}};
+               }
+               else {
+                       $mapitems{$page}='';
+               }
+               # Check for a common prefix.
+               if (! defined $common_prefix) {
+                       $common_prefix=$page;
+               }
+               elsif (length $common_prefix &&
+                      $page !~ /^\Q$common_prefix\E(\/|$)/) {
+                       my @a=split(/\//, $page);
+                       my @b=split(/\//, $common_prefix);
+                       $common_prefix="";
+                       while (@a && @b && $a[0] eq $b[0]) {
+                               if (length $common_prefix) {
+                                       $common_prefix.="/";
                                }
+                               $common_prefix.=shift(@a);
+                               shift @b;
                        }
                }
        }
@@ -68,20 +71,22 @@ sub preprocess (@) { #{{{
                $common_prefix=IkiWiki::dirname($common_prefix);
        }
 
-       # Needs to update whenever a page is added or removed (or in some
-       # cases, when its content changes, if show=title), so register a
-       # dependency.
-       add_depends($params{page}, $params{pages});
-       # Explicitly add all currently shown pages, to detect when pages
-       # are removed.
-       add_depends($params{page}, join(" or ", keys %mapitems));
-
        # Create the map.
        my $parent="";
        my $indent=0;
        my $openli=0;
-       my $dummy=0;
-       my $map = "<div class='map'>\n<ul>\n";
+       my $addparent="";
+       my $map = "<div class='map'>\n";
+
+       if (! keys %mapitems) {
+               # return empty div for empty map
+               $map .= "</div>\n";
+               return $map; 
+       } 
+       else {
+               $map .= "<ul>\n";
+       }
+
        foreach my $item (sort keys %mapitems) {
                my @linktext = (length $mapitems{$item} ? (linktext => $mapitems{$item}) : ());
                $item=~s/^\Q$common_prefix\E\///
@@ -90,14 +95,14 @@ sub preprocess (@) { #{{{
                my $baseitem=IkiWiki::dirname($item);
                while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) {
                        $parent=IkiWiki::dirname($parent);
-                       last if !$dummy && length $parent && $baseitem =~ /^\Q$parent\E(\/|$)/;
+                       last if length $addparent && $baseitem =~ /^\Q$addparent\E(\/|$)/;
+                       $addparent="";
                        $indent--;
                        $map .= "</li>\n";
                        if ($indent > 0) {
                                $map .= "</ul>\n";
                        }
                }
-               $dummy=0;
                while ($depth < $indent) {
                        $indent--;
                        $map .= "</li>\n";
@@ -106,22 +111,23 @@ sub preprocess (@) { #{{{
                        }
                }
                my @bits=split("/", $item);
+               my $p="";
+               $p.="/".shift(@bits) for 1..$indent;
                while ($depth > $indent) {
                        $indent++;
                        if ($indent > 1) {
                                $map .= "<ul>\n";
                        }
                        if ($depth > $indent) {
-                               my $p="";
-                               $p.="/".shift(@bits) for 1..$indent+1;
-                               $p=~s/^\///;
+                               $p.="/".shift(@bits);
+                               $addparent=$p;
+                               $addparent=~s/^\///;
                                $map .= "<li>"
                                        .htmllink($params{page}, $params{destpage},
-                                                $p, class => "mapparent",
+                                                "/".$common_prefix.$p, class => "mapparent",
                                                 noimageinline => 1)
                                        ."\n";
                                $openli=1;
-                               $dummy=1;
                        }
                        else {
                                $openli=0;
@@ -143,6 +149,6 @@ sub preprocess (@) { #{{{
        }
        $map .= "</div>\n";
        return $map;
-} # }}}
+}
 
 1