dbobjectsearch.class.php 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005
  1. <?php
  2. // Copyright (C) 2010-2016 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * Define filters for a given class of objects (formerly named "filter")
  20. *
  21. * @copyright Copyright (C) 2010-2016 Combodo SARL
  22. * @license http://opensource.org/licenses/AGPL-3.0
  23. */
  24. // Dev hack for disabling the some query build optimizations (Folding/Merging)
  25. define('ENABLE_OPT', true);
  26. class DBObjectSearch extends DBSearch
  27. {
  28. private $m_aClasses; // queried classes (alias => class name), the first item is the class corresponding to this filter (the rest is coming from subfilters)
  29. private $m_aSelectedClasses; // selected for the output (alias => class name)
  30. private $m_oSearchCondition;
  31. private $m_aParams;
  32. private $m_aFullText;
  33. private $m_aPointingTo;
  34. private $m_aReferencedBy;
  35. // By default, some information may be hidden to the current user
  36. // But it may happen that we need to disable that feature
  37. protected $m_bAllowAllData = false;
  38. protected $m_bDataFiltered = false;
  39. public function __construct($sClass, $sClassAlias = null)
  40. {
  41. parent::__construct();
  42. if (is_null($sClassAlias)) $sClassAlias = $sClass;
  43. if(!is_string($sClass)) throw new Exception('DBObjectSearch::__construct called with a non-string parameter: $sClass = '.print_r($sClass, true));
  44. if(!MetaModel::IsValidClass($sClass)) throw new Exception('DBObjectSearch::__construct called for an invalid class: "'.$sClass.'"');
  45. $this->m_aSelectedClasses = array($sClassAlias => $sClass);
  46. $this->m_aClasses = array($sClassAlias => $sClass);
  47. $this->m_oSearchCondition = new TrueExpression;
  48. $this->m_aParams = array();
  49. $this->m_aFullText = array();
  50. $this->m_aPointingTo = array();
  51. $this->m_aReferencedBy = array();
  52. }
  53. public function AllowAllData($bAllowAllData = true) {$this->m_bAllowAllData = $bAllowAllData;}
  54. public function IsAllDataAllowed() {return $this->m_bAllowAllData;}
  55. protected function IsDataFiltered() {return $this->m_bDataFiltered; }
  56. protected function SetDataFiltered() {$this->m_bDataFiltered = true;}
  57. // Create a search definition that leads to 0 result, still a valid search object
  58. static public function FromEmptySet($sClass)
  59. {
  60. $oResultFilter = new DBObjectSearch($sClass);
  61. $oResultFilter->m_oSearchCondition = new FalseExpression;
  62. return $oResultFilter;
  63. }
  64. public function GetJoinedClasses() {return $this->m_aClasses;}
  65. public function GetClassName($sAlias)
  66. {
  67. if (array_key_exists($sAlias, $this->m_aSelectedClasses))
  68. {
  69. return $this->m_aSelectedClasses[$sAlias];
  70. }
  71. else
  72. {
  73. throw new CoreException("Invalid class alias '$sAlias'");
  74. }
  75. }
  76. public function GetClass()
  77. {
  78. return reset($this->m_aSelectedClasses);
  79. }
  80. public function GetClassAlias()
  81. {
  82. reset($this->m_aSelectedClasses);
  83. return key($this->m_aSelectedClasses);
  84. }
  85. public function GetFirstJoinedClass()
  86. {
  87. return reset($this->m_aClasses);
  88. }
  89. public function GetFirstJoinedClassAlias()
  90. {
  91. reset($this->m_aClasses);
  92. return key($this->m_aClasses);
  93. }
  94. /**
  95. * Change the class (only subclasses are supported as of now, because the conditions must fit the new class)
  96. * Defaults to the first selected class (most of the time it is also the first joined class
  97. */
  98. public function ChangeClass($sNewClass, $sAlias = null)
  99. {
  100. if (is_null($sAlias))
  101. {
  102. $sAlias = $this->GetClassAlias();
  103. }
  104. else
  105. {
  106. if (!array_key_exists($sAlias, $this->m_aSelectedClasses))
  107. {
  108. // discard silently - necessary when recursing on the related nodes (see code below)
  109. return;
  110. }
  111. }
  112. $sCurrClass = $this->GetClassName($sAlias);
  113. if ($sNewClass == $sCurrClass)
  114. {
  115. // Skip silently
  116. return;
  117. }
  118. if (!MetaModel::IsParentClass($sCurrClass, $sNewClass))
  119. {
  120. throw new Exception("Could not change the search class from '$sCurrClass' to '$sNewClass'. Only child classes are permitted.");
  121. }
  122. // Change for this node
  123. //
  124. $this->m_aSelectedClasses[$sAlias] = $sNewClass;
  125. $this->m_aClasses[$sAlias] = $sNewClass;
  126. // Change for all the related node (yes, this was necessary with some queries - strange effects otherwise)
  127. //
  128. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  129. {
  130. foreach($aPointingTo as $iOperatorCode => $aFilter)
  131. {
  132. foreach($aFilter as $oExtFilter)
  133. {
  134. $oExtFilter->ChangeClass($sNewClass, $sAlias);
  135. }
  136. }
  137. }
  138. foreach($this->m_aReferencedBy as $sForeignClass => $aReferences)
  139. {
  140. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  141. {
  142. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  143. {
  144. foreach ($aFilters as $oForeignFilter)
  145. {
  146. $oForeignFilter->ChangeClass($sNewClass, $sAlias);
  147. }
  148. }
  149. }
  150. }
  151. }
  152. public function GetSelectedClasses()
  153. {
  154. return $this->m_aSelectedClasses;
  155. }
  156. /**
  157. * @param array $aSelectedClasses array of aliases
  158. * @throws CoreException
  159. */
  160. public function SetSelectedClasses($aSelectedClasses)
  161. {
  162. $this->m_aSelectedClasses = array();
  163. foreach ($aSelectedClasses as $sAlias)
  164. {
  165. if (!array_key_exists($sAlias, $this->m_aClasses))
  166. {
  167. throw new CoreException("SetSelectedClasses: Invalid class alias $sAlias");
  168. }
  169. $this->m_aSelectedClasses[$sAlias] = $this->m_aClasses[$sAlias];
  170. }
  171. }
  172. /**
  173. * Change any alias of the query tree
  174. *
  175. * @param $sOldName
  176. * @param $sNewName
  177. * @return bool True if the alias has been found and changed
  178. */
  179. public function RenameAlias($sOldName, $sNewName)
  180. {
  181. $bFound = false;
  182. if (array_key_exists($sOldName, $this->m_aClasses))
  183. {
  184. $bFound = true;
  185. }
  186. if (array_key_exists($sNewName, $this->m_aClasses))
  187. {
  188. throw new Exception("RenameAlias: alias '$sNewName' already used");
  189. }
  190. $aClasses = array();
  191. foreach ($this->m_aClasses as $sAlias => $sClass)
  192. {
  193. if ($sAlias === $sOldName)
  194. {
  195. $aClasses[$sNewName] = $sClass;
  196. }
  197. else
  198. {
  199. $aClasses[$sAlias] = $sClass;
  200. }
  201. }
  202. $this->m_aClasses = $aClasses;
  203. $aSelectedClasses = array();
  204. foreach ($this->m_aSelectedClasses as $sAlias => $sClass)
  205. {
  206. if ($sAlias === $sOldName)
  207. {
  208. $aSelectedClasses[$sNewName] = $sClass;
  209. }
  210. else
  211. {
  212. $aSelectedClasses[$sAlias] = $sClass;
  213. }
  214. }
  215. $this->m_aSelectedClasses = $aSelectedClasses;
  216. $this->m_oSearchCondition->RenameAlias($sOldName, $sNewName);
  217. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  218. {
  219. foreach($aPointingTo as $iOperatorCode => $aFilter)
  220. {
  221. foreach($aFilter as $oExtFilter)
  222. {
  223. $bFound = $oExtFilter->RenameAlias($sOldName, $sNewName) || $bFound;
  224. }
  225. }
  226. }
  227. foreach($this->m_aReferencedBy as $sForeignClass => $aReferences)
  228. {
  229. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  230. {
  231. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  232. {
  233. foreach ($aFilters as $oForeignFilter)
  234. {
  235. $bFound = $oForeignFilter->RenameAlias($sOldName, $sNewName) || $bFound;
  236. }
  237. }
  238. }
  239. }
  240. return $bFound;
  241. }
  242. public function SetModifierProperty($sPluginClass, $sProperty, $value)
  243. {
  244. $this->m_aModifierProperties[$sPluginClass][$sProperty] = $value;
  245. }
  246. public function GetModifierProperties($sPluginClass)
  247. {
  248. if (array_key_exists($sPluginClass, $this->m_aModifierProperties))
  249. {
  250. return $this->m_aModifierProperties[$sPluginClass];
  251. }
  252. else
  253. {
  254. return array();
  255. }
  256. }
  257. public function IsAny()
  258. {
  259. if (!$this->m_oSearchCondition->IsTrue()) return false;
  260. if (count($this->m_aFullText) > 0) return false;
  261. if (count($this->m_aPointingTo) > 0) return false;
  262. if (count($this->m_aReferencedBy) > 0) return false;
  263. return true;
  264. }
  265. protected function TransferConditionExpression($oFilter, $aTranslation)
  266. {
  267. // Prevent collisions in the parameter names by renaming them if needed
  268. foreach($this->m_aParams as $sParam => $value)
  269. {
  270. if (array_key_exists($sParam, $oFilter->m_aParams) && ($value != $oFilter->m_aParams[$sParam]))
  271. {
  272. // Generate a new and unique name for the collinding parameter
  273. $index = 1;
  274. while(array_key_exists($sParam.$index, $oFilter->m_aParams))
  275. {
  276. $index++;
  277. }
  278. $secondValue = $oFilter->m_aParams[$sParam];
  279. $oFilter->RenameParam($sParam, $sParam.$index);
  280. unset($oFilter->m_aParams[$sParam]);
  281. $oFilter->m_aParams[$sParam.$index] = $secondValue;
  282. }
  283. }
  284. $oTranslated = $oFilter->GetCriteria()->Translate($aTranslation, false, false /* leave unresolved fields */);
  285. $this->AddConditionExpression($oTranslated);
  286. $this->m_aParams = array_merge($this->m_aParams, $oFilter->m_aParams);
  287. }
  288. protected function RenameParam($sOldName, $sNewName)
  289. {
  290. $this->m_oSearchCondition->RenameParam($sOldName, $sNewName);
  291. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  292. {
  293. foreach($aPointingTo as $iOperatorCode => $aFilter)
  294. {
  295. foreach($aFilter as $oExtFilter)
  296. {
  297. $oExtFilter->RenameParam($sOldName, $sNewName);
  298. }
  299. }
  300. }
  301. foreach($this->m_aReferencedBy as $sForeignClass => $aReferences)
  302. {
  303. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  304. {
  305. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  306. {
  307. foreach ($aFilters as $oForeignFilter)
  308. {
  309. $oForeignFilter->RenameParam($sOldName, $sNewName);
  310. }
  311. }
  312. }
  313. }
  314. }
  315. public function ResetCondition()
  316. {
  317. $this->m_oSearchCondition = new TrueExpression();
  318. // ? is that usefull/enough, do I need to rebuild the list after the subqueries ?
  319. }
  320. public function MergeConditionExpression($oExpression)
  321. {
  322. $this->m_oSearchCondition = $this->m_oSearchCondition->LogOr($oExpression);
  323. }
  324. public function AddConditionExpression($oExpression)
  325. {
  326. $this->m_oSearchCondition = $this->m_oSearchCondition->LogAnd($oExpression);
  327. }
  328. public function AddNameCondition($sName)
  329. {
  330. $oValueExpr = new ScalarExpression($sName);
  331. $oNameExpr = new FieldExpression('friendlyname', $this->GetClassAlias());
  332. $oNewCondition = new BinaryExpression($oNameExpr, '=', $oValueExpr);
  333. $this->AddConditionExpression($oNewCondition);
  334. }
  335. public function AddCondition($sFilterCode, $value, $sOpCode = null, $bParseSeachString = false)
  336. {
  337. MyHelpers::CheckKeyInArray('filter code in class: '.$this->GetClass(), $sFilterCode, MetaModel::GetClassFilterDefs($this->GetClass()));
  338. $oFilterDef = MetaModel::GetClassFilterDef($this->GetClass(), $sFilterCode);
  339. $oField = new FieldExpression($sFilterCode, $this->GetClassAlias());
  340. if (empty($sOpCode))
  341. {
  342. if ($sFilterCode == 'id')
  343. {
  344. $sOpCode = '=';
  345. }
  346. else
  347. {
  348. $oAttDef = MetaModel::GetAttributeDef($this->GetClass(), $sFilterCode);
  349. $oNewCondition = $oAttDef->GetSmartConditionExpression($value, $oField, $this->m_aParams, $bParseSeachString);
  350. $this->AddConditionExpression($oNewCondition);
  351. return;
  352. }
  353. }
  354. MyHelpers::CheckKeyInArray('operator', $sOpCode, $oFilterDef->GetOperators());
  355. // Parse search strings if needed and if the filter code corresponds to a valid attcode
  356. if($bParseSeachString && MetaModel::IsValidAttCode($this->GetClass(), $sFilterCode))
  357. {
  358. $oAttDef = MetaModel::GetAttributeDef($sClass, $sFilterCode);
  359. $value = $oAttDef->ParseSearchString($value);
  360. }
  361. // Preserve backward compatibility - quick n'dirty way to change that API semantic
  362. //
  363. switch($sOpCode)
  364. {
  365. case 'SameDay':
  366. case 'SameMonth':
  367. case 'SameYear':
  368. case 'Today':
  369. case '>|':
  370. case '<|':
  371. case '=|':
  372. throw new CoreException('Deprecated operator, please consider using OQL (SQL) expressions like "(TO_DAYS(NOW()) - TO_DAYS(x)) AS AgeDays"', array('operator' => $sOpCode));
  373. break;
  374. case "IN":
  375. if (!is_array($value)) $value = array($value);
  376. $sListExpr = '('.implode(', ', CMDBSource::Quote($value)).')';
  377. $sOQLCondition = $oField->Render()." IN $sListExpr";
  378. break;
  379. case "NOTIN":
  380. if (!is_array($value)) $value = array($value);
  381. $sListExpr = '('.implode(', ', CMDBSource::Quote($value)).')';
  382. $sOQLCondition = $oField->Render()." NOT IN $sListExpr";
  383. break;
  384. case 'Contains':
  385. $this->m_aParams[$sFilterCode] = "%$value%";
  386. $sOperator = 'LIKE';
  387. break;
  388. case 'Begins with':
  389. $this->m_aParams[$sFilterCode] = "$value%";
  390. $sOperator = 'LIKE';
  391. break;
  392. case 'Finishes with':
  393. $this->m_aParams[$sFilterCode] = "%$value";
  394. $sOperator = 'LIKE';
  395. break;
  396. default:
  397. $this->m_aParams[$sFilterCode] = $value;
  398. $sOperator = $sOpCode;
  399. }
  400. switch($sOpCode)
  401. {
  402. case "IN":
  403. case "NOTIN":
  404. $oNewCondition = Expression::FromOQL($sOQLCondition);
  405. break;
  406. case 'Contains':
  407. case 'Begins with':
  408. case 'Finishes with':
  409. default:
  410. $oRightExpr = new VariableExpression($sFilterCode);
  411. $oNewCondition = new BinaryExpression($oField, $sOperator, $oRightExpr);
  412. }
  413. $this->AddConditionExpression($oNewCondition);
  414. }
  415. /**
  416. * Specify a condition on external keys or link sets
  417. * @param sAttSpec Can be either an attribute code or extkey->[sAttSpec] or linkset->[sAttSpec] and so on, recursively
  418. * Example: infra_list->ci_id->location_id->country
  419. * @param value The value to match (can be an array => IN(val1, val2...)
  420. * @return void
  421. */
  422. public function AddConditionAdvanced($sAttSpec, $value)
  423. {
  424. $sClass = $this->GetClass();
  425. $iPos = strpos($sAttSpec, '->');
  426. if ($iPos !== false)
  427. {
  428. $sAttCode = substr($sAttSpec, 0, $iPos);
  429. $sSubSpec = substr($sAttSpec, $iPos + 2);
  430. if (!MetaModel::IsValidAttCode($sClass, $sAttCode))
  431. {
  432. throw new Exception("Invalid attribute code '$sClass/$sAttCode' in condition specification '$sAttSpec'");
  433. }
  434. $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
  435. if ($oAttDef->IsLinkSet())
  436. {
  437. $sTargetClass = $oAttDef->GetLinkedClass();
  438. $sExtKeyToMe = $oAttDef->GetExtKeyToMe();
  439. $oNewFilter = new DBObjectSearch($sTargetClass);
  440. $oNewFilter->AddConditionAdvanced($sSubSpec, $value);
  441. $this->AddCondition_ReferencedBy($oNewFilter, $sExtKeyToMe);
  442. }
  443. elseif ($oAttDef->IsExternalKey(EXTKEY_ABSOLUTE))
  444. {
  445. $sTargetClass = $oAttDef->GetTargetClass(EXTKEY_ABSOLUTE);
  446. $oNewFilter = new DBObjectSearch($sTargetClass);
  447. $oNewFilter->AddConditionAdvanced($sSubSpec, $value);
  448. $this->AddCondition_PointingTo($oNewFilter, $sAttCode);
  449. }
  450. else
  451. {
  452. throw new Exception("Attribute specification '$sAttSpec', '$sAttCode' should be either a link set or an external key");
  453. }
  454. }
  455. else
  456. {
  457. // $sAttSpec is an attribute code
  458. //
  459. if (is_array($value))
  460. {
  461. $oField = new FieldExpression($sAttSpec, $this->GetClass());
  462. $oListExpr = ListExpression::FromScalars($value);
  463. $oInValues = new BinaryExpression($oField, 'IN', $oListExpr);
  464. $this->AddConditionExpression($oInValues);
  465. }
  466. else
  467. {
  468. $this->AddCondition($sAttSpec, $value);
  469. }
  470. }
  471. }
  472. public function AddCondition_FullText($sFullText)
  473. {
  474. $this->m_aFullText[] = $sFullText;
  475. }
  476. protected function AddToNameSpace(&$aClassAliases, &$aAliasTranslation, $bTranslateMainAlias = true)
  477. {
  478. if ($bTranslateMainAlias)
  479. {
  480. $sOrigAlias = $this->GetFirstJoinedClassAlias();
  481. if (array_key_exists($sOrigAlias, $aClassAliases))
  482. {
  483. $sNewAlias = MetaModel::GenerateUniqueAlias($aClassAliases, $sOrigAlias, $this->GetFirstJoinedClass());
  484. if (isset($this->m_aSelectedClasses[$sOrigAlias]))
  485. {
  486. $this->m_aSelectedClasses[$sNewAlias] = $this->GetFirstJoinedClass();
  487. unset($this->m_aSelectedClasses[$sOrigAlias]);
  488. }
  489. // TEMPORARY ALGORITHM (m_aClasses is not correctly updated, it is not possible to add a subtree onto a subnode)
  490. // Replace the element at the same position (unset + set is not enough because the hash array is ordered)
  491. $aPrevList = $this->m_aClasses;
  492. $this->m_aClasses = array();
  493. foreach ($aPrevList as $sSomeAlias => $sSomeClass)
  494. {
  495. if ($sSomeAlias == $sOrigAlias)
  496. {
  497. $this->m_aClasses[$sNewAlias] = $sSomeClass; // note: GetFirstJoinedClass now returns '' !!!
  498. }
  499. else
  500. {
  501. $this->m_aClasses[$sSomeAlias] = $sSomeClass;
  502. }
  503. }
  504. // Translate the condition expression with the new alias
  505. $aAliasTranslation[$sOrigAlias]['*'] = $sNewAlias;
  506. }
  507. // add the alias into the filter aliases list
  508. $aClassAliases[$this->GetFirstJoinedClassAlias()] = $this->GetFirstJoinedClass();
  509. }
  510. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  511. {
  512. foreach($aPointingTo as $iOperatorCode => $aFilter)
  513. {
  514. foreach($aFilter as $oFilter)
  515. {
  516. $oFilter->AddToNameSpace($aClassAliases, $aAliasTranslation);
  517. }
  518. }
  519. }
  520. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  521. {
  522. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  523. {
  524. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  525. {
  526. foreach ($aFilters as $oForeignFilter)
  527. {
  528. $oForeignFilter->AddToNameSpace($aClassAliases, $aAliasTranslation);
  529. }
  530. }
  531. }
  532. }
  533. }
  534. // Browse the tree nodes recursively
  535. //
  536. protected function GetNode($sAlias)
  537. {
  538. if ($this->GetFirstJoinedClassAlias() == $sAlias)
  539. {
  540. return $this;
  541. }
  542. else
  543. {
  544. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  545. {
  546. foreach($aPointingTo as $iOperatorCode => $aFilter)
  547. {
  548. foreach($aFilter as $oFilter)
  549. {
  550. $ret = $oFilter->GetNode($sAlias);
  551. if (is_object($ret))
  552. {
  553. return $ret;
  554. }
  555. }
  556. }
  557. }
  558. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  559. {
  560. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  561. {
  562. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  563. {
  564. foreach ($aFilters as $oForeignFilter)
  565. {
  566. $ret = $oForeignFilter->GetNode($sAlias);
  567. if (is_object($ret))
  568. {
  569. return $ret;
  570. }
  571. }
  572. }
  573. }
  574. }
  575. }
  576. // Not found
  577. return null;
  578. }
  579. /**
  580. * Helper to
  581. * - convert a translation table (format optimized for the translation in an expression tree) into simple hash
  582. * - compile over an eventually existing map
  583. *
  584. * @param $aRealiasingMap Map to update
  585. * @param $aAliasTranslation Translation table resulting from calls to MergeWith_InNamespace
  586. * @return array of <old-alias> => <new-alias>
  587. */
  588. protected function UpdateRealiasingMap(&$aRealiasingMap, $aAliasTranslation)
  589. {
  590. if ($aRealiasingMap !== null)
  591. {
  592. foreach ($aAliasTranslation as $sPrevAlias => $aRules)
  593. {
  594. if (isset($aRules['*']))
  595. {
  596. $sNewAlias = $aRules['*'];
  597. $sOriginalAlias = array_search($sPrevAlias, $aRealiasingMap);
  598. if ($sOriginalAlias !== false)
  599. {
  600. $aRealiasingMap[$sOriginalAlias] = $sNewAlias;
  601. }
  602. else
  603. {
  604. $aRealiasingMap[$sPrevAlias] = $sNewAlias;
  605. }
  606. }
  607. }
  608. }
  609. }
  610. /**
  611. * Completes the list of alias=>class by browsing the whole structure recursively
  612. * This a workaround to handle some cases in which the list of classes is not correctly updated.
  613. * This code should disappear as soon as DBObjectSearch get split between a container search class and a Node class
  614. *
  615. * @param $aClasses List to be completed
  616. */
  617. protected function RecomputeClassList(&$aClasses)
  618. {
  619. $aClasses[$this->GetFirstJoinedClassAlias()] = $this->GetFirstJoinedClass();
  620. // Recurse in the query tree
  621. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  622. {
  623. foreach($aPointingTo as $iOperatorCode => $aFilter)
  624. {
  625. foreach($aFilter as $oFilter)
  626. {
  627. $oFilter->RecomputeClassList($aClasses);
  628. }
  629. }
  630. }
  631. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  632. {
  633. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  634. {
  635. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  636. {
  637. foreach ($aFilters as $oForeignFilter)
  638. {
  639. $oForeignFilter->RecomputeClassList($aClasses);
  640. }
  641. }
  642. }
  643. }
  644. }
  645. /**
  646. * @param DBObjectSearch $oFilter
  647. * @param $sExtKeyAttCode
  648. * @param int $iOperatorCode
  649. * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
  650. * @throws CoreException
  651. * @throws CoreWarning
  652. */
  653. public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
  654. {
  655. if (!MetaModel::IsValidKeyAttCode($this->GetClass(), $sExtKeyAttCode))
  656. {
  657. throw new CoreWarning("The attribute code '$sExtKeyAttCode' is not an external key of the class '{$this->GetClass()}'");
  658. }
  659. $oAttExtKey = MetaModel::GetAttributeDef($this->GetClass(), $sExtKeyAttCode);
  660. if(!MetaModel::IsSameFamilyBranch($oFilter->GetClass(), $oAttExtKey->GetTargetClass()))
  661. {
  662. throw new CoreException("The specified filter (pointing to {$oFilter->GetClass()}) is not compatible with the key '{$this->GetClass()}::$sExtKeyAttCode', which is pointing to {$oAttExtKey->GetTargetClass()}");
  663. }
  664. if(($iOperatorCode != TREE_OPERATOR_EQUALS) && !($oAttExtKey instanceof AttributeHierarchicalKey))
  665. {
  666. throw new CoreException("The specified tree operator $iOperatorCode is not applicable to the key '{$this->GetClass()}::$sExtKeyAttCode', which is not a HierarchicalKey");
  667. }
  668. // Note: though it seems to be a good practice to clone the given source filter
  669. // (as it was done and fixed an issue in Intersect())
  670. // this was not implemented here because it was causing a regression (login as admin, select an org, click on any badge)
  671. // root cause: FromOQL relies on the fact that the passed filter can be modified later
  672. // NO: $oFilter = $oFilter->DeepClone();
  673. // See also: Trac #639, and self::AddCondition_ReferencedBy()
  674. $aAliasTranslation = array();
  675. $res = $this->AddCondition_PointingTo_InNameSpace($oFilter, $sExtKeyAttCode, $this->m_aClasses, $aAliasTranslation, $iOperatorCode);
  676. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  677. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  678. if (ENABLE_OPT && ($oFilter->GetClass() == $oFilter->GetFirstJoinedClass()))
  679. {
  680. if (isset($oFilter->m_aReferencedBy[$this->GetClass()][$sExtKeyAttCode][$iOperatorCode]))
  681. {
  682. // Optimization - fold sibling query
  683. $oRemoteFilter = $oFilter->m_aReferencedBy[$this->GetClass()][$sExtKeyAttCode][$iOperatorCode][0];
  684. $aAliasTranslation = array();
  685. $this->MergeWith_InNamespace($oRemoteFilter, $this->m_aClasses, $aAliasTranslation);
  686. unset($oFilter->m_aReferencedBy[$this->GetClass()][$sExtKeyAttCode][$iOperatorCode]);
  687. $this->m_oSearchCondition = $this->m_oSearchCondition->Translate($aAliasTranslation, false, false);
  688. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  689. }
  690. }
  691. $this->RecomputeClassList($this->m_aClasses);
  692. return $res;
  693. }
  694. protected function AddCondition_PointingTo_InNameSpace(DBObjectSearch $oFilter, $sExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
  695. {
  696. // Find the node on which the new tree must be attached (most of the time it is "this")
  697. $oReceivingFilter = $this->GetNode($this->GetClassAlias());
  698. if (ENABLE_OPT && isset($oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode]))
  699. {
  700. $oExisting = $oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][0];
  701. $oExisting->MergeWith_InNamespace($oFilter, $oExisting->m_aClasses, $aAliasTranslation);
  702. }
  703. else
  704. {
  705. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  706. $oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][] = $oFilter;
  707. }
  708. }
  709. /**
  710. * @param DBObjectSearch $oFilter
  711. * @param $sForeignExtKeyAttCode
  712. * @param int $iOperatorCode
  713. * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
  714. */
  715. public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
  716. {
  717. $sForeignClass = $oFilter->GetClass();
  718. if (!MetaModel::IsValidKeyAttCode($sForeignClass, $sForeignExtKeyAttCode))
  719. {
  720. throw new CoreException("The attribute code '$sForeignExtKeyAttCode' is not an external key of the class '{$sForeignClass}'");
  721. }
  722. $oAttExtKey = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  723. if(!MetaModel::IsSameFamilyBranch($this->GetClass(), $oAttExtKey->GetTargetClass()))
  724. {
  725. // à refaire en spécifique dans FromOQL
  726. throw new CoreException("The specified filter (objects referencing an object of class {$this->GetClass()}) is not compatible with the key '{$sForeignClass}::$sForeignExtKeyAttCode', which is pointing to {$oAttExtKey->GetTargetClass()}");
  727. }
  728. // Note: though it seems to be a good practice to clone the given source filter
  729. // (as it was done and fixed an issue in Intersect())
  730. // this was not implemented here because it was causing a regression (login as admin, select an org, click on any badge)
  731. // root cause: FromOQL relies on the fact that the passed filter can be modified later
  732. // NO: $oFilter = $oFilter->DeepClone();
  733. // See also: Trac #639, and self::AddCondition_PointingTo()
  734. $aAliasTranslation = array();
  735. $res = $this->AddCondition_ReferencedBy_InNameSpace($oFilter, $sForeignExtKeyAttCode, $this->m_aClasses, $aAliasTranslation, $iOperatorCode);
  736. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  737. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  738. if (ENABLE_OPT && ($oFilter->GetClass() == $oFilter->GetFirstJoinedClass()))
  739. {
  740. if (isset($oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode]))
  741. {
  742. // Optimization - fold sibling query
  743. $oRemoteFilter = $oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode][0];
  744. $aAliasTranslation = array();
  745. $this->MergeWith_InNamespace($oRemoteFilter, $this->m_aClasses, $aAliasTranslation);
  746. unset($oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode]);
  747. $this->m_oSearchCondition = $this->m_oSearchCondition->Translate($aAliasTranslation, false, false);
  748. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  749. }
  750. }
  751. $this->RecomputeClassList($this->m_aClasses);
  752. return $res;
  753. }
  754. protected function AddCondition_ReferencedBy_InNameSpace(DBSearch $oFilter, $sForeignExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
  755. {
  756. $sForeignClass = $oFilter->GetClass();
  757. // Find the node on which the new tree must be attached (most of the time it is "this")
  758. $oReceivingFilter = $this->GetNode($this->GetClassAlias());
  759. if (ENABLE_OPT && isset($oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode]))
  760. {
  761. $oExisting = $oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode][0];
  762. $oExisting->MergeWith_InNamespace($oFilter, $oExisting->m_aClasses, $aAliasTranslation);
  763. }
  764. else
  765. {
  766. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  767. $oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode][] = $oFilter;
  768. }
  769. }
  770. public function Intersect(DBSearch $oFilter)
  771. {
  772. if ($oFilter instanceof DBUnionSearch)
  773. {
  774. // Develop!
  775. $aFilters = $oFilter->GetSearches();
  776. }
  777. else
  778. {
  779. $aFilters = array($oFilter);
  780. }
  781. $aSearches = array();
  782. foreach ($aFilters as $oRightFilter)
  783. {
  784. // Limitation: the queried class must be the first declared class
  785. if ($this->GetFirstJoinedClassAlias() != $this->GetClassAlias())
  786. {
  787. throw new CoreException("Limitation: cannot merge two queries if the queried class ({$this->GetClass()} AS {$this->GetClassAlias()}) is not the first joined class ({$this->GetFirstJoinedClass()} AS {$this->GetFirstJoinedClassAlias()})");
  788. }
  789. if ($oRightFilter->GetFirstJoinedClassAlias() != $oRightFilter->GetClassAlias())
  790. {
  791. throw new CoreException("Limitation: cannot merge two queries if the queried class ({$oRightFilter->GetClass()} AS {$oRightFilter->GetClassAlias()}) is not the first joined class ({$oRightFilter->GetFirstJoinedClass()} AS {$oRightFilter->GetFirstJoinedClassAlias()})");
  792. }
  793. $oLeftFilter = $this->DeepClone();
  794. $oRightFilter = $oRightFilter->DeepClone();
  795. $bAllowAllData = ($oLeftFilter->IsAllDataAllowed() && $oRightFilter->IsAllDataAllowed());
  796. $oLeftFilter->AllowAllData($bAllowAllData);
  797. if ($oLeftFilter->GetClass() != $oRightFilter->GetClass())
  798. {
  799. if (MetaModel::IsParentClass($oLeftFilter->GetClass(), $oRightFilter->GetClass()))
  800. {
  801. // Specialize $oLeftFilter
  802. $oLeftFilter->ChangeClass($oRightFilter->GetClass());
  803. }
  804. elseif (MetaModel::IsParentClass($oRightFilter->GetClass(), $oLeftFilter->GetClass()))
  805. {
  806. // Specialize $oRightFilter
  807. $oRightFilter->ChangeClass($oLeftFilter->GetClass());
  808. }
  809. else
  810. {
  811. throw new CoreException("Attempting to merge a filter of class '{$oLeftFilter->GetClass()}' with a filter of class '{$oRightFilter->GetClass()}'");
  812. }
  813. }
  814. $aAliasTranslation = array();
  815. $oLeftFilter->MergeWith_InNamespace($oRightFilter, $oLeftFilter->m_aClasses, $aAliasTranslation);
  816. $oLeftFilter->TransferConditionExpression($oRightFilter, $aAliasTranslation);
  817. $aSearches[] = $oLeftFilter;
  818. }
  819. if (count($aSearches) == 1)
  820. {
  821. // return a DBObjectSearch
  822. return $aSearches[0];
  823. }
  824. else
  825. {
  826. return new DBUnionSearch($aSearches);
  827. }
  828. }
  829. protected function MergeWith_InNamespace($oFilter, &$aClassAliases, &$aAliasTranslation)
  830. {
  831. if ($this->GetClass() != $oFilter->GetClass())
  832. {
  833. throw new CoreException("Attempting to merge a filter of class '{$this->GetClass()}' with a filter of class '{$oFilter->GetClass()}'");
  834. }
  835. // Translate search condition into our aliasing scheme
  836. $aAliasTranslation[$oFilter->GetClassAlias()]['*'] = $this->GetClassAlias();
  837. $this->m_aFullText = array_merge($this->m_aFullText, $oFilter->m_aFullText);
  838. foreach($oFilter->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  839. {
  840. foreach($aPointingTo as $iOperatorCode => $aFilter)
  841. {
  842. foreach($aFilter as $oExtFilter)
  843. {
  844. $this->AddCondition_PointingTo_InNamespace($oExtFilter, $sExtKeyAttCode, $aClassAliases, $aAliasTranslation, $iOperatorCode);
  845. }
  846. }
  847. }
  848. foreach($oFilter->m_aReferencedBy as $sForeignClass => $aReferences)
  849. {
  850. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  851. {
  852. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  853. {
  854. foreach ($aFilters as $oForeignFilter)
  855. {
  856. $this->AddCondition_ReferencedBy_InNamespace($oForeignFilter, $sForeignExtKeyAttCode, $aClassAliases, $aAliasTranslation, $iOperatorCode);
  857. }
  858. }
  859. }
  860. }
  861. }
  862. public function GetCriteria() {return $this->m_oSearchCondition;}
  863. public function GetCriteria_FullText() {return $this->m_aFullText;}
  864. protected function GetCriteria_PointingTo($sKeyAttCode = "")
  865. {
  866. if (empty($sKeyAttCode))
  867. {
  868. return $this->m_aPointingTo;
  869. }
  870. if (!array_key_exists($sKeyAttCode, $this->m_aPointingTo)) return array();
  871. return $this->m_aPointingTo[$sKeyAttCode];
  872. }
  873. protected function GetCriteria_ReferencedBy()
  874. {
  875. return $this->m_aReferencedBy;
  876. }
  877. public function SetInternalParams($aParams)
  878. {
  879. return $this->m_aParams = $aParams;
  880. }
  881. public function GetInternalParams()
  882. {
  883. return $this->m_aParams;
  884. }
  885. public function GetQueryParams($bExcludeMagicParams = true)
  886. {
  887. $aParams = array();
  888. $this->m_oSearchCondition->Render($aParams, true);
  889. if ($bExcludeMagicParams)
  890. {
  891. $aRet = array();
  892. // Make the list of acceptable arguments... could be factorized with run_query, into oSearch->GetQueryParams($bExclude magic params)
  893. $aNakedMagicArguments = array();
  894. foreach (MetaModel::PrepareQueryArguments(array()) as $sArgName => $value)
  895. {
  896. $iPos = strpos($sArgName, '->object()');
  897. if ($iPos === false)
  898. {
  899. $aNakedMagicArguments[$sArgName] = $value;
  900. }
  901. else
  902. {
  903. $aNakedMagicArguments[substr($sArgName, 0, $iPos)] = true;
  904. }
  905. }
  906. foreach ($aParams as $sParam => $foo)
  907. {
  908. $iPos = strpos($sParam, '->');
  909. if ($iPos === false)
  910. {
  911. $sRefName = $sParam;
  912. }
  913. else
  914. {
  915. $sRefName = substr($sParam, 0, $iPos);
  916. }
  917. if (!array_key_exists($sRefName, $aNakedMagicArguments))
  918. {
  919. $aRet[$sParam] = $foo;
  920. }
  921. }
  922. }
  923. return $aRet;
  924. }
  925. public function ListConstantFields()
  926. {
  927. return $this->m_oSearchCondition->ListConstantFields();
  928. }
  929. /**
  930. * Turn the parameters (:xxx) into scalar values in order to easily
  931. * serialize a search
  932. */
  933. public function ApplyParameters($aArgs)
  934. {
  935. return $this->m_oSearchCondition->ApplyParameters(array_merge($this->m_aParams, $aArgs));
  936. }
  937. public function ToOQL($bDevelopParams = false, $aContextParams = null, $bWithAllowAllFlag = false)
  938. {
  939. // Currently unused, but could be useful later
  940. $bRetrofitParams = false;
  941. if ($bDevelopParams)
  942. {
  943. if (is_null($aContextParams))
  944. {
  945. $aParams = array_merge($this->m_aParams);
  946. }
  947. else
  948. {
  949. $aParams = array_merge($aContextParams, $this->m_aParams);
  950. }
  951. $aParams = MetaModel::PrepareQueryArguments($aParams);
  952. }
  953. else
  954. {
  955. // Leave it as is, the rendering will be made with parameters in clear
  956. $aParams = null;
  957. }
  958. $aSelectedAliases = array();
  959. foreach ($this->m_aSelectedClasses as $sAlias => $sClass)
  960. {
  961. $aSelectedAliases[] = '`' . $sAlias . '`';
  962. }
  963. $sSelectedClasses = implode(', ', $aSelectedAliases);
  964. $sRes = 'SELECT '.$sSelectedClasses.' FROM';
  965. $sRes .= ' ' . $this->GetFirstJoinedClass() . ' AS `' . $this->GetFirstJoinedClassAlias() . '`';
  966. $sRes .= $this->ToOQL_Joins();
  967. $sRes .= " WHERE ".$this->m_oSearchCondition->Render($aParams, $bRetrofitParams);
  968. // Temporary: add more info about other conditions, necessary to avoid strange behaviors with the cache
  969. foreach($this->m_aFullText as $sFullText)
  970. {
  971. $sRes .= " AND MATCHES '$sFullText'";
  972. }
  973. if ($bWithAllowAllFlag && $this->m_bAllowAllData)
  974. {
  975. $sRes .= " ALLOW ALL DATA";
  976. }
  977. return $sRes;
  978. }
  979. protected function OperatorCodeToOQL($iOperatorCode)
  980. {
  981. switch($iOperatorCode)
  982. {
  983. case TREE_OPERATOR_EQUALS:
  984. $sOperator = ' = ';
  985. break;
  986. case TREE_OPERATOR_BELOW:
  987. $sOperator = ' BELOW ';
  988. break;
  989. case TREE_OPERATOR_BELOW_STRICT:
  990. $sOperator = ' BELOW STRICT ';
  991. break;
  992. case TREE_OPERATOR_NOT_BELOW:
  993. $sOperator = ' NOT BELOW ';
  994. break;
  995. case TREE_OPERATOR_NOT_BELOW_STRICT:
  996. $sOperator = ' NOT BELOW STRICT ';
  997. break;
  998. case TREE_OPERATOR_ABOVE:
  999. $sOperator = ' ABOVE ';
  1000. break;
  1001. case TREE_OPERATOR_ABOVE_STRICT:
  1002. $sOperator = ' ABOVE STRICT ';
  1003. break;
  1004. case TREE_OPERATOR_NOT_ABOVE:
  1005. $sOperator = ' NOT ABOVE ';
  1006. break;
  1007. case TREE_OPERATOR_NOT_ABOVE_STRICT:
  1008. $sOperator = ' NOT ABOVE STRICT ';
  1009. break;
  1010. }
  1011. return $sOperator;
  1012. }
  1013. protected function ToOQL_Joins()
  1014. {
  1015. $sRes = '';
  1016. foreach($this->m_aPointingTo as $sExtKey => $aPointingTo)
  1017. {
  1018. foreach($aPointingTo as $iOperatorCode => $aFilter)
  1019. {
  1020. $sOperator = $this->OperatorCodeToOQL($iOperatorCode);
  1021. foreach($aFilter as $oFilter)
  1022. {
  1023. $sRes .= ' JOIN ' . $oFilter->GetFirstJoinedClass() . ' AS `' . $oFilter->GetFirstJoinedClassAlias() . '` ON `' . $this->GetFirstJoinedClassAlias() . '`.' . $sExtKey . $sOperator . '`' . $oFilter->GetFirstJoinedClassAlias() . '`.id';
  1024. $sRes .= $oFilter->ToOQL_Joins();
  1025. }
  1026. }
  1027. }
  1028. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  1029. {
  1030. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  1031. {
  1032. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  1033. {
  1034. $sOperator = $this->OperatorCodeToOQL($iOperatorCode);
  1035. foreach ($aFilters as $oForeignFilter)
  1036. {
  1037. $sRes .= ' JOIN ' . $oForeignFilter->GetFirstJoinedClass() . ' AS `' . $oForeignFilter->GetFirstJoinedClassAlias() . '` ON `' . $oForeignFilter->GetFirstJoinedClassAlias() . '`.' . $sForeignExtKeyAttCode . $sOperator . '`' . $this->GetFirstJoinedClassAlias() . '`.id';
  1038. $sRes .= $oForeignFilter->ToOQL_Joins();
  1039. }
  1040. }
  1041. }
  1042. }
  1043. return $sRes;
  1044. }
  1045. protected function OQLExpressionToCondition($sQuery, $oExpression, $aClassAliases)
  1046. {
  1047. if ($oExpression instanceof BinaryOqlExpression)
  1048. {
  1049. $sOperator = $oExpression->GetOperator();
  1050. $oLeft = $this->OQLExpressionToCondition($sQuery, $oExpression->GetLeftExpr(), $aClassAliases);
  1051. $oRight = $this->OQLExpressionToCondition($sQuery, $oExpression->GetRightExpr(), $aClassAliases);
  1052. return new BinaryExpression($oLeft, $sOperator, $oRight);
  1053. }
  1054. elseif ($oExpression instanceof FieldOqlExpression)
  1055. {
  1056. $sClassAlias = $oExpression->GetParent();
  1057. $sFltCode = $oExpression->GetName();
  1058. if (empty($sClassAlias))
  1059. {
  1060. // Need to find the right alias
  1061. // Build an array of field => array of aliases
  1062. $aFieldClasses = array();
  1063. foreach($aClassAliases as $sAlias => $sReal)
  1064. {
  1065. foreach(MetaModel::GetFiltersList($sReal) as $sAnFltCode)
  1066. {
  1067. $aFieldClasses[$sAnFltCode][] = $sAlias;
  1068. }
  1069. }
  1070. $sClassAlias = $aFieldClasses[$sFltCode][0];
  1071. }
  1072. return new FieldExpression($sFltCode, $sClassAlias);
  1073. }
  1074. elseif ($oExpression instanceof VariableOqlExpression)
  1075. {
  1076. return new VariableExpression($oExpression->GetName());
  1077. }
  1078. elseif ($oExpression instanceof TrueOqlExpression)
  1079. {
  1080. return new TrueExpression;
  1081. }
  1082. elseif ($oExpression instanceof ScalarOqlExpression)
  1083. {
  1084. return new ScalarExpression($oExpression->GetValue());
  1085. }
  1086. elseif ($oExpression instanceof ListOqlExpression)
  1087. {
  1088. $aItems = array();
  1089. foreach ($oExpression->GetItems() as $oItemExpression)
  1090. {
  1091. $aItems[] = $this->OQLExpressionToCondition($sQuery, $oItemExpression, $aClassAliases);
  1092. }
  1093. return new ListExpression($aItems);
  1094. }
  1095. elseif ($oExpression instanceof FunctionOqlExpression)
  1096. {
  1097. $aArgs = array();
  1098. foreach ($oExpression->GetArgs() as $oArgExpression)
  1099. {
  1100. $aArgs[] = $this->OQLExpressionToCondition($sQuery, $oArgExpression, $aClassAliases);
  1101. }
  1102. return new FunctionExpression($oExpression->GetVerb(), $aArgs);
  1103. }
  1104. elseif ($oExpression instanceof IntervalOqlExpression)
  1105. {
  1106. return new IntervalExpression($oExpression->GetValue(), $oExpression->GetUnit());
  1107. }
  1108. else
  1109. {
  1110. throw new CoreException('Unknown expression type', array('class'=>get_class($oExpression), 'query'=>$sQuery));
  1111. }
  1112. }
  1113. public function InitFromOqlQuery(OqlQuery $oOqlQuery, $sQuery)
  1114. {
  1115. $oModelReflection = new ModelReflectionRuntime();
  1116. $sClass = $oOqlQuery->GetClass($oModelReflection);
  1117. $sClassAlias = $oOqlQuery->GetClassAlias();
  1118. $aAliases = array($sClassAlias => $sClass);
  1119. // Maintain an array of filters, because the flat list is in fact referring to a tree
  1120. // And this will be an easy way to dispatch the conditions
  1121. // $this will be referenced by the other filters, or the other way around...
  1122. $aJoinItems = array($sClassAlias => $this);
  1123. $aJoinSpecs = $oOqlQuery->GetJoins();
  1124. if (is_array($aJoinSpecs))
  1125. {
  1126. foreach ($aJoinSpecs as $oJoinSpec)
  1127. {
  1128. $sJoinClass = $oJoinSpec->GetClass();
  1129. $sJoinClassAlias = $oJoinSpec->GetClassAlias();
  1130. // Assumption: ext key on the left only !!!
  1131. // normalization should take care of this
  1132. $oLeftField = $oJoinSpec->GetLeftField();
  1133. $sFromClass = $oLeftField->GetParent();
  1134. $sExtKeyAttCode = $oLeftField->GetName();
  1135. $oRightField = $oJoinSpec->GetRightField();
  1136. $sToClass = $oRightField->GetParent();
  1137. $aAliases[$sJoinClassAlias] = $sJoinClass;
  1138. $aJoinItems[$sJoinClassAlias] = new DBObjectSearch($sJoinClass, $sJoinClassAlias);
  1139. $sOperator = $oJoinSpec->GetOperator();
  1140. switch($sOperator)
  1141. {
  1142. case '=':
  1143. default:
  1144. $iOperatorCode = TREE_OPERATOR_EQUALS;
  1145. break;
  1146. case 'BELOW':
  1147. $iOperatorCode = TREE_OPERATOR_BELOW;
  1148. break;
  1149. case 'BELOW_STRICT':
  1150. $iOperatorCode = TREE_OPERATOR_BELOW_STRICT;
  1151. break;
  1152. case 'NOT_BELOW':
  1153. $iOperatorCode = TREE_OPERATOR_NOT_BELOW;
  1154. break;
  1155. case 'NOT_BELOW_STRICT':
  1156. $iOperatorCode = TREE_OPERATOR_NOT_BELOW_STRICT;
  1157. break;
  1158. case 'ABOVE':
  1159. $iOperatorCode = TREE_OPERATOR_ABOVE;
  1160. break;
  1161. case 'ABOVE_STRICT':
  1162. $iOperatorCode = TREE_OPERATOR_ABOVE_STRICT;
  1163. break;
  1164. case 'NOT_ABOVE':
  1165. $iOperatorCode = TREE_OPERATOR_NOT_ABOVE;
  1166. break;
  1167. case 'NOT_ABOVE_STRICT':
  1168. $iOperatorCode = TREE_OPERATOR_NOT_ABOVE_STRICT;
  1169. break;
  1170. }
  1171. if ($sFromClass == $sJoinClassAlias)
  1172. {
  1173. $oReceiver = $aJoinItems[$sToClass];
  1174. $oNewComer = $aJoinItems[$sFromClass];
  1175. $aAliasTranslation = array();
  1176. $oReceiver->AddCondition_ReferencedBy_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation, $iOperatorCode);
  1177. }
  1178. else
  1179. {
  1180. $oReceiver = $aJoinItems[$sFromClass];
  1181. $oNewComer = $aJoinItems[$sToClass];
  1182. $aAliasTranslation = array();
  1183. $oReceiver->AddCondition_PointingTo_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation, $iOperatorCode);
  1184. }
  1185. }
  1186. }
  1187. // Check and prepare the select information
  1188. $this->m_aSelectedClasses = array();
  1189. foreach ($oOqlQuery->GetSelectedClasses() as $oClassDetails)
  1190. {
  1191. $sClassToSelect = $oClassDetails->GetValue();
  1192. $this->m_aSelectedClasses[$sClassToSelect] = $aAliases[$sClassToSelect];
  1193. }
  1194. $this->m_aClasses = $aAliases;
  1195. $oConditionTree = $oOqlQuery->GetCondition();
  1196. if ($oConditionTree instanceof Expression)
  1197. {
  1198. $this->m_oSearchCondition = $this->OQLExpressionToCondition($sQuery, $oConditionTree, $aAliases);
  1199. }
  1200. }
  1201. ////////////////////////////////////////////////////////////////////////////
  1202. //
  1203. // Construction of the SQL queries
  1204. //
  1205. ////////////////////////////////////////////////////////////////////////////
  1206. public function MakeDeleteQuery($aArgs = array())
  1207. {
  1208. $aModifierProperties = MetaModel::MakeModifierProperties($this);
  1209. $oBuild = new QueryBuilderContext($this, $aModifierProperties);
  1210. $oSQLQuery = $this->MakeSQLObjectQuery($oBuild, null, array());
  1211. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1212. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1213. $aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
  1214. return $oSQLQuery->RenderDelete($aScalarArgs);
  1215. }
  1216. public function MakeUpdateQuery($aValues, $aArgs = array())
  1217. {
  1218. // $aValues is an array of $sAttCode => $value
  1219. $aModifierProperties = MetaModel::MakeModifierProperties($this);
  1220. $oBuild = new QueryBuilderContext($this, $aModifierProperties);
  1221. $oSQLQuery = $this->MakeSQLObjectQuery($oBuild, null, $aValues);
  1222. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1223. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1224. $aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
  1225. return $oSQLQuery->RenderUpdate($aScalarArgs);
  1226. }
  1227. public function MakeSQLQuery($aAttToLoad, $bGetCount, $aModifierProperties, $aGroupByExpr = null, $aSelectedClasses = null)
  1228. {
  1229. // Hide objects that are not visible to the current user
  1230. //
  1231. $oSearch = $this;
  1232. if (!$this->IsAllDataAllowed() && !$this->IsDataFiltered())
  1233. {
  1234. $oVisibleObjects = UserRights::GetSelectFilter($this->GetClass(), $this->GetModifierProperties('UserRightsGetSelectFilter'));
  1235. if ($oVisibleObjects === false)
  1236. {
  1237. // Make sure this is a valid search object, saying NO for all
  1238. $oVisibleObjects = DBObjectSearch::FromEmptySet($this->GetClass());
  1239. }
  1240. if (is_object($oVisibleObjects))
  1241. {
  1242. $oVisibleObjects->AllowAllData();
  1243. $oSearch = $this->Intersect($oVisibleObjects);
  1244. $oSearch->SetDataFiltered();
  1245. }
  1246. else
  1247. {
  1248. // should be true at this point, meaning that no additional filtering
  1249. // is required
  1250. }
  1251. }
  1252. $oBuild = new QueryBuilderContext($oSearch, $aModifierProperties, $aGroupByExpr, $aSelectedClasses);
  1253. $oSQLQuery = $oSearch->MakeSQLObjectQuery($oBuild, $aAttToLoad, array());
  1254. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1255. if ($aGroupByExpr)
  1256. {
  1257. $aCols = $oBuild->m_oQBExpressions->GetGroupBy();
  1258. $oSQLQuery->SetGroupBy($aCols);
  1259. $oSQLQuery->SetSelect($aCols);
  1260. }
  1261. else
  1262. {
  1263. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1264. }
  1265. if (self::$m_bOptimizeQueries)
  1266. {
  1267. if ($bGetCount)
  1268. {
  1269. // Simplify the query if just getting the count
  1270. $oSQLQuery->SetSelect(array());
  1271. }
  1272. $oBuild->m_oQBExpressions->GetMandatoryTables($aMandatoryTables);
  1273. $oSQLQuery->OptimizeJoins($aMandatoryTables);
  1274. }
  1275. return $oSQLQuery;
  1276. }
  1277. protected function MakeSQLObjectQuery(&$oBuild, $aAttToLoad = null, $aValues = array())
  1278. {
  1279. // Note: query class might be different than the class of the filter
  1280. // -> this occurs when we are linking our class to an external class (referenced by, or pointing to)
  1281. $sClass = $this->GetFirstJoinedClass();
  1282. $sClassAlias = $this->GetFirstJoinedClassAlias();
  1283. $bIsOnQueriedClass = array_key_exists($sClassAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  1284. self::DbgTrace("Entering: ".$this->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  1285. $sRootClass = MetaModel::GetRootClass($sClass);
  1286. $sKeyField = MetaModel::DBGetKey($sClass);
  1287. if ($bIsOnQueriedClass)
  1288. {
  1289. // default to the whole list of attributes + the very std id/finalclass
  1290. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.'id', new FieldExpression('id', $sClassAlias));
  1291. if (is_null($aAttToLoad) || !array_key_exists($sClassAlias, $aAttToLoad))
  1292. {
  1293. $sSelectedClass = $oBuild->GetSelectedClass($sClassAlias);
  1294. $aAttList = MetaModel::ListAttributeDefs($sSelectedClass);
  1295. }
  1296. else
  1297. {
  1298. $aAttList = $aAttToLoad[$sClassAlias];
  1299. }
  1300. foreach ($aAttList as $sAttCode => $oAttDef)
  1301. {
  1302. if (!$oAttDef->IsScalar()) continue;
  1303. // keep because it can be used for sorting - if (!$oAttDef->LoadInObject()) continue;
  1304. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1305. {
  1306. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.$sAttCode.$sColId, new FieldExpression($sAttCode.$sColId, $sClassAlias));
  1307. }
  1308. }
  1309. // Transform the full text condition into additional condition expression
  1310. $aFullText = $this->GetCriteria_FullText();
  1311. if (count($aFullText) > 0)
  1312. {
  1313. $aFullTextFields = array();
  1314. foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  1315. {
  1316. if (!$oAttDef->IsScalar()) continue;
  1317. if ($oAttDef->IsExternalKey()) continue;
  1318. $aFullTextFields[] = new FieldExpression($sAttCode, $sClassAlias);
  1319. }
  1320. $oTextFields = new CharConcatWSExpression(' ', $aFullTextFields);
  1321. foreach($aFullText as $sFTNeedle)
  1322. {
  1323. $oNewCond = new BinaryExpression($oTextFields, 'LIKE', new ScalarExpression("%$sFTNeedle%"));
  1324. $oBuild->m_oQBExpressions->AddCondition($oNewCond);
  1325. }
  1326. }
  1327. }
  1328. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1329. $aExpectedAtts = array(); // array of (attcode => fieldexpression)
  1330. //echo "<p>".__LINE__.": GetUnresolvedFields($sClassAlias, ...)</p>\n";
  1331. $oBuild->m_oQBExpressions->GetUnresolvedFields($sClassAlias, $aExpectedAtts);
  1332. // Compute a clear view of required joins (from the current class)
  1333. // Build the list of external keys:
  1334. // -> ext keys required by an explicit join
  1335. // -> ext keys mentionned in a 'pointing to' condition
  1336. // -> ext keys required for an external field
  1337. // -> ext keys required for a friendly name
  1338. //
  1339. $aExtKeys = array(); // array of sTableClass => array of (sAttCode (keys) => array of (sAttCode (fields)=> oAttDef))
  1340. //
  1341. // Optimization: could be partially computed once for all (cached) ?
  1342. //
  1343. if ($bIsOnQueriedClass)
  1344. {
  1345. // Get all Ext keys for the queried class (??)
  1346. foreach(MetaModel::GetKeysList($sClass) as $sKeyAttCode)
  1347. {
  1348. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1349. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1350. }
  1351. }
  1352. // Get all Ext keys used by the filter
  1353. foreach ($this->GetCriteria_PointingTo() as $sKeyAttCode => $aPointingTo)
  1354. {
  1355. if (array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  1356. {
  1357. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1358. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1359. }
  1360. }
  1361. $aFNJoinAlias = array(); // array of (subclass => alias)
  1362. if (array_key_exists('friendlyname', $aExpectedAtts))
  1363. {
  1364. // To optimize: detect a restriction on child classes in the condition expression
  1365. // e.g. SELECT FunctionalCI WHERE finalclass IN ('Server', 'VirtualMachine')
  1366. $oNameExpression = self::GetExtendedNameExpression($sClass);
  1367. $aNameFields = array();
  1368. $oNameExpression->GetUnresolvedFields('', $aNameFields);
  1369. $aTranslateNameFields = array();
  1370. foreach($aNameFields as $sSubClass => $aFields)
  1371. {
  1372. foreach($aFields as $sAttCode => $oField)
  1373. {
  1374. $oAttDef = MetaModel::GetAttributeDef($sSubClass, $sAttCode);
  1375. if ($oAttDef->IsExternalKey())
  1376. {
  1377. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sAttCode);
  1378. $aExtKeys[$sClassOfAttribute][$sAttCode] = array();
  1379. }
  1380. elseif ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1381. {
  1382. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1383. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sKeyAttCode);
  1384. $aExtKeys[$sClassOfAttribute][$sKeyAttCode][$sAttCode] = $oAttDef;
  1385. }
  1386. else
  1387. {
  1388. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sAttCode);
  1389. }
  1390. if (MetaModel::IsParentClass($sClassOfAttribute, $sClass))
  1391. {
  1392. // The attribute is part of the standard query
  1393. //
  1394. $sAliasForAttribute = $sClassAlias;
  1395. }
  1396. else
  1397. {
  1398. // The attribute will be available from an additional outer join
  1399. // For each subclass (table) one single join is enough
  1400. //
  1401. if (!array_key_exists($sClassOfAttribute, $aFNJoinAlias))
  1402. {
  1403. $sAliasForAttribute = $oBuild->GenerateClassAlias($sClassAlias.'_fn_'.$sClassOfAttribute, $sClassOfAttribute);
  1404. $aFNJoinAlias[$sClassOfAttribute] = $sAliasForAttribute;
  1405. }
  1406. else
  1407. {
  1408. $sAliasForAttribute = $aFNJoinAlias[$sClassOfAttribute];
  1409. }
  1410. }
  1411. $aTranslateNameFields[$sSubClass][$sAttCode] = new FieldExpression($sAttCode, $sAliasForAttribute);
  1412. }
  1413. }
  1414. $oNameExpression = $oNameExpression->Translate($aTranslateNameFields, false);
  1415. $aTranslateNow = array();
  1416. $aTranslateNow[$sClassAlias]['friendlyname'] = $oNameExpression;
  1417. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  1418. }
  1419. // Add the ext fields used in the select (eventually adds an external key)
  1420. foreach(MetaModel::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  1421. {
  1422. if ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1423. {
  1424. if (array_key_exists($sAttCode, $aExpectedAtts))
  1425. {
  1426. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1427. if ($sKeyAttCode != 'id')
  1428. {
  1429. // Add the external attribute
  1430. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1431. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  1432. }
  1433. }
  1434. }
  1435. }
  1436. // First query built upon on the leaf (ie current) class
  1437. //
  1438. self::DbgTrace("Main (=leaf) class, call MakeSQLObjectQuerySingleTable()");
  1439. if (MetaModel::HasTable($sClass))
  1440. {
  1441. $oSelectBase = $this->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sClass, $aExtKeys, $aValues);
  1442. }
  1443. else
  1444. {
  1445. $oSelectBase = null;
  1446. // As the join will not filter on the expected classes, we have to specify it explicitely
  1447. $sExpectedClasses = implode("', '", MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  1448. $oFinalClassRestriction = Expression::FromOQL("`$sClassAlias`.finalclass IN ('$sExpectedClasses')");
  1449. $oBuild->m_oQBExpressions->AddCondition($oFinalClassRestriction);
  1450. }
  1451. // Then we join the queries of the eventual parent classes (compound model)
  1452. foreach(MetaModel::EnumParentClasses($sClass) as $sParentClass)
  1453. {
  1454. if (!MetaModel::HasTable($sParentClass)) continue;
  1455. self::DbgTrace("Parent class: $sParentClass... let's call MakeSQLObjectQuerySingleTable()");
  1456. $oSelectParentTable = $this->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sParentClass, $aExtKeys, $aValues);
  1457. if (is_null($oSelectBase))
  1458. {
  1459. $oSelectBase = $oSelectParentTable;
  1460. }
  1461. else
  1462. {
  1463. $oSelectBase->AddInnerJoin($oSelectParentTable, $sKeyField, MetaModel::DBGetKey($sParentClass));
  1464. }
  1465. }
  1466. // Filter on objects referencing me
  1467. //
  1468. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  1469. {
  1470. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  1471. {
  1472. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  1473. {
  1474. foreach ($aFilters as $oForeignFilter)
  1475. {
  1476. $oForeignKeyAttDef = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  1477. self::DbgTrace("Referenced by foreign key: $sForeignExtKeyAttCode... let's call MakeSQLObjectQuery()");
  1478. //self::DbgTrace($oForeignFilter);
  1479. //self::DbgTrace($oForeignFilter->ToOQL());
  1480. //self::DbgTrace($oSelectForeign);
  1481. //self::DbgTrace($oSelectForeign->RenderSelect(array()));
  1482. $sForeignClassAlias = $oForeignFilter->GetFirstJoinedClassAlias();
  1483. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sForeignExtKeyAttCode, $sForeignClassAlias));
  1484. if ($oForeignKeyAttDef instanceof AttributeObjectKey)
  1485. {
  1486. $sClassAttCode = $oForeignKeyAttDef->Get('class_attcode');
  1487. // Add the condition: `$sForeignClassAlias`.$sClassAttCode IN (subclasses of $sClass')
  1488. $oClassListExpr = ListExpression::FromScalars(MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  1489. $oClassExpr = new FieldExpression($sClassAttCode, $sForeignClassAlias);
  1490. $oClassRestriction = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1491. $oBuild->m_oQBExpressions->AddCondition($oClassRestriction);
  1492. }
  1493. $oSelectForeign = $oForeignFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1494. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1495. $sForeignKeyTable = $oJoinExpr->GetParent();
  1496. $sForeignKeyColumn = $oJoinExpr->GetName();
  1497. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  1498. {
  1499. $oSelectBase->AddInnerJoin($oSelectForeign, $sKeyField, $sForeignKeyColumn, $sForeignKeyTable);
  1500. }
  1501. else
  1502. {
  1503. // Hierarchical key
  1504. $KeyLeft = $oForeignKeyAttDef->GetSQLLeft();
  1505. $KeyRight = $oForeignKeyAttDef->GetSQLRight();
  1506. $oSelectBase->AddInnerJoinTree($oSelectForeign, $KeyLeft, $KeyRight, $KeyLeft, $KeyRight, $sForeignKeyTable, $iOperatorCode, true);
  1507. }
  1508. }
  1509. }
  1510. }
  1511. }
  1512. // Additional JOINS for Friendly names
  1513. //
  1514. foreach ($aFNJoinAlias as $sSubClass => $sSubClassAlias)
  1515. {
  1516. $oSubClassFilter = new DBObjectSearch($sSubClass, $sSubClassAlias);
  1517. $oSelectFN = $oSubClassFilter->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sSubClass, $aExtKeys, array());
  1518. $oSelectBase->AddLeftJoin($oSelectFN, $sKeyField, MetaModel::DBGetKey($sSubClass));
  1519. }
  1520. // That's all... cross fingers and we'll get some working query
  1521. //MyHelpers::var_dump_html($oSelectBase, true);
  1522. //MyHelpers::var_dump_html($oSelectBase->RenderSelect(), true);
  1523. if (self::$m_bDebugQuery) $oSelectBase->DisplayHtml();
  1524. return $oSelectBase;
  1525. }
  1526. protected function MakeSQLObjectQuerySingleTable(&$oBuild, $aAttToLoad, $sTableClass, $aExtKeys, $aValues)
  1527. {
  1528. // $aExtKeys is an array of sTableClass => array of (sAttCode (keys) => array of sAttCode (fields))
  1529. //echo "MakeSQLObjectQuery($sTableClass)-liste des clefs externes($sTableClass): <pre>".print_r($aExtKeys, true)."</pre><br/>\n";
  1530. // Prepare the query for a single table (compound objects)
  1531. // Ignores the items (attributes/filters) that are not on the target table
  1532. // Perform an (inner or left) join for every external key (and specify the expected fields)
  1533. //
  1534. // Returns an SQLQuery
  1535. //
  1536. $sTargetClass = $this->GetFirstJoinedClass();
  1537. $sTargetAlias = $this->GetFirstJoinedClassAlias();
  1538. $sTable = MetaModel::DBGetTable($sTableClass);
  1539. $sTableAlias = $oBuild->GenerateTableAlias($sTargetAlias.'_'.$sTable, $sTable);
  1540. $aTranslation = array();
  1541. $aExpectedAtts = array();
  1542. $oBuild->m_oQBExpressions->GetUnresolvedFields($sTargetAlias, $aExpectedAtts);
  1543. $bIsOnQueriedClass = array_key_exists($sTargetAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  1544. self::DbgTrace("Entering: tableclass=$sTableClass, filter=".$this->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  1545. // 1 - SELECT and UPDATE
  1546. //
  1547. // Note: no need for any values nor fields for foreign Classes (ie not the queried Class)
  1548. //
  1549. $aUpdateValues = array();
  1550. // 1/a - Get the key and friendly name
  1551. //
  1552. // We need one pkey to be the key, let's take the first one available
  1553. $oSelectedIdField = null;
  1554. $oIdField = new FieldExpressionResolved(MetaModel::DBGetKey($sTableClass), $sTableAlias);
  1555. $aTranslation[$sTargetAlias]['id'] = $oIdField;
  1556. if ($bIsOnQueriedClass)
  1557. {
  1558. // Add this field to the list of queried fields (required for the COUNT to work fine)
  1559. $oSelectedIdField = $oIdField;
  1560. }
  1561. // 1/b - Get the other attributes
  1562. //
  1563. foreach(MetaModel::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  1564. {
  1565. // Skip this attribute if not defined in this table
  1566. if (MetaModel::GetAttributeOrigin($sTargetClass, $sAttCode) != $sTableClass) continue;
  1567. // Skip this attribute if not made of SQL columns
  1568. if (count($oAttDef->GetSQLExpressions()) == 0) continue;
  1569. // Update...
  1570. //
  1571. if ($bIsOnQueriedClass && array_key_exists($sAttCode, $aValues))
  1572. {
  1573. assert ($oAttDef->IsDirectField());
  1574. foreach ($oAttDef->GetSQLValues($aValues[$sAttCode]) as $sColumn => $sValue)
  1575. {
  1576. $aUpdateValues[$sColumn] = $sValue;
  1577. }
  1578. }
  1579. }
  1580. // 2 - The SQL query, for this table only
  1581. //
  1582. $oSelectBase = new SQLObjectQuery($sTable, $sTableAlias, array(), $bIsOnQueriedClass, $aUpdateValues, $oSelectedIdField);
  1583. // 3 - Resolve expected expressions (translation table: alias.attcode => table.column)
  1584. //
  1585. foreach(MetaModel::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  1586. {
  1587. // Skip this attribute if not defined in this table
  1588. if (MetaModel::GetAttributeOrigin($sTargetClass, $sAttCode) != $sTableClass) continue;
  1589. // Select...
  1590. //
  1591. if ($oAttDef->IsExternalField())
  1592. {
  1593. // skip, this will be handled in the joined tables (done hereabove)
  1594. }
  1595. else
  1596. {
  1597. //echo "<p>MakeSQLObjectQuerySingleTable: Field $sAttCode is part of the table $sTable (named: $sTableAlias)</p>";
  1598. // standard field, or external key
  1599. // add it to the output
  1600. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1601. {
  1602. if (array_key_exists($sAttCode.$sColId, $aExpectedAtts))
  1603. {
  1604. $oFieldSQLExp = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  1605. foreach (MetaModel::EnumPlugins('iQueryModifier') as $sPluginClass => $oQueryModifier)
  1606. {
  1607. $oFieldSQLExp = $oQueryModifier->GetFieldExpression($oBuild, $sTargetClass, $sAttCode, $sColId, $oFieldSQLExp, $oSelectBase);
  1608. }
  1609. $aTranslation[$sTargetAlias][$sAttCode.$sColId] = $oFieldSQLExp;
  1610. }
  1611. }
  1612. }
  1613. }
  1614. //echo "MakeSQLObjectQuery- Classe $sTableClass<br/>\n";
  1615. // 4 - The external keys -> joins...
  1616. //
  1617. $aAllPointingTo = $this->GetCriteria_PointingTo();
  1618. if (array_key_exists($sTableClass, $aExtKeys))
  1619. {
  1620. foreach ($aExtKeys[$sTableClass] as $sKeyAttCode => $aExtFields)
  1621. {
  1622. $oKeyAttDef = MetaModel::GetAttributeDef($sTableClass, $sKeyAttCode);
  1623. $aPointingTo = $this->GetCriteria_PointingTo($sKeyAttCode);
  1624. //echo "MakeSQLObjectQuery-Cle '$sKeyAttCode'<br/>\n";
  1625. if (!array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  1626. {
  1627. //echo "MakeSQLObjectQuery-Ajoutons l'operateur TREE_OPERATOR_EQUALS pour $sKeyAttCode<br/>\n";
  1628. // The join was not explicitely defined in the filter,
  1629. // we need to do it now
  1630. $sKeyClass = $oKeyAttDef->GetTargetClass();
  1631. $sKeyClassAlias = $oBuild->GenerateClassAlias($sKeyClass.'_'.$sKeyAttCode, $sKeyClass);
  1632. $oExtFilter = new DBObjectSearch($sKeyClass, $sKeyClassAlias);
  1633. $aAllPointingTo[$sKeyAttCode][TREE_OPERATOR_EQUALS][$sKeyClassAlias] = $oExtFilter;
  1634. }
  1635. }
  1636. }
  1637. //echo "MakeSQLObjectQuery-liste des clefs de jointure: <pre>".print_r(array_keys($aAllPointingTo), true)."</pre><br/>\n";
  1638. foreach ($aAllPointingTo as $sKeyAttCode => $aPointingTo)
  1639. {
  1640. foreach($aPointingTo as $iOperatorCode => $aFilter)
  1641. {
  1642. foreach($aFilter as $oExtFilter)
  1643. {
  1644. if (!MetaModel::IsValidAttCode($sTableClass, $sKeyAttCode)) continue; // Not defined in the class, skip it
  1645. // The aliases should not conflict because normalization occured while building the filter
  1646. $oKeyAttDef = MetaModel::GetAttributeDef($sTableClass, $sKeyAttCode);
  1647. $sKeyClass = $oExtFilter->GetFirstJoinedClass();
  1648. $sKeyClassAlias = $oExtFilter->GetFirstJoinedClassAlias();
  1649. //echo "MakeSQLObjectQuery-$sTableClass::$sKeyAttCode Foreach PointingTo($iOperatorCode) <span style=\"color:red\">$sKeyClass (alias:$sKeyClassAlias)</span><br/>\n";
  1650. // Note: there is no search condition in $oExtFilter, because normalization did merge the condition onto the top of the filter tree
  1651. //echo "MakeSQLObjectQuery-array_key_exists($sTableClass, \$aExtKeys)<br/>\n";
  1652. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  1653. {
  1654. if (array_key_exists($sTableClass, $aExtKeys) && array_key_exists($sKeyAttCode, $aExtKeys[$sTableClass]))
  1655. {
  1656. // Specify expected attributes for the target class query
  1657. // ... and use the current alias !
  1658. $aTranslateNow = array(); // Translation for external fields - must be performed before the join is done (recursion...)
  1659. foreach($aExtKeys[$sTableClass][$sKeyAttCode] as $sAttCode => $oAtt)
  1660. {
  1661. //echo "MakeSQLObjectQuery aExtKeys[$sTableClass][$sKeyAttCode] => $sAttCode-oAtt: <pre>".print_r($oAtt, true)."</pre><br/>\n";
  1662. if ($oAtt instanceof AttributeFriendlyName)
  1663. {
  1664. // Note: for a given ext key, there is one single attribute "friendly name"
  1665. $aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);
  1666. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);</b></p>\n";
  1667. }
  1668. else
  1669. {
  1670. $sExtAttCode = $oAtt->GetExtAttCode();
  1671. // Translate mainclass.extfield => remoteclassalias.remotefieldcode
  1672. $oRemoteAttDef = MetaModel::GetAttributeDef($sKeyClass, $sExtAttCode);
  1673. foreach ($oRemoteAttDef->GetSQLExpressions() as $sColId => $sRemoteAttExpr)
  1674. {
  1675. $aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);
  1676. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);</b></p>\n";
  1677. }
  1678. //echo "<p><b>ExtAttr2: $sTargetAlias.$sAttCode to $sKeyClassAlias.$sRemoteAttExpr (class: $sKeyClass)</b></p>\n";
  1679. }
  1680. }
  1681. if ($oKeyAttDef instanceof AttributeObjectKey)
  1682. {
  1683. // Add the condition: `$sTargetAlias`.$sClassAttCode IN (subclasses of $sKeyClass')
  1684. $sClassAttCode = $oKeyAttDef->Get('class_attcode');
  1685. $oClassAttDef = MetaModel::GetAttributeDef($sTargetClass, $sClassAttCode);
  1686. foreach ($oClassAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1687. {
  1688. $aTranslateNow[$sTargetAlias][$sClassAttCode.$sColId] = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  1689. }
  1690. $oClassListExpr = ListExpression::FromScalars(MetaModel::EnumChildClasses($sKeyClass, ENUM_CHILD_CLASSES_ALL));
  1691. $oClassExpr = new FieldExpression($sClassAttCode, $sTargetAlias);
  1692. $oClassRestriction = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1693. $oBuild->m_oQBExpressions->AddCondition($oClassRestriction);
  1694. }
  1695. // Translate prior to recursing
  1696. //
  1697. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."\n".print_r($aTranslateNow, true)."</pre></p>\n";
  1698. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  1699. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1700. //echo "<p>External key $sKeyAttCode (class: $sKeyClass), call MakeSQLObjectQuery()/p>\n";
  1701. self::DbgTrace("External key $sKeyAttCode (class: $sKeyClass), call MakeSQLObjectQuery()");
  1702. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression('id', $sKeyClassAlias));
  1703. //echo "<p>Recursive MakeSQLObjectQuery ".__LINE__.": <pre>\n".print_r($oBuild->GetRootFilter()->GetSelectedClasses(), true)."</pre></p>\n";
  1704. $oSelectExtKey = $oExtFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1705. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1706. $sExternalKeyTable = $oJoinExpr->GetParent();
  1707. $sExternalKeyField = $oJoinExpr->GetName();
  1708. $aCols = $oKeyAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  1709. $sLocalKeyField = current($aCols); // get the first column for an external key
  1710. self::DbgTrace("External key $sKeyAttCode, Join on $sLocalKeyField = $sExternalKeyField");
  1711. if ($oKeyAttDef->IsNullAllowed())
  1712. {
  1713. $oSelectBase->AddLeftJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  1714. }
  1715. else
  1716. {
  1717. $oSelectBase->AddInnerJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  1718. }
  1719. }
  1720. }
  1721. elseif(MetaModel::GetAttributeOrigin($sKeyClass, $sKeyAttCode) == $sTableClass)
  1722. {
  1723. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sKeyAttCode, $sKeyClassAlias));
  1724. $oSelectExtKey = $oExtFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1725. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1726. $sExternalKeyTable = $oJoinExpr->GetParent();
  1727. $sExternalKeyField = $oJoinExpr->GetName();
  1728. $sLeftIndex = $sExternalKeyField.'_left'; // TODO use GetSQLLeft()
  1729. $sRightIndex = $sExternalKeyField.'_right'; // TODO use GetSQLRight()
  1730. $LocalKeyLeft = $oKeyAttDef->GetSQLLeft();
  1731. $LocalKeyRight = $oKeyAttDef->GetSQLRight();
  1732. $oSelectBase->AddInnerJoinTree($oSelectExtKey, $LocalKeyLeft, $LocalKeyRight, $sLeftIndex, $sRightIndex, $sExternalKeyTable, $iOperatorCode);
  1733. }
  1734. }
  1735. }
  1736. }
  1737. // Translate the selected columns
  1738. //
  1739. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1740. $oBuild->m_oQBExpressions->Translate($aTranslation, false);
  1741. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1742. //MyHelpers::var_dump_html($oSelectBase->RenderSelect());
  1743. return $oSelectBase;
  1744. }
  1745. /**
  1746. * Get the friendly name for the class and its subclasses (if finalclass = 'subclass' ...)
  1747. * Simplifies the final expression by grouping classes having the same name expression
  1748. * Used when querying a parent class
  1749. */
  1750. static protected function GetExtendedNameExpression($sClass)
  1751. {
  1752. // 1st step - get all of the required expressions (instantiable classes)
  1753. // and group them using their OQL representation
  1754. //
  1755. $aFNExpressions = array(); // signature => array('expression' => oExp, 'classes' => array of classes)
  1756. foreach (MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL) as $sSubClass)
  1757. {
  1758. if (($sSubClass != $sClass) && MetaModel::IsAbstract($sSubClass)) continue;
  1759. $oSubClassName = MetaModel::GetNameExpression($sSubClass);
  1760. $sSignature = $oSubClassName->Render();
  1761. if (!array_key_exists($sSignature, $aFNExpressions))
  1762. {
  1763. $aFNExpressions[$sSignature] = array(
  1764. 'expression' => $oSubClassName,
  1765. 'classes' => array(),
  1766. );
  1767. }
  1768. $aFNExpressions[$sSignature]['classes'][] = $sSubClass;
  1769. }
  1770. // 2nd step - build the final name expression depending on the finalclass
  1771. //
  1772. if (count($aFNExpressions) == 1)
  1773. {
  1774. $aExpData = reset($aFNExpressions);
  1775. $oNameExpression = $aExpData['expression'];
  1776. }
  1777. else
  1778. {
  1779. $oNameExpression = null;
  1780. foreach ($aFNExpressions as $sSignature => $aExpData)
  1781. {
  1782. $oClassListExpr = ListExpression::FromScalars($aExpData['classes']);
  1783. $oClassExpr = new FieldExpression('finalclass', $sClass);
  1784. $oClassInList = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1785. if (is_null($oNameExpression))
  1786. {
  1787. $oNameExpression = $aExpData['expression'];
  1788. }
  1789. else
  1790. {
  1791. $oNameExpression = new FunctionExpression('IF', array($oClassInList, $aExpData['expression'], $oNameExpression));
  1792. }
  1793. }
  1794. }
  1795. return $oNameExpression;
  1796. }
  1797. }