Advanced Search

Convert from raw OQL to search form widget operator

SVN:b1162[5395]

application/cmdbabstract.class.inc.php

@@ -46,6 +46,10 @@ require_once(APPROOT.'/application/ui.htmleditorwidget.class.inc.php');
 require_once(APPROOT.'/application/datatable.class.inc.php');
 require_once(APPROOT.'/sources/renderer/console/consoleformrenderer.class.inc.php');
 require_once(APPROOT.'/sources/application/search/searchform.class.inc.php');
+require_once(APPROOT.'/sources/application/search/criterionparser.class.inc.php');
+require_once(APPROOT.'/sources/application/search/criterionconversionabstract.class.inc.php');
+require_once(APPROOT.'/sources/application/search/criterionconversion/criteriontooql.class.inc.php');
+require_once(APPROOT.'/sources/application/search/criterionconversion/criteriontosearchform.class.inc.php');
 
 abstract class cmdbAbstractObject extends CMDBObject implements iDisplay
 {

core/oql/expression.class.inc.php

@@ -912,9 +912,26 @@ class FieldExpression extends UnaryExpression
 	}
 
 
+	/**
+	 * @param $oSearch
+	 * @param null $aArgs
+	 * @param bool $bRetrofitParams
+	 * @param AttributeDefinition $oAttDef
+	 *
+	 * @return array
+	 */
 	public function GetCriterion($oSearch, &$aArgs = null, $bRetrofitParams = false, $oAttDef = null)
 	{
-		return array('ref' => $this->GetParent().'.'.$this->GetName());
+		if (!is_null($oAttDef))
+		{
+			$sSearchType = $oAttDef->GetSearchType();
+		}
+		else
+		{
+			$sSearchType = AttributeDefinition::SEARCH_WIDGET_TYPE;
+		}
+
+		return array('ref' => $this->GetParent().'.'.$this->GetName(), 'widget' => $sSearchType);
 	}
 }
 

sources/application/search/criterionconversion/criteriontooql.class.inc.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Copyright (C) 2010-2018 Combodo SARL
+ *
+ * This file is part of iTop.
+ *
+ *  iTop is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with iTop. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+
+namespace Combodo\iTop\Application\Search\CriterionConversion;
+
+
+use Combodo\iTop\Application\Search\CriterionConversionAbstract;
+
+class CriterionToOQL extends CriterionConversionAbstract
+{
+
+	public static function Convert($aCriteria)
+	{
+		if (!empty($aCriteria['oql']))
+		{
+			return $aCriteria['oql'];
+		}
+
+		$aRef = explode('.', $aCriteria['ref']);
+		for($i = 0; $i < count($aRef); $i++)
+		{
+			$aRef[$i] = '`'.$aRef[$i].'`';
+		}
+		$sRef = implode('.', $aRef);
+
+		$sOperator = $aCriteria['operator'];
+
+		$aMappedOperators = array(
+			self::OP_CONTAINS => 'ContainsToOql',
+			self::OP_STARTS_WITH => 'StartsWithToOql',
+			self::OP_ENDS_WITH => 'EndsWithToOql',
+			self::OP_EMPTY => 'EmptyToOql',
+			self::OP_NOT_EMPTY => 'NotEmptyToOql',
+		);
+
+		if (array_key_exists($sOperator, $aMappedOperators))
+		{
+			$sFct = $aMappedOperators[$sOperator];
+
+			return self::$sFct($sRef, $sOperator, $aCriteria['values']);
+		}
+
+		$sValue = $aCriteria['values'][0]['value'];
+
+		return "({$sRef} {$sOperator} '{$sValue}')";
+	}
+
+	protected static function ContainsToOql($sRef, $sOperator, $aValues)
+	{
+		$sValue = $aValues[0]['value'];
+
+		return "({$sRef} LIKE '%{$sValue}%')";
+	}
+
+	protected static function StartsWithToOql($sRef, $sOperator, $aValues)
+	{
+		$sValue = $aValues[0]['value'];
+
+		return "({$sRef} LIKE '{$sValue}%')";
+	}
+
+	protected static function EndsWithToOql($sRef, $sOperator, $aValues)
+	{
+		$sValue = $aValues[0]['value'];
+
+		return "({$sRef} LIKE '%{$sValue}')";
+	}
+
+	protected static function EmptyToOql($sRef, $sOperator, $aValues)
+	{
+		return "({$sRef} = '')";
+	}
+
+	protected static function NotEmptyToOql($sRef, $sOperator, $aValues)
+	{
+		return "({$sRef} != '')";
+	}
+
+}

sources/application/search/criterionconversion/criteriontosearchform.class.inc.php

