cmdbabstract.class.inc.php 150 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074
  1. <?php
  2. // Copyright (C) 2010-2015 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * Abstract class that implements some common and useful methods for displaying
  20. * the objects
  21. *
  22. * @copyright Copyright (C) 2010-2012 Combodo SARL
  23. * @license http://opensource.org/licenses/AGPL-3.0
  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. define('MIN_WATCHDOG_INTERVAL', 15); // Minimum interval for the watchdog: 15s
  31. require_once(APPROOT.'/core/cmdbobject.class.inc.php');
  32. require_once(APPROOT.'/application/applicationextension.inc.php');
  33. require_once(APPROOT.'/application/utils.inc.php');
  34. require_once(APPROOT.'/application/applicationcontext.class.inc.php');
  35. require_once(APPROOT.'/application/ui.linkswidget.class.inc.php');
  36. require_once(APPROOT.'/application/ui.linksdirectwidget.class.inc.php');
  37. require_once(APPROOT.'/application/ui.passwordwidget.class.inc.php');
  38. require_once(APPROOT.'/application/ui.extkeywidget.class.inc.php');
  39. require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
  40. require_once(APPROOT.'/application/datatable.class.inc.php');
  41. abstract class cmdbAbstractObject extends CMDBObject implements iDisplay
  42. {
  43. protected $m_iFormId; // The ID of the form used to edit the object (when in edition mode !)
  44. static $iGlobalFormId = 1;
  45. protected $aFieldsMap;
  46. /**
  47. * returns what will be the next ID for the forms
  48. */
  49. public static function GetNextFormId()
  50. {
  51. return 1 + self::$iGlobalFormId;
  52. }
  53. public static function GetUIPage()
  54. {
  55. return 'UI.php';
  56. }
  57. function ReloadAndDisplay($oPage, $oObj, $aParams)
  58. {
  59. $oAppContext = new ApplicationContext();
  60. // Reload the page to let the "calling" page execute its 'onunload' method.
  61. // Note 1: The redirection MUST NOT be made via an HTTP "header" since onunload is only called when the actual content of the DOM
  62. // is replaced by some other content. So the "bouncing" page must provide some content (in our case a script making the redirection).
  63. // Note 2: make sure that the URL below is different from the one of the "Modify" button, otherwise the button will have no effect. This is why we add "&a=1" at the end !!!
  64. // Note 3: we use the toggle of a flag in the sessionStorage object to prevent an infinite loop of reloads in case the object is actually locked by another window
  65. $sSessionStorageKey = get_class($oObj).'_'.$oObj->GetKey();
  66. $sParams = '';
  67. foreach($aParams as $sName => $value)
  68. {
  69. $sParams .= $sName.'='.urlencode($value).'&'; // Always add a trailing &
  70. }
  71. $sUrl = utils::GetAbsoluteUrlAppRoot().'pages/'.$oObj->GetUIPage().'?'.$sParams.'class='.get_class($oObj).'&id='.$oObj->getKey().'&'.$oAppContext->GetForLink().'&a=1';
  72. $oPage->add_script(
  73. <<<EOF
  74. if (!sessionStorage.getItem('$sSessionStorageKey'))
  75. {
  76. sessionStorage.setItem('$sSessionStorageKey', 1);
  77. window.location.href= "$sUrl";
  78. }
  79. else
  80. {
  81. sessionStorage.removeItem('$sSessionStorageKey');
  82. }
  83. EOF
  84. );
  85. $oObj->Reload();
  86. $oObj->DisplayDetails($oPage, false);
  87. }
  88. /**
  89. * Set a message diplayed to the end-user next time this object will be displayed
  90. * Messages are uniquely identified so that plugins can override standard messages (the final work is given to the last plugin to set the message for a given message id)
  91. * In practice, standard messages are recorded at the end but they will not overwrite existing messages
  92. *
  93. * @param string $sClass The class of the object (must be the final class)
  94. * @param int $iKey The identifier of the object
  95. * @param string $sMessageId Your id or one of the well-known ids: 'create', 'update' and 'apply_stimulus'
  96. * @param string $sMessage The HTML message (must be correctly escaped)
  97. * @param string $sSeverity Any of the following: ok, info, error.
  98. * @param float $fRank Ordering of the message: smallest displayed first (can be negative)
  99. * @param bool $bMustNotExist Do not alter any existing message (considering the id)
  100. *
  101. */
  102. public static function SetSessionMessage($sClass, $iKey, $sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false)
  103. {
  104. $sMessageKey = $sClass.'::'.$iKey;
  105. if (!isset($_SESSION['obj_messages'][$sMessageKey]))
  106. {
  107. $_SESSION['obj_messages'][$sMessageKey] = array();
  108. }
  109. if (!$bMustNotExist || !array_key_exists($sMessageId, $_SESSION['obj_messages'][$sMessageKey]))
  110. {
  111. $_SESSION['obj_messages'][$sMessageKey][$sMessageId] = array(
  112. 'rank' => $fRank,
  113. 'severity' => $sSeverity,
  114. 'message' => $sMessage
  115. );
  116. }
  117. }
  118. function DisplayBareHeader(WebPage $oPage, $bEditMode = false)
  119. {
  120. // Standard Header with name, actions menu and history block
  121. //
  122. // Is there a message for this object ??
  123. $aMessages = array();
  124. $aRanks = array();
  125. if (MetaModel::GetConfig()->Get('concurrent_lock_enabled'))
  126. {
  127. $aLockInfo = iTopOwnershipLock::IsLocked(get_class($this), $this->GetKey());
  128. if ($aLockInfo['locked'])
  129. {
  130. $aRanks[] = 0;
  131. $sName = $aLockInfo['owner']->GetName();
  132. if ($aLockInfo['owner']->Get('contactid') != 0)
  133. {
  134. $sName .= ' ('.$aLockInfo['owner']->Get('contactid_friendlyname').')';
  135. }
  136. $aResult['message'] = Dict::Format('UI:CurrentObjectIsLockedBy_User', $sName); $aMessages[] = "<div class=\"header_message message_error\">".Dict::Format('UI:CurrentObjectIsLockedBy_User', $sName)."</div>";
  137. }
  138. }
  139. $sMessageKey = get_class($this).'::'.$this->GetKey();
  140. if (array_key_exists('obj_messages', $_SESSION) && array_key_exists($sMessageKey, $_SESSION['obj_messages']))
  141. {
  142. foreach ($_SESSION['obj_messages'][$sMessageKey] as $sMessageId => $aMessageData)
  143. {
  144. $sMsgClass = 'message_'.$aMessageData['severity'];
  145. $aMessages[] = "<div class=\"header_message $sMsgClass\">".$aMessageData['message']."</div>";
  146. $aRanks[] = $aMessageData['rank'];
  147. }
  148. unset($_SESSION['obj_messages'][$sMessageKey]);
  149. }
  150. array_multisort($aRanks, $aMessages);
  151. foreach ($aMessages as $sMessage)
  152. {
  153. $oPage->add($sMessage);
  154. }
  155. // action menu
  156. $oSingletonFilter = new DBObjectSearch(get_class($this));
  157. $oSingletonFilter->AddCondition('id', $this->GetKey(), '=');
  158. $oBlock = new MenuBlock($oSingletonFilter, 'details', false);
  159. $oBlock->Display($oPage, -1);
  160. // Master data sources
  161. $sSynchroIcon = '';
  162. $bSynchronized = false;
  163. $oCreatorTask = null;
  164. $bCanBeDeletedByTask = false;
  165. $bCanBeDeletedByUser = true;
  166. $aMasterSources = array();
  167. $aSyncData = $this->GetSynchroData();
  168. if (count($aSyncData) > 0)
  169. {
  170. $bSynchronized = true;
  171. foreach ($aSyncData as $iSourceId => $aSourceData)
  172. {
  173. $oDataSource = $aSourceData['source'];
  174. $oReplica = reset($aSourceData['replica']); // Take the first one!
  175. $sApplicationURL = $oDataSource->GetApplicationUrl($this, $oReplica);
  176. $sLink = $oDataSource->GetName();
  177. if (!empty($sApplicationURL))
  178. {
  179. $sLink = "<a href=\"$sApplicationURL\" target=\"_blank\">".$oDataSource->GetName()."</a>";
  180. }
  181. if ($oReplica->Get('status_dest_creator') == 1)
  182. {
  183. $oCreatorTask = $oDataSource;
  184. $bCreatedByTask = true;
  185. }
  186. else
  187. {
  188. $bCreatedByTask = false;
  189. }
  190. if ($bCreatedByTask)
  191. {
  192. $sDeletePolicy = $oDataSource->Get('delete_policy');
  193. if (($sDeletePolicy == 'delete') || ($sDeletePolicy == 'update_then_delete'))
  194. {
  195. $bCanBeDeletedByTask = true;
  196. }
  197. $sUserDeletePolicy = $oDataSource->Get('user_delete_policy');
  198. if ($sUserDeletePolicy == 'nobody')
  199. {
  200. $bCanBeDeletedByUser = false;
  201. }
  202. elseif (($sUserDeletePolicy == 'administrators') && !UserRights::IsAdministrator())
  203. {
  204. $bCanBeDeletedByUser = false;
  205. }
  206. else // everybody...
  207. {
  208. }
  209. }
  210. $aMasterSources[$iSourceId]['datasource'] = $oDataSource;
  211. $aMasterSources[$iSourceId]['url'] = $sLink;
  212. $aMasterSources[$iSourceId]['last_synchro'] = $oReplica->Get('status_last_seen');
  213. }
  214. if (is_object($oCreatorTask))
  215. {
  216. $sTaskUrl = $aMasterSources[$oCreatorTask->GetKey()]['url'];
  217. if (!$bCanBeDeletedByUser)
  218. {
  219. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectCannotBeDeletedByUser_Source', $sTaskUrl)."</p>";
  220. }
  221. else
  222. {
  223. $sTip = "<p>".Dict::Format('Core:Synchro:TheObjectWasCreatedBy_Source', $sTaskUrl)."</p>";
  224. }
  225. if ($bCanBeDeletedByTask)
  226. {
  227. $sTip .= "<p>".Dict::Format('Core:Synchro:TheObjectCanBeDeletedBy_Source', $sTaskUrl)."</p>";
  228. }
  229. }
  230. else
  231. {
  232. $sTip = "<p>".Dict::S('Core:Synchro:ThisObjectIsSynchronized')."</p>";
  233. }
  234. $sTip .= "<p><b>".Dict::S('Core:Synchro:ListOfDataSources')."</b></p>";
  235. foreach($aMasterSources as $aStruct)
  236. {
  237. $oDataSource = $aStruct['datasource'];
  238. $sLink = $aStruct['url'];
  239. $sTip .= "<p style=\"white-space:nowrap\">".$oDataSource->GetIcon(true, 'style="vertical-align:middle"')."&nbsp;$sLink<br/>";
  240. $sTip .= Dict::S('Core:Synchro:LastSynchro').'<br/>'.$aStruct['last_synchro']."</p>";
  241. }
  242. $sSynchroIcon = '&nbsp;<img style="vertical-align:middle;" id="synchro_icon" src="../images/locked.png"/>';
  243. $sTip = addslashes($sTip);
  244. $oPage->add_ready_script("$('#synchro_icon').qtip( { content: '$sTip', show: 'mouseover', hide: { fixed: true }, style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  245. }
  246. $oPage->add("<div class=\"page_header\"><h1>".$this->GetIcon()."&nbsp;\n");
  247. $sRefreshIcon = '';
  248. if ($_SERVER['REQUEST_METHOD'] == 'GET')
  249. {
  250. $sRefreshIcon = '<img src="../images/reload.png" style="cursor:pointer;vertical-align:middle;margin-left:1em;" onclick="window.location.reload();" title="'.htmlentities(Dict::S('UI:Button:Refresh'), ENT_QUOTES, 'UTF-8').'"/>';
  251. }
  252. $oPage->add(MetaModel::GetName(get_class($this)).": <span class=\"hilite\">".$this->GetName()."</span>$sRefreshIcon $sSynchroIcon</h1>\n");
  253. $oPage->add("</div>\n");
  254. }
  255. function DisplayBareHistory(WebPage $oPage, $bEditMode = false, $iLimitCount = 0, $iLimitStart = 0)
  256. {
  257. // history block (with as a tab)
  258. $oHistoryFilter = new DBObjectSearch('CMDBChangeOp');
  259. $oHistoryFilter->AddCondition('objkey', $this->GetKey(), '=');
  260. $oHistoryFilter->AddCondition('objclass', get_class($this), '=');
  261. $oBlock = new HistoryBlock($oHistoryFilter, 'table', false);
  262. $oBlock->SetLimit($iLimitCount, $iLimitStart);
  263. $oBlock->Display($oPage, 'history');
  264. }
  265. function DisplayBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix = '', $aExtraParams = array())
  266. {
  267. $aFieldsMap = $this->GetBareProperties($oPage, $bEditMode, $sPrefix, $aExtraParams);
  268. if (!isset($aExtraParams['disable_plugins']) || !$aExtraParams['disable_plugins'])
  269. {
  270. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  271. {
  272. $oExtensionInstance->OnDisplayProperties($this, $oPage, $bEditMode);
  273. }
  274. }
  275. // Special case to display the case log, if any...
  276. // WARNING: if you modify the loop below, also check the corresponding code in UpdateObject and DisplayModifyForm
  277. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  278. {
  279. if ($oAttDef instanceof AttributeCaseLog)
  280. {
  281. $sComment = (isset($aExtraParams['fieldsComments'][$sAttCode])) ? $aExtraParams['fieldsComments'][$sAttCode] : '';
  282. $this->DisplayCaseLog($oPage, $sAttCode, $sComment, $sPrefix, $bEditMode);
  283. $aFieldsMap[$sAttCode] = $this->m_iFormId.'_'.$sAttCode;
  284. }
  285. }
  286. return $aFieldsMap;
  287. }
  288. /**
  289. * Add a field to the map: attcode => id used when building a form
  290. * @param string $sAttCode The attribute code of the field being edited
  291. * @param string $sInputId The unique ID of the control/widget in the page
  292. */
  293. protected function AddToFieldsMap($sAttCode, $sInputId)
  294. {
  295. $this->aFieldsMap[$sAttCode] = $sInputId;
  296. }
  297. function DisplayBareRelations(WebPage $oPage, $bEditMode = false)
  298. {
  299. $aRedundancySettings = $this->FindVisibleRedundancySettings();
  300. // Related objects: display all the linkset attributes, each as a separate tab
  301. // In the order described by the 'display' ZList
  302. $aList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  303. if (count($aList) == 0)
  304. {
  305. // Empty ZList defined, display all the linkedset attributes defined
  306. $aList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  307. }
  308. $sClass = get_class($this);
  309. foreach($aList as $sAttCode)
  310. {
  311. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  312. // Display mode
  313. if (!$oAttDef->IsLinkset()) continue; // Process only linkset attributes...
  314. // $oSet = new DBObjectSet($this->Get($sAttCode)->GetFilter()); // Why do something so useless ?
  315. $oSet = $this->Get($sAttCode);
  316. $iCount = $oSet->Count();
  317. $sCount = '';
  318. if ($iCount != 0)
  319. {
  320. $sCount = " ($iCount)";
  321. }
  322. $oPage->SetCurrentTab($oAttDef->GetLabel().$sCount);
  323. if ($this->IsNew())
  324. {
  325. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  326. }
  327. else
  328. {
  329. $iFlags = $this->GetAttributeFlags($sAttCode);
  330. }
  331. // Adjust the flags according to user rights
  332. if ($oAttDef->IsIndirect())
  333. {
  334. $sLinkedClass = $oAttDef->GetLinkedClass();
  335. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  336. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  337. // n:n links => must be allowed to modify the linking class AND read the target class in order to edit the linkedset
  338. if (!UserRights::IsActionAllowed($sLinkedClass, UR_ACTION_MODIFY) || !UserRights::IsActionAllowed($sTargetClass, UR_ACTION_READ))
  339. {
  340. $iFlags |= OPT_ATT_READONLY;
  341. }
  342. // n:n links => must be allowed to read the linking class AND the target class in order to display the linkedset
  343. if (!UserRights::IsActionAllowed($sLinkedClass, UR_ACTION_READ) || !UserRights::IsActionAllowed($sTargetClass, UR_ACTION_READ))
  344. {
  345. $iFlags |= OPT_ATT_HIDDEN;
  346. }
  347. }
  348. else
  349. {
  350. // 1:n links => must be allowed to modify the linked class in order to edit the linkedset
  351. if (!UserRights::IsActionAllowed($oAttDef->GetLinkedClass(), UR_ACTION_MODIFY))
  352. {
  353. $iFlags |= OPT_ATT_READONLY;
  354. }
  355. // 1:n links => must be allowed to read the linked class in order to display the linkedset
  356. if (!UserRights::IsActionAllowed($oAttDef->GetLinkedClass(), UR_ACTION_READ))
  357. {
  358. $iFlags |= OPT_ATT_HIDDEN;
  359. }
  360. }
  361. // Non-readable/hidden linkedset... don't display anything
  362. if ($iFlags & OPT_ATT_HIDDEN) continue;
  363. $aArgs = array('this' => $this);
  364. $bReadOnly = ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE));
  365. if ($bEditMode && (!$bReadOnly))
  366. {
  367. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  368. $sLinkedClass = $oAttDef->GetLinkedClass();
  369. if ($oAttDef->IsIndirect())
  370. {
  371. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  372. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  373. }
  374. else
  375. {
  376. $sTargetClass = $sLinkedClass;
  377. }
  378. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription().'<span id="busy_'.$sInputId.'"></span>');
  379. $oValue = $this->Get($sAttCode);
  380. $sDisplayValue = ''; // not used
  381. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $oValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  382. $this->AddToFieldsMap($sAttCode, $sInputId);
  383. $oPage->add($sHTMLValue);
  384. }
  385. else
  386. {
  387. // Display mode
  388. if (!$oAttDef->IsIndirect())
  389. {
  390. // 1:n links
  391. $sTargetClass = $oAttDef->GetLinkedClass();
  392. $aDefaults = array($oAttDef->GetExtKeyToMe() => $this->GetKey());
  393. $oAppContext = new ApplicationContext();
  394. foreach($oAppContext->GetNames() as $sKey)
  395. {
  396. // The linked object inherits the parent's value for the context
  397. if (MetaModel::IsValidAttCode($sClass, $sKey))
  398. {
  399. $aDefaults[$sKey] = $this->Get($sKey);
  400. }
  401. }
  402. $aParams = array(
  403. 'target_attr' => $oAttDef->GetExtKeyToMe(),
  404. 'object_id' => $this->GetKey(),
  405. 'menu' => false,
  406. 'default' => $aDefaults,
  407. 'table_id' => $sClass.'_'.$sAttCode,
  408. );
  409. }
  410. else
  411. {
  412. // n:n links
  413. $sLinkedClass = $oAttDef->GetLinkedClass();
  414. $oLinkingAttDef = MetaModel::GetAttributeDef($sLinkedClass, $oAttDef->GetExtKeyToRemote());
  415. $sTargetClass = $oLinkingAttDef->GetTargetClass();
  416. $bMenu = ($this->Get($sAttCode)->Count() > 0); // The menu is enabled only if there are already some elements...
  417. $aParams = array(
  418. 'link_attr' => $oAttDef->GetExtKeyToMe(),
  419. 'object_id' => $this->GetKey(),
  420. 'target_attr' => $oAttDef->GetExtKeyToRemote(),
  421. 'view_link' => false,
  422. 'menu' => false,
  423. 'display_limit' => true, // By default limit the list to speed up the initial load & display
  424. 'table_id' => $sClass.'_'.$sAttCode,
  425. );
  426. }
  427. $oPage->p(MetaModel::GetClassIcon($sTargetClass)."&nbsp;".$oAttDef->GetDescription());
  428. $oBlock = new DisplayBlock($this->Get($sAttCode)->GetFilter(), 'list', false);
  429. $oBlock->Display($oPage, 'rel_'.$sAttCode, $aParams);
  430. }
  431. if (array_key_exists($sAttCode, $aRedundancySettings))
  432. {
  433. foreach ($aRedundancySettings[$sAttCode] as $oRedundancyAttDef)
  434. {
  435. $sRedundancyAttCode = $oRedundancyAttDef->GetCode();
  436. $sValue = $this->Get($sRedundancyAttCode);
  437. $iRedundancyFlags = $this->GetFormAttributeFlags($sRedundancyAttCode);
  438. $bRedundancyReadOnly = ($iRedundancyFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE));
  439. $oPage->add('<fieldset>');
  440. $oPage->add('<legend>'.$oRedundancyAttDef->GetLabel().'</legend>');
  441. if ($bEditMode && (!$bRedundancyReadOnly))
  442. {
  443. $sInputId = $this->m_iFormId.'_'.$sRedundancyAttCode;
  444. $oPage->add("<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sRedundancyAttCode, $oRedundancyAttDef, $sValue, '', $sInputId, '', $iFlags, $aArgs).'</span>');
  445. }
  446. else
  447. {
  448. $oPage->add($oRedundancyAttDef->GetDisplayForm($sValue, $oPage, false, $this->m_iFormId));
  449. }
  450. $oPage->add('</fieldset>');
  451. }
  452. }
  453. }
  454. $oPage->SetCurrentTab('');
  455. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  456. {
  457. $oExtensionInstance->OnDisplayRelations($this, $oPage, $bEditMode);
  458. }
  459. // Display Notifications after the other tabs since this tab disappears in edition
  460. if (!$bEditMode)
  461. {
  462. // Look for any trigger that considers this object as "In Scope"
  463. // If any trigger has been found then display a tab with notifications
  464. //
  465. $oTriggerSet = new CMDBObjectSet(new DBObjectSearch('Trigger'));
  466. $aTriggers = array();
  467. while($oTrigger = $oTriggerSet->Fetch())
  468. {
  469. if($oTrigger->IsInScope($this))
  470. {
  471. $aTriggers[] = $oTrigger->GetKey();
  472. }
  473. }
  474. if (count($aTriggers) > 0)
  475. {
  476. $iId = $this->GetKey();
  477. $sTriggersList = implode(',', $aTriggers);
  478. $aNotifSearches = array();
  479. $iNotifsCount = 0;
  480. $aNotificationClasses = MetaModel::EnumChildClasses('EventNotification', ENUM_CHILD_CLASSES_EXCLUDETOP);
  481. foreach($aNotificationClasses as $sNotifClass)
  482. {
  483. $aNotifSearches[$sNotifClass] = DBObjectSearch::FromOQL("SELECT $sNotifClass AS Ev JOIN Trigger AS T ON Ev.trigger_id = T.id WHERE T.id IN ($sTriggersList) AND Ev.object_id = $iId");
  484. $oNotifSet = new DBObjectSet($aNotifSearches[$sNotifClass]);
  485. $iNotifsCount += $oNotifSet->Count();
  486. }
  487. // Display notifications regarding the object: on block per subclass to have the intersting columns
  488. $sCount = ($iNotifsCount > 0) ? ' ('.$iNotifsCount.')' : '';
  489. $oPage->SetCurrentTab(Dict::S('UI:NotificationsTab').$sCount);
  490. foreach($aNotificationClasses as $sNotifClass)
  491. {
  492. $oPage->p(MetaModel::GetClassIcon($sNotifClass, true).'&nbsp;'.MetaModel::GetName($sNotifClass));
  493. $oBlock = new DisplayBlock($aNotifSearches[$sNotifClass], 'list', false);
  494. $oBlock->Display($oPage, 'notifications_'.$sNotifClass, array('menu' => false));
  495. }
  496. }
  497. }
  498. }
  499. function GetBareProperties(WebPage $oPage, $bEditMode = false, $sPrefix, $aExtraParams = array())
  500. {
  501. $sHtml = '';
  502. $oAppContext = new ApplicationContext();
  503. $sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
  504. $aDetails = array();
  505. $sClass = get_class($this);
  506. $aDetailsList = MetaModel::GetZListItems($sClass, 'details');
  507. $aDetailsStruct = self::ProcessZlist($aDetailsList, array('UI:PropertiesTab' => array()), 'UI:PropertiesTab', 'col1', '');
  508. // Compute the list of properties to display, first the attributes in the 'details' list, then
  509. // all the remaining attributes that are not external fields
  510. $sHtml = '';
  511. $aDetails = array();
  512. $iInputId = 0;
  513. $aFieldsMap = array();
  514. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  515. $aExtraFlags = (isset($aExtraParams['fieldsFlags'])) ? $aExtraParams['fieldsFlags'] : array();
  516. $bFieldComments = (count($aFieldsComments) > 0);
  517. foreach($aDetailsStruct as $sTab => $aCols )
  518. {
  519. $aDetails[$sTab] = array();
  520. ksort($aCols);
  521. $oPage->SetCurrentTab(Dict::S($sTab));
  522. $oPage->add('<table style="vertical-align:top"><tr>');
  523. foreach($aCols as $sColIndex => $aFieldsets)
  524. {
  525. $oPage->add('<td style="vertical-align:top">');
  526. //$aDetails[$sTab][$sColIndex] = array();
  527. $sLabel = '';
  528. $sPreviousLabel = '';
  529. $aDetails[$sTab][$sColIndex] = array();
  530. foreach($aFieldsets as $sFieldsetName => $aFields)
  531. {
  532. if (!empty($sFieldsetName) && ($sFieldsetName[0] != '_'))
  533. {
  534. $sLabel = $sFieldsetName;
  535. }
  536. else
  537. {
  538. $sLabel = '';
  539. }
  540. if ($sLabel != $sPreviousLabel)
  541. {
  542. if (!empty($sPreviousLabel))
  543. {
  544. $oPage->add('<fieldset>');
  545. $oPage->add('<legend>'.Dict::S($sPreviousLabel).'</legend>');
  546. }
  547. $oPage->Details($aDetails[$sTab][$sColIndex]);
  548. if (!empty($sPreviousLabel))
  549. {
  550. $oPage->add('</fieldset>');
  551. }
  552. $aDetails[$sTab][$sColIndex] = array();
  553. $sPreviousLabel = $sLabel;
  554. }
  555. foreach($aFields as $sAttCode)
  556. {
  557. if ($bEditMode)
  558. {
  559. $sComments = isset($aFieldsComments[$sAttCode]) ? $aFieldsComments[$sAttCode] : '&nbsp;';
  560. $sInfos = '&nbsp;';
  561. $iFlags = $this->GetFormAttributeFlags($sAttCode);
  562. if (array_key_exists($sAttCode, $aExtraFlags))
  563. {
  564. // the caller may override some flags if needed
  565. $iFlags = $iFlags | $aExtraFlags[$sAttCode];
  566. }
  567. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  568. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0))
  569. {
  570. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  571. if ($oAttDef->IsWritable())
  572. {
  573. if ($sStateAttCode == $sAttCode)
  574. {
  575. // State attribute is always read-only from the UI
  576. $sHTMLValue = $this->GetStateLabel();
  577. $val = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  578. }
  579. else
  580. {
  581. if ($iFlags & OPT_ATT_HIDDEN)
  582. {
  583. // Attribute is hidden, add a hidden input
  584. $oPage->add('<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/>');
  585. $aFieldsMap[$sAttCode] = $sInputId;
  586. }
  587. else
  588. {
  589. if ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE))
  590. {
  591. // Check if the attribute is not read-only because of a synchro...
  592. $aReasons = array();
  593. $sSynchroIcon = '';
  594. if ($iFlags & OPT_ATT_SLAVE)
  595. {
  596. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  597. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  598. $sTip = '';
  599. foreach($aReasons as $aRow)
  600. {
  601. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  602. }
  603. $sTip = addslashes($sTip);
  604. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  605. }
  606. // Attribute is read-only
  607. $sHTMLValue = "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode);
  608. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->Get($sAttCode), ENT_QUOTES, 'UTF-8').'"/></span>';
  609. $aFieldsMap[$sAttCode] = $sInputId;
  610. $sComments = $sSynchroIcon;
  611. }
  612. else
  613. {
  614. $sValue = $this->Get($sAttCode);
  615. $sDisplayValue = $this->GetEditValue($sAttCode);
  616. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  617. $sHTMLValue = "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  618. $aFieldsMap[$sAttCode] = $sInputId;
  619. }
  620. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  621. }
  622. }
  623. }
  624. else
  625. {
  626. $val = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => "<span id=\"field_{$sInputId}\">".$this->GetAsHTML($sAttCode)."</span>", 'comments' => $sComments, 'infos' => $sInfos);
  627. $aFieldsMap[$sAttCode] = $sInputId;
  628. }
  629. }
  630. else
  631. {
  632. $val = null; // Skip this field
  633. }
  634. }
  635. else
  636. {
  637. // !bEditMode
  638. $val = $this->GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode);
  639. }
  640. if ($val != null)
  641. {
  642. // The field is visible, add it to the current column
  643. $aDetails[$sTab][$sColIndex][] = $val;
  644. $iInputId++;
  645. }
  646. }
  647. }
  648. if (!empty($sPreviousLabel))
  649. {
  650. $oPage->add('<fieldset>');
  651. $oPage->add('<legend>'.Dict::S($sFieldsetName).'</legend>');
  652. }
  653. $oPage->Details($aDetails[$sTab][$sColIndex]);
  654. if (!empty($sPreviousLabel))
  655. {
  656. $oPage->add('</fieldset>');
  657. }
  658. $oPage->add('</td>');
  659. }
  660. $oPage->add('</tr></table>');
  661. }
  662. return $aFieldsMap;
  663. }
  664. function DisplayDetails(WebPage $oPage, $bEditMode = false)
  665. {
  666. $sTemplate = Utils::ReadFromFile(MetaModel::GetDisplayTemplate(get_class($this)));
  667. if (!empty($sTemplate))
  668. {
  669. $oTemplate = new DisplayTemplate($sTemplate);
  670. // Note: to preserve backward compatibility with home-made templates, the placeholder '$pkey$' has been preserved
  671. // but the preferred method is to use '$id$'
  672. $oTemplate->Render($oPage, array('class_name'=> MetaModel::GetName(get_class($this)),'class'=> get_class($this), 'pkey'=> $this->GetKey(), 'id'=> $this->GetKey(), 'name' => $this->GetName()));
  673. }
  674. else
  675. {
  676. // Object's details
  677. // template not found display the object using the *old style*
  678. $this->DisplayBareHeader($oPage, $bEditMode);
  679. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB);
  680. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  681. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  682. $this->DisplayBareProperties($oPage, $bEditMode);
  683. $this->DisplayBareRelations($oPage, $bEditMode);
  684. //$oPage->SetCurrentTab(Dict::S('UI:HistoryTab'));
  685. //$this->DisplayBareHistory($oPage, $bEditMode);
  686. $oPage->AddAjaxTab(Dict::S('UI:HistoryTab'), utils::GetAbsoluteUrlAppRoot().'pages/ajax.render.php?operation=history&class='.get_class($this).'&id='.$this->GetKey());
  687. }
  688. }
  689. function DisplayPreview(WebPage $oPage)
  690. {
  691. $aDetails = array();
  692. $sClass = get_class($this);
  693. $aList = MetaModel::GetZListItems($sClass, 'preview');
  694. foreach($aList as $sAttCode)
  695. {
  696. $aDetails[] = array('label' => MetaModel::GetLabel($sClass, $sAttCode), 'value' =>$this->GetAsHTML($sAttCode));
  697. }
  698. $oPage->details($aDetails);
  699. }
  700. public static function DisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  701. {
  702. if ($oPage->is_pdf())
  703. {
  704. $oPage->add(self::DisplaySetForPrinting($oPage, $oSet, $aExtraParams));
  705. }
  706. else
  707. {
  708. $oPage->add(self::GetDisplaySet($oPage, $oSet, $aExtraParams));
  709. }
  710. }
  711. /**
  712. * Simplifed version of GetDisplaySet() with less "decoration" around the table (and no paging)
  713. * that fits better into a printed document (like a PDF)
  714. * @param PDFPage $oPage
  715. * @param DBObjectSet $oSet
  716. * @param hash $aExtraParams
  717. * @return string The HTML representation of the table
  718. */
  719. public static function DisplaySetForPrinting(PDFPage $oPage, DBObjectSet $oSet, $aExtraParams = array())
  720. {
  721. $iListId = empty($aExtraParams['currentId']) ? $oPage->GetUniqueId() : $aExtraParams['currentId'];
  722. $sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
  723. $bViewLink = true;
  724. $sSelectMode = 'none';
  725. $iListId = $sTableId;
  726. $sClassAlias = $oSet->GetClassAlias();
  727. $sClassName = $oSet->GetClass();
  728. $sZListName = 'list';
  729. $aClassAliases = array( $sClassAlias => $sClassName);
  730. $aList = cmdbAbstractObject::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  731. $oDataTable = new PrintableDataTable($iListId, $oSet, $aClassAliases, $sTableId);
  732. $oSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
  733. $oSettings->iDefaultPageSize = 0;
  734. $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
  735. return $oDataTable->Display($oPage, $oSettings, false /* $bDisplayMenu */, $sSelectMode, $bViewLink, $aExtraParams);
  736. }
  737. /**
  738. * Get the HTML fragment corresponding to the display of a table representing a set of objects
  739. * @param WebPage $oPage The page object is used for out-of-band information (mostly scripts) output
  740. * @param CMDBObjectSet The set of objects to display
  741. * @param Hash $aExtraParams Some extra configuration parameters to tweak the behavior of the display
  742. * @return String The HTML fragment representing the table of objects
  743. */
  744. public static function GetDisplaySet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  745. {
  746. if (empty($aExtraParams['currentId']))
  747. {
  748. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  749. }
  750. else
  751. {
  752. $iListId = $aExtraParams['currentId'];
  753. }
  754. // Initialize and check the parameters
  755. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  756. $sLinkageAttribute = isset($aExtraParams['link_attr']) ? $aExtraParams['link_attr'] : '';
  757. $iLinkedObjectId = isset($aExtraParams['object_id']) ? $aExtraParams['object_id'] : 0;
  758. $sTargetAttr = isset($aExtraParams['target_attr']) ? $aExtraParams['target_attr'] : '';
  759. if (!empty($sLinkageAttribute))
  760. {
  761. if($iLinkedObjectId == 0)
  762. {
  763. // if 'links' mode is requested the id of the object to link to must be specified
  764. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_object_id'));
  765. }
  766. if($sTargetAttr == '')
  767. {
  768. // if 'links' mode is requested the d of the object to link to must be specified
  769. throw new ApplicationException(Dict::S('UI:Error:MandatoryTemplateParameter_target_attr'));
  770. }
  771. }
  772. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  773. $bTruncated = isset($aExtraParams['truncated']) ? $aExtraParams['truncated'] == true : true;
  774. $bSelectMode = isset($aExtraParams['selection_mode']) ? $aExtraParams['selection_mode'] == true : false;
  775. $bSingleSelectMode = isset($aExtraParams['selection_type']) ? ($aExtraParams['selection_type'] == 'single') : false;
  776. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  777. $aExtraFields = array();
  778. foreach ($aExtraFieldsRaw as $sFieldName)
  779. {
  780. // Ignore attributes not of the main queried class
  781. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  782. {
  783. $sClassAlias = $aMatches[1];
  784. $sAttCode = $aMatches[2];
  785. if ($sClassAlias == $oSet->GetFilter()->GetClassAlias())
  786. {
  787. $aExtraFields[] = $sAttCode;
  788. }
  789. }
  790. else
  791. {
  792. $aExtraFields[] = $sFieldName;
  793. }
  794. }
  795. $sHtml = '';
  796. $oAppContext = new ApplicationContext();
  797. $sClassName = $oSet->GetFilter()->GetClass();
  798. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  799. if ($sZListName !== false)
  800. {
  801. $aList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  802. $aList = array_merge($aList, $aExtraFields);
  803. }
  804. else
  805. {
  806. $aList = $aExtraFields;
  807. }
  808. // Filter the list to removed linked set since we are not able to display them here
  809. foreach($aList as $index => $sAttCode)
  810. {
  811. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  812. if ($oAttDef instanceof AttributeLinkedSet)
  813. {
  814. // Removed from the display list
  815. unset($aList[$index]);
  816. }
  817. }
  818. if (!empty($sLinkageAttribute))
  819. {
  820. // The set to display is in fact a set of links between the object specified in the $sLinkageAttribute
  821. // and other objects...
  822. // The display will then group all the attributes related to the link itself:
  823. // | Link_attr1 | link_attr2 | ... || Object_attr1 | Object_attr2 | Object_attr3 | .. | Object_attr_n |
  824. $aDisplayList = array();
  825. $aAttDefs = MetaModel::ListAttributeDefs($sClassName);
  826. assert(isset($aAttDefs[$sLinkageAttribute]));
  827. $oAttDef = $aAttDefs[$sLinkageAttribute];
  828. assert($oAttDef->IsExternalKey());
  829. // First display all the attributes specific to the link record
  830. foreach($aList as $sLinkAttCode)
  831. {
  832. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  833. if ( (!$oLinkAttDef->IsExternalKey()) && (!$oLinkAttDef->IsExternalField()) )
  834. {
  835. $aDisplayList[] = $sLinkAttCode;
  836. }
  837. }
  838. // Then display all the attributes neither specific to the link record nor to the 'linkage' object (because the latter are constant)
  839. foreach($aList as $sLinkAttCode)
  840. {
  841. $oLinkAttDef = $aAttDefs[$sLinkAttCode];
  842. if (($oLinkAttDef->IsExternalKey() && ($sLinkAttCode != $sLinkageAttribute))
  843. || ($oLinkAttDef->IsExternalField() && ($oLinkAttDef->GetKeyAttCode()!=$sLinkageAttribute)) )
  844. {
  845. $aDisplayList[] = $sLinkAttCode;
  846. }
  847. }
  848. // First display all the attributes specific to the link
  849. // Then display all the attributes linked to the other end of the relationship
  850. $aList = $aDisplayList;
  851. }
  852. $sSelectMode = 'none';
  853. if ($bSelectMode)
  854. {
  855. $sSelectMode = $bSingleSelectMode ? 'single' : 'multiple';
  856. }
  857. $sClassAlias = $oSet->GetClassAlias();
  858. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  859. $sTableId = isset($aExtraParams['table_id']) ? $aExtraParams['table_id'] : null;
  860. $aClassAliases = array( $sClassAlias => $sClassName);
  861. $oDataTable = new DataTable($iListId, $oSet, $aClassAliases, $sTableId);
  862. $oSettings = DataTableSettings::GetDataModelSettings($aClassAliases, $bViewLink, array($sClassAlias => $aList));
  863. if ($bDisplayLimit)
  864. {
  865. $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
  866. $oSettings->iDefaultPageSize = $iDefaultPageSize;
  867. }
  868. else
  869. {
  870. $oSettings->iDefaultPageSize = 0;
  871. }
  872. $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
  873. return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
  874. }
  875. public static function GetDisplayExtendedSet(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  876. {
  877. if (empty($aExtraParams['currentId']))
  878. {
  879. $iListId = $oPage->GetUniqueId(); // Works only if not in an Ajax page !!
  880. }
  881. else
  882. {
  883. $iListId = $aExtraParams['currentId'];
  884. }
  885. $aList = array();
  886. // Initialize and check the parameters
  887. $bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
  888. $bDisplayMenu = isset($aExtraParams['menu']) ? $aExtraParams['menu'] == true : true;
  889. // Check if there is a list of aliases to limit the display to...
  890. $aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : array();
  891. $sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
  892. $aExtraFieldsRaw = isset($aExtraParams['extra_fields']) ? explode(',', trim($aExtraParams['extra_fields'])) : array();
  893. $aExtraFields = array();
  894. foreach ($aExtraFieldsRaw as $sFieldName)
  895. {
  896. // Ignore attributes not of the main queried class
  897. if (preg_match('/^(.*)\.(.*)$/', $sFieldName, $aMatches))
  898. {
  899. $sClassAlias = $aMatches[1];
  900. $sAttCode = $aMatches[2];
  901. if (array_key_exists($sClassAlias, $oSet->GetSelectedClasses()))
  902. {
  903. $aExtraFields[$sClassAlias][] = $sAttCode;
  904. }
  905. }
  906. else
  907. {
  908. $aExtraFields['*'] = $sAttCode;
  909. }
  910. }
  911. $sHtml = '';
  912. $oAppContext = new ApplicationContext();
  913. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  914. $aAuthorizedClasses = array();
  915. foreach($aClasses as $sAlias => $sClassName)
  916. {
  917. if ( (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS)) &&
  918. ( (count($aDisplayAliases) == 0) || (in_array($sAlias, $aDisplayAliases))) )
  919. {
  920. $aAuthorizedClasses[$sAlias] = $sClassName;
  921. }
  922. }
  923. $aAttribs = array();
  924. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  925. {
  926. if (array_key_exists($sAlias, $aExtraFields))
  927. {
  928. $aList[$sAlias] = $aExtraFields[$sAlias];
  929. }
  930. else
  931. {
  932. $aList[$sAlias] = array();
  933. }
  934. if ($sZListName !== false)
  935. {
  936. $aDefaultList = self::FlattenZList(MetaModel::GetZListItems($sClassName, $sZListName));
  937. $aList[$sAlias] = array_merge($aDefaultList, $aList[$sAlias]);
  938. }
  939. // Filter the list to removed linked set since we are not able to display them here
  940. foreach($aList[$sAlias] as $index => $sAttCode)
  941. {
  942. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sAttCode);
  943. if ($oAttDef instanceof AttributeLinkedSet)
  944. {
  945. // Removed from the display list
  946. unset($aList[$sAlias][$index]);
  947. }
  948. }
  949. }
  950. $sSelectMode = 'none';
  951. $sClassAlias = $oSet->GetClassAlias();
  952. $oDataTable = new DataTable($iListId, $oSet, $aAuthorizedClasses);
  953. $oSettings = DataTableSettings::GetDataModelSettings($aAuthorizedClasses, $bViewLink, $aList);
  954. $bDisplayLimit = isset($aExtraParams['display_limit']) ? $aExtraParams['display_limit'] : true;
  955. if ($bDisplayLimit)
  956. {
  957. $iDefaultPageSize = appUserPreferences::GetPref('default_page_size', MetaModel::GetConfig()->GetMinDisplayLimit());
  958. $oSettings->iDefaultPageSize = $iDefaultPageSize;
  959. }
  960. $oSettings->aSortOrder = MetaModel::GetOrderByDefault($sClassName);
  961. return $oDataTable->Display($oPage, $oSettings, $bDisplayMenu, $sSelectMode, $bViewLink, $aExtraParams);
  962. }
  963. static function DisplaySetAsCSV(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array(), $sCharset = 'UTF-8')
  964. {
  965. $oPage->add(self::GetSetAsCSV($oSet, $aParams, $sCharset));
  966. }
  967. static function GetSetAsCSV(DBObjectSet $oSet, $aParams = array(), $sCharset = 'UTF-8')
  968. {
  969. $sSeparator = isset($aParams['separator']) ? $aParams['separator'] : ','; // default separator is comma
  970. $sTextQualifier = isset($aParams['text_qualifier']) ? $aParams['text_qualifier'] : '"'; // default text qualifier is double quote
  971. $aFields = null;
  972. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  973. {
  974. $aFields = explode(',', $aParams['fields']);
  975. }
  976. $bFieldsAdvanced = false;
  977. if (isset($aParams['fields_advanced']))
  978. {
  979. $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
  980. }
  981. $bLocalize = true;
  982. if (isset($aParams['localize_values']))
  983. {
  984. $bLocalize = (bool) $aParams['localize_values'];
  985. }
  986. $aList = array();
  987. $oAppContext = new ApplicationContext();
  988. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  989. $aAuthorizedClasses = array();
  990. foreach($aClasses as $sAlias => $sClassName)
  991. {
  992. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  993. {
  994. $aAuthorizedClasses[$sAlias] = $sClassName;
  995. }
  996. }
  997. $aAttribs = array();
  998. $aHeader = array();
  999. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1000. {
  1001. $aList[$sAlias] = array();
  1002. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  1003. {
  1004. if (is_null($aFields) || (count($aFields) == 0))
  1005. {
  1006. // Standard list of attributes (no link sets)
  1007. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  1008. {
  1009. $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
  1010. if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  1011. {
  1012. if ($bFieldsAdvanced)
  1013. {
  1014. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  1015. if ($oAttDef->IsExternalKey(EXTKEY_RELATIVE))
  1016. {
  1017. $sRemoteClass = $oAttDef->GetTargetClass();
  1018. foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
  1019. {
  1020. $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
  1021. }
  1022. }
  1023. }
  1024. }
  1025. else
  1026. {
  1027. // Any other attribute
  1028. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  1029. }
  1030. }
  1031. }
  1032. else
  1033. {
  1034. // User defined list of attributes
  1035. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  1036. {
  1037. $aList[$sAlias][$sAttCode] = $oAttDef;
  1038. }
  1039. }
  1040. }
  1041. if ($bFieldsAdvanced)
  1042. {
  1043. $aHeader[] = 'id';
  1044. }
  1045. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1046. {
  1047. $aHeader[] = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx, isset($aParams['showMandatoryFields'])) : $sAttCodeEx;
  1048. }
  1049. }
  1050. $sHtml = implode($sSeparator, $aHeader)."\n";
  1051. $oSet->Seek(0);
  1052. while ($aObjects = $oSet->FetchAssoc())
  1053. {
  1054. $aRow = array();
  1055. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1056. {
  1057. $oObj = $aObjects[$sAlias];
  1058. if ($bFieldsAdvanced)
  1059. {
  1060. if (is_null($oObj))
  1061. {
  1062. $aRow[] = '';
  1063. }
  1064. else
  1065. {
  1066. $aRow[] = $oObj->GetKey();
  1067. }
  1068. }
  1069. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1070. {
  1071. if (is_null($oObj))
  1072. {
  1073. $aRow[] = '';
  1074. }
  1075. else
  1076. {
  1077. $value = $oObj->Get($sAttCodeEx);
  1078. $sCSVValue = $oAttDef->GetAsCSV($value, $sSeparator, $sTextQualifier, $oObj, $bLocalize);
  1079. $aRow[] = iconv('UTF-8', $sCharset.'//IGNORE//TRANSLIT', $sCSVValue);
  1080. }
  1081. }
  1082. }
  1083. $sHtml .= implode($sSeparator, $aRow)."\n";
  1084. }
  1085. return $sHtml;
  1086. }
  1087. static function DisplaySetAsHTMLSpreadsheet(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1088. {
  1089. $oPage->add(self::GetSetAsHTMLSpreadsheet($oSet, $aParams));
  1090. }
  1091. /**
  1092. * Spreadsheet output: designed for end users doing some reporting
  1093. * Then the ids are excluded and replaced by the corresponding friendlyname
  1094. */
  1095. static function GetSetAsHTMLSpreadsheet(DBObjectSet $oSet, $aParams = array())
  1096. {
  1097. $aFields = null;
  1098. if (isset($aParams['fields']) && (strlen($aParams['fields']) > 0))
  1099. {
  1100. $aFields = explode(',', $aParams['fields']);
  1101. }
  1102. $bFieldsAdvanced = false;
  1103. if (isset($aParams['fields_advanced']))
  1104. {
  1105. $bFieldsAdvanced = (bool) $aParams['fields_advanced'];
  1106. }
  1107. $bLocalize = true;
  1108. if (isset($aParams['localize_values']))
  1109. {
  1110. $bLocalize = (bool) $aParams['localize_values'];
  1111. }
  1112. $aList = array();
  1113. $oAppContext = new ApplicationContext();
  1114. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1115. $aAuthorizedClasses = array();
  1116. foreach($aClasses as $sAlias => $sClassName)
  1117. {
  1118. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1119. {
  1120. $aAuthorizedClasses[$sAlias] = $sClassName;
  1121. }
  1122. }
  1123. $aAttribs = array();
  1124. $aHeader = array();
  1125. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1126. {
  1127. $aList[$sAlias] = array();
  1128. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode => $oAttDef)
  1129. {
  1130. if (is_null($aFields) || (count($aFields) == 0))
  1131. {
  1132. // Standard list of attributes (no link sets)
  1133. if ($oAttDef->IsScalar() && ($oAttDef->IsWritable() || $oAttDef->IsExternalField()))
  1134. {
  1135. $sAttCodeEx = $oAttDef->IsExternalField() ? $oAttDef->GetKeyAttCode().'->'.$oAttDef->GetExtAttCode() : $sAttCode;
  1136. $aList[$sAlias][$sAttCodeEx] = $oAttDef;
  1137. if ($bFieldsAdvanced && $oAttDef->IsExternalKey(EXTKEY_RELATIVE))
  1138. {
  1139. $sRemoteClass = $oAttDef->GetTargetClass();
  1140. foreach(MetaModel::GetReconcKeys($sRemoteClass) as $sRemoteAttCode)
  1141. {
  1142. $aList[$sAlias][$sAttCode.'->'.$sRemoteAttCode] = MetaModel::GetAttributeDef($sRemoteClass, $sRemoteAttCode);
  1143. }
  1144. }
  1145. }
  1146. }
  1147. else
  1148. {
  1149. // User defined list of attributes
  1150. if (in_array($sAttCode, $aFields) || in_array($sAlias.'.'.$sAttCode, $aFields))
  1151. {
  1152. $aList[$sAlias][$sAttCode] = $oAttDef;
  1153. }
  1154. }
  1155. }
  1156. // Replace external key by the corresponding friendly name (if not already in the list)
  1157. foreach($aList[$sAlias] as $sAttCode => $oAttDef)
  1158. {
  1159. if ($oAttDef->IsExternalKey())
  1160. {
  1161. unset($aList[$sAlias][$sAttCode]);
  1162. $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
  1163. if (!array_key_exists($sFriendlyNameAttCode, $aList[$sAlias]) && MetaModel::IsValidAttCode($sClassName, $sFriendlyNameAttCode))
  1164. {
  1165. $oFriendlyNameAtt = MetaModel::GetAttributeDef($sClassName, $sFriendlyNameAttCode);
  1166. $aList[$sAlias][$sFriendlyNameAttCode] = $oFriendlyNameAtt;
  1167. }
  1168. }
  1169. }
  1170. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1171. {
  1172. $sColLabel = $bLocalize ? MetaModel::GetLabel($sClassName, $sAttCodeEx) : $sAttCodeEx;
  1173. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1174. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1175. {
  1176. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')';
  1177. $aHeader[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')';
  1178. }
  1179. else
  1180. {
  1181. $aHeader[] = $sColLabel;
  1182. }
  1183. }
  1184. }
  1185. $sHtml = "<table border=\"1\">\n";
  1186. $sHtml .= "<tr>\n";
  1187. $sHtml .= "<td>".implode("</td><td>", $aHeader)."</td>\n";
  1188. $sHtml .= "</tr>\n";
  1189. $oSet->Seek(0);
  1190. while ($aObjects = $oSet->FetchAssoc())
  1191. {
  1192. $aRow = array();
  1193. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1194. {
  1195. $oObj = $aObjects[$sAlias];
  1196. foreach($aList[$sAlias] as $sAttCodeEx => $oAttDef)
  1197. {
  1198. if (is_null($oObj))
  1199. {
  1200. $aRow[] = '<td></td>';
  1201. }
  1202. else
  1203. {
  1204. $oFinalAttDef = $oAttDef->GetFinalAttDef();
  1205. if (get_class($oFinalAttDef) == 'AttributeDateTime')
  1206. {
  1207. $sDate = $oObj->Get($sAttCodeEx);
  1208. if ($sDate === null)
  1209. {
  1210. $aRow[] = '<td></td>';
  1211. $aRow[] = '<td></td>';
  1212. }
  1213. else
  1214. {
  1215. $iDate = AttributeDateTime::GetAsUnixSeconds($sDate);
  1216. $aRow[] = '<td>'.date('Y-m-d', $iDate).'</td>';
  1217. $aRow[] = '<td>'.date('H:i:s', $iDate).'</td>';
  1218. }
  1219. }
  1220. else if($oAttDef instanceof AttributeCaseLog)
  1221. {
  1222. $rawValue = $oObj->Get($sAttCodeEx);
  1223. $outputValue = str_replace("\n", "<br/>", htmlentities($rawValue->__toString(), ENT_QUOTES, 'UTF-8'));
  1224. // Trick for Excel: treat the content as text even if it begins with an equal sign
  1225. $aRow[] = '<td x:str>'.$outputValue.'</td>';
  1226. }
  1227. else
  1228. {
  1229. $rawValue = $oObj->Get($sAttCodeEx);
  1230. // Due to custom formatting rules, empty friendlynames may be rendered as non-empty strings
  1231. // let's fix this and make sure we render an empty string if the key == 0
  1232. if ($oAttDef instanceof AttributeFriendlyName)
  1233. {
  1234. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1235. if ($sKeyAttCode != 'id')
  1236. {
  1237. if ($oObj->Get($sKeyAttCode) == 0)
  1238. {
  1239. $rawValue = '';
  1240. }
  1241. }
  1242. }
  1243. if ($bLocalize)
  1244. {
  1245. $outputValue = htmlentities($oFinalAttDef->GetEditValue($rawValue), ENT_QUOTES, 'UTF-8');
  1246. }
  1247. else
  1248. {
  1249. $outputValue = htmlentities($rawValue, ENT_QUOTES, 'UTF-8');
  1250. }
  1251. $aRow[] = '<td>'.$outputValue.'</td>';
  1252. }
  1253. }
  1254. }
  1255. }
  1256. $sHtml .= implode("\n", $aRow);
  1257. $sHtml .= "</tr>\n";
  1258. }
  1259. $sHtml .= "</table>\n";
  1260. return $sHtml;
  1261. }
  1262. static function DisplaySetAsXML(WebPage $oPage, CMDBObjectSet $oSet, $aParams = array())
  1263. {
  1264. $bLocalize = true;
  1265. if (isset($aParams['localize_values']))
  1266. {
  1267. $bLocalize = (bool) $aParams['localize_values'];
  1268. }
  1269. $oAppContext = new ApplicationContext();
  1270. $aClasses = $oSet->GetFilter()->GetSelectedClasses();
  1271. $aAuthorizedClasses = array();
  1272. foreach($aClasses as $sAlias => $sClassName)
  1273. {
  1274. if (UserRights::IsActionAllowed($sClassName, UR_ACTION_READ, $oSet) && (UR_ALLOWED_YES || UR_ALLOWED_DEPENDS))
  1275. {
  1276. $aAuthorizedClasses[$sAlias] = $sClassName;
  1277. }
  1278. }
  1279. $aAttribs = array();
  1280. $aList = array();
  1281. $aList[$sAlias] = MetaModel::GetZListItems($sClassName, 'details');
  1282. $oPage->add("<Set>\n");
  1283. $oSet->Seek(0);
  1284. while ($aObjects = $oSet->FetchAssoc())
  1285. {
  1286. if (count($aAuthorizedClasses) > 1)
  1287. {
  1288. $oPage->add("<Row>\n");
  1289. }
  1290. foreach($aAuthorizedClasses as $sAlias => $sClassName)
  1291. {
  1292. $oObj = $aObjects[$sAlias];
  1293. if (is_null($oObj))
  1294. {
  1295. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"null\">\n");
  1296. }
  1297. else
  1298. {
  1299. $sClassName = get_class($oObj);
  1300. $oPage->add("<$sClassName alias=\"$sAlias\" id=\"".$oObj->GetKey()."\">\n");
  1301. }
  1302. foreach(MetaModel::ListAttributeDefs($sClassName) as $sAttCode=>$oAttDef)
  1303. {
  1304. if (is_null($oObj))
  1305. {
  1306. $oPage->add("<$sAttCode>null</$sAttCode>\n");
  1307. }
  1308. else
  1309. {
  1310. if ($oAttDef->IsWritable())
  1311. {
  1312. if (!$oAttDef->IsLinkSet())
  1313. {
  1314. $sValue = $oObj->GetAsXML($sAttCode, $bLocalize);
  1315. $oPage->add("<$sAttCode>$sValue</$sAttCode>\n");
  1316. }
  1317. }
  1318. }
  1319. }
  1320. $oPage->add("</$sClassName>\n");
  1321. }
  1322. if (count($aAuthorizedClasses) > 1)
  1323. {
  1324. $oPage->add("</Row>\n");
  1325. }
  1326. }
  1327. $oPage->add("</Set>\n");
  1328. }
  1329. public static function DisplaySearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1330. {
  1331. $oPage->add(self::GetSearchForm($oPage, $oSet, $aExtraParams));
  1332. }
  1333. public static function GetSearchForm(WebPage $oPage, CMDBObjectSet $oSet, $aExtraParams = array())
  1334. {
  1335. static $iSearchFormId = 0;
  1336. $bMultiSelect = false;
  1337. $oAppContext = new ApplicationContext();
  1338. $sHtml = '';
  1339. $numCols=4;
  1340. $sClassName = $oSet->GetFilter()->GetClass();
  1341. // Romain: temporarily removed the tab "OQL query" because it was not finalized
  1342. // (especially when used to add a link)
  1343. /*
  1344. $sHtml .= "<div class=\"mini_tabs\" id=\"mini_tabs{$iSearchFormId}\"><ul>
  1345. <li><a href=\"#\" onClick=\"$('div.mini_tab{$iSearchFormId}').toggle();$('#mini_tabs{$iSearchFormId} ul li a').toggleClass('selected');\">".Dict::S('UI:OQLQueryTab')."</a></li>
  1346. <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>
  1347. </ul></div>\n";
  1348. */
  1349. // Simple search form
  1350. if (isset($aExtraParams['currentId']))
  1351. {
  1352. $sSearchFormId = $aExtraParams['currentId'];
  1353. }
  1354. else
  1355. {
  1356. $iSearchFormId = $oPage->GetUniqueId();
  1357. $sSearchFormId = 'SimpleSearchForm'.$iSearchFormId;
  1358. $sHtml .= "<div id=\"ds_$sSearchFormId\" class=\"mini_tab{$iSearchFormId}\">\n";
  1359. }
  1360. // Check if the current class has some sub-classes
  1361. if (isset($aExtraParams['baseClass']))
  1362. {
  1363. $sRootClass = $aExtraParams['baseClass'];
  1364. }
  1365. else
  1366. {
  1367. $sRootClass = $sClassName;
  1368. }
  1369. $aSubClasses = MetaModel::GetSubclasses($sRootClass);
  1370. if (count($aSubClasses) > 0)
  1371. {
  1372. $aOptions = array();
  1373. $aOptions[MetaModel::GetName($sRootClass)] = "<option value=\"$sRootClass\">".MetaModel::GetName($sRootClass)."</options>\n";
  1374. foreach($aSubClasses as $sSubclassName)
  1375. {
  1376. $aOptions[MetaModel::GetName($sSubclassName)] = "<option value=\"$sSubclassName\">".MetaModel::GetName($sSubclassName)."</options>\n";
  1377. }
  1378. $aOptions[MetaModel::GetName($sClassName)] = "<option selected value=\"$sClassName\">".MetaModel::GetName($sClassName)."</options>\n";
  1379. ksort($aOptions);
  1380. $sContext = $oAppContext->GetForLink();
  1381. $sClassesCombo = "<select name=\"class\" onChange=\"ReloadSearchForm('$sSearchFormId', this.value, '$sRootClass', '$sContext')\">\n".implode('', $aOptions)."</select>\n";
  1382. }
  1383. else
  1384. {
  1385. $sClassesCombo = MetaModel::GetName($sClassName);
  1386. }
  1387. $oUnlimitedFilter = new DBObjectSearch($sClassName);
  1388. $sAction = (isset($aExtraParams['action'])) ? $aExtraParams['action'] : utils::GetAbsoluteUrlAppRoot().'pages/UI.php';
  1389. $sHtml .= "<form id=\"fs_{$sSearchFormId}\" action=\"{$sAction}\">\n"; // Don't use $_SERVER['SCRIPT_NAME'] since the form may be called asynchronously (from ajax.php)
  1390. $sHtml .= "<h2>".Dict::Format('UI:SearchFor_Class_Objects', $sClassesCombo)."</h2>\n";
  1391. $index = 0;
  1392. $sHtml .= "<p>\n";
  1393. $aFilterCriteria = $oSet->GetFilter()->GetCriteria();
  1394. $aMapCriteria = array();
  1395. // Todo: Investigate... The search criteria is an expression, i.e. a tree!
  1396. // I wonder if that code could work... cleanup required/recommended
  1397. foreach($aFilterCriteria as $aCriteria)
  1398. {
  1399. $aMapCriteria[$aCriteria['filtercode']][] = array('value' => $aCriteria['value'], 'opcode' => $aCriteria['opcode']);
  1400. }
  1401. $aList = MetaModel::GetZListItems($sClassName, 'standard_search');
  1402. $aConsts = $oSet->ListConstantFields(); // Some fields are constants based on the query/context
  1403. $sClassAlias = $oSet->GetFilter()->GetClassAlias();
  1404. foreach($aList as $sFilterCode)
  1405. {
  1406. //$oAppContext->Reset($sFilterCode); // Make sure the same parameter will not be passed twice
  1407. $sHtml .= '<span style="white-space: nowrap;padding:5px;display:inline-block;">';
  1408. $sFilterValue = isset($aConsts[$sClassAlias][$sFilterCode]) ? $aConsts[$sClassAlias][$sFilterCode] : '';
  1409. $sFilterValue = utils::ReadParam($sFilterCode, $sFilterValue, false, 'raw_data');
  1410. $sFilterOpCode = null; // Use the default 'loose' OpCode
  1411. if (empty($sFilterValue))
  1412. {
  1413. if (isset($aMapCriteria[$sFilterCode]))
  1414. {
  1415. if (count($aMapCriteria[$sFilterCode]) > 1)
  1416. {
  1417. $sFilterValue = Dict::S('UI:SearchValue:Mixed');
  1418. }
  1419. else
  1420. {
  1421. $sFilterValue = $aMapCriteria[$sFilterCode][0]['value'];
  1422. $sFilterOpCode = $aMapCriteria[$sFilterCode][0]['opcode'];
  1423. }
  1424. // Todo: Investigate...
  1425. if ($sFilterCode != 'company')
  1426. {
  1427. $oUnlimitedFilter->AddCondition($sFilterCode, $sFilterValue, $sFilterOpCode);
  1428. }
  1429. }
  1430. }
  1431. $oAttDef = MetaModel::GetAttributeDef($sClassName, $sFilterCode);
  1432. if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  1433. {
  1434. $oKeyAttDef = $oAttDef->GetFinalAttDef();
  1435. $sKeyAttClass = $oKeyAttDef->GetHostClass();
  1436. $sKeyAttCode = $oKeyAttDef->GetCode();
  1437. $sTargetClass = $oKeyAttDef->GetTargetClass();
  1438. $oSearch = new DBObjectSearch($sTargetClass);
  1439. $oSearch->SetModifierProperty('UserRightsGetSelectFilter', 'bSearchMode', true);
  1440. $oAllowedValues = new DBObjectSet($oSearch);
  1441. $iFieldSize = $oKeyAttDef->GetMaxSize();
  1442. $iMaxComboLength = $oKeyAttDef->GetMaximumComboLength();
  1443. $sHtml .= "<label>".MetaModel::GetFilterLabel($sKeyAttClass, $sKeyAttCode).":</label>&nbsp;";
  1444. $aExtKeyParams = $aExtraParams;
  1445. $aExtKeyParams['iFieldSize'] = $oKeyAttDef->GetMaxSize();
  1446. $aExtKeyParams['iMinChars'] = $oKeyAttDef->GetMinAutoCompleteChars();
  1447. $sHtml .= UIExtKeyWidget::DisplayFromAttCode($oPage, $sKeyAttCode, $sKeyAttClass, $oAttDef->GetLabel(), $oAllowedValues, $sFilterValue, $sSearchFormId.'search_'.$sFilterCode, false, $sFilterCode, '', $aExtKeyParams, true);
  1448. }
  1449. else
  1450. {
  1451. $aAllowedValues = MetaModel::GetAllowedValues_flt($sClassName, $sFilterCode, $aExtraParams);
  1452. if (is_null($aAllowedValues))
  1453. {
  1454. // Any value is possible, display an input box
  1455. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;<input class=\"textSearch\" name=\"$sFilterCode\" value=\"".htmlentities($sFilterValue, ENT_QUOTES, 'utf-8')."\"/>\n";
  1456. }
  1457. else
  1458. {
  1459. //Enum field, display a multi-select combo
  1460. $sValue = "<select class=\"multiselect\" size=\"1\" name=\"{$sFilterCode}[]\" multiple>\n";
  1461. $bMultiSelect = true;
  1462. //$sValue .= "<option value=\"\">".Dict::S('UI:SearchValue:Any')."</option>\n";
  1463. asort($aAllowedValues);
  1464. foreach($aAllowedValues as $key => $value)
  1465. {
  1466. if (is_array($sFilterValue) && in_array($key, $sFilterValue))
  1467. {
  1468. $sSelected = ' selected';
  1469. }
  1470. else if ($sFilterValue == $key)
  1471. {
  1472. $sSelected = ' selected';
  1473. }
  1474. else
  1475. {
  1476. $sSelected = '';
  1477. }
  1478. $sValue .= "<option value=\"$key\"$sSelected>$value</option>\n";
  1479. }
  1480. $sValue .= "</select>\n";
  1481. $sHtml .= "<label>".MetaModel::GetFilterLabel($sClassName, $sFilterCode).":</label>&nbsp;$sValue\n";
  1482. }
  1483. }
  1484. unset($aExtraParams[$sFilterCode]);
  1485. // Finally, add a tooltip if one is defined for this attribute definition
  1486. $sTip = $oAttDef->GetHelpOnSmartSearch();
  1487. if (strlen($sTip) > 0)
  1488. {
  1489. $sTip = addslashes($sTip);
  1490. $sTip = str_replace(array("\n", "\r"), " ", $sTip);
  1491. // :input does represent in form visible input (INPUT, SELECT, TEXTAREA)
  1492. $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' }} } );");
  1493. }
  1494. $index++;
  1495. $sHtml .= '</span> ';
  1496. }
  1497. $sHtml .= "</p>\n";
  1498. $sHtml .= "<p align=\"right\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Search')."\"></p>\n";
  1499. if (isset($aExtraParams['table_id']))
  1500. {
  1501. // Rename to avoid collisions...
  1502. $aExtraParams['_table_id_'] = $aExtraParams['table_id'];
  1503. unset($aExtraParams['table_id']);
  1504. }
  1505. foreach($aExtraParams as $sName => $sValue)
  1506. {
  1507. if (is_scalar($sValue))
  1508. {
  1509. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"".htmlentities($sValue, ENT_QUOTES, 'UTF-8')."\" />\n";
  1510. }
  1511. }
  1512. $sHtml .= "<input type=\"hidden\" name=\"class\" value=\"$sClassName\" />\n";
  1513. $sHtml .= "<input type=\"hidden\" name=\"dosearch\" value=\"1\" />\n";
  1514. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_form\" />\n";
  1515. $sHtml .= $oAppContext->GetForForm();
  1516. $sHtml .= "</form>\n";
  1517. if (!isset($aExtraParams['currentId']))
  1518. {
  1519. $sHtml .= "</div><!-- Simple search form -->\n";
  1520. }
  1521. if ($bMultiSelect)
  1522. {
  1523. $aOptions = array(
  1524. 'header' => true,
  1525. 'checkAllText' => Dict::S('UI:SearchValue:CheckAll'),
  1526. 'uncheckAllText' => Dict::S('UI:SearchValue:UncheckAll'),
  1527. 'noneSelectedText' => Dict::S('UI:SearchValue:Any'),
  1528. 'selectedText' => Dict::S('UI:SearchValue:NbSelected'),
  1529. 'selectedList' => 1,
  1530. );
  1531. $sJSOptions = json_encode($aOptions);
  1532. $oPage->add_ready_script("$('.multiselect').multiselect($sJSOptions);");
  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. if (is_scalar($sValue))
  1556. {
  1557. $sHtml .= "<input type=\"hidden\" name=\"$sName\" value=\"$sValue\" />\n";
  1558. }
  1559. }
  1560. $sHtml .= "<input type=\"hidden\" name=\"operation\" value=\"search_oql\" />\n";
  1561. $sHtml .= $oAppContext->GetForForm();
  1562. $sHtml .= "</table></form>\n";
  1563. $sHtml .= "</div><!-- OQL query form -->\n";
  1564. */
  1565. return $sHtml;
  1566. }
  1567. public static function GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $value = '', $sDisplayValue = '', $iId = '', $sNameSuffix = '', $iFlags = 0, $aArgs = array())
  1568. {
  1569. static $iInputId = 0;
  1570. $sFieldPrefix = '';
  1571. $sFormPrefix = isset($aArgs['formPrefix']) ? $aArgs['formPrefix'] : '';
  1572. $sFieldPrefix = isset($aArgs['prefix']) ? $sFormPrefix.$aArgs['prefix'] : $sFormPrefix;
  1573. if ($sDisplayValue == '')
  1574. {
  1575. $sDisplayValue = $value;
  1576. }
  1577. if (isset($aArgs[$sAttCode]) && empty($value))
  1578. {
  1579. // default value passed by the context (either the app context of the operation)
  1580. $value = $aArgs[$sAttCode];
  1581. }
  1582. if (!empty($iId))
  1583. {
  1584. $iInputId = $iId;
  1585. }
  1586. else
  1587. {
  1588. $iInputId = $oPage->GetUniqueId();
  1589. }
  1590. if (!$oAttDef->IsExternalField())
  1591. {
  1592. $bMandatory = 'false';
  1593. if ( (!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  1594. {
  1595. $bMandatory = 'true';
  1596. }
  1597. $sValidationField = "<span class=\"form_validation\" id=\"v_{$iId}\"></span>";
  1598. $sHelpText = htmlentities($oAttDef->GetHelpOnEdition(), ENT_QUOTES, 'UTF-8');
  1599. $aEventsList = array();
  1600. switch($oAttDef->GetEditClass())
  1601. {
  1602. case 'Date':
  1603. $aEventsList[] ='validate';
  1604. $aEventsList[] ='keyup';
  1605. $aEventsList[] ='change';
  1606. if (($iFlags & OPT_ATT_MANDATORY) && (empty($sDisplayValue)))
  1607. {
  1608. $sDisplayValue = date($oAttDef->GetDateFormat());
  1609. }
  1610. $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}";
  1611. break;
  1612. case 'DateTime':
  1613. $aEventsList[] ='validate';
  1614. $aEventsList[] ='keyup';
  1615. $aEventsList[] ='change';
  1616. if (($iFlags & OPT_ATT_MANDATORY) && (empty($sDisplayValue)))
  1617. {
  1618. $sDisplayValue = date($oAttDef->GetDateFormat());
  1619. }
  1620. $sHTMLValue = "<input title=\"$sHelpText\" class=\"datetime-pick\" type=\"text\" size=\"20\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($sDisplayValue, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1621. break;
  1622. case 'Duration':
  1623. $aEventsList[] ='validate';
  1624. $aEventsList[] ='change';
  1625. $oPage->add_ready_script("$('#{$iId}_d').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1626. $oPage->add_ready_script("$('#{$iId}_h').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1627. $oPage->add_ready_script("$('#{$iId}_m').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1628. $oPage->add_ready_script("$('#{$iId}_s').bind('keyup change', function(evt, sFormId) { return UpdateDuration('$iId'); });");
  1629. $aVal = AttributeDuration::SplitDuration($value);
  1630. $sDays = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"3\" name=\"attr_{$sFieldPrefix}{$sAttCode}[d]{$sNameSuffix}\" value=\"{$aVal['days']}\" id=\"{$iId}_d\"/>";
  1631. $sHours = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[h]{$sNameSuffix}\" value=\"{$aVal['hours']}\" id=\"{$iId}_h\"/>";
  1632. $sMinutes = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[m]{$sNameSuffix}\" value=\"{$aVal['minutes']}\" id=\"{$iId}_m\"/>";
  1633. $sSeconds = "<input title=\"$sHelpText\" type=\"text\" style=\"text-align:right\" size=\"2\" name=\"attr_{$sFieldPrefix}{$sAttCode}[s]{$sNameSuffix}\" value=\"{$aVal['seconds']}\" id=\"{$iId}_s\"/>";
  1634. $sHidden = "<input type=\"hidden\" id=\"{$iId}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\"/>";
  1635. $sHTMLValue = Dict::Format('UI:DurationForm_Days_Hours_Minutes_Seconds', $sDays, $sHours, $sMinutes, $sSeconds).$sHidden."&nbsp;".$sValidationField;
  1636. $oPage->add_ready_script("$('#{$iId}').bind('update', function(evt, sFormId) { return ToggleDurationField('$iId'); });");
  1637. break;
  1638. case 'Password':
  1639. $aEventsList[] ='validate';
  1640. $aEventsList[] ='keyup';
  1641. $aEventsList[] ='change';
  1642. $sHTMLValue = "<input title=\"$sHelpText\" type=\"password\" size=\"30\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\" id=\"$iId\"/>&nbsp;{$sValidationField}";
  1643. break;
  1644. case 'OQLExpression':
  1645. case 'Text':
  1646. $aEventsList[] ='validate';
  1647. $aEventsList[] ='keyup';
  1648. $aEventsList[] ='change';
  1649. $sEditValue = $oAttDef->GetEditValue($value);
  1650. $aStyles = array();
  1651. $sStyle = '';
  1652. $sWidth = $oAttDef->GetWidth('width', '');
  1653. if (!empty($sWidth))
  1654. {
  1655. $aStyles[] = 'width:'.$sWidth;
  1656. }
  1657. $sHeight = $oAttDef->GetHeight('height', '');
  1658. if (!empty($sHeight))
  1659. {
  1660. $aStyles[] = 'height:'.$sHeight;
  1661. }
  1662. if (count($aStyles) > 0)
  1663. {
  1664. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1665. }
  1666. if ($oAttDef->GetEditClass() == 'OQLExpression')
  1667. {
  1668. $sTestResId = 'query_res_'.$sFieldPrefix.$sAttCode.$sNameSuffix; //$oPage->GetUniqueId();
  1669. $sBaseUrl = utils::GetAbsoluteUrlAppRoot().'pages/run_query.php?expression=';
  1670. $sInitialUrl = $sBaseUrl.urlencode($sEditValue);
  1671. $sAdditionalStuff = "<a id=\"$sTestResId\" target=\"_blank\" href=\"$sInitialUrl\">".Dict::S('UI:Edit:TestQuery')."</a>";
  1672. $oPage->add_ready_script("$('#$iId').bind('change keyup', function(evt, sFormId) { $('#$sTestResId').attr('href', '$sBaseUrl'+encodeURIComponent($(this).val())); } );");
  1673. }
  1674. else
  1675. {
  1676. $sAdditionalStuff = "";
  1677. }
  1678. // Ok, the text area is drawn here
  1679. $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>";
  1680. break;
  1681. case 'CaseLog':
  1682. $aStyles = array();
  1683. $sStyle = '';
  1684. $sWidth = $oAttDef->GetWidth('width', '');
  1685. if (!empty($sWidth))
  1686. {
  1687. $aStyles[] = 'width:'.$sWidth;
  1688. }
  1689. $sHeight = $oAttDef->GetHeight('height', '');
  1690. if (!empty($sHeight))
  1691. {
  1692. $aStyles[] = 'height:'.$sHeight;
  1693. }
  1694. if (count($aStyles) > 0)
  1695. {
  1696. $sStyle = 'style="'.implode('; ', $aStyles).'"';
  1697. }
  1698. $sHeader = '<div class="caselog_input_header">&nbsp;'.Dict::S('UI:CaseLogTypeYourTextHere').'</div>';
  1699. $sEditValue = $oAttDef->GetEditValue($value);
  1700. $sPreviousLog = is_object($value) ? $value->GetAsHTML($oPage, true /* bEditMode */, array('AttributeText', 'RenderWikiHtml')) : '';
  1701. $iEntriesCount = is_object($value) ? count($value->GetIndex()) : 0;
  1702. $sHidden = "<input type=\"hidden\" id=\"{$iId}_count\" value=\"$iEntriesCount\"/>"; // To know how many entries the case log already contains
  1703. $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>";
  1704. $oPage->add_ready_script("$('#$iId').bind('keyup change validate', function(evt, sFormId) { return ValidateCaseLogField('$iId', $bMandatory, sFormId) } );"); // Custom validation function
  1705. break;
  1706. case 'HTML':
  1707. $oWidget = new UIHTMLEditorWidget($iId, $sAttCode, $sNameSuffix, $sFieldPrefix, $sHelpText, $sValidationField, $value, $bMandatory);
  1708. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1709. break;
  1710. case 'LinkedSet':
  1711. if ($oAttDef->IsIndirect())
  1712. {
  1713. $oWidget = new UILinksWidget($sClass, $sAttCode, $iId, $sNameSuffix, $oAttDef->DuplicatesAllowed(), $aArgs);
  1714. }
  1715. else
  1716. {
  1717. $oWidget = new UILinksWidgetDirect($sClass, $sAttCode, $iId, $sNameSuffix, $aArgs);
  1718. }
  1719. $aEventsList[] ='validate';
  1720. $aEventsList[] ='change';
  1721. $oObj = isset($aArgs['this']) ? $aArgs['this'] : null;
  1722. $sHTMLValue = $oWidget->Display($oPage, $value, array(), $sFormPrefix, $oObj);
  1723. break;
  1724. case 'Document':
  1725. $aEventsList[] ='validate';
  1726. $aEventsList[] ='change';
  1727. $oDocument = $value; // Value is an ormDocument object
  1728. $sFileName = '';
  1729. if (is_object($oDocument))
  1730. {
  1731. $sFileName = $oDocument->GetFileName();
  1732. }
  1733. $iMaxFileSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  1734. $sHTMLValue = "<input type=\"hidden\" name=\"MAX_FILE_SIZE\" value=\"$iMaxFileSize\" />\n";
  1735. $sHTMLValue .= "<input name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[filename]\" type=\"hidden\" id=\"$iId\" \" value=\"".htmlentities($sFileName, ENT_QUOTES, 'UTF-8')."\"/>\n";
  1736. $sHTMLValue .= "<span id=\"name_$iInputId\">$sFileName</span><br/>\n";
  1737. $sHTMLValue .= "<input title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}[fcontents]\" type=\"file\" id=\"file_$iId\" onChange=\"UpdateFileName('$iId', this.value)\"/>&nbsp;{$sValidationField}\n";
  1738. break;
  1739. case 'StopWatch':
  1740. $sHTMLValue = "The edition of a stopwatch is not allowed!!!";
  1741. break;
  1742. case 'List':
  1743. // Not editable for now...
  1744. $sHTMLValue = '';
  1745. break;
  1746. case 'One Way Password':
  1747. $aEventsList[] ='validate';
  1748. $oWidget = new UIPasswordWidget($sAttCode, $iId, $sNameSuffix);
  1749. $sHTMLValue = $oWidget->Display($oPage, $aArgs);
  1750. // Event list & validation is handled directly by the widget
  1751. break;
  1752. case 'ExtKey':
  1753. $aEventsList[] ='validate';
  1754. $aEventsList[] ='change';
  1755. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  1756. $sFieldName = $sFieldPrefix.$sAttCode.$sNameSuffix;
  1757. $aExtKeyParams = $aArgs;
  1758. $aExtKeyParams['iFieldSize'] = $oAttDef->GetMaxSize();
  1759. $aExtKeyParams['iMinChars'] = $oAttDef->GetMinAutoCompleteChars();
  1760. $sHTMLValue = UIExtKeyWidget::DisplayFromAttCode($oPage, $sAttCode, $sClass, $oAttDef->GetLabel(), $oAllowedValues, $value, $iId, $bMandatory, $sFieldName, $sFormPrefix, $aExtKeyParams);
  1761. $sHTMLValue .= "<!-- iFlags: $iFlags bMandatory: $bMandatory -->\n";
  1762. break;
  1763. case 'RedundancySetting':
  1764. $sHTMLValue = '<table>';
  1765. $sHTMLValue .= '<tr>';
  1766. $sHTMLValue .= '<td>';
  1767. $sHTMLValue .= '<div id="'.$iId.'">';
  1768. $sHTMLValue .= $oAttDef->GetDisplayForm($value, $oPage, true);
  1769. $sHTMLValue .= '</div>';
  1770. $sHTMLValue .= '</td>';
  1771. $sHTMLValue .= '<td>'.$sValidationField.'</td>';
  1772. $sHTMLValue .= '</tr>';
  1773. $sHTMLValue .= '</table>';
  1774. $oPage->add_ready_script("$('#$iId :input').bind('keyup change validate', function(evt, sFormId) { return ValidateRedundancySettings('$iId',sFormId); } );"); // Custom validation function
  1775. break;
  1776. case 'String':
  1777. default:
  1778. $aEventsList[] ='validate';
  1779. // #@# todo - add context information (depending on dimensions)
  1780. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  1781. $iFieldSize = $oAttDef->GetMaxSize();
  1782. if ($aAllowedValues !== null)
  1783. {
  1784. // Discrete list of values, use a SELECT or RADIO buttons depending on the config
  1785. $sDisplayStyle = $oAttDef->GetDisplayStyle();
  1786. switch($sDisplayStyle)
  1787. {
  1788. case 'radio':
  1789. case 'radio_horizontal':
  1790. case 'radio_vertical':
  1791. $sHTMLValue = '';
  1792. $bVertical = ($sDisplayStyle != 'radio_horizontal');
  1793. $sHTMLValue = $oPage->GetRadioButtons($aAllowedValues, $value, $iId, "attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}", $bMandatory, $bVertical, $sValidationField);
  1794. $aEventsList[] ='change';
  1795. break;
  1796. case 'select':
  1797. default:
  1798. $sHTMLValue = "<select title=\"$sHelpText\" name=\"attr_{$sFieldPrefix}{$sAttCode}{$sNameSuffix}\" id=\"$iId\">\n";
  1799. $sHTMLValue .= "<option value=\"\">".Dict::S('UI:SelectOne')."</option>\n";
  1800. foreach($aAllowedValues as $key => $display_value)
  1801. {
  1802. if ((count($aAllowedValues) == 1) && ($bMandatory == 'true') )
  1803. {
  1804. // When there is only once choice, select it by default
  1805. $sSelected = ' selected';
  1806. }
  1807. else
  1808. {
  1809. $sSelected = ($value == $key) ? ' selected' : '';
  1810. }
  1811. $sHTMLValue .= "<option value=\"$key\"$sSelected>$display_value</option>\n";
  1812. }
  1813. $sHTMLValue .= "</select>&nbsp;{$sValidationField}\n";
  1814. $aEventsList[] ='change';
  1815. }
  1816. }
  1817. else
  1818. {
  1819. $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}";
  1820. $aEventsList[] ='keyup';
  1821. $aEventsList[] ='change';
  1822. }
  1823. break;
  1824. }
  1825. $sPattern = addslashes($oAttDef->GetValidationPattern()); //'^([0-9]+)$';
  1826. if (!empty($aEventsList))
  1827. {
  1828. $sNullValue = $oAttDef->GetNullValue();
  1829. if (!is_numeric($sNullValue))
  1830. {
  1831. $sNullValue = "'$sNullValue'"; // Add quotes to turn this into a JS string if it's not a number
  1832. }
  1833. $sOriginalValue = ($iFlags & OPT_ATT_MUSTCHANGE) ? json_encode($value) : 'undefined';
  1834. $oPage->add_ready_script("$('#$iId').bind('".implode(' ', $aEventsList)."', function(evt, sFormId) { return ValidateField('$iId', '$sPattern', $bMandatory, sFormId, $sNullValue, $sOriginalValue) } );\n"); // Bind to a custom event: validate
  1835. }
  1836. $aDependencies = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that depend on the current one
  1837. if (count($aDependencies) > 0)
  1838. {
  1839. // Unbind first to avoid duplicate event handlers in case of reload of the whole (or part of the) form
  1840. $oPage->add_ready_script("$('#$iId').unbind('change.dependencies').bind('change.dependencies', function(evt, sFormId) { return oWizardHelper{$sFormPrefix}.UpdateDependentFields(['".implode("','", $aDependencies)."']) } );\n"); // Bind to a custom event: validate
  1841. }
  1842. }
  1843. $oPage->add_dict_entry('UI:ValueMustBeSet');
  1844. $oPage->add_dict_entry('UI:ValueMustBeChanged');
  1845. $oPage->add_dict_entry('UI:ValueInvalidFormat');
  1846. return "<div>{$sHTMLValue}</div>";
  1847. }
  1848. public function DisplayModifyForm(WebPage $oPage, $aExtraParams = array())
  1849. {
  1850. $sOwnershipToken = null;
  1851. $iKey = $this->GetKey();
  1852. $sClass = get_class($this);
  1853. if ($iKey > 0)
  1854. {
  1855. // The concurrent access lock makes sense only for already existing objects
  1856. $LockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
  1857. if ($LockEnabled)
  1858. {
  1859. $sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
  1860. if ($sOwnershipToken !== null)
  1861. {
  1862. // We're probably inside something like "apply_modify" where the validation failed and we must prompt the user again to edit the object
  1863. // let's extend our lock
  1864. $aLockInfo = iTopOwnershipLock::ExtendLock($sClass, $iKey, $sOwnershipToken);
  1865. $sOwnershipDate = $aLockInfo['acquired'];
  1866. }
  1867. else
  1868. {
  1869. $aLockInfo = iTopOwnershipLock::AcquireLock($sClass, $iKey);
  1870. if ($aLockInfo['success'])
  1871. {
  1872. $sOwnershipToken = $aLockInfo['token'];
  1873. $sOwnershipDate = $aLockInfo['acquired'];
  1874. }
  1875. else
  1876. {
  1877. $oOwner = $aLockInfo['lock']->GetOwner();
  1878. // If the object is locked by the current user, it's worth trying again, since
  1879. // the lock may be released by 'onunload' which is called AFTER loading the current page.
  1880. //$bTryAgain = $oOwner->GetKey() == UserRights::GetUserId();
  1881. self::ReloadAndDisplay($oPage, $this, array('operation' => 'modify'));
  1882. return;
  1883. }
  1884. }
  1885. }
  1886. }
  1887. if (isset($aExtraParams['wizard_container']) && $aExtraParams['wizard_container'])
  1888. {
  1889. $sClassLabel = MetaModel::GetName($sClass);
  1890. $oPage->set_title(Dict::Format('UI:ModificationPageTitle_Object_Class', $this->GetRawName(), $sClassLabel)); // Set title will take care of the encoding
  1891. $oPage->add("<div class=\"page_header\">\n");
  1892. $oPage->add("<h1>".$this->GetIcon()."&nbsp;".Dict::Format('UI:ModificationTitle_Class_Object', $sClassLabel, $this->GetName())."</h1>\n");
  1893. $oPage->add("</div>\n");
  1894. $oPage->add("<div class=\"wizContainer\">\n");
  1895. }
  1896. self::$iGlobalFormId++;
  1897. $this->aFieldsMap = array();
  1898. $sPrefix = '';
  1899. if (isset($aExtraParams['formPrefix']))
  1900. {
  1901. $sPrefix = $aExtraParams['formPrefix'];
  1902. }
  1903. $aFieldsComments = (isset($aExtraParams['fieldsComments'])) ? $aExtraParams['fieldsComments'] : array();
  1904. $this->m_iFormId = $sPrefix.self::$iGlobalFormId;
  1905. $oAppContext = new ApplicationContext();
  1906. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  1907. $aDetails = array();
  1908. $aFieldsMap = array();
  1909. if (!isset($aExtraParams['action']))
  1910. {
  1911. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  1912. }
  1913. else
  1914. {
  1915. $sFormAction = $aExtraParams['action'];
  1916. }
  1917. // Custom label for the apply button ?
  1918. if (isset($aExtraParams['custom_button']))
  1919. {
  1920. $sApplyButton = $aExtraParams['custom_button'];
  1921. }
  1922. else if ($iKey > 0)
  1923. {
  1924. $sApplyButton = Dict::S('UI:Button:Apply');
  1925. }
  1926. else
  1927. {
  1928. $sApplyButton = Dict::S('UI:Button:Create');
  1929. }
  1930. // Custom operation for the form ?
  1931. if (isset($aExtraParams['custom_operation']))
  1932. {
  1933. $sOperation = $aExtraParams['custom_operation'];
  1934. }
  1935. else if ($iKey > 0)
  1936. {
  1937. $sOperation = 'apply_modify';
  1938. }
  1939. else
  1940. {
  1941. $sOperation = 'apply_new';
  1942. }
  1943. if ($iKey > 0)
  1944. {
  1945. // The object already exists in the database, it's a modification
  1946. $sButtons = "<input id=\"{$sPrefix}_id\" type=\"hidden\" name=\"id\" value=\"$iKey\">\n";
  1947. $sButtons .= "<input type=\"hidden\" name=\"operation\" value=\"{$sOperation}\">\n";
  1948. $sButtons .= "<button type=\"button\" class=\"action cancel\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1949. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1950. }
  1951. else
  1952. {
  1953. // The object does not exist in the database it's a creation
  1954. $sButtons = "<input type=\"hidden\" name=\"operation\" value=\"$sOperation\">\n";
  1955. $sButtons .= "<button type=\"button\" class=\"action cancel\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n";
  1956. $sButtons .= "<button type=\"submit\" class=\"action\"><span>{$sApplyButton}</span></button>\n";
  1957. }
  1958. $aTransitions = $this->EnumTransitions();
  1959. if (!isset($aExtraParams['custom_operation']) && count($aTransitions))
  1960. {
  1961. // transitions are displayed only for the standard new/modify actions, not for modify_all or any other case...
  1962. $oSetToCheckRights = DBObjectSet::FromObject($this);
  1963. $aStimuli = Metamodel::EnumStimuli($sClass);
  1964. foreach($aTransitions as $sStimulusCode => $aTransitionDef)
  1965. {
  1966. $iActionAllowed = (get_class($aStimuli[$sStimulusCode]) == 'StimulusUserAction') ? UserRights::IsStimulusAllowed($sClass, $sStimulusCode, $oSetToCheckRights) : UR_ALLOWED_NO;
  1967. switch($iActionAllowed)
  1968. {
  1969. case UR_ALLOWED_YES:
  1970. $sButtons .= "<button type=\"submit\" name=\"next_action\" value=\"{$sStimulusCode}\" class=\"action\"><span>".$aStimuli[$sStimulusCode]->GetLabel()."</span></button>\n";
  1971. break;
  1972. default:
  1973. // Do nothing
  1974. }
  1975. }
  1976. }
  1977. $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
  1978. $iTransactionId = isset($aExtraParams['transaction_id']) ? $aExtraParams['transaction_id'] : utils::GetNewTransactionId();
  1979. $oPage->SetTransactionId($iTransactionId);
  1980. $oPage->add("<form action=\"$sFormAction\" id=\"form_{$this->m_iFormId}\" enctype=\"multipart/form-data\" method=\"post\" onSubmit=\"return OnSubmit('form_{$this->m_iFormId}');\">\n");
  1981. $sStatesSelection = '';
  1982. if (!isset($aExtraParams['custom_operation']) && $this->IsNew())
  1983. {
  1984. $aInitialStates = MetaModel::EnumInitialStates($sClass);
  1985. //$aInitialStates = array('new' => 'foo', 'closed' => 'bar');
  1986. if (count($aInitialStates) > 1)
  1987. {
  1988. $sStatesSelection = Dict::Format('UI:Create_Class_InState', MetaModel::GetName($sClass)).'<select name="obj_state" class="state_select_'.$this->m_iFormId.'">';
  1989. foreach($aInitialStates as $sStateCode => $sStateData)
  1990. {
  1991. $sSelected = '';
  1992. if ($sStateCode == $this->GetState())
  1993. {
  1994. $sSelected = ' selected';
  1995. }
  1996. $sStatesSelection .= '<option value="'.$sStateCode.'"'.$sSelected.'>'.MetaModel::GetStateLabel($sClass, $sStateCode).'</option>';
  1997. }
  1998. $sStatesSelection .= '</select>';
  1999. $oPage->add_ready_script("$('.state_select_{$this->m_iFormId}').change( function() { oWizardHelper$sPrefix.ReloadObjectCreationForm('form_{$this->m_iFormId}', $(this).val()); } );");
  2000. }
  2001. }
  2002. $sConfirmationMessage = addslashes(Dict::S('UI:NavigateAwayConfirmationMessage'));
  2003. $sJSToken = json_encode($sOwnershipToken);
  2004. $oPage->add_ready_script(
  2005. <<<EOF
  2006. $(window).unload(function() { return OnUnload('$iTransactionId', '$sClass', $iKey, $sJSToken) } );
  2007. window.onbeforeunload = function() {
  2008. if (!window.bInSubmit && !window.bInCancel)
  2009. {
  2010. return '$sConfirmationMessage';
  2011. }
  2012. // return nothing ! safer for IE
  2013. };
  2014. EOF
  2015. );
  2016. if ($sButtonsPosition != 'bottom')
  2017. {
  2018. // top or both, display the buttons here
  2019. $oPage->p($sStatesSelection);
  2020. $oPage->add($sButtons);
  2021. }
  2022. $oPage->AddTabContainer(OBJECT_PROPERTIES_TAB, $sPrefix);
  2023. $oPage->SetCurrentTabContainer(OBJECT_PROPERTIES_TAB);
  2024. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  2025. $aFieldsMap = $this->DisplayBareProperties($oPage, true, $sPrefix, $aExtraParams);
  2026. if ($iKey > 0)
  2027. {
  2028. $aFieldsMap['id'] = $sPrefix.'_id';
  2029. }
  2030. // Now display the relations, one tab per relation
  2031. if (!isset($aExtraParams['noRelations']))
  2032. {
  2033. $this->DisplayBareRelations($oPage, true); // Edit mode, will fill $this->aFieldsMap
  2034. $aFieldsMap = array_merge($aFieldsMap, $this->aFieldsMap);
  2035. }
  2036. $oPage->SetCurrentTab('');
  2037. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  2038. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"$iTransactionId\">\n");
  2039. foreach($aExtraParams as $sName => $value)
  2040. {
  2041. if (is_scalar($value))
  2042. {
  2043. $oPage->add("<input type=\"hidden\" name=\"$sName\" value=\"$value\">\n");
  2044. }
  2045. }
  2046. if ($sOwnershipToken !== null)
  2047. {
  2048. $oPage->add("<input type=\"hidden\" name=\"ownership_token\" value=\"".htmlentities($sOwnershipToken, ENT_QUOTES, 'UTF-8')."\">\n");
  2049. }
  2050. $oPage->add($oAppContext->GetForForm());
  2051. if ($sButtonsPosition != 'top')
  2052. {
  2053. // bottom or both: display the buttons here
  2054. $oPage->p($sStatesSelection);
  2055. $oPage->add($sButtons);
  2056. }
  2057. // Hook the cancel button via jQuery so that it can be unhooked easily as well if needed
  2058. $sDefaultUrl = utils::GetAbsoluteUrlAppRoot().'pages/UI.php?operation=cancel&'.$oAppContext->GetForLink();
  2059. $oPage->add_ready_script("$('#form_{$this->m_iFormId} button.cancel').click( function() { BackToDetails('$sClass', $iKey, '$sDefaultUrl')} );");
  2060. $oPage->add("</form>\n");
  2061. if (isset($aExtraParams['wizard_container']) && $aExtraParams['wizard_container'])
  2062. {
  2063. $oPage->add("</div>\n");
  2064. }
  2065. $iFieldsCount = count($aFieldsMap);
  2066. $sJsonFieldsMap = json_encode($aFieldsMap);
  2067. $sState = $this->GetState();
  2068. $sSessionStorageKey = $sClass.'_'.$iKey;
  2069. $oPage->add_script(
  2070. <<<EOF
  2071. sessionStorage.removeItem('$sSessionStorageKey');
  2072. // Create the object once at the beginning of the page...
  2073. var oWizardHelper$sPrefix = new WizardHelper('$sClass', '$sPrefix', '$sState');
  2074. oWizardHelper$sPrefix.SetFieldsMap($sJsonFieldsMap);
  2075. oWizardHelper$sPrefix.SetFieldsCount($iFieldsCount);
  2076. EOF
  2077. );
  2078. $oPage->add_ready_script(
  2079. <<<EOF
  2080. oWizardHelper$sPrefix.UpdateWizard();
  2081. // Starts the validation when the page is ready
  2082. CheckFields('form_{$this->m_iFormId}', false);
  2083. EOF
  2084. );
  2085. if ($sOwnershipToken !== null)
  2086. {
  2087. $this->GetOwnershipJSHandler($oPage, $sOwnershipToken);
  2088. }
  2089. else
  2090. {
  2091. // Probably a new object (or no concurrent lock), let's add a watchdog so that the session is kept open while editing
  2092. $iInterval = MetaModel::GetConfig()->Get('concurrent_lock_expiration_delay') * 1000 / 2;
  2093. if ($iInterval > 0)
  2094. {
  2095. $iInterval = max(MIN_WATCHDOG_INTERVAL*1000, $iInterval); // Minimum interval for the watchdog is MIN_WATCHDOG_INTERVAL
  2096. $oPage->add_ready_script(
  2097. <<<EOF
  2098. window.setInterval(function() {
  2099. $.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'watchdog'});
  2100. }, $iInterval);
  2101. EOF
  2102. );
  2103. }
  2104. }
  2105. }
  2106. public static function DisplayCreationForm(WebPage $oPage, $sClass, $oObjectToClone = null, $aArgs = array(), $aExtraParams = array())
  2107. {
  2108. $oAppContext = new ApplicationContext();
  2109. $sClass = ($oObjectToClone == null) ? $sClass : get_class($oObjectToClone);
  2110. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  2111. $aStates = MetaModel::EnumStates($sClass);
  2112. $sStatesSelection = '';
  2113. if ($oObjectToClone == null)
  2114. {
  2115. $oObj = MetaModel::NewObject($sClass);
  2116. if (!empty($sStateAttCode))
  2117. {
  2118. $sTargetState = MetaModel::GetDefaultState($sClass);
  2119. $oObj->Set($sStateAttCode, $sTargetState);
  2120. }
  2121. }
  2122. else
  2123. {
  2124. $oObj = clone $oObjectToClone;
  2125. }
  2126. // Pre-fill the object with default values, when there is only on possible choice
  2127. // AND the field is mandatory (otherwise there is always the possiblity to let it empty)
  2128. $aArgs['this'] = $oObj;
  2129. $aDetailsList = self::FLattenZList(MetaModel::GetZListItems($sClass, 'details'));
  2130. // Order the fields based on their dependencies
  2131. $aDeps = array();
  2132. foreach($aDetailsList as $sAttCode)
  2133. {
  2134. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  2135. }
  2136. $aList = self::OrderDependentFields($aDeps);
  2137. // Now fill-in the fields with default/supplied values
  2138. foreach($aList as $sAttCode)
  2139. {
  2140. if (isset($aArgs['default'][$sAttCode]))
  2141. {
  2142. $oObj->Set($sAttCode, $aArgs['default'][$sAttCode]);
  2143. }
  2144. else
  2145. {
  2146. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2147. // If the field is mandatory, set it to the only possible value
  2148. $iFlags = $oObj->GetInitialStateAttributeFlags($sAttCode);
  2149. if ((!$oAttDef->IsNullAllowed()) || ($iFlags & OPT_ATT_MANDATORY))
  2150. {
  2151. if ($oAttDef->IsExternalKey())
  2152. {
  2153. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  2154. if ($oAllowedValues->Count() == 1)
  2155. {
  2156. $oRemoteObj = $oAllowedValues->Fetch();
  2157. $oObj->Set($sAttCode, $oRemoteObj->GetKey());
  2158. }
  2159. }
  2160. else
  2161. {
  2162. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  2163. if (count($aAllowedValues) == 1)
  2164. {
  2165. $aValues = array_keys($aAllowedValues);
  2166. $oObj->Set($sAttCode, $aValues[0]);
  2167. }
  2168. }
  2169. }
  2170. }
  2171. }
  2172. return $oObj->DisplayModifyForm( $oPage, $aExtraParams);
  2173. }
  2174. public function DisplayStimulusForm(WebPage $oPage, $sStimulus)
  2175. {
  2176. $sClass = get_class($this);
  2177. $iKey = $this->GetKey();
  2178. $aTransitions = $this->EnumTransitions();
  2179. $aStimuli = MetaModel::EnumStimuli($sClass);
  2180. if (!isset($aTransitions[$sStimulus]))
  2181. {
  2182. // Invalid stimulus
  2183. throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus, $this->GetName(), $this->GetStateLabel()));
  2184. }
  2185. // Check for concurrent access lock
  2186. $LockEnabled = MetaModel::GetConfig()->Get('concurrent_lock_enabled');
  2187. $sOwnershipToken = null;
  2188. if ($LockEnabled)
  2189. {
  2190. $sOwnershipToken = utils::ReadPostedParam('ownership_token', null, false, 'raw_data');
  2191. $aLockInfo = iTopOwnershipLock::AcquireLock($sClass, $iKey);
  2192. if ($aLockInfo['success'])
  2193. {
  2194. $sOwnershipToken = $aLockInfo['token'];
  2195. $sOwnershipDate = $aLockInfo['acquired'];
  2196. }
  2197. else
  2198. {
  2199. $oOwner = $aLockInfo['lock']->GetOwner();
  2200. // If the object is locked by the current user, it's worth trying again, since
  2201. // the lock may be released by 'onunload' which is called AFTER loading the current page.
  2202. //$bTryAgain = $oOwner->GetKey() == UserRights::GetUserId();
  2203. self::ReloadAndDisplay($oPage, $this, array('operation' => 'stimulus', 'stimulus' => $sStimulus));
  2204. return;
  2205. }
  2206. }
  2207. $sActionLabel = $aStimuli[$sStimulus]->GetLabel();
  2208. $sActionDetails = $aStimuli[$sStimulus]->GetDescription();
  2209. $aTransition = $aTransitions[$sStimulus];
  2210. $sTargetState = $aTransition['target_state'];
  2211. $aTargetStates = MetaModel::EnumStates($sClass);
  2212. $oPage->add("<div class=\"page_header\">\n");
  2213. $oPage->add("<h1>$sActionLabel - <span class=\"hilite\">{$this->GetName()}</span></h1>\n");
  2214. $oPage->set_title($sActionLabel);
  2215. $oPage->add("</div>\n");
  2216. $aTargetState = $aTargetStates[$sTargetState];
  2217. $aExpectedAttributes = $aTargetState['attribute_list'];
  2218. $oPage->add("<h1>$sActionDetails</h1>\n");
  2219. $sButtonsPosition = MetaModel::GetConfig()->Get('buttons_position');
  2220. if ($sButtonsPosition == 'bottom')
  2221. {
  2222. // bottom: Displays the ticket details BEFORE the actions
  2223. $oPage->add('<div class="ui-widget-content">');
  2224. $this->DisplayBareProperties($oPage);
  2225. $oPage->add('</div>');
  2226. }
  2227. $oPage->add("<div class=\"wizContainer\">\n");
  2228. $oPage->add("<form id=\"apply_stimulus\" method=\"post\" onSubmit=\"return OnSubmit('apply_stimulus');\">\n");
  2229. $aDetails = array();
  2230. $iFieldIndex = 0;
  2231. $aFieldsMap = array();
  2232. $aDetailsList =$this->FlattenZList(MetaModel::GetZListItems($sClass, 'details'));
  2233. // Order the fields based on their dependencies, set the fields for which there is only one possible value
  2234. // and perform this in the order of dependencies to avoid dead-ends
  2235. $aDeps = array();
  2236. foreach($aDetailsList as $sAttCode)
  2237. {
  2238. $aDeps[$sAttCode] = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode);
  2239. }
  2240. $aList =$this->OrderDependentFields($aDeps);
  2241. foreach($aList as $sAttCode)
  2242. {
  2243. // Consider only the "expected" fields for the target state
  2244. if (array_key_exists($sAttCode, $aExpectedAttributes))
  2245. {
  2246. $iExpectCode = $aExpectedAttributes[$sAttCode];
  2247. // Prompt for an attribute if
  2248. // - the attribute must be changed or must be displayed to the user for confirmation
  2249. // - or the field is mandatory and currently empty
  2250. if ( ($iExpectCode & (OPT_ATT_MUSTCHANGE | OPT_ATT_MUSTPROMPT)) ||
  2251. (($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) == '')) )
  2252. {
  2253. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2254. $aArgs = array('this' => $this);
  2255. // If the field is mandatory, set it to the only possible value
  2256. if ((!$oAttDef->IsNullAllowed()) || ($iExpectCode & OPT_ATT_MANDATORY))
  2257. {
  2258. if ($oAttDef->IsExternalKey())
  2259. {
  2260. $oAllowedValues = MetaModel::GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs);
  2261. if ($oAllowedValues->Count() == 1)
  2262. {
  2263. $oRemoteObj = $oAllowedValues->Fetch();
  2264. $this->Set($sAttCode, $oRemoteObj->GetKey());
  2265. }
  2266. }
  2267. else
  2268. {
  2269. $aAllowedValues = MetaModel::GetAllowedValues_att($sClass, $sAttCode, $aArgs);
  2270. if (count($aAllowedValues) == 1)
  2271. {
  2272. $aValues = array_keys($aAllowedValues);
  2273. $this->Set($sAttCode, $aValues[0]);
  2274. }
  2275. }
  2276. }
  2277. $sHTMLValue = cmdbAbstractObject::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef,$this->Get($sAttCode),$this->GetEditValue($sAttCode), 'att_'.$iFieldIndex, '', $iExpectCode, $aArgs);
  2278. $aDetails[] = array('label' => '<span>'.$oAttDef->GetLabel().'</span>', 'value' => "<span id=\"field_att_$iFieldIndex\">$sHTMLValue</span>");
  2279. $aFieldsMap[$sAttCode] = 'att_'.$iFieldIndex;
  2280. $iFieldIndex++;
  2281. }
  2282. }
  2283. }
  2284. $oPage->add('<table><tr><td>');
  2285. $oPage->details($aDetails);
  2286. $oPage->add('</td></tr></table>');
  2287. $oPage->add("<input type=\"hidden\" name=\"id\" value=\"".$this->GetKey()."\" id=\"id\">\n");
  2288. $aFieldsMap['id'] = 'id';
  2289. $oPage->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  2290. $oPage->add("<input type=\"hidden\" name=\"operation\" value=\"apply_stimulus\">\n");
  2291. $oPage->add("<input type=\"hidden\" name=\"stimulus\" value=\"$sStimulus\">\n");
  2292. $iTransactionId = utils::GetNewTransactionId();
  2293. $oPage->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".$iTransactionId."\">\n");
  2294. if ($sOwnershipToken !== null)
  2295. {
  2296. $oPage->add("<input type=\"hidden\" name=\"ownership_token\" value=\"".htmlentities($sOwnershipToken, ENT_QUOTES, 'UTF-8')."\">\n");
  2297. }
  2298. $oAppContext = new ApplicationContext();
  2299. $oPage->add($oAppContext->GetForForm());
  2300. $oPage->add("<button type=\"button\" class=\"action cancel\" onClick=\"BackToDetails('$sClass', ".$this->GetKey().")\"><span>".Dict::S('UI:Button:Cancel')."</span></button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  2301. $oPage->add("<button type=\"submit\" class=\"action\"><span>$sActionLabel</span></button>\n");
  2302. $oPage->add("</form>\n");
  2303. $oPage->add("</div>\n");
  2304. if ($sButtonsPosition != 'top')
  2305. {
  2306. // bottom or both: Displays the ticket details AFTER the actions
  2307. $oPage->add('<div class="ui-widget-content">');
  2308. $this->DisplayBareProperties($oPage);
  2309. $oPage->add('</div>');
  2310. }
  2311. $iFieldsCount = count($aFieldsMap);
  2312. $sJsonFieldsMap = json_encode($aFieldsMap);
  2313. $oPage->add_script(
  2314. <<<EOF
  2315. // Initializes the object once at the beginning of the page...
  2316. var oWizardHelper = new WizardHelper('$sClass', '', '$sTargetState');
  2317. oWizardHelper.SetFieldsMap($sJsonFieldsMap);
  2318. oWizardHelper.SetFieldsCount($iFieldsCount);
  2319. EOF
  2320. );
  2321. $sJSToken = json_encode($sOwnershipToken);
  2322. $oPage->add_ready_script(
  2323. <<<EOF
  2324. // Starts the validation when the page is ready
  2325. CheckFields('apply_stimulus', false);
  2326. $(window).unload(function() { return OnUnload('$iTransactionId', '$sClass', $iKey, $sJSToken) } );
  2327. EOF
  2328. );
  2329. if ($sOwnershipToken !== null)
  2330. {
  2331. $this->GetOwnershipJSHandler($oPage, $sOwnershipToken);
  2332. }
  2333. }
  2334. public static function ProcessZlist($aList, $aDetails, $sCurrentTab, $sCurrentCol, $sCurrentSet)
  2335. {
  2336. //echo "<pre>ZList: ";
  2337. //print_r($aList);
  2338. //echo "</pre>\n";
  2339. $index = 0;
  2340. foreach($aList as $sKey => $value)
  2341. {
  2342. if (is_array($value))
  2343. {
  2344. if (preg_match('/^(.*):(.*)$/U', $sKey, $aMatches))
  2345. {
  2346. $sCode = $aMatches[1];
  2347. $sName = $aMatches[2];
  2348. switch($sCode)
  2349. {
  2350. case 'tab':
  2351. //echo "<p>Found a tab: $sName ($sKey)</p>\n";
  2352. if(!isset($aDetails[$sName]))
  2353. {
  2354. $aDetails[$sName] = array('col1' => array());
  2355. }
  2356. $aDetails = self::ProcessZlist($value, $aDetails, $sName, 'col1', '');
  2357. break;
  2358. case 'fieldset':
  2359. //echo "<p>Found a fieldset: $sName ($sKey)</p>\n";
  2360. if(!isset($aDetailsStruct[$sCurrentTab][$sCurrentCol][$sName]))
  2361. {
  2362. $aDetails[$sCurrentTab][$sCurrentCol][$sName] = array();
  2363. }
  2364. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sCurrentCol, $sName);
  2365. break;
  2366. default:
  2367. case 'col':
  2368. //echo "<p>Found a column: $sName ($sKey)</p>\n";
  2369. if(!isset($aDetails[$sCurrentTab][$sName]))
  2370. {
  2371. $aDetails[$sCurrentTab][$sName] = array();
  2372. }
  2373. $aDetails = self::ProcessZlist($value, $aDetails, $sCurrentTab, $sName, '');
  2374. break;
  2375. }
  2376. }
  2377. }
  2378. else
  2379. {
  2380. //echo "<p>Scalar value: $value, in [$sCurrentTab][$sCurrentCol][$sCurrentSet][]</p>\n";
  2381. if (empty($sCurrentSet))
  2382. {
  2383. $aDetails[$sCurrentTab][$sCurrentCol]['_'.$index][] = $value;
  2384. }
  2385. else
  2386. {
  2387. $aDetails[$sCurrentTab][$sCurrentCol][$sCurrentSet][] = $value;
  2388. }
  2389. }
  2390. $index++;
  2391. }
  2392. return $aDetails;
  2393. }
  2394. static function FlattenZList($aList)
  2395. {
  2396. $aResult = array();
  2397. foreach($aList as $value)
  2398. {
  2399. if (!is_array($value))
  2400. {
  2401. $aResult[] = $value;
  2402. }
  2403. else
  2404. {
  2405. $aResult = array_merge($aResult,self::FlattenZList($value));
  2406. }
  2407. }
  2408. return $aResult;
  2409. }
  2410. protected function GetFieldAsHtml($sClass, $sAttCode, $sStateAttCode)
  2411. {
  2412. $retVal = null;
  2413. if ($this->IsNew())
  2414. {
  2415. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2416. }
  2417. else
  2418. {
  2419. $iFlags = $this->GetAttributeFlags($sAttCode);
  2420. }
  2421. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  2422. if ( (!$oAttDef->IsLinkSet()) && (($iFlags & OPT_ATT_HIDDEN) == 0) )
  2423. {
  2424. // The field is visible in the current state of the object
  2425. if ($sStateAttCode == $sAttCode)
  2426. {
  2427. // Special display for the 'state' attribute itself
  2428. $sDisplayValue = $this->GetStateLabel();
  2429. }
  2430. else if ($oAttDef->GetEditClass() == 'Document')
  2431. {
  2432. $oDocument = $this->Get($sAttCode);
  2433. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2434. $sDisplayValue .= "<br/>".Dict::Format('UI:OpenDocumentInNewWindow_', $oDocument->GetDisplayLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2435. $sDisplayValue .= "<br/>".Dict::Format('UI:DownloadDocument_', $oDocument->GetDownloadLink(get_class($this), $this->GetKey(), $sAttCode)).", \n";
  2436. }
  2437. else
  2438. {
  2439. $sDisplayValue = $this->GetAsHTML($sAttCode);
  2440. }
  2441. $retVal = array('label' => '<span title="'.MetaModel::GetDescription($sClass, $sAttCode).'">'.MetaModel::GetLabel($sClass, $sAttCode).'</span>', 'value' => $sDisplayValue);
  2442. }
  2443. return $retVal;
  2444. }
  2445. /**
  2446. * Displays a blob document *inline* (if possible, depending on the type of the document)
  2447. * @return string
  2448. */
  2449. public function DisplayDocumentInline(WebPage $oPage, $sAttCode)
  2450. {
  2451. $oDoc = $this->Get($sAttCode);
  2452. $sClass = get_class($this);
  2453. $Id = $this->GetKey();
  2454. switch ($oDoc->GetMainMimeType())
  2455. {
  2456. case 'text':
  2457. case 'html':
  2458. $data = $oDoc->GetData();
  2459. switch($oDoc->GetMimeType())
  2460. {
  2461. case 'text/html':
  2462. case 'text/xml':
  2463. $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");
  2464. break;
  2465. default:
  2466. $oPage->add("<pre>".htmlentities(MyHelpers::beautifulstr($data, 1000, true), ENT_QUOTES, 'UTF-8')."</pre>\n");
  2467. }
  2468. break;
  2469. case 'application':
  2470. switch($oDoc->GetMimeType())
  2471. {
  2472. case 'application/pdf':
  2473. $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");
  2474. break;
  2475. default:
  2476. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2477. }
  2478. break;
  2479. case 'image':
  2480. $oPage->add("<img src=\"".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=display_document&class=$sClass&id=$Id&field=$sAttCode\" />\n");
  2481. break;
  2482. default:
  2483. $oPage->add(Dict::S('UI:Document:NoPreview'));
  2484. }
  2485. }
  2486. // $m_highlightComparison[previous][new] => next value
  2487. protected static $m_highlightComparison = array(
  2488. HILIGHT_CLASS_CRITICAL => array(
  2489. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2490. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_CRITICAL,
  2491. HILIGHT_CLASS_OK => HILIGHT_CLASS_CRITICAL,
  2492. HILIGHT_CLASS_NONE => HILIGHT_CLASS_CRITICAL,
  2493. ),
  2494. HILIGHT_CLASS_WARNING => array(
  2495. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2496. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2497. HILIGHT_CLASS_OK => HILIGHT_CLASS_WARNING,
  2498. HILIGHT_CLASS_NONE => HILIGHT_CLASS_WARNING,
  2499. ),
  2500. HILIGHT_CLASS_OK => array(
  2501. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2502. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2503. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2504. HILIGHT_CLASS_NONE => HILIGHT_CLASS_OK,
  2505. ),
  2506. HILIGHT_CLASS_NONE => array(
  2507. HILIGHT_CLASS_CRITICAL => HILIGHT_CLASS_CRITICAL,
  2508. HILIGHT_CLASS_WARNING => HILIGHT_CLASS_WARNING,
  2509. HILIGHT_CLASS_OK => HILIGHT_CLASS_OK,
  2510. HILIGHT_CLASS_NONE => HILIGHT_CLASS_NONE,
  2511. ),
  2512. );
  2513. /**
  2514. * This function returns a 'hilight' CSS class, used to hilight a given row in a table
  2515. * There are currently (i.e defined in the CSS) 4 possible values HILIGHT_CLASS_CRITICAL,
  2516. * HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2517. * To Be overridden by derived classes
  2518. * @param void
  2519. * @return String The desired higlight class for the object/row
  2520. */
  2521. public function GetHilightClass()
  2522. {
  2523. // Possible return values are:
  2524. // HILIGHT_CLASS_CRITICAL, HILIGHT_CLASS_WARNING, HILIGHT_CLASS_OK, HILIGHT_CLASS_NONE
  2525. $current = parent::GetHilightClass(); // Default computation
  2526. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2527. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  2528. {
  2529. $new = $oExtensionInstance->GetHilightClass($this);
  2530. @$current = self::$m_highlightComparison[$current][$new];
  2531. }
  2532. return $current;
  2533. }
  2534. /**
  2535. * Re-order the fields based on their inter-dependencies
  2536. * @params hash @aFields field_code => array_of_depencies
  2537. * @return array Ordered array of fields or throws an exception
  2538. */
  2539. public static function OrderDependentFields($aFields)
  2540. {
  2541. $bCircular = false;
  2542. $aResult = array();
  2543. $iCount = 0;
  2544. do
  2545. {
  2546. $bSet = false;
  2547. $iCount++;
  2548. foreach($aFields as $sFieldCode => $aDeps)
  2549. {
  2550. foreach($aDeps as $key => $sDependency)
  2551. {
  2552. if (in_array($sDependency, $aResult))
  2553. {
  2554. // Dependency is resolved, remove it
  2555. unset($aFields[$sFieldCode][$key]);
  2556. }
  2557. else if (!array_key_exists($sDependency, $aFields))
  2558. {
  2559. // The current fields depends on a field not present in the form
  2560. // let's ignore it (since it cannot change)
  2561. unset($aFields[$sFieldCode][$key]);
  2562. }
  2563. }
  2564. if (count($aFields[$sFieldCode]) == 0)
  2565. {
  2566. // No more pending depencies for this field, add it to the list
  2567. $aResult[] = $sFieldCode;
  2568. unset($aFields[$sFieldCode]);
  2569. $bSet = true;
  2570. }
  2571. }
  2572. }
  2573. while($bSet && (count($aFields) > 0));
  2574. if (count($aFields) > 0)
  2575. {
  2576. $sMessage = "Error: Circular dependencies between the fields! <pre>".print_r($aFields, true)."</pre>";
  2577. throw(new Exception($sMessage));
  2578. }
  2579. return $aResult;
  2580. }
  2581. /**
  2582. * Get the list of actions to be displayed as 'shortcuts' (i.e buttons) instead of inside the Actions popup menu
  2583. * @param $sFinalClass string The actual class of the objects for which to display the menu
  2584. * @return Array the list of menu codes (i.e dictionary entries) that can be displayed as shortcuts next to the actions menu
  2585. */
  2586. public static function GetShortcutActions($sFinalClass)
  2587. {
  2588. $sShortcutActions = MetaModel::GetConfig()->Get('shortcut_actions');
  2589. $aShortcutActions = explode(',', $sShortcutActions);
  2590. return $aShortcutActions;
  2591. }
  2592. /**
  2593. * Maps the given context parameter name to the appropriate filter/search code for this class
  2594. * @param string $sContextParam Name of the context parameter, i.e. 'org_id'
  2595. * @return string Filter code, i.e. 'customer_id'
  2596. */
  2597. public static function MapContextParam($sContextParam)
  2598. {
  2599. if ($sContextParam == 'menu')
  2600. {
  2601. return null;
  2602. }
  2603. else
  2604. {
  2605. return $sContextParam;
  2606. }
  2607. }
  2608. /**
  2609. * Updates the object from a flat array of values
  2610. * @param $aAttList array $aAttList array of attcode
  2611. * @param $aErrors array Returns information about slave attributes
  2612. * @param $sTargetState string Target state for which to evaluate the writeable attributes (=current state is empty)
  2613. * @return array of attcodes that can be used for writing on the current object
  2614. */
  2615. public function GetWriteableAttList($aAttList, &$aErrors, $sTargetState = '')
  2616. {
  2617. if (!is_array($aAttList))
  2618. {
  2619. $aAttList = $this->FlattenZList(MetaModel::GetZListItems(get_class($this), 'details'));
  2620. // Special case to process the case log, if any...
  2621. // WARNING: if you change this also check the functions DisplayModifyForm and DisplayCaseLog
  2622. foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  2623. {
  2624. if ($this->IsNew())
  2625. {
  2626. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2627. }
  2628. else
  2629. {
  2630. $aVoid = array();
  2631. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2632. }
  2633. if ($oAttDef instanceof AttributeCaseLog)
  2634. {
  2635. if (!($iFlags & (OPT_ATT_HIDDEN|OPT_ATT_SLAVE|OPT_ATT_READONLY)))
  2636. {
  2637. // The case log is editable, append it to the list of fields to retrieve
  2638. $aAttList[] = $sAttCode;
  2639. }
  2640. }
  2641. }
  2642. }
  2643. $aWriteableAttList = array();
  2644. foreach($aAttList as $sAttCode)
  2645. {
  2646. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2647. if ($this->IsNew())
  2648. {
  2649. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2650. }
  2651. else
  2652. {
  2653. $aVoid = array();
  2654. $iFlags = $this->GetAttributeFlags($sAttCode, $aVoid, $sTargetState);
  2655. }
  2656. if ($oAttDef->IsWritable())
  2657. {
  2658. if ( $iFlags & (OPT_ATT_HIDDEN | OPT_ATT_READONLY))
  2659. {
  2660. // Non-visible, or read-only attribute, do nothing
  2661. }
  2662. elseif($iFlags & OPT_ATT_SLAVE)
  2663. {
  2664. $aErrors[$sAttCode] = Dict::Format('UI:AttemptingToSetASlaveAttribute_Name', $oAttDef->GetLabel());
  2665. }
  2666. else
  2667. {
  2668. $aWriteableAttList[$sAttCode] = $oAttDef;
  2669. }
  2670. }
  2671. }
  2672. return $aWriteableAttList;
  2673. }
  2674. /**
  2675. * Compute the attribute flags depending on the object state
  2676. */
  2677. public function GetFormAttributeFlags($sAttCode)
  2678. {
  2679. if ($this->IsNew())
  2680. {
  2681. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  2682. }
  2683. else
  2684. {
  2685. $iFlags = $this->GetAttributeFlags($sAttCode);
  2686. }
  2687. if (($iFlags & OPT_ATT_MANDATORY) && $this->IsNew())
  2688. {
  2689. $iFlags = $iFlags & ~OPT_ATT_READONLY; // Mandatory fields cannot be read-only when creating an object
  2690. }
  2691. return $iFlags;
  2692. }
  2693. /**
  2694. * Updates the object from a flat array of values
  2695. * @param string $aValues array of attcode => scalar or array (N-N links)
  2696. * @return void
  2697. */
  2698. public function UpdateObjectFromArray($aValues)
  2699. {
  2700. foreach($aValues as $sAttCode => $value)
  2701. {
  2702. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2703. if ($oAttDef->IsLinkSet() && $oAttDef->IsIndirect())
  2704. {
  2705. $aLinks = $value;
  2706. $sLinkedClass = $oAttDef->GetLinkedClass();
  2707. $sExtKeyToRemote = $oAttDef->GetExtKeyToRemote();
  2708. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  2709. $oLinkedSet = DBObjectSet::FromScratch($sLinkedClass);
  2710. if (is_array($aLinks))
  2711. {
  2712. foreach($aLinks as $id => $aData)
  2713. {
  2714. if (is_numeric($id))
  2715. {
  2716. if ($id < 0)
  2717. {
  2718. // New link to be created, the opposite of the id (-$id) is the ID of the remote object
  2719. $oLink = MetaModel::NewObject($sLinkedClass);
  2720. $oLink->Set($sExtKeyToRemote, -$id);
  2721. $oLink->Set($sExtKeyToMe, $this->GetKey());
  2722. }
  2723. else
  2724. {
  2725. // Existing link, potentially to be updated...
  2726. $oLink = MetaModel::GetObject($sLinkedClass, $id);
  2727. }
  2728. // Now populate the attributes
  2729. foreach($aData as $sName => $value)
  2730. {
  2731. if (MetaModel::IsValidAttCode($sLinkedClass, $sName))
  2732. {
  2733. $oLinkAttDef = MetaModel::GetAttributeDef($sLinkedClass, $sName);
  2734. if ($oLinkAttDef->IsWritable())
  2735. {
  2736. $oLink->Set($sName, $value);
  2737. }
  2738. }
  2739. }
  2740. $oLinkedSet->AddObject($oLink);
  2741. }
  2742. }
  2743. }
  2744. $this->Set($sAttCode, $oLinkedSet);
  2745. }
  2746. elseif ($oAttDef->GetEditClass() == 'Document')
  2747. {
  2748. // There should be an uploaded file with the named attr_<attCode>
  2749. $oDocument = $value['fcontents'];
  2750. if (!$oDocument->IsEmpty())
  2751. {
  2752. // A new file has been uploaded
  2753. $this->Set($sAttCode, $oDocument);
  2754. }
  2755. }
  2756. elseif ($oAttDef->GetEditClass() == 'One Way Password')
  2757. {
  2758. // Check if the password was typed/changed
  2759. $aPwdData = $value;
  2760. if (!is_null($aPwdData) && $aPwdData['changed'])
  2761. {
  2762. // The password has been changed or set
  2763. $this->Set($sAttCode, $aPwdData['value']);
  2764. }
  2765. }
  2766. elseif ($oAttDef->GetEditClass() == 'Duration')
  2767. {
  2768. $aDurationData = $value;
  2769. if (!is_array($aDurationData)) continue;
  2770. $iValue = (((24*$aDurationData['d'])+$aDurationData['h'])*60 +$aDurationData['m'])*60 + $aDurationData['s'];
  2771. $this->Set($sAttCode, $iValue);
  2772. $previousValue = $this->Get($sAttCode);
  2773. if ($previousValue !== $iValue)
  2774. {
  2775. $this->Set($sAttCode, $iValue);
  2776. }
  2777. }
  2778. else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() &&
  2779. (($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE) || ($oAttDef->GetEditMode() == LINKSET_EDITMODE_ADDREMOVE)))
  2780. {
  2781. $oLinkset = $this->Get($sAttCode);
  2782. $sLinkedClass = $oLinkset->GetClass();
  2783. $aObjSet = array();
  2784. $oLinkset->Rewind();
  2785. $bModified = false;
  2786. while($oLink = $oLinkset->Fetch())
  2787. {
  2788. if (in_array($oLink->GetKey(), $value['to_be_deleted']))
  2789. {
  2790. // The link is to be deleted, don't copy it in the array
  2791. $bModified = true;
  2792. }
  2793. else
  2794. {
  2795. if (!array_key_exists('to_be_removed', $value) || !in_array($oLink->GetKey(), $value['to_be_removed']))
  2796. {
  2797. $aObjSet[] = $oLink;
  2798. }
  2799. }
  2800. }
  2801. if (array_key_exists('to_be_created', $value) && (count($value['to_be_created']) > 0))
  2802. {
  2803. // Now handle the links to be created
  2804. foreach($value['to_be_created'] as $aData)
  2805. {
  2806. $sSubClass = $aData['class'];
  2807. if ( ($sLinkedClass == $sSubClass) || (is_subclass_of($sSubClass, $sLinkedClass)) )
  2808. {
  2809. $aObjData = $aData['data'];
  2810. $oLink = new $sSubClass;
  2811. $oLink->UpdateObjectFromArray($aObjData);
  2812. $aObjSet[] = $oLink;
  2813. $bModified = true;
  2814. }
  2815. }
  2816. }
  2817. if (array_key_exists('to_be_added', $value) && (count($value['to_be_added']) > 0))
  2818. {
  2819. // Now handle the links to be added by making the remote object point to self
  2820. foreach($value['to_be_added'] as $iObjKey)
  2821. {
  2822. $oLink = MetaModel::GetObject($sLinkedClass, $iObjKey, false);
  2823. if ($oLink)
  2824. {
  2825. $aObjSet[] = $oLink;
  2826. $bModified = true;
  2827. }
  2828. }
  2829. }
  2830. if (array_key_exists('to_be_removed', $value) && (count($value['to_be_removed']) > 0))
  2831. {
  2832. // Now handle the links to be removed by making the remote object point to nothing
  2833. // Keep them in the set (modified), DBWriteLinks will handle them
  2834. foreach($value['to_be_removed'] as $iObjKey)
  2835. {
  2836. $oLink = MetaModel::GetObject($sLinkedClass, $iObjKey, false);
  2837. if ($oLink)
  2838. {
  2839. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  2840. $oLink->Set($sExtKeyToMe, null);
  2841. $aObjSet[] = $oLink;
  2842. $bModified = true;
  2843. }
  2844. }
  2845. }
  2846. if ($bModified)
  2847. {
  2848. $oNewSet = DBObjectSet::FromArray($oLinkset->GetClass(), $aObjSet);
  2849. $this->Set($sAttCode, $oNewSet);
  2850. }
  2851. }
  2852. else
  2853. {
  2854. if (!is_null($value))
  2855. {
  2856. $aAttributes[$sAttCode] = trim($value);
  2857. $previousValue = $this->Get($sAttCode);
  2858. if ($previousValue !== $aAttributes[$sAttCode])
  2859. {
  2860. $this->Set($sAttCode, $aAttributes[$sAttCode]);
  2861. }
  2862. }
  2863. }
  2864. }
  2865. }
  2866. /**
  2867. * Updates the object from the POSTed parameters (form)
  2868. */
  2869. public function UpdateObjectFromPostedForm($sFormPrefix = '', $aAttList = null, $sTargetState = '')
  2870. {
  2871. if (is_null($aAttList))
  2872. {
  2873. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2874. }
  2875. $aValues = array();
  2876. foreach($aAttList as $sAttCode)
  2877. {
  2878. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  2879. if ($oAttDef->GetEditClass() == 'Document')
  2880. {
  2881. $value = array('fcontents' => utils::ReadPostedDocument("attr_{$sFormPrefix}{$sAttCode}", 'fcontents'));
  2882. }
  2883. elseif ($oAttDef->GetEditClass() == 'RedundancySetting')
  2884. {
  2885. $value = $oAttDef->ReadValueFromPostedForm($sFormPrefix);
  2886. }
  2887. else if (($oAttDef->GetEditClass() == 'LinkedSet') && !$oAttDef->IsIndirect() &&
  2888. (($oAttDef->GetEditMode() == LINKSET_EDITMODE_INPLACE) || ($oAttDef->GetEditMode() == LINKSET_EDITMODE_ADDREMOVE)) )
  2889. {
  2890. $aRawToBeCreated = json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbc", '{}', 'raw_data'), true);
  2891. $aToBeCreated = array();
  2892. foreach($aRawToBeCreated as $aData)
  2893. {
  2894. $sSubFormPrefix = $aData['formPrefix'];
  2895. $sObjClass = $aData['class'];
  2896. $aObjData = array();
  2897. foreach($aData as $sKey => $value)
  2898. {
  2899. if (preg_match("/^attr_$sSubFormPrefix(.*)$/", $sKey, $aMatches))
  2900. {
  2901. $aObjData[$aMatches[1]] = $value;
  2902. }
  2903. }
  2904. $aToBeCreated[] = array('class' => $sObjClass, 'data' => $aObjData);
  2905. }
  2906. $value = array('to_be_created' => $aToBeCreated,
  2907. 'to_be_deleted' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbd", '[]', 'raw_data'), true),
  2908. 'to_be_added' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tba", '[]', 'raw_data'), true),
  2909. 'to_be_removed' => json_decode(utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}_tbr", '[]', 'raw_data'), true) );
  2910. }
  2911. else
  2912. {
  2913. $value = utils::ReadPostedParam("attr_{$sFormPrefix}{$sAttCode}", null, 'raw_data');
  2914. }
  2915. if (!is_null($value))
  2916. {
  2917. $aValues[$sAttCode] = $value;
  2918. }
  2919. }
  2920. $aErrors = array();
  2921. $aFinalValues = array();
  2922. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2923. {
  2924. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2925. }
  2926. $this->UpdateObjectFromArray($aFinalValues);
  2927. // Invoke extensions after the update of the object from the form
  2928. foreach (MetaModel::EnumPlugins('iApplicationUIExtension') as $oExtensionInstance)
  2929. {
  2930. $oExtensionInstance->OnFormSubmit($this, $sFormPrefix);
  2931. }
  2932. return $aErrors;
  2933. }
  2934. /**
  2935. * Updates the object from a given page argument
  2936. */
  2937. public function UpdateObjectFromArg($sArgName, $aAttList = null, $sTargetState = '')
  2938. {
  2939. if (is_null($aAttList))
  2940. {
  2941. $aAttList = array_keys(MetaModel::ListAttributeDefs(get_class($this)));
  2942. }
  2943. $aRawValues = utils::ReadParam($sArgName, array(), '', 'raw_data');
  2944. $aValues = array();
  2945. foreach($aAttList as $sAttCode)
  2946. {
  2947. if (isset($aRawValues[$sAttCode]))
  2948. {
  2949. $aValues[$sAttCode] = $aRawValues[$sAttCode];
  2950. }
  2951. }
  2952. $aErrors = array();
  2953. $aFinalValues = array();
  2954. foreach($this->GetWriteableAttList(array_keys($aValues), $aErrors, $sTargetState) as $sAttCode => $oAttDef)
  2955. {
  2956. $aFinalValues[$sAttCode] = $aValues[$sAttCode];
  2957. }
  2958. $this->UpdateObjectFromArray($aFinalValues);
  2959. return $aErrors;
  2960. }
  2961. public function DBInsertNoReload()
  2962. {
  2963. $res = parent::DBInsertNoReload();
  2964. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2965. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2966. {
  2967. $oExtensionInstance->OnDBInsert($this, self::GetCurrentChange());
  2968. }
  2969. return $res;
  2970. }
  2971. protected function DBCloneTracked_Internal($newKey = null)
  2972. {
  2973. $oNewObj = parent::DBCloneTracked_Internal($newKey);
  2974. // Invoke extensions after insertion (the object must exist, have an id, etc.)
  2975. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2976. {
  2977. $oExtensionInstance->OnDBInsert($oNewObj, self::GetCurrentChange());
  2978. }
  2979. return $oNewObj;
  2980. }
  2981. public function DBUpdate()
  2982. {
  2983. $res = parent::DBUpdate();
  2984. // Invoke extensions after the update (could be before)
  2985. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  2986. {
  2987. $oExtensionInstance->OnDBUpdate($this, self::GetCurrentChange());
  2988. }
  2989. return $res;
  2990. }
  2991. protected static function BulkUpdateTracked_Internal(DBObjectSearch $oFilter, array $aValues)
  2992. {
  2993. // Todo - invoke the extension
  2994. return parent::BulkUpdateTracked_Internal($oFilter, $aValues);
  2995. }
  2996. protected function DBDeleteTracked_Internal(&$oDeletionPlan = null)
  2997. {
  2998. // Invoke extensions before the deletion (the deletion will do some cleanup and we might loose some information
  2999. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  3000. {
  3001. $oExtensionInstance->OnDBDelete($this, self::GetCurrentChange());
  3002. }
  3003. return parent::DBDeleteTracked_Internal($oDeletionPlan);
  3004. }
  3005. public function IsModified()
  3006. {
  3007. if (parent::IsModified())
  3008. {
  3009. return true;
  3010. }
  3011. // Plugins
  3012. //
  3013. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  3014. {
  3015. if ($oExtensionInstance->OnIsModified($this))
  3016. {
  3017. return true;
  3018. }
  3019. }
  3020. return false;
  3021. }
  3022. public function DoCheckToWrite()
  3023. {
  3024. parent::DoCheckToWrite();
  3025. // Plugins
  3026. //
  3027. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  3028. {
  3029. $aNewIssues = $oExtensionInstance->OnCheckToWrite($this);
  3030. if (count($aNewIssues) > 0)
  3031. {
  3032. $this->m_aCheckIssues = array_merge($this->m_aCheckIssues, $aNewIssues);
  3033. }
  3034. }
  3035. // User rights
  3036. //
  3037. $aChanges = $this->ListChanges();
  3038. if (count($aChanges) > 0)
  3039. {
  3040. $aForbiddenFields = array();
  3041. foreach ($this->ListChanges() as $sAttCode => $value)
  3042. {
  3043. $bUpdateAllowed = UserRights::IsActionAllowedOnAttribute(get_class($this), $sAttCode, UR_ACTION_MODIFY, DBObjectSet::FromObject($this));
  3044. if (!$bUpdateAllowed)
  3045. {
  3046. $oAttCode = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  3047. $aForbiddenFields[] = $oAttCode->GetLabel();
  3048. }
  3049. }
  3050. if (count($aForbiddenFields) > 0)
  3051. {
  3052. // Security issue
  3053. $this->m_bSecurityIssue = true;
  3054. $this->m_aCheckIssues[] = Dict::Format('UI:Delete:NotAllowedToUpdate_Fields',implode(', ', $aForbiddenFields));
  3055. }
  3056. }
  3057. }
  3058. protected function DoCheckToDelete(&$oDeletionPlan)
  3059. {
  3060. parent::DoCheckToDelete($oDeletionPlan);
  3061. // Plugins
  3062. //
  3063. foreach (MetaModel::EnumPlugins('iApplicationObjectExtension') as $oExtensionInstance)
  3064. {
  3065. $aNewIssues = $oExtensionInstance->OnCheckToDelete($this);
  3066. if (count($aNewIssues) > 0)
  3067. {
  3068. $this->m_aDeleteIssues = array_merge($this->m_aDeleteIssues, $aNewIssues);
  3069. }
  3070. }
  3071. // User rights
  3072. //
  3073. $bDeleteAllowed = UserRights::IsActionAllowed(get_class($this), UR_ACTION_DELETE, DBObjectSet::FromObject($this));
  3074. if (!$bDeleteAllowed)
  3075. {
  3076. // Security issue
  3077. $this->m_bSecurityIssue = true;
  3078. $this->m_aDeleteIssues[] = Dict::S('UI:Delete:NotAllowedToDelete');
  3079. }
  3080. }
  3081. /**
  3082. * Special display where the case log uses the whole "screen" at the bottom of the "Properties" tab
  3083. */
  3084. public function DisplayCaseLog(WebPage $oPage, $sAttCode, $sComment = '', $sPrefix = '', $bEditMode = false)
  3085. {
  3086. $oPage->SetCurrentTab(Dict::S('UI:PropertiesTab'));
  3087. $sClass = get_class($this);
  3088. if ($this->IsNew())
  3089. {
  3090. $iFlags = $this->GetInitialStateAttributeFlags($sAttCode);
  3091. }
  3092. else
  3093. {
  3094. $iFlags = $this->GetAttributeFlags($sAttCode);
  3095. }
  3096. if ( $iFlags & OPT_ATT_HIDDEN)
  3097. {
  3098. // The case log is hidden do nothing
  3099. }
  3100. else
  3101. {
  3102. $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
  3103. $sInputId = $this->m_iFormId.'_'.$sAttCode;
  3104. if ((!$bEditMode) || ($iFlags & (OPT_ATT_READONLY|OPT_ATT_SLAVE)))
  3105. {
  3106. // Check if the attribute is not read-only because of a synchro...
  3107. $aReasons = array();
  3108. $sSynchroIcon = '';
  3109. if ($iFlags & OPT_ATT_SLAVE)
  3110. {
  3111. $iSynchroFlags = $this->GetSynchroReplicaFlags($sAttCode, $aReasons);
  3112. $sSynchroIcon = "&nbsp;<img id=\"synchro_$sInputId\" src=\"../images/transp-lock.png\" style=\"vertical-align:middle\"/>";
  3113. $sTip = '';
  3114. foreach($aReasons as $aRow)
  3115. {
  3116. $sTip .= "<p>Synchronized with {$aRow['name']} - {$aRow['description']}</p>";
  3117. }
  3118. $sTip = addslashes($sTip);
  3119. $oPage->add_ready_script("$('#synchro_$sInputId').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );");
  3120. }
  3121. // Attribute is read-only
  3122. $sHTMLValue = $this->GetAsHTML($sAttCode);
  3123. $sHTMLValue .= '<input type="hidden" id="'.$sInputId.'" name="attr_'.$sPrefix.$sAttCode.'" value="'.htmlentities($this->GetEditValue($sAttCode), ENT_QUOTES, 'UTF-8').'"/>';
  3124. $aFieldsMap[$sAttCode] = $sInputId;
  3125. $sComment .= $sSynchroIcon;
  3126. }
  3127. else
  3128. {
  3129. $sValue = $this->Get($sAttCode);
  3130. $sDisplayValue = $this->GetEditValue($sAttCode);
  3131. $aArgs = array('this' => $this, 'formPrefix' => $sPrefix);
  3132. $sHTMLValue = '';
  3133. if ($sComment != '')
  3134. {
  3135. $sHTMLValue = '<span>'.$sComment.'</span><br/>';
  3136. }
  3137. $sHTMLValue .= "<span id=\"field_{$sInputId}\">".self::GetFormElementForField($oPage, $sClass, $sAttCode, $oAttDef, $sValue, $sDisplayValue, $sInputId, '', $iFlags, $aArgs).'</span>';
  3138. $aFieldsMap[$sAttCode] = $sInputId;
  3139. }
  3140. //$aVal = array('label' => '<span title="'.$oAttDef->GetDescription().'">'.$oAttDef->GetLabel().'</span>', 'value' => $sHTMLValue, 'comments' => $sComments, 'infos' => $sInfos);
  3141. $oPage->add('<fieldset><legend>'.$oAttDef->GetLabel().'</legend>');
  3142. $oPage->add($sHTMLValue);
  3143. $oPage->add('</fieldset>');
  3144. }
  3145. }
  3146. public function GetExpectedAttributes($sCurrentState, $sStimulus, $bOnlyNewOnes)
  3147. {
  3148. $aTransitions = $this->EnumTransitions();
  3149. $aStimuli = MetaModel::EnumStimuli(get_class($this));
  3150. if (!isset($aTransitions[$sStimulus]))
  3151. {
  3152. // Invalid stimulus
  3153. throw new ApplicationException(Dict::Format('UI:Error:Invalid_Stimulus_On_Object_In_State', $sStimulus,$this->GetName(),$this->GetStateLabel()));
  3154. }
  3155. $aTransition = $aTransitions[$sStimulus];
  3156. $sTargetState = $aTransition['target_state'];
  3157. $aTargetStates = MetaModel::EnumStates(get_class($this));
  3158. $aTargetState = $aTargetStates[$sTargetState];
  3159. $aCurrentState = $aTargetStates[$this->GetState()];
  3160. $aExpectedAttributes = $aTargetState['attribute_list'];
  3161. $aCurrentAttributes = $aCurrentState['attribute_list'];
  3162. $aComputedAttributes = array();
  3163. foreach($aExpectedAttributes as $sAttCode => $iExpectCode)
  3164. {
  3165. if (!array_key_exists($sAttCode, $aCurrentAttributes))
  3166. {
  3167. $aComputedAttributes[$sAttCode] = $iExpectCode;
  3168. }
  3169. else
  3170. {
  3171. if ( !($aCurrentAttributes[$sAttCode] & (OPT_ATT_HIDDEN|OPT_ATT_READONLY)) )
  3172. {
  3173. $iExpectCode = $iExpectCode & ~(OPT_ATT_MUSTPROMPT|OPT_ATT_MUSTCHANGE); // Already prompted/changed, reset the flags
  3174. }
  3175. //TODO: better check if the attribute is not *null*
  3176. if ( ($iExpectCode & OPT_ATT_MANDATORY) && ($this->Get($sAttCode) != ''))
  3177. {
  3178. $iExpectCode = $iExpectCode & ~(OPT_ATT_MANDATORY); // If the attribute is present, then no need to request its presence
  3179. }
  3180. $aComputedAttributes[$sAttCode] = $iExpectCode;
  3181. }
  3182. $aComputedAttributes[$sAttCode] = $aComputedAttributes[$sAttCode] & ~(OPT_ATT_READONLY|OPT_ATT_HIDDEN); // Don't care about this form now
  3183. if ($aComputedAttributes[$sAttCode] == 0)
  3184. {
  3185. unset($aComputedAttributes[$sAttCode]);
  3186. }
  3187. }
  3188. return $aComputedAttributes;
  3189. }
  3190. /**
  3191. * Display a form for modifying several objects at once
  3192. * The form will be submitted to the current page, with the specified additional values
  3193. */
  3194. public static function DisplayBulkModifyForm($oP, $sClass, $aSelectedObj, $sCustomOperation, $sCancelUrl, $aExcludeAttributes = array(), $aContextData = array())
  3195. {
  3196. if (count($aSelectedObj) > 0)
  3197. {
  3198. $iAllowedCount = count($aSelectedObj);
  3199. $sSelectedObj = implode(',', $aSelectedObj);
  3200. $sOQL = "SELECT $sClass WHERE id IN (".$sSelectedObj.")";
  3201. $oSet = new CMDBObjectSet(DBObjectSearch::FromOQL($sOQL));
  3202. // Compute the distribution of the values for each field to determine which of the "scalar" fields are homogenous
  3203. $aList = MetaModel::ListAttributeDefs($sClass);
  3204. $aValues = array();
  3205. foreach($aList as $sAttCode => $oAttDef)
  3206. {
  3207. if ($oAttDef->IsScalar())
  3208. {
  3209. $aValues[$sAttCode] = array();
  3210. }
  3211. }
  3212. while($oObj = $oSet->Fetch())
  3213. {
  3214. foreach($aList as $sAttCode => $oAttDef)
  3215. {
  3216. if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
  3217. {
  3218. $currValue = $oObj->Get($sAttCode);
  3219. if ($oAttDef instanceof AttributeCaseLog)
  3220. {
  3221. $currValue = ' '; // Don't put an empty string, in case the field would be considered as mandatory...
  3222. }
  3223. if (is_object($currValue)) continue; // Skip non scalar values...
  3224. if(!array_key_exists($currValue, $aValues[$sAttCode]))
  3225. {
  3226. $aValues[$sAttCode][$currValue] = array('count' => 1, 'display' => $oObj->GetAsHTML($sAttCode));
  3227. }
  3228. else
  3229. {
  3230. $aValues[$sAttCode][$currValue]['count']++;
  3231. }
  3232. }
  3233. }
  3234. }
  3235. // Now create an object that has values for the homogenous values only
  3236. $oDummyObj = new $sClass(); // @@ What if the class is abstract ?
  3237. $aComments = array();
  3238. function MyComparison($a, $b) // Sort descending
  3239. {
  3240. if ($a['count'] == $b['count'])
  3241. {
  3242. return 0;
  3243. }
  3244. return ($a['count'] > $b['count']) ? -1 : 1;
  3245. }
  3246. $iFormId = cmdbAbstractObject::GetNextFormId(); // Identifier that prefixes all the form fields
  3247. $sReadyScript = '';
  3248. $aDependsOn = array();
  3249. $sFormPrefix = '2_';
  3250. foreach($aList as $sAttCode => $oAttDef)
  3251. {
  3252. $aPrerequisites = MetaModel::GetPrequisiteAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
  3253. if (count($aPrerequisites) > 0)
  3254. {
  3255. // When 'enabling' a field, all its prerequisites must be enabled too
  3256. $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aPrerequisites)."']";
  3257. $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, true); } );\n");
  3258. }
  3259. $aDependents = MetaModel::GetDependentAttributes($sClass, $sAttCode); // List of attributes that are needed for the current one
  3260. if (count($aDependents) > 0)
  3261. {
  3262. // When 'disabling' a field, all its dependent fields must be disabled too
  3263. $sFieldList = "['{$sFormPrefix}".implode("','{$sFormPrefix}", $aDependents)."']";
  3264. $oP->add_ready_script("$('#enable_{$sFormPrefix}{$sAttCode}').bind('change', function(evt, sFormId) { return PropagateCheckBox( this.checked, $sFieldList, false); } );\n");
  3265. }
  3266. if ($oAttDef->IsScalar() && $oAttDef->IsWritable())
  3267. {
  3268. if ($oAttDef->GetEditClass() == 'One Way Password')
  3269. {
  3270. $sTip = "Unknown values";
  3271. $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
  3272. $oDummyObj->Set($sAttCode, null);
  3273. $aComments[$sAttCode] = '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  3274. $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'"> ? </div>';
  3275. $sReadyScript .= 'ToogleField(false, \''.$iFormId.'_'.$sAttCode.'\');'."\n";
  3276. }
  3277. else
  3278. {
  3279. $iCount = count($aValues[$sAttCode]);
  3280. if ($iCount == 1)
  3281. {
  3282. // Homogenous value
  3283. reset($aValues[$sAttCode]);
  3284. $aKeys = array_keys($aValues[$sAttCode]);
  3285. $currValue = $aKeys[0]; // The only value is the first key
  3286. //echo "<p>current value for $sAttCode : $currValue</p>";
  3287. $oDummyObj->Set($sAttCode, $currValue);
  3288. $aComments[$sAttCode] = '';
  3289. if ($sAttCode != MetaModel::GetStateAttributeCode($sClass))
  3290. {
  3291. $aComments[$sAttCode] .= '<input type="checkbox" checked id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  3292. }
  3293. $aComments[$sAttCode] .= '<div class="mono_value">1</div>';
  3294. }
  3295. else
  3296. {
  3297. // Non-homogenous value
  3298. $aMultiValues = $aValues[$sAttCode];
  3299. uasort($aMultiValues, 'MyComparison');
  3300. $iMaxCount = 5;
  3301. $sTip = "<p><b>".Dict::Format('UI:BulkModify_Count_DistinctValues', $iCount)."</b><ul>";
  3302. $index = 0;
  3303. foreach($aMultiValues as $sCurrValue => $aVal)
  3304. {
  3305. $sDisplayValue = empty($aVal['display']) ? '<i>'.Dict::S('Enum:Undefined').'</i>' : str_replace(array("\n", "\r"), " ", $aVal['display']);
  3306. $sTip .= "<li>".Dict::Format('UI:BulkModify:Value_Exists_N_Times', $sDisplayValue, $aVal['count'])."</li>";
  3307. $index++;
  3308. if ($iMaxCount == $index)
  3309. {
  3310. $sTip .= "<li>".Dict::Format('UI:BulkModify:N_MoreValues', count($aMultiValues) - $iMaxCount)."</li>";
  3311. break;
  3312. }
  3313. }
  3314. $sTip .= "</ul></p>";
  3315. $sTip = addslashes($sTip);
  3316. $sReadyScript .= "$('#multi_values_$sAttCode').qtip( { content: '$sTip', show: 'mouseover', hide: 'mouseout', style: { name: 'dark', tip: 'leftTop' }, position: { corner: { target: 'rightMiddle', tooltip: 'leftTop' }} } );";
  3317. $oDummyObj->Set($sAttCode, null);
  3318. $aComments[$sAttCode] = '';
  3319. if ($sAttCode != MetaModel::GetStateAttributeCode($sClass))
  3320. {
  3321. $aComments[$sAttCode] .= '<input type="checkbox" id="enable_'.$iFormId.'_'.$sAttCode.'" onClick="ToogleField(this.checked, \''.$iFormId.'_'.$sAttCode.'\')"/>';
  3322. }
  3323. $aComments[$sAttCode] .= '<div class="multi_values" id="multi_values_'.$sAttCode.'">'.$iCount.'</div>';
  3324. }
  3325. $sReadyScript .= 'ToogleField('.(($iCount == 1) ? 'true': 'false').', \''.$iFormId.'_'.$sAttCode.'\');'."\n";
  3326. }
  3327. }
  3328. }
  3329. $sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
  3330. if (($sStateAttCode != '') && ($oDummyObj->GetState() == ''))
  3331. {
  3332. // Hmmm, it's not gonna work like this ! Set a default value for the "state"
  3333. // Maybe we should use the "state" that is the most common among the objects...
  3334. $aMultiValues = $aValues[$sStateAttCode];
  3335. uasort($aMultiValues, 'MyComparison');
  3336. foreach($aMultiValues as $sCurrValue => $aVal)
  3337. {
  3338. $oDummyObj->Set($sStateAttCode, $sCurrValue);
  3339. break;
  3340. }
  3341. //$oStateAtt = MetaModel::GetAttributeDef($sClass, $sStateAttCode);
  3342. //$oDummyObj->Set($sStateAttCode, $oStateAtt->GetDefaultValue());
  3343. }
  3344. $oP->add("<div class=\"page_header\">\n");
  3345. $oP->add("<h1>".$oDummyObj->GetIcon()."&nbsp;".Dict::Format('UI:Modify_M_ObjectsOf_Class_OutOf_N', $iAllowedCount, $sClass, $iAllowedCount)."</h1>\n");
  3346. $oP->add("</div>\n");
  3347. $oP->add("<div class=\"wizContainer\">\n");
  3348. $sDisableFields = json_encode($aExcludeAttributes);
  3349. $aParams = array
  3350. (
  3351. 'fieldsComments' => $aComments,
  3352. 'noRelations' => true,
  3353. 'custom_operation' => $sCustomOperation,
  3354. 'custom_button' => Dict::S('UI:Button:PreviewModifications'),
  3355. 'selectObj' => $sSelectedObj,
  3356. 'preview_mode' => true,
  3357. 'disabled_fields' => $sDisableFields,
  3358. 'disable_plugins' => true
  3359. );
  3360. $aParams = $aParams + $aContextData; // merge keeping associations
  3361. $oDummyObj->DisplayModifyForm($oP, $aParams);
  3362. $oP->add("</div>\n");
  3363. $oP->add_ready_script($sReadyScript);
  3364. $oP->add_ready_script(
  3365. <<<EOF
  3366. $('.wizContainer button.cancel').unbind('click');
  3367. $('.wizContainer button.cancel').click( function() { window.location.href = '$sCancelUrl'; } );
  3368. EOF
  3369. );
  3370. } // Else no object selected ???
  3371. else
  3372. {
  3373. $oP->p("No object selected !, nothing to do");
  3374. }
  3375. }
  3376. /**
  3377. * Process the reply made from a form built with DisplayBulkModifyForm
  3378. */
  3379. public static function DoBulkModify($oP, $sClass, $aSelectedObj, $sCustomOperation, $bPreview, $sCancelUrl, $aContextData = array())
  3380. {
  3381. $aHeaders = array(
  3382. 'form::select' => array('label' => "<input type=\"checkbox\" onClick=\"CheckAll('.selectList:not(:disabled)', this.checked);\"></input>", 'description' => Dict::S('UI:SelectAllToggle+')),
  3383. 'object' => array('label' => MetaModel::GetName($sClass), 'description' => Dict::S('UI:ModifiedObject')),
  3384. 'status' => array('label' => Dict::S('UI:BulkModifyStatus'), 'description' => Dict::S('UI:BulkModifyStatus+')),
  3385. 'errors' => array('label' => Dict::S('UI:BulkModifyErrors'), 'description' => Dict::S('UI:BulkModifyErrors+')),
  3386. );
  3387. $aRows = array();
  3388. $oP->add("<div class=\"page_header\">\n");
  3389. $oP->add("<h1>".MetaModel::GetClassIcon($sClass)."&nbsp;".Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), MetaModel::GetName($sClass))."</h1>\n");
  3390. $oP->add("</div>\n");
  3391. $oP->set_title(Dict::Format('UI:Modify_N_ObjectsOf_Class', count($aSelectedObj), $sClass));
  3392. if (!$bPreview)
  3393. {
  3394. // Not in preview mode, do the update for real
  3395. $sTransactionId = utils::ReadPostedParam('transaction_id', '');
  3396. if (!utils::IsTransactionValid($sTransactionId, false))
  3397. {
  3398. throw new Exception(Dict::S('UI:Error:ObjectAlreadyUpdated'));
  3399. }
  3400. utils::RemoveTransaction($sTransactionId);
  3401. }
  3402. $iPreviousTimeLimit = ini_get('max_execution_time');
  3403. $iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
  3404. foreach($aSelectedObj as $iId)
  3405. {
  3406. set_time_limit($iLoopTimeLimit);
  3407. $oObj = MetaModel::GetObject($sClass, $iId);
  3408. $aErrors = $oObj->UpdateObjectFromPostedForm('');
  3409. $bResult = (count($aErrors) == 0);
  3410. if ($bResult)
  3411. {
  3412. list($bResult, $aErrors) = $oObj->CheckToWrite(true /* Enforce Read-only fields */);
  3413. }
  3414. if ($bPreview)
  3415. {
  3416. $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusOk') : Dict::S('UI:BulkModifyStatusError');
  3417. }
  3418. else
  3419. {
  3420. $sStatus = $bResult ? Dict::S('UI:BulkModifyStatusModified') : Dict::S('UI:BulkModifyStatusSkipped');
  3421. }
  3422. $sCSSClass = $bResult ? HILIGHT_CLASS_NONE : HILIGHT_CLASS_CRITICAL;
  3423. $sChecked = $bResult ? 'checked' : '';
  3424. $sDisabled = $bResult ? '' : 'disabled';
  3425. $aRows[] = array(
  3426. 'form::select' => "<input type=\"checkbox\" class=\"selectList\" $sChecked $sDisabled\"></input>",
  3427. 'object' => $oObj->GetHyperlink(),
  3428. 'status' => $sStatus,
  3429. 'errors' => '<p>'.($bResult ? '': implode('</p><p>', $aErrors)).'</p>',
  3430. '@class' => $sCSSClass,
  3431. );
  3432. if ($bResult && (!$bPreview))
  3433. {
  3434. $oObj->DBUpdate();
  3435. }
  3436. }
  3437. set_time_limit($iPreviousTimeLimit);
  3438. $oP->Table($aHeaders, $aRows);
  3439. if ($bPreview)
  3440. {
  3441. $sFormAction = $_SERVER['SCRIPT_NAME']; // No parameter in the URL, the only parameter will be the ones passed through the form
  3442. // Form to submit:
  3443. $oP->add("<form method=\"post\" action=\"$sFormAction\" enctype=\"multipart/form-data\">\n");
  3444. $aDefaults = utils::ReadParam('default', array());
  3445. $oAppContext = new ApplicationContext();
  3446. $oP->add($oAppContext->GetForForm());
  3447. foreach ($aContextData as $sKey => $value)
  3448. {
  3449. $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
  3450. }
  3451. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
  3452. $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  3453. $oP->add("<input type=\"hidden\" name=\"preview_mode\" value=\"0\">\n");
  3454. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  3455. $oP->add("<button type=\"button\" class=\"action cancel\" onClick=\"window.location.href='$sCancelUrl'\">".Dict::S('UI:Button:Cancel')."</button>&nbsp;&nbsp;&nbsp;&nbsp;\n");
  3456. $oP->add("<button type=\"submit\" class=\"action\"><span>".Dict::S('UI:Button:ModifyAll')."</span></button>\n");
  3457. foreach($_POST as $sKey => $value)
  3458. {
  3459. if (preg_match('/attr_(.+)/', $sKey, $aMatches))
  3460. {
  3461. // Beware: some values (like durations) are passed as arrays
  3462. if (is_array($value))
  3463. {
  3464. foreach($value as $vKey => $vValue)
  3465. {
  3466. $oP->add("<input type=\"hidden\" name=\"{$sKey}[$vKey]\" value=\"".htmlentities($vValue, ENT_QUOTES, 'UTF-8')."\">\n");
  3467. }
  3468. }
  3469. else
  3470. {
  3471. $oP->add("<input type=\"hidden\" name=\"$sKey\" value=\"".htmlentities($value, ENT_QUOTES, 'UTF-8')."\">\n");
  3472. }
  3473. }
  3474. }
  3475. $oP->add("</form>\n");
  3476. }
  3477. else
  3478. {
  3479. $oP->add("<button type=\"button\" onClick=\"window.location.href='$sCancelUrl'\" class=\"action\"><span>".Dict::S('UI:Button:Done')."</span></button>\n");
  3480. }
  3481. }
  3482. /**
  3483. * Perform all the needed checks to delete one (or more) objects
  3484. */
  3485. public static function DeleteObjects(WebPage $oP, $sClass, $aObjects, $bPreview, $sCustomOperation, $aContextData = array())
  3486. {
  3487. $oDeletionPlan = new DeletionPlan();
  3488. foreach($aObjects as $oObj)
  3489. {
  3490. if ($bPreview)
  3491. {
  3492. $oObj->CheckToDelete($oDeletionPlan);
  3493. }
  3494. else
  3495. {
  3496. $oObj->DBDeleteTracked(CMDBObject::GetCurrentChange(), null, $oDeletionPlan);
  3497. }
  3498. }
  3499. if ($bPreview)
  3500. {
  3501. if (count($aObjects) == 1)
  3502. {
  3503. $oObj = $aObjects[0];
  3504. $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Name', $oObj->GetName())."</h1>\n");
  3505. }
  3506. else
  3507. {
  3508. $oP->add("<h1>".Dict::Format('UI:Delete:ConfirmDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
  3509. }
  3510. // Explain what should be done
  3511. //
  3512. $aDisplayData = array();
  3513. foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
  3514. {
  3515. foreach ($aDeletes as $iId => $aData)
  3516. {
  3517. $oToDelete = $aData['to_delete'];
  3518. $bAutoDel = (($aData['mode'] == DEL_SILENT) || ($aData['mode'] == DEL_AUTO));
  3519. if (array_key_exists('issue', $aData))
  3520. {
  3521. if ($bAutoDel)
  3522. {
  3523. if (isset($aData['requested_explicitely']))
  3524. {
  3525. $sConsequence = Dict::Format('UI:Delete:CannotDeleteBecause', $aData['issue']);
  3526. }
  3527. else
  3528. {
  3529. $sConsequence = Dict::Format('UI:Delete:ShouldBeDeletedAtomaticallyButNotPossible', $aData['issue']);
  3530. }
  3531. }
  3532. else
  3533. {
  3534. $sConsequence = Dict::Format('UI:Delete:MustBeDeletedManuallyButNotPossible', $aData['issue']);
  3535. }
  3536. }
  3537. else
  3538. {
  3539. if ($bAutoDel)
  3540. {
  3541. if (isset($aData['requested_explicitely']))
  3542. {
  3543. $sConsequence = ''; // not applicable
  3544. }
  3545. else
  3546. {
  3547. $sConsequence = Dict::S('UI:Delete:WillBeDeletedAutomatically');
  3548. }
  3549. }
  3550. else
  3551. {
  3552. $sConsequence = Dict::S('UI:Delete:MustBeDeletedManually');
  3553. }
  3554. }
  3555. $aDisplayData[] = array(
  3556. 'class' => MetaModel::GetName(get_class($oToDelete)),
  3557. 'object' => $oToDelete->GetHyperLink(),
  3558. 'consequence' => $sConsequence,
  3559. );
  3560. }
  3561. }
  3562. foreach ($oDeletionPlan->ListUpdates() as $sRemoteClass => $aToUpdate)
  3563. {
  3564. foreach ($aToUpdate as $iId => $aData)
  3565. {
  3566. $oToUpdate = $aData['to_reset'];
  3567. if (array_key_exists('issue', $aData))
  3568. {
  3569. $sConsequence = Dict::Format('UI:Delete:CannotUpdateBecause_Issue', $aData['issue']);
  3570. }
  3571. else
  3572. {
  3573. $sConsequence = Dict::Format('UI:Delete:WillAutomaticallyUpdate_Fields', $aData['attributes_list']);
  3574. }
  3575. $aDisplayData[] = array(
  3576. 'class' => MetaModel::GetName(get_class($oToUpdate)),
  3577. 'object' => $oToUpdate->GetHyperLink(),
  3578. 'consequence' => $sConsequence,
  3579. );
  3580. }
  3581. }
  3582. $iImpactedIndirectly = $oDeletionPlan->GetTargetCount() - count($aObjects);
  3583. if ($iImpactedIndirectly > 0)
  3584. {
  3585. if (count($aObjects) == 1)
  3586. {
  3587. $oObj = $aObjects[0];
  3588. $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencing_Object', $iImpactedIndirectly, $oObj->GetName()));
  3589. }
  3590. else
  3591. {
  3592. $oP->p(Dict::Format('UI:Delete:Count_Objects/LinksReferencingTheObjects', $iImpactedIndirectly));
  3593. }
  3594. $oP->p(Dict::S('UI:Delete:ReferencesMustBeDeletedToEnsureIntegrity'));
  3595. }
  3596. if (($iImpactedIndirectly > 0) || $oDeletionPlan->FoundStopper())
  3597. {
  3598. $aDisplayConfig = array();
  3599. $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
  3600. $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
  3601. $aDisplayConfig['consequence'] = array('label' => 'Consequence', 'description' => Dict::S('UI:Delete:Consequence+'));
  3602. $oP->table($aDisplayConfig, $aDisplayData);
  3603. }
  3604. if ($oDeletionPlan->FoundStopper())
  3605. {
  3606. if ($oDeletionPlan->FoundSecurityIssue())
  3607. {
  3608. $oP->p(Dict::S('UI:Delete:SorryDeletionNotAllowed'));
  3609. }
  3610. elseif ($oDeletionPlan->FoundManualOperation())
  3611. {
  3612. $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
  3613. }
  3614. else // $bFoundManualOp
  3615. {
  3616. $oP->p(Dict::S('UI:Delete:PleaseDoTheManualOperations'));
  3617. }
  3618. $oAppContext = new ApplicationContext();
  3619. $oP->add("<form method=\"post\">\n");
  3620. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::ReadParam('transaction_id')."\">\n");
  3621. $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
  3622. $oP->add("<input DISABLED type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
  3623. $oP->add($oAppContext->GetForForm());
  3624. $oP->add("</form>\n");
  3625. }
  3626. else
  3627. {
  3628. if (count($aObjects) == 1)
  3629. {
  3630. $oObj = $aObjects[0];
  3631. $id = $oObj->GetKey();
  3632. $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Object', $oObj->GetHyperLink()).'</h1>');
  3633. }
  3634. else
  3635. {
  3636. $oP->p('<h1>'.Dict::Format('UI:Delect:Confirm_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)).'</h1>');
  3637. }
  3638. foreach($aObjects as $oObj)
  3639. {
  3640. $aKeys[] = $oObj->GetKey();
  3641. }
  3642. $oFilter = new DBObjectSearch($sClass);
  3643. $oFilter->AddCondition('id', $aKeys, 'IN');
  3644. $oSet = new CMDBobjectSet($oFilter);
  3645. $oP->add('<div id="0">');
  3646. CMDBAbstractObject::DisplaySet($oP, $oSet, array('display_limit' => false, 'menu' => false));
  3647. $oP->add("</div>\n");
  3648. $oP->add("<form method=\"post\">\n");
  3649. foreach ($aContextData as $sKey => $value)
  3650. {
  3651. $oP->add("<input type=\"hidden\" name=\"{$sKey}\" value=\"$value\">\n");
  3652. }
  3653. $oP->add("<input type=\"hidden\" name=\"transaction_id\" value=\"".utils::GetNewTransactionId()."\">\n");
  3654. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sCustomOperation\">\n");
  3655. $oP->add("<input type=\"hidden\" name=\"filter\" value=\"".$oFilter->Serialize()."\">\n");
  3656. $oP->add("<input type=\"hidden\" name=\"class\" value=\"$sClass\">\n");
  3657. foreach($aObjects as $oObj)
  3658. {
  3659. $oP->add("<input type=\"hidden\" name=\"selectObject[]\" value=\"".$oObj->GetKey()."\">\n");
  3660. }
  3661. $oP->add("<input type=\"button\" onclick=\"window.history.back();\" value=\"".Dict::S('UI:Button:Back')."\">\n");
  3662. $oP->add("<input type=\"submit\" name=\"\" value=\"".Dict::S('UI:Button:Delete')."\">\n");
  3663. $oAppContext = new ApplicationContext();
  3664. $oP->add($oAppContext->GetForForm());
  3665. $oP->add("</form>\n");
  3666. }
  3667. }
  3668. else // if ($bPreview)...
  3669. {
  3670. // Execute the deletion
  3671. //
  3672. if (count($aObjects) == 1)
  3673. {
  3674. $oObj = $aObjects[0];
  3675. $oP->add("<h1>".Dict::Format('UI:Title:DeletionOf_Object', $oObj->GetName())."</h1>\n");
  3676. }
  3677. else
  3678. {
  3679. $oP->add("<h1>".Dict::Format('UI:Title:BulkDeletionOf_Count_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass))."</h1>\n");
  3680. }
  3681. // Security - do not allow the user to force a forbidden delete by the mean of page arguments...
  3682. if ($oDeletionPlan->FoundSecurityIssue())
  3683. {
  3684. throw new CoreException(Dict::S('UI:Error:NotEnoughRightsToDelete'));
  3685. }
  3686. if ($oDeletionPlan->FoundManualOperation())
  3687. {
  3688. throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseManualOpNeeded'));
  3689. }
  3690. if ($oDeletionPlan->FoundManualDelete())
  3691. {
  3692. throw new CoreException(Dict::S('UI:Error:CannotDeleteBecauseOfDepencies'));
  3693. }
  3694. // Report deletions
  3695. //
  3696. $aDisplayData = array();
  3697. foreach ($oDeletionPlan->ListDeletes() as $sTargetClass => $aDeletes)
  3698. {
  3699. foreach ($aDeletes as $iId => $aData)
  3700. {
  3701. $oToDelete = $aData['to_delete'];
  3702. if (isset($aData['requested_explicitely']))
  3703. {
  3704. $sMessage = Dict::S('UI:Delete:Deleted');
  3705. }
  3706. else
  3707. {
  3708. $sMessage = Dict::S('UI:Delete:AutomaticallyDeleted');
  3709. }
  3710. $aDisplayData[] = array(
  3711. 'class' => MetaModel::GetName(get_class($oToDelete)),
  3712. 'object' => $oToDelete->GetName(),
  3713. 'consequence' => $sMessage,
  3714. );
  3715. }
  3716. }
  3717. // Report updates
  3718. //
  3719. foreach ($oDeletionPlan->ListUpdates() as $sTargetClass => $aToUpdate)
  3720. {
  3721. foreach ($aToUpdate as $iId => $aData)
  3722. {
  3723. $oToUpdate = $aData['to_reset'];
  3724. $aDisplayData[] = array(
  3725. 'class' => MetaModel::GetName(get_class($oToUpdate)),
  3726. 'object' => $oToUpdate->GetHyperLink(),
  3727. 'consequence' => Dict::Format('UI:Delete:AutomaticResetOf_Fields', $aData['attributes_list']),
  3728. );
  3729. }
  3730. }
  3731. // Report automatic jobs
  3732. //
  3733. if ($oDeletionPlan->GetTargetCount() > 0)
  3734. {
  3735. if (count($aObjects) == 1)
  3736. {
  3737. $oObj = $aObjects[0];
  3738. $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Object', $oObj->GetName()));
  3739. }
  3740. else
  3741. {
  3742. $oP->p(Dict::Format('UI:Delete:CleaningUpRefencesTo_Several_ObjectsOf_Class', count($aObjects), MetaModel::GetName($sClass)));
  3743. }
  3744. $aDisplayConfig = array();
  3745. $aDisplayConfig['class'] = array('label' => 'Class', 'description' => '');
  3746. $aDisplayConfig['object'] = array('label' => 'Object', 'description' => '');
  3747. $aDisplayConfig['consequence'] = array('label' => 'Done', 'description' => Dict::S('UI:Delete:Done+'));
  3748. $oP->table($aDisplayConfig, $aDisplayData);
  3749. }
  3750. }
  3751. }
  3752. /**
  3753. * Find redundancy settings that can be viewed and modified in a tab
  3754. * Settings are distributed to the corresponding link set attribute so as to be shown in the relevant tab
  3755. */
  3756. protected function FindVisibleRedundancySettings()
  3757. {
  3758. $aRet = array();
  3759. foreach (MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode => $oAttDef)
  3760. {
  3761. if ($oAttDef instanceof AttributeRedundancySettings)
  3762. {
  3763. if ($oAttDef->IsVisible())
  3764. {
  3765. $aQueryInfo = $oAttDef->GetRelationQueryData();
  3766. if (isset($aQueryInfo['sAttribute']))
  3767. {
  3768. $oUpperAttDef = MetaModel::GetAttributeDef($aQueryInfo['sFromClass'], $aQueryInfo['sAttribute']);
  3769. $oHostAttDef = $oUpperAttDef->GetMirrorLinkAttribute();
  3770. if ($oHostAttDef)
  3771. {
  3772. $sHostAttCode = $oHostAttDef->GetCode();
  3773. $aRet[$sHostAttCode][] = $oAttDef;
  3774. }
  3775. }
  3776. }
  3777. }
  3778. }
  3779. return $aRet;
  3780. }
  3781. /**
  3782. * Generates the javascript code handle the "watchdog" associated with the concurrent access locking mechanism
  3783. * @param Webpage $oPage
  3784. * @param string $sOwnershipToken
  3785. */
  3786. protected function GetOwnershipJSHandler($oPage, $sOwnershipToken)
  3787. {
  3788. $iInterval = max(MIN_WATCHDOG_INTERVAL, MetaModel::GetConfig()->Get('concurrent_lock_expiration_delay')) * 1000 / 2; // Minimum interval for the watchdog is MIN_WATCHDOG_INTERVAL
  3789. $sJSClass = json_encode(get_class($this));
  3790. $iKey = (int) $this->GetKey();
  3791. $sJSToken = json_encode($sOwnershipToken);
  3792. $sJSTitle = json_encode(Dict::S('UI:DisconnectedDlgTitle'));
  3793. $sJSOk = json_encode(Dict::S('UI:Button:Ok'));
  3794. $oPage->add_ready_script(
  3795. <<<EOF
  3796. window.setInterval(function() {
  3797. $.post(GetAbsoluteUrlAppRoot()+'pages/ajax.render.php', {operation: 'extend_lock', obj_class: $sJSClass, obj_key: $iKey, token: $sJSToken }, function(data) {
  3798. if (!data.status)
  3799. {
  3800. if ($('.lock_owned').length == 0)
  3801. {
  3802. $('.ui-layout-content').prepend('<div class="header_message message_error lock_owned">'+data.message+'</div>');
  3803. $('<div>'+data.popup_message+'</div>').dialog({title: $sJSTitle, modal: true, autoOpen: true, buttons:[ {text: $sJSOk, click: function() { $(this).dialog('close'); } }], close: function() { $(this).remove(); }});
  3804. }
  3805. $('.wizContainer form button.action:not(.cancel)').attr('disabled', 'disabled');
  3806. }
  3807. else if ((data.operation == 'lost') || (data.operation == 'expired'))
  3808. {
  3809. if ($('.lock_owned').length == 0)
  3810. {
  3811. $('.ui-layout-content').prepend('<div class="header_message message_error lock_owned">'+data.message+'</div>');
  3812. $('<div>'+data.popup_message+'</div>').dialog({title: $sJSTitle, modal: true, autoOpen: true, buttons:[ {text: $sJSOk, click: function() { $(this).dialog('close'); } }], close: function() { $(this).remove(); }});
  3813. }
  3814. $('.wizContainer form button.action:not(.cancel)').attr('disabled', 'disabled');
  3815. }
  3816. }, 'json');
  3817. }, $iInterval);
  3818. EOF
  3819. );
  3820. }
  3821. }