metamodel.class.php 152 KB

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