]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/linkmap.pm
linkmap: Use a combination of presence and link dependencies.
[ikiwiki.git] / IkiWiki / Plugin / linkmap.pm
index 497b1ef43485dbdd4cb77043072f42c4a3b2898e..d7ba68da9e91133c33bbef0f743430f5fd0993b0 100644 (file)
@@ -3,25 +3,34 @@ package IkiWiki::Plugin::linkmap;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 use IPC::Open2;
 
-sub import { #{{{
+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;
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params=@_;
 
        $params{pages}="*" unless defined $params{pages};
        
-       # Needs to update whenever a page is added or removed, so
-       # register a dependency.
-       add_depends($params{page}, $params{pages});
+       # Needs to update whenever a relevant page is added, or removed, or
+       # its links change.
+       add_depends($params{page}, $params{pages}, presence => 1, links => 1);
        
        # Can't just return the linkmap here, since the htmlscrubber
        # scrubs out all <object> tags (with good reason!)
@@ -30,17 +39,17 @@ sub preprocess (@) { #{{{
        $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};
-} # }}}
+}
 
-sub genmap ($) { #{{{
+sub genmap ($) {
        my $mapnum=shift;
        return "" unless exists $maps{$mapnum};
        my %params=%{$maps{$mapnum}};
@@ -48,25 +57,23 @@ sub genmap ($) { #{{{
        # Get all the items to map.
        my %mapitems = ();
        foreach my $item (keys %links) {
-               if (pagespec_match($item, $params{pages})) {
-                       my $link=htmlpage($item);
-                       $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
-                       $mapitems{$item}=$link;
+               if (pagespec_match($item, $params{pages}, location => $params{page})) {
+                       $mapitems{$item}=urlto($item, $params{destpage});
                }
        }
 
+       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.
-       writefile("$params{page}.png", $config{destdir}, "");
+       will_render($params{page}, $dest);
+       writefile($dest, $config{destdir}, "");
 
        # 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 $pid;
-       my $sigpipe=0;;
+       my $sigpipe=0;
        $SIG{PIPE}=sub { $sigpipe=1 };
-       $pid=open2(*IN, *OUT, "dot -Tpng -o '$config{destdir}/$params{page}.png' -Tcmapx");
+       $pid=open2(*IN, *OUT, "dot -Tpng -o '$config{destdir}/$dest' -Tcmapx");
        
        # open2 doesn't respect "use open ':utf8'"
        binmode (IN, ':utf8'); 
@@ -88,8 +95,7 @@ sub genmap ($) { #{{{
        close OUT;
 
        local $/=undef;
-       my $ret="<object data=\"".
-              IkiWiki::abs2rel("$params{page}.png", IkiWiki::dirname($params{page})).
+       my $ret="<object data=\"".urlto($dest, $params{destpage}).
               "\" type=\"image/png\" usemap=\"#linkmap$mapnum\">\n".
                <IN>.
                "</object>";
@@ -97,11 +103,9 @@ sub genmap ($) { #{{{
        
        waitpid $pid, 0;
        $SIG{PIPE}="DEFAULT";
-       if ($sigpipe) {
-               return  "[[linkmap failed to run dot]]";
-       }
+       error gettext("failed to run dot") if $sigpipe;
 
        return $ret;
-} #}}}
+}
 
 1