cmdbabstract.class.inc.php 151 KB

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