@@ -0,0 +1,70 @@
+<?php
+/**
+ * Copyright (C) 2010-2018 Combodo SARL
+ *
+ * This file is part of iTop.
+ *
+ *  iTop is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with iTop. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+
+namespace Combodo\iTop\Application\Search\CriterionConversion;
+
+
+use AttributeString;
+use Combodo\iTop\Application\Search\CriterionConversionAbstract;
+
+class CriterionToSearchForm extends CriterionConversionAbstract
+{
+
+	public static function Convert($aAndCriterionRaw)
+	{
+		$aAndCriterion = array();
+		$aMappingOperatorToFunction = array(
+			AttributeString::SEARCH_WIDGET_TYPE => 'TextToSearchForm',
+		);
+
+		foreach($aAndCriterionRaw as $aCriteria)
+		{
+			if (array_key_exists($aCriteria['widget'], $aMappingOperatorToFunction))
+			{
+				$sFct = $aMappingOperatorToFunction[$aCriteria['widget']];
+				$aAndCriterion[] = self::$sFct($aCriteria);
+			}
+		}
+
+		return $aAndCriterion;
+	}
+
+	protected static function TextToSearchForm($aCriteria)
+	{
+		$sRef = $aCriteria['ref'];
+		$sOperator = $aCriteria['operator'];
+		$aValues = $aCriteria['values'];
+
+
+		$value = $aValues[0]['value'];
+		if ('' == $value)
+		{
+			$aCriteria['operator'] = CriterionConversionAbstract::OP_EMPTY;
+
+			return $aCriteria;
+		}
+		$bStartWithPercent = $value{0} == '%' ? true : false;
+		$bEndWithPercent = $value{0} == '%' ? true : false;
+
+		return $aCriteria;
+	}
+}

sources/application/search/criterionconversionabstract.class.inc.php

@@ -19,17 +19,19 @@
  *
  */
 
-/**
- * Created by PhpStorm.
- * User: Eric
- * Date: 08/03/2018
- * Time: 14:47
- */
 
 namespace Combodo\iTop\Application\Search;
 
 
-class CriterionConversion
+abstract class CriterionConversionAbstract
 {
 
-}
+	const OP_CONTAINS = 'contains';
+	const OP_STARTS_WITH = 'starts_with';
+	const OP_ENDS_WITH = 'ends_with';
+	const OP_EMPTY = 'empty';
+	const OP_NOT_EMPTY = 'not_empty';
+
+
+}
+

sources/application/search/criterionparser.class.inc.php

@@ -29,6 +29,7 @@
 namespace Combodo\iTop\Application\Search;
 
 
+use Combodo\iTop\Application\Search\CriterionConversion\CriterionToOQL;
 use DBObjectSearch;
 use IssueLog;
 use OQLException;
@@ -62,19 +63,17 @@ class CriterionParser
 		}
 
 		// Sanitize the base OQL
-		if (strpos($sBaseOql, ' WHERE '))
+		try
 		{
-			try
-			{
-				$oSearch = DBObjectSearch::FromOQL($sBaseOql);
-				$oSearch->ResetCondition();
-				$sBaseOql = $oSearch->ToOQL();
-			} catch (OQLException $e)
-			{
-				IssueLog::Error($e->getMessage());
-			}
+			$oSearch = DBObjectSearch::FromOQL($sBaseOql);
+			$oSearch->ResetCondition();
+			$sBaseOql = str_replace(' WHERE 1', '', $oSearch->ToOQL());
+		} catch (OQLException $e)
+		{
+			IssueLog::Error($e->getMessage());
 		}
 
+
 		return $sBaseOql.' WHERE '.implode(" OR ", $aExpression).'';
 	}
 
@@ -83,7 +82,7 @@ class CriterionParser
 		$aExpression = array();
 		foreach($aAnd as $aCriteria)
 		{
-			$aExpression[] = self::ParseCriteria($aCriteria);
+			$aExpression[] = CriterionToOQL::Convert($aCriteria);
 		}
 
 		if (empty($aExpression))
@@ -93,22 +92,4 @@ class CriterionParser
 
 		return '('.implode(" AND ", $aExpression).')';
 	}
-
-	private static function ParseCriteria($aCriteria)
-	{
-
-		if (!empty($aCriteria['oql']))
-		{
-			return $aCriteria['oql'];
-		}
-
-		// TODO Manage more complicated case
-		$aRef = explode('.', $aCriteria['ref']);
-		$sRef = '`'.$aRef[0].'`.`'.$aRef[1].'`';
-
-		$sOperator = $aCriteria['operator'];
-		$sValue = $aCriteria['values'][0]['value'];
-
-		return "({$sRef} {$sOperator} '{$sValue}')";
-	}
 }

sources/application/search/searchform.class.inc.php

@@ -26,6 +26,7 @@ namespace Combodo\iTop\Application\Search;
 use ApplicationContext;
 use AttributeDefinition;
 use CMDBObjectSet;
+use Combodo\iTop\Application\Search\CriterionConversion\CriterionToSearchForm;
 use CoreException;
 use DBObjectSearch;
 use Dict;
@@ -212,6 +213,7 @@ class SearchForm
 				}
 				$aAndCriterion[] = $oAndSubExpr->GetCriterion($oSearch);
 			}
+			$aAndCriterion = CriterionToSearchForm::Convert($aAndCriterion);
 			$aOrCriterion[] = array('and' => $aAndCriterion);
 		}
 

test/application/search/CriterionConversionTest.php

@@ -0,0 +1,148 @@
+<?php
+/**
+ * Copyright (C) 2010-2018 Combodo SARL
+ *
+ * This file is part of iTop.
+ *
+ *  iTop is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * iTop is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with iTop. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Created by PhpStorm.
+ * User: Eric
+ * Date: 08/03/2018
+ * Time: 16:46
+ */
+
+namespace Combodo\iTop\Test\UnitTest\Application\Search;
+
+use Combodo\iTop\Application\Search\CriterionConversion\CriterionToOQL;
+use Combodo\iTop\Test\UnitTest\ItopDataTestCase;
+
+class CriterionConversionTest extends ItopDataTestCase
+{
+	/**
+	 * @throws Exception
+	 */
+	protected function setUp()
+	{
+		parent::setUp();
+
+		require_once(APPROOT."sources/application/search/criterionconversionabstract.class.inc.php");
+	}
+
+	/**
+	 * @dataProvider ToOqlProvider
+	 */
+	public function testToOql($sJSONCriterion, $sExpectedOQL)
+	{
+		$sOql = CriterionToOQL::Convert(
+			json_decode($sJSONCriterion, true)
+		);
+
+		$this->debug($sOql);
+		$this->assertEquals($sExpectedOQL, $sOql);
+	}
+
+	public function ToOqlProvider()
+	{
+		return array(
+			'>' => array(
+				'{
+                    "ref": "UserRequest.start_date",
+                    "values": [
+                        {
+                            "value": "2017-01-01",
+                            "label": "2017-01-01 00:00:00"
+                        }
+                    ],
+                    "operator": ">",
+                    "oql": ""
+                }',
+				"(`UserRequest`.`start_date` > '2017-01-01')"
+			),
+			'contains' => array(
+				'{
+                    "ref": "Contact.name",
+                    "values": [
+                        {
+                            "value": "toto",
+                            "label": "toto"
+                        }
+                    ],
+                    "operator": "contains",
+                    "oql": ""
+                }',
+				"(`Contact`.`name` LIKE '%toto%')"
+			),
+			'starts_with' => array(
+				'{
+                    "ref": "Contact.name",
+                    "values": [
+                        {
+                            "value": "toto",
+                            "label": "toto"
+                        }
+                    ],
+                    "operator": "starts_with",
+                    "oql": ""
+                }',
+				"(`Contact`.`name` LIKE 'toto%')"
+			),
+			'ends_with' => array(
+				'{
+                    "ref": "Contact.name",
+                    "values": [
+                        {
+                            "value": "toto",
+                            "label": "toto"
+                        }
+                    ],
+                    "operator": "ends_with",
+                    "oql": ""
+                }',
+				"(`Contact`.`name` LIKE '%toto')"
+			),
+			'empty' => array(
+				'{
+                    "ref": "Contact.name",
+                    "values": [
+                        {
+                            "value": "",
+                            "label": ""
+                        }
+                    ],
+                    "operator": "empty",
+                    "oql": ""
+                }',
+				"(`Contact`.`name` = '')"
+			),
+			'not_empty' => array(
+				'{
+                    "ref": "Contact.name",
+                    "values": [
+                        {
+                            "value": "",
+                            "label": ""
+                        }
+                    ],
+                    "operator": "not_empty",
+                    "oql": ""
+                }',
+				"(`Contact`.`name` != '')"
+			),
+		);
+	}
+}

test/application/search/CriterionParserTest.php

@@ -81,6 +81,7 @@ class CriterionParserTest extends ItopDataTestCase
 		$sOQL = CriterionParser::Parse($sBaseOql, $aCriterion);
 
 		$this->debug($sOQL);
-		$this->markTestIncomplete();
+
+		$this->assertEquals("SELECT `UserRequest` FROM UserRequest AS `UserRequest` WHERE ((`UserRequest`.`start_date` > '2017-01-01') AND (`UserRequest`.`start_date` < '2018-01-01'))", $sOQL);
 	}
 }