X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/58141a0ebcdf3313a83af712b83f8acd1c08aa3b..849b5446fa7279c99242c5cfe457deee0b9165c6:/IkiWiki/Plugin/linkmap.pm diff --git a/IkiWiki/Plugin/linkmap.pm b/IkiWiki/Plugin/linkmap.pm index 528d51697..b5ef1a137 100644 --- a/IkiWiki/Plugin/linkmap.pm +++ b/IkiWiki/Plugin/linkmap.pm @@ -3,68 +3,65 @@ package IkiWiki::Plugin::linkmap; use warnings; use strict; -use IkiWiki; +use IkiWiki 3.00; use IPC::Open2; +use HTML::Entities; -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, + 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. - add_depends($params{page}, $params{pages}); - - # Can't just return the linkmap here, since the htmlscrubber - # scrubs out all tags (with good reason!) - # Instead, insert a placeholder tag, which will be expanded during - # formatting. $mapnum++; - $maps{$mapnum}=\%params; - return "
"; -} # }}} - -sub format (@) { #{{{ - my %params=@_; - - $params{content}=~s/
<\/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 %links) { - if (pagespec_match($item, $params{pages}, $params{page})) { - my $link=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. - will_render($params{page}, $params{page}.".png"); - 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. 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'); @@ -75,31 +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"; + $show->($item) unless $connected; foreach my $link (map { bestlink($item, $_) } @{$links{$item}}) { - print OUT "\"$item\" -> \"$link\";\n" - if $mapitems{$link}; + 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="\n". - . - ""; - close IN; + my $ret="\"".gettext("linkmap").\n". + ; + close IN || error gettext("failed to run dot"); waitpid $pid, 0; - $SIG{PIPE}="DEFAULT"; - if ($sigpipe) { - return "[[".gettext("linkmap failed to run dot")."]]"; + if ($?) { + error gettext("failed to run dot"); } + $SIG{PIPE}="DEFAULT"; + error gettext("failed to run dot") if $sigpipe; return $ret; -} #}}} +} 1