dbobjectsearch.class.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. /**
  17. * Define filters for a given class of objects (formerly named "filter")
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. class DBObjectSearch
  25. {
  26. private $m_aClasses; // queried classes (alias => class name), the first item is the class corresponding to this filter (the rest is coming from subfilters)
  27. private $m_aSelectedClasses; // selected for the output (alias => class name)
  28. private $m_oSearchCondition;
  29. private $m_aParams;
  30. private $m_aFullText;
  31. private $m_aPointingTo;
  32. private $m_aReferencedBy;
  33. private $m_aRelatedTo;
  34. public function __construct($sClass, $sClassAlias = null)
  35. {
  36. if (is_null($sClassAlias)) $sClassAlias = $sClass;
  37. assert('is_string($sClass)');
  38. assert('MetaModel::IsValidClass($sClass)'); // #@# could do better than an assert, or at least give the caller's reference
  39. // => idee d'un assert avec call stack (autre utilisation = echec sur query SQL)
  40. $this->m_aSelectedClasses = array($sClassAlias => $sClass);
  41. $this->m_aClasses = array($sClassAlias => $sClass);
  42. $this->m_oSearchCondition = new TrueExpression;
  43. $this->m_aParams = array();
  44. $this->m_aFullText = array();
  45. $this->m_aPointingTo = array();
  46. $this->m_aReferencedBy = array();
  47. $this->m_aRelatedTo = array();
  48. }
  49. public function GetClassName($sAlias) {return $this->m_aClasses[$sAlias];}
  50. public function GetJoinedClasses() {return $this->m_aClasses;}
  51. public function GetClass()
  52. {
  53. return reset($this->m_aSelectedClasses);
  54. }
  55. public function GetClassAlias()
  56. {
  57. reset($this->m_aSelectedClasses);
  58. return key($this->m_aSelectedClasses);
  59. }
  60. public function GetFirstJoinedClass()
  61. {
  62. return reset($this->m_aClasses);
  63. }
  64. public function GetFirstJoinedClassAlias()
  65. {
  66. reset($this->m_aClasses);
  67. return key($this->m_aClasses);
  68. }
  69. public function SetSelectedClasses($aNewSet)
  70. {
  71. $this->m_aSelectedClasses = array();
  72. foreach ($aNewSet as $sAlias => $sClass)
  73. {
  74. if (!array_key_exists($sAlias, $this->m_aClasses))
  75. {
  76. throw new CoreException('Unexpected class alias', array('alias'=>$sAlias, 'expected'=>$this->m_aClasses));
  77. }
  78. $this->m_aSelectedClasses[$sAlias] = $sClass;
  79. }
  80. }
  81. public function GetSelectedClasses()
  82. {
  83. return $this->m_aSelectedClasses;
  84. }
  85. public function IsAny()
  86. {
  87. // #@# todo - if (!$this->m_oSearchCondition->IsTrue()) return false;
  88. if (count($this->m_aFullText) > 0) return false;
  89. if (count($this->m_aPointingTo) > 0) return false;
  90. if (count($this->m_aReferencedBy) > 0) return false;
  91. if (count($this->m_aRelatedTo) > 0) return false;
  92. return true;
  93. }
  94. public function Describe()
  95. {
  96. // To replace __Describe
  97. }
  98. public function DescribeConditionPointTo($sExtKeyAttCode)
  99. {
  100. if (!isset($this->m_aPointingTo[$sExtKeyAttCode])) return "";
  101. $oFilter = $this->m_aPointingTo[$sExtKeyAttCode];
  102. if ($oFilter->IsAny()) return "";
  103. $oAtt = MetaModel::GetAttributeDef($this->GetClass(), $sExtKeyAttCode);
  104. return $oAtt->GetLabel()." having ({$oFilter->DescribeConditions()})";
  105. }
  106. public function DescribeConditionRefBy($sForeignClass, $sForeignExtKeyAttCode)
  107. {
  108. if (!isset($this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode])) return "";
  109. $oFilter = $this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode];
  110. if ($oFilter->IsAny()) return "";
  111. $oAtt = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  112. return "being ".$oAtt->GetLabel()." for ".$sForeignClass."s in ({$oFilter->DescribeConditions()})";
  113. }
  114. public function DescribeConditionRelTo($aRelInfo)
  115. {
  116. $oFilter = $aRelInfo['flt'];
  117. $sRelCode = $aRelInfo['relcode'];
  118. $iMaxDepth = $aRelInfo['maxdepth'];
  119. return "related ($sRelCode... peut mieux faire !, $iMaxDepth dig depth) to a {$oFilter->GetClass()} ({$oFilter->DescribeConditions()})";
  120. }
  121. public function DescribeConditions()
  122. {
  123. $aConditions = array();
  124. $aCondFT = array();
  125. foreach($this->m_aFullText as $sFullText)
  126. {
  127. $aCondFT[] = " contain word(s) '$sFullText'";
  128. }
  129. if (count($aCondFT) > 0)
  130. {
  131. $aConditions[] = "which ".implode(" and ", $aCondFT);
  132. }
  133. // #@# todo - review textual description of the JOIN and search condition (is that still feasible?)
  134. $aConditions[] = $this->RenderCondition();
  135. $aCondPoint = array();
  136. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$oFilter)
  137. {
  138. if ($oFilter->IsAny()) continue;
  139. $aCondPoint[] = $this->DescribeConditionPointTo($sExtKeyAttCode);
  140. }
  141. if (count($aCondPoint) > 0)
  142. {
  143. $aConditions[] = implode(" and ", $aCondPoint);
  144. }
  145. $aCondReferred= array();
  146. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  147. {
  148. foreach($aReferences as $sForeignExtKeyAttCode=>$oForeignFilter)
  149. {
  150. if ($oForeignFilter->IsAny()) continue;
  151. $aCondReferred[] = $this->DescribeConditionRefBy($sForeignClass, $sForeignExtKeyAttCode);
  152. }
  153. }
  154. foreach ($this->m_aRelatedTo as $aRelInfo)
  155. {
  156. $aCondReferred[] = $this->DescribeConditionRelTo($aRelInfo);
  157. }
  158. if (count($aCondReferred) > 0)
  159. {
  160. $aConditions[] = implode(" and ", $aCondReferred);
  161. }
  162. return implode(" and ", $aConditions);
  163. }
  164. public function __DescribeHTML()
  165. {
  166. try
  167. {
  168. $sConditionDesc = $this->DescribeConditions();
  169. }
  170. catch (MissingQueryArgument $e)
  171. {
  172. $sConditionDesc = '?missing query argument?';
  173. }
  174. if (!empty($sConditionDesc))
  175. {
  176. return "Objects of class '".$this->GetClass()."', $sConditionDesc";
  177. }
  178. return "Any object of class '".$this->GetClass()."'";
  179. }
  180. protected function TransferConditionExpression($oFilter, $aTranslation)
  181. {
  182. $oTranslated = $oFilter->GetCriteria()->Translate($aTranslation, false);
  183. $this->AddConditionExpression($oTranslated);
  184. // #@# what about collisions in parameter names ???
  185. $this->m_aParams = array_merge($this->m_aParams, $oFilter->m_aParams);
  186. }
  187. public function ResetCondition()
  188. {
  189. $this->m_oSearchCondition = new TrueExpression();
  190. // ? is that usefull/enough, do I need to rebuild the list after the subqueries ?
  191. }
  192. public function AddConditionExpression($oExpression)
  193. {
  194. $this->m_oSearchCondition = $this->m_oSearchCondition->LogAnd($oExpression);
  195. }
  196. public function AddCondition($sFilterCode, $value, $sOpCode = null)
  197. {
  198. MyHelpers::CheckKeyInArray('filter code', $sFilterCode, MetaModel::GetClassFilterDefs($this->GetClass()));
  199. $oFilterDef = MetaModel::GetClassFilterDef($this->GetClass(), $sFilterCode);
  200. $oField = new FieldExpression($sFilterCode, $this->GetClassAlias());
  201. if (empty($sOpCode))
  202. {
  203. if ($sFilterCode == 'id')
  204. {
  205. $sOpCode = '=';
  206. }
  207. else
  208. {
  209. $oAttDef = MetaModel::GetAttributeDef($this->GetClass(), $sFilterCode);
  210. $oNewCondition = $oAttDef->GetSmartConditionExpression($value, $oField, $this->m_aParams);
  211. $this->AddConditionExpression($oNewCondition);
  212. return;
  213. }
  214. }
  215. MyHelpers::CheckKeyInArray('operator', $sOpCode, $oFilterDef->GetOperators());
  216. // Preserve backward compatibility - quick n'dirty way to change that API semantic
  217. //
  218. switch($sOpCode)
  219. {
  220. case 'SameDay':
  221. case 'SameMonth':
  222. case 'SameYear':
  223. case 'Today':
  224. case '>|':
  225. case '<|':
  226. case '=|':
  227. throw new CoreException('Deprecated operator, please consider using OQL (SQL) expressions like "(TO_DAYS(NOW()) - TO_DAYS(x)) AS AgeDays"', array('operator' => $sOpCode));
  228. break;
  229. case "IN":
  230. if (!is_array($value)) $value = array($value);
  231. $sListExpr = '('.implode(', ', CMDBSource::Quote($value)).')';
  232. $sOQLCondition = $oField->Render()." IN $sListExpr";
  233. break;
  234. case "NOTIN":
  235. if (!is_array($value)) $value = array($value);
  236. $sListExpr = '('.implode(', ', CMDBSource::Quote($value)).')';
  237. $sOQLCondition = $oField->Render()." NOT IN $sListExpr";
  238. break;
  239. case 'Contains':
  240. $this->m_aParams[$sFilterCode] = "%$value%";
  241. $sOperator = 'LIKE';
  242. break;
  243. case 'Begins with':
  244. $this->m_aParams[$sFilterCode] = "$value%";
  245. $sOperator = 'LIKE';
  246. break;
  247. case 'Finishes with':
  248. $this->m_aParams[$sFilterCode] = "%$value";
  249. $sOperator = 'LIKE';
  250. break;
  251. default:
  252. $this->m_aParams[$sFilterCode] = $value;
  253. $sOperator = $sOpCode;
  254. }
  255. switch($sOpCode)
  256. {
  257. case "IN":
  258. case "NOTIN":
  259. $oNewCondition = Expression::FromOQL($sOQLCondition);
  260. break;
  261. case 'Contains':
  262. case 'Begins with':
  263. case 'Finishes with':
  264. default:
  265. $oRightExpr = new VariableExpression($sFilterCode);
  266. $oNewCondition = new BinaryExpression($oField, $sOperator, $oRightExpr);
  267. }
  268. $this->AddConditionExpression($oNewCondition);
  269. }
  270. public function AddCondition_FullText($sFullText)
  271. {
  272. $this->m_aFullText[] = $sFullText;
  273. }
  274. protected function AddToNameSpace(&$aClassAliases, &$aAliasTranslation)
  275. {
  276. $sOrigAlias = $this->GetClassAlias();
  277. if (array_key_exists($sOrigAlias, $aClassAliases))
  278. {
  279. $sNewAlias = MetaModel::GenerateUniqueAlias($aClassAliases, $sOrigAlias, $this->GetClass());
  280. $this->m_aSelectedClasses[$sNewAlias] = $this->GetClass();
  281. unset($this->m_aSelectedClasses[$sOrigAlias]);
  282. // Translate the condition expression with the new alias
  283. $aAliasTranslation[$sOrigAlias]['*'] = $sNewAlias;
  284. }
  285. // add the alias into the filter aliases list
  286. $aClassAliases[$this->GetClassAlias()] = $this->GetClass();
  287. foreach($this->m_aPointingTo as $sExtKeyAttCode=>$oFilter)
  288. {
  289. $oFilter->AddToNameSpace($aClassAliases, $aAliasTranslation);
  290. }
  291. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  292. {
  293. foreach($aReferences as $sForeignExtKeyAttCode=>$oForeignFilter)
  294. {
  295. $oForeignFilter->AddToNameSpace($aClassAliases, $aAliasTranslation);
  296. }
  297. }
  298. }
  299. public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode)
  300. {
  301. $aAliasTranslation = array();
  302. $res = $this->AddCondition_PointingTo_InNameSpace($oFilter, $sExtKeyAttCode, $this->m_aClasses, $aAliasTranslation);
  303. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  304. return $res;
  305. }
  306. protected function AddCondition_PointingTo_InNameSpace(DBObjectSearch $oFilter, $sExtKeyAttCode, &$aClassAliases, &$aAliasTranslation)
  307. {
  308. if (!MetaModel::IsValidKeyAttCode($this->GetClass(), $sExtKeyAttCode))
  309. {
  310. throw new CoreWarning("The attribute code '$sExtKeyAttCode' is not an external key of the class '{$this->GetClass()}' - the condition will be ignored");
  311. }
  312. $oAttExtKey = MetaModel::GetAttributeDef($this->GetClass(), $sExtKeyAttCode);
  313. if(!MetaModel::IsSameFamilyBranch($oFilter->GetClass(), $oAttExtKey->GetTargetClass()))
  314. {
  315. 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()}");
  316. }
  317. if (array_key_exists($sExtKeyAttCode, $this->m_aPointingTo))
  318. {
  319. $this->m_aPointingTo[$sExtKeyAttCode]->MergeWith_InNamespace($oFilter, $aClassAliases, $aAliasTranslation);
  320. }
  321. else
  322. {
  323. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  324. // #@# The condition expression found in that filter should not be used - could be another kind of structure like a join spec tree !!!!
  325. // $oNewFilter = clone $oFilter;
  326. // $oNewFilter->ResetCondition();
  327. $this->m_aPointingTo[$sExtKeyAttCode] = $oFilter;
  328. }
  329. }
  330. public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode)
  331. {
  332. $aAliasTranslation = array();
  333. $res = $this->AddCondition_ReferencedBy_InNameSpace($oFilter, $sForeignExtKeyAttCode, $this->m_aClasses, $aAliasTranslation);
  334. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  335. return $res;
  336. }
  337. protected function AddCondition_ReferencedBy_InNameSpace(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, &$aClassAliases, &$aAliasTranslation)
  338. {
  339. $sForeignClass = $oFilter->GetClass();
  340. $sForeignClassAlias = $oFilter->GetClassAlias();
  341. if (!MetaModel::IsValidKeyAttCode($sForeignClass, $sForeignExtKeyAttCode))
  342. {
  343. throw new CoreException("The attribute code '$sForeignExtKeyAttCode' is not an external key of the class '{$sForeignClass}' - the condition will be ignored");
  344. }
  345. $oAttExtKey = MetaModel::GetAttributeDef($sForeignClass, $sForeignExtKeyAttCode);
  346. if(!MetaModel::IsSameFamilyBranch($this->GetClass(), $oAttExtKey->GetTargetClass()))
  347. {
  348. 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()}");
  349. }
  350. if (array_key_exists($sForeignClass, $this->m_aReferencedBy) && array_key_exists($sForeignExtKeyAttCode, $this->m_aReferencedBy[$sForeignClass]))
  351. {
  352. $this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]->MergeWith_InNamespace($oFilter, $aClassAliases, $aAliasTranslation);
  353. }
  354. else
  355. {
  356. $oFilter->AddToNamespace($aClassAliases, $aAliasTranslation);
  357. // #@# The condition expression found in that filter should not be used - could be another kind of structure like a join spec tree !!!!
  358. //$oNewFilter = clone $oFilter;
  359. //$oNewFilter->ResetCondition();
  360. $this->m_aReferencedBy[$sForeignClass][$sForeignExtKeyAttCode]= $oFilter;
  361. }
  362. }
  363. public function AddCondition_LinkedTo(DBObjectSearch $oLinkFilter, $sExtKeyAttCodeToMe, $sExtKeyAttCodeTarget, DBObjectSearch $oFilterTarget)
  364. {
  365. $oLinkFilterFinal = clone $oLinkFilter;
  366. $oLinkFilterFinal->AddCondition_PointingTo($sExtKeyAttCodeToMe);
  367. $this->AddCondition_ReferencedBy($oLinkFilterFinal, $sExtKeyAttCodeToMe);
  368. }
  369. public function AddCondition_RelatedTo(DBObjectSearch $oFilter, $sRelCode, $iMaxDepth)
  370. {
  371. MyHelpers::CheckValueInArray('relation code', $sRelCode, MetaModel::EnumRelations());
  372. $this->m_aRelatedTo[] = array('flt'=>$oFilter, 'relcode'=>$sRelCode, 'maxdepth'=>$iMaxDepth);
  373. }
  374. public function MergeWith($oFilter)
  375. {
  376. $aAliasTranslation = array();
  377. $res = $this->MergeWith_InNamespace($oFilter, $this->m_aClasses, $aAliasTranslation);
  378. $this->TransferConditionExpression($oFilter, $aAliasTranslation);
  379. return $res;
  380. }
  381. protected function MergeWith_InNamespace($oFilter, &$aClassAliases, &$aAliasTranslation)
  382. {
  383. if ($this->GetClass() != $oFilter->GetClass())
  384. {
  385. throw new CoreException("Attempting to merge a filter of class '{$this->GetClass()}' with a filter of class '{$oFilter->GetClass()}'");
  386. }
  387. // Translate search condition into our aliasing scheme
  388. $aAliasTranslation[$oFilter->GetClassAlias()]['*'] = $this->GetClassAlias();
  389. $this->m_aFullText = array_merge($this->m_aFullText, $oFilter->m_aFullText);
  390. $this->m_aRelatedTo = array_merge($this->m_aRelatedTo, $oFilter->m_aRelatedTo);
  391. foreach($oFilter->m_aPointingTo as $sExtKeyAttCode=>$oExtFilter)
  392. {
  393. $this->AddCondition_PointingTo_InNamespace($oExtFilter, $sExtKeyAttCode, $aClassAliases, $aAliasTranslation);
  394. }
  395. foreach($oFilter->m_aReferencedBy as $sForeignClass => $aReferences)
  396. {
  397. foreach($aReferences as $sForeignExtKeyAttCode => $oForeignFilter)
  398. {
  399. $this->AddCondition_ReferencedBy_InNamespace($oForeignFilter, $sForeignExtKeyAttCode, $aClassAliases, $aAliasTranslation);
  400. }
  401. }
  402. }
  403. public function GetCriteria() {return $this->m_oSearchCondition;}
  404. public function GetCriteria_FullText() {return $this->m_aFullText;}
  405. public function GetCriteria_PointingTo($sKeyAttCode = "")
  406. {
  407. if (empty($sKeyAttCode))
  408. {
  409. return $this->m_aPointingTo;
  410. }
  411. if (!array_key_exists($sKeyAttCode, $this->m_aPointingTo)) return null;
  412. return $this->m_aPointingTo[$sKeyAttCode];
  413. }
  414. public function GetCriteria_ReferencedBy($sRemoteClass = "", $sForeignExtKeyAttCode = "")
  415. {
  416. if (empty($sRemoteClass))
  417. {
  418. return $this->m_aReferencedBy;
  419. }
  420. if (!array_key_exists($sRemoteClass, $this->m_aReferencedBy)) return null;
  421. if (empty($sForeignExtKeyAttCode))
  422. {
  423. return $this->m_aReferencedBy[$sRemoteClass];
  424. }
  425. if (!array_key_exists($sForeignExtKeyAttCode, $this->m_aReferencedBy[$sRemoteClass])) return null;
  426. return $this->m_aReferencedBy[$sRemoteClass][$sForeignExtKeyAttCode];
  427. }
  428. public function GetCriteria_RelatedTo()
  429. {
  430. return $this->m_aRelatedTo;
  431. }
  432. public function GetInternalParams()
  433. {
  434. return $this->m_aParams;
  435. }
  436. public function RenderCondition()
  437. {
  438. return $this->m_oSearchCondition->Render($this->m_aParams, false);
  439. }
  440. public function serialize()
  441. {
  442. $sOql = $this->ToOql();
  443. return base64_encode($sOql);
  444. }
  445. static public function unserialize($sValue)
  446. {
  447. $sOql = base64_decode($sValue);
  448. // We've tried to use gzcompress/gzuncompress, but for some specific queries
  449. // it was not working at all (See Trac #193)
  450. // gzuncompress was issuing a warning "data error" and the return object was null
  451. return self::FromOQL($sOql);
  452. }
  453. // SImple BUt Structured Query Languag - SubuSQL
  454. //
  455. static private function Value2Expression($value)
  456. {
  457. $sRet = $value;
  458. if (is_array($value))
  459. {
  460. $sRet = VS_START.implode(', ', $value).VS_END;
  461. }
  462. else if (!is_numeric($value))
  463. {
  464. $sRet = "'".addslashes($value)."'";
  465. }
  466. return $sRet;
  467. }
  468. static private function Expression2Value($sExpr)
  469. {
  470. $retValue = $sExpr;
  471. if ((substr($sExpr, 0, 1) == "'") && (substr($sExpr, -1, 1) == "'"))
  472. {
  473. $sNoQuotes = substr($sExpr, 1, -1);
  474. return stripslashes($sNoQuotes);
  475. }
  476. if ((substr($sExpr, 0, 1) == VS_START) && (substr($sExpr, -1, 1) == VS_END))
  477. {
  478. $sNoBracket = substr($sExpr, 1, -1);
  479. $aRetValue = array();
  480. foreach (explode(",", $sNoBracket) as $sItem)
  481. {
  482. $aRetValue[] = self::Expression2Value(trim($sItem));
  483. }
  484. return $aRetValue;
  485. }
  486. return $retValue;
  487. }
  488. public function ToOQL(&$aParams = null)
  489. {
  490. $bRetrofitParams = (!is_null($aParams));
  491. if (is_null($aParams))
  492. {
  493. if (count($this->m_aParams) > 0)
  494. {
  495. $aParams = $this->m_aParams;
  496. }
  497. $bRetrofitParams = false;
  498. }
  499. else
  500. {
  501. if (count($this->m_aParams) > 0)
  502. {
  503. $aParams = array_merge($aParams, $this->m_aParams);
  504. }
  505. $bRetrofitParams = true;
  506. }
  507. $sSelectedClasses = implode(', ', array_keys($this->m_aSelectedClasses));
  508. $sRes = 'SELECT '.$sSelectedClasses.' FROM';
  509. $sRes .= ' '.$this->GetClass().' AS '.$this->GetClassAlias();
  510. $sRes .= $this->ToOQL_Joins();
  511. $sRes .= " WHERE ".$this->m_oSearchCondition->Render($aParams, $bRetrofitParams);
  512. // Temporary: add more info about other conditions, necessary to avoid strange behaviors with the cache
  513. foreach($this->m_aFullText as $sFullText)
  514. {
  515. $sRes .= " AND MATCHES '$sFullText'";
  516. }
  517. return $sRes;
  518. }
  519. protected function ToOQL_Joins()
  520. {
  521. $sRes = '';
  522. foreach($this->m_aPointingTo as $sExtKey=>$oFilter)
  523. {
  524. $sRes .= ' JOIN '.$oFilter->GetClass().' AS '.$oFilter->GetClassAlias().' ON '.$this->GetClassAlias().'.'.$sExtKey.' = '.$oFilter->GetClassAlias().'.id';
  525. $sRes .= $oFilter->ToOQL_Joins();
  526. }
  527. foreach($this->m_aReferencedBy as $sForeignClass=>$aReferences)
  528. {
  529. foreach($aReferences as $sForeignExtKeyAttCode=>$oForeignFilter)
  530. {
  531. $sRes .= ' JOIN '.$oForeignFilter->GetClass().' AS '.$oForeignFilter->GetClassAlias().' ON '.$oForeignFilter->GetClassAlias().'.'.$sForeignExtKeyAttCode.' = '.$this->GetClassAlias().'.id';
  532. $sRes .= $oForeignFilter->ToOQL_Joins();
  533. }
  534. }
  535. return $sRes;
  536. }
  537. protected function OQLExpressionToCondition($sQuery, $oExpression, $aClassAliases)
  538. {
  539. if ($oExpression instanceof BinaryOqlExpression)
  540. {
  541. $sOperator = $oExpression->GetOperator();
  542. $oLeft = $this->OQLExpressionToCondition($sQuery, $oExpression->GetLeftExpr(), $aClassAliases);
  543. $oRight = $this->OQLExpressionToCondition($sQuery, $oExpression->GetRightExpr(), $aClassAliases);
  544. return new BinaryExpression($oLeft, $sOperator, $oRight);
  545. }
  546. elseif ($oExpression instanceof FieldOqlExpression)
  547. {
  548. $sClassAlias = $oExpression->GetParent();
  549. $sFltCode = $oExpression->GetName();
  550. if (empty($sClassAlias))
  551. {
  552. // Try to find an alias
  553. // Build an array of field => array of aliases
  554. $aFieldClasses = array();
  555. foreach($aClassAliases as $sAlias => $sReal)
  556. {
  557. foreach(MetaModel::GetFiltersList($sReal) as $sAnFltCode)
  558. {
  559. $aFieldClasses[$sAnFltCode][] = $sAlias;
  560. }
  561. }
  562. if (!array_key_exists($sFltCode, $aFieldClasses))
  563. {
  564. throw new OqlNormalizeException('Unknown filter code', $sQuery, $oExpression->GetNameDetails(), array_keys($aFieldClasses));
  565. }
  566. if (count($aFieldClasses[$sFltCode]) > 1)
  567. {
  568. throw new OqlNormalizeException('Ambiguous filter code', $sQuery, $oExpression->GetNameDetails());
  569. }
  570. $sClassAlias = $aFieldClasses[$sFltCode][0];
  571. }
  572. else
  573. {
  574. if (!array_key_exists($sClassAlias, $aClassAliases))
  575. {
  576. throw new OqlNormalizeException('Unknown class [alias]', $sQuery, $oExpression->GetParentDetails(), array_keys($aClassAliases));
  577. }
  578. $sClass = $aClassAliases[$sClassAlias];
  579. if (!MetaModel::IsValidFilterCode($sClass, $sFltCode))
  580. {
  581. throw new OqlNormalizeException('Unknown filter code', $sQuery, $oExpression->GetNameDetails(), MetaModel::GetFiltersList($sClass));
  582. }
  583. }
  584. return new FieldExpression($sFltCode, $sClassAlias);
  585. }
  586. elseif ($oExpression instanceof VariableOqlExpression)
  587. {
  588. return new VariableExpression($oExpression->GetName());
  589. }
  590. elseif ($oExpression instanceof TrueOqlExpression)
  591. {
  592. return new TrueExpression;
  593. }
  594. elseif ($oExpression instanceof ScalarOqlExpression)
  595. {
  596. return new ScalarExpression($oExpression->GetValue());
  597. }
  598. elseif ($oExpression instanceof ListOqlExpression)
  599. {
  600. return new ListExpression($oExpression->GetItems());
  601. }
  602. elseif ($oExpression instanceof FunctionOqlExpression)
  603. {
  604. return new FunctionExpression($oExpression->GetVerb(), $oExpression->GetArgs());
  605. }
  606. else
  607. {
  608. throw new CoreException('Unknown expression type', array('class'=>get_class($oExpression), 'query'=>$sQuery));
  609. }
  610. }
  611. static protected $m_aOQLQueries = array();
  612. static public function FromOQL($sQuery)
  613. {
  614. if (empty($sQuery)) return null;
  615. // Query caching
  616. $bOQLCacheEnabled = true;
  617. if ($bOQLCacheEnabled && array_key_exists($sQuery, self::$m_aOQLQueries))
  618. {
  619. // hit!
  620. return clone self::$m_aOQLQueries[$sQuery];
  621. }
  622. $oOql = new OqlInterpreter($sQuery);
  623. $oOqlQuery = $oOql->ParseObjectQuery();
  624. $sClass = $oOqlQuery->GetClass();
  625. $sClassAlias = $oOqlQuery->GetClassAlias();
  626. if (!MetaModel::IsValidClass($sClass))
  627. {
  628. throw new OqlNormalizeException('Unknown class', $sQuery, $oOqlQuery->GetClassDetails(), MetaModel::GetClasses());
  629. }
  630. $oResultFilter = new DBObjectSearch($sClass, $sClassAlias);
  631. $aAliases = array($sClassAlias => $sClass);
  632. // Maintain an array of filters, because the flat list is in fact referring to a tree
  633. // And this will be an easy way to dispatch the conditions
  634. // $oResultFilter will be referenced by the other filters, or the other way around...
  635. $aJoinItems = array($sClassAlias => $oResultFilter);
  636. $aJoinSpecs = $oOqlQuery->GetJoins();
  637. if (is_array($aJoinSpecs))
  638. {
  639. foreach ($aJoinSpecs as $oJoinSpec)
  640. {
  641. $sJoinClass = $oJoinSpec->GetClass();
  642. $sJoinClassAlias = $oJoinSpec->GetClassAlias();
  643. if (!MetaModel::IsValidClass($sJoinClass))
  644. {
  645. throw new OqlNormalizeException('Unknown class', $sQuery, $oJoinSpec->GetClassDetails(), MetaModel::GetClasses());
  646. }
  647. if (array_key_exists($sJoinClassAlias, $aAliases))
  648. {
  649. if ($sJoinClassAlias != $sJoinClass)
  650. {
  651. throw new OqlNormalizeException('Duplicate class alias', $sQuery, $oJoinSpec->GetClassAliasDetails());
  652. }
  653. else
  654. {
  655. throw new OqlNormalizeException('Duplicate class name', $sQuery, $oJoinSpec->GetClassDetails());
  656. }
  657. }
  658. // Assumption: ext key on the left only !!!
  659. // normalization should take care of this
  660. $oLeftField = $oJoinSpec->GetLeftField();
  661. $sFromClass = $oLeftField->GetParent();
  662. $sExtKeyAttCode = $oLeftField->GetName();
  663. $oRightField = $oJoinSpec->GetRightField();
  664. $sToClass = $oRightField->GetParent();
  665. $sPKeyDescriptor = $oRightField->GetName();
  666. if ($sPKeyDescriptor != 'id')
  667. {
  668. throw new OqlNormalizeException('Wrong format for Join clause (right hand), expecting an id', $sQuery, $oRightField->GetNameDetails(), array('id'));
  669. }
  670. $aAliases[$sJoinClassAlias] = $sJoinClass;
  671. $aJoinItems[$sJoinClassAlias] = new DBObjectSearch($sJoinClass, $sJoinClassAlias);
  672. if (!array_key_exists($sFromClass, $aJoinItems))
  673. {
  674. throw new OqlNormalizeException('Unknown class in join condition (left expression)', $sQuery, $oLeftField->GetParentDetails(), array_keys($aJoinItems));
  675. }
  676. if (!array_key_exists($sToClass, $aJoinItems))
  677. {
  678. throw new OqlNormalizeException('Unknown class in join condition (right expression)', $sQuery, $oRightField->GetParentDetails(), array_keys($aJoinItems));
  679. }
  680. $aExtKeys = array_keys(MetaModel::GetExternalKeys($aAliases[$sFromClass]));
  681. if (!in_array($sExtKeyAttCode, $aExtKeys))
  682. {
  683. throw new OqlNormalizeException('Unknown external key in join condition (left expression)', $sQuery, $oLeftField->GetNameDetails(), $aExtKeys);
  684. }
  685. if ($sFromClass == $sJoinClassAlias)
  686. {
  687. $aJoinItems[$sToClass]->AddCondition_ReferencedBy($aJoinItems[$sFromClass], $sExtKeyAttCode);
  688. }
  689. else
  690. {
  691. $aJoinItems[$sFromClass]->AddCondition_PointingTo($aJoinItems[$sToClass], $sExtKeyAttCode);
  692. }
  693. }
  694. }
  695. // Check and prepare the select information
  696. $aSelected = array();
  697. foreach ($oOqlQuery->GetSelectedClasses() as $oClassDetails)
  698. {
  699. $sClassToSelect = $oClassDetails->GetValue();
  700. if (!array_key_exists($sClassToSelect, $aAliases))
  701. {
  702. throw new OqlNormalizeException('Unknown class [alias]', $sQuery, $oClassDetails, array_keys($aAliases));
  703. }
  704. $aSelected[$sClassToSelect] = $aAliases[$sClassToSelect];
  705. }
  706. $oResultFilter->SetSelectedClasses($aSelected);
  707. $oConditionTree = $oOqlQuery->GetCondition();
  708. if ($oConditionTree instanceof Expression)
  709. {
  710. $oResultFilter->m_oSearchCondition = $oResultFilter->OQLExpressionToCondition($sQuery, $oConditionTree, $aAliases);
  711. }
  712. if ($bOQLCacheEnabled)
  713. {
  714. self::$m_aOQLQueries[$sQuery] = clone $oResultFilter;
  715. }
  716. return $oResultFilter;
  717. }
  718. public function toxpath()
  719. {
  720. // #@# a voir...
  721. }
  722. static public function fromxpath()
  723. {
  724. // #@# a voir...
  725. }
  726. }
  727. ?>