portalwebpage.class.inc.php 26 KB

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