displayablegraph.class.inc.php 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357
  1. <?php
  2. // Copyright (C) 2015 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * Special kind of Graph for producing some nice output
  20. *
  21. * @copyright Copyright (C) 2015 Combodo SARL
  22. * @license http://opensource.org/licenses/AGPL-3.0
  23. */
  24. class DisplayableNode extends GraphNode
  25. {
  26. public $x;
  27. public $y;
  28. /**
  29. * Create a new node inside a graph
  30. * @param SimpleGraph $oGraph
  31. * @param string $sId The unique identifier of this node inside the graph
  32. * @param number $x Horizontal position
  33. * @param number $y Vertical position
  34. */
  35. public function __construct(SimpleGraph $oGraph, $sId, $x = 0, $y = 0)
  36. {
  37. parent::__construct($oGraph, $sId);
  38. $this->x = $x;
  39. $this->y = $y;
  40. $this->bFiltered = false;
  41. }
  42. public function GetIconURL()
  43. {
  44. return $this->GetProperty('icon_url', '');
  45. }
  46. public function GetLabel()
  47. {
  48. return $this->GetProperty('label', $this->sId);
  49. }
  50. public function GetWidth()
  51. {
  52. return max(32, 5*strlen($this->GetProperty('label'))); // approximation of the text's bounding box
  53. }
  54. public function GetHeight()
  55. {
  56. return 32;
  57. }
  58. public function Distance2(DisplayableNode $oNode)
  59. {
  60. $dx = $this->x - $oNode->x;
  61. $dy = $this->y - $oNode->y;
  62. $d2 = $dx*$dx + $dy*$dy - $this->GetHeight()*$this->GetHeight();
  63. if ($d2 < 40)
  64. {
  65. $d2 = 40;
  66. }
  67. return $d2;
  68. }
  69. public function Distance(DisplayableNode $oNode)
  70. {
  71. return sqrt($this->Distance2($oNode));
  72. }
  73. public function GetForRaphael($aContextDefs)
  74. {
  75. $aNode = array();
  76. $aNode['shape'] = 'icon';
  77. $aNode['icon_url'] = $this->GetIconURL();
  78. $aNode['width'] = 32;
  79. $aNode['source'] = ($this->GetProperty('source') == true);
  80. $aNode['obj_class'] = get_class($this->GetProperty('object'));
  81. $aNode['obj_key'] = $this->GetProperty('object')->GetKey();
  82. $aNode['sink'] = ($this->GetProperty('sink') == true);
  83. $aNode['x'] = $this->x;
  84. $aNode['y']= $this->y;
  85. $aNode['label'] = $this->GetLabel();
  86. $aNode['id'] = $this->GetId();
  87. $fOpacity = ($this->GetProperty('is_reached') ? 1 : 0.4);
  88. $aNode['icon_attr'] = array('opacity' => $fOpacity);
  89. $aNode['text_attr'] = array('opacity' => $fOpacity);
  90. $aNode['tooltip'] = $this->GetTooltip($aContextDefs);
  91. $aNode['context_icons'] = array();
  92. $aContextRootCauses = $this->GetProperty('context_root_causes');
  93. if (!is_null($aContextRootCauses))
  94. {
  95. foreach($aContextRootCauses as $key => $aObjects)
  96. {
  97. $aNode['context_icons'][] = utils::GetAbsoluteUrlModulesRoot().$aContextDefs[$key]['icon'];
  98. }
  99. }
  100. return $aNode;
  101. }
  102. public function RenderAsPDF(TCPDF $oPdf, DisplayableGraph $oGraph, $fScale, $aContextDefs)
  103. {
  104. $Alpha = 1.0;
  105. $oPdf->SetFillColor(200, 200, 200);
  106. $oPdf->setAlpha(1);
  107. $sIconUrl = $this->GetProperty('icon_url');
  108. $sIconPath = str_replace(utils::GetAbsoluteUrlModulesRoot(), APPROOT.'env-'.utils::GetCurrentEnvironment().'/', $sIconUrl);
  109. if ($this->GetProperty('source'))
  110. {
  111. $oPdf->SetLineStyle(array('width' => 2*$fScale, 'cap' => 'round', 'join' => 'miter', 'dash' => 0, 'color' => array(204, 51, 51)));
  112. $oPdf->Circle($this->x * $fScale, $this->y * $fScale, 16 * 1.25 * $fScale, 0, 360, 'D');
  113. }
  114. else if ($this->GetProperty('sink'))
  115. {
  116. $oPdf->SetLineStyle(array('width' => 2*$fScale, 'cap' => 'round', 'join' => 'miter', 'dash' => 0, 'color' => array(51, 51, 204)));
  117. $oPdf->Circle($this->x * $fScale, $this->y * $fScale, 16 * 1.25 * $fScale, 0, 360, 'D');
  118. }
  119. if (!$this->GetProperty('is_reached'))
  120. {
  121. $sTempImageName = $this->CreateWhiteIcon($oGraph, $sIconPath);
  122. if ($sTempImageName != null)
  123. {
  124. $oPdf->Image($sTempImageName, ($this->x - 16)*$fScale, ($this->y - 16)*$fScale, 32*$fScale, 32*$fScale, 'PNG');
  125. }
  126. $Alpha = 0.4;
  127. $oPdf->setAlpha($Alpha);
  128. }
  129. $oPdf->Image($sIconPath, ($this->x - 16)*$fScale, ($this->y - 16)*$fScale, 32*$fScale, 32*$fScale);
  130. $aContextRootCauses = $this->GetProperty('context_root_causes');
  131. if (!is_null($aContextRootCauses))
  132. {
  133. $idx = 0;
  134. foreach($aContextRootCauses as $key => $aObjects)
  135. {
  136. $sgn = 2*($idx %2) -1;
  137. $coef = floor((1+$idx)/2) * $sgn;
  138. $alpha = $coef*pi()/4 - pi()/2;
  139. $x = $this->x * $fScale + cos($alpha) * 16*1.25 * $fScale;
  140. $y = $this->y * $fScale + sin($alpha) * 16*1.25 * $fScale;
  141. $l = 32 * $fScale / 3;
  142. $sIconPath = APPROOT.'env-'.utils::GetCurrentEnvironment().'/'.$aContextDefs[$key]['icon'];
  143. $oPdf->Image($sIconPath, $x - $l/2, $y - $l/2, $l, $l);
  144. $idx++;
  145. }
  146. }
  147. $oPdf->SetFont('dejavusans', '', 24 * $fScale, '', true);
  148. $width = $oPdf->GetStringWidth($this->GetProperty('label'));
  149. $height = $oPdf->GetStringHeight(1000, $this->GetProperty('label'));
  150. $oPdf->setAlpha(0.6 * $Alpha);
  151. $oPdf->SetFillColor(255, 255, 255);
  152. $oPdf->SetDrawColor(255, 255, 255);
  153. $oPdf->Rect($this->x*$fScale - $width/2, ($this->y + 18)*$fScale, $width, $height, 'DF');
  154. $oPdf->setAlpha($Alpha);
  155. $oPdf->SetTextColor(0, 0, 0);
  156. $oPdf->Text($this->x*$fScale - $width/2, ($this->y + 18)*$fScale, $this->GetProperty('label'));
  157. }
  158. /**
  159. * Create a "whitened" version of the icon (retaining the transparency) to be used a background for masking the underlying lines
  160. * @param string $sIconFile The path to the file containing the icon
  161. * @return NULL|string The path to a temporary file containing the white version of the icon
  162. */
  163. protected function CreateWhiteIcon(DisplayableGraph $oGraph, $sIconFile)
  164. {
  165. $aInfo = getimagesize($sIconFile);
  166. $im = null;
  167. switch($aInfo['mime'])
  168. {
  169. case 'image/png':
  170. if (function_exists('imagecreatefrompng'))
  171. {
  172. $im = imagecreatefrompng($sIconFile);
  173. }
  174. break;
  175. case 'image/gif':
  176. if (function_exists('imagecreatefromgif'))
  177. {
  178. $im = imagecreatefromgif($sIconFile);
  179. }
  180. break;
  181. case 'image/jpeg':
  182. case 'image/jpg':
  183. if (function_exists('imagecreatefromjpeg'))
  184. {
  185. $im = imagecreatefromjpeg($sIconFile);
  186. }
  187. break;
  188. default:
  189. return null;
  190. }
  191. if($im && imagefilter($im, IMG_FILTER_COLORIZE, 255, 255, 255))
  192. {
  193. $sTempImageName = $oGraph->GetTempImageName();
  194. imagesavealpha($im, true);
  195. imagepng($im, $sTempImageName);
  196. imagedestroy($im);
  197. return $sTempImageName;
  198. }
  199. else
  200. {
  201. return null;
  202. }
  203. }
  204. /**
  205. * Group together (as a special kind of nodes) all the similar neighbours of the current node
  206. * @param DisplayableGraph $oGraph
  207. * @param int $iThresholdCount
  208. * @param boolean $bDirectionUp
  209. * @param boolean $bDirectionDown
  210. */
  211. public function GroupSimilarNeighbours(DisplayableGraph $oGraph, $iThresholdCount, $bDirectionUp = false, $bDirectionDown = true)
  212. {
  213. if ($this->GetProperty('grouped') === true) return;
  214. $this->SetProperty('grouped', true);
  215. if ($bDirectionDown)
  216. {
  217. $aNodesPerClass = array();
  218. foreach($this->GetOutgoingEdges() as $oEdge)
  219. {
  220. $oNode = $oEdge->GetSinkNode();
  221. if ($oNode->GetProperty('class') !== null)
  222. {
  223. $sClass = $oNode->GetProperty('class');
  224. if (($sClass!== null) && (!array_key_exists($sClass, $aNodesPerClass)))
  225. {
  226. $aNodesPerClass[$sClass] = array(
  227. 'reached' => array(
  228. 'count' => 0,
  229. 'nodes' => array(),
  230. 'icon_url' => $oNode->GetProperty('icon_url'),
  231. ),
  232. 'not_reached' => array(
  233. 'count' => 0,
  234. 'nodes' => array(),
  235. 'icon_url' => $oNode->GetProperty('icon_url'),
  236. )
  237. );
  238. }
  239. $sKey = $oNode->GetProperty('is_reached') ? 'reached' : 'not_reached';
  240. if (!array_key_exists($oNode->GetId(), $aNodesPerClass[$sClass][$sKey]['nodes']))
  241. {
  242. $aNodesPerClass[$sClass][$sKey]['nodes'][$oNode->GetId()] = $oNode;
  243. $aNodesPerClass[$sClass][$sKey]['count'] += (int)$oNode->GetProperty('count', 1);
  244. }
  245. }
  246. else
  247. {
  248. $oNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  249. }
  250. }
  251. foreach($aNodesPerClass as $sClass => $aDefs)
  252. {
  253. foreach($aDefs as $sStatus => $aGroupProps)
  254. {
  255. if (count($aGroupProps['nodes']) >= $iThresholdCount)
  256. {
  257. $sNewId = $this->GetId().'::'.(($sStatus == 'reached') ? '_reached': '');
  258. $oNewNode = $oGraph->GetNode($sNewId);
  259. if ($oNewNode == null)
  260. {
  261. $oNewNode = new DisplayableGroupNode($oGraph, $sNewId);
  262. $oNewNode->SetProperty('label', 'x'.$aGroupProps['count']);
  263. $oNewNode->SetProperty('icon_url', $aGroupProps['icon_url']);
  264. $oNewNode->SetProperty('class', $sClass);
  265. $oNewNode->SetProperty('is_reached', ($sStatus == 'reached'));
  266. $oNewNode->SetProperty('count', $aGroupProps['count']);
  267. }
  268. else
  269. {
  270. $oNewNode->SetProperty('count', $oNewNode->GetProperty('count')+$aGroupProps['count']);
  271. }
  272. try
  273. {
  274. $oIncomingEdge = new DisplayableEdge($oGraph, $this->GetId().'-'.$oNewNode->GetId(), $this, $oNewNode);
  275. }
  276. catch(Exception $e)
  277. {
  278. // Ignore this redundant egde
  279. }
  280. foreach($aGroupProps['nodes'] as $oNode)
  281. {
  282. foreach($oNode->GetIncomingEdges() as $oEdge)
  283. {
  284. if ($oEdge->GetSourceNode()->GetId() !== $this->GetId())
  285. {
  286. try
  287. {
  288. $oNewEdge = new DisplayableEdge($oGraph, $oEdge->GetId().'::'.$sClass, $oEdge->GetSourceNode(), $oNewNode);
  289. }
  290. catch(Exception $e)
  291. {
  292. // ignore this edge
  293. }
  294. }
  295. }
  296. foreach($oNode->GetOutgoingEdges() as $oEdge)
  297. {
  298. $aOutgoing[] = $oEdge->GetSinkNode();
  299. try
  300. {
  301. $oNewEdge = new DisplayableEdge($oGraph, $oEdge->GetId().'::'.$sClass, $oNewNode, $oEdge->GetSinkNode());
  302. }
  303. catch(Exception $e)
  304. {
  305. // ignore this edge
  306. }
  307. }
  308. if ($oGraph->GetNode($oNode->GetId()))
  309. {
  310. $oGraph->_RemoveNode($oNode);
  311. $oNewNode->AddObject($oNode->GetProperty('object'));
  312. }
  313. }
  314. $oNewNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  315. }
  316. else
  317. {
  318. foreach($aGroupProps['nodes'] as $oNode)
  319. {
  320. $oNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  321. }
  322. }
  323. }
  324. }
  325. }
  326. }
  327. public function GetTooltip($aContextDefs)
  328. {
  329. $sHtml = '';
  330. $oCurrObj = $this->GetProperty('object');
  331. $sSubClass = get_class($oCurrObj);
  332. $sHtml .= $oCurrObj->GetHyperlink()."<hr/>";
  333. $aContextRootCauses = $this->GetProperty('context_root_causes');
  334. if (!is_null($aContextRootCauses))
  335. {
  336. foreach($aContextRootCauses as $key => $aObjects)
  337. {
  338. $aContext = $aContextDefs[$key];
  339. $aRootCauses = array();
  340. foreach($aObjects as $oRootCause)
  341. {
  342. $aRootCauses[] = $oRootCause->GetHyperlink();
  343. }
  344. $sHtml .= '<p><img style="max-height: 24px; vertical-align:bottom;" src="'.utils::GetAbsoluteUrlModulesRoot().$aContext['icon'].'" title="'.htmlentities(Dict::S($aContext['dict'])).'">&nbsp;'.implode(', ', $aRootCauses).'</p>';
  345. }
  346. $sHtml .= '<hr/>';
  347. }
  348. $sHtml .= '<table><tbody>';
  349. foreach(MetaModel::GetZListItems($sSubClass, 'list') as $sAttCode)
  350. {
  351. $oAttDef = MetaModel::GetAttributeDef($sSubClass, $sAttCode);
  352. $sHtml .= '<tr><td>'.$oAttDef->GetLabel().':&nbsp;</td><td>'.$oCurrObj->GetAsHtml($sAttCode).'</td></tr>';
  353. }
  354. $sHtml .= '</tbody></table>';
  355. return $sHtml;
  356. }
  357. }
  358. class DisplayableRedundancyNode extends DisplayableNode
  359. {
  360. public function GetWidth()
  361. {
  362. return 24;
  363. }
  364. public function GetForRaphael($aContextDefs)
  365. {
  366. $aNode = array();
  367. $aNode['shape'] = 'disc';
  368. $aNode['icon_url'] = $this->GetIconURL();
  369. $aNode['source'] = ($this->GetProperty('source') == true);
  370. $aNode['width'] = $this->GetWidth();
  371. $aNode['x'] = $this->x;
  372. $aNode['y']= $this->y;
  373. $aNode['label'] = $this->GetLabel();
  374. $aNode['id'] = $this->GetId();
  375. $fDiscOpacity = ($this->GetProperty('is_reached') ? 1 : 0.2);
  376. $sColor = ($this->GetProperty('is_reached_count') > $this->GetProperty('threshold')) ? '#c33' : '#999';
  377. $aNode['disc_attr'] = array('stroke-width' => 3, 'stroke' => '#000', 'fill' => $sColor, 'opacity' => $fDiscOpacity);
  378. $fTextOpacity = ($this->GetProperty('is_reached') ? 1 : 0.4);
  379. $aNode['text_attr'] = array('fill' => '#fff', 'opacity' => $fTextOpacity);
  380. $aNode['tooltip'] = $this->GetTooltip($aContextDefs);
  381. return $aNode;
  382. }
  383. public function RenderAsPDF(TCPDF $oPdf, DisplayableGraph $oGraph, $fScale, $aContextDefs)
  384. {
  385. $oPdf->SetAlpha(1);
  386. if($this->GetProperty('is_reached_count') > $this->GetProperty('threshold'))
  387. {
  388. $oPdf->SetFillColor(200, 0, 0);
  389. }
  390. else
  391. {
  392. $oPdf->SetFillColor(144, 144, 144);
  393. }
  394. $oPdf->SetDrawColor(0, 0, 0);
  395. $oPdf->Circle($this->x*$fScale, $this->y*$fScale, 16*$fScale, 0, 360, 'DF');
  396. $oPdf->SetTextColor(255, 255, 255);
  397. $oPdf->SetFont('dejavusans', '', 28 * $fScale, '', true);
  398. $sLabel = (string)$this->GetProperty('label');
  399. $width = $oPdf->GetStringWidth($sLabel, 'dejavusans', 'B', 24*$fScale);
  400. $height = $oPdf->GetStringHeight(1000, $sLabel);
  401. $xPos = (float)$this->x*$fScale - $width/2;
  402. $yPos = (float)$this->y*$fScale - $height/2;
  403. $oPdf->SetXY(($this->x - 16)*$fScale, ($this->y - 16)*$fScale);
  404. $oPdf->Cell(32*$fScale, 32*$fScale, $sLabel, 0, 0, 'C', 0, '', 0, false, 'T', 'C');
  405. }
  406. /**
  407. * @see DisplayableNode::GroupSimilarNeighbours()
  408. */
  409. public function GroupSimilarNeighbours(DisplayableGraph $oGraph, $iThresholdCount, $bDirectionUp = false, $bDirectionDown = true)
  410. {
  411. parent::GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  412. if ($bDirectionUp)
  413. {
  414. $aNodesPerClass = array();
  415. foreach($this->GetIncomingEdges() as $oEdge)
  416. {
  417. $oNode = $oEdge->GetSourceNode();
  418. if (($oNode->GetProperty('class') !== null) && (!$oNode->GetProperty('is_reached')))
  419. {
  420. $sClass = $oNode->GetProperty('class');
  421. if (!array_key_exists($sClass, $aNodesPerClass))
  422. {
  423. $aNodesPerClass[$sClass] = array('reached' => array(), 'not_reached' => array());
  424. }
  425. $aNodesPerClass[$sClass][$oNode->GetProperty('is_reached') ? 'reached' : 'not_reached'][] = $oNode;
  426. }
  427. else
  428. {
  429. //$oNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  430. }
  431. }
  432. foreach($aNodesPerClass as $sClass => $aDefs)
  433. {
  434. foreach($aDefs as $sStatus => $aNodes)
  435. {
  436. if (count($aNodes) >= $iThresholdCount)
  437. {
  438. $oNewNode = new DisplayableGroupNode($oGraph, '-'.$this->GetId().'::'.$sClass.'/'.$sStatus);
  439. $oNewNode->SetProperty('label', 'x'.count($aNodes));
  440. $oNewNode->SetProperty('icon_url', $aNodes[0]->GetProperty('icon_url'));
  441. $oNewNode->SetProperty('is_reached', $aNodes[0]->GetProperty('is_reached'));
  442. $oOutgoingEdge = new DisplayableEdge($oGraph, '-'.$this->GetId().'-'.$oNewNode->GetId().'/'.$sStatus, $oNewNode, $this);
  443. foreach($aNodes as $oNode)
  444. {
  445. foreach($oNode->GetIncomingEdges() as $oEdge)
  446. {
  447. $oNewEdge = new DisplayableEdge($oGraph, '-'.$oEdge->GetId().'::'.$sClass, $oEdge->GetSourceNode(), $oNewNode);
  448. }
  449. foreach($oNode->GetOutgoingEdges() as $oEdge)
  450. {
  451. if ($oEdge->GetSinkNode()->GetId() !== $this->GetId())
  452. {
  453. $aOutgoing[] = $oEdge->GetSinkNode();
  454. $oNewEdge = new DisplayableEdge($oGraph, '-'.$oEdge->GetId().'::'.$sClass.'/'.$sStatus, $oNewNode, $oEdge->GetSinkNode());
  455. }
  456. }
  457. $oGraph->_RemoveNode($oNode);
  458. $oNewNode->AddObject($oNode->GetProperty('object'));
  459. }
  460. //$oNewNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  461. }
  462. else
  463. {
  464. foreach($aNodes as $oNode)
  465. {
  466. //$oNode->GroupSimilarNeighbours($oGraph, $iThresholdCount, $bDirectionUp, $bDirectionDown);
  467. }
  468. }
  469. }
  470. }
  471. }
  472. }
  473. public function GetTooltip($aContextDefs)
  474. {
  475. $sHtml = '';
  476. $sHtml .= Dict::S('UI:RelationTooltip:Redundancy')."<hr>";
  477. $sHtml .= '<table><tbody>';
  478. $sHtml .= "<tr><td>".Dict::Format('UI:RelationTooltip:ImpactedItems_N_of_M' , $this->GetProperty('is_reached_count'), $this->GetProperty('min_up') + $this->GetProperty('threshold'))."</td></tr>";
  479. $sHtml .= "<tr><td>".Dict::Format('UI:RelationTooltip:CriticalThreshold_N_of_M' , $this->GetProperty('threshold'), $this->GetProperty('min_up') + $this->GetProperty('threshold'))."</td></tr>";
  480. $sHtml .= '</tbody></table>';
  481. return $sHtml;
  482. }
  483. }
  484. class DisplayableEdge extends GraphEdge
  485. {
  486. public function RenderAsPDF(TCPDF $oPdf, DisplayableGraph $oGraph, $fScale, $aContextDefs)
  487. {
  488. $xStart = $this->GetSourceNode()->x * $fScale;
  489. $yStart = $this->GetSourceNode()->y * $fScale;
  490. $xEnd = $this->GetSinkNode()->x * $fScale;
  491. $yEnd = $this->GetSinkNode()->y * $fScale;
  492. $bReached = ($this->GetSourceNode()->GetProperty('is_reached') && $this->GetSinkNode()->GetProperty('is_reached'));
  493. $oPdf->setAlpha(1);
  494. if ($bReached)
  495. {
  496. $aColor = array(100, 100, 100);
  497. }
  498. else
  499. {
  500. $aColor = array(200, 200, 200);
  501. }
  502. $oPdf->SetLineStyle(array('width' => 2*$fScale, 'cap' => 'round', 'join' => 'miter', 'dash' => 0, 'color' => $aColor));
  503. $oPdf->Line($xStart, $yStart, $xEnd, $yEnd);
  504. $vx = $xEnd - $xStart;
  505. $vy = $yEnd - $yStart;
  506. $l = sqrt($vx*$vx + $vy*$vy);
  507. $vx = $vx / $l;
  508. $vy = $vy / $l;
  509. $ux = -$vy;
  510. $uy = $vx;
  511. $lPos = max($l/2, $l - 40*$fScale);
  512. $iArrowSize = 5*$fScale;
  513. $x = $xStart + $lPos * $vx;
  514. $y = $yStart + $lPos * $vy;
  515. $oPdf->Line($x, $y, $x + $iArrowSize * ($ux-$vx), $y + $iArrowSize * ($uy-$vy));
  516. $oPdf->Line($x, $y, $x - $iArrowSize * ($ux+$vx), $y - $iArrowSize * ($uy+$vy));
  517. }
  518. }
  519. class DisplayableGroupNode extends DisplayableNode
  520. {
  521. protected $aObjects;
  522. public function __construct(SimpleGraph $oGraph, $sId, $x = 0, $y = 0)
  523. {
  524. parent::__construct($oGraph, $sId, $x, $y);
  525. $this->aObjects = array();
  526. }
  527. public function AddObject(DBObject $oObj)
  528. {
  529. $this->aObjects[$oObj->GetKey()] = $oObj;
  530. }
  531. public function GetObjects()
  532. {
  533. return $this->aObjects;
  534. }
  535. public function GetWidth()
  536. {
  537. return 50;
  538. }
  539. public function GetForRaphael($aContextDefs)
  540. {
  541. $aNode = array();
  542. $aNode['shape'] = 'group';
  543. $aNode['icon_url'] = $this->GetIconURL();
  544. $aNode['source'] = ($this->GetProperty('source') == true);
  545. $aNode['width'] = $this->GetWidth();
  546. $aNode['x'] = $this->x;
  547. $aNode['y']= $this->y;
  548. $aNode['label'] = $this->GetLabel();
  549. $aNode['id'] = $this->GetId();
  550. $aNode['group_index'] = $this->GetProperty('group_index'); // if supplied
  551. $fDiscOpacity = ($this->GetProperty('is_reached') ? 1 : 0.2);
  552. $fTextOpacity = ($this->GetProperty('is_reached') ? 1 : 0.4);
  553. $aNode['icon_attr'] = array('opacity' => $fTextOpacity);
  554. $aNode['disc_attr'] = array('stroke-width' => 3, 'stroke' => '#000', 'fill' => '#fff', 'opacity' => $fDiscOpacity);
  555. $aNode['text_attr'] = array('fill' => '#000', 'opacity' => $fTextOpacity);
  556. $aNode['tooltip'] = $this->GetTooltip($aContextDefs);
  557. return $aNode;
  558. }
  559. public function RenderAsPDF(TCPDF $oPdf, DisplayableGraph $oGraph, $fScale, $aContextDefs)
  560. {
  561. $bReached = $this->GetProperty('is_reached');
  562. $oPdf->SetFillColor(255, 255, 255);
  563. if ($bReached)
  564. {
  565. $aBorderColor = array(100, 100, 100);
  566. }
  567. else
  568. {
  569. $aBorderColor = array(200, 200, 200);
  570. }
  571. $oPdf->SetLineStyle(array('width' => 2*$fScale, 'cap' => 'round', 'join' => 'miter', 'dash' => 0, 'color' => $aBorderColor));
  572. $sIconUrl = $this->GetProperty('icon_url');
  573. $sIconPath = str_replace(utils::GetAbsoluteUrlModulesRoot(), APPROOT.'env-'.utils::GetCurrentEnvironment().'/', $sIconUrl);
  574. $oPdf->SetAlpha(1);
  575. $oPdf->Circle($this->x*$fScale, $this->y*$fScale, $this->GetWidth() / 2 * $fScale, 0, 360, 'DF');
  576. if ($bReached)
  577. {
  578. $oPdf->SetAlpha(1);
  579. }
  580. else
  581. {
  582. $oPdf->SetAlpha(0.4);
  583. }
  584. $oPdf->Image($sIconPath, ($this->x - 17)*$fScale, ($this->y - 17)*$fScale, 16*$fScale, 16*$fScale);
  585. $oPdf->Image($sIconPath, ($this->x + 1)*$fScale, ($this->y - 17)*$fScale, 16*$fScale, 16*$fScale);
  586. $oPdf->Image($sIconPath, ($this->x -8)*$fScale, ($this->y +1)*$fScale, 16*$fScale, 16*$fScale);
  587. $oPdf->SetFont('dejavusans', '', 24 * $fScale, '', true);
  588. $width = $oPdf->GetStringWidth($this->GetProperty('label'));
  589. $oPdf->SetTextColor(0, 0, 0);
  590. $oPdf->Text($this->x*$fScale - $width/2, ($this->y + 25)*$fScale, $this->GetProperty('label'));
  591. }
  592. public function GetTooltip($aContextDefs)
  593. {
  594. $sHtml = '';
  595. $iGroupIdx = $this->GetProperty('group_index');
  596. $sHtml .= Dict::Format('UI:RelationGroupNumber_N', (1+$iGroupIdx));
  597. return $sHtml;
  598. }
  599. }
  600. /**
  601. * A Graph that can be displayed interactively using Raphael JS or saved as a PDF document
  602. */
  603. class DisplayableGraph extends SimpleGraph
  604. {
  605. protected $bDirectionDown;
  606. protected $aTempImages;
  607. protected $aSourceObjects;
  608. protected $aSinkObjects;
  609. public function __construct()
  610. {
  611. parent::__construct();
  612. $this->aTempImages = array();
  613. $this->aSourceObjects = array();
  614. $this->aSinkObjects = array();
  615. }
  616. public function GetTempImageName()
  617. {
  618. $sNewTempName = tempnam(APPROOT.'data', 'img-');
  619. $this->aTempImages[] = $sNewTempName;
  620. return $sNewTempName;
  621. }
  622. public function __destruct()
  623. {
  624. foreach($this->aTempImages as $sTempFile)
  625. {
  626. @unlink($sTempFile);
  627. }
  628. }
  629. /**
  630. * Build a DisplayableGraph from a RelationGraph
  631. * @param RelationGraph $oGraph
  632. * @param number $iGroupingThreshold
  633. * @param string $bDirectionDown
  634. * @return DisplayableGraph
  635. */
  636. public static function FromRelationGraph(RelationGraph $oGraph, $iGroupingThreshold = 20, $bDirectionDown = true)
  637. {
  638. $oNewGraph = new DisplayableGraph();
  639. $oNewGraph->bDirectionDown = $bDirectionDown;
  640. $iPreviousTimeLimit = ini_get('max_execution_time');
  641. $iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
  642. $oNodesIter = new RelationTypeIterator($oGraph, 'Node');
  643. foreach($oNodesIter as $oNode)
  644. {
  645. set_time_limit($iLoopTimeLimit);
  646. switch(get_class($oNode))
  647. {
  648. case 'RelationObjectNode':
  649. $oNewNode = new DisplayableNode($oNewGraph, $oNode->GetId(), 0, 0);
  650. $oObj = $oNode->GetProperty('object');
  651. $sClass = get_class($oObj);
  652. if ($oNode->GetProperty('source'))
  653. {
  654. if (!array_key_exists($sClass, $oNewGraph->aSourceObjects))
  655. {
  656. $oNewGraph->aSourceObjects[$sClass] = array();
  657. }
  658. $oNewGraph->aSourceObjects[$sClass][] = $oObj->GetKey();
  659. $oNewNode->SetProperty('source', true);
  660. }
  661. if ($oNode->GetProperty('sink'))
  662. {
  663. if (!array_key_exists($sClass, $oNewGraph->aSinkObjects))
  664. {
  665. $oNewGraph->aSinkObjects[$sClass] = array();
  666. }
  667. $oNewGraph->aSinkObjects[$sClass][] = $oObj->GetKey();
  668. $oNewNode->SetProperty('sink', true);
  669. }
  670. $oNewNode->SetProperty('class', $sClass);
  671. $oNewNode->SetProperty('object', $oObj);
  672. $oNewNode->SetProperty('icon_url', $oObj->GetIcon(false));
  673. $oNewNode->SetProperty('label', $oObj->GetRawName());
  674. $oNewNode->SetProperty('is_reached', $bDirectionDown ? $oNode->GetProperty('is_reached') : true); // When going "up" is_reached does not matter
  675. $oNewNode->SetProperty('is_reached_allowed', $oNode->GetProperty('is_reached_allowed'));
  676. $oNewNode->SetProperty('context_root_causes', $oNode->GetProperty('context_root_causes'));
  677. break;
  678. default:
  679. $oNewNode = new DisplayableRedundancyNode($oNewGraph, $oNode->GetId(), 0, 0);
  680. $iNbReached = (is_null($oNode->GetProperty('is_reached_count'))) ? 0 : $oNode->GetProperty('is_reached_count');
  681. $oNewNode->SetProperty('label', $iNbReached."/".($oNode->GetProperty('min_up') + $oNode->GetProperty('threshold')));
  682. $oNewNode->SetProperty('min_up', $oNode->GetProperty('min_up'));
  683. $oNewNode->SetProperty('threshold', $oNode->GetProperty('threshold'));
  684. $oNewNode->SetProperty('is_reached_count', $iNbReached);
  685. $oNewNode->SetProperty('is_reached', true);
  686. }
  687. }
  688. $oEdgesIter = new RelationTypeIterator($oGraph, 'Edge');
  689. foreach($oEdgesIter as $oEdge)
  690. {
  691. set_time_limit($iLoopTimeLimit);
  692. $oSourceNode = $oNewGraph->GetNode($oEdge->GetSourceNode()->GetId());
  693. $oSinkNode = $oNewGraph->GetNode($oEdge->GetSinkNode()->GetId());
  694. $oNewEdge = new DisplayableEdge($oNewGraph, $oEdge->GetId(), $oSourceNode, $oSinkNode);
  695. }
  696. // Remove duplicate edges between two nodes
  697. $oEdgesIter = new RelationTypeIterator($oNewGraph, 'Edge');
  698. $aEdgeKeys = array();
  699. foreach($oEdgesIter as $oEdge)
  700. {
  701. set_time_limit($iLoopTimeLimit);
  702. $sSourceId = $oEdge->GetSourceNode()->GetId();
  703. $sSinkId = $oEdge->GetSinkNode()->GetId();
  704. if ($sSourceId == $sSinkId)
  705. {
  706. // Remove self referring edges
  707. $oNewGraph->_RemoveEdge($oEdge);
  708. }
  709. else
  710. {
  711. $sKey = $sSourceId.'//'.$sSinkId;
  712. if (array_key_exists($sKey, $aEdgeKeys))
  713. {
  714. // Remove duplicate edges
  715. $oNewGraph->_RemoveEdge($oEdge);
  716. }
  717. else
  718. {
  719. $aEdgeKeys[$sKey] = true;
  720. }
  721. }
  722. }
  723. $oNodesIter = new RelationTypeIterator($oNewGraph, 'Node');
  724. foreach($oNodesIter as $oNode)
  725. {
  726. set_time_limit($iLoopTimeLimit);
  727. if ($oNode->GetProperty('source'))
  728. {
  729. $oNode->GroupSimilarNeighbours($oNewGraph, $iGroupingThreshold, true, true);
  730. }
  731. }
  732. // Groups numbering
  733. $oIterator = new RelationTypeIterator($oNewGraph, 'Node');
  734. $iGroupIdx = 0;
  735. foreach($oIterator as $oNode)
  736. {
  737. set_time_limit($iLoopTimeLimit);
  738. if ($oNode instanceof DisplayableGroupNode)
  739. {
  740. $aGroups[] = $oNode->GetObjects();
  741. $oNode->SetProperty('group_index', $iGroupIdx);
  742. $iGroupIdx++;
  743. }
  744. }
  745. // Remove duplicate edges between two nodes
  746. $oEdgesIter = new RelationTypeIterator($oNewGraph, 'Edge');
  747. $aEdgeKeys = array();
  748. foreach($oEdgesIter as $oEdge)
  749. {
  750. set_time_limit($iLoopTimeLimit);
  751. $sSourceId = $oEdge->GetSourceNode()->GetId();
  752. $sSinkId = $oEdge->GetSinkNode()->GetId();
  753. if ($sSourceId == $sSinkId)
  754. {
  755. // Remove self referring edges
  756. $oNewGraph->_RemoveEdge($oEdge);
  757. }
  758. else
  759. {
  760. $sKey = $sSourceId.'//'.$sSinkId;
  761. if (array_key_exists($sKey, $aEdgeKeys))
  762. {
  763. // Remove duplicate edges
  764. $oNewGraph->_RemoveEdge($oEdge);
  765. }
  766. else
  767. {
  768. $aEdgeKeys[$sKey] = true;
  769. }
  770. }
  771. }
  772. set_time_limit($iPreviousTimeLimit);
  773. return $oNewGraph;
  774. }
  775. /**
  776. * Initializes the positions by rendering using Graphviz in xdot format
  777. * and parsing the output.
  778. * @throws Exception
  779. */
  780. public function InitFromGraphviz()
  781. {
  782. $sDot = $this->DumpAsXDot();
  783. if (strpos($sDot, 'digraph') === false)
  784. {
  785. throw new Exception($sDot);
  786. }
  787. $aChunks = explode(";", $sDot);
  788. foreach($aChunks as $sChunk)
  789. {
  790. if(preg_match('/"([^"]+)".+pos="([0-9\\.]+),([0-9\\.]+)"/ms', $sChunk, $aMatches))
  791. {
  792. $sId = $aMatches[1];
  793. $xPos = $aMatches[2];
  794. $yPos = $aMatches[3];
  795. $oNode = $this->GetNode($sId);
  796. $oNode->x = (float)$xPos;
  797. $oNode->y = (float)$yPos;
  798. }
  799. }
  800. }
  801. public function GetBoundingBox()
  802. {
  803. $xMin = null;
  804. $xMax = null;
  805. $yMin = null;
  806. $yMax = null;
  807. $oIterator = new RelationTypeIterator($this, 'Node');
  808. foreach($oIterator as $sId => $oNode)
  809. {
  810. if ($xMin === null) // First element in the loop
  811. {
  812. $xMin = $oNode->x - $oNode->GetWidth();
  813. $xMax = $oNode->x + $oNode->GetWidth();
  814. $yMin = $oNode->y - $oNode->GetHeight();
  815. $yMax = $oNode->y + $oNode->GetHeight();
  816. }
  817. else
  818. {
  819. $xMin = min($xMin, $oNode->x - $oNode->GetWidth() / 2);
  820. $xMax = max($xMax, $oNode->x + $oNode->GetWidth() / 2);
  821. $yMin = min($yMin, $oNode->y - $oNode->GetHeight() / 2);
  822. $yMax = max($yMax, $oNode->y + $oNode->GetHeight() / 2);
  823. }
  824. }
  825. return array('xmin' => $xMin, 'xmax' => $xMax, 'ymin' => $yMin, 'ymax' => $yMax);
  826. }
  827. function Translate($dx, $dy)
  828. {
  829. $oIterator = new RelationTypeIterator($this, 'Node');
  830. foreach($oIterator as $sId => $oNode)
  831. {
  832. $oNode->x += $dx;
  833. $oNode->y += $dy;
  834. }
  835. }
  836. public function UpdatePositions($aPositions)
  837. {
  838. foreach($aPositions as $sNodeId => $aPos)
  839. {
  840. $oNode = $this->GetNode($sNodeId);
  841. if ($oNode != null)
  842. {
  843. $oNode->x = $aPos['x'];
  844. $oNode->y = $aPos['y'];
  845. }
  846. }
  847. }
  848. /**
  849. * Renders as JSON string suitable for loading into the simple_graph widget
  850. */
  851. function GetAsJSON($sContextKey)
  852. {
  853. $aContextDefs = $this->GetContextDefinitions($sContextKey, false);
  854. $aData = array('nodes' => array(), 'edges' => array());
  855. $iGroupIdx = 0;
  856. $oIterator = new RelationTypeIterator($this, 'Node');
  857. foreach($oIterator as $sId => $oNode)
  858. {
  859. if ($oNode instanceof DisplayableGroupNode)
  860. {
  861. $aGroups[] = $oNode->GetObjects();
  862. $oNode->SetProperty('group_index', $iGroupIdx);
  863. $iGroupIdx++;
  864. }
  865. $aData['nodes'][] = $oNode->GetForRaphael($aContextDefs);
  866. }
  867. $oIterator = new RelationTypeIterator($this, 'Edge');
  868. foreach($oIterator as $sId => $oEdge)
  869. {
  870. $aEdge = array();
  871. $aEdge['id'] = $oEdge->GetId();
  872. $aEdge['source_node_id'] = $oEdge->GetSourceNode()->GetId();
  873. $aEdge['sink_node_id'] = $oEdge->GetSinkNode()->GetId();
  874. $fOpacity = ($oEdge->GetSinkNode()->GetProperty('is_reached') && $oEdge->GetSourceNode()->GetProperty('is_reached') ? 1 : 0.2);
  875. $aEdge['attr'] = array('opacity' => $fOpacity, 'stroke' => '#000');
  876. $aData['edges'][] = $aEdge;
  877. }
  878. return json_encode($aData);
  879. }
  880. /**
  881. * Renders the graph in a PDF document: centered in the current page
  882. * @param PDFPage $oPage The PDFPage representing the PDF document to draw into
  883. * @param string $sComments An optional comment to display next to the graph (HTML entities will be escaped, \n replaced by <br/>)
  884. * @param string $sContextKey The key to fetch the queries in the configuration. Example: itop-tickets/relation_context/UserRequest/impacts/down
  885. * @param float $xMin Left coordinate of the bounding box to display the graph
  886. * @param float $xMax Right coordinate of the bounding box to display the graph
  887. * @param float $yMin Top coordinate of the bounding box to display the graph
  888. * @param float $yMax Bottom coordinate of the bounding box to display the graph
  889. */
  890. function RenderAsPDF(PDFPage $oPage, $sComments = '', $sContextKey, $xMin = -1, $xMax = -1, $yMin = -1, $yMax = -1)
  891. {
  892. $aContextDefs = $this->GetContextDefinitions($sContextKey, false); // No need to develop the parameters
  893. $oPdf = $oPage->get_tcpdf();
  894. $aBB = $this->GetBoundingBox();
  895. $this->Translate(-$aBB['xmin'], -$aBB['ymin']);
  896. $aMargins = $oPdf->getMargins();
  897. if ($xMin == -1)
  898. {
  899. $xMin = $aMargins['left'];
  900. }
  901. if ($xMax == -1)
  902. {
  903. $xMax = $oPdf->getPageWidth() - $aMargins['right'];
  904. }
  905. if ($yMin == -1)
  906. {
  907. $yMin = $aMargins['top'];
  908. }
  909. if ($yMax == -1)
  910. {
  911. $yMax = $oPdf->getPageHeight() - $aMargins['bottom'];
  912. }
  913. $fBreakMargin = $oPdf->getBreakMargin();
  914. $oPdf->SetAutoPageBreak(false);
  915. $aRemainingArea = $this->RenderKey($oPdf, $sComments, $xMin, $yMin, $xMax, $yMax, $aContextDefs);
  916. $xMin = $aRemainingArea['xmin'];
  917. $xMax = $aRemainingArea['xmax'];
  918. $yMin = $aRemainingArea['ymin'];
  919. $yMax = $aRemainingArea['ymax'];
  920. //$oPdf->Rect($xMin, $yMin, $xMax - $xMin, $yMax - $yMin, 'D', array(), array(225, 50, 50));
  921. $fPageW = $xMax - $xMin;
  922. $fPageH = $yMax - $yMin;
  923. $w = $aBB['xmax'] - $aBB['xmin'];
  924. $h = $aBB['ymax'] - $aBB['ymin'] + 10; // Extra space for the labels which may appear "below" the icons
  925. $fScale = min($fPageW / $w, $fPageH / $h);
  926. $dx = ($fPageW - $fScale * $w) / 2;
  927. $dy = ($fPageH - $fScale * $h) / 2;
  928. $this->Translate(($xMin + $dx)/$fScale, ($yMin + $dy)/$fScale);
  929. $oIterator = new RelationTypeIterator($this, 'Edge');
  930. $iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
  931. foreach($oIterator as $sId => $oEdge)
  932. {
  933. set_time_limit($iLoopTimeLimit);
  934. $oEdge->RenderAsPDF($oPdf, $this, $fScale, $aContextDefs);
  935. }
  936. $oIterator = new RelationTypeIterator($this, 'Node');
  937. foreach($oIterator as $sId => $oNode)
  938. {
  939. set_time_limit($iLoopTimeLimit);
  940. $oNode->RenderAsPDF($oPdf, $this, $fScale, $aContextDefs);
  941. }
  942. $oIterator = new RelationTypeIterator($this, 'Node');
  943. $oPdf->SetAutoPageBreak(true, $fBreakMargin);
  944. $oPdf->SetAlpha(1);
  945. }
  946. /**
  947. * Renders (in PDF) the key (legend) of the graphics vertically to the left of the specified zone (xmin,ymin, xmax,ymax),
  948. * and the comment (if any) at the bottom of the page. Returns the position of remaining area.
  949. * @param TCPDF $oPdf
  950. * @param string $sComments
  951. * @param float $xMin
  952. * @param float $yMin
  953. * @param float $xMax
  954. * @param float $yMax
  955. * @param hash $aContextDefs
  956. * @return hash An array ('xmin' => , 'xmax' => ,'ymin' => , 'ymax' => ) of the remaining available area to paint the graph
  957. */
  958. protected function RenderKey(TCPDF $oPdf, $sComments, $xMin, $yMin, $xMax, $yMax, $aContextDefs)
  959. {
  960. $fFontSize = 7; // in mm
  961. $fIconSize = 6; // in mm
  962. $fPadding = 1; // in mm
  963. $oIterator = new RelationTypeIterator($this, 'Node');
  964. $fMaxWidth = max($oPdf->GetStringWidth(Dict::S('UI:Relation:Key')) - $fIconSize, $oPdf->GetStringWidth(Dict::S('UI:Relation:Comments')) - $fIconSize);
  965. $aClasses = array();
  966. $aIcons = array();
  967. $aContexts = array();
  968. $aContextIcons = array();
  969. $oPdf->SetFont('dejavusans', '', $fFontSize, '', true);
  970. foreach($oIterator as $sId => $oNode)
  971. {
  972. if ($sClass = $oNode->GetProperty('class'))
  973. {
  974. if (!array_key_exists($sClass, $aClasses))
  975. {
  976. $sClassLabel = MetaModel::GetName($sClass);
  977. $width = $oPdf->GetStringWidth($sClassLabel);
  978. $fMaxWidth = max($width, $fMaxWidth);
  979. $aClasses[$sClass] = $sClassLabel;
  980. $sIconUrl = $oNode->GetProperty('icon_url');
  981. $sIconPath = str_replace(utils::GetAbsoluteUrlModulesRoot(), APPROOT.'env-'.utils::GetCurrentEnvironment().'/', $sIconUrl);
  982. $aIcons[$sClass] = $sIconPath;
  983. }
  984. }
  985. $aContextRootCauses = $oNode->GetProperty('context_root_causes');
  986. if (!is_null($aContextRootCauses))
  987. {
  988. foreach($aContextRootCauses as $key => $aObjects)
  989. {
  990. $aContexts[$key] = Dict::S($aContextDefs[$key]['dict']);
  991. $aContextIcons[$key] = APPROOT.'env-'.utils::GetCurrentEnvironment().'/'.$aContextDefs[$key]['icon'];
  992. }
  993. }
  994. }
  995. $oPdf->SetXY($xMin + $fPadding, $yMin + $fPadding);
  996. $yPos = $yMin + $fPadding;
  997. $oPdf->SetFillColor(225, 225, 225);
  998. $oPdf->Cell($fIconSize + $fPadding + $fMaxWidth, $fIconSize + $fPadding, Dict::S('UI:Relation:Key'), 0 /* border */, 1 /* ln */, 'C', true /* fill */);
  999. $yPos += $fIconSize + 2*$fPadding;
  1000. foreach($aClasses as $sClass => $sLabel)
  1001. {
  1002. $oPdf->SetX($xMin + $fIconSize + $fPadding);
  1003. $oPdf->Cell(0, $fIconSize + 2*$fPadding, $sLabel, 0 /* border */, 1 /* ln */);
  1004. $oPdf->Image($aIcons[$sClass], $xMin+1, $yPos, $fIconSize, $fIconSize);
  1005. $yPos += $fIconSize + 2*$fPadding;
  1006. }
  1007. foreach($aContexts as $key => $sLabel)
  1008. {
  1009. $oPdf->SetX($xMin + $fIconSize + $fPadding);
  1010. $oPdf->Cell(0, $fIconSize + 2*$fPadding, $sLabel, 0 /* border */, 1 /* ln */);
  1011. $oPdf->Image($aContextIcons[$key], $xMin+1+$fIconSize*0.125, $yPos+$fIconSize*0.125, $fIconSize*0.75, $fIconSize*0.75);
  1012. $yPos += $fIconSize + 2*$fPadding;
  1013. }
  1014. $oPdf->Rect($xMin, $yMin, $fMaxWidth + $fIconSize + 3*$fPadding, $yMax - $yMin, 'D');
  1015. if ($sComments != '')
  1016. {
  1017. // Draw the comment text (surrounded by a rectangle)
  1018. $xPos = $xMin + $fMaxWidth + $fIconSize + 4*$fPadding;
  1019. $w = $xMax - $xPos - 2*$fPadding;
  1020. $iNbLines = 1;
  1021. $sText = '<p>'.str_replace("\n", '<br/>', htmlentities($sComments, ENT_QUOTES, 'UTF-8'), $iNbLines).'</p>';
  1022. $fLineHeight = $oPdf->getStringHeight($w, $sText);
  1023. $h = (1+$iNbLines) * $fLineHeight;
  1024. $yPos = $yMax - 2*$fPadding - $h;
  1025. $oPdf->writeHTMLCell($w, $h, $xPos + $fPadding, $yPos + $fPadding, $sText, 0 /* border */, 1 /* ln */);
  1026. $oPdf->Rect($xPos, $yPos, $w + 2*$fPadding, $h + 2*$fPadding, 'D');
  1027. $yMax = $yPos - $fPadding;
  1028. }
  1029. return array('xmin' => $xMin + $fMaxWidth + $fIconSize + 4*$fPadding, 'xmax' => $xMax, 'ymin' => $yMin, 'ymax' => $yMax);
  1030. }
  1031. /**
  1032. * Get the context definitions from the parameters / configuration. The format of the "key" string is:
  1033. * <module>/relation_context/<class>/<relation>/<direction>
  1034. * The values will be retrieved for the given class and all its parents and merged together as a single array.
  1035. * Entries with an invalid query are removed from the list.
  1036. * @param string $sContextKey The key to fetch the queries in the configuration. Example: itop-tickets/relation_context/UserRequest/impacts/down
  1037. * @param bool $bDevelopParams Whether or not to substitute the parameters inside the queries with the supplied "context params"
  1038. * @param array $aContextParams Arguments for the queries (via ToArgs()) if $bDevelopParams == true
  1039. * @return multitype:multitype:string
  1040. */
  1041. public function GetContextDefinitions($sContextKey, $bDevelopParams = true, $aContextParams = array())
  1042. {
  1043. $aLevels = explode('/', $sContextKey);
  1044. $sLeafClass = $aLevels[2];
  1045. $aRelationContext = MetaModel::GetConfig()->GetModuleSetting($aLevels[0], $aLevels[1], array());
  1046. $aContextDefs = array();
  1047. foreach(MetaModel::EnumParentClasses($sLeafClass, ENUM_PARENT_CLASSES_ALL) as $sClass)
  1048. {
  1049. if (isset($aRelationContext[$sClass][$aLevels[3]][$aLevels[4]]['items']))
  1050. {
  1051. $aContextDefs = array_merge($aContextDefs, $aRelationContext[$sClass][$aLevels[3]][$aLevels[4]]['items']);
  1052. }
  1053. }
  1054. // Check if the queries are valid
  1055. foreach($aContextDefs as $sKey => $sDefs)
  1056. {
  1057. $sOQL = $aContextDefs[$sKey]['oql'];
  1058. try
  1059. {
  1060. // Expand the parameters. If anything goes wrong, then the query is considered as invalid and removed from the list
  1061. $oSearch = DBObjectSearch::FromOQL($sOQL);
  1062. $aContextDefs[$sKey]['oql'] = $oSearch->ToOQL($bDevelopParams, $aContextParams);
  1063. }
  1064. catch(Exception $e)
  1065. {
  1066. unset($aContextDefs[$sKey]);
  1067. }
  1068. }
  1069. return $aContextDefs;
  1070. }
  1071. /**
  1072. * Display the graph inside the given page, with the "filter" drawer above it
  1073. * @param WebPage $oP
  1074. * @param hash $aResults
  1075. * @param string $sRelation
  1076. * @param ApplicationContext $oAppContext
  1077. * @param array $aExcludedObjects
  1078. */
  1079. function Display(WebPage $oP, $aResults, $sRelation, ApplicationContext $oAppContext, $aExcludedObjects = array(), $sObjClass = null, $iObjKey = null, $sContextKey, $aContextParams = array())
  1080. {
  1081. $aContextDefs = $this->GetContextDefinitions($sContextKey, true, $aContextParams);
  1082. $aExcludedByClass = array();
  1083. foreach($aExcludedObjects as $oObj)
  1084. {
  1085. if (!array_key_exists(get_class($oObj), $aExcludedByClass))
  1086. {
  1087. $aExcludedByClass[get_class($oObj)] = array();
  1088. }
  1089. $aExcludedByClass[get_class($oObj)][] = $oObj->GetKey();
  1090. }
  1091. $oP->add("<div class=\"not-printable\">\n");
  1092. $oP->add("<div id=\"ds_flash\" class=\"SearchDrawer\" style=\"display:none;\">\n");
  1093. $oP->add_ready_script(
  1094. <<<EOF
  1095. $( "#tabbedContent_0" ).tabs({ heightStyle: "fill" });
  1096. $("#dh_flash").click( function() {
  1097. $("#ds_flash").slideToggle('normal', function() { $("#ds_flash").parent().resize(); } );
  1098. $("#dh_flash").toggleClass('open');
  1099. });
  1100. $('#ReloadMovieBtn').button().button('disable');
  1101. EOF
  1102. );
  1103. $aSortedElements = array();
  1104. foreach($aResults as $sClassIdx => $aObjects)
  1105. {
  1106. foreach($aObjects as $oCurrObj)
  1107. {
  1108. $sSubClass = get_class($oCurrObj);
  1109. $aSortedElements[$sSubClass] = MetaModel::GetName($sSubClass);
  1110. }
  1111. }
  1112. asort($aSortedElements);
  1113. $idx = 0;
  1114. foreach($aSortedElements as $sSubClass => $sClassName)
  1115. {
  1116. $oP->add("<span style=\"padding-right:2em; white-space:nowrap;\"><input type=\"checkbox\" id=\"exclude_$idx\" name=\"excluded[]\" value=\"$sSubClass\" checked onChange=\"$('#ReloadMovieBtn').button('enable')\"><label for=\"exclude_$idx\">&nbsp;".MetaModel::GetClassIcon($sSubClass)."&nbsp;$sClassName</label></span> ");
  1117. $idx++;
  1118. }
  1119. $oP->add("<p style=\"text-align:right\"><button type=\"button\" id=\"ReloadMovieBtn\" onClick=\"DoReload()\">".Dict::S('UI:Button:Refresh')."</button></p>");
  1120. $oP->add("</div>\n");
  1121. $oP->add("<div class=\"HRDrawer\"></div>\n");
  1122. $oP->add("<div id=\"dh_flash\" class=\"DrawerHandle\">".Dict::S('UI:ElementsDisplayed')."</div>\n");
  1123. $oP->add("</div>\n"); // class="not-printable"
  1124. $aAdditionalContexts = array();
  1125. foreach($aContextDefs as $sKey => $aDefinition)
  1126. {
  1127. $aAdditionalContexts[] = array('key' => $sKey, 'label' => Dict::S($aDefinition['dict']), 'oql' => $aDefinition['oql']);
  1128. }
  1129. $sDirection = utils::ReadParam('d', 'horizontal');
  1130. $iGroupingThreshold = utils::ReadParam('g', 5);
  1131. $oP->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/fraphael.js');
  1132. $oP->add_linked_stylesheet(utils::GetAbsoluteUrlAppRoot().'css/jquery.contextMenu.css');
  1133. $oP->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/jquery.contextMenu.js');
  1134. $oP->add_linked_script(utils::GetAbsoluteUrlAppRoot().'js/simple_graph.js');
  1135. try
  1136. {
  1137. $this->InitFromGraphviz();
  1138. $sExportAsPdfURL = '';
  1139. $sExportAsPdfURL = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=relation_pdf&relation='.$sRelation.'&direction='.($this->bDirectionDown ? 'down' : 'up');
  1140. $oAppcontext = new ApplicationContext();
  1141. $sContext = $oAppContext->GetForLink();
  1142. $sDrillDownURL = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=details&class=%1$s&id=%2$s&'.$sContext;
  1143. $sExportAsDocumentURL = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=relation_attachment&relation='.$sRelation.'&direction='.($this->bDirectionDown ? 'down' : 'up');
  1144. $sLoadFromURL = utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=relation_json&relation='.$sRelation.'&direction='.($this->bDirectionDown ? 'down' : 'up');
  1145. $sAttachmentExportTitle = '';
  1146. if (($sObjClass != null) && ($iObjKey != null))
  1147. {
  1148. $oTargetObj = MetaModel::GetObject($sObjClass, $iObjKey, false);
  1149. if ($oTargetObj)
  1150. {
  1151. $sAttachmentExportTitle = Dict::Format('UI:Relation:AttachmentExportOptions_Name', $oTargetObj->GetName());
  1152. }
  1153. }
  1154. $sId = 'graph';
  1155. $sStyle = '';
  1156. if ($oP->IsPrintableVersion())
  1157. {
  1158. // Optimize for printing on A4/Letter vertically
  1159. $sStyle = 'max-width: 17cm; margin-left:auto; margin-right:auto;';
  1160. }
  1161. $oP->add('<div id="'.$sId.'" class="simple-graph" style="'.$sStyle.'"></div>');
  1162. $aParams = array(
  1163. 'source_url' => $sLoadFromURL,
  1164. 'sources' => ($this->bDirectionDown ? $this->aSourceObjects : $this->aSinkObjects),
  1165. 'excluded' => $aExcludedByClass,
  1166. 'grouping_threshold' => $iGroupingThreshold,
  1167. 'export_as_pdf' => array('url' => $sExportAsPdfURL, 'label' => Dict::S('UI:Relation:ExportAsPDF')),
  1168. 'export_as_attachment' => array('url' => $sExportAsDocumentURL, 'label' => Dict::S('UI:Relation:ExportAsAttachment'), 'obj_class' => $sObjClass, 'obj_key' => $iObjKey),
  1169. 'drill_down' => array('url' => $sDrillDownURL, 'label' => Dict::S('UI:Relation:DrillDown')),
  1170. 'labels' => array(
  1171. 'export_pdf_title' => Dict::S('UI:Relation:PDFExportOptions'),
  1172. 'export_as_attachment_title' => $sAttachmentExportTitle,
  1173. 'export' => Dict::S('UI:Button:Export'),
  1174. 'cancel' => Dict::S('UI:Button:Cancel'),
  1175. 'title' => Dict::S('UI:RelationOption:Title'),
  1176. 'untitled' => Dict::S('UI:RelationOption:Untitled'),
  1177. 'include_list' => Dict::S('UI:RelationOption:IncludeList'),
  1178. 'comments' => Dict::S('UI:RelationOption:Comments'),
  1179. 'grouping_threshold' => Dict::S('UI:RelationOption:GroupingThreshold'),
  1180. 'refresh' => Dict::S('UI:Button:Refresh'),
  1181. 'check_all' => Dict::S('UI:SearchValue:CheckAll'),
  1182. 'uncheck_all' => Dict::S('UI:SearchValue:UncheckAll'),
  1183. 'none_selected' => Dict::S('UI:Relation:NoneSelected'),
  1184. 'nb_selected' => Dict::S('UI:SearchValue:NbSelected'),
  1185. 'additional_context_info' => Dict::S('UI:Relation:AdditionalContextInfo'),
  1186. 'zoom' => Dict::S('UI:Relation:Zoom'),
  1187. 'loading' => Dict::S('UI:Loading'),
  1188. ),
  1189. 'page_format' => array(
  1190. 'label' => Dict::S('UI:Relation:PDFExportPageFormat'),
  1191. 'values' => array(
  1192. 'A3' => Dict::S('UI:PageFormat_A3'),
  1193. 'A4' => Dict::S('UI:PageFormat_A4'),
  1194. 'Letter' => Dict::S('UI:PageFormat_Letter'),
  1195. ),
  1196. ),
  1197. 'page_orientation' => array(
  1198. 'label' => Dict::S('UI:Relation:PDFExportPageOrientation'),
  1199. 'values' => array(
  1200. 'P' => Dict::S('UI:PageOrientation_Portrait'),
  1201. 'L' => Dict::S('UI:PageOrientation_Landscape'),
  1202. ),
  1203. ),
  1204. 'additional_contexts' => $aAdditionalContexts,
  1205. 'context_key' => $sContextKey,
  1206. );
  1207. if (!extension_loaded('gd'))
  1208. {
  1209. // PDF export requires GD
  1210. unset($aParams['export_as_pdf']);
  1211. }
  1212. if (!extension_loaded('gd') || is_null($sObjClass) || is_null($iObjKey))
  1213. {
  1214. // Export as Attachment requires GD (for building the PDF) AND a valid objclass/objkey couple
  1215. unset($aParams['export_as_attachment']);
  1216. }
  1217. $oP->add_ready_script("$('#$sId').simple_graph(".json_encode($aParams).");");
  1218. }
  1219. catch(Exception $e)
  1220. {
  1221. $oP->add('<div>'.$e->getMessage().'</div>');
  1222. }
  1223. $oP->add_script(
  1224. <<<EOF
  1225. function DoReload()
  1226. {
  1227. $('#ReloadMovieBtn').button('disable');
  1228. try
  1229. {
  1230. var aExcluded = [];
  1231. $('input[name^=excluded]').each( function() {
  1232. if (!$(this).prop('checked'))
  1233. {
  1234. aExcluded.push($(this).val());
  1235. }
  1236. } );
  1237. $('#graph').simple_graph('option', {excluded_classes: aExcluded});
  1238. $('#graph').simple_graph('reload');
  1239. }
  1240. catch(err)
  1241. {
  1242. alert(err);
  1243. }
  1244. }
  1245. EOF
  1246. );
  1247. }
  1248. }