cmdbabstract.class.inc.php 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305
  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. * Abstract class that implements some common and useful methods for displaying
  18. * the objects
  19. *
  20. * @author Erwan Taloc <erwan.taloc@combodo.com>
  21. * @author Romain Quetiez <romain.quetiez@combodo.com>
  22. * @author Denis Flaven <denis.flaven@combodo.com>
  23. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  24. */
  25. define('OBJECT_PROPERTIES_TAB', 'ObjectProperties');
  26. define('HILIGHT_CLASS_CRITICAL', 'red');
  27. define('HILIGHT_CLASS_WARNING', 'orange');
  28. define('HILIGHT_CLASS_OK', 'green');
  29. define('HILIGHT_CLASS_NONE', '');
  30. require_once(APPROOT.'/core/cmdbobject.class.inc.php');
  31. require_once(APPROOT.'/application/applicationextension.inc.php');
  32. require_once(APPROOT.'/application/utils.inc.php');
  33. require_once(APPROOT.'/application/applicationcontext.class.inc.php');
  34. require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
  35. require_once(APPROOT.'/application/ui.passwordwidget.class.inc.php');
  36. require_once(APPROOT.'/application/ui.extkeywidget.class.inc.php');
  37. require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
  38. /**
  39. * All objects to be displayed in the application (either as a list or as details)
  40. * must implement this interface.
  41. */
  42. interface iDisplay
  43. {
  44. /**
  45. * Maps the given context parameter name to the appropriate filter/search code for this class
  46. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  47. * @return string Filter code, i.e. 'customer_id'
  48. */
  49. public static function MapContextParam($sContextParam);
  50. /**
  51. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  52. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  53. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  54. * To Be overridden by derived classes
  55. * @param void
  56. * @return String The desired higlight class for the object/row
  57. */
  58. public function GetHilightClass();
  59. /**
  60. * Returns the relative path to the page that handles the display of the object
  61. * @return string
  62. */
  63. public static function GetUIPage();
  64. /**
  65. * Displays the details of the object
  66. */
  67. public function DisplayDetails(WebPage $oPage, $bEditMode = false);
  68. }
  69. abstract class cmdbAbstractObject extends CMDBObject implements iDisplay
  70. {
  71. protected $m_iFormId; // The ID of the form used to edit the object (when in edition mode !)
  72. static $iGlobalFormId = 1;
  73. /**
  74. * returns what will be the next ID for the forms
  75. */
  76. public static function GetNextFormId()
  77. {
  78. return 1 + self::$iGlobalFormId;
  79. }
  80. public static function GetUIPage()
  81. {
  82. return '../pages/UI.php';
  83. }
  84. function DisplayBareHeader(WebPage $oPage, $bEditMode = false)
  85. {
  86. // Standard Header with name, actions menu and history block
  87. //
  88. // action menu
  89. $oSingletonFilter = new DBObjectSearch(get_class($this));
  90. $oSingletonFilter->AddCondition('id', $this->GetKey(), '=');
  91. $oBlock = new MenuBlock($oSingletonFilter, 'popup', false);
  92. $oBlock->Display($oPage, -1);
  93. // Master data sources
  94. $oReplicaSet = $this->GetMasterReplica();
  95. $bSynchronized = false;
  96. $bCreated = false;
  97. $bCanBeDeleted = false;
  98. $aMasterSources = array();
  99. if ($oReplicaSet->Count() > 0)
  100. {
  101. $bSynchronized = true;
  102. $sTip = "<p>".Dict::S('Core:Synchro:ThisObjectIsSynchronized')."</p>";
  103. while($aData = $oReplicaSet->FetchAssoc())
  104. {
  105. // Assumption: $aData['datasource'] will not be null because the data source id is always set...
  106. $sApplicationURL = $aData['datasource']->GetApplicationUrl($this, $aData['replica']);
  107. $sLink = $aData['datasource']->GetName();
  108. if (!empty($sApplicationURL))
  109. {
  110. $sLink = "<a href=\"$sApplicationURL\" target=\"_blank\">".$aData['datasource']->GetName()."</a>";
  111. }
  112. if ($aData['replica']->Get('status_dest_creator') == 1)
  113. {
  114. $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectWasCreatedBy_Source', $sLink)."</p>";
  115. $bCreated = true;
  116. }
  117. if ($bCreated)
  118. {
  119. $sDeletePolicy = $aData['datasource']->Get('delete_policy');
  120. if (($sDeletePolicy == 'delete') || ($sDeletePolicy == 'update_then_delete'))
  121. {
  122. $bCanBeDeleted = true;
  123. $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectCanBeDeletedBy_Source', $sLink)."</p>";
  124. }
  125. }
  126. $aMasterSources[$aData['datasource']->GetKey()]['datasource'] = $aData['datasource'];
  127. $aMasterSources[$aData['datasource']->GetKey()]['url'] = $sLink;
  128. $aMasterSources[$aData['datasource']->GetKey()]['last_synchro'] = $aData['replica']->Get('status_last_seen');
  129. }
  130. }
  131. $sSynchroIcon = '';
  132. if ($bSynchronized)
  133. {
  134. $sTip .= "<p><b>".Dict::S('Core:Synchro:ListOfDataSources')."</b></p>";
  135. foreach($aMasterSources as $aStruct)
  136. {
  137. $oDataSource = $aStruct['datasource'];
  138. $sLink = $aStruct['url'];
  139. $sTip .= "<p style=\"white-space:nowrap\">".$oDataSource->GetIcon(true, 'style="vertical-align:middle"')."&nbsp;$sLink<br/>";
  140. $sTip .= Dict::S('Core:Synchro:LastSynchro').'<br/>'.$aStruct['last_synchro']."</p>";
  141. }
  142. $sSynchroIcon = '&nbsp;<img style="vertical-align:middle;" id="synchro_icon" src="../images/locked.png"/>';
  143. $oPage->add_ready_script("$('#synchro_icon').qtip( { content: '$sTip', show: 'mouseover', hide: 'unfocus', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  144. }
  145. $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()."&nbsp;\n");
  146. $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span>$sSynchroIcon</h1>\n");
  147. $oPage->add("</div>\n");
  148. }
  149. function DisplayBareHistory(WebPage $oPage, $bEditMode = false)
  150. {
  151. // history block (with as a tab)
  152. $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
  153. $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
  154. $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
  155. $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
  156. $oBlock->Display($oPage, -1);
  157. }
  158. function DisplayBareProperties(WebPage $oPage, $bEditMode = false)
  159. {
  160. $oPage->add($this->GetBareProperties($oPage, $bEditMode));
  161. // Special case to display the case log, if any...
  162. if (MetaModel::IsValidAttCode(get_class($this), 'ticket_log'))
  163. {
  164. $oAttDef = MetaModel::GetAttributeDef(get_class($this), 'ticket_log');
  165. if ($oAttDef instanceof AttributeCaseLog)
  166. {
  167. $this->DisplayCaseLog($oPage, 'ticket_log', '', '', false);
  168. }
  169. }
  170. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  171. {
  172. $oExtensionInstance->OnDisplayProperties($this, $oPage, $bEditMode);
  173. }
  174. }
  175. function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  176. {
  177. // Related objects: display all the linkset attributes, each as a separate tab
  178. // In the order described by the 'display' ZList
  179. $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  180. if (count($aList) == 0)
  181. {
  182. // Empty ZList defined, display all the linkedset attributes defined
  183. $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  184. }
  185. $sClass = get_class($this);
  186. foreach($aList as $sAttCode)
  187. {
  188. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  189. // Display mode
  190. if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
  191. $oPage->SetCurrentTab($oAttDef->GetLabel());
  192. if ($bEditMode)
  193. {
  194. $iFlags = $this->GetAttributeFlags($sAttCode);
  195. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  196. if (get_class($oAttDef) == 'AttributeLinkedSet')
  197. {
  198. // 1:n links
  199. $sTargetClass = $oAttDef->GetLinkedClass();
  200. if ($this->IsNew())
  201. {
  202. $oPage->p(Dict::Format('UI:BeforeAdding_Class_ObjectsSaveThisObject', MetaModel::GetName($sTargetClass)));
  203. }
  204. else
  205. {
  206. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  207. $oFilter = new DBObjectSearch($sTargetClass);
  208. $oFilter->AddCondition($oAttDef->GetExtKeyToMe(), $this->GetKey(),'=');
  209. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  210. $oAppContext = new ApplicationContext();
  211. foreach($oAppContext->GetNames() as $sKey)
  212. {
  213. // The linked object inherits the parent's value for the context
  214. if (MetaModel::IsValidAttCode($sClass, $sKey))
  215. {
  216. $aDefaults[$sKey] = $this->Get($sKey);
  217. }
  218. }
  219. $aParams = array(
  220. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  221. 'object_id' => $this->GetKey(),
  222. 'menu' => true,
  223. 'default' => $aDefaults,
  224. );
  225. $oBlock = new DisplayBlock($oFilter, 'list', false);
  226. $oBlock->Display($oPage, $sInputId, $aParams);
  227. }
  228. }
  229. else // get_class($oAttDef) == 'AttributeLinkedSetIndirect'
  230. {
  231. // n:n links
  232. $sLinkedClass = $oAttDef->GetLinkedClass();
  233. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  234. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  235. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
  236. $sValue = $this->Get($sAttCode);
  237. $sDisplayValue = $this->GetEditValue($sAttCode);
  238. $aArgs = array('this' => $this);
  239. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  240. $aFieldsMap[$sAttCode] = $sInputId;
  241. $oPage->add($sHTMLValue);
  242. }
  243. }
  244. else
  245. {
  246. // Display mode
  247. if (!$oAttDef->IsIndirect())
  248. {
  249. // 1:n links
  250. $sTargetClass = $oAttDef->GetLinkedClass();
  251. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  252. $oAppContext = new ApplicationContext();
  253. foreach($oAppContext->GetNames() as $sKey)
  254. {
  255. // The linked object inherits the parent's value for the context
  256. if (MetaModel::IsValidAttCode($sClass, $sKey))
  257. {
  258. $aDefaults[$sKey] = $this->Get($sKey);
  259. }
  260. }
  261. $aParams = array(
  262. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  263. 'object_id' => $this->GetKey(),
  264. 'menu' => false,
  265. 'default' => $aDefaults,
  266. );
  267. }
  268. else
  269. {
  270. // n:n links
  271. $sLinkedClass = $oAttDef->GetLinkedClass();
  272. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  273. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  274. $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
  275. $aParams = array(
  276. 'link_attr' => $oAttDef->GetExtKeyToMe(),
  277. 'object_id' => $this->GetKey(),
  278. 'target_attr' => $oAttDef->GetExtKeyToRemote(),
  279. 'view_link' => false,
  280. 'menu' => false,
  281. 'display_limit' => true, // By default limit the list to speed up the initial load & display
  282. );
  283. }
  284. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  285. $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
  286. $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
  287. }
  288. }
  289. $oPage->SetCurrentTab('');
  290. if (!$bEditMode)
  291. {
  292. // Get the actual class of the current object
  293. // And look for triggers referring to it
  294. // If any trigger has been found then display a tab with notifications
  295. //
  296. $sClass = get_class($this);
  297. $sClassList = implode("', '", MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL));
  298. $oTriggerSet = new CMDBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnObject AS T WHERE T.target_class IN ('$sClassList')"));
  299. if ($oTriggerSet->Count() > 0)
  300. {
  301. $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab'));
  302. // Display notifications regarding the object
  303. $iId = $this->GetKey();
  304. $oBlock = new DisplayBlock(DBObjectSearch::FromOQL("SELECT EventNotificationEmail AS Ev JOIN TriggerOnObject AS T ON Ev.trigger_id = T.id WHERE T.target_class IN ('$sClassList') AND Ev.object_id = $iId"), 'list', false);
  305. $oBlock->Display($oPage, 'notifications', array('menu' => false));
  306. }
  307. }
  308. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  309. {
  310. $oExtensionInstance->OnDisplayRelations($this, $oPage, $bEditMode);
  311. }
  312. }
  313. function GetBareProperties(WebPage $oPage, $bEditMode = false)
  314. {
  315. $sHtml = '';
  316. $oAppContext = new ApplicationContext();
  317. $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
  318. $aDetails = array();
  319. $sClass = get_class($this);
  320. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  321. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  322. // Compute the list of properties to display, first the attributes in the 'details' list, then
  323. // all the remaining attributes that are not external fields
  324. $sHtml = '';
  325. $aDetails = array();
  326. $iInputId = 0;
  327. foreach($aDetailsStruct as $sTab => $aCols )
  328. {
  329. $aDetails[$sTab] = array();
  330. ksort($aCols);
  331. $oPage->SetCurrentTab(Dict::S($sTab));
  332. $oPage->add('<table style="vertical-align:top"><tr>');
  333. foreach($aCols as $sColIndex => $aFieldsets)
  334. {
  335. $oPage->add('<td style="vertical-align:top">');
  336. //$aDetails[$sTab][$sColIndex] = array();
  337. $sLabel = '';
  338. $sPreviousLabel = '';
  339. $aDetails[$sTab][$sColIndex] = array();
  340. foreach($aFieldsets as $sFieldsetName => $aFields)
  341. {
  342. if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
  343. {
  344. $sLabel = $sFieldsetName;
  345. }
  346. else
  347. {
  348. $sLabel = '';
  349. }
  350. if ($sLabel != $sPreviousLabel)
  351. {
  352. if (!empty($sPreviousLabel))
  353. {
  354. $oPage->add('<fieldset>');
  355. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  356. }
  357. $oPage->Details($aDetails[$sTab][$sColIndex]);
  358. if (!empty($sPreviousLabel))
  359. {
  360. $oPage->add('</fieldset>');
  361. }
  362. $aDetails[$sTab][$sColIndex] = array();
  363. $sPreviousLabel = $sLabel;
  364. }
  365. foreach($aFields as $sAttCode)
  366. {
  367. $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
  368. if ($val != null)
  369. {
  370. /*
  371. * Removed for now...
  372. // Check if the attribute is not mastered by a synchro...
  373. $aReasons = array();
  374. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  375. $sSynchroIcon = '';
  376. if ($iSynchroFlags & OPT_ATT_SLAVE)
  377. {
  378. $sSynchroIcon = "&nbsp;<img id=\"synchro_$iInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  379. $sTip = '';
  380. foreach($aReasons as $aRow)
  381. {
  382. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  383. }
  384. $oPage->add_ready_script("$('#synchro_$iInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  385. }
  386. $val['comments'] = $sSynchroIcon;
  387. */
  388. // The field is visible, add it to the current column
  389. $aDetails[$sTab][$sColIndex][] = $val;
  390. $iInputId++;
  391. }
  392. }
  393. }
  394. if (!empty($sPreviousLabel))
  395. {
  396. $oPage->add('<fieldset>');
  397. $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
  398. }
  399. $oPage->Details($aDetails[$sTab][$sColIndex]);
  400. if (!empty($sPreviousLabel))
  401. {
  402. $oPage->add('</fieldset>');
  403. }
  404. $oPage->add('</td>');
  405. }
  406. $oPage->add('</tr></table>');
  407. }
  408. return $sHtml;
  409. }
  410. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  411. {
  412. $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
  413. if (!empty($sTemplate))
  414. {
  415. $oTemplate = new DisplayTemplate($sTemplate);
  416. // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
  417. // but the preferred method is to use '$id$'
  418. $oTemplate->Render($oPage, array('class_name'=> MetaModel::GetName(get_class($this)),'class'=> get_class($this), 'pkey'=> $this->GetKey(), 'id'=> $this->GetKey(), 'name' => $this->Get('friendlyname')));
  419. }
  420. else
  421. {
  422. // Object's details
  423. // template not found display the object using the *old style*
  424. $this->DisplayBareHeader($oPage, $bEditMode);
  425. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  426. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  427. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  428. $this->DisplayBareProperties($oPage, $bEditMode);
  429. $this->DisplayBareRelations($oPage, $bEditMode);
  430. $oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
  431. $this->DisplayBareHistory($oPage, $bEditMode);
  432. }
  433. }
  434. function DisplayPreview(WebPage $oPage)
  435. {
  436. $aDetails = array();
  437. $sClass = get_class($this);
  438. $aList = MetaModel::GetZListItems($sClass, 'preview');
  439. foreach($aList as $sAttCode)
  440. {
  441. $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
  442. }
  443. $oPage->details($aDetails);
  444. }
  445. public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  446. {
  447. $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
  448. }
  449. /**
  450. * Get the HTML fragment corresponding to the display of a table representing a set of objects
  451. * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
  452. * @param CMDBObjectSet The set of objects to display
  453. * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
  454. * @return String The HTML fragment representing the table of objects
  455. */
  456. public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  457. {
  458. if (empty($aExtraParams['currentId']))
  459. {
  460. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  461. }
  462. else
  463. {
  464. $iListId = $aExtraParams['currentId'];
  465. }
  466. // Initialize and check the parameters
  467. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  468. $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
  469. $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
  470. $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
  471. if (!empty($sLinkageAttribute))
  472. {
  473. if($iLinkedObjectId == 0)
  474. {
  475. // if 'links' mode is requested the id of the object to link to must be specified
  476. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  477. }
  478. if($sTargetAttr == '')
  479. {
  480. // if 'links' mode is requested the d of the object to link to must be specified
  481. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  482. }
  483. }
  484. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  485. $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
  486. $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
  487. $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
  488. $aExtraFields = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  489. $sHtml = '';
  490. $oAppContext = new ApplicationContext();
  491. $sClassName = $oSet->GetFilter()->GetClass();
  492. $aAttribs = array();
  493. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  494. $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  495. $aList = array_merge($aList, $aExtraFields);
  496. // Filter the list to removed linked set since we are not able to display them here
  497. foreach($aList as $index => $sAttCode)
  498. {
  499. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  500. if ($oAttDef instanceof AttributeLinkedSet)
  501. {
  502. // Removed from the display list
  503. unset($aList[$index]);
  504. }
  505. }
  506. if (!empty($sLinkageAttribute))
  507. {
  508. // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
  509. // and other objects...
  510. // The display will then group all the attributes related to the link itself:
  511. // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
  512. $aDisplayList = array();
  513. $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
  514. assert(isset($aAttDefs[$sLinkageAttribute]));
  515. $oAttDef = $aAttDefs[$sLinkageAttribute];
  516. assert($oAttDef->IsExternalKey());
  517. // First display all the attributes specific to the link record
  518. foreach($aList as $sLinkAttCode)
  519. {
  520. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  521. if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
  522. {
  523. $aDisplayList[] = $sLinkAttCode;
  524. }
  525. }
  526. // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
  527. foreach($aList as $sLinkAttCode)
  528. {
  529. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  530. if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
  531. || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
  532. {
  533. $aDisplayList[] = $sLinkAttCode;
  534. }
  535. }
  536. // First display all the attributes specific to the link
  537. // Then display all the attributes linked to the other end of the relationship
  538. $aList = $aDisplayList;
  539. }
  540. if ($bSelectMode)
  541. {
  542. if (!$bSingleSelectMode)
  543. {
  544. $aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$iListId}:not(:disabled)', this.checked);\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
  545. }
  546. else
  547. {
  548. $aAttribs['form::select'] = array('label' => "", 'description' => '');
  549. }
  550. }
  551. if ($bViewLink)
  552. {
  553. $aAttribs['key'] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  554. }
  555. foreach($aList as $sAttCode)
  556. {
  557. $aAttribs[$sAttCode] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  558. }
  559. $aValues = array();
  560. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  561. $iMaxObjects = -1;
  562. if ($bDisplayLimit && $bTruncated)
  563. {
  564. if ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
  565. {
  566. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  567. $oSet->SetLimit($iMaxObjects);
  568. }
  569. }
  570. $oSet->Seek(0);
  571. while (($oObj = $oSet->Fetch()) && ($iMaxObjects != 0))
  572. {
  573. $aRow = array();
  574. $sHilightClass = $oObj->GetHilightClass();
  575. if ($sHilightClass != '')
  576. {
  577. $aRow['@class'] = $sHilightClass;
  578. }
  579. if ($bViewLink)
  580. {
  581. $aRow['key'] = $oObj->GetHyperLink();
  582. }
  583. if ($bSelectMode)
  584. {
  585. if (array_key_exists('selection_enabled', $aExtraParams) && isset($aExtraParams['selection_enabled'][$oObj->GetKey()]))
  586. {
  587. $sDisabled = ($aExtraParams['selection_enabled'][$oObj->GetKey()]) ? '' : ' disabled="disabled"';
  588. }
  589. else
  590. {
  591. $sDisabled = '';
  592. }
  593. if ($bSingleSelectMode)
  594. {
  595. $aRow['form::select'] = "<input type=\"radio\" $sDisabled class=\"selectList{$iListId}\" name=\"selectObject\" value=\"".$oObj->GetKey()."\"></input>";
  596. }
  597. else
  598. {
  599. $aRow['form::select'] = "<input type=\"checkBox\" $sDisabled class=\"selectList{$iListId}\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\"></input>";
  600. }
  601. }
  602. foreach($aList as $sAttCode)
  603. {
  604. $aRow[$sAttCode] = $oObj->GetAsHTML($sAttCode);
  605. }
  606. $aValues[] = $aRow;
  607. $iMaxObjects--;
  608. }
  609. $sHtml .= '<table class="listContainer">';
  610. $sColspan = '';
  611. // if (isset($aExtraParams['block_id']))
  612. // {
  613. // $divId = $aExtraParams['block_id'];
  614. // }
  615. // else
  616. // {
  617. // $divId = 'missingblockid';
  618. // }
  619. $sFilter = $oSet->GetFilter()->serialize();
  620. $iMinDisplayLimit = MetaModel::GetConfig()->GetMinDisplayLimit();
  621. $sCollapsedLabel = Dict::Format('UI:TruncatedResults', $iMinDisplayLimit, $oSet->Count());
  622. $sLinkLabel = Dict::S('UI:DisplayAll');
  623. foreach($oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
  624. {
  625. $aExtraParams['query_params'][$sName] = $sValue;
  626. }
  627. if ($bDisplayLimit && $bTruncated && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  628. {
  629. // list truncated
  630. $aExtraParams['display_limit'] = true;
  631. $sHtml .= '<tr class="containerHeader"><td><span id="lbl_'.$iListId.'">'.$sCollapsedLabel.'</span>&nbsp;&nbsp;<a class="truncated" id="trc_'.$iListId.'">'.$sLinkLabel.'</a></td><td>';
  632. $oPage->add_ready_script(
  633. <<<EOF
  634. $('#$iListId table.listResults').addClass('truncated');
  635. $('#$iListId table.listResults tr:last td').addClass('truncated');
  636. EOF
  637. );
  638. }
  639. else if ($bDisplayLimit && !$bTruncated && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  640. {
  641. // Collapsible list
  642. $aExtraParams['display_limit'] = true;
  643. $sHtml .= '<tr class="containerHeader"><td><span id="lbl_'.$iListId.'">'.Dict::Format('UI:CountOfResults', $oSet->Count()).'</span><a class="truncated" id="trc_'.$iListId.'">'.Dict::S('UI:CollapseList').'</a></td><td>';
  644. }
  645. $aExtraParams['truncated'] = false; // To expand the full list when clicked
  646. $sExtraParamsExpand = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  647. $oPage->add_ready_script(
  648. <<<EOF
  649. // Handle truncated lists
  650. $('#trc_$iListId').click(function()
  651. {
  652. var state = {};
  653. var currentState = $.bbq.getState( this.id, true ) || 'close';
  654. // Toggle the state!
  655. if (currentState == 'close')
  656. {
  657. state[ this.id ] = 'open';
  658. }
  659. else
  660. {
  661. state[ this.id ] = 'close';
  662. }
  663. $.bbq.pushState( state );
  664. $(this).trigger(state[this.id]);
  665. });
  666. $('#trc_$iListId').unbind('open');
  667. $('#trc_$iListId').bind('open', function()
  668. {
  669. ReloadTruncatedList('$iListId', '$sFilter', '$sExtraParamsExpand');
  670. });
  671. $('#trc_$iListId').unbind('close');
  672. $('#trc_$iListId').bind('close', function()
  673. {
  674. TruncateList('$iListId', $iMinDisplayLimit, '$sCollapsedLabel', '$sLinkLabel');
  675. });
  676. EOF
  677. );
  678. if ($bDisplayMenu)
  679. {
  680. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  681. $sColspan = 'colspan="2"';
  682. $aMenuExtraParams = $aExtraParams;
  683. if (!empty($sLinkageAttribute))
  684. {
  685. //$aMenuExtraParams['linkage'] = $sLinkageAttribute;
  686. $aMenuExtraParams = $aExtraParams;
  687. }
  688. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams, $iListId);
  689. $sHtml .= '</td></tr>';
  690. }
  691. $sHtml .= "<tr><td $sColspan>";
  692. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  693. $sHtml .= '</td></tr>';
  694. $sHtml .= '</table>';
  695. return $sHtml;
  696. }
  697. public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  698. {
  699. static $iListId = 0;
  700. $iListId++;
  701. $aList = array();
  702. // Initialize and check the parameters
  703. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  704. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  705. // Check if there is a list of aliases to limit the display to...
  706. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
  707. $sHtml = '';
  708. $oAppContext = new ApplicationContext();
  709. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  710. $aAuthorizedClasses = array();
  711. foreach($aClasses as $sAlias => $sClassName)
  712. {
  713. if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
  714. ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
  715. {
  716. $aAuthorizedClasses[$sAlias] = $sClassName;
  717. }
  718. }
  719. $aAttribs = array();
  720. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  721. {
  722. $aList[$sClassName] = MetaModel::GetZListItems($sClassName, 'list');
  723. if ($bViewLink)
  724. {
  725. $aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  726. }
  727. foreach($aList[$sClassName] as $sAttCode)
  728. {
  729. $aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  730. }
  731. }
  732. $aValues = array();
  733. $oSet->Seek(0);
  734. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  735. $iMaxObjects = -1;
  736. if ($bDisplayLimit)
  737. {
  738. if ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
  739. {
  740. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  741. }
  742. }
  743. while (($aObjects = $oSet->FetchAssoc()) && ($iMaxObjects != 0))
  744. {
  745. $aRow = array();
  746. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  747. {
  748. if ($bViewLink)
  749. {
  750. if (is_null($aObjects[$sAlias]))
  751. {
  752. $aRow['key_'.$sAlias] = '';
  753. }
  754. else
  755. {
  756. $aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
  757. }
  758. }
  759. foreach($aList[$sClassName] as $sAttCode)
  760. {
  761. if (is_null($aObjects[$sAlias]))
  762. {
  763. $aRow[$sAttCode.'_'.$sAlias] = '';
  764. }
  765. else
  766. {
  767. $aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode);
  768. }
  769. }
  770. }
  771. $aValues[] = $aRow;
  772. $iMaxObjects--;
  773. }
  774. $sHtml .= '<table class="listContainer">';
  775. $sColspan = '';
  776. if ($bDisplayMenu)
  777. {
  778. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  779. $sColspan = 'colspan="2"';
  780. $aMenuExtraParams = $aExtraParams;
  781. if (!empty($sLinkageAttribute))
  782. {
  783. $aMenuExtraParams = $aExtraParams;
  784. }
  785. if ($bDisplayLimit && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  786. {
  787. // list truncated
  788. $divId = $aExtraParams['block_id'];
  789. $sFilter = $oSet->GetFilter()->serialize();
  790. $aExtraParams['display_limit'] = false; // To expand the full list
  791. $sExtraParams = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  792. $sHtml .= '<tr class="containerHeader"><td>'.Dict::Format('UI:TruncatedResults', MetaModel::GetConfig()->GetMinDisplayLimit(), $oSet->Count()).'&nbsp;&nbsp;<a href="Javascript:ReloadTruncatedList(\''.$divId.'\', \''.$sFilter.'\', \''.$sExtraParams.'\');">'.Dict::S('UI:DisplayAll').'</a></td><td>';
  793. $oPage->add_ready_script("$('#{$divId} table.listResults').addClass('truncated');");
  794. $oPage->add_ready_script("$('#{$divId} table.listResults tr:last td').addClass('truncated');");
  795. }
  796. else
  797. {
  798. // Full list
  799. $sHtml .= '<tr class="containerHeader"><td>&nbsp;'.Dict::Format('UI:CountOfResults', $oSet->Count()).'</td><td>';
  800. }
  801. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams, $aMenuExtraParams['currentId']);
  802. $sHtml .= '</td></tr>';
  803. }
  804. $sHtml .= "<tr><td $sColspan>";
  805. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  806. $sHtml .= '</td></tr>';
  807. $sHtml .= '</table>';
  808. return $sHtml;
  809. }
  810. static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  811. {
  812. $oPage->add(self::GetSetAsCSV($oSet, $aParams));
  813. }
  814. static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array())
  815. {
  816. $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
  817. $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
  818. $aFields = null;
  819. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  820. {
  821. $aFields = explode(',', $aParams['fields']);
  822. }
  823. $aList = array();
  824. $oAppContext = new ApplicationContext();
  825. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  826. $aAuthorizedClasses = array();
  827. foreach($aClasses as $sAlias => $sClassName)
  828. {
  829. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  830. {
  831. $aAuthorizedClasses[$sAlias] = $sClassName;
  832. }
  833. }
  834. $aAttribs = array();
  835. $aHeader = array();
  836. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  837. {
  838. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  839. {
  840. if (is_null($aFields) || (count($aFields) == 0))
  841. {
  842. // Standard list of attributes (no link sets)
  843. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  844. {
  845. $aList[$sClassName][$sAttCode] = $oAttDef;
  846. }
  847. }
  848. else
  849. {
  850. // User defined list of attributes
  851. if (in_array($sAttCode, $aFields))
  852. {
  853. $aList[$sClassName][$sAttCode] = $oAttDef;
  854. }
  855. }
  856. }
  857. $aHeader[] = 'id';
  858. foreach($aList[$sClassName] as $sAttCode => $oAttDef)
  859. {
  860. $sStar = '';
  861. if ($oAttDef->IsExternalField())
  862. {
  863. $sExtKeyLabel = MetaModel::GetLabel($sClassName, $oAttDef->GetKeyAttCode());
  864. $oExtKeyAttDef = MetaModel::GetAttributeDef($sClassName, $oAttDef->GetKeyAttCode());
  865. if (!$oExtKeyAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  866. {
  867. $sStar = '*';
  868. }
  869. $sRemoteAttLabel = MetaModel::GetLabel($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  870. $oTargetAttDef = MetaModel::GetAttributeDef($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  871. $sSuffix = '';
  872. if ($oTargetAttDef->IsExternalKey())
  873. {
  874. $sSuffix = '->id';
  875. }
  876. $aHeader[] = $sExtKeyLabel.'->'.$sRemoteAttLabel.$sSuffix.$sStar;
  877. }
  878. else
  879. {
  880. if (!$oAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  881. {
  882. $sStar = '*';
  883. }
  884. $aHeader[] = MetaModel::GetLabel($sClassName, $sAttCode).$sStar;
  885. }
  886. }
  887. }
  888. $sHtml = implode($sSeparator, $aHeader)."\n";
  889. $oSet->Seek(0);
  890. while ($aObjects = $oSet->FetchAssoc())
  891. {
  892. $aRow = array();
  893. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  894. {
  895. $oObj = $aObjects[$sAlias];
  896. if (is_null($oObj))
  897. {
  898. $aRow[] = '';
  899. }
  900. else
  901. {
  902. $aRow[] = $oObj->GetKey();
  903. }
  904. foreach($aList[$sClassName] as $sAttCode => $oAttDef)
  905. {
  906. if (is_null($oObj))
  907. {
  908. $aRow[] = '';
  909. }
  910. else
  911. {
  912. $aRow[] = $oObj->GetAsCSV($sAttCode, $sSeparator, $sTextQualifier);
  913. }
  914. }
  915. }
  916. $sHtml .= implode($sSeparator, $aRow)."\n";
  917. }
  918. return $sHtml;
  919. }
  920. static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  921. {
  922. $oAppContext = new ApplicationContext();
  923. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  924. $aAuthorizedClasses = array();
  925. foreach($aClasses as $sAlias => $sClassName)
  926. {
  927. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  928. {
  929. $aAuthorizedClasses[$sAlias] = $sClassName;
  930. }
  931. }
  932. $aAttribs = array();
  933. $aList = array();
  934. $aList[$sClassName] = MetaModel::GetZListItems($sClassName, 'details');
  935. $oPage->add("<Set>\n");
  936. $oSet->Seek(0);
  937. while ($aObjects = $oSet->FetchAssoc())
  938. {
  939. if (count($aAuthorizedClasses) > 1)
  940. {
  941. $oPage->add("<Row>\n");
  942. }
  943. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  944. {
  945. $oObj = $aObjects[$sAlias];
  946. if (is_null($oObj))
  947. {
  948. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"null\">\n");
  949. }
  950. else
  951. {
  952. $sClassName = get_class($oObj);
  953. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
  954. }
  955. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
  956. {
  957. if (is_null($oObj))
  958. {
  959. $oPage->add("<$sAttCode>null</$sAttCode>\n");
  960. }
  961. else
  962. {
  963. if ($oAttDef->IsWritable())
  964. {
  965. $sValue = $oObj->GetAsXML($sAttCode);
  966. $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
  967. }
  968. }
  969. }
  970. $oPage->add("</$sClassName>\n");
  971. }
  972. if (count($aAuthorizedClasses) > 1)
  973. {
  974. $oPage->add("</Row>\n");
  975. }
  976. }
  977. $oPage->add("</Set>\n");
  978. }
  979. public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  980. {
  981. $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
  982. }
  983. public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  984. {
  985. static $iSearchFormId = 0;
  986. $oAppContext = new ApplicationContext();
  987. $sHtml = '';
  988. $numCols=4;
  989. $sClassName = $oSet->GetFilter()->GetClass();
  990. // Romain: temporarily removed the tab "OQL query" because it was not finalized
  991. // (especially when used to add a link)
  992. /*
  993. $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
  994. <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
  995. <li><a class=\"selected\" href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:SimpleSearchTab')."</a></li>
  996. </ul></div>\n";
  997. */
  998. // Simple search form
  999. if (isset($aExtraParams['currentId']))
  1000. {
  1001. $sSearchFormId = $aExtraParams['currentId'];
  1002. }
  1003. else
  1004. {
  1005. $iSearchFormId = $oPage->GetUniqueId();
  1006. $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
  1007. $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
  1008. }
  1009. // Check if the current class has some sub-classes
  1010. if (isset($aExtraParams['baseClass']))
  1011. {
  1012. $sRootClass = $aExtraParams['baseClass'];
  1013. }
  1014. else
  1015. {
  1016. $sRootClass = $sClassName;
  1017. }
  1018. $aSubClasses = MetaModel::GetSubclasses($sRootClass);
  1019. if (count($aSubClasses) > 0)
  1020. {
  1021. $aOptions = array();
  1022. $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
  1023. foreach($aSubClasses as $sSubclassName)
  1024. {
  1025. $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
  1026. }
  1027. $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
  1028. ksort($aOptions);
  1029. $sContext = $oAppContext->GetForLink();
  1030. $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
  1031. }
  1032. else
  1033. {
  1034. $sClassesCombo = MetaModel::GetName($sClassName);
  1035. }
  1036. $oUnlimitedFilter = new DBObjectSearch($sClassName);
  1037. $sAction = (isset($aExtraParams['action'])) ? $aExtraParams['action'] : '../pages/UI.php';
  1038. $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"{$sAction}\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  1039. $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
  1040. $index = 0;
  1041. $sHtml .= "<p>\n";
  1042. $aFilterCriteria = $oSet->GetFilter()->GetCriteria();
  1043. $aMapCriteria = array();
  1044. foreach($aFilterCriteria as $aCriteria)
  1045. {
  1046. $aMapCriteria[$aCriteria['filtercode']][] = array('value' => $aCriteria['value'], 'opcode' => $aCriteria['opcode']);
  1047. }
  1048. $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
  1049. foreach($aList as $sFilterCode)
  1050. {
  1051. //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
  1052. $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
  1053. $sFilterValue = '';
  1054. $sFilterValue = utils::ReadParam($sFilterCode, '');
  1055. $sFilterOpCode = null; // Use the default 'loose' OpCode
  1056. if (empty($sFilterValue))
  1057. {
  1058. if (isset($aMapCriteria[$sFilterCode]))
  1059. {
  1060. if (count($aMapCriteria[$sFilterCode]) > 1)
  1061. {
  1062. $sFilterValue = Dict::S('UI:SearchValue:Mixed');
  1063. }
  1064. else
  1065. {
  1066. $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
  1067. $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
  1068. }
  1069. if ($sFilterCode != 'company')
  1070. {
  1071. $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
  1072. }
  1073. }
  1074. }
  1075. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
  1076. if ($aAllowedValues != null)
  1077. {
  1078. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sFilterCode);
  1079. if ($oAttDef->IsExternalKey())
  1080. {
  1081. $iFieldSize = $oAttDef->GetMaxSize();
  1082. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  1083. $oWidget = new UIExtKeyWidget($sFilterCode, $sClassName, $oAttDef->GetLabel(), $aAllowedValues, $sFilterValue, 'search_'.$sFilterCode, false, '', '', '');
  1084. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;";
  1085. $sHtml .= $oWidget->Display($oPage, $aExtraParams, true /* bSearchMode */);
  1086. }
  1087. else
  1088. {
  1089. //Enum field or external key, display a combo
  1090. $sValue = "<select name=\"$sFilterCode\">\n";
  1091. $sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  1092. foreach($aAllowedValues as $key => $value)
  1093. {
  1094. if ($sFilterValue == $key)
  1095. {
  1096. $sSelected = ' selected';
  1097. }
  1098. else
  1099. {
  1100. $sSelected = '';
  1101. }
  1102. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  1103. }
  1104. $sValue .= "</select>\n";
  1105. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;$sValue\n";
  1106. }
  1107. unset($aExtraParams[$sFilterCode]);
  1108. }
  1109. else
  1110. {
  1111. // Any value is possible, display an input box
  1112. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;<input class=\"textSearch\" name=\"$sFilterCode\" value=\"$sFilterValue\"/>\n";
  1113. unset($aExtraParams[$sFilterCode]);
  1114. }
  1115. $index++;
  1116. $sHtml .= '</span> ';
  1117. }
  1118. $sHtml .= "</p>\n";
  1119. $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
  1120. foreach($aExtraParams as $sName => $sValue)
  1121. {
  1122. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1123. }
  1124. $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
  1125. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1126. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
  1127. $sHtml .= $oAppContext->GetForForm();
  1128. $sHtml .= "</form>\n";
  1129. if (!isset($aExtraParams['currentId']))
  1130. {
  1131. $sHtml .= "</div><!-- Simple search form -->\n";
  1132. }
  1133. /*
  1134. // OQL query builder
  1135. $sHtml .= "<div id=\"OQLQuery{$iSearchFormId}\" style=\"display:none\" class=\"mini_tab{$iSearchFormId}\">\n";
  1136. $sHtml .= "<h1>".Dict::S('UI:OQLQueryBuilderTitle')."</h1>\n";
  1137. $sHtml .= "<form id=\"formOQL{$iSearchFormId}\"><table style=\"width:80%;\"><tr style=\"vertical-align:top\">\n";
  1138. $sHtml .= "<td style=\"text-align:right\"><label>SELECT&nbsp;</label><select name=\"oql_class\">";
  1139. $aClasses = MetaModel::EnumChildClasses($sClassName, ENUM_CHILD_CLASSES_ALL);
  1140. $sSelectedClass = utils::ReadParam('oql_class', $sClassName);
  1141. $sOQLClause = utils::ReadParam('oql_clause', '');
  1142. asort($aClasses);
  1143. foreach($aClasses as $sChildClass)
  1144. {
  1145. $sSelected = ($sChildClass == $sSelectedClass) ? 'selected' : '';
  1146. $sHtml.= "<option value=\"$sChildClass\" $sSelected>".MetaModel::GetName($sChildClass)."</option>\n";
  1147. }
  1148. $sHtml .= "</select>&nbsp;</td><td>\n";
  1149. $sHtml .= "<textarea name=\"oql_clause\" style=\"width:100%\">$sOQLClause</textarea></td></tr>\n";
  1150. $sHtml .= "<tr><td colspan=\"2\" style=\"text-align:right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Query')."\"></td></tr>\n";
  1151. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1152. foreach($aExtraParams as $sName => $sValue)
  1153. {
  1154. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1155. }
  1156. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
  1157. $sHtml .= $oAppContext->GetForForm();
  1158. $sHtml .= "</table></form>\n";
  1159. $sHtml .= "</div><!-- OQL query form -->\n";
  1160. */
  1161. return $sHtml;
  1162. }
  1163. public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
  1164. {
  1165. static $iInputId = 0;
  1166. $sFieldPrefix = '';
  1167. $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
  1168. $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
  1169. if (isset($aArgs[$sAttCode]) && empty($value))
  1170. {
  1171. // default value passed by the context (either the app context of the operation)
  1172. $value = $aArgs[$sAttCode];
  1173. }
  1174. if (!empty($iId))
  1175. {
  1176. $iInputId = $iId;
  1177. }
  1178. else
  1179. {
  1180. $iInputId = $oPage->GetUniqueId();
  1181. }
  1182. if (!$oAttDef->IsExternalField())
  1183. {
  1184. $bMandatory = 'false';
  1185. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1186. {
  1187. $bMandatory = 'true';
  1188. }
  1189. $sValidationField = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
  1190. $sHelpText = $oAttDef->GetHelpOnEdition();
  1191. $aEventsList = array();
  1192. switch($oAttDef->GetEditClass())
  1193. {
  1194. case 'Date':
  1195. case 'DateTime':
  1196. $aEventsList[] ='validate';
  1197. $aEventsList[] ='keyup';
  1198. $aEventsList[] ='change';
  1199. $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"20\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1200. break;
  1201. case 'Duration':
  1202. $aEventsList[] ='validate';
  1203. $aEventsList[] ='change';
  1204. $oPage->add_ready_script("$('#{$iId}_d').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1205. $oPage->add_ready_script("$('#{$iId}_h').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1206. $oPage->add_ready_script("$('#{$iId}_m').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1207. $oPage->add_ready_script("$('#{$iId}_s').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1208. $aVal = AttributeDuration::SplitDuration($value);
  1209. $sDays = "<input title=\"$sHelpText\" type=\"text\" size=\"3\" name=\"attr_{$sFieldPrefix}{$sAttCode}[d]{$sNameSuffix}\" value=\"{$aVal['days']}\" id=\"{$iId}_d\"/>";
  1210. $sHours = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[h]{$sNameSuffix}\" value=\"{$aVal['hours']}\" id=\"{$iId}_h\"/>";
  1211. $sMinutes = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[m]{$sNameSuffix}\" value=\"{$aVal['minutes']}\" id=\"{$iId}_m\"/>";
  1212. $sSeconds = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[s]{$sNameSuffix}\" value=\"{$aVal['seconds']}\" id=\"{$iId}_s\"/>";
  1213. $sHidden = "<input type=\"hidden\" id=\"{$iId}\" value=\"$value\"/>";
  1214. $sHTMLValue = Dict::Format('UI:DurationForm_Days_Hours_Minutes_Seconds', $sDays, $sHours, $sMinutes, $sSeconds).$sHidden."&nbsp;".$sValidationField;
  1215. $oPage->add_ready_script("$('#{$iId}').bind('update', function(evt, sFormId) { return ToggleDurationField('$iId'); });");
  1216. break;
  1217. case 'Password':
  1218. $aEventsList[] ='validate';
  1219. $aEventsList[] ='keyup';
  1220. $aEventsList[] ='change';
  1221. $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1222. break;
  1223. case 'Text':
  1224. $aEventsList[] ='validate';
  1225. $aEventsList[] ='keyup';
  1226. $aEventsList[] ='change';
  1227. $sEditValue = $oAttDef->GetEditValue($value);
  1228. $aStyles = array();
  1229. $sStyle = '';
  1230. $sWidth = $oAttDef->GetWidth('width', '');
  1231. if (!empty($sWidth))
  1232. {
  1233. $aStyles[] = 'width:'.$sWidth;
  1234. }
  1235. $sHeight = $oAttDef->GetHeight('height', '');
  1236. if (!empty($sHeight))
  1237. {
  1238. $aStyles[] = 'height:'.$sHeight;
  1239. }
  1240. if (count($aStyles) > 0)
  1241. {
  1242. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1243. }
  1244. $sHTMLValue = "<table><tr><td><textarea class=\"resizable\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\" $sStyle>$sEditValue</textarea></td><td>{$sValidationField}</td></tr></table>";
  1245. break;
  1246. case 'CaseLog':
  1247. $aEventsList[] ='validate';
  1248. $aEventsList[] ='keyup';
  1249. $aEventsList[] ='change';
  1250. $aStyles = array();
  1251. $sStyle = '';
  1252. $sWidth = $oAttDef->GetWidth('width', '');
  1253. if (!empty($sWidth))
  1254. {
  1255. $aStyles[] = 'width:'.$sWidth;
  1256. }
  1257. $sHeight = $oAttDef->GetHeight('height', '');
  1258. if (!empty($sHeight))
  1259. {
  1260. $aStyles[] = 'height:'.$sHeight;
  1261. }
  1262. if (count($aStyles) > 0)
  1263. {
  1264. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1265. }
  1266. $sHeader = '<div class="caselog_input_header">&nbsp;'.Dict::S('UI:CaseLogTypeYourTextHere').'</div>';
  1267. $sEditValue = $oAttDef->GetEditValue($value);
  1268. $sPreviousLog = $value->GetAsHTML();
  1269. $sHTMLValue = "<div class=\"caselog\" $sStyle><table style=\"width:100%;\"><tr><td>$sHeader<textarea style=\"border:0;width:100%\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">$sEditValue</textarea>$sPreviousLog</td><td>{$sValidationField}</td></tr></table></div>";
  1270. break;
  1271. case 'HTML':
  1272. $oWidget = new UIHTMLEditorWidget($iId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $value, $bMandatory);
  1273. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1274. break;
  1275. case 'LinkedSet':
  1276. $aEventsList[] ='validate';
  1277. $aEventsList[] ='change';
  1278. $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed());
  1279. $sHTMLValue = $oWidget->Display($oPage, $value);
  1280. break;
  1281. case 'Document':
  1282. $aEventsList[] ='validate';
  1283. $aEventsList[] ='change';
  1284. $oDocument = $value; // Value is an ormDocument object
  1285. $sFileName = '';
  1286. if (is_object($oDocument))
  1287. {
  1288. $sFileName = $oDocument->GetFileName();
  1289. }
  1290. $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  1291. $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
  1292. $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" type=\"hidden\" id=\"$iId\" \" value=\"$sFileName\"/>\n";
  1293. $sHTMLValue .= "<span id=\"name_$iInputId\">$sFileName</span><br/>\n";
  1294. $sHTMLValue .= "<input title=\"$sHelpText\" name=\"file_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/>&nbsp;{$sValidationField}\n";
  1295. break;
  1296. case 'List':
  1297. // Not editable for now...
  1298. $sHTMLValue = '';
  1299. break;
  1300. case 'One Way Password':
  1301. $aEventsList[] ='validate';
  1302. $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
  1303. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1304. // Event list & validation is handled directly by the widget
  1305. break;
  1306. case 'ExtKey':
  1307. $aEventsList[] ='validate';
  1308. $aEventsList[] ='change';
  1309. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1310. $iFieldSize = $oAttDef->GetMaxSize();
  1311. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  1312. $oWidget = new UIExtKeyWidget($sAttCode, $sClass, $oAttDef->GetLabel(), $aAllowedValues, $value, $iId, $bMandatory, $sNameSuffix, $sFieldPrefix, $sFormPrefix);
  1313. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1314. $sHTMLValue .= "<!-- iFlags: $iFlags bMandatory: $bMandatory -->\n";
  1315. break;
  1316. case 'String':
  1317. default:
  1318. $aEventsList[] ='validate';
  1319. // #@# todo - add context information (depending on dimensions)
  1320. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1321. $iFieldSize = $oAttDef->GetMaxSize();
  1322. if ($aAllowedValues !== null)
  1323. {
  1324. // Discrete list of values, use a SELECT
  1325. $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
  1326. $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
  1327. foreach($aAllowedValues as $key => $display_value)
  1328. {
  1329. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  1330. {
  1331. // When there is only once choice, select it by default
  1332. $sSelected = ' selected';
  1333. }
  1334. else
  1335. {
  1336. $sSelected = ($value == $key) ? ' selected' : '';
  1337. }
  1338. $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
  1339. }
  1340. $sHTMLValue .= "</select>&nbsp;{$sValidationField}\n";
  1341. $aEventsList[] ='change';
  1342. }
  1343. else
  1344. {
  1345. $sHTMLValue = "<input title=\"$sHelpText\" type=\"text\" size=\"30\" maxlength=\"$iFieldSize\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1346. $aEventsList[] ='keyup';
  1347. $aEventsList[] ='change';
  1348. }
  1349. break;
  1350. }
  1351. $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
  1352. if (!empty($aEventsList))
  1353. {
  1354. $sNullValue = $oAttDef->GetNullValue();
  1355. if (!is_numeric($sNullValue))
  1356. {
  1357. $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
  1358. }
  1359. $oPage->add_ready_script("$('#$iId').bind('".implode(' ', $aEventsList)."', function(evt, sFormId) { return ValidateField('$iId', '$sPattern', $bMandatory, sFormId, $sNullValue) } );\n"); // Bind to a custom event: validate
  1360. }
  1361. $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
  1362. if (count($aDependencies) > 0)
  1363. {
  1364. $oPage->add_ready_script("$('#$iId').bind('change', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
  1365. }
  1366. }
  1367. return "<div>{$sHTMLValue}</div>";
  1368. }
  1369. public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
  1370. {
  1371. self::$iGlobalFormId++;
  1372. $sPrefix = '';
  1373. if (isset($aExtraParams['formPrefix']))
  1374. {
  1375. $sPrefix = $aExtraParams['formPrefix'];
  1376. }
  1377. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  1378. $this->m_iFormId = $sPrefix.self::$iGlobalFormId;
  1379. $sClass = get_class($this);
  1380. $oAppContext = new ApplicationContext();
  1381. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1382. $iKey = $this->GetKey();
  1383. $aDetails = array();
  1384. $aFieldsMap = array();
  1385. if (!isset($aExtraParams['action']))
  1386. {
  1387. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  1388. }
  1389. else
  1390. {
  1391. $sFormAction = $aExtraParams['action'];
  1392. }
  1393. $iTransactionId = utils::GetNewTransactionId();
  1394. $oPage->SetTransactionId($iTransactionId);
  1395. $oPage->add("<form action=\"$sFormAction\" id=\"form_{$this->m_iFormId}\" enctype=\"multipart/form-data\" method=\"post\" onSubmit=\"return CheckFields('form_{$this->m_iFormId}', true)\">\n");
  1396. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
  1397. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  1398. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  1399. // $aDetailsList = $this->FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  1400. //$aFullList = MetaModel::ListAttributeDefs($sClass);
  1401. $aList = array();
  1402. // Compute the list of properties to display, first the attributes in the 'details' list, then
  1403. // all the remaining attributes that are not external fields
  1404. // foreach($aDetailsList as $sAttCode)
  1405. // {
  1406. // $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1407. // if (!$oAttDef->IsExternalField())
  1408. // {
  1409. // $aList[] = $sAttCode;
  1410. // }
  1411. // }
  1412. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  1413. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  1414. $sHtml = '';
  1415. $aDetails = array();
  1416. foreach($aDetailsStruct as $sTab => $aCols )
  1417. {
  1418. $aDetails[$sTab] = array();
  1419. ksort($aCols);
  1420. $oPage->SetCurrentTab(Dict::S($sTab));
  1421. $oPage->add('<table style="vertical-align:top"><tr>');
  1422. foreach($aCols as $sColIndex => $aFieldsets)
  1423. {
  1424. $sLabel = '';
  1425. $sPreviousLabel = '';
  1426. $aDetails[$sTab][$sColIndex] = array();
  1427. $oPage->add('<td style="vertical-align:top">');
  1428. //$aDetails[$sTab][$sColIndex] = array();
  1429. foreach($aFieldsets as $sFieldsetName => $aFields)
  1430. {
  1431. if (!empty($sFieldsetName) && ($sFieldsetName[0]!='_'))
  1432. {
  1433. $sLabel = $sFieldsetName;
  1434. }
  1435. else
  1436. {
  1437. $sLabel = '';
  1438. }
  1439. if ($sLabel != $sPreviousLabel)
  1440. {
  1441. if (!empty($sPreviousLabel))
  1442. {
  1443. $oPage->add('<fieldset>');
  1444. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  1445. }
  1446. $oPage->Details($aDetails[$sTab][$sColIndex]);
  1447. if (!empty($sPreviousLabel))
  1448. {
  1449. $oPage->add('</fieldset>');
  1450. }
  1451. $aDetails[$sTab][$sColIndex] = array();
  1452. $sPreviousLabel = $sLabel;
  1453. }
  1454. foreach($aFields as $sAttCode)
  1455. {
  1456. $aVal = null;
  1457. $sComments = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '&nbsp;';
  1458. $sInfos = '&nbsp;';
  1459. $iFlags = $this->GetAttributeFlags($sAttCode);
  1460. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1461. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
  1462. {
  1463. if ($oAttDef->IsWritable())
  1464. {
  1465. if ($sStateAttCode == $sAttCode)
  1466. {
  1467. // State attribute is always read-only from the UI
  1468. $sHTMLValue = $this->GetStateLabel();
  1469. $aVal = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  1470. }
  1471. else
  1472. {
  1473. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  1474. if ($iFlags & OPT_ATT_HIDDEN)
  1475. {
  1476. // Attribute is hidden, add a hidden input
  1477. $oPage->add('<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>');
  1478. $aFieldsMap[$sAttCode] = $sInputId;
  1479. }
  1480. else
  1481. {
  1482. if ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE))
  1483. {
  1484. // Check if the attribute is not read-only becuase of a synchro...
  1485. $aReasons = array();
  1486. $sSynchroIcon = '';
  1487. if ($iFlags & OPT_ATT_SLAVE)
  1488. {
  1489. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  1490. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  1491. $sTip = '';
  1492. foreach($aReasons as $aRow)
  1493. {
  1494. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  1495. }
  1496. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  1497. }
  1498. // Attribute is read-only
  1499. $sHTMLValue = $this->GetAsHTML($sAttCode);
  1500. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  1501. $aFieldsMap[$sAttCode] = $sInputId;
  1502. $sComments = $sSynchroIcon;
  1503. }
  1504. else
  1505. {
  1506. $sValue = $this->Get($sAttCode);
  1507. $sDisplayValue = $this->GetEditValue($sAttCode);
  1508. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  1509. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  1510. $aFieldsMap[$sAttCode] = $sInputId;
  1511. }
  1512. $aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  1513. }
  1514. }
  1515. }
  1516. else
  1517. {
  1518. $aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $this->GetAsHTML($sAttCode), 'comments' => $sComments, 'infos' => $sInfos);
  1519. }
  1520. }
  1521. if ($aVal != null)
  1522. {
  1523. // The field is visible, add it to the current column
  1524. $aDetails[$sTab][$sColIndex][] = $aVal;
  1525. }
  1526. }
  1527. }
  1528. if (!empty($sPreviousLabel))
  1529. {
  1530. $oPage->add('<fieldset>');
  1531. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  1532. }
  1533. $oPage->Details($aDetails[$sTab][$sColIndex]);
  1534. if (!empty($sPreviousLabel))
  1535. {
  1536. $oPage->add('</fieldset>');
  1537. }
  1538. $oPage->add('</td>');
  1539. }
  1540. $oPage->add('</tr></table>');
  1541. }
  1542. // Special case to display the case log, if any...
  1543. if (MetaModel::IsValidAttCode($sClass, 'ticket_log'))
  1544. {
  1545. $oAttDef = MetaModel::GetAttributeDef($sClass, 'ticket_log');
  1546. if ($oAttDef instanceof AttributeCaseLog)
  1547. {
  1548. $sComments = isset($aFieldsComments['ticket_log']) ? $aFieldsComments['ticket_log'] : '&nbsp;';
  1549. $this->DisplayCaseLog($oPage, 'ticket_log', $sComments, $sPrefix, true);
  1550. $sInputId = $this->m_iFormId.'_ticket_log';
  1551. $aFieldsMap['ticket_log'] = $sInputId;
  1552. }
  1553. }
  1554. // Now display the relations, one tab per relation
  1555. if (!isset($aExtraParams['noRelations']))
  1556. {
  1557. $this->DisplayBareRelations($oPage, true); // Edit mode
  1558. }
  1559. $oPage->SetCurrentTab('');
  1560. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  1561. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"$iTransactionId\">\n");
  1562. foreach($aExtraParams as $sName => $value)
  1563. {
  1564. $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
  1565. }
  1566. $oPage->add($oAppContext->GetForForm());
  1567. // Custom operation for the form ?
  1568. if (isset($aExtraParams['custom_operation']))
  1569. {
  1570. $sOperation = $aExtraParams['custom_operation'];
  1571. }
  1572. else if ($iKey > 0)
  1573. {
  1574. $sOperation = 'apply_modify';
  1575. }
  1576. else
  1577. {
  1578. $sOperation = 'apply_new';
  1579. }
  1580. // Custom label for the apply button ?
  1581. if (isset($aExtraParams['custom_button']))
  1582. {
  1583. $sApplyButton = $aExtraParams['custom_button'];
  1584. }
  1585. else if ($iKey > 0)
  1586. {
  1587. $sApplyButton = Dict::S('UI:Button:Apply');
  1588. }
  1589. else
  1590. {
  1591. $sApplyButton = Dict::S('UI:Button:Create');
  1592. }
  1593. if ($iKey > 0)
  1594. {
  1595. // The object already exists in the database, it's a modification
  1596. $oPage->add("<input type=\"hidden\" name=\"id\" value=\"$iKey\">\n");
  1597. $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"{$sOperation}\">\n");
  1598. $oPage->add("<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1599. $oPage->add("<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n");
  1600. }
  1601. else
  1602. {
  1603. // The object does not exist in the database it's a creation
  1604. $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"$sOperation\">\n");
  1605. $oPage->add("<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1606. $oPage->add("<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n");
  1607. }
  1608. // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
  1609. $sDefaultUrl = '../pages/UI.php?operation=cancel';
  1610. $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl')} );");
  1611. $oPage->add("</form>\n");
  1612. $iFieldsCount = count($aFieldsMap);
  1613. $sJsonFieldsMap = json_encode($aFieldsMap);
  1614. $sState = $this->GetState();
  1615. $oPage->add_script(
  1616. <<<EOF
  1617. // Create the object once at the beginning of the page...
  1618. var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix', '$sState');
  1619. oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
  1620. oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
  1621. EOF
  1622. );
  1623. $oPage->add_ready_script(
  1624. <<<EOF
  1625. // Starts the validation when the page is ready
  1626. CheckFields('form_{$this->m_iFormId}', false);
  1627. EOF
  1628. );
  1629. }
  1630. public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
  1631. {
  1632. $oAppContext = new ApplicationContext();
  1633. $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
  1634. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1635. $aStates = MetaModel::EnumStates($sClass);
  1636. if ($oObjectToClone == null)
  1637. {
  1638. $oObj = MetaModel::NewObject($sClass);
  1639. if (!empty($sStateAttCode))
  1640. {
  1641. $sTargetState = MetaModel::GetDefaultState($sClass);
  1642. $oObj->Set($sStateAttCode, $sTargetState);
  1643. }
  1644. }
  1645. else
  1646. {
  1647. $oObj = clone $oObjectToClone;
  1648. }
  1649. // Pre-fill the object with default values, when there is only on possible choice
  1650. // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
  1651. $aArgs['this'] = $oObj;
  1652. $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  1653. // Order the fields based on their dependencies
  1654. $aDeps = array();
  1655. foreach($aDetailsList as $sAttCode)
  1656. {
  1657. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  1658. }
  1659. $aList = self::OrderDependentFields($aDeps);
  1660. // Now fill-in the fields with default/supplied values
  1661. foreach($aList as $sAttCode)
  1662. {
  1663. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1664. if (isset($aArgs['default'][$sAttCode]))
  1665. {
  1666. $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
  1667. }
  1668. elseif (count($aAllowedValues) == 1)
  1669. {
  1670. // If the field is mandatory, set it to the only possible value
  1671. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1672. $iFlags = $oObj->GetAttributeFlags($sAttCode);
  1673. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1674. {
  1675. $aValues = array_keys($aAllowedValues);
  1676. $oObj->Set($sAttCode, $aValues[0]);
  1677. }
  1678. }
  1679. }
  1680. return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
  1681. }
  1682. protected static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
  1683. {
  1684. //echo "<pre>ZList: ";
  1685. //print_r($aList);
  1686. //echo "</pre>\n";
  1687. $index = 0;
  1688. foreach($aList as $sKey => $value)
  1689. {
  1690. if (is_array($value))
  1691. {
  1692. if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
  1693. {
  1694. $sCode = $aMatches[1];
  1695. $sName = $aMatches[2];
  1696. switch($sCode)
  1697. {
  1698. case 'tab':
  1699. //echo "<p>Found a tab: $sName ($sKey)</p>\n";
  1700. if(!isset($aDetails[$sName]))
  1701. {
  1702. $aDetails[$sName] = array('col1' => array());
  1703. }
  1704. $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
  1705. break;
  1706. case 'fieldset':
  1707. //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
  1708. if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
  1709. {
  1710. $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
  1711. }
  1712. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
  1713. break;
  1714. default:
  1715. case 'col':
  1716. //echo "<p>Found a column: $sName ($sKey)</p>\n";
  1717. if(!isset($aDetails[$sCurrentTab][$sName]))
  1718. {
  1719. $aDetails[$sCurrentTab][$sName] = array();
  1720. }
  1721. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
  1722. break;
  1723. }
  1724. }
  1725. }
  1726. else
  1727. {
  1728. //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
  1729. if (empty($sCurrentSet))
  1730. {
  1731. $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
  1732. }
  1733. else
  1734. {
  1735. $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
  1736. }
  1737. }
  1738. $index++;
  1739. }
  1740. return $aDetails;
  1741. }
  1742. protected static function FlattenZList($aList)
  1743. {
  1744. $aResult = array();
  1745. foreach($aList as $value)
  1746. {
  1747. if (!is_array($value))
  1748. {
  1749. $aResult[] = $value;
  1750. }
  1751. else
  1752. {
  1753. $aResult = array_merge($aResult,self::FlattenZList($value));
  1754. }
  1755. }
  1756. return $aResult;
  1757. }
  1758. protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
  1759. {
  1760. $retVal = null;
  1761. $iFlags = $this->GetAttributeFlags($sAttCode);
  1762. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1763. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  1764. {
  1765. // The field is visible in the current state of the object
  1766. if ($sStateAttCode == $sAttCode)
  1767. {
  1768. // Special display for the 'state' attribute itself
  1769. $sDisplayValue = $this->GetStateLabel();
  1770. }
  1771. else if ($oAttDef->GetEditClass() == 'Document')
  1772. {
  1773. $oDocument = $this->Get($sAttCode);
  1774. $sDisplayValue = $this->GetAsHTML($sAttCode);
  1775. $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  1776. $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  1777. }
  1778. else
  1779. {
  1780. $sDisplayValue = $this->GetAsHTML($sAttCode);
  1781. }
  1782. $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  1783. }
  1784. return $retVal;
  1785. }
  1786. /**
  1787. * Displays a blob document *inline* (if possible, depending on the type of the document)
  1788. * @return string
  1789. */
  1790. public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
  1791. {
  1792. $oDoc = $this->Get($sAttCode);
  1793. $sClass = get_class($this);
  1794. $Id = $this->GetKey();
  1795. switch ($oDoc->GetMainMimeType())
  1796. {
  1797. case 'text':
  1798. case 'html':
  1799. $data = $oDoc->GetData();
  1800. switch($oDoc->GetMimeType())
  1801. {
  1802. case 'text/html':
  1803. case 'text/xml':
  1804. $oPage->add("<iframe id='preview_$sAttCode' src=\"../pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  1805. break;
  1806. default:
  1807. $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true), ENT_QUOTES, 'UTF-8')."</pre>\n");
  1808. }
  1809. break;
  1810. case 'application':
  1811. switch($oDoc->GetMimeType())
  1812. {
  1813. case 'application/pdf':
  1814. $oPage->add("<iframe id='preview_$sAttCode' src=\"../pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  1815. break;
  1816. default:
  1817. $oPage->add(Dict::S('UI:Document:NoPreview'));
  1818. }
  1819. break;
  1820. case 'image':
  1821. $oPage->add("<img src=\"../pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
  1822. break;
  1823. default:
  1824. $oPage->add(Dict::S('UI:Document:NoPreview'));
  1825. }
  1826. }
  1827. // $m_highlightComparison[previous][new] => next value
  1828. protected static $m_highlightComparison = array(
  1829. HILIGHT_CLASS_CRITICAL => array(
  1830. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  1831. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_CRITICAL,
  1832. HILIGHT_CLASS_OK => HILIGHT_CLASS_CRITICAL,
  1833. HILIGHT_CLASS_NONE => HILIGHT_CLASS_CRITICAL,
  1834. ),
  1835. HILIGHT_CLASS_WARNING => array(
  1836. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  1837. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  1838. HILIGHT_CLASS_OK => HILIGHT_CLASS_WARNING,
  1839. HILIGHT_CLASS_NONE => HILIGHT_CLASS_WARNING,
  1840. ),
  1841. HILIGHT_CLASS_OK => array(
  1842. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  1843. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  1844. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  1845. HILIGHT_CLASS_NONE => HILIGHT_CLASS_OK,
  1846. ),
  1847. HILIGHT_CLASS_NONE => array(
  1848. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  1849. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  1850. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  1851. HILIGHT_CLASS_NONE => HILIGHT_CLASS_NONE,
  1852. ),
  1853. );
  1854. /**
  1855. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  1856. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  1857. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1858. * To Be overridden by derived classes
  1859. * @param void
  1860. * @return String The desired higlight class for the object/row
  1861. */
  1862. public function GetHilightClass()
  1863. {
  1864. // Possible return values are:
  1865. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1866. $current = HILIGHT_CLASS_NONE; // Not hilighted by default
  1867. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  1868. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  1869. {
  1870. $new = $oExtensionInstance->GetHilightClass($this);
  1871. @$current = self::$m_highlightComparison[$current][$new];
  1872. }
  1873. return $current;
  1874. }
  1875. /**
  1876. * Re-order the fields based on their inter-dependencies
  1877. * @params hash @aFields field_code => array_of_depencies
  1878. * @return array Ordered array of fields or throws an exception
  1879. */
  1880. public static function OrderDependentFields($aFields)
  1881. {
  1882. $bCircular = false;
  1883. $aResult = array();
  1884. $iCount = 0;
  1885. do
  1886. {
  1887. $bSet = false;
  1888. $iCount++;
  1889. foreach($aFields as $sFieldCode => $aDeps)
  1890. {
  1891. foreach($aDeps as $key => $sDependency)
  1892. {
  1893. if (in_array($sDependency, $aResult))
  1894. {
  1895. // Dependency is resolved, remove it
  1896. unset($aFields[$sFieldCode][$key]);
  1897. }
  1898. }
  1899. if (count($aFields[$sFieldCode]) == 0)
  1900. {
  1901. // No more pending depencies for this field, add it to the list
  1902. $aResult[] = $sFieldCode;
  1903. unset($aFields[$sFieldCode]);
  1904. $bSet = true;
  1905. }
  1906. }
  1907. }
  1908. while($bSet && (count($aFields) > 0));
  1909. if (count($aFields) > 0)
  1910. {
  1911. $sMessage = "Error: Circular dependencies between the fields (or field missing in ZList) ! <pre>".print_r($aFields, true)."</pre>";
  1912. throw(new Exception($sMessage));
  1913. }
  1914. return $aResult;
  1915. }
  1916. /**
  1917. * Maps the given context parameter name to the appropriate filter/search code for this class
  1918. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  1919. * @return string Filter code, i.e. 'customer_id'
  1920. */
  1921. public static function MapContextParam($sContextParam)
  1922. {
  1923. if ($sContextParam == 'menu')
  1924. {
  1925. return null;
  1926. }
  1927. else
  1928. {
  1929. return $sContextParam;
  1930. }
  1931. }
  1932. /**
  1933. * Updates the object from the POSTed parameters
  1934. */
  1935. public function UpdateObject($sFormPrefix = '')
  1936. {
  1937. $aErrors = array();
  1938. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode=>$oAttDef)
  1939. {
  1940. if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  1941. {
  1942. $aLinks = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  1943. if (is_null($aLinks)) continue;
  1944. $sLinkedClass = $oAttDef->GetLinkedClass();
  1945. $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
  1946. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  1947. $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
  1948. if (is_array($aLinks))
  1949. {
  1950. foreach($aLinks as $id => $aData)
  1951. {
  1952. if (is_numeric($id))
  1953. {
  1954. if ($id < 0)
  1955. {
  1956. // New link to be created, the opposite of the id (-$id) is the ID of the remote object
  1957. $oLink = MetaModel::NewObject($sLinkedClass);
  1958. $oLink->Set($sExtKeyToRemote, -$id);
  1959. $oLink->Set($sExtKeyToMe, $this->GetKey());
  1960. }
  1961. else
  1962. {
  1963. // Existing link, potentially to be updated...
  1964. $oLink = MetaModel::GetObject($sLinkedClass, $id);
  1965. }
  1966. // Now populate the attributes
  1967. foreach($aData as $sName => $value)
  1968. {
  1969. if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
  1970. {
  1971. $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
  1972. if ($oLinkAttDef->IsWritable())
  1973. {
  1974. $oLink->Set($sName, $value);
  1975. }
  1976. }
  1977. }
  1978. $oLinkedSet->AddObject($oLink);
  1979. }
  1980. }
  1981. }
  1982. $this->Set($sAttCode, $oLinkedSet);
  1983. }
  1984. else if ($oAttDef->IsWritable())
  1985. {
  1986. $iFlags = $this->GetAttributeFlags($sAttCode);
  1987. if ( $iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
  1988. {
  1989. // Non-visible, or read-only attribute, do nothing
  1990. }
  1991. elseif($iFlags & OPT_ATT_SLAVE)
  1992. {
  1993. $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  1994. if (!is_null($value) && ($value != $this->Get($sAttCode)))
  1995. {
  1996. $aErrors[] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel());
  1997. }
  1998. }
  1999. elseif ($oAttDef->GetEditClass() == 'Document')
  2000. {
  2001. // There should be an uploaded file with the named attr_<attCode>
  2002. $oDocument = utils::ReadPostedDocument("file_{$sFormPrefix}{$sAttCode}");
  2003. if (!$oDocument->IsEmpty())
  2004. {
  2005. // A new file has been uploaded
  2006. $this->Set($sAttCode, $oDocument);
  2007. }
  2008. }
  2009. elseif ($oAttDef->GetEditClass() == 'One Way Password')
  2010. {
  2011. // Check if the password was typed/changed
  2012. $bChanged = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_changed", false);
  2013. if ($bChanged)
  2014. {
  2015. // The password has been changed or set
  2016. $rawValue = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  2017. $this->Set($sAttCode, $rawValue);
  2018. }
  2019. }
  2020. elseif ($oAttDef->GetEditClass() == 'Duration')
  2021. {
  2022. $rawValue = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  2023. if (!is_array($rawValue)) continue;
  2024. $iValue = (((24*$rawValue['d'])+$rawValue['h'])*60 +$rawValue['m'])*60 + $rawValue['s'];
  2025. $this->Set($sAttCode, $iValue);
  2026. $previousValue = $this->Get($sAttCode);
  2027. if ($previousValue !== $iValue)
  2028. {
  2029. $this->Set($sAttCode, $iValue);
  2030. }
  2031. }
  2032. else
  2033. {
  2034. $rawValue = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  2035. if (!is_null($rawValue))
  2036. {
  2037. $aAttributes[$sAttCode] = trim($rawValue);
  2038. $previousValue = $this->Get($sAttCode);
  2039. if ($previousValue !== $aAttributes[$sAttCode])
  2040. {
  2041. $this->Set($sAttCode, $aAttributes[$sAttCode]);
  2042. }
  2043. }
  2044. }
  2045. }
  2046. }
  2047. // Invoke extensions after the update of the object from the form
  2048. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2049. {
  2050. $oExtensionInstance->OnFormSubmit($this, $sFormPrefix);
  2051. }
  2052. return $aErrors;
  2053. }
  2054. protected function DBInsertTracked_Internal($bDoNotReload = false)
  2055. {
  2056. $res = parent::DBInsertTracked_Internal($bDoNotReload);
  2057. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2058. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2059. {
  2060. $oExtensionInstance->OnDBInsert($this, self::$m_oCurrChange);
  2061. }
  2062. return $res;
  2063. }
  2064. protected function DBCloneTracked_Internal($newKey = null)
  2065. {
  2066. $oNewObj = parent::DBCloneTracked_Internal($newKey);
  2067. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2068. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2069. {
  2070. $oExtensionInstance->OnDBInsert($oNewObj, self::$m_oCurrChange);
  2071. }
  2072. return $oNewObj;
  2073. }
  2074. protected function DBUpdateTracked_Internal()
  2075. {
  2076. $res = parent::DBUpdateTracked_Internal();
  2077. // Invoke extensions after the update (could be before)
  2078. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2079. {
  2080. $oExtensionInstance->OnDBUpdate($this, self::$m_oCurrChange);
  2081. }
  2082. return $res;
  2083. }
  2084. protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
  2085. {
  2086. // Todo - invoke the extension
  2087. return parent::BulkUpdateTracked_Internal($oFilter, $aValues);
  2088. }
  2089. protected function DBDeleteTracked_Internal()
  2090. {
  2091. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2092. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2093. {
  2094. $oExtensionInstance->OnDBDelete($this, self::$m_oCurrChange);
  2095. }
  2096. return parent::DBDeleteTracked_Internal();
  2097. }
  2098. protected static function BulkDeleteTracked_Internal(DBObjectSearch $oFilter)
  2099. {
  2100. // Todo - invoke the extension
  2101. return parent::BulkDeleteTracked_Internal($oFilter);
  2102. }
  2103. public function DoCheckToWrite()
  2104. {
  2105. parent::DoCheckToWrite();
  2106. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2107. {
  2108. $aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
  2109. if (count($aNewIssues) > 0)
  2110. {
  2111. $this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
  2112. }
  2113. }
  2114. }
  2115. protected function DoCheckToDelete()
  2116. {
  2117. parent::DoCheckToDelete();
  2118. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2119. {
  2120. $aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
  2121. if (count($aNewIssues) > 0)
  2122. {
  2123. $this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
  2124. }
  2125. }
  2126. }
  2127. /**
  2128. * Special display where the case log uses the whole "screen" at the bottom of the "Properties" tab
  2129. */
  2130. public function DisplayCaseLog(WebPage $oPage, $sAttCode, $sComment = '', $sPrefix = '', $bEditMode = false)
  2131. {
  2132. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  2133. $sClass = get_class($this);
  2134. $iFlags = $this->GetAttributeFlags($sAttCode);
  2135. if ( $iFlags & OPT_ATT_HIDDEN)
  2136. {
  2137. // The case log is hidden do nothing
  2138. }
  2139. else
  2140. {
  2141. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2142. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  2143. if ((!$bEditMode) || ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
  2144. {
  2145. // Check if the attribute is not read-only becuase of a synchro...
  2146. $aReasons = array();
  2147. $sSynchroIcon = '';
  2148. if ($iFlags & OPT_ATT_SLAVE)
  2149. {
  2150. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  2151. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  2152. $sTip = '';
  2153. foreach($aReasons as $aRow)
  2154. {
  2155. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  2156. }
  2157. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  2158. }
  2159. // Attribute is read-only
  2160. $sHTMLValue = $this->GetAsHTML($sAttCode);
  2161. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  2162. $aFieldsMap[$sAttCode] = $sInputId;
  2163. $sComment .= $sSynchroIcon;
  2164. }
  2165. else
  2166. {
  2167. $sValue = $this->Get($sAttCode);
  2168. $sDisplayValue = $this->GetEditValue($sAttCode);
  2169. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  2170. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  2171. $aFieldsMap[$sAttCode] = $sInputId;
  2172. }
  2173. //$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  2174. $oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'&nbsp<span>'.$sComment.'</span></legend>');
  2175. $oPage->add($sHTMLValue);
  2176. $oPage->add('</fieldset>');
  2177. }
  2178. }
  2179. }
  2180. ?>