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