portalwebpage.class.inc.php 25 KB

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