From: Joey Hess <joey@kitenet.net>
Date: Wed, 30 Nov 2011 18:40:27 +0000 (-0400)
Subject: graphviz: Support urls embedded in the graph, by having graphviz generate an imagemap.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=44863ea2346eea32b3bc8b9b700101bf7ea3b32f;p=ikiwiki.git

graphviz: Support urls embedded in the graph, by having graphviz generate an imagemap.

Also, I let preview mode write real files, rather than using data: uri.
Which is ok these days, since ikiwiki tracks files created during
previewing, and cleans them up later.
---

diff --git a/IkiWiki/Plugin/graphviz.pm b/IkiWiki/Plugin/graphviz.pm
index 4ed8b89f1..f01fdca85 100644
--- a/IkiWiki/Plugin/graphviz.pm
+++ b/IkiWiki/Plugin/graphviz.pm
@@ -26,10 +26,13 @@ my %graphviz_programs = (
 	"dot" => 1, "neato" => 1, "fdp" => 1, "twopi" => 1, "circo" => 1
 );
 
+my $graphnum=0;
+
 sub render_graph (\%) {
 	my %params = %{(shift)};
 
-	my $src = "$params{type} g {\n";
+	$graphnum++;
+	my $src = "$params{type} graph$graphnum {\n";
 	$src .= "charset=\"utf-8\";\n";
 	$src .= "ratio=compress;\nsize=\"".($params{width}+0).", ".($params{height}+0)."\";\n"
 		if defined $params{width} and defined $params{height};
@@ -39,48 +42,50 @@ sub render_graph (\%) {
 	# Use the sha1 of the graphviz code as part of its filename.
 	eval q{use Digest::SHA};
 	error($@) if $@;
-	my $dest=$params{page}."/graph-".
-		IkiWiki::possibly_foolish_untaint(Digest::SHA::sha1_hex($src)).
-		".png";
+	my $base=$params{page}."/graph-".
+		IkiWiki::possibly_foolish_untaint(Digest::SHA::sha1_hex($src));
+	my $dest=$base.".png";
 	will_render($params{page}, $dest);
 
-	if (! -e "$config{destdir}/$dest") {
+	# The imagemap data is stored as a separate file.
+	my $imagemap=$base.".imagemap";
+	will_render($params{page}, $imagemap);
+	
+	my $map;
+	if (! -e "$config{destdir}/$dest" || ! -e "$config{destdir}/$imagemap") {
+		# Use ikiwiki's function to create the image file, this makes
+		# sure needed subdirs are there and does some sanity checking.
+		writefile($dest, $config{destdir}, "");
+		
 		my $pid;
 		my $sigpipe=0;
 		$SIG{PIPE}=sub { $sigpipe=1 };
-		$pid=open2(*IN, *OUT, "$params{prog} -Tpng");
+		$pid=open2(*IN, *OUT, "$params{prog} -Tpng -o '$config{destdir}/$dest' -Tcmapx");
 
 		# open2 doesn't respect "use open ':utf8'"
+		binmode (IN, ':utf8');
 		binmode (OUT, ':utf8');
 
 		print OUT $src;
 		close OUT;
 
-		my $png;
-		{
-			local $/ = undef;
-			$png = <IN>;
-		}
+		local $/ = undef;
+		$map=<IN>;
 		close IN;
+		writefile($imagemap, $config{destdir}, $map);
 
 		waitpid $pid, 0;
 		$SIG{PIPE}="DEFAULT";
-		error gettext("failed to run graphviz") if $sigpipe;
-
-		if (! $params{preview}) {
-			writefile($dest, $config{destdir}, $png, 1);
-		}
-		else {
-			# in preview mode, embed the image in a data uri
-			# to avoid temp file clutter
-			eval q{use MIME::Base64};
-			error($@) if $@;
-			return "<img src=\"data:image/png;base64,".
-				encode_base64($png)."\" />";
-		}
+		error gettext("failed to run graphviz") if ($sigpipe || $?);
+
+	}
+	else {
+		$map=readfile("$config{destdir}/$imagemap");
 	}
 
-	return "<img src=\"".urlto($dest, $params{destpage})."\" />\n";
+	return "<img src=\"".urlto($dest, $params{destpage}).
+		"\" usemap=\"#graph$graphnum\" />\n".
+		$map;
 }
 
 sub graph (@) {
diff --git a/debian/changelog b/debian/changelog
index 73318b269..c77fbbeef 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,6 +6,8 @@ ikiwiki (3.20111107) UNRELEASED; urgency=low
   * The umask setting can now be set to private, group, or public,
     avoiding the need to enter octal correctly which is particularly
     difficult in yaml setup files. (smcv)
+  * graphviz: Support urls embedded in the graph, by having graphviz
+    generate an imagemap.
 
  -- Joey Hess <joeyh@debian.org>  Thu, 17 Nov 2011 18:52:23 -0400
 
diff --git a/doc/ikiwiki/directive/graph.mdwn b/doc/ikiwiki/directive/graph.mdwn
index 433187268..2828921d7 100644
--- a/doc/ikiwiki/directive/graph.mdwn
+++ b/doc/ikiwiki/directive/graph.mdwn
@@ -1,14 +1,10 @@
 The `graph` directive is supplied by the [[!iki plugins/graphviz desc=graphviz]] plugin.
 
-This directive allows embedding [graphviz](http://www.graphviz.org/) graphs in a
-page.  Example usage:
+This directive allows embedding [graphviz](http://www.graphviz.org/)
+graphs in a page.  Example usage:
 
 	\[[!graph src="a -> b -> c; a -> c;"]]
 
-Note that graphs will only show up in previews if your browser has
-[[!wikipedia data: URI]] support, or if the same graph already exists on that
-page.
-
 The `graph` directive supports the following parameters:
 
 - `src` - The graphviz source to render.