displayblock.class.inc.php 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. /**
  17. * DisplayBlock and derived class
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. require_once(APPROOT.'/application/webpage.class.inc.php');
  25. require_once(APPROOT.'/application/utils.inc.php');
  26. /**
  27. * Helper class to manage 'blocks' of HTML pieces that are parts of a page and contain some list of cmdb objects
  28. *
  29. * Each block is actually rendered as a <div></div> tag that can be rendered synchronously
  30. * or as a piece of Javascript/JQuery/Ajax that will get its content from another page (ajax.render.php).
  31. * The list of cmdbObjects to be displayed into the block is defined by a filter
  32. * Right now the type of display is either: list, count, bare_details, details, csv, modify or search
  33. * - list produces a table listing the objects
  34. * - count produces a paragraphs with a sentence saying 'cont' objects found
  35. * - bare_details displays just the details of the attributes of the object (best if only one)
  36. * - details display the full details of each object found using its template (best if only one)
  37. * - csv displays a textarea with the CSV export of the list of objects
  38. * - modify displays the form to modify an object (best if only one)
  39. * - search displays a search form with the criteria of the filter set
  40. */
  41. class DisplayBlock
  42. {
  43. const TAG_BLOCK = 'itopblock';
  44. protected $m_oFilter;
  45. protected $m_sStyle;
  46. protected $m_bAsynchronous;
  47. protected $m_aParams;
  48. protected $m_oSet;
  49. public function __construct(DBObjectSearch $oFilter, $sStyle = 'list', $bAsynchronous = false, $aParams = array(), $oSet = null)
  50. {
  51. $this->m_oFilter = $oFilter;
  52. $this->m_sStyle = $sStyle;
  53. $this->m_bAsynchronous = $bAsynchronous;
  54. $this->m_aParams = $aParams;
  55. $this->m_oSet = $oSet;
  56. }
  57. /**
  58. * Constructs a DisplayBlock object from a DBObjectSet already in memory
  59. * @param $oSet DBObjectSet
  60. * @return DisplayBlock The DisplayBlock object, or null if the creation failed
  61. */
  62. public static function FromObjectSet(DBObjectSet $oSet, $sStyle, $aParams = array())
  63. {
  64. $oDummyFilter = new DBObjectSearch($oSet->GetClass());
  65. $aKeys = array();
  66. while($oObject = $oSet->Fetch())
  67. {
  68. $aKeys[] = $oObject->GetKey();
  69. }
  70. $oSet->Rewind();
  71. $oDummyFilter->AddCondition('id', $aKeys, 'IN');
  72. $oBlock = new DisplayBlock($oDummyFilter, $sStyle, false, $aParams); // DisplayBlocks built this way are synchronous
  73. return $oBlock;
  74. }
  75. /**
  76. * Constructs a DisplayBlock object from an XML template
  77. * @param $sTemplate string The XML template
  78. * @return DisplayBlock The DisplayBlock object, or null if the template is invalid
  79. */
  80. public static function FromTemplate($sTemplate)
  81. {
  82. $iStartPos = stripos($sTemplate, '<'.self::TAG_BLOCK.' ',0);
  83. $iEndPos = stripos($sTemplate, '</'.self::TAG_BLOCK.'>', $iStartPos);
  84. $iEndTag = stripos($sTemplate, '>', $iStartPos);
  85. $aParams = array();
  86. if (($iStartPos === false) || ($iEndPos === false)) return null; // invalid template
  87. $sITopBlock = substr($sTemplate,$iStartPos, $iEndPos-$iStartPos+strlen('</'.self::TAG_BLOCK.'>'));
  88. $sITopData = substr($sTemplate, 1+$iEndTag, $iEndPos - $iEndTag - 1);
  89. $sITopTag = substr($sTemplate, $iStartPos + strlen('<'.self::TAG_BLOCK), $iEndTag - $iStartPos - strlen('<'.self::TAG_BLOCK));
  90. $aMatches = array();
  91. $sBlockClass = "DisplayBlock";
  92. $bAsynchronous = false;
  93. $sBlockType = 'list';
  94. $sEncoding = 'text/serialize';
  95. if (preg_match('/ type="(.*)"/U',$sITopTag, $aMatches))
  96. {
  97. $sBlockType = strtolower($aMatches[1]);
  98. }
  99. if (preg_match('/ asynchronous="(.*)"/U',$sITopTag, $aMatches))
  100. {
  101. $bAsynchronous = (strtolower($aMatches[1]) == 'true');
  102. }
  103. if (preg_match('/ blockclass="(.*)"/U',$sITopTag, $aMatches))
  104. {
  105. $sBlockClass = $aMatches[1];
  106. }
  107. if (preg_match('/ objectclass="(.*)"/U',$sITopTag, $aMatches))
  108. {
  109. $sObjectClass = $aMatches[1];
  110. }
  111. if (preg_match('/ encoding="(.*)"/U',$sITopTag, $aMatches))
  112. {
  113. $sEncoding = strtolower($aMatches[1]);
  114. }
  115. if (preg_match('/ link_attr="(.*)"/U',$sITopTag, $aMatches))
  116. {
  117. // The list to display is a list of links to the specified object
  118. $aParams['link_attr'] = $aMatches[1]; // Name of the Ext. Key that makes this linkage
  119. }
  120. if (preg_match('/ target_attr="(.*)"/U',$sITopTag, $aMatches))
  121. {
  122. // The list to display is a list of links to the specified object
  123. $aParams['target_attr'] = $aMatches[1]; // Name of the Ext. Key that make this linkage
  124. }
  125. if (preg_match('/ object_id="(.*)"/U',$sITopTag, $aMatches))
  126. {
  127. // The list to display is a list of links to the specified object
  128. $aParams['object_id'] = $aMatches[1]; // Id of the object to be linked to
  129. }
  130. // Parameters contains a list of extra parameters for the block
  131. // the syntax is param_name1:value1;param_name2:value2;...
  132. if (preg_match('/ parameters="(.*)"/U',$sITopTag, $aMatches))
  133. {
  134. $sParameters = $aMatches[1];
  135. $aPairs = explode(';', $sParameters);
  136. foreach($aPairs as $sPair)
  137. {
  138. if (preg_match('/(.*)\:(.*)/',$sPair, $aMatches))
  139. {
  140. $aParams[trim($aMatches[1])] = trim($aMatches[2]);
  141. }
  142. }
  143. }
  144. if (!empty($aParams['link_attr']))
  145. {
  146. // Check that all mandatory parameters are present:
  147. if(empty($aParams['object_id']))
  148. {
  149. // if 'links' mode is requested the d of the object to link to must be specified
  150. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  151. }
  152. if(empty($aParams['target_attr']))
  153. {
  154. // if 'links' mode is requested the id of the object to link to must be specified
  155. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  156. }
  157. }
  158. switch($sEncoding)
  159. {
  160. case 'text/serialize':
  161. $oFilter = CMDBSearchFilter::unserialize($sITopData);
  162. break;
  163. case 'text/oql':
  164. $oFilter = CMDBSearchFilter::FromOQL($sITopData);
  165. break;
  166. }
  167. return new $sBlockClass($oFilter, $sBlockType, $bAsynchronous, $aParams);
  168. }
  169. public function Display(WebPage $oPage, $sId, $aExtraParams = array())
  170. {
  171. $oPage->add($this->GetDisplay($oPage, $sId, $aExtraParams));
  172. /*
  173. $aExtraParams = array_merge($aExtraParams, $this->m_aParams);
  174. $aExtraParams['block_id'] = $sId;
  175. if (!$this->m_bAsynchronous)
  176. {
  177. // render now
  178. $oPage->add("<div id=\"$sId\" class=\"display_block\">\n");
  179. $this->RenderContent($oPage, $aExtraParams);
  180. $oPage->add("</div>\n");
  181. }
  182. else
  183. {
  184. // render it as an Ajax (asynchronous) call
  185. $sFilter = $this->m_oFilter->serialize();
  186. $oPage->add("<div id=\"$sId\" class=\"display_block loading\">\n");
  187. $oPage->p("<img src=\"../images/indicator_arrows.gif\"> Loading...");
  188. $oPage->add("</div>\n");
  189. $oPage->add('
  190. <script language="javascript">
  191. $.post("ajax.render.php?style='.$this->m_sStyle.'",
  192. { operation: "ajax", filter: "$sFilter" },
  193. function(data){
  194. $("#'.$sId.'").empty();
  195. $("#'.$sId.'").append(data);
  196. $("#'.$sId.'").removeClass("loading");
  197. }
  198. );
  199. </script>'); // TO DO: add support for $aExtraParams in asynchronous/Ajax mode
  200. }
  201. */
  202. }
  203. public function GetDisplay(WebPage $oPage, $sId, $aExtraParams = array())
  204. {
  205. $sHtml = '';
  206. $aExtraParams = array_merge($aExtraParams, $this->m_aParams);
  207. $aExtraParams['currentId'] = $sId;
  208. $sExtraParams = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  209. $bAutoReload = false;
  210. if (isset($aExtraParams['auto_reload']))
  211. {
  212. switch($aExtraParams['auto_reload'])
  213. {
  214. case 'fast':
  215. $bAutoReload = true;
  216. $iReloadInterval = MetaModel::GetConfig()->GetFastReloadInterval()*1000;
  217. break;
  218. case 'standard':
  219. case 'true':
  220. case true:
  221. $bAutoReload = true;
  222. $iReloadInterval = MetaModel::GetConfig()->GetStandardReloadInterval()*1000;
  223. break;
  224. default:
  225. if (is_numeric($aExtraParams['auto_reload']))
  226. {
  227. $bAutoReload = true;
  228. $iReloadInterval = $aExtraParams['auto_reload']*1000;
  229. }
  230. else
  231. {
  232. // incorrect config, ignore it
  233. $bAutoReload = false;
  234. }
  235. }
  236. }
  237. $sFilter = $this->m_oFilter->serialize(); // Used either for asynchronous or auto_reload
  238. if (!$this->m_bAsynchronous)
  239. {
  240. // render now
  241. $sHtml .= "<div id=\"$sId\" class=\"display_block\">\n";
  242. $sHtml .= $this->GetRenderContent($oPage, $aExtraParams, $sId);
  243. $sHtml .= "</div>\n";
  244. }
  245. else
  246. {
  247. // render it as an Ajax (asynchronous) call
  248. $sHtml .= "<div id=\"$sId\" class=\"display_block loading\">\n";
  249. $sHtml .= $oPage->GetP("<img src=\"../images/indicator_arrows.gif\"> ".Dict::S('UI:Loading'));
  250. $sHtml .= "</div>\n";
  251. $sHtml .= '
  252. <script language="javascript">
  253. $.post("ajax.render.php?style='.$this->m_sStyle.'",
  254. { operation: "ajax", filter: "'.$sFilter.'", extra_params: "'.$sExtraParams.'" },
  255. function(data){
  256. $("#'.$sId.'").empty();
  257. $("#'.$sId.'").append(data);
  258. $("#'.$sId.'").removeClass("loading");
  259. // Check each "listResults" table for a checkbox in the first column and make the first column sortable only if it does not contain a checkbox in the header
  260. $("#'.$sId.'.listResults").each( function()
  261. {
  262. var table = $(this);
  263. var id = $(this).parent();
  264. var checkbox = (table.find(\'th:first :checkbox\').length > 0);
  265. if (checkbox)
  266. {
  267. // There is a checkbox in the first column, do not make it sortable
  268. table.tablesorter( { headers: { 0: {sorter: false}}, widgets: [\'myZebra\', \'truncatedList\']} ); // sortable and zebra tables
  269. }
  270. else
  271. {
  272. // There is NO checkbox in the first column, all columns are considered sortable
  273. table.tablesorter( { widgets: [\'myZebra\', \'truncatedList\']} ); // sortable and zebra tables
  274. }
  275. });
  276. }
  277. );
  278. </script>';
  279. }
  280. if ($bAutoReload)
  281. {
  282. $sHtml .= '
  283. <script language="javascript">
  284. setInterval("ReloadBlock(\''.$sId.'\', \''.$this->m_sStyle.'\', \''.$sFilter.'\', \"'.$sExtraParams.'\")", '.$iReloadInterval.');
  285. </script>';
  286. }
  287. return $sHtml;
  288. }
  289. public function RenderContent(WebPage $oPage, $aExtraParams = array())
  290. {
  291. if (empty($aExtraParams['currentId']))
  292. {
  293. $sId = $oPage->GetUniqueId(); // Works only if the page is not an Ajax one !
  294. }
  295. else
  296. {
  297. $sId = $aExtraParams['currentId'];
  298. }
  299. $oPage->add($this->GetRenderContent($oPage, $aExtraParams, $sId));
  300. }
  301. public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
  302. {
  303. $sHtml = '';
  304. // Add the extra params into the filter if they make sense for such a filter
  305. $bDoSearch = utils::ReadParam('dosearch', false);
  306. if ($this->m_oSet == null)
  307. {
  308. $aQueryParams = array();
  309. if (isset($aExtraParams['query_params']))
  310. {
  311. $aQueryParams = $aExtraParams['query_params'];
  312. }
  313. if ($this->m_sStyle != 'links')
  314. {
  315. $oAppContext = new ApplicationContext();
  316. $sClass = $this->m_oFilter->GetClass();
  317. $aFilterCodes = array_keys(MetaModel::GetClassFilterDefs($sClass));
  318. foreach($oAppContext->GetNames() as $sContextParam)
  319. {
  320. eval("\$sParamCode = $sClass::MapContextParam('$sContextParam');"); //Map context parameter to the value/filter code depending on the class
  321. if (!is_null($sParamCode))
  322. {
  323. $sParamValue = $oAppContext->GetCurrentValue($sContextParam, null);
  324. if (!is_null($sParamValue))
  325. {
  326. $aExtraParams[$sParamCode] = $sParamValue;
  327. }
  328. }
  329. }
  330. foreach($aFilterCodes as $sFilterCode)
  331. {
  332. $sExternalFilterValue = utils::ReadParam($sFilterCode, '');
  333. $condition = null;
  334. if (isset($aExtraParams[$sFilterCode]))
  335. {
  336. $condition = $aExtraParams[$sFilterCode];
  337. }
  338. // else if ($bDoSearch && $sExternalFilterValue != "")
  339. if ($bDoSearch && $sExternalFilterValue != "")
  340. {
  341. // Search takes precedence over context params...
  342. unset($aExtraParams[$sFilterCode]);
  343. $condition = trim($sExternalFilterValue);
  344. }
  345. if (!is_null($condition))
  346. {
  347. $this->m_oFilter->AddCondition($sFilterCode, $condition); // Use the default 'loose' operator
  348. }
  349. }
  350. }
  351. $this->m_oSet = new CMDBObjectSet($this->m_oFilter, array(), $aQueryParams);
  352. }
  353. switch($this->m_sStyle)
  354. {
  355. case 'count':
  356. if (isset($aExtraParams['group_by']))
  357. {
  358. $sGroupByField = $aExtraParams['group_by'];
  359. $aGroupBy = array();
  360. $sLabels = array();
  361. while($oObj = $this->m_oSet->Fetch())
  362. {
  363. if (isset($aExtraParams['group_by_expr']))
  364. {
  365. eval("\$sValue = ".sprintf($aExtraParams['group_by_expr'], $oObj->Get($sGroupByField)).';');
  366. }
  367. else
  368. {
  369. $sValue = $oObj->Get($sGroupByField);
  370. }
  371. $aGroupBy[$sValue] = isset($aGroupBy[$sValue]) ? $aGroupBy[$sValue]+1 : 1;
  372. $sLabels[$sValue] = $oObj->GetAsHtml($sGroupByField);
  373. }
  374. $sFilter = urlencode($this->m_oFilter->serialize());
  375. $aData = array();
  376. $oAppContext = new ApplicationContext();
  377. $sParams = $oAppContext->GetForLink();
  378. foreach($aGroupBy as $sValue => $iCount)
  379. {
  380. $aData[] = array ( 'group' => $sLabels[$sValue],
  381. 'value' => "<a href=\"./UI.php?operation=search&dosearch=1&$sParams&filter=$sFilter&$sGroupByField=".urlencode($sValue)."\">$iCount</a>"); // TO DO: add the context information
  382. }
  383. $aAttribs =array(
  384. 'group' => array('label' => MetaModel::GetLabel($this->m_oFilter->GetClass(), $sGroupByField), 'description' => ''),
  385. 'value' => array('label'=> Dict::S('UI:GroupBy:Count'), 'description' => Dict::S('UI:GroupBy:Count+'))
  386. );
  387. $sHtml .= $oPage->GetTable($aAttribs, $aData);
  388. }
  389. else
  390. {
  391. // Simply count the number of elements in the set
  392. $iCount = $this->m_oSet->Count();
  393. $sFormat = 'UI:CountOfObjects';
  394. if (isset($aExtraParams['format']))
  395. {
  396. $sFormat = $aExtraParams['format'];
  397. }
  398. $sHtml .= $oPage->GetP(Dict::Format($sFormat, $iCount));
  399. }
  400. break;
  401. case 'join':
  402. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']): array();
  403. if (!isset($aExtraParams['group_by']))
  404. {
  405. $sHtml .= $oPage->GetP(Dict::S('UI:Error:MandatoryTemplateParameter_group_by'));
  406. }
  407. else
  408. {
  409. $aGroupByFields = array();
  410. $aGroupBy = explode(',', $aExtraParams['group_by']);
  411. foreach($aGroupBy as $sGroupBy)
  412. {
  413. $aMatches = array();
  414. if (preg_match('/^(.+)\.(.+)$/', $sGroupBy, $aMatches) > 0)
  415. {
  416. $aGroupByFields[] = array('alias' => $aMatches[1], 'att_code' => $aMatches[2]);
  417. }
  418. }
  419. if (count($aGroupByFields) == 0)
  420. {
  421. $sHtml .= $oPage->GetP(Dict::Format('UI:Error:InvalidGroupByFields', $aExtraParams['group_by']));
  422. }
  423. else
  424. {
  425. $aResults = array();
  426. $aCriteria = array();
  427. while($aObjects = $this->m_oSet->FetchAssoc())
  428. {
  429. $aKeys = array();
  430. foreach($aGroupByFields as $aField)
  431. {
  432. $sAlias = $aField['alias'];
  433. if (is_null($aObjects[$sAlias]))
  434. {
  435. $aKeys[$sAlias.'.'.$aField['att_code']] = '';
  436. }
  437. else
  438. {
  439. $aKeys[$sAlias.'.'.$aField['att_code']] = $aObjects[$sAlias]->Get($aField['att_code']);
  440. }
  441. }
  442. $sCategory = implode($aKeys, ' ');
  443. $aResults[$sCategory][] = $aObjects;
  444. $aCriteria[$sCategory] = $aKeys;
  445. }
  446. $sHtml .= "<table>\n";
  447. // Construct a new (parametric) query that will return the content of this block
  448. $oBlockFilter = clone $this->m_oFilter;
  449. $aExpressions = array();
  450. $index = 0;
  451. foreach($aGroupByFields as $aField)
  452. {
  453. $aExpressions[] = '`'.$aField['alias'].'`.`'.$aField['att_code'].'` = :param'.$index++;
  454. }
  455. $sExpression = implode(' AND ', $aExpressions);
  456. $oExpression = Expression::FromOQL($sExpression);
  457. $oBlockFilter->AddConditionExpression($oExpression);
  458. $aExtraParams['menu'] = false;
  459. foreach($aResults as $sCategory => $aObjects)
  460. {
  461. $sHtml .= "<tr><td><h1>$sCategory</h1></td></tr>\n";
  462. if (count($aDisplayAliases) == 1)
  463. {
  464. $aSimpleArray = array();
  465. foreach($aObjects as $aRow)
  466. {
  467. $oObj = $aRow[$aDisplayAliases[0]];
  468. if (!is_null($oObj))
  469. {
  470. $aSimpleArray[] = $oObj;
  471. }
  472. }
  473. $oSet = CMDBObjectSet::FromArray($this->m_oFilter->GetClass(), $aSimpleArray);
  474. $sHtml .= "<tr><td>".cmdbAbstractObject::GetDisplaySet($oPage, $oSet, $aExtraParams)."</td></tr>\n";
  475. }
  476. else
  477. {
  478. $index = 0;
  479. $aArgs = array();
  480. foreach($aGroupByFields as $aField)
  481. {
  482. $aArgs['param'.$index] = $aCriteria[$sCategory][$aField['alias'].'.'.$aField['att_code']];
  483. $index++;
  484. }
  485. $oSet = new CMDBObjectSet($oBlockFilter, array(), $aArgs);
  486. $sHtml .= "<tr><td>".cmdbAbstractObject::GetDisplayExtendedSet($oPage, $oSet, $aExtraParams)."</td></tr>\n";
  487. }
  488. }
  489. $sHtml .= "</table>\n";
  490. }
  491. }
  492. break;
  493. case 'list':
  494. $aClasses = $this->m_oSet->GetSelectedClasses();
  495. $aAuthorizedClasses = array();
  496. if (count($aClasses) > 1)
  497. {
  498. // Check the classes that can be read (i.e authorized) by this user...
  499. foreach($aClasses as $sAlias => $sClassName)
  500. {
  501. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $this->m_oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  502. {
  503. $aAuthorizedClasses[$sAlias] = $sClassName;
  504. }
  505. }
  506. if (count($aAuthorizedClasses) > 0)
  507. {
  508. if($this->m_oSet->Count() > 0)
  509. {
  510. $sHtml .= cmdbAbstractObject::GetDisplayExtendedSet($oPage, $this->m_oSet, $aExtraParams);
  511. }
  512. else
  513. {
  514. // Empty set
  515. $sHtml .= $oPage->GetP(Dict::S('UI:NoObjectToDisplay'));
  516. }
  517. }
  518. else
  519. {
  520. // Not authorized
  521. $sHtml .= $oPage->GetP(Dict::S('UI:NoObjectToDisplay'));
  522. }
  523. }
  524. else
  525. {
  526. // The list is made of only 1 class of objects, actions on the list are possible
  527. if ( ($this->m_oSet->Count()> 0) && (UserRights::IsActionAllowed($this->m_oSet->GetClass(), UR_ACTION_READ, $this->m_oSet) == UR_ALLOWED_YES) )
  528. {
  529. $sHtml .= cmdbAbstractObject::GetDisplaySet($oPage, $this->m_oSet, $aExtraParams);
  530. }
  531. else
  532. {
  533. $sHtml .= $oPage->GetP(Dict::S('UI:NoObjectToDisplay'));
  534. $sClass = $this->m_oFilter->GetClass();
  535. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  536. if ($bDisplayMenu)
  537. {
  538. if ((UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
  539. {
  540. $oAppContext = new ApplicationContext();
  541. $sParams = $oAppContext->GetForLink();
  542. // 1:n links, populate the target object as a default value when creating a new linked object
  543. if (isset($aExtraParams['target_attr']))
  544. {
  545. $aExtraParams['default'][$aExtraParams['target_attr']] = $aExtraParams['object_id'];
  546. }
  547. $sDefault = '';
  548. if (!empty($aExtraParams['default']))
  549. {
  550. foreach($aExtraParams['default'] as $sKey => $sValue)
  551. {
  552. $sDefault.= "&default[$sKey]=$sValue";
  553. }
  554. }
  555. $sHtml .= $oPage->GetP("<a href=\"./UI.php?operation=new&class=$sClass&$sParams{$sDefault}\">".Dict::Format('UI:ClickToCreateNew', Metamodel::GetName($sClass))."</a>\n");
  556. }
  557. }
  558. }
  559. }
  560. break;
  561. case 'links':
  562. //$bDashboardMode = isset($aExtraParams['dashboard']) ? ($aExtraParams['dashboard'] == 'true') : false;
  563. //$bSelectMode = isset($aExtraParams['select']) ? ($aExtraParams['select'] == 'true') : false;
  564. if ( ($this->m_oSet->Count()> 0) && (UserRights::IsActionAllowed($this->m_oSet->GetClass(), UR_ACTION_READ, $this->m_oSet) == UR_ALLOWED_YES) )
  565. {
  566. //$sLinkage = isset($aExtraParams['linkage']) ? $aExtraParams['linkage'] : '';
  567. $sHtml .= cmdbAbstractObject::GetDisplaySet($oPage, $this->m_oSet, $aExtraParams);
  568. }
  569. else
  570. {
  571. $sClass = $this->m_oFilter->GetClass();
  572. $oAttDef = MetaModel::GetAttributeDef($sClass, $this->m_aParams['target_attr']);
  573. $sTargetClass = $oAttDef->GetTargetClass();
  574. $sHtml .= $oPage->GetP(Dict::Format('UI:NoObject_Class_ToDisplay', MetaModel::GetName($sTargetClass)));
  575. $bDisplayMenu = isset($this->m_aParams['menu']) ? $this->m_aParams['menu'] == true : true;
  576. if ($bDisplayMenu)
  577. {
  578. if ((UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES))
  579. {
  580. $oAppContext = new ApplicationContext();
  581. $sParams = $oAppContext->GetForLink();
  582. $sDefaults = '';
  583. if (isset($this->m_aParams['default']))
  584. {
  585. foreach($this->m_aParams['default'] as $sName => $sValue)
  586. {
  587. $sDefaults .= '&'.urlencode($sName).'='.urlencode($sValue);
  588. }
  589. }
  590. $sHtml .= $oPage->GetP("<a href=\"../pages/UI.php?operation=modify_links&class=$sClass&sParams&link_attr=".$aExtraParams['link_attr']."&id=".$aExtraParams['object_id']."&target_class=$sTargetClass&addObjects=true$sDefaults\">".Dict::Format('UI:ClickToCreateNew', Metamodel::GetName($sClass))."</a>\n");
  591. }
  592. }
  593. }
  594. break;
  595. case 'details':
  596. while($oObj = $this->m_oSet->Fetch())
  597. {
  598. $sHtml .= $oObj->GetDetails($oPage); // Still used ???
  599. }
  600. break;
  601. case 'actions':
  602. $sClass = $this->m_oFilter->GetClass();
  603. $oAppContext = new ApplicationContext();
  604. $bContextFilter = isset($aExtraParams['context_filter']) ? isset($aExtraParams['context_filter']) != 0 : false;
  605. if ($bContextFilter)
  606. {
  607. $aFilterCodes = array_keys(MetaModel::GetClassFilterDefs($this->m_oFilter->GetClass()));
  608. foreach($oAppContext->GetNames() as $sFilterCode)
  609. {
  610. $sContextParamValue = $oAppContext->GetCurrentValue($sFilterCode, null);
  611. if (!is_null($sContextParamValue) && ! empty($sContextParamValue) && MetaModel::IsValidFilterCode($sClass, $sFilterCode))
  612. {
  613. $this->m_oFilter->AddCondition($sFilterCode, $sContextParamValue); // Use the default 'loose' operator
  614. }
  615. }
  616. $aQueryParams = array();
  617. if (isset($aExtraParams['query_params']))
  618. {
  619. $aQueryParams = $aExtraParams['query_params'];
  620. }
  621. $this->m_oSet = new CMDBObjectSet($this->m_oFilter, array(), $aQueryParams);
  622. }
  623. $iCount = $this->m_oSet->Count();
  624. $sHyperlink = '../pages/UI.php?operation=search&'.$oAppContext->GetForLink().'&filter='.$this->m_oFilter->serialize();
  625. $sHtml .= '<p><a class="actions" href="'.$sHyperlink.'">';
  626. $sHtml .= MetaModel::GetClassIcon($sClass, true, 'float;left;margin-right:10px;');
  627. $sHtml .= MetaModel::GetName($sClass).': '.$iCount.'</a></p>';
  628. $sParams = $oAppContext->GetForLink();
  629. $sHtml .= '<p>';
  630. if (UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY))
  631. {
  632. $sHtml .= "<a href=\"../pages/UI.php?operation=new&class={$sClass}&$sParams\">".Dict::Format('UI:ClickToCreateNew', MetaModel::GetName($sClass))."</a><br/>\n";
  633. }
  634. $sHtml .= "<a href=\"../pages/UI.php?operation=search_form&class={$sClass}&$sParams\">".Dict::Format('UI:SearchFor_Class', MetaModel::GetName($sClass))."</a>\n";
  635. $sHtml .= '</p>';
  636. break;
  637. case 'summary':
  638. $sClass = $this->m_oFilter->GetClass();
  639. $oAppContext = new ApplicationContext();
  640. $sTitle = isset($aExtraParams['title[block]']) ? $aExtraParams['title[block]'] : '';
  641. $sLabel = isset($aExtraParams['label[block]']) ? $aExtraParams['label[block]'] : '';
  642. $sStateAttrCode = isset($aExtraParams['status[block]']) ? $aExtraParams['status[block]'] : 'status';
  643. $sStatesList = isset($aExtraParams['status_codes[block]']) ? $aExtraParams['status_codes[block]'] : '';
  644. $bContextFilter = isset($aExtraParams['context_filter']) ? isset($aExtraParams['context_filter']) != 0 : false;
  645. if ($bContextFilter)
  646. {
  647. $aFilterCodes = array_keys(MetaModel::GetClassFilterDefs($this->m_oFilter->GetClass()));
  648. foreach($oAppContext->GetNames() as $sFilterCode)
  649. {
  650. $sContextParamValue = $oAppContext->GetCurrentValue($sFilterCode, null);
  651. if (!is_null($sContextParamValue) && ! empty($sContextParamValue) && MetaModel::IsValidFilterCode($sClass, $sFilterCode))
  652. {
  653. $this->m_oFilter->AddCondition($sFilterCode, $sContextParamValue); // Use the default 'loose' operator
  654. }
  655. }
  656. $aQueryParams = array();
  657. if (isset($aExtraParams['query_params']))
  658. {
  659. $aQueryParams = $aExtraParams['query_params'];
  660. }
  661. $this->m_oSet = new CMDBObjectSet($this->m_oFilter, array(), $aQueryParams);
  662. }
  663. // Summary details
  664. $aCounts = array();
  665. $aStateLabels = array();
  666. if (!empty($sStateAttrCode) && !empty($sStatesList))
  667. {
  668. $aStates = explode(',', $sStatesList);
  669. $oAttDef = MetaModel::GetAttributeDef($sClass, $sStateAttrCode);
  670. foreach($aStates as $sStateValue)
  671. {
  672. $oFilter = clone($this->m_oFilter);
  673. $oFilter->AddCondition($sStateAttrCode, $sStateValue, '=');
  674. $oSet = new DBObjectSet($oFilter);
  675. $aCounts[$sStateValue] = $oSet->Count();
  676. $aStateLabels[$sStateValue] = Dict::S("Class:".$oAttDef->GetHostClass()."/Attribute:$sStateAttrCode/Value:$sStateValue");
  677. if ($aCounts[$sStateValue] == 0)
  678. {
  679. $aCounts[$sStateValue] = '-';
  680. }
  681. else
  682. {
  683. $sHyperlink = '../pages/UI.php?operation=search&'.$oAppContext->GetForLink().'&filter='.$oFilter->serialize();
  684. $aCounts[$sStateValue] = "<a href=\"$sHyperlink\">{$aCounts[$sStateValue]}</a>";
  685. }
  686. }
  687. }
  688. $sHtml .= '<div class="summary-details"><table><tr><th>'.implode('</th><th>', $aStateLabels).'</th></tr>';
  689. $sHtml .= '<tr><td>'.implode('</td><td>', $aCounts).'</td></tr></table></div>';
  690. // Title & summary
  691. $iCount = $this->m_oSet->Count();
  692. $sHyperlink = '../pages/UI.php?operation=search&'.$oAppContext->GetForLink().'&filter='.$this->m_oFilter->serialize();
  693. $sHtml .= '<h1>'.Dict::S(str_replace('_', ':', $sTitle)).'</h1>';
  694. $sHtml .= '<a class="summary" href="'.$sHyperlink.'">'.Dict::Format(str_replace('_', ':', $sLabel), $iCount).'</a>';
  695. break;
  696. case 'bare_details':
  697. while($oObj = $this->m_oSet->Fetch())
  698. {
  699. $sHtml .= $oObj->GetBareProperties($oPage);
  700. }
  701. break;
  702. case 'csv':
  703. $sHtml .= "<textarea style=\"width:95%;height:98%\">\n";
  704. $sHtml .= cmdbAbstractObject::GetSetAsCSV($this->m_oSet);
  705. $sHtml .= "</textarea>\n";
  706. break;
  707. case 'modify':
  708. if ((UserRights::IsActionAllowed($this->m_oSet->GetClass(), UR_ACTION_MODIFY, $this->m_oSet) == UR_ALLOWED_YES))
  709. {
  710. while($oObj = $this->m_oSet->Fetch())
  711. {
  712. $sHtml .= $oObj->GetModifyForm($oPage);
  713. }
  714. }
  715. break;
  716. case 'search':
  717. $sStyle = (isset($aExtraParams['open']) && ($aExtraParams['open'] == 'true')) ? 'SearchDrawer' : 'SearchDrawer DrawerClosed';
  718. $sHtml .= "<div id=\"ds_$sId\" class=\"$sStyle\">\n";
  719. $oPage->add_ready_script(
  720. <<<EOF
  721. $("#dh_$sId").click( function() {
  722. $("#ds_$sId").slideToggle('normal', function() { $("#ds_$sId").parent().resize(); } );
  723. $("#dh_$sId").toggleClass('open');
  724. });
  725. EOF
  726. );
  727. $aExtraParams['currentId'] = $sId;
  728. $sHtml .= cmdbAbstractObject::GetSearchForm($oPage, $this->m_oSet, $aExtraParams);
  729. $sHtml .= "</div>\n";
  730. $sHtml .= "<div class=\"HRDrawer\"></div>\n";
  731. $sHtml .= "<div id=\"dh_$sId\" class=\"DrawerHandle\">".Dict::S('UI:SearchToggle')."</div>\n";
  732. break;
  733. case 'open_flash_chart':
  734. static $iChartCounter = 0;
  735. $sChartType = isset($aExtraParams['chart_type']) ? $aExtraParams['chart_type'] : 'pie';
  736. $sTitle = isset($aExtraParams['chart_title']) ? $aExtraParams['chart_title'] : '';
  737. $sGroupBy = isset($aExtraParams['group_by']) ? $aExtraParams['group_by'] : '';
  738. $sGroupByExpr = isset($aExtraParams['group_by_expr']) ? '&params[group_by_expr]='.$aExtraParams['group_by_expr'] : '';
  739. $sFilter = $this->m_oFilter->serialize();
  740. $sHtml .= "<div id=\"my_chart_{$iChartCounter}\">If the chart does not display, <a href=\"http://get.adobe.com/flash/\" target=\"_blank\">install Flash</a></div>\n";
  741. $oPage->add_script("function ofc_resize(left, width, top, height) { /* do nothing special */ }");
  742. $oPage->add_ready_script("swfobject.embedSWF(\"../images/open-flash-chart.swf\", \"my_chart_{$iChartCounter}\", \"100%\", \"300\",\"9.0.0\", \"expressInstall.swf\",
  743. {\"data-file\":\"".urlencode("../pages/ajax.render.php?operation=open_flash_chart&params[group_by]=$sGroupBy{$sGroupByExpr}&params[chart_type]=$sChartType&params[chart_title]=$sTitle&id=$sId&filter=".$sFilter)."\"}, {wmode: 'transparent'} );\n");
  744. $iChartCounter++;
  745. if (isset($aExtraParams['group_by']))
  746. {
  747. $sGroupByField = $aExtraParams['group_by'];
  748. $aGroupBy = array();
  749. while($oObj = $this->m_oSet->Fetch())
  750. {
  751. if (isset($aExtraParams['group_by_expr']))
  752. {
  753. eval("\$sValue = ".sprintf($aExtraParams['group_by_expr'], $oObj->Get($sGroupByField)).';');
  754. }
  755. else
  756. {
  757. $sValue = $oObj->Get($sGroupByField);
  758. }
  759. $aGroupBy[$sValue] = isset($aGroupBy[$sValue]) ? $aGroupBy[$sValue]+1 : 1;
  760. }
  761. $sFilter = urlencode($this->m_oFilter->serialize());
  762. $aData = array();
  763. $aLabels = array();
  764. $idx = 0;
  765. foreach($aGroupBy as $sValue => $iValue)
  766. {
  767. $oDrillDownFilter = clone $this->m_oFilter;
  768. $oDrillDownFilter->AddCondition($sGroupByField, $sValue, '=');
  769. $aURLs[$idx] = $oDrillDownFilter->serialize();
  770. $idx++;
  771. }
  772. $sURLList = '';
  773. foreach($aURLs as $index => $sURL)
  774. {
  775. $sURLList .= "\taURLs[$index] = '".utils::GetAbsoluteUrlAppRoot()."pages/UI.php?operation=search&format=html&filter=".addslashes($sURL)."';\n";
  776. }
  777. $oPage->add_script(
  778. <<<EOF
  779. function ofc_drill_down_{$sId}(index)
  780. {
  781. var aURLs = new Array();
  782. {$sURLList}
  783. window.location.href=aURLs[index];
  784. }
  785. EOF
  786. );
  787. }
  788. break;
  789. case 'open_flash_chart_ajax':
  790. require_once(APPROOT.'/pages/php-ofc-library/open-flash-chart.php');
  791. $sChartType = isset($aExtraParams['chart_type']) ? $aExtraParams['chart_type'] : 'pie';
  792. $sId = utils::ReadParam('id', '');
  793. $oChart = new open_flash_chart();
  794. switch($sChartType)
  795. {
  796. case 'bars':
  797. $oChartElement = new bar_glass();
  798. if (isset($aExtraParams['group_by']))
  799. {
  800. $sGroupByField = $aExtraParams['group_by'];
  801. $aGroupBy = array();
  802. while($oObj = $this->m_oSet->Fetch())
  803. {
  804. if (isset($aExtraParams['group_by_expr']))
  805. {
  806. eval("\$sValue = ".sprintf($aExtraParams['group_by_expr'], $oObj->Get($sGroupByField)).';');
  807. }
  808. else
  809. {
  810. $sValue = $oObj->Get($sGroupByField);
  811. }
  812. $aGroupBy[$sValue] = isset($aGroupBy[$sValue]) ? $aGroupBy[$sValue]+1 : 1;
  813. }
  814. $sFilter = urlencode($this->m_oFilter->serialize());
  815. $aData = array();
  816. $aLabels = array();
  817. $maxValue = 0;
  818. foreach($aGroupBy as $sValue => $iValue)
  819. {
  820. $oBarValue = new bar_value($iValue);
  821. $oBarValue->on_click("ofc_drill_down_$sId");
  822. $aData[] = $oBarValue;
  823. if ($iValue > $maxValue) $maxValue = $iValue;
  824. $aLabels[] = $sValue;
  825. }
  826. $oYAxis = new y_axis();
  827. $aMagicValues = array(1,2,5,10);
  828. $iMultiplier = 1;
  829. $index = 0;
  830. $iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
  831. while($maxValue > $iTop)
  832. {
  833. $index++;
  834. $iTop = $aMagicValues[$index % count($aMagicValues)]*$iMultiplier;
  835. if (($index % count($aMagicValues)) == 0)
  836. {
  837. $iMultiplier = $iMultiplier * 10;
  838. }
  839. }
  840. //echo "oYAxis->set_range(0, $iTop, $iMultiplier);\n";
  841. $oYAxis->set_range(0, $iTop, $iMultiplier);
  842. $oChart->set_y_axis( $oYAxis );
  843. $oChartElement->set_values( $aData );
  844. $oXAxis = new x_axis();
  845. $oXLabels = new x_axis_labels();
  846. // set them vertical
  847. $oXLabels->set_vertical();
  848. // set the label text
  849. $oXLabels->set_labels($aLabels);
  850. // Add the X Axis Labels to the X Axis
  851. $oXAxis->set_labels( $oXLabels );
  852. $oChart->set_x_axis( $oXAxis );
  853. }
  854. break;
  855. case 'pie':
  856. default:
  857. $oChartElement = new pie();
  858. $oChartElement->set_start_angle( 35 );
  859. $oChartElement->set_animate( true );
  860. $oChartElement->set_tooltip( '#label# - #val# (#percent#)' );
  861. $oChartElement->set_colours( array('#FF8A00', '#909980', '#2C2B33', '#CCC08D', '#596664') );
  862. if (isset($aExtraParams['group_by']))
  863. {
  864. $sGroupByField = $aExtraParams['group_by'];
  865. $aGroupBy = array();
  866. while($oObj = $this->m_oSet->Fetch())
  867. {
  868. if (isset($aExtraParams['group_by_expr']))
  869. {
  870. eval("\$sValue = ".sprintf($aExtraParams['group_by_expr'], $oObj->Get($sGroupByField)).';');
  871. }
  872. else
  873. {
  874. $sValue = $oObj->Get($sGroupByField);
  875. }
  876. $aGroupBy[$sValue] = isset($aGroupBy[$sValue]) ? $aGroupBy[$sValue]+1 : 1;
  877. }
  878. $sFilter = urlencode($this->m_oFilter->serialize());
  879. $aData = array();
  880. foreach($aGroupBy as $sValue => $iValue)
  881. {
  882. $PieValue = new pie_value($iValue, $sValue); //@@ BUG: not passed via ajax !!!
  883. $PieValue->on_click("ofc_drill_down_$sId");
  884. $aData[] = $PieValue;
  885. }
  886. $oChartElement->set_values( $aData );
  887. $oChart->x_axis = null;
  888. }
  889. }
  890. if (isset($aExtraParams['chart_title']))
  891. {
  892. $oTitle = new title( Dict::S($aExtraParams['chart_title']) );
  893. $oChart->set_title( $oTitle );
  894. }
  895. $oChart->set_bg_colour('#FFFFFF');
  896. $oChart->add_element( $oChartElement );
  897. $sHtml = $oChart->toPrettyString();
  898. break;
  899. default:
  900. // Unsupported style, do nothing.
  901. $sHtml .= Dict::format('UI:Error:UnsupportedStyleOfBlock', $this->m_sStyle);
  902. }
  903. return $sHtml;
  904. }
  905. }
  906. /**
  907. * Helper class to manage 'blocks' of HTML pieces that are parts of a page and contain some list of cmdb objects
  908. *
  909. * Each block is actually rendered as a <div></div> tag that can be rendered synchronously
  910. * or as a piece of Javascript/JQuery/Ajax that will get its content from another page (ajax.render.php).
  911. * The list of cmdbObjects to be displayed into the block is defined by a filter
  912. * Right now the type of display is either: list, count or details
  913. * - list produces a table listing the objects
  914. * - count produces a paragraphs with a sentence saying 'cont' objects found
  915. * - details display (as table) the details of each object found (best if only one)
  916. */
  917. class HistoryBlock extends DisplayBlock
  918. {
  919. public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
  920. {
  921. $sHtml = '';
  922. $oSet = new CMDBObjectSet($this->m_oFilter, array('date'=>false));
  923. $sHtml .= "<!-- filter: ".($this->m_oFilter->ToOQL())."-->\n";
  924. switch($this->m_sStyle)
  925. {
  926. case 'toggle':
  927. // First the latest change that the user is allowed to see
  928. do
  929. {
  930. $oLatestChangeOp = $oSet->Fetch();
  931. }
  932. while(is_object($oLatestChangeOp) && ($oLatestChangeOp->GetDescription() == ''));
  933. if (is_object($oLatestChangeOp))
  934. {
  935. // There is one change in the list... only when the object has been created !
  936. $sDate = $oLatestChangeOp->GetAsHTML('date');
  937. $oChange = MetaModel::GetObject('CMDBChange', $oLatestChangeOp->Get('change'));
  938. $sUserInfo = $oChange->GetAsHTML('userinfo');
  939. $sHtml .= $oPage->GetStartCollapsibleSection(Dict::Format('UI:History:LastModified_On_By', $sDate, $sUserInfo));
  940. $sHtml .= $this->GetHistoryTable($oPage, $oSet);
  941. $sHtml .= $oPage->GetEndCollapsibleSection();
  942. }
  943. break;
  944. case 'table':
  945. default:
  946. $sHtml .= $this->GetHistoryTable($oPage, $oSet);
  947. }
  948. return $sHtml;
  949. }
  950. protected function GetHistoryTable(WebPage $oPage, DBObjectSet $oSet)
  951. {
  952. $sHtml = '';
  953. // First the latest change that the user is allowed to see
  954. $oSet->Rewind(); // Reset the pointer to the beginning of the set
  955. $aChanges = array();
  956. while($oChangeOp = $oSet->Fetch())
  957. {
  958. $sChangeDescription = $oChangeOp->GetDescription();
  959. if ($sChangeDescription != '')
  960. {
  961. // The change is visible for the current user
  962. $changeId = $oChangeOp->Get('change');
  963. $aChanges[$changeId]['date'] = $oChangeOp->Get('date');
  964. $aChanges[$changeId]['userinfo'] = $oChangeOp->Get('userinfo');
  965. if (!isset($aChanges[$changeId]['log']))
  966. {
  967. $aChanges[$changeId]['log'] = array();
  968. }
  969. $aChanges[$changeId]['log'][] = $sChangeDescription;
  970. }
  971. }
  972. $aAttribs = array('date' => array('label' => Dict::S('UI:History:Date'), 'description' => Dict::S('UI:History:Date+')),
  973. 'userinfo' => array('label' => Dict::S('UI:History:User'), 'description' => Dict::S('UI:History:User+')),
  974. 'log' => array('label' => Dict::S('UI:History:Changes'), 'description' => Dict::S('UI:History:Changes+')),
  975. );
  976. $aValues = array();
  977. foreach($aChanges as $aChange)
  978. {
  979. $aValues[] = array('date' => $aChange['date'], 'userinfo' => $aChange['userinfo'], 'log' => "<ul><li>".implode('</li><li>', $aChange['log'])."</li></ul>");
  980. }
  981. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  982. return $sHtml;
  983. }
  984. }
  985. class MenuBlock extends DisplayBlock
  986. {
  987. /**
  988. * Renders the "Actions" popup menu for the given set of objects
  989. *
  990. * Note that the menu links containing (or ending) with a hash (#) will have their fragment
  991. * part (whatever is after the hash) dynamically replaced (by javascript) when the menu is
  992. * displayed, to correspond to the current hash/fragment in the page. This allows modifying
  993. * an object in with the same tab active by default as the tab that was active when selecting
  994. * the "Modify..." action.
  995. */
  996. public function GetRenderContent(WebPage $oPage, $aExtraParams = array(), $sId)
  997. {
  998. $sHtml = '';
  999. $oAppContext = new ApplicationContext();
  1000. $sContext = $oAppContext->GetForLink();
  1001. $sClass = $this->m_oFilter->GetClass();
  1002. $oSet = new CMDBObjectSet($this->m_oFilter);
  1003. $sFilter = $this->m_oFilter->serialize();
  1004. $sFilterDesc = $this->m_oFilter->ToOql();
  1005. $aActions = array();
  1006. $sUIPage = cmdbAbstractObject::ComputeStandardUIPage($sClass);
  1007. // 1:n links, populate the target object as a default value when creating a new linked object
  1008. if (isset($aExtraParams['target_attr']))
  1009. {
  1010. $aExtraParams['default'][$aExtraParams['target_attr']] = $aExtraParams['object_id'];
  1011. }
  1012. $sDefault = '';
  1013. if (!empty($aExtraParams['default']))
  1014. {
  1015. foreach($aExtraParams['default'] as $sKey => $sValue)
  1016. {
  1017. $sDefault.= "&default[$sKey]=$sValue";
  1018. }
  1019. }
  1020. switch($oSet->Count())
  1021. {
  1022. case 0:
  1023. // No object in the set, the only possible action is "new"
  1024. $bIsModifyAllowed = (UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY) == UR_ALLOWED_YES);
  1025. if ($bIsModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:New'), 'url' => "../page/$sUIPage?operation=new&class=$sClass&$sContext{$sDefault}"); }
  1026. break;
  1027. case 1:
  1028. $oObj = $oSet->Fetch();
  1029. $id = $oObj->GetKey();
  1030. $bIsModifyAllowed = (UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY, $oSet) == UR_ALLOWED_YES);
  1031. $bIsDeleteAllowed = UserRights::IsActionAllowed($sClass, UR_ACTION_DELETE, $oSet);
  1032. $bIsBulkModifyAllowed = (!MetaModel::IsAbstract($sClass)) && UserRights::IsActionAllowed($sClass, UR_ACTION_BULK_MODIFY, $oSet);
  1033. $bIsBulkDeleteAllowed = UserRights::IsActionAllowed($sClass, UR_ACTION_BULK_DELETE, $oSet);
  1034. // Just one object in the set, possible actions are "new / clone / modify and delete"
  1035. if (!isset($aExtraParams['link_attr']))
  1036. {
  1037. if ($bIsModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:Modify'), 'url' => "../pages/$sUIPage?operation=modify&class=$sClass&id=$id&$sContext#"); }
  1038. if ($bIsModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:New'), 'url' => "../pages/$sUIPage?operation=new&class=$sClass&$sContext{$sDefault}"); }
  1039. if ($bIsDeleteAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:Delete'), 'url' => "../pages/$sUIPage?operation=delete&class=$sClass&id=$id&$sContext"); }
  1040. // Transitions / Stimuli
  1041. $aTransitions = $oObj->EnumTransitions();
  1042. if (count($aTransitions))
  1043. {
  1044. $this->AddMenuSeparator($aActions);
  1045. $aStimuli = Metamodel::EnumStimuli($sClass);
  1046. foreach($aTransitions as $sStimulusCode => $aTransitionDef)
  1047. {
  1048. $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? UserRights::IsStimulusAllowed($sClass, $sStimulusCode, $oSet) : UR_ALLOWED_NO;
  1049. switch($iActionAllowed)
  1050. {
  1051. case UR_ALLOWED_YES:
  1052. $aActions[] = array('label' => $aStimuli[$sStimulusCode]->GetLabel(), 'url' => "../pages/UI.php?operation=stimulus&stimulus=$sStimulusCode&class=$sClass&id=$id&$sContext");
  1053. break;
  1054. default:
  1055. // Do nothing
  1056. }
  1057. }
  1058. }
  1059. // Relations...
  1060. $aRelations = MetaModel::EnumRelations($sClass);
  1061. if (count($aRelations))
  1062. {
  1063. $this->AddMenuSeparator($aActions);
  1064. foreach($aRelations as $sRelationCode)
  1065. {
  1066. $aActions[] = array ('label' => MetaModel::GetRelationVerbUp($sRelationCode), 'url' => "../pages/$sUIPage?operation=swf_navigator&relation=$sRelationCode&class=$sClass&id=$id&$sContext");
  1067. }
  1068. }
  1069. $this->AddMenuSeparator($aActions);
  1070. // Static menus: Email this page & CSV Export
  1071. $sUrl = ApplicationContext::MakeObjectUrl($sClass, $id);
  1072. $aActions[] = array ('label' => Dict::S('UI:Menu:EMail'), 'url' => "mailto:?subject=".$oObj->GetName()."&body=".urlencode($sUrl));
  1073. $aActions[] = array ('label' => Dict::S('UI:Menu:CSVExport'), 'url' => "../pages/$sUIPage?operation=search&filter=$sFilter&format=csv&$sContext");
  1074. }
  1075. $this->AddMenuSeparator($aActions);
  1076. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  1077. {
  1078. $oSet->Rewind();
  1079. foreach($oExtensionInstance->EnumAllowedActions($oSet) as $sLabel => $sUrl)
  1080. {
  1081. $aActions[] = array ('label' => $sLabel, 'url' => $sUrl);
  1082. }
  1083. }
  1084. break;
  1085. default:
  1086. // Check rights
  1087. // New / Modify
  1088. $bIsModifyAllowed = UserRights::IsActionAllowed($sClass, UR_ACTION_MODIFY, $oSet);
  1089. $bIsBulkModifyAllowed = (!MetaModel::IsAbstract($sClass)) && UserRights::IsActionAllowed($sClass, UR_ACTION_BULK_MODIFY, $oSet);
  1090. $bIsBulkDeleteAllowed = UserRights::IsActionAllowed($sClass, UR_ACTION_BULK_DELETE, $oSet);
  1091. if (isset($aExtraParams['link_attr']))
  1092. {
  1093. $id = $aExtraParams['object_id'];
  1094. $sTargetAttr = $aExtraParams['target_attr'];
  1095. $oAttDef = MetaModel::GetAttributeDef($sClass, $sTargetAttr);
  1096. $sTargetClass = $oAttDef->GetTargetClass();
  1097. $bIsDeleteAllowed = UserRights::IsActionAllowed($sClass, UR_ACTION_DELETE, $oSet);
  1098. if ($bIsModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:Add'), 'url' => "../pages/$sUIPage?operation=modify_links&class=$sClass&link_attr=".$aExtraParams['link_attr']."&target_class=$sTargetClass&id=$id&addObjects=true&$sContext"); }
  1099. if ($bIsBulkModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:Manage'), 'url' => "../pages/$sUIPage?operation=modify_links&class=$sClass&link_attr=".$aExtraParams['link_attr']."&target_class=$sTargetClass&id=$id&sContext"); }
  1100. //if ($bIsBulkDeleteAllowed) { $aActions[] = array ('label' => 'Remove All...', 'url' => "#"); }
  1101. }
  1102. else
  1103. {
  1104. // many objects in the set, possible actions are: new / modify all / delete all
  1105. if ($bIsModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:New'), 'url' => "../pages/$sUIPage?operation=new&class=$sClass&$sContext{$sDefault}"); }
  1106. if ($bIsBulkModifyAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:ModifyAll'), 'url' => "../pages/$sUIPage?operation=select_for_modify_all&class=$sClass&filter=$sFilter&sContext"); }
  1107. if ($bIsBulkDeleteAllowed) { $aActions[] = array ('label' => Dict::S('UI:Menu:BulkDelete'), 'url' => "../pages/$sUIPage?operation=select_for_deletion&filter=$sFilter&$sContext"); }
  1108. // Stimuli
  1109. $aStates = MetaModel::EnumStates($sClass);
  1110. if (count($aStates) > 0)
  1111. {
  1112. // Life cycle actions may be available... if all objects are in the same state
  1113. $oSet->Rewind();
  1114. $aStates = array();
  1115. while($oObj = $oSet->Fetch())
  1116. {
  1117. $aStates[$oObj->GetState()] = $oObj->GetState();
  1118. }
  1119. $oSet->Rewind();
  1120. if (count($aStates) == 1)
  1121. {
  1122. // All objects are in the same state...
  1123. $sState = array_pop($aStates);
  1124. $aTransitions = Metamodel::EnumTransitions($sClass, $sState);
  1125. if (count($aTransitions))
  1126. {
  1127. $this->AddMenuSeparator($aActions);
  1128. $aStimuli = Metamodel::EnumStimuli($sClass);
  1129. foreach($aTransitions as $sStimulusCode => $aTransitionDef)
  1130. {
  1131. $oChecker = new StimulusChecker($this->m_oFilter, $sState, $sStimulusCode);
  1132. $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? $oChecker->IsAllowed() : UR_ALLOWED_NO;
  1133. switch($iActionAllowed)
  1134. {
  1135. case UR_ALLOWED_YES:
  1136. case UR_ALLOWED_DEPENDS:
  1137. $aActions[] = array('label' => $aStimuli[$sStimulusCode]->GetLabel(), 'url' => "../pages/UI.php?operation=select_bulk_stimulus&stimulus=$sStimulusCode&state=$sState&class=$sClass&filter=$sFilter&$sContext");
  1138. break;
  1139. default:
  1140. // Do nothing
  1141. }
  1142. }
  1143. }
  1144. }
  1145. }
  1146. $this->AddMenuSeparator($aActions);
  1147. $sUrl = utils::GetAbsoluteUrlAppRoot();
  1148. $aActions[] = array ('label' => Dict::S('UI:Menu:EMail'), 'url' => "mailto:?subject=$sFilterDesc&body=".urlencode("{$sUrl}pages/$sUIPage?operation=search&filter=$sFilter&$sContext"));
  1149. $aActions[] = array ('label' => Dict::S('UI:Menu:CSVExport'), 'url' => "../pages/$sUIPage?operation=search&filter=$sFilter&format=csv&$sContext");
  1150. }
  1151. $this->AddMenuSeparator($aActions);
  1152. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  1153. {
  1154. $oSet->Rewind();
  1155. foreach($oExtensionInstance->EnumAllowedActions($oSet) as $sLabel => $sUrl)
  1156. {
  1157. $aActions[] = array ('label' => $sLabel, 'url' => $sUrl);
  1158. }
  1159. }
  1160. }
  1161. $sHtml .= "<div class=\"itop_popup\"><ul>\n<li>".Dict::S('UI:Menu:Actions')."\n<ul>\n";
  1162. foreach ($aActions as $aAction)
  1163. {
  1164. $sClass = isset($aAction['class']) ? " class=\"{$aAction['class']}\"" : "";
  1165. if (empty($aAction['url']))
  1166. {
  1167. $sHtml .= "<li>{$aAction['label']}</li>\n";
  1168. }
  1169. else
  1170. {
  1171. $sHtml .= "<li><a href=\"{$aAction['url']}\"$sClass>{$aAction['label']}</a></li>\n";
  1172. }
  1173. }
  1174. $sHtml .= "</ul>\n</li>\n</ul></div>\n";
  1175. static $bPopupScript = false;
  1176. if (!$bPopupScript)
  1177. {
  1178. // Output this once per page...
  1179. $oPage->add_ready_script("$(\"div.itop_popup>ul\").popupmenu();\n");
  1180. $bPopupScript = true;
  1181. }
  1182. return $sHtml;
  1183. }
  1184. /**
  1185. * Appends a menu separator to the current list of actions
  1186. * @param Hash $aActions The current actions list
  1187. * @return void
  1188. */
  1189. protected function AddMenuSeparator(&$aActions)
  1190. {
  1191. $sSeparator = '<hr class="menu-separator"/>';
  1192. if (count($aActions) > 0) // Make sure that the separator is not the first item in the menu
  1193. {
  1194. if ($aActions[count($aActions)-1]['label'] != $sSeparator) // Make sure there are no 2 consecutive separators
  1195. {
  1196. $aActions[] = array('label' => $sSeparator, 'url' => '');
  1197. }
  1198. }
  1199. }
  1200. }
  1201. ?>