index.php 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832
  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. * iTop User Portal main page
  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.inc.php');
  25. require_once(APPROOT.'/application/application.inc.php');
  26. require_once(APPROOT.'/application/nicewebpage.class.inc.php');
  27. require_once(APPROOT.'/application/wizardhelper.class.inc.php');
  28. /**
  29. * Get the list of parameters (i.e. attribute codes) to be handled while creating a new UserRequest object
  30. * @return Array The list of attribute codes
  31. */
  32. function GetParamsList()
  33. {
  34. return array('org_id', 'caller_id', 'service_id', 'servicesubcategory_id', 'request_type', 'title', 'description', 'impact', 'urgency', 'workgroup_id');
  35. }
  36. /**
  37. * Outputs a list of parameters as hidden field into the current page
  38. * (must be called when inside a form)
  39. * @param WebPage $oP The current web page
  40. * @param Array $aInteractive The list of parameters that are handled intractively and thus should not be output as hidden fields
  41. * @param Hash $aParameters Array name => value for the parameters
  42. * @return void
  43. */
  44. function DumpHiddenParams($oP, $aInteractive, $aParameters)
  45. {
  46. foreach($aParameters as $sAttCode => $value)
  47. {
  48. if (!in_array($sAttCode, $aInteractive))
  49. {
  50. $oP->Add("<input type=\"hidden\" name=\"attr_$sAttCode\" value=\"$value\">");
  51. }
  52. }
  53. }
  54. /**
  55. * Read all the parameters of the page for building a UserRequest
  56. * Parameters that were absent from the page's parameters are not set in the resulting hash array
  57. * @input string $sMethod Either get or post
  58. * @return Hash Array of name => value corresponding to the parameters that were passed to the page
  59. */
  60. function ReadAllParams($sMethod = 'get')
  61. {
  62. $aParams = GetParamsList();
  63. $aValues = array();
  64. foreach($aParams as $sName)
  65. {
  66. $value = utils::ReadParam('attr_'.$sName, null, $sMethod);
  67. if (!is_null($value))
  68. {
  69. $aValues[$sName] = $value;
  70. }
  71. }
  72. return $aValues;
  73. }
  74. /**
  75. * Displays the portal main menu
  76. * @param WebPage $oP The current web page
  77. * @return void
  78. */
  79. function DisplayMainMenu(WebPage $oP)
  80. {
  81. $oP->AddMenuButton('refresh', 'Portal:Refresh', './index.php?operation=welcome');
  82. $oP->AddMenuButton('create', 'Portal:CreateNewRequest', './index.php?operation=create_request');
  83. $oP->AddMenuButton('change_pwd', 'Portal:ChangeMyPassword', './index.php?loginop=change_pwd');
  84. $oP->add("<div id=\"#div_resolved_requests\">\n");
  85. $oP->add("<h1 id=\"#open_requests\">".Dict::S('Portal:OpenRequests')."</h1>\n");
  86. ListOpenRequests($oP);
  87. $oP->add("</div>\n");
  88. $oP->add("<div id=\"#div_resolved_requests\">\n");
  89. $oP->add("<h1 id=\"#resolved_requests\">".Dict::S('Portal:ResolvedRequests')."</h1>\n");
  90. ListResolvedRequests($oP);
  91. $oP->add("</div>\n");
  92. }
  93. /**
  94. * Displays the form to select a Service Id (among the valid ones for the specified user Organization)
  95. * @param WebPage $oP Web page for the form output
  96. * @param Organization $oUserOrg The organization of the current user
  97. * @return void
  98. */
  99. function SelectService($oP, $oUserOrg)
  100. {
  101. // Init forms parameters
  102. $aParameters = ReadAllParams();
  103. $oSearch = DBObjectSearch::FromOQL('SELECT Service AS s JOIN SLA AS sla ON sla.service_id=s.id JOIN lnkContractToSLA AS ln ON ln.sla_id=sla.id JOIN CustomerContract AS cc ON ln.contract_id=cc.id WHERE cc.org_id = :org_id');
  104. $oSet = new CMDBObjectSet($oSearch, array(), array('org_id' => $oUserOrg->GetKey()));
  105. $oP->add("<div class=\"wizContainer\" id=\"form_select_service\">\n");
  106. $oP->add("<h1 id=\"select_subcategory\">".Dict::S('Portal:SelectService')."</h1>\n");
  107. $oP->add("<form action=\"../portal/index.php\" id=\"request_form\" method=\"get\">\n");
  108. $oP->add("<table>\n");
  109. while($oService = $oSet->Fetch())
  110. {
  111. $id = $oService->GetKey();
  112. $sChecked = "";
  113. if ($id == $aParameters['service_id'])
  114. {
  115. $sChecked = "checked";
  116. }
  117. $oP->p("<tr><td style=\"vertical-align:top\"><p><input name=\"attr_service_id\" $sChecked type=\"radio\" id=\"svc_$id\" value=\"$id\"></p></td><td style=\"vertical-align:top\"><p><b><label for=\"svc_$id\">".htmlentities($oService->GetName(), ENT_QUOTES, 'UTF-8')."</label></b></p>");
  118. $oP->p("<p>".htmlentities($oService->Get('description'), ENT_QUOTES, 'UTF-8')."</p></td></tr>");
  119. }
  120. $oP->add("</table>\n");
  121. DumpHiddenParams($oP, array('service_id'), $aParameters);
  122. $oP->add("<input type=\"hidden\" name=\"step\" value=\"1\">");
  123. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"create_request\">");
  124. $oP->p("<input type=\"submit\" value=\"".Dict::S('UI:Button:Next')."\">");
  125. $oP->add("</form>");
  126. $oP->add("</div class=\"wizContainer\">\n");
  127. $sMessage = Dict::S('Portal:PleaseSelectOneService');
  128. $oP->add_ready_script(
  129. <<<EOF
  130. $('#request_form').submit(function() {
  131. return CheckSelection('$sMessage');
  132. });
  133. EOF
  134. );
  135. }
  136. /**
  137. * Displays the form to select a Service Subcategory Id (among the valid ones for the specified user Organization)
  138. * and based on the page's parameter 'service_id'
  139. * @param WebPage $oP Web page for the form output
  140. * @param Organization $oUserOrg The organization of the current user
  141. * @return void
  142. */
  143. function SelectSubService($oP, $oUserOrg)
  144. {
  145. // Init forms parameters
  146. $aParameters = ReadAllParams();
  147. $iSvcId = $aParameters['service_id'];
  148. $iDefaultSubSvcId = isset($aParameters['servicesubcategory_id']) ? $aParameters['servicesubcategory_id'] : 0;
  149. $oSearch = DBObjectSearch::FromOQL('SELECT ServiceSubcategory AS ss WHERE ss.service_id = :svc_id');
  150. $oSet = new CMDBObjectSet($oSearch, array(), array('svc_id' => $iSvcId));
  151. $oService = MetaModel::GetObject('Service', $iSvcId, false);
  152. if (is_object($oService))
  153. {
  154. $oP->add("<div class=\"wizContainer\" id=\"form_select_servicesubcategory\">\n");
  155. $oP->add("<h1 id=\"select_subcategory\">".Dict::Format('Portal:SelectSubcategoryFrom_Service', htmlentities($oService->GetName(), ENT_QUOTES, 'UTF-8'))."</h1>\n");
  156. $oP->add("<form id=\"request_form\" method=\"get\">\n");
  157. $oP->add("<table>\n");
  158. while($oSubService = $oSet->Fetch())
  159. {
  160. $id = $oSubService->GetKey();
  161. $sChecked = "";
  162. if ($id == $iDefaultSubSvcId)
  163. {
  164. $sChecked = "checked";
  165. }
  166. $oP->p("<tr><td style=\"vertical-align:top\"><p><input name=\"attr_servicesubcategory_id\" $sChecked type=\"radio\" id=\"subsvc_$id\" value=\"$id\"></p></td><td style=\"vertical-align:top\"><p><b><label for=\"subsvc_$id\">".htmlentities($oSubService->GetName(), ENT_QUOTES, 'UTF-8')."</label></b></p>");
  167. $oP->p("<p>".htmlentities($oSubService->Get('description'), ENT_QUOTES, 'UTF-8')."</p></td></tr>");
  168. }
  169. $sMessage = Dict::S('Portal:PleaseSelectAServiceSubCategory');
  170. $oP->add_ready_script(
  171. <<<EOF
  172. $('#request_form').submit(function() {
  173. return CheckSelection('$sMessage');
  174. });
  175. EOF
  176. );
  177. $oP->add("</table>\n");
  178. DumpHiddenParams($oP, array('servicesubcategory_id'), $aParameters);
  179. $oP->add("<input type=\"hidden\" name=\"step\" value=\"2\">");
  180. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"create_request\">");
  181. $oP->p("<input type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\" onClick=\"GoBack();\">&nbsp;<input type=\"submit\" value=\"".Dict::S('UI:Button:Next')."\">");
  182. $oP->add("</form>");
  183. $oP->add("</div>\n");
  184. }
  185. else
  186. {
  187. $oP->p("Error: Invalid Service: id = $iSvcId");
  188. }
  189. }
  190. /**
  191. * Displays the form for the final step of the UserRequest creation
  192. * @param WebPage $oP The current web page for the form output
  193. * @param Organization $oUserOrg The organization of the current user
  194. * @return void
  195. */
  196. function RequestCreationForm($oP, $oUserOrg)
  197. {
  198. $aList = array('request_type', 'title', 'description', 'impact', 'urgency', 'workgroup_id');
  199. $aParameters = ReadAllParams();
  200. $oService = MetaModel::GetObject('Service', $aParameters['service_id'], false);
  201. $oSubService = MetaModel::GetObject('ServiceSubcategory', $aParameters['servicesubcategory_id'], false);
  202. if (is_object($oService) && is_object($oSubService))
  203. {
  204. $oRequest = new UserRequest();
  205. $oRequest->Set('org_id', $oUserOrg->GetKey());
  206. $oRequest->Set('caller_id', UserRights::GetContactId());
  207. $oRequest->Set('service_id', $aParameters['service_id']);
  208. $oRequest->Set('servicesubcategory_id', $aParameters['servicesubcategory_id']);
  209. $oAttDef = MetaModel::GetAttributeDef('UserRequest', 'service_id');
  210. $aDetails[] = array('label' => $oAttDef->GetLabel(), 'value' => htmlentities($oService->GetName(), ENT_QUOTES, 'UTF-8'));
  211. $oAttDef = MetaModel::GetAttributeDef('UserRequest', 'servicesubcategory_id');
  212. $aDetails[] = array('label' => $oAttDef->GetLabel(), 'value' => htmlentities($oSubService->GetName(), ENT_QUOTES, 'UTF-8'));
  213. $iFlags = 0;
  214. foreach($aList as $sAttCode)
  215. {
  216. $value = '';
  217. if (isset($aParameters[$sAttCode]))
  218. {
  219. $value = $aParameters[$sAttCode];
  220. $oRequest->Set($sAttCode, $value);
  221. }
  222. }
  223. foreach($aList as $sAttCode)
  224. {
  225. $value = '';
  226. $oAttDef = MetaModel::GetAttributeDef(get_class($oRequest), $sAttCode);
  227. $iFlags = $oRequest->GetAttributeFlags($sAttCode);
  228. if (isset($aParameters[$sAttCode]))
  229. {
  230. $value = $aParameters[$sAttCode];
  231. }
  232. $aArgs = array('this' => $oRequest);
  233. $sValue = $oRequest->GetFormElementForField($oP, get_class($oRequest), $sAttCode, $oAttDef, $value, '', 'attr_'.$sAttCode, '', $iFlags, $aArgs);
  234. $aDetails[] = array('label' => $oAttDef->GetLabel(), 'value' => $sValue);
  235. }
  236. $oP->add("<div class=\"wizContainer\" id=\"form_request_description\">\n");
  237. $oP->add("<h1 id=\"title_request_form\">".Dict::S('Portal:DescriptionOfTheRequest')."</h1>\n");
  238. $oP->add("<form action=\"../portal/index.php\" id=\"request_form\" method=\"post\">\n");
  239. $oP->add("<table>\n");
  240. $oP->details($aDetails);
  241. DumpHiddenParams($oP, $aList, $aParameters);
  242. $oP->add("<input type=\"hidden\" name=\"step\" value=\"3\">");
  243. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"create_request\">");
  244. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  245. $oP->p("<input type=\"submit\" value=\"".Dict::S('UI:Button:Back')."\" onClick=\"GoBack();\">&nbsp;<input type=\"submit\" value=\"".Dict::S('UI:Button:Finish')."\">");
  246. $oP->add("</form>");
  247. $oP->add("</div>\n");
  248. $oP->add_ready_script(
  249. <<<EOF
  250. // Starts the validation when the page is ready
  251. CheckFields('request_form', false);
  252. $('#request_form').submit( function() {
  253. return CheckFields('request_form', true);
  254. });
  255. EOF
  256. );
  257. }
  258. else
  259. {
  260. // User not authorized to use this service ?
  261. DisplayMainMenu($oP);
  262. }
  263. }
  264. /**
  265. * Validate the parameters and create the UserRequest object (based on the page's POSTed parameters)
  266. * @param WebPage $oP The current web page for the output
  267. * @param Organization $oUserOrg The organization of the current user
  268. * @return void
  269. */
  270. function DoCreateRequest($oP, $oUserOrg)
  271. {
  272. $aParameters = ReadAllParams();
  273. $sTransactionId = utils::ReadPostedParam('transaction_id', '');
  274. if (!utils::IsTransactionValid($sTransactionId))
  275. {
  276. $oP->add("<h1>".Dict::S('UI:Error:ObjectAlreadyCreated')."</h1>\n");
  277. DisplayMainMenu($oP);
  278. return;
  279. }
  280. // Validate the parameters
  281. // 1) Service
  282. $oSearch = DBObjectSearch::FromOQL('SELECT Service AS s JOIN SLA AS sla ON sla.service_id=s.id JOIN lnkContractToSLA AS ln ON ln.sla_id=sla.id JOIN CustomerContract AS cc ON ln.contract_id=cc.id WHERE cc.org_id = :org_id AND s.id = :svc_id');
  283. $oSet = new CMDBObjectSet($oSearch, array(), array('org_id' => $oUserOrg->GetKey(), 'svc_id' => $aParameters['service_id']));
  284. if ($oSet->Count() != 1)
  285. {
  286. // Invalid service for the current user !
  287. throw new Exception("Invalid Service: id={$aParameters['servicesubcategory_id']} for the current user (org_id=".$oUserOrg->GetKey().").");
  288. }
  289. $oService = $oSet->Fetch();
  290. // 2) Service Subcategory
  291. $oSearch = DBObjectSearch::FromOQL('SELECT ServiceSubcategory AS sc WHERE sc.id = :subcategory_id AND sc.service_id = :svc_id');
  292. $oSet = new CMDBObjectSet($oSearch, array(), array('svc_id' => $aParameters['service_id'], 'subcategory_id' =>$aParameters['servicesubcategory_id'] ));
  293. if ($oSet->Count() != 1)
  294. {
  295. // Invalid subcategory
  296. throw new Exception("Invalid ServiceSubcategory: id={$aParameters['servicesubcategory_id']} for service ".$oService->GetName()."({$aParameters['service_id']})");
  297. }
  298. $oRequest = new UserRequest();
  299. $oRequest->Set('org_id', $oUserOrg->GetKey());
  300. $oRequest->Set('caller_id', UserRights::GetContactId());
  301. $aList = array('service_id', 'servicesubcategory_id', 'request_type', 'title', 'description', 'impact', 'urgency', 'workgroup_id');
  302. foreach($aList as $sAttCode)
  303. {
  304. $oRequest->Set($sAttCode, $aParameters[$sAttCode]);
  305. }
  306. list($bRes, $aIssues) = $oRequest->CheckToWrite();
  307. if ($bRes)
  308. {
  309. $oMyChange = MetaModel::NewObject("CMDBChange");
  310. $oMyChange->Set("date", time());
  311. $sUserString = CMDBChange::GetCurrentUserName();
  312. $oMyChange->Set("userinfo", $sUserString);
  313. $iChangeId = $oMyChange->DBInsert();
  314. $oRequest->DBInsertTracked($oMyChange);
  315. $oP->add("<h1>".Dict::Format('UI:Title:Object_Of_Class_Created', $oRequest->GetName(), MetaModel::GetName(get_class($oRequest)))."</h1>\n");
  316. DisplayMainMenu($oP);
  317. }
  318. else
  319. {
  320. RequestCreationForm($oP, $oUserOrg);
  321. $sIssueDesc = Dict::Format('UI:ObjectCouldNotBeWritten', implode(', ', $aIssues));
  322. $oP->add_ready_script("alert('".addslashes($sIssueDesc)."');");
  323. }
  324. }
  325. /**
  326. * Prompts the user for creating a new request
  327. * @param WebPage $oP The current web page
  328. * @return void
  329. */
  330. function CreateRequest(WebPage $oP, Organization $oUserOrg)
  331. {
  332. $iStep = utils::ReadParam('step', 0);
  333. switch($iStep)
  334. {
  335. case 0:
  336. default:
  337. $oP->AddMenuButton('cancel', 'UI:Button:Cancel', './index.php?operation=welcome');
  338. SelectService($oP, $oUserOrg);
  339. break;
  340. case 1:
  341. $oP->AddMenuButton('cancel', 'UI:Button:Cancel', './index.php?operation=welcome');
  342. SelectSubService($oP, $oUserOrg);
  343. break;
  344. case 2:
  345. $oP->AddMenuButton('cancel', 'UI:Button:Cancel', './index.php?operation=welcome');
  346. RequestCreationForm($oP, $oUserOrg);
  347. break;
  348. case 3:
  349. DoCreateRequest($oP, $oUserOrg);
  350. break;
  351. }
  352. }
  353. /**
  354. * Displays the value of the given field, in HTML, without any hyperlink to other objects
  355. * @param DBObject $oObj The object to use
  356. * @param string $sAttCode Code of the attribute to display
  357. * @return string HTML text representing the value of this field
  358. */
  359. function GetFieldAsHtml($oObj, $sAttCode)
  360. {
  361. $sValue = '';
  362. $oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $sAttCode);
  363. if ($oAttDef->IsExternalKey())
  364. {
  365. // Special processing for external keys: don't display any hyperlink
  366. $oTargetObj = MetaModel::GetObject($oAttDef->GetTargetClass(), $oObj->Get($sAttCode), false);
  367. if (is_object($oTargetObj))
  368. {
  369. $sValue = $oTargetObj->GetName();
  370. }
  371. else
  372. {
  373. $sValue = Dict::S('UI:UndefinedObject');
  374. }
  375. }
  376. else
  377. {
  378. $sValue = $oObj->GetAsHTML($sAttCode);
  379. }
  380. return $sValue;
  381. }
  382. /**
  383. * Displays a list of objects, without any hyperlink (except for the object's details)
  384. * @param WebPage $oP The web page for the output
  385. * @param DBObjectSet $oSet The set of objects to display
  386. * @param Array $aZList The ZList (list of field codes) to use for the tabular display
  387. * @return string The HTML text representing the list
  388. */
  389. function DisplaySet($oP, $oSet, $aZList)
  390. {
  391. if ($oSet->Count() > 0)
  392. {
  393. $aAttribs = array();
  394. $aValues = array();
  395. $oAttDef = MetaModel::GetAttributeDef('UserRequest', 'ref');
  396. $aAttribs['key'] = array('label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
  397. foreach($aZList as $sAttCode)
  398. {
  399. $oAttDef = MetaModel::GetAttributeDef('UserRequest', $sAttCode);
  400. $aAttribs[$sAttCode] = array('label' => $oAttDef->GetLabel(), 'description' => $oAttDef->GetDescription());
  401. }
  402. while($oRequest = $oSet->Fetch())
  403. {
  404. $aRow = array();
  405. $aRow['key'] = '<a href="./index.php?operation=details&id='.$oRequest->GetKey().'">'.$oRequest->Get('ref').'</a>';
  406. $sHilightClass = $oRequest->GetHilightClass();
  407. if ($sHilightClass != '')
  408. {
  409. $aRow['@class'] = $sHilightClass;
  410. }
  411. foreach($aZList as $sAttCode)
  412. {
  413. $aRow[$sAttCode] = GetFieldAsHtml($oRequest, $sAttCode);
  414. }
  415. $aValues[$oRequest->GetKey()] = $aRow;
  416. }
  417. $oP->Table($aAttribs, $aValues);
  418. }
  419. else
  420. {
  421. $oP->add(Dict::S('Portal:NoOpenRequest'));
  422. }
  423. }
  424. /**
  425. * Lists all the currently opened User Requests for the current user
  426. * @param WebPage $oP The current web page
  427. * @return void
  428. */
  429. function ListOpenRequests(WebPage $oP)
  430. {
  431. $iContactId = UserRights::GetContactId();
  432. $oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
  433. if (is_object($oContact))
  434. {
  435. $sOQL = 'SELECT UserRequest WHERE caller_id = :contact_id AND status NOT IN ("resolved", "closed")';
  436. $oSearch = DBObjectSearch::FromOQL($sOQL);
  437. $oSet = new CMDBObjectSet($oSearch, array(), array('contact_id' => $iContactId));
  438. $aZList = array('title', 'start_date', 'status', 'service_id', 'priority', 'workgroup_id', 'agent_id');
  439. DisplaySet($oP, $oSet, $aZList);
  440. }
  441. }
  442. /**
  443. * Lists all the currently Resolved (not "Closed")User Requests for the current user
  444. * @param WebPage $oP The current web page
  445. * @return void
  446. */
  447. function ListResolvedRequests(WebPage $oP)
  448. {
  449. $iContactId = UserRights::GetContactId();
  450. $oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
  451. if (is_object($oContact))
  452. {
  453. $sOQL = 'SELECT UserRequest WHERE caller_id = :contact_id AND status ="resolved"';
  454. $oSearch = DBObjectSearch::FromOQL($sOQL);
  455. $oSet = new CMDBObjectSet($oSearch, array(), array('contact_id' => $iContactId));
  456. $aZList = array('title', 'start_date', 'status', 'service_id', 'priority', 'workgroup_id', 'agent_id');
  457. DisplaySet($oP, $oSet, $aZList);
  458. }
  459. }
  460. /**
  461. * Displays the details of the specified UserRequest object
  462. * @param WebPage $oP The current web page for the output
  463. * @param UserRequest $oRequest The object to display
  464. * @return void
  465. */
  466. function DisplayRequestDetails($oP, UserRequest $oRequest)
  467. {
  468. $aList = array('ref', 'status', 'title', 'description', 'request_type','ticket_log', 'start_date', 'tto_escalation_deadline', 'ttr_escalation_deadline', 'caller_id', 'service_id', 'servicesubcategory_id', 'product', 'impact', 'urgency', 'priority', 'workgroup_id', 'agent_id', 'related_problem_id', 'related_change_id', 'close_date', 'last_update', 'assignment_date', 'closure_deadline', 'resolution_code', 'solution', 'user_satisfaction', 'user_commment', 'freeze_reason');
  469. $aDetails = array();
  470. foreach($aList as $sAttCode)
  471. {
  472. $iFlags = $oRequest->GetAttributeFlags($sAttCode);
  473. $oAttDef = MetaModel::GetAttributeDef(get_class($oRequest), $sAttCode);
  474. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  475. {
  476. // Don't display linked set and non-visible attributes (in this state)
  477. $sDisplayValue = GetFieldAsHtml($oRequest, $sAttCode);
  478. $aDetails[] = array('label' => '<span title="'.MetaModel::GetDescription('UserRequest', $sAttCode).'">'.MetaModel::GetLabel('UserRequest', $sAttCode).'</span>', 'value' => $sDisplayValue);
  479. }
  480. }
  481. $oP->add('<div id="request_details">');
  482. $oP->details($aDetails);
  483. $oP->add('</div>');
  484. }
  485. /**
  486. * Displays a form for the user to provide feedback about a 'resolved' UserRequest and then close the request
  487. * @param WebPage $oP The current web page
  488. * @param UserRequest $oRequest The object to display
  489. * @return void
  490. */
  491. function DisplayResolvedRequestForm($oP, UserRequest $oRequest)
  492. {
  493. $oP->add("<div class=\"wizContainer\" id=\"form_close_request\">\n");
  494. $oP->add("<form action=\"../portal/index.php\" id=\"request_form\" method=\"post\">\n");
  495. $oP->add('<table id="close_form_table"><tr><td style="vertical-align:top;">');
  496. $oP->add("<h1 id=\"title_request_details\">".Dict::Format('Portal:TitleRequestDetailsFor_Request', $oRequest->GetName())."</h1>\n");
  497. DisplayRequestDetails($oP, $oRequest);
  498. $oP->add('</td><td style="vertical-align:top;">');
  499. $aArgs = array('this' => $oRequest);
  500. $sClass = get_class($oRequest);
  501. $aDetails = array();
  502. $aTargetStates = MetaModel::EnumStates($sClass);
  503. $aTargetState = $aTargetStates['closed'];
  504. $aExpectedAttributes = $aTargetState['attribute_list'];
  505. $iFieldIndex = 0;
  506. foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
  507. {
  508. // Prompt for an attribute if
  509. // - the attribute must be changed or must be displayed to the user for confirmation
  510. // - or the field is mandatory and currently empty
  511. if ( ($iExpectCode & (OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ||
  512. (($iExpectCode & OPT_ATT_MANDATORY) && ($oRequest->Get($sAttCode) == '')) )
  513. {
  514. $aAttributesDef = MetaModel::ListAttributeDefs($sClass);
  515. $oAttDef = $aAttributesDef[$sAttCode];
  516. $aArgs = array('this' => $oRequest);
  517. $sHTMLValue = cmdbAbstractObject::GetFormElementForField($oP, $sClass, $sAttCode, $oAttDef, $oRequest->Get($sAttCode), $oRequest->GetEditValue($sAttCode), 'att_'.$iFieldIndex, '', $iExpectCode, $aArgs);
  518. $aDetails[] = array('label' => $oAttDef->GetLabel(), 'value' => "<span id=\"field_att_$iFieldIndex\">$sHTMLValue</span>");
  519. $aFieldsMap[$sAttCode] = 'att_'.$iFieldIndex;
  520. $iFieldIndex++;
  521. }
  522. }
  523. $aStimuli = MetaModel::EnumStimuli($sClass);
  524. $oP->add("<h1>".Dict::S('Portal:EnterYourCommentsOnTicket')."</h1>");
  525. $oP->details($aDetails);
  526. $oP->add("<input type=\"hidden\" name=\"id\" value=\"".$oRequest->GetKey()."\">");
  527. $oP->add("<input type=\"hidden\" name=\"step\" value=\"2\">");
  528. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  529. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"details\">");
  530. $oP->p("<input type=\"submit\" value=\"".Dict::S('Portal:Button:CloseTicket')."\">");
  531. $oP->add('</td></tr></table>');
  532. $oP->add("</form>");
  533. $oP->add("</div>\n");
  534. $oP->add_ready_script(
  535. <<<EOF
  536. // Starts the validation when the page is ready
  537. CheckFields('request_form', false);
  538. $('#request_form').submit( function() {
  539. return CheckFields('request_form', true);
  540. });
  541. EOF
  542. );
  543. }
  544. /**
  545. * Actually close the request and saves the user's feedback
  546. * @param WebPage $oP The current web page
  547. * @param UserRequest $oRequest The object to close
  548. * @return void
  549. */
  550. function DoCloseRequest($oP, UserRequest $oRequest)
  551. {
  552. $sTransactionId = utils::ReadPostedParam('transaction_id', '');
  553. if (!utils::IsTransactionValid($sTransactionId))
  554. {
  555. $oP->add("<h1>".Dict::S('UI:Error:ObjectAlreadyCreated')."</h1>\n");
  556. DisplayMainMenu($oP);
  557. return;
  558. }
  559. $sClass = get_class($oRequest);
  560. $aDetails = array();
  561. $aTargetStates = MetaModel::EnumStates($sClass);
  562. $aTargetState = $aTargetStates['closed'];
  563. $aExpectedAttributes = $aTargetState['attribute_list'];
  564. $iFieldIndex = 0;
  565. foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
  566. {
  567. // Prompt for an attribute if
  568. // - the attribute must be changed or must be displayed to the user for confirmation
  569. // - or the field is mandatory and currently empty
  570. if ( ($iExpectCode & (OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ||
  571. (($iExpectCode & OPT_ATT_MANDATORY) && ($oRequest->Get($sAttCode) == '')) )
  572. {
  573. $value = utils::ReadPostedParam('attr_'.$sAttCode, null);
  574. if (!is_null($value))
  575. {
  576. $oRequest->Set($sAttCode, $value);
  577. }
  578. }
  579. }
  580. if ($oRequest->ApplyStimulus('ev_close'))
  581. {
  582. $oMyChange = MetaModel::NewObject("CMDBChange");
  583. $oMyChange->Set("date", time());
  584. $sUserString = CMDBChange::GetCurrentUserName();
  585. $oMyChange->Set("userinfo", $sUserString);
  586. $iChangeId = $oMyChange->DBInsert();
  587. $oRequest->DBUpdateTracked($oMyChange);
  588. $oP->p("<h1>".Dict::Format('UI:Class_Object_Updated', MetaModel::GetName(get_class($oRequest)), $oRequest->GetName())."</h1>\n");
  589. DisplayMainMenu($oP);
  590. }
  591. else
  592. {
  593. $oP->AddMenuButton('back', 'Portal:Back', './index.php?operation=welcome');
  594. $oP->add('Error: cannot close the request - '.$oRequest->GetName());
  595. }
  596. }
  597. /**
  598. * Find the UserRequest object of the specified ID. Make sure that it the caller is the current user
  599. * @param integer $id The ID of the request to find
  600. * @return UserRequert The found object, or null in case of failure (object does not exist, user has no rights to see it...)
  601. */
  602. function FindRequest($id)
  603. {
  604. $oRequest = null;
  605. $iContactId = UserRights::GetContactId();
  606. $oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
  607. if (is_object($oContact))
  608. {
  609. $sOQL = "SELECT UserRequest WHERE caller_id = :contact_id AND id = :request_id";
  610. $oSearch = DBObjectSearch::FromOQL($sOQL);
  611. $oSet = new CMDBObjectSet($oSearch, array(), array('contact_id' => $iContactId, 'request_id' => $id));
  612. if ($oSet->Count() > 0)
  613. {
  614. $oRequest = $oSet->Fetch();
  615. }
  616. }
  617. else
  618. {
  619. $oP->AddMenuButton('back', 'Portal:Back', './index.php?operation=welcome');
  620. $oP->add("<p class=\"error\">".Dict::S('Portal:ErrorNoContactForThisUser')."</p>");
  621. }
  622. return $oRequest;
  623. }
  624. /**
  625. * Displays the details of a request
  626. * @param WebPage $oP The current web page
  627. * @return void
  628. */
  629. function RequestDetails(WebPage $oP, $id)
  630. {
  631. $oRequest = FindRequest($id);
  632. if (!is_object($oRequest))
  633. {
  634. DisplayMainMenu($oP);
  635. return;
  636. }
  637. $iDefaultStep = 0;
  638. if ($oRequest->GetState() == 'resolved')
  639. {
  640. // The current ticket is in 'resolved' state, prompt to close it
  641. $iDefaultStep = 1;
  642. }
  643. $iStep = utils::ReadParam('step', $iDefaultStep);
  644. switch($iStep)
  645. {
  646. case 0:
  647. $oP->AddMenuButton('back', 'Portal:Back', './index.php?operation=welcome');
  648. $oP->add("<h1 id=\"title_request_details\">".$oRequest->GetIcon()."&nbsp;".Dict::Format('Portal:TitleRequestDetailsFor_Request', $oRequest->GetName())."</h1>\n");
  649. DisplayRequestDetails($oP, $oRequest);
  650. break;
  651. case 1:
  652. $oP->AddMenuButton('cancel', 'UI:Button:Cancel', './index.php?operation=welcome');
  653. DisplayResolvedRequestForm($oP, $oRequest);
  654. break;
  655. case 2:
  656. DoCloseRequest($oP, $oRequest);
  657. break;
  658. }
  659. }
  660. /**
  661. * Get The organization of the current user (i.e. the organization of its contact)
  662. * @param WebPage $oP The current page, for errors output
  663. * @return Organization The user's org or null in case of problem...
  664. */
  665. function GetUserOrg()
  666. {
  667. $oOrg = null;
  668. $iContactId = UserRights::GetContactId();
  669. $oContact = MetaModel::GetObject('Contact', $iContactId, false); // false => Can fail
  670. if (is_object($oContact))
  671. {
  672. $oOrg = MetaModel::GetObject('Organization', $oContact->Get('org_id'), false); // false => can fail
  673. }
  674. else
  675. {
  676. throw new Exception(Dict::S('Portal:ErrorNoContactForThisUser'));
  677. }
  678. return $oOrg;
  679. }
  680. try
  681. {
  682. require_once(APPROOT.'/application/startup.inc.php');
  683. require_once(APPROOT.'/application/portalwebpage.class.inc.php');
  684. $oAppContext = new ApplicationContext();
  685. $sOperation = utils::ReadParam('operation', '');
  686. require_once(APPROOT.'/application/loginwebpage.class.inc.php');
  687. LoginWebPage::DoLogin(false /* bMustBeAdmin */, true /* IsAllowedToPortalUsers */); // Check user rights and prompt if needed
  688. $oUserOrg = GetUserOrg();
  689. $sCode = $oUserOrg->Get('code');
  690. $sAlternateStylesheet = '';
  691. if (@file_exists("./$sCode/portal.css"))
  692. {
  693. $sAlternateStylesheet = "$sCode";
  694. }
  695. $oP = new PortalWebPage(Dict::S('Portal:Title'), $sAlternateStylesheet);
  696. $oP->add($sAlternateStylesheet);
  697. if (is_object($oUserOrg))
  698. {
  699. switch($sOperation)
  700. {
  701. case 'create_request':
  702. CreateRequest($oP, $oUserOrg);
  703. break;
  704. case 'details':
  705. $iRequestId = utils::ReadParam('id', 0);
  706. RequestDetails($oP, $iRequestId);
  707. break;
  708. case 'welcome':
  709. default:
  710. DisplayMainMenu($oP);
  711. }
  712. }
  713. $oP->output();
  714. }
  715. catch(CoreException $e)
  716. {
  717. require_once(APPROOT.'/setup/setuppage.class.inc.php');
  718. $oP = new SetupWebPage(Dict::S('UI:PageTitle:FatalError'));
  719. $oP->add("<h1>".Dict::S('UI:FatalErrorMessage')."</h1>\n");
  720. $oP->error(Dict::Format('UI:Error_Details', $e->getHtmlDesc()));
  721. $oP->output();
  722. if (MetaModel::IsLogEnabledIssue())
  723. {
  724. if (MetaModel::IsValidClass('EventIssue'))
  725. {
  726. try
  727. {
  728. $oLog = new EventIssue();
  729. $oLog->Set('message', $e->getMessage());
  730. $oLog->Set('userinfo', '');
  731. $oLog->Set('issue', $e->GetIssue());
  732. $oLog->Set('impact', 'Page could not be displayed');
  733. $oLog->Set('callstack', $e->getTrace());
  734. $oLog->Set('data', $e->getContextData());
  735. $oLog->DBInsertNoReload();
  736. }
  737. catch(Exception $e)
  738. {
  739. IssueLog::Error("Failed to log issue into the DB");
  740. }
  741. }
  742. IssueLog::Error($e->getMessage());
  743. }
  744. // For debugging only
  745. //throw $e;
  746. }
  747. catch(Exception $e)
  748. {
  749. require_once(APPROOT.'/setup/setuppage.class.inc.php');
  750. $oP = new SetupWebPage(Dict::S('UI:PageTitle:FatalError'));
  751. $oP->add("<h1>".Dict::S('UI:FatalErrorMessage')."</h1>\n");
  752. $oP->error(Dict::Format('UI:Error_Details', $e->getMessage()));
  753. $oP->output();
  754. if (MetaModel::IsLogEnabledIssue())
  755. {
  756. if (MetaModel::IsValidClass('EventIssue'))
  757. {
  758. try
  759. {
  760. $oLog = new EventIssue();
  761. $oLog->Set('message', $e->getMessage());
  762. $oLog->Set('userinfo', '');
  763. $oLog->Set('issue', 'PHP Exception');
  764. $oLog->Set('impact', 'Page could not be displayed');
  765. $oLog->Set('callstack', $e->getTrace());
  766. $oLog->Set('data', array());
  767. $oLog->DBInsertNoReload();
  768. }
  769. catch(Exception $e)
  770. {
  771. IssueLog::Error("Failed to log issue into the DB");
  772. }
  773. }
  774. IssueLog::Error($e->getMessage());
  775. }
  776. }
  777. ?>