cmdbabstract.class.inc.php 154 KB

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