cmdbabstract.class.inc.php 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788
  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/utils.inc.php');
  32. require_once(APPROOT.'/application/applicationcontext.class.inc.php');
  33. require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
  34. require_once(APPROOT.'/application/ui.passwordwidget.class.inc.php');
  35. require_once(APPROOT.'/application/ui.extkeywidget.class.inc.php');
  36. require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
  37. abstract class cmdbAbstractObject extends CMDBObject
  38. {
  39. protected $m_iFormId; // The ID of the form used to edit the object (when in edition mode !)
  40. public static function GetUIPage()
  41. {
  42. return '../pages/UI.php';
  43. }
  44. public static function ComputeUIPage($sClass)
  45. {
  46. static $aUIPagesCache = array(); // Cache to store the php page used to display each class of object
  47. if (!isset($aUIPagesCache[$sClass]))
  48. {
  49. $UIPage = false;
  50. if (is_callable("$sClass::GetUIPage"))
  51. {
  52. $UIPage = eval("return $sClass::GetUIPage();"); // May return false in case of error
  53. }
  54. $aUIPagesCache[$sClass] = $UIPage === false ? './UI.php' : $UIPage;
  55. }
  56. $sPage = $aUIPagesCache[$sClass];
  57. return $sPage;
  58. }
  59. protected static function MakeHyperLink($sObjClass, $sObjKey, $sLabel = '')
  60. {
  61. if ($sObjKey <= 0) return '<em>'.Dict::S('UI:UndefinedObject').'</em>'; // Objects built in memory have negative IDs
  62. $oAppContext = new ApplicationContext();
  63. $sPage = self::ComputeUIPage($sObjClass);
  64. $sAbsoluteUrl = utils::GetAbsoluteUrlPath();
  65. // Safety net
  66. //
  67. if (empty($sLabel))
  68. {
  69. $sLabel = MetaModel::GetName($sObjClass)." #$sObjKey";
  70. }
  71. $sHint = MetaModel::GetName($sObjClass)."::$sObjKey";
  72. return "<a href=\"{$sAbsoluteUrl}{$sPage}?operation=details&class=$sObjClass&id=$sObjKey&".$oAppContext->GetForLink()."\" title=\"$sHint\">$sLabel</a>";
  73. }
  74. function DisplayBareHeader(WebPage $oPage, $bEditMode = false)
  75. {
  76. // Standard Header with name, actions menu and history block
  77. //
  78. // action menu
  79. $oSingletonFilter = new DBObjectSearch(get_class($this));
  80. $oSingletonFilter->AddCondition('id', $this->GetKey(), '=');
  81. $oBlock = new MenuBlock($oSingletonFilter, 'popup', false);
  82. $oBlock->Display($oPage, -1);
  83. $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()."&nbsp;\n");
  84. $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span></h1>\n");
  85. $oPage->add("</div>\n");
  86. }
  87. function DisplayBareHistory(WebPage $oPage, $bEditMode = false)
  88. {
  89. // history block (with as a tab)
  90. $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
  91. $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
  92. $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
  93. $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
  94. $oBlock->Display($oPage, -1);
  95. }
  96. function DisplayBareProperties(WebPage $oPage, $bEditMode = false)
  97. {
  98. $oPage->add($this->GetBareProperties($oPage, $bEditMode));
  99. }
  100. function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  101. {
  102. // Related objects: display all the linkset attributes, each as a separate tab
  103. // In the order described by the 'display' ZList
  104. $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  105. if (count($aList) == 0)
  106. {
  107. // Empty ZList defined, display all the linkedset attributes defined
  108. $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  109. }
  110. $sClass = get_class($this);
  111. foreach($aList as $sAttCode)
  112. {
  113. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  114. // Display mode
  115. if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
  116. $oPage->SetCurrentTab($oAttDef->GetLabel());
  117. if ($bEditMode)
  118. {
  119. $iFlags = $this->GetAttributeFlags($sAttCode);
  120. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  121. if (get_class($oAttDef) == 'AttributeLinkedSet')
  122. {
  123. // 1:n links
  124. $sTargetClass = $oAttDef->GetLinkedClass();
  125. if ($this->IsNew())
  126. {
  127. $oPage->p(Dict::Format('UI:BeforeAdding_Class_ObjectsSaveThisObject', MetaModel::GetName($sTargetClass)));
  128. }
  129. else
  130. {
  131. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  132. $oFilter = new DBObjectSearch($sTargetClass);
  133. $oFilter->AddCondition($oAttDef->GetExtKeyToMe(), $this->GetKey(),'=');
  134. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  135. $oAppContext = new ApplicationContext();
  136. foreach($oAppContext->GetNames() as $sKey)
  137. {
  138. // The linked object inherits the parent's value for the context
  139. if (MetaModel::IsValidAttCode($sClass, $sKey))
  140. {
  141. $aDefaults[$sKey] = $this->Get($sKey);
  142. }
  143. }
  144. $aParams = array(
  145. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  146. 'object_id' => $this->GetKey(),
  147. 'menu' => true,
  148. 'default' => $aDefaults,
  149. );
  150. $oBlock = new DisplayBlock($oFilter, 'list', false);
  151. $oBlock->Display($oPage, $sInputId, $aParams);
  152. }
  153. }
  154. else // get_class($oAttDef) == 'AttributeLinkedSetIndirect'
  155. {
  156. // n:n links
  157. $sLinkedClass = $oAttDef->GetLinkedClass();
  158. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  159. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  160. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
  161. $sValue = $this->Get($sAttCode);
  162. $sDisplayValue = $this->GetEditValue($sAttCode);
  163. $aArgs = array('this' => $this);
  164. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  165. $aFieldsMap[$sAttCode] = $sInputId;
  166. $oPage->add($sHTMLValue);
  167. }
  168. }
  169. else
  170. {
  171. // Display mode
  172. if (!$oAttDef->IsIndirect())
  173. {
  174. // 1:n links
  175. $sTargetClass = $oAttDef->GetLinkedClass();
  176. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  177. $oAppContext = new ApplicationContext();
  178. foreach($oAppContext->GetNames() as $sKey)
  179. {
  180. // The linked object inherits the parent's value for the context
  181. if (MetaModel::IsValidAttCode($sClass, $sKey))
  182. {
  183. $aDefaults[$sKey] = $this->Get($sKey);
  184. }
  185. }
  186. $aParams = array(
  187. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  188. 'object_id' => $this->GetKey(),
  189. 'menu' => false,
  190. 'default' => $aDefaults,
  191. );
  192. }
  193. else
  194. {
  195. // n:n links
  196. $sLinkedClass = $oAttDef->GetLinkedClass();
  197. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  198. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  199. $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
  200. $aParams = array(
  201. 'link_attr' => $oAttDef->GetExtKeyToMe(),
  202. 'object_id' => $this->GetKey(),
  203. 'target_attr' => $oAttDef->GetExtKeyToRemote(),
  204. 'view_link' => false,
  205. 'menu' => false,
  206. 'display_limit' => true, // By default limit the list to speed up the initial load & display
  207. );
  208. }
  209. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  210. $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
  211. $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
  212. }
  213. }
  214. $oPage->SetCurrentTab('');
  215. if (!$bEditMode)
  216. {
  217. // Get the actual class of the current object
  218. // And look for triggers referring to it
  219. // If any trigger has been found then display a tab with notifications
  220. //
  221. $sClass = get_class($this);
  222. $sClassList = implode("', '", MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL));
  223. $oTriggerSet = new CMDBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnObject AS T WHERE T.target_class IN ('$sClassList')"));
  224. if ($oTriggerSet->Count() > 0)
  225. {
  226. $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab'));
  227. // Display notifications regarding the object
  228. $iId = $this->GetKey();
  229. $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);
  230. $oBlock->Display($oPage, 'notifications', array());
  231. }
  232. }
  233. }
  234. function GetBareProperties(WebPage $oPage, $bEditMode = false)
  235. {
  236. $sHtml = '';
  237. $oAppContext = new ApplicationContext();
  238. $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
  239. $aDetails = array();
  240. $sClass = get_class($this);
  241. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  242. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  243. // Compute the list of properties to display, first the attributes in the 'details' list, then
  244. // all the remaining attributes that are not external fields
  245. $sHtml = '';
  246. $aDetails = array();
  247. foreach($aDetailsStruct as $sTab => $aCols )
  248. {
  249. $aDetails[$sTab] = array();
  250. ksort($aCols);
  251. $oPage->SetCurrentTab(Dict::S($sTab));
  252. $oPage->add('<table style="vertical-align:top"><tr>');
  253. foreach($aCols as $sColIndex => $aFieldsets)
  254. {
  255. $oPage->add('<td style="vertical-align:top">');
  256. //$aDetails[$sTab][$sColIndex] = array();
  257. $sLabel = '';
  258. $sPreviousLabel = '';
  259. $aDetails[$sTab][$sColIndex] = array();
  260. foreach($aFieldsets as $sFieldsetName => $aFields)
  261. {
  262. if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
  263. {
  264. $sLabel = $sFieldsetName;
  265. }
  266. else
  267. {
  268. $sLabel = '';
  269. }
  270. if ($sLabel != $sPreviousLabel)
  271. {
  272. if (!empty($sPreviousLabel))
  273. {
  274. $oPage->add('<fieldset>');
  275. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  276. }
  277. $oPage->Details($aDetails[$sTab][$sColIndex]);
  278. if (!empty($sPreviousLabel))
  279. {
  280. $oPage->add('</fieldset>');
  281. }
  282. $aDetails[$sTab][$sColIndex] = array();
  283. $sPreviousLabel = $sLabel;
  284. }
  285. foreach($aFields as $sAttCode)
  286. {
  287. $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
  288. if ($val != null)
  289. {
  290. // The field is visible, add it to the current column
  291. $aDetails[$sTab][$sColIndex][] = $val;
  292. }
  293. }
  294. }
  295. if (!empty($sPreviousLabel))
  296. {
  297. $oPage->add('<fieldset>');
  298. $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
  299. }
  300. $oPage->Details($aDetails[$sTab][$sColIndex]);
  301. if (!empty($sPreviousLabel))
  302. {
  303. $oPage->add('</fieldset>');
  304. }
  305. $oPage->add('</td>');
  306. }
  307. $oPage->add('</tr></table>');
  308. }
  309. return $sHtml;
  310. }
  311. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  312. {
  313. $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
  314. if (!empty($sTemplate))
  315. {
  316. $oTemplate = new DisplayTemplate($sTemplate);
  317. // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
  318. // but the preferred method is to use '$id$'
  319. $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')));
  320. }
  321. else
  322. {
  323. // Object's details
  324. // template not found display the object using the *old style*
  325. $this->DisplayBareHeader($oPage, $bEditMode);
  326. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  327. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  328. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  329. $this->DisplayBareProperties($oPage, $bEditMode);
  330. $this->DisplayBareRelations($oPage, $bEditMode);
  331. $oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
  332. $this->DisplayBareHistory($oPage, $bEditMode);
  333. }
  334. }
  335. function DisplayPreview(WebPage $oPage)
  336. {
  337. $aDetails = array();
  338. $sClass = get_class($this);
  339. $aList = MetaModel::GetZListItems($sClass, 'preview');
  340. foreach($aList as $sAttCode)
  341. {
  342. $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
  343. }
  344. $oPage->details($aDetails);
  345. }
  346. public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  347. {
  348. $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
  349. }
  350. /**
  351. * Get the HTML fragment corresponding to the display of a table representing a set of objects
  352. * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
  353. * @param CMDBObjectSet The set of objects to display
  354. * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
  355. * @return String The HTML fragment representing the table of objects
  356. */
  357. public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  358. {
  359. if (empty($aExtraParams['currentId']))
  360. {
  361. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  362. }
  363. else
  364. {
  365. $iListId = $aExtraParams['currentId'];
  366. }
  367. // Initialize and check the parameters
  368. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  369. $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
  370. $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
  371. $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
  372. if (!empty($sLinkageAttribute))
  373. {
  374. if($iLinkedObjectId == 0)
  375. {
  376. // if 'links' mode is requested the id of the object to link to must be specified
  377. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  378. }
  379. if($sTargetAttr == '')
  380. {
  381. // if 'links' mode is requested the d of the object to link to must be specified
  382. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  383. }
  384. }
  385. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  386. $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
  387. $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
  388. $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
  389. $aExtraFields = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  390. $sHtml = '';
  391. $oAppContext = new ApplicationContext();
  392. $sClassName = $oSet->GetFilter()->GetClass();
  393. $aAttribs = array();
  394. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  395. $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  396. $aList = array_merge($aList, $aExtraFields);
  397. // Filter the list to removed linked set since we are not able to display them here
  398. foreach($aList as $index => $sAttCode)
  399. {
  400. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  401. if ($oAttDef instanceof AttributeLinkedSet)
  402. {
  403. // Removed from the display list
  404. unset($aList[$index]);
  405. }
  406. }
  407. if (!empty($sLinkageAttribute))
  408. {
  409. // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
  410. // and other objects...
  411. // The display will then group all the attributes related to the link itself:
  412. // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
  413. $aDisplayList = array();
  414. $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
  415. assert(isset($aAttDefs[$sLinkageAttribute]));
  416. $oAttDef = $aAttDefs[$sLinkageAttribute];
  417. assert($oAttDef->IsExternalKey());
  418. // First display all the attributes specific to the link record
  419. foreach($aList as $sLinkAttCode)
  420. {
  421. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  422. if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
  423. {
  424. $aDisplayList[] = $sLinkAttCode;
  425. }
  426. }
  427. // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
  428. foreach($aList as $sLinkAttCode)
  429. {
  430. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  431. if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
  432. || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
  433. {
  434. $aDisplayList[] = $sLinkAttCode;
  435. }
  436. }
  437. // First display all the attributes specific to the link
  438. // Then display all the attributes linked to the other end of the relationship
  439. $aList = $aDisplayList;
  440. }
  441. if ($bSelectMode)
  442. {
  443. if (!$bSingleSelectMode)
  444. {
  445. $aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$iListId}', this.checked);\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
  446. }
  447. else
  448. {
  449. $aAttribs['form::select'] = array('label' => "", 'description' => '');
  450. }
  451. }
  452. if ($bViewLink)
  453. {
  454. $aAttribs['key'] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  455. }
  456. foreach($aList as $sAttCode)
  457. {
  458. $aAttribs[$sAttCode] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  459. }
  460. $aValues = array();
  461. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  462. $iMaxObjects = -1;
  463. if ($bDisplayLimit && $bTruncated)
  464. {
  465. if ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
  466. {
  467. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  468. $oSet->SetLimit($iMaxObjects);
  469. }
  470. }
  471. $oSet->Seek(0);
  472. while (($oObj = $oSet->Fetch()) && ($iMaxObjects != 0))
  473. {
  474. $aRow = array();
  475. $sHilightClass = $oObj->GetHilightClass();
  476. if ($sHilightClass != '')
  477. {
  478. $aRow['@class'] = $sHilightClass;
  479. }
  480. if ($bViewLink)
  481. {
  482. $aRow['key'] = $oObj->GetHyperLink();
  483. }
  484. if ($bSelectMode)
  485. {
  486. if ($bSingleSelectMode)
  487. {
  488. $aRow['form::select'] = "<input type=\"radio\" class=\"selectList{$iListId}\" name=\"selectObject\" value=\"".$oObj->GetKey()."\"></input>";
  489. }
  490. else
  491. {
  492. $aRow['form::select'] = "<input type=\"checkBox\" class=\"selectList{$iListId}\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\"></input>";
  493. }
  494. }
  495. foreach($aList as $sAttCode)
  496. {
  497. $aRow[$sAttCode] = $oObj->GetAsHTML($sAttCode);
  498. }
  499. $aValues[] = $aRow;
  500. $iMaxObjects--;
  501. }
  502. $sHtml .= '<table class="listContainer">';
  503. $sColspan = '';
  504. // if (isset($aExtraParams['block_id']))
  505. // {
  506. // $divId = $aExtraParams['block_id'];
  507. // }
  508. // else
  509. // {
  510. // $divId = 'missingblockid';
  511. // }
  512. $sFilter = $oSet->GetFilter()->serialize();
  513. $iMinDisplayLimit = MetaModel::GetConfig()->GetMinDisplayLimit();
  514. $sCollapsedLabel = Dict::Format('UI:TruncatedResults', $iMinDisplayLimit, $oSet->Count());
  515. $sLinkLabel = Dict::S('UI:DisplayAll');
  516. foreach($oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
  517. {
  518. $aExtraParams['query_params'][$sName] = $sValue;
  519. }
  520. if ($bDisplayLimit && $bTruncated && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  521. {
  522. // list truncated
  523. $aExtraParams['display_limit'] = true;
  524. $sHtml .= '<tr class="containerHeader"><td><span id="lbl_'.$iListId.'">'.$sCollapsedLabel.'</span>&nbsp;&nbsp;<a class="truncated" id="trc_'.$iListId.'">'.$sLinkLabel.'</a></td><td>';
  525. $oPage->add_ready_script(
  526. <<<EOF
  527. $('#$iListId table.listResults').addClass('truncated');
  528. $('#$iListId table.listResults tr:last td').addClass('truncated');
  529. EOF
  530. );
  531. }
  532. else if ($bDisplayLimit && !$bTruncated && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  533. {
  534. // Collapsible list
  535. $aExtraParams['display_limit'] = true;
  536. $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>';
  537. }
  538. $aExtraParams['truncated'] = false; // To expand the full list when clicked
  539. $sExtraParamsExpand = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  540. $oPage->add_ready_script(
  541. <<<EOF
  542. // Handle truncated lists
  543. $('#trc_$iListId').click(function()
  544. {
  545. var state = {};
  546. var currentState = $.bbq.getState( this.id, true ) || 'close';
  547. // Toggle the state!
  548. if (currentState == 'close')
  549. {
  550. state[ this.id ] = 'open';
  551. }
  552. else
  553. {
  554. state[ this.id ] = 'close';
  555. }
  556. $.bbq.pushState( state );
  557. $(this).trigger(state[this.id]);
  558. });
  559. $('#trc_$iListId').unbind('open');
  560. $('#trc_$iListId').bind('open', function()
  561. {
  562. ReloadTruncatedList('$iListId', '$sFilter', '$sExtraParamsExpand');
  563. });
  564. $('#trc_$iListId').unbind('close');
  565. $('#trc_$iListId').bind('close', function()
  566. {
  567. TruncateList('$iListId', $iMinDisplayLimit, '$sCollapsedLabel', '$sLinkLabel');
  568. });
  569. EOF
  570. );
  571. if ($bDisplayMenu)
  572. {
  573. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  574. $sColspan = 'colspan="2"';
  575. $aMenuExtraParams = $aExtraParams;
  576. if (!empty($sLinkageAttribute))
  577. {
  578. //$aMenuExtraParams['linkage'] = $sLinkageAttribute;
  579. $aMenuExtraParams = $aExtraParams;
  580. }
  581. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams, $iListId);
  582. $sHtml .= '</td></tr>';
  583. }
  584. $sHtml .= "<tr><td $sColspan>";
  585. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  586. $sHtml .= '</td></tr>';
  587. $sHtml .= '</table>';
  588. return $sHtml;
  589. }
  590. public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  591. {
  592. static $iListId = 0;
  593. $iListId++;
  594. $aList = array();
  595. // Initialize and check the parameters
  596. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  597. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  598. // Check if there is a list of aliases to limit the display to...
  599. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
  600. $sHtml = '';
  601. $oAppContext = new ApplicationContext();
  602. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  603. $aAuthorizedClasses = array();
  604. foreach($aClasses as $sAlias => $sClassName)
  605. {
  606. if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
  607. ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
  608. {
  609. $aAuthorizedClasses[$sAlias] = $sClassName;
  610. }
  611. }
  612. $aAttribs = array();
  613. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  614. {
  615. $aList[$sClassName] = MetaModel::GetZListItems($sClassName, 'list');
  616. if ($bViewLink)
  617. {
  618. $aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  619. }
  620. foreach($aList[$sClassName] as $sAttCode)
  621. {
  622. $aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  623. }
  624. }
  625. $aValues = array();
  626. $oSet->Seek(0);
  627. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  628. $iMaxObjects = -1;
  629. if ($bDisplayLimit)
  630. {
  631. if ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
  632. {
  633. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  634. }
  635. }
  636. while (($aObjects = $oSet->FetchAssoc()) && ($iMaxObjects != 0))
  637. {
  638. $aRow = array();
  639. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  640. {
  641. if ($bViewLink)
  642. {
  643. $aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
  644. }
  645. foreach($aList[$sClassName] as $sAttCode)
  646. {
  647. $aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode);
  648. }
  649. }
  650. $aValues[] = $aRow;
  651. $iMaxObjects--;
  652. }
  653. $sHtml .= '<table class="listContainer">';
  654. $sColspan = '';
  655. if ($bDisplayMenu)
  656. {
  657. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  658. $sColspan = 'colspan="2"';
  659. $aMenuExtraParams = $aExtraParams;
  660. if (!empty($sLinkageAttribute))
  661. {
  662. $aMenuExtraParams = $aExtraParams;
  663. }
  664. if ($bDisplayLimit && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  665. {
  666. // list truncated
  667. $divId = $aExtraParams['block_id'];
  668. $sFilter = $oSet->GetFilter()->serialize();
  669. $aExtraParams['display_limit'] = false; // To expand the full list
  670. $sExtraParams = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  671. $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>';
  672. $oPage->add_ready_script("$('#{$divId} table.listResults').addClass('truncated');");
  673. $oPage->add_ready_script("$('#{$divId} table.listResults tr:last td').addClass('truncated');");
  674. }
  675. else
  676. {
  677. // Full list
  678. $sHtml .= '<tr class="containerHeader"><td>&nbsp;'.Dict::Format('UI:CountOfResults', $oSet->Count()).'</td><td>';
  679. }
  680. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams);
  681. $sHtml .= '</td></tr>';
  682. }
  683. $sHtml .= "<tr><td $sColspan>";
  684. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  685. $sHtml .= '</td></tr>';
  686. $sHtml .= '</table>';
  687. return $sHtml;
  688. }
  689. static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  690. {
  691. $oPage->add(self::GetSetAsCSV($oSet, $aParams));
  692. }
  693. static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array())
  694. {
  695. $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
  696. $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
  697. $aList = array();
  698. $oAppContext = new ApplicationContext();
  699. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  700. $aAuthorizedClasses = array();
  701. foreach($aClasses as $sAlias => $sClassName)
  702. {
  703. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  704. {
  705. $aAuthorizedClasses[$sAlias] = $sClassName;
  706. }
  707. }
  708. $aAttribs = array();
  709. $aHeader = array();
  710. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  711. {
  712. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  713. {
  714. if ((($oAttDef->IsExternalField()) || ($oAttDef->IsWritable())) && $oAttDef->IsScalar())
  715. {
  716. $aList[$sClassName][$sAttCode] = $oAttDef;
  717. }
  718. }
  719. $aHeader[] = 'id';
  720. foreach($aList[$sClassName] as $sAttCode => $oAttDef)
  721. {
  722. $sStar = '';
  723. if ($oAttDef->IsExternalField())
  724. {
  725. $sExtKeyLabel = MetaModel::GetLabel($sClassName, $oAttDef->GetKeyAttCode());
  726. $oExtKeyAttDef = MetaModel::GetAttributeDef($sClassName, $oAttDef->GetKeyAttCode());
  727. if (!$oExtKeyAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  728. {
  729. $sStar = '*';
  730. }
  731. $sRemoteAttLabel = MetaModel::GetLabel($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  732. $oTargetAttDef = MetaModel::GetAttributeDef($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  733. $sSuffix = '';
  734. if ($oTargetAttDef->IsExternalKey())
  735. {
  736. $sSuffix = '->id';
  737. }
  738. $aHeader[] = $sExtKeyLabel.'->'.$sRemoteAttLabel.$sSuffix.$sStar;
  739. }
  740. else
  741. {
  742. if (!$oAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  743. {
  744. $sStar = '*';
  745. }
  746. $aHeader[] = MetaModel::GetLabel($sClassName, $sAttCode).$sStar;
  747. }
  748. }
  749. }
  750. $sHtml = implode($sSeparator, $aHeader)."\n";
  751. $oSet->Seek(0);
  752. while ($aObjects = $oSet->FetchAssoc())
  753. {
  754. $aRow = array();
  755. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  756. {
  757. $oObj = $aObjects[$sAlias];
  758. $aRow[] = $oObj->GetKey();
  759. foreach($aList[$sClassName] as $sAttCode => $oAttDef)
  760. {
  761. $aRow[] = $oObj->GetAsCSV($sAttCode, $sSeparator, '\\');
  762. }
  763. }
  764. $sHtml .= implode($sSeparator, $aRow)."\n";
  765. }
  766. return $sHtml;
  767. }
  768. static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  769. {
  770. $oAppContext = new ApplicationContext();
  771. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  772. $aAuthorizedClasses = array();
  773. foreach($aClasses as $sAlias => $sClassName)
  774. {
  775. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  776. {
  777. $aAuthorizedClasses[$sAlias] = $sClassName;
  778. }
  779. }
  780. $aAttribs = array();
  781. $aList = array();
  782. $aList[$sClassName] = MetaModel::GetZListItems($sClassName, 'details');
  783. $oPage->add("<Set>\n");
  784. $oSet->Seek(0);
  785. while ($aObjects = $oSet->FetchAssoc())
  786. {
  787. if (count($aAuthorizedClasses) > 1)
  788. {
  789. $oPage->add("<Row>\n");
  790. }
  791. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  792. {
  793. $oObj = $aObjects[$sAlias];
  794. $sClassName = get_class($oObj);
  795. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
  796. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
  797. {
  798. if (($oAttDef->IsWritable()) && ($oAttDef->IsScalar()))
  799. {
  800. $sValue = $oObj->GetAsXML($sAttCode);
  801. $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
  802. }
  803. }
  804. $oPage->add("</$sClassName>\n");
  805. }
  806. if (count($aAuthorizedClasses) > 1)
  807. {
  808. $oPage->add("</Row>\n");
  809. }
  810. }
  811. $oPage->add("</Set>\n");
  812. }
  813. public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  814. {
  815. $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
  816. }
  817. public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  818. {
  819. static $iSearchFormId = 0;
  820. $oAppContext = new ApplicationContext();
  821. $sHtml = '';
  822. $numCols=4;
  823. $sClassName = $oSet->GetFilter()->GetClass();
  824. // Romain: temporarily removed the tab "OQL query" because it was not finalized
  825. // (especially when used to add a link)
  826. /*
  827. $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
  828. <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
  829. <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>
  830. </ul></div>\n";
  831. */
  832. // Simple search form
  833. if (isset($aExtraParams['currentId']))
  834. {
  835. $sSearchFormId = $aExtraParams['currentId'];
  836. }
  837. else
  838. {
  839. $iSearchFormId = $oPage->GetUniqueId();
  840. $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
  841. $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
  842. }
  843. // Check if the current class has some sub-classes
  844. if (isset($aExtraParams['baseClass']))
  845. {
  846. $sRootClass = $aExtraParams['baseClass'];
  847. }
  848. else
  849. {
  850. $sRootClass = $sClassName;
  851. }
  852. $aSubClasses = MetaModel::GetSubclasses($sRootClass);
  853. if (count($aSubClasses) > 0)
  854. {
  855. $aOptions = array();
  856. $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
  857. foreach($aSubClasses as $sSubclassName)
  858. {
  859. $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
  860. }
  861. $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
  862. ksort($aOptions);
  863. $sContext = $oAppContext->GetForLink();
  864. $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
  865. }
  866. else
  867. {
  868. $sClassesCombo = MetaModel::GetName($sClassName);
  869. }
  870. $oUnlimitedFilter = new DBObjectSearch($sClassName);
  871. $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"../pages/UI.php\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  872. $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
  873. $index = 0;
  874. $sHtml .= "<p>\n";
  875. $aFilterCriteria = $oSet->GetFilter()->GetCriteria();
  876. $aMapCriteria = array();
  877. foreach($aFilterCriteria as $aCriteria)
  878. {
  879. $aMapCriteria[$aCriteria['filtercode']][] = array('value' => $aCriteria['value'], 'opcode' => $aCriteria['opcode']);
  880. }
  881. $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
  882. foreach($aList as $sFilterCode)
  883. {
  884. //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
  885. $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
  886. $sFilterValue = '';
  887. $sFilterValue = utils::ReadParam($sFilterCode, '');
  888. $sFilterOpCode = null; // Use the default 'loose' OpCode
  889. if (empty($sFilterValue))
  890. {
  891. if (isset($aMapCriteria[$sFilterCode]))
  892. {
  893. if (count($aMapCriteria[$sFilterCode]) > 1)
  894. {
  895. $sFilterValue = Dict::S('UI:SearchValue:Mixed');
  896. }
  897. else
  898. {
  899. $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
  900. $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
  901. }
  902. if ($sFilterCode != 'company')
  903. {
  904. $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
  905. }
  906. }
  907. }
  908. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
  909. if ($aAllowedValues != null)
  910. {
  911. //Enum field or external key, display a combo
  912. $sValue = "<select name=\"$sFilterCode\">\n";
  913. $sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  914. foreach($aAllowedValues as $key => $value)
  915. {
  916. if ($sFilterValue == $key)
  917. {
  918. $sSelected = ' selected';
  919. }
  920. else
  921. {
  922. $sSelected = '';
  923. }
  924. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  925. }
  926. $sValue .= "</select>\n";
  927. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;$sValue\n";
  928. unset($aExtraParams[$sFilterCode]);
  929. }
  930. else
  931. {
  932. // Any value is possible, display an input box
  933. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;<input class=\"textSearch\" name=\"$sFilterCode\" value=\"$sFilterValue\"/>\n";
  934. unset($aExtraParams[$sFilterCode]);
  935. }
  936. $index++;
  937. $sHtml .= '</span> ';
  938. }
  939. $sHtml .= "</p>\n";
  940. $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
  941. foreach($aExtraParams as $sName => $sValue)
  942. {
  943. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  944. }
  945. $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
  946. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  947. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
  948. $sHtml .= $oAppContext->GetForForm();
  949. $sHtml .= "</form>\n";
  950. if (!isset($aExtraParams['currentId']))
  951. {
  952. $sHtml .= "</div><!-- Simple search form -->\n";
  953. }
  954. /*
  955. // OQL query builder
  956. $sHtml .= "<div id=\"OQLQuery{$iSearchFormId}\" style=\"display:none\" class=\"mini_tab{$iSearchFormId}\">\n";
  957. $sHtml .= "<h1>".Dict::S('UI:OQLQueryBuilderTitle')."</h1>\n";
  958. $sHtml .= "<form id=\"formOQL{$iSearchFormId}\"><table style=\"width:80%;\"><tr style=\"vertical-align:top\">\n";
  959. $sHtml .= "<td style=\"text-align:right\"><label>SELECT&nbsp;</label><select name=\"oql_class\">";
  960. $aClasses = MetaModel::EnumChildClasses($sClassName, ENUM_CHILD_CLASSES_ALL);
  961. $sSelectedClass = utils::ReadParam('oql_class', $sClassName);
  962. $sOQLClause = utils::ReadParam('oql_clause', '');
  963. asort($aClasses);
  964. foreach($aClasses as $sChildClass)
  965. {
  966. $sSelected = ($sChildClass == $sSelectedClass) ? 'selected' : '';
  967. $sHtml.= "<option value=\"$sChildClass\" $sSelected>".MetaModel::GetName($sChildClass)."</option>\n";
  968. }
  969. $sHtml .= "</select>&nbsp;</td><td>\n";
  970. $sHtml .= "<textarea name=\"oql_clause\" style=\"width:100%\">$sOQLClause</textarea></td></tr>\n";
  971. $sHtml .= "<tr><td colspan=\"2\" style=\"text-align:right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Query')."\"></td></tr>\n";
  972. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  973. foreach($aExtraParams as $sName => $sValue)
  974. {
  975. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  976. }
  977. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
  978. $sHtml .= $oAppContext->GetForForm();
  979. $sHtml .= "</table></form>\n";
  980. $sHtml .= "</div><!-- OQL query form -->\n";
  981. */
  982. return $sHtml;
  983. }
  984. public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
  985. {
  986. static $iInputId = 0;
  987. $sFieldPrefix = '';
  988. $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
  989. $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
  990. if (isset($aArgs[$sAttCode]) && empty($value))
  991. {
  992. // default value passed by the context (either the app context of the operation)
  993. $value = $aArgs[$sAttCode];
  994. }
  995. if (!empty($iId))
  996. {
  997. $iInputId = $iId;
  998. }
  999. else
  1000. {
  1001. $iInputId = $oPage->GetUniqueId();
  1002. }
  1003. if (!$oAttDef->IsExternalField())
  1004. {
  1005. $bMandatory = 'false';
  1006. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1007. {
  1008. $bMandatory = 'true';
  1009. }
  1010. $sValidationField = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
  1011. $sHelpText = $oAttDef->GetHelpOnEdition();
  1012. $aEventsList = array();
  1013. switch($oAttDef->GetEditClass())
  1014. {
  1015. case 'Date':
  1016. case 'DateTime':
  1017. $aEventsList[] ='validate';
  1018. $aEventsList[] ='keyup';
  1019. $aEventsList[] ='change';
  1020. $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"20\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1021. break;
  1022. case 'Password':
  1023. $aEventsList[] ='validate';
  1024. $aEventsList[] ='keyup';
  1025. $aEventsList[] ='change';
  1026. $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1027. break;
  1028. case 'Text':
  1029. $aEventsList[] ='validate';
  1030. $aEventsList[] ='keyup';
  1031. $aEventsList[] ='change';
  1032. $sEditValue = $oAttDef->GetEditValue($value);
  1033. $sHTMLValue = "<table><tr><td><textarea class=\"resizable\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\">$sEditValue</textarea></td><td>{$sValidationField}</td></tr></table>";
  1034. break;
  1035. case 'HTML':
  1036. $oWidget = new UIHTMLEditorWidget($iId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $value, $bMandatory);
  1037. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1038. break;
  1039. case 'LinkedSet':
  1040. $aEventsList[] ='validate';
  1041. $aEventsList[] ='change';
  1042. $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed());
  1043. $sHTMLValue = $oWidget->Display($oPage, $value);
  1044. break;
  1045. case 'Document':
  1046. $aEventsList[] ='validate';
  1047. $aEventsList[] ='change';
  1048. $oDocument = $value; // Value is an ormDocument object
  1049. $sFileName = '';
  1050. if (is_object($oDocument))
  1051. {
  1052. $sFileName = $oDocument->GetFileName();
  1053. }
  1054. $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  1055. $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
  1056. $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" type=\"hidden\" id=\"$iId\" \" value=\"$sFileName\"/>\n";
  1057. $sHTMLValue .= "<span id=\"name_$iInputId\">$sFileName</span><br/>\n";
  1058. $sHTMLValue .= "<input title=\"$sHelpText\" name=\"file_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/>&nbsp;{$sValidationField}\n";
  1059. break;
  1060. case 'List':
  1061. // Not editable for now...
  1062. $sHTMLValue = '';
  1063. break;
  1064. case 'One Way Password':
  1065. $aEventsList[] ='validate';
  1066. $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
  1067. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1068. // Event list & validation is handled directly by the widget
  1069. break;
  1070. case 'ExtKey':
  1071. $aEventsList[] ='validate';
  1072. $aEventsList[] ='change';
  1073. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1074. $iFieldSize = $oAttDef->GetMaxSize();
  1075. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  1076. $oWidget = new UIExtKeyWidget($sAttCode, $sClass, $oAttDef->GetLabel(), $aAllowedValues, $value, $iId, $bMandatory, $sNameSuffix, $sFieldPrefix, $sFormPrefix);
  1077. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1078. break;
  1079. case 'String':
  1080. default:
  1081. $aEventsList[] ='validate';
  1082. // #@# todo - add context information (depending on dimensions)
  1083. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1084. $iFieldSize = $oAttDef->GetMaxSize();
  1085. if ($aAllowedValues !== null)
  1086. {
  1087. // Discrete list of values, use a SELECT
  1088. $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
  1089. $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
  1090. foreach($aAllowedValues as $key => $display_value)
  1091. {
  1092. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  1093. {
  1094. // When there is only once choice, select it by default
  1095. $sSelected = ' selected';
  1096. }
  1097. else
  1098. {
  1099. $sSelected = ($value == $key) ? ' selected' : '';
  1100. }
  1101. $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
  1102. }
  1103. $sHTMLValue .= "</select>&nbsp;{$sValidationField}\n";
  1104. $aEventsList[] ='change';
  1105. }
  1106. else
  1107. {
  1108. $sHTMLValue = "<input title=\"$sHelpText\" type=\"text\" size=\"30\" maxlength=\"$iFieldSize\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"$value\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1109. $aEventsList[] ='keyup';
  1110. $aEventsList[] ='change';
  1111. }
  1112. break;
  1113. }
  1114. $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
  1115. if (!empty($aEventsList))
  1116. {
  1117. $sNullValue = $oAttDef->GetNullValue();
  1118. if (!is_numeric($sNullValue))
  1119. {
  1120. $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
  1121. }
  1122. $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
  1123. }
  1124. $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
  1125. if (count($aDependencies) > 0)
  1126. {
  1127. $oPage->add_ready_script("$('#$iId').bind('change', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
  1128. }
  1129. }
  1130. return "<div>{$sHTMLValue}</div>";
  1131. }
  1132. public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
  1133. {
  1134. static $iGlobalFormId = 1;
  1135. $iGlobalFormId++;
  1136. $sPrefix = '';
  1137. if (isset($aExtraParams['formPrefix']))
  1138. {
  1139. $sPrefix = $aExtraParams['formPrefix'];
  1140. }
  1141. $this->m_iFormId = $sPrefix.$iGlobalFormId;
  1142. $sClass = get_class($this);
  1143. $oAppContext = new ApplicationContext();
  1144. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1145. $iKey = $this->GetKey();
  1146. $aDetails = array();
  1147. $aFieldsMap = array();
  1148. if (!isset($aExtraParams['action']))
  1149. {
  1150. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  1151. }
  1152. else
  1153. {
  1154. $sFormAction = $aExtraParams['action'];
  1155. }
  1156. $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");
  1157. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
  1158. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  1159. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  1160. // $aDetailsList = $this->FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  1161. //$aFullList = MetaModel::ListAttributeDefs($sClass);
  1162. $aList = array();
  1163. // Compute the list of properties to display, first the attributes in the 'details' list, then
  1164. // all the remaining attributes that are not external fields
  1165. // foreach($aDetailsList as $sAttCode)
  1166. // {
  1167. // $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1168. // if (!$oAttDef->IsExternalField())
  1169. // {
  1170. // $aList[] = $sAttCode;
  1171. // }
  1172. // }
  1173. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  1174. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  1175. $sHtml = '';
  1176. $aDetails = array();
  1177. foreach($aDetailsStruct as $sTab => $aCols )
  1178. {
  1179. $aDetails[$sTab] = array();
  1180. ksort($aCols);
  1181. $oPage->SetCurrentTab(Dict::S($sTab));
  1182. $oPage->add('<table style="vertical-align:top"><tr>');
  1183. foreach($aCols as $sColIndex => $aFieldsets)
  1184. {
  1185. $sLabel = '';
  1186. $sPreviousLabel = '';
  1187. $aDetails[$sTab][$sColIndex] = array();
  1188. $oPage->add('<td style="vertical-align:top">');
  1189. //$aDetails[$sTab][$sColIndex] = array();
  1190. foreach($aFieldsets as $sFieldsetName => $aFields)
  1191. {
  1192. if (!empty($sFieldsetName) && ($sFieldsetName[0]!='_'))
  1193. {
  1194. $sLabel = $sFieldsetName;
  1195. }
  1196. else
  1197. {
  1198. $sLabel = '';
  1199. }
  1200. if ($sLabel != $sPreviousLabel)
  1201. {
  1202. if (!empty($sPreviousLabel))
  1203. {
  1204. $oPage->add('<fieldset>');
  1205. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  1206. }
  1207. $oPage->Details($aDetails[$sTab][$sColIndex]);
  1208. if (!empty($sPreviousLabel))
  1209. {
  1210. $oPage->add('</fieldset>');
  1211. }
  1212. $aDetails[$sTab][$sColIndex] = array();
  1213. $sPreviousLabel = $sLabel;
  1214. }
  1215. foreach($aFields as $sAttCode)
  1216. {
  1217. $aVal = null;
  1218. $iFlags = $this->GetAttributeFlags($sAttCode);
  1219. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1220. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
  1221. {
  1222. if ($oAttDef->IsWritable())
  1223. {
  1224. if ($sStateAttCode == $sAttCode)
  1225. {
  1226. // State attribute is always read-only from the UI
  1227. $sHTMLValue = $this->GetStateLabel();
  1228. $aVal = array('label' => $oAttDef->GetLabel(), 'value' => $sHTMLValue);
  1229. }
  1230. else
  1231. {
  1232. $iFlags = $this->GetAttributeFlags($sAttCode);
  1233. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  1234. if ($iFlags & OPT_ATT_HIDDEN)
  1235. {
  1236. // Attribute is hidden, add a hidden input
  1237. $oPage->add('<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>');
  1238. $aFieldsMap[$sAttCode] = $sInputId;
  1239. }
  1240. else
  1241. {
  1242. if ($iFlags & OPT_ATT_READONLY)
  1243. {
  1244. // Attribute is read-only
  1245. $sHTMLValue = $this->GetAsHTML($sAttCode);
  1246. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  1247. $aFieldsMap[$sAttCode] = $sInputId;
  1248. }
  1249. else
  1250. {
  1251. $sValue = $this->Get($sAttCode);
  1252. $sDisplayValue = $this->GetEditValue($sAttCode);
  1253. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  1254. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  1255. $aFieldsMap[$sAttCode] = $sInputId;
  1256. }
  1257. $aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue);
  1258. }
  1259. }
  1260. }
  1261. else
  1262. {
  1263. $aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $this->GetAsHTML($sAttCode));
  1264. }
  1265. }
  1266. if ($aVal != null)
  1267. {
  1268. // The field is visible, add it to the current column
  1269. $aDetails[$sTab][$sColIndex][] = $aVal;
  1270. }
  1271. }
  1272. }
  1273. if (!empty($sPreviousLabel))
  1274. {
  1275. $oPage->add('<fieldset>');
  1276. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  1277. }
  1278. $oPage->Details($aDetails[$sTab][$sColIndex]);
  1279. if (!empty($sPreviousLabel))
  1280. {
  1281. $oPage->add('</fieldset>');
  1282. }
  1283. $oPage->add('</td>');
  1284. }
  1285. $oPage->add('</tr></table>');
  1286. }
  1287. // Now display the relations, one tab per relation
  1288. if (!isset($aExtraParams['noRelations']))
  1289. {
  1290. $this->DisplayBareRelations($oPage, true); // Edit mode
  1291. }
  1292. $oPage->SetCurrentTab('');
  1293. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  1294. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  1295. foreach($aExtraParams as $sName => $value)
  1296. {
  1297. $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
  1298. }
  1299. $oPage->add($oAppContext->GetForForm());
  1300. if ($iKey > 0)
  1301. {
  1302. // The object already exists in the database, it's modification
  1303. $oPage->add("<input type=\"hidden\" name=\"id\" value=\"$iKey\">\n");
  1304. $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"apply_modify\">\n");
  1305. // $oPage->add("<button type=\"button\" id=\"btn_cancel_{$sPrefix}\" class=\"action\" onClick=\"BackToDetails('$sClass', $iKey)\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1306. $oPage->add("<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1307. $oPage->add("<button type=\"submit\" class=\"action\"><span>".Dict::S('UI:Button:Apply')."</span></button>\n");
  1308. }
  1309. else
  1310. {
  1311. // The object does not exist in the database it's a creation
  1312. $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"apply_new\">\n");
  1313. // $oPage->add("<button type=\"button\" id=\"btn_cancel_{$sPrefix}\" class=\"action\" onClick=\"BackToDetails('$sClass', $iKey)\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1314. $oPage->add("<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  1315. $oPage->add("<button type=\"submit\" class=\"action\"><span>".Dict::S('UI:Button:Create')."</span></button>\n");
  1316. }
  1317. // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
  1318. $sDefaultUrl = '../pages/UI.php?operation=cancel';
  1319. $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl')} );");
  1320. $oPage->add("</form>\n");
  1321. $iFieldsCount = count($aFieldsMap);
  1322. $sJsonFieldsMap = json_encode($aFieldsMap);
  1323. $oPage->add_script(
  1324. <<<EOF
  1325. // Create the object once at the beginning of the page...
  1326. var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix');
  1327. oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
  1328. oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
  1329. EOF
  1330. );
  1331. $oPage->add_ready_script(
  1332. <<<EOF
  1333. // Starts the validation when the page is ready
  1334. CheckFields('form_{$this->m_iFormId}', false);
  1335. EOF
  1336. );
  1337. }
  1338. public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
  1339. {
  1340. $oAppContext = new ApplicationContext();
  1341. $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
  1342. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1343. $aStates = MetaModel::EnumStates($sClass);
  1344. if ($oObjectToClone == null)
  1345. {
  1346. $oObj = MetaModel::NewObject($sClass);
  1347. if (!empty($sStateAttCode))
  1348. {
  1349. $sTargetState = MetaModel::GetDefaultState($sClass);
  1350. $oObj->Set($sStateAttCode, $sTargetState);
  1351. }
  1352. }
  1353. else
  1354. {
  1355. $oObj = clone $oObjectToClone;
  1356. }
  1357. // Pre-fill the object with default values, when there is only on possible choice
  1358. // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
  1359. $aArgs['this'] = $oObj;
  1360. $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  1361. // Order the fields based on their dependencies
  1362. $aDeps = array();
  1363. foreach($aDetailsList as $sAttCode)
  1364. {
  1365. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  1366. }
  1367. $aList = self::OrderDependentFields($aDeps);
  1368. // Now fill-in the fields with default/supplied values
  1369. foreach($aList as $sAttCode)
  1370. {
  1371. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1372. if (isset($aArgs['default'][$sAttCode]))
  1373. {
  1374. $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
  1375. }
  1376. elseif (count($aAllowedValues) == 1)
  1377. {
  1378. // If the field is mandatory, set it to the only possible value
  1379. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1380. $iFlags = $oObj->GetAttributeFlags($sAttCode);
  1381. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1382. {
  1383. $aValues = array_keys($aAllowedValues);
  1384. $oObj->Set($sAttCode, $aValues[0]);
  1385. }
  1386. }
  1387. }
  1388. return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
  1389. }
  1390. protected static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
  1391. {
  1392. //echo "<pre>ZList: ";
  1393. //print_r($aList);
  1394. //echo "</pre>\n";
  1395. $index = 0;
  1396. foreach($aList as $sKey => $value)
  1397. {
  1398. if (is_array($value))
  1399. {
  1400. if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
  1401. {
  1402. $sCode = $aMatches[1];
  1403. $sName = $aMatches[2];
  1404. switch($sCode)
  1405. {
  1406. case 'tab':
  1407. //echo "<p>Found a tab: $sName ($sKey)</p>\n";
  1408. if(!isset($aDetails[$sName]))
  1409. {
  1410. $aDetails[$sName] = array('col1' => array());
  1411. }
  1412. $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
  1413. break;
  1414. case 'fieldset':
  1415. //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
  1416. if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
  1417. {
  1418. $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
  1419. }
  1420. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
  1421. break;
  1422. default:
  1423. case 'col':
  1424. //echo "<p>Found a column: $sName ($sKey)</p>\n";
  1425. if(!isset($aDetails[$sCurrentTab][$sName]))
  1426. {
  1427. $aDetails[$sCurrentTab][$sName] = array();
  1428. }
  1429. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
  1430. break;
  1431. }
  1432. }
  1433. }
  1434. else
  1435. {
  1436. //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
  1437. if (empty($sCurrentSet))
  1438. {
  1439. $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
  1440. }
  1441. else
  1442. {
  1443. $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
  1444. }
  1445. }
  1446. $index++;
  1447. }
  1448. return $aDetails;
  1449. }
  1450. protected static function FlattenZList($aList)
  1451. {
  1452. $aResult = array();
  1453. foreach($aList as $value)
  1454. {
  1455. if (!is_array($value))
  1456. {
  1457. $aResult[] = $value;
  1458. }
  1459. else
  1460. {
  1461. $aResult = array_merge($aResult,self::FlattenZList($value));
  1462. }
  1463. }
  1464. return $aResult;
  1465. }
  1466. protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
  1467. {
  1468. $retVal = null;
  1469. $iFlags = $this->GetAttributeFlags($sAttCode);
  1470. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  1471. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  1472. {
  1473. // The field is visible in the current state of the object
  1474. if ($sStateAttCode == $sAttCode)
  1475. {
  1476. // Special display for the 'state' attribute itself
  1477. $sDisplayValue = $this->GetStateLabel();
  1478. }
  1479. else if ($oAttDef->GetEditClass() == 'Document')
  1480. {
  1481. $oDocument = $this->Get($sAttCode);
  1482. $sDisplayValue = $this->GetAsHTML($sAttCode);
  1483. $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  1484. $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  1485. }
  1486. else
  1487. {
  1488. $sDisplayValue = $this->GetAsHTML($sAttCode);
  1489. }
  1490. $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  1491. }
  1492. return $retVal;
  1493. }
  1494. /**
  1495. * Displays a blob document *inline* (if possible, depending on the type of the document)
  1496. * @return string
  1497. */
  1498. public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
  1499. {
  1500. $oDoc = $this->Get($sAttCode);
  1501. $sClass = get_class($this);
  1502. $Id = $this->GetKey();
  1503. switch ($oDoc->GetMainMimeType())
  1504. {
  1505. case 'text':
  1506. case 'html':
  1507. $data = $oDoc->GetData();
  1508. switch($oDoc->GetMimeType())
  1509. {
  1510. case 'text/html':
  1511. case 'text/xml':
  1512. $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");
  1513. break;
  1514. default:
  1515. $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true))."</pre>\n");
  1516. }
  1517. break;
  1518. case 'application':
  1519. switch($oDoc->GetMimeType())
  1520. {
  1521. case 'application/pdf':
  1522. $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");
  1523. break;
  1524. default:
  1525. $oPage->add(Dict::S('UI:Document:NoPreview'));
  1526. }
  1527. break;
  1528. case 'image':
  1529. $oPage->add("<img src=\"../pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
  1530. break;
  1531. default:
  1532. $oPage->add(Dict::S('UI:Document:NoPreview'));
  1533. }
  1534. }
  1535. /**
  1536. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  1537. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  1538. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1539. * To Be overridden by derived classes
  1540. * @param void
  1541. * @return String The desired higlight class for the object/row
  1542. */
  1543. public function GetHilightClass()
  1544. {
  1545. // Possible return values are:
  1546. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  1547. return HILIGHT_CLASS_NONE; // Not hilighted by default
  1548. }
  1549. /**
  1550. * Re-order the fields based on their inter-dependencies
  1551. * @params hash @aFields field_code => array_of_depencies
  1552. * @return array Ordered array of fields or throws an exception
  1553. */
  1554. public static function OrderDependentFields($aFields)
  1555. {
  1556. $bCircular = false;
  1557. $aResult = array();
  1558. $iCount = 0;
  1559. do
  1560. {
  1561. $bSet = false;
  1562. $iCount++;
  1563. foreach($aFields as $sFieldCode => $aDeps)
  1564. {
  1565. foreach($aDeps as $key => $sDependency)
  1566. {
  1567. if (in_array($sDependency, $aResult))
  1568. {
  1569. // Dependency is resolved, remove it
  1570. unset($aFields[$sFieldCode][$key]);
  1571. }
  1572. }
  1573. if (count($aFields[$sFieldCode]) == 0)
  1574. {
  1575. // No more pending depencies for this field, add it to the list
  1576. $aResult[] = $sFieldCode;
  1577. unset($aFields[$sFieldCode]);
  1578. $bSet = true;
  1579. }
  1580. }
  1581. }
  1582. while($bSet && (count($aFields) > 0));
  1583. if (count($aFields) > 0)
  1584. {
  1585. $sMessage = "Error: Circular dependencies between the fields ! <pre>".print_r($aFields, true)."</pre>";
  1586. throw(new Exception($sMessage));
  1587. }
  1588. return $aResult;
  1589. }
  1590. /**
  1591. * Maps the given context parameter name to the appropriate filter/search code for this class
  1592. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  1593. * @return string Filter code, i.e. 'customer_id'
  1594. */
  1595. public static function MapContextParam($sContextParam)
  1596. {
  1597. if ($sContextParam == 'menu')
  1598. {
  1599. return null;
  1600. }
  1601. else
  1602. {
  1603. return $sContextParam;
  1604. }
  1605. }
  1606. /**
  1607. * Updates the object from the POSTed parameters
  1608. */
  1609. public function UpdateObject($sFormPrefix = '')
  1610. {
  1611. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode=>$oAttDef)
  1612. {
  1613. if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  1614. {
  1615. $aLinks = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", '');
  1616. $sLinkedClass = $oAttDef->GetLinkedClass();
  1617. $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
  1618. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  1619. $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
  1620. if (is_array($aLinks))
  1621. {
  1622. foreach($aLinks as $id => $aData)
  1623. {
  1624. if (is_numeric($id))
  1625. {
  1626. if ($id < 0)
  1627. {
  1628. // New link to be created, the opposite of the id (-$id) is the ID of the remote object
  1629. $oLink = MetaModel::NewObject($sLinkedClass);
  1630. $oLink->Set($sExtKeyToRemote, -$id);
  1631. $oLink->Set($sExtKeyToMe, $this->GetKey());
  1632. }
  1633. else
  1634. {
  1635. // Existing link, potentially to be updated...
  1636. $oLink = MetaModel::GetObject($sLinkedClass, $id);
  1637. }
  1638. // Now populate the attributes
  1639. foreach($aData as $sName => $value)
  1640. {
  1641. if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
  1642. {
  1643. $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
  1644. if ($oLinkAttDef->IsWritable())
  1645. {
  1646. $oLink->Set($sName, $value);
  1647. }
  1648. }
  1649. }
  1650. $oLinkedSet->AddObject($oLink);
  1651. }
  1652. }
  1653. }
  1654. $this->Set($sAttCode, $oLinkedSet);
  1655. }
  1656. else if ($oAttDef->IsWritable())
  1657. {
  1658. $iFlags = $this->GetAttributeFlags($sAttCode);
  1659. if ($iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
  1660. {
  1661. // Non-visible, or read-only attribute, do nothing
  1662. }
  1663. elseif ($oAttDef->GetEditClass() == 'Document')
  1664. {
  1665. // There should be an uploaded file with the named attr_<attCode>
  1666. $oDocument = utils::ReadPostedDocument("file_{$sFormPrefix}{$sAttCode}");
  1667. if (!$oDocument->IsEmpty())
  1668. {
  1669. // A new file has been uploaded
  1670. $this->Set($sAttCode, $oDocument);
  1671. }
  1672. }
  1673. elseif ($oAttDef->GetEditClass() == 'One Way Password')
  1674. {
  1675. // Check if the password was typed/changed
  1676. $bChanged = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_changed", false);
  1677. if ($bChanged)
  1678. {
  1679. // The password has been changed or set
  1680. $rawValue = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  1681. $this->Set($sAttCode, $rawValue);
  1682. }
  1683. }
  1684. else
  1685. {
  1686. $rawValue = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null);
  1687. if (!is_null($rawValue))
  1688. {
  1689. $aAttributes[$sAttCode] = trim($rawValue);
  1690. $previousValue = $this->Get($sAttCode);
  1691. if ($previousValue !== $aAttributes[$sAttCode])
  1692. {
  1693. $this->Set($sAttCode, $aAttributes[$sAttCode]);
  1694. }
  1695. }
  1696. }
  1697. }
  1698. }
  1699. }
  1700. }
  1701. ?>