metamodel.class.php 163 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. require_once(APPROOT.'core/modulehandler.class.inc.php');
  17. require_once(APPROOT.'core/querybuildercontext.class.inc.php');
  18. require_once(APPROOT.'core/querymodifier.class.inc.php');
  19. require_once(APPROOT.'core/metamodelmodifier.inc.php');
  20. require_once(APPROOT.'core/computing.inc.php');
  21. /**
  22. * Metamodel
  23. *
  24. * @author Erwan Taloc <erwan.taloc@combodo.com>
  25. * @author Romain Quetiez <romain.quetiez@combodo.com>
  26. * @author Denis Flaven <denis.flaven@combodo.com>
  27. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  28. */
  29. // #@# todo: change into class const (see Doctrine)
  30. // Doctrine example
  31. // class toto
  32. // {
  33. // /**
  34. // * VERSION
  35. // */
  36. // const VERSION = '1.0.0';
  37. // }
  38. /**
  39. * add some description here...
  40. *
  41. * @package iTopORM
  42. */
  43. define('ENUM_CHILD_CLASSES_EXCLUDETOP', 1);
  44. /**
  45. * add some description here...
  46. *
  47. * @package iTopORM
  48. */
  49. define('ENUM_CHILD_CLASSES_ALL', 2);
  50. /**
  51. * add some description here...
  52. *
  53. * @package iTopORM
  54. */
  55. define('ENUM_PARENT_CLASSES_EXCLUDELEAF', 1);
  56. /**
  57. * add some description here...
  58. *
  59. * @package iTopORM
  60. */
  61. define('ENUM_PARENT_CLASSES_ALL', 2);
  62. /**
  63. * Specifies that this attribute is visible/editable.... normal (default config)
  64. *
  65. * @package iTopORM
  66. */
  67. define('OPT_ATT_NORMAL', 0);
  68. /**
  69. * Specifies that this attribute is hidden in that state
  70. *
  71. * @package iTopORM
  72. */
  73. define('OPT_ATT_HIDDEN', 1);
  74. /**
  75. * Specifies that this attribute is not editable in that state
  76. *
  77. * @package iTopORM
  78. */
  79. define('OPT_ATT_READONLY', 2);
  80. /**
  81. * Specifieds that the attribute must be set (different than default value?) when arriving into that state
  82. *
  83. * @package iTopORM
  84. */
  85. define('OPT_ATT_MANDATORY', 4);
  86. /**
  87. * Specifies that the attribute must change when arriving into that state
  88. *
  89. * @package iTopORM
  90. */
  91. define('OPT_ATT_MUSTCHANGE', 8);
  92. /**
  93. * Specifies that the attribute must be proposed when arriving into that state
  94. *
  95. * @package iTopORM
  96. */
  97. define('OPT_ATT_MUSTPROMPT', 16);
  98. /**
  99. * Specifies that the attribute is in 'slave' mode compared to one data exchange task:
  100. * it should not be edited inside iTop anymore
  101. *
  102. * @package iTopORM
  103. */
  104. define('OPT_ATT_SLAVE', 32);
  105. /**
  106. * DB Engine -should be moved into CMDBSource
  107. *
  108. * @package iTopORM
  109. */
  110. define('MYSQL_ENGINE', 'innodb');
  111. //define('MYSQL_ENGINE', 'myisam');
  112. /**
  113. * (API) The objects definitions as well as their mapping to the database
  114. *
  115. * @package iTopORM
  116. */
  117. abstract class MetaModel
  118. {
  119. ///////////////////////////////////////////////////////////////////////////
  120. //
  121. // STATIC Members
  122. //
  123. ///////////////////////////////////////////////////////////////////////////
  124. private static $m_bTraceSourceFiles = false;
  125. private static $m_aClassToFile = array();
  126. public static function GetClassFiles()
  127. {
  128. return self::$m_aClassToFile;
  129. }
  130. // Purpose: workaround the following limitation = PHP5 does not allow to know the class (derived from the current one)
  131. // from which a static function is called (__CLASS__ and self are interpreted during parsing)
  132. private static function GetCallersPHPClass($sExpectedFunctionName = null, $bRecordSourceFile = false)
  133. {
  134. //var_dump(debug_backtrace());
  135. $aBacktrace = debug_backtrace();
  136. // $aBacktrace[0] is where we are
  137. // $aBacktrace[1] is the caller of GetCallersPHPClass
  138. // $aBacktrace[1] is the info we want
  139. if (!empty($sExpectedFunctionName))
  140. {
  141. assert('$aBacktrace[2]["function"] == $sExpectedFunctionName');
  142. }
  143. if ($bRecordSourceFile)
  144. {
  145. self::$m_aClassToFile[$aBacktrace[2]["class"]] = $aBacktrace[1]["file"];
  146. }
  147. return $aBacktrace[2]["class"];
  148. }
  149. // Static init -why and how it works
  150. //
  151. // We found the following limitations:
  152. //- it is not possible to define non scalar constants
  153. //- it is not possible to declare a static variable as '= new myclass()'
  154. // Then we had do propose this model, in which a derived (non abstract)
  155. // class should implement Init(), to call InheritAttributes or AddAttribute.
  156. private static function _check_subclass($sClass)
  157. {
  158. // See also IsValidClass()... ???? #@#
  159. // class is mandatory
  160. // (it is not possible to guess it when called as myderived::...)
  161. if (!array_key_exists($sClass, self::$m_aClassParams))
  162. {
  163. throw new CoreException("Unknown class '$sClass', expected a value in {".implode(', ', array_keys(self::$m_aClassParams))."}");
  164. }
  165. }
  166. public static function static_var_dump()
  167. {
  168. var_dump(get_class_vars(__CLASS__));
  169. }
  170. private static $m_bDebugQuery = false;
  171. private static $m_iStackDepthRef = 0;
  172. public static function StartDebugQuery()
  173. {
  174. $aBacktrace = debug_backtrace();
  175. self::$m_iStackDepthRef = count($aBacktrace);
  176. self::$m_bDebugQuery = true;
  177. }
  178. public static function StopDebugQuery()
  179. {
  180. self::$m_bDebugQuery = false;
  181. }
  182. public static function DbgTrace($value)
  183. {
  184. if (!self::$m_bDebugQuery) return;
  185. $aBacktrace = debug_backtrace();
  186. $iCallStackPos = count($aBacktrace) - self::$m_bDebugQuery;
  187. $sIndent = "";
  188. for ($i = 0 ; $i < $iCallStackPos ; $i++)
  189. {
  190. $sIndent .= " .-=^=-. ";
  191. }
  192. $aCallers = array();
  193. foreach($aBacktrace as $aStackInfo)
  194. {
  195. $aCallers[] = $aStackInfo["function"];
  196. }
  197. $sCallers = "Callstack: ".implode(', ', $aCallers);
  198. $sFunction = "<b title=\"$sCallers\">".$aBacktrace[1]["function"]."</b>";
  199. if (is_string($value))
  200. {
  201. echo "$sIndent$sFunction: $value<br/>\n";
  202. }
  203. else if (is_object($value))
  204. {
  205. echo "$sIndent$sFunction:\n<pre>\n";
  206. print_r($value);
  207. echo "</pre>\n";
  208. }
  209. else
  210. {
  211. echo "$sIndent$sFunction: $value<br/>\n";
  212. }
  213. }
  214. private static $m_oConfig = null;
  215. private static $m_bSkipCheckToWrite = false;
  216. private static $m_bSkipCheckExtKeys = false;
  217. private static $m_bUseAPCCache = false;
  218. private static $m_iQueryCacheTTL = 3600;
  219. private static $m_bQueryCacheEnabled = false;
  220. private static $m_bTraceQueries = false;
  221. private static $m_aQueriesLog = array();
  222. private static $m_bLogIssue = false;
  223. private static $m_bLogNotification = false;
  224. private static $m_bLogWebService = false;
  225. public static function SkipCheckToWrite()
  226. {
  227. return self::$m_bSkipCheckToWrite;
  228. }
  229. public static function SkipCheckExtKeys()
  230. {
  231. return self::$m_bSkipCheckExtKeys;
  232. }
  233. public static function IsLogEnabledIssue()
  234. {
  235. return self::$m_bLogIssue;
  236. }
  237. public static function IsLogEnabledNotification()
  238. {
  239. return self::$m_bLogNotification;
  240. }
  241. public static function IsLogEnabledWebService()
  242. {
  243. return self::$m_bLogWebService;
  244. }
  245. private static $m_sDBName = "";
  246. private static $m_sTablePrefix = ""; // table prefix for the current application instance (allow several applications on the same DB)
  247. private static $m_Category2Class = array();
  248. private static $m_aRootClasses = array(); // array of "classname" => "rootclass"
  249. private static $m_aParentClasses = array(); // array of ("classname" => array of "parentclass")
  250. private static $m_aChildClasses = array(); // array of ("classname" => array of "childclass")
  251. private static $m_aClassParams = array(); // array of ("classname" => array of class information)
  252. static public function GetParentPersistentClass($sRefClass)
  253. {
  254. $sClass = get_parent_class($sRefClass);
  255. if (!$sClass) return '';
  256. if ($sClass == 'DBObject') return ''; // Warning: __CLASS__ is lower case in my version of PHP
  257. // Note: the UI/business model may implement pure PHP classes (intermediate layers)
  258. if (array_key_exists($sClass, self::$m_aClassParams))
  259. {
  260. return $sClass;
  261. }
  262. return self::GetParentPersistentClass($sClass);
  263. }
  264. final static public function GetName($sClass)
  265. {
  266. self::_check_subclass($sClass);
  267. $sStringCode = 'Class:'.$sClass;
  268. return Dict::S($sStringCode, str_replace('_', ' ', $sClass));
  269. }
  270. final static public function GetName_Obsolete($sClass)
  271. {
  272. // Written for compatibility with a data model written prior to version 0.9.1
  273. self::_check_subclass($sClass);
  274. if (array_key_exists('name', self::$m_aClassParams[$sClass]))
  275. {
  276. return self::$m_aClassParams[$sClass]['name'];
  277. }
  278. else
  279. {
  280. return self::GetName($sClass);
  281. }
  282. }
  283. final static public function GetClassFromLabel($sClassLabel, $bCaseSensitive = true)
  284. {
  285. foreach(self::GetClasses() as $sClass)
  286. {
  287. if ($bCaseSensitive)
  288. {
  289. if (self::GetName($sClass) == $sClassLabel)
  290. {
  291. return $sClass;
  292. }
  293. }
  294. else
  295. {
  296. if (strcasecmp(self::GetName($sClass), $sClassLabel) == 0)
  297. {
  298. return $sClass;
  299. }
  300. }
  301. }
  302. return null;
  303. }
  304. final static public function GetCategory($sClass)
  305. {
  306. self::_check_subclass($sClass);
  307. return self::$m_aClassParams[$sClass]["category"];
  308. }
  309. final static public function HasCategory($sClass, $sCategory)
  310. {
  311. self::_check_subclass($sClass);
  312. return (strpos(self::$m_aClassParams[$sClass]["category"], $sCategory) !== false);
  313. }
  314. final static public function GetClassDescription($sClass)
  315. {
  316. self::_check_subclass($sClass);
  317. $sStringCode = 'Class:'.$sClass.'+';
  318. return Dict::S($sStringCode, '');
  319. }
  320. final static public function GetClassDescription_Obsolete($sClass)
  321. {
  322. // Written for compatibility with a data model written prior to version 0.9.1
  323. self::_check_subclass($sClass);
  324. if (array_key_exists('description', self::$m_aClassParams[$sClass]))
  325. {
  326. return self::$m_aClassParams[$sClass]['description'];
  327. }
  328. else
  329. {
  330. return self::GetClassDescription($sClass);
  331. }
  332. }
  333. final static public function GetClassIcon($sClass, $bImgTag = true, $sMoreStyles = '')
  334. {
  335. self::_check_subclass($sClass);
  336. $sIcon = '';
  337. if (array_key_exists('icon', self::$m_aClassParams[$sClass]))
  338. {
  339. $sIcon = self::$m_aClassParams[$sClass]['icon'];
  340. }
  341. if (strlen($sIcon) == 0)
  342. {
  343. $sParentClass = self::GetParentPersistentClass($sClass);
  344. if (strlen($sParentClass) > 0)
  345. {
  346. return self::GetClassIcon($sParentClass, $bImgTag, $sMoreStyles);
  347. }
  348. }
  349. if ($bImgTag && ($sIcon != ''))
  350. {
  351. $sIcon = "<img src=\"$sIcon\" style=\"vertical-align:middle;$sMoreStyles\"/>";
  352. }
  353. return $sIcon;
  354. }
  355. final static public function IsAutoIncrementKey($sClass)
  356. {
  357. self::_check_subclass($sClass);
  358. return (self::$m_aClassParams[$sClass]["key_type"] == "autoincrement");
  359. }
  360. final static public function GetNameSpec($sClass)
  361. {
  362. self::_check_subclass($sClass);
  363. $nameRawSpec = self::$m_aClassParams[$sClass]["name_attcode"];
  364. if (is_array($nameRawSpec))
  365. {
  366. $sFormat = Dict::S("Class:$sClass/Name", '');
  367. if (strlen($sFormat) == 0)
  368. {
  369. // Default to "%1$s %2$s..."
  370. for($i = 1 ; $i <= count($nameRawSpec) ; $i++)
  371. {
  372. if (empty($sFormat))
  373. {
  374. $sFormat .= '%'.$i.'$s';
  375. }
  376. else
  377. {
  378. $sFormat .= ' %'.$i.'$s';
  379. }
  380. }
  381. }
  382. return array($sFormat, $nameRawSpec);
  383. }
  384. elseif (empty($nameRawSpec))
  385. {
  386. //return array($sClass.' %s', array('id'));
  387. return array($sClass, array());
  388. }
  389. else
  390. {
  391. // string -> attcode
  392. return array('%1$s', array($nameRawSpec));
  393. }
  394. }
  395. final static public function GetNameExpression($sClass, $sClassAlias)
  396. {
  397. $aNameSpec = self::GetNameSpec($sClass);
  398. $sFormat = $aNameSpec[0];
  399. $aAttributes = $aNameSpec[1];
  400. $aPieces = preg_split('/%([0-9])\\$s/', $sFormat, -1, PREG_SPLIT_DELIM_CAPTURE);
  401. //echo "<pre>\n";
  402. //print_r($aPieces);
  403. //echo "</pre>\n";
  404. $aExpressions = array();
  405. foreach($aPieces as $i => $sPiece)
  406. {
  407. if ($i & 1)
  408. {
  409. // $i is ODD - sPiece is a delimiter
  410. //
  411. $iReplacement = (int)$sPiece - 1;
  412. if (isset($aAttributes[$iReplacement]))
  413. {
  414. $sAtt = $aAttributes[$iReplacement];
  415. $aExpressions[] = new FieldExpression($sAtt, $sClassAlias);
  416. }
  417. }
  418. else
  419. {
  420. // $i is EVEN - sPiece is a literal
  421. //
  422. if (strlen($sPiece) > 0)
  423. {
  424. $aExpressions[] = new ScalarExpression($sPiece);
  425. }
  426. }
  427. }
  428. //echo "<pre>\n";
  429. //print_r($aExpressions);
  430. //echo "</pre>\n";
  431. $oNameExpr = new CharConcatExpression($aExpressions);
  432. return $oNameExpr;
  433. }
  434. final static public function GetStateAttributeCode($sClass)
  435. {
  436. self::_check_subclass($sClass);
  437. return self::$m_aClassParams[$sClass]["state_attcode"];
  438. }
  439. final static public function GetDefaultState($sClass)
  440. {
  441. $sDefaultState = '';
  442. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  443. if (!empty($sStateAttrCode))
  444. {
  445. $oStateAttrDef = self::GetAttributeDef($sClass, $sStateAttrCode);
  446. $sDefaultState = $oStateAttrDef->GetDefaultValue();
  447. }
  448. return $sDefaultState;
  449. }
  450. final static public function GetReconcKeys($sClass)
  451. {
  452. self::_check_subclass($sClass);
  453. return self::$m_aClassParams[$sClass]["reconc_keys"];
  454. }
  455. final static public function GetDisplayTemplate($sClass)
  456. {
  457. self::_check_subclass($sClass);
  458. return array_key_exists("display_template", self::$m_aClassParams[$sClass]) ? self::$m_aClassParams[$sClass]["display_template"]: '';
  459. }
  460. final static public function GetOrderByDefault($sClass, $bOnlyDeclared = false)
  461. {
  462. self::_check_subclass($sClass);
  463. $aOrderBy = array_key_exists("order_by_default", self::$m_aClassParams[$sClass]) ? self::$m_aClassParams[$sClass]["order_by_default"]: array();
  464. if ($bOnlyDeclared)
  465. {
  466. // Used to reverse engineer the declaration of the data model
  467. return $aOrderBy;
  468. }
  469. else
  470. {
  471. if (count($aOrderBy) == 0)
  472. {
  473. $aOrderBy['friendlyname'] = true;
  474. }
  475. return $aOrderBy;
  476. }
  477. }
  478. final static public function GetAttributeOrigin($sClass, $sAttCode)
  479. {
  480. self::_check_subclass($sClass);
  481. return self::$m_aAttribOrigins[$sClass][$sAttCode];
  482. }
  483. final static public function GetPrequisiteAttributes($sClass, $sAttCode)
  484. {
  485. self::_check_subclass($sClass);
  486. $oAtt = self::GetAttributeDef($sClass, $sAttCode);
  487. // Temporary implementation: later, we might be able to compute
  488. // the dependencies, based on the attributes definition
  489. // (allowed values and default values)
  490. if ($oAtt->IsWritable())
  491. {
  492. return $oAtt->GetPrerequisiteAttributes();
  493. }
  494. else
  495. {
  496. return array();
  497. }
  498. }
  499. /**
  500. * Find all attributes that depend on the specified one (reverse of GetPrequisiteAttributes)
  501. * @param string $sClass Name of the class
  502. * @param string $sAttCode Code of the attributes
  503. * @return Array List of attribute codes that depend on the given attribute, empty array if none.
  504. */
  505. final static public function GetDependentAttributes($sClass, $sAttCode)
  506. {
  507. $aResults = array();
  508. self::_check_subclass($sClass);
  509. foreach (self::ListAttributeDefs($sClass) as $sDependentAttCode=>$void)
  510. {
  511. $aPrerequisites = self::GetPrequisiteAttributes($sClass, $sDependentAttCode);
  512. if (in_array($sAttCode, $aPrerequisites))
  513. {
  514. $aResults[] = $sDependentAttCode;
  515. }
  516. }
  517. return $aResults;
  518. }
  519. // #@# restore to private ?
  520. final static public function DBGetTable($sClass, $sAttCode = null)
  521. {
  522. self::_check_subclass($sClass);
  523. if (empty($sAttCode) || ($sAttCode == "id"))
  524. {
  525. $sTableRaw = self::$m_aClassParams[$sClass]["db_table"];
  526. if (empty($sTableRaw))
  527. {
  528. // return an empty string whenever the table is undefined, meaning that there is no table associated to this 'abstract' class
  529. return '';
  530. }
  531. else
  532. {
  533. // If the format changes here, do not forget to update the setup index page (detection of installed modules)
  534. return self::$m_sTablePrefix.$sTableRaw;
  535. }
  536. }
  537. // This attribute has been inherited (compound objects)
  538. return self::DBGetTable(self::$m_aAttribOrigins[$sClass][$sAttCode]);
  539. }
  540. final static public function DBGetView($sClass)
  541. {
  542. return self::$m_sTablePrefix."view_".$sClass;
  543. }
  544. final static protected function DBEnumTables()
  545. {
  546. // This API does not rely on our capability to query the DB and retrieve
  547. // the list of existing tables
  548. // Rather, it uses the list of expected tables, corresponding to the data model
  549. $aTables = array();
  550. foreach (self::GetClasses() as $sClass)
  551. {
  552. if (!self::HasTable($sClass)) continue;
  553. $sTable = self::DBGetTable($sClass);
  554. // Could be completed later with all the classes that are using a given table
  555. if (!array_key_exists($sTable, $aTables))
  556. {
  557. $aTables[$sTable] = array();
  558. }
  559. $aTables[$sTable][] = $sClass;
  560. }
  561. return $aTables;
  562. }
  563. final static public function DBGetKey($sClass)
  564. {
  565. self::_check_subclass($sClass);
  566. return self::$m_aClassParams[$sClass]["db_key_field"];
  567. }
  568. final static public function DBGetClassField($sClass)
  569. {
  570. self::_check_subclass($sClass);
  571. return self::$m_aClassParams[$sClass]["db_finalclass_field"];
  572. }
  573. final static public function IsStandaloneClass($sClass)
  574. {
  575. self::_check_subclass($sClass);
  576. if (count(self::$m_aChildClasses[$sClass]) == 0)
  577. {
  578. if (count(self::$m_aParentClasses[$sClass]) == 0)
  579. {
  580. return true;
  581. }
  582. }
  583. return false;
  584. }
  585. final static public function IsParentClass($sParentClass, $sChildClass)
  586. {
  587. self::_check_subclass($sChildClass);
  588. self::_check_subclass($sParentClass);
  589. if (in_array($sParentClass, self::$m_aParentClasses[$sChildClass])) return true;
  590. if ($sChildClass == $sParentClass) return true;
  591. return false;
  592. }
  593. final static public function IsSameFamilyBranch($sClassA, $sClassB)
  594. {
  595. self::_check_subclass($sClassA);
  596. self::_check_subclass($sClassB);
  597. if (in_array($sClassA, self::$m_aParentClasses[$sClassB])) return true;
  598. if (in_array($sClassB, self::$m_aParentClasses[$sClassA])) return true;
  599. if ($sClassA == $sClassB) return true;
  600. return false;
  601. }
  602. final static public function IsSameFamily($sClassA, $sClassB)
  603. {
  604. self::_check_subclass($sClassA);
  605. self::_check_subclass($sClassB);
  606. return (self::GetRootClass($sClassA) == self::GetRootClass($sClassB));
  607. }
  608. // Attributes of a given class may contain attributes defined in a parent class
  609. // - Some attributes are a copy of the definition
  610. // - Some attributes correspond to the upper class table definition (compound objects)
  611. // (see also filters definition)
  612. private static $m_aAttribDefs = array(); // array of ("classname" => array of attributes)
  613. private static $m_aAttribOrigins = array(); // array of ("classname" => array of ("attcode"=>"sourceclass"))
  614. private static $m_aExtKeyFriends = array(); // array of ("classname" => array of ("indirect ext key attcode"=> array of ("relative ext field")))
  615. private static $m_aIgnoredAttributes = array(); //array of ("classname" => array of ("attcode")
  616. final static public function ListAttributeDefs($sClass)
  617. {
  618. self::_check_subclass($sClass);
  619. return self::$m_aAttribDefs[$sClass];
  620. }
  621. final public static function GetAttributesList($sClass)
  622. {
  623. self::_check_subclass($sClass);
  624. return array_keys(self::$m_aAttribDefs[$sClass]);
  625. }
  626. final public static function GetFiltersList($sClass)
  627. {
  628. self::_check_subclass($sClass);
  629. return array_keys(self::$m_aFilterDefs[$sClass]);
  630. }
  631. final public static function GetKeysList($sClass)
  632. {
  633. self::_check_subclass($sClass);
  634. $aExtKeys = array();
  635. foreach(self::$m_aAttribDefs[$sClass] as $sAttCode => $oAttDef)
  636. {
  637. if ($oAttDef->IsExternalKey())
  638. {
  639. $aExtKeys[] = $sAttCode;
  640. }
  641. }
  642. return $aExtKeys;
  643. }
  644. final static public function IsValidKeyAttCode($sClass, $sAttCode)
  645. {
  646. if (!array_key_exists($sClass, self::$m_aAttribDefs)) return false;
  647. if (!array_key_exists($sAttCode, self::$m_aAttribDefs[$sClass])) return false;
  648. return (self::$m_aAttribDefs[$sClass][$sAttCode]->IsExternalKey());
  649. }
  650. final static public function IsValidAttCode($sClass, $sAttCode, $bExtended = false)
  651. {
  652. if (!array_key_exists($sClass, self::$m_aAttribDefs)) return false;
  653. if ($bExtended)
  654. {
  655. if (($iPos = strpos($sAttCode, '->')) === false)
  656. {
  657. $bRes = array_key_exists($sAttCode, self::$m_aAttribDefs[$sClass]);
  658. }
  659. else
  660. {
  661. $sExtKeyAttCode = substr($sAttCode, 0, $iPos);
  662. $sRemoteAttCode = substr($sAttCode, $iPos + 2);
  663. if (MetaModel::IsValidAttCode($sClass, $sExtKeyAttCode))
  664. {
  665. $oKeyAttDef = MetaModel::GetAttributeDef($sClass, $sExtKeyAttCode);
  666. $sRemoteClass = $oKeyAttDef->GetTargetClass();
  667. $bRes = MetaModel::IsValidAttCode($sRemoteClass, $sRemoteAttCode, true);
  668. }
  669. else
  670. {
  671. $bRes = false;
  672. }
  673. }
  674. }
  675. else
  676. {
  677. $bRes = array_key_exists($sAttCode, self::$m_aAttribDefs[$sClass]);
  678. }
  679. return $bRes;
  680. }
  681. final static public function IsAttributeOrigin($sClass, $sAttCode)
  682. {
  683. return (self::$m_aAttribOrigins[$sClass][$sAttCode] == $sClass);
  684. }
  685. final static public function IsValidFilterCode($sClass, $sFilterCode)
  686. {
  687. if (!array_key_exists($sClass, self::$m_aFilterDefs)) return false;
  688. return (array_key_exists($sFilterCode, self::$m_aFilterDefs[$sClass]));
  689. }
  690. public static function IsValidClass($sClass)
  691. {
  692. return (array_key_exists($sClass, self::$m_aAttribDefs));
  693. }
  694. public static function IsValidObject($oObject)
  695. {
  696. if (!is_object($oObject)) return false;
  697. return (self::IsValidClass(get_class($oObject)));
  698. }
  699. public static function IsReconcKey($sClass, $sAttCode)
  700. {
  701. return (in_array($sAttCode, self::GetReconcKeys($sClass)));
  702. }
  703. final static public function GetAttributeDef($sClass, $sAttCode)
  704. {
  705. self::_check_subclass($sClass);
  706. return self::$m_aAttribDefs[$sClass][$sAttCode];
  707. }
  708. final static public function GetExternalKeys($sClass)
  709. {
  710. $aExtKeys = array();
  711. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  712. {
  713. if ($oAtt->IsExternalKey())
  714. {
  715. $aExtKeys[$sAttCode] = $oAtt;
  716. }
  717. }
  718. return $aExtKeys;
  719. }
  720. final static public function GetLinkedSets($sClass)
  721. {
  722. $aLinkedSets = array();
  723. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  724. {
  725. if (is_subclass_of($oAtt, 'AttributeLinkedSet'))
  726. {
  727. $aLinkedSets[$sAttCode] = $oAtt;
  728. }
  729. }
  730. return $aLinkedSets;
  731. }
  732. final static public function GetExternalFields($sClass, $sKeyAttCode)
  733. {
  734. $aExtFields = array();
  735. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  736. {
  737. if ($oAtt->IsExternalField() && ($oAtt->GetKeyAttCode() == $sKeyAttCode))
  738. {
  739. $aExtFields[] = $oAtt;
  740. }
  741. }
  742. return $aExtFields;
  743. }
  744. final static public function GetExtKeyFriends($sClass, $sExtKeyAttCode)
  745. {
  746. if (array_key_exists($sExtKeyAttCode, self::$m_aExtKeyFriends[$sClass]))
  747. {
  748. return self::$m_aExtKeyFriends[$sClass][$sExtKeyAttCode];
  749. }
  750. else
  751. {
  752. return array();
  753. }
  754. }
  755. public static function GetLabel($sClass, $sAttCode)
  756. {
  757. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  758. if ($oAttDef) return $oAttDef->GetLabel();
  759. return "";
  760. }
  761. public static function GetDescription($sClass, $sAttCode)
  762. {
  763. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  764. if ($oAttDef) return $oAttDef->GetDescription();
  765. return "";
  766. }
  767. // Filters of a given class may contain filters defined in a parent class
  768. // - Some filters are a copy of the definition
  769. // - Some filters correspond to the upper class table definition (compound objects)
  770. // (see also attributes definition)
  771. private static $m_aFilterDefs = array(); // array of ("classname" => array filterdef)
  772. private static $m_aFilterOrigins = array(); // array of ("classname" => array of ("attcode"=>"sourceclass"))
  773. public static function GetClassFilterDefs($sClass)
  774. {
  775. self::_check_subclass($sClass);
  776. return self::$m_aFilterDefs[$sClass];
  777. }
  778. final static public function GetClassFilterDef($sClass, $sFilterCode)
  779. {
  780. self::_check_subclass($sClass);
  781. if (!array_key_exists($sFilterCode, self::$m_aFilterDefs[$sClass]))
  782. {
  783. throw new CoreException("Unknown filter code '$sFilterCode' for class '$sClass'");
  784. }
  785. return self::$m_aFilterDefs[$sClass][$sFilterCode];
  786. }
  787. public static function GetFilterLabel($sClass, $sFilterCode)
  788. {
  789. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  790. if ($oFilter) return $oFilter->GetLabel();
  791. return "";
  792. }
  793. public static function GetFilterDescription($sClass, $sFilterCode)
  794. {
  795. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  796. if ($oFilter) return $oFilter->GetDescription();
  797. return "";
  798. }
  799. // returns an array of opcode=>oplabel (e.g. "differs from")
  800. public static function GetFilterOperators($sClass, $sFilterCode)
  801. {
  802. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  803. if ($oFilter) return $oFilter->GetOperators();
  804. return array();
  805. }
  806. // returns an opcode
  807. public static function GetFilterLooseOperator($sClass, $sFilterCode)
  808. {
  809. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  810. if ($oFilter) return $oFilter->GetLooseOperator();
  811. return array();
  812. }
  813. public static function GetFilterOpDescription($sClass, $sFilterCode, $sOpCode)
  814. {
  815. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  816. if ($oFilter) return $oFilter->GetOpDescription($sOpCode);
  817. return "";
  818. }
  819. public static function GetFilterHTMLInput($sFilterCode)
  820. {
  821. return "<INPUT name=\"$sFilterCode\">";
  822. }
  823. // Lists of attributes/search filters
  824. //
  825. private static $m_aListInfos = array(); // array of ("listcode" => various info on the list, common to every classes)
  826. private static $m_aListData = array(); // array of ("classname" => array of "listcode" => list)
  827. // list may be an array of attcode / fltcode
  828. // list may be an array of "groupname" => (array of attcode / fltcode)
  829. public static function EnumZLists()
  830. {
  831. return array_keys(self::$m_aListInfos);
  832. }
  833. final static public function GetZListInfo($sListCode)
  834. {
  835. return self::$m_aListInfos[$sListCode];
  836. }
  837. public static function GetZListItems($sClass, $sListCode)
  838. {
  839. if (array_key_exists($sClass, self::$m_aListData))
  840. {
  841. if (array_key_exists($sListCode, self::$m_aListData[$sClass]))
  842. {
  843. return self::$m_aListData[$sClass][$sListCode];
  844. }
  845. }
  846. $sParentClass = self::GetParentPersistentClass($sClass);
  847. if (empty($sParentClass)) return array(); // nothing for the mother of all classes
  848. // Dig recursively
  849. return self::GetZListItems($sParentClass, $sListCode);
  850. }
  851. public static function IsAttributeInZList($sClass, $sListCode, $sAttCodeOrFltCode, $sGroup = null)
  852. {
  853. $aZList = self::FlattenZlist(self::GetZListItems($sClass, $sListCode));
  854. if (!$sGroup)
  855. {
  856. return (in_array($sAttCodeOrFltCode, $aZList));
  857. }
  858. return (in_array($sAttCodeOrFltCode, $aZList[$sGroup]));
  859. }
  860. //
  861. // Relations
  862. //
  863. private static $m_aRelationInfos = array(); // array of ("relcode" => various info on the list, common to every classes)
  864. public static function EnumRelations($sClass = '')
  865. {
  866. $aResult = array_keys(self::$m_aRelationInfos);
  867. if (!empty($sClass))
  868. {
  869. // Return only the relations that have a meaning (i.e. for which at least one query is defined)
  870. // for the specified class
  871. $aClassRelations = array();
  872. foreach($aResult as $sRelCode)
  873. {
  874. $aQueries = self::EnumRelationQueries($sClass, $sRelCode);
  875. if (count($aQueries) > 0)
  876. {
  877. $aClassRelations[] = $sRelCode;
  878. }
  879. }
  880. return $aClassRelations;
  881. }
  882. return $aResult;
  883. }
  884. public static function EnumRelationProperties($sRelCode)
  885. {
  886. MyHelpers::CheckKeyInArray('relation code', $sRelCode, self::$m_aRelationInfos);
  887. return self::$m_aRelationInfos[$sRelCode];
  888. }
  889. final static public function GetRelationDescription($sRelCode)
  890. {
  891. return Dict::S("Relation:$sRelCode/Description");
  892. }
  893. final static public function GetRelationVerbUp($sRelCode)
  894. {
  895. return Dict::S("Relation:$sRelCode/VerbUp");
  896. }
  897. final static public function GetRelationVerbDown($sRelCode)
  898. {
  899. return Dict::S("Relation:$sRelCode/VerbDown");
  900. }
  901. public static function EnumRelationQueries($sClass, $sRelCode)
  902. {
  903. MyHelpers::CheckKeyInArray('relation code', $sRelCode, self::$m_aRelationInfos);
  904. return call_user_func_array(array($sClass, 'GetRelationQueries'), array($sRelCode));
  905. }
  906. //
  907. // Object lifecycle model
  908. //
  909. private static $m_aStates = array(); // array of ("classname" => array of "statecode"=>array('label'=>..., attribute_inherit=> attribute_list=>...))
  910. private static $m_aStimuli = array(); // array of ("classname" => array of ("stimuluscode"=>array('label'=>...)))
  911. private static $m_aTransitions = array(); // array of ("classname" => array of ("statcode_from"=>array of ("stimuluscode" => array('target_state'=>..., 'actions'=>array of handlers procs, 'user_restriction'=>TBD)))
  912. public static function EnumStates($sClass)
  913. {
  914. if (array_key_exists($sClass, self::$m_aStates))
  915. {
  916. return self::$m_aStates[$sClass];
  917. }
  918. else
  919. {
  920. return array();
  921. }
  922. }
  923. /*
  924. * Enumerate all possible initial states, including the default one
  925. */
  926. public static function EnumInitialStates($sClass)
  927. {
  928. if (array_key_exists($sClass, self::$m_aStates))
  929. {
  930. $aRet = array();
  931. // Add the states for which the flag 'is_initial_state' is set to <true>
  932. foreach(self::$m_aStates[$sClass] as $aStateCode => $aProps)
  933. {
  934. if (isset($aProps['initial_state_path']))
  935. {
  936. $aRet[$aStateCode] = $aProps['initial_state_path'];
  937. }
  938. }
  939. // Add the default initial state
  940. $sMainInitialState = self::GetDefaultState($sClass);
  941. if (!isset($aRet[$sMainInitialState]))
  942. {
  943. $aRet[$sMainInitialState] = array();
  944. }
  945. return $aRet;
  946. }
  947. else
  948. {
  949. return array();
  950. }
  951. }
  952. public static function EnumStimuli($sClass)
  953. {
  954. if (array_key_exists($sClass, self::$m_aStimuli))
  955. {
  956. return self::$m_aStimuli[$sClass];
  957. }
  958. else
  959. {
  960. return array();
  961. }
  962. }
  963. public static function GetStateLabel($sClass, $sStateValue)
  964. {
  965. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  966. $oAttDef = self::GetAttributeDef($sClass, $sStateAttrCode);
  967. return $oAttDef->GetValueLabel($sStateValue);
  968. }
  969. public static function GetStateDescription($sClass, $sStateValue)
  970. {
  971. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  972. $oAttDef = self::GetAttributeDef($sClass, $sStateAttrCode);
  973. return $oAttDef->GetValueDescription($sStateValue);
  974. }
  975. public static function EnumTransitions($sClass, $sStateCode)
  976. {
  977. if (array_key_exists($sClass, self::$m_aTransitions))
  978. {
  979. if (array_key_exists($sStateCode, self::$m_aTransitions[$sClass]))
  980. {
  981. return self::$m_aTransitions[$sClass][$sStateCode];
  982. }
  983. }
  984. return array();
  985. }
  986. public static function GetAttributeFlags($sClass, $sState, $sAttCode)
  987. {
  988. $iFlags = 0; // By default (if no life cycle) no flag at all
  989. $sStateAttCode = self::GetStateAttributeCode($sClass);
  990. if (!empty($sStateAttCode))
  991. {
  992. $aStates = MetaModel::EnumStates($sClass);
  993. if (!array_key_exists($sState, $aStates))
  994. {
  995. throw new CoreException("Invalid state '$sState' for class '$sClass', expecting a value in {".implode(', ', array_keys($aStates))."}");
  996. }
  997. $aCurrentState = $aStates[$sState];
  998. if ( (array_key_exists('attribute_list', $aCurrentState)) && (array_key_exists($sAttCode, $aCurrentState['attribute_list'])) )
  999. {
  1000. $iFlags = $aCurrentState['attribute_list'][$sAttCode];
  1001. }
  1002. }
  1003. return $iFlags;
  1004. }
  1005. /**
  1006. * Combines the flags from the all states that compose the initial_state_path
  1007. */
  1008. public static function GetInitialStateAttributeFlags($sClass, $sState, $sAttCode)
  1009. {
  1010. $iFlags = self::GetAttributeFlags($sClass, $sState, $sAttCode); // Be default set the same flags as the 'target' state
  1011. $sStateAttCode = self::GetStateAttributeCode($sClass);
  1012. if (!empty($sStateAttCode))
  1013. {
  1014. $aStates = MetaModel::EnumInitialStates($sClass);
  1015. if (array_key_exists($sState, $aStates))
  1016. {
  1017. $bReadOnly = (($iFlags & OPT_ATT_READONLY) == OPT_ATT_READONLY);
  1018. $bHidden = (($iFlags & OPT_ATT_HIDDEN) == OPT_ATT_HIDDEN);
  1019. foreach($aStates[$sState] as $sPrevState)
  1020. {
  1021. $iPrevFlags = self::GetAttributeFlags($sClass, $sPrevState, $sAttCode);
  1022. $bReadOnly = $bReadOnly && (($iPrevFlags & OPT_ATT_READONLY) == OPT_ATT_READONLY); // if it is/was not readonly => then it's not
  1023. $bHidden = $bHidden && (($iPrevFlags & OPT_ATT_HIDDEN) == OPT_ATT_HIDDEN); // if it is/was not hidden => then it's not
  1024. }
  1025. if ($bReadOnly)
  1026. {
  1027. $iFlags = $iFlags | OPT_ATT_READONLY;
  1028. }
  1029. else
  1030. {
  1031. $iFlags = $iFlags & ~OPT_ATT_READONLY;
  1032. }
  1033. if ($bHidden)
  1034. {
  1035. $iFlags = $iFlags | OPT_ATT_HIDDEN;
  1036. }
  1037. else
  1038. {
  1039. $iFlags = $iFlags & ~OPT_ATT_HIDDEN;
  1040. }
  1041. }
  1042. }
  1043. return $iFlags;
  1044. }
  1045. //
  1046. // Allowed values
  1047. //
  1048. public static function GetAllowedValues_att($sClass, $sAttCode, $aArgs = array(), $sContains = '')
  1049. {
  1050. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  1051. return $oAttDef->GetAllowedValues($aArgs, $sContains);
  1052. }
  1053. public static function GetAllowedValues_flt($sClass, $sFltCode, $aArgs = array(), $sContains = '')
  1054. {
  1055. $oFltDef = self::GetClassFilterDef($sClass, $sFltCode);
  1056. return $oFltDef->GetAllowedValues($aArgs, $sContains);
  1057. }
  1058. public static function GetAllowedValuesAsObjectSet($sClass, $sAttCode, $aArgs = array(), $sContains = '')
  1059. {
  1060. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  1061. return $oAttDef->GetAllowedValuesAsObjectSet($aArgs, $sContains);
  1062. }
  1063. //
  1064. // Businezz model declaration verbs (should be static)
  1065. //
  1066. public static function RegisterZList($sListCode, $aListInfo)
  1067. {
  1068. // Check mandatory params
  1069. $aMandatParams = array(
  1070. "description" => "detailed (though one line) description of the list",
  1071. "type" => "attributes | filters",
  1072. );
  1073. foreach($aMandatParams as $sParamName=>$sParamDesc)
  1074. {
  1075. if (!array_key_exists($sParamName, $aListInfo))
  1076. {
  1077. throw new CoreException("Declaration of list $sListCode - missing parameter $sParamName");
  1078. }
  1079. }
  1080. self::$m_aListInfos[$sListCode] = $aListInfo;
  1081. }
  1082. public static function RegisterRelation($sRelCode)
  1083. {
  1084. // Each item used to be an array of properties...
  1085. self::$m_aRelationInfos[$sRelCode] = $sRelCode;
  1086. }
  1087. // Must be called once and only once...
  1088. public static function InitClasses($sTablePrefix)
  1089. {
  1090. if (count(self::GetClasses()) > 0)
  1091. {
  1092. throw new CoreException("InitClasses should not be called more than once -skipped");
  1093. return;
  1094. }
  1095. self::$m_sTablePrefix = $sTablePrefix;
  1096. // Build the list of available extensions
  1097. //
  1098. $aInterfaces = array('iApplicationUIExtension', 'iApplicationObjectExtension', 'iQueryModifier', 'iOnClassInitialization');
  1099. foreach($aInterfaces as $sInterface)
  1100. {
  1101. self::$m_aExtensionClasses[$sInterface] = array();
  1102. }
  1103. foreach(get_declared_classes() as $sPHPClass)
  1104. {
  1105. $oRefClass = new ReflectionClass($sPHPClass);
  1106. $oExtensionInstance = null;
  1107. foreach($aInterfaces as $sInterface)
  1108. {
  1109. if ($oRefClass->implementsInterface($sInterface))
  1110. {
  1111. if (is_null($oExtensionInstance))
  1112. {
  1113. $oExtensionInstance = new $sPHPClass;
  1114. }
  1115. self::$m_aExtensionClasses[$sInterface][$sPHPClass] = $oExtensionInstance;
  1116. }
  1117. }
  1118. }
  1119. // Initialize the classes (declared attributes, etc.)
  1120. //
  1121. foreach(get_declared_classes() as $sPHPClass) {
  1122. if (is_subclass_of($sPHPClass, 'DBObject'))
  1123. {
  1124. $sParent = get_parent_class($sPHPClass);
  1125. if (array_key_exists($sParent, self::$m_aIgnoredAttributes))
  1126. {
  1127. // Inherit info about attributes to ignore
  1128. self::$m_aIgnoredAttributes[$sPHPClass] = self::$m_aIgnoredAttributes[$sParent];
  1129. }
  1130. if (method_exists($sPHPClass, 'Init'))
  1131. {
  1132. call_user_func(array($sPHPClass, 'Init'));
  1133. foreach (MetaModel::EnumPlugins('iOnClassInitialization') as $sPluginClass => $oClassInit)
  1134. {
  1135. $oClassInit->OnAfterClassInitialization($sPHPClass);
  1136. }
  1137. }
  1138. }
  1139. }
  1140. // Add a 'class' attribute/filter to the root classes and their children
  1141. //
  1142. foreach(self::EnumRootClasses() as $sRootClass)
  1143. {
  1144. if (self::IsStandaloneClass($sRootClass)) continue;
  1145. $sDbFinalClassField = self::DBGetClassField($sRootClass);
  1146. if (strlen($sDbFinalClassField) == 0)
  1147. {
  1148. $sDbFinalClassField = 'finalclass';
  1149. self::$m_aClassParams[$sRootClass]["db_finalclass_field"] = 'finalclass';
  1150. }
  1151. $oClassAtt = new AttributeFinalClass('finalclass', array(
  1152. "sql"=>$sDbFinalClassField,
  1153. "default_value"=>$sRootClass,
  1154. "is_null_allowed"=>false,
  1155. "depends_on"=>array()
  1156. ));
  1157. $oClassAtt->SetHostClass($sRootClass);
  1158. self::$m_aAttribDefs[$sRootClass]['finalclass'] = $oClassAtt;
  1159. self::$m_aAttribOrigins[$sRootClass]['finalclass'] = $sRootClass;
  1160. $oClassFlt = new FilterFromAttribute($oClassAtt);
  1161. self::$m_aFilterDefs[$sRootClass]['finalclass'] = $oClassFlt;
  1162. self::$m_aFilterOrigins[$sRootClass]['finalclass'] = $sRootClass;
  1163. foreach(self::EnumChildClasses($sRootClass, ENUM_CHILD_CLASSES_EXCLUDETOP) as $sChildClass)
  1164. {
  1165. if (array_key_exists('finalclass', self::$m_aAttribDefs[$sChildClass]))
  1166. {
  1167. throw new CoreException("Class $sChildClass, 'finalclass' is a reserved keyword, it cannot be used as an attribute code");
  1168. }
  1169. if (array_key_exists('finalclass', self::$m_aFilterDefs[$sChildClass]))
  1170. {
  1171. throw new CoreException("Class $sChildClass, 'finalclass' is a reserved keyword, it cannot be used as a filter code");
  1172. }
  1173. $oCloned = clone $oClassAtt;
  1174. $oCloned->SetFixedValue($sChildClass);
  1175. self::$m_aAttribDefs[$sChildClass]['finalclass'] = $oCloned;
  1176. self::$m_aAttribOrigins[$sChildClass]['finalclass'] = $sRootClass;
  1177. $oClassFlt = new FilterFromAttribute($oClassAtt);
  1178. self::$m_aFilterDefs[$sChildClass]['finalclass'] = $oClassFlt;
  1179. self::$m_aFilterOrigins[$sChildClass]['finalclass'] = self::GetRootClass($sChildClass);
  1180. }
  1181. }
  1182. // Prepare external fields and filters
  1183. // Add final class to external keys
  1184. //
  1185. foreach (self::GetClasses() as $sClass)
  1186. {
  1187. // Create the friendly name attribute
  1188. $sFriendlyNameAttCode = 'friendlyname';
  1189. $oFriendlyName = new AttributeFriendlyName($sFriendlyNameAttCode, 'id');
  1190. $oFriendlyName->SetHostClass($sClass);
  1191. self::$m_aAttribDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyName;
  1192. self::$m_aAttribOrigins[$sClass][$sFriendlyNameAttCode] = $sClass;
  1193. $oFriendlyNameFlt = new FilterFromAttribute($oFriendlyName);
  1194. self::$m_aFilterDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyNameFlt;
  1195. self::$m_aFilterOrigins[$sClass][$sFriendlyNameAttCode] = $sClass;
  1196. self::$m_aExtKeyFriends[$sClass] = array();
  1197. foreach (self::$m_aAttribDefs[$sClass] as $sAttCode => $oAttDef)
  1198. {
  1199. // Compute the filter codes
  1200. //
  1201. foreach ($oAttDef->GetFilterDefinitions() as $sFilterCode => $oFilterDef)
  1202. {
  1203. self::$m_aFilterDefs[$sClass][$sFilterCode] = $oFilterDef;
  1204. if ($oAttDef->IsExternalField())
  1205. {
  1206. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1207. $oKeyDef = self::GetAttributeDef($sClass, $sKeyAttCode);
  1208. self::$m_aFilterOrigins[$sClass][$sFilterCode] = $oKeyDef->GetTargetClass();
  1209. }
  1210. else
  1211. {
  1212. self::$m_aFilterOrigins[$sClass][$sFilterCode] = self::$m_aAttribOrigins[$sClass][$sAttCode];
  1213. }
  1214. }
  1215. // Compute the fields that will be used to display a pointer to another object
  1216. //
  1217. if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  1218. {
  1219. // oAttDef is either
  1220. // - an external KEY / FIELD (direct),
  1221. // - an external field pointing to an external KEY / FIELD
  1222. // - an external field pointing to an external field pointing to....
  1223. $sRemoteClass = $oAttDef->GetTargetClass();
  1224. if ($oAttDef->IsExternalField())
  1225. {
  1226. // This is a key, but the value comes from elsewhere
  1227. // Create an external field pointing to the remote friendly name attribute
  1228. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1229. $sRemoteAttCode = $oAttDef->GetExtAttCode()."_friendlyname";
  1230. $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
  1231. // propagate "is_null_allowed" ?
  1232. $oFriendlyName = new AttributeExternalField($sFriendlyNameAttCode, array("allowed_values"=>null, "extkey_attcode"=>$sKeyAttCode, "target_attcode"=>$sRemoteAttCode, "depends_on"=>array()));
  1233. $oFriendlyName->SetHostClass($sClass);
  1234. self::$m_aAttribDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyName;
  1235. self::$m_aAttribOrigins[$sClass][$sFriendlyNameAttCode] = $sRemoteClass;
  1236. $oFriendlyNameFlt = new FilterFromAttribute($oFriendlyName);
  1237. self::$m_aFilterDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyNameFlt;
  1238. self::$m_aFilterOrigins[$sClass][$sFriendlyNameAttCode] = $sRemoteClass;
  1239. }
  1240. else
  1241. {
  1242. // Create the friendly name attribute
  1243. $sFriendlyNameAttCode = $sAttCode.'_friendlyname';
  1244. $oFriendlyName = new AttributeFriendlyName($sFriendlyNameAttCode, $sAttCode);
  1245. $oFriendlyName->SetHostClass($sClass);
  1246. self::$m_aAttribDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyName;
  1247. self::$m_aAttribOrigins[$sClass][$sFriendlyNameAttCode] = $sRemoteClass;
  1248. $oFriendlyNameFlt = new FilterFromAttribute($oFriendlyName);
  1249. self::$m_aFilterDefs[$sClass][$sFriendlyNameAttCode] = $oFriendlyNameFlt;
  1250. self::$m_aFilterOrigins[$sClass][$sFriendlyNameAttCode] = $sRemoteClass;
  1251. if (self::HasChildrenClasses($sRemoteClass))
  1252. {
  1253. // First, create an external field attribute, that gets the final class
  1254. $sClassRecallAttCode = $sAttCode.'_finalclass_recall';
  1255. $oClassRecall = new AttributeExternalField($sClassRecallAttCode, array(
  1256. "allowed_values"=>null,
  1257. "extkey_attcode"=>$sAttCode,
  1258. "target_attcode"=>"finalclass",
  1259. "is_null_allowed"=>true,
  1260. "depends_on"=>array()
  1261. ));
  1262. $oClassRecall->SetHostClass($sClass);
  1263. self::$m_aAttribDefs[$sClass][$sClassRecallAttCode] = $oClassRecall;
  1264. self::$m_aAttribOrigins[$sClass][$sClassRecallAttCode] = $sRemoteClass;
  1265. $oClassFlt = new FilterFromAttribute($oClassRecall);
  1266. self::$m_aFilterDefs[$sClass][$sClassRecallAttCode] = $oClassFlt;
  1267. self::$m_aFilterOrigins[$sClass][$sClassRecallAttCode] = $sRemoteClass;
  1268. // Add it to the ZLists where the external key is present
  1269. //foreach(self::$m_aListData[$sClass] as $sListCode => $aAttributes)
  1270. $sListCode = 'list';
  1271. if (isset(self::$m_aListData[$sClass][$sListCode]))
  1272. {
  1273. $aAttributes = self::$m_aListData[$sClass][$sListCode];
  1274. // temporary.... no loop
  1275. {
  1276. if (in_array($sAttCode, $aAttributes))
  1277. {
  1278. $aNewList = array();
  1279. foreach($aAttributes as $iPos => $sAttToDisplay)
  1280. {
  1281. if (is_string($sAttToDisplay) && ($sAttToDisplay == $sAttCode))
  1282. {
  1283. // Insert the final class right before
  1284. $aNewList[] = $sClassRecallAttCode;
  1285. }
  1286. $aNewList[] = $sAttToDisplay;
  1287. }
  1288. self::$m_aListData[$sClass][$sListCode] = $aNewList;
  1289. }
  1290. }
  1291. }
  1292. }
  1293. }
  1294. // Get the real external key attribute
  1295. // It will be our reference to determine the other ext fields related to the same ext key
  1296. $oFinalKeyAttDef = $oAttDef->GetKeyAttDef(EXTKEY_ABSOLUTE);
  1297. self::$m_aExtKeyFriends[$sClass][$sAttCode] = array();
  1298. foreach (self::GetExternalFields($sClass, $oAttDef->GetKeyAttCode($sAttCode)) as $oExtField)
  1299. {
  1300. // skip : those extfields will be processed as external keys
  1301. if ($oExtField->IsExternalKey(EXTKEY_ABSOLUTE)) continue;
  1302. // Note: I could not compare the objects by the mean of '==='
  1303. // because they are copied for the inheritance, and the internal references are NOT updated
  1304. if ($oExtField->GetKeyAttDef(EXTKEY_ABSOLUTE) == $oFinalKeyAttDef)
  1305. {
  1306. self::$m_aExtKeyFriends[$sClass][$sAttCode][$oExtField->GetCode()] = $oExtField;
  1307. }
  1308. }
  1309. }
  1310. }
  1311. // Add a 'id' filter
  1312. //
  1313. if (array_key_exists('id', self::$m_aAttribDefs[$sClass]))
  1314. {
  1315. throw new CoreException("Class $sClass, 'id' is a reserved keyword, it cannot be used as an attribute code");
  1316. }
  1317. if (array_key_exists('id', self::$m_aFilterDefs[$sClass]))
  1318. {
  1319. throw new CoreException("Class $sClass, 'id' is a reserved keyword, it cannot be used as a filter code");
  1320. }
  1321. $oFilter = new FilterPrivateKey('id', array('id_field' => self::DBGetKey($sClass)));
  1322. self::$m_aFilterDefs[$sClass]['id'] = $oFilter;
  1323. self::$m_aFilterOrigins[$sClass]['id'] = $sClass;
  1324. // Define defaults values for the standard ZLists
  1325. //
  1326. //foreach (self::$m_aListInfos as $sListCode => $aListConfig)
  1327. //{
  1328. // if (!isset(self::$m_aListData[$sClass][$sListCode]))
  1329. // {
  1330. // $aAllAttributes = array_keys(self::$m_aAttribDefs[$sClass]);
  1331. // self::$m_aListData[$sClass][$sListCode] = $aAllAttributes;
  1332. // //echo "<p>$sClass: $sListCode (".count($aAllAttributes)." attributes)</p>\n";
  1333. // }
  1334. //}
  1335. }
  1336. }
  1337. // To be overriden, must be called for any object class (optimization)
  1338. public static function Init()
  1339. {
  1340. // In fact it is an ABSTRACT function, but this is not compatible with the fact that it is STATIC (error in E_STRICT interpretation)
  1341. }
  1342. // To be overloaded by biz model declarations
  1343. public static function GetRelationQueries($sRelCode)
  1344. {
  1345. // In fact it is an ABSTRACT function, but this is not compatible with the fact that it is STATIC (error in E_STRICT interpretation)
  1346. return array();
  1347. }
  1348. public static function Init_Params($aParams)
  1349. {
  1350. // Check mandatory params
  1351. $aMandatParams = array(
  1352. "category" => "group classes by modules defining their visibility in the UI",
  1353. "key_type" => "autoincrement | string",
  1354. "name_attcode" => "define wich attribute is the class name, may be an array of attributes (format specified in the dictionary as 'Class:myclass/Name' => '%1\$s %2\$s...'",
  1355. "state_attcode" => "define wich attribute is representing the state (object lifecycle)",
  1356. "reconc_keys" => "define the attributes that will 'almost uniquely' identify an object in batch processes",
  1357. "db_table" => "database table",
  1358. "db_key_field" => "database field which is the key",
  1359. "db_finalclass_field" => "database field wich is the reference to the actual class of the object, considering that this will be a compound class",
  1360. );
  1361. $sClass = self::GetCallersPHPClass("Init", self::$m_bTraceSourceFiles);
  1362. foreach($aMandatParams as $sParamName=>$sParamDesc)
  1363. {
  1364. if (!array_key_exists($sParamName, $aParams))
  1365. {
  1366. throw new CoreException("Declaration of class $sClass - missing parameter $sParamName");
  1367. }
  1368. }
  1369. $aCategories = explode(',', $aParams['category']);
  1370. foreach ($aCategories as $sCategory)
  1371. {
  1372. self::$m_Category2Class[$sCategory][] = $sClass;
  1373. }
  1374. self::$m_Category2Class[''][] = $sClass; // all categories, include this one
  1375. self::$m_aRootClasses[$sClass] = $sClass; // first, let consider that I am the root... updated on inheritance
  1376. self::$m_aParentClasses[$sClass] = array();
  1377. self::$m_aChildClasses[$sClass] = array();
  1378. self::$m_aClassParams[$sClass]= $aParams;
  1379. self::$m_aAttribDefs[$sClass] = array();
  1380. self::$m_aAttribOrigins[$sClass] = array();
  1381. self::$m_aExtKeyFriends[$sClass] = array();
  1382. self::$m_aFilterDefs[$sClass] = array();
  1383. self::$m_aFilterOrigins[$sClass] = array();
  1384. }
  1385. protected static function object_array_mergeclone($aSource1, $aSource2)
  1386. {
  1387. $aRes = array();
  1388. foreach ($aSource1 as $key=>$object)
  1389. {
  1390. $aRes[$key] = clone $object;
  1391. }
  1392. foreach ($aSource2 as $key=>$object)
  1393. {
  1394. $aRes[$key] = clone $object;
  1395. }
  1396. return $aRes;
  1397. }
  1398. public static function Init_InheritAttributes($sSourceClass = null)
  1399. {
  1400. $sTargetClass = self::GetCallersPHPClass("Init");
  1401. if (empty($sSourceClass))
  1402. {
  1403. // Default: inherit from parent class
  1404. $sSourceClass = self::GetParentPersistentClass($sTargetClass);
  1405. if (empty($sSourceClass)) return; // no attributes for the mother of all classes
  1406. }
  1407. if (isset(self::$m_aAttribDefs[$sSourceClass]))
  1408. {
  1409. if (!isset(self::$m_aAttribDefs[$sTargetClass]))
  1410. {
  1411. self::$m_aAttribDefs[$sTargetClass] = array();
  1412. self::$m_aAttribOrigins[$sTargetClass] = array();
  1413. }
  1414. self::$m_aAttribDefs[$sTargetClass] = self::object_array_mergeclone(self::$m_aAttribDefs[$sTargetClass], self::$m_aAttribDefs[$sSourceClass]);
  1415. foreach(self::$m_aAttribDefs[$sTargetClass] as $sAttCode => $oAttDef)
  1416. {
  1417. $oAttDef->SetHostClass($sTargetClass);
  1418. }
  1419. self::$m_aAttribOrigins[$sTargetClass] = array_merge(self::$m_aAttribOrigins[$sTargetClass], self::$m_aAttribOrigins[$sSourceClass]);
  1420. }
  1421. // Build root class information
  1422. if (array_key_exists($sSourceClass, self::$m_aRootClasses))
  1423. {
  1424. // Inherit...
  1425. self::$m_aRootClasses[$sTargetClass] = self::$m_aRootClasses[$sSourceClass];
  1426. }
  1427. else
  1428. {
  1429. // This class will be the root class
  1430. self::$m_aRootClasses[$sSourceClass] = $sSourceClass;
  1431. self::$m_aRootClasses[$sTargetClass] = $sSourceClass;
  1432. }
  1433. self::$m_aParentClasses[$sTargetClass] += self::$m_aParentClasses[$sSourceClass];
  1434. self::$m_aParentClasses[$sTargetClass][] = $sSourceClass;
  1435. // I am the child of each and every parent...
  1436. foreach(self::$m_aParentClasses[$sTargetClass] as $sAncestorClass)
  1437. {
  1438. self::$m_aChildClasses[$sAncestorClass][] = $sTargetClass;
  1439. }
  1440. }
  1441. protected static function Init_IsKnownClass($sClass)
  1442. {
  1443. // Differs from self::IsValidClass()
  1444. // because it is being called before all the classes have been initialized
  1445. if (!class_exists($sClass)) return false;
  1446. if (!is_subclass_of($sClass, 'DBObject')) return false;
  1447. return true;
  1448. }
  1449. public static function Init_AddAttribute(AttributeDefinition $oAtt, $sTargetClass = null)
  1450. {
  1451. if (!$sTargetClass)
  1452. {
  1453. $sTargetClass = self::GetCallersPHPClass("Init");
  1454. }
  1455. $sAttCode = $oAtt->GetCode();
  1456. if ($sAttCode == 'finalclass')
  1457. {
  1458. throw new Exception("Declaration of $sTargetClass: using the reserved keyword '$sAttCode' in attribute declaration");
  1459. }
  1460. if ($sAttCode == 'friendlyname')
  1461. {
  1462. throw new Exception("Declaration of $sTargetClass: using the reserved keyword '$sAttCode' in attribute declaration");
  1463. }
  1464. if (array_key_exists($sAttCode, self::$m_aAttribDefs[$sTargetClass]))
  1465. {
  1466. throw new Exception("Declaration of $sTargetClass: attempting to redeclare the inherited attribute '$sAttCode', originaly declared in ".self::$m_aAttribOrigins[$sTargetClass][$sAttCode]);
  1467. }
  1468. // Set the "host class" as soon as possible, since HierarchicalKeys use it for their 'target class' as well
  1469. // and this needs to be know early (for Init_IsKnowClass 19 lines below)
  1470. $oAtt->SetHostClass($sTargetClass);
  1471. // Some attributes could refer to a class
  1472. // declared in a module which is currently not installed/active
  1473. // We simply discard those attributes
  1474. //
  1475. if ($oAtt->IsLinkSet())
  1476. {
  1477. $sRemoteClass = $oAtt->GetLinkedClass();
  1478. if (!self::Init_IsKnownClass($sRemoteClass))
  1479. {
  1480. self::$m_aIgnoredAttributes[$sTargetClass][$oAtt->GetCode()] = $sRemoteClass;
  1481. return;
  1482. }
  1483. }
  1484. elseif($oAtt->IsExternalKey())
  1485. {
  1486. $sRemoteClass = $oAtt->GetTargetClass();
  1487. if (!self::Init_IsKnownClass($sRemoteClass))
  1488. {
  1489. self::$m_aIgnoredAttributes[$sTargetClass][$oAtt->GetCode()] = $sRemoteClass;
  1490. return;
  1491. }
  1492. }
  1493. elseif($oAtt->IsExternalField())
  1494. {
  1495. $sExtKeyAttCode = $oAtt->GetKeyAttCode();
  1496. if (isset(self::$m_aIgnoredAttributes[$sTargetClass][$sExtKeyAttCode]))
  1497. {
  1498. // The corresponding external key has already been ignored
  1499. self::$m_aIgnoredAttributes[$sTargetClass][$oAtt->GetCode()] = self::$m_aIgnoredAttributes[$sTargetClass][$sExtKeyAttCode];
  1500. return;
  1501. }
  1502. // #@# todo - Check if the target attribute is still there
  1503. // this is not simple to implement because is involves
  1504. // several passes (the load order has a significant influence on that)
  1505. }
  1506. self::$m_aAttribDefs[$sTargetClass][$oAtt->GetCode()] = $oAtt;
  1507. self::$m_aAttribOrigins[$sTargetClass][$oAtt->GetCode()] = $sTargetClass;
  1508. // Note: it looks redundant to put targetclass there, but a mix occurs when inheritance is used
  1509. }
  1510. public static function Init_SetZListItems($sListCode, $aItems, $sTargetClass = null)
  1511. {
  1512. MyHelpers::CheckKeyInArray('list code', $sListCode, self::$m_aListInfos);
  1513. if (!$sTargetClass)
  1514. {
  1515. $sTargetClass = self::GetCallersPHPClass("Init");
  1516. }
  1517. // Discard attributes that do not make sense
  1518. // (missing classes in the current module combination, resulting in irrelevant ext key or link set)
  1519. //
  1520. self::Init_CheckZListItems($aItems, $sTargetClass);
  1521. self::$m_aListData[$sTargetClass][$sListCode] = $aItems;
  1522. }
  1523. protected static function Init_CheckZListItems(&$aItems, $sTargetClass)
  1524. {
  1525. foreach($aItems as $iFoo => $attCode)
  1526. {
  1527. if (is_array($attCode))
  1528. {
  1529. // Note: to make sure that the values will be updated recursively,
  1530. // do not pass $attCode, but $aItems[$iFoo] instead
  1531. self::Init_CheckZListItems($aItems[$iFoo], $sTargetClass);
  1532. if (count($aItems[$iFoo]) == 0)
  1533. {
  1534. unset($aItems[$iFoo]);
  1535. }
  1536. }
  1537. else if (isset(self::$m_aIgnoredAttributes[$sTargetClass][$attCode]))
  1538. {
  1539. unset($aItems[$iFoo]);
  1540. }
  1541. }
  1542. }
  1543. public static function FlattenZList($aList)
  1544. {
  1545. $aResult = array();
  1546. foreach($aList as $value)
  1547. {
  1548. if (!is_array($value))
  1549. {
  1550. $aResult[] = $value;
  1551. }
  1552. else
  1553. {
  1554. $aResult = array_merge($aResult, self::FlattenZList($value));
  1555. }
  1556. }
  1557. return $aResult;
  1558. }
  1559. public static function Init_DefineState($sStateCode, $aStateDef)
  1560. {
  1561. $sTargetClass = self::GetCallersPHPClass("Init");
  1562. if (is_null($aStateDef['attribute_list'])) $aStateDef['attribute_list'] = array();
  1563. $sParentState = $aStateDef['attribute_inherit'];
  1564. if (!empty($sParentState))
  1565. {
  1566. // Inherit from the given state (must be defined !)
  1567. //
  1568. $aToInherit = self::$m_aStates[$sTargetClass][$sParentState];
  1569. // Reset the constraint when it was mandatory to set the value at the previous state
  1570. //
  1571. foreach ($aToInherit['attribute_list'] as $sState => $iFlags)
  1572. {
  1573. $iFlags = $iFlags & ~OPT_ATT_MUSTPROMPT;
  1574. $iFlags = $iFlags & ~OPT_ATT_MUSTCHANGE;
  1575. $aToInherit['attribute_list'][$sState] = $iFlags;
  1576. }
  1577. // The inherited configuration could be overriden
  1578. $aStateDef['attribute_list'] = array_merge($aToInherit['attribute_list'], $aStateDef['attribute_list']);
  1579. }
  1580. foreach($aStateDef['attribute_list'] as $sAttCode => $iFlags)
  1581. {
  1582. if (isset(self::$m_aIgnoredAttributes[$sTargetClass][$sAttCode]))
  1583. {
  1584. unset($aStateDef['attribute_list'][$sAttCode]);
  1585. }
  1586. }
  1587. self::$m_aStates[$sTargetClass][$sStateCode] = $aStateDef;
  1588. // by default, create an empty set of transitions associated to that state
  1589. self::$m_aTransitions[$sTargetClass][$sStateCode] = array();
  1590. }
  1591. public static function Init_OverloadStateAttribute($sStateCode, $sAttCode, $iFlags)
  1592. {
  1593. // Warning: this is not sufficient: the flags have to be copied to the states that are inheriting from this state
  1594. $sTargetClass = self::GetCallersPHPClass("Init");
  1595. self::$m_aStates[$sTargetClass][$sStateCode]['attribute_list'][$sAttCode] = $iFlags;
  1596. }
  1597. public static function Init_DefineStimulus($oStimulus)
  1598. {
  1599. $sTargetClass = self::GetCallersPHPClass("Init");
  1600. self::$m_aStimuli[$sTargetClass][$oStimulus->GetCode()] = $oStimulus;
  1601. // I wanted to simplify the syntax of the declaration of objects in the biz model
  1602. // Therefore, the reference to the host class is set there
  1603. $oStimulus->SetHostClass($sTargetClass);
  1604. }
  1605. public static function Init_DefineTransition($sStateCode, $sStimulusCode, $aTransitionDef)
  1606. {
  1607. $sTargetClass = self::GetCallersPHPClass("Init");
  1608. if (is_null($aTransitionDef['actions'])) $aTransitionDef['actions'] = array();
  1609. self::$m_aTransitions[$sTargetClass][$sStateCode][$sStimulusCode] = $aTransitionDef;
  1610. }
  1611. public static function Init_InheritLifecycle($sSourceClass = '')
  1612. {
  1613. $sTargetClass = self::GetCallersPHPClass("Init");
  1614. if (empty($sSourceClass))
  1615. {
  1616. // Default: inherit from parent class
  1617. $sSourceClass = self::GetParentPersistentClass($sTargetClass);
  1618. if (empty($sSourceClass)) return; // no attributes for the mother of all classes
  1619. }
  1620. self::$m_aClassParams[$sTargetClass]["state_attcode"] = self::$m_aClassParams[$sSourceClass]["state_attcode"];
  1621. self::$m_aStates[$sTargetClass] = self::$m_aStates[$sSourceClass];
  1622. // #@# Note: the aim is to clone the data, could be an issue if the simuli objects are changed
  1623. self::$m_aStimuli[$sTargetClass] = self::$m_aStimuli[$sSourceClass];
  1624. self::$m_aTransitions[$sTargetClass] = self::$m_aTransitions[$sSourceClass];
  1625. }
  1626. //
  1627. // Static API
  1628. //
  1629. public static function GetRootClass($sClass = null)
  1630. {
  1631. self::_check_subclass($sClass);
  1632. return self::$m_aRootClasses[$sClass];
  1633. }
  1634. public static function IsRootClass($sClass)
  1635. {
  1636. self::_check_subclass($sClass);
  1637. return (self::GetRootClass($sClass) == $sClass);
  1638. }
  1639. public static function GetParentClass($sClass)
  1640. {
  1641. if (count(self::$m_aParentClasses[$sClass]) == 0)
  1642. {
  1643. return null;
  1644. }
  1645. else
  1646. {
  1647. return end(self::$m_aParentClasses[$sClass]);
  1648. }
  1649. }
  1650. /**
  1651. * Tells if a class contains a hierarchical key, and if so what is its AttCode
  1652. * @return mixed String = sAttCode or false if the class is not part of a hierarchy
  1653. */
  1654. public static function IsHierarchicalClass($sClass)
  1655. {
  1656. $sHierarchicalKeyCode = false;
  1657. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  1658. {
  1659. if ($oAtt->IsHierarchicalKey())
  1660. {
  1661. $sHierarchicalKeyCode = $sAttCode; // Found the hierarchical key, no need to continue
  1662. break;
  1663. }
  1664. }
  1665. return $sHierarchicalKeyCode;
  1666. }
  1667. public static function EnumRootClasses()
  1668. {
  1669. return array_unique(self::$m_aRootClasses);
  1670. }
  1671. public static function EnumParentClasses($sClass, $iOption = ENUM_PARENT_CLASSES_EXCLUDELEAF)
  1672. {
  1673. self::_check_subclass($sClass);
  1674. if ($iOption == ENUM_PARENT_CLASSES_EXCLUDELEAF)
  1675. {
  1676. return self::$m_aParentClasses[$sClass];
  1677. }
  1678. $aRes = self::$m_aParentClasses[$sClass];
  1679. $aRes[] = $sClass;
  1680. return $aRes;
  1681. }
  1682. public static function EnumChildClasses($sClass, $iOption = ENUM_CHILD_CLASSES_EXCLUDETOP)
  1683. {
  1684. self::_check_subclass($sClass);
  1685. $aRes = self::$m_aChildClasses[$sClass];
  1686. if ($iOption != ENUM_CHILD_CLASSES_EXCLUDETOP)
  1687. {
  1688. // Add it to the list
  1689. $aRes[] = $sClass;
  1690. }
  1691. return $aRes;
  1692. }
  1693. public static function HasChildrenClasses($sClass)
  1694. {
  1695. return (count(self::$m_aChildClasses[$sClass]) > 0);
  1696. }
  1697. public static function EnumCategories()
  1698. {
  1699. return array_keys(self::$m_Category2Class);
  1700. }
  1701. // Note: use EnumChildClasses to take the compound objects into account
  1702. public static function GetSubclasses($sClass)
  1703. {
  1704. self::_check_subclass($sClass);
  1705. $aSubClasses = array();
  1706. foreach(get_declared_classes() as $sSubClass) {
  1707. if (is_subclass_of($sSubClass, $sClass))
  1708. {
  1709. $aSubClasses[] = $sSubClass;
  1710. }
  1711. }
  1712. return $aSubClasses;
  1713. }
  1714. public static function GetClasses($sCategories = '', $bStrict = false)
  1715. {
  1716. $aCategories = explode(',', $sCategories);
  1717. $aClasses = array();
  1718. foreach($aCategories as $sCategory)
  1719. {
  1720. $sCategory = trim($sCategory);
  1721. if (strlen($sCategory) == 0)
  1722. {
  1723. return array_keys(self::$m_aClassParams);
  1724. }
  1725. if (array_key_exists($sCategory, self::$m_Category2Class))
  1726. {
  1727. $aClasses = array_merge($aClasses, self::$m_Category2Class[$sCategory]);
  1728. }
  1729. elseif ($bStrict)
  1730. {
  1731. throw new CoreException("unkown class category '$sCategory', expecting a value in {".implode(', ', array_keys(self::$m_Category2Class))."}");
  1732. }
  1733. }
  1734. return array_unique($aClasses);
  1735. }
  1736. public static function HasTable($sClass)
  1737. {
  1738. if (strlen(self::DBGetTable($sClass)) == 0) return false;
  1739. return true;
  1740. }
  1741. public static function IsAbstract($sClass)
  1742. {
  1743. $oReflection = new ReflectionClass($sClass);
  1744. return $oReflection->isAbstract();
  1745. }
  1746. protected static $m_aQueryStructCache = array();
  1747. protected static function PrepareQueryArguments($aArgs)
  1748. {
  1749. // Translate any object into scalars
  1750. //
  1751. $aScalarArgs = array();
  1752. foreach($aArgs as $sArgName => $value)
  1753. {
  1754. if (self::IsValidObject($value))
  1755. {
  1756. $aScalarArgs = array_merge($aScalarArgs, $value->ToArgs($sArgName));
  1757. }
  1758. else
  1759. {
  1760. $aScalarArgs[$sArgName] = (string) $value;
  1761. }
  1762. }
  1763. // Add standard contextual arguments
  1764. //
  1765. $aScalarArgs['current_contact_id'] = UserRights::GetContactId();
  1766. return $aScalarArgs;
  1767. }
  1768. public static function MakeGroupByQuery(DBObjectSearch $oFilter, $aArgs, $aGroupByExpr)
  1769. {
  1770. $aAttToLoad = array();
  1771. $oSelect = self::MakeSelectStructure($oFilter, array(), $aArgs, $aAttToLoad, null, 0, 0, false, $aGroupByExpr);
  1772. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1773. try
  1774. {
  1775. $sRes = $oSelect->RenderGroupBy($aScalarArgs);
  1776. }
  1777. catch (MissingQueryArgument $e)
  1778. {
  1779. // Add some information...
  1780. $e->addInfo('OQL', $oFilter->ToOQL());
  1781. throw $e;
  1782. }
  1783. return $sRes;
  1784. }
  1785. public static function MakeSelectQuery(DBObjectSearch $oFilter, $aOrderBy = array(), $aArgs = array(), $aAttToLoad = null, $aExtendedDataSpec = null, $iLimitCount = 0, $iLimitStart = 0, $bGetCount = false)
  1786. {
  1787. // Check the order by specification, and prefix with the class alias
  1788. // and make sure that the ordering columns are going to be selected
  1789. //
  1790. $aOrderSpec = array();
  1791. foreach ($aOrderBy as $sFieldAlias => $bAscending)
  1792. {
  1793. if ($sFieldAlias != 'id')
  1794. {
  1795. MyHelpers::CheckValueInArray('field name in ORDER BY spec', $sFieldAlias, self::GetAttributesList($oFilter->GetFirstJoinedClass()));
  1796. }
  1797. if (!is_bool($bAscending))
  1798. {
  1799. throw new CoreException("Wrong direction in ORDER BY spec, found '$bAscending' and expecting a boolean value");
  1800. }
  1801. $sFirstClassAlias = $oFilter->GetClassAlias();
  1802. if (self::IsValidAttCode($oFilter->GetClass(), $sFieldAlias))
  1803. {
  1804. $oAttDef = self::GetAttributeDef($oFilter->GetClass(), $sFieldAlias);
  1805. foreach($oAttDef->GetOrderBySQLExpressions($sFirstClassAlias) as $sSQLExpression)
  1806. {
  1807. $aOrderSpec[$sSQLExpression] = $bAscending;
  1808. }
  1809. }
  1810. else
  1811. {
  1812. $aOrderSpec['`'.$sFirstClassAlias.$sFieldAlias.'`'] = $bAscending;
  1813. }
  1814. // Make sure that the columns used for sorting are present in the loaded columns
  1815. if (!is_null($aAttToLoad) && !isset($aAttToLoad[$sFirstClassAlias][$sFieldAlias]))
  1816. {
  1817. $aAttToLoad[$sFirstClassAlias][$sFieldAlias] = MetaModel::GetAttributeDef($oFilter->GetFirstJoinedClass(), $sFieldAlias);
  1818. }
  1819. }
  1820. $oSelect = self::MakeSelectStructure($oFilter, $aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount);
  1821. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1822. try
  1823. {
  1824. $sRes = $oSelect->RenderSelect($aOrderSpec, $aScalarArgs, $iLimitCount, $iLimitStart, $bGetCount);
  1825. }
  1826. catch (MissingQueryArgument $e)
  1827. {
  1828. // Add some information...
  1829. $e->addInfo('OQL', $sOqlQuery);
  1830. throw $e;
  1831. }
  1832. return $sRes;
  1833. }
  1834. protected static function MakeSelectStructure(DBObjectSearch $oFilter, $aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $aGroupByExpr = null)
  1835. {
  1836. // Hide objects that are not visible to the current user
  1837. //
  1838. if (!$oFilter->IsAllDataAllowed() && !$oFilter->IsDataFiltered())
  1839. {
  1840. $oVisibleObjects = UserRights::GetSelectFilter($oFilter->GetClass(), $oFilter->GetModifierProperties('UserRightsGetSelectFilter'));
  1841. if ($oVisibleObjects === false)
  1842. {
  1843. // Make sure this is a valid search object, saying NO for all
  1844. $oVisibleObjects = DBObjectSearch::FromEmptySet($oFilter->GetClass());
  1845. }
  1846. if (is_object($oVisibleObjects))
  1847. {
  1848. $oFilter->MergeWith($oVisibleObjects);
  1849. $oFilter->SetDataFiltered();
  1850. }
  1851. else
  1852. {
  1853. // should be true at this point, meaning that no additional filtering
  1854. // is required
  1855. }
  1856. }
  1857. // Compute query modifiers properties (can be set in the search itself, by the context, etc.)
  1858. //
  1859. $aModifierProperties = self::MakeModifierProperties($oFilter);
  1860. if (self::$m_bQueryCacheEnabled || self::$m_bTraceQueries)
  1861. {
  1862. // Need to identify the query
  1863. $sOqlQuery = $oFilter->ToOql();
  1864. if (count($aModifierProperties))
  1865. {
  1866. array_multisort($aModifierProperties);
  1867. $sModifierProperties = json_encode($aModifierProperties);
  1868. }
  1869. else
  1870. {
  1871. $sModifierProperties = '';
  1872. }
  1873. $sRawId = $sOqlQuery.$sModifierProperties;
  1874. if (!is_null($aAttToLoad))
  1875. {
  1876. foreach($aAttToLoad as $sAlias => $aAttributes)
  1877. {
  1878. $sRawId = $sOqlQuery.'|'.implode(',', array_keys($aAttributes));
  1879. }
  1880. }
  1881. if (!is_null($aGroupByExpr))
  1882. {
  1883. foreach($aGroupByExpr as $sAlias => $oExpr)
  1884. {
  1885. $sRawId = 'g:'.$sAlias.'!'.$oExpr->Render();
  1886. }
  1887. }
  1888. $sOqlId = md5($sRawId);
  1889. }
  1890. else
  1891. {
  1892. $sOqlQuery = "SELECTING... ".$oFilter->GetClass();
  1893. $sOqlId = "query id ? n/a";
  1894. }
  1895. // Query caching
  1896. //
  1897. if (self::$m_bQueryCacheEnabled)
  1898. {
  1899. // Warning: using directly the query string as the key to the hash array can FAIL if the string
  1900. // is long and the differences are only near the end... so it's safer (but not bullet proof?)
  1901. // to use a hash (like md5) of the string as the key !
  1902. //
  1903. // Example of two queries that were found as similar by the hash array:
  1904. // SELECT SLT JOIN lnkSLTToSLA AS L1 ON L1.slt_id=SLT.id JOIN SLA ON L1.sla_id = SLA.id JOIN lnkContractToSLA AS L2 ON L2.sla_id = SLA.id JOIN CustomerContract ON L2.contract_id = CustomerContract.id WHERE SLT.ticket_priority = 1 AND SLA.service_id = 3 AND SLT.metric = 'TTO' AND CustomerContract.customer_id = 2
  1905. // and
  1906. // SELECT SLT JOIN lnkSLTToSLA AS L1 ON L1.slt_id=SLT.id JOIN SLA ON L1.sla_id = SLA.id JOIN lnkContractToSLA AS L2 ON L2.sla_id = SLA.id JOIN CustomerContract ON L2.contract_id = CustomerContract.id WHERE SLT.ticket_priority = 1 AND SLA.service_id = 3 AND SLT.metric = 'TTR' AND CustomerContract.customer_id = 2
  1907. // the only difference is R instead or O at position 285 (TTR instead of TTO)...
  1908. //
  1909. if (array_key_exists($sOqlId, self::$m_aQueryStructCache))
  1910. {
  1911. // hit!
  1912. $oSelect = clone self::$m_aQueryStructCache[$sOqlId];
  1913. }
  1914. elseif (self::$m_bUseAPCCache)
  1915. {
  1916. // Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
  1917. //
  1918. $sOqlAPCCacheId = 'itop-'.MetaModel::GetEnvironmentId().'-query-cache-'.$sOqlId;
  1919. $oKPI = new ExecutionKPI();
  1920. $result = apc_fetch($sOqlAPCCacheId);
  1921. $oKPI->ComputeStats('Query APC (fetch)', $sOqlQuery);
  1922. if (is_object($result))
  1923. {
  1924. $oSelect = $result;
  1925. self::$m_aQueryStructCache[$sOqlId] = $oSelect;
  1926. }
  1927. }
  1928. }
  1929. if (!isset($oSelect))
  1930. {
  1931. $oBuild = new QueryBuilderContext($oFilter, $aModifierProperties, $aGroupByExpr);
  1932. $oKPI = new ExecutionKPI();
  1933. $oSelect = self::MakeQuery($oBuild, $oFilter, $aAttToLoad, array(), true /* main query */);
  1934. $oSelect->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1935. $oSelect->SetSourceOQL($sOqlQuery);
  1936. if ($aGroupByExpr)
  1937. {
  1938. $aCols = $oBuild->m_oQBExpressions->GetGroupBy();
  1939. $oSelect->SetGroupBy($aCols);
  1940. $oSelect->SetSelect($aCols);
  1941. }
  1942. else
  1943. {
  1944. $oSelect->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1945. }
  1946. $oKPI->ComputeStats('MakeQuery (select)', $sOqlQuery);
  1947. if (self::$m_bQueryCacheEnabled)
  1948. {
  1949. if (self::$m_bUseAPCCache)
  1950. {
  1951. $oKPI = new ExecutionKPI();
  1952. apc_store($sOqlAPCCacheId, $oSelect, self::$m_iQueryCacheTTL);
  1953. $oKPI->ComputeStats('Query APC (store)', $sOqlQuery);
  1954. }
  1955. self::$m_aQueryStructCache[$sOqlId] = clone $oSelect;
  1956. }
  1957. }
  1958. // Join to an additional table, if required...
  1959. //
  1960. if ($aExtendedDataSpec != null)
  1961. {
  1962. $sTableAlias = '_extended_data_';
  1963. $aExtendedFields = array();
  1964. foreach($aExtendedDataSpec['fields'] as $sColumn)
  1965. {
  1966. $sColRef = $oFilter->GetClassAlias().'_extdata_'.$sColumn;
  1967. $aExtendedFields[$sColRef] = new FieldExpressionResolved($sColumn, $sTableAlias);
  1968. }
  1969. $oSelectExt = new SQLQuery($aExtendedDataSpec['table'], $sTableAlias, $aExtendedFields);
  1970. $oSelect->AddInnerJoin($oSelectExt, 'id', $aExtendedDataSpec['join_key'] /*, $sTableAlias*/);
  1971. }
  1972. if (self::$m_bTraceQueries)
  1973. {
  1974. $sQueryId = md5($sRes);
  1975. if(!isset(self::$m_aQueriesLog[$sOqlId]))
  1976. {
  1977. self::$m_aQueriesLog[$sOqlId]['oql'] = $sOqlQuery;
  1978. self::$m_aQueriesLog[$sOqlId]['hits'] = 1;
  1979. }
  1980. else
  1981. {
  1982. self::$m_aQueriesLog[$sOqlId]['hits']++;
  1983. }
  1984. if(!isset(self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]))
  1985. {
  1986. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['sql'] = $sRes;
  1987. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['count'] = 1;
  1988. }
  1989. else
  1990. {
  1991. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['count']++;
  1992. }
  1993. }
  1994. return $oSelect;
  1995. }
  1996. public static function ShowQueryTrace()
  1997. {
  1998. if (!self::$m_bTraceQueries) return;
  1999. $iOqlCount = count(self::$m_aQueriesLog);
  2000. if ($iOqlCount == 0)
  2001. {
  2002. echo "<p>Trace activated, but no query found</p>\n";
  2003. return;
  2004. }
  2005. $iSqlCount = 0;
  2006. foreach (self::$m_aQueriesLog as $aOqlData)
  2007. {
  2008. $iSqlCount += $aOqlData['hits'];
  2009. }
  2010. echo "<h2>Stats on SELECT queries: OQL=$iOqlCount, SQL=$iSqlCount</h2>\n";
  2011. foreach (self::$m_aQueriesLog as $aOqlData)
  2012. {
  2013. $sOql = $aOqlData['oql'];
  2014. $sHits = $aOqlData['hits'];
  2015. echo "<p><b>$sHits</b> hits for OQL query: $sOql</p>\n";
  2016. echo "<ul id=\"ClassesRelationships\" class=\"treeview\">\n";
  2017. foreach($aOqlData['queries'] as $aSqlData)
  2018. {
  2019. $sQuery = $aSqlData['sql'];
  2020. $sSqlHits = $aSqlData['count'];
  2021. echo "<li><b>$sSqlHits</b> hits for SQL: <span style=\"font-size:60%\">$sQuery</span><li>\n";
  2022. }
  2023. echo "</ul>\n";
  2024. }
  2025. }
  2026. protected static function MakeModifierProperties($oFilter)
  2027. {
  2028. // Compute query modifiers properties (can be set in the search itself, by the context, etc.)
  2029. //
  2030. $aModifierProperties = array();
  2031. foreach (MetaModel::EnumPlugins('iQueryModifier') as $sPluginClass => $oQueryModifier)
  2032. {
  2033. // Lowest precedence: the application context
  2034. $aPluginProps = ApplicationContext::GetPluginProperties($sPluginClass);
  2035. // Highest precedence: programmatically specified (or OQL)
  2036. foreach($oFilter->GetModifierProperties($sPluginClass) as $sProp => $value)
  2037. {
  2038. $aPluginProps[$sProp] = $value;
  2039. }
  2040. if (count($aPluginProps) > 0)
  2041. {
  2042. $aModifierProperties[$sPluginClass] = $aPluginProps;
  2043. }
  2044. }
  2045. return $aModifierProperties;
  2046. }
  2047. public static function MakeDeleteQuery(DBObjectSearch $oFilter, $aArgs = array())
  2048. {
  2049. $aModifierProperties = self::MakeModifierProperties($oFilter);
  2050. $oBuild = new QueryBuilderContext($oFilter, $aModifierProperties);
  2051. $oSelect = self::MakeQuery($oBuild, $oFilter, null, array(), true /* main query */);
  2052. $oSelect->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  2053. $oSelect->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  2054. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  2055. return $oSelect->RenderDelete($aScalarArgs);
  2056. }
  2057. public static function MakeUpdateQuery(DBObjectSearch $oFilter, $aValues, $aArgs = array())
  2058. {
  2059. // $aValues is an array of $sAttCode => $value
  2060. $aModifierProperties = self::MakeModifierProperties($oFilter);
  2061. $oBuild = new QueryBuilderContext($oFilter, $aModifierProperties);
  2062. $oSelect = self::MakeQuery($oBuild, $oFilter, null, $aValues, true /* main query */);
  2063. $oSelect->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  2064. $oSelect->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  2065. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  2066. return $oSelect->RenderUpdate($aScalarArgs);
  2067. }
  2068. private static function MakeQuery(&$oBuild, DBObjectSearch $oFilter, $aAttToLoad = null, $aValues = array(), $bIsMainQueryUNUSED = false)
  2069. {
  2070. // Note: query class might be different than the class of the filter
  2071. // -> this occurs when we are linking our class to an external class (referenced by, or pointing to)
  2072. $sClass = $oFilter->GetFirstJoinedClass();
  2073. $sClassAlias = $oFilter->GetFirstJoinedClassAlias();
  2074. $bIsOnQueriedClass = array_key_exists($sClassAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  2075. self::DbgTrace("Entering: ".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  2076. $sRootClass = self::GetRootClass($sClass);
  2077. $sKeyField = self::DBGetKey($sClass);
  2078. if ($bIsOnQueriedClass)
  2079. {
  2080. // default to the whole list of attributes + the very std id/finalclass
  2081. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.'id', new FieldExpression('id', $sClassAlias));
  2082. if (is_null($aAttToLoad) || !array_key_exists($sClassAlias, $aAttToLoad))
  2083. {
  2084. $aAttList = self::ListAttributeDefs($sClass);
  2085. }
  2086. else
  2087. {
  2088. $aAttList = $aAttToLoad[$sClassAlias];
  2089. }
  2090. foreach ($aAttList as $sAttCode => $oAttDef)
  2091. {
  2092. if (!$oAttDef->IsScalar()) continue;
  2093. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  2094. {
  2095. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.$sAttCode.$sColId, new FieldExpression($sAttCode.$sColId, $sClassAlias));
  2096. }
  2097. }
  2098. // Transform the full text condition into additional condition expression
  2099. $aFullText = $oFilter->GetCriteria_FullText();
  2100. if (count($aFullText) > 0)
  2101. {
  2102. $aFullTextFields = array();
  2103. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  2104. {
  2105. if (!$oAttDef->IsScalar()) continue;
  2106. if ($oAttDef->IsExternalKey()) continue;
  2107. $aFullTextFields[] = new FieldExpression($sAttCode, $sClassAlias);
  2108. }
  2109. $oTextFields = new CharConcatWSExpression(' ', $aFullTextFields);
  2110. foreach($aFullText as $sFTNeedle)
  2111. {
  2112. $oNewCond = new BinaryExpression($oTextFields, 'LIKE', new ScalarExpression("%$sFTNeedle%"));
  2113. $oBuild->m_oQBExpressions->AddCondition($oNewCond);
  2114. }
  2115. }
  2116. }
  2117. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2118. $aExpectedAtts = array(); // array of (attcode => fieldexpression)
  2119. //echo "<p>".__LINE__.": GetUnresolvedFields($sClassAlias, ...)</p>\n";
  2120. $oBuild->m_oQBExpressions->GetUnresolvedFields($sClassAlias, $aExpectedAtts);
  2121. // Compute a clear view of required joins (from the current class)
  2122. // Build the list of external keys:
  2123. // -> ext keys required by an explicit join
  2124. // -> ext keys mentionned in a 'pointing to' condition
  2125. // -> ext keys required for an external field
  2126. // -> ext keys required for a friendly name
  2127. //
  2128. $aExtKeys = array(); // array of sTableClass => array of (sAttCode (keys) => array of (sAttCode (fields)=> oAttDef))
  2129. //
  2130. // Optimization: could be partially computed once for all (cached) ?
  2131. //
  2132. if ($bIsOnQueriedClass)
  2133. {
  2134. // Get all Ext keys for the queried class (??)
  2135. foreach(self::GetKeysList($sClass) as $sKeyAttCode)
  2136. {
  2137. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  2138. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  2139. }
  2140. }
  2141. // Get all Ext keys used by the filter
  2142. foreach ($oFilter->GetCriteria_PointingTo() as $sKeyAttCode => $aPointingTo)
  2143. {
  2144. if (array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  2145. {
  2146. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  2147. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  2148. }
  2149. }
  2150. if (array_key_exists('friendlyname', $aExpectedAtts))
  2151. {
  2152. $aTranslateNow = array();
  2153. $aTranslateNow[$sClassAlias]['friendlyname'] = self::GetNameExpression($sClass, $sClassAlias);
  2154. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2155. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  2156. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2157. $aNameSpec = self::GetNameSpec($sClass);
  2158. foreach($aNameSpec[1] as $i => $sAttCode)
  2159. {
  2160. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  2161. if ($oAttDef->IsExternalKey())
  2162. {
  2163. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sAttCode];
  2164. $aExtKeys[$sKeyTableClass][$sAttCode] = array();
  2165. }
  2166. elseif ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  2167. {
  2168. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  2169. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  2170. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  2171. }
  2172. }
  2173. }
  2174. // Add the ext fields used in the select (eventually adds an external key)
  2175. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2176. {
  2177. if ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  2178. {
  2179. if (array_key_exists($sAttCode, $aExpectedAtts))
  2180. {
  2181. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  2182. if ($sKeyAttCode != 'id')
  2183. {
  2184. // Add the external attribute
  2185. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  2186. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  2187. }
  2188. }
  2189. }
  2190. }
  2191. // First query built upon on the leaf (ie current) class
  2192. //
  2193. self::DbgTrace("Main (=leaf) class, call MakeQuerySingleTable()");
  2194. if (self::HasTable($sClass))
  2195. {
  2196. $oSelectBase = self::MakeQuerySingleTable($oBuild, $oFilter, $sClass, $aExtKeys, $aValues);
  2197. }
  2198. else
  2199. {
  2200. $oSelectBase = null;
  2201. // As the join will not filter on the expected classes, we have to specify it explicitely
  2202. $sExpectedClasses = implode("', '", self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  2203. $oFinalClassRestriction = Expression::FromOQL("`$sClassAlias`.finalclass IN ('$sExpectedClasses')");
  2204. $oBuild->m_oQBExpressions->AddCondition($oFinalClassRestriction);
  2205. }
  2206. // Then we join the queries of the eventual parent classes (compound model)
  2207. foreach(self::EnumParentClasses($sClass) as $sParentClass)
  2208. {
  2209. if (!self::HasTable($sParentClass)) continue;
  2210. //echo "<p>Parent class: $sParentClass... let's call MakeQuerySingleTable()</p>";
  2211. self::DbgTrace("Parent class: $sParentClass... let's call MakeQuerySingleTable()");
  2212. $oSelectParentTable = self::MakeQuerySingleTable($oBuild, $oFilter, $sParentClass, $aExtKeys, $aValues);
  2213. if (is_null($oSelectBase))
  2214. {
  2215. $oSelectBase = $oSelectParentTable;
  2216. }
  2217. else
  2218. {
  2219. $oSelectBase->AddInnerJoin($oSelectParentTable, $sKeyField, self::DBGetKey($sParentClass));
  2220. }
  2221. }
  2222. // Filter on objects referencing me
  2223. foreach ($oFilter->GetCriteria_ReferencedBy() as $sForeignClass => $aKeysAndFilters)
  2224. {
  2225. foreach ($aKeysAndFilters as $sForeignKeyAttCode => $oForeignFilter)
  2226. {
  2227. $oForeignKeyAttDef = self::GetAttributeDef($sForeignClass, $sForeignKeyAttCode);
  2228. self::DbgTrace("Referenced by foreign key: $sForeignKeyAttCode... let's call MakeQuery()");
  2229. //self::DbgTrace($oForeignFilter);
  2230. //self::DbgTrace($oForeignFilter->ToOQL());
  2231. //self::DbgTrace($oSelectForeign);
  2232. //self::DbgTrace($oSelectForeign->RenderSelect(array()));
  2233. $sForeignClassAlias = $oForeignFilter->GetFirstJoinedClassAlias();
  2234. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sForeignKeyAttCode, $sForeignClassAlias));
  2235. $oSelectForeign = self::MakeQuery($oBuild, $oForeignFilter, $aAttToLoad);
  2236. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  2237. $sForeignKeyTable = $oJoinExpr->GetParent();
  2238. $sForeignKeyColumn = $oJoinExpr->GetName();
  2239. $oSelectBase->AddInnerJoin($oSelectForeign, $sKeyField, $sForeignKeyColumn, $sForeignKeyTable);
  2240. }
  2241. }
  2242. // Filter on related objects
  2243. //
  2244. foreach ($oFilter->GetCriteria_RelatedTo() as $aCritInfo)
  2245. {
  2246. $oSubFilter = $aCritInfo['flt'];
  2247. $sRelCode = $aCritInfo['relcode'];
  2248. $iMaxDepth = $aCritInfo['maxdepth'];
  2249. // Get the starting point objects
  2250. $oStartSet = new CMDBObjectSet($oSubFilter);
  2251. // Get the objects related to those objects... recursively...
  2252. $aRelatedObjs = $oStartSet->GetRelatedObjects($sRelCode, $iMaxDepth);
  2253. $aRestriction = array_key_exists($sRootClass, $aRelatedObjs) ? $aRelatedObjs[$sRootClass] : array();
  2254. // #@# todo - related objects and expressions...
  2255. // Create condition
  2256. if (count($aRestriction) > 0)
  2257. {
  2258. $oSelectBase->AddCondition($sKeyField.' IN ('.implode(', ', CMDBSource::Quote(array_keys($aRestriction), true)).')');
  2259. }
  2260. else
  2261. {
  2262. // Quick N'dirty -> generate an empty set
  2263. $oSelectBase->AddCondition('false');
  2264. }
  2265. }
  2266. // That's all... cross fingers and we'll get some working query
  2267. //MyHelpers::var_dump_html($oSelectBase, true);
  2268. //MyHelpers::var_dump_html($oSelectBase->RenderSelect(), true);
  2269. if (self::$m_bDebugQuery) $oSelectBase->DisplayHtml();
  2270. return $oSelectBase;
  2271. }
  2272. protected static function MakeQuerySingleTable(&$oBuild, $oFilter, $sTableClass, $aExtKeys, $aValues)
  2273. {
  2274. // $aExtKeys is an array of sTableClass => array of (sAttCode (keys) => array of sAttCode (fields))
  2275. //echo "MAKEQUERY($sTableClass)-liste des clefs externes($sTableClass): <pre>".print_r($aExtKeys, true)."</pre><br/>\n";
  2276. // Prepare the query for a single table (compound objects)
  2277. // Ignores the items (attributes/filters) that are not on the target table
  2278. // Perform an (inner or left) join for every external key (and specify the expected fields)
  2279. //
  2280. // Returns an SQLQuery
  2281. //
  2282. $sTargetClass = $oFilter->GetFirstJoinedClass();
  2283. $sTargetAlias = $oFilter->GetFirstJoinedClassAlias();
  2284. $sTable = self::DBGetTable($sTableClass);
  2285. $sTableAlias = $oBuild->GenerateTableAlias($sTargetAlias.'_'.$sTable, $sTable);
  2286. $aTranslation = array();
  2287. $aExpectedAtts = array();
  2288. $oBuild->m_oQBExpressions->GetUnresolvedFields($sTargetAlias, $aExpectedAtts);
  2289. $bIsOnQueriedClass = array_key_exists($sTargetAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  2290. self::DbgTrace("Entering: tableclass=$sTableClass, filter=".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  2291. // 1 - SELECT and UPDATE
  2292. //
  2293. // Note: no need for any values nor fields for foreign Classes (ie not the queried Class)
  2294. //
  2295. $aUpdateValues = array();
  2296. // 1/a - Get the key and friendly name
  2297. //
  2298. // We need one pkey to be the key, let's take the one corresponding to the root class
  2299. // (used to be based on the leaf, but it may happen that this one has no table defined)
  2300. $sRootClass = self::GetRootClass($sTargetClass);
  2301. $oSelectedIdField = null;
  2302. if ($sTableClass == $sRootClass)
  2303. {
  2304. $oIdField = new FieldExpressionResolved(self::DBGetKey($sTableClass), $sTableAlias);
  2305. $aTranslation[$sTargetAlias]['id'] = $oIdField;
  2306. if ($bIsOnQueriedClass)
  2307. {
  2308. // Add this field to the list of queried fields (required for the COUNT to work fine)
  2309. $oSelectedIdField = $oIdField;
  2310. }
  2311. }
  2312. // 1/b - Get the other attributes
  2313. //
  2314. foreach(self::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  2315. {
  2316. // Skip this attribute if not defined in this table
  2317. if (self::$m_aAttribOrigins[$sTargetClass][$sAttCode] != $sTableClass) continue;
  2318. // Skip this attribute if not made of SQL columns
  2319. if (count($oAttDef->GetSQLExpressions()) == 0) continue;
  2320. // Update...
  2321. //
  2322. if ($bIsOnQueriedClass && array_key_exists($sAttCode, $aValues))
  2323. {
  2324. assert ($oAttDef->IsDirectField());
  2325. foreach ($oAttDef->GetSQLValues($aValues[$sAttCode]) as $sColumn => $sValue)
  2326. {
  2327. $aUpdateValues[$sColumn] = $sValue;
  2328. }
  2329. }
  2330. }
  2331. // 2 - The SQL query, for this table only
  2332. //
  2333. $oSelectBase = new SQLQuery($sTable, $sTableAlias, array(), $bIsOnQueriedClass, $aUpdateValues, $oSelectedIdField);
  2334. // 3 - Resolve expected expressions (translation table: alias.attcode => table.column)
  2335. //
  2336. foreach(self::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  2337. {
  2338. // Skip this attribute if not defined in this table
  2339. if (self::$m_aAttribOrigins[$sTargetClass][$sAttCode] != $sTableClass) continue;
  2340. // Select...
  2341. //
  2342. if ($oAttDef->IsExternalField())
  2343. {
  2344. // skip, this will be handled in the joined tables (done hereabove)
  2345. }
  2346. else
  2347. {
  2348. //echo "<p>MakeQuerySingleTable: Field $sAttCode is part of the table $sTable (named: $sTableAlias)</p>";
  2349. // standard field, or external key
  2350. // add it to the output
  2351. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  2352. {
  2353. if (array_key_exists($sAttCode.$sColId, $aExpectedAtts))
  2354. {
  2355. $oFieldSQLExp = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  2356. foreach (MetaModel::EnumPlugins('iQueryModifier') as $sPluginClass => $oQueryModifier)
  2357. {
  2358. $oFieldSQLExp = $oQueryModifier->GetFieldExpression($oBuild, $sTargetClass, $sAttCode, $sColId, $oFieldSQLExp, $oSelectBase);
  2359. }
  2360. $aTranslation[$sTargetAlias][$sAttCode.$sColId] = $oFieldSQLExp;
  2361. }
  2362. }
  2363. }
  2364. }
  2365. //echo "MAKEQUERY- Classe $sTableClass<br/>\n";
  2366. // 4 - The external keys -> joins...
  2367. //
  2368. $aAllPointingTo = $oFilter->GetCriteria_PointingTo();
  2369. if (array_key_exists($sTableClass, $aExtKeys))
  2370. {
  2371. foreach ($aExtKeys[$sTableClass] as $sKeyAttCode => $aExtFields)
  2372. {
  2373. $oKeyAttDef = self::GetAttributeDef($sTableClass, $sKeyAttCode);
  2374. $aPointingTo = $oFilter->GetCriteria_PointingTo($sKeyAttCode);
  2375. //echo "MAKEQUERY-Cle '$sKeyAttCode'<br/>\n";
  2376. if (!array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  2377. {
  2378. //echo "MAKEQUERY-Ajoutons l'operateur TREE_OPERATOR_EQUALS pour $sKeyAttCode<br/>\n";
  2379. // The join was not explicitely defined in the filter,
  2380. // we need to do it now
  2381. $sKeyClass = $oKeyAttDef->GetTargetClass();
  2382. $sKeyClassAlias = $oBuild->GenerateClassAlias($sKeyClass.'_'.$sKeyAttCode, $sKeyClass);
  2383. $oExtFilter = new DBObjectSearch($sKeyClass, $sKeyClassAlias);
  2384. $aAllPointingTo[$sKeyAttCode][TREE_OPERATOR_EQUALS][$sKeyClassAlias] = $oExtFilter;
  2385. }
  2386. }
  2387. }
  2388. //echo "MAKEQUERY-liste des clefs de jointure: <pre>".print_r(array_keys($aAllPointingTo), true)."</pre><br/>\n";
  2389. foreach ($aAllPointingTo as $sKeyAttCode => $aPointingTo)
  2390. {
  2391. foreach($aPointingTo as $iOperatorCode => $aFilter)
  2392. {
  2393. foreach($aFilter as $sAlias => $oExtFilter)
  2394. {
  2395. if (!MetaModel::IsValidAttCode($sTableClass, $sKeyAttCode)) continue; // Not defined in the class, skip it
  2396. // The aliases should not conflict because normalization occured while building the filter
  2397. $oKeyAttDef = self::GetAttributeDef($sTableClass, $sKeyAttCode);
  2398. $sKeyClass = $oExtFilter->GetFirstJoinedClass();
  2399. $sKeyClassAlias = $oExtFilter->GetFirstJoinedClassAlias();
  2400. //echo "MAKEQUERY-$sTableClass::$sKeyAttCode Foreach PointingTo($iOperatorCode) <span style=\"color:red\">$sKeyClass (alias:$sKeyClassAlias)</span><br/>\n";
  2401. // Note: there is no search condition in $oExtFilter, because normalization did merge the condition onto the top of the filter tree
  2402. //echo "MAKEQUERY-array_key_exists($sTableClass, \$aExtKeys)<br/>\n";
  2403. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  2404. {
  2405. if (array_key_exists($sTableClass, $aExtKeys) && array_key_exists($sKeyAttCode, $aExtKeys[$sTableClass]))
  2406. {
  2407. // Specify expected attributes for the target class query
  2408. // ... and use the current alias !
  2409. $aTranslateNow = array(); // Translation for external fields - must be performed before the join is done (recursion...)
  2410. foreach($aExtKeys[$sTableClass][$sKeyAttCode] as $sAttCode => $oAtt)
  2411. {
  2412. //echo "MAKEQUERY aExtKeys[$sTableClass][$sKeyAttCode] => $sAttCode-oAtt: <pre>".print_r($oAtt, true)."</pre><br/>\n";
  2413. if ($oAtt instanceof AttributeFriendlyName)
  2414. {
  2415. // Note: for a given ext key, there is one single attribute "friendly name"
  2416. $aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);
  2417. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);</b></p>\n";
  2418. }
  2419. else
  2420. {
  2421. $sExtAttCode = $oAtt->GetExtAttCode();
  2422. // Translate mainclass.extfield => remoteclassalias.remotefieldcode
  2423. $oRemoteAttDef = self::GetAttributeDef($sKeyClass, $sExtAttCode);
  2424. foreach ($oRemoteAttDef->GetSQLExpressions() as $sColID => $sRemoteAttExpr)
  2425. {
  2426. $aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);
  2427. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);</b></p>\n";
  2428. }
  2429. //echo "<p><b>ExtAttr2: $sTargetAlias.$sAttCode to $sKeyClassAlias.$sRemoteAttExpr (class: $sKeyClass)</b></p>\n";
  2430. }
  2431. }
  2432. // Translate prior to recursing
  2433. //
  2434. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."\n".print_r($aTranslateNow, true)."</pre></p>\n";
  2435. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  2436. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2437. //echo "<p>External key $sKeyAttCode (class: $sKeyClass), call MakeQuery()/p>\n";
  2438. self::DbgTrace("External key $sKeyAttCode (class: $sKeyClass), call MakeQuery()");
  2439. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression('id', $sKeyClassAlias));
  2440. //echo "<p>Recursive MakeQuery ".__LINE__.": <pre>\n".print_r($oBuild->GetRootFilter()->GetSelectedClasses(), true)."</pre></p>\n";
  2441. $oSelectExtKey = self::MakeQuery($oBuild, $oExtFilter);
  2442. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  2443. $sExternalKeyTable = $oJoinExpr->GetParent();
  2444. $sExternalKeyField = $oJoinExpr->GetName();
  2445. $aCols = $oKeyAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  2446. $sLocalKeyField = current($aCols); // get the first column for an external key
  2447. self::DbgTrace("External key $sKeyAttCode, Join on $sLocalKeyField = $sExternalKeyField");
  2448. if ($oKeyAttDef->IsNullAllowed())
  2449. {
  2450. $oSelectBase->AddLeftJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  2451. }
  2452. else
  2453. {
  2454. $oSelectBase->AddInnerJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  2455. }
  2456. }
  2457. }
  2458. elseif(self::$m_aAttribOrigins[$sKeyClass][$sKeyAttCode] == $sTableClass)
  2459. {
  2460. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sKeyAttCode, $sKeyClassAlias));
  2461. $oSelectExtKey = self::MakeQuery($oBuild, $oExtFilter);
  2462. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  2463. //echo "MAKEQUERY-PopJoinField pour $sKeyAttCode, $sKeyClassAlias: <pre>".print_r($oJoinExpr, true)."</pre><br/>\n";
  2464. $sExternalKeyTable = $oJoinExpr->GetParent();
  2465. $sExternalKeyField = $oJoinExpr->GetName();
  2466. $sLeftIndex = $sExternalKeyField.'_left'; // TODO use GetSQLLeft()
  2467. $sRightIndex = $sExternalKeyField.'_right'; // TODO use GetSQLRight()
  2468. $LocalKeyLeft = $oKeyAttDef->GetSQLLeft();
  2469. $LocalKeyRight = $oKeyAttDef->GetSQLRight();
  2470. //echo "MAKEQUERY-LocalKeyLeft pour $sKeyAttCode => $LocalKeyLeft<br/>\n";
  2471. $oSelectBase->AddInnerJoinTree($oSelectExtKey, $LocalKeyLeft, $LocalKeyRight, $sLeftIndex, $sRightIndex, $sExternalKeyTable, $iOperatorCode);
  2472. }
  2473. }
  2474. }
  2475. }
  2476. // Translate the selected columns
  2477. //
  2478. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2479. $oBuild->m_oQBExpressions->Translate($aTranslation, false);
  2480. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  2481. //MyHelpers::var_dump_html($oSelectBase->RenderSelect());
  2482. return $oSelectBase;
  2483. }
  2484. /**
  2485. * Special processing for the hierarchical keys stored as nested sets
  2486. * @param $iId integer The identifier of the parent
  2487. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2488. * @param $stable string The name of the database table containing the hierarchical key
  2489. */
  2490. public static function HKInsertChildUnder($iId, $oAttDef, $sTable)
  2491. {
  2492. // Get the parent id.right value
  2493. if ($iId == 0)
  2494. {
  2495. // No parent, insert completely at the right of the tree
  2496. $sSQL = "SELECT max(`".$oAttDef->GetSQLRight()."`) AS max FROM `$sTable`";
  2497. $aRes = CMDBSource::QueryToArray($sSQL);
  2498. if (count($aRes) == 0)
  2499. {
  2500. $iMyRight = 1;
  2501. }
  2502. else
  2503. {
  2504. $iMyRight = $aRes[0]['max']+1;
  2505. }
  2506. }
  2507. else
  2508. {
  2509. $sSQL = "SELECT `".$oAttDef->GetSQLRight()."` FROM `$sTable` WHERE id=".$iId;
  2510. $iMyRight = CMDBSource::QueryToScalar($sSQL);
  2511. $sSQLUpdateRight = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` + 2 WHERE `".$oAttDef->GetSQLRight()."` >= $iMyRight";
  2512. CMDBSource::Query($sSQLUpdateRight);
  2513. $sSQLUpdateLeft = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` + 2 WHERE `".$oAttDef->GetSQLLeft()."` > $iMyRight";
  2514. CMDBSource::Query($sSQLUpdateLeft);
  2515. }
  2516. return array($oAttDef->GetSQLRight() => $iMyRight+1, $oAttDef->GetSQLLeft() => $iMyRight);
  2517. }
  2518. /**
  2519. * Special processing for the hierarchical keys stored as nested sets: temporary remove the branch
  2520. * @param $iId integer The identifier of the parent
  2521. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2522. * @param $sTable string The name of the database table containing the hierarchical key
  2523. */
  2524. public static function HKTemporaryCutBranch($iMyLeft, $iMyRight, $oAttDef, $sTable)
  2525. {
  2526. $iDelta = $iMyRight - $iMyLeft + 1;
  2527. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = $iMyLeft - `".$oAttDef->GetSQLRight()."`, `".$oAttDef->GetSQLLeft()."` = $iMyLeft - `".$oAttDef->GetSQLLeft();
  2528. $sSQL .= "` WHERE `".$oAttDef->GetSQLLeft()."`> $iMyLeft AND `".$oAttDef->GetSQLRight()."`< $iMyRight";
  2529. CMDBSource::Query($sSQL);
  2530. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` - $iDelta WHERE `".$oAttDef->GetSQLLeft()."` > $iMyRight";
  2531. CMDBSource::Query($sSQL);
  2532. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` - $iDelta WHERE `".$oAttDef->GetSQLRight()."` > $iMyRight";
  2533. CMDBSource::Query($sSQL);
  2534. }
  2535. /**
  2536. * Special processing for the hierarchical keys stored as nested sets: replug the temporary removed branch
  2537. * @param $iId integer The identifier of the parent
  2538. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2539. * @param $sTable string The name of the database table containing the hierarchical key
  2540. */
  2541. public static function HKReplugBranch($iNewLeft, $iNewRight, $oAttDef, $sTable)
  2542. {
  2543. $iDelta = $iNewRight - $iNewLeft + 1;
  2544. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` + $iDelta WHERE `".$oAttDef->GetSQLLeft()."` > $iNewLeft";
  2545. CMDBSource::Query($sSQL);
  2546. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` + $iDelta WHERE `".$oAttDef->GetSQLRight()."` >= $iNewLeft";
  2547. CMDBSource::Query($sSQL);
  2548. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = $iNewLeft - `".$oAttDef->GetSQLRight()."`, `".$oAttDef->GetSQLLeft()."` = $iNewLeft - `".$oAttDef->GetSQLLeft()."` WHERE `".$oAttDef->GetSQLRight()."`< 0";
  2549. CMDBSource::Query($sSQL);
  2550. }
  2551. /**
  2552. * Check (and updates if needed) the hierarchical keys
  2553. * @param $bDiagnosticsOnly boolean If true only a diagnostic pass will be run, returning true or false
  2554. * @param $bVerbose boolean Displays some information about what is done/what needs to be done
  2555. * @param $bForceComputation boolean If true, the _left and _right parameters will be recomputed even if some values already exist in the DB
  2556. */
  2557. public static function CheckHKeys($bDiagnosticsOnly = false, $bVerbose = false, $bForceComputation = false)
  2558. {
  2559. $bChangeNeeded = false;
  2560. foreach (self::GetClasses() as $sClass)
  2561. {
  2562. if (!self::HasTable($sClass)) continue;
  2563. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2564. {
  2565. // Check (once) all the attributes that are hierarchical keys
  2566. if((self::GetAttributeOrigin($sClass, $sAttCode) == $sClass) && $oAttDef->IsHierarchicalKey())
  2567. {
  2568. if ($bVerbose)
  2569. {
  2570. echo "The attribute $sAttCode from $sClass is a hierarchical key.\n";
  2571. }
  2572. $bResult = self::HKInit($sClass, $sAttCode, $bDiagnosticsOnly, $bVerbose, $bForceComputation);
  2573. $bChangeNeeded |= $bResult;
  2574. if ($bVerbose && !$bResult)
  2575. {
  2576. echo "Ok, the attribute $sAttCode from class $sClass seems up to date.\n";
  2577. }
  2578. }
  2579. }
  2580. }
  2581. return $bChangeNeeded;
  2582. }
  2583. /**
  2584. * Initializes (i.e converts) a hierarchy stored using a 'parent_id' external key
  2585. * into a hierarchy stored with a HierarchicalKey, by initializing the _left and _right values
  2586. * to correspond to the existing hierarchy in the database
  2587. * @param $sClass string Name of the class to process
  2588. * @param $sAttCode string Code of the attribute to process
  2589. * @param $bDiagnosticsOnly boolean If true only a diagnostic pass will be run, returning true or false
  2590. * @param $bVerbose boolean Displays some information about what is done/what needs to be done
  2591. * @param $bForceComputation boolean If true, the _left and _right parameters will be recomputed even if some values already exist in the DB
  2592. * @return true if an update is needed (diagnostics only) / was performed
  2593. */
  2594. public static function HKInit($sClass, $sAttCode, $bDiagnosticsOnly = false, $bVerbose = false, $bForceComputation = false)
  2595. {
  2596. $idx = 1;
  2597. $bUpdateNeeded = $bForceComputation;
  2598. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  2599. $sTable = self::DBGetTable($sClass, $sAttCode);
  2600. if ($oAttDef->IsHierarchicalKey())
  2601. {
  2602. // Check if some values already exist in the table for the _right value, if so, do nothing
  2603. $sRight = $oAttDef->GetSQLRight();
  2604. $sSQL = "SELECT MAX(`$sRight`) AS MaxRight FROM `$sTable`";
  2605. $iMaxRight = CMDBSource::QueryToScalar($sSQL);
  2606. $sSQL = "SELECT COUNT(*) AS Count FROM `$sTable`"; // Note: COUNT(field) returns zero if the given field contains only NULLs
  2607. $iCount = CMDBSource::QueryToScalar($sSQL);
  2608. if (!$bForceComputation && ($iCount != 0) && ($iMaxRight == 0))
  2609. {
  2610. $bUpdateNeeded = true;
  2611. if ($bVerbose)
  2612. {
  2613. echo "The table '$sTable' must be updated to compute the fields $sRight and ".$oAttDef->GetSQLLeft()."\n";
  2614. }
  2615. }
  2616. if ($bForceComputation && !$bDiagnosticsOnly)
  2617. {
  2618. echo "Rebuilding the fields $sRight and ".$oAttDef->GetSQLLeft()." from table '$sTable'...\n";
  2619. }
  2620. if ($bUpdateNeeded && !$bDiagnosticsOnly)
  2621. {
  2622. try
  2623. {
  2624. CMDBSource::Query('START TRANSACTION');
  2625. self::HKInitChildren($sTable, $sAttCode, $oAttDef, 0, $idx);
  2626. CMDBSource::Query('COMMIT');
  2627. if ($bVerbose)
  2628. {
  2629. echo "Ok, table '$sTable' successfully updated.\n";
  2630. }
  2631. }
  2632. catch(Exception $e)
  2633. {
  2634. CMDBSource::Query('ROLLBACK');
  2635. throw new Exception("An error occured (".$e->getMessage().") while initializing the hierarchy for ($sClass, $sAttCode). The database was not modified.");
  2636. }
  2637. }
  2638. }
  2639. return $bUpdateNeeded;
  2640. }
  2641. /**
  2642. * Recursive helper function called by HKInit
  2643. */
  2644. protected static function HKInitChildren($sTable, $sAttCode, $oAttDef, $iId, &$iCurrIndex)
  2645. {
  2646. $sSQL = "SELECT id FROM `$sTable` WHERE `$sAttCode` = $iId";
  2647. $aRes = CMDBSource::QueryToArray($sSQL);
  2648. $aTree = array();
  2649. $sLeft = $oAttDef->GetSQLLeft();
  2650. $sRight = $oAttDef->GetSQLRight();
  2651. foreach($aRes as $aValues)
  2652. {
  2653. $iChildId = $aValues['id'];
  2654. $iLeft = $iCurrIndex++;
  2655. $aChildren = self::HKInitChildren($sTable, $sAttCode, $oAttDef, $iChildId, $iCurrIndex);
  2656. $iRight = $iCurrIndex++;
  2657. $sSQL = "UPDATE `$sTable` SET `$sLeft` = $iLeft, `$sRight` = $iRight WHERE id= $iChildId";
  2658. CMDBSource::Query($sSQL);
  2659. }
  2660. }
  2661. public static function CheckDataSources($bDiagnostics, $bVerbose)
  2662. {
  2663. $sOQL = 'SELECT SynchroDataSource';
  2664. $oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL));
  2665. $bFixNeeded = false;
  2666. if ($bVerbose && $oSet->Count() == 0)
  2667. {
  2668. echo "There are no Data Sources in the database.\n";
  2669. }
  2670. while($oSource = $oSet->Fetch())
  2671. {
  2672. if ($bVerbose)
  2673. {
  2674. echo "Checking Data Source '".$oSource->GetName()."'...\n";
  2675. $bFixNeeded = $bFixNeeded | $oSource->CheckDBConsistency($bDiagnostics, $bVerbose);
  2676. }
  2677. }
  2678. if (!$bFixNeeded && $bVerbose)
  2679. {
  2680. echo "Ok.\n";
  2681. }
  2682. return $bFixNeeded;
  2683. }
  2684. public static function GenerateUniqueAlias(&$aAliases, $sNewName, $sRealName)
  2685. {
  2686. if (!array_key_exists($sNewName, $aAliases))
  2687. {
  2688. $aAliases[$sNewName] = $sRealName;
  2689. return $sNewName;
  2690. }
  2691. for ($i = 1 ; $i < 100 ; $i++)
  2692. {
  2693. $sAnAlias = $sNewName.$i;
  2694. if (!array_key_exists($sAnAlias, $aAliases))
  2695. {
  2696. // Create that new alias
  2697. $aAliases[$sAnAlias] = $sRealName;
  2698. return $sAnAlias;
  2699. }
  2700. }
  2701. throw new CoreException('Failed to create an alias', array('aliases' => $aAliases, 'new'=>$sNewName));
  2702. }
  2703. public static function CheckDefinitions()
  2704. {
  2705. if (count(self::GetClasses()) == 0)
  2706. {
  2707. throw new CoreException("MetaModel::InitClasses() has not been called, or no class has been declared ?!?!");
  2708. }
  2709. $aErrors = array();
  2710. $aSugFix = array();
  2711. foreach (self::GetClasses() as $sClass)
  2712. {
  2713. $aNameSpec = self::GetNameSpec($sClass);
  2714. foreach($aNameSpec[1] as $i => $sAttCode)
  2715. {
  2716. if(!self::IsValidAttCode($sClass, $sAttCode))
  2717. {
  2718. $aErrors[$sClass][] = "Unkown attribute code '".$sAttCode."' for the name definition";
  2719. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2720. }
  2721. }
  2722. foreach(self::GetReconcKeys($sClass) as $sReconcKeyAttCode)
  2723. {
  2724. if (!empty($sReconcKeyAttCode) && !self::IsValidAttCode($sClass, $sReconcKeyAttCode))
  2725. {
  2726. $aErrors[$sClass][] = "Unkown attribute code '".$sReconcKeyAttCode."' in the list of reconciliation keys";
  2727. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2728. }
  2729. }
  2730. $bHasWritableAttribute = false;
  2731. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2732. {
  2733. // It makes no sense to check the attributes again and again in the subclasses
  2734. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2735. if ($oAttDef->IsExternalKey())
  2736. {
  2737. if (!self::IsValidClass($oAttDef->GetTargetClass()))
  2738. {
  2739. $aErrors[$sClass][] = "Unkown class '".$oAttDef->GetTargetClass()."' for the external key '$sAttCode'";
  2740. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetClasses())."}";
  2741. }
  2742. }
  2743. elseif ($oAttDef->IsExternalField())
  2744. {
  2745. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  2746. if (!self::IsValidAttCode($sClass, $sKeyAttCode) || !self::IsValidKeyAttCode($sClass, $sKeyAttCode))
  2747. {
  2748. $aErrors[$sClass][] = "Unkown key attribute code '".$sKeyAttCode."' for the external field $sAttCode";
  2749. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sClass))."}";
  2750. }
  2751. else
  2752. {
  2753. $oKeyAttDef = self::GetAttributeDef($sClass, $sKeyAttCode);
  2754. $sTargetClass = $oKeyAttDef->GetTargetClass();
  2755. $sExtAttCode = $oAttDef->GetExtAttCode();
  2756. if (!self::IsValidAttCode($sTargetClass, $sExtAttCode))
  2757. {
  2758. $aErrors[$sClass][] = "Unkown key attribute code '".$sExtAttCode."' for the external field $sAttCode";
  2759. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sTargetClass))."}";
  2760. }
  2761. }
  2762. }
  2763. else // standard attributes
  2764. {
  2765. // Check that the default values definition is a valid object!
  2766. $oValSetDef = $oAttDef->GetValuesDef();
  2767. if (!is_null($oValSetDef) && !$oValSetDef instanceof ValueSetDefinition)
  2768. {
  2769. $aErrors[$sClass][] = "Allowed values for attribute $sAttCode is not of the relevant type";
  2770. $aSugFix[$sClass][] = "Please set it as an instance of a ValueSetDefinition object.";
  2771. }
  2772. else
  2773. {
  2774. // Default value must be listed in the allowed values (if defined)
  2775. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  2776. if (!is_null($aAllowedValues))
  2777. {
  2778. $sDefaultValue = $oAttDef->GetDefaultValue();
  2779. if (is_string($sDefaultValue) && !array_key_exists($sDefaultValue, $aAllowedValues))
  2780. {
  2781. $aErrors[$sClass][] = "Default value '".$sDefaultValue."' for attribute $sAttCode is not an allowed value";
  2782. $aSugFix[$sClass][] = "Please pickup the default value out of {'".implode(", ", array_keys($aAllowedValues))."'}";
  2783. }
  2784. }
  2785. }
  2786. }
  2787. // Check dependencies
  2788. if ($oAttDef->IsWritable())
  2789. {
  2790. $bHasWritableAttribute = true;
  2791. foreach ($oAttDef->GetPrerequisiteAttributes() as $sDependOnAttCode)
  2792. {
  2793. if (!self::IsValidAttCode($sClass, $sDependOnAttCode))
  2794. {
  2795. $aErrors[$sClass][] = "Unkown attribute code '".$sDependOnAttCode."' in the list of prerequisite attributes";
  2796. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2797. }
  2798. }
  2799. }
  2800. }
  2801. foreach(self::GetClassFilterDefs($sClass) as $sFltCode=>$oFilterDef)
  2802. {
  2803. if (method_exists($oFilterDef, '__GetRefAttribute'))
  2804. {
  2805. $oAttDef = $oFilterDef->__GetRefAttribute();
  2806. if (!self::IsValidAttCode($sClass, $oAttDef->GetCode()))
  2807. {
  2808. $aErrors[$sClass][] = "Wrong attribute code '".$oAttDef->GetCode()."' (wrong class) for the \"basic\" filter $sFltCode";
  2809. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2810. }
  2811. }
  2812. }
  2813. // Lifecycle
  2814. //
  2815. $sStateAttCode = self::GetStateAttributeCode($sClass);
  2816. if (strlen($sStateAttCode) > 0)
  2817. {
  2818. // Lifecycle - check that the state attribute does exist as an attribute
  2819. if (!self::IsValidAttCode($sClass, $sStateAttCode))
  2820. {
  2821. $aErrors[$sClass][] = "Unkown attribute code '".$sStateAttCode."' for the state definition";
  2822. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2823. }
  2824. else
  2825. {
  2826. // Lifecycle - check that there is a value set constraint on the state attribute
  2827. $aAllowedValuesRaw = self::GetAllowedValues_att($sClass, $sStateAttCode);
  2828. $aStates = array_keys(self::EnumStates($sClass));
  2829. if (is_null($aAllowedValuesRaw))
  2830. {
  2831. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' will reflect the state of the object. It must be restricted to a set of values";
  2832. $aSugFix[$sClass][] = "Please define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')]";
  2833. }
  2834. else
  2835. {
  2836. $aAllowedValues = array_keys($aAllowedValuesRaw);
  2837. // Lifecycle - check the the state attribute allowed values are defined states
  2838. foreach($aAllowedValues as $sValue)
  2839. {
  2840. if (!in_array($sValue, $aStates))
  2841. {
  2842. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has an allowed value ($sValue) which is not a known state";
  2843. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  2844. }
  2845. }
  2846. // Lifecycle - check that defined states are allowed values
  2847. foreach($aStates as $sStateValue)
  2848. {
  2849. if (!in_array($sStateValue, $aAllowedValues))
  2850. {
  2851. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has a state ($sStateValue) which is not an allowed value";
  2852. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  2853. }
  2854. }
  2855. }
  2856. // Lifcycle - check that the action handlers are defined
  2857. foreach (self::EnumStates($sClass) as $sStateCode => $aStateDef)
  2858. {
  2859. foreach(self::EnumTransitions($sClass, $sStateCode) as $sStimulusCode => $aTransitionDef)
  2860. {
  2861. foreach ($aTransitionDef['actions'] as $sActionHandler)
  2862. {
  2863. if (!method_exists($sClass, $sActionHandler))
  2864. {
  2865. $aErrors[$sClass][] = "Unknown function '$sActionHandler' in transition [$sStateCode/$sStimulusCode] for state attribute '$sStateAttCode'";
  2866. $aSugFix[$sClass][] = "Specify a function which prototype is in the form [public function $sActionHandler(\$sStimulusCode){return true;}]";
  2867. }
  2868. }
  2869. }
  2870. }
  2871. }
  2872. }
  2873. if ($bHasWritableAttribute)
  2874. {
  2875. if (!self::HasTable($sClass))
  2876. {
  2877. $aErrors[$sClass][] = "No table has been defined for this class";
  2878. $aSugFix[$sClass][] = "Either define a table name or move the attributes elsewhere";
  2879. }
  2880. }
  2881. // ZList
  2882. //
  2883. foreach(self::EnumZLists() as $sListCode)
  2884. {
  2885. foreach (self::FlattenZList(self::GetZListItems($sClass, $sListCode)) as $sMyAttCode)
  2886. {
  2887. if (!self::IsValidAttCode($sClass, $sMyAttCode))
  2888. {
  2889. $aErrors[$sClass][] = "Unkown attribute code '".$sMyAttCode."' from ZList '$sListCode'";
  2890. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2891. }
  2892. }
  2893. }
  2894. // Check unicity of the SQL columns
  2895. //
  2896. if (self::HasTable($sClass))
  2897. {
  2898. $aTableColumns = array(); // array of column => attcode (the column is used by this attribute)
  2899. $aTableColumns[self::DBGetKey($sClass)] = 'id';
  2900. // Check that SQL columns are declared only once
  2901. //
  2902. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2903. {
  2904. // Skip this attribute if not originaly defined in this class
  2905. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2906. foreach($oAttDef->GetSQLColumns() as $sField => $sDBFieldType)
  2907. {
  2908. if (array_key_exists($sField, $aTableColumns))
  2909. {
  2910. $aErrors[$sClass][] = "Column '$sField' declared for attribute $sAttCode, but already used for attribute ".$aTableColumns[$sField];
  2911. $aSugFix[$sClass][] = "Please find another name for the SQL column";
  2912. }
  2913. else
  2914. {
  2915. $aTableColumns[$sField] = $sAttCode;
  2916. }
  2917. }
  2918. }
  2919. }
  2920. } // foreach class
  2921. if (count($aErrors) > 0)
  2922. {
  2923. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  2924. echo "<h3>Business model inconsistencies have been found</h3>\n";
  2925. // #@# later -> this is the responsibility of the caller to format the output
  2926. foreach ($aErrors as $sClass => $aMessages)
  2927. {
  2928. echo "<p>Wrong declaration for class <b>$sClass</b></p>\n";
  2929. echo "<ul class=\"treeview\">\n";
  2930. $i = 0;
  2931. foreach ($aMessages as $sMsg)
  2932. {
  2933. echo "<li>$sMsg ({$aSugFix[$sClass][$i]})</li>\n";
  2934. $i++;
  2935. }
  2936. echo "</ul>\n";
  2937. }
  2938. echo "<p>Aborting...</p>\n";
  2939. echo "</div>\n";
  2940. exit;
  2941. }
  2942. }
  2943. public static function DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes)
  2944. {
  2945. if (empty($sRepairUrl)) return;
  2946. // By design, some queries might be blank, we have to ignore them
  2947. $aCleanFixes = array();
  2948. foreach($aSQLFixes as $sSQLFix)
  2949. {
  2950. if (!empty($sSQLFix))
  2951. {
  2952. $aCleanFixes[] = $sSQLFix;
  2953. }
  2954. }
  2955. if (count($aCleanFixes) == 0) return;
  2956. echo "<form action=\"$sRepairUrl\" method=\"POST\">\n";
  2957. echo " <input type=\"hidden\" name=\"$sSQLStatementArgName\" value=\"".htmlentities(implode("##SEP##", $aCleanFixes), ENT_QUOTES, 'UTF-8')."\">\n";
  2958. echo " <input type=\"submit\" value=\" Apply changes (".count($aCleanFixes)." queries) \">\n";
  2959. echo "</form>\n";
  2960. }
  2961. public static function DBExists($bMustBeComplete = true)
  2962. {
  2963. // returns true if at least one table exists
  2964. //
  2965. if (!CMDBSource::IsDB(self::$m_sDBName))
  2966. {
  2967. return false;
  2968. }
  2969. CMDBSource::SelectDB(self::$m_sDBName);
  2970. $aFound = array();
  2971. $aMissing = array();
  2972. foreach (self::DBEnumTables() as $sTable => $aClasses)
  2973. {
  2974. if (CMDBSource::IsTable($sTable))
  2975. {
  2976. $aFound[] = $sTable;
  2977. }
  2978. else
  2979. {
  2980. $aMissing[] = $sTable;
  2981. }
  2982. }
  2983. if (count($aFound) == 0)
  2984. {
  2985. // no expected table has been found
  2986. return false;
  2987. }
  2988. else
  2989. {
  2990. if (count($aMissing) == 0)
  2991. {
  2992. // the database is complete (still, could be some fields missing!)
  2993. return true;
  2994. }
  2995. else
  2996. {
  2997. // not all the tables, could be an older version
  2998. if ($bMustBeComplete)
  2999. {
  3000. return false;
  3001. }
  3002. else
  3003. {
  3004. return true;
  3005. }
  3006. }
  3007. }
  3008. }
  3009. public static function DBDrop()
  3010. {
  3011. $bDropEntireDB = true;
  3012. if (!empty(self::$m_sTablePrefix))
  3013. {
  3014. // Do drop only tables corresponding to the sub-database (table prefix)
  3015. // then possibly drop the DB itself (if no table remain)
  3016. foreach (CMDBSource::EnumTables() as $sTable)
  3017. {
  3018. // perform a case insensitive test because on Windows the table names become lowercase :-(
  3019. if (strtolower(substr($sTable, 0, strlen(self::$m_sTablePrefix))) == strtolower(self::$m_sTablePrefix))
  3020. {
  3021. CMDBSource::DropTable($sTable);
  3022. }
  3023. else
  3024. {
  3025. // There is at least one table which is out of the scope of the current application
  3026. $bDropEntireDB = false;
  3027. }
  3028. }
  3029. }
  3030. if ($bDropEntireDB)
  3031. {
  3032. CMDBSource::DropDB(self::$m_sDBName);
  3033. }
  3034. }
  3035. public static function DBCreate()
  3036. {
  3037. // Note: we have to check if the DB does exist, because we may share the DB
  3038. // with other applications (in which case the DB does exist, not the tables with the given prefix)
  3039. if (!CMDBSource::IsDB(self::$m_sDBName))
  3040. {
  3041. CMDBSource::CreateDB(self::$m_sDBName);
  3042. }
  3043. self::DBCreateTables();
  3044. self::DBCreateViews();
  3045. }
  3046. protected static function DBCreateTables()
  3047. {
  3048. list($aErrors, $aSugFix, $aCondensedQueries) = self::DBCheckFormat();
  3049. //$sSQL = implode('; ', $aCondensedQueries); Does not work - multiple queries not allowed
  3050. foreach($aCondensedQueries as $sQuery)
  3051. {
  3052. CMDBSource::CreateTable($sQuery);
  3053. }
  3054. }
  3055. protected static function DBCreateViews()
  3056. {
  3057. list($aErrors, $aSugFix) = self::DBCheckViews();
  3058. $aSQL = array();
  3059. foreach ($aSugFix as $sClass => $aTarget)
  3060. {
  3061. foreach ($aTarget as $aQueries)
  3062. {
  3063. foreach ($aQueries as $sQuery)
  3064. {
  3065. if (!empty($sQuery))
  3066. {
  3067. //$aSQL[] = $sQuery;
  3068. // forces a refresh of cached information
  3069. CMDBSource::CreateTable($sQuery);
  3070. }
  3071. }
  3072. }
  3073. }
  3074. }
  3075. public static function DBDump()
  3076. {
  3077. $aDataDump = array();
  3078. foreach (self::DBEnumTables() as $sTable => $aClasses)
  3079. {
  3080. $aRows = CMDBSource::DumpTable($sTable);
  3081. $aDataDump[$sTable] = $aRows;
  3082. }
  3083. return $aDataDump;
  3084. }
  3085. /*
  3086. * Determines wether the target DB is frozen or not
  3087. */
  3088. public static function DBIsReadOnly()
  3089. {
  3090. // Improvement: check the mySQL variable -> Read-only
  3091. if (UserRights::IsAdministrator())
  3092. {
  3093. return (!self::DBHasAccess(ACCESS_ADMIN_WRITE));
  3094. }
  3095. else
  3096. {
  3097. return (!self::DBHasAccess(ACCESS_USER_WRITE));
  3098. }
  3099. }
  3100. public static function DBHasAccess($iRequested = ACCESS_FULL)
  3101. {
  3102. $iMode = self::$m_oConfig->Get('access_mode');
  3103. if (($iMode & $iRequested) == 0) return false;
  3104. return true;
  3105. }
  3106. protected static function MakeDictEntry($sKey, $sValueFromOldSystem, $sDefaultValue, &$bNotInDico)
  3107. {
  3108. $sValue = Dict::S($sKey, 'x-no-nothing');
  3109. if ($sValue == 'x-no-nothing')
  3110. {
  3111. $bNotInDico = true;
  3112. $sValue = $sValueFromOldSystem;
  3113. if (strlen($sValue) == 0)
  3114. {
  3115. $sValue = $sDefaultValue;
  3116. }
  3117. }
  3118. return " '$sKey' => '".str_replace("'", "\\'", $sValue)."',\n";
  3119. }
  3120. public static function MakeDictionaryTemplate($sModules = '', $sOutputFilter = 'NotInDictionary')
  3121. {
  3122. $sRes = '';
  3123. $sRes .= "// Dictionnay conventions\n";
  3124. $sRes .= htmlentities("// Class:<class_name>\n", ENT_QUOTES, 'UTF-8');
  3125. $sRes .= htmlentities("// Class:<class_name>+\n", ENT_QUOTES, 'UTF-8');
  3126. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>\n", ENT_QUOTES, 'UTF-8');
  3127. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>+\n", ENT_QUOTES, 'UTF-8');
  3128. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>\n", ENT_QUOTES, 'UTF-8');
  3129. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>+\n", ENT_QUOTES, 'UTF-8');
  3130. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>\n", ENT_QUOTES, 'UTF-8');
  3131. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>+\n", ENT_QUOTES, 'UTF-8');
  3132. $sRes .= "\n";
  3133. // Note: I did not use EnumCategories(), because a given class maybe found in several categories
  3134. // Need to invent the "module", to characterize the origins of a class
  3135. if (strlen($sModules) == 0)
  3136. {
  3137. $aModules = array('bizmodel', 'core/cmdb', 'gui' , 'application', 'addon/userrights');
  3138. }
  3139. else
  3140. {
  3141. $aModules = explode(', ', $sModules);
  3142. }
  3143. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  3144. $sRes .= "// Note: The classes have been grouped by categories: ".implode(', ', $aModules)."\n";
  3145. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  3146. foreach ($aModules as $sCategory)
  3147. {
  3148. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  3149. $sRes .= "// Classes in '<em>$sCategory</em>'\n";
  3150. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  3151. $sRes .= "//\n";
  3152. $sRes .= "\n";
  3153. foreach (self::GetClasses($sCategory) as $sClass)
  3154. {
  3155. if (!self::HasTable($sClass)) continue;
  3156. $bNotInDico = false;
  3157. $sClassRes = "//\n";
  3158. $sClassRes .= "// Class: $sClass\n";
  3159. $sClassRes .= "//\n";
  3160. $sClassRes .= "\n";
  3161. $sClassRes .= "Dict::Add('EN US', 'English', 'English', array(\n";
  3162. $sClassRes .= self::MakeDictEntry("Class:$sClass", self::GetName_Obsolete($sClass), $sClass, $bNotInDico);
  3163. $sClassRes .= self::MakeDictEntry("Class:$sClass+", self::GetClassDescription_Obsolete($sClass), '', $bNotInDico);
  3164. foreach(self::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  3165. {
  3166. // Skip this attribute if not originaly defined in this class
  3167. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  3168. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode", $oAttDef->GetLabel_Obsolete(), $sAttCode, $bNotInDico);
  3169. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode+", $oAttDef->GetDescription_Obsolete(), '', $bNotInDico);
  3170. if ($oAttDef instanceof AttributeEnum)
  3171. {
  3172. if (self::GetStateAttributeCode($sClass) == $sAttCode)
  3173. {
  3174. foreach (self::EnumStates($sClass) as $sStateCode => $aStateData)
  3175. {
  3176. if (array_key_exists('label', $aStateData))
  3177. {
  3178. $sValue = $aStateData['label'];
  3179. }
  3180. else
  3181. {
  3182. $sValue = MetaModel::GetStateLabel($sClass, $sStateCode);
  3183. }
  3184. if (array_key_exists('description', $aStateData))
  3185. {
  3186. $sValuePlus = $aStateData['description'];
  3187. }
  3188. else
  3189. {
  3190. $sValuePlus = MetaModel::GetStateDescription($sClass, $sStateCode);
  3191. }
  3192. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode", $sValue, '', $bNotInDico);
  3193. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode+", $sValuePlus, '', $bNotInDico);
  3194. }
  3195. }
  3196. else
  3197. {
  3198. foreach ($oAttDef->GetAllowedValues() as $sKey => $value)
  3199. {
  3200. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey", $value, '', $bNotInDico);
  3201. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey+", $value, '', $bNotInDico);
  3202. }
  3203. }
  3204. }
  3205. }
  3206. foreach(self::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
  3207. {
  3208. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode", $oStimulus->GetLabel_Obsolete(), '', $bNotInDico);
  3209. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode+", $oStimulus->GetDescription_Obsolete(), '', $bNotInDico);
  3210. }
  3211. $sClassRes .= "));\n";
  3212. $sClassRes .= "\n";
  3213. if ($bNotInDico || ($sOutputFilter != 'NotInDictionary'))
  3214. {
  3215. $sRes .= $sClassRes;
  3216. }
  3217. }
  3218. }
  3219. return $sRes;
  3220. }
  3221. public static function DBCheckFormat()
  3222. {
  3223. $aErrors = array();
  3224. $aSugFix = array();
  3225. // A new way of representing things to be done - quicker to execute !
  3226. $aCreateTable = array(); // array of <table> => <table options>
  3227. $aCreateTableItems = array(); // array of <table> => array of <create definition>
  3228. $aAlterTableItems = array(); // array of <table> => <alter specification>
  3229. foreach (self::GetClasses() as $sClass)
  3230. {
  3231. if (!self::HasTable($sClass)) continue;
  3232. // Check that the table exists
  3233. //
  3234. $sTable = self::DBGetTable($sClass);
  3235. $sKeyField = self::DBGetKey($sClass);
  3236. $sAutoIncrement = (self::IsAutoIncrementKey($sClass) ? "AUTO_INCREMENT" : "");
  3237. $sKeyFieldDefinition = "`$sKeyField` INT(11) NOT NULL $sAutoIncrement PRIMARY KEY";
  3238. if (!CMDBSource::IsTable($sTable))
  3239. {
  3240. $aErrors[$sClass]['*'][] = "table '$sTable' could not be found into the DB";
  3241. $aSugFix[$sClass]['*'][] = "CREATE TABLE `$sTable` ($sKeyFieldDefinition) ENGINE = ".MYSQL_ENGINE." CHARACTER SET utf8 COLLATE utf8_unicode_ci";
  3242. $aCreateTable[$sTable] = "ENGINE = ".MYSQL_ENGINE." CHARACTER SET utf8 COLLATE utf8_unicode_ci";
  3243. $aCreateTableItems[$sTable][$sKeyField] = $sKeyFieldDefinition;
  3244. }
  3245. // Check that the key field exists
  3246. //
  3247. elseif (!CMDBSource::IsField($sTable, $sKeyField))
  3248. {
  3249. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) could not be found";
  3250. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` ADD $sKeyFieldDefinition";
  3251. if (!array_key_exists($sTable, $aCreateTable))
  3252. {
  3253. $aAlterTableItems[$sTable][$sKeyField] = "ADD $sKeyFieldDefinition";
  3254. }
  3255. }
  3256. else
  3257. {
  3258. // Check the key field properties
  3259. //
  3260. if (!CMDBSource::IsKey($sTable, $sKeyField))
  3261. {
  3262. $aErrors[$sClass]['id'][] = "key '$sKeyField' is not a key for table '$sTable'";
  3263. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable`, DROP PRIMARY KEY, ADD PRIMARY key(`$sKeyField`)";
  3264. if (!array_key_exists($sTable, $aCreateTable))
  3265. {
  3266. $aAlterTableItems[$sTable][$sKeyField] = "CHANGE `$sKeyField` $sKeyFieldDefinition";
  3267. }
  3268. }
  3269. if (self::IsAutoIncrementKey($sClass) && !CMDBSource::IsAutoIncrement($sTable, $sKeyField))
  3270. {
  3271. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) is not automatically incremented";
  3272. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` CHANGE `$sKeyField` $sKeyFieldDefinition";
  3273. if (!array_key_exists($sTable, $aCreateTable))
  3274. {
  3275. $aAlterTableItems[$sTable][$sKeyField] = "CHANGE `$sKeyField` $sKeyFieldDefinition";
  3276. }
  3277. }
  3278. }
  3279. // Check that any defined field exists
  3280. //
  3281. $aTableInfo = CMDBSource::GetTableInfo($sTable);
  3282. $aTableInfo['Fields'][$sKeyField]['used'] = true;
  3283. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3284. {
  3285. // Skip this attribute if not originaly defined in this class
  3286. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  3287. foreach($oAttDef->GetSQLColumns() as $sField => $sDBFieldType)
  3288. {
  3289. // Keep track of columns used by iTop
  3290. $aTableInfo['Fields'][$sField]['used'] = true;
  3291. $bIndexNeeded = $oAttDef->RequiresIndex();
  3292. $sFieldDefinition = "`$sField` ".($oAttDef->IsNullAllowed() ? "$sDBFieldType NULL" : "$sDBFieldType NOT NULL");
  3293. if (!CMDBSource::IsField($sTable, $sField))
  3294. {
  3295. $aErrors[$sClass][$sAttCode][] = "field '$sField' could not be found in table '$sTable'";
  3296. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD $sFieldDefinition";
  3297. if ($bIndexNeeded)
  3298. {
  3299. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  3300. }
  3301. if (array_key_exists($sTable, $aCreateTable))
  3302. {
  3303. $aCreateTableItems[$sTable][$sField] = $sFieldDefinition;
  3304. if ($bIndexNeeded)
  3305. {
  3306. $aCreateTableItems[$sTable][$sField.'_ix'] = "INDEX (`$sField`)";
  3307. }
  3308. }
  3309. else
  3310. {
  3311. $aAlterTableItems[$sTable][$sField] = "ADD $sFieldDefinition";
  3312. if ($bIndexNeeded)
  3313. {
  3314. $aAlterTableItems[$sTable][$sField.'_ix'] = "ADD INDEX (`$sField`)";
  3315. }
  3316. }
  3317. }
  3318. else
  3319. {
  3320. // The field already exists, does it have the relevant properties?
  3321. //
  3322. $bToBeChanged = false;
  3323. if ($oAttDef->IsNullAllowed() != CMDBSource::IsNullAllowed($sTable, $sField))
  3324. {
  3325. $bToBeChanged = true;
  3326. if ($oAttDef->IsNullAllowed())
  3327. {
  3328. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could be NULL";
  3329. }
  3330. else
  3331. {
  3332. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could NOT be NULL";
  3333. }
  3334. }
  3335. $sActualFieldType = CMDBSource::GetFieldType($sTable, $sField);
  3336. if (strcasecmp($sDBFieldType, $sActualFieldType) != 0)
  3337. {
  3338. $bToBeChanged = true;
  3339. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' has a wrong type: found '$sActualFieldType' while expecting '$sDBFieldType'";
  3340. }
  3341. if ($bToBeChanged)
  3342. {
  3343. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` CHANGE `$sField` $sFieldDefinition";
  3344. $aAlterTableItems[$sTable][$sField] = "CHANGE `$sField` $sFieldDefinition";
  3345. }
  3346. // Create indexes (external keys only... so far)
  3347. //
  3348. if ($bIndexNeeded && !CMDBSource::HasIndex($sTable, $sField))
  3349. {
  3350. $aErrors[$sClass][$sAttCode][] = "Foreign key '$sField' in table '$sTable' should have an index";
  3351. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  3352. $aAlterTableItems[$sTable][$sField.'_ix'] = "ADD INDEX (`$sField`)";
  3353. }
  3354. }
  3355. }
  3356. }
  3357. // Find out unused columns
  3358. //
  3359. foreach($aTableInfo['Fields'] as $sField => $aFieldData)
  3360. {
  3361. if (!isset($aFieldData['used']) || !$aFieldData['used'])
  3362. {
  3363. $aErrors[$sClass]['*'][] = "Column '$sField' in table '$sTable' is not used";
  3364. if (!CMDBSource::IsNullAllowed($sTable, $sField))
  3365. {
  3366. // Allow null values so that new record can be inserted
  3367. // without specifying the value of this unknown column
  3368. $sFieldDefinition = "`$sField` ".CMDBSource::GetFieldType($sTable, $sField).' NULL';
  3369. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` CHANGE `$sField` $sFieldDefinition";
  3370. $aAlterTableItems[$sTable][$sField] = "CHANGE `$sField` $sFieldDefinition";
  3371. }
  3372. }
  3373. }
  3374. }
  3375. $aCondensedQueries = array();
  3376. foreach($aCreateTable as $sTable => $sTableOptions)
  3377. {
  3378. $sTableItems = implode(', ', $aCreateTableItems[$sTable]);
  3379. $aCondensedQueries[] = "CREATE TABLE `$sTable` ($sTableItems) $sTableOptions";
  3380. }
  3381. foreach($aAlterTableItems as $sTable => $aChangeList)
  3382. {
  3383. $sChangeList = implode(', ', $aChangeList);
  3384. $aCondensedQueries[] = "ALTER TABLE `$sTable` $sChangeList";
  3385. }
  3386. return array($aErrors, $aSugFix, $aCondensedQueries);
  3387. }
  3388. public static function DBCheckViews()
  3389. {
  3390. $aErrors = array();
  3391. $aSugFix = array();
  3392. // Reporting views (must be created after any other table)
  3393. //
  3394. foreach (self::GetClasses('bizmodel') as $sClass)
  3395. {
  3396. $sView = self::DBGetView($sClass);
  3397. if (CMDBSource::IsTable($sView))
  3398. {
  3399. // Check that the view is complete
  3400. //
  3401. $bIsComplete = true;
  3402. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3403. {
  3404. foreach($oAttDef->GetSQLExpressions() as $sSuffix => $sTrash)
  3405. {
  3406. $sCol = $sAttCode.$sSuffix;
  3407. if (!CMDBSource::IsField($sView, $sCol))
  3408. {
  3409. $bIsComplete = false;
  3410. $aErrors[$sClass][$sAttCode][] = "field '$sCol' could not be found in view '$sView'";
  3411. $aSugFix[$sClass][$sAttCode][] = "";
  3412. }
  3413. }
  3414. }
  3415. if (!$bIsComplete)
  3416. {
  3417. // Rework the view
  3418. //
  3419. $oFilter = new DBObjectSearch($sClass, '');
  3420. $oFilter->AllowAllData();
  3421. $sSQL = self::MakeSelectQuery($oFilter);
  3422. $aErrors[$sClass]['*'][] = "View '$sView' is currently not complete";
  3423. $aSugFix[$sClass]['*'][] = "ALTER VIEW `$sView` AS $sSQL";
  3424. }
  3425. }
  3426. else
  3427. {
  3428. // Create the view
  3429. //
  3430. $oFilter = new DBObjectSearch($sClass, '');
  3431. $oFilter->AllowAllData();
  3432. $sSQL = self::MakeSelectQuery($oFilter);
  3433. $aErrors[$sClass]['*'][] = "Missing view for class: $sClass";
  3434. $aSugFix[$sClass]['*'][] = "DROP VIEW IF EXISTS `$sView`";
  3435. $aSugFix[$sClass]['*'][] = "CREATE VIEW `$sView` AS $sSQL";
  3436. }
  3437. }
  3438. return array($aErrors, $aSugFix);
  3439. }
  3440. private static function DBCheckIntegrity_Check2Delete($sSelWrongRecs, $sErrorDesc, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel, $bProcessingFriends = false)
  3441. {
  3442. $sRootClass = self::GetRootClass($sClass);
  3443. $sTable = self::DBGetTable($sClass);
  3444. $sKeyField = self::DBGetKey($sClass);
  3445. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  3446. {
  3447. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  3448. }
  3449. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  3450. if (count($aWrongRecords) == 0) return;
  3451. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  3452. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3453. foreach ($aWrongRecords as $iRecordId)
  3454. {
  3455. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  3456. {
  3457. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  3458. {
  3459. case 'Delete':
  3460. // Already planned for a deletion
  3461. // Let's concatenate the errors description together
  3462. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  3463. break;
  3464. case 'Update':
  3465. // Let's plan a deletion
  3466. break;
  3467. }
  3468. }
  3469. else
  3470. {
  3471. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  3472. }
  3473. if (!$bProcessingFriends)
  3474. {
  3475. if (!array_key_exists($sTable, $aPlannedDel) || !in_array($iRecordId, $aPlannedDel[$sTable]))
  3476. {
  3477. // Something new to be deleted...
  3478. $iNewDelCount++;
  3479. }
  3480. }
  3481. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Delete';
  3482. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array();
  3483. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  3484. $aPlannedDel[$sTable][] = $iRecordId;
  3485. }
  3486. // Now make sure that we would delete the records of the other tables for that class
  3487. //
  3488. if (!$bProcessingFriends)
  3489. {
  3490. $sDeleteKeys = "'".implode("', '", $aWrongRecords)."'";
  3491. foreach (self::EnumChildClasses($sRootClass, ENUM_CHILD_CLASSES_ALL) as $sFriendClass)
  3492. {
  3493. $sFriendTable = self::DBGetTable($sFriendClass);
  3494. $sFriendKey = self::DBGetKey($sFriendClass);
  3495. // skip the current table
  3496. if ($sFriendTable == $sTable) continue;
  3497. $sFindRelatedRec = "SELECT DISTINCT maintable.`$sFriendKey` AS id FROM `$sFriendTable` AS maintable WHERE maintable.`$sFriendKey` IN ($sDeleteKeys)";
  3498. self::DBCheckIntegrity_Check2Delete($sFindRelatedRec, "Cascading deletion of record in friend table `<em>$sTable</em>`", $sFriendClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel, true);
  3499. }
  3500. }
  3501. }
  3502. private static function DBCheckIntegrity_Check2Update($sSelWrongRecs, $sErrorDesc, $sColumn, $sNewValue, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  3503. {
  3504. $sRootClass = self::GetRootClass($sClass);
  3505. $sTable = self::DBGetTable($sClass);
  3506. $sKeyField = self::DBGetKey($sClass);
  3507. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  3508. {
  3509. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  3510. }
  3511. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  3512. if (count($aWrongRecords) == 0) return;
  3513. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  3514. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3515. foreach ($aWrongRecords as $iRecordId)
  3516. {
  3517. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  3518. {
  3519. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  3520. {
  3521. case 'Delete':
  3522. // No need to update, the record will be deleted!
  3523. break;
  3524. case 'Update':
  3525. // Already planned for an update
  3526. // Add this new update spec to the list
  3527. $bFoundSameSpec = false;
  3528. foreach ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] as $aUpdateSpec)
  3529. {
  3530. if (($sColumn == $aUpdateSpec['column']) && ($sNewValue == $aUpdateSpec['newvalue']))
  3531. {
  3532. $bFoundSameSpec = true;
  3533. }
  3534. }
  3535. if (!$bFoundSameSpec)
  3536. {
  3537. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'][] = (array('column' => $sColumn, 'newvalue'=>$sNewValue));
  3538. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  3539. }
  3540. break;
  3541. }
  3542. }
  3543. else
  3544. {
  3545. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  3546. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Update';
  3547. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array(array('column' => $sColumn, 'newvalue'=>$sNewValue));
  3548. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  3549. }
  3550. }
  3551. }
  3552. // returns the count of records found for deletion
  3553. public static function DBCheckIntegrity_SinglePass(&$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  3554. {
  3555. foreach (self::GetClasses() as $sClass)
  3556. {
  3557. if (!self::HasTable($sClass)) continue;
  3558. $sRootClass = self::GetRootClass($sClass);
  3559. $sTable = self::DBGetTable($sClass);
  3560. $sKeyField = self::DBGetKey($sClass);
  3561. if (!self::IsStandaloneClass($sClass))
  3562. {
  3563. if (self::IsRootClass($sClass))
  3564. {
  3565. // Check that the final class field contains the name of a class which inherited from the current class
  3566. //
  3567. $sFinalClassField = self::DBGetClassField($sClass);
  3568. $aAllowedValues = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  3569. $sAllowedValues = implode(",", CMDBSource::Quote($aAllowedValues, true));
  3570. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE `$sFinalClassField` NOT IN ($sAllowedValues)";
  3571. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "final class (field `<em>$sFinalClassField</em>`) is wrong (expected a value in {".$sAllowedValues."})", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3572. }
  3573. else
  3574. {
  3575. $sRootTable = self::DBGetTable($sRootClass);
  3576. $sRootKey = self::DBGetKey($sRootClass);
  3577. $sFinalClassField = self::DBGetClassField($sRootClass);
  3578. $aExpectedClasses = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  3579. $sExpectedClasses = implode(",", CMDBSource::Quote($aExpectedClasses, true));
  3580. // Check that any record found here has its counterpart in the root table
  3581. // and which refers to a child class
  3582. //
  3583. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` as maintable LEFT JOIN `$sRootTable` ON maintable.`$sKeyField` = `$sRootTable`.`$sRootKey` AND `$sRootTable`.`$sFinalClassField` IN ($sExpectedClasses) WHERE `$sRootTable`.`$sRootKey` IS NULL";
  3584. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Found a record in `<em>$sTable</em>`, but no counterpart in root table `<em>$sRootTable</em>` (inc. records pointing to a class in {".$sExpectedClasses."})", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3585. // Check that any record found in the root table and referring to a child class
  3586. // has its counterpart here (detect orphan nodes -root or in the middle of the hierarchy)
  3587. //
  3588. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sRootKey` AS id FROM `$sRootTable` AS maintable LEFT JOIN `$sTable` ON maintable.`$sRootKey` = `$sTable`.`$sKeyField` WHERE `$sTable`.`$sKeyField` IS NULL AND maintable.`$sFinalClassField` IN ($sExpectedClasses)";
  3589. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Found a record in root table `<em>$sRootTable</em>`, but no counterpart in table `<em>$sTable</em>` (root records pointing to a class in {".$sExpectedClasses."})", $sRootClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3590. }
  3591. }
  3592. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3593. {
  3594. // Skip this attribute if not defined in this table
  3595. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  3596. if ($oAttDef->IsExternalKey())
  3597. {
  3598. // Check that any external field is pointing to an existing object
  3599. //
  3600. $sRemoteClass = $oAttDef->GetTargetClass();
  3601. $sRemoteTable = self::DBGetTable($sRemoteClass);
  3602. $sRemoteKey = self::DBGetKey($sRemoteClass);
  3603. $aCols = $oAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  3604. $sExtKeyField = current($aCols); // get the first column for an external key
  3605. // Note: a class/table may have an external key on itself
  3606. $sSelBase = "SELECT DISTINCT maintable.`$sKeyField` AS id, maintable.`$sExtKeyField` AS extkey FROM `$sTable` AS maintable LEFT JOIN `$sRemoteTable` ON maintable.`$sExtKeyField` = `$sRemoteTable`.`$sRemoteKey`";
  3607. $sSelWrongRecs = $sSelBase." WHERE `$sRemoteTable`.`$sRemoteKey` IS NULL";
  3608. if ($oAttDef->IsNullAllowed())
  3609. {
  3610. // Exclude the records pointing to 0/null from the errors
  3611. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  3612. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  3613. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3614. }
  3615. else
  3616. {
  3617. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3618. }
  3619. // Do almost the same, taking into account the records planned for deletion
  3620. if (array_key_exists($sRemoteTable, $aPlannedDel) && count($aPlannedDel[$sRemoteTable]) > 0)
  3621. {
  3622. // This could be done by the mean of a 'OR ... IN (aIgnoreRecords)
  3623. // but in that case you won't be able to track the root cause (cascading)
  3624. $sSelWrongRecs = $sSelBase." WHERE maintable.`$sExtKeyField` IN ('".implode("', '", $aPlannedDel[$sRemoteTable])."')";
  3625. if ($oAttDef->IsNullAllowed())
  3626. {
  3627. // Exclude the records pointing to 0/null from the errors
  3628. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  3629. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  3630. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3631. }
  3632. else
  3633. {
  3634. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3635. }
  3636. }
  3637. }
  3638. else if ($oAttDef->IsDirectField())
  3639. {
  3640. // Check that the values fit the allowed values
  3641. //
  3642. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  3643. if (!is_null($aAllowedValues) && count($aAllowedValues) > 0)
  3644. {
  3645. $sExpectedValues = implode(",", CMDBSource::Quote(array_keys($aAllowedValues), true));
  3646. $aCols = $oAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  3647. $sMyAttributeField = current($aCols); // get the first column for the moment
  3648. $sDefaultValue = $oAttDef->GetDefaultValue();
  3649. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE maintable.`$sMyAttributeField` NOT IN ($sExpectedValues)";
  3650. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record having a column ('<em>$sAttCode</em>') with an unexpected value", $sMyAttributeField, CMDBSource::Quote($sDefaultValue), $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3651. }
  3652. }
  3653. }
  3654. }
  3655. }
  3656. public static function DBCheckIntegrity($sRepairUrl = "", $sSQLStatementArgName = "")
  3657. {
  3658. // Records in error, and action to be taken: delete or update
  3659. // by RootClass/Table/Record
  3660. $aErrorsAndFixes = array();
  3661. // Records to be ignored in the current/next pass
  3662. // by Table = array of RecordId
  3663. $aPlannedDel = array();
  3664. // Count of errors in the next pass: no error means that we can leave...
  3665. $iErrorCount = 0;
  3666. // Limit in case of a bug in the algorythm
  3667. $iLoopCount = 0;
  3668. $iNewDelCount = 1; // startup...
  3669. while ($iNewDelCount > 0)
  3670. {
  3671. $iNewDelCount = 0;
  3672. self::DBCheckIntegrity_SinglePass($aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3673. $iErrorCount += $iNewDelCount;
  3674. // Safety net #1 - limit the planned deletions
  3675. //
  3676. $iMaxDel = 1000;
  3677. $iPlannedDel = 0;
  3678. foreach ($aPlannedDel as $sTable => $aPlannedDelOnTable)
  3679. {
  3680. $iPlannedDel += count($aPlannedDelOnTable);
  3681. }
  3682. if ($iPlannedDel > $iMaxDel)
  3683. {
  3684. throw new CoreWarning("DB Integrity Check safety net - Exceeding the limit of $iMaxDel planned record deletion");
  3685. break;
  3686. }
  3687. // Safety net #2 - limit the iterations
  3688. //
  3689. $iLoopCount++;
  3690. $iMaxLoops = 10;
  3691. if ($iLoopCount > $iMaxLoops)
  3692. {
  3693. throw new CoreWarning("DB Integrity Check safety net - Reached the limit of $iMaxLoops loops");
  3694. break;
  3695. }
  3696. }
  3697. // Display the results
  3698. //
  3699. $iIssueCount = 0;
  3700. $aFixesDelete = array();
  3701. $aFixesUpdate = array();
  3702. foreach ($aErrorsAndFixes as $sRootClass => $aTables)
  3703. {
  3704. foreach ($aTables as $sTable => $aRecords)
  3705. {
  3706. foreach ($aRecords as $iRecord => $aError)
  3707. {
  3708. $sAction = $aError['Action'];
  3709. $sReason = $aError['Reason'];
  3710. $iPass = $aError['Pass'];
  3711. switch ($sAction)
  3712. {
  3713. case 'Delete':
  3714. $sActionDetails = "";
  3715. $aFixesDelete[$sTable][] = $iRecord;
  3716. break;
  3717. case 'Update':
  3718. $aUpdateDesc = array();
  3719. foreach($aError['Action_Details'] as $aUpdateSpec)
  3720. {
  3721. $aUpdateDesc[] = $aUpdateSpec['column']." -&gt; ".$aUpdateSpec['newvalue'];
  3722. $aFixesUpdate[$sTable][$aUpdateSpec['column']][$aUpdateSpec['newvalue']][] = $iRecord;
  3723. }
  3724. $sActionDetails = "Set ".implode(", ", $aUpdateDesc);
  3725. break;
  3726. default:
  3727. $sActionDetails = "bug: unknown action '$sAction'";
  3728. }
  3729. $aIssues[] = "$sRootClass / $sTable / $iRecord / $sReason / $sAction / $sActionDetails";
  3730. $iIssueCount++;
  3731. }
  3732. }
  3733. }
  3734. if ($iIssueCount > 0)
  3735. {
  3736. // Build the queries to fix in the database
  3737. //
  3738. // First step, be able to get class data out of the table name
  3739. // Could be optimized, because we've made the job earlier... but few benefits, so...
  3740. $aTable2ClassProp = array();
  3741. foreach (self::GetClasses() as $sClass)
  3742. {
  3743. if (!self::HasTable($sClass)) continue;
  3744. $sRootClass = self::GetRootClass($sClass);
  3745. $sTable = self::DBGetTable($sClass);
  3746. $sKeyField = self::DBGetKey($sClass);
  3747. $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3748. $aTable2ClassProp[$sTable] = array('rootclass'=>$sRootClass, 'class'=>$sClass, 'keyfield'=>$sKeyField);
  3749. }
  3750. // Second step, build a flat list of SQL queries
  3751. $aSQLFixes = array();
  3752. $iPlannedUpdate = 0;
  3753. foreach ($aFixesUpdate as $sTable => $aColumns)
  3754. {
  3755. foreach ($aColumns as $sColumn => $aNewValues)
  3756. {
  3757. foreach ($aNewValues as $sNewValue => $aRecords)
  3758. {
  3759. $iPlannedUpdate += count($aRecords);
  3760. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  3761. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  3762. $aSQLFixes[] = "UPDATE `$sTable` SET `$sColumn` = $sNewValue WHERE `$sKeyField` IN ($sWrongRecords)";
  3763. }
  3764. }
  3765. }
  3766. $iPlannedDel = 0;
  3767. foreach ($aFixesDelete as $sTable => $aRecords)
  3768. {
  3769. $iPlannedDel += count($aRecords);
  3770. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  3771. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  3772. $aSQLFixes[] = "DELETE FROM `$sTable` WHERE `$sKeyField` IN ($sWrongRecords)";
  3773. }
  3774. // Report the results
  3775. //
  3776. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  3777. echo "<h3>Database corruption error(s): $iErrorCount issues have been encountered. $iPlannedDel records will be deleted, $iPlannedUpdate records will be updated:</h3>\n";
  3778. // #@# later -> this is the responsibility of the caller to format the output
  3779. echo "<ul class=\"treeview\">\n";
  3780. foreach ($aIssues as $sIssueDesc)
  3781. {
  3782. echo "<li>$sIssueDesc</li>\n";
  3783. }
  3784. echo "</ul>\n";
  3785. self::DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes);
  3786. echo "<p>Aborting...</p>\n";
  3787. echo "</div>\n";
  3788. exit;
  3789. }
  3790. }
  3791. public static function Startup($config, $bModelOnly = false, $bAllowCache = true, $bTraceSourceFiles = false)
  3792. {
  3793. define('MODULESROOT', APPROOT.'env-'.utils::GetCurrentEnvironment().'/');
  3794. self::$m_bTraceSourceFiles = $bTraceSourceFiles;
  3795. // $config can be either a filename, or a Configuration object (volatile!)
  3796. if ($config instanceof Config)
  3797. {
  3798. self::LoadConfig($config, $bAllowCache);
  3799. }
  3800. else
  3801. {
  3802. self::LoadConfig(new Config($config), $bAllowCache);
  3803. }
  3804. if ($bModelOnly) return;
  3805. CMDBSource::SelectDB(self::$m_sDBName);
  3806. foreach(get_declared_classes() as $sPHPClass)
  3807. {
  3808. if (is_subclass_of($sPHPClass, 'ModuleHandlerAPI'))
  3809. {
  3810. $aCallSpec = array($sPHPClass, 'OnMetaModelStarted');
  3811. call_user_func_array($aCallSpec, array());
  3812. }
  3813. }
  3814. if (false)
  3815. {
  3816. echo "Debug<br/>\n";
  3817. self::static_var_dump();
  3818. }
  3819. }
  3820. public static function LoadConfig($oConfiguration, $bAllowCache = false)
  3821. {
  3822. self::$m_oConfig = $oConfiguration;
  3823. // Set log ASAP
  3824. if (self::$m_oConfig->GetLogGlobal())
  3825. {
  3826. if (self::$m_oConfig->GetLogIssue())
  3827. {
  3828. self::$m_bLogIssue = true;
  3829. IssueLog::Enable(APPROOT.'/error.log');
  3830. }
  3831. self::$m_bLogNotification = self::$m_oConfig->GetLogNotification();
  3832. self::$m_bLogWebService = self::$m_oConfig->GetLogWebService();
  3833. ToolsLog::Enable(APPROOT.'/tools.log');
  3834. }
  3835. else
  3836. {
  3837. self::$m_bLogIssue = false;
  3838. self::$m_bLogNotification = false;
  3839. self::$m_bLogWebService = false;
  3840. }
  3841. if (self::$m_oConfig->GetLogKPIDuration())
  3842. {
  3843. ExecutionKPI::EnableDuration();
  3844. }
  3845. if (self::$m_oConfig->GetLogKPIMemory())
  3846. {
  3847. ExecutionKPI::EnableMemory();
  3848. }
  3849. self::$m_bTraceQueries = self::$m_oConfig->GetDebugQueries();
  3850. self::$m_bQueryCacheEnabled = self::$m_oConfig->GetQueryCacheEnabled();
  3851. self::$m_bSkipCheckToWrite = self::$m_oConfig->Get('skip_check_to_write');
  3852. self::$m_bSkipCheckExtKeys = self::$m_oConfig->Get('skip_check_ext_keys');
  3853. self::$m_bUseAPCCache = $bAllowCache
  3854. && self::$m_oConfig->Get('apc_cache.enabled')
  3855. && function_exists('apc_fetch')
  3856. && function_exists('apc_store');
  3857. self::$m_iQueryCacheTTL = self::$m_oConfig->Get('apc_cache.query_ttl');
  3858. // PHP timezone first...
  3859. //
  3860. $sPHPTimezone = self::$m_oConfig->Get('timezone');
  3861. if ($sPHPTimezone == '')
  3862. {
  3863. // Leave as is... up to the admin to set a value somewhere...
  3864. //$sPHPTimezone = date_default_timezone_get();
  3865. }
  3866. else
  3867. {
  3868. date_default_timezone_set($sPHPTimezone);
  3869. }
  3870. // Note: load the dictionary as soon as possible, because it might be
  3871. // needed when some error occur
  3872. $sAppIdentity = 'itop-'.MetaModel::GetEnvironmentId();
  3873. $bDictInitializedFromData = false;
  3874. if (!self::$m_bUseAPCCache || !Dict::InCache($sAppIdentity))
  3875. {
  3876. $bDictInitializedFromData = true;
  3877. foreach (self::$m_oConfig->GetDictionaries() as $sModule => $sToInclude)
  3878. {
  3879. self::IncludeModule('dictionaries', $sToInclude);
  3880. }
  3881. }
  3882. // Set the language... after the dictionaries have been loaded!
  3883. Dict::SetDefaultLanguage(self::$m_oConfig->GetDefaultLanguage());
  3884. // Romain: this is the only way I've found to cope with the fact that
  3885. // classes have to be derived from cmdbabstract (to be editable in the UI)
  3886. require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
  3887. foreach (self::$m_oConfig->GetAppModules() as $sModule => $sToInclude)
  3888. {
  3889. self::IncludeModule('application', $sToInclude);
  3890. }
  3891. foreach (self::$m_oConfig->GetDataModels() as $sModule => $sToInclude)
  3892. {
  3893. self::IncludeModule('business', $sToInclude);
  3894. }
  3895. foreach (self::$m_oConfig->GetWebServiceCategories() as $sModule => $sToInclude)
  3896. {
  3897. self::IncludeModule('webservice', $sToInclude);
  3898. }
  3899. foreach (self::$m_oConfig->GetAddons() as $sModule => $sToInclude)
  3900. {
  3901. self::IncludeModule('addons', $sToInclude);
  3902. }
  3903. $sServer = self::$m_oConfig->GetDBHost();
  3904. $sUser = self::$m_oConfig->GetDBUser();
  3905. $sPwd = self::$m_oConfig->GetDBPwd();
  3906. $sSource = self::$m_oConfig->GetDBName();
  3907. $sTablePrefix = self::$m_oConfig->GetDBSubname();
  3908. $sCharacterSet = self::$m_oConfig->GetDBCharacterSet();
  3909. $sCollation = self::$m_oConfig->GetDBCollation();
  3910. if (self::$m_bUseAPCCache)
  3911. {
  3912. $oKPI = new ExecutionKPI();
  3913. // Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
  3914. //
  3915. $sOqlAPCCacheId = 'itop-'.MetaModel::GetEnvironmentId().'-metamodel';
  3916. $result = apc_fetch($sOqlAPCCacheId);
  3917. if (is_array($result))
  3918. {
  3919. // todo - verifier que toutes les classes mentionnees ici sont chargees dans InitClasses()
  3920. self::$m_aExtensionClasses = $result['m_aExtensionClasses'];
  3921. self::$m_Category2Class = $result['m_Category2Class'];
  3922. self::$m_aRootClasses = $result['m_aRootClasses'];
  3923. self::$m_aParentClasses = $result['m_aParentClasses'];
  3924. self::$m_aChildClasses = $result['m_aChildClasses'];
  3925. self::$m_aClassParams = $result['m_aClassParams'];
  3926. self::$m_aAttribDefs = $result['m_aAttribDefs'];
  3927. self::$m_aAttribOrigins = $result['m_aAttribOrigins'];
  3928. self::$m_aExtKeyFriends = $result['m_aExtKeyFriends'];
  3929. self::$m_aIgnoredAttributes = $result['m_aIgnoredAttributes'];
  3930. self::$m_aFilterDefs = $result['m_aFilterDefs'];
  3931. self::$m_aFilterOrigins = $result['m_aFilterOrigins'];
  3932. self::$m_aListInfos = $result['m_aListInfos'];
  3933. self::$m_aListData = $result['m_aListData'];
  3934. self::$m_aRelationInfos = $result['m_aRelationInfos'];
  3935. self::$m_aStates = $result['m_aStates'];
  3936. self::$m_aStimuli = $result['m_aStimuli'];
  3937. self::$m_aTransitions = $result['m_aTransitions'];
  3938. }
  3939. $oKPI->ComputeAndReport('Metamodel APC (fetch + read)');
  3940. }
  3941. if (count(self::$m_aAttribDefs) == 0)
  3942. {
  3943. // The includes have been included, let's browse the existing classes and
  3944. // develop some data based on the proposed model
  3945. $oKPI = new ExecutionKPI();
  3946. self::InitClasses($sTablePrefix);
  3947. $oKPI->ComputeAndReport('Initialization of Data model structures');
  3948. if (self::$m_bUseAPCCache)
  3949. {
  3950. $oKPI = new ExecutionKPI();
  3951. $aCache = array();
  3952. $aCache['m_aExtensionClasses'] = self::$m_aExtensionClasses;
  3953. $aCache['m_Category2Class'] = self::$m_Category2Class;
  3954. $aCache['m_aRootClasses'] = self::$m_aRootClasses; // array of "classname" => "rootclass"
  3955. $aCache['m_aParentClasses'] = self::$m_aParentClasses; // array of ("classname" => array of "parentclass")
  3956. $aCache['m_aChildClasses'] = self::$m_aChildClasses; // array of ("classname" => array of "childclass")
  3957. $aCache['m_aClassParams'] = self::$m_aClassParams; // array of ("classname" => array of class information)
  3958. $aCache['m_aAttribDefs'] = self::$m_aAttribDefs; // array of ("classname" => array of attributes)
  3959. $aCache['m_aAttribOrigins'] = self::$m_aAttribOrigins; // array of ("classname" => array of ("attcode"=>"sourceclass"))
  3960. $aCache['m_aExtKeyFriends'] = self::$m_aExtKeyFriends; // array of ("classname" => array of ("indirect ext key attcode"=> array of ("relative ext field")))
  3961. $aCache['m_aIgnoredAttributes'] = self::$m_aIgnoredAttributes; //array of ("classname" => array of ("attcode")
  3962. $aCache['m_aFilterDefs'] = self::$m_aFilterDefs; // array of ("classname" => array filterdef)
  3963. $aCache['m_aFilterOrigins'] = self::$m_aFilterOrigins; // array of ("classname" => array of ("attcode"=>"sourceclass"))
  3964. $aCache['m_aListInfos'] = self::$m_aListInfos; // array of ("listcode" => various info on the list, common to every classes)
  3965. $aCache['m_aListData'] = self::$m_aListData; // array of ("classname" => array of "listcode" => list)
  3966. $aCache['m_aRelationInfos'] = self::$m_aRelationInfos; // array of ("relcode" => various info on the list, common to every classes)
  3967. $aCache['m_aStates'] = self::$m_aStates; // array of ("classname" => array of "statecode"=>array('label'=>..., attribute_inherit=> attribute_list=>...))
  3968. $aCache['m_aStimuli'] = self::$m_aStimuli; // array of ("classname" => array of ("stimuluscode"=>array('label'=>...)))
  3969. $aCache['m_aTransitions'] = self::$m_aTransitions; // array of ("classname" => array of ("statcode_from"=>array of ("stimuluscode" => array('target_state'=>..., 'actions'=>array of handlers procs, 'user_restriction'=>TBD)))
  3970. apc_store($sOqlAPCCacheId, $aCache);
  3971. $oKPI->ComputeAndReport('Metamodel APC (store)');
  3972. }
  3973. }
  3974. if (self::$m_bUseAPCCache && $bDictInitializedFromData)
  3975. {
  3976. Dict::InitCache($sAppIdentity);
  3977. }
  3978. self::$m_sDBName = $sSource;
  3979. self::$m_sTablePrefix = $sTablePrefix;
  3980. CMDBSource::Init($sServer, $sUser, $sPwd); // do not select the DB (could not exist)
  3981. CMDBSource::SetCharacterSet($sCharacterSet, $sCollation);
  3982. // Later when timezone implementation is correctly done: CMDBSource::SetTimezone($sDBTimezone);
  3983. }
  3984. public static function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
  3985. {
  3986. return self::$m_oConfig->GetModuleSetting($sModule, $sProperty, $defaultvalue);
  3987. }
  3988. public static function GetConfig()
  3989. {
  3990. return self::$m_oConfig;
  3991. }
  3992. public static function GetEnvironmentId()
  3993. {
  3994. return md5(APPROOT).'-'.utils::GetCurrentEnvironment();
  3995. }
  3996. protected static $m_aExtensionClasses = array();
  3997. protected static function IncludeModule($sModuleType, $sToInclude)
  3998. {
  3999. $sFirstChar = substr($sToInclude, 0, 1);
  4000. $sSecondChar = substr($sToInclude, 1, 1);
  4001. if (($sFirstChar != '/') && ($sFirstChar != '\\') && ($sSecondChar != ':'))
  4002. {
  4003. // It is a relative path, prepend APPROOT
  4004. if (substr($sToInclude, 0, 3) == '../')
  4005. {
  4006. // Preserve compatibility with config files written before 1.0.1
  4007. // Replace '../' by '<root>/'
  4008. $sFile = APPROOT.'/'.substr($sToInclude, 3);
  4009. }
  4010. else
  4011. {
  4012. $sFile = APPROOT.'/'.$sToInclude;
  4013. }
  4014. }
  4015. else
  4016. {
  4017. // Leave as is - should be an absolute path
  4018. $sFile = $sToInclude;
  4019. }
  4020. if (!file_exists($sFile))
  4021. {
  4022. $sConfigFile = self::$m_oConfig->GetLoadedFile();
  4023. throw new CoreException('Wrong filename in configuration file', array('file' => $sConfigFile, 'module' => $sModuleType, 'filename' => $sFile));
  4024. }
  4025. require_once($sFile);
  4026. }
  4027. // Building an object
  4028. //
  4029. //
  4030. private static $aQueryCacheGetObject = array();
  4031. private static $aQueryCacheGetObjectHits = array();
  4032. public static function GetQueryCacheStatus()
  4033. {
  4034. $aRes = array();
  4035. $iTotalHits = 0;
  4036. foreach(self::$aQueryCacheGetObjectHits as $sClassSign => $iHits)
  4037. {
  4038. $aRes[] = "$sClassSign: $iHits";
  4039. $iTotalHits += $iHits;
  4040. }
  4041. return $iTotalHits.' ('.implode(', ', $aRes).')';
  4042. }
  4043. public static function MakeSingleRow($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
  4044. {
  4045. // Build the query cache signature
  4046. //
  4047. $sQuerySign = $sClass;
  4048. if($bAllowAllData)
  4049. {
  4050. $sQuerySign .= '_all_';
  4051. }
  4052. if (count($aModifierProperties))
  4053. {
  4054. array_multisort($aModifierProperties);
  4055. $sModifierProperties = json_encode($aModifierProperties);
  4056. $sQuerySign .= '_all_'.md5($sModifierProperties);
  4057. }
  4058. if (!array_key_exists($sQuerySign, self::$aQueryCacheGetObject))
  4059. {
  4060. // NOTE: Quick and VERY dirty caching mechanism which relies on
  4061. // the fact that the string '987654321' will never appear in the
  4062. // standard query
  4063. // This could be simplified a little, relying solely on the query cache,
  4064. // but this would slow down -by how much time?- the application
  4065. $oFilter = new DBObjectSearch($sClass);
  4066. $oFilter->AddCondition('id', 987654321, '=');
  4067. if ($aModifierProperties)
  4068. {
  4069. foreach ($aModifierProperties as $sPluginClass => $aProperties)
  4070. {
  4071. foreach ($aProperties as $sProperty => $value)
  4072. {
  4073. $oFilter->SetModifierProperty($sPluginClass, $sProperty, $value);
  4074. }
  4075. }
  4076. }
  4077. if ($bAllowAllData)
  4078. {
  4079. $oFilter->AllowAllData();
  4080. }
  4081. $sSQL = self::MakeSelectQuery($oFilter);
  4082. self::$aQueryCacheGetObject[$sQuerySign] = $sSQL;
  4083. self::$aQueryCacheGetObjectHits[$sQuerySign] = 0;
  4084. }
  4085. else
  4086. {
  4087. $sSQL = self::$aQueryCacheGetObject[$sQuerySign];
  4088. self::$aQueryCacheGetObjectHits[$sQuerySign] += 1;
  4089. // echo " -load $sClass/$iKey- ".self::$aQueryCacheGetObjectHits[$sQuerySign]."<br/>\n";
  4090. }
  4091. $sSQL = str_replace(CMDBSource::Quote(987654321), CMDBSource::Quote($iKey), $sSQL);
  4092. $res = CMDBSource::Query($sSQL);
  4093. $aRow = CMDBSource::FetchArray($res);
  4094. CMDBSource::FreeResult($res);
  4095. if ($bMustBeFound && empty($aRow))
  4096. {
  4097. throw new CoreException("No result for the single row query: '$sSQL'");
  4098. }
  4099. return $aRow;
  4100. }
  4101. public static function GetObjectByRow($sClass, $aRow, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
  4102. {
  4103. self::_check_subclass($sClass);
  4104. if (strlen($sClassAlias) == 0)
  4105. {
  4106. $sClassAlias = $sClass;
  4107. }
  4108. // Compound objects: if available, get the final object class
  4109. //
  4110. if (!array_key_exists($sClassAlias."finalclass", $aRow))
  4111. {
  4112. // Either this is a bug (forgot to specify a root class with a finalclass field
  4113. // Or this is the expected behavior, because the object is not made of several tables
  4114. }
  4115. elseif (empty($aRow[$sClassAlias."finalclass"]))
  4116. {
  4117. // The data is missing in the DB
  4118. // @#@ possible improvement: check that the class is valid !
  4119. $sRootClass = self::GetRootClass($sClass);
  4120. $sFinalClassField = self::DBGetClassField($sRootClass);
  4121. throw new CoreException("Empty class name for object $sClass::{$aRow["id"]} (root class '$sRootClass', field '{$sFinalClassField}' is empty)");
  4122. }
  4123. else
  4124. {
  4125. // do the job for the real target class
  4126. $sClass = $aRow[$sClassAlias."finalclass"];
  4127. }
  4128. return new $sClass($aRow, $sClassAlias, $aAttToLoad, $aExtendedDataSpec);
  4129. }
  4130. public static function GetObject($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
  4131. {
  4132. self::_check_subclass($sClass);
  4133. $aRow = self::MakeSingleRow($sClass, $iKey, $bMustBeFound, $bAllowAllData, $aModifierProperties);
  4134. if (empty($aRow))
  4135. {
  4136. return null;
  4137. }
  4138. return self::GetObjectByRow($sClass, $aRow);
  4139. }
  4140. public static function GetObjectByName($sClass, $sName, $bMustBeFound = true)
  4141. {
  4142. self::_check_subclass($sClass);
  4143. $oObjSearch = new DBObjectSearch($sClass);
  4144. $oObjSearch->AddNameCondition($sName);
  4145. $oSet = new DBObjectSet($oObjSearch);
  4146. if ($oSet->Count() != 1)
  4147. {
  4148. if ($bMustBeFound) throw new CoreException('Failed to get an object by its name', array('class'=>$sClass, 'name'=>$sName));
  4149. return null;
  4150. }
  4151. $oObj = $oSet->fetch();
  4152. return $oObj;
  4153. }
  4154. static protected $m_aCacheObjectByColumn = array();
  4155. public static function GetObjectByColumn($sClass, $sAttCode, $value, $bMustBeFoundUnique = true)
  4156. {
  4157. if (!isset(self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value]))
  4158. {
  4159. self::_check_subclass($sClass);
  4160. $oObjSearch = new DBObjectSearch($sClass);
  4161. $oObjSearch->AddCondition($sAttCode, $value, '=');
  4162. $oSet = new DBObjectSet($oObjSearch);
  4163. if ($oSet->Count() == 1)
  4164. {
  4165. self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value] = $oSet->fetch();
  4166. }
  4167. else
  4168. {
  4169. if ($bMustBeFoundUnique) throw new CoreException('Failed to get an object by column', array('class'=>$sClass, 'attcode'=>$sAttCode, 'value'=>$value, 'matches' => $oSet->Count()));
  4170. self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value] = null;
  4171. }
  4172. }
  4173. return self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value];
  4174. }
  4175. public static function GetObjectFromOQL($sQuery, $aParams = null, $bAllowAllData = false)
  4176. {
  4177. $oFilter = DBObjectSearch::FromOQL($sQuery, $aParams);
  4178. if ($bAllowAllData)
  4179. {
  4180. $oFilter->AllowAllData();
  4181. }
  4182. $oSet = new DBObjectSet($oFilter);
  4183. $oObject = $oSet->Fetch();
  4184. return $oObject;
  4185. }
  4186. public static function GetHyperLink($sTargetClass, $iKey)
  4187. {
  4188. if ($iKey < 0)
  4189. {
  4190. return "$sTargetClass: $iKey (invalid value)";
  4191. }
  4192. $oObj = self::GetObject($sTargetClass, $iKey, false);
  4193. if (is_null($oObj))
  4194. {
  4195. return "$sTargetClass: $iKey (not found)";
  4196. }
  4197. return $oObj->GetHyperLink();
  4198. }
  4199. public static function NewObject($sClass)
  4200. {
  4201. self::_check_subclass($sClass);
  4202. return new $sClass();
  4203. }
  4204. public static function GetNextKey($sClass)
  4205. {
  4206. $sRootClass = MetaModel::GetRootClass($sClass);
  4207. $sRootTable = MetaModel::DBGetTable($sRootClass);
  4208. $iNextKey = CMDBSource::GetNextInsertId($sRootTable);
  4209. return $iNextKey;
  4210. }
  4211. public static function BulkDelete(DBObjectSearch $oFilter)
  4212. {
  4213. $sSQL = self::MakeDeleteQuery($oFilter);
  4214. if (!self::DBIsReadOnly())
  4215. {
  4216. CMDBSource::Query($sSQL);
  4217. }
  4218. }
  4219. public static function BulkUpdate(DBObjectSearch $oFilter, array $aValues)
  4220. {
  4221. // $aValues is an array of $sAttCode => $value
  4222. $sSQL = self::MakeUpdateQuery($oFilter, $aValues);
  4223. if (!self::DBIsReadOnly())
  4224. {
  4225. CMDBSource::Query($sSQL);
  4226. }
  4227. }
  4228. // Links
  4229. //
  4230. //
  4231. public static function EnumReferencedClasses($sClass)
  4232. {
  4233. self::_check_subclass($sClass);
  4234. // 1-N links (referenced by my class), returns an array of sAttCode=>sClass
  4235. $aResult = array();
  4236. foreach(self::$m_aAttribDefs[$sClass] as $sAttCode=>$oAttDef)
  4237. {
  4238. if ($oAttDef->IsExternalKey())
  4239. {
  4240. $aResult[$sAttCode] = $oAttDef->GetTargetClass();
  4241. }
  4242. }
  4243. return $aResult;
  4244. }
  4245. public static function EnumReferencingClasses($sClass, $bSkipLinkingClasses = false, $bInnerJoinsOnly = false)
  4246. {
  4247. self::_check_subclass($sClass);
  4248. if ($bSkipLinkingClasses)
  4249. {
  4250. $aLinksClasses = self::EnumLinksClasses();
  4251. }
  4252. // 1-N links (referencing my class), array of sClass => array of sAttcode
  4253. $aResult = array();
  4254. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  4255. {
  4256. if ($bSkipLinkingClasses && in_array($sSomeClass, $aLinksClasses)) continue;
  4257. $aExtKeys = array();
  4258. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  4259. {
  4260. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  4261. if ($oAttDef->IsExternalKey() && (self::IsParentClass($oAttDef->GetTargetClass(), $sClass)))
  4262. {
  4263. if ($bInnerJoinsOnly && $oAttDef->IsNullAllowed()) continue;
  4264. // Ok, I want this one
  4265. $aExtKeys[$sAttCode] = $oAttDef;
  4266. }
  4267. }
  4268. if (count($aExtKeys) != 0)
  4269. {
  4270. $aResult[$sSomeClass] = $aExtKeys;
  4271. }
  4272. }
  4273. return $aResult;
  4274. }
  4275. public static function EnumLinksClasses()
  4276. {
  4277. // Returns a flat array of classes having at least two external keys
  4278. $aResult = array();
  4279. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  4280. {
  4281. $iExtKeyCount = 0;
  4282. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  4283. {
  4284. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  4285. if ($oAttDef->IsExternalKey())
  4286. {
  4287. $iExtKeyCount++;
  4288. }
  4289. }
  4290. if ($iExtKeyCount >= 2)
  4291. {
  4292. $aResult[] = $sSomeClass;
  4293. }
  4294. }
  4295. return $aResult;
  4296. }
  4297. public static function EnumLinkingClasses($sClass = "")
  4298. {
  4299. // N-N links, array of sLinkClass => (array of sAttCode=>sClass)
  4300. $aResult = array();
  4301. foreach (self::EnumLinksClasses() as $sSomeClass)
  4302. {
  4303. $aTargets = array();
  4304. $bFoundClass = false;
  4305. foreach (self::ListAttributeDefs($sSomeClass) as $sAttCode=>$oAttDef)
  4306. {
  4307. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  4308. if ($oAttDef->IsExternalKey())
  4309. {
  4310. $sRemoteClass = $oAttDef->GetTargetClass();
  4311. if (empty($sClass))
  4312. {
  4313. $aTargets[$sAttCode] = $sRemoteClass;
  4314. }
  4315. elseif ($sClass == $sRemoteClass)
  4316. {
  4317. $bFoundClass = true;
  4318. }
  4319. else
  4320. {
  4321. $aTargets[$sAttCode] = $sRemoteClass;
  4322. }
  4323. }
  4324. }
  4325. if (empty($sClass) || $bFoundClass)
  4326. {
  4327. $aResult[$sSomeClass] = $aTargets;
  4328. }
  4329. }
  4330. return $aResult;
  4331. }
  4332. public static function GetLinkLabel($sLinkClass, $sAttCode)
  4333. {
  4334. self::_check_subclass($sLinkClass);
  4335. // e.g. "supported by" (later: $this->GetLinkLabel(), computed on link data!)
  4336. return self::GetLabel($sLinkClass, $sAttCode);
  4337. }
  4338. /**
  4339. * Replaces all the parameters by the values passed in the hash array
  4340. */
  4341. static public function ApplyParams($aInput, $aParams)
  4342. {
  4343. // Declare magic parameters
  4344. $aParams['APP_URL'] = utils::GetAbsoluteUrlAppRoot();
  4345. $aParams['MODULES_URL'] = utils::GetAbsoluteUrlModulesRoot();
  4346. $aSearches = array();
  4347. $aReplacements = array();
  4348. foreach($aParams as $sSearch => $replace)
  4349. {
  4350. // Some environment parameters are objects, we just need scalars
  4351. if (is_object($replace)) continue;
  4352. $aSearches[] = '$'.$sSearch.'$';
  4353. $aReplacements[] = (string) $replace;
  4354. }
  4355. return str_replace($aSearches, $aReplacements, $aInput);
  4356. }
  4357. /**
  4358. * Returns an array of classes=>instance implementing the given interface
  4359. */
  4360. public static function EnumPlugins($sInterface)
  4361. {
  4362. if (array_key_exists($sInterface, self::$m_aExtensionClasses))
  4363. {
  4364. return self::$m_aExtensionClasses[$sInterface];
  4365. }
  4366. else
  4367. {
  4368. return array();
  4369. }
  4370. }
  4371. /**
  4372. * Returns the instance of the specified plug-ins for the given interface
  4373. */
  4374. public static function GetPlugins($sInterface, $sClassName)
  4375. {
  4376. $oInstance = null;
  4377. if (array_key_exists($sInterface, self::$m_aExtensionClasses))
  4378. {
  4379. if (array_key_exists($sClassName, self::$m_aExtensionClasses[$sInterface]))
  4380. {
  4381. return self::$m_aExtensionClasses[$sInterface][$sClassName];
  4382. }
  4383. }
  4384. return $oInstance;
  4385. }
  4386. public static function GetCacheEntries($sEnvironment = null)
  4387. {
  4388. if (!function_exists('apc_cache_info')) return array();
  4389. if (is_null($sEnvironment))
  4390. {
  4391. $sEnvironment = MetaModel::GetEnvironmentId();
  4392. }
  4393. $aCacheUserData = apc_cache_info('user');
  4394. $sPrefix = 'itop-'.$sEnvironment.'-';
  4395. $aEntries = array();
  4396. foreach($aCacheUserData['cache_list'] as $i => $aEntry)
  4397. {
  4398. $sEntryKey = $aEntry['info'];
  4399. if (strpos($sEntryKey, $sPrefix) === 0)
  4400. {
  4401. $sCleanKey = substr($sEntryKey, strlen($sPrefix));
  4402. $aEntries[$sCleanKey] = $aEntry;
  4403. }
  4404. }
  4405. return $aEntries;
  4406. }
  4407. public static function ResetCache($sEnvironment = null)
  4408. {
  4409. if (!function_exists('apc_delete')) return;
  4410. if (is_null($sEnvironment))
  4411. {
  4412. $sEnvironment = MetaModel::GetEnvironmentId();
  4413. }
  4414. $sAppIdentity = 'itop-'.$sEnvironment;
  4415. Dict::ResetCache($sAppIdentity);
  4416. foreach(self::GetCacheEntries($sEnvironment) as $sKey => $aAPCInfo)
  4417. {
  4418. $sAPCKey = $aAPCInfo['info'];
  4419. apc_delete($sAPCKey);
  4420. }
  4421. }
  4422. } // class MetaModel
  4423. // Standard attribute lists
  4424. MetaModel::RegisterZList("noneditable", array("description"=>"non editable fields", "type"=>"attributes"));
  4425. MetaModel::RegisterZList("details", array("description"=>"All attributes to be displayed for the 'details' of an object", "type"=>"attributes"));
  4426. MetaModel::RegisterZList("list", array("description"=>"All attributes to be displayed for a list of objects", "type"=>"attributes"));
  4427. MetaModel::RegisterZList("preview", array("description"=>"All attributes visible in preview mode", "type"=>"attributes"));
  4428. MetaModel::RegisterZList("standard_search", array("description"=>"List of criteria for the standard search", "type"=>"filters"));
  4429. MetaModel::RegisterZList("advanced_search", array("description"=>"List of criteria for the advanced search", "type"=>"filters"));
  4430. ?>