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

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

diff --git a/IkiWiki/Plugin/linkmap.pm b/IkiWiki/Plugin/linkmap.pm
index 2c92784c2a5e05b1892daf041845a28cf5acc883..28acbda32abdbb4a9abd022d96a9906b81e987b7 100644 (file)
--- a/IkiWiki/Plugin/linkmap.pm
+++ b/IkiWiki/Plugin/linkmap.pm
@@ -3,27 +3,31 @@ package IkiWiki::Plugin::linkmap;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki;
+use IkiWiki 3.00;

 use IPC::Open2;
 
 use IPC::Open2;
 

-sub import { #{{{
-       IkiWiki::hook(type => "preprocess", id => "linkmap",
-               call => \&preprocess);
-       IkiWiki::hook(type => "format", id => "linkmap",
-               call => \&format);
-} # }}}
+sub import {
+       hook(type => "getsetup", id => "linkmap", call => \&getsetup);
+       hook(type => "preprocess", id => "linkmap", call => \&preprocess);
+       hook(type => "format", id => "linkmap", call => \&format);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+}

 
 my $mapnum=0;
 my %maps;
 
 
 my $mapnum=0;
 my %maps;
 

-sub preprocess (@) { #{{{
+sub preprocess (@) {

        my %params=@_;
        my %params=@_;

+

        $params{pages}="*" unless defined $params{pages};
        
        $params{pages}="*" unless defined $params{pages};
        

-       # Needs to update whenever a page is added or removed, so
-       # register a dependency.
-       IkiWiki::add_depends($params{page}, $params{pages});
-       

        # Can't just return the linkmap here, since the htmlscrubber
        # scrubs out all <object> tags (with good reason!)
        # Instead, insert a placeholder tag, which will be expanded during
        # Can't just return the linkmap here, since the htmlscrubber
        # scrubs out all <object> tags (with good reason!)
        # Instead, insert a placeholder tag, which will be expanded during


@@ -31,51 +35,42 @@ sub preprocess (@) { #{{{
        $mapnum++;
        $maps{$mapnum}=\%params;
        return "<div class=\"linkmap$mapnum\"></div>";
        $mapnum++;
        $maps{$mapnum}=\%params;
        return "<div class=\"linkmap$mapnum\"></div>";

-} # }}}
+}

 
 

-sub format (@) { #{{{
+sub format (@) {

         my %params=@_;
 
        $params{content}=~s/<div class=\"linkmap(\d+)"><\/div>/genmap($1)/eg;
 
         return $params{content};
         my %params=@_;
 
        $params{content}=~s/<div class=\"linkmap(\d+)"><\/div>/genmap($1)/eg;
 
         return $params{content};

-} # }}}
+}

 
 

-sub genmap ($) { #{{{
+sub genmap ($) {

        my $mapnum=shift;
        return "" unless exists $maps{$mapnum};
        my %params=%{$maps{$mapnum}};
        my $mapnum=shift;
        return "" unless exists $maps{$mapnum};
        my %params=%{$maps{$mapnum}};

+       my $connected=IkiWiki::yesno($params{connected});

 
        # Get all the items to map.
 
        # Get all the items to map.

-       my %mapitems = ();
-       foreach my $item (keys %IkiWiki::links) {
-               if (IkiWiki::pagespec_match($item, $params{pages})) {
-                       my $link=IkiWiki::htmlpage($item);
-                       $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
-                       $mapitems{$item}=$link;
-               }
-       }
+       my %mapitems = map { $_ => urlto($_, $params{destpage}) }
+               pagespec_match_list($params{page}, $params{pages},
+                       # update when a page is added or removed, or its
+                       # links change
+                       deptype => deptype("presence", "links"));
+
+       my $dest=$params{page}."/linkmap.png";

 
        # Use ikiwiki's function to create the file, this makes sure needed
        # subdirs are there and does some sanity checking.
 
        # Use ikiwiki's function to create the file, this makes sure needed
        # subdirs are there and does some sanity checking.

-       IkiWiki::writefile("$params{page}.png", $IkiWiki::config{destdir}, "");
+       will_render($params{page}, $dest);
+       writefile($dest, $config{destdir}, "");

 
        # Run dot to create the graphic and get the map data.
 
        # Run dot to create the graphic and get the map data.

-       # TODO: should really add the png to renderedfiles and call
-       # check_overwrite, but currently renderedfiles
-       # only supports listing one file per page.
-       my $tries=10;

        my $pid;
        my $pid;

-       while (1) {
-               eval {
-                       $pid=open2(*IN, *OUT, "dot /dev/stdin -Tpng -o '$IkiWiki::config{destdir}/$params{page}.png' -Tcmapx");
-               };
-               last unless $@;
-               $tries--;
-               if ($tries < 1) {
-                       return "failed to run dot: $@";
-               }
-       }
+       my $sigpipe=0;
+       $SIG{PIPE}=sub { $sigpipe=1 };
+       $pid=open2(*IN, *OUT, "dot -Tpng -o '$config{destdir}/$dest' -Tcmapx");
+       

        # open2 doesn't respect "use open ':utf8'"
        binmode (IN, ':utf8'); 
        binmode (OUT, ':utf8'); 
        # open2 doesn't respect "use open ':utf8'"
        binmode (IN, ':utf8'); 
        binmode (OUT, ':utf8'); 


@@ -83,25 +78,44 @@ sub genmap ($) { #{{{
        print OUT "digraph linkmap$mapnum {\n";
        print OUT "concentrate=true;\n";
        print OUT "charset=\"utf-8\";\n";
        print OUT "digraph linkmap$mapnum {\n";
        print OUT "concentrate=true;\n";
        print OUT "charset=\"utf-8\";\n";

+       print OUT "ratio=compress;\nsize=\"".($params{width}+0).", ".($params{height}+0)."\";\n"
+               if defined $params{width} and defined $params{height};
+       my %shown;
+       my $show=sub {
+               my $item=shift;
+               if (! $shown{$item}) {
+                       print OUT "\"$item\" [shape=box,href=\"$mapitems{$item}\"];\n";
+                       $shown{$item}=1;
+               }
+       };

        foreach my $item (keys %mapitems) {
        foreach my $item (keys %mapitems) {

-               print OUT "\"$item\" [shape=box,href=\"$mapitems{$item}\"];\n";
-               foreach my $link (map { IkiWiki::bestlink($item, $_) } @{$IkiWiki::links{$item}}) {
-                       print OUT "\"$item\" -> \"$link\";\n"
-                               if $mapitems{$link};
+               $show->($item) unless $connected;
+               foreach my $link (map { bestlink($item, $_) } @{$links{$item}}) {
+                       next unless length $link and $mapitems{$link};
+                       foreach my $endpoint ($item, $link) {
+                               $show->($endpoint);
+                       }
+                       print OUT "\"$item\" -> \"$link\";\n";

                }
        }
        print OUT "}\n";
                }
        }
        print OUT "}\n";

-       close OUT;
+       close OUT || error gettext("failed to run dot");

 
        local $/=undef;
 
        local $/=undef;

-       my $ret="<object data=\"".
-               IkiWiki::abs2rel("$params{page}.png", IkiWiki::dirname($params{page})).
-               "\" type=\"image/png\" usemap=\"#linkmap$mapnum\">\n".
-                <IN>.
-                "</object>";
-       close IN;
+       my $ret="<object data=\"".urlto($dest, $params{destpage}).
+              "\" type=\"image/png\" usemap=\"#linkmap$mapnum\">\n".
+               <IN>.
+               "</object>";
+       close IN || error gettext("failed to run dot");
+       

        waitpid $pid, 0;
        waitpid $pid, 0;

+       if ($?) {
+               error gettext("failed to run dot");
+       }
+       $SIG{PIPE}="DEFAULT";
+       error gettext("failed to run dot") if $sigpipe;
+

        return $ret;
        return $ret;

-} #}}}
+}

 
 1
 
 1