IkiWiki/Plugin/linkmap.pm

   1 #!/usr/bin/perl
   2 package IkiWiki::Plugin::linkmap;
   3
   4 use warnings;
   5 use strict;
   6 use IkiWiki;
   7 use IPC::Open2;
   8
   9 sub import { #{{{
  10         IkiWiki::hook(type => "preprocess", id => "linkmap",
  11                 call => \&preprocess);
  12         IkiWiki::hook(type => "format", id => "linkmap",
  13                 call => \&format);
  14 } # }}}
  15
  16 my $mapnum=0;
  17 my %maps;
  18
  19 sub preprocess (@) { #{{{
  20         my %params=@_;
  21         $params{pages}="*" unless defined $params{pages};
  22
  23         # Needs to update whenever a page is added or removed, so
  24         # register a dependency.
  25         IkiWiki::add_depends($params{page}, $params{pages});
  26
  27         # Can't just return the linkmap here, since the htmlscrubber
  28         # scrubs out all <object> tags (with good reason!)
  29         # Instead, insert a placeholder tag, which will be expanded during
  30         # formatting.
  31         $mapnum++;
  32         $maps{$mapnum}=\%params;
  33         return "<div class=\"linkmap$mapnum\"></div>";
  34 } # }}}
  35
  36 sub format (@) { #{{{
  37         my %params=@_;
  38
  39         $params{content}=~s/<div class=\"linkmap(\d+)"><\/div>/genmap($1)/eg;
  40
  41         return $params{content};
  42 } # }}}
  43
  44 sub genmap ($) { #{{{
  45         my $mapnum=shift;
  46         return "" unless exists $maps{$mapnum};
  47         my %params=%{$maps{$mapnum}};
  48
  49         # Get all the items to map.
  50         my %mapitems = ();
  51         foreach my $item (keys %IkiWiki::links) {
  52                 if (IkiWiki::pagespec_match($item, $params{pages})) {
  53                         my $link=IkiWiki::htmlpage($item);
  54                         $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page}));
  55                         $mapitems{$item}=$link;
  56                 }
  57         }
  58
  59         # Use ikiwiki's function to create the file, this makes sure needed
  60         # subdirs are there and does some sanity checking.
  61         IkiWiki::writefile("$params{page}.png", $IkiWiki::config{destdir}, "");
  62
  63         # Run dot to create the graphic and get the map data.
  64         # TODO: should really add the png to renderedfiles and call
  65         # check_overwrite, but currently renderedfiles
  66         # only supports listing one file per page.
  67         my $tries=10;
  68         my $pid;
  69         while (1) {
  70                 eval {
  71                         $pid=open2(*IN, *OUT, "dot /dev/stdin -Tpng -o '$IkiWiki::config{destdir}/$params{page}.png' -Tcmapx");
  72                 };
  73                 last unless $@;
  74                 $tries--;
  75                 if ($tries < 1) {
  76                         return "failed to run dot: $@";
  77                 }
  78         }
  79         # open2 doesn't respect "use open ':utf8'"
  80         binmode (IN, ':utf8');
  81         binmode (OUT, ':utf8');
  82
  83         print OUT "digraph linkmap$mapnum {\n";
  84         print OUT "concentrate=true;\n";
  85         print OUT "charset=\"utf-8\";\n";
  86         foreach my $item (keys %mapitems) {
  87                 print OUT "\"$item\" [shape=box,href=\"$mapitems{$item}\"];\n";
  88                 foreach my $link (map { IkiWiki::bestlink($item, $_) } @{$IkiWiki::links{$item}}) {
  89                         print OUT "\"$item\" -> \"$link\";\n"
  90                                 if $mapitems{$link};
  91                 }
  92         }
  93         print OUT "}\n";
  94         close OUT;
  95
  96         local $/=undef;
  97         my $ret="<object data=\"".
  98                 IkiWiki::abs2rel("$params{page}.png", IkiWiki::dirname($params{page})).
  99                 "\" type=\"image/png\" usemap=\"#linkmap$mapnum\">\n".
 100                  <IN>.
 101                  "</object>";
 102         close IN;
 103         waitpid $pid, 0;
 104         return $ret;
 105 } #}}}
 106
 107 1