portalwebpage.class.inc.php 26 KB

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