metamodel.class.php 152 KB

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