]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/linkmap.pm
Added a comment
[git.ikiwiki.info.git] / IkiWiki / Plugin / linkmap.pm
index 2405cae7f52c4199042642c9d2103a2fae1a38ae..b5ef1a137beb26e3e66aee89f468c33fd6e1865a 100644 (file)
@@ -3,80 +3,66 @@ package IkiWiki::Plugin::linkmap;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 3.00;
 use IPC::Open2;
+use HTML::Entities;
 
-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);
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+                       section => "widget",
+               },
+}
 
 my $mapnum=0;
-my %maps;
 
-sub preprocess (@) { #{{{
+sub pageescape {
+       my $item = shift;
+       # encoding explicitly in case ikiwiki is configured to accept <> or &
+       # in file names
+       my $title = pagetitle($item, 1);
+       # it would not be necessary to encode *all* the html entities (<> would
+       # be sufficient, &" probably a good idea), as dot accepts utf8, but it
+       # isn't bad either
+       $title = encode_entities($title);
+       return("<$title>");
+}
+
+sub preprocess (@) {
        my %params=@_;
 
        $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
-       # formatting.
        $mapnum++;
-       $maps{$mapnum}=\%params;
-       return "<div class=\"linkmap$mapnum\"></div>";
-} # }}}
-
-sub format (@) { #{{{
-        my %params=@_;
-
-       $params{content}=~s/<div class=\"linkmap(\d+)"><\/div>/genmap($1)/eg;
-
-        return $params{content};
-} # }}}
-
-sub genmap ($) { #{{{
-       my $mapnum=shift;
-       return "" unless exists $maps{$mapnum};
-       my %params=%{$maps{$mapnum}};
+       my $connected=IkiWiki::yesno($params{connected});
 
        # 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.
-       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.
-       # 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;
-       while (1) {
-               eval {
-                       $pid=open2(*IN, *OUT, "dot -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'); 
@@ -86,25 +72,42 @@ sub genmap ($) { #{{{
        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 pageescape($item)." [shape=box,href=\"$mapitems{$item}\"];\n";
+                       $shown{$item}=1;
+               }
+       };
        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 pageescape($item)." -> ".pageescape($link).";\n";
                }
        }
        print OUT "}\n";
-       close OUT;
+       close OUT || error gettext("failed to run dot");
 
        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="<img src=\"".urlto($dest, $params{destpage}).
+              "\" alt=\"".gettext("linkmap").
+              "\" usemap=\"#linkmap$mapnum\" />\n".
+               <IN>;
+       close IN || error gettext("failed to run dot");
+       
        waitpid $pid, 0;
+       if ($?) {
+               error gettext("failed to run dot");
+       }
+       $SIG{PIPE}="DEFAULT";
+       error gettext("failed to run dot") if $sigpipe;
+
        return $ret;
-} #}}}
+}
 
 1