1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
|
<?php
namespace EasyRdf\Serialiser;
/**
* EasyRdf
*
* LICENSE
*
* Copyright (c) 2012-2020 Nicholas J Humfrey. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author 'Nicholas J Humfrey" may be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package EasyRdf
* @copyright Copyright (c) 2009-2020 Nicholas J Humfrey
* @license https://www.opensource.org/licenses/bsd-license.php
*/
use EasyRdf\Exception;
use EasyRdf\Graph;
use EasyRdf\RdfNamespace;
use EasyRdf\Resource;
use EasyRdf\Serialiser;
use EasyRdf\Utils;
/**
* Class to serialise an EasyRdf\Graph to GraphViz
*
* Depends upon the GraphViz 'dot' command line tools to render images.
*
* See http://www.graphviz.org/ for more information.
*
* @package EasyRdf
* @copyright Copyright (c) 2012-2020 Nicholas J Humfrey
* @license https://www.opensource.org/licenses/bsd-license.php
*/
class GraphViz extends Serialiser
{
private $dotCommand = 'dot';
private $useLabels = false;
private $onlyLabelled = false;
private $attributes = array('charset' => 'utf-8');
/**
* Set the path to the GraphViz 'dot' command
*
* Default is to search PATH for the command 'dot'.
*
* @param string $cmd The path to the 'dot' command.
*
* @return self
*/
public function setDotCommand($cmd)
{
$this->dotCommand = $cmd;
return $this;
}
/**
* Get the path to the GraphViz 'dot' command
*
* The default value is simply 'dot'
*
* @return string The path to the 'dot' command.
*/
public function getDotCommand()
{
return $this->dotCommand;
}
/**
* Turn on/off the option to display labels instead of URIs.
*
* When this option is turned on, then labels for resources will
* be displayed instead of the full URI of a resource. This makes
* it simpler to create friendly diagrams that non-technical people
* can understand.
*
* This option is turned off by default.
*
* @param bool $useLabels A boolean value to turn labels on and off
*
* @return GraphViz
*/
public function setUseLabels($useLabels)
{
$this->useLabels = $useLabels;
return $this;
}
/**
* Get the state of the use labels option
*
* @return bool The current state of the use labels option
*/
public function getUseLabels()
{
return $this->useLabels;
}
/**
* Turn on/off the option to only display nodes and edges with labels
*
* When this option is turned on, then only nodes (resources and literals)
* and edges (properties) will only be displayed if they have a label. You
* can use this option, to create concise, diagrams of your data, rather than
* the RDF.
*
* This option is turned off by default.
*
* @param bool $onlyLabelled A boolean value to enable/display only labelled items
*
* @return GraphViz
*/
public function setOnlyLabelled($onlyLabelled)
{
$this->onlyLabelled = $onlyLabelled;
return $this;
}
/**
* Get the state of the only Only Labelled option
*
* @return bool The current state of the Only Labelled option
*/
public function getOnlyLabelled()
{
return $this->onlyLabelled;
}
/**
* Set an attribute on the GraphViz graph
*
* Example:
* $serialiser->setAttribute('rotate', 90);
*
* See the GraphViz tool documentation for information about the
* available attributes.
*
* @param string $name The name of the attribute
* @param string $value The value for the attribute
*
* @return GraphViz
*/
public function setAttribute($name, $value)
{
$this->attributes[$name] = $value;
return $this;
}
/**
* Get an attribute of the GraphViz graph
*
* @param string $name Attribute name
*
* @return string The value of the graph attribute
*/
public function getAttribute($name)
{
return $this->attributes[$name];
}
/**
* Convert an EasyRdf object into a GraphViz node identifier
*
* @ignore
*/
protected function nodeName($entity)
{
if ($entity instanceof Resource) {
if ($entity->isBNode()) {
return "B".$entity->getUri();
} else {
return "R".$entity->getUri();
}
} else {
return "L".$entity;
}
}
/**
* Internal function to escape a string into DOT safe syntax
*
* @ignore
*/
protected function escape($input)
{
if (preg_match('/^([a-z_][a-z_0-9]*|-?(\.[0-9]+|[0-9]+(\.[0-9]*)?))$/i', $input)) {
return $input;
} else {
return '"'.str_replace(
array("\r\n", "\n", "\r", '"'),
array('\n', '\n', '\n', '\"'),
$input
).'"';
}
}
/**
* Internal function to escape an associate array of attributes and
* turns it into a DOT notation string
*
* @ignore
*/
protected function escapeAttributes($array)
{
$items = array();
foreach ($array as $k => $v) {
$items[] = $this->escape($k).'='.$this->escape($v);
}
return '['.implode(',', $items).']';
}
/**
* Internal function to create dot syntax line for either a node or an edge
*
* @ignore
*/
protected function serialiseRow($node1, $node2 = null, $attributes = array())
{
$result = ' '.$this->escape($node1);
if ($node2) {
$result .= ' -> '.$this->escape($node2);
}
if (count($attributes)) {
$result .= ' '.$this->escapeAttributes($attributes);
}
return $result.";\n";
}
/**
* Internal function to serialise an EasyRdf\Graph into a DOT formatted string
*
* @ignore
*/
protected function serialiseDot(Graph $graph)
{
$result = "digraph {\n";
// Write the graph attributes
foreach ($this->attributes as $k => $v) {
$result .= ' '.$this->escape($k).'='.$this->escape($v).";\n";
}
// Go through each of the properties and write the edges
$nodes = array();
$result .= "\n // Edges\n";
foreach ($graph->resources() as $resource) {
$name1 = $this->nodeName($resource);
foreach ($resource->propertyUris() as $property) {
$label = null;
if ($this->useLabels) {
$label = $graph->resource($property)->label();
}
if ($label === null) {
if ($this->onlyLabelled == true) {
continue;
} else {
$label = RdfNamespace::shorten($property);
}
}
foreach ($resource->all("<$property>") as $value) {
$name2 = $this->nodeName($value);
$nodes[$name1] = $resource;
$nodes[$name2] = $value;
$result .= $this->serialiseRow(
$name1,
$name2,
array('label' => $label)
);
}
}
}
ksort($nodes);
$result .= "\n // Nodes\n";
foreach ($nodes as $name => $node) {
$type = substr($name, 0, 1);
$label = '';
if ($type == 'R') {
if ($this->useLabels) {
$label = $node->label();
}
if (!$label) {
$label = $node->shorten();
}
if (!$label) {
$label = $node->getURI();
}
$result .= $this->serialiseRow(
$name,
null,
array(
'URL' => $node->getURI(),
'label' => $label,
'shape' => 'ellipse',
'color' => 'blue'
)
);
} elseif ($type == 'B') {
if ($this->useLabels) {
$label = $node->label();
}
$result .= $this->serialiseRow(
$name,
null,
array(
'label' => $label,
'shape' => 'circle',
'color' => 'green'
)
);
} else {
$result .= $this->serialiseRow(
$name,
null,
array(
'label' => strval($node),
'shape' => 'record',
)
);
}
}
$result .= "}\n";
return $result;
}
/**
* Internal function to render a graph into an image
*
* @ignore
*/
public function renderImage(Graph $graph, $format = 'png')
{
$dot = $this->serialiseDot($graph);
return Utils::execCommandPipe(
$this->dotCommand,
array("-T$format"),
$dot
);
}
/**
* Serialise an EasyRdf\Graph into a GraphViz dot document.
*
* Supported output format names: dot, gif, png, svg
*
* @param Graph $graph An EasyRdf\Graph object.
* @param string $format The name of the format to convert to.
* @param array $options
*
* @return string The RDF in the new desired format.
* @throws Exception
*/
public function serialise(Graph $graph, $format, array $options = array())
{
parent::checkSerialiseParams($format);
switch ($format) {
case 'dot':
return $this->serialiseDot($graph);
case 'png':
case 'gif':
case 'svg':
return $this->renderImage($graph, $format);
default:
throw new Exception(
"EasyRdf\\Serialiser\\GraphViz does not support: {$format}"
);
}
}
}
|