portalwebpage.class.inc.php 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825
  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. * Class PortalWebPage
  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/nicewebpage.class.inc.php");
  25. require_once(APPROOT."/application/applicationcontext.class.inc.php");
  26. require_once(APPROOT."/application/user.preferences.class.inc.php");
  27. define('BUTTON_CANCEL', 1);
  28. define('BUTTON_BACK', 2);
  29. define('BUTTON_NEXT', 4);
  30. define('BUTTON_FINISH', 8);
  31. define('PARAM_ARROW_SEP', '_x_');
  32. class TransactionException extends Exception
  33. {
  34. }
  35. /**
  36. * Web page with some associated CSS and scripts (jquery) for a fancier display
  37. * of the Portal web page
  38. */
  39. class PortalWebPage extends NiceWebPage
  40. {
  41. /**
  42. * Portal menu
  43. */
  44. protected $m_sWelcomeMsg;
  45. protected $m_aMenuButtons;
  46. public function __construct($sTitle, $sAlternateStyleSheet = '')
  47. {
  48. $this->m_sWelcomeMsg = '';
  49. $this->m_aMenuButtons = array();
  50. parent::__construct($sTitle);
  51. $this->add_header("Content-type: text/html; charset=utf-8");
  52. $this->add_header("Cache-control: no-cache");
  53. $this->add_linked_stylesheet("../css/jquery.treeview.css");
  54. $this->add_linked_stylesheet("../css/jquery.autocomplete.css");
  55. $sAbsURLAppRoot = addslashes(utils::GetAbsoluteUrlAppRoot()); // Pass it to Javascript scripts
  56. $sAbsURLModulesRoot = addslashes(utils::GetAbsoluteUrlModulesRoot()); // Pass it to Javascript scripts
  57. $oAppContext = new ApplicationContext();
  58. $sAppContext = addslashes($oAppContext->GetForLink());
  59. if ($sAlternateStyleSheet != '')
  60. {
  61. $this->add_linked_stylesheet("../portal/$sAlternateStyleSheet/portal.css");
  62. }
  63. else
  64. {
  65. $this->add_linked_stylesheet("../portal/portal.css");
  66. }
  67. $this->add_linked_script('../js/jquery.layout.min.js');
  68. $this->add_linked_script('../js/jquery.ba-bbq.min.js');
  69. $this->add_linked_script("../js/jquery.tablehover.js");
  70. $this->add_linked_script("../js/jquery.treeview.js");
  71. $this->add_linked_script("../js/jquery.autocomplete.js");
  72. $this->add_linked_script("../js/jquery.positionBy.js");
  73. $this->add_linked_script("../js/jquery.popupmenu.js");
  74. $this->add_linked_script("../js/date.js");
  75. $this->add_linked_script("../js/jquery.tablesorter.min.js");
  76. $this->add_linked_script("../js/jquery.tablesorter.pager.js");
  77. $this->add_linked_script("../js/jquery.blockUI.js");
  78. $this->add_linked_script("../js/utils.js");
  79. $this->add_linked_script("../js/forms-json-utils.js");
  80. $this->add_linked_script("../js/swfobject.js");
  81. $this->add_linked_script("../js/jquery.qtip-1.0.min.js");
  82. $this->add_ready_script(
  83. <<<EOF
  84. try
  85. {
  86. //add new widget called TruncatedList to properly display truncated lists when they are sorted
  87. $.tablesorter.addWidget({
  88. // give the widget a id
  89. id: "truncatedList",
  90. // format is called when the on init and when a sorting has finished
  91. format: function(table)
  92. {
  93. // Check if there is a "truncated" line
  94. this.truncatedList = false;
  95. if ($("tr td.truncated",table).length > 0)
  96. {
  97. this.truncatedList = true;
  98. }
  99. if (this.truncatedList)
  100. {
  101. $("tr td",table).removeClass('truncated');
  102. $("tr:last td",table).addClass('truncated');
  103. }
  104. }
  105. });
  106. $.tablesorter.addWidget({
  107. // give the widget a id
  108. id: "myZebra",
  109. // format is called when the on init and when a sorting has finished
  110. format: function(table)
  111. {
  112. // Replace the 'red even' lines by 'red_even' since most browser do not support 2 classes selector in CSS, etc..
  113. $("tbody tr:even",table).addClass('even');
  114. $("tbody tr.red:even",table).removeClass('red').removeClass('even').addClass('red_even');
  115. $("tbody tr.orange:even",table).removeClass('orange').removeClass('even').addClass('orange_even');
  116. $("tbody tr.green:even",table).removeClass('green').removeClass('even').addClass('green_even');
  117. }
  118. });
  119. $(".date-pick").datepicker({
  120. showOn: 'button',
  121. buttonImage: '../images/calendar.png',
  122. buttonImageOnly: true,
  123. dateFormat: 'yy-mm-dd',
  124. constrainInput: false,
  125. changeMonth: true,
  126. changeYear: true
  127. });
  128. //$('.resizable').resizable(); // Make resizable everything that claims to be resizable !
  129. $('.caselog_header').click( function () { $(this).toggleClass('open').next('.caselog_entry').toggle(); });
  130. }
  131. catch(err)
  132. {
  133. // Do something with the error !
  134. alert(err);
  135. }
  136. EOF
  137. );
  138. $this->add_script(
  139. <<<EOF
  140. function CheckSelection(sMessage, sInputId)
  141. {
  142. var bResult;
  143. if (sInputId.length > 0)
  144. {
  145. bResult = ($('input[name='+sInputId+']:checked').length > 0);
  146. }
  147. else
  148. {
  149. // First select found...
  150. bResult = ($('input:checked').length > 0);
  151. }
  152. if (!bResult)
  153. {
  154. alert(sMessage);
  155. }
  156. return bResult;
  157. }
  158. function GetAbsoluteUrlAppRoot()
  159. {
  160. return '$sAbsURLAppRoot';
  161. }
  162. function GetAbsoluteUrlModulesRoot()
  163. {
  164. return '$sAbsURLModulesRoot';
  165. }
  166. function AddAppContext(sURL)
  167. {
  168. var sContext = '$sAppContext';
  169. if (sContext.length > 0)
  170. {
  171. if (sURL.indexOf('?') == -1)
  172. {
  173. return sURL+'?'+sContext;
  174. }
  175. return sURL+'&'+sContext;
  176. }
  177. return sURL;
  178. }
  179. function GoBack(sFormId)
  180. {
  181. var form = $('#'+sFormId);
  182. var step_back = $('input[name=step_back]');
  183. form.unbind('submit'); // De-activate validation
  184. step_back.val(1);
  185. form.submit(); // Go
  186. }
  187. function GoHome()
  188. {
  189. var form = $('FORM');
  190. form.unbind('submit'); // De-activate validation
  191. window.location.href = '?operation=';
  192. return false;
  193. }
  194. function SetWizardNextStep(sStep)
  195. {
  196. var next_step = $('input[id=next_step]');
  197. next_step.val(sStep);
  198. }
  199. EOF
  200. );
  201. }
  202. public function SetCurrentTab($sTabLabel = '')
  203. {
  204. }
  205. /**
  206. * Specify a welcome message (optional)
  207. */
  208. public function SetWelcomeMessage($sMsg)
  209. {
  210. $this->m_sWelcomeMsg = $sMsg;
  211. }
  212. /**
  213. * Add a button to the portal's main menu
  214. */
  215. public function AddMenuButton($sId, $sLabel, $sHyperlink)
  216. {
  217. $this->m_aMenuButtons[] = array('id' => $sId, 'label' => $sLabel, 'hyperlink' => $sHyperlink);
  218. }
  219. var $m_bEnableDisconnectButton = true;
  220. public function EnableDisconnectButton($bEnable)
  221. {
  222. $this->m_bEnableDisconnectButton = $bEnable;
  223. }
  224. public function output()
  225. {
  226. $sMenu = '';
  227. if ($this->m_bEnableDisconnectButton)
  228. {
  229. $this->AddMenuButton('logoff', 'Portal:Disconnect', utils::GetAbsoluteUrlAppRoot().'pages/logoff.php'); // This menu is always present and is the last one
  230. }
  231. foreach($this->m_aMenuButtons as $aMenuItem)
  232. {
  233. $sMenu .= "<a class=\"button\" id=\"{$aMenuItem['id']}\" href=\"{$aMenuItem['hyperlink']}\"><span>".Dict::S($aMenuItem['label'])."</span></a>";
  234. }
  235. $this->s_content = '<div id="portal"><div id="welcome">'.$this->m_sWelcomeMsg.'</div><div id="banner"><div id="logo"></div><div id="menu">'.$sMenu.'</div></div><div id="content">'.$this->s_content.'</div></div>';
  236. parent::output();
  237. }
  238. /**
  239. * Displays a list of objects, without any hyperlink (except for the object's details)
  240. * @param DBObjectSet $oSet The set of objects to display
  241. * @param Array $aZList The ZList (list of field codes) to use for the tabular display
  242. * @param String $sEmptyListMessage Message displayed whenever the list is empty
  243. * @return string The HTML text representing the list
  244. */
  245. public function DisplaySet($oSet, $aZList, $sEmptyListMessage = '')
  246. {
  247. if ($oSet->Count() > 0)
  248. {
  249. $sClass = $oSet->GetClass();
  250. if (is_subclass_of($sClass, 'cmdbAbstractObject'))
  251. {
  252. // Home-made and very limited display of an object set
  253. $sUniqueId = $sClass.$this->GetUniqueId();
  254. $this->add("<div id=\"$sUniqueId\">\n"); // The id here MUST be the same as currentId, otherwise the pagination will be broken
  255. cmdbAbstractObject::DisplaySet($this, $oSet, array('currentId' => $sUniqueId, 'menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList)));
  256. $this->add("</div>\n");
  257. }
  258. else
  259. {
  260. // Home-made and very limited display of an object set
  261. $aAttribs = array();
  262. $aValues = array();
  263. $aAttribs['key'] = array('label' => MetaModel::GetName($sClass), 'description' => '');
  264. foreach($aZList as $sAttCode)
  265. {
  266. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  267. $aAttribs[$sAttCode] = array('label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
  268. }
  269. while($oObj = $oSet->Fetch())
  270. {
  271. $aRow = array();
  272. $aRow['key'] = '<a href="./index.php?operation=details&class='.get_class($oObj).'&id='.$oObj->GetKey().'">'.$oObj->GetName().'</a>';
  273. $sHilightClass = $oObj->GetHilightClass();
  274. if ($sHilightClass != '')
  275. {
  276. $aRow['@class'] = $sHilightClass;
  277. }
  278. foreach($aZList as $sAttCode)
  279. {
  280. $aRow[$sAttCode] = $oObj->GetAsHTML($sAttCode);
  281. }
  282. $aValues[$oObj->GetKey()] = $aRow;
  283. }
  284. $this->table($aAttribs, $aValues);
  285. }
  286. }
  287. elseif (strlen($sEmptyListMessage) > 0)
  288. {
  289. $this->add($sEmptyListMessage);
  290. }
  291. }
  292. /**
  293. * Display the attributes of an object (no title, no form)
  294. * @param Object $oObj Any kind of object
  295. * @param aAttList The list of attributes to display
  296. * @return void
  297. */
  298. public function DisplayObjectDetails($oObj, $aAttList)
  299. {
  300. $sClass = get_class($oObj);
  301. $aDetails = array();
  302. foreach($aAttList as $sAttCode)
  303. {
  304. $iFlags = $oObj->GetAttributeFlags($sAttCode);
  305. $oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
  306. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  307. {
  308. // Don't display linked set and non-visible attributes (in this state)
  309. $sDisplayValue = $oObj->GetAsHTML($sAttCode);
  310. $aDetails[] = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  311. }
  312. }
  313. $this->details($aDetails);
  314. }
  315. /**
  316. * DisplayObjectLinkset
  317. * @param Object $oObj Any kind of object
  318. * @param $sLinkSetAttCode The attribute code of the link set attribute to display
  319. * @param $sRemoteAttCode The external key on the linked class, pointing to the remote objects
  320. * @param $aZList The list of attribute of the remote object
  321. * @param $sEmptyListMessage The message to display if the list is empty
  322. * @return void
  323. */
  324. public function DisplayObjectLinkset($oObj, $sLinkSetAttCode, $sRemoteAttCode, $aZList, $sEmptyListMessage = '', $oSearchRestriction = null)
  325. {
  326. if (empty($sEmptyListMessage))
  327. {
  328. $sEmptyListMessage = Dict::S('UI:Search:NoObjectFound');
  329. }
  330. $oLinkSet = $oObj->Get($sLinkSetAttCode);
  331. if ($oLinkSet->Count() > 0)
  332. {
  333. $sClass = $oLinkSet->GetClass();
  334. $oExtKeyToRemote = MetaModel::GetAttributeDef($sClass, $sRemoteAttCode);
  335. $sRemoteClass = $oExtKeyToRemote->GetTargetClass();
  336. if (is_null($oSearchRestriction))
  337. {
  338. $oObjSearch = new DBObjectSearch($sRemoteClass);
  339. }
  340. else
  341. {
  342. $oObjSearch = $oSearchRestriction;
  343. }
  344. $oObjSearch->AddCondition_ReferencedBy($oLinkSet->GetFilter(), $sRemoteAttCode);
  345. $aExtraParams = array('menu' => false, 'zlist' => false, 'extra_fields' => implode(',', $aZList));
  346. $oBlock = new DisplayBlock($oObjSearch, 'list', false);
  347. $oBlock->Display($this, 1, $aExtraParams);
  348. }
  349. elseif (strlen($sEmptyListMessage) > 0)
  350. {
  351. $this->add($sEmptyListMessage);
  352. }
  353. }
  354. protected function DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix, $sFieldName = null)
  355. {
  356. if (is_null($sFieldName))
  357. {
  358. $sFieldName = str_replace('->', PARAM_ARROW_SEP, $sAttSpec);
  359. }
  360. $iPos = strpos($sAttSpec, '->');
  361. if ($iPos !== false)
  362. {
  363. $sAttCode = substr($sAttSpec, 0, $iPos);
  364. $sSubSpec = substr($sAttSpec, $iPos + 2);
  365. if (!MetaModel::IsValidAttCode($sClass, $sAttCode))
  366. {
  367. throw new Exception("Invalid attribute code '$sClass/$sAttCode' in search specification '$sAttSpec'");
  368. }
  369. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  370. if ($oAttDef->IsLinkSet())
  371. {
  372. $sTargetClass = $oAttDef->GetLinkedClass();
  373. }
  374. elseif ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  375. {
  376. $sTargetClass = $oAttDef->GetTargetClass(EXTKEY_ABSOLUTE);
  377. }
  378. else
  379. {
  380. throw new Exception("Attribute specification '$sAttSpec', '$sAttCode' should be either a link set or an external key");
  381. }
  382. $this->DisplaySearchField($sTargetClass, $sSubSpec, $aExtraParams, $sPrefix, $sFieldName);
  383. }
  384. else
  385. {
  386. // $sAttSpec is an attribute code
  387. //
  388. $this->add('<span style="white-space: nowrap;padding:5px;display:inline-block;">');
  389. $sFilterValue = '';
  390. $sFilterValue = utils::ReadParam($sPrefix.$sFieldName, '', false, 'raw_data');
  391. $sFilterOpCode = null; // Use the default 'loose' OpCode
  392. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttSpec);
  393. if ($oAttDef->IsExternalKey())
  394. {
  395. $sTargetClass = $oAttDef->GetTargetClass();
  396. $oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
  397. $iFieldSize = $oAttDef->GetMaxSize();
  398. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  399. $this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;");
  400. //$oWidget = UIExtKeyWidget::DIsplayFromAttCode($sAttSpec, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sPrefix.$sFieldName, false, '', $sPrefix, '');
  401. //$this->add($oWidget->Display($this, $aExtraParams, true /* bSearchMode */));
  402. $aExtKeyParams = $aExtraParams;
  403. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  404. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  405. // DisplayFromAttCode($this, $sAttCode, $sClass, $sTitle, $oAllowedValues, $value, $iInputId, $bMandatory, $sFieldName = '', $sFormPrefix = '', $aArgs, $bSearchMode = false)
  406. $sHtml = UIExtKeyWidget::DisplayFromAttCode($this, $sAttSpec, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sPrefix.$sFieldName, false, $sPrefix.$sFieldName, $sPrefix, $aExtKeyParams, true);
  407. $this->add($sHtml);
  408. }
  409. else
  410. {
  411. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClass, $sAttSpec, $aExtraParams);
  412. if (is_null($aAllowedValues))
  413. {
  414. // Any value is possible, display an input box
  415. $this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;<input class=\"textSearch\" name=\"$sPrefix$sFieldName\" value=\"$sFilterValue\"/>\n");
  416. }
  417. else
  418. {
  419. //Enum field or external key, display a combo
  420. $sValue = "<select name=\"$sPrefix$sFieldName\">\n";
  421. $sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  422. foreach($aAllowedValues as $key => $value)
  423. {
  424. if ($sFilterValue == $key)
  425. {
  426. $sSelected = ' selected';
  427. }
  428. else
  429. {
  430. $sSelected = '';
  431. }
  432. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  433. }
  434. $sValue .= "</select>\n";
  435. $this->add("<label>".MetaModel::GetFilterLabel($sClass, $sAttSpec).":</label>&nbsp;$sValue\n");
  436. }
  437. }
  438. unset($aExtraParams[$sFieldName]);
  439. $this->add('</span> ');
  440. $sTip = $oAttDef->GetHelpOnSmartSearch();
  441. if (strlen($sTip) > 0)
  442. {
  443. $sTip = addslashes($sTip);
  444. $sTip = str_replace(array("\n", "\r"), " ", $sTip);
  445. // :input does represent in form visible input (INPUT, SELECT, TEXTAREA)
  446. $this->add_ready_script("$(':input[name={$sPrefix}$sFieldName]').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  447. }
  448. }
  449. }
  450. public function DisplaySearchForm($sClass, $aAttList, $aExtraParams, $sPrefix, $bClosed = true)
  451. {
  452. $sCSSClass = ($bClosed) ? 'DrawerClosed' : '';
  453. $this->add("<div id=\"ds_$sPrefix\" class=\"SearchDrawer $sCSSClass\">\n");
  454. $this->add_ready_script(
  455. <<<EOF
  456. $("#dh_$sPrefix").click( function() {
  457. $("#ds_$sPrefix").slideToggle('normal', function() { $("#ds_$sPrefix").parent().resize(); } );
  458. $("#dh_$sPrefix").toggleClass('open');
  459. });
  460. EOF
  461. );
  462. $this->add("<form id=\"search_$sClass\" action=\"\" method=\"post\">\n"); // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  463. // $this->add("<h2>".Dict::Format('UI:SearchFor_Class_Objects', 'xxxxxx')."</h2>\n");
  464. $this->add("<p>\n");
  465. foreach($aAttList as $sAttSpec)
  466. {
  467. //$oAppContext->Reset($sAttSpec); // Make sure the same parameter will not be passed twice
  468. $this->DisplaySearchField($sClass, $sAttSpec, $aExtraParams, $sPrefix);
  469. }
  470. $this->add("</p>\n");
  471. $this->add("<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n");
  472. foreach($aExtraParams as $sName => $sValue)
  473. {
  474. $this->add("<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n");
  475. }
  476. // $this->add($oAppContext->GetForForm());
  477. $this->add("</form>\n");
  478. $this->add("</div>\n");
  479. $this->add("<div class=\"HRDrawer\"></div>\n");
  480. $this->add("<div id=\"dh_$sPrefix\" class=\"DrawerHandle\">".Dict::S('UI:SearchToggle')."</div>\n");
  481. }
  482. /**
  483. * Read parameters from the page
  484. * Parameters that were absent from the page's parameters are not set in the resulting hash array
  485. * @input string $sMethod Either get or post
  486. * @return Hash Array of name => value corresponding to the parameters that were passed to the page
  487. */
  488. public function ReadAllParams($sParamList, $sPrefix = 'attr_')
  489. {
  490. $aParams = explode(',', $sParamList);
  491. $aValues = array();
  492. foreach($aParams as $sName)
  493. {
  494. $sName = trim($sName);
  495. $value = utils::ReadParam($sPrefix.$sName, null, false, 'raw_data');
  496. if (!is_null($value))
  497. {
  498. $aValues[$sName] = $value;
  499. }
  500. }
  501. return $aValues;
  502. }
  503. /**
  504. * Outputs a list of parameters as hidden fields
  505. * Example: attr_dummy[-123][id] = "blah"
  506. * @param Hash $aParameters Array name => value for the parameters
  507. * @param Array $aExclude The list of parameters that must not be handled this way (probably already in the visible part of the form)
  508. * @return void
  509. */
  510. protected function DumpHiddenParamsInternal($sName, $value)
  511. {
  512. if (is_array($value))
  513. {
  514. foreach($value as $sKey => $item)
  515. {
  516. $this->DumpHiddenParamsInternal($sName.'['.$sKey.']', $item);
  517. }
  518. }
  519. else
  520. {
  521. $this->Add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">");
  522. }
  523. }
  524. /**
  525. * Outputs a list of parameters as hidden field into the current page
  526. * (must be called when inside a form)
  527. * @param Hash $aParameters Array name => value for the parameters
  528. * @param Array $aExclude The list of parameters that must not be handled this way (probably already in the visible part of the form)
  529. * @return void
  530. */
  531. public function DumpHiddenParams($aParameters, $aExclude = null, $sPrefix = 'attr_')
  532. {
  533. foreach($aParameters as $sAttCode => $value)
  534. {
  535. if (is_null($aExclude) || !in_array($sAttCode, $aExclude))
  536. {
  537. $this->DumpHiddenParamsInternal($sPrefix.$sAttCode, $value);
  538. }
  539. }
  540. }
  541. public function PostedParamsToFilter($sClass, $aAttList, $sPrefix)
  542. {
  543. $oFilter = new DBObjectSearch($sClass);
  544. $iCountParams = 0;
  545. foreach($aAttList as $sAttSpec)
  546. {
  547. $sFieldName = str_replace('->', PARAM_ARROW_SEP, $sAttSpec);
  548. $value = utils::ReadPostedParam($sPrefix.$sFieldName, null, 'raw_data');
  549. if (!is_null($value) && strlen($value) > 0)
  550. {
  551. $oFilter->AddConditionAdvanced($sAttSpec, $value);
  552. $iCountParams++;
  553. }
  554. }
  555. if ($iCountParams == 0)
  556. {
  557. return null;
  558. }
  559. else
  560. {
  561. return $oFilter;
  562. }
  563. }
  564. /**
  565. * Updates the object form POSTED arguments, and writes it into the DB (applies a stimuli if requested)
  566. * @param DBObject $oObj The object to update
  567. * $param array $aAttList If set, this will limit the list of updated attributes
  568. * @return void
  569. */
  570. public function DoUpdateObjectFromPostedForm(DBObject $oObj, $aAttList = null)
  571. {
  572. $sTransactionId = utils::ReadPostedParam('transaction_id', '');
  573. if (!utils::IsTransactionValid($sTransactionId))
  574. {
  575. throw new TransactionException();
  576. }
  577. $sClass = get_class($oObj);
  578. $sStimulus = trim(utils::ReadPostedParam('apply_stimulus', ''));
  579. $sTargetState = '';
  580. if (!empty($sStimulus))
  581. {
  582. // Compute the target state
  583. $aTransitions = $oObj->EnumTransitions();
  584. if (!isset($aTransitions[$sStimulus]))
  585. {
  586. throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
  587. }
  588. $sTargetState = $aTransitions[$sStimulus]['target_state'];
  589. }
  590. $oObj->UpdateObjectFromPostedForm('' /* form prefix */, $aAttList, $sTargetState);
  591. // Optional: apply a stimulus
  592. //
  593. if (!empty($sStimulus))
  594. {
  595. if (!$oObj->ApplyStimulus($sStimulus))
  596. {
  597. throw new Exception("Cannot apply stimulus '$sStimulus' to {$oObj->GetName()}");
  598. }
  599. }
  600. // Record the change
  601. //
  602. $oObj->DBUpdate();
  603. // Trigger ?
  604. //
  605. $aClasses = MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL);
  606. $sClassList = implode(", ", CMDBSource::Quote($aClasses));
  607. $oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnPortalUpdate AS t WHERE t.target_class IN ($sClassList)"));
  608. while ($oTrigger = $oSet->Fetch())
  609. {
  610. $oTrigger->DoActivate($oObj->ToArgs('this'));
  611. }
  612. $this->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oObj)), $oObj->GetName())."</h1>\n");
  613. }
  614. /**
  615. * Find the object of the specified Class/ID.
  616. * @param WebPage $oP The current page
  617. * @return DBObject The found object, or throws an exception in case of failure
  618. */
  619. public function FindObjectFromArgs($aAllowedClasses = null)
  620. {
  621. $sClass = utils::ReadParam('class', '', true, 'class');
  622. $iId = utils::ReadParam('id', 0, true, 'integer');
  623. if (empty($sClass))
  624. {
  625. throw new Exception("Missing argument 'class'");
  626. }
  627. if (!MetaModel::IsValidClass($sClass))
  628. {
  629. throw new Exception("Wrong value for argument 'class': $sClass");
  630. }
  631. if ($iId == 0)
  632. {
  633. throw new Exception("Missing argument 'id'");
  634. }
  635. if(!is_null($aAllowedClasses))
  636. {
  637. $bAllowed = false;
  638. foreach($aAllowedClasses as $sParentClass)
  639. {
  640. if (MetaModel::IsParentClass($sParentClass, $sClass))
  641. {
  642. $bAllowed = true;
  643. }
  644. }
  645. if (!$bAllowed)
  646. {
  647. throw new Exception("Class '$sClass not allowed in this implementation'");
  648. }
  649. }
  650. $oObj = MetaModel::GetObject($sClass, $iId, false);
  651. if (!is_object($oObj))
  652. {
  653. throw new Exception("Could not find the object $sClass/$iId");
  654. }
  655. return $oObj;
  656. }
  657. var $m_sWizardId = null;
  658. public function WizardFormStart($sId = '', $sNextStep = null, $bAttachment = false, $sMethod = 'post')
  659. {
  660. $this->m_sWizardId = $sId;
  661. // multipart... needed for file upload
  662. $this->add("<form id=\"{$this->m_sWizardId}\" method=\"$sMethod\" enctype=\"multipart/form-data\">\n");
  663. $aPreviousSteps = $this->GetWizardStepHistory();
  664. if (utils::ReadParam('step_back', 0) == 1)
  665. {
  666. // Back into the past history
  667. array_pop($aPreviousSteps);
  668. }
  669. else
  670. {
  671. // Moving forward
  672. array_push($aPreviousSteps, utils::ReadParam('next_step'));
  673. }
  674. $sStepHistory = implode(',', $aPreviousSteps);
  675. $this->add("<input type=\"hidden\" id=\"step_history\" name=\"step_history\" value=\"$sStepHistory\">");
  676. if (!is_null($sNextStep))
  677. {
  678. $this->add("<input type=\"hidden\" id=\"next_step\" name=\"next_step\" value=\"$sNextStep\">");
  679. }
  680. $this->add("<input type=\"hidden\" id=\"step_back\" name=\"step_back\" value=\"0\">");
  681. $sTransactionId = utils::GetNewTransactionId();
  682. $this->SetTransactionId($sTransactionId);
  683. $this->add("<input type=\"hidden\" id=\"transaction_id\" name=\"transaction_id\" value=\"$sTransactionId\">\n");
  684. $this->add_ready_script("$(window).unload(function() { OnUnload('$sTransactionId') } );\n");
  685. }
  686. public function WizardFormButtons($iButtonFlags)
  687. {
  688. $aButtons = array();
  689. if ($iButtonFlags & BUTTON_CANCEL)
  690. {
  691. $aButtons[] = "<input id=\"btn_cancel\" type=\"button\" value=\"".Dict::S('UI:Button:Cancel')."\" onClick=\"GoHome();\">";
  692. }
  693. if ($iButtonFlags & BUTTON_BACK)
  694. {
  695. $aButtons[] = "<input id=\"btn_back\" type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\" onClick=\"GoBack('{$this->m_sWizardId}');\">";
  696. }
  697. if ($iButtonFlags & BUTTON_NEXT)
  698. {
  699. $aButtons[] = "<input id=\"btn_next\" type=\"submit\" value=\"".Dict::S('UI:Button:Next')."\">";
  700. }
  701. if ($iButtonFlags & BUTTON_FINISH)
  702. {
  703. $aButtons[] = "<input id=\"btn_finish\" type=\"submit\" value=\"".Dict::S('UI:Button:Finish')."\">";
  704. }
  705. $this->add('<div id="buttons">');
  706. $this->add(implode('', $aButtons));
  707. $this->add('</div>');
  708. }
  709. public function WizardFormEnd()
  710. {
  711. $this->add("</form>\n");
  712. }
  713. public function GetWizardStep()
  714. {
  715. if (utils::ReadParam('step_back', 0) == 1)
  716. {
  717. // Take the value into the history - one level above
  718. $aPreviousSteps = $this->GetWizardStepHistory();
  719. array_pop($aPreviousSteps);
  720. return end($aPreviousSteps);
  721. }
  722. else
  723. {
  724. return utils::ReadParam('next_step');
  725. }
  726. }
  727. protected function GetWizardStepHistory()
  728. {
  729. $sRawHistory = trim(utils::ReadParam('step_history', '', false, 'raw_data'));
  730. if (strlen($sRawHistory) == 0)
  731. {
  732. return array();
  733. }
  734. else
  735. {
  736. return explode(',', $sRawHistory);
  737. }
  738. }
  739. public function WizardCheckSelectionOnSubmit($sMessageIfNoSelection, $sInputName = '')
  740. {
  741. $this->add_ready_script(
  742. <<<EOF
  743. $('#{$this->m_sWizardId}').submit(function() {
  744. return CheckSelection('$sMessageIfNoSelection', '$sInputName');
  745. });
  746. EOF
  747. );
  748. }
  749. }
  750. ?>