metamodel.class.php 108 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309
  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. /**
  17. * Metamodel
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. // #@# todo: change into class const (see Doctrine)
  25. // Doctrine example
  26. // class toto
  27. // {
  28. // /**
  29. // * VERSION
  30. // */
  31. // const VERSION = '1.0.0';
  32. // }
  33. /**
  34. * add some description here...
  35. *
  36. * @package iTopORM
  37. */
  38. define('ENUM_CHILD_CLASSES_EXCLUDETOP', 1);
  39. /**
  40. * add some description here...
  41. *
  42. * @package iTopORM
  43. */
  44. define('ENUM_CHILD_CLASSES_ALL', 2);
  45. /**
  46. * Specifies that this attribute is hidden in that state
  47. *
  48. * @package iTopORM
  49. */
  50. define('OPT_ATT_HIDDEN', 1);
  51. /**
  52. * Specifies that this attribute is not editable in that state
  53. *
  54. * @package iTopORM
  55. */
  56. define('OPT_ATT_READONLY', 2);
  57. /**
  58. * Specifieds that the attribute must be set (different than default value?) when arriving into that state
  59. *
  60. * @package iTopORM
  61. */
  62. define('OPT_ATT_MANDATORY', 4);
  63. /**
  64. * Specifies that the attribute must change when arriving into that state
  65. *
  66. * @package iTopORM
  67. */
  68. define('OPT_ATT_MUSTCHANGE', 8);
  69. /**
  70. * Specifies that the attribute must be proposed when arriving into that state
  71. *
  72. * @package iTopORM
  73. */
  74. define('OPT_ATT_MUSTPROMPT', 16);
  75. /**
  76. * (API) The objects definitions as well as their mapping to the database
  77. *
  78. * @package iTopORM
  79. */
  80. abstract class MetaModel
  81. {
  82. ///////////////////////////////////////////////////////////////////////////
  83. //
  84. // STATIC Members
  85. //
  86. ///////////////////////////////////////////////////////////////////////////
  87. // Purpose: workaround the following limitation = PHP5 does not allow to know the class (derived from the current one)
  88. // from which a static function is called (__CLASS__ and self are interpreted during parsing)
  89. private static function GetCallersPHPClass($sExpectedFunctionName = null)
  90. {
  91. //var_dump(debug_backtrace());
  92. $aBacktrace = debug_backtrace();
  93. // $aBacktrace[0] is where we are
  94. // $aBacktrace[1] is the caller of GetCallersPHPClass
  95. // $aBacktrace[1] is the info we want
  96. if (!empty($sExpectedFunctionName))
  97. {
  98. assert('$aBacktrace[2]["function"] == $sExpectedFunctionName');
  99. }
  100. return $aBacktrace[2]["class"];
  101. }
  102. // Static init -why and how it works
  103. //
  104. // We found the following limitations:
  105. //- it is not possible to define non scalar constants
  106. //- it is not possible to declare a static variable as '= new myclass()'
  107. // Then we had do propose this model, in which a derived (non abstract)
  108. // class should implement Init(), to call InheritAttributes or AddAttribute.
  109. private static function _check_subclass($sClass)
  110. {
  111. // See also IsValidClass()... ???? #@#
  112. // class is mandatory
  113. // (it is not possible to guess it when called as myderived::...)
  114. if (!array_key_exists($sClass, self::$m_aClassParams))
  115. {
  116. throw new CoreException("Unknown class '$sClass', expected a value in {".implode(', ', array_keys(self::$m_aClassParams))."}");
  117. }
  118. }
  119. public static function static_var_dump()
  120. {
  121. var_dump(get_class_vars(__CLASS__));
  122. }
  123. private static $m_bDebugQuery = false;
  124. private static $m_iStackDepthRef = 0;
  125. public static function StartDebugQuery()
  126. {
  127. $aBacktrace = debug_backtrace();
  128. self::$m_iStackDepthRef = count($aBacktrace);
  129. self::$m_bDebugQuery = true;
  130. }
  131. public static function StopDebugQuery()
  132. {
  133. self::$m_bDebugQuery = false;
  134. }
  135. public static function DbgTrace($value)
  136. {
  137. if (!self::$m_bDebugQuery) return;
  138. $aBacktrace = debug_backtrace();
  139. $iCallStackPos = count($aBacktrace) - self::$m_bDebugQuery;
  140. $sIndent = "";
  141. for ($i = 0 ; $i < $iCallStackPos ; $i++)
  142. {
  143. $sIndent .= " .-=^=-. ";
  144. }
  145. $aCallers = array();
  146. foreach($aBacktrace as $aStackInfo)
  147. {
  148. $aCallers[] = $aStackInfo["function"];
  149. }
  150. $sCallers = "Callstack: ".implode(', ', $aCallers);
  151. $sFunction = "<b title=\"$sCallers\">".$aBacktrace[1]["function"]."</b>";
  152. if (is_string($value))
  153. {
  154. echo "$sIndent$sFunction: $value<br/>\n";
  155. }
  156. else if (is_object($value))
  157. {
  158. echo "$sIndent$sFunction:\n<pre>\n";
  159. print_r($value);
  160. echo "</pre>\n";
  161. }
  162. else
  163. {
  164. echo "$sIndent$sFunction: $value<br/>\n";
  165. }
  166. }
  167. private static $m_bTraceQueries = true;
  168. private static $m_aQueriesLog = array();
  169. private static $m_bLogIssue = false;
  170. private static $m_bLogNotification = false;
  171. private static $m_bLogWebService = false;
  172. public static function IsLogEnabledIssue()
  173. {
  174. return self::$m_bLogIssue;
  175. }
  176. public static function IsLogEnabledNotification()
  177. {
  178. return self::$m_bLogNotification;
  179. }
  180. public static function IsLogEnabledWebService()
  181. {
  182. return self::$m_bLogWebService;
  183. }
  184. private static $m_sDBName = "";
  185. private static $m_sTablePrefix = ""; // table prefix for the current application instance (allow several applications on the same DB)
  186. private static $m_Category2Class = array();
  187. private static $m_aRootClasses = array(); // array of "classname" => "rootclass"
  188. private static $m_aParentClasses = array(); // array of ("classname" => array of "parentclass")
  189. private static $m_aChildClasses = array(); // array of ("classname" => array of "childclass")
  190. private static $m_aClassParams = array(); // array of ("classname" => array of class information)
  191. static public function GetParentPersistentClass($sRefClass)
  192. {
  193. $sClass = get_parent_class($sRefClass);
  194. if (!$sClass) return '';
  195. if ($sClass == 'DBObject') return ''; // Warning: __CLASS__ is lower case in my version of PHP
  196. // Note: the UI/business model may implement pure PHP classes (intermediate layers)
  197. if (array_key_exists($sClass, self::$m_aClassParams))
  198. {
  199. return $sClass;
  200. }
  201. return self::GetParentPersistentClass($sClass);
  202. }
  203. static public function IsReadOnlyClass($sClass)
  204. {
  205. $bReadOnly = call_user_func(array($sClass, 'IsReadOnly'));
  206. return $bReadOnly;
  207. }
  208. final static public function GetName($sClass)
  209. {
  210. self::_check_subclass($sClass);
  211. $sStringCode = 'Class:'.$sClass;
  212. return Dict::S($sStringCode, $sClass);
  213. }
  214. final static public function GetName_Obsolete($sClass)
  215. {
  216. // Written for compatibility with a data model written prior to version 0.9.1
  217. self::_check_subclass($sClass);
  218. if (array_key_exists('name', self::$m_aClassParams[$sClass]))
  219. {
  220. return self::$m_aClassParams[$sClass]['name'];
  221. }
  222. else
  223. {
  224. return self::GetName($sClass);
  225. }
  226. }
  227. final static public function GetCategory($sClass)
  228. {
  229. self::_check_subclass($sClass);
  230. return self::$m_aClassParams[$sClass]["category"];
  231. }
  232. final static public function HasCategory($sClass, $sCategory)
  233. {
  234. self::_check_subclass($sClass);
  235. return (strpos(self::$m_aClassParams[$sClass]["category"], $sCategory) !== false);
  236. }
  237. final static public function GetClassDescription($sClass)
  238. {
  239. self::_check_subclass($sClass);
  240. $sStringCode = 'Class:'.$sClass.'+';
  241. return Dict::S($sStringCode, '');
  242. }
  243. final static public function GetClassDescription_Obsolete($sClass)
  244. {
  245. // Written for compatibility with a data model written prior to version 0.9.1
  246. self::_check_subclass($sClass);
  247. if (array_key_exists('description', self::$m_aClassParams[$sClass]))
  248. {
  249. return self::$m_aClassParams[$sClass]['description'];
  250. }
  251. else
  252. {
  253. return self::GetClassDescription($sClass);
  254. }
  255. }
  256. final static public function GetClassIcon($sClass)
  257. {
  258. self::_check_subclass($sClass);
  259. $sIcon = '';
  260. if (array_key_exists('icon', self::$m_aClassParams[$sClass]))
  261. {
  262. $sIcon = self::$m_aClassParams[$sClass]['icon'];
  263. }
  264. if (strlen($sIcon) == 0)
  265. {
  266. $sParentClass = self::GetParentPersistentClass($sClass);
  267. if (strlen($sParentClass) > 0)
  268. {
  269. return self::GetClassIcon($sParentClass);
  270. }
  271. }
  272. return $sIcon;
  273. }
  274. final static public function IsAutoIncrementKey($sClass)
  275. {
  276. self::_check_subclass($sClass);
  277. return (self::$m_aClassParams[$sClass]["key_type"] == "autoincrement");
  278. }
  279. final static public function GetNameAttributeCode($sClass)
  280. {
  281. self::_check_subclass($sClass);
  282. return self::$m_aClassParams[$sClass]["name_attcode"];
  283. }
  284. final static public function GetStateAttributeCode($sClass)
  285. {
  286. self::_check_subclass($sClass);
  287. return self::$m_aClassParams[$sClass]["state_attcode"];
  288. }
  289. final static public function GetDefaultState($sClass)
  290. {
  291. $sDefaultState = '';
  292. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  293. if (!empty($sStateAttrCode))
  294. {
  295. $oStateAttrDef = self::GetAttributeDef($sClass, $sStateAttrCode);
  296. $sDefaultState = $oStateAttrDef->GetDefaultValue();
  297. }
  298. return $sDefaultState;
  299. }
  300. final static public function GetReconcKeys($sClass)
  301. {
  302. self::_check_subclass($sClass);
  303. return self::$m_aClassParams[$sClass]["reconc_keys"];
  304. }
  305. final static public function GetDisplayTemplate($sClass)
  306. {
  307. self::_check_subclass($sClass);
  308. return array_key_exists("display_template", self::$m_aClassParams[$sClass]) ? self::$m_aClassParams[$sClass]["display_template"]: '';
  309. }
  310. final static public function GetAttributeOrigin($sClass, $sAttCode)
  311. {
  312. self::_check_subclass($sClass);
  313. return self::$m_aAttribOrigins[$sClass][$sAttCode];
  314. }
  315. final static public function GetPrequisiteAttributes($sClass, $sAttCode)
  316. {
  317. self::_check_subclass($sClass);
  318. $oAtt = self::GetAttributeDef($sClass, $sAttCode);
  319. // Temporary implementation: later, we might be able to compute
  320. // the dependencies, based on the attributes definition
  321. // (allowed values and default values)
  322. if ($oAtt->IsWritable())
  323. {
  324. return $oAtt->GetPrerequisiteAttributes();
  325. }
  326. else
  327. {
  328. return array();
  329. }
  330. }
  331. /**
  332. * Find all attributes that depend on the specified one (reverse of GetPrequisiteAttributes)
  333. * @param string $sClass Name of the class
  334. * @param string $sAttCode Code of the attributes
  335. * @return Array List of attribute codes that depend on the given attribute, empty array if none.
  336. */
  337. final static public function GetDependentAttributes($sClass, $sAttCode)
  338. {
  339. $aResults = array();
  340. self::_check_subclass($sClass);
  341. foreach (self::ListAttributeDefs($sClass) as $sDependentAttCode=>$void)
  342. {
  343. $aPrerequisites = self::GetPrequisiteAttributes($sClass, $sDependentAttCode);
  344. if (in_array($sAttCode, $aPrerequisites))
  345. {
  346. $aResults[] = $sDependentAttCode;
  347. }
  348. }
  349. return $aResults;
  350. }
  351. // #@# restore to private ?
  352. final static public function DBGetTable($sClass, $sAttCode = null)
  353. {
  354. self::_check_subclass($sClass);
  355. if (empty($sAttCode) || ($sAttCode == "id"))
  356. {
  357. $sTableRaw = self::$m_aClassParams[$sClass]["db_table"];
  358. if (empty($sTableRaw))
  359. {
  360. // return an empty string whenever the table is undefined, meaning that there is no table associated to this 'abstract' class
  361. return '';
  362. }
  363. else
  364. {
  365. return self::$m_sTablePrefix.$sTableRaw;
  366. }
  367. }
  368. // This attribute has been inherited (compound objects)
  369. return self::DBGetTable(self::$m_aAttribOrigins[$sClass][$sAttCode]);
  370. }
  371. final static protected function DBEnumTables()
  372. {
  373. // This API do not rely on our capability to query the DB and retrieve
  374. // the list of existing tables
  375. // Rather, it uses the list of expected tables, corresponding to the data model
  376. $aTables = array();
  377. foreach (self::GetClasses() as $sClass)
  378. {
  379. if (!self::HasTable($sClass)) continue;
  380. $sTable = self::DBGetTable($sClass);
  381. // Could be completed later with all the classes that are using a given table
  382. if (!array_key_exists($sTable, $aTables))
  383. {
  384. $aTables[$sTable] = array();
  385. }
  386. $aTables[$sTable][] = $sClass;
  387. }
  388. return $aTables;
  389. }
  390. final static public function DBGetKey($sClass)
  391. {
  392. self::_check_subclass($sClass);
  393. return self::$m_aClassParams[$sClass]["db_key_field"];
  394. }
  395. final static public function DBGetClassField($sClass)
  396. {
  397. self::_check_subclass($sClass);
  398. return self::$m_aClassParams[$sClass]["db_finalclass_field"];
  399. }
  400. final static public function IsStandaloneClass($sClass)
  401. {
  402. self::_check_subclass($sClass);
  403. if (count(self::$m_aChildClasses[$sClass]) == 0)
  404. {
  405. if (count(self::$m_aParentClasses[$sClass]) == 0)
  406. {
  407. return true;
  408. }
  409. }
  410. return false;
  411. }
  412. final static public function IsParentClass($sParentClass, $sChildClass)
  413. {
  414. self::_check_subclass($sChildClass);
  415. self::_check_subclass($sParentClass);
  416. if (in_array($sParentClass, self::$m_aParentClasses[$sChildClass])) return true;
  417. if ($sChildClass == $sParentClass) return true;
  418. return false;
  419. }
  420. final static public function IsSameFamilyBranch($sClassA, $sClassB)
  421. {
  422. self::_check_subclass($sClassA);
  423. self::_check_subclass($sClassB);
  424. if (in_array($sClassA, self::$m_aParentClasses[$sClassB])) return true;
  425. if (in_array($sClassB, self::$m_aParentClasses[$sClassA])) return true;
  426. if ($sClassA == $sClassB) return true;
  427. return false;
  428. }
  429. final static public function IsSameFamily($sClassA, $sClassB)
  430. {
  431. self::_check_subclass($sClassA);
  432. self::_check_subclass($sClassB);
  433. return (self::GetRootClass($sClassA) == self::GetRootClass($sClassB));
  434. }
  435. // Attributes of a given class may contain attributes defined in a parent class
  436. // - Some attributes are a copy of the definition
  437. // - Some attributes correspond to the upper class table definition (compound objects)
  438. // (see also filters definition)
  439. private static $m_aAttribDefs = array(); // array of ("classname" => array of attributes)
  440. private static $m_aAttribOrigins = array(); // array of ("classname" => array of ("attcode"=>"sourceclass"))
  441. private static $m_aExtKeyFriends = array(); // array of ("classname" => array of ("indirect ext key attcode"=> array of ("relative ext field")))
  442. final static public function ListAttributeDefs($sClass)
  443. {
  444. self::_check_subclass($sClass);
  445. return self::$m_aAttribDefs[$sClass];
  446. }
  447. final public static function GetAttributesList($sClass)
  448. {
  449. self::_check_subclass($sClass);
  450. return array_keys(self::$m_aAttribDefs[$sClass]);
  451. }
  452. final public static function GetFiltersList($sClass)
  453. {
  454. self::_check_subclass($sClass);
  455. return array_keys(self::$m_aFilterDefs[$sClass]);
  456. }
  457. final public static function GetKeysList($sClass)
  458. {
  459. self::_check_subclass($sClass);
  460. $aExtKeys = array();
  461. foreach(self::$m_aAttribDefs[$sClass] as $sAttCode => $oAttDef)
  462. {
  463. if ($oAttDef->IsExternalKey())
  464. {
  465. $aExtKeys[] = $sAttCode;
  466. }
  467. }
  468. return $aExtKeys;
  469. }
  470. final static public function IsValidKeyAttCode($sClass, $sAttCode)
  471. {
  472. if (!array_key_exists($sClass, self::$m_aAttribDefs)) return false;
  473. if (!array_key_exists($sAttCode, self::$m_aAttribDefs[$sClass])) return false;
  474. return (self::$m_aAttribDefs[$sClass][$sAttCode]->IsExternalKey());
  475. }
  476. final static public function IsValidAttCode($sClass, $sAttCode)
  477. {
  478. if (!array_key_exists($sClass, self::$m_aAttribDefs)) return false;
  479. return (array_key_exists($sAttCode, self::$m_aAttribDefs[$sClass]));
  480. }
  481. final static public function IsAttributeOrigin($sClass, $sAttCode)
  482. {
  483. return (self::$m_aAttribOrigins[$sClass][$sAttCode] == $sClass);
  484. }
  485. final static public function IsValidFilterCode($sClass, $sFilterCode)
  486. {
  487. if (!array_key_exists($sClass, self::$m_aFilterDefs)) return false;
  488. return (array_key_exists($sFilterCode, self::$m_aFilterDefs[$sClass]));
  489. }
  490. public static function IsValidClass($sClass)
  491. {
  492. return (array_key_exists($sClass, self::$m_aAttribDefs));
  493. }
  494. public static function IsValidObject($oObject)
  495. {
  496. if (!is_object($oObject)) return false;
  497. return (self::IsValidClass(get_class($oObject)));
  498. }
  499. public static function IsReconcKey($sClass, $sAttCode)
  500. {
  501. return (in_array($sAttCode, self::GetReconcKeys($sClass)));
  502. }
  503. final static public function GetAttributeDef($sClass, $sAttCode)
  504. {
  505. self::_check_subclass($sClass);
  506. return self::$m_aAttribDefs[$sClass][$sAttCode];
  507. }
  508. final static public function GetExternalKeys($sClass)
  509. {
  510. $aExtKeys = array();
  511. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  512. {
  513. if ($oAtt->IsExternalKey())
  514. {
  515. $aExtKeys[$sAttCode] = $oAtt;
  516. }
  517. }
  518. return $aExtKeys;
  519. }
  520. final static public function GetLinkedSets($sClass)
  521. {
  522. $aLinkedSets = array();
  523. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  524. {
  525. if (is_subclass_of($oAtt, 'AttributeLinkedSet'))
  526. {
  527. $aLinkedSets[$sAttCode] = $oAtt;
  528. }
  529. }
  530. return $aLinkedSets;
  531. }
  532. final static public function GetExternalFields($sClass, $sKeyAttCode)
  533. {
  534. $aExtFields = array();
  535. foreach (self::ListAttributeDefs($sClass) as $sAttCode => $oAtt)
  536. {
  537. if ($oAtt->IsExternalField() && ($oAtt->GetKeyAttCode() == $sKeyAttCode))
  538. {
  539. $aExtFields[] = $oAtt;
  540. }
  541. }
  542. return $aExtFields;
  543. }
  544. final static public function GetExtKeyFriends($sClass, $sExtKeyAttCode)
  545. {
  546. if (array_key_exists($sExtKeyAttCode, self::$m_aExtKeyFriends[$sClass]))
  547. {
  548. return self::$m_aExtKeyFriends[$sClass][$sExtKeyAttCode];
  549. }
  550. else
  551. {
  552. return array();
  553. }
  554. }
  555. public static function GetLabel($sClass, $sAttCode)
  556. {
  557. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  558. if ($oAttDef) return $oAttDef->GetLabel();
  559. return "";
  560. }
  561. public static function GetDescription($sClass, $sAttCode)
  562. {
  563. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  564. if ($oAttDef) return $oAttDef->GetDescription();
  565. return "";
  566. }
  567. // Filters of a given class may contain filters defined in a parent class
  568. // - Some filters are a copy of the definition
  569. // - Some filters correspond to the upper class table definition (compound objects)
  570. // (see also attributes definition)
  571. private static $m_aFilterDefs = array(); // array of ("classname" => array filterdef)
  572. private static $m_aFilterOrigins = array(); // array of ("classname" => array of ("attcode"=>"sourceclass"))
  573. public static function GetClassFilterDefs($sClass)
  574. {
  575. self::_check_subclass($sClass);
  576. return self::$m_aFilterDefs[$sClass];
  577. }
  578. final static public function GetClassFilterDef($sClass, $sFilterCode)
  579. {
  580. self::_check_subclass($sClass);
  581. return self::$m_aFilterDefs[$sClass][$sFilterCode];
  582. }
  583. public static function GetFilterLabel($sClass, $sFilterCode)
  584. {
  585. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  586. if ($oFilter) return $oFilter->GetLabel();
  587. return "";
  588. }
  589. public static function GetFilterDescription($sClass, $sFilterCode)
  590. {
  591. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  592. if ($oFilter) return $oFilter->GetDescription();
  593. return "";
  594. }
  595. // returns an array of opcode=>oplabel (e.g. "differs from")
  596. public static function GetFilterOperators($sClass, $sFilterCode)
  597. {
  598. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  599. if ($oFilter) return $oFilter->GetOperators();
  600. return array();
  601. }
  602. // returns an opcode
  603. public static function GetFilterLooseOperator($sClass, $sFilterCode)
  604. {
  605. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  606. if ($oFilter) return $oFilter->GetLooseOperator();
  607. return array();
  608. }
  609. public static function GetFilterOpDescription($sClass, $sFilterCode, $sOpCode)
  610. {
  611. $oFilter = self::GetClassFilterDef($sClass, $sFilterCode);
  612. if ($oFilter) return $oFilter->GetOpDescription($sOpCode);
  613. return "";
  614. }
  615. public static function GetFilterHTMLInput($sFilterCode)
  616. {
  617. return "<INPUT name=\"$sFilterCode\">";
  618. }
  619. // Lists of attributes/search filters
  620. //
  621. private static $m_aListInfos = array(); // array of ("listcode" => various info on the list, common to every classes)
  622. private static $m_aListData = array(); // array of ("classname" => array of "listcode" => list)
  623. // list may be an array of attcode / fltcode
  624. // list may be an array of "groupname" => (array of attcode / fltcode)
  625. public static function EnumZLists()
  626. {
  627. return array_keys(self::$m_aListInfos);
  628. }
  629. final static public function GetZListInfo($sListCode)
  630. {
  631. return self::$m_aListInfos[$sListCode];
  632. }
  633. public static function GetZListItems($sClass, $sListCode)
  634. {
  635. if (array_key_exists($sClass, self::$m_aListData))
  636. {
  637. if (array_key_exists($sListCode, self::$m_aListData[$sClass]))
  638. {
  639. return self::$m_aListData[$sClass][$sListCode];
  640. }
  641. }
  642. $sParentClass = self::GetParentPersistentClass($sClass);
  643. if (empty($sParentClass)) return array(); // nothing for the mother of all classes
  644. // Dig recursively
  645. return self::GetZListItems($sParentClass, $sListCode);
  646. }
  647. public static function IsAttributeInZList($sClass, $sListCode, $sAttCodeOrFltCode, $sGroup = null)
  648. {
  649. $aZList = self::GetZListItems($sClass, $sListCode);
  650. if (!$sGroup)
  651. {
  652. return (in_array($sAttCodeOrFltCode, $aZList));
  653. }
  654. return (in_array($sAttCodeOrFltCode, $aZList[$sGroup]));
  655. }
  656. //
  657. // Relations
  658. //
  659. private static $m_aRelationInfos = array(); // array of ("relcode" => various info on the list, common to every classes)
  660. public static function EnumRelations($sClass = '')
  661. {
  662. if (empty($sClass))
  663. {
  664. return array_keys(self::$m_aRelationInfos);
  665. }
  666. return array_keys(self::EnumRelationQueries($sClass, $sRelCode));
  667. }
  668. public static function EnumRelationProperties($sRelCode)
  669. {
  670. MyHelpers::CheckKeyInArray('relation code', $sRelCode, self::$m_aRelationInfos);
  671. return self::$m_aRelationInfos[$sRelCode];
  672. }
  673. final static public function GetRelationDescription($sRelCode)
  674. {
  675. return Dict::S("Relation:$sRelCode/Description");
  676. }
  677. final static public function GetRelationVerbUp($sRelCode)
  678. {
  679. return Dict::S("Relation:$sRelCode/VerbUp");
  680. }
  681. final static public function GetRelationVerbDown($sRelCode)
  682. {
  683. return Dict::S("Relation:$sRelCode/VerbDown");
  684. }
  685. public static function EnumRelationQueries($sClass, $sRelCode)
  686. {
  687. MyHelpers::CheckKeyInArray('relation code', $sRelCode, self::$m_aRelationInfos);
  688. return call_user_func_array(array($sClass, 'GetRelationQueries'), array($sRelCode));
  689. }
  690. //
  691. // Object lifecycle model
  692. //
  693. private static $m_aStates = array(); // array of ("classname" => array of "statecode"=>array('label'=>..., 'description'=>..., attribute_inherit=> attribute_list=>...))
  694. private static $m_aStimuli = array(); // array of ("classname" => array of ("stimuluscode"=>array('label'=>..., 'description'=>...)))
  695. 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)))
  696. public static function EnumStates($sClass)
  697. {
  698. if (array_key_exists($sClass, self::$m_aStates))
  699. {
  700. return self::$m_aStates[$sClass];
  701. }
  702. else
  703. {
  704. return array();
  705. }
  706. }
  707. public static function EnumStimuli($sClass)
  708. {
  709. if (array_key_exists($sClass, self::$m_aStimuli))
  710. {
  711. return self::$m_aStimuli[$sClass];
  712. }
  713. else
  714. {
  715. return array();
  716. }
  717. }
  718. public static function GetStateLabel($sClass, $sStateValue)
  719. {
  720. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  721. return Dict::S("Class:$sClass/Attribute:$sStateAttrCode/Value:$sStateValue", $sStateValue);
  722. // I've decided the current implementation, because I need
  723. // to get the description as well -GetAllowedValues does not render the description,
  724. // so far...
  725. // Could have been implemented the following way (not tested
  726. // $oStateAttrDef = self::GetAttributeDef($sClass, $sStateAttrCode);
  727. // $aAllowedValues = $oStateAttrDef->GetAllowedValues();
  728. // return $aAllowedValues[$sStateValue];
  729. }
  730. public static function GetStateDescription($sClass, $sStateValue)
  731. {
  732. $sStateAttrCode = self::GetStateAttributeCode($sClass);
  733. return Dict::S("Class:$sClass/Attribute:$sStateAttrCode/Value:$sStateValue+", '');
  734. }
  735. public static function EnumTransitions($sClass, $sStateCode)
  736. {
  737. if (array_key_exists($sClass, self::$m_aTransitions))
  738. {
  739. if (array_key_exists($sStateCode, self::$m_aTransitions[$sClass]))
  740. {
  741. return self::$m_aTransitions[$sClass][$sStateCode];
  742. }
  743. }
  744. return array();
  745. }
  746. public static function GetAttributeFlags($sClass, $sState, $sAttCode)
  747. {
  748. $iFlags = 0; // By default (if no life cycle) no flag at all
  749. $sStateAttCode = self::GetStateAttributeCode($sClass);
  750. if (!empty($sStateAttCode))
  751. {
  752. $aStates = MetaModel::EnumStates($sClass);
  753. if (!array_key_exists($sState, $aStates))
  754. {
  755. throw new CoreException("Invalid state '$sState' for class '$sClass', expecting a value in {".implode(', ', array_keys($aStates))."}");
  756. }
  757. $aCurrentState = $aStates[$sState];
  758. if ( (array_key_exists('attribute_list', $aCurrentState)) && (array_key_exists($sAttCode, $aCurrentState['attribute_list'])) )
  759. {
  760. $iFlags = $aCurrentState['attribute_list'][$sAttCode];
  761. }
  762. }
  763. return $iFlags;
  764. }
  765. //
  766. // Allowed values
  767. //
  768. public static function GetAllowedValues_att($sClass, $sAttCode, $aArgs = array(), $sBeginsWith = '')
  769. {
  770. $oAttDef = self::GetAttributeDef($sClass, $sAttCode);
  771. return $oAttDef->GetAllowedValues($aArgs, $sBeginsWith);
  772. }
  773. public static function GetAllowedValues_flt($sClass, $sFltCode, $aArgs = array(), $sBeginsWith = '')
  774. {
  775. $oFltDef = self::GetClassFilterDef($sClass, $sFltCode);
  776. return $oFltDef->GetAllowedValues($aArgs, $sBeginsWith);
  777. }
  778. //
  779. // Businezz model declaration verbs (should be static)
  780. //
  781. public static function RegisterZList($sListCode, $aListInfo)
  782. {
  783. // Check mandatory params
  784. $aMandatParams = array(
  785. "description" => "detailed (though one line) description of the list",
  786. "type" => "attributes | filters",
  787. );
  788. foreach($aMandatParams as $sParamName=>$sParamDesc)
  789. {
  790. if (!array_key_exists($sParamName, $aListInfo))
  791. {
  792. throw new CoreException("Declaration of list $sListCode - missing parameter $sParamName");
  793. }
  794. }
  795. self::$m_aListInfos[$sListCode] = $aListInfo;
  796. }
  797. public static function RegisterRelation($sRelCode)
  798. {
  799. // Each item used to be an array of properties...
  800. self::$m_aRelationInfos[$sRelCode] = $sRelCode;
  801. }
  802. // Must be called once and only once...
  803. public static function InitClasses($sTablePrefix)
  804. {
  805. if (count(self::GetClasses()) > 0)
  806. {
  807. throw new CoreException("InitClasses should not be called more than once -skipped");
  808. return;
  809. }
  810. self::$m_sTablePrefix = $sTablePrefix;
  811. foreach(get_declared_classes() as $sPHPClass) {
  812. if (is_subclass_of($sPHPClass, 'DBObject'))
  813. {
  814. if (method_exists($sPHPClass, 'Init'))
  815. {
  816. call_user_func(array($sPHPClass, 'Init'));
  817. }
  818. }
  819. }
  820. foreach (self::GetClasses() as $sClass)
  821. {
  822. self::$m_aExtKeyFriends[$sClass] = array();
  823. foreach (self::$m_aAttribDefs[$sClass] as $sAttCode => $oAttDef)
  824. {
  825. // Compute the filter codes
  826. //
  827. foreach ($oAttDef->GetFilterDefinitions() as $sFilterCode => $oFilterDef)
  828. {
  829. self::$m_aFilterDefs[$sClass][$sFilterCode] = $oFilterDef;
  830. }
  831. if ($oAttDef->IsExternalField())
  832. {
  833. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  834. $oKeyDef = self::GetAttributeDef($sClass, $sKeyAttCode);
  835. self::$m_aFilterOrigins[$sClass][$sFilterCode] = $oKeyDef->GetTargetClass();
  836. }
  837. else
  838. {
  839. self::$m_aFilterOrigins[$sClass][$sFilterCode] = self::$m_aAttribOrigins[$sClass][$sAttCode];
  840. }
  841. // Compute the fields that will be used to display a pointer to another object
  842. //
  843. if ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  844. {
  845. // oAttDef is either
  846. // - an external KEY / FIELD (direct),
  847. // - an external field pointing to an external KEY / FIELD
  848. // - an external field pointing to an external field pointing to....
  849. // Get the real external key attribute
  850. // It will be our reference to determine the other ext fields related to the same ext key
  851. $oFinalKeyAttDef = $oAttDef->GetKeyAttDef(EXTKEY_ABSOLUTE);
  852. self::$m_aExtKeyFriends[$sClass][$sAttCode] = array();
  853. foreach (self::GetExternalFields($sClass, $oAttDef->GetKeyAttCode($sAttCode)) as $oExtField)
  854. {
  855. // skip : those extfields will be processed as external keys
  856. if ($oExtField->IsExternalKey(EXTKEY_ABSOLUTE)) continue;
  857. // Note: I could not compare the objects by the mean of '==='
  858. // because they are copied for the inheritance, and the internal references are NOT updated
  859. if ($oExtField->GetKeyAttDef(EXTKEY_ABSOLUTE) == $oFinalKeyAttDef)
  860. {
  861. self::$m_aExtKeyFriends[$sClass][$sAttCode][$oExtField->GetCode()] = $oExtField;
  862. }
  863. }
  864. }
  865. }
  866. // Add a 'id' filter
  867. //
  868. if (array_key_exists('id', self::$m_aAttribDefs[$sClass]))
  869. {
  870. throw new CoreException("Class $sClass, 'id' is a reserved keyword, it cannot be used as an attribute code");
  871. }
  872. if (array_key_exists('id', self::$m_aFilterDefs[$sClass]))
  873. {
  874. throw new CoreException("Class $sClass, 'id' is a reserved keyword, it cannot be used as a filter code");
  875. }
  876. $oFilter = new FilterPrivateKey('id', array('id_field' => self::DBGetKey($sClass)));
  877. self::$m_aFilterDefs[$sClass]['id'] = $oFilter;
  878. self::$m_aFilterOrigins[$sClass]['id'] = $sClass;
  879. // Define defaults values for the standard ZLists
  880. //
  881. //foreach (self::$m_aListInfos as $sListCode => $aListConfig)
  882. //{
  883. // if (!isset(self::$m_aListData[$sClass][$sListCode]))
  884. // {
  885. // $aAllAttributes = array_keys(self::$m_aAttribDefs[$sClass]);
  886. // self::$m_aListData[$sClass][$sListCode] = $aAllAttributes;
  887. // //echo "<p>$sClass: $sListCode (".count($aAllAttributes)." attributes)</p>\n";
  888. // }
  889. //}
  890. }
  891. // Add a 'class' attribute/filter to the root classes and their children
  892. //
  893. foreach(self::EnumRootClasses() as $sRootClass)
  894. {
  895. if (self::IsStandaloneClass($sRootClass)) continue;
  896. $sDbFinalClassField = self::DBGetClassField($sRootClass);
  897. if (strlen($sDbFinalClassField) == 0)
  898. {
  899. $sDbFinalClassField = 'finalclass';
  900. self::$m_aClassParams[$sClass]["db_finalclass_field"] = 'finalclass';
  901. }
  902. $oClassAtt = new AttributeFinalClass('finalclass', array(
  903. "sql"=>$sDbFinalClassField,
  904. "default_value"=>$sRootClass,
  905. "is_null_allowed"=>false,
  906. "depends_on"=>array()
  907. ));
  908. $oClassAtt->SetHostClass($sRootClass);
  909. self::$m_aAttribDefs[$sRootClass]['finalclass'] = $oClassAtt;
  910. self::$m_aAttribOrigins[$sRootClass]['finalclass'] = $sRootClass;
  911. $oClassFlt = new FilterFromAttribute($oClassAtt);
  912. self::$m_aFilterDefs[$sRootClass]['finalclass'] = $oClassFlt;
  913. self::$m_aFilterOrigins[$sRootClass]['finalclass'] = $sRootClass;
  914. foreach(self::EnumChildClasses($sRootClass, ENUM_CHILD_CLASSES_EXCLUDETOP) as $sChildClass)
  915. {
  916. if (array_key_exists('finalclass', self::$m_aAttribDefs[$sChildClass]))
  917. {
  918. throw new CoreException("Class $sChildClass, 'finalclass' is a reserved keyword, it cannot be used as an attribute code");
  919. }
  920. if (array_key_exists('finalclass', self::$m_aFilterDefs[$sChildClass]))
  921. {
  922. throw new CoreException("Class $sChildClass, 'finalclass' is a reserved keyword, it cannot be used as a filter code");
  923. }
  924. $oCloned = clone $oClassAtt;
  925. $oCloned->SetFixedValue($sChildClass);
  926. self::$m_aAttribDefs[$sChildClass]['finalclass'] = $oCloned;
  927. self::$m_aAttribOrigins[$sChildClass]['finalclass'] = $sRootClass;
  928. $oClassFlt = new FilterFromAttribute($oClassAtt);
  929. self::$m_aFilterDefs[$sChildClass]['finalclass'] = $oClassFlt;
  930. self::$m_aFilterOrigins[$sChildClass]['finalclass'] = self::GetRootClass($sChildClass);
  931. }
  932. }
  933. }
  934. // To be overriden, must be called for any object class (optimization)
  935. public static function Init()
  936. {
  937. // In fact it is an ABSTRACT function, but this is not compatible with the fact that it is STATIC (error in E_STRICT interpretation)
  938. }
  939. // To be overloaded by biz model declarations
  940. public static function GetRelationQueries($sRelCode)
  941. {
  942. // In fact it is an ABSTRACT function, but this is not compatible with the fact that it is STATIC (error in E_STRICT interpretation)
  943. return array();
  944. }
  945. public static function Init_Params($aParams)
  946. {
  947. // Check mandatory params
  948. $aMandatParams = array(
  949. "category" => "group classes by modules defining their visibility in the UI",
  950. "key_type" => "autoincrement | string",
  951. "name_attcode" => "define wich attribute is the class name, may be an inherited attribute",
  952. "state_attcode" => "define wich attribute is representing the state (object lifecycle)",
  953. "reconc_keys" => "define the attributes that will 'almost uniquely' identify an object in batch processes",
  954. "db_table" => "database table",
  955. "db_key_field" => "database field which is the key",
  956. "db_finalclass_field" => "database field wich is the reference to the actual class of the object, considering that this will be a compound class",
  957. );
  958. $sClass = self::GetCallersPHPClass("Init");
  959. foreach($aMandatParams as $sParamName=>$sParamDesc)
  960. {
  961. if (!array_key_exists($sParamName, $aParams))
  962. {
  963. throw new CoreException("Declaration of class $sClass - missing parameter $sParamName");
  964. }
  965. }
  966. $aCategories = explode(',', $aParams['category']);
  967. foreach ($aCategories as $sCategory)
  968. {
  969. self::$m_Category2Class[$sCategory][] = $sClass;
  970. }
  971. self::$m_Category2Class[''][] = $sClass; // all categories, include this one
  972. self::$m_aRootClasses[$sClass] = $sClass; // first, let consider that I am the root... updated on inheritance
  973. self::$m_aParentClasses[$sClass] = array();
  974. self::$m_aChildClasses[$sClass] = array();
  975. self::$m_aClassParams[$sClass]= $aParams;
  976. self::$m_aAttribDefs[$sClass] = array();
  977. self::$m_aAttribOrigins[$sClass] = array();
  978. self::$m_aExtKeyFriends[$sClass] = array();
  979. self::$m_aFilterDefs[$sClass] = array();
  980. self::$m_aFilterOrigins[$sClass] = array();
  981. }
  982. protected static function object_array_mergeclone($aSource1, $aSource2)
  983. {
  984. $aRes = array();
  985. foreach ($aSource1 as $key=>$object)
  986. {
  987. $aRes[$key] = clone $object;
  988. }
  989. foreach ($aSource2 as $key=>$object)
  990. {
  991. $aRes[$key] = clone $object;
  992. }
  993. return $aRes;
  994. }
  995. public static function Init_InheritAttributes($sSourceClass = null)
  996. {
  997. $sTargetClass = self::GetCallersPHPClass("Init");
  998. if (empty($sSourceClass))
  999. {
  1000. // Default: inherit from parent class
  1001. $sSourceClass = self::GetParentPersistentClass($sTargetClass);
  1002. if (empty($sSourceClass)) return; // no attributes for the mother of all classes
  1003. }
  1004. if (isset(self::$m_aAttribDefs[$sSourceClass]))
  1005. {
  1006. if (!isset(self::$m_aAttribDefs[$sTargetClass]))
  1007. {
  1008. self::$m_aAttribDefs[$sTargetClass] = array();
  1009. self::$m_aAttribOrigins[$sTargetClass] = array();
  1010. }
  1011. self::$m_aAttribDefs[$sTargetClass] = self::object_array_mergeclone(self::$m_aAttribDefs[$sTargetClass], self::$m_aAttribDefs[$sSourceClass]);
  1012. self::$m_aAttribOrigins[$sTargetClass] = array_merge(self::$m_aAttribOrigins[$sTargetClass], self::$m_aAttribOrigins[$sSourceClass]);
  1013. }
  1014. // Build root class information
  1015. if (array_key_exists($sSourceClass, self::$m_aRootClasses))
  1016. {
  1017. // Inherit...
  1018. self::$m_aRootClasses[$sTargetClass] = self::$m_aRootClasses[$sSourceClass];
  1019. }
  1020. else
  1021. {
  1022. // This class will be the root class
  1023. self::$m_aRootClasses[$sSourceClass] = $sSourceClass;
  1024. self::$m_aRootClasses[$sTargetClass] = $sSourceClass;
  1025. }
  1026. self::$m_aParentClasses[$sTargetClass] += self::$m_aParentClasses[$sSourceClass];
  1027. self::$m_aParentClasses[$sTargetClass][] = $sSourceClass;
  1028. // I am the child of each and every parent...
  1029. foreach(self::$m_aParentClasses[$sTargetClass] as $sAncestorClass)
  1030. {
  1031. self::$m_aChildClasses[$sAncestorClass][] = $sTargetClass;
  1032. }
  1033. }
  1034. public static function Init_OverloadAttributeParams($sAttCode, $aParams)
  1035. {
  1036. $sTargetClass = self::GetCallersPHPClass("Init");
  1037. if (!self::IsValidAttCode($sTargetClass, $sAttCode))
  1038. {
  1039. throw new CoreException("Could not overload '$sAttCode', expecting a code from {".implode(", ", self::GetAttributesList($sTargetClass))."}");
  1040. }
  1041. self::$m_aAttribDefs[$sTargetClass][$sAttCode]->OverloadParams($aParams);
  1042. }
  1043. public static function Init_AddAttribute(AttributeDefinition $oAtt)
  1044. {
  1045. $sTargetClass = self::GetCallersPHPClass("Init");
  1046. self::$m_aAttribDefs[$sTargetClass][$oAtt->GetCode()] = $oAtt;
  1047. self::$m_aAttribOrigins[$sTargetClass][$oAtt->GetCode()] = $sTargetClass;
  1048. // Note: it looks redundant to put targetclass there, but a mix occurs when inheritance is used
  1049. // Specific case of external fields:
  1050. // I wanted to simplify the syntax of the declaration of objects in the biz model
  1051. // Therefore, the reference to the host class is set there
  1052. $oAtt->SetHostClass($sTargetClass);
  1053. }
  1054. public static function Init_SetZListItems($sListCode, $aItems)
  1055. {
  1056. MyHelpers::CheckKeyInArray('list code', $sListCode, self::$m_aListInfos);
  1057. $sTargetClass = self::GetCallersPHPClass("Init");
  1058. self::$m_aListData[$sTargetClass][$sListCode] = $aItems;
  1059. }
  1060. public static function Init_DefineState($sStateCode, $aStateDef)
  1061. {
  1062. $sTargetClass = self::GetCallersPHPClass("Init");
  1063. if (is_null($aStateDef['attribute_list'])) $aStateDef['attribute_list'] = array();
  1064. $sParentState = $aStateDef['attribute_inherit'];
  1065. if (!empty($sParentState))
  1066. {
  1067. // Inherit from the given state (must be defined !)
  1068. $aToInherit = self::$m_aStates[$sTargetClass][$sParentState];
  1069. // The inherited configuration could be overriden
  1070. $aStateDef['attribute_list'] = array_merge($aToInherit, $aStateDef['attribute_list']);
  1071. }
  1072. self::$m_aStates[$sTargetClass][$sStateCode] = $aStateDef;
  1073. // by default, create an empty set of transitions associated to that state
  1074. self::$m_aTransitions[$sTargetClass][$sStateCode] = array();
  1075. }
  1076. public static function Init_DefineStimulus($oStimulus)
  1077. {
  1078. $sTargetClass = self::GetCallersPHPClass("Init");
  1079. self::$m_aStimuli[$sTargetClass][$oStimulus->GetCode()] = $oStimulus;
  1080. // I wanted to simplify the syntax of the declaration of objects in the biz model
  1081. // Therefore, the reference to the host class is set there
  1082. $oStimulus->SetHostClass($sTargetClass);
  1083. }
  1084. public static function Init_DefineTransition($sStateCode, $sStimulusCode, $aTransitionDef)
  1085. {
  1086. $sTargetClass = self::GetCallersPHPClass("Init");
  1087. if (is_null($aTransitionDef['actions'])) $aTransitionDef['actions'] = array();
  1088. self::$m_aTransitions[$sTargetClass][$sStateCode][$sStimulusCode] = $aTransitionDef;
  1089. }
  1090. public static function Init_InheritLifecycle($sSourceClass = '')
  1091. {
  1092. $sTargetClass = self::GetCallersPHPClass("Init");
  1093. if (empty($sSourceClass))
  1094. {
  1095. // Default: inherit from parent class
  1096. $sSourceClass = self::GetParentPersistentClass($sTargetClass);
  1097. if (empty($sSourceClass)) return; // no attributes for the mother of all classes
  1098. }
  1099. self::$m_aClassParams[$sTargetClass]["state_attcode"] = self::$m_aClassParams[$sSourceClass]["state_attcode"];
  1100. self::$m_aStates[$sTargetClass] = clone self::$m_aStates[$sSourceClass];
  1101. self::$m_aStimuli[$sTargetClass] = clone self::$m_aStimuli[$sSourceClass];
  1102. self::$m_aTransitions[$sTargetClass] = clone self::$m_aTransitions[$sSourceClass];
  1103. }
  1104. //
  1105. // Static API
  1106. //
  1107. public static function GetRootClass($sClass = null)
  1108. {
  1109. self::_check_subclass($sClass);
  1110. return self::$m_aRootClasses[$sClass];
  1111. }
  1112. public static function IsRootClass($sClass)
  1113. {
  1114. self::_check_subclass($sClass);
  1115. return (self::GetRootClass($sClass) == $sClass);
  1116. }
  1117. public static function EnumRootClasses()
  1118. {
  1119. return array_unique(self::$m_aRootClasses);
  1120. }
  1121. public static function EnumParentClasses($sClass)
  1122. {
  1123. self::_check_subclass($sClass);
  1124. return self::$m_aParentClasses[$sClass];
  1125. }
  1126. public static function EnumChildClasses($sClass, $iOption = ENUM_CHILD_CLASSES_EXCLUDETOP)
  1127. {
  1128. self::_check_subclass($sClass);
  1129. $aRes = self::$m_aChildClasses[$sClass];
  1130. if ($iOption != ENUM_CHILD_CLASSES_EXCLUDETOP)
  1131. {
  1132. // Add it to the list
  1133. $aRes[] = $sClass;
  1134. }
  1135. return $aRes;
  1136. }
  1137. public static function EnumCategories()
  1138. {
  1139. return array_keys(self::$m_Category2Class);
  1140. }
  1141. // Note: use EnumChildClasses to take the compound objects into account
  1142. public static function GetSubclasses($sClass)
  1143. {
  1144. self::_check_subclass($sClass);
  1145. $aSubClasses = array();
  1146. foreach(get_declared_classes() as $sSubClass) {
  1147. if (is_subclass_of($sSubClass, $sClass))
  1148. {
  1149. $aSubClasses[] = $sSubClass;
  1150. }
  1151. }
  1152. return $aSubClasses;
  1153. }
  1154. public static function GetClasses($sCategory = '')
  1155. {
  1156. if (array_key_exists($sCategory, self::$m_Category2Class))
  1157. {
  1158. return self::$m_Category2Class[$sCategory];
  1159. }
  1160. if (count(self::$m_Category2Class) > 0)
  1161. {
  1162. throw new CoreException("unkown class category '$sCategory', expecting a value in {".implode(', ', array_keys(self::$m_Category2Class))."}");
  1163. }
  1164. return array();
  1165. }
  1166. public static function HasTable($sClass)
  1167. {
  1168. if (strlen(self::DBGetTable($sClass)) == 0) return false;
  1169. return true;
  1170. }
  1171. public static function IsAbstract($sClass)
  1172. {
  1173. $oReflection = new ReflectionClass($sClass);
  1174. return $oReflection->isAbstract();
  1175. }
  1176. protected static $m_aQueryStructCache = array();
  1177. protected static function PrepareQueryArguments($aArgs)
  1178. {
  1179. // Translate any object into scalars
  1180. //
  1181. $aScalarArgs = array();
  1182. foreach($aArgs as $sArgName => $value)
  1183. {
  1184. if (self::IsValidObject($value))
  1185. {
  1186. $aScalarArgs = array_merge($aScalarArgs, $value->ToArgs($sArgName));
  1187. }
  1188. else
  1189. {
  1190. $aScalarArgs[$sArgName] = (string) $value;
  1191. }
  1192. }
  1193. // Add standard contextual arguments
  1194. //
  1195. $aScalarArgs['current_contact_id'] = UserRights::GetContactId();
  1196. return $aScalarArgs;
  1197. }
  1198. public static function MakeSelectQuery(DBObjectSearch $oFilter, $aOrderBy = array(), $aArgs = array())
  1199. {
  1200. // Query caching
  1201. //
  1202. $bQueryCacheEnabled = true;
  1203. $aParams = array();
  1204. $sOqlQuery = $oFilter->ToOql($aParams); // Render with arguments in clear
  1205. if ($bQueryCacheEnabled)
  1206. {
  1207. if (array_key_exists($sOqlQuery, self::$m_aQueryStructCache))
  1208. {
  1209. // hit!
  1210. $oSelect = clone self::$m_aQueryStructCache[$sOqlQuery];
  1211. }
  1212. }
  1213. if (!isset($oSelect))
  1214. {
  1215. $aTranslation = array();
  1216. $aClassAliases = array();
  1217. $aTableAliases = array();
  1218. $oConditionTree = $oFilter->GetCriteria();
  1219. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oFilter);
  1220. self::$m_aQueryStructCache[$sOqlQuery] = clone $oSelect;
  1221. }
  1222. // Check the order by specification, and prefix with the class alias
  1223. //
  1224. $aOrderSpec = array();
  1225. foreach ($aOrderBy as $sFieldAlias => $bAscending)
  1226. {
  1227. MyHelpers::CheckValueInArray('field name in ORDER BY spec', $sFieldAlias, self::GetAttributesList($oFilter->GetFirstJoinedClass()));
  1228. if (!is_bool($bAscending))
  1229. {
  1230. throw new CoreException("Wrong direction in ORDER BY spec, found '$bAscending' and expecting a boolean value");
  1231. }
  1232. $aOrderSpec[$oFilter->GetFirstJoinedClassAlias().$sFieldAlias] = $bAscending;
  1233. }
  1234. // By default, force the name attribute to be the ordering key
  1235. //
  1236. if (empty($aOrderSpec))
  1237. {
  1238. foreach ($oFilter->GetSelectedClasses() as $sSelectedAlias => $sSelectedClass)
  1239. {
  1240. $sNameAttCode = self::GetNameAttributeCode($sSelectedClass);
  1241. if (!empty($sNameAttCode))
  1242. {
  1243. // By default, simply order on the "name" attribute, ascending
  1244. $aOrderSpec[$sSelectedAlias.$sNameAttCode] = true;
  1245. }
  1246. }
  1247. }
  1248. // Go
  1249. //
  1250. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1251. try
  1252. {
  1253. $sRes = $oSelect->RenderSelect($aOrderSpec, $aScalarArgs);
  1254. }
  1255. catch (MissingQueryArgument $e)
  1256. {
  1257. // Add some information...
  1258. $e->addInfo('OQL', $sOqlQuery);
  1259. throw $e;
  1260. }
  1261. if (self::$m_bTraceQueries)
  1262. {
  1263. $aParams = array();
  1264. if (!array_key_exists($sOqlQuery, self::$m_aQueriesLog))
  1265. {
  1266. self::$m_aQueriesLog[$sOqlQuery] = array(
  1267. 'sql' => array(),
  1268. 'count' => 0,
  1269. );
  1270. }
  1271. self::$m_aQueriesLog[$sOqlQuery]['count']++;
  1272. self::$m_aQueriesLog[$sOqlQuery]['sql'][] = $sRes;
  1273. }
  1274. return $sRes;
  1275. }
  1276. public static function ShowQueryTrace()
  1277. {
  1278. $iTotal = 0;
  1279. foreach (self::$m_aQueriesLog as $sOql => $aQueryData)
  1280. {
  1281. echo "<h2>$sOql</h2>\n";
  1282. $iTotal += $aQueryData['count'];
  1283. echo '<p>'.$aQueryData['count'].'</p>';
  1284. echo '<p>Example: '.$aQueryData['sql'][0].'</p>';
  1285. }
  1286. echo "<h2>Total</h2>\n";
  1287. echo "<p>Count of executed queries: $iTotal</p>";
  1288. echo "<p>Count of built queries: ".count(self::$m_aQueriesLog)."</p>";
  1289. }
  1290. public static function MakeDeleteQuery(DBObjectSearch $oFilter, $aArgs = array())
  1291. {
  1292. $aTranslation = array();
  1293. $aClassAliases = array();
  1294. $aTableAliases = array();
  1295. $oConditionTree = $oFilter->GetCriteria();
  1296. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oFilter);
  1297. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1298. return $oSelect->RenderDelete($aScalarArgs);
  1299. }
  1300. public static function MakeUpdateQuery(DBObjectSearch $oFilter, $aValues, $aArgs = array())
  1301. {
  1302. // $aValues is an array of $sAttCode => $value
  1303. $aTranslation = array();
  1304. $aClassAliases = array();
  1305. $aTableAliases = array();
  1306. $oConditionTree = $oFilter->GetCriteria();
  1307. $oSelect = self::MakeQuery($oFilter->GetSelectedClasses(), $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oFilter, array(), $aValues);
  1308. $aScalarArgs = array_merge(self::PrepareQueryArguments($aArgs), $oFilter->GetInternalParams());
  1309. return $oSelect->RenderUpdate($aScalarArgs);
  1310. }
  1311. private static function MakeQuery($aSelectedClasses, &$oConditionTree, &$aClassAliases, &$aTableAliases, &$aTranslation, DBObjectSearch $oFilter, $aExpectedAtts = array(), $aValues = array())
  1312. {
  1313. // Note: query class might be different than the class of the filter
  1314. // -> this occurs when we are linking our class to an external class (referenced by, or pointing to)
  1315. // $aExpectedAtts is an array of sAttCode=>array of columns
  1316. $sClass = $oFilter->GetFirstJoinedClass();
  1317. $sClassAlias = $oFilter->GetFirstJoinedClassAlias();
  1318. $bIsOnQueriedClass = array_key_exists($sClassAlias, $aSelectedClasses);
  1319. if ($bIsOnQueriedClass)
  1320. {
  1321. $aClassAliases = array_merge($aClassAliases, $oFilter->GetJoinedClasses());
  1322. }
  1323. self::DbgTrace("Entering: ".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY").", expectedatts=".count($aExpectedAtts).": ".implode(",", array_keys($aExpectedAtts)));
  1324. $sRootClass = self::GetRootClass($sClass);
  1325. $sKeyField = self::DBGetKey($sClass);
  1326. if ($bIsOnQueriedClass)
  1327. {
  1328. // default to the whole list of attributes + the very std id/finalclass
  1329. $aExpectedAtts['id'][] = $sClassAlias.'id';
  1330. foreach (self::GetAttributesList($sClass) as $sAttCode)
  1331. {
  1332. $aExpectedAtts[$sAttCode][] = $sClassAlias.$sAttCode; // alias == class and attcode
  1333. }
  1334. }
  1335. // Compute a clear view of external keys, and external attributes
  1336. // Build the list of external keys:
  1337. // -> ext keys required by a closed join ???
  1338. // -> ext keys mentionned in a 'pointing to' condition
  1339. // -> ext keys required for an external field
  1340. //
  1341. $aExtKeys = array(); // array of sTableClass => array of (sAttCode (keys) => array of (sAttCode (fields)=> oAttDef))
  1342. //
  1343. // Optimization: could be computed once for all (cached)
  1344. // Could be done in MakeQuerySingleTable ???
  1345. //
  1346. if ($bIsOnQueriedClass)
  1347. {
  1348. // Get all Ext keys for the queried class (??)
  1349. foreach(self::GetKeysList($sClass) as $sKeyAttCode)
  1350. {
  1351. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1352. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1353. }
  1354. }
  1355. // Get all Ext keys used by the filter
  1356. foreach ($oFilter->GetCriteria_PointingTo() as $sKeyAttCode => $trash)
  1357. {
  1358. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1359. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1360. }
  1361. // Add the ext fields used in the select (eventually adds an external key)
  1362. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  1363. {
  1364. if ($oAttDef->IsExternalField())
  1365. {
  1366. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1367. if (array_key_exists($sAttCode, $aExpectedAtts) || $oConditionTree->RequiresField($sClassAlias, $sAttCode))
  1368. {
  1369. // Add the external attribute
  1370. $sKeyTableClass = self::$m_aAttribOrigins[$sClass][$sKeyAttCode];
  1371. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  1372. }
  1373. }
  1374. }
  1375. // First query built upon on the leaf (ie current) class
  1376. //
  1377. self::DbgTrace("Main (=leaf) class, call MakeQuerySingleTable()");
  1378. if (self::HasTable($sClass))
  1379. {
  1380. $oSelectBase = self::MakeQuerySingleTable($aSelectedClasses, $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oFilter, $sClass, $aExpectedAtts, $aExtKeys, $aValues);
  1381. }
  1382. else
  1383. {
  1384. $oSelectBase = null;
  1385. // As the join will not filter on the expected classes, we have to specify it explicitely
  1386. $sExpectedClasses = implode("', '", self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  1387. $oFinalClassRestriction = Expression::FromOQL("`$sClassAlias`.finalclass IN ('$sExpectedClasses')");
  1388. $oConditionTree = $oConditionTree->LogAnd($oFinalClassRestriction);
  1389. }
  1390. // Then we join the queries of the eventual parent classes (compound model)
  1391. foreach(self::EnumParentClasses($sClass) as $sParentClass)
  1392. {
  1393. if (self::DBGetTable($sParentClass) == "") continue;
  1394. self::DbgTrace("Parent class: $sParentClass... let's call MakeQuerySingleTable()");
  1395. $oSelectParentTable = self::MakeQuerySingleTable($aSelectedClasses, $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oFilter, $sParentClass, $aExpectedAtts, $aExtKeys, $aValues);
  1396. if (is_null($oSelectBase))
  1397. {
  1398. $oSelectBase = $oSelectParentTable;
  1399. }
  1400. else
  1401. {
  1402. $oSelectBase->AddInnerJoin($oSelectParentTable, $sKeyField, self::DBGetKey($sParentClass));
  1403. }
  1404. }
  1405. // Filter on objects referencing me
  1406. foreach ($oFilter->GetCriteria_ReferencedBy() as $sForeignClass => $aKeysAndFilters)
  1407. {
  1408. foreach ($aKeysAndFilters as $sForeignKeyAttCode => $oForeignFilter)
  1409. {
  1410. $oForeignKeyAttDef = self::GetAttributeDef($sForeignClass, $sForeignKeyAttCode);
  1411. // We don't want any attribute from the foreign class, just filter on an inner join
  1412. $aExpAtts = array();
  1413. self::DbgTrace("Referenced by foreign key: $sForeignKeyAttCode... let's call MakeQuery()");
  1414. //self::DbgTrace($oForeignFilter);
  1415. //self::DbgTrace($oForeignFilter->ToOQL());
  1416. //self::DbgTrace($oSelectForeign);
  1417. //self::DbgTrace($oSelectForeign->RenderSelect(array()));
  1418. $oSelectForeign = self::MakeQuery($aSelectedClasses, $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oForeignFilter, $aExpAtts);
  1419. $sForeignClassAlias = $oForeignFilter->GetFirstJoinedClassAlias();
  1420. $sForeignKeyTable = $aTranslation[$sForeignClassAlias][$sForeignKeyAttCode][0];
  1421. $sForeignKeyColumn = $aTranslation[$sForeignClassAlias][$sForeignKeyAttCode][1];
  1422. $oSelectBase->AddInnerJoin($oSelectForeign, $sKeyField, $sForeignKeyColumn, $sForeignKeyTable);
  1423. }
  1424. }
  1425. // Filter on related objects
  1426. //
  1427. foreach ($oFilter->GetCriteria_RelatedTo() as $aCritInfo)
  1428. {
  1429. $oSubFilter = $aCritInfo['flt'];
  1430. $sRelCode = $aCritInfo['relcode'];
  1431. $iMaxDepth = $aCritInfo['maxdepth'];
  1432. // Get the starting point objects
  1433. $oStartSet = new CMDBObjectSet($oSubFilter);
  1434. // Get the objects related to those objects... recursively...
  1435. $aRelatedObjs = $oStartSet->GetRelatedObjects($sRelCode, $iMaxDepth);
  1436. $aRestriction = array_key_exists($sRootClass, $aRelatedObjs) ? $aRelatedObjs[$sRootClass] : array();
  1437. // #@# todo - related objects and expressions...
  1438. // Create condition
  1439. if (count($aRestriction) > 0)
  1440. {
  1441. $oSelectBase->AddCondition($sKeyField.' IN ('.implode(', ', CMDBSource::Quote(array_keys($aRestriction), true)).')');
  1442. }
  1443. else
  1444. {
  1445. // Quick N'dirty -> generate an empty set
  1446. $oSelectBase->AddCondition('false');
  1447. }
  1448. }
  1449. // Translate the conditions... and go
  1450. //
  1451. if ($bIsOnQueriedClass)
  1452. {
  1453. $oConditionTranslated = $oConditionTree->Translate($aTranslation);
  1454. $oSelectBase->SetCondition($oConditionTranslated);
  1455. }
  1456. // That's all... cross fingers and we'll get some working query
  1457. //MyHelpers::var_dump_html($oSelectBase, true);
  1458. //MyHelpers::var_dump_html($oSelectBase->RenderSelect(), true);
  1459. if (self::$m_bDebugQuery) $oSelectBase->DisplayHtml();
  1460. return $oSelectBase;
  1461. }
  1462. protected static function MakeQuerySingleTable($aSelectedClasses, &$oConditionTree, &$aClassAliases, &$aTableAliases, &$aTranslation, $oFilter, $sTableClass, $aExpectedAtts, $aExtKeys, $aValues)
  1463. {
  1464. // $aExpectedAtts is an array of sAttCode=>sAlias
  1465. // $aExtKeys is an array of sTableClass => array of (sAttCode (keys) => array of sAttCode (fields))
  1466. // Prepare the query for a single table (compound objects)
  1467. // Ignores the items (attributes/filters) that are not on the target table
  1468. // Perform an (inner or left) join for every external key (and specify the expected fields)
  1469. //
  1470. // Returns an SQLQuery
  1471. //
  1472. $sTargetClass = $oFilter->GetFirstJoinedClass();
  1473. $sTargetAlias = $oFilter->GetFirstJoinedClassAlias();
  1474. $sTable = self::DBGetTable($sTableClass);
  1475. $sTableAlias = self::GenerateUniqueAlias($aTableAliases, $sTargetAlias.'_'.$sTable, $sTable);
  1476. $bIsOnQueriedClass = array_key_exists($sTargetAlias, $aSelectedClasses);
  1477. self::DbgTrace("Entering: tableclass=$sTableClass, filter=".$oFilter->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY").", expectedatts=".count($aExpectedAtts).": ".implode(",", array_keys($aExpectedAtts)));
  1478. // 1 - SELECT and UPDATE
  1479. //
  1480. // Note: no need for any values nor fields for foreign Classes (ie not the queried Class)
  1481. //
  1482. $aSelect = array();
  1483. $aUpdateValues = array();
  1484. // 1/a - Get the key
  1485. //
  1486. if ($bIsOnQueriedClass)
  1487. {
  1488. $aSelect[$aExpectedAtts['id'][0]] = new FieldExpression(self::DBGetKey($sTableClass), $sTableAlias);
  1489. }
  1490. // We need one pkey to be the key, let's take the one corresponding to the root class
  1491. // (used to be based on the leaf, but it may happen that this one has no table defined)
  1492. $sRootClass = self::GetRootClass($sTargetClass);
  1493. if ($sTableClass == $sRootClass)
  1494. {
  1495. $aTranslation[$sTargetAlias]['id'] = array($sTableAlias, self::DBGetKey($sTableClass));
  1496. }
  1497. // 1/b - Get the other attributes
  1498. //
  1499. foreach(self::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  1500. {
  1501. // Skip this attribute if not defined in this table
  1502. if (self::$m_aAttribOrigins[$sTargetClass][$sAttCode] != $sTableClass) continue;
  1503. // Skip this attribute if not writable (means that it does not correspond
  1504. if (count($oAttDef->GetSQLExpressions()) == 0) continue;
  1505. // Update...
  1506. //
  1507. if ($bIsOnQueriedClass && array_key_exists($sAttCode, $aValues))
  1508. {
  1509. assert ($oAttDef->IsDirectField());
  1510. foreach ($oAttDef->GetSQLValues($aValues[$sAttCode]) as $sColumn => $sValue)
  1511. {
  1512. $aUpdateValues[$sColumn] = $sValue;
  1513. }
  1514. }
  1515. // Select...
  1516. //
  1517. // Skip, if a list of fields has been specified and it is not there
  1518. if (!array_key_exists($sAttCode, $aExpectedAtts)) continue;
  1519. if ($oAttDef->IsExternalField())
  1520. {
  1521. // skip, this will be handled in the joined tables
  1522. }
  1523. else
  1524. {
  1525. // standard field, or external key
  1526. // add it to the output
  1527. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1528. {
  1529. foreach ($aExpectedAtts[$sAttCode] as $sAttAlias)
  1530. {
  1531. $aSelect[$sAttAlias.$sColId] = new FieldExpression($sSQLExpr, $sTableAlias);
  1532. }
  1533. }
  1534. }
  1535. }
  1536. // 2 - WHERE
  1537. //
  1538. foreach(self::$m_aFilterDefs[$sTargetClass] as $sFltCode => $oFltAtt)
  1539. {
  1540. // Skip this filter if not defined in this table
  1541. if (self::$m_aFilterOrigins[$sTargetClass][$sFltCode] != $sTableClass) continue;
  1542. // #@# todo - aller plus loin... a savoir que la table de translation doit contenir une "Expression"
  1543. foreach($oFltAtt->GetSQLExpressions() as $sColID => $sFltExpr)
  1544. {
  1545. // Note: I did not test it with filters relying on several expressions...
  1546. // as long as sColdID is empty, this is working, otherwise... ?
  1547. $aTranslation[$sTargetAlias][$sFltCode.$sColID] = array($sTableAlias, $sFltExpr);
  1548. }
  1549. }
  1550. // #@# todo - See what a full text search condition should be
  1551. // 2' - WHERE / Full text search condition
  1552. //
  1553. if ($bIsOnQueriedClass)
  1554. {
  1555. $aFullText = $oFilter->GetCriteria_FullText();
  1556. }
  1557. else
  1558. {
  1559. // Pourquoi ???
  1560. $aFullText = array();
  1561. }
  1562. // 3 - The whole stuff, for this table only
  1563. //
  1564. $oSelectBase = new SQLQuery($sTable, $sTableAlias, $aSelect, null, $aFullText, $bIsOnQueriedClass, $aUpdateValues);
  1565. // 4 - The external keys -> joins...
  1566. //
  1567. if (array_key_exists($sTableClass, $aExtKeys))
  1568. {
  1569. foreach ($aExtKeys[$sTableClass] as $sKeyAttCode => $aExtFields)
  1570. {
  1571. $oKeyAttDef = self::GetAttributeDef($sTargetClass, $sKeyAttCode);
  1572. $oExtFilter = $oFilter->GetCriteria_PointingTo($sKeyAttCode);
  1573. // In case the join was not explicitely defined in the filter,
  1574. // we need to do it now
  1575. if (empty($oExtFilter))
  1576. {
  1577. $sKeyClass = $oKeyAttDef->GetTargetClass();
  1578. $sKeyClassAlias = self::GenerateUniqueAlias($aClassAliases, $sKeyClass.'_'.$sKeyAttCode, $sKeyClass);
  1579. $oExtFilter = new DBObjectSearch($sKeyClass, $sKeyClassAlias);
  1580. }
  1581. else
  1582. {
  1583. // The aliases should not conflict because normalization occured while building the filter
  1584. $sKeyClass = $oExtFilter->GetFirstJoinedClass();
  1585. $sKeyClassAlias = $oExtFilter->GetFirstJoinedClassAlias();
  1586. // Note: there is no search condition in $oExtFilter, because normalization did merge the condition onto the top of the filter tree
  1587. }
  1588. // Specify expected attributes for the target class query
  1589. // ... and use the current alias !
  1590. $aExpAtts = array();
  1591. $aIntermediateTranslation = array();
  1592. foreach($aExtFields as $sAttCode => $oAtt)
  1593. {
  1594. $sExtAttCode = $oAtt->GetExtAttCode();
  1595. if (array_key_exists($sAttCode, $aExpectedAtts))
  1596. {
  1597. // Request this attribute... transmit the alias !
  1598. $aExpAtts[$sExtAttCode] = $aExpectedAtts[$sAttCode];
  1599. }
  1600. // Translate mainclass.extfield => remoteclassalias.remotefieldcode
  1601. $oRemoteAttDef = self::GetAttributeDef($sKeyClass, $sExtAttCode);
  1602. foreach ($oRemoteAttDef->GetSQLExpressions() as $sColID => $sRemoteAttExpr)
  1603. {
  1604. $aIntermediateTranslation[$sTargetAlias.$sColID][$sAttCode] = array($sKeyClassAlias, $sRemoteAttExpr);
  1605. }
  1606. //#@# debug - echo "<p>$sTargetAlias.$sAttCode to $sKeyClassAlias.$sRemoteAttExpr (class: $sKeyClass)</p>\n";
  1607. }
  1608. $oConditionTree = $oConditionTree->Translate($aIntermediateTranslation, false);
  1609. self::DbgTrace("External key $sKeyAttCode (class: $sKeyClass), call MakeQuery()");
  1610. $oSelectExtKey = self::MakeQuery($aSelectedClasses, $oConditionTree, $aClassAliases, $aTableAliases, $aTranslation, $oExtFilter, $aExpAtts);
  1611. $sLocalKeyField = current($oKeyAttDef->GetSQLExpressions()); // get the first column for an external key
  1612. $sExternalKeyField = self::DBGetKey($sKeyClass);
  1613. self::DbgTrace("External key $sKeyAttCode, Join on $sLocalKeyField = $sExternalKeyField");
  1614. if ($oKeyAttDef->IsNullAllowed())
  1615. {
  1616. $oSelectBase->AddLeftJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField);
  1617. }
  1618. else
  1619. {
  1620. $oSelectBase->AddInnerJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField);
  1621. }
  1622. }
  1623. }
  1624. //MyHelpers::var_dump_html($oSelectBase->RenderSelect());
  1625. return $oSelectBase;
  1626. }
  1627. public static function GenerateUniqueAlias(&$aAliases, $sNewName, $sRealName)
  1628. {
  1629. if (!array_key_exists($sNewName, $aAliases))
  1630. {
  1631. $aAliases[$sNewName] = $sRealName;
  1632. return $sNewName;
  1633. }
  1634. for ($i = 1 ; $i < 100 ; $i++)
  1635. {
  1636. $sAnAlias = $sNewName.$i;
  1637. if (!array_key_exists($sAnAlias, $aAliases))
  1638. {
  1639. // Create that new alias
  1640. $aAliases[$sAnAlias] = $sRealName;
  1641. return $sAnAlias;
  1642. }
  1643. }
  1644. throw new CoreException('Failed to create an alias', array('aliases' => $aAliases, 'new'=>$sNewName));
  1645. }
  1646. public static function CheckDefinitions()
  1647. {
  1648. if (count(self::GetClasses()) == 0)
  1649. {
  1650. throw new CoreException("MetaModel::InitClasses() has not been called, or no class has been declared ?!?!");
  1651. }
  1652. $aErrors = array();
  1653. $aSugFix = array();
  1654. foreach (self::GetClasses() as $sClass)
  1655. {
  1656. $sNameAttCode = self::GetNameAttributeCode($sClass);
  1657. if (empty($sNameAttCode))
  1658. {
  1659. // let's try this !!!
  1660. // $aErrors[$sClass][] = "Missing value for name definition: the framework will (should...) replace it by the id";
  1661. // $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  1662. }
  1663. else if(!self::IsValidAttCode($sClass, $sNameAttCode))
  1664. {
  1665. $aErrors[$sClass][] = "Unkown attribute code '".$sNameAttCode."' for the name definition";
  1666. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  1667. }
  1668. foreach(self::GetReconcKeys($sClass) as $sReconcKeyAttCode)
  1669. {
  1670. if (!empty($sReconcKeyAttCode) && !self::IsValidAttCode($sClass, $sReconcKeyAttCode))
  1671. {
  1672. $aErrors[$sClass][] = "Unkown attribute code '".$sReconcKeyAttCode."' in the list of reconciliation keys";
  1673. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  1674. }
  1675. }
  1676. $bHasWritableAttribute = false;
  1677. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  1678. {
  1679. // It makes no sense to check the attributes again and again in the subclasses
  1680. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  1681. if ($oAttDef->IsExternalKey())
  1682. {
  1683. if (!self::IsValidClass($oAttDef->GetTargetClass()))
  1684. {
  1685. $aErrors[$sClass][] = "Unkown class '".$oAttDef->GetTargetClass()."' for the external key '$sAttCode'";
  1686. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetClasses())."}";
  1687. }
  1688. }
  1689. elseif ($oAttDef->IsExternalField())
  1690. {
  1691. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1692. if (!self::IsValidAttCode($sClass, $sKeyAttCode) || !self::IsValidKeyAttCode($sClass, $sKeyAttCode))
  1693. {
  1694. $aErrors[$sClass][] = "Unkown key attribute code '".$sKeyAttCode."' for the external field $sAttCode";
  1695. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sClass))."}";
  1696. }
  1697. else
  1698. {
  1699. $oKeyAttDef = self::GetAttributeDef($sClass, $sKeyAttCode);
  1700. $sTargetClass = $oKeyAttDef->GetTargetClass();
  1701. $sExtAttCode = $oAttDef->GetExtAttCode();
  1702. if (!self::IsValidAttCode($sTargetClass, $sExtAttCode))
  1703. {
  1704. $aErrors[$sClass][] = "Unkown key attribute code '".$sExtAttCode."' for the external field $sAttCode";
  1705. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetKeysList($sTargetClass))."}";
  1706. }
  1707. }
  1708. }
  1709. else // standard attributes
  1710. {
  1711. // Check that the default values definition is a valid object!
  1712. $oValSetDef = $oAttDef->GetValuesDef();
  1713. if (!is_null($oValSetDef) && !$oValSetDef instanceof ValueSetDefinition)
  1714. {
  1715. $aErrors[$sClass][] = "Allowed values for attribute $sAttCode is not of the relevant type";
  1716. $aSugFix[$sClass][] = "Please set it as an instance of a ValueSetDefinition object.";
  1717. }
  1718. else
  1719. {
  1720. // Default value must be listed in the allowed values (if defined)
  1721. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  1722. if (!is_null($aAllowedValues))
  1723. {
  1724. $sDefaultValue = $oAttDef->GetDefaultValue();
  1725. if (!array_key_exists($sDefaultValue, $aAllowedValues))
  1726. {
  1727. $aErrors[$sClass][] = "Default value '".$sDefaultValue."' for attribute $sAttCode is not an allowed value";
  1728. $aSugFix[$sClass][] = "Please pickup the default value out of {'".implode(", ", array_keys($aAllowedValues))."'}";
  1729. }
  1730. }
  1731. }
  1732. }
  1733. // Check dependencies
  1734. if ($oAttDef->IsWritable())
  1735. {
  1736. $bHasWritableAttribute = true;
  1737. foreach ($oAttDef->GetPrerequisiteAttributes() as $sDependOnAttCode)
  1738. {
  1739. if (!self::IsValidAttCode($sClass, $sDependOnAttCode))
  1740. {
  1741. $aErrors[$sClass][] = "Unkown attribute code '".$sDependOnAttCode."' in the list of prerequisite attributes";
  1742. $aSugFix[$sClass][] = "Expecting a value in ".implode(", ", self::GetAttributesList($sClass));
  1743. }
  1744. }
  1745. }
  1746. }
  1747. foreach(self::GetClassFilterDefs($sClass) as $sFltCode=>$oFilterDef)
  1748. {
  1749. if (method_exists($oFilterDef, '__GetRefAttribute'))
  1750. {
  1751. $oAttDef = $oFilterDef->__GetRefAttribute();
  1752. if (!self::IsValidAttCode($sClass, $oAttDef->GetCode()))
  1753. {
  1754. $aErrors[$sClass][] = "Wrong attribute code '".$oAttDef->GetCode()."' (wrong class) for the \"basic\" filter $sFltCode";
  1755. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  1756. }
  1757. }
  1758. }
  1759. // Lifecycle
  1760. //
  1761. $sStateAttCode = self::GetStateAttributeCode($sClass);
  1762. if (strlen($sStateAttCode) > 0)
  1763. {
  1764. // Lifecycle - check that the state attribute does exist as an attribute
  1765. if (!self::IsValidAttCode($sClass, $sStateAttCode))
  1766. {
  1767. $aErrors[$sClass][] = "Unkown attribute code '".$sStateAttCode."' for the state definition";
  1768. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  1769. }
  1770. else
  1771. {
  1772. // Lifecycle - check that there is a value set constraint on the state attribute
  1773. $aAllowedValuesRaw = self::GetAllowedValues_att($sClass, $sStateAttCode);
  1774. $aStates = array_keys(self::EnumStates($sClass));
  1775. if (is_null($aAllowedValuesRaw))
  1776. {
  1777. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' will reflect the state of the object. It must be restricted to a set of values";
  1778. $aSugFix[$sClass][] = "Please define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')]";
  1779. }
  1780. else
  1781. {
  1782. $aAllowedValues = array_keys($aAllowedValuesRaw);
  1783. // Lifecycle - check the the state attribute allowed values are defined states
  1784. foreach($aAllowedValues as $sValue)
  1785. {
  1786. if (!in_array($sValue, $aStates))
  1787. {
  1788. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has an allowed value ($sValue) which is not a known state";
  1789. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  1790. }
  1791. }
  1792. // Lifecycle - check that defined states are allowed values
  1793. foreach($aStates as $sStateValue)
  1794. {
  1795. if (!in_array($sStateValue, $aAllowedValues))
  1796. {
  1797. $aErrors[$sClass][] = "Attribute '".$sStateAttCode."' (object state) has a state ($sStateValue) which is not an allowed value";
  1798. $aSugFix[$sClass][] = "You may define its allowed_values property as [new ValueSetEnum('".implode(", ", $aStates)."')], or reconsider the list of states";
  1799. }
  1800. }
  1801. }
  1802. // Lifcycle - check that the action handlers are defined
  1803. foreach (self::EnumStates($sClass) as $sStateCode => $aStateDef)
  1804. {
  1805. foreach(self::EnumTransitions($sClass, $sStateCode) as $sStimulusCode => $aTransitionDef)
  1806. {
  1807. foreach ($aTransitionDef['actions'] as $sActionHandler)
  1808. {
  1809. if (!method_exists($sClass, $sActionHandler))
  1810. {
  1811. $aErrors[$sClass][] = "Unknown function '$sActionHandler' in transition [$sStateCode/$sStimulusCode] for state attribute '$sStateAttCode'";
  1812. $aSugFix[$sClass][] = "Specify a function which prototype is in the form [public function $sActionHandler(\$sStimulusCode){return true;}]";
  1813. }
  1814. }
  1815. }
  1816. }
  1817. }
  1818. }
  1819. if ($bHasWritableAttribute)
  1820. {
  1821. if (!self::HasTable($sClass))
  1822. {
  1823. $aErrors[$sClass][] = "No table has been defined for this class";
  1824. $aSugFix[$sClass][] = "Either define a table name or move the attributes elsewhere";
  1825. }
  1826. }
  1827. // ZList
  1828. //
  1829. foreach(self::EnumZLists() as $sListCode)
  1830. {
  1831. foreach (self::GetZListItems($sClass, $sListCode) as $sMyAttCode)
  1832. {
  1833. if (!self::IsValidAttCode($sClass, $sMyAttCode))
  1834. {
  1835. $aErrors[$sClass][] = "Unkown attribute code '".$sMyAttCode."' from ZList '$sListCode'";
  1836. $aSugFix[$sClass][] = "Expecting a value in {".implode(", ", self::GetAttributesList($sClass))."}";
  1837. }
  1838. }
  1839. }
  1840. }
  1841. if (count($aErrors) > 0)
  1842. {
  1843. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  1844. echo "<h3>Business model inconsistencies have been found</h3>\n";
  1845. // #@# later -> this is the responsibility of the caller to format the output
  1846. foreach ($aErrors as $sClass => $aMessages)
  1847. {
  1848. echo "<p>Wrong declaration for class <b>$sClass</b></p>\n";
  1849. echo "<ul class=\"treeview\">\n";
  1850. $i = 0;
  1851. foreach ($aMessages as $sMsg)
  1852. {
  1853. echo "<li>$sMsg ({$aSugFix[$sClass][$i]})</li>\n";
  1854. $i++;
  1855. }
  1856. echo "</ul>\n";
  1857. }
  1858. echo "<p>Aborting...</p>\n";
  1859. echo "</div>\n";
  1860. exit;
  1861. }
  1862. }
  1863. public static function DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes)
  1864. {
  1865. if (empty($sRepairUrl)) return;
  1866. // By design, some queries might be blank, we have to ignore them
  1867. $aCleanFixes = array();
  1868. foreach($aSQLFixes as $sSQLFix)
  1869. {
  1870. if (!empty($sSQLFix))
  1871. {
  1872. $aCleanFixes[] = $sSQLFix;
  1873. }
  1874. }
  1875. if (count($aCleanFixes) == 0) return;
  1876. echo "<form action=\"$sRepairUrl\" method=\"POST\">\n";
  1877. echo " <input type=\"hidden\" name=\"$sSQLStatementArgName\" value=\"".htmlentities(implode("##SEP##", $aCleanFixes))."\">\n";
  1878. echo " <input type=\"submit\" value=\" Apply changes (".count($aCleanFixes)." queries) \">\n";
  1879. echo "</form>\n";
  1880. }
  1881. public static function DBExists($bMustBeComplete = true)
  1882. {
  1883. // returns true if at least one table exists
  1884. //
  1885. if (!CMDBSource::IsDB(self::$m_sDBName))
  1886. {
  1887. return false;
  1888. }
  1889. CMDBSource::SelectDB(self::$m_sDBName);
  1890. $aFound = array();
  1891. $aMissing = array();
  1892. foreach (self::DBEnumTables() as $sTable => $aClasses)
  1893. {
  1894. if (CMDBSource::IsTable($sTable))
  1895. {
  1896. $aFound[] = $sTable;
  1897. }
  1898. else
  1899. {
  1900. $aMissing[] = $sTable;
  1901. }
  1902. }
  1903. if (count($aFound) == 0)
  1904. {
  1905. // no expected table has been found
  1906. return false;
  1907. }
  1908. else
  1909. {
  1910. if (count($aMissing) == 0)
  1911. {
  1912. // the database is complete (still, could be some fields missing!)
  1913. return true;
  1914. }
  1915. else
  1916. {
  1917. // not all the tables, could be an older version
  1918. if ($bMustBeComplete)
  1919. {
  1920. return false;
  1921. }
  1922. else
  1923. {
  1924. return true;
  1925. }
  1926. }
  1927. }
  1928. }
  1929. public static function DBDrop()
  1930. {
  1931. $bDropEntireDB = true;
  1932. if (!empty(self::$m_sTablePrefix))
  1933. {
  1934. // Do drop only tables corresponding to the sub-database (table prefix)
  1935. // then possibly drop the DB itself (if no table remain)
  1936. foreach (CMDBSource::EnumTables() as $sTable)
  1937. {
  1938. // perform a case insensitive test because on Windows the table names become lowercase :-(
  1939. if (strtolower(substr($sTable, 0, strlen(self::$m_sTablePrefix))) == strtolower(self::$m_sTablePrefix))
  1940. {
  1941. CMDBSource::DropTable($sTable);
  1942. }
  1943. else
  1944. {
  1945. // There is at least one table which is out of the scope of the current application
  1946. $bDropEntireDB = false;
  1947. }
  1948. }
  1949. }
  1950. if ($bDropEntireDB)
  1951. {
  1952. CMDBSource::DropDB(self::$m_sDBName);
  1953. }
  1954. }
  1955. public static function DBCreate()
  1956. {
  1957. // Note: we have to check if the DB does exist, because we may share the DB
  1958. // with other applications (in which case the DB does exist, not the tables with the given prefix)
  1959. if (!CMDBSource::IsDB(self::$m_sDBName))
  1960. {
  1961. CMDBSource::CreateDB(self::$m_sDBName);
  1962. }
  1963. self::DBCreateTables();
  1964. self::DBCreateViews();
  1965. }
  1966. protected static function DBCreateTables()
  1967. {
  1968. list($aErrors, $aSugFix) = self::DBCheckFormat();
  1969. $aSQL = array();
  1970. foreach ($aSugFix as $sClass => $aTarget)
  1971. {
  1972. foreach ($aTarget as $aQueries)
  1973. {
  1974. foreach ($aQueries as $sQuery)
  1975. {
  1976. if (!empty($sQuery))
  1977. {
  1978. //$aSQL[] = $sQuery;
  1979. // forces a refresh of cached information
  1980. CMDBSource::CreateTable($sQuery);
  1981. }
  1982. }
  1983. }
  1984. }
  1985. // does not work -how to have multiple statements in a single query?
  1986. // $sDoCreateAll = implode(" ; ", $aSQL);
  1987. }
  1988. protected static function DBCreateViews()
  1989. {
  1990. list($aErrors, $aSugFix) = self::DBCheckViews();
  1991. $aSQL = array();
  1992. foreach ($aSugFix as $sClass => $aTarget)
  1993. {
  1994. foreach ($aTarget as $aQueries)
  1995. {
  1996. foreach ($aQueries as $sQuery)
  1997. {
  1998. if (!empty($sQuery))
  1999. {
  2000. //$aSQL[] = $sQuery;
  2001. // forces a refresh of cached information
  2002. CMDBSource::CreateTable($sQuery);
  2003. }
  2004. }
  2005. }
  2006. }
  2007. }
  2008. public static function DBDump()
  2009. {
  2010. $aDataDump = array();
  2011. foreach (self::DBEnumTables() as $sTable => $aClasses)
  2012. {
  2013. $aRows = CMDBSource::DumpTable($sTable);
  2014. $aDataDump[$sTable] = $aRows;
  2015. }
  2016. return $aDataDump;
  2017. }
  2018. protected static function MakeDictEntry($sKey, $sValueFromOldSystem, $sDefaultValue, &$bNotInDico)
  2019. {
  2020. $sValue = Dict::S($sKey, 'x-no-nothing');
  2021. if ($sValue == 'x-no-nothing')
  2022. {
  2023. $bNotInDico = true;
  2024. $sValue = $sValueFromOldSystem;
  2025. if (strlen($sValue) == 0)
  2026. {
  2027. $sValue = $sDefaultValue;
  2028. }
  2029. }
  2030. return " '$sKey' => '".str_replace("'", "\\'", $sValue)."',\n";
  2031. }
  2032. public static function MakeDictionaryTemplate($sModules = '', $sOutputFilter = 'NotInDictionary')
  2033. {
  2034. $sRes = '';
  2035. $sRes .= "// Dictionnay conventions\n";
  2036. $sRes .= htmlentities("// Class:<class_name>\n");
  2037. $sRes .= htmlentities("// Class:<class_name>+\n");
  2038. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>\n");
  2039. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>+\n");
  2040. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>\n");
  2041. $sRes .= htmlentities("// Class:<class_name>/Attribute:<attribute_code>/Value:<value>+\n");
  2042. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>\n");
  2043. $sRes .= htmlentities("// Class:<class_name>/Stimulus:<stimulus_code>+\n");
  2044. $sRes .= "\n";
  2045. // Note: I did not use EnumCategories(), because a given class maybe found in several categories
  2046. // Need to invent the "module", to characterize the origins of a class
  2047. if (strlen($sModules) == 0)
  2048. {
  2049. $aModules = array('bizmodel', 'core/cmdb', 'gui' , 'application', 'addon/userrights');
  2050. }
  2051. else
  2052. {
  2053. $aModules = explode(', ', $sModules);
  2054. }
  2055. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2056. $sRes .= "// Note: The classes have been grouped by categories: ".implode(', ', $aModules)."\n";
  2057. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2058. foreach ($aModules as $sCategory)
  2059. {
  2060. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2061. $sRes .= "// Classes in '<em>$sCategory</em>'\n";
  2062. $sRes .= "//////////////////////////////////////////////////////////////////////\n";
  2063. $sRes .= "//\n";
  2064. $sRes .= "\n";
  2065. foreach (self::GetClasses($sCategory) as $sClass)
  2066. {
  2067. if (!self::HasTable($sClass)) continue;
  2068. $bNotInDico = false;
  2069. $sClassRes = "//\n";
  2070. $sClassRes .= "// Class: $sClass\n";
  2071. $sClassRes .= "//\n";
  2072. $sClassRes .= "\n";
  2073. $sClassRes .= "Dict::Add('EN US', 'English', 'English', array(\n";
  2074. $sClassRes .= self::MakeDictEntry("Class:$sClass", self::GetName_Obsolete($sClass), $sClass, $bNotInDico);
  2075. $sClassRes .= self::MakeDictEntry("Class:$sClass+", self::GetClassDescription_Obsolete($sClass), '', $bNotInDico);
  2076. foreach(self::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  2077. {
  2078. // Skip this attribute if not originaly defined in this class
  2079. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2080. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode", $oAttDef->GetLabel_Obsolete(), $sAttCode, $bNotInDico);
  2081. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode+", $oAttDef->GetDescription_Obsolete(), '', $bNotInDico);
  2082. if ($oAttDef instanceof AttributeEnum)
  2083. {
  2084. if (self::GetStateAttributeCode($sClass) == $sAttCode)
  2085. {
  2086. foreach (self::EnumStates($sClass) as $sStateCode => $aStateData)
  2087. {
  2088. if (array_key_exists('label', $aStateData))
  2089. {
  2090. $sValue = $aStateData['label'];
  2091. }
  2092. else
  2093. {
  2094. $sValue = MetaModel::GetStateLabel($sClass, $sStateCode);
  2095. }
  2096. if (array_key_exists('description', $aStateData))
  2097. {
  2098. $sValuePlus = $aStateData['description'];
  2099. }
  2100. else
  2101. {
  2102. $sValuePlus = MetaModel::GetStateDescription($sClass, $sStateCode);
  2103. }
  2104. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode", $sValue, '', $bNotInDico);
  2105. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sStateCode+", $sValuePlus, '', $bNotInDico);
  2106. }
  2107. }
  2108. else
  2109. {
  2110. foreach ($oAttDef->GetAllowedValues() as $sKey => $value)
  2111. {
  2112. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey", $value, '', $bNotInDico);
  2113. $sClassRes .= self::MakeDictEntry("Class:$sClass/Attribute:$sAttCode/Value:$sKey+", $value, '', $bNotInDico);
  2114. }
  2115. }
  2116. }
  2117. }
  2118. foreach(self::EnumStimuli($sClass) as $sStimulusCode => $oStimulus)
  2119. {
  2120. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode", $oStimulus->GetLabel_Obsolete(), '', $bNotInDico);
  2121. $sClassRes .= self::MakeDictEntry("Class:$sClass/Stimulus:$sStimulusCode+", $oStimulus->GetDescription_Obsolete(), '', $bNotInDico);
  2122. }
  2123. $sClassRes .= "));\n";
  2124. $sClassRes .= "\n";
  2125. if ($bNotInDico || ($sOutputFilter != 'NotInDictionary'))
  2126. {
  2127. $sRes .= $sClassRes;
  2128. }
  2129. }
  2130. }
  2131. return $sRes;
  2132. }
  2133. public static function DBCheckFormat()
  2134. {
  2135. $aErrors = array();
  2136. $aSugFix = array();
  2137. foreach (self::GetClasses() as $sClass)
  2138. {
  2139. if (!self::HasTable($sClass)) continue;
  2140. // Check that the table exists
  2141. //
  2142. $sTable = self::DBGetTable($sClass);
  2143. $sKeyField = self::DBGetKey($sClass);
  2144. $sAutoIncrement = (self::IsAutoIncrementKey($sClass) ? "AUTO_INCREMENT" : "");
  2145. if (!CMDBSource::IsTable($sTable))
  2146. {
  2147. $aErrors[$sClass]['*'][] = "table '$sTable' could not be found into the DB";
  2148. $aSugFix[$sClass]['*'][] = "CREATE TABLE `$sTable` (`$sKeyField` INT(11) NOT NULL $sAutoIncrement PRIMARY KEY) ENGINE = innodb CHARACTER SET utf8 COLLATE utf8_unicode_ci";
  2149. }
  2150. // Check that the key field exists
  2151. //
  2152. elseif (!CMDBSource::IsField($sTable, $sKeyField))
  2153. {
  2154. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) could not be found";
  2155. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` ADD `$sKeyField` INT(11) NOT NULL $sAutoIncrement PRIMARY KEY";
  2156. }
  2157. else
  2158. {
  2159. // Check the key field properties
  2160. //
  2161. if (!CMDBSource::IsKey($sTable, $sKeyField))
  2162. {
  2163. $aErrors[$sClass]['id'][] = "key '$sKeyField' is not a key for table '$sTable'";
  2164. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable`, DROP PRIMARY KEY, ADD PRIMARY key(`$sKeyField`)";
  2165. }
  2166. if (self::IsAutoIncrementKey($sClass) && !CMDBSource::IsAutoIncrement($sTable, $sKeyField))
  2167. {
  2168. $aErrors[$sClass]['id'][] = "key '$sKeyField' (table $sTable) is not automatically incremented";
  2169. $aSugFix[$sClass]['id'][] = "ALTER TABLE `$sTable` CHANGE `$sKeyField` `$sKeyField` INT(11) NOT NULL AUTO_INCREMENT";
  2170. }
  2171. }
  2172. // Check that any defined field exists
  2173. //
  2174. $aTableInfo = CMDBSource::GetTableInfo($sTable);
  2175. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2176. {
  2177. // Skip this attribute if not originaly defined in this class
  2178. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2179. foreach($oAttDef->GetSQLColumns() as $sField => $sDBFieldType)
  2180. {
  2181. $bIndexNeeded = $oAttDef->RequiresIndex();
  2182. $sFieldSpecs = $oAttDef->IsNullAllowed() ? "$sDBFieldType NULL" : "$sDBFieldType NOT NULL";
  2183. if (!CMDBSource::IsField($sTable, $sField))
  2184. {
  2185. $aErrors[$sClass][$sAttCode][] = "field '$sField' could not be found in table '$sTable'";
  2186. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD `$sField` $sFieldSpecs";
  2187. if ($bIndexNeeded)
  2188. {
  2189. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  2190. }
  2191. }
  2192. else
  2193. {
  2194. // The field already exists, does it have the relevant properties?
  2195. //
  2196. $bToBeChanged = false;
  2197. if ($oAttDef->IsNullAllowed() != CMDBSource::IsNullAllowed($sTable, $sField))
  2198. {
  2199. $bToBeChanged = true;
  2200. if ($oAttDef->IsNullAllowed())
  2201. {
  2202. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could be NULL";
  2203. }
  2204. else
  2205. {
  2206. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' could NOT be NULL";
  2207. }
  2208. }
  2209. $sActualFieldType = CMDBSource::GetFieldType($sTable, $sField);
  2210. if (strcasecmp($sDBFieldType, $sActualFieldType) != 0)
  2211. {
  2212. $bToBeChanged = true;
  2213. $aErrors[$sClass][$sAttCode][] = "field '$sField' in table '$sTable' has a wrong type: found '$sActualFieldType' while expecting '$sDBFieldType'";
  2214. }
  2215. if ($bToBeChanged)
  2216. {
  2217. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` CHANGE `$sField` `$sField` $sFieldSpecs";
  2218. }
  2219. // Create indexes (external keys only... so far)
  2220. //
  2221. if ($bIndexNeeded && !CMDBSource::HasIndex($sTable, $sField))
  2222. {
  2223. $aErrors[$sClass][$sAttCode][] = "Foreign key '$sField' in table '$sTable' should have an index";
  2224. $aSugFix[$sClass][$sAttCode][] = "ALTER TABLE `$sTable` ADD INDEX (`$sField`)";
  2225. }
  2226. }
  2227. }
  2228. }
  2229. }
  2230. return array($aErrors, $aSugFix);
  2231. }
  2232. public static function DBCheckViews()
  2233. {
  2234. $aErrors = array();
  2235. $aSugFix = array();
  2236. // Reporting views (must be created after any other table)
  2237. //
  2238. foreach (self::GetClasses('bizmodel') as $sClass)
  2239. {
  2240. $sView = "view_$sClass";
  2241. if (CMDBSource::IsTable($sView))
  2242. {
  2243. // Check that the view is complete
  2244. //
  2245. $bIsComplete = true;
  2246. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2247. {
  2248. foreach($oAttDef->GetSQLExpressions() as $sSuffix => $sTrash)
  2249. {
  2250. $sCol = $sAttCode.$sSuffix;
  2251. if (!CMDBSource::IsField($sView, $sCol))
  2252. {
  2253. $bIsComplete = false;
  2254. $aErrors[$sClass][$sAttCode][] = "field '$sCol' could not be found in view '$sView'";
  2255. $aSugFix[$sClass][$sAttCode][] = "";
  2256. }
  2257. }
  2258. }
  2259. if (!$bIsComplete)
  2260. {
  2261. // Rework the view
  2262. //
  2263. $oFilter = new DBObjectSearch($sClass, '');
  2264. $sSQL = self::MakeSelectQuery($oFilter);
  2265. $aErrors[$sClass]['*'][] = "View '$sView' is currently not complete";
  2266. $aSugFix[$sClass]['*'][] = "ALTER VIEW `$sView` AS $sSQL";
  2267. }
  2268. }
  2269. else
  2270. {
  2271. // Create the view
  2272. //
  2273. $oFilter = new DBObjectSearch($sClass, '');
  2274. $sSQL = self::MakeSelectQuery($oFilter);
  2275. $aErrors[$sClass]['*'][] = "Missing view for class: $sClass";
  2276. $aSugFix[$sClass]['*'][] = "CREATE VIEW `$sView` AS $sSQL";
  2277. }
  2278. }
  2279. return array($aErrors, $aSugFix);
  2280. }
  2281. private static function DBCheckIntegrity_Check2Delete($sSelWrongRecs, $sErrorDesc, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel, $bProcessingFriends = false)
  2282. {
  2283. $sRootClass = self::GetRootClass($sClass);
  2284. $sTable = self::DBGetTable($sClass);
  2285. $sKeyField = self::DBGetKey($sClass);
  2286. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  2287. {
  2288. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  2289. }
  2290. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  2291. if (count($aWrongRecords) == 0) return;
  2292. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  2293. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  2294. foreach ($aWrongRecords as $iRecordId)
  2295. {
  2296. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  2297. {
  2298. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  2299. {
  2300. case 'Delete':
  2301. // Already planned for a deletion
  2302. // Let's concatenate the errors description together
  2303. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  2304. break;
  2305. case 'Update':
  2306. // Let's plan a deletion
  2307. break;
  2308. }
  2309. }
  2310. else
  2311. {
  2312. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  2313. }
  2314. if (!$bProcessingFriends)
  2315. {
  2316. if (!array_key_exists($sTable, $aPlannedDel) || !in_array($iRecordId, $aPlannedDel[$sTable]))
  2317. {
  2318. // Something new to be deleted...
  2319. $iNewDelCount++;
  2320. }
  2321. }
  2322. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Delete';
  2323. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array();
  2324. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  2325. $aPlannedDel[$sTable][] = $iRecordId;
  2326. }
  2327. // Now make sure that we would delete the records of the other tables for that class
  2328. //
  2329. if (!$bProcessingFriends)
  2330. {
  2331. $sDeleteKeys = "'".implode("', '", $aWrongRecords)."'";
  2332. foreach (self::EnumChildClasses($sRootClass, ENUM_CHILD_CLASSES_ALL) as $sFriendClass)
  2333. {
  2334. $sFriendTable = self::DBGetTable($sFriendClass);
  2335. $sFriendKey = self::DBGetKey($sFriendClass);
  2336. // skip the current table
  2337. if ($sFriendTable == $sTable) continue;
  2338. $sFindRelatedRec = "SELECT DISTINCT maintable.`$sFriendKey` AS id FROM `$sFriendTable` AS maintable WHERE maintable.`$sFriendKey` IN ($sDeleteKeys)";
  2339. self::DBCheckIntegrity_Check2Delete($sFindRelatedRec, "Cascading deletion of record in friend table `<em>$sTable</em>`", $sFriendClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel, true);
  2340. }
  2341. }
  2342. }
  2343. private static function DBCheckIntegrity_Check2Update($sSelWrongRecs, $sErrorDesc, $sColumn, $sNewValue, $sClass, &$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  2344. {
  2345. $sRootClass = self::GetRootClass($sClass);
  2346. $sTable = self::DBGetTable($sClass);
  2347. $sKeyField = self::DBGetKey($sClass);
  2348. if (array_key_exists($sTable, $aPlannedDel) && count($aPlannedDel[$sTable]) > 0)
  2349. {
  2350. $sSelWrongRecs .= " AND maintable.`$sKeyField` NOT IN ('".implode("', '", $aPlannedDel[$sTable])."')";
  2351. }
  2352. $aWrongRecords = CMDBSource::QueryToCol($sSelWrongRecs, "id");
  2353. if (count($aWrongRecords) == 0) return;
  2354. if (!array_key_exists($sRootClass, $aErrorsAndFixes)) $aErrorsAndFixes[$sRootClass] = array();
  2355. if (!array_key_exists($sTable, $aErrorsAndFixes[$sRootClass])) $aErrorsAndFixes[$sRootClass][$sTable] = array();
  2356. foreach ($aWrongRecords as $iRecordId)
  2357. {
  2358. if (array_key_exists($iRecordId, $aErrorsAndFixes[$sRootClass][$sTable]))
  2359. {
  2360. switch ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'])
  2361. {
  2362. case 'Delete':
  2363. // No need to update, the record will be deleted!
  2364. break;
  2365. case 'Update':
  2366. // Already planned for an update
  2367. // Add this new update spec to the list
  2368. $bFoundSameSpec = false;
  2369. foreach ($aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] as $aUpdateSpec)
  2370. {
  2371. if (($sColumn == $aUpdateSpec['column']) && ($sNewValue == $aUpdateSpec['newvalue']))
  2372. {
  2373. $bFoundSameSpec = true;
  2374. }
  2375. }
  2376. if (!$bFoundSameSpec)
  2377. {
  2378. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'][] = (array('column' => $sColumn, 'newvalue'=>$sNewValue));
  2379. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] .= ', '.$sErrorDesc;
  2380. }
  2381. break;
  2382. }
  2383. }
  2384. else
  2385. {
  2386. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Reason'] = $sErrorDesc;
  2387. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action'] = 'Update';
  2388. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Action_Details'] = array(array('column' => $sColumn, 'newvalue'=>$sNewValue));
  2389. $aErrorsAndFixes[$sRootClass][$sTable][$iRecordId]['Pass'] = 123;
  2390. }
  2391. }
  2392. }
  2393. // returns the count of records found for deletion
  2394. public static function DBCheckIntegrity_SinglePass(&$aErrorsAndFixes, &$iNewDelCount, &$aPlannedDel)
  2395. {
  2396. foreach (self::GetClasses() as $sClass)
  2397. {
  2398. if (!self::HasTable($sClass)) continue;
  2399. $sRootClass = self::GetRootClass($sClass);
  2400. $sTable = self::DBGetTable($sClass);
  2401. $sKeyField = self::DBGetKey($sClass);
  2402. if (!self::IsStandaloneClass($sClass))
  2403. {
  2404. if (self::IsRootClass($sClass))
  2405. {
  2406. // Check that the final class field contains the name of a class which inherited from the current class
  2407. //
  2408. $sFinalClassField = self::DBGetClassField($sClass);
  2409. $aAllowedValues = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  2410. $sAllowedValues = implode(",", CMDBSource::Quote($aAllowedValues, true));
  2411. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE `$sFinalClassField` NOT IN ($sAllowedValues)";
  2412. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "final class (field `<em>$sFinalClassField</em>`) is wrong (expected a value in {".$sAllowedValues."})", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2413. }
  2414. else
  2415. {
  2416. $sRootTable = self::DBGetTable($sRootClass);
  2417. $sRootKey = self::DBGetKey($sRootClass);
  2418. $sFinalClassField = self::DBGetClassField($sRootClass);
  2419. $aExpectedClasses = self::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL);
  2420. $sExpectedClasses = implode(",", CMDBSource::Quote($aExpectedClasses, true));
  2421. // Check that any record found here has its counterpart in the root table
  2422. // and which refers to a child class
  2423. //
  2424. $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";
  2425. 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);
  2426. // Check that any record found in the root table and referring to a child class
  2427. // has its counterpart here (detect orphan nodes -root or in the middle of the hierarchy)
  2428. //
  2429. $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)";
  2430. 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);
  2431. }
  2432. }
  2433. foreach(self::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  2434. {
  2435. // Skip this attribute if not defined in this table
  2436. if (self::$m_aAttribOrigins[$sClass][$sAttCode] != $sClass) continue;
  2437. if ($oAttDef->IsExternalKey())
  2438. {
  2439. // Check that any external field is pointing to an existing object
  2440. //
  2441. $sRemoteClass = $oAttDef->GetTargetClass();
  2442. $sRemoteTable = self::DBGetTable($sRemoteClass);
  2443. $sRemoteKey = self::DBGetKey($sRemoteClass);
  2444. $sExtKeyField = current($oAttDef->GetSQLExpressions()); // get the first column for an external key
  2445. // Note: a class/table may have an external key on itself
  2446. $sSelBase = "SELECT DISTINCT maintable.`$sKeyField` AS id, maintable.`$sExtKeyField` AS extkey FROM `$sTable` AS maintable LEFT JOIN `$sRemoteTable` ON maintable.`$sExtKeyField` = `$sRemoteTable`.`$sRemoteKey`";
  2447. $sSelWrongRecs = $sSelBase." WHERE `$sRemoteTable`.`$sRemoteKey` IS NULL";
  2448. if ($oAttDef->IsNullAllowed())
  2449. {
  2450. // Exclude the records pointing to 0/null from the errors
  2451. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  2452. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  2453. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2454. }
  2455. else
  2456. {
  2457. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') non existing objects", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2458. }
  2459. // Do almost the same, taking into account the records planned for deletion
  2460. if (array_key_exists($sRemoteTable, $aPlannedDel) && count($aPlannedDel[$sRemoteTable]) > 0)
  2461. {
  2462. // This could be done by the mean of a 'OR ... IN (aIgnoreRecords)
  2463. // but in that case you won't be able to track the root cause (cascading)
  2464. $sSelWrongRecs = $sSelBase." WHERE maintable.`$sExtKeyField` IN ('".implode("', '", $aPlannedDel[$sRemoteTable])."')";
  2465. if ($oAttDef->IsNullAllowed())
  2466. {
  2467. // Exclude the records pointing to 0/null from the errors
  2468. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` IS NOT NULL";
  2469. $sSelWrongRecs .= " AND maintable.`$sExtKeyField` != 0";
  2470. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sExtKeyField, 'null', $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2471. }
  2472. else
  2473. {
  2474. self::DBCheckIntegrity_Check2Delete($sSelWrongRecs, "Record pointing to (external key '<em>$sAttCode</em>') a record planned for deletion", $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2475. }
  2476. }
  2477. }
  2478. else if ($oAttDef->IsDirectField())
  2479. {
  2480. // Check that the values fit the allowed values
  2481. //
  2482. $aAllowedValues = self::GetAllowedValues_att($sClass, $sAttCode);
  2483. if (!is_null($aAllowedValues) && count($aAllowedValues) > 0)
  2484. {
  2485. $sExpectedValues = implode(",", CMDBSource::Quote(array_keys($aAllowedValues), true));
  2486. $sMyAttributeField = current($oAttDef->GetSQLExpressions()); // get the first column for the moment
  2487. $sDefaultValue = $oAttDef->GetDefaultValue();
  2488. $sSelWrongRecs = "SELECT DISTINCT maintable.`$sKeyField` AS id FROM `$sTable` AS maintable WHERE maintable.`$sMyAttributeField` NOT IN ($sExpectedValues)";
  2489. self::DBCheckIntegrity_Check2Update($sSelWrongRecs, "Record having a column ('<em>$sAttCode</em>') with an unexpected value", $sMyAttributeField, CMDBSource::Quote($sDefaultValue), $sClass, $aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2490. }
  2491. }
  2492. }
  2493. }
  2494. }
  2495. public static function DBCheckIntegrity($sRepairUrl = "", $sSQLStatementArgName = "")
  2496. {
  2497. // Records in error, and action to be taken: delete or update
  2498. // by RootClass/Table/Record
  2499. $aErrorsAndFixes = array();
  2500. // Records to be ignored in the current/next pass
  2501. // by Table = array of RecordId
  2502. $aPlannedDel = array();
  2503. // Count of errors in the next pass: no error means that we can leave...
  2504. $iErrorCount = 0;
  2505. // Limit in case of a bug in the algorythm
  2506. $iLoopCount = 0;
  2507. $iNewDelCount = 1; // startup...
  2508. while ($iNewDelCount > 0)
  2509. {
  2510. $iNewDelCount = 0;
  2511. self::DBCheckIntegrity_SinglePass($aErrorsAndFixes, $iNewDelCount, $aPlannedDel);
  2512. $iErrorCount += $iNewDelCount;
  2513. // Safety net #1 - limit the planned deletions
  2514. //
  2515. $iMaxDel = 1000;
  2516. $iPlannedDel = 0;
  2517. foreach ($aPlannedDel as $sTable => $aPlannedDelOnTable)
  2518. {
  2519. $iPlannedDel += count($aPlannedDelOnTable);
  2520. }
  2521. if ($iPlannedDel > $iMaxDel)
  2522. {
  2523. throw new CoreWarning("DB Integrity Check safety net - Exceeding the limit of $iMaxDel planned record deletion");
  2524. break;
  2525. }
  2526. // Safety net #2 - limit the iterations
  2527. //
  2528. $iLoopCount++;
  2529. $iMaxLoops = 10;
  2530. if ($iLoopCount > $iMaxLoops)
  2531. {
  2532. throw new CoreWarning("DB Integrity Check safety net - Reached the limit of $iMaxLoops loops");
  2533. break;
  2534. }
  2535. }
  2536. // Display the results
  2537. //
  2538. $iIssueCount = 0;
  2539. $aFixesDelete = array();
  2540. $aFixesUpdate = array();
  2541. foreach ($aErrorsAndFixes as $sRootClass => $aTables)
  2542. {
  2543. foreach ($aTables as $sTable => $aRecords)
  2544. {
  2545. foreach ($aRecords as $iRecord => $aError)
  2546. {
  2547. $sAction = $aError['Action'];
  2548. $sReason = $aError['Reason'];
  2549. $iPass = $aError['Pass'];
  2550. switch ($sAction)
  2551. {
  2552. case 'Delete':
  2553. $sActionDetails = "";
  2554. $aFixesDelete[$sTable][] = $iRecord;
  2555. break;
  2556. case 'Update':
  2557. $aUpdateDesc = array();
  2558. foreach($aError['Action_Details'] as $aUpdateSpec)
  2559. {
  2560. $aUpdateDesc[] = $aUpdateSpec['column']." -&gt; ".$aUpdateSpec['newvalue'];
  2561. $aFixesUpdate[$sTable][$aUpdateSpec['column']][$aUpdateSpec['newvalue']][] = $iRecord;
  2562. }
  2563. $sActionDetails = "Set ".implode(", ", $aUpdateDesc);
  2564. break;
  2565. default:
  2566. $sActionDetails = "bug: unknown action '$sAction'";
  2567. }
  2568. $aIssues[] = "$sRootClass / $sTable / $iRecord / $sReason / $sAction / $sActionDetails";
  2569. $iIssueCount++;
  2570. }
  2571. }
  2572. }
  2573. if ($iIssueCount > 0)
  2574. {
  2575. // Build the queries to fix in the database
  2576. //
  2577. // First step, be able to get class data out of the table name
  2578. // Could be optimized, because we've made the job earlier... but few benefits, so...
  2579. $aTable2ClassProp = array();
  2580. foreach (self::GetClasses() as $sClass)
  2581. {
  2582. if (!self::HasTable($sClass)) continue;
  2583. $sRootClass = self::GetRootClass($sClass);
  2584. $sTable = self::DBGetTable($sClass);
  2585. $sKeyField = self::DBGetKey($sClass);
  2586. $aErrorsAndFixes[$sRootClass][$sTable] = array();
  2587. $aTable2ClassProp[$sTable] = array('rootclass'=>$sRootClass, 'class'=>$sClass, 'keyfield'=>$sKeyField);
  2588. }
  2589. // Second step, build a flat list of SQL queries
  2590. $aSQLFixes = array();
  2591. $iPlannedUpdate = 0;
  2592. foreach ($aFixesUpdate as $sTable => $aColumns)
  2593. {
  2594. foreach ($aColumns as $sColumn => $aNewValues)
  2595. {
  2596. foreach ($aNewValues as $sNewValue => $aRecords)
  2597. {
  2598. $iPlannedUpdate += count($aRecords);
  2599. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  2600. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  2601. $aSQLFixes[] = "UPDATE `$sTable` SET `$sColumn` = $sNewValue WHERE `$sKeyField` IN ($sWrongRecords)";
  2602. }
  2603. }
  2604. }
  2605. $iPlannedDel = 0;
  2606. foreach ($aFixesDelete as $sTable => $aRecords)
  2607. {
  2608. $iPlannedDel += count($aRecords);
  2609. $sWrongRecords = "'".implode("', '", $aRecords)."'";
  2610. $sKeyField = $aTable2ClassProp[$sTable]['keyfield'];
  2611. $aSQLFixes[] = "DELETE FROM `$sTable` WHERE `$sKeyField` IN ($sWrongRecords)";
  2612. }
  2613. // Report the results
  2614. //
  2615. echo "<div style=\"width:100%;padding:10px;background:#FFAAAA;display:;\">";
  2616. echo "<h3>Database corruption error(s): $iErrorCount issues have been encountered. $iPlannedDel records will be deleted, $iPlannedUpdate records will be updated:</h3>\n";
  2617. // #@# later -> this is the responsibility of the caller to format the output
  2618. echo "<ul class=\"treeview\">\n";
  2619. foreach ($aIssues as $sIssueDesc)
  2620. {
  2621. echo "<li>$sIssueDesc</li>\n";
  2622. }
  2623. echo "</ul>\n";
  2624. self::DBShowApplyForm($sRepairUrl, $sSQLStatementArgName, $aSQLFixes);
  2625. echo "<p>Aborting...</p>\n";
  2626. echo "</div>\n";
  2627. exit;
  2628. }
  2629. }
  2630. public static function Startup($sConfigFile, $bAllowMissingDB = false)
  2631. {
  2632. self::LoadConfig($sConfigFile);
  2633. if (self::DBExists())
  2634. {
  2635. CMDBSource::SelectDB(self::$m_sDBName);
  2636. // Some of the init could not be done earlier (requiring classes to be declared and DB to be accessible)
  2637. self::InitPlugins();
  2638. }
  2639. else
  2640. {
  2641. if (!$bAllowMissingDB)
  2642. {
  2643. throw new CoreException('Database not found, check your configuration file', array('config_file'=>$sConfigFile, 'db_name'=>self::$m_sDBName));
  2644. }
  2645. }
  2646. }
  2647. public static function LoadConfig($sConfigFile)
  2648. {
  2649. $oConfig = new Config($sConfigFile);
  2650. // Set log ASAP
  2651. if ($oConfig->GetLogGlobal())
  2652. {
  2653. if ($oConfig->GetLogIssue())
  2654. {
  2655. self::$m_bLogIssue = true;
  2656. IssueLog::Enable('../error.log');
  2657. }
  2658. self::$m_bLogNotification = $oConfig->GetLogNotification();
  2659. self::$m_bLogWebService = $oConfig->GetLogWebService();
  2660. }
  2661. else
  2662. {
  2663. self::$m_bLogIssue = false;
  2664. self::$m_bLogNotification = false;
  2665. self::$m_bLogWebService = false;
  2666. }
  2667. // Note: load the dictionary as soon as possible, because it might be
  2668. // needed when some error occur
  2669. foreach ($oConfig->GetDictionaries() as $sModule => $sToInclude)
  2670. {
  2671. self::Plugin($sConfigFile, 'dictionaries', $sToInclude);
  2672. }
  2673. // Set the language... after the dictionaries have been loaded!
  2674. Dict::SetDefaultLanguage($oConfig->GetDefaultLanguage());
  2675. foreach ($oConfig->GetAppModules() as $sModule => $sToInclude)
  2676. {
  2677. self::Plugin($sConfigFile, 'application', $sToInclude);
  2678. }
  2679. foreach ($oConfig->GetDataModels() as $sModule => $sToInclude)
  2680. {
  2681. self::Plugin($sConfigFile, 'business', $sToInclude);
  2682. }
  2683. foreach ($oConfig->GetAddons() as $sModule => $sToInclude)
  2684. {
  2685. self::Plugin($sConfigFile, 'addons', $sToInclude);
  2686. }
  2687. $sServer = $oConfig->GetDBHost();
  2688. $sUser = $oConfig->GetDBUser();
  2689. $sPwd = $oConfig->GetDBPwd();
  2690. $sSource = $oConfig->GetDBName();
  2691. $sTablePrefix = $oConfig->GetDBSubname();
  2692. // The include have been included, let's browse the existing classes and
  2693. // develop some data based on the proposed model
  2694. self::InitClasses($sTablePrefix);
  2695. self::$m_sDBName = $sSource;
  2696. self::$m_sTablePrefix = $sTablePrefix;
  2697. CMDBSource::Init($sServer, $sUser, $sPwd); // do not select the DB (could not exist)
  2698. }
  2699. protected static $m_aPlugins = array();
  2700. public static function RegisterPlugin($sType, $sName, $aInitCallSpec = array())
  2701. {
  2702. self::$m_aPlugins[$sName] = array(
  2703. 'type' => $sType,
  2704. 'init' => $aInitCallSpec,
  2705. );
  2706. }
  2707. protected static function Plugin($sConfigFile, $sModuleType, $sToInclude)
  2708. {
  2709. if (!file_exists($sToInclude))
  2710. {
  2711. throw new CoreException('Wrong filename in configuration file', array('file' => $sConfigFile, 'module' => $sModuleType, 'filename' => $sToInclude));
  2712. }
  2713. require_once($sToInclude);
  2714. }
  2715. protected static function InitPlugins()
  2716. {
  2717. foreach(self::$m_aPlugins as $sName => $aData)
  2718. {
  2719. $aCallSpec = @$aData['init'];
  2720. if (count($aCallSpec) == 2)
  2721. {
  2722. if (!is_callable($aCallSpec))
  2723. {
  2724. throw new CoreException('Wrong declaration in plugin', array('plugin' => $aData['name'], 'type' => $aData['type'], 'class' => $aData['class'], 'init' => $aData['init']));
  2725. }
  2726. call_user_func($aCallSpec);
  2727. }
  2728. }
  2729. }
  2730. // Building an object
  2731. //
  2732. //
  2733. private static $aQueryCacheGetObject = array();
  2734. private static $aQueryCacheGetObjectHits = array();
  2735. public static function GetQueryCacheStatus()
  2736. {
  2737. $aRes = array();
  2738. $iTotalHits = 0;
  2739. foreach(self::$aQueryCacheGetObjectHits as $sClass => $iHits)
  2740. {
  2741. $aRes[] = "$sClass: $iHits";
  2742. $iTotalHits += $iHits;
  2743. }
  2744. return $iTotalHits.' ('.implode(', ', $aRes).')';
  2745. }
  2746. public static function MakeSingleRow($sClass, $iKey, $bMustBeFound = true)
  2747. {
  2748. if (!array_key_exists($sClass, self::$aQueryCacheGetObject))
  2749. {
  2750. // NOTE: Quick and VERY dirty caching mechanism which relies on
  2751. // the fact that the string '987654321' will never appear in the
  2752. // standard query
  2753. // This will be replaced for sure with a prepared statement
  2754. // or a view... next optimization to come!
  2755. $oFilter = new DBObjectSearch($sClass);
  2756. $oFilter->AddCondition('id', 987654321, '=');
  2757. $sSQL = self::MakeSelectQuery($oFilter);
  2758. self::$aQueryCacheGetObject[$sClass] = $sSQL;
  2759. self::$aQueryCacheGetObjectHits[$sClass] = 0;
  2760. }
  2761. else
  2762. {
  2763. $sSQL = self::$aQueryCacheGetObject[$sClass];
  2764. self::$aQueryCacheGetObjectHits[$sClass] += 1;
  2765. // echo " -load $sClass/$iKey- ".self::$aQueryCacheGetObjectHits[$sClass]."<br/>\n";
  2766. }
  2767. $sSQL = str_replace('987654321', CMDBSource::Quote($iKey), $sSQL);
  2768. $res = CMDBSource::Query($sSQL);
  2769. $aRow = CMDBSource::FetchArray($res);
  2770. CMDBSource::FreeResult($res);
  2771. if ($bMustBeFound && empty($aRow))
  2772. {
  2773. throw new CoreException("No result for the single row query: '$sSQL'");
  2774. }
  2775. return $aRow;
  2776. }
  2777. public static function GetObjectByRow($sClass, $aRow, $sClassAlias = '')
  2778. {
  2779. self::_check_subclass($sClass);
  2780. if (strlen($sClassAlias) == 0)
  2781. {
  2782. $sClassAlias = $sClass;
  2783. }
  2784. // Compound objects: if available, get the final object class
  2785. //
  2786. if (!array_key_exists($sClassAlias."finalclass", $aRow))
  2787. {
  2788. // Either this is a bug (forgot to specify a root class with a finalclass field
  2789. // Or this is the expected behavior, because the object is not made of several tables
  2790. }
  2791. elseif (empty($aRow[$sClassAlias."finalclass"]))
  2792. {
  2793. // The data is missing in the DB
  2794. // @#@ possible improvement: check that the class is valid !
  2795. $sRootClass = self::GetRootClass($sClass);
  2796. $sFinalClassField = self::DBGetClassField($sRootClass);
  2797. throw new CoreException("Empty class name for object $sClass::{$aRow["id"]} (root class '$sRootClass', field '{$sFinalClassField}' is empty)");
  2798. }
  2799. else
  2800. {
  2801. // do the job for the real target class
  2802. $sClass = $aRow[$sClassAlias."finalclass"];
  2803. }
  2804. return new $sClass($aRow, $sClassAlias);
  2805. }
  2806. public static function GetObject($sClass, $iKey, $bMustBeFound = true)
  2807. {
  2808. self::_check_subclass($sClass);
  2809. $aRow = self::MakeSingleRow($sClass, $iKey, $bMustBeFound);
  2810. if (empty($aRow))
  2811. {
  2812. return null;
  2813. }
  2814. return self::GetObjectByRow($sClass, $aRow);
  2815. }
  2816. public static function GetHyperLink($sTargetClass, $iKey)
  2817. {
  2818. if ($iKey < 0)
  2819. {
  2820. return "$sTargetClass: $iKey (invalid value)";
  2821. }
  2822. $oObj = self::GetObject($sTargetClass, $iKey, false);
  2823. if (is_null($oObj))
  2824. {
  2825. return "$sTargetClass: $iKey (not found)";
  2826. }
  2827. return $oObj->GetHyperLink();
  2828. }
  2829. public static function NewObject($sClass)
  2830. {
  2831. self::_check_subclass($sClass);
  2832. return new $sClass();
  2833. }
  2834. public static function GetNextKey($sClass)
  2835. {
  2836. $sRootClass = MetaModel::GetRootClass($sClass);
  2837. $sRootTable = MetaModel::DBGetTable($sRootClass);
  2838. $iNextKey = CMDBSource::GetNextInsertId($sRootTable);
  2839. return $iNextKey;
  2840. }
  2841. public static function BulkDelete(DBObjectSearch $oFilter)
  2842. {
  2843. $sSQL = self::MakeDeleteQuery($oFilter);
  2844. CMDBSource::Query($sSQL);
  2845. }
  2846. public static function BulkUpdate(DBObjectSearch $oFilter, array $aValues)
  2847. {
  2848. // $aValues is an array of $sAttCode => $value
  2849. $sSQL = self::MakeUpdateQuery($oFilter, $aValues);
  2850. CMDBSource::Query($sSQL);
  2851. }
  2852. // Links
  2853. //
  2854. //
  2855. public static function EnumReferencedClasses($sClass)
  2856. {
  2857. self::_check_subclass($sClass);
  2858. // 1-N links (referenced by my class), returns an array of sAttCode=>sClass
  2859. $aResult = array();
  2860. foreach(self::$m_aAttribDefs[$sClass] as $sAttCode=>$oAttDef)
  2861. {
  2862. if ($oAttDef->IsExternalKey())
  2863. {
  2864. $aResult[$sAttCode] = $oAttDef->GetTargetClass();
  2865. }
  2866. }
  2867. return $aResult;
  2868. }
  2869. public static function EnumReferencingClasses($sClass, $bSkipLinkingClasses = false, $bInnerJoinsOnly = false)
  2870. {
  2871. self::_check_subclass($sClass);
  2872. if ($bSkipLinkingClasses)
  2873. {
  2874. $aLinksClasses = self::EnumLinksClasses();
  2875. }
  2876. // 1-N links (referencing my class), array of sClass => array of sAttcode
  2877. $aResult = array();
  2878. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  2879. {
  2880. if ($bSkipLinkingClasses && in_array($sSomeClass, $aLinksClasses)) continue;
  2881. $aExtKeys = array();
  2882. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  2883. {
  2884. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  2885. if ($oAttDef->IsExternalKey() && (self::IsParentClass($oAttDef->GetTargetClass(), $sClass)))
  2886. {
  2887. if ($bInnerJoinsOnly && $oAttDef->IsNullAllowed()) continue;
  2888. // Ok, I want this one
  2889. $aExtKeys[$sAttCode] = $oAttDef;
  2890. }
  2891. }
  2892. if (count($aExtKeys) != 0)
  2893. {
  2894. $aResult[$sSomeClass] = $aExtKeys;
  2895. }
  2896. }
  2897. return $aResult;
  2898. }
  2899. public static function EnumLinksClasses()
  2900. {
  2901. // Returns a flat array of classes having at least two external keys
  2902. $aResult = array();
  2903. foreach (self::$m_aAttribDefs as $sSomeClass=>$aClassAttributes)
  2904. {
  2905. $iExtKeyCount = 0;
  2906. foreach ($aClassAttributes as $sAttCode=>$oAttDef)
  2907. {
  2908. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  2909. if ($oAttDef->IsExternalKey())
  2910. {
  2911. $iExtKeyCount++;
  2912. }
  2913. }
  2914. if ($iExtKeyCount >= 2)
  2915. {
  2916. $aResult[] = $sSomeClass;
  2917. }
  2918. }
  2919. return $aResult;
  2920. }
  2921. public static function EnumLinkingClasses($sClass = "")
  2922. {
  2923. // N-N links, array of sLinkClass => (array of sAttCode=>sClass)
  2924. $aResult = array();
  2925. foreach (self::EnumLinksClasses() as $sSomeClass)
  2926. {
  2927. $aTargets = array();
  2928. $bFoundClass = false;
  2929. foreach (self::ListAttributeDefs($sSomeClass) as $sAttCode=>$oAttDef)
  2930. {
  2931. if (self::$m_aAttribOrigins[$sSomeClass][$sAttCode] != $sSomeClass) continue;
  2932. if ($oAttDef->IsExternalKey())
  2933. {
  2934. $sRemoteClass = $oAttDef->GetTargetClass();
  2935. if (empty($sClass))
  2936. {
  2937. $aTargets[$sAttCode] = $sRemoteClass;
  2938. }
  2939. elseif ($sClass == $sRemoteClass)
  2940. {
  2941. $bFoundClass = true;
  2942. }
  2943. else
  2944. {
  2945. $aTargets[$sAttCode] = $sRemoteClass;
  2946. }
  2947. }
  2948. }
  2949. if (empty($sClass) || $bFoundClass)
  2950. {
  2951. $aResult[$sSomeClass] = $aTargets;
  2952. }
  2953. }
  2954. return $aResult;
  2955. }
  2956. public static function GetLinkLabel($sLinkClass, $sAttCode)
  2957. {
  2958. self::_check_subclass($sLinkClass);
  2959. // e.g. "supported by" (later: $this->GetLinkLabel(), computed on link data!)
  2960. return self::GetLabel($sLinkClass, $sAttCode);
  2961. }
  2962. /**
  2963. * Replaces all the parameters by the values passed in the hash array
  2964. */
  2965. static public function ApplyParams($aInput, $aParams)
  2966. {
  2967. $aSearches = array();
  2968. $aReplacements = array();
  2969. foreach($aParams as $sSearch => $sReplace)
  2970. {
  2971. $aSearches[] = '$'.$sSearch.'$';
  2972. $aReplacements[] = $sReplace;
  2973. }
  2974. return str_replace($aSearches, $aReplacements, $aInput);
  2975. }
  2976. } // class MetaModel
  2977. // Standard attribute lists
  2978. MetaModel::RegisterZList("noneditable", array("description"=>"non editable fields", "type"=>"attributes"));
  2979. MetaModel::RegisterZList("details", array("description"=>"All attributes to be displayed for the 'details' of an object", "type"=>"attributes"));
  2980. MetaModel::RegisterZList("list", array("description"=>"All attributes to be displayed for a list of objects", "type"=>"attributes"));
  2981. MetaModel::RegisterZList("preview", array("description"=>"All attributes visible in preview mode", "type"=>"attributes"));
  2982. MetaModel::RegisterZList("standard_search", array("description"=>"List of criteria for the standard search", "type"=>"filters"));
  2983. MetaModel::RegisterZList("advanced_search", array("description"=>"List of criteria for the advanced search", "type"=>"filters"));
  2984. ?>