dbobjectsearch.class.php 75 KB

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