cmdbabstract.class.inc.php 106 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967
  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 '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. $sSynchroIcon = '';
  95. $oReplicaSet = $this->GetMasterReplica();
  96. $bSynchronized = false;
  97. $oCreatorTask = null;
  98. $bCanBeDeletedByTask = false;
  99. $bCanBeDeletedByUser = true;
  100. $aMasterSources = array();
  101. if ($oReplicaSet->Count() > 0)
  102. {
  103. $bSynchronized = true;
  104. while($aData = $oReplicaSet->FetchAssoc())
  105. {
  106. // Assumption: $aData['datasource'] will not be null because the data source id is always set...
  107. $sApplicationURL = $aData['datasource']->GetApplicationUrl($this, $aData['replica']);
  108. $sLink = $aData['datasource']->GetName();
  109. if (!empty($sApplicationURL))
  110. {
  111. $sLink = "<a href=\"$sApplicationURL\" target=\"_blank\">".$aData['datasource']->GetName()."</a>";
  112. }
  113. if ($aData['replica']->Get('status_dest_creator') == 1)
  114. {
  115. $oCreatorTask = $aData['datasource'];
  116. $bCreatedByTask = true;
  117. }
  118. else
  119. {
  120. $bCreatedByTask = false;
  121. }
  122. if ($bCreatedByTask)
  123. {
  124. $sDeletePolicy = $aData['datasource']->Get('delete_policy');
  125. if (($sDeletePolicy == 'delete') || ($sDeletePolicy == 'update_then_delete'))
  126. {
  127. $bCanBeDeletedByTask = true;
  128. }
  129. $sUserDeletePolicy = $aData['datasource']->Get('user_delete_policy');
  130. if ($sUserDeletePolicy == 'nobody')
  131. {
  132. $bCanBeDeletedByUser = false;
  133. }
  134. elseif (($sUserDeletePolicy == 'administrators') && !UserRights::IsAdministrator())
  135. {
  136. $bCanBeDeletedByUser = false;
  137. }
  138. else // everybody...
  139. {
  140. }
  141. }
  142. $aMasterSources[$aData['datasource']->GetKey()]['datasource'] = $aData['datasource'];
  143. $aMasterSources[$aData['datasource']->GetKey()]['url'] = $sLink;
  144. $aMasterSources[$aData['datasource']->GetKey()]['last_synchro'] = $aData['replica']->Get('status_last_seen');
  145. }
  146. if (is_object($oCreatorTask))
  147. {
  148. $sTaskUrl = $aMasterSources[$oCreatorTask->GetKey()]['url'];
  149. if (!$bCanBeDeletedByUser)
  150. {
  151. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectCannotBeDeletedByUser_Source', $sTaskUrl)."</p>";
  152. }
  153. else
  154. {
  155. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectWasCreatedBy_Source', $sTaskUrl)."</p>";
  156. }
  157. if ($bCanBeDeletedByTask)
  158. {
  159. $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectCanBeDeletedBy_Source', $sTaskUrl)."</p>";
  160. }
  161. }
  162. else
  163. {
  164. $sTip = "<p>".Dict::S('Core:Synchro:ThisObjectIsSynchronized')."</p>";
  165. }
  166. $sTip .= "<p><b>".Dict::S('Core:Synchro:ListOfDataSources')."</b></p>";
  167. foreach($aMasterSources as $aStruct)
  168. {
  169. $oDataSource = $aStruct['datasource'];
  170. $sLink = $aStruct['url'];
  171. $sTip .= "<p style=\"white-space:nowrap\">".$oDataSource->GetIcon(true, 'style="vertical-align:middle"')."&nbsp;$sLink<br/>";
  172. $sTip .= Dict::S('Core:Synchro:LastSynchro').'<br/>'.$aStruct['last_synchro']."</p>";
  173. }
  174. $sSynchroIcon = '&nbsp;<img style="vertical-align:middle;" id="synchro_icon" src="../images/locked.png"/>';
  175. $oPage->add_ready_script("$('#synchro_icon').qtip( { content: '$sTip', show: 'mouseover', hide: 'unfocus', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  176. }
  177. $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()."&nbsp;\n");
  178. $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span>$sSynchroIcon</h1>\n");
  179. $oPage->add("</div>\n");
  180. }
  181. function DisplayBareHistory(WebPage $oPage, $bEditMode = false)
  182. {
  183. // history block (with as a tab)
  184. $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
  185. $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
  186. $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
  187. $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
  188. $oBlock->Display($oPage, -1);
  189. }
  190. function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
  191. {
  192. $aFieldsMap = $this->GetBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
  193. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  194. {
  195. $oExtensionInstance->OnDisplayProperties($this, $oPage, $bEditMode);
  196. }
  197. // Special case to display the case log, if any...
  198. // WARNING: if you modify the loop below, also check the corresponding code in UpdateObject and DisplayModifyForm
  199. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  200. {
  201. if ($oAttDef instanceof AttributeCaseLog)
  202. {
  203. $sComment = (isset($aExtraParams['fieldsComments'][$sAttCode])) ? $aExtraParams['fieldsComments'][$sAttCode] : '';
  204. $this->DisplayCaseLog($oPage, $sAttCode, $sComment, $sPrefix, $bEditMode);
  205. }
  206. }
  207. return $aFieldsMap;
  208. }
  209. function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  210. {
  211. // Related objects: display all the linkset attributes, each as a separate tab
  212. // In the order described by the 'display' ZList
  213. $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  214. if (count($aList) == 0)
  215. {
  216. // Empty ZList defined, display all the linkedset attributes defined
  217. $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  218. }
  219. $sClass = get_class($this);
  220. foreach($aList as $sAttCode)
  221. {
  222. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  223. // Display mode
  224. if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
  225. $oSet = new DBObjectSet($this->Get($sAttCode)->GetFilter());
  226. $iCount = $oSet->Count();
  227. $sCount = '';
  228. if ($iCount != 0)
  229. {
  230. $sCount = " ($iCount)";
  231. }
  232. $oPage->SetCurrentTab($oAttDef->GetLabel().$sCount);
  233. if ($bEditMode)
  234. {
  235. if ($this->IsNew())
  236. {
  237. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  238. }
  239. else
  240. {
  241. $iFlags = $this->GetAttributeFlags($sAttCode);
  242. }
  243. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  244. if (get_class($oAttDef) == 'AttributeLinkedSet')
  245. {
  246. // 1:n links
  247. $sTargetClass = $oAttDef->GetLinkedClass();
  248. if ($this->IsNew())
  249. {
  250. $oPage->p(Dict::Format('UI:BeforeAdding_Class_ObjectsSaveThisObject', MetaModel::GetName($sTargetClass)));
  251. }
  252. else
  253. {
  254. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  255. $oFilter = new DBObjectSearch($sTargetClass);
  256. $oFilter->AddCondition($oAttDef->GetExtKeyToMe(), $this->GetKey(),'=');
  257. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  258. $oAppContext = new ApplicationContext();
  259. foreach($oAppContext->GetNames() as $sKey)
  260. {
  261. // The linked object inherits the parent's value for the context
  262. if (MetaModel::IsValidAttCode($sClass, $sKey))
  263. {
  264. $aDefaults[$sKey] = $this->Get($sKey);
  265. }
  266. }
  267. $aParams = array(
  268. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  269. 'object_id' => $this->GetKey(),
  270. 'menu' => true,
  271. 'default' => $aDefaults,
  272. );
  273. $oBlock = new DisplayBlock($oFilter, 'list', false);
  274. $oBlock->Display($oPage, $sInputId, $aParams);
  275. }
  276. }
  277. else // get_class($oAttDef) == 'AttributeLinkedSetIndirect'
  278. {
  279. // n:n links
  280. $sLinkedClass = $oAttDef->GetLinkedClass();
  281. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  282. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  283. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
  284. $sValue = $this->Get($sAttCode);
  285. $sDisplayValue = $this->GetEditValue($sAttCode);
  286. $aArgs = array('this' => $this);
  287. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  288. $aFieldsMap[$sAttCode] = $sInputId;
  289. $oPage->add($sHTMLValue);
  290. }
  291. }
  292. else
  293. {
  294. // Display mode
  295. if (!$oAttDef->IsIndirect())
  296. {
  297. // 1:n links
  298. $sTargetClass = $oAttDef->GetLinkedClass();
  299. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  300. $oAppContext = new ApplicationContext();
  301. foreach($oAppContext->GetNames() as $sKey)
  302. {
  303. // The linked object inherits the parent's value for the context
  304. if (MetaModel::IsValidAttCode($sClass, $sKey))
  305. {
  306. $aDefaults[$sKey] = $this->Get($sKey);
  307. }
  308. }
  309. $aParams = array(
  310. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  311. 'object_id' => $this->GetKey(),
  312. 'menu' => false,
  313. 'default' => $aDefaults,
  314. );
  315. }
  316. else
  317. {
  318. // n:n links
  319. $sLinkedClass = $oAttDef->GetLinkedClass();
  320. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  321. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  322. $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
  323. $aParams = array(
  324. 'link_attr' => $oAttDef->GetExtKeyToMe(),
  325. 'object_id' => $this->GetKey(),
  326. 'target_attr' => $oAttDef->GetExtKeyToRemote(),
  327. 'view_link' => false,
  328. 'menu' => false,
  329. 'display_limit' => true, // By default limit the list to speed up the initial load & display
  330. );
  331. }
  332. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  333. $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
  334. $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
  335. }
  336. }
  337. $oPage->SetCurrentTab('');
  338. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  339. {
  340. $oExtensionInstance->OnDisplayRelations($this, $oPage, $bEditMode);
  341. }
  342. // Display Notifications after the other tabs since this tab disappears in edition
  343. if (!$bEditMode)
  344. {
  345. // Get the actual class of the current object
  346. // And look for triggers referring to it
  347. // If any trigger has been found then display a tab with notifications
  348. //
  349. $sClass = get_class($this);
  350. $sClassList = implode("', '", MetaModel::EnumParentClasses($sClass, ENUM_PARENT_CLASSES_ALL));
  351. $oTriggerSet = new CMDBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnObject AS T WHERE T.target_class IN ('$sClassList')"));
  352. if ($oTriggerSet->Count() > 0)
  353. {
  354. // Display notifications regarding the object
  355. $iId = $this->GetKey();
  356. $oNotifSearch = 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");
  357. $oNotifSet = new DBObjectSet($oNotifSearch);
  358. $sCount = ($oNotifSet->Count() > 0) ? ' ('.$oNotifSet->Count().')' : '';
  359. $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab').$sCount);
  360. $oBlock = new DisplayBlock($oNotifSearch, 'list', false);
  361. $oBlock->Display($oPage, 'notifications', array('menu' => false));
  362. }
  363. }
  364. }
  365. function GetBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix, $aExtraParams = array())
  366. {
  367. $sHtml = '';
  368. $oAppContext = new ApplicationContext();
  369. $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
  370. $aDetails = array();
  371. $sClass = get_class($this);
  372. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  373. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  374. // Compute the list of properties to display, first the attributes in the 'details' list, then
  375. // all the remaining attributes that are not external fields
  376. $sHtml = '';
  377. $aDetails = array();
  378. $iInputId = 0;
  379. $aFieldsMap = array();
  380. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  381. $bFieldComments = (count($aFieldsComments) > 0);
  382. foreach($aDetailsStruct as $sTab => $aCols )
  383. {
  384. $aDetails[$sTab] = array();
  385. ksort($aCols);
  386. $oPage->SetCurrentTab(Dict::S($sTab));
  387. $oPage->add('<table style="vertical-align:top"><tr>');
  388. foreach($aCols as $sColIndex => $aFieldsets)
  389. {
  390. $oPage->add('<td style="vertical-align:top">');
  391. //$aDetails[$sTab][$sColIndex] = array();
  392. $sLabel = '';
  393. $sPreviousLabel = '';
  394. $aDetails[$sTab][$sColIndex] = array();
  395. foreach($aFieldsets as $sFieldsetName => $aFields)
  396. {
  397. if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
  398. {
  399. $sLabel = $sFieldsetName;
  400. }
  401. else
  402. {
  403. $sLabel = '';
  404. }
  405. if ($sLabel != $sPreviousLabel)
  406. {
  407. if (!empty($sPreviousLabel))
  408. {
  409. $oPage->add('<fieldset>');
  410. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  411. }
  412. $oPage->Details($aDetails[$sTab][$sColIndex]);
  413. if (!empty($sPreviousLabel))
  414. {
  415. $oPage->add('</fieldset>');
  416. }
  417. $aDetails[$sTab][$sColIndex] = array();
  418. $sPreviousLabel = $sLabel;
  419. }
  420. foreach($aFields as $sAttCode)
  421. {
  422. if ($bEditMode)
  423. {
  424. $sComments = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '&nbsp;';
  425. $sInfos = '&nbsp;';
  426. if ($this->IsNew())
  427. {
  428. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  429. }
  430. else
  431. {
  432. $iFlags = $this->GetAttributeFlags($sAttCode);
  433. }
  434. if (($iFlags & OPT_ATT_MANDATORY) && $this->IsNew())
  435. {
  436. $iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
  437. }
  438. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  439. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
  440. {
  441. if ($oAttDef->IsWritable())
  442. {
  443. if ($sStateAttCode == $sAttCode)
  444. {
  445. // State attribute is always read-only from the UI
  446. $sHTMLValue = $this->GetStateLabel();
  447. $val = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  448. }
  449. else
  450. {
  451. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  452. if ($iFlags & OPT_ATT_HIDDEN)
  453. {
  454. // Attribute is hidden, add a hidden input
  455. $oPage->add('<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>');
  456. $aFieldsMap[$sAttCode] = $sInputId;
  457. }
  458. else
  459. {
  460. if ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE))
  461. {
  462. // Check if the attribute is not read-only because of a synchro...
  463. $aReasons = array();
  464. $sSynchroIcon = '';
  465. if ($iFlags & OPT_ATT_SLAVE)
  466. {
  467. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  468. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  469. $sTip = '';
  470. foreach($aReasons as $aRow)
  471. {
  472. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  473. }
  474. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  475. }
  476. // Attribute is read-only
  477. $sHTMLValue = "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode);
  478. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/></span>';
  479. $aFieldsMap[$sAttCode] = $sInputId;
  480. $sComments = $sSynchroIcon;
  481. }
  482. else
  483. {
  484. $sValue = $this->Get($sAttCode);
  485. $sDisplayValue = $this->GetEditValue($sAttCode);
  486. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  487. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  488. $aFieldsMap[$sAttCode] = $sInputId;
  489. }
  490. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  491. }
  492. }
  493. }
  494. else
  495. {
  496. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $this->GetAsHTML($sAttCode), 'comments' => $sComments, 'infos' => $sInfos);
  497. }
  498. }
  499. else
  500. {
  501. $val = null; // Skip this field
  502. }
  503. }
  504. else
  505. {
  506. // !bEditMode
  507. $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
  508. }
  509. if ($val != null)
  510. {
  511. // The field is visible, add it to the current column
  512. $aDetails[$sTab][$sColIndex][] = $val;
  513. $iInputId++;
  514. }
  515. }
  516. }
  517. if (!empty($sPreviousLabel))
  518. {
  519. $oPage->add('<fieldset>');
  520. $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
  521. }
  522. $oPage->Details($aDetails[$sTab][$sColIndex]);
  523. if (!empty($sPreviousLabel))
  524. {
  525. $oPage->add('</fieldset>');
  526. }
  527. $oPage->add('</td>');
  528. }
  529. $oPage->add('</tr></table>');
  530. }
  531. return $aFieldsMap;
  532. }
  533. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  534. {
  535. $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
  536. if (!empty($sTemplate))
  537. {
  538. $oTemplate = new DisplayTemplate($sTemplate);
  539. // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
  540. // but the preferred method is to use '$id$'
  541. $oTemplate->Render($oPage, array('class_name'=> MetaModel::GetName(get_class($this)),'class'=> get_class($this), 'pkey'=> $this->GetKey(), 'id'=> $this->GetKey(), 'name' => $this->GetName()));
  542. }
  543. else
  544. {
  545. // Object's details
  546. // template not found display the object using the *old style*
  547. $this->DisplayBareHeader($oPage, $bEditMode);
  548. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  549. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  550. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  551. $this->DisplayBareProperties($oPage, $bEditMode);
  552. $this->DisplayBareRelations($oPage, $bEditMode);
  553. $oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
  554. $this->DisplayBareHistory($oPage, $bEditMode);
  555. }
  556. }
  557. function DisplayPreview(WebPage $oPage)
  558. {
  559. $aDetails = array();
  560. $sClass = get_class($this);
  561. $aList = MetaModel::GetZListItems($sClass, 'preview');
  562. foreach($aList as $sAttCode)
  563. {
  564. $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
  565. }
  566. $oPage->details($aDetails);
  567. }
  568. public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  569. {
  570. $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
  571. }
  572. /**
  573. * Get the HTML fragment corresponding to the display of a table representing a set of objects
  574. * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
  575. * @param CMDBObjectSet The set of objects to display
  576. * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
  577. * @return String The HTML fragment representing the table of objects
  578. */
  579. public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  580. {
  581. if (empty($aExtraParams['currentId']))
  582. {
  583. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  584. }
  585. else
  586. {
  587. $iListId = $aExtraParams['currentId'];
  588. }
  589. // Initialize and check the parameters
  590. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  591. $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
  592. $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
  593. $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
  594. if (!empty($sLinkageAttribute))
  595. {
  596. if($iLinkedObjectId == 0)
  597. {
  598. // if 'links' mode is requested the id of the object to link to must be specified
  599. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  600. }
  601. if($sTargetAttr == '')
  602. {
  603. // if 'links' mode is requested the d of the object to link to must be specified
  604. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  605. }
  606. }
  607. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  608. $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
  609. $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
  610. $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
  611. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  612. $aExtraFields = array();
  613. foreach ($aExtraFieldsRaw as $sFieldName)
  614. {
  615. // Ignore attributes not of the main queried class
  616. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  617. {
  618. $sClassAlias = $aMatches[1];
  619. $sAttCode = $aMatches[2];
  620. if ($sClassAlias == $oSet->GetFilter()->GetClassAlias())
  621. {
  622. $aExtraFields[] = $sAttCode;
  623. }
  624. }
  625. else
  626. {
  627. $aExtraFields[] = $sFieldName;
  628. }
  629. }
  630. $sHtml = '';
  631. $oAppContext = new ApplicationContext();
  632. $sClassName = $oSet->GetFilter()->GetClass();
  633. $aAttribs = array();
  634. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  635. if ($sZListName !== false)
  636. {
  637. $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  638. $aList = array_merge($aList, $aExtraFields);
  639. }
  640. else
  641. {
  642. $aList = $aExtraFields;
  643. }
  644. // Filter the list to removed linked set since we are not able to display them here
  645. foreach($aList as $index => $sAttCode)
  646. {
  647. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  648. if ($oAttDef instanceof AttributeLinkedSet)
  649. {
  650. // Removed from the display list
  651. unset($aList[$index]);
  652. }
  653. }
  654. // Load only the requested columns
  655. $sClassAlias = $oSet->GetFilter()->GetClassAlias();
  656. $oSet->OptimizeColumnLoad(array($sClassAlias => $aList));
  657. if (!empty($sLinkageAttribute))
  658. {
  659. // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
  660. // and other objects...
  661. // The display will then group all the attributes related to the link itself:
  662. // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
  663. $aDisplayList = array();
  664. $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
  665. assert(isset($aAttDefs[$sLinkageAttribute]));
  666. $oAttDef = $aAttDefs[$sLinkageAttribute];
  667. assert($oAttDef->IsExternalKey());
  668. // First display all the attributes specific to the link record
  669. foreach($aList as $sLinkAttCode)
  670. {
  671. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  672. if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
  673. {
  674. $aDisplayList[] = $sLinkAttCode;
  675. }
  676. }
  677. // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
  678. foreach($aList as $sLinkAttCode)
  679. {
  680. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  681. if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
  682. || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
  683. {
  684. $aDisplayList[] = $sLinkAttCode;
  685. }
  686. }
  687. // First display all the attributes specific to the link
  688. // Then display all the attributes linked to the other end of the relationship
  689. $aList = $aDisplayList;
  690. }
  691. if ($bSelectMode)
  692. {
  693. if (!$bSingleSelectMode)
  694. {
  695. $aAttribs['form::select'] = array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList{$iListId}:not(:disabled)', this.checked);\" class=\"checkAll\"></input>", 'description' => Dict::S('UI:SelectAllToggle+'));
  696. }
  697. else
  698. {
  699. $aAttribs['form::select'] = array('label' => "", 'description' => '');
  700. }
  701. }
  702. if ($bViewLink)
  703. {
  704. $aAttribs['key'] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  705. }
  706. foreach($aList as $sAttCode)
  707. {
  708. $aAttribs[$sAttCode] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  709. }
  710. $aValues = array();
  711. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  712. $iMaxObjects = -1;
  713. //if ($bDisplayLimit && $bTruncated)
  714. //{
  715. if ($bDisplayLimit && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  716. {
  717. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  718. $oSet->SetLimit($iMaxObjects);
  719. }
  720. //}
  721. $oSet->Seek(0);
  722. while (($oObj = $oSet->Fetch()) && ($iMaxObjects != 0))
  723. {
  724. $aRow = array();
  725. $sHilightClass = $oObj->GetHilightClass();
  726. if ($sHilightClass != '')
  727. {
  728. $aRow['@class'] = $sHilightClass;
  729. }
  730. if ($bViewLink)
  731. {
  732. $aRow['key'] = $oObj->GetHyperLink();
  733. }
  734. if ($bSelectMode)
  735. {
  736. if (array_key_exists('selection_enabled', $aExtraParams) && isset($aExtraParams['selection_enabled'][$oObj->GetKey()]))
  737. {
  738. $sDisabled = ($aExtraParams['selection_enabled'][$oObj->GetKey()]) ? '' : ' disabled="disabled"';
  739. }
  740. else
  741. {
  742. $sDisabled = '';
  743. }
  744. if ($bSingleSelectMode)
  745. {
  746. $aRow['form::select'] = "<input type=\"radio\" $sDisabled class=\"selectList{$iListId}\" name=\"selectObject\" value=\"".$oObj->GetKey()."\"></input>";
  747. }
  748. else
  749. {
  750. $aRow['form::select'] = "<input type=\"checkBox\" $sDisabled class=\"selectList{$iListId}\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\"></input>";
  751. }
  752. }
  753. foreach($aList as $sAttCode)
  754. {
  755. $aRow[$sAttCode] = $oObj->GetAsHTML($sAttCode);
  756. }
  757. $aValues[] = $aRow;
  758. $iMaxObjects--;
  759. }
  760. $sHtml .= '<table class="listContainer">';
  761. $sColspan = '';
  762. // if (isset($aExtraParams['block_id']))
  763. // {
  764. // $divId = $aExtraParams['block_id'];
  765. // }
  766. // else
  767. // {
  768. // $divId = 'missingblockid';
  769. // }
  770. $sFilter = $oSet->GetFilter()->serialize();
  771. $iMinDisplayLimit = MetaModel::GetConfig()->GetMinDisplayLimit();
  772. $sCollapsedLabel = Dict::Format('UI:TruncatedResults', $iMinDisplayLimit, $oSet->Count());
  773. $sLinkLabel = Dict::S('UI:DisplayAll');
  774. foreach($oSet->GetFilter()->GetInternalParams() as $sName => $sValue)
  775. {
  776. $aExtraParams['query_params'][$sName] = $sValue;
  777. }
  778. if ($bDisplayMenu)
  779. {
  780. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  781. $sColspan = 'colspan="2"';
  782. $aMenuExtraParams = $aExtraParams;
  783. if (!empty($sLinkageAttribute))
  784. {
  785. //$aMenuExtraParams['linkage'] = $sLinkageAttribute;
  786. $aMenuExtraParams = $aExtraParams;
  787. }
  788. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams, $iListId);
  789. $sHtml .= '</td></tr>';
  790. }
  791. $sHtml .= "<tr><td $sColspan>";
  792. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  793. $sHtml .= '</td></tr>';
  794. $sHtml .= '</table>';
  795. $iCount = $oSet->Count();
  796. if ($bSelectMode)
  797. {
  798. $sHeader = Dict::Format('UI:Pagination:HeaderSelection', '<span id="total">'.$iCount.'</span>', '<span class="selectedCount">0</span>');
  799. }
  800. else
  801. {
  802. $sHeader = Dict::Format('UI:Pagination:HeaderNoSelection', '<span id="total">'.$iCount.'</span>');
  803. }
  804. if ($bDisplayLimit && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  805. {
  806. $sCombo = '<select class="pagesize">';
  807. for($iPage = 1; $iPage < 5; $iPage++)
  808. {
  809. $sSelected = '';
  810. if ($iPage == 1)
  811. {
  812. $sSelected = 'selected="selected"';
  813. }
  814. $iNbItems = $iPage * MetaModel::GetConfig()->GetMinDisplayLimit();
  815. $sCombo .= "<option $sSelected value=\"$iNbItems\">$iNbItems</option>";
  816. }
  817. $sCombo .= "<option $sSelected value=\"-1\">".Dict::S('UI:Pagination:All')."</option>";
  818. $sCombo .= '</select>';
  819. $sPages = Dict::S('UI:Pagination:PagesLabel');
  820. $sPageSizeCombo = Dict::Format('UI:Pagination:PageSize', $sCombo);
  821. $sHtml =
  822. <<<EOF
  823. <div id="pager{$iListId}" class="pager">
  824. <p>$sHeader</p>
  825. <p><table class="pagination"><tr><td>$sPages</td><td><img src="../images/first.png" class="first"/></td>
  826. <td><img src="../images/prev.png" class="prev"/></td>
  827. <td><span id="index"></span></td>
  828. <td><img src="../images/next.png" class="next"/></td>
  829. <td><img src="../images/last.png" class="last"/></td>
  830. <td>$sPageSizeCombo</td>
  831. <td><span id="loading">&nbsp;</span></td>
  832. </tr>
  833. </table>
  834. <input type="hidden" name="selectionMode" value="positive"></input>
  835. </div>
  836. EOF
  837. .$sHtml;
  838. $aArgs = $oSet->GetArgs();
  839. $sExtraParams = addslashes(str_replace('"', "'", json_encode(array_merge($aExtraParams, $aArgs)))); // JSON encode, change the style of the quotes and escape them
  840. $sSelectMode = '';
  841. $sHeaders = '';
  842. if ($bSelectMode)
  843. {
  844. $sSelectMode = $bSingleSelectMode ? 'single' : 'multiple';
  845. $sHeaders = 'headers: { 0: {sorter: false}},';
  846. }
  847. $sDisplayKey = ($bViewLink) ? 'true' : 'false';
  848. $sDisplayList = json_encode($aList);
  849. $sCssCount = isset($aExtraParams['cssCount']) ? ", cssCount: '{$aExtraParams['cssCount']}'" : '';
  850. $iPageSize = MetaModel::GetConfig()->GetMinDisplayLimit();
  851. $oSet->ApplyParameters();
  852. $sOQL = addslashes($oSet->GetFilter()->serialize());
  853. $oPage->add_ready_script("$('#{$iListId} table.listResults').tablesorter( { $sHeaders widgets: ['myZebra', 'truncatedList']} ).tablesorterPager({container: $('#pager{$iListId}'), totalRows:$iCount, size: $iPageSize, filter: '$sOQL', extra_params: '$sExtraParams', select_mode: '$sSelectMode', displayKey: $sDisplayKey, displayList: $sDisplayList $sCssCount});\n");
  854. }
  855. else
  856. {
  857. $sHtml =
  858. <<<EOF
  859. <div id="pager{$iListId}" class="pager">
  860. <p>$sHeader</p>
  861. </div>
  862. EOF
  863. .$sHtml;
  864. $sHeaders = '';
  865. if ($bSelectMode)
  866. {
  867. $sHeaders = 'headers: { 0: {sorter: false}},';
  868. }
  869. $oPage->add_ready_script("$('#{$iListId} table.listResults').tableHover().tablesorter( { $sHeaders widgets: ['myZebra', 'truncatedList']} );\n");
  870. // Manage how we update the 'Ok/Add' buttons that depend on the number of selected items
  871. if (isset($aExtraParams['cssCount']))
  872. {
  873. $sCssCount = $aExtraParams['cssCount'];
  874. if ($bSingleSelectMode)
  875. {
  876. $sSelectSelector = ":radio[name^=selectObj]";
  877. }
  878. else
  879. {
  880. $sSelectSelector = ":checkbox[name^=selectObj]";
  881. }
  882. $oPage->add_ready_script(
  883. <<<EOF
  884. $('#{$iListId} table.listResults $sSelectSelector').change(function() {
  885. var c = $('{$sCssCount}');
  886. var v = $('#{$iListId} table.listResults $sSelectSelector:checked').length;
  887. c.val(v);
  888. $('#{$iListId} .selectedCount').text(v);
  889. c.trigger('change');
  890. });
  891. EOF
  892. );
  893. }
  894. }
  895. return $sHtml;
  896. }
  897. public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  898. {
  899. static $iListId = 0;
  900. $iListId++;
  901. $aList = array();
  902. // Initialize and check the parameters
  903. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  904. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  905. // Check if there is a list of aliases to limit the display to...
  906. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
  907. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  908. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  909. $aExtraFields = array();
  910. foreach ($aExtraFieldsRaw as $sFieldName)
  911. {
  912. // Ignore attributes not of the main queried class
  913. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  914. {
  915. $sClassAlias = $aMatches[1];
  916. $sAttCode = $aMatches[2];
  917. if (array_key_exists($sClassAlias, $oSet->GetSelectedClasses()))
  918. {
  919. $aExtraFields[$sClassAlias][] = $sAttCode;
  920. }
  921. }
  922. else
  923. {
  924. $aExtraFields['*'] = $sAttCode;
  925. }
  926. }
  927. $sHtml = '';
  928. $oAppContext = new ApplicationContext();
  929. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  930. $aAuthorizedClasses = array();
  931. foreach($aClasses as $sAlias => $sClassName)
  932. {
  933. if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
  934. ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
  935. {
  936. $aAuthorizedClasses[$sAlias] = $sClassName;
  937. }
  938. }
  939. $aAttribs = array();
  940. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  941. {
  942. if (array_key_exists($sAlias, $aExtraFields))
  943. {
  944. $aList[$sAlias] = $aExtraFields[$sAlias];
  945. }
  946. else
  947. {
  948. $aList[$sAlias] = array();
  949. }
  950. if ($sZListName !== false)
  951. {
  952. $aDefaultList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  953. $aList[$sAlias] = array_merge($aDefaultList, $aList[$sAlias]);
  954. }
  955. // Filter the list to removed linked set since we are not able to display them here
  956. foreach($aList[$sAlias] as $index => $sAttCode)
  957. {
  958. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  959. if ($oAttDef instanceof AttributeLinkedSet)
  960. {
  961. // Removed from the display list
  962. unset($aList[$sAlias][$index]);
  963. }
  964. }
  965. if ($bViewLink)
  966. {
  967. $aAttribs['key_'.$sAlias] = array('label' => MetaModel::GetName($sClassName), 'description' => '');
  968. }
  969. foreach($aList[$sAlias] as $sAttCode)
  970. {
  971. $aAttribs[$sAttCode.'_'.$sAlias] = array('label' => MetaModel::GetLabel($sClassName, $sAttCode), 'description' => MetaModel::GetDescription($sClassName, $sAttCode));
  972. }
  973. }
  974. // Load only the requested columns
  975. $aAttToLoad = array(); // attributes to load
  976. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  977. {
  978. foreach($aList[$sAlias] as $sAttCode)
  979. {
  980. $aAttToLoad[$sAlias][] = $sAttCode;
  981. }
  982. }
  983. $oSet->OptimizeColumnLoad($aAttToLoad);
  984. $aValues = array();
  985. $oSet->Seek(0);
  986. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  987. $iMaxObjects = -1;
  988. if ($bDisplayLimit)
  989. {
  990. if ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit())
  991. {
  992. $iMaxObjects = MetaModel::GetConfig()->GetMinDisplayLimit();
  993. }
  994. }
  995. while (($aObjects = $oSet->FetchAssoc()) && ($iMaxObjects != 0))
  996. {
  997. $aRow = array();
  998. foreach($aAuthorizedClasses as $sAlias => $sClassName) // TO DO: check if the user has enough rights to view the classes of the list...
  999. {
  1000. if ($bViewLink)
  1001. {
  1002. if (is_null($aObjects[$sAlias]))
  1003. {
  1004. $aRow['key_'.$sAlias] = '';
  1005. }
  1006. else
  1007. {
  1008. $aRow['key_'.$sAlias] = $aObjects[$sAlias]->GetHyperLink();
  1009. }
  1010. }
  1011. foreach($aList[$sAlias] as $sAttCode)
  1012. {
  1013. if (is_null($aObjects[$sAlias]))
  1014. {
  1015. $aRow[$sAttCode.'_'.$sAlias] = '';
  1016. }
  1017. else
  1018. {
  1019. $aRow[$sAttCode.'_'.$sAlias] = $aObjects[$sAlias]->GetAsHTML($sAttCode);
  1020. }
  1021. }
  1022. }
  1023. $aValues[] = $aRow;
  1024. $iMaxObjects--;
  1025. }
  1026. $sHtml .= '<table class="listContainer">';
  1027. $sColspan = '';
  1028. if ($bDisplayMenu)
  1029. {
  1030. $oMenuBlock = new MenuBlock($oSet->GetFilter());
  1031. $sColspan = 'colspan="2"';
  1032. $aMenuExtraParams = $aExtraParams;
  1033. if (!empty($sLinkageAttribute))
  1034. {
  1035. $aMenuExtraParams = $aExtraParams;
  1036. }
  1037. if ($bDisplayLimit && ($oSet->Count() > MetaModel::GetConfig()->GetMaxDisplayLimit()))
  1038. {
  1039. // list truncated
  1040. $divId = $aExtraParams['block_id'];
  1041. $sFilter = $oSet->GetFilter()->serialize();
  1042. $aExtraParams['display_limit'] = false; // To expand the full list
  1043. $sExtraParams = addslashes(str_replace('"', "'", json_encode($aExtraParams))); // JSON encode, change the style of the quotes and escape them
  1044. $sHtml .= '<tr class="containerHeader"><td>'.Dict::Format('UI:TruncatedResults', MetaModel::GetConfig()->GetMinDisplayLimit(), $oSet->Count()).'&nbsp;&nbsp;<span style=\"cursor:pointer;\" onClick="Javascript:ReloadTruncatedList(\''.$divId.'\', \''.$sFilter.'\', \''.$sExtraParams.'\');">'.Dict::S('UI:DisplayAll').'</span></td><td>';
  1045. $oPage->add_ready_script("$('#{$divId} table.listResults').addClass('truncated');");
  1046. $oPage->add_ready_script("$('#{$divId} table.listResults tr:last td').addClass('truncated');");
  1047. }
  1048. else
  1049. {
  1050. // Full list
  1051. $sHtml .= '<tr class="containerHeader"><td>&nbsp;'.Dict::Format('UI:CountOfResults', $oSet->Count()).'</td><td>';
  1052. }
  1053. $sHtml .= $oMenuBlock->GetRenderContent($oPage, $aMenuExtraParams, $aMenuExtraParams['currentId']);
  1054. $sHtml .= '</td></tr>';
  1055. }
  1056. $sHtml .= "<tr><td $sColspan>";
  1057. $sHtml .= $oPage->GetTable($aAttribs, $aValues);
  1058. $sHtml .= '</td></tr>';
  1059. $sHtml .= '</table>';
  1060. return $sHtml;
  1061. }
  1062. static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1063. {
  1064. $oPage->add(self::GetSetAsCSV($oSet, $aParams));
  1065. }
  1066. static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array())
  1067. {
  1068. $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
  1069. $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
  1070. $aFields = null;
  1071. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  1072. {
  1073. $aFields = explode(',', $aParams['fields']);
  1074. }
  1075. $aList = array();
  1076. $oAppContext = new ApplicationContext();
  1077. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1078. $aAuthorizedClasses = array();
  1079. foreach($aClasses as $sAlias => $sClassName)
  1080. {
  1081. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1082. {
  1083. $aAuthorizedClasses[$sAlias] = $sClassName;
  1084. }
  1085. }
  1086. $aAttribs = array();
  1087. $aHeader = array();
  1088. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1089. {
  1090. $aList[$sAlias] = array();
  1091. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  1092. {
  1093. if (is_null($aFields) || (count($aFields) == 0))
  1094. {
  1095. // Standard list of attributes (no link sets)
  1096. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  1097. {
  1098. $aList[$sAlias][$sAttCode] = $oAttDef;
  1099. }
  1100. }
  1101. else
  1102. {
  1103. // User defined list of attributes
  1104. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  1105. {
  1106. $aList[$sAlias][$sAttCode] = $oAttDef;
  1107. }
  1108. }
  1109. }
  1110. $aHeader[] = 'id';
  1111. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1112. {
  1113. $sStar = '';
  1114. if ($oAttDef->IsExternalField())
  1115. {
  1116. $sExtKeyLabel = MetaModel::GetLabel($sClassName, $oAttDef->GetKeyAttCode());
  1117. $oExtKeyAttDef = MetaModel::GetAttributeDef($sClassName, $oAttDef->GetKeyAttCode());
  1118. if (!$oExtKeyAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  1119. {
  1120. $sStar = '*';
  1121. }
  1122. $sRemoteAttLabel = MetaModel::GetLabel($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  1123. $oTargetAttDef = MetaModel::GetAttributeDef($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  1124. $sSuffix = '';
  1125. if ($oTargetAttDef->IsExternalKey())
  1126. {
  1127. $sSuffix = '->id';
  1128. }
  1129. $aHeader[] = $sExtKeyLabel.'->'.$sRemoteAttLabel.$sSuffix.$sStar;
  1130. }
  1131. else
  1132. {
  1133. if (!$oAttDef->IsNullAllowed() && isset($aParams['showMandatoryFields']))
  1134. {
  1135. $sStar = '*';
  1136. }
  1137. $aHeader[] = MetaModel::GetLabel($sClassName, $sAttCode).$sStar;
  1138. }
  1139. }
  1140. }
  1141. $sHtml = implode($sSeparator, $aHeader)."\n";
  1142. $oSet->Seek(0);
  1143. while ($aObjects = $oSet->FetchAssoc())
  1144. {
  1145. $aRow = array();
  1146. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1147. {
  1148. $oObj = $aObjects[$sAlias];
  1149. if (is_null($oObj))
  1150. {
  1151. $aRow[] = '';
  1152. }
  1153. else
  1154. {
  1155. $aRow[] = $oObj->GetKey();
  1156. }
  1157. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1158. {
  1159. if (is_null($oObj))
  1160. {
  1161. $aRow[] = '';
  1162. }
  1163. else
  1164. {
  1165. $aRow[] = $oObj->GetAsCSV($sAttCode, $sSeparator, $sTextQualifier);
  1166. }
  1167. }
  1168. }
  1169. $sHtml .= implode($sSeparator, $aRow)."\n";
  1170. }
  1171. return $sHtml;
  1172. }
  1173. static function DisplaySetAsHTMLSpreadsheet(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1174. {
  1175. $oPage->add(self::GetSetAsHTMLSpreadsheet($oSet, $aParams));
  1176. }
  1177. /**
  1178. * Spreadsheet output: designed for end users doing some reporting
  1179. * Then the ids are excluded and replaced by the corresponding friendlyname
  1180. */
  1181. static function GetSetAsHTMLSpreadsheet(DBObjectSet $oSet, $aParams = array())
  1182. {
  1183. $aFields = null;
  1184. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  1185. {
  1186. $aFields = explode(',', $aParams['fields']);
  1187. }
  1188. $aList = array();
  1189. $oAppContext = new ApplicationContext();
  1190. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1191. $aAuthorizedClasses = array();
  1192. foreach($aClasses as $sAlias => $sClassName)
  1193. {
  1194. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1195. {
  1196. $aAuthorizedClasses[$sAlias] = $sClassName;
  1197. }
  1198. }
  1199. $aAttribs = array();
  1200. $aHeader = array();
  1201. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1202. {
  1203. $aList[$sAlias] = array();
  1204. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  1205. {
  1206. if (is_null($aFields) || (count($aFields) == 0))
  1207. {
  1208. // Standard list of attributes (no link sets)
  1209. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  1210. {
  1211. $aList[$sAlias][$sAttCode] = $oAttDef;
  1212. }
  1213. }
  1214. else
  1215. {
  1216. // User defined list of attributes
  1217. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  1218. {
  1219. $aList[$sAlias][$sAttCode] = $oAttDef;
  1220. }
  1221. }
  1222. }
  1223. // Replace external key by the corresponding friendly name (if not already in the list)
  1224. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1225. {
  1226. if ($oAttDef->IsExternalKey())
  1227. {
  1228. unset($aList[$sAlias][$sAttCode]);
  1229. $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
  1230. if (!array_key_exists($sFriendlyNameAttCode, $aList[$sAlias]) && MetaModel::IsValidAttCode($sClassName, $sFriendlyNameAttCode))
  1231. {
  1232. $oFriendlyNameAtt = MetaModel::GetAttributeDef($sClassName, $sFriendlyNameAttCode);
  1233. $aList[$sAlias][$sFriendlyNameAttCode] = $oFriendlyNameAtt;
  1234. }
  1235. }
  1236. }
  1237. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1238. {
  1239. if ($oAttDef->IsExternalField())
  1240. {
  1241. $sExtKeyLabel = MetaModel::GetLabel($sClassName, $oAttDef->GetKeyAttCode());
  1242. $oExtKeyAttDef = MetaModel::GetAttributeDef($sClassName, $oAttDef->GetKeyAttCode());
  1243. $sRemoteAttLabel = MetaModel::GetLabel($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  1244. $oTargetAttDef = MetaModel::GetAttributeDef($oAttDef->GetTargetClass(), $oAttDef->GetExtAttCode());
  1245. $sSuffix = '';
  1246. if ($oTargetAttDef->IsExternalKey())
  1247. {
  1248. $sSuffix = '->id';
  1249. }
  1250. $sColLabel = $sExtKeyLabel.'->'.$sRemoteAttLabel.$sSuffix;
  1251. }
  1252. else
  1253. {
  1254. $sColLabel = MetaModel::GetLabel($sClassName, $sAttCode);
  1255. }
  1256. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1257. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1258. {
  1259. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')';
  1260. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')';
  1261. }
  1262. else
  1263. {
  1264. $aHeader[] = $sColLabel;
  1265. }
  1266. }
  1267. }
  1268. $sHtml = "<table border=\"1\">\n";
  1269. $sHtml .= "<tr>\n";
  1270. $sHtml .= "<td>".implode("</td><td>", $aHeader)."</td>\n";
  1271. $sHtml .= "</tr>\n";
  1272. $oSet->Seek(0);
  1273. while ($aObjects = $oSet->FetchAssoc())
  1274. {
  1275. $aRow = array();
  1276. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1277. {
  1278. $oObj = $aObjects[$sAlias];
  1279. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1280. {
  1281. if (is_null($oObj))
  1282. {
  1283. $aRow[] = '<td></td>';
  1284. }
  1285. else
  1286. {
  1287. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1288. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1289. {
  1290. $iDate = AttributeDateTime::GetAsUnixSeconds($oObj->Get($sAttCode));
  1291. $aRow[] = '<td>'.date('Y-m-d', $iDate).'</td>';
  1292. $aRow[] = '<td>'.date('h:i:s', $iDate).'</td>';
  1293. }
  1294. else
  1295. {
  1296. $aRow[] = '<td>'.(string) $oObj->Get($sAttCode).'</td>';
  1297. }
  1298. }
  1299. }
  1300. }
  1301. $sHtml .= implode("\n", $aRow);
  1302. $sHtml .= "</tr>\n";
  1303. }
  1304. $sHtml .= "</table>\n";
  1305. return $sHtml;
  1306. }
  1307. static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1308. {
  1309. $oAppContext = new ApplicationContext();
  1310. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1311. $aAuthorizedClasses = array();
  1312. foreach($aClasses as $sAlias => $sClassName)
  1313. {
  1314. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1315. {
  1316. $aAuthorizedClasses[$sAlias] = $sClassName;
  1317. }
  1318. }
  1319. $aAttribs = array();
  1320. $aList = array();
  1321. $aList[$sAlias] = MetaModel::GetZListItems($sClassName, 'details');
  1322. $oPage->add("<Set>\n");
  1323. $oSet->Seek(0);
  1324. while ($aObjects = $oSet->FetchAssoc())
  1325. {
  1326. if (count($aAuthorizedClasses) > 1)
  1327. {
  1328. $oPage->add("<Row>\n");
  1329. }
  1330. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1331. {
  1332. $oObj = $aObjects[$sAlias];
  1333. if (is_null($oObj))
  1334. {
  1335. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"null\">\n");
  1336. }
  1337. else
  1338. {
  1339. $sClassName = get_class($oObj);
  1340. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
  1341. }
  1342. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
  1343. {
  1344. if (is_null($oObj))
  1345. {
  1346. $oPage->add("<$sAttCode>null</$sAttCode>\n");
  1347. }
  1348. else
  1349. {
  1350. if ($oAttDef->IsWritable())
  1351. {
  1352. $sValue = $oObj->GetAsXML($sAttCode);
  1353. $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
  1354. }
  1355. }
  1356. }
  1357. $oPage->add("</$sClassName>\n");
  1358. }
  1359. if (count($aAuthorizedClasses) > 1)
  1360. {
  1361. $oPage->add("</Row>\n");
  1362. }
  1363. }
  1364. $oPage->add("</Set>\n");
  1365. }
  1366. public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1367. {
  1368. $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
  1369. }
  1370. public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1371. {
  1372. static $iSearchFormId = 0;
  1373. $oAppContext = new ApplicationContext();
  1374. $sHtml = '';
  1375. $numCols=4;
  1376. $sClassName = $oSet->GetFilter()->GetClass();
  1377. // Romain: temporarily removed the tab "OQL query" because it was not finalized
  1378. // (especially when used to add a link)
  1379. /*
  1380. $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
  1381. <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
  1382. <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>
  1383. </ul></div>\n";
  1384. */
  1385. // Simple search form
  1386. if (isset($aExtraParams['currentId']))
  1387. {
  1388. $sSearchFormId = $aExtraParams['currentId'];
  1389. }
  1390. else
  1391. {
  1392. $iSearchFormId = $oPage->GetUniqueId();
  1393. $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
  1394. $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
  1395. }
  1396. // Check if the current class has some sub-classes
  1397. if (isset($aExtraParams['baseClass']))
  1398. {
  1399. $sRootClass = $aExtraParams['baseClass'];
  1400. }
  1401. else
  1402. {
  1403. $sRootClass = $sClassName;
  1404. }
  1405. $aSubClasses = MetaModel::GetSubclasses($sRootClass);
  1406. if (count($aSubClasses) > 0)
  1407. {
  1408. $aOptions = array();
  1409. $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
  1410. foreach($aSubClasses as $sSubclassName)
  1411. {
  1412. $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
  1413. }
  1414. $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
  1415. ksort($aOptions);
  1416. $sContext = $oAppContext->GetForLink();
  1417. $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
  1418. }
  1419. else
  1420. {
  1421. $sClassesCombo = MetaModel::GetName($sClassName);
  1422. }
  1423. $oUnlimitedFilter = new DBObjectSearch($sClassName);
  1424. $sAction = (isset($aExtraParams['action'])) ? $aExtraParams['action'] : utils::GetAbsoluteUrlAppRoot().'pages/UI.php';
  1425. $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"{$sAction}\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  1426. $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
  1427. $index = 0;
  1428. $sHtml .= "<p>\n";
  1429. $aFilterCriteria = $oSet->GetFilter()->GetCriteria();
  1430. $aMapCriteria = array();
  1431. foreach($aFilterCriteria as $aCriteria)
  1432. {
  1433. $aMapCriteria[$aCriteria['filtercode']][] = array('value' => $aCriteria['value'], 'opcode' => $aCriteria['opcode']);
  1434. }
  1435. $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
  1436. $aConsts = $oSet->ListConstantFields(); // Some fields are constants based on the query/context
  1437. $sClassAlias = $oSet->GetFilter()->GetClassAlias();
  1438. foreach($aList as $sFilterCode)
  1439. {
  1440. //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
  1441. $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
  1442. $sFilterValue = isset($aConsts[$sClassAlias][$sFilterCode]) ? $aConsts[$sClassAlias][$sFilterCode] : '';
  1443. $sFilterValue = utils::ReadParam($sFilterCode, $sFilterValue, false, 'raw_data');
  1444. $sFilterOpCode = null; // Use the default 'loose' OpCode
  1445. if (empty($sFilterValue))
  1446. {
  1447. if (isset($aMapCriteria[$sFilterCode]))
  1448. {
  1449. if (count($aMapCriteria[$sFilterCode]) > 1)
  1450. {
  1451. $sFilterValue = Dict::S('UI:SearchValue:Mixed');
  1452. }
  1453. else
  1454. {
  1455. $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
  1456. $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
  1457. }
  1458. if ($sFilterCode != 'company')
  1459. {
  1460. $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
  1461. }
  1462. }
  1463. }
  1464. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sFilterCode);
  1465. if ($oAttDef->IsExternalKey())
  1466. {
  1467. $sTargetClass = $oAttDef->GetTargetClass();
  1468. $oAllowedValues = new DBObjectSet(new DBObjectSearch($sTargetClass));
  1469. $iFieldSize = $oAttDef->GetMaxSize();
  1470. $iMaxComboLength = $oAttDef->GetMaximumComboLength();
  1471. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;";
  1472. $aExtKeyParams = $aExtraParams;
  1473. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  1474. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  1475. $sHtml .= UIExtKeyWidget::DisplayFromAttCode($oPage, $sFilterCode, $sClassName, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sSearchFormId.'search_'.$sFilterCode, false, $sFilterCode, '', $aExtKeyParams, true);
  1476. }
  1477. else
  1478. {
  1479. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
  1480. if (is_null($aAllowedValues))
  1481. {
  1482. // Any value is possible, display an input box
  1483. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;<input class=\"textSearch\" name=\"$sFilterCode\" value=\"$sFilterValue\"/>\n";
  1484. }
  1485. else
  1486. {
  1487. //Enum field, display a combo
  1488. $sValue = "<select name=\"$sFilterCode\">\n";
  1489. $sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  1490. foreach($aAllowedValues as $key => $value)
  1491. {
  1492. if ($sFilterValue == $key)
  1493. {
  1494. $sSelected = ' selected';
  1495. }
  1496. else
  1497. {
  1498. $sSelected = '';
  1499. }
  1500. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  1501. }
  1502. $sValue .= "</select>\n";
  1503. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;$sValue\n";
  1504. }
  1505. }
  1506. unset($aExtraParams[$sFilterCode]);
  1507. // Finally, add a tooltip if one is defined for this attribute definition
  1508. $sTip = $oAttDef->GetHelpOnSmartSearch();
  1509. if (strlen($sTip) > 0)
  1510. {
  1511. $sTip = addslashes($sTip);
  1512. $sTip = str_replace(array("\n", "\r"), " ", $sTip);
  1513. // :input does represent in form visible input (INPUT, SELECT, TEXTAREA)
  1514. $oPage->add_ready_script("$('form#fs_$sSearchFormId :input[name={$sFilterCode}]').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  1515. }
  1516. $index++;
  1517. $sHtml .= '</span> ';
  1518. }
  1519. $sHtml .= "</p>\n";
  1520. $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
  1521. foreach($aExtraParams as $sName => $sValue)
  1522. {
  1523. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1524. }
  1525. $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
  1526. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1527. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
  1528. $sHtml .= $oAppContext->GetForForm();
  1529. $sHtml .= "</form>\n";
  1530. if (!isset($aExtraParams['currentId']))
  1531. {
  1532. $sHtml .= "</div><!-- Simple search form -->\n";
  1533. }
  1534. /*
  1535. // OQL query builder
  1536. $sHtml .= "<div id=\"OQLQuery{$iSearchFormId}\" style=\"display:none\" class=\"mini_tab{$iSearchFormId}\">\n";
  1537. $sHtml .= "<h1>".Dict::S('UI:OQLQueryBuilderTitle')."</h1>\n";
  1538. $sHtml .= "<form id=\"formOQL{$iSearchFormId}\"><table style=\"width:80%;\"><tr style=\"vertical-align:top\">\n";
  1539. $sHtml .= "<td style=\"text-align:right\"><label>SELECT&nbsp;</label><select name=\"oql_class\">";
  1540. $aClasses = MetaModel::EnumChildClasses($sClassName, ENUM_CHILD_CLASSES_ALL);
  1541. $sSelectedClass = utils::ReadParam('oql_class', $sClassName, false, 'class');
  1542. $sOQLClause = utils::ReadParam('oql_clause', '', false, 'raw_data');
  1543. asort($aClasses);
  1544. foreach($aClasses as $sChildClass)
  1545. {
  1546. $sSelected = ($sChildClass == $sSelectedClass) ? 'selected' : '';
  1547. $sHtml.= "<option value=\"$sChildClass\" $sSelected>".MetaModel::GetName($sChildClass)."</option>\n";
  1548. }
  1549. $sHtml .= "</select>&nbsp;</td><td>\n";
  1550. $sHtml .= "<textarea name=\"oql_clause\" style=\"width:100%\">$sOQLClause</textarea></td></tr>\n";
  1551. $sHtml .= "<tr><td colspan=\"2\" style=\"text-align:right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Query')."\"></td></tr>\n";
  1552. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1553. foreach($aExtraParams as $sName => $sValue)
  1554. {
  1555. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1556. }
  1557. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
  1558. $sHtml .= $oAppContext->GetForForm();
  1559. $sHtml .= "</table></form>\n";
  1560. $sHtml .= "</div><!-- OQL query form -->\n";
  1561. */
  1562. return $sHtml;
  1563. }
  1564. public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
  1565. {
  1566. static $iInputId = 0;
  1567. $sFieldPrefix = '';
  1568. $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
  1569. $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
  1570. if ($sDisplayValue == '')
  1571. {
  1572. $sDisplayValue = $value;
  1573. }
  1574. if (isset($aArgs[$sAttCode]) && empty($value))
  1575. {
  1576. // default value passed by the context (either the app context of the operation)
  1577. $value = $aArgs[$sAttCode];
  1578. }
  1579. if (!empty($iId))
  1580. {
  1581. $iInputId = $iId;
  1582. }
  1583. else
  1584. {
  1585. $iInputId = $oPage->GetUniqueId();
  1586. }
  1587. if (!$oAttDef->IsExternalField())
  1588. {
  1589. $bMandatory = 'false';
  1590. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1591. {
  1592. $bMandatory = 'true';
  1593. }
  1594. $sValidationField = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
  1595. $sHelpText = $oAttDef->GetHelpOnEdition();
  1596. $aEventsList = array();
  1597. switch($oAttDef->GetEditClass())
  1598. {
  1599. case 'Date':
  1600. $aEventsList[] ='validate';
  1601. $aEventsList[] ='keyup';
  1602. $aEventsList[] ='change';
  1603. $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"12\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1604. break;
  1605. case 'DateTime':
  1606. $aEventsList[] ='validate';
  1607. $aEventsList[] ='keyup';
  1608. $aEventsList[] ='change';
  1609. $sHTMLValue = "<input title=\"$sHelpText\" class=\"date-pick\" type=\"text\" size=\"20\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1610. break;
  1611. case 'Duration':
  1612. $aEventsList[] ='validate';
  1613. $aEventsList[] ='change';
  1614. $oPage->add_ready_script("$('#{$iId}_d').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1615. $oPage->add_ready_script("$('#{$iId}_h').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1616. $oPage->add_ready_script("$('#{$iId}_m').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1617. $oPage->add_ready_script("$('#{$iId}_s').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1618. $aVal = AttributeDuration::SplitDuration($value);
  1619. $sDays = "<input title=\"$sHelpText\" type=\"text\" size=\"3\" name=\"attr_{$sFieldPrefix}{$sAttCode}[d]{$sNameSuffix}\" value=\"{$aVal['days']}\" id=\"{$iId}_d\"/>";
  1620. $sHours = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[h]{$sNameSuffix}\" value=\"{$aVal['hours']}\" id=\"{$iId}_h\"/>";
  1621. $sMinutes = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[m]{$sNameSuffix}\" value=\"{$aVal['minutes']}\" id=\"{$iId}_m\"/>";
  1622. $sSeconds = "<input title=\"$sHelpText\" type=\"text\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[s]{$sNameSuffix}\" value=\"{$aVal['seconds']}\" id=\"{$iId}_s\"/>";
  1623. $sHidden = "<input type=\"hidden\" id=\"{$iId}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\"/>";
  1624. $sHTMLValue = Dict::Format('UI:DurationForm_Days_Hours_Minutes_Seconds', $sDays, $sHours, $sMinutes, $sSeconds).$sHidden."&nbsp;".$sValidationField;
  1625. $oPage->add_ready_script("$('#{$iId}').bind('update', function(evt, sFormId) { return ToggleDurationField('$iId'); });");
  1626. break;
  1627. case 'Password':
  1628. $aEventsList[] ='validate';
  1629. $aEventsList[] ='keyup';
  1630. $aEventsList[] ='change';
  1631. $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1632. break;
  1633. case 'OQLExpression':
  1634. case 'Text':
  1635. $aEventsList[] ='validate';
  1636. $aEventsList[] ='keyup';
  1637. $aEventsList[] ='change';
  1638. $sEditValue = $oAttDef->GetEditValue($value);
  1639. $aStyles = array();
  1640. $sStyle = '';
  1641. $sWidth = $oAttDef->GetWidth('width', '');
  1642. if (!empty($sWidth))
  1643. {
  1644. $aStyles[] = 'width:'.$sWidth;
  1645. }
  1646. $sHeight = $oAttDef->GetHeight('height', '');
  1647. if (!empty($sHeight))
  1648. {
  1649. $aStyles[] = 'height:'.$sHeight;
  1650. }
  1651. if (count($aStyles) > 0)
  1652. {
  1653. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1654. }
  1655. if ($oAttDef->GetEditClass() == 'OQLExpression')
  1656. {
  1657. $sTestResId = 'query_res_'.$sFieldPrefix.$sAttCode.$sNameSuffix; //$oPage->GetUniqueId();
  1658. $sBaseUrl = utils::GetAbsoluteUrlAppRoot().'pages/run_query.php?expression=';
  1659. $sInitialUrl = $sBaseUrl.urlencode($sEditValue);
  1660. $sAdditionalStuff = "<a id=\"$sTestResId\" target=\"_blank\" href=\"$sInitialUrl\">".Dict::S('UI:Edit:TestQuery')."</a>";
  1661. $oPage->add_ready_script("$('#$iId').bind('change keyup', function(evt, sFormId) { $('#$sTestResId').attr('href', '$sBaseUrl'+encodeURIComponent($(this).val())); } );");
  1662. }
  1663. else
  1664. {
  1665. $sAdditionalStuff = "";
  1666. }
  1667. // Ok, the text area is drawn here
  1668. $sHTMLValue = "<table><tr><td><textarea class=\"resizable\" title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" rows=\"8\" cols=\"40\" id=\"$iId\" $sStyle>".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sAdditionalStuff</td><td>{$sValidationField}</td></tr></table>";
  1669. break;
  1670. case 'CaseLog':
  1671. $aStyles = array();
  1672. $sStyle = '';
  1673. $sWidth = $oAttDef->GetWidth('width', '');
  1674. if (!empty($sWidth))
  1675. {
  1676. $aStyles[] = 'width:'.$sWidth;
  1677. }
  1678. $sHeight = $oAttDef->GetHeight('height', '');
  1679. if (!empty($sHeight))
  1680. {
  1681. $aStyles[] = 'height:'.$sHeight;
  1682. }
  1683. if (count($aStyles) > 0)
  1684. {
  1685. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1686. }
  1687. $sHeader = '<div class="caselog_input_header">&nbsp;'.Dict::S('UI:CaseLogTypeYourTextHere').'</div>';
  1688. $sEditValue = $oAttDef->GetEditValue($value);
  1689. $sPreviousLog = is_object($value) ? $value->GetAsHTML() : '';
  1690. $iEntriesCount = is_object($value) ? count($value->GetIndex()) : 0;
  1691. $sHidden = "<input type=\"hidden\" id=\"{$iId}_count\" value=\"$iEntriesCount\"/>"; // To know how many entries the case log already contains
  1692. $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\">".htmlentities($sEditValue, ENT_QUOTES, 'UTF-8')."</textarea>$sPreviousLog</td><td>{$sValidationField}</td></tr></table>$sHidden</div>";
  1693. $oPage->add_ready_script("$('#$iId').bind('keyup change validate', function(evt, sFormId) { return ValidateCaseLogField('$iId', $bMandatory, sFormId) } );"); // Custom validation function
  1694. break;
  1695. case 'HTML':
  1696. $oWidget = new UIHTMLEditorWidget($iId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $value, $bMandatory);
  1697. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1698. break;
  1699. case 'LinkedSet':
  1700. $aEventsList[] ='validate';
  1701. $aEventsList[] ='change';
  1702. $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed(), $aArgs);
  1703. $oObj = isset($aArgs['this']) ? $aArgs['this'] : null;
  1704. $sHTMLValue = $oWidget->Display($oPage, $value, array(), $sFormPrefix, $oObj);
  1705. break;
  1706. case 'Document':
  1707. $aEventsList[] ='validate';
  1708. $aEventsList[] ='change';
  1709. $oDocument = $value; // Value is an ormDocument object
  1710. $sFileName = '';
  1711. if (is_object($oDocument))
  1712. {
  1713. $sFileName = $oDocument->GetFileName();
  1714. }
  1715. $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  1716. $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
  1717. $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[filename]\" type=\"hidden\" id=\"$iId\" \" value=\"".htmlentities($sFileName, ENT_QUOTES, 'UTF-8')."\"/>\n";
  1718. $sHTMLValue .= "<span id=\"name_$iInputId\">$sFileName</span><br/>\n";
  1719. $sHTMLValue .= "<input title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[fcontents]\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/>&nbsp;{$sValidationField}\n";
  1720. break;
  1721. case 'List':
  1722. // Not editable for now...
  1723. $sHTMLValue = '';
  1724. break;
  1725. case 'One Way Password':
  1726. $aEventsList[] ='validate';
  1727. $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
  1728. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1729. // Event list & validation is handled directly by the widget
  1730. break;
  1731. case 'ExtKey':
  1732. $aEventsList[] ='validate';
  1733. $aEventsList[] ='change';
  1734. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  1735. $sFieldName = $sFieldPrefix.$sAttCode.$sNameSuffix;
  1736. $aExtKeyParams = $aArgs;
  1737. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  1738. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  1739. $sHTMLValue = UIExtKeyWidget::DisplayFromAttCode($oPage, $sAttCode, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $value, $iId, $bMandatory, $sFieldName, $sFormPrefix, $aExtKeyParams);
  1740. $sHTMLValue .= "<!-- iFlags: $iFlags bMandatory: $bMandatory -->\n";
  1741. break;
  1742. case 'String':
  1743. default:
  1744. $aEventsList[] ='validate';
  1745. // #@# todo - add context information (depending on dimensions)
  1746. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1747. $iFieldSize = $oAttDef->GetMaxSize();
  1748. if ($aAllowedValues !== null)
  1749. {
  1750. // Discrete list of values, use a SELECT or RADIO buttons depending on the config
  1751. $sDisplayStyle = $oAttDef->GetDisplayStyle();
  1752. switch($sDisplayStyle)
  1753. {
  1754. case 'radio':
  1755. case 'radio_horizontal':
  1756. case 'radio_vertical':
  1757. $sHTMLValue = '';
  1758. $bVertical = ($sDisplayStyle != 'radio_horizontal');
  1759. $sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $iId, "attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}", $bMandatory, $bVertical, $sValidationField);
  1760. $aEventsList[] ='change';
  1761. break;
  1762. case 'select':
  1763. default:
  1764. $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
  1765. $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
  1766. foreach($aAllowedValues as $key => $display_value)
  1767. {
  1768. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  1769. {
  1770. // When there is only once choice, select it by default
  1771. $sSelected = ' selected';
  1772. }
  1773. else
  1774. {
  1775. $sSelected = ($value == $key) ? ' selected' : '';
  1776. }
  1777. $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
  1778. }
  1779. $sHTMLValue .= "</select>&nbsp;{$sValidationField}\n";
  1780. $aEventsList[] ='change';
  1781. }
  1782. }
  1783. else
  1784. {
  1785. $sHTMLValue = "<input title=\"$sHelpText\" type=\"text\" size=\"30\" maxlength=\"$iFieldSize\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1786. $aEventsList[] ='keyup';
  1787. $aEventsList[] ='change';
  1788. }
  1789. break;
  1790. }
  1791. $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
  1792. if (!empty($aEventsList))
  1793. {
  1794. $sNullValue = $oAttDef->GetNullValue();
  1795. if (!is_numeric($sNullValue))
  1796. {
  1797. $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
  1798. }
  1799. $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
  1800. }
  1801. $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
  1802. if (count($aDependencies) > 0)
  1803. {
  1804. $oPage->add_ready_script("$('#$iId').bind('change', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
  1805. }
  1806. }
  1807. return "<div>{$sHTMLValue}</div>";
  1808. }
  1809. public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
  1810. {
  1811. self::$iGlobalFormId++;
  1812. $sPrefix = '';
  1813. if (isset($aExtraParams['formPrefix']))
  1814. {
  1815. $sPrefix = $aExtraParams['formPrefix'];
  1816. }
  1817. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  1818. $this->m_iFormId = $sPrefix.self::$iGlobalFormId;
  1819. $sClass = get_class($this);
  1820. $oAppContext = new ApplicationContext();
  1821. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1822. $iKey = $this->GetKey();
  1823. $aDetails = array();
  1824. $aFieldsMap = array();
  1825. if (!isset($aExtraParams['action']))
  1826. {
  1827. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  1828. }
  1829. else
  1830. {
  1831. $sFormAction = $aExtraParams['action'];
  1832. }
  1833. // Custom label for the apply button ?
  1834. if (isset($aExtraParams['custom_button']))
  1835. {
  1836. $sApplyButton = $aExtraParams['custom_button'];
  1837. }
  1838. else if ($iKey > 0)
  1839. {
  1840. $sApplyButton = Dict::S('UI:Button:Apply');
  1841. }
  1842. else
  1843. {
  1844. $sApplyButton = Dict::S('UI:Button:Create');
  1845. }
  1846. // Custom operation for the form ?
  1847. if (isset($aExtraParams['custom_operation']))
  1848. {
  1849. $sOperation = $aExtraParams['custom_operation'];
  1850. }
  1851. else if ($iKey > 0)
  1852. {
  1853. $sOperation = 'apply_modify';
  1854. }
  1855. else
  1856. {
  1857. $sOperation = 'apply_new';
  1858. }
  1859. if ($iKey > 0)
  1860. {
  1861. // The object already exists in the database, it's a modification
  1862. $sButtons = "<input id=\"{$sPrefix}_id\" type=\"hidden\" name=\"id\" value=\"$iKey\">\n";
  1863. $sButtons .= "<input type=\"hidden\" name=\"operation\" value=\"{$sOperation}\">\n";
  1864. $sButtons .= "<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1865. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1866. }
  1867. else
  1868. {
  1869. // The object does not exist in the database it's a creation
  1870. $sButtons = "<input type=\"hidden\" name=\"operation\" value=\"$sOperation\">\n";
  1871. $sButtons .= "<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1872. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1873. }
  1874. $aTransitions = $this->EnumTransitions();
  1875. if (!isset($aExtraParams['custom_operation']) && count($aTransitions))
  1876. {
  1877. // transitions are displayed only for the standard new/modify actions, not for modify_all or any other case...
  1878. $oSetToCheckRights = DBObjectSet::FromObject($this);
  1879. $aStimuli = Metamodel::EnumStimuli($sClass);
  1880. foreach($aTransitions as $sStimulusCode => $aTransitionDef)
  1881. {
  1882. $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? UserRights::IsStimulusAllowed($sClass, $sStimulusCode, $oSetToCheckRights) : UR_ALLOWED_NO;
  1883. switch($iActionAllowed)
  1884. {
  1885. case UR_ALLOWED_YES:
  1886. $sButtons .= "<button type=\"submit\" name=\"next_action\" value=\"{$sStimulusCode}\" class=\"action\"><span>".$aStimuli[$sStimulusCode]->GetLabel()."</span></button>\n";
  1887. break;
  1888. default:
  1889. // Do nothing
  1890. }
  1891. }
  1892. }
  1893. $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
  1894. $iTransactionId = isset($aExtraParams['transaction_id']) ? $aExtraParams['transaction_id'] : utils::GetNewTransactionId();
  1895. $oPage->SetTransactionId($iTransactionId);
  1896. $oPage->add("<form action=\"$sFormAction\" id=\"form_{$this->m_iFormId}\" enctype=\"multipart/form-data\" method=\"post\" onSubmit=\"return OnSubmit('form_{$this->m_iFormId}');\">\n");
  1897. $sStatesSelection = '';
  1898. if (!isset($aExtraParams['custom_operation']) && $this->IsNew())
  1899. {
  1900. $aInitialStates = MetaModel::EnumInitialStates($sClass);
  1901. //$aInitialStates = array('new' => 'foo', 'closed' => 'bar');
  1902. if (count($aInitialStates) > 1)
  1903. {
  1904. $sStatesSelection = Dict::Format('UI:Create_Class_InState', MetaModel::GetName($sClass)).'<select name="obj_state" class="state_select_'.$this->m_iFormId.'">';
  1905. foreach($aInitialStates as $sStateCode => $sStateData)
  1906. {
  1907. $sSelected = '';
  1908. if ($sStateCode == $this->GetState())
  1909. {
  1910. $sSelected = ' selected';
  1911. }
  1912. $sStatesSelection .= '<option value="'.$sStateCode.'"'.$sSelected.'>'.MetaModel::GetStateLabel($sClass, $sStateCode).'</option>';
  1913. }
  1914. $sStatesSelection .= '</select>';
  1915. $oPage->add_ready_script("$('.state_select_{$this->m_iFormId}').change( function() { oWizardHelper$sPrefix.ReloadObjectCreationForm('form_{$this->m_iFormId}', $(this).val()); } );");
  1916. }
  1917. }
  1918. $sConfirmationMessage = addslashes(Dict::S('UI:NavigateAwayConfirmationMessage'));
  1919. $oPage->add_ready_script(
  1920. <<<EOF
  1921. $(window).unload(function() { return OnUnload('$iTransactionId') } );
  1922. window.onbeforeunload = function() {
  1923. if (!window.bInSubmit && !window.bInCancel)
  1924. {
  1925. return '$sConfirmationMessage';
  1926. }
  1927. // return nothing ! safer for IE
  1928. };
  1929. EOF
  1930. );
  1931. if ($sButtonsPosition != 'bottom')
  1932. {
  1933. // top or both, display the buttons here
  1934. $oPage->p($sStatesSelection);
  1935. $oPage->add($sButtons);
  1936. }
  1937. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
  1938. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  1939. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  1940. $aFieldsMap = $this->DisplayBareProperties($oPage, true, $sPrefix, $aExtraParams);
  1941. if ($iKey > 0)
  1942. {
  1943. $aFieldsMap['id'] = $sPrefix.'_id';
  1944. }
  1945. // Now display the relations, one tab per relation
  1946. if (!isset($aExtraParams['noRelations']))
  1947. {
  1948. $this->DisplayBareRelations($oPage, true); // Edit mode
  1949. }
  1950. $oPage->SetCurrentTab('');
  1951. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  1952. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"$iTransactionId\">\n");
  1953. foreach($aExtraParams as $sName => $value)
  1954. {
  1955. $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
  1956. }
  1957. $oPage->add($oAppContext->GetForForm());
  1958. if ($sButtonsPosition != 'top')
  1959. {
  1960. // bottom or both: display the buttons here
  1961. $oPage->p($sStatesSelection);
  1962. $oPage->add($sButtons);
  1963. }
  1964. // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
  1965. $sDefaultUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=cancel&'.$oAppContext->GetForLink();
  1966. $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl')} );");
  1967. $oPage->add("</form>\n");
  1968. $iFieldsCount = count($aFieldsMap);
  1969. $sJsonFieldsMap = json_encode($aFieldsMap);
  1970. $sState = $this->GetState();
  1971. $oPage->add_script(
  1972. <<<EOF
  1973. // Create the object once at the beginning of the page...
  1974. var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix', '$sState');
  1975. oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
  1976. oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
  1977. EOF
  1978. );
  1979. $oPage->add_ready_script(
  1980. <<<EOF
  1981. oWizardHelper$sPrefix.UpdateWizard();
  1982. // Starts the validation when the page is ready
  1983. CheckFields('form_{$this->m_iFormId}', false);
  1984. EOF
  1985. );
  1986. }
  1987. public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
  1988. {
  1989. $oAppContext = new ApplicationContext();
  1990. $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
  1991. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1992. $aStates = MetaModel::EnumStates($sClass);
  1993. $sStatesSelection = '';
  1994. if ($oObjectToClone == null)
  1995. {
  1996. $oObj = MetaModel::NewObject($sClass);
  1997. if (!empty($sStateAttCode))
  1998. {
  1999. $sTargetState = MetaModel::GetDefaultState($sClass);
  2000. $oObj->Set($sStateAttCode, $sTargetState);
  2001. }
  2002. }
  2003. else
  2004. {
  2005. $oObj = clone $oObjectToClone;
  2006. }
  2007. // Pre-fill the object with default values, when there is only on possible choice
  2008. // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
  2009. $aArgs['this'] = $oObj;
  2010. $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  2011. // Order the fields based on their dependencies
  2012. $aDeps = array();
  2013. foreach($aDetailsList as $sAttCode)
  2014. {
  2015. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  2016. }
  2017. $aList = self::OrderDependentFields($aDeps);
  2018. // Now fill-in the fields with default/supplied values
  2019. foreach($aList as $sAttCode)
  2020. {
  2021. if (isset($aArgs['default'][$sAttCode]))
  2022. {
  2023. $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
  2024. }
  2025. else
  2026. {
  2027. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2028. // If the field is mandatory, set it to the only possible value
  2029. $iFlags = $oObj->GetInitialStateAttributeFlags($sAttCode);
  2030. if ((!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  2031. {
  2032. if ($oAttDef->IsExternalKey())
  2033. {
  2034. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  2035. if ($oAllowedValues->Count() == 1)
  2036. {
  2037. $oRemoteObj = $oAllowedValues->Fetch();
  2038. $oObj->Set($sAttCode, $oRemoteObj->GetKey());
  2039. }
  2040. }
  2041. else
  2042. {
  2043. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  2044. if (count($aAllowedValues) == 1)
  2045. {
  2046. $aValues = array_keys($aAllowedValues);
  2047. $oObj->Set($sAttCode, $aValues[0]);
  2048. }
  2049. }
  2050. }
  2051. }
  2052. }
  2053. return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
  2054. }
  2055. public static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
  2056. {
  2057. //echo "<pre>ZList: ";
  2058. //print_r($aList);
  2059. //echo "</pre>\n";
  2060. $index = 0;
  2061. foreach($aList as $sKey => $value)
  2062. {
  2063. if (is_array($value))
  2064. {
  2065. if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
  2066. {
  2067. $sCode = $aMatches[1];
  2068. $sName = $aMatches[2];
  2069. switch($sCode)
  2070. {
  2071. case 'tab':
  2072. //echo "<p>Found a tab: $sName ($sKey)</p>\n";
  2073. if(!isset($aDetails[$sName]))
  2074. {
  2075. $aDetails[$sName] = array('col1' => array());
  2076. }
  2077. $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
  2078. break;
  2079. case 'fieldset':
  2080. //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
  2081. if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
  2082. {
  2083. $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
  2084. }
  2085. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
  2086. break;
  2087. default:
  2088. case 'col':
  2089. //echo "<p>Found a column: $sName ($sKey)</p>\n";
  2090. if(!isset($aDetails[$sCurrentTab][$sName]))
  2091. {
  2092. $aDetails[$sCurrentTab][$sName] = array();
  2093. }
  2094. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
  2095. break;
  2096. }
  2097. }
  2098. }
  2099. else
  2100. {
  2101. //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
  2102. if (empty($sCurrentSet))
  2103. {
  2104. $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
  2105. }
  2106. else
  2107. {
  2108. $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
  2109. }
  2110. }
  2111. $index++;
  2112. }
  2113. return $aDetails;
  2114. }
  2115. static function FlattenZList($aList)
  2116. {
  2117. $aResult = array();
  2118. foreach($aList as $value)
  2119. {
  2120. if (!is_array($value))
  2121. {
  2122. $aResult[] = $value;
  2123. }
  2124. else
  2125. {
  2126. $aResult = array_merge($aResult,self::FlattenZList($value));
  2127. }
  2128. }
  2129. return $aResult;
  2130. }
  2131. protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
  2132. {
  2133. $retVal = null;
  2134. if ($this->IsNew())
  2135. {
  2136. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2137. }
  2138. else
  2139. {
  2140. $iFlags = $this->GetAttributeFlags($sAttCode);
  2141. }
  2142. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2143. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  2144. {
  2145. // The field is visible in the current state of the object
  2146. if ($sStateAttCode == $sAttCode)
  2147. {
  2148. // Special display for the 'state' attribute itself
  2149. $sDisplayValue = $this->GetStateLabel();
  2150. }
  2151. else if ($oAttDef->GetEditClass() == 'Document')
  2152. {
  2153. $oDocument = $this->Get($sAttCode);
  2154. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2155. $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2156. $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDownloadLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2157. }
  2158. else
  2159. {
  2160. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2161. }
  2162. $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  2163. }
  2164. return $retVal;
  2165. }
  2166. /**
  2167. * Displays a blob document *inline* (if possible, depending on the type of the document)
  2168. * @return string
  2169. */
  2170. public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
  2171. {
  2172. $oDoc = $this->Get($sAttCode);
  2173. $sClass = get_class($this);
  2174. $Id = $this->GetKey();
  2175. switch ($oDoc->GetMainMimeType())
  2176. {
  2177. case 'text':
  2178. case 'html':
  2179. $data = $oDoc->GetData();
  2180. switch($oDoc->GetMimeType())
  2181. {
  2182. case 'text/html':
  2183. case 'text/xml':
  2184. $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  2185. break;
  2186. default:
  2187. $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true), ENT_QUOTES, 'UTF-8')."</pre>\n");
  2188. }
  2189. break;
  2190. case 'application':
  2191. switch($oDoc->GetMimeType())
  2192. {
  2193. case 'application/pdf':
  2194. $oPage->add("<iframe id='preview_$sAttCode' src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" width=\"100%\" height=\"400\">Loading...</iframe>\n");
  2195. break;
  2196. default:
  2197. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2198. }
  2199. break;
  2200. case 'image':
  2201. $oPage->add("<img src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
  2202. break;
  2203. default:
  2204. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2205. }
  2206. }
  2207. // $m_highlightComparison[previous][new] => next value
  2208. protected static $m_highlightComparison = array(
  2209. HILIGHT_CLASS_CRITICAL => array(
  2210. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2211. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_CRITICAL,
  2212. HILIGHT_CLASS_OK => HILIGHT_CLASS_CRITICAL,
  2213. HILIGHT_CLASS_NONE => HILIGHT_CLASS_CRITICAL,
  2214. ),
  2215. HILIGHT_CLASS_WARNING => array(
  2216. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2217. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2218. HILIGHT_CLASS_OK => HILIGHT_CLASS_WARNING,
  2219. HILIGHT_CLASS_NONE => HILIGHT_CLASS_WARNING,
  2220. ),
  2221. HILIGHT_CLASS_OK => array(
  2222. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2223. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2224. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2225. HILIGHT_CLASS_NONE => HILIGHT_CLASS_OK,
  2226. ),
  2227. HILIGHT_CLASS_NONE => array(
  2228. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2229. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2230. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2231. HILIGHT_CLASS_NONE => HILIGHT_CLASS_NONE,
  2232. ),
  2233. );
  2234. /**
  2235. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  2236. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  2237. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2238. * To Be overridden by derived classes
  2239. * @param void
  2240. * @return String The desired higlight class for the object/row
  2241. */
  2242. public function GetHilightClass()
  2243. {
  2244. // Possible return values are:
  2245. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2246. $current = HILIGHT_CLASS_NONE; // Not hilighted by default
  2247. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2248. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2249. {
  2250. $new = $oExtensionInstance->GetHilightClass($this);
  2251. @$current = self::$m_highlightComparison[$current][$new];
  2252. }
  2253. return $current;
  2254. }
  2255. /**
  2256. * Re-order the fields based on their inter-dependencies
  2257. * @params hash @aFields field_code => array_of_depencies
  2258. * @return array Ordered array of fields or throws an exception
  2259. */
  2260. public static function OrderDependentFields($aFields)
  2261. {
  2262. $bCircular = false;
  2263. $aResult = array();
  2264. $iCount = 0;
  2265. do
  2266. {
  2267. $bSet = false;
  2268. $iCount++;
  2269. foreach($aFields as $sFieldCode => $aDeps)
  2270. {
  2271. foreach($aDeps as $key => $sDependency)
  2272. {
  2273. if (in_array($sDependency, $aResult))
  2274. {
  2275. // Dependency is resolved, remove it
  2276. unset($aFields[$sFieldCode][$key]);
  2277. }
  2278. }
  2279. if (count($aFields[$sFieldCode]) == 0)
  2280. {
  2281. // No more pending depencies for this field, add it to the list
  2282. $aResult[] = $sFieldCode;
  2283. unset($aFields[$sFieldCode]);
  2284. $bSet = true;
  2285. }
  2286. }
  2287. }
  2288. while($bSet && (count($aFields) > 0));
  2289. if (count($aFields) > 0)
  2290. {
  2291. $sMessage = "Error: Circular dependencies between the fields (or field missing in ZList) ! <pre>".print_r($aFields, true)."</pre>";
  2292. throw(new Exception($sMessage));
  2293. }
  2294. return $aResult;
  2295. }
  2296. /**
  2297. * Get the list of actions to be displayed as 'shortcuts' (i.e buttons) instead of inside the Actions popup menu
  2298. * @param $sFinalClass string The actual class of the objects for which to display the menu
  2299. * @return Array the list of menu codes (i.e dictionary entries) that can be displayed as shortcuts next to the actions menu
  2300. */
  2301. public static function GetShortcutActions($sFinalClass)
  2302. {
  2303. $sShortcutActions = MetaModel::GetConfig()->Get('shortcut_actions');
  2304. $aShortcutActions = explode(',', $sShortcutActions);
  2305. return $aShortcutActions;
  2306. }
  2307. /**
  2308. * Maps the given context parameter name to the appropriate filter/search code for this class
  2309. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  2310. * @return string Filter code, i.e. 'customer_id'
  2311. */
  2312. public static function MapContextParam($sContextParam)
  2313. {
  2314. if ($sContextParam == 'menu')
  2315. {
  2316. return null;
  2317. }
  2318. else
  2319. {
  2320. return $sContextParam;
  2321. }
  2322. }
  2323. /**
  2324. * Updates the object from a flat array of values
  2325. * @param $aAttList array $aAttList array of attcode
  2326. * @param $aErrors array Returns information about slave attributes
  2327. * @param $sTargetState string Target state for which to evaluate the writeable attributes (=current state is empty)
  2328. * @return array of attcodes that can be used for writing on the current object
  2329. */
  2330. public function GetWriteableAttList($aAttList, &$aErrors, $sTargetState = '')
  2331. {
  2332. if (!is_array($aAttList))
  2333. {
  2334. $aAttList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  2335. // Special case to process the case log, if any...
  2336. // WARNING: if you change this also check the functions DisplayModifyForm and DisplayCaseLog
  2337. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  2338. {
  2339. if ($this->IsNew())
  2340. {
  2341. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2342. }
  2343. else
  2344. {
  2345. $aVoid = array();
  2346. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2347. }
  2348. if ($oAttDef instanceof AttributeCaseLog)
  2349. {
  2350. if (!($iFlags & (OPT_ATT_HIDDEN|OPT_ATT_SLAVE|OPT_ATT_READONLY)))
  2351. {
  2352. // The case log is editable, append it to the list of fields to retrieve
  2353. $aAttList[] = $sAttCode;
  2354. }
  2355. }
  2356. }
  2357. }
  2358. $aWriteableAttList = array();
  2359. foreach($aAttList as $sAttCode)
  2360. {
  2361. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2362. if ($this->IsNew())
  2363. {
  2364. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2365. }
  2366. else
  2367. {
  2368. $aVoid = array();
  2369. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2370. }
  2371. if ($oAttDef->IsWritable())
  2372. {
  2373. if ( $iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
  2374. {
  2375. // Non-visible, or read-only attribute, do nothing
  2376. }
  2377. elseif($iFlags & OPT_ATT_SLAVE)
  2378. {
  2379. $aErrors[$sAttCode] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel());
  2380. }
  2381. else
  2382. {
  2383. $aWriteableAttList[$sAttCode] = $oAttDef;
  2384. }
  2385. }
  2386. }
  2387. return $aWriteableAttList;
  2388. }
  2389. /**
  2390. * Updates the object from a flat array of values
  2391. * @param string $aValues array of attcode => scalar or array (N-N links)
  2392. * @return void
  2393. */
  2394. public function UpdateObjectFromArray($aValues)
  2395. {
  2396. foreach($aValues as $sAttCode => $value)
  2397. {
  2398. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2399. if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  2400. {
  2401. $aLinks = $value;
  2402. $sLinkedClass = $oAttDef->GetLinkedClass();
  2403. $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
  2404. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  2405. $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
  2406. if (is_array($aLinks))
  2407. {
  2408. foreach($aLinks as $id => $aData)
  2409. {
  2410. if (is_numeric($id))
  2411. {
  2412. if ($id < 0)
  2413. {
  2414. // New link to be created, the opposite of the id (-$id) is the ID of the remote object
  2415. $oLink = MetaModel::NewObject($sLinkedClass);
  2416. $oLink->Set($sExtKeyToRemote, -$id);
  2417. $oLink->Set($sExtKeyToMe, $this->GetKey());
  2418. }
  2419. else
  2420. {
  2421. // Existing link, potentially to be updated...
  2422. $oLink = MetaModel::GetObject($sLinkedClass, $id);
  2423. }
  2424. // Now populate the attributes
  2425. foreach($aData as $sName => $value)
  2426. {
  2427. if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
  2428. {
  2429. $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
  2430. if ($oLinkAttDef->IsWritable())
  2431. {
  2432. $oLink->Set($sName, $value);
  2433. }
  2434. }
  2435. }
  2436. $oLinkedSet->AddObject($oLink);
  2437. }
  2438. }
  2439. }
  2440. $this->Set($sAttCode, $oLinkedSet);
  2441. }
  2442. elseif ($oAttDef->GetEditClass() == 'Document')
  2443. {
  2444. // There should be an uploaded file with the named attr_<attCode>
  2445. $oDocument = $value['fcontents'];
  2446. if (!$oDocument->IsEmpty())
  2447. {
  2448. // A new file has been uploaded
  2449. $this->Set($sAttCode, $oDocument);
  2450. }
  2451. }
  2452. elseif ($oAttDef->GetEditClass() == 'One Way Password')
  2453. {
  2454. // Check if the password was typed/changed
  2455. $aPwdData = $value;
  2456. if (!is_null($aPwdData) && $aPwdData['changed'])
  2457. {
  2458. // The password has been changed or set
  2459. $this->Set($sAttCode, $aPwdData['value']);
  2460. }
  2461. }
  2462. elseif ($oAttDef->GetEditClass() == 'Duration')
  2463. {
  2464. $aDurationData = $value;
  2465. if (!is_array($aDurationData)) continue;
  2466. $iValue = (((24*$aDurationData['d'])+$aDurationData['h'])*60 +$aDurationData['m'])*60 + $aDurationData['s'];
  2467. $this->Set($sAttCode, $iValue);
  2468. $previousValue = $this->Get($sAttCode);
  2469. if ($previousValue !== $iValue)
  2470. {
  2471. $this->Set($sAttCode, $iValue);
  2472. }
  2473. }
  2474. else
  2475. {
  2476. if (!is_null($value))
  2477. {
  2478. $aAttributes[$sAttCode] = trim($value);
  2479. $previousValue = $this->Get($sAttCode);
  2480. if ($previousValue !== $aAttributes[$sAttCode])
  2481. {
  2482. $this->Set($sAttCode, $aAttributes[$sAttCode]);
  2483. }
  2484. }
  2485. }
  2486. }
  2487. }
  2488. /**
  2489. * Updates the object from the POSTed parameters (form)
  2490. */
  2491. public function UpdateObjectFromPostedForm($sFormPrefix = '', $aAttList = null, $sTargetState = '')
  2492. {
  2493. if (is_null($aAttList))
  2494. {
  2495. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2496. }
  2497. $aValues = array();
  2498. foreach($aAttList as $sAttCode)
  2499. {
  2500. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2501. if ($oAttDef->GetEditClass() == 'Document')
  2502. {
  2503. $value = array('fcontents' => utils::ReadPostedDocument("attr_{$sFormPrefix}{$sAttCode}", 'fcontents'));
  2504. }
  2505. else
  2506. {
  2507. $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null, 'raw_data');
  2508. }
  2509. if (!is_null($value))
  2510. {
  2511. $aValues[$sAttCode] = $value;
  2512. }
  2513. }
  2514. $aErrors = array();
  2515. $aFinalValues = array();
  2516. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2517. {
  2518. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2519. }
  2520. $this->UpdateObjectFromArray($aFinalValues);
  2521. // Invoke extensions after the update of the object from the form
  2522. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2523. {
  2524. $oExtensionInstance->OnFormSubmit($this, $sFormPrefix);
  2525. }
  2526. return $aErrors;
  2527. }
  2528. /**
  2529. * Updates the object from a given page argument
  2530. */
  2531. public function UpdateObjectFromArg($sArgName, $aAttList = null, $sTargetState = '')
  2532. {
  2533. if (is_null($aAttList))
  2534. {
  2535. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2536. }
  2537. $aRawValues = utils::ReadParam($sArgName, array(), '', 'raw_data');
  2538. $aValues = array();
  2539. foreach($aAttList as $sAttCode)
  2540. {
  2541. if (isset($aRawValues[$sAttCode]))
  2542. {
  2543. $aValues[$sAttCode] = $aRawValues[$sAttCode];
  2544. }
  2545. }
  2546. $aErrors = array();
  2547. $aFinalValues = array();
  2548. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2549. {
  2550. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2551. }
  2552. $this->UpdateObjectFromArray($aFinalValues);
  2553. return $aErrors;
  2554. }
  2555. protected function DBInsertTracked_Internal($bDoNotReload = false)
  2556. {
  2557. $res = parent::DBInsertTracked_Internal($bDoNotReload);
  2558. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2559. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2560. {
  2561. $oExtensionInstance->OnDBInsert($this, self::$m_oCurrChange);
  2562. }
  2563. return $res;
  2564. }
  2565. protected function DBCloneTracked_Internal($newKey = null)
  2566. {
  2567. $oNewObj = parent::DBCloneTracked_Internal($newKey);
  2568. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2569. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2570. {
  2571. $oExtensionInstance->OnDBInsert($oNewObj, self::$m_oCurrChange);
  2572. }
  2573. return $oNewObj;
  2574. }
  2575. protected function DBUpdateTracked_Internal()
  2576. {
  2577. $res = parent::DBUpdateTracked_Internal();
  2578. // Invoke extensions after the update (could be before)
  2579. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2580. {
  2581. $oExtensionInstance->OnDBUpdate($this, self::$m_oCurrChange);
  2582. }
  2583. return $res;
  2584. }
  2585. protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
  2586. {
  2587. // Todo - invoke the extension
  2588. return parent::BulkUpdateTracked_Internal($oFilter, $aValues);
  2589. }
  2590. protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
  2591. {
  2592. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2593. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2594. {
  2595. $oExtensionInstance->OnDBDelete($this, self::$m_oCurrChange);
  2596. }
  2597. return parent::DBDeleteTracked_Internal($oDeletionPlan);
  2598. }
  2599. protected static function BulkDeleteTracked_Internal(DBObjectSearch $oFilter)
  2600. {
  2601. // Todo - invoke the extension
  2602. return parent::BulkDeleteTracked_Internal($oFilter);
  2603. }
  2604. public function IsModified()
  2605. {
  2606. if (parent::IsModified())
  2607. {
  2608. return true;
  2609. }
  2610. // Plugins
  2611. //
  2612. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2613. {
  2614. if ($oExtensionInstance->OnIsModified($this))
  2615. {
  2616. return true;
  2617. }
  2618. }
  2619. }
  2620. public function DoCheckToWrite()
  2621. {
  2622. parent::DoCheckToWrite();
  2623. // Plugins
  2624. //
  2625. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2626. {
  2627. $aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
  2628. if (count($aNewIssues) > 0)
  2629. {
  2630. $this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
  2631. }
  2632. }
  2633. // User rights
  2634. //
  2635. $aChanges = $this->ListChanges();
  2636. if (count($aChanges) > 0)
  2637. {
  2638. $aForbiddenFields = array();
  2639. foreach ($this->ListChanges() as $sAttCode => $value)
  2640. {
  2641. $bUpdateAllowed = UserRights::IsActionAllowedOnAttribute(get_class($this), $sAttCode, UR_ACTION_MODIFY, DBObjectSet::FromObject($this));
  2642. if (!$bUpdateAllowed)
  2643. {
  2644. $oAttCode = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2645. $aForbiddenFields[] = $oAttCode->GetLabel();
  2646. }
  2647. }
  2648. if (count($aForbiddenFields) > 0)
  2649. {
  2650. // Security issue
  2651. $this->m_bSecurityIssue = true;
  2652. $this->m_aCheckIssues[] = Dict::Format('UI:Delete:NotAllowedToUpdate_Fields',implode(', ', $aForbiddenFields));
  2653. }
  2654. }
  2655. }
  2656. protected function DoCheckToDelete(&$oDeletionPlan)
  2657. {
  2658. parent::DoCheckToDelete($oDeletionPlan);
  2659. // Plugins
  2660. //
  2661. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2662. {
  2663. $aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
  2664. if (count($aNewIssues) > 0)
  2665. {
  2666. $this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
  2667. }
  2668. }
  2669. // User rights
  2670. //
  2671. $bDeleteAllowed = UserRights::IsActionAllowed(get_class($this), UR_ACTION_DELETE, DBObjectSet::FromObject($this));
  2672. if (!$bDeleteAllowed)
  2673. {
  2674. // Security issue
  2675. $this->m_bSecurityIssue = true;
  2676. $this->m_aDeleteIssues[] = Dict::S('UI:Delete:NotAllowedToDelete');
  2677. }
  2678. }
  2679. /**
  2680. * Special display where the case log uses the whole "screen" at the bottom of the "Properties" tab
  2681. */
  2682. public function DisplayCaseLog(WebPage $oPage, $sAttCode, $sComment = '', $sPrefix = '', $bEditMode = false)
  2683. {
  2684. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  2685. $sClass = get_class($this);
  2686. if ($this->IsNew())
  2687. {
  2688. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2689. }
  2690. else
  2691. {
  2692. $iFlags = $this->GetAttributeFlags($sAttCode);
  2693. }
  2694. if ( $iFlags & OPT_ATT_HIDDEN)
  2695. {
  2696. // The case log is hidden do nothing
  2697. }
  2698. else
  2699. {
  2700. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2701. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  2702. if ((!$bEditMode) || ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
  2703. {
  2704. // Check if the attribute is not read-only because of a synchro...
  2705. $aReasons = array();
  2706. $sSynchroIcon = '';
  2707. if ($iFlags & OPT_ATT_SLAVE)
  2708. {
  2709. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  2710. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  2711. $sTip = '';
  2712. foreach($aReasons as $aRow)
  2713. {
  2714. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  2715. }
  2716. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  2717. }
  2718. // Attribute is read-only
  2719. $sHTMLValue = $this->GetAsHTML($sAttCode);
  2720. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  2721. $aFieldsMap[$sAttCode] = $sInputId;
  2722. $sComment .= $sSynchroIcon;
  2723. }
  2724. else
  2725. {
  2726. $sValue = $this->Get($sAttCode);
  2727. $sDisplayValue = $this->GetEditValue($sAttCode);
  2728. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  2729. $sHTMLValue = '';
  2730. if ($sComment != '')
  2731. {
  2732. $sHTMLValue = '<span>'.$sComment.'</span><br/>';
  2733. }
  2734. $sHTMLValue .= "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  2735. $aFieldsMap[$sAttCode] = $sInputId;
  2736. }
  2737. //$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  2738. $oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'</legend>');
  2739. $oPage->add($sHTMLValue);
  2740. $oPage->add('</fieldset>');
  2741. }
  2742. }
  2743. public function GetExpectedAttributes($sCurrentState, $sStimulus, $bOnlyNewOnes)
  2744. {
  2745. $aTransitions = $this->EnumTransitions();
  2746. $aStimuli = MetaModel::EnumStimuli(get_class($this));
  2747. if (!isset($aTransitions[$sStimulus]))
  2748. {
  2749. // Invalid stimulus
  2750. throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $oObj->GetName(), $oObj->GetStateLabel()));
  2751. }
  2752. $aTransition = $aTransitions[$sStimulus];
  2753. $sTargetState = $aTransition['target_state'];
  2754. $aTargetStates = MetaModel::EnumStates(get_class($this));
  2755. $aTargetState = $aTargetStates[$sTargetState];
  2756. $aCurrentState = $aTargetStates[$this->GetState()];
  2757. $aExpectedAttributes = $aTargetState['attribute_list'];
  2758. $aCurrentAttributes = $aCurrentState['attribute_list'];
  2759. $aComputedAttributes = array();
  2760. foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
  2761. {
  2762. if (!array_key_exists($sAttCode, $aCurrentAttributes))
  2763. {
  2764. $aComputedAttributes[$sAttCode] = $iExpectCode;
  2765. }
  2766. else
  2767. {
  2768. if ( !($aCurrentAttributes[$sAttCode] & (OPT_ATT_HIDDEN|OPT_ATT_READONLY)) )
  2769. {
  2770. $iExpectCode = $iExpectCode & ~(OPT_ATT_MUSTPROMPT|OPT_ATT_MUSTCHANGE); // Already prompted/changed, reset the flags
  2771. }
  2772. //TODO: better check if the attribute is not *null*
  2773. if ( ($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) != ''))
  2774. {
  2775. $iExpectCode = $iExpectCode & ~(OPT_ATT_MANDATORY); // If the attribute is present, then no need to request its presence
  2776. }
  2777. $aComputedAttributes[$sAttCode] = $iExpectCode;
  2778. }
  2779. $aComputedAttributes[$sAttCode] = $aComputedAttributes[$sAttCode] & ~(OPT_ATT_READONLY|OPT_ATT_HIDDEN); // Don't care about this form now
  2780. if ($aComputedAttributes[$sAttCode] == 0)
  2781. {
  2782. unset($aComputedAttributes[$sAttCode]);
  2783. }
  2784. }
  2785. return $aComputedAttributes;
  2786. }
  2787. }
  2788. ?>