metamodel.class.php 108 KB

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