dbobjectsearch.class.php 76 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192
  1. <?php
  2. // Copyright (C) 2010-2017 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-2017 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. foreach ($oFilter->m_aReferencedBy[$this->GetClass()][$sExtKeyAttCode][$iOperatorCode] as $oRemoteFilter)
  683. {
  684. if ($this->GetClass() == $oRemoteFilter->GetClass())
  685. {
  686. // Optimization - fold sibling query
  687. $aAliasTranslation = array();
  688. $this->MergeWith_InNamespace($oRemoteFilter, $this->m_aClasses, $aAliasTranslation);
  689. unset($oFilter->m_aReferencedBy[$this->GetClass()][$sExtKeyAttCode][$iOperatorCode]);
  690. $this->m_oSearchCondition = $this->m_oSearchCondition->Translate($aAliasTranslation, false, false);
  691. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  692. break;
  693. }
  694. }
  695. }
  696. }
  697. $this->RecomputeClassList($this->m_aClasses);
  698. return $res;
  699. }
  700. protected function AddCondition_PointingTo_InNameSpace(DBObjectSearch $oFilter, $sExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
  701. {
  702. // Find the node on which the new tree must be attached (most of the time it is "this")
  703. $oReceivingFilter = $this->GetNode($this->GetClassAlias());
  704. $bMerged = false;
  705. if (ENABLE_OPT && isset($oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode]))
  706. {
  707. foreach ($oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode] as $oExisting)
  708. {
  709. if ($oExisting->GetClass() == $oFilter->GetClass())
  710. {
  711. $oExisting->MergeWith_InNamespace($oFilter, $oExisting->m_aClasses, $aAliasTranslation);
  712. $bMerged = true;
  713. break;
  714. }
  715. }
  716. }
  717. if (!$bMerged)
  718. {
  719. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  720. $oReceivingFilter->m_aPointingTo[$sExtKeyAttCode][$iOperatorCode][] = $oFilter;
  721. }
  722. }
  723. /**
  724. * @param DBObjectSearch $oFilter
  725. * @param $sForeignExtKeyAttCode
  726. * @param int $iOperatorCode
  727. * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
  728. */
  729. public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
  730. {
  731. $sForeignClass = $oFilter->GetClass();
  732. if (!MetaModel::IsValidKeyAttCode($sForeignClass, $sForeignExtKeyAttCode))
  733. {
  734. throw new CoreException("The attribute code '$sForeignExtKeyAttCode' is not an external key of the class '{$sForeignClass}'");
  735. }
  736. $oAttExtKey = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  737. if(!MetaModel::IsSameFamilyBranch($this->GetClass(), $oAttExtKey->GetTargetClass()))
  738. {
  739. // à refaire en spécifique dans FromOQL
  740. 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()}");
  741. }
  742. // Note: though it seems to be a good practice to clone the given source filter
  743. // (as it was done and fixed an issue in Intersect())
  744. // this was not implemented here because it was causing a regression (login as admin, select an org, click on any badge)
  745. // root cause: FromOQL relies on the fact that the passed filter can be modified later
  746. // NO: $oFilter = $oFilter->DeepClone();
  747. // See also: Trac #639, and self::AddCondition_PointingTo()
  748. $aAliasTranslation = array();
  749. $res = $this->AddCondition_ReferencedBy_InNameSpace($oFilter, $sForeignExtKeyAttCode, $this->m_aClasses, $aAliasTranslation, $iOperatorCode);
  750. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  751. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  752. if (ENABLE_OPT && ($oFilter->GetClass() == $oFilter->GetFirstJoinedClass()))
  753. {
  754. if (isset($oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode]))
  755. {
  756. foreach ($oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode] as $oRemoteFilter)
  757. {
  758. if ($this->GetClass() == $oRemoteFilter->GetClass())
  759. {
  760. // Optimization - fold sibling query
  761. $aAliasTranslation = array();
  762. $this->MergeWith_InNamespace($oRemoteFilter, $this->m_aClasses, $aAliasTranslation);
  763. unset($oFilter->m_aPointingTo[$sForeignExtKeyAttCode][$iOperatorCode]);
  764. $this->m_oSearchCondition = $this->m_oSearchCondition->Translate($aAliasTranslation, false, false);
  765. $this->UpdateRealiasingMap($aRealiasingMap, $aAliasTranslation);
  766. break;
  767. }
  768. }
  769. }
  770. }
  771. $this->RecomputeClassList($this->m_aClasses);
  772. return $res;
  773. }
  774. protected function AddCondition_ReferencedBy_InNameSpace(DBSearch $oFilter, $sForeignExtKeyAttCode, &$aClassAliases, &$aAliasTranslation, $iOperatorCode)
  775. {
  776. $sForeignClass = $oFilter->GetClass();
  777. // Find the node on which the new tree must be attached (most of the time it is "this")
  778. $oReceivingFilter = $this->GetNode($this->GetClassAlias());
  779. $bMerged = false;
  780. if (ENABLE_OPT && isset($oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode]))
  781. {
  782. foreach ($oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode] as $oExisting)
  783. {
  784. if ($oExisting->GetClass() == $oFilter->GetClass())
  785. {
  786. $oExisting->MergeWith_InNamespace($oFilter, $oExisting->m_aClasses, $aAliasTranslation);
  787. $bMerged = true;
  788. break;
  789. }
  790. }
  791. }
  792. if (!$bMerged)
  793. {
  794. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  795. $oReceivingFilter->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode][$iOperatorCode][] = $oFilter;
  796. }
  797. }
  798. public function Intersect(DBSearch $oFilter)
  799. {
  800. if ($oFilter instanceof DBUnionSearch)
  801. {
  802. // Develop!
  803. $aFilters = $oFilter->GetSearches();
  804. }
  805. else
  806. {
  807. $aFilters = array($oFilter);
  808. }
  809. $aSearches = array();
  810. foreach ($aFilters as $oRightFilter)
  811. {
  812. // Limitation: the queried class must be the first declared class
  813. if ($this->GetFirstJoinedClassAlias() != $this->GetClassAlias())
  814. {
  815. 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()})");
  816. }
  817. if ($oRightFilter->GetFirstJoinedClassAlias() != $oRightFilter->GetClassAlias())
  818. {
  819. 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()})");
  820. }
  821. $oLeftFilter = $this->DeepClone();
  822. $oRightFilter = $oRightFilter->DeepClone();
  823. $bAllowAllData = ($oLeftFilter->IsAllDataAllowed() && $oRightFilter->IsAllDataAllowed());
  824. $oLeftFilter->AllowAllData($bAllowAllData);
  825. if ($oLeftFilter->GetClass() != $oRightFilter->GetClass())
  826. {
  827. if (MetaModel::IsParentClass($oLeftFilter->GetClass(), $oRightFilter->GetClass()))
  828. {
  829. // Specialize $oLeftFilter
  830. $oLeftFilter->ChangeClass($oRightFilter->GetClass());
  831. }
  832. elseif (MetaModel::IsParentClass($oRightFilter->GetClass(), $oLeftFilter->GetClass()))
  833. {
  834. // Specialize $oRightFilter
  835. $oRightFilter->ChangeClass($oLeftFilter->GetClass());
  836. }
  837. else
  838. {
  839. throw new CoreException("Attempting to merge a filter of class '{$oLeftFilter->GetClass()}' with a filter of class '{$oRightFilter->GetClass()}'");
  840. }
  841. }
  842. $aAliasTranslation = array();
  843. $oLeftFilter->MergeWith_InNamespace($oRightFilter, $oLeftFilter->m_aClasses, $aAliasTranslation);
  844. $oLeftFilter->TransferConditionExpression($oRightFilter, $aAliasTranslation);
  845. $aSearches[] = $oLeftFilter;
  846. }
  847. if (count($aSearches) == 1)
  848. {
  849. // return a DBObjectSearch
  850. return $aSearches[0];
  851. }
  852. else
  853. {
  854. return new DBUnionSearch($aSearches);
  855. }
  856. }
  857. protected function MergeWith_InNamespace($oFilter, &$aClassAliases, &$aAliasTranslation)
  858. {
  859. if ($this->GetClass() != $oFilter->GetClass())
  860. {
  861. throw new CoreException("Attempting to merge a filter of class '{$this->GetClass()}' with a filter of class '{$oFilter->GetClass()}'");
  862. }
  863. // Translate search condition into our aliasing scheme
  864. $aAliasTranslation[$oFilter->GetClassAlias()]['*'] = $this->GetClassAlias();
  865. $this->m_aFullText = array_merge($this->m_aFullText, $oFilter->m_aFullText);
  866. foreach($oFilter->m_aPointingTo as $sExtKeyAttCode=>$aPointingTo)
  867. {
  868. foreach($aPointingTo as $iOperatorCode => $aFilter)
  869. {
  870. foreach($aFilter as $oExtFilter)
  871. {
  872. $this->AddCondition_PointingTo_InNamespace($oExtFilter, $sExtKeyAttCode, $aClassAliases, $aAliasTranslation, $iOperatorCode);
  873. }
  874. }
  875. }
  876. foreach($oFilter->m_aReferencedBy as $sForeignClass => $aReferences)
  877. {
  878. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  879. {
  880. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  881. {
  882. foreach ($aFilters as $oForeignFilter)
  883. {
  884. $this->AddCondition_ReferencedBy_InNamespace($oForeignFilter, $sForeignExtKeyAttCode, $aClassAliases, $aAliasTranslation, $iOperatorCode);
  885. }
  886. }
  887. }
  888. }
  889. }
  890. public function GetCriteria() {return $this->m_oSearchCondition;}
  891. public function GetCriteria_FullText() {return $this->m_aFullText;}
  892. protected function GetCriteria_PointingTo($sKeyAttCode = "")
  893. {
  894. if (empty($sKeyAttCode))
  895. {
  896. return $this->m_aPointingTo;
  897. }
  898. if (!array_key_exists($sKeyAttCode, $this->m_aPointingTo)) return array();
  899. return $this->m_aPointingTo[$sKeyAttCode];
  900. }
  901. protected function GetCriteria_ReferencedBy()
  902. {
  903. return $this->m_aReferencedBy;
  904. }
  905. public function SetInternalParams($aParams)
  906. {
  907. return $this->m_aParams = $aParams;
  908. }
  909. public function GetInternalParams()
  910. {
  911. return $this->m_aParams;
  912. }
  913. public function GetQueryParams($bExcludeMagicParams = true)
  914. {
  915. $aParams = array();
  916. $this->m_oSearchCondition->Render($aParams, true);
  917. if ($bExcludeMagicParams)
  918. {
  919. $aRet = array();
  920. // Make the list of acceptable arguments... could be factorized with run_query, into oSearch->GetQueryParams($bExclude magic params)
  921. $aNakedMagicArguments = array();
  922. foreach (MetaModel::PrepareQueryArguments(array()) as $sArgName => $value)
  923. {
  924. $iPos = strpos($sArgName, '->object()');
  925. if ($iPos === false)
  926. {
  927. $aNakedMagicArguments[$sArgName] = $value;
  928. }
  929. else
  930. {
  931. $aNakedMagicArguments[substr($sArgName, 0, $iPos)] = true;
  932. }
  933. }
  934. foreach ($aParams as $sParam => $foo)
  935. {
  936. $iPos = strpos($sParam, '->');
  937. if ($iPos === false)
  938. {
  939. $sRefName = $sParam;
  940. }
  941. else
  942. {
  943. $sRefName = substr($sParam, 0, $iPos);
  944. }
  945. if (!array_key_exists($sRefName, $aNakedMagicArguments))
  946. {
  947. $aRet[$sParam] = $foo;
  948. }
  949. }
  950. }
  951. return $aRet;
  952. }
  953. public function ListConstantFields()
  954. {
  955. return $this->m_oSearchCondition->ListConstantFields();
  956. }
  957. /**
  958. * Turn the parameters (:xxx) into scalar values in order to easily
  959. * serialize a search
  960. */
  961. public function ApplyParameters($aArgs)
  962. {
  963. return $this->m_oSearchCondition->ApplyParameters(array_merge($this->m_aParams, $aArgs));
  964. }
  965. public function ToOQL($bDevelopParams = false, $aContextParams = null, $bWithAllowAllFlag = false)
  966. {
  967. // Currently unused, but could be useful later
  968. $bRetrofitParams = false;
  969. if ($bDevelopParams)
  970. {
  971. if (is_null($aContextParams))
  972. {
  973. $aParams = array_merge($this->m_aParams);
  974. }
  975. else
  976. {
  977. $aParams = array_merge($aContextParams, $this->m_aParams);
  978. }
  979. $aParams = MetaModel::PrepareQueryArguments($aParams);
  980. }
  981. else
  982. {
  983. // Leave it as is, the rendering will be made with parameters in clear
  984. $aParams = null;
  985. }
  986. $aSelectedAliases = array();
  987. foreach ($this->m_aSelectedClasses as $sAlias => $sClass)
  988. {
  989. $aSelectedAliases[] = '`' . $sAlias . '`';
  990. }
  991. $sSelectedClasses = implode(', ', $aSelectedAliases);
  992. $sRes = 'SELECT '.$sSelectedClasses.' FROM';
  993. $sRes .= ' ' . $this->GetFirstJoinedClass() . ' AS `' . $this->GetFirstJoinedClassAlias() . '`';
  994. $sRes .= $this->ToOQL_Joins();
  995. $sRes .= " WHERE ".$this->m_oSearchCondition->Render($aParams, $bRetrofitParams);
  996. // Temporary: add more info about other conditions, necessary to avoid strange behaviors with the cache
  997. foreach($this->m_aFullText as $sFullText)
  998. {
  999. $sRes .= " AND MATCHES '$sFullText'";
  1000. }
  1001. if ($bWithAllowAllFlag && $this->m_bAllowAllData)
  1002. {
  1003. $sRes .= " ALLOW ALL DATA";
  1004. }
  1005. return $sRes;
  1006. }
  1007. protected function OperatorCodeToOQL($iOperatorCode)
  1008. {
  1009. switch($iOperatorCode)
  1010. {
  1011. case TREE_OPERATOR_EQUALS:
  1012. $sOperator = ' = ';
  1013. break;
  1014. case TREE_OPERATOR_BELOW:
  1015. $sOperator = ' BELOW ';
  1016. break;
  1017. case TREE_OPERATOR_BELOW_STRICT:
  1018. $sOperator = ' BELOW STRICT ';
  1019. break;
  1020. case TREE_OPERATOR_NOT_BELOW:
  1021. $sOperator = ' NOT BELOW ';
  1022. break;
  1023. case TREE_OPERATOR_NOT_BELOW_STRICT:
  1024. $sOperator = ' NOT BELOW STRICT ';
  1025. break;
  1026. case TREE_OPERATOR_ABOVE:
  1027. $sOperator = ' ABOVE ';
  1028. break;
  1029. case TREE_OPERATOR_ABOVE_STRICT:
  1030. $sOperator = ' ABOVE STRICT ';
  1031. break;
  1032. case TREE_OPERATOR_NOT_ABOVE:
  1033. $sOperator = ' NOT ABOVE ';
  1034. break;
  1035. case TREE_OPERATOR_NOT_ABOVE_STRICT:
  1036. $sOperator = ' NOT ABOVE STRICT ';
  1037. break;
  1038. }
  1039. return $sOperator;
  1040. }
  1041. protected function ToOQL_Joins()
  1042. {
  1043. $sRes = '';
  1044. foreach($this->m_aPointingTo as $sExtKey => $aPointingTo)
  1045. {
  1046. foreach($aPointingTo as $iOperatorCode => $aFilter)
  1047. {
  1048. $sOperator = $this->OperatorCodeToOQL($iOperatorCode);
  1049. foreach($aFilter as $oFilter)
  1050. {
  1051. $sRes .= ' JOIN ' . $oFilter->GetFirstJoinedClass() . ' AS `' . $oFilter->GetFirstJoinedClassAlias() . '` ON `' . $this->GetFirstJoinedClassAlias() . '`.' . $sExtKey . $sOperator . '`' . $oFilter->GetFirstJoinedClassAlias() . '`.id';
  1052. $sRes .= $oFilter->ToOQL_Joins();
  1053. }
  1054. }
  1055. }
  1056. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  1057. {
  1058. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  1059. {
  1060. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  1061. {
  1062. $sOperator = $this->OperatorCodeToOQL($iOperatorCode);
  1063. foreach ($aFilters as $oForeignFilter)
  1064. {
  1065. $sRes .= ' JOIN ' . $oForeignFilter->GetFirstJoinedClass() . ' AS `' . $oForeignFilter->GetFirstJoinedClassAlias() . '` ON `' . $oForeignFilter->GetFirstJoinedClassAlias() . '`.' . $sForeignExtKeyAttCode . $sOperator . '`' . $this->GetFirstJoinedClassAlias() . '`.id';
  1066. $sRes .= $oForeignFilter->ToOQL_Joins();
  1067. }
  1068. }
  1069. }
  1070. }
  1071. return $sRes;
  1072. }
  1073. protected function OQLExpressionToCondition($sQuery, $oExpression, $aClassAliases)
  1074. {
  1075. if ($oExpression instanceof BinaryOqlExpression)
  1076. {
  1077. $sOperator = $oExpression->GetOperator();
  1078. $oLeft = $this->OQLExpressionToCondition($sQuery, $oExpression->GetLeftExpr(), $aClassAliases);
  1079. $oRight = $this->OQLExpressionToCondition($sQuery, $oExpression->GetRightExpr(), $aClassAliases);
  1080. return new BinaryExpression($oLeft, $sOperator, $oRight);
  1081. }
  1082. elseif ($oExpression instanceof FieldOqlExpression)
  1083. {
  1084. $sClassAlias = $oExpression->GetParent();
  1085. $sFltCode = $oExpression->GetName();
  1086. if (empty($sClassAlias))
  1087. {
  1088. // Need to find the right alias
  1089. // Build an array of field => array of aliases
  1090. $aFieldClasses = array();
  1091. foreach($aClassAliases as $sAlias => $sReal)
  1092. {
  1093. foreach(MetaModel::GetFiltersList($sReal) as $sAnFltCode)
  1094. {
  1095. $aFieldClasses[$sAnFltCode][] = $sAlias;
  1096. }
  1097. }
  1098. $sClassAlias = $aFieldClasses[$sFltCode][0];
  1099. }
  1100. return new FieldExpression($sFltCode, $sClassAlias);
  1101. }
  1102. elseif ($oExpression instanceof VariableOqlExpression)
  1103. {
  1104. return new VariableExpression($oExpression->GetName());
  1105. }
  1106. elseif ($oExpression instanceof TrueOqlExpression)
  1107. {
  1108. return new TrueExpression;
  1109. }
  1110. elseif ($oExpression instanceof ScalarOqlExpression)
  1111. {
  1112. return new ScalarExpression($oExpression->GetValue());
  1113. }
  1114. elseif ($oExpression instanceof ListOqlExpression)
  1115. {
  1116. $aItems = array();
  1117. foreach ($oExpression->GetItems() as $oItemExpression)
  1118. {
  1119. $aItems[] = $this->OQLExpressionToCondition($sQuery, $oItemExpression, $aClassAliases);
  1120. }
  1121. return new ListExpression($aItems);
  1122. }
  1123. elseif ($oExpression instanceof FunctionOqlExpression)
  1124. {
  1125. $aArgs = array();
  1126. foreach ($oExpression->GetArgs() as $oArgExpression)
  1127. {
  1128. $aArgs[] = $this->OQLExpressionToCondition($sQuery, $oArgExpression, $aClassAliases);
  1129. }
  1130. return new FunctionExpression($oExpression->GetVerb(), $aArgs);
  1131. }
  1132. elseif ($oExpression instanceof IntervalOqlExpression)
  1133. {
  1134. return new IntervalExpression($oExpression->GetValue(), $oExpression->GetUnit());
  1135. }
  1136. else
  1137. {
  1138. throw new CoreException('Unknown expression type', array('class'=>get_class($oExpression), 'query'=>$sQuery));
  1139. }
  1140. }
  1141. public function InitFromOqlQuery(OqlQuery $oOqlQuery, $sQuery)
  1142. {
  1143. $oModelReflection = new ModelReflectionRuntime();
  1144. $sClass = $oOqlQuery->GetClass($oModelReflection);
  1145. $sClassAlias = $oOqlQuery->GetClassAlias();
  1146. $aAliases = array($sClassAlias => $sClass);
  1147. // Note: the condition must be built here, it may be altered later on when optimizing some joins
  1148. $oConditionTree = $oOqlQuery->GetCondition();
  1149. if ($oConditionTree instanceof Expression)
  1150. {
  1151. $aRawAliases = array($sClassAlias => $sClass);
  1152. $aJoinSpecs = $oOqlQuery->GetJoins();
  1153. if (is_array($aJoinSpecs))
  1154. {
  1155. foreach ($aJoinSpecs as $oJoinSpec)
  1156. {
  1157. $aRawAliases[$oJoinSpec->GetClassAlias()] = $oJoinSpec->GetClass();
  1158. }
  1159. }
  1160. $this->m_oSearchCondition = $this->OQLExpressionToCondition($sQuery, $oConditionTree, $aRawAliases);
  1161. }
  1162. // Maintain an array of filters, because the flat list is in fact referring to a tree
  1163. // And this will be an easy way to dispatch the conditions
  1164. // $this will be referenced by the other filters, or the other way around...
  1165. $aJoinItems = array($sClassAlias => $this);
  1166. $aJoinSpecs = $oOqlQuery->GetJoins();
  1167. if (is_array($aJoinSpecs))
  1168. {
  1169. $aAliasTranslation = array();
  1170. foreach ($aJoinSpecs as $oJoinSpec)
  1171. {
  1172. $sJoinClass = $oJoinSpec->GetClass();
  1173. $sJoinClassAlias = $oJoinSpec->GetClassAlias();
  1174. if (isset($aAliasTranslation[$sJoinClassAlias]['*']))
  1175. {
  1176. $sJoinClassAlias = $aAliasTranslation[$sJoinClassAlias]['*'];
  1177. }
  1178. // Assumption: ext key on the left only !!!
  1179. // normalization should take care of this
  1180. $oLeftField = $oJoinSpec->GetLeftField();
  1181. $sFromClass = $oLeftField->GetParent();
  1182. if (isset($aAliasTranslation[$sFromClass]['*']))
  1183. {
  1184. $sFromClass = $aAliasTranslation[$sFromClass]['*'];
  1185. }
  1186. $sExtKeyAttCode = $oLeftField->GetName();
  1187. $oRightField = $oJoinSpec->GetRightField();
  1188. $sToClass = $oRightField->GetParent();
  1189. if (isset($aAliasTranslation[$sToClass]['*']))
  1190. {
  1191. $sToClass = $aAliasTranslation[$sToClass]['*'];
  1192. }
  1193. $aAliases[$sJoinClassAlias] = $sJoinClass;
  1194. $aJoinItems[$sJoinClassAlias] = new DBObjectSearch($sJoinClass, $sJoinClassAlias);
  1195. $sOperator = $oJoinSpec->GetOperator();
  1196. switch($sOperator)
  1197. {
  1198. case '=':
  1199. default:
  1200. $iOperatorCode = TREE_OPERATOR_EQUALS;
  1201. break;
  1202. case 'BELOW':
  1203. $iOperatorCode = TREE_OPERATOR_BELOW;
  1204. break;
  1205. case 'BELOW_STRICT':
  1206. $iOperatorCode = TREE_OPERATOR_BELOW_STRICT;
  1207. break;
  1208. case 'NOT_BELOW':
  1209. $iOperatorCode = TREE_OPERATOR_NOT_BELOW;
  1210. break;
  1211. case 'NOT_BELOW_STRICT':
  1212. $iOperatorCode = TREE_OPERATOR_NOT_BELOW_STRICT;
  1213. break;
  1214. case 'ABOVE':
  1215. $iOperatorCode = TREE_OPERATOR_ABOVE;
  1216. break;
  1217. case 'ABOVE_STRICT':
  1218. $iOperatorCode = TREE_OPERATOR_ABOVE_STRICT;
  1219. break;
  1220. case 'NOT_ABOVE':
  1221. $iOperatorCode = TREE_OPERATOR_NOT_ABOVE;
  1222. break;
  1223. case 'NOT_ABOVE_STRICT':
  1224. $iOperatorCode = TREE_OPERATOR_NOT_ABOVE_STRICT;
  1225. break;
  1226. }
  1227. if ($sFromClass == $sJoinClassAlias)
  1228. {
  1229. $oReceiver = $aJoinItems[$sToClass];
  1230. $oNewComer = $aJoinItems[$sFromClass];
  1231. $oReceiver->AddCondition_ReferencedBy_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation, $iOperatorCode);
  1232. }
  1233. else
  1234. {
  1235. $oReceiver = $aJoinItems[$sFromClass];
  1236. $oNewComer = $aJoinItems[$sToClass];
  1237. $oReceiver->AddCondition_PointingTo_InNameSpace($oNewComer, $sExtKeyAttCode, $oReceiver->m_aClasses, $aAliasTranslation, $iOperatorCode);
  1238. }
  1239. }
  1240. $this->m_oSearchCondition = $this->m_oSearchCondition->Translate($aAliasTranslation, false, false /* leave unresolved fields */);
  1241. }
  1242. // Check and prepare the select information
  1243. $this->m_aSelectedClasses = array();
  1244. foreach ($oOqlQuery->GetSelectedClasses() as $oClassDetails)
  1245. {
  1246. $sClassToSelect = $oClassDetails->GetValue();
  1247. $this->m_aSelectedClasses[$sClassToSelect] = $aAliases[$sClassToSelect];
  1248. }
  1249. $this->m_aClasses = $aAliases;
  1250. }
  1251. ////////////////////////////////////////////////////////////////////////////
  1252. //
  1253. // Construction of the SQL queries
  1254. //
  1255. ////////////////////////////////////////////////////////////////////////////
  1256. public function MakeDeleteQuery($aArgs = array())
  1257. {
  1258. $aModifierProperties = MetaModel::MakeModifierProperties($this);
  1259. $oBuild = new QueryBuilderContext($this, $aModifierProperties);
  1260. $oSQLQuery = $this->MakeSQLObjectQuery($oBuild, null, array());
  1261. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1262. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1263. $aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
  1264. return $oSQLQuery->RenderDelete($aScalarArgs);
  1265. }
  1266. public function MakeUpdateQuery($aValues, $aArgs = array())
  1267. {
  1268. // $aValues is an array of $sAttCode => $value
  1269. $aModifierProperties = MetaModel::MakeModifierProperties($this);
  1270. $oBuild = new QueryBuilderContext($this, $aModifierProperties);
  1271. $oSQLQuery = $this->MakeSQLObjectQuery($oBuild, null, $aValues);
  1272. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1273. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1274. $aScalarArgs = MetaModel::PrepareQueryArguments($aArgs, $this->GetInternalParams());
  1275. return $oSQLQuery->RenderUpdate($aScalarArgs);
  1276. }
  1277. public function GetSQLQueryStructure($aAttToLoad, $bGetCount, $aGroupByExpr = null, $aSelectedClasses = null)
  1278. {
  1279. // Hide objects that are not visible to the current user
  1280. //
  1281. $oSearch = $this;
  1282. if (!$this->IsAllDataAllowed() && !$this->IsDataFiltered())
  1283. {
  1284. $oVisibleObjects = UserRights::GetSelectFilter($this->GetClass(), $this->GetModifierProperties('UserRightsGetSelectFilter'));
  1285. if ($oVisibleObjects === false)
  1286. {
  1287. // Make sure this is a valid search object, saying NO for all
  1288. $oVisibleObjects = DBObjectSearch::FromEmptySet($this->GetClass());
  1289. }
  1290. if (is_object($oVisibleObjects))
  1291. {
  1292. $oVisibleObjects->AllowAllData();
  1293. $oSearch = $this->Intersect($oVisibleObjects);
  1294. $oSearch->SetDataFiltered();
  1295. }
  1296. else
  1297. {
  1298. // should be true at this point, meaning that no additional filtering
  1299. // is required
  1300. }
  1301. }
  1302. // Compute query modifiers properties (can be set in the search itself, by the context, etc.)
  1303. //
  1304. $aModifierProperties = MetaModel::MakeModifierProperties($oSearch);
  1305. // Create a unique cache id
  1306. //
  1307. if (self::$m_bQueryCacheEnabled || self::$m_bTraceQueries)
  1308. {
  1309. // Need to identify the query
  1310. $sOqlQuery = $oSearch->ToOql(false, null, true);
  1311. if (count($aModifierProperties))
  1312. {
  1313. array_multisort($aModifierProperties);
  1314. $sModifierProperties = json_encode($aModifierProperties);
  1315. }
  1316. else
  1317. {
  1318. $sModifierProperties = '';
  1319. }
  1320. $sRawId = $sOqlQuery.$sModifierProperties;
  1321. if (!is_null($aAttToLoad))
  1322. {
  1323. $sRawId .= json_encode($aAttToLoad);
  1324. }
  1325. if (!is_null($aGroupByExpr))
  1326. {
  1327. foreach($aGroupByExpr as $sAlias => $oExpr)
  1328. {
  1329. $sRawId .= 'g:'.$sAlias.'!'.$oExpr->Render();
  1330. }
  1331. }
  1332. $sRawId .= $bGetCount;
  1333. if (is_array($aSelectedClasses))
  1334. {
  1335. $sRawId .= implode(',', $aSelectedClasses); // Unions may alter the list of selected columns
  1336. }
  1337. $sRawId .= $oSearch->GetArchiveMode() ? '--arch' : '';
  1338. $sOqlId = md5($sRawId);
  1339. }
  1340. else
  1341. {
  1342. $sOqlQuery = "SELECTING... ".$oSearch->GetClass();
  1343. $sOqlId = "query id ? n/a";
  1344. }
  1345. // Query caching
  1346. //
  1347. if (self::$m_bQueryCacheEnabled)
  1348. {
  1349. // Warning: using directly the query string as the key to the hash array can FAIL if the string
  1350. // is long and the differences are only near the end... so it's safer (but not bullet proof?)
  1351. // to use a hash (like md5) of the string as the key !
  1352. //
  1353. // Example of two queries that were found as similar by the hash array:
  1354. // SELECT SLT JOIN lnkSLTToSLA AS L1 ON L1.slt_id=SLT.id JOIN SLA ON L1.sla_id = SLA.id JOIN lnkContractToSLA AS L2 ON L2.sla_id = SLA.id JOIN CustomerContract ON L2.contract_id = CustomerContract.id WHERE SLT.ticket_priority = 1 AND SLA.service_id = 3 AND SLT.metric = 'TTO' AND CustomerContract.customer_id = 2
  1355. // and
  1356. // SELECT SLT JOIN lnkSLTToSLA AS L1 ON L1.slt_id=SLT.id JOIN SLA ON L1.sla_id = SLA.id JOIN lnkContractToSLA AS L2 ON L2.sla_id = SLA.id JOIN CustomerContract ON L2.contract_id = CustomerContract.id WHERE SLT.ticket_priority = 1 AND SLA.service_id = 3 AND SLT.metric = 'TTR' AND CustomerContract.customer_id = 2
  1357. // the only difference is R instead or O at position 285 (TTR instead of TTO)...
  1358. //
  1359. if (array_key_exists($sOqlId, self::$m_aQueryStructCache))
  1360. {
  1361. // hit!
  1362. $oSQLQuery = unserialize(serialize(self::$m_aQueryStructCache[$sOqlId]));
  1363. // Note: cloning is not enough because the subtree is made of objects
  1364. }
  1365. elseif (self::$m_bUseAPCCache)
  1366. {
  1367. // Note: For versions of APC older than 3.0.17, fetch() accepts only one parameter
  1368. //
  1369. $sOqlAPCCacheId = 'itop-'.MetaModel::GetEnvironmentId().'-query-cache-'.$sOqlId;
  1370. $oKPI = new ExecutionKPI();
  1371. $result = apc_fetch($sOqlAPCCacheId);
  1372. $oKPI->ComputeStats('Query APC (fetch)', $sOqlQuery);
  1373. if (is_object($result))
  1374. {
  1375. $oSQLQuery = $result;
  1376. self::$m_aQueryStructCache[$sOqlId] = $oSQLQuery;
  1377. }
  1378. }
  1379. }
  1380. if (!isset($oSQLQuery))
  1381. {
  1382. $oKPI = new ExecutionKPI();
  1383. $oSQLQuery = $oSearch->BuildSQLQueryStruct($aAttToLoad, $bGetCount, $aModifierProperties, $aGroupByExpr, $aSelectedClasses);
  1384. $oKPI->ComputeStats('BuildSQLQueryStruct', $sOqlQuery);
  1385. if (self::$m_bQueryCacheEnabled)
  1386. {
  1387. if (self::$m_bUseAPCCache)
  1388. {
  1389. $oKPI = new ExecutionKPI();
  1390. apc_store($sOqlAPCCacheId, $oSQLQuery, self::$m_iQueryCacheTTL);
  1391. $oKPI->ComputeStats('Query APC (store)', $sOqlQuery);
  1392. }
  1393. self::$m_aQueryStructCache[$sOqlId] = $oSQLQuery->DeepClone();
  1394. }
  1395. }
  1396. return $oSQLQuery;
  1397. }
  1398. protected function BuildSQLQueryStruct($aAttToLoad, $bGetCount, $aModifierProperties, $aGroupByExpr = null, $aSelectedClasses = null)
  1399. {
  1400. $oBuild = new QueryBuilderContext($this, $aModifierProperties, $aGroupByExpr, $aSelectedClasses);
  1401. $oSQLQuery = $this->MakeSQLObjectQuery($oBuild, $aAttToLoad, array());
  1402. $oSQLQuery->SetCondition($oBuild->m_oQBExpressions->GetCondition());
  1403. if ($aGroupByExpr)
  1404. {
  1405. $aCols = $oBuild->m_oQBExpressions->GetGroupBy();
  1406. $oSQLQuery->SetGroupBy($aCols);
  1407. $oSQLQuery->SetSelect($aCols);
  1408. }
  1409. else
  1410. {
  1411. $oSQLQuery->SetSelect($oBuild->m_oQBExpressions->GetSelect());
  1412. }
  1413. $aMandatoryTables = null;
  1414. if (self::$m_bOptimizeQueries)
  1415. {
  1416. if ($bGetCount)
  1417. {
  1418. // Simplify the query if just getting the count
  1419. $oSQLQuery->SetSelect(array());
  1420. }
  1421. $oBuild->m_oQBExpressions->GetMandatoryTables($aMandatoryTables);
  1422. $oSQLQuery->OptimizeJoins($aMandatoryTables);
  1423. }
  1424. // Filter tables as late as possible: do not interfere with the optimization process
  1425. foreach ($oBuild->GetFilteredTables() as $sTableAlias => $aConditions)
  1426. {
  1427. if ($aMandatoryTables && array_key_exists($sTableAlias, $aMandatoryTables))
  1428. {
  1429. foreach ($aConditions as $oCondition)
  1430. {
  1431. $oSQLQuery->AddCondition($oCondition);
  1432. }
  1433. }
  1434. }
  1435. return $oSQLQuery;
  1436. }
  1437. protected function MakeSQLObjectQuery(&$oBuild, $aAttToLoad = null, $aValues = array())
  1438. {
  1439. // Note: query class might be different than the class of the filter
  1440. // -> this occurs when we are linking our class to an external class (referenced by, or pointing to)
  1441. $sClass = $this->GetFirstJoinedClass();
  1442. $sClassAlias = $this->GetFirstJoinedClassAlias();
  1443. $bIsOnQueriedClass = array_key_exists($sClassAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  1444. self::DbgTrace("Entering: ".$this->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  1445. $sRootClass = MetaModel::GetRootClass($sClass);
  1446. $sKeyField = MetaModel::DBGetKey($sClass);
  1447. if ($bIsOnQueriedClass)
  1448. {
  1449. // default to the whole list of attributes + the very std id/finalclass
  1450. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.'id', new FieldExpression('id', $sClassAlias));
  1451. if (is_null($aAttToLoad) || !array_key_exists($sClassAlias, $aAttToLoad))
  1452. {
  1453. $sSelectedClass = $oBuild->GetSelectedClass($sClassAlias);
  1454. $aAttList = MetaModel::ListAttributeDefs($sSelectedClass);
  1455. }
  1456. else
  1457. {
  1458. $aAttList = $aAttToLoad[$sClassAlias];
  1459. }
  1460. foreach ($aAttList as $sAttCode => $oAttDef)
  1461. {
  1462. if (!$oAttDef->IsScalar()) continue;
  1463. // keep because it can be used for sorting - if (!$oAttDef->LoadInObject()) continue;
  1464. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1465. {
  1466. $oBuild->m_oQBExpressions->AddSelect($sClassAlias.$sAttCode.$sColId, new FieldExpression($sAttCode.$sColId, $sClassAlias));
  1467. }
  1468. }
  1469. // Transform the full text condition into additional condition expression
  1470. $aFullText = $this->GetCriteria_FullText();
  1471. if (count($aFullText) > 0)
  1472. {
  1473. $aFullTextFields = array();
  1474. foreach (MetaModel::ListAttributeDefs($sClass) as $sAttCode => $oAttDef)
  1475. {
  1476. if (!$oAttDef->IsScalar()) continue;
  1477. if ($oAttDef->IsExternalKey()) continue;
  1478. $aFullTextFields[] = new FieldExpression($sAttCode, $sClassAlias);
  1479. }
  1480. $oTextFields = new CharConcatWSExpression(' ', $aFullTextFields);
  1481. foreach($aFullText as $sFTNeedle)
  1482. {
  1483. $oNewCond = new BinaryExpression($oTextFields, 'LIKE', new ScalarExpression("%$sFTNeedle%"));
  1484. $oBuild->m_oQBExpressions->AddCondition($oNewCond);
  1485. }
  1486. }
  1487. }
  1488. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1489. $aExpectedAtts = array(); // array of (attcode => fieldexpression)
  1490. //echo "<p>".__LINE__.": GetUnresolvedFields($sClassAlias, ...)</p>\n";
  1491. $oBuild->m_oQBExpressions->GetUnresolvedFields($sClassAlias, $aExpectedAtts);
  1492. // Compute a clear view of required joins (from the current class)
  1493. // Build the list of external keys:
  1494. // -> ext keys required by an explicit join
  1495. // -> ext keys mentionned in a 'pointing to' condition
  1496. // -> ext keys required for an external field
  1497. // -> ext keys required for a friendly name
  1498. //
  1499. $aExtKeys = array(); // array of sTableClass => array of (sAttCode (keys) => array of (sAttCode (fields)=> oAttDef))
  1500. //
  1501. // Optimization: could be partially computed once for all (cached) ?
  1502. //
  1503. if ($bIsOnQueriedClass)
  1504. {
  1505. // Get all Ext keys for the queried class (??)
  1506. foreach(MetaModel::GetKeysList($sClass) as $sKeyAttCode)
  1507. {
  1508. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1509. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1510. }
  1511. }
  1512. // Get all Ext keys used by the filter
  1513. foreach ($this->GetCriteria_PointingTo() as $sKeyAttCode => $aPointingTo)
  1514. {
  1515. if (array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  1516. {
  1517. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1518. $aExtKeys[$sKeyTableClass][$sKeyAttCode] = array();
  1519. }
  1520. }
  1521. $aFNJoinAlias = array(); // array of (subclass => alias)
  1522. if (array_key_exists('friendlyname', $aExpectedAtts))
  1523. {
  1524. // To optimize: detect a restriction on child classes in the condition expression
  1525. // e.g. SELECT FunctionalCI WHERE finalclass IN ('Server', 'VirtualMachine')
  1526. $oNameExpression = self::GetExtendedNameExpression($sClass);
  1527. $aNameFields = array();
  1528. $oNameExpression->GetUnresolvedFields('', $aNameFields);
  1529. $aTranslateNameFields = array();
  1530. foreach($aNameFields as $sSubClass => $aFields)
  1531. {
  1532. foreach($aFields as $sAttCode => $oField)
  1533. {
  1534. $oAttDef = MetaModel::GetAttributeDef($sSubClass, $sAttCode);
  1535. if ($oAttDef->IsExternalKey())
  1536. {
  1537. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sAttCode);
  1538. $aExtKeys[$sClassOfAttribute][$sAttCode] = array();
  1539. }
  1540. elseif ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1541. {
  1542. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1543. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sKeyAttCode);
  1544. $aExtKeys[$sClassOfAttribute][$sKeyAttCode][$sAttCode] = $oAttDef;
  1545. }
  1546. else
  1547. {
  1548. $sClassOfAttribute = MetaModel::GetAttributeOrigin($sSubClass, $sAttCode);
  1549. }
  1550. if (MetaModel::IsParentClass($sClassOfAttribute, $sClass))
  1551. {
  1552. // The attribute is part of the standard query
  1553. //
  1554. $sAliasForAttribute = $sClassAlias;
  1555. }
  1556. else
  1557. {
  1558. // The attribute will be available from an additional outer join
  1559. // For each subclass (table) one single join is enough
  1560. //
  1561. if (!array_key_exists($sClassOfAttribute, $aFNJoinAlias))
  1562. {
  1563. $sAliasForAttribute = $oBuild->GenerateClassAlias($sClassAlias.'_fn_'.$sClassOfAttribute, $sClassOfAttribute);
  1564. $aFNJoinAlias[$sClassOfAttribute] = $sAliasForAttribute;
  1565. }
  1566. else
  1567. {
  1568. $sAliasForAttribute = $aFNJoinAlias[$sClassOfAttribute];
  1569. }
  1570. }
  1571. $aTranslateNameFields[$sSubClass][$sAttCode] = new FieldExpression($sAttCode, $sAliasForAttribute);
  1572. }
  1573. }
  1574. $oNameExpression = $oNameExpression->Translate($aTranslateNameFields, false);
  1575. $aTranslateNow = array();
  1576. $aTranslateNow[$sClassAlias]['friendlyname'] = $oNameExpression;
  1577. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  1578. }
  1579. // Add the ext fields used in the select (eventually adds an external key)
  1580. foreach(MetaModel::ListAttributeDefs($sClass) as $sAttCode=>$oAttDef)
  1581. {
  1582. if ($oAttDef->IsExternalField() || ($oAttDef instanceof AttributeFriendlyName))
  1583. {
  1584. if (array_key_exists($sAttCode, $aExpectedAtts))
  1585. {
  1586. $sKeyAttCode = $oAttDef->GetKeyAttCode();
  1587. if ($sKeyAttCode != 'id')
  1588. {
  1589. // Add the external attribute
  1590. $sKeyTableClass = MetaModel::GetAttributeOrigin($sClass, $sKeyAttCode);
  1591. $aExtKeys[$sKeyTableClass][$sKeyAttCode][$sAttCode] = $oAttDef;
  1592. }
  1593. }
  1594. }
  1595. }
  1596. // First query built upon on the leaf (ie current) class
  1597. //
  1598. self::DbgTrace("Main (=leaf) class, call MakeSQLObjectQuerySingleTable()");
  1599. if (MetaModel::HasTable($sClass))
  1600. {
  1601. $oSelectBase = $this->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sClass, $aExtKeys, $aValues);
  1602. }
  1603. else
  1604. {
  1605. $oSelectBase = null;
  1606. // As the join will not filter on the expected classes, we have to specify it explicitely
  1607. $sExpectedClasses = implode("', '", MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  1608. $oFinalClassRestriction = Expression::FromOQL("`$sClassAlias`.finalclass IN ('$sExpectedClasses')");
  1609. $oBuild->m_oQBExpressions->AddCondition($oFinalClassRestriction);
  1610. }
  1611. // Then we join the queries of the eventual parent classes (compound model)
  1612. foreach(MetaModel::EnumParentClasses($sClass) as $sParentClass)
  1613. {
  1614. if (!MetaModel::HasTable($sParentClass)) continue;
  1615. self::DbgTrace("Parent class: $sParentClass... let's call MakeSQLObjectQuerySingleTable()");
  1616. $oSelectParentTable = $this->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sParentClass, $aExtKeys, $aValues);
  1617. if (is_null($oSelectBase))
  1618. {
  1619. $oSelectBase = $oSelectParentTable;
  1620. }
  1621. else
  1622. {
  1623. $oSelectBase->AddInnerJoin($oSelectParentTable, $sKeyField, MetaModel::DBGetKey($sParentClass));
  1624. }
  1625. }
  1626. // Filter on objects referencing me
  1627. //
  1628. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  1629. {
  1630. foreach($aReferences as $sForeignExtKeyAttCode => $aFiltersByOperator)
  1631. {
  1632. foreach ($aFiltersByOperator as $iOperatorCode => $aFilters)
  1633. {
  1634. foreach ($aFilters as $oForeignFilter)
  1635. {
  1636. $oForeignKeyAttDef = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  1637. self::DbgTrace("Referenced by foreign key: $sForeignExtKeyAttCode... let's call MakeSQLObjectQuery()");
  1638. //self::DbgTrace($oForeignFilter);
  1639. //self::DbgTrace($oForeignFilter->ToOQL());
  1640. //self::DbgTrace($oSelectForeign);
  1641. //self::DbgTrace($oSelectForeign->RenderSelect(array()));
  1642. $sForeignClassAlias = $oForeignFilter->GetFirstJoinedClassAlias();
  1643. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sForeignExtKeyAttCode, $sForeignClassAlias));
  1644. if ($oForeignKeyAttDef instanceof AttributeObjectKey)
  1645. {
  1646. $sClassAttCode = $oForeignKeyAttDef->Get('class_attcode');
  1647. // Add the condition: `$sForeignClassAlias`.$sClassAttCode IN (subclasses of $sClass')
  1648. $oClassListExpr = ListExpression::FromScalars(MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL));
  1649. $oClassExpr = new FieldExpression($sClassAttCode, $sForeignClassAlias);
  1650. $oClassRestriction = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1651. $oBuild->m_oQBExpressions->AddCondition($oClassRestriction);
  1652. }
  1653. $oSelectForeign = $oForeignFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1654. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1655. $sForeignKeyTable = $oJoinExpr->GetParent();
  1656. $sForeignKeyColumn = $oJoinExpr->GetName();
  1657. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  1658. {
  1659. $oSelectBase->AddInnerJoin($oSelectForeign, $sKeyField, $sForeignKeyColumn, $sForeignKeyTable);
  1660. }
  1661. else
  1662. {
  1663. // Hierarchical key
  1664. $KeyLeft = $oForeignKeyAttDef->GetSQLLeft();
  1665. $KeyRight = $oForeignKeyAttDef->GetSQLRight();
  1666. $oSelectBase->AddInnerJoinTree($oSelectForeign, $KeyLeft, $KeyRight, $KeyLeft, $KeyRight, $sForeignKeyTable, $iOperatorCode, true);
  1667. }
  1668. }
  1669. }
  1670. }
  1671. }
  1672. // Additional JOINS for Friendly names
  1673. //
  1674. foreach ($aFNJoinAlias as $sSubClass => $sSubClassAlias)
  1675. {
  1676. $oSubClassFilter = new DBObjectSearch($sSubClass, $sSubClassAlias);
  1677. $oSelectFN = $oSubClassFilter->MakeSQLObjectQuerySingleTable($oBuild, $aAttToLoad, $sSubClass, $aExtKeys, array());
  1678. $oSelectBase->AddLeftJoin($oSelectFN, $sKeyField, MetaModel::DBGetKey($sSubClass));
  1679. }
  1680. // That's all... cross fingers and we'll get some working query
  1681. //MyHelpers::var_dump_html($oSelectBase, true);
  1682. //MyHelpers::var_dump_html($oSelectBase->RenderSelect(), true);
  1683. if (self::$m_bDebugQuery) $oSelectBase->DisplayHtml();
  1684. return $oSelectBase;
  1685. }
  1686. protected function MakeSQLObjectQuerySingleTable(&$oBuild, $aAttToLoad, $sTableClass, $aExtKeys, $aValues)
  1687. {
  1688. // $aExtKeys is an array of sTableClass => array of (sAttCode (keys) => array of sAttCode (fields))
  1689. //echo "MakeSQLObjectQuery($sTableClass)-liste des clefs externes($sTableClass): <pre>".print_r($aExtKeys, true)."</pre><br/>\n";
  1690. // Prepare the query for a single table (compound objects)
  1691. // Ignores the items (attributes/filters) that are not on the target table
  1692. // Perform an (inner or left) join for every external key (and specify the expected fields)
  1693. //
  1694. // Returns an SQLQuery
  1695. //
  1696. $sTargetClass = $this->GetFirstJoinedClass();
  1697. $sTargetAlias = $this->GetFirstJoinedClassAlias();
  1698. $sTable = MetaModel::DBGetTable($sTableClass);
  1699. $sTableAlias = $oBuild->GenerateTableAlias($sTargetAlias.'_'.$sTable, $sTable);
  1700. $aTranslation = array();
  1701. $aExpectedAtts = array();
  1702. $oBuild->m_oQBExpressions->GetUnresolvedFields($sTargetAlias, $aExpectedAtts);
  1703. $bIsOnQueriedClass = array_key_exists($sTargetAlias, $oBuild->GetRootFilter()->GetSelectedClasses());
  1704. self::DbgTrace("Entering: tableclass=$sTableClass, filter=".$this->ToOQL().", ".($bIsOnQueriedClass ? "MAIN" : "SECONDARY"));
  1705. // 1 - SELECT and UPDATE
  1706. //
  1707. // Note: no need for any values nor fields for foreign Classes (ie not the queried Class)
  1708. //
  1709. $aUpdateValues = array();
  1710. // 1/a - Get the key and friendly name
  1711. //
  1712. // We need one pkey to be the key, let's take the first one available
  1713. $oSelectedIdField = null;
  1714. $oIdField = new FieldExpressionResolved(MetaModel::DBGetKey($sTableClass), $sTableAlias);
  1715. $aTranslation[$sTargetAlias]['id'] = $oIdField;
  1716. if ($bIsOnQueriedClass)
  1717. {
  1718. // Add this field to the list of queried fields (required for the COUNT to work fine)
  1719. $oSelectedIdField = $oIdField;
  1720. }
  1721. // 1/b - Get the other attributes
  1722. //
  1723. foreach(MetaModel::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  1724. {
  1725. // Skip this attribute if not defined in this table
  1726. if (MetaModel::GetAttributeOrigin($sTargetClass, $sAttCode) != $sTableClass) continue;
  1727. // Skip this attribute if not made of SQL columns
  1728. if (count($oAttDef->GetSQLExpressions()) == 0) continue;
  1729. // Update...
  1730. //
  1731. if ($bIsOnQueriedClass && array_key_exists($sAttCode, $aValues))
  1732. {
  1733. assert ($oAttDef->IsDirectField());
  1734. foreach ($oAttDef->GetSQLValues($aValues[$sAttCode]) as $sColumn => $sValue)
  1735. {
  1736. $aUpdateValues[$sColumn] = $sValue;
  1737. }
  1738. }
  1739. }
  1740. // 2 - The SQL query, for this table only
  1741. //
  1742. $oSelectBase = new SQLObjectQuery($sTable, $sTableAlias, array(), $bIsOnQueriedClass, $aUpdateValues, $oSelectedIdField);
  1743. // 3 - Resolve expected expressions (translation table: alias.attcode => table.column)
  1744. //
  1745. foreach(MetaModel::ListAttributeDefs($sTableClass) as $sAttCode=>$oAttDef)
  1746. {
  1747. // Skip this attribute if not defined in this table
  1748. if (MetaModel::GetAttributeOrigin($sTargetClass, $sAttCode) != $sTableClass) continue;
  1749. // Select...
  1750. //
  1751. if ($oAttDef->IsExternalField())
  1752. {
  1753. // skip, this will be handled in the joined tables (done hereabove)
  1754. }
  1755. else
  1756. {
  1757. //echo "<p>MakeSQLObjectQuerySingleTable: Field $sAttCode is part of the table $sTable (named: $sTableAlias)</p>";
  1758. // standard field, or external key
  1759. // add it to the output
  1760. foreach ($oAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1761. {
  1762. if (array_key_exists($sAttCode.$sColId, $aExpectedAtts))
  1763. {
  1764. $oFieldSQLExp = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  1765. foreach (MetaModel::EnumPlugins('iQueryModifier') as $sPluginClass => $oQueryModifier)
  1766. {
  1767. $oFieldSQLExp = $oQueryModifier->GetFieldExpression($oBuild, $sTargetClass, $sAttCode, $sColId, $oFieldSQLExp, $oSelectBase);
  1768. }
  1769. $aTranslation[$sTargetAlias][$sAttCode.$sColId] = $oFieldSQLExp;
  1770. }
  1771. }
  1772. }
  1773. }
  1774. //echo "MakeSQLObjectQuery- Classe $sTableClass<br/>\n";
  1775. // 4 - The external keys -> joins...
  1776. //
  1777. $aAllPointingTo = $this->GetCriteria_PointingTo();
  1778. if (array_key_exists($sTableClass, $aExtKeys))
  1779. {
  1780. foreach ($aExtKeys[$sTableClass] as $sKeyAttCode => $aExtFields)
  1781. {
  1782. $oKeyAttDef = MetaModel::GetAttributeDef($sTableClass, $sKeyAttCode);
  1783. $aPointingTo = $this->GetCriteria_PointingTo($sKeyAttCode);
  1784. //echo "MakeSQLObjectQuery-Cle '$sKeyAttCode'<br/>\n";
  1785. if (!array_key_exists(TREE_OPERATOR_EQUALS, $aPointingTo))
  1786. {
  1787. //echo "MakeSQLObjectQuery-Ajoutons l'operateur TREE_OPERATOR_EQUALS pour $sKeyAttCode<br/>\n";
  1788. // The join was not explicitely defined in the filter,
  1789. // we need to do it now
  1790. $sKeyClass = $oKeyAttDef->GetTargetClass();
  1791. $sKeyClassAlias = $oBuild->GenerateClassAlias($sKeyClass.'_'.$sKeyAttCode, $sKeyClass);
  1792. $oExtFilter = new DBObjectSearch($sKeyClass, $sKeyClassAlias);
  1793. $aAllPointingTo[$sKeyAttCode][TREE_OPERATOR_EQUALS][$sKeyClassAlias] = $oExtFilter;
  1794. }
  1795. }
  1796. }
  1797. //echo "MakeSQLObjectQuery-liste des clefs de jointure: <pre>".print_r(array_keys($aAllPointingTo), true)."</pre><br/>\n";
  1798. foreach ($aAllPointingTo as $sKeyAttCode => $aPointingTo)
  1799. {
  1800. foreach($aPointingTo as $iOperatorCode => $aFilter)
  1801. {
  1802. foreach($aFilter as $oExtFilter)
  1803. {
  1804. if (!MetaModel::IsValidAttCode($sTableClass, $sKeyAttCode)) continue; // Not defined in the class, skip it
  1805. // The aliases should not conflict because normalization occured while building the filter
  1806. $oKeyAttDef = MetaModel::GetAttributeDef($sTableClass, $sKeyAttCode);
  1807. $sKeyClass = $oExtFilter->GetFirstJoinedClass();
  1808. $sKeyClassAlias = $oExtFilter->GetFirstJoinedClassAlias();
  1809. //echo "MakeSQLObjectQuery-$sTableClass::$sKeyAttCode Foreach PointingTo($iOperatorCode) <span style=\"color:red\">$sKeyClass (alias:$sKeyClassAlias)</span><br/>\n";
  1810. // Note: there is no search condition in $oExtFilter, because normalization did merge the condition onto the top of the filter tree
  1811. //echo "MakeSQLObjectQuery-array_key_exists($sTableClass, \$aExtKeys)<br/>\n";
  1812. if ($iOperatorCode == TREE_OPERATOR_EQUALS)
  1813. {
  1814. if (array_key_exists($sTableClass, $aExtKeys) && array_key_exists($sKeyAttCode, $aExtKeys[$sTableClass]))
  1815. {
  1816. // Specify expected attributes for the target class query
  1817. // ... and use the current alias !
  1818. $aTranslateNow = array(); // Translation for external fields - must be performed before the join is done (recursion...)
  1819. foreach($aExtKeys[$sTableClass][$sKeyAttCode] as $sAttCode => $oAtt)
  1820. {
  1821. //echo "MakeSQLObjectQuery aExtKeys[$sTableClass][$sKeyAttCode] => $sAttCode-oAtt: <pre>".print_r($oAtt, true)."</pre><br/>\n";
  1822. if ($oAtt instanceof AttributeFriendlyName)
  1823. {
  1824. // Note: for a given ext key, there is one single attribute "friendly name"
  1825. $aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);
  1826. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode] = new FieldExpression('friendlyname', $sKeyClassAlias);</b></p>\n";
  1827. }
  1828. else
  1829. {
  1830. $sExtAttCode = $oAtt->GetExtAttCode();
  1831. // Translate mainclass.extfield => remoteclassalias.remotefieldcode
  1832. $oRemoteAttDef = MetaModel::GetAttributeDef($sKeyClass, $sExtAttCode);
  1833. foreach ($oRemoteAttDef->GetSQLExpressions() as $sColId => $sRemoteAttExpr)
  1834. {
  1835. $aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);
  1836. //echo "<p><b>aTranslateNow[$sTargetAlias][$sAttCode.$sColId] = new FieldExpression($sExtAttCode, $sKeyClassAlias);</b></p>\n";
  1837. }
  1838. //echo "<p><b>ExtAttr2: $sTargetAlias.$sAttCode to $sKeyClassAlias.$sRemoteAttExpr (class: $sKeyClass)</b></p>\n";
  1839. }
  1840. }
  1841. if ($oKeyAttDef instanceof AttributeObjectKey)
  1842. {
  1843. // Add the condition: `$sTargetAlias`.$sClassAttCode IN (subclasses of $sKeyClass')
  1844. $sClassAttCode = $oKeyAttDef->Get('class_attcode');
  1845. $oClassAttDef = MetaModel::GetAttributeDef($sTargetClass, $sClassAttCode);
  1846. foreach ($oClassAttDef->GetSQLExpressions() as $sColId => $sSQLExpr)
  1847. {
  1848. $aTranslateNow[$sTargetAlias][$sClassAttCode.$sColId] = new FieldExpressionResolved($sSQLExpr, $sTableAlias);
  1849. }
  1850. $oClassListExpr = ListExpression::FromScalars(MetaModel::EnumChildClasses($sKeyClass, ENUM_CHILD_CLASSES_ALL));
  1851. $oClassExpr = new FieldExpression($sClassAttCode, $sTargetAlias);
  1852. $oClassRestriction = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1853. $oBuild->m_oQBExpressions->AddCondition($oClassRestriction);
  1854. }
  1855. // Translate prior to recursing
  1856. //
  1857. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."\n".print_r($aTranslateNow, true)."</pre></p>\n";
  1858. $oBuild->m_oQBExpressions->Translate($aTranslateNow, false);
  1859. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1860. //echo "<p>External key $sKeyAttCode (class: $sKeyClass), call MakeSQLObjectQuery()/p>\n";
  1861. self::DbgTrace("External key $sKeyAttCode (class: $sKeyClass), call MakeSQLObjectQuery()");
  1862. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression('id', $sKeyClassAlias));
  1863. //echo "<p>Recursive MakeSQLObjectQuery ".__LINE__.": <pre>\n".print_r($oBuild->GetRootFilter()->GetSelectedClasses(), true)."</pre></p>\n";
  1864. $oSelectExtKey = $oExtFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1865. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1866. $sExternalKeyTable = $oJoinExpr->GetParent();
  1867. $sExternalKeyField = $oJoinExpr->GetName();
  1868. $aCols = $oKeyAttDef->GetSQLExpressions(); // Workaround a PHP bug: sometimes issuing a Notice if invoking current(somefunc())
  1869. $sLocalKeyField = current($aCols); // get the first column for an external key
  1870. self::DbgTrace("External key $sKeyAttCode, Join on $sLocalKeyField = $sExternalKeyField");
  1871. if ($oKeyAttDef->IsNullAllowed())
  1872. {
  1873. $oSelectBase->AddLeftJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  1874. }
  1875. else
  1876. {
  1877. $oSelectBase->AddInnerJoin($oSelectExtKey, $sLocalKeyField, $sExternalKeyField, $sExternalKeyTable);
  1878. }
  1879. }
  1880. }
  1881. elseif(MetaModel::GetAttributeOrigin($sKeyClass, $sKeyAttCode) == $sTableClass)
  1882. {
  1883. $oBuild->m_oQBExpressions->PushJoinField(new FieldExpression($sKeyAttCode, $sKeyClassAlias));
  1884. $oSelectExtKey = $oExtFilter->MakeSQLObjectQuery($oBuild, $aAttToLoad);
  1885. $oJoinExpr = $oBuild->m_oQBExpressions->PopJoinField();
  1886. $sExternalKeyTable = $oJoinExpr->GetParent();
  1887. $sExternalKeyField = $oJoinExpr->GetName();
  1888. $sLeftIndex = $sExternalKeyField.'_left'; // TODO use GetSQLLeft()
  1889. $sRightIndex = $sExternalKeyField.'_right'; // TODO use GetSQLRight()
  1890. $LocalKeyLeft = $oKeyAttDef->GetSQLLeft();
  1891. $LocalKeyRight = $oKeyAttDef->GetSQLRight();
  1892. $oSelectBase->AddInnerJoinTree($oSelectExtKey, $LocalKeyLeft, $LocalKeyRight, $sLeftIndex, $sRightIndex, $sExternalKeyTable, $iOperatorCode);
  1893. }
  1894. }
  1895. }
  1896. }
  1897. // Translate the selected columns
  1898. //
  1899. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1900. $oBuild->m_oQBExpressions->Translate($aTranslation, false);
  1901. //echo "<p>oQBExpr ".__LINE__.": <pre>\n".print_r($oBuild->m_oQBExpressions, true)."</pre></p>\n";
  1902. // Filter out archived records
  1903. //
  1904. if (MetaModel::IsArchivable($sTableClass))
  1905. {
  1906. if (!$oBuild->GetRootFilter()->GetArchiveMode())
  1907. {
  1908. $bIsOnJoinedClass = array_key_exists($sTargetAlias, $oBuild->GetRootFilter()->GetJoinedClasses());
  1909. //$bIsOnJoinedClass = true;
  1910. if ($bIsOnJoinedClass)
  1911. {
  1912. if (MetaModel::IsParentClass($sTableClass, $sTargetClass))
  1913. {
  1914. $oNotArchived = new BinaryExpression(new FieldExpressionResolved('archive_flag', $sTableAlias), '=', new ScalarExpression(0));
  1915. $oBuild->AddFilteredTable($sTableAlias, $oNotArchived);
  1916. }
  1917. }
  1918. }
  1919. }
  1920. //MyHelpers::var_dump_html($oSelectBase->RenderSelect());
  1921. return $oSelectBase;
  1922. }
  1923. /**
  1924. * Get the friendly name for the class and its subclasses (if finalclass = 'subclass' ...)
  1925. * Simplifies the final expression by grouping classes having the same name expression
  1926. * Used when querying a parent class
  1927. */
  1928. static protected function GetExtendedNameExpression($sClass)
  1929. {
  1930. // 1st step - get all of the required expressions (instantiable classes)
  1931. // and group them using their OQL representation
  1932. //
  1933. $aFNExpressions = array(); // signature => array('expression' => oExp, 'classes' => array of classes)
  1934. foreach (MetaModel::EnumChildClasses($sClass, ENUM_CHILD_CLASSES_ALL) as $sSubClass)
  1935. {
  1936. if (($sSubClass != $sClass) && MetaModel::IsAbstract($sSubClass)) continue;
  1937. $oSubClassName = MetaModel::GetNameExpression($sSubClass);
  1938. $sSignature = $oSubClassName->Render();
  1939. if (!array_key_exists($sSignature, $aFNExpressions))
  1940. {
  1941. $aFNExpressions[$sSignature] = array(
  1942. 'expression' => $oSubClassName,
  1943. 'classes' => array(),
  1944. );
  1945. }
  1946. $aFNExpressions[$sSignature]['classes'][] = $sSubClass;
  1947. }
  1948. // 2nd step - build the final name expression depending on the finalclass
  1949. //
  1950. if (count($aFNExpressions) == 1)
  1951. {
  1952. $aExpData = reset($aFNExpressions);
  1953. $oNameExpression = $aExpData['expression'];
  1954. }
  1955. else
  1956. {
  1957. $oNameExpression = null;
  1958. foreach ($aFNExpressions as $sSignature => $aExpData)
  1959. {
  1960. $oClassListExpr = ListExpression::FromScalars($aExpData['classes']);
  1961. $oClassExpr = new FieldExpression('finalclass', $sClass);
  1962. $oClassInList = new BinaryExpression($oClassExpr, 'IN', $oClassListExpr);
  1963. if (is_null($oNameExpression))
  1964. {
  1965. $oNameExpression = $aExpData['expression'];
  1966. }
  1967. else
  1968. {
  1969. $oNameExpression = new FunctionExpression('IF', array($oClassInList, $aExpData['expression'], $oNameExpression));
  1970. }
  1971. }
  1972. }
  1973. return $oNameExpression;
  1974. }
  1975. }