metamodel.class.php 152 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512
  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())
  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. }
  1659. else
  1660. {
  1661. // should be true at this point, meaning that no additional filtering
  1662. // is required
  1663. }
  1664. }
  1665. if (self::$m_bQueryCacheEnabled || self::$m_bTraceQueries)
  1666. {
  1667. // Need to identify the query
  1668. $sOqlQuery = $oFilter->ToOql();
  1669. $sRawId = $sOqlQuery;
  1670. if (!is_null($aAttToLoad))
  1671. {
  1672. foreach($aAttToLoad as $sAlias => $aAttributes)
  1673. {
  1674. $sRawId = $sOqlQuery.'|'.implode(',', array_keys($aAttributes));
  1675. }
  1676. }
  1677. $sOqlId = md5($sRawId);
  1678. }
  1679. else
  1680. {
  1681. $sOqlQuery = "SELECTING... ".$oFilter->GetClass();
  1682. $sOqlId = "query id ? n/a";
  1683. }
  1684. // Query caching
  1685. //
  1686. if (self::$m_bQueryCacheEnabled)
  1687. {
  1688. // Warning: using directly the query string as the key to the hash array can FAIL if the string
  1689. // is long and the differences are only near the end... so it's safer (but not bullet proof?)
  1690. // to use a hash (like md5) of the string as the key !
  1691. //
  1692. // Example of two queries that were found as similar by the hash array:
  1693. // 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
  1694. // and
  1695. // 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
  1696. // the only difference is R instead or O at position 285 (TTR instead of TTO)...
  1697. //
  1698. if (array_key_exists($sOqlId, self::$m_aQueryStructCache))
  1699. {
  1700. // hit!
  1701. $oSelect = clone self::$m_aQueryStructCache[$sOqlId];
  1702. }
  1703. elseif (self::$m_bUseAPCCache)
  1704. {
  1705. // Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
  1706. //
  1707. $sAppIdentity = self::GetConfig()->Get('session_name');
  1708. $sOqlAPCCacheId = $sAppIdentity.'-query-cache-'.$sOqlId;
  1709. $oKPI = new ExecutionKPI();
  1710. $result = apc_fetch($sOqlAPCCacheId);
  1711. $oKPI->ComputeStats('Query APC (fetch)', $sOqlQuery);
  1712. if (is_object($result))
  1713. {
  1714. $oSelect = $result;
  1715. self::$m_aQueryStructCache[$sOqlId] = $oSelect;
  1716. }
  1717. }
  1718. }
  1719. // Check the order by specification, and prefix with the class alias
  1720. // and make sure that the ordering columns are going to be selected
  1721. //
  1722. $aOrderSpec = array();
  1723. foreach ($aOrderBy as $sFieldAlias => $bAscending)
  1724. {
  1725. MyHelpers::CheckValueInArray('field name in ORDER BY spec', $sFieldAlias, self::GetAttributesList($oFilter->GetFirstJoinedClass()));
  1726. if (!is_bool($bAscending))
  1727. {
  1728. throw new CoreException("Wrong direction in ORDER BY spec, found '$bAscending' and expecting a boolean value");
  1729. }
  1730. $sFirstClassAlias = $oFilter->GetFirstJoinedClassAlias();
  1731. $aOrderSpec[$sFirstClassAlias.$sFieldAlias] = $bAscending;
  1732. // Make sure that the columns used for sorting are present in the loaded columns
  1733. if (!is_null($aAttToLoad) && !isset($aAttToLoad[$sFirstClassAlias][$sFieldAlias]))
  1734. {
  1735. $aAttToLoad[$sFirstClassAlias][$sFieldAlias] = MetaModel::GetAttributeDef($oFilter->GetFirstJoinedClass(), $sFieldAlias);
  1736. }
  1737. }
  1738. // By default, force the name attribute to be the ordering key
  1739. //
  1740. if (empty($aOrderSpec))
  1741. {
  1742. foreach ($oFilter->GetSelectedClasses() as $sSelectedAlias => $sSelectedClass)
  1743. {
  1744. // By default, simply order on the "friendlyname" attribute, ascending
  1745. $aOrderSpec[$sSelectedAlias."friendlyname"] = true;
  1746. // Make sure that the columns used for sorting are present in the loaded columns
  1747. if (!is_null($aAttToLoad) && !isset($aAttToLoad[$sSelectedAlias]["friendlyname"]))
  1748. {
  1749. $aAttToLoad[$sSelectedAlias]["friendlyname"] = MetaModel::GetAttributeDef($sSelectedClass, "friendlyname");
  1750. }
  1751. }
  1752. }
  1753. if (!isset($oSelect))
  1754. {
  1755. $aClassAliases = array();
  1756. $aTableAliases = array();
  1757. $oQBExpr = new QueryBuilderExpressions(array(), $oFilter->GetCriteria());
  1758. $oKPI = new ExecutionKPI();
  1759. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oQBExpr, $aClassAliases, $aTableAliases, $oFilter, $aAttToLoad, array(), true /* main query */);
  1760. $oSelect->SetSourceOQL($sOqlQuery);
  1761. $oKPI->ComputeStats('MakeQuery (select)', $sOqlQuery);
  1762. if (self::$m_bQueryCacheEnabled)
  1763. {
  1764. if (self::$m_bUseAPCCache)
  1765. {
  1766. $oKPI = new ExecutionKPI();
  1767. apc_store($sOqlAPCCacheId, $oSelect, self::$m_iQueryCacheTTL);
  1768. $oKPI->ComputeStats('Query APC (store)', $sOqlQuery);
  1769. }
  1770. self::$m_aQueryStructCache[$sOqlId] = clone $oSelect;
  1771. }
  1772. }
  1773. // Join to an additional table, if required...
  1774. //
  1775. if ($aExtendedDataSpec != null)
  1776. {
  1777. $sTableAlias = '_extended_data_';
  1778. $aExtendedFields = array();
  1779. foreach($aExtendedDataSpec['fields'] as $sColumn)
  1780. {
  1781. $sColRef = $oFilter->GetClassAlias().'_extdata_'.$sColumn;
  1782. $aExtendedFields[$sColRef] = new FieldExpressionResolved($sColumn, $sTableAlias);;
  1783. }
  1784. $oSelectExt = new SQLQuery($aExtendedDataSpec['table'], $sTableAlias, $aExtendedFields);
  1785. $oSelect->AddInnerJoin($oSelectExt, 'id', $aExtendedDataSpec['join_key'] /*, $sTableAlias*/);
  1786. }
  1787. // Go
  1788. //
  1789. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1790. try
  1791. {
  1792. $sRes = $oSelect->RenderSelect($aOrderSpec, $aScalarArgs, $iLimitCount, $iLimitStart, $bGetCount);
  1793. //echo "<p>MakeQuery: $sRes</p>";
  1794. }
  1795. catch (MissingQueryArgument $e)
  1796. {
  1797. // Add some information...
  1798. $e->addInfo('OQL', $sOqlQuery);
  1799. throw $e;
  1800. }
  1801. if (self::$m_bTraceQueries)
  1802. {
  1803. $sQueryId = md5($sRes);
  1804. if(!isset(self::$m_aQueriesLog[$sOqlId]))
  1805. {
  1806. self::$m_aQueriesLog[$sOqlId]['oql'] = $sOqlQuery;
  1807. self::$m_aQueriesLog[$sOqlId]['hits'] = 1;
  1808. }
  1809. else
  1810. {
  1811. self::$m_aQueriesLog[$sOqlId]['hits']++;
  1812. }
  1813. if(!isset(self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]))
  1814. {
  1815. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['sql'] = $sRes;
  1816. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['count'] = 1;
  1817. }
  1818. else
  1819. {
  1820. self::$m_aQueriesLog[$sOqlId]['queries'][$sQueryId]['count']++;
  1821. }
  1822. }
  1823. return $sRes;
  1824. }
  1825. public static function ShowQueryTrace()
  1826. {
  1827. if (!self::$m_bTraceQueries) return;
  1828. $iOqlCount = count(self::$m_aQueriesLog);
  1829. if ($iOqlCount == 0)
  1830. {
  1831. echo "<p>Trace activated, but no query found</p>\n";
  1832. return;
  1833. }
  1834. $iSqlCount = 0;
  1835. foreach (self::$m_aQueriesLog as $aOqlData)
  1836. {
  1837. $iSqlCount += $aOqlData['hits'];
  1838. }
  1839. echo "<h2>Stats on SELECT queries: OQL=$iOqlCount, SQL=$iSqlCount</h2>\n";
  1840. foreach (self::$m_aQueriesLog as $aOqlData)
  1841. {
  1842. $sOql = $aOqlData['oql'];
  1843. $sHits = $aOqlData['hits'];
  1844. echo "<p><b>$sHits</b> hits for OQL query: $sOql</p>\n";
  1845. echo "<ul id=\"ClassesRelationships\" class=\"treeview\">\n";
  1846. foreach($aOqlData['queries'] as $aSqlData)
  1847. {
  1848. $sQuery = $aSqlData['sql'];
  1849. $sSqlHits = $aSqlData['count'];
  1850. echo "<li><b>$sSqlHits</b> hits for SQL: <span style=\"font-size:60%\">$sQuery</span><li>\n";
  1851. }
  1852. echo "</ul>\n";
  1853. }
  1854. }
  1855. public static function MakeDeleteQuery(DBObjectSearch $oFilter, $aArgs = array())
  1856. {
  1857. $aClassAliases = array();
  1858. $aTableAliases = array();
  1859. $oQBExpr = new QueryBuilderExpressions(array(), $oFilter->GetCriteria());
  1860. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oQBExpr, $aClassAliases, $aTableAliases, $oFilter, null, array(), true /* main query */);
  1861. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1862. return $oSelect->RenderDelete($aScalarArgs);
  1863. }
  1864. public static function MakeUpdateQuery(DBObjectSearch $oFilter, $aValues, $aArgs = array())
  1865. {
  1866. // $aValues is an array of $sAttCode => $value
  1867. $aClassAliases = array();
  1868. $aTableAliases = array();
  1869. $oQBExpr = new QueryBuilderExpressions(array(), $oFilter->GetCriteria());
  1870. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oQBExpr, $aClassAliases, $aTableAliases, $oFilter, null, $aValues, true /* main query */);
  1871. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1872. return $oSelect->RenderUpdate($aScalarArgs);
  1873. }
  1874. private static function MakeQuery($aSelectedClasses, &$oQBExpr, &$aClassAliases, &$aTableAliases, DBObjectSearch $oFilter, $aAttToLoad = null, $aValues = array(), $bIsMainQuery = false)
  1875. {
  1876. // Note: query class might be different than the class of the filter
  1877. // -> this occurs when we are linking our class to an external class (referenced by, or pointing to)
  1878. $sClass = $oFilter->GetFirstJoinedClass();
  1879. $sClassAlias = $oFilter->GetFirstJoinedClassAlias();
  1880. $bIsOnQueriedClass = array_key_exists($sClassAlias, $aSelectedClasses);
  1881. if ($bIsOnQueriedClass)
  1882. {
  1883. $aClassAliases = array_merge($aClassAliases, $oFilter->GetJoinedClasses());
  1884. }
  1885. self::DbgTrace("Entering: ".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  1886. $sRootClass = self::GetRootClass($sClass);
  1887. $sKeyField = self::DBGetKey($sClass);
  1888. if ($bIsOnQueriedClass)
  1889. {
  1890. // default to the whole list of attributes + the very std id/finalclass
  1891. $oQBExpr->AddSelect($sClassAlias.'id', new FieldExpression('id', $sClassAlias));
  1892. if (is_null($aAttToLoad) || !array_key_exists($sClassAlias, $aAttToLoad))
  1893. {
  1894. $aAttList = self::ListAttributeDefs($sClass);
  1895. }
  1896. else
  1897. {
  1898. $aAttList = $aAttToLoad[$sClassAlias];
  1899. }
  1900. foreach ($aAttList as $sAttCode => $oAttDef)
  1901. {
  1902. if (!$oAttDef->IsScalar()) continue;
  1903. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1904. {
  1905. $oQBExpr->AddSelect($sClassAlias.$sAttCode.$sColId, new FieldExpression($sAttCode.$sColId, $sClassAlias));
  1906. }
  1907. }
  1908. // Transform the full text condition into additional condition expression
  1909. $aFullText = $oFilter->GetCriteria_FullText();
  1910. if (count($aFullText) > 0)
  1911. {
  1912. $aFullTextFields = array();
  1913. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  1914. {
  1915. if (!$oAttDef->IsScalar()) continue;
  1916. if ($oAttDef->IsExternalKey()) continue;
  1917. $aFullTextFields[] = new FieldExpression($sAttCode, $sClassAlias);
  1918. }
  1919. $oTextFields = new CharConcatWSExpression(' ', $aFullTextFields);
  1920. foreach($aFullText as $sFTNeedle)
  1921. {
  1922. $oNewCond = new BinaryExpression($oTextFields, 'LIKE', new ScalarExpression("%$sFTNeedle%"));
  1923. $oQBExpr->AddCondition($oNewCond);
  1924. }
  1925. }
  1926. }
  1927. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  1928. $aExpectedAtts = array(); // array of (attcode => fieldexpression)
  1929. //echo "<p>".__LINE__.": GetUnresolvedFields($sClassAlias, ...)</p>\n";
  1930. $oQBExpr->GetUnresolvedFields($sClassAlias, $aExpectedAtts);
  1931. // Compute a clear view of required joins (from the current class)
  1932. // Build the list of external keys:
  1933. // -> ext keys required by an explicit join
  1934. // -> ext keys mentionned in a 'pointing to' condition
  1935. // -> ext keys required for an external field
  1936. // -> ext keys required for a friendly name
  1937. //
  1938. $aExtKeys = array(); // array of sTableClass => array of (sAttCode (keys) => array of (sAttCode (fields)=> oAttDef))
  1939. //
  1940. // Optimization: could be partially computed once for all (cached) ?
  1941. //
  1942. if ($bIsOnQueriedClass)
  1943. {
  1944. // Get all Ext keys for the queried class (??)
  1945. foreach(self::GetKeysList($sClass) as $sKeyAttCode)
  1946. {
  1947. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1948. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1949. }
  1950. }
  1951. // Get all Ext keys used by the filter
  1952. foreach ($oFilter->GetCriteria_PointingTo() as $sKeyAttCode => $aPointingTo)
  1953. {
  1954. if (array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  1955. {
  1956. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1957. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1958. }
  1959. }
  1960. if (array_key_exists('friendlyname', $aExpectedAtts))
  1961. {
  1962. $aTranslateNow = array();
  1963. $aTranslateNow[$sClassAlias]['friendlyname'] = self::GetNameExpression($sClass, $sClassAlias);
  1964. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  1965. $oQBExpr->Translate($aTranslateNow, false);
  1966. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  1967. $aNameSpec = self::GetNameSpec($sClass);
  1968. foreach($aNameSpec[1] as $i => $sAttCode)
  1969. {
  1970. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  1971. if ($oAttDef->IsExternalKey())
  1972. {
  1973. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sAttCode];
  1974. $aExtKeys[$sKeyTableClass][$sAttCode] = array();
  1975. }
  1976. elseif ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1977. {
  1978. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1979. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1980. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  1981. }
  1982. }
  1983. }
  1984. // Add the ext fields used in the select (eventually adds an external key)
  1985. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  1986. {
  1987. if ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1988. {
  1989. if (array_key_exists($sAttCode, $aExpectedAtts))
  1990. {
  1991. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1992. if ($sKeyAttCode != 'id')
  1993. {
  1994. // Add the external attribute
  1995. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1996. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  1997. }
  1998. }
  1999. }
  2000. }
  2001. // First query built upon on the leaf (ie current) class
  2002. //
  2003. self::DbgTrace("Main (=leaf) class, call MakeQuerySingleTable()");
  2004. if (self::HasTable($sClass))
  2005. {
  2006. $oSelectBase = self::MakeQuerySingleTable($aSelectedClasses, $oQBExpr, $aClassAliases, $aTableAliases, $oFilter, $sClass, $aExtKeys, $aValues);
  2007. }
  2008. else
  2009. {
  2010. $oSelectBase = null;
  2011. // As the join will not filter on the expected classes, we have to specify it explicitely
  2012. $sExpectedClasses = implode("', '", self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  2013. $oFinalClassRestriction = Expression::FromOQL("`$sClassAlias`.finalclass IN ('$sExpectedClasses')");
  2014. $oQBExpr->AddCondition($oFinalClassRestriction);
  2015. }
  2016. // Then we join the queries of the eventual parent classes (compound model)
  2017. foreach(self::EnumParentClasses($sClass) as $sParentClass)
  2018. {
  2019. if (!self::HasTable($sParentClass)) continue;
  2020. //echo "<p>Parent class: $sParentClass... let's call MakeQuerySingleTable()</p>";
  2021. self::DbgTrace("Parent class: $sParentClass... let's call MakeQuerySingleTable()");
  2022. $oSelectParentTable = self::MakeQuerySingleTable($aSelectedClasses, $oQBExpr, $aClassAliases, $aTableAliases, $oFilter, $sParentClass, $aExtKeys, $aValues);
  2023. if (is_null($oSelectBase))
  2024. {
  2025. $oSelectBase = $oSelectParentTable;
  2026. }
  2027. else
  2028. {
  2029. $oSelectBase->AddInnerJoin($oSelectParentTable, $sKeyField, self::DBGetKey($sParentClass));
  2030. }
  2031. }
  2032. // Filter on objects referencing me
  2033. foreach ($oFilter->GetCriteria_ReferencedBy() as $sForeignClass => $aKeysAndFilters)
  2034. {
  2035. foreach ($aKeysAndFilters as $sForeignKeyAttCode => $oForeignFilter)
  2036. {
  2037. $oForeignKeyAttDef = self::GetAttributeDef($sForeignClass, $sForeignKeyAttCode);
  2038. self::DbgTrace("Referenced by foreign key: $sForeignKeyAttCode... let's call MakeQuery()");
  2039. //self::DbgTrace($oForeignFilter);
  2040. //self::DbgTrace($oForeignFilter->ToOQL());
  2041. //self::DbgTrace($oSelectForeign);
  2042. //self::DbgTrace($oSelectForeign->RenderSelect(array()));
  2043. $sForeignClassAlias = $oForeignFilter->GetFirstJoinedClassAlias();
  2044. $oQBExpr->PushJoinField(new FieldExpression($sForeignKeyAttCode, $sForeignClassAlias));
  2045. $oSelectForeign = self::MakeQuery($aSelectedClasses, $oQBExpr, $aClassAliases, $aTableAliases, $oForeignFilter, $aAttToLoad);
  2046. $oJoinExpr = $oQBExpr->PopJoinField();
  2047. $sForeignKeyTable = $oJoinExpr->GetParent();
  2048. $sForeignKeyColumn = $oJoinExpr->GetName();
  2049. $oSelectBase->AddInnerJoin($oSelectForeign, $sKeyField, $sForeignKeyColumn, $sForeignKeyTable);
  2050. }
  2051. }
  2052. // Filter on related objects
  2053. //
  2054. foreach ($oFilter->GetCriteria_RelatedTo() as $aCritInfo)
  2055. {
  2056. $oSubFilter = $aCritInfo['flt'];
  2057. $sRelCode = $aCritInfo['relcode'];
  2058. $iMaxDepth = $aCritInfo['maxdepth'];
  2059. // Get the starting point objects
  2060. $oStartSet = new CMDBObjectSet($oSubFilter);
  2061. // Get the objects related to those objects... recursively...
  2062. $aRelatedObjs = $oStartSet->GetRelatedObjects($sRelCode, $iMaxDepth);
  2063. $aRestriction = array_key_exists($sRootClass, $aRelatedObjs) ? $aRelatedObjs[$sRootClass] : array();
  2064. // #@# todo - related objects and expressions...
  2065. // Create condition
  2066. if (count($aRestriction) > 0)
  2067. {
  2068. $oSelectBase->AddCondition($sKeyField.' IN ('.implode(', ', CMDBSource::Quote(array_keys($aRestriction), true)).')');
  2069. }
  2070. else
  2071. {
  2072. // Quick N'dirty -> generate an empty set
  2073. $oSelectBase->AddCondition('false');
  2074. }
  2075. }
  2076. // Translate the conditions... and go
  2077. //
  2078. if ($bIsMainQuery)
  2079. {
  2080. $oSelectBase->SetCondition($oQBExpr->GetCondition());
  2081. $oSelectBase->SetSelect($oQBExpr->GetSelect());
  2082. }
  2083. // That's all... cross fingers and we'll get some working query
  2084. //MyHelpers::var_dump_html($oSelectBase, true);
  2085. //MyHelpers::var_dump_html($oSelectBase->RenderSelect(), true);
  2086. if (self::$m_bDebugQuery) $oSelectBase->DisplayHtml();
  2087. return $oSelectBase;
  2088. }
  2089. protected static function MakeQuerySingleTable($aSelectedClasses, &$oQBExpr, &$aClassAliases, &$aTableAliases, $oFilter, $sTableClass, $aExtKeys, $aValues)
  2090. {
  2091. // $aExtKeys is an array of sTableClass => array of (sAttCode (keys) => array of sAttCode (fields))
  2092. //echo "MAKEQUERY($sTableClass)-liste des clefs externes($sTableClass): <pre>".print_r($aExtKeys, true)."</pre><br/>\n";
  2093. // Prepare the query for a single table (compound objects)
  2094. // Ignores the items (attributes/filters) that are not on the target table
  2095. // Perform an (inner or left) join for every external key (and specify the expected fields)
  2096. //
  2097. // Returns an SQLQuery
  2098. //
  2099. $sTargetClass = $oFilter->GetFirstJoinedClass();
  2100. $sTargetAlias = $oFilter->GetFirstJoinedClassAlias();
  2101. $sTable = self::DBGetTable($sTableClass);
  2102. $sTableAlias = self::GenerateUniqueAlias($aTableAliases, $sTargetAlias.'_'.$sTable, $sTable);
  2103. $aTranslation = array();
  2104. $aExpectedAtts = array();
  2105. $oQBExpr->GetUnresolvedFields($sTargetAlias, $aExpectedAtts);
  2106. $bIsOnQueriedClass = array_key_exists($sTargetAlias, $aSelectedClasses);
  2107. self::DbgTrace("Entering: tableclass=$sTableClass, filter=".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  2108. // 1 - SELECT and UPDATE
  2109. //
  2110. // Note: no need for any values nor fields for foreign Classes (ie not the queried Class)
  2111. //
  2112. $aUpdateValues = array();
  2113. // 1/a - Get the key and friendly name
  2114. //
  2115. // We need one pkey to be the key, let's take the one corresponding to the root class
  2116. // (used to be based on the leaf, but it may happen that this one has no table defined)
  2117. $sRootClass = self::GetRootClass($sTargetClass);
  2118. $oSelectedIdField = null;
  2119. if ($sTableClass == $sRootClass)
  2120. {
  2121. $oIdField = new FieldExpressionResolved(self::DBGetKey($sTableClass), $sTableAlias);
  2122. $aTranslation[$sTargetAlias]['id'] = $oIdField;
  2123. if ($bIsOnQueriedClass)
  2124. {
  2125. // Add this field to the list of queried fields (required for the COUNT to work fine)
  2126. $oSelectedIdField = $oIdField;
  2127. }
  2128. }
  2129. // 1/b - Get the other attributes
  2130. //
  2131. foreach(self::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  2132. {
  2133. // Skip this attribute if not defined in this table
  2134. if (self::$m_aAttribOrigins[$sTargetClass][$sAttCode] != $sTableClass) continue;
  2135. // Skip this attribute if not made of SQL columns
  2136. if (count($oAttDef->GetSQLExpressions()) == 0) continue;
  2137. // Update...
  2138. //
  2139. if ($bIsOnQueriedClass && array_key_exists($sAttCode, $aValues))
  2140. {
  2141. assert ($oAttDef->IsDirectField());
  2142. foreach ($oAttDef->GetSQLValues($aValues[$sAttCode]) as $sColumn => $sValue)
  2143. {
  2144. $aUpdateValues[$sColumn] = $sValue;
  2145. }
  2146. }
  2147. // Select...
  2148. //
  2149. if ($oAttDef->IsExternalField())
  2150. {
  2151. // skip, this will be handled in the joined tables (done hereabove)
  2152. }
  2153. else
  2154. {
  2155. //echo "<p>MakeQuerySingleTable: Field $sAttCode is part of the table $sTable (named: $sTableAlias)</p>";
  2156. // standard field, or external key
  2157. // add it to the output
  2158. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  2159. {
  2160. if (array_key_exists($sAttCode, $aExpectedAtts))
  2161. {
  2162. $aTranslation[$sTargetAlias][$sAttCode.$sColId] = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  2163. }
  2164. }
  2165. }
  2166. }
  2167. // 3 - The whole stuff, for this table only
  2168. //
  2169. $oSelectBase = new SQLQuery($sTable, $sTableAlias, array(), $bIsOnQueriedClass, $aUpdateValues, $oSelectedIdField);
  2170. //echo "MAKEQUERY- Classe $sTableClass<br/>\n";
  2171. // 4 - The external keys -> joins...
  2172. //
  2173. $aAllPointingTo = $oFilter->GetCriteria_PointingTo();
  2174. if (array_key_exists($sTableClass, $aExtKeys))
  2175. {
  2176. foreach ($aExtKeys[$sTableClass] as $sKeyAttCode => $aExtFields)
  2177. {
  2178. $oKeyAttDef = self::GetAttributeDef($sTableClass, $sKeyAttCode);
  2179. $aPointingTo = $oFilter->GetCriteria_PointingTo($sKeyAttCode);
  2180. //echo "MAKEQUERY-Cle '$sKeyAttCode'<br/>\n";
  2181. if (!array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  2182. {
  2183. //echo "MAKEQUERY-Ajoutons l'operateur TREE_OPERATOR_EQUALS pour $sKeyAttCode<br/>\n";
  2184. // The join was not explicitely defined in the filter,
  2185. // we need to do it now
  2186. $sKeyClass = $oKeyAttDef->GetTargetClass();
  2187. $sKeyClassAlias = self::GenerateUniqueAlias($aClassAliases, $sKeyClass.'_'.$sKeyAttCode, $sKeyClass);
  2188. $oExtFilter = new DBObjectSearch($sKeyClass, $sKeyClassAlias);
  2189. $aAllPointingTo[$sKeyAttCode][TREE_OPERATOR_EQUALS] = $oExtFilter;
  2190. }
  2191. }
  2192. }
  2193. //echo "MAKEQUERY-liste des clefs de jointure: <pre>".print_r(array_keys($aAllPointingTo), true)."</pre><br/>\n";
  2194. foreach ($aAllPointingTo as $sKeyAttCode => $aPointingTo)
  2195. {
  2196. foreach($aPointingTo as $iOperatorCode => $oExtFilter)
  2197. {
  2198. if (!MetaModel::IsValidAttCode($sTableClass, $sKeyAttCode)) continue; // Not defined in the class, skip it
  2199. // The aliases should not conflict because normalization occured while building the filter
  2200. $oKeyAttDef = self::GetAttributeDef($sTableClass, $sKeyAttCode);
  2201. $sKeyClass = $oExtFilter->GetFirstJoinedClass();
  2202. $sKeyClassAlias = $oExtFilter->GetFirstJoinedClassAlias();
  2203. //echo "MAKEQUERY-$sTableClass::$sKeyAttCode Foreach PointingTo($iOperatorCode) <span style=\"color:red\">$sKeyClass (alias:$sKeyClassAlias)</span><br/>\n";
  2204. // Note: there is no search condition in $oExtFilter, because normalization did merge the condition onto the top of the filter tree
  2205. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  2206. {
  2207. // Specify expected attributes for the target class query
  2208. // ... and use the current alias !
  2209. $aTranslateNow = array(); // Translation for external fields - must be performed before the join is done (recursion...)
  2210. //echo "MAKEQUERY-array_key_exists($sTableClass, \$aExtKeys)<br/>\n";
  2211. if (array_key_exists($sTableClass, $aExtKeys) && array_key_exists($sKeyAttCode, $aExtKeys[$sTableClass]))
  2212. {
  2213. foreach($aExtKeys[$sTableClass][$sKeyAttCode] as $sAttCode => $oAtt)
  2214. {
  2215. //echo "MAKEQUERY aExtKeys[$sTableClass][$sKeyAttCode] => $sAttCode-oAtt: <pre>".print_r($oAtt, true)."</pre><br/>\n";
  2216. if ($oAtt instanceof AttributeFriendlyName)
  2217. {
  2218. // Note: for a given ext key, there is one single attribute "friendly name"
  2219. $aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);
  2220. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);</b></p>\n";
  2221. }
  2222. else
  2223. {
  2224. $sExtAttCode = $oAtt->GetExtAttCode();
  2225. // Translate mainclass.extfield => remoteclassalias.remotefieldcode
  2226. $oRemoteAttDef = self::GetAttributeDef($sKeyClass, $sExtAttCode);
  2227. foreach ($oRemoteAttDef->GetSQLExpressions() as $sColID => $sRemoteAttExpr)
  2228. {
  2229. $aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);
  2230. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);</b></p>\n";
  2231. }
  2232. //echo "<p><b>ExtAttr2: $sTargetAlias.$sAttCode to $sKeyClassAlias.$sRemoteAttExpr (class: $sKeyClass)</b></p>\n";
  2233. }
  2234. }
  2235. // Translate prior to recursing
  2236. //
  2237. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."\n".print_r($aTranslateNow, true)."</pre></p>\n";
  2238. $oQBExpr->Translate($aTranslateNow, false);
  2239. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  2240. //echo "<p>External key $sKeyAttCode (class: $sKeyClass), call MakeQuery()/p>\n";
  2241. self::DbgTrace("External key $sKeyAttCode (class: $sKeyClass), call MakeQuery()");
  2242. $oQBExpr->PushJoinField(new FieldExpression('id', $sKeyClassAlias));
  2243. //echo "<p>Recursive MakeQuery ".__LINE__.": <pre>\n".print_r($aSelectedClasses, true)."</pre></p>\n";
  2244. $oSelectExtKey = self::MakeQuery($aSelectedClasses, $oQBExpr, $aClassAliases, $aTableAliases, $oExtFilter);
  2245. $oJoinExpr = $oQBExpr->PopJoinField();
  2246. $sExternalKeyTable = $oJoinExpr->GetParent();
  2247. $sExternalKeyField = $oJoinExpr->GetName();
  2248. $aCols = $oKeyAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  2249. $sLocalKeyField = current($aCols); // get the first column for an external key
  2250. self::DbgTrace("External key $sKeyAttCode, Join on $sLocalKeyField = $sExternalKeyField");
  2251. if ($oKeyAttDef->IsNullAllowed())
  2252. {
  2253. $oSelectBase->AddLeftJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  2254. }
  2255. else
  2256. {
  2257. $oSelectBase->AddInnerJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  2258. }
  2259. }
  2260. }
  2261. else
  2262. {
  2263. $oQBExpr->PushJoinField(new FieldExpression($sKeyAttCode, $sKeyClassAlias));
  2264. $oSelectExtKey = self::MakeQuery($aSelectedClasses, $oQBExpr, $aClassAliases, $aTableAliases, $oExtFilter);
  2265. $oJoinExpr = $oQBExpr->PopJoinField();
  2266. //echo "MAKEQUERY-PopJoinField pour $sKeyAttCode, $sKeyClassAlias: <pre>".print_r($oJoinExpr, true)."</pre><br/>\n";
  2267. $sExternalKeyTable = $oJoinExpr->GetParent();
  2268. $sExternalKeyField = $oJoinExpr->GetName();
  2269. $sLeftIndex = $sExternalKeyField.'_left'; // TODO use GetSQLLeft()
  2270. $sRightIndex = $sExternalKeyField.'_right'; // TODO use GetSQLRight()
  2271. $LocalKeyLeft = $oKeyAttDef->GetSQLLeft();
  2272. //echo "MAKEQUERY-LocalKeyLeft pour $sKeyAttCode => $LocalKeyLeft<br/>\n";
  2273. $oSelectBase->AddInnerJoinTree($oSelectExtKey, $LocalKeyLeft, $sLeftIndex, $sRightIndex, $sExternalKeyTable, $iOperatorCode);
  2274. }
  2275. }
  2276. }
  2277. // Translate the selected columns
  2278. //
  2279. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  2280. $oQBExpr->Translate($aTranslation, false);
  2281. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oQBExpr, true)."</pre></p>\n";
  2282. //MyHelpers::var_dump_html($oSelectBase->RenderSelect());
  2283. return $oSelectBase;
  2284. }
  2285. /**
  2286. * Special processing for the hierarchical keys stored as nested sets
  2287. * @param $iId integer The identifier of the parent
  2288. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2289. * @param $stable string The name of the database table containing the hierarchical key
  2290. */
  2291. public static function HKInsertChildUnder($iId, $oAttDef, $sTable)
  2292. {
  2293. // Get the parent id.right value
  2294. if ($iId == 0)
  2295. {
  2296. // No parent, insert completely at the right of the tree
  2297. $sSQL = "SELECT max(`".$oAttDef->GetSQLRight()."`) AS max FROM `$sTable`";
  2298. $aRes = CMDBSource::QueryToArray($sSQL);
  2299. if (count($aRes) == 0)
  2300. {
  2301. $iMyRight = 1;
  2302. }
  2303. else
  2304. {
  2305. $iMyRight = $aRes[0]['max']+1;
  2306. }
  2307. }
  2308. else
  2309. {
  2310. $sSQL = "SELECT `".$oAttDef->GetSQLRight()."` FROM `$sTable` WHERE id=".$iId;
  2311. $iMyRight = CMDBSource::QueryToScalar($sSQL);
  2312. $sSQLUpdateRight = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` + 2 WHERE `".$oAttDef->GetSQLRight()."` >= $iMyRight";
  2313. CMDBSource::Query($sSQLUpdateRight);
  2314. $sSQLUpdateLeft = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` + 2 WHERE `".$oAttDef->GetSQLLeft()."` > $iMyRight";
  2315. CMDBSource::Query($sSQLUpdateLeft);
  2316. }
  2317. return array($oAttDef->GetSQLRight() => $iMyRight+1, $oAttDef->GetSQLLeft() => $iMyRight);
  2318. }
  2319. /**
  2320. * Special processing for the hierarchical keys stored as nested sets: temporary remove the branch
  2321. * @param $iId integer The identifier of the parent
  2322. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2323. * @param $sTable string The name of the database table containing the hierarchical key
  2324. */
  2325. public static function HKTemporaryCutBranch($iMyLeft, $iMyRight, $oAttDef, $sTable)
  2326. {
  2327. $iDelta = $iMyRight - $iMyLeft + 1;
  2328. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = $iMyLeft - `".$oAttDef->GetSQLRight()."`, `".$oAttDef->GetSQLLeft()."` = $iMyLeft - `".$oAttDef->GetSQLLeft();
  2329. $sSQL .= "` WHERE `".$oAttDef->GetSQLLeft()."`> $iMyLeft AND `".$oAttDef->GetSQLRight()."`< $iMyRight";
  2330. CMDBSource::Query($sSQL);
  2331. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` - $iDelta WHERE `".$oAttDef->GetSQLLeft()."` > $iMyRight";
  2332. CMDBSource::Query($sSQL);
  2333. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` - $iDelta WHERE `".$oAttDef->GetSQLRight()."` > $iMyRight";
  2334. CMDBSource::Query($sSQL);
  2335. }
  2336. /**
  2337. * Special processing for the hierarchical keys stored as nested sets: replug the temporary removed branch
  2338. * @param $iId integer The identifier of the parent
  2339. * @param $oAttDef AttributeDefinition The attribute corresponding to the hierarchical key
  2340. * @param $sTable string The name of the database table containing the hierarchical key
  2341. */
  2342. public static function HKReplugBranch($iNewLeft, $iNewRight, $oAttDef, $sTable)
  2343. {
  2344. $iDelta = $iNewRight - $iNewLeft + 1;
  2345. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLLeft()."` = `".$oAttDef->GetSQLLeft()."` + $iDelta WHERE `".$oAttDef->GetSQLLeft()."` > $iNewLeft";
  2346. CMDBSource::Query($sSQL);
  2347. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = `".$oAttDef->GetSQLRight()."` + $iDelta WHERE `".$oAttDef->GetSQLRight()."` >= $iNewLeft";
  2348. CMDBSource::Query($sSQL);
  2349. $sSQL = "UPDATE `$sTable` SET `".$oAttDef->GetSQLRight()."` = $iNewLeft - `".$oAttDef->GetSQLRight()."`, `".$oAttDef->GetSQLLeft()."` = $iNewLeft - `".$oAttDef->GetSQLLeft()."` WHERE `".$oAttDef->GetSQLRight()."`< 0";
  2350. CMDBSource::Query($sSQL);
  2351. }
  2352. /**
  2353. * Check (and updates if needed) the hierarchical keys
  2354. * @param $bForceComputation boolean If true, the _left and _right parameters will be recomputed even if some values already exist in the DB
  2355. */
  2356. public static function CheckHKeys($bForceComputation = false)
  2357. {
  2358. foreach (self::GetClasses() as $sClass)
  2359. {
  2360. if (!self::HasTable($sClass)) continue;
  2361. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2362. {
  2363. // Check (once) all the attributes that are hierarchical keys
  2364. if((self::GetAttributeOrigin($sClass, $sAttCode) == $sClass) && $oAttDef->IsHierarchicalKey())
  2365. {
  2366. self::HKInit($sClass, $sAttCode, $bForceComputation);
  2367. }
  2368. }
  2369. }
  2370. }
  2371. /**
  2372. * Initializes (i.e converts) a hierarchy stored using a 'parent_id' external key
  2373. * into a hierarchy stored with a HierarchicalKey, by initializing the _left and _right values
  2374. * to correspond to the existing hierarchy in the database
  2375. * @param $sClass string Name of the class to process
  2376. * @param $sAttCode string Code of the attribute to process
  2377. * @param $bForceComputation boolean If true, the _left and _right parameters will be recomputed even if some values already exist in the DB
  2378. */
  2379. public static function HKInit($sClass, $sAttCode, $bForceComputation = false)
  2380. {
  2381. $idx = 1;
  2382. $bUpdateNeeded = $bForceComputation;
  2383. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  2384. $sTable = self::DBGetTable($sClass, $sAttCode);
  2385. if ($oAttDef->IsHierarchicalKey())
  2386. {
  2387. if (!$bForceComputation)
  2388. {
  2389. // Check if some values already exist in the table for the _right value, if so, do nothing
  2390. $sRight = $oAttDef->GetSQLRight();
  2391. $sSQL = "SELECT MAX(`$sRight`) AS MaxRight FROM `$sTable`";
  2392. $iMaxRight = CMDBSource::QueryToScalar($sSQL);
  2393. if ($iMaxRight == 0)
  2394. {
  2395. $bUpdateNeeded = true;
  2396. }
  2397. }
  2398. if ($bUpdateNeeded)
  2399. {
  2400. try
  2401. {
  2402. CMDBSource::Query('START TRANSACTION');
  2403. self::HKInitChildren($sTable, $sAttCode, $oAttDef, 0, $idx);
  2404. CMDBSource::Query('COMMIT');
  2405. }
  2406. catch(Exception $e)
  2407. {
  2408. CMDBSource::Query('ROLLBACK');
  2409. throw new Exception("An error occured (".$e->getMessage().") while initializing the hierarchy for ($sClass, $sAttCode). The database was not modified.");
  2410. }
  2411. }
  2412. }
  2413. }
  2414. /**
  2415. * Recursive helper function called by HKInit
  2416. */
  2417. protected static function HKInitChildren($sTable, $sAttCode, $oAttDef, $iId, &$iCurrIndex)
  2418. {
  2419. $sSQL = "SELECT id FROM `$sTable` WHERE `$sAttCode` = $iId";
  2420. $aRes = CMDBSource::QueryToArray($sSQL);
  2421. $aTree = array();
  2422. $sLeft = $oAttDef->GetSQLLeft();
  2423. $sRight = $oAttDef->GetSQLRight();
  2424. foreach($aRes as $aValues)
  2425. {
  2426. $iChildId = $aValues['id'];
  2427. $iLeft = $iCurrIndex++;
  2428. $aChildren = self::HKInitChildren($sTable, $sAttCode, $oAttDef, $iChildId, $iCurrIndex);
  2429. $iRight = $iCurrIndex++;
  2430. $sSQL = "UPDATE `$sTable` SET `$sLeft` = $iLeft, `$sRight` = $iRight WHERE id= $iChildId";
  2431. CMDBSource::Query($sSQL);
  2432. }
  2433. }
  2434. public static function GenerateUniqueAlias(&$aAliases, $sNewName, $sRealName)
  2435. {
  2436. if (!array_key_exists($sNewName, $aAliases))
  2437. {
  2438. $aAliases[$sNewName] = $sRealName;
  2439. return $sNewName;
  2440. }
  2441. for ($i = 1 ; $i < 100 ; $i++)
  2442. {
  2443. $sAnAlias = $sNewName.$i;
  2444. if (!array_key_exists($sAnAlias, $aAliases))
  2445. {
  2446. // Create that new alias
  2447. $aAliases[$sAnAlias] = $sRealName;
  2448. return $sAnAlias;
  2449. }
  2450. }
  2451. throw new CoreException('Failed to create an alias', array('aliases' => $aAliases, 'new'=>$sNewName));
  2452. }
  2453. public static function CheckDefinitions()
  2454. {
  2455. if (count(self::GetClasses()) == 0)
  2456. {
  2457. throw new CoreException("MetaModel::InitClasses() has not been called, or no class has been declared ?!?!");
  2458. }
  2459. $aErrors = array();
  2460. $aSugFix = array();
  2461. foreach (self::GetClasses() as $sClass)
  2462. {
  2463. $aNameSpec = self::GetNameSpec($sClass);
  2464. foreach($aNameSpec[1] as $i => $sAttCode)
  2465. {
  2466. if(!self::IsValidAttCode($sClass, $sAttCode))
  2467. {
  2468. $aErrors[$sClass][] = "Unkown attribute code '".$sAttCode."' for the name definition";
  2469. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2470. }
  2471. }
  2472. foreach(self::GetReconcKeys($sClass) as $sReconcKeyAttCode)
  2473. {
  2474. if (!empty($sReconcKeyAttCode) && !self::IsValidAttCode($sClass, $sReconcKeyAttCode))
  2475. {
  2476. $aErrors[$sClass][] = "Unkown attribute code '".$sReconcKeyAttCode."' in the list of reconciliation keys";
  2477. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2478. }
  2479. }
  2480. $bHasWritableAttribute = false;
  2481. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2482. {
  2483. // It makes no sense to check the attributes again and again in the subclasses
  2484. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2485. if ($oAttDef->IsExternalKey())
  2486. {
  2487. if (!self::IsValidClass($oAttDef->GetTargetClass()))
  2488. {
  2489. $aErrors[$sClass][] = "Unkown class '".$oAttDef->GetTargetClass()."' for the external key '$sAttCode'";
  2490. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetClasses())."}";
  2491. }
  2492. }
  2493. elseif ($oAttDef->IsExternalField())
  2494. {
  2495. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  2496. if (!self::IsValidAttCode($sClass, $sKeyAttCode) || !self::IsValidKeyAttCode($sClass, $sKeyAttCode))
  2497. {
  2498. $aErrors[$sClass][] = "Unkown key attribute code '".$sKeyAttCode."' for the external field $sAttCode";
  2499. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sClass))."}";
  2500. }
  2501. else
  2502. {
  2503. $oKeyAttDef = self::GetAttributeDef($sClass, $sKeyAttCode);
  2504. $sTargetClass = $oKeyAttDef->GetTargetClass();
  2505. $sExtAttCode = $oAttDef->GetExtAttCode();
  2506. if (!self::IsValidAttCode($sTargetClass, $sExtAttCode))
  2507. {
  2508. $aErrors[$sClass][] = "Unkown key attribute code '".$sExtAttCode."' for the external field $sAttCode";
  2509. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sTargetClass))."}";
  2510. }
  2511. }
  2512. }
  2513. else // standard attributes
  2514. {
  2515. // Check that the default values definition is a valid object!
  2516. $oValSetDef = $oAttDef->GetValuesDef();
  2517. if (!is_null($oValSetDef) && !$oValSetDef instanceof ValueSetDefinition)
  2518. {
  2519. $aErrors[$sClass][] = "Allowed values for attribute $sAttCode is not of the relevant type";
  2520. $aSugFix[$sClass][] = "Please set it as an instance of a ValueSetDefinition object.";
  2521. }
  2522. else
  2523. {
  2524. // Default value must be listed in the allowed values (if defined)
  2525. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  2526. if (!is_null($aAllowedValues))
  2527. {
  2528. $sDefaultValue = $oAttDef->GetDefaultValue();
  2529. if (is_string($sDefaultValue) && !array_key_exists($sDefaultValue, $aAllowedValues))
  2530. {
  2531. $aErrors[$sClass][] = "Default value '".$sDefaultValue."' for attribute $sAttCode is not an allowed value";
  2532. $aSugFix[$sClass][] = "Please pickup the default value out of {'".implode(", ", array_keys($aAllowedValues))."'}";
  2533. }
  2534. }
  2535. }
  2536. }
  2537. // Check dependencies
  2538. if ($oAttDef->IsWritable())
  2539. {
  2540. $bHasWritableAttribute = true;
  2541. foreach ($oAttDef->GetPrerequisiteAttributes() as $sDependOnAttCode)
  2542. {
  2543. if (!self::IsValidAttCode($sClass, $sDependOnAttCode))
  2544. {
  2545. $aErrors[$sClass][] = "Unkown attribute code '".$sDependOnAttCode."' in the list of prerequisite attributes";
  2546. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  2547. }
  2548. }
  2549. }
  2550. }
  2551. foreach(self::GetClassFilterDefs($sClass) as $sFltCode=>$oFilterDef)
  2552. {
  2553. if (method_exists($oFilterDef, '__GetRefAttribute'))
  2554. {
  2555. $oAttDef = $oFilterDef->__GetRefAttribute();
  2556. if (!self::IsValidAttCode($sClass, $oAttDef->GetCode()))
  2557. {
  2558. $aErrors[$sClass][] = "Wrong attribute code '".$oAttDef->GetCode()."' (wrong class) for the \"basic\" filter $sFltCode";
  2559. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2560. }
  2561. }
  2562. }
  2563. // Lifecycle
  2564. //
  2565. $sStateAttCode = self::GetStateAttributeCode($sClass);
  2566. if (strlen($sStateAttCode) > 0)
  2567. {
  2568. // Lifecycle - check that the state attribute does exist as an attribute
  2569. if (!self::IsValidAttCode($sClass, $sStateAttCode))
  2570. {
  2571. $aErrors[$sClass][] = "Unkown attribute code '".$sStateAttCode."' for the state definition";
  2572. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2573. }
  2574. else
  2575. {
  2576. // Lifecycle - check that there is a value set constraint on the state attribute
  2577. $aAllowedValuesRaw = self::GetAllowedValues_att($sClass, $sStateAttCode);
  2578. $aStates = array_keys(self::EnumStates($sClass));
  2579. if (is_null($aAllowedValuesRaw))
  2580. {
  2581. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' will reflect the state of the object. It must be restricted to a set of values";
  2582. $aSugFix[$sClass][] = "Please define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')]";
  2583. }
  2584. else
  2585. {
  2586. $aAllowedValues = array_keys($aAllowedValuesRaw);
  2587. // Lifecycle - check the the state attribute allowed values are defined states
  2588. foreach($aAllowedValues as $sValue)
  2589. {
  2590. if (!in_array($sValue, $aStates))
  2591. {
  2592. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has an allowed value ($sValue) which is not a known state";
  2593. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  2594. }
  2595. }
  2596. // Lifecycle - check that defined states are allowed values
  2597. foreach($aStates as $sStateValue)
  2598. {
  2599. if (!in_array($sStateValue, $aAllowedValues))
  2600. {
  2601. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has a state ($sStateValue) which is not an allowed value";
  2602. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  2603. }
  2604. }
  2605. }
  2606. // Lifcycle - check that the action handlers are defined
  2607. foreach (self::EnumStates($sClass) as $sStateCode => $aStateDef)
  2608. {
  2609. foreach(self::EnumTransitions($sClass, $sStateCode) as $sStimulusCode => $aTransitionDef)
  2610. {
  2611. foreach ($aTransitionDef['actions'] as $sActionHandler)
  2612. {
  2613. if (!method_exists($sClass, $sActionHandler))
  2614. {
  2615. $aErrors[$sClass][] = "Unknown function '$sActionHandler' in transition [$sStateCode/$sStimulusCode] for state attribute '$sStateAttCode'";
  2616. $aSugFix[$sClass][] = "Specify a function which prototype is in the form [public function $sActionHandler(\$sStimulusCode){return true;}]";
  2617. }
  2618. }
  2619. }
  2620. }
  2621. }
  2622. }
  2623. if ($bHasWritableAttribute)
  2624. {
  2625. if (!self::HasTable($sClass))
  2626. {
  2627. $aErrors[$sClass][] = "No table has been defined for this class";
  2628. $aSugFix[$sClass][] = "Either define a table name or move the attributes elsewhere";
  2629. }
  2630. }
  2631. // ZList
  2632. //
  2633. foreach(self::EnumZLists() as $sListCode)
  2634. {
  2635. foreach (self::FlattenZList(self::GetZListItems($sClass, $sListCode)) as $sMyAttCode)
  2636. {
  2637. if (!self::IsValidAttCode($sClass, $sMyAttCode))
  2638. {
  2639. $aErrors[$sClass][] = "Unkown attribute code '".$sMyAttCode."' from ZList '$sListCode'";
  2640. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  2641. }
  2642. }
  2643. }
  2644. }
  2645. if (count($aErrors) > 0)
  2646. {
  2647. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  2648. echo "<h3>Business model inconsistencies have been found</h3>\n";
  2649. // #@# later -> this is the responsibility of the caller to format the output
  2650. foreach ($aErrors as $sClass => $aMessages)
  2651. {
  2652. echo "<p>Wrong declaration for class <b>$sClass</b></p>\n";
  2653. echo "<ul class=\"treeview\">\n";
  2654. $i = 0;
  2655. foreach ($aMessages as $sMsg)
  2656. {
  2657. echo "<li>$sMsg ({$aSugFix[$sClass][$i]})</li>\n";
  2658. $i++;
  2659. }
  2660. echo "</ul>\n";
  2661. }
  2662. echo "<p>Aborting...</p>\n";
  2663. echo "</div>\n";
  2664. exit;
  2665. }
  2666. }
  2667. public static function DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes)
  2668. {
  2669. if (empty($sRepairUrl)) return;
  2670. // By design, some queries might be blank, we have to ignore them
  2671. $aCleanFixes = array();
  2672. foreach($aSQLFixes as $sSQLFix)
  2673. {
  2674. if (!empty($sSQLFix))
  2675. {
  2676. $aCleanFixes[] = $sSQLFix;
  2677. }
  2678. }
  2679. if (count($aCleanFixes) == 0) return;
  2680. echo "<form action=\"$sRepairUrl\" method=\"POST\">\n";
  2681. echo " <input type=\"hidden\" name=\"$sSQLStatementArgName\" value=\"".htmlentities(implode("##SEP##", $aCleanFixes), ENT_QUOTES, 'UTF-8')."\">\n";
  2682. echo " <input type=\"submit\" value=\" Apply changes (".count($aCleanFixes)." queries) \">\n";
  2683. echo "</form>\n";
  2684. }
  2685. public static function DBExists($bMustBeComplete = true)
  2686. {
  2687. // returns true if at least one table exists
  2688. //
  2689. if (!CMDBSource::IsDB(self::$m_sDBName))
  2690. {
  2691. return false;
  2692. }
  2693. CMDBSource::SelectDB(self::$m_sDBName);
  2694. $aFound = array();
  2695. $aMissing = array();
  2696. foreach (self::DBEnumTables() as $sTable => $aClasses)
  2697. {
  2698. if (CMDBSource::IsTable($sTable))
  2699. {
  2700. $aFound[] = $sTable;
  2701. }
  2702. else
  2703. {
  2704. $aMissing[] = $sTable;
  2705. }
  2706. }
  2707. if (count($aFound) == 0)
  2708. {
  2709. // no expected table has been found
  2710. return false;
  2711. }
  2712. else
  2713. {
  2714. if (count($aMissing) == 0)
  2715. {
  2716. // the database is complete (still, could be some fields missing!)
  2717. return true;
  2718. }
  2719. else
  2720. {
  2721. // not all the tables, could be an older version
  2722. if ($bMustBeComplete)
  2723. {
  2724. return false;
  2725. }
  2726. else
  2727. {
  2728. return true;
  2729. }
  2730. }
  2731. }
  2732. }
  2733. public static function DBDrop()
  2734. {
  2735. $bDropEntireDB = true;
  2736. if (!empty(self::$m_sTablePrefix))
  2737. {
  2738. // Do drop only tables corresponding to the sub-database (table prefix)
  2739. // then possibly drop the DB itself (if no table remain)
  2740. foreach (CMDBSource::EnumTables() as $sTable)
  2741. {
  2742. // perform a case insensitive test because on Windows the table names become lowercase :-(
  2743. if (strtolower(substr($sTable, 0, strlen(self::$m_sTablePrefix))) == strtolower(self::$m_sTablePrefix))
  2744. {
  2745. CMDBSource::DropTable($sTable);
  2746. }
  2747. else
  2748. {
  2749. // There is at least one table which is out of the scope of the current application
  2750. $bDropEntireDB = false;
  2751. }
  2752. }
  2753. }
  2754. if ($bDropEntireDB)
  2755. {
  2756. CMDBSource::DropDB(self::$m_sDBName);
  2757. }
  2758. }
  2759. public static function DBCreate()
  2760. {
  2761. // Note: we have to check if the DB does exist, because we may share the DB
  2762. // with other applications (in which case the DB does exist, not the tables with the given prefix)
  2763. if (!CMDBSource::IsDB(self::$m_sDBName))
  2764. {
  2765. CMDBSource::CreateDB(self::$m_sDBName);
  2766. }
  2767. self::DBCreateTables();
  2768. self::DBCreateViews();
  2769. }
  2770. protected static function DBCreateTables()
  2771. {
  2772. list($aErrors, $aSugFix, $aCondensedQueries) = self::DBCheckFormat();
  2773. //$sSQL = implode('; ', $aCondensedQueries); Does not work - multiple queries not allowed
  2774. foreach($aCondensedQueries as $sQuery)
  2775. {
  2776. CMDBSource::CreateTable($sQuery);
  2777. }
  2778. }
  2779. protected static function DBCreateViews()
  2780. {
  2781. list($aErrors, $aSugFix) = self::DBCheckViews();
  2782. $aSQL = array();
  2783. foreach ($aSugFix as $sClass => $aTarget)
  2784. {
  2785. foreach ($aTarget as $aQueries)
  2786. {
  2787. foreach ($aQueries as $sQuery)
  2788. {
  2789. if (!empty($sQuery))
  2790. {
  2791. //$aSQL[] = $sQuery;
  2792. // forces a refresh of cached information
  2793. CMDBSource::CreateTable($sQuery);
  2794. }
  2795. }
  2796. }
  2797. }
  2798. }
  2799. public static function DBDump()
  2800. {
  2801. $aDataDump = array();
  2802. foreach (self::DBEnumTables() as $sTable => $aClasses)
  2803. {
  2804. $aRows = CMDBSource::DumpTable($sTable);
  2805. $aDataDump[$sTable] = $aRows;
  2806. }
  2807. return $aDataDump;
  2808. }
  2809. /*
  2810. * Determines wether the target DB is frozen or not
  2811. */
  2812. public static function DBIsReadOnly()
  2813. {
  2814. // Improvement: check the mySQL variable -> Read-only
  2815. if (UserRights::IsAdministrator())
  2816. {
  2817. return (!self::DBHasAccess(ACCESS_ADMIN_WRITE));
  2818. }
  2819. else
  2820. {
  2821. return (!self::DBHasAccess(ACCESS_USER_WRITE));
  2822. }
  2823. }
  2824. public static function DBHasAccess($iRequested = ACCESS_FULL)
  2825. {
  2826. $iMode = self::$m_oConfig->Get('access_mode');
  2827. if (($iMode & $iRequested) == 0) return false;
  2828. return true;
  2829. }
  2830. protected static function MakeDictEntry($sKey, $sValueFromOldSystem, $sDefaultValue, &$bNotInDico)
  2831. {
  2832. $sValue = Dict::S($sKey, 'x-no-nothing');
  2833. if ($sValue == 'x-no-nothing')
  2834. {
  2835. $bNotInDico = true;
  2836. $sValue = $sValueFromOldSystem;
  2837. if (strlen($sValue) == 0)
  2838. {
  2839. $sValue = $sDefaultValue;
  2840. }
  2841. }
  2842. return " '$sKey' => '".str_replace("'", "\\'", $sValue)."',\n";
  2843. }
  2844. public static function MakeDictionaryTemplate($sModules = '', $sOutputFilter = 'NotInDictionary')
  2845. {
  2846. $sRes = '';
  2847. $sRes .= "// Dictionnay conventions\n";
  2848. $sRes .= htmlentities("// Class:<class_name>\n", ENT_QUOTES, 'UTF-8');
  2849. $sRes .= htmlentities("// Class:<class_name>+\n", ENT_QUOTES, 'UTF-8');
  2850. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>\n", ENT_QUOTES, 'UTF-8');
  2851. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>+\n", ENT_QUOTES, 'UTF-8');
  2852. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>\n", ENT_QUOTES, 'UTF-8');
  2853. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>+\n", ENT_QUOTES, 'UTF-8');
  2854. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>\n", ENT_QUOTES, 'UTF-8');
  2855. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>+\n", ENT_QUOTES, 'UTF-8');
  2856. $sRes .= "\n";
  2857. // Note: I did not use EnumCategories(), because a given class maybe found in several categories
  2858. // Need to invent the "module", to characterize the origins of a class
  2859. if (strlen($sModules) == 0)
  2860. {
  2861. $aModules = array('bizmodel', 'core/cmdb', 'gui' , 'application', 'addon/userrights');
  2862. }
  2863. else
  2864. {
  2865. $aModules = explode(', ', $sModules);
  2866. }
  2867. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2868. $sRes .= "// Note: The classes have been grouped by categories: ".implode(', ', $aModules)."\n";
  2869. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2870. foreach ($aModules as $sCategory)
  2871. {
  2872. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2873. $sRes .= "// Classes in '<em>$sCategory</em>'\n";
  2874. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2875. $sRes .= "//\n";
  2876. $sRes .= "\n";
  2877. foreach (self::GetClasses($sCategory) as $sClass)
  2878. {
  2879. if (!self::HasTable($sClass)) continue;
  2880. $bNotInDico = false;
  2881. $sClassRes = "//\n";
  2882. $sClassRes .= "// Class: $sClass\n";
  2883. $sClassRes .= "//\n";
  2884. $sClassRes .= "\n";
  2885. $sClassRes .= "Dict::Add('EN US', 'English', 'English', array(\n";
  2886. $sClassRes .= self::MakeDictEntry("Class:$sClass", self::GetName_Obsolete($sClass), $sClass, $bNotInDico);
  2887. $sClassRes .= self::MakeDictEntry("Class:$sClass+", self::GetClassDescription_Obsolete($sClass), '', $bNotInDico);
  2888. foreach(self::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  2889. {
  2890. // Skip this attribute if not originaly defined in this class
  2891. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2892. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode", $oAttDef->GetLabel_Obsolete(), $sAttCode, $bNotInDico);
  2893. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode+", $oAttDef->GetDescription_Obsolete(), '', $bNotInDico);
  2894. if ($oAttDef instanceof AttributeEnum)
  2895. {
  2896. if (self::GetStateAttributeCode($sClass) == $sAttCode)
  2897. {
  2898. foreach (self::EnumStates($sClass) as $sStateCode => $aStateData)
  2899. {
  2900. if (array_key_exists('label', $aStateData))
  2901. {
  2902. $sValue = $aStateData['label'];
  2903. }
  2904. else
  2905. {
  2906. $sValue = MetaModel::GetStateLabel($sClass, $sStateCode);
  2907. }
  2908. if (array_key_exists('description', $aStateData))
  2909. {
  2910. $sValuePlus = $aStateData['description'];
  2911. }
  2912. else
  2913. {
  2914. $sValuePlus = MetaModel::GetStateDescription($sClass, $sStateCode);
  2915. }
  2916. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode", $sValue, '', $bNotInDico);
  2917. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode+", $sValuePlus, '', $bNotInDico);
  2918. }
  2919. }
  2920. else
  2921. {
  2922. foreach ($oAttDef->GetAllowedValues() as $sKey => $value)
  2923. {
  2924. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey", $value, '', $bNotInDico);
  2925. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey+", $value, '', $bNotInDico);
  2926. }
  2927. }
  2928. }
  2929. }
  2930. foreach(self::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
  2931. {
  2932. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode", $oStimulus->GetLabel_Obsolete(), '', $bNotInDico);
  2933. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode+", $oStimulus->GetDescription_Obsolete(), '', $bNotInDico);
  2934. }
  2935. $sClassRes .= "));\n";
  2936. $sClassRes .= "\n";
  2937. if ($bNotInDico || ($sOutputFilter != 'NotInDictionary'))
  2938. {
  2939. $sRes .= $sClassRes;
  2940. }
  2941. }
  2942. }
  2943. return $sRes;
  2944. }
  2945. public static function DBCheckFormat()
  2946. {
  2947. $aErrors = array();
  2948. $aSugFix = array();
  2949. // A new way of representing things to be done - quicker to execute !
  2950. $aCreateTable = array(); // array of <table> => <table options>
  2951. $aCreateTableItems = array(); // array of <table> => array of <create definition>
  2952. $aAlterTableItems = array(); // array of <table> => <alter specification>
  2953. foreach (self::GetClasses() as $sClass)
  2954. {
  2955. if (!self::HasTable($sClass)) continue;
  2956. // Check that the table exists
  2957. //
  2958. $sTable = self::DBGetTable($sClass);
  2959. $sKeyField = self::DBGetKey($sClass);
  2960. $sAutoIncrement = (self::IsAutoIncrementKey($sClass) ? "AUTO_INCREMENT" : "");
  2961. $sKeyFieldDefinition = "`$sKeyField` INT(11) NOT NULL $sAutoIncrement PRIMARY KEY";
  2962. if (!CMDBSource::IsTable($sTable))
  2963. {
  2964. $aErrors[$sClass]['*'][] = "table '$sTable' could not be found into the DB";
  2965. $aSugFix[$sClass]['*'][] = "CREATE TABLE `$sTable` ($sKeyFieldDefinition) ENGINE = ".MYSQL_ENGINE." CHARACTER SET utf8 COLLATE utf8_unicode_ci";
  2966. $aCreateTable[$sTable] = "ENGINE = ".MYSQL_ENGINE." CHARACTER SET utf8 COLLATE utf8_unicode_ci";
  2967. $aCreateTableItems[$sTable][$sKeyField] = $sKeyFieldDefinition;
  2968. }
  2969. // Check that the key field exists
  2970. //
  2971. elseif (!CMDBSource::IsField($sTable, $sKeyField))
  2972. {
  2973. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) could not be found";
  2974. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` ADD $sKeyFieldDefinition";
  2975. if (!array_key_exists($sTable, $aCreateTable))
  2976. {
  2977. $aAlterTableItems[$sTable][$sKeyField] = "ADD $sKeyFieldDefinition";
  2978. }
  2979. }
  2980. else
  2981. {
  2982. // Check the key field properties
  2983. //
  2984. if (!CMDBSource::IsKey($sTable, $sKeyField))
  2985. {
  2986. $aErrors[$sClass]['id'][] = "key '$sKeyField' is not a key for table '$sTable'";
  2987. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable`, DROP PRIMARY KEY, ADD PRIMARY key(`$sKeyField`)";
  2988. if (!array_key_exists($sTable, $aCreateTable))
  2989. {
  2990. $aAlterTableItems[$sTable][$sKeyField] = "CHANGE `$sKeyField` $sKeyFieldDefinition";
  2991. }
  2992. }
  2993. if (self::IsAutoIncrementKey($sClass) && !CMDBSource::IsAutoIncrement($sTable, $sKeyField))
  2994. {
  2995. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) is not automatically incremented";
  2996. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` CHANGE `$sKeyField` $sKeyFieldDefinition";
  2997. if (!array_key_exists($sTable, $aCreateTable))
  2998. {
  2999. $aAlterTableItems[$sTable][$sKeyField] = "CHANGE `$sKeyField` $sKeyFieldDefinition";
  3000. }
  3001. }
  3002. }
  3003. // Check that any defined field exists
  3004. //
  3005. $aTableInfo = CMDBSource::GetTableInfo($sTable);
  3006. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3007. {
  3008. // Skip this attribute if not originaly defined in this class
  3009. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  3010. foreach($oAttDef->GetSQLColumns() as $sField => $sDBFieldType)
  3011. {
  3012. $bIndexNeeded = $oAttDef->RequiresIndex();
  3013. $sFieldDefinition = "`$sField` ".($oAttDef->IsNullAllowed() ? "$sDBFieldType NULL" : "$sDBFieldType NOT NULL");
  3014. if (!CMDBSource::IsField($sTable, $sField))
  3015. {
  3016. $aErrors[$sClass][$sAttCode][] = "field '$sField' could not be found in table '$sTable'";
  3017. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD $sFieldDefinition";
  3018. if ($bIndexNeeded)
  3019. {
  3020. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  3021. }
  3022. if (array_key_exists($sTable, $aCreateTable))
  3023. {
  3024. $aCreateTableItems[$sTable][$sField] = $sFieldDefinition;
  3025. if ($bIndexNeeded)
  3026. {
  3027. $aCreateTableItems[$sTable][$sField.'_ix'] = "INDEX (`$sField`)";
  3028. }
  3029. }
  3030. else
  3031. {
  3032. $aAlterTableItems[$sTable][$sField] = "ADD $sFieldDefinition";
  3033. if ($bIndexNeeded)
  3034. {
  3035. $aAlterTableItems[$sTable][$sField.'_ix'] = "ADD INDEX (`$sField`)";
  3036. }
  3037. }
  3038. }
  3039. else
  3040. {
  3041. // The field already exists, does it have the relevant properties?
  3042. //
  3043. $bToBeChanged = false;
  3044. if ($oAttDef->IsNullAllowed() != CMDBSource::IsNullAllowed($sTable, $sField))
  3045. {
  3046. $bToBeChanged = true;
  3047. if ($oAttDef->IsNullAllowed())
  3048. {
  3049. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could be NULL";
  3050. }
  3051. else
  3052. {
  3053. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could NOT be NULL";
  3054. }
  3055. }
  3056. $sActualFieldType = CMDBSource::GetFieldType($sTable, $sField);
  3057. if (strcasecmp($sDBFieldType, $sActualFieldType) != 0)
  3058. {
  3059. $bToBeChanged = true;
  3060. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' has a wrong type: found '$sActualFieldType' while expecting '$sDBFieldType'";
  3061. }
  3062. if ($bToBeChanged)
  3063. {
  3064. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` CHANGE `$sField` $sFieldDefinition";
  3065. $aAlterTableItems[$sTable][$sField] = "CHANGE `$sField` $sFieldDefinition";
  3066. }
  3067. // Create indexes (external keys only... so far)
  3068. //
  3069. if ($bIndexNeeded && !CMDBSource::HasIndex($sTable, $sField))
  3070. {
  3071. $aErrors[$sClass][$sAttCode][] = "Foreign key '$sField' in table '$sTable' should have an index";
  3072. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  3073. $aAlterTableItems[$sTable][$sField.'_ix'] = "ADD INDEX (`$sField`)";
  3074. }
  3075. }
  3076. }
  3077. }
  3078. }
  3079. $aCondensedQueries = array();
  3080. foreach($aCreateTable as $sTable => $sTableOptions)
  3081. {
  3082. $sTableItems = implode(', ', $aCreateTableItems[$sTable]);
  3083. $aCondensedQueries[] = "CREATE TABLE `$sTable` ($sTableItems) $sTableOptions";
  3084. }
  3085. foreach($aAlterTableItems as $sTable => $aChangeList)
  3086. {
  3087. $sChangeList = implode(', ', $aChangeList);
  3088. $aCondensedQueries[] = "ALTER TABLE `$sTable` $sChangeList";
  3089. }
  3090. return array($aErrors, $aSugFix, $aCondensedQueries);
  3091. }
  3092. public static function DBCheckViews()
  3093. {
  3094. $aErrors = array();
  3095. $aSugFix = array();
  3096. // Reporting views (must be created after any other table)
  3097. //
  3098. foreach (self::GetClasses('bizmodel') as $sClass)
  3099. {
  3100. $sView = self::DBGetView($sClass);
  3101. if (CMDBSource::IsTable($sView))
  3102. {
  3103. // Check that the view is complete
  3104. //
  3105. $bIsComplete = true;
  3106. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3107. {
  3108. foreach($oAttDef->GetSQLExpressions() as $sSuffix => $sTrash)
  3109. {
  3110. $sCol = $sAttCode.$sSuffix;
  3111. if (!CMDBSource::IsField($sView, $sCol))
  3112. {
  3113. $bIsComplete = false;
  3114. $aErrors[$sClass][$sAttCode][] = "field '$sCol' could not be found in view '$sView'";
  3115. $aSugFix[$sClass][$sAttCode][] = "";
  3116. }
  3117. }
  3118. }
  3119. if (!$bIsComplete)
  3120. {
  3121. // Rework the view
  3122. //
  3123. $oFilter = new DBObjectSearch($sClass, '');
  3124. $oFilter->AllowAllData();
  3125. $sSQL = self::MakeSelectQuery($oFilter);
  3126. $aErrors[$sClass]['*'][] = "View '$sView' is currently not complete";
  3127. $aSugFix[$sClass]['*'][] = "ALTER VIEW `$sView` AS $sSQL";
  3128. }
  3129. }
  3130. else
  3131. {
  3132. // Create the view
  3133. //
  3134. $oFilter = new DBObjectSearch($sClass, '');
  3135. $oFilter->AllowAllData();
  3136. $sSQL = self::MakeSelectQuery($oFilter);
  3137. $aErrors[$sClass]['*'][] = "Missing view for class: $sClass";
  3138. $aSugFix[$sClass]['*'][] = "CREATE VIEW `$sView` AS $sSQL";
  3139. }
  3140. }
  3141. return array($aErrors, $aSugFix);
  3142. }
  3143. private static function DBCheckIntegrity_Check2Delete($sSelWrongRecs, $sErrorDesc, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel, $bProcessingFriends = false)
  3144. {
  3145. $sRootClass = self::GetRootClass($sClass);
  3146. $sTable = self::DBGetTable($sClass);
  3147. $sKeyField = self::DBGetKey($sClass);
  3148. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  3149. {
  3150. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  3151. }
  3152. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  3153. if (count($aWrongRecords) == 0) return;
  3154. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  3155. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3156. foreach ($aWrongRecords as $iRecordId)
  3157. {
  3158. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  3159. {
  3160. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  3161. {
  3162. case 'Delete':
  3163. // Already planned for a deletion
  3164. // Let's concatenate the errors description together
  3165. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  3166. break;
  3167. case 'Update':
  3168. // Let's plan a deletion
  3169. break;
  3170. }
  3171. }
  3172. else
  3173. {
  3174. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  3175. }
  3176. if (!$bProcessingFriends)
  3177. {
  3178. if (!array_key_exists($sTable, $aPlannedDel) || !in_array($iRecordId, $aPlannedDel[$sTable]))
  3179. {
  3180. // Something new to be deleted...
  3181. $iNewDelCount++;
  3182. }
  3183. }
  3184. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Delete';
  3185. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array();
  3186. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  3187. $aPlannedDel[$sTable][] = $iRecordId;
  3188. }
  3189. // Now make sure that we would delete the records of the other tables for that class
  3190. //
  3191. if (!$bProcessingFriends)
  3192. {
  3193. $sDeleteKeys = "'".implode("', '", $aWrongRecords)."'";
  3194. foreach (self::EnumChildClasses($sRootClass, ENUM_CHILD_CLASSES_ALL) as $sFriendClass)
  3195. {
  3196. $sFriendTable = self::DBGetTable($sFriendClass);
  3197. $sFriendKey = self::DBGetKey($sFriendClass);
  3198. // skip the current table
  3199. if ($sFriendTable == $sTable) continue;
  3200. $sFindRelatedRec = "SELECT DISTINCT maintable.`$sFriendKey` AS id FROM `$sFriendTable` AS maintable WHERE maintable.`$sFriendKey` IN ($sDeleteKeys)";
  3201. self::DBCheckIntegrity_Check2Delete($sFindRelatedRec, "Cascading deletion of record in friend table `<em>$sTable</em>`", $sFriendClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel, true);
  3202. }
  3203. }
  3204. }
  3205. private static function DBCheckIntegrity_Check2Update($sSelWrongRecs, $sErrorDesc, $sColumn, $sNewValue, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  3206. {
  3207. $sRootClass = self::GetRootClass($sClass);
  3208. $sTable = self::DBGetTable($sClass);
  3209. $sKeyField = self::DBGetKey($sClass);
  3210. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  3211. {
  3212. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  3213. }
  3214. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  3215. if (count($aWrongRecords) == 0) return;
  3216. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  3217. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3218. foreach ($aWrongRecords as $iRecordId)
  3219. {
  3220. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  3221. {
  3222. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  3223. {
  3224. case 'Delete':
  3225. // No need to update, the record will be deleted!
  3226. break;
  3227. case 'Update':
  3228. // Already planned for an update
  3229. // Add this new update spec to the list
  3230. $bFoundSameSpec = false;
  3231. foreach ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] as $aUpdateSpec)
  3232. {
  3233. if (($sColumn == $aUpdateSpec['column']) && ($sNewValue == $aUpdateSpec['newvalue']))
  3234. {
  3235. $bFoundSameSpec = true;
  3236. }
  3237. }
  3238. if (!$bFoundSameSpec)
  3239. {
  3240. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'][] = (array('column' => $sColumn, 'newvalue'=>$sNewValue));
  3241. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  3242. }
  3243. break;
  3244. }
  3245. }
  3246. else
  3247. {
  3248. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  3249. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Update';
  3250. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array(array('column' => $sColumn, 'newvalue'=>$sNewValue));
  3251. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  3252. }
  3253. }
  3254. }
  3255. // returns the count of records found for deletion
  3256. public static function DBCheckIntegrity_SinglePass(&$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  3257. {
  3258. foreach (self::GetClasses() as $sClass)
  3259. {
  3260. if (!self::HasTable($sClass)) continue;
  3261. $sRootClass = self::GetRootClass($sClass);
  3262. $sTable = self::DBGetTable($sClass);
  3263. $sKeyField = self::DBGetKey($sClass);
  3264. if (!self::IsStandaloneClass($sClass))
  3265. {
  3266. if (self::IsRootClass($sClass))
  3267. {
  3268. // Check that the final class field contains the name of a class which inherited from the current class
  3269. //
  3270. $sFinalClassField = self::DBGetClassField($sClass);
  3271. $aAllowedValues = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  3272. $sAllowedValues = implode(",", CMDBSource::Quote($aAllowedValues, true));
  3273. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE `$sFinalClassField` NOT IN ($sAllowedValues)";
  3274. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "final class (field `<em>$sFinalClassField</em>`) is wrong (expected a value in {".$sAllowedValues."})", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3275. }
  3276. else
  3277. {
  3278. $sRootTable = self::DBGetTable($sRootClass);
  3279. $sRootKey = self::DBGetKey($sRootClass);
  3280. $sFinalClassField = self::DBGetClassField($sRootClass);
  3281. $aExpectedClasses = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  3282. $sExpectedClasses = implode(",", CMDBSource::Quote($aExpectedClasses, true));
  3283. // Check that any record found here has its counterpart in the root table
  3284. // and which refers to a child class
  3285. //
  3286. $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";
  3287. 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);
  3288. // Check that any record found in the root table and referring to a child class
  3289. // has its counterpart here (detect orphan nodes -root or in the middle of the hierarchy)
  3290. //
  3291. $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)";
  3292. 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);
  3293. }
  3294. }
  3295. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  3296. {
  3297. // Skip this attribute if not defined in this table
  3298. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  3299. if ($oAttDef->IsExternalKey())
  3300. {
  3301. // Check that any external field is pointing to an existing object
  3302. //
  3303. $sRemoteClass = $oAttDef->GetTargetClass();
  3304. $sRemoteTable = self::DBGetTable($sRemoteClass);
  3305. $sRemoteKey = self::DBGetKey($sRemoteClass);
  3306. $aCols = $oAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  3307. $sExtKeyField = current($aCols); // get the first column for an external key
  3308. // Note: a class/table may have an external key on itself
  3309. $sSelBase = "SELECT DISTINCT maintable.`$sKeyField` AS id, maintable.`$sExtKeyField` AS extkey FROM `$sTable` AS maintable LEFT JOIN `$sRemoteTable` ON maintable.`$sExtKeyField` = `$sRemoteTable`.`$sRemoteKey`";
  3310. $sSelWrongRecs = $sSelBase." WHERE `$sRemoteTable`.`$sRemoteKey` IS NULL";
  3311. if ($oAttDef->IsNullAllowed())
  3312. {
  3313. // Exclude the records pointing to 0/null from the errors
  3314. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  3315. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  3316. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3317. }
  3318. else
  3319. {
  3320. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3321. }
  3322. // Do almost the same, taking into account the records planned for deletion
  3323. if (array_key_exists($sRemoteTable, $aPlannedDel) && count($aPlannedDel[$sRemoteTable]) > 0)
  3324. {
  3325. // This could be done by the mean of a 'OR ... IN (aIgnoreRecords)
  3326. // but in that case you won't be able to track the root cause (cascading)
  3327. $sSelWrongRecs = $sSelBase." WHERE maintable.`$sExtKeyField` IN ('".implode("', '", $aPlannedDel[$sRemoteTable])."')";
  3328. if ($oAttDef->IsNullAllowed())
  3329. {
  3330. // Exclude the records pointing to 0/null from the errors
  3331. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  3332. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  3333. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3334. }
  3335. else
  3336. {
  3337. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3338. }
  3339. }
  3340. }
  3341. else if ($oAttDef->IsDirectField())
  3342. {
  3343. // Check that the values fit the allowed values
  3344. //
  3345. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  3346. if (!is_null($aAllowedValues) && count($aAllowedValues) > 0)
  3347. {
  3348. $sExpectedValues = implode(",", CMDBSource::Quote(array_keys($aAllowedValues), true));
  3349. $aCols = $oAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  3350. $sMyAttributeField = current($aCols); // get the first column for the moment
  3351. $sDefaultValue = $oAttDef->GetDefaultValue();
  3352. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE maintable.`$sMyAttributeField` NOT IN ($sExpectedValues)";
  3353. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record having a column ('<em>$sAttCode</em>') with an unexpected value", $sMyAttributeField, CMDBSource::Quote($sDefaultValue), $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3354. }
  3355. }
  3356. }
  3357. }
  3358. }
  3359. public static function DBCheckIntegrity($sRepairUrl = "", $sSQLStatementArgName = "")
  3360. {
  3361. // Records in error, and action to be taken: delete or update
  3362. // by RootClass/Table/Record
  3363. $aErrorsAndFixes = array();
  3364. // Records to be ignored in the current/next pass
  3365. // by Table = array of RecordId
  3366. $aPlannedDel = array();
  3367. // Count of errors in the next pass: no error means that we can leave...
  3368. $iErrorCount = 0;
  3369. // Limit in case of a bug in the algorythm
  3370. $iLoopCount = 0;
  3371. $iNewDelCount = 1; // startup...
  3372. while ($iNewDelCount > 0)
  3373. {
  3374. $iNewDelCount = 0;
  3375. self::DBCheckIntegrity_SinglePass($aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  3376. $iErrorCount += $iNewDelCount;
  3377. // Safety net #1 - limit the planned deletions
  3378. //
  3379. $iMaxDel = 1000;
  3380. $iPlannedDel = 0;
  3381. foreach ($aPlannedDel as $sTable => $aPlannedDelOnTable)
  3382. {
  3383. $iPlannedDel += count($aPlannedDelOnTable);
  3384. }
  3385. if ($iPlannedDel > $iMaxDel)
  3386. {
  3387. throw new CoreWarning("DB Integrity Check safety net - Exceeding the limit of $iMaxDel planned record deletion");
  3388. break;
  3389. }
  3390. // Safety net #2 - limit the iterations
  3391. //
  3392. $iLoopCount++;
  3393. $iMaxLoops = 10;
  3394. if ($iLoopCount > $iMaxLoops)
  3395. {
  3396. throw new CoreWarning("DB Integrity Check safety net - Reached the limit of $iMaxLoops loops");
  3397. break;
  3398. }
  3399. }
  3400. // Display the results
  3401. //
  3402. $iIssueCount = 0;
  3403. $aFixesDelete = array();
  3404. $aFixesUpdate = array();
  3405. foreach ($aErrorsAndFixes as $sRootClass => $aTables)
  3406. {
  3407. foreach ($aTables as $sTable => $aRecords)
  3408. {
  3409. foreach ($aRecords as $iRecord => $aError)
  3410. {
  3411. $sAction = $aError['Action'];
  3412. $sReason = $aError['Reason'];
  3413. $iPass = $aError['Pass'];
  3414. switch ($sAction)
  3415. {
  3416. case 'Delete':
  3417. $sActionDetails = "";
  3418. $aFixesDelete[$sTable][] = $iRecord;
  3419. break;
  3420. case 'Update':
  3421. $aUpdateDesc = array();
  3422. foreach($aError['Action_Details'] as $aUpdateSpec)
  3423. {
  3424. $aUpdateDesc[] = $aUpdateSpec['column']." -&gt; ".$aUpdateSpec['newvalue'];
  3425. $aFixesUpdate[$sTable][$aUpdateSpec['column']][$aUpdateSpec['newvalue']][] = $iRecord;
  3426. }
  3427. $sActionDetails = "Set ".implode(", ", $aUpdateDesc);
  3428. break;
  3429. default:
  3430. $sActionDetails = "bug: unknown action '$sAction'";
  3431. }
  3432. $aIssues[] = "$sRootClass / $sTable / $iRecord / $sReason / $sAction / $sActionDetails";
  3433. $iIssueCount++;
  3434. }
  3435. }
  3436. }
  3437. if ($iIssueCount > 0)
  3438. {
  3439. // Build the queries to fix in the database
  3440. //
  3441. // First step, be able to get class data out of the table name
  3442. // Could be optimized, because we've made the job earlier... but few benefits, so...
  3443. $aTable2ClassProp = array();
  3444. foreach (self::GetClasses() as $sClass)
  3445. {
  3446. if (!self::HasTable($sClass)) continue;
  3447. $sRootClass = self::GetRootClass($sClass);
  3448. $sTable = self::DBGetTable($sClass);
  3449. $sKeyField = self::DBGetKey($sClass);
  3450. $aErrorsAndFixes[$sRootClass][$sTable] = array();
  3451. $aTable2ClassProp[$sTable] = array('rootclass'=>$sRootClass, 'class'=>$sClass, 'keyfield'=>$sKeyField);
  3452. }
  3453. // Second step, build a flat list of SQL queries
  3454. $aSQLFixes = array();
  3455. $iPlannedUpdate = 0;
  3456. foreach ($aFixesUpdate as $sTable => $aColumns)
  3457. {
  3458. foreach ($aColumns as $sColumn => $aNewValues)
  3459. {
  3460. foreach ($aNewValues as $sNewValue => $aRecords)
  3461. {
  3462. $iPlannedUpdate += count($aRecords);
  3463. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  3464. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  3465. $aSQLFixes[] = "UPDATE `$sTable` SET `$sColumn` = $sNewValue WHERE `$sKeyField` IN ($sWrongRecords)";
  3466. }
  3467. }
  3468. }
  3469. $iPlannedDel = 0;
  3470. foreach ($aFixesDelete as $sTable => $aRecords)
  3471. {
  3472. $iPlannedDel += count($aRecords);
  3473. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  3474. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  3475. $aSQLFixes[] = "DELETE FROM `$sTable` WHERE `$sKeyField` IN ($sWrongRecords)";
  3476. }
  3477. // Report the results
  3478. //
  3479. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  3480. echo "<h3>Database corruption error(s): $iErrorCount issues have been encountered. $iPlannedDel records will be deleted, $iPlannedUpdate records will be updated:</h3>\n";
  3481. // #@# later -> this is the responsibility of the caller to format the output
  3482. echo "<ul class=\"treeview\">\n";
  3483. foreach ($aIssues as $sIssueDesc)
  3484. {
  3485. echo "<li>$sIssueDesc</li>\n";
  3486. }
  3487. echo "</ul>\n";
  3488. self::DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes);
  3489. echo "<p>Aborting...</p>\n";
  3490. echo "</div>\n";
  3491. exit;
  3492. }
  3493. }
  3494. public static function Startup($sConfigFile, $bModelOnly = false, $bAllowCache = true, $bTraceSourceFiles = false)
  3495. {
  3496. self::$m_bTraceSourceFiles = $bTraceSourceFiles;
  3497. self::LoadConfig($sConfigFile, $bAllowCache);
  3498. if ($bModelOnly) return;
  3499. CMDBSource::SelectDB(self::$m_sDBName);
  3500. foreach(get_declared_classes() as $sPHPClass)
  3501. {
  3502. if (is_subclass_of($sPHPClass, 'ModuleHandlerAPI'))
  3503. {
  3504. $aCallSpec = array($sPHPClass, 'OnMetaModelStarted');
  3505. call_user_func_array($aCallSpec, array());
  3506. }
  3507. }
  3508. if (false)
  3509. {
  3510. echo "Debug<br/>\n";
  3511. self::static_var_dump();
  3512. }
  3513. }
  3514. public static function LoadConfig($sConfigFile, $bAllowCache = false)
  3515. {
  3516. self::$m_oConfig = new Config($sConfigFile);
  3517. // Set log ASAP
  3518. if (self::$m_oConfig->GetLogGlobal())
  3519. {
  3520. if (self::$m_oConfig->GetLogIssue())
  3521. {
  3522. self::$m_bLogIssue = true;
  3523. IssueLog::Enable(APPROOT.'/error.log');
  3524. }
  3525. self::$m_bLogNotification = self::$m_oConfig->GetLogNotification();
  3526. self::$m_bLogWebService = self::$m_oConfig->GetLogWebService();
  3527. ToolsLog::Enable(APPROOT.'/tools.log');
  3528. }
  3529. else
  3530. {
  3531. self::$m_bLogIssue = false;
  3532. self::$m_bLogNotification = false;
  3533. self::$m_bLogWebService = false;
  3534. }
  3535. if (self::$m_oConfig->GetLogKPIDuration())
  3536. {
  3537. ExecutionKPI::EnableDuration();
  3538. }
  3539. if (self::$m_oConfig->GetLogKPIMemory())
  3540. {
  3541. ExecutionKPI::EnableMemory();
  3542. }
  3543. self::$m_bTraceQueries = self::$m_oConfig->GetDebugQueries();
  3544. self::$m_bQueryCacheEnabled = self::$m_oConfig->GetQueryCacheEnabled();
  3545. self::$m_bSkipCheckToWrite = self::$m_oConfig->Get('skip_check_to_write');
  3546. self::$m_bSkipCheckExtKeys = self::$m_oConfig->Get('skip_check_ext_keys');
  3547. self::$m_bUseAPCCache = $bAllowCache
  3548. && self::$m_oConfig->Get('apc_cache.enabled')
  3549. && function_exists('apc_fetch')
  3550. && function_exists('apc_store');
  3551. self::$m_iQueryCacheTTL = self::$m_oConfig->Get('apc_cache.query_ttl');
  3552. // PHP timezone first...
  3553. //
  3554. $sPHPTimezone = self::$m_oConfig->Get('timezone');
  3555. if ($sPHPTimezone == '')
  3556. {
  3557. // Leave as is... up to the admin to set a value somewhere...
  3558. //$sPHPTimezone = date_default_timezone_get();
  3559. }
  3560. else
  3561. {
  3562. date_default_timezone_set($sPHPTimezone);
  3563. }
  3564. // Note: load the dictionary as soon as possible, because it might be
  3565. // needed when some error occur
  3566. $sAppIdentity = self::GetConfig()->Get('session_name');
  3567. if (!self::$m_bUseAPCCache || !Dict::InCache($sAppIdentity))
  3568. {
  3569. foreach (self::$m_oConfig->GetDictionaries() as $sModule => $sToInclude)
  3570. {
  3571. self::IncludeModule($sConfigFile, 'dictionaries', $sToInclude);
  3572. }
  3573. if (self::$m_bUseAPCCache)
  3574. {
  3575. Dict::InitCache($sAppIdentity);
  3576. }
  3577. }
  3578. // Set the language... after the dictionaries have been loaded!
  3579. Dict::SetDefaultLanguage(self::$m_oConfig->GetDefaultLanguage());
  3580. // Romain: this is the only way I've found to cope with the fact that
  3581. // classes have to be derived from cmdbabstract (to be editable in the UI)
  3582. require_once(APPROOT.'/application/cmdbabstract.class.inc.php');
  3583. foreach (self::$m_oConfig->GetAppModules() as $sModule => $sToInclude)
  3584. {
  3585. self::IncludeModule($sConfigFile, 'application', $sToInclude);
  3586. }
  3587. foreach (self::$m_oConfig->GetDataModels() as $sModule => $sToInclude)
  3588. {
  3589. self::IncludeModule($sConfigFile, 'business', $sToInclude);
  3590. }
  3591. foreach (self::$m_oConfig->GetWebServiceCategories() as $sModule => $sToInclude)
  3592. {
  3593. self::IncludeModule($sConfigFile, 'webservice', $sToInclude);
  3594. }
  3595. foreach (self::$m_oConfig->GetAddons() as $sModule => $sToInclude)
  3596. {
  3597. self::IncludeModule($sConfigFile, 'addons', $sToInclude);
  3598. }
  3599. $sServer = self::$m_oConfig->GetDBHost();
  3600. $sUser = self::$m_oConfig->GetDBUser();
  3601. $sPwd = self::$m_oConfig->GetDBPwd();
  3602. $sSource = self::$m_oConfig->GetDBName();
  3603. $sTablePrefix = self::$m_oConfig->GetDBSubname();
  3604. $sCharacterSet = self::$m_oConfig->GetDBCharacterSet();
  3605. $sCollation = self::$m_oConfig->GetDBCollation();
  3606. if (self::$m_bUseAPCCache)
  3607. {
  3608. $oKPI = new ExecutionKPI();
  3609. // Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
  3610. //
  3611. $sAppIdentity = self::GetConfig()->Get('session_name');
  3612. $sOqlAPCCacheId = $sAppIdentity.'-metamodel';
  3613. $result = apc_fetch($sOqlAPCCacheId);
  3614. if (is_array($result))
  3615. {
  3616. // todo - verifier que toutes les classes mentionnees ici sont chargees dans InitClasses()
  3617. self::$m_aExtensionClasses = $result['m_aExtensionClasses'];
  3618. self::$m_Category2Class = $result['m_Category2Class'];
  3619. self::$m_aRootClasses = $result['m_aRootClasses'];
  3620. self::$m_aParentClasses = $result['m_aParentClasses'];
  3621. self::$m_aChildClasses = $result['m_aChildClasses'];
  3622. self::$m_aClassParams = $result['m_aClassParams'];
  3623. self::$m_aAttribDefs = $result['m_aAttribDefs'];
  3624. self::$m_aAttribOrigins = $result['m_aAttribOrigins'];
  3625. self::$m_aExtKeyFriends = $result['m_aExtKeyFriends'];
  3626. self::$m_aIgnoredAttributes = $result['m_aIgnoredAttributes'];
  3627. self::$m_aFilterDefs = $result['m_aFilterDefs'];
  3628. self::$m_aFilterOrigins = $result['m_aFilterOrigins'];
  3629. self::$m_aListInfos = $result['m_aListInfos'];
  3630. self::$m_aListData = $result['m_aListData'];
  3631. self::$m_aRelationInfos = $result['m_aRelationInfos'];
  3632. self::$m_aStates = $result['m_aStates'];
  3633. self::$m_aStimuli = $result['m_aStimuli'];
  3634. self::$m_aTransitions = $result['m_aTransitions'];
  3635. }
  3636. $oKPI->ComputeAndReport('Metamodel APC (fetch + read)');
  3637. }
  3638. if (count(self::$m_aAttribDefs) == 0)
  3639. {
  3640. // The includes have been included, let's browse the existing classes and
  3641. // develop some data based on the proposed model
  3642. $oKPI = new ExecutionKPI();
  3643. self::InitClasses($sTablePrefix);
  3644. $oKPI->ComputeAndReport('Initialization of Data model structures');
  3645. if (self::$m_bUseAPCCache)
  3646. {
  3647. $oKPI = new ExecutionKPI();
  3648. $aCache = array();
  3649. $aCache['m_aExtensionClasses'] = self::$m_aExtensionClasses;
  3650. $aCache['m_Category2Class'] = self::$m_Category2Class;
  3651. $aCache['m_aRootClasses'] = self::$m_aRootClasses; // array of "classname" => "rootclass"
  3652. $aCache['m_aParentClasses'] = self::$m_aParentClasses; // array of ("classname" => array of "parentclass")
  3653. $aCache['m_aChildClasses'] = self::$m_aChildClasses; // array of ("classname" => array of "childclass")
  3654. $aCache['m_aClassParams'] = self::$m_aClassParams; // array of ("classname" => array of class information)
  3655. $aCache['m_aAttribDefs'] = self::$m_aAttribDefs; // array of ("classname" => array of attributes)
  3656. $aCache['m_aAttribOrigins'] = self::$m_aAttribOrigins; // array of ("classname" => array of ("attcode"=>"sourceclass"))
  3657. $aCache['m_aExtKeyFriends'] = self::$m_aExtKeyFriends; // array of ("classname" => array of ("indirect ext key attcode"=> array of ("relative ext field")))
  3658. $aCache['m_aIgnoredAttributes'] = self::$m_aIgnoredAttributes; //array of ("classname" => array of ("attcode")
  3659. $aCache['m_aFilterDefs'] = self::$m_aFilterDefs; // array of ("classname" => array filterdef)
  3660. $aCache['m_aFilterOrigins'] = self::$m_aFilterOrigins; // array of ("classname" => array of ("attcode"=>"sourceclass"))
  3661. $aCache['m_aListInfos'] = self::$m_aListInfos; // array of ("listcode" => various info on the list, common to every classes)
  3662. $aCache['m_aListData'] = self::$m_aListData; // array of ("classname" => array of "listcode" => list)
  3663. $aCache['m_aRelationInfos'] = self::$m_aRelationInfos; // array of ("relcode" => various info on the list, common to every classes)
  3664. $aCache['m_aStates'] = self::$m_aStates; // array of ("classname" => array of "statecode"=>array('label'=>..., attribute_inherit=> attribute_list=>...))
  3665. $aCache['m_aStimuli'] = self::$m_aStimuli; // array of ("classname" => array of ("stimuluscode"=>array('label'=>...)))
  3666. $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)))
  3667. apc_store($sOqlAPCCacheId, $aCache);
  3668. $oKPI->ComputeAndReport('Metamodel APC (store)');
  3669. }
  3670. }
  3671. self::$m_sDBName = $sSource;
  3672. self::$m_sTablePrefix = $sTablePrefix;
  3673. CMDBSource::Init($sServer, $sUser, $sPwd); // do not select the DB (could not exist)
  3674. CMDBSource::SetCharacterSet($sCharacterSet, $sCollation);
  3675. // Later when timezone implementation is correctly done: CMDBSource::SetTimezone($sDBTimezone);
  3676. }
  3677. public static function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
  3678. {
  3679. return self::$m_oConfig->GetModuleSetting($sModule, $sProperty, $defaultvalue);
  3680. }
  3681. public static function GetConfig()
  3682. {
  3683. return self::$m_oConfig;
  3684. }
  3685. protected static $m_aExtensionClasses = array();
  3686. protected static function IncludeModule($sConfigFile, $sModuleType, $sToInclude)
  3687. {
  3688. $sFirstChar = substr($sToInclude, 0, 1);
  3689. $sSecondChar = substr($sToInclude, 1, 1);
  3690. if (($sFirstChar != '/') && ($sFirstChar != '\\') && ($sSecondChar != ':'))
  3691. {
  3692. // It is a relative path, prepend APPROOT
  3693. if (substr($sToInclude, 0, 3) == '../')
  3694. {
  3695. // Preserve compatibility with config files written before 1.0.1
  3696. // Replace '../' by '<root>/'
  3697. $sFile = APPROOT.'/'.substr($sToInclude, 3);
  3698. }
  3699. else
  3700. {
  3701. $sFile = APPROOT.'/'.$sToInclude;
  3702. }
  3703. }
  3704. else
  3705. {
  3706. // Leave as is - should be an absolute path
  3707. $sFile = $sToInclude;
  3708. }
  3709. if (!file_exists($sFile))
  3710. {
  3711. throw new CoreException('Wrong filename in configuration file', array('file' => $sConfigFile, 'module' => $sModuleType, 'filename' => $sFile));
  3712. }
  3713. require_once($sFile);
  3714. }
  3715. // Building an object
  3716. //
  3717. //
  3718. private static $aQueryCacheGetObject = array();
  3719. private static $aQueryCacheGetObjectHits = array();
  3720. public static function GetQueryCacheStatus()
  3721. {
  3722. $aRes = array();
  3723. $iTotalHits = 0;
  3724. foreach(self::$aQueryCacheGetObjectHits as $sClass => $iHits)
  3725. {
  3726. $aRes[] = "$sClass: $iHits";
  3727. $iTotalHits += $iHits;
  3728. }
  3729. return $iTotalHits.' ('.implode(', ', $aRes).')';
  3730. }
  3731. public static function MakeSingleRow($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false)
  3732. {
  3733. if (!array_key_exists($sClass, self::$aQueryCacheGetObject))
  3734. {
  3735. // NOTE: Quick and VERY dirty caching mechanism which relies on
  3736. // the fact that the string '987654321' will never appear in the
  3737. // standard query
  3738. // This could be simplified a little, relying solely on the query cache,
  3739. // but this would slow down -by how much time?- the application
  3740. $oFilter = new DBObjectSearch($sClass);
  3741. $oFilter->AddCondition('id', 987654321, '=');
  3742. if ($bAllowAllData)
  3743. {
  3744. $oFilter->AllowAllData();
  3745. }
  3746. $sSQL = self::MakeSelectQuery($oFilter);
  3747. self::$aQueryCacheGetObject[$sClass] = $sSQL;
  3748. self::$aQueryCacheGetObjectHits[$sClass] = 0;
  3749. }
  3750. else
  3751. {
  3752. $sSQL = self::$aQueryCacheGetObject[$sClass];
  3753. self::$aQueryCacheGetObjectHits[$sClass] += 1;
  3754. // echo " -load $sClass/$iKey- ".self::$aQueryCacheGetObjectHits[$sClass]."<br/>\n";
  3755. }
  3756. $sSQL = str_replace(CMDBSource::Quote(987654321), CMDBSource::Quote($iKey), $sSQL);
  3757. $res = CMDBSource::Query($sSQL);
  3758. $aRow = CMDBSource::FetchArray($res);
  3759. CMDBSource::FreeResult($res);
  3760. if ($bMustBeFound && empty($aRow))
  3761. {
  3762. throw new CoreException("No result for the single row query: '$sSQL'");
  3763. }
  3764. return $aRow;
  3765. }
  3766. public static function GetObjectByRow($sClass, $aRow, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
  3767. {
  3768. self::_check_subclass($sClass);
  3769. if (strlen($sClassAlias) == 0)
  3770. {
  3771. $sClassAlias = $sClass;
  3772. }
  3773. // Compound objects: if available, get the final object class
  3774. //
  3775. if (!array_key_exists($sClassAlias."finalclass", $aRow))
  3776. {
  3777. // Either this is a bug (forgot to specify a root class with a finalclass field
  3778. // Or this is the expected behavior, because the object is not made of several tables
  3779. }
  3780. elseif (empty($aRow[$sClassAlias."finalclass"]))
  3781. {
  3782. // The data is missing in the DB
  3783. // @#@ possible improvement: check that the class is valid !
  3784. $sRootClass = self::GetRootClass($sClass);
  3785. $sFinalClassField = self::DBGetClassField($sRootClass);
  3786. throw new CoreException("Empty class name for object $sClass::{$aRow["id"]} (root class '$sRootClass', field '{$sFinalClassField}' is empty)");
  3787. }
  3788. else
  3789. {
  3790. // do the job for the real target class
  3791. $sClass = $aRow[$sClassAlias."finalclass"];
  3792. }
  3793. return new $sClass($aRow, $sClassAlias, $aAttToLoad, $aExtendedDataSpec);
  3794. }
  3795. public static function GetObject($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false)
  3796. {
  3797. self::_check_subclass($sClass);
  3798. $aRow = self::MakeSingleRow($sClass, $iKey, $bMustBeFound, $bAllowAllData);
  3799. if (empty($aRow))
  3800. {
  3801. return null;
  3802. }
  3803. return self::GetObjectByRow($sClass, $aRow);
  3804. }
  3805. public static function GetObjectByName($sClass, $sName, $bMustBeFound = true)
  3806. {
  3807. self::_check_subclass($sClass);
  3808. $oObjSearch = new DBObjectSearch($sClass);
  3809. $oObjSearch->AddNameCondition($sName);
  3810. $oSet = new DBObjectSet($oObjSearch);
  3811. if ($oSet->Count() != 1)
  3812. {
  3813. if ($bMustBeFound) throw new CoreException('Failed to get an object by its name', array('class'=>$sClass, 'name'=>$sName));
  3814. return null;
  3815. }
  3816. $oObj = $oSet->fetch();
  3817. return $oObj;
  3818. }
  3819. static protected $m_aCacheObjectByColumn = array();
  3820. public static function GetObjectByColumn($sClass, $sAttCode, $value, $bMustBeFoundUnique = true)
  3821. {
  3822. if (!isset(self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value]))
  3823. {
  3824. self::_check_subclass($sClass);
  3825. $oObjSearch = new DBObjectSearch($sClass);
  3826. $oObjSearch->AddCondition($sAttCode, $value, '=');
  3827. $oSet = new DBObjectSet($oObjSearch);
  3828. if ($oSet->Count() == 1)
  3829. {
  3830. self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value] = $oSet->fetch();
  3831. }
  3832. else
  3833. {
  3834. if ($bMustBeFoundUnique) throw new CoreException('Failed to get an object by column', array('class'=>$sClass, 'attcode'=>$sAttCode, 'value'=>$value, 'matches' => $oSet->Count()));
  3835. self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value] = null;
  3836. }
  3837. }
  3838. return self::$m_aCacheObjectByColumn[$sClass][$sAttCode][$value];
  3839. }
  3840. public static function GetObjectFromOQL($sQuery, $aParams = null, $bAllowAllData = false)
  3841. {
  3842. $oFilter = DBObjectSearch::FromOQL($sQuery, $aParams);
  3843. if ($bAllowAllData)
  3844. {
  3845. $oFilter->AllowAllData();
  3846. }
  3847. $oSet = new DBObjectSet($oFilter);
  3848. $oObject = $oSet->Fetch();
  3849. return $oObject;
  3850. }
  3851. public static function GetHyperLink($sTargetClass, $iKey)
  3852. {
  3853. if ($iKey < 0)
  3854. {
  3855. return "$sTargetClass: $iKey (invalid value)";
  3856. }
  3857. $oObj = self::GetObject($sTargetClass, $iKey, false);
  3858. if (is_null($oObj))
  3859. {
  3860. return "$sTargetClass: $iKey (not found)";
  3861. }
  3862. return $oObj->GetHyperLink();
  3863. }
  3864. public static function NewObject($sClass)
  3865. {
  3866. self::_check_subclass($sClass);
  3867. return new $sClass();
  3868. }
  3869. public static function GetNextKey($sClass)
  3870. {
  3871. $sRootClass = MetaModel::GetRootClass($sClass);
  3872. $sRootTable = MetaModel::DBGetTable($sRootClass);
  3873. $iNextKey = CMDBSource::GetNextInsertId($sRootTable);
  3874. return $iNextKey;
  3875. }
  3876. public static function BulkDelete(DBObjectSearch $oFilter)
  3877. {
  3878. $sSQL = self::MakeDeleteQuery($oFilter);
  3879. if (!self::DBIsReadOnly())
  3880. {
  3881. CMDBSource::Query($sSQL);
  3882. }
  3883. }
  3884. public static function BulkUpdate(DBObjectSearch $oFilter, array $aValues)
  3885. {
  3886. // $aValues is an array of $sAttCode => $value
  3887. $sSQL = self::MakeUpdateQuery($oFilter, $aValues);
  3888. if (!self::DBIsReadOnly())
  3889. {
  3890. CMDBSource::Query($sSQL);
  3891. }
  3892. }
  3893. // Links
  3894. //
  3895. //
  3896. public static function EnumReferencedClasses($sClass)
  3897. {
  3898. self::_check_subclass($sClass);
  3899. // 1-N links (referenced by my class), returns an array of sAttCode=>sClass
  3900. $aResult = array();
  3901. foreach(self::$m_aAttribDefs[$sClass] as $sAttCode=>$oAttDef)
  3902. {
  3903. if ($oAttDef->IsExternalKey())
  3904. {
  3905. $aResult[$sAttCode] = $oAttDef->GetTargetClass();
  3906. }
  3907. }
  3908. return $aResult;
  3909. }
  3910. public static function EnumReferencingClasses($sClass, $bSkipLinkingClasses = false, $bInnerJoinsOnly = false)
  3911. {
  3912. self::_check_subclass($sClass);
  3913. if ($bSkipLinkingClasses)
  3914. {
  3915. $aLinksClasses = self::EnumLinksClasses();
  3916. }
  3917. // 1-N links (referencing my class), array of sClass => array of sAttcode
  3918. $aResult = array();
  3919. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  3920. {
  3921. if ($bSkipLinkingClasses && in_array($sSomeClass, $aLinksClasses)) continue;
  3922. $aExtKeys = array();
  3923. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  3924. {
  3925. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  3926. if ($oAttDef->IsExternalKey() && (self::IsParentClass($oAttDef->GetTargetClass(), $sClass)))
  3927. {
  3928. if ($bInnerJoinsOnly && $oAttDef->IsNullAllowed()) continue;
  3929. // Ok, I want this one
  3930. $aExtKeys[$sAttCode] = $oAttDef;
  3931. }
  3932. }
  3933. if (count($aExtKeys) != 0)
  3934. {
  3935. $aResult[$sSomeClass] = $aExtKeys;
  3936. }
  3937. }
  3938. return $aResult;
  3939. }
  3940. public static function EnumLinksClasses()
  3941. {
  3942. // Returns a flat array of classes having at least two external keys
  3943. $aResult = array();
  3944. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  3945. {
  3946. $iExtKeyCount = 0;
  3947. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  3948. {
  3949. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  3950. if ($oAttDef->IsExternalKey())
  3951. {
  3952. $iExtKeyCount++;
  3953. }
  3954. }
  3955. if ($iExtKeyCount >= 2)
  3956. {
  3957. $aResult[] = $sSomeClass;
  3958. }
  3959. }
  3960. return $aResult;
  3961. }
  3962. public static function EnumLinkingClasses($sClass = "")
  3963. {
  3964. // N-N links, array of sLinkClass => (array of sAttCode=>sClass)
  3965. $aResult = array();
  3966. foreach (self::EnumLinksClasses() as $sSomeClass)
  3967. {
  3968. $aTargets = array();
  3969. $bFoundClass = false;
  3970. foreach (self::ListAttributeDefs($sSomeClass) as $sAttCode=>$oAttDef)
  3971. {
  3972. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  3973. if ($oAttDef->IsExternalKey())
  3974. {
  3975. $sRemoteClass = $oAttDef->GetTargetClass();
  3976. if (empty($sClass))
  3977. {
  3978. $aTargets[$sAttCode] = $sRemoteClass;
  3979. }
  3980. elseif ($sClass == $sRemoteClass)
  3981. {
  3982. $bFoundClass = true;
  3983. }
  3984. else
  3985. {
  3986. $aTargets[$sAttCode] = $sRemoteClass;
  3987. }
  3988. }
  3989. }
  3990. if (empty($sClass) || $bFoundClass)
  3991. {
  3992. $aResult[$sSomeClass] = $aTargets;
  3993. }
  3994. }
  3995. return $aResult;
  3996. }
  3997. public static function GetLinkLabel($sLinkClass, $sAttCode)
  3998. {
  3999. self::_check_subclass($sLinkClass);
  4000. // e.g. "supported by" (later: $this->GetLinkLabel(), computed on link data!)
  4001. return self::GetLabel($sLinkClass, $sAttCode);
  4002. }
  4003. /**
  4004. * Replaces all the parameters by the values passed in the hash array
  4005. */
  4006. static public function ApplyParams($aInput, $aParams)
  4007. {
  4008. $aSearches = array();
  4009. $aReplacements = array();
  4010. foreach($aParams as $sSearch => $replace)
  4011. {
  4012. // Some environment parameters are objects, we just need scalars
  4013. if (is_object($replace)) continue;
  4014. $aSearches[] = '$'.$sSearch.'$';
  4015. $aReplacements[] = (string) $replace;
  4016. }
  4017. return str_replace($aSearches, $aReplacements, $aInput);
  4018. }
  4019. /**
  4020. * Returns an array of classes implementing the given interface
  4021. */
  4022. public static function EnumPlugins($sInterface)
  4023. {
  4024. if (array_key_exists($sInterface, self::$m_aExtensionClasses))
  4025. {
  4026. return self::$m_aExtensionClasses[$sInterface];
  4027. }
  4028. else
  4029. {
  4030. return array();
  4031. }
  4032. }
  4033. public static function GetCacheEntries(Config $oConfig = null)
  4034. {
  4035. if (!function_exists('apc_cache_info')) return array();
  4036. if (is_null($oConfig))
  4037. {
  4038. $oConfig = self::GetConfig();
  4039. }
  4040. $sAppIdentity = $oConfig->Get('session_name');
  4041. $aCacheUserData = apc_cache_info('user');
  4042. $sPrefix = $sAppIdentity.'-';
  4043. $aEntries = array();
  4044. foreach($aCacheUserData['cache_list'] as $i => $aEntry)
  4045. {
  4046. $sEntryKey = $aEntry['info'];
  4047. if (strpos($sEntryKey, $sPrefix) === 0)
  4048. {
  4049. $sCleanKey = substr($sEntryKey, strlen($sPrefix));
  4050. $aEntries[$sCleanKey] = $aEntry;
  4051. }
  4052. }
  4053. return $aEntries;
  4054. }
  4055. public static function ResetCache(Config $oConfig = null)
  4056. {
  4057. if (!function_exists('apc_delete')) return;
  4058. if (is_null($oConfig))
  4059. {
  4060. $oConfig = self::GetConfig();
  4061. }
  4062. $sAppIdentity = $oConfig->Get('session_name');
  4063. Dict::ResetCache($sAppIdentity);
  4064. foreach(self::GetCacheEntries($oConfig) as $sKey => $aAPCInfo)
  4065. {
  4066. $sAPCKey = $aAPCInfo['info'];
  4067. apc_delete($sAPCKey);
  4068. }
  4069. }
  4070. } // class MetaModel
  4071. // Standard attribute lists
  4072. MetaModel::RegisterZList("noneditable", array("description"=>"non editable fields", "type"=>"attributes"));
  4073. MetaModel::RegisterZList("details", array("description"=>"All attributes to be displayed for the 'details' of an object", "type"=>"attributes"));
  4074. MetaModel::RegisterZList("list", array("description"=>"All attributes to be displayed for a list of objects", "type"=>"attributes"));
  4075. MetaModel::RegisterZList("preview", array("description"=>"All attributes visible in preview mode", "type"=>"attributes"));
  4076. MetaModel::RegisterZList("standard_search", array("description"=>"List of criteria for the standard search", "type"=>"filters"));
  4077. MetaModel::RegisterZList("advanced_search", array("description"=>"List of criteria for the advanced search", "type"=>"filters"));
  4078. ?>