Fix count with Archive mode

2026-02-13 07:24:13 +01:00 · 2019-10-11 22:06:42 +02:00
parent 4c386da7d2
commit 75794fb4d9
3 changed files with 304 additions and 8 deletions
--- a/core/sqlobjectquerybuilder.class.inc.php
+++ b/core/sqlobjectquerybuilder.class.inc.php
@@ -102,6 +102,18 @@ class SQLObjectQueryBuilder
 		return $oOQLClassNode;
 	}

+	/**
+	 *
+	 * @param \QueryBuilderContext $oBuild  The builder will be unusable after that
+	 *
+	 * @return string
+	 * @throws \CoreException
+	 */
+	public function DebugOQLClassTree($oBuild)
+	{
+		return $this->GetOQLClassTree($oBuild)->RenderDebug();
+	}
+

 	/**
 	 * @param \QueryBuilderContext $oBuild
@@ -264,12 +276,8 @@ class SQLObjectQueryBuilder
 		{
 			if (!$oBuild->GetRootFilter()->GetArchiveMode())
 			{
-				$bIsOnJoinedClass = array_key_exists($sClassAlias, $oBuild->GetRootFilter()->GetJoinedClasses());
-				if ($bIsOnJoinedClass)
-				{
-					$oNotArchived = new BinaryExpression(new FieldExpressionResolved('archive_flag', $sClassAlias), '=', new ScalarExpression(0));
-					$oBuild->AddFilteredTable($sClassAlias, $oNotArchived);
-				}
+				$oNotArchived = new BinaryExpression(new FieldExpressionResolved('archive_flag', $sClassAlias), '=', new ScalarExpression(0));
+				$oBuild->AddFilteredTable($sClassAlias, $oNotArchived);
 			}
 		}

@@ -288,4 +296,4 @@ class SQLObjectQueryBuilder
 		return $oBaseSQLQuery;
 	}

-}
+}
--- a/pages/ajax.searchform.php
+++ b/pages/ajax.searchform.php
@@ -119,7 +119,7 @@ try
 	}


-	if (isset($aListParams['debug']) || (UserRights::IsActionAllowed('ResourceRunQueriesMenu', UR_ACTION_MODIFY) == UR_ALLOWED_YES))
+	if (isset($aListParams['debug']) || UserRights::IsAdministrator())
 	{
 		$oPage->StartCollapsibleSection(Dict::S('UI:RunQuery:MoreInfo'), false, 'SearchQuery');
 		$oPage->p(Dict::S('UI:RunQuery:DevelopedQuery').htmlentities($oFilter->ToOQL(), ENT_QUOTES, 'UTF-8'));
--- a/test/VerifyOQL.php
+++ b/test/VerifyOQL.php
@@ -0,0 +1,288 @@
+<?php
+/**
+ * @copyright   Copyright (C) 2010-2019 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+
+/**
+ * Copyright (C) 2013-2019 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
+ */
+
+require_once('../approot.inc.php');
+require_once(APPROOT.'/bootstrap.inc.php');
+require_once(APPROOT.'/application/application.inc.php');
+require_once(APPROOT.'/application/itopwebpage.class.inc.php');
+require_once(APPROOT.'/application/startup.inc.php');
+require_once(APPROOT.'/application/loginwebpage.class.inc.php');
+
+LoginWebPage::DoLogin(); // Check user rights and prompt if needed
+ApplicationMenu::CheckMenuIdEnabled('RunQueriesMenu');
+
+function ShowExamples($oP, $sExpression)
+{
+	$bUsingExample = false;
+
+	$aExamples = array(
+		'Pedagogic examples' => array(
+			"Web applications" => "SELECT WebApplication",
+			"Person having an 'A' in their name" => "SELECT Person AS B WHERE B.name LIKE '%A%'",
+			"Servers having a name like dbserver1.demo.com or dbserver023.foo.fr" => "SELECT Server WHERE name REGEXP '^dbserver[0-9]+\\\\..+\\\\.[a-z]{2,3}$'",
+			"Changes planned on new year's day" => "SELECT Change AS ch WHERE ch.start_date >= '2009-12-31' AND ch.end_date <= '2010-01-01'",
+			"IPs in a range" => "SELECT DatacenterDevice AS dev WHERE INET_ATON(dev.managementip) > INET_ATON('10.22.32.224') AND INET_ATON(dev.managementip) < INET_ATON('10.22.32.255')",
+			"Persons below a given root organization" => "SELECT Person AS P JOIN Organization AS Node ON P.org_id = Node.id JOIN Organization AS Root ON Node.parent_id BELOW Root.id WHERE Root.id=1",
+		),
+		'Usefull examples' => array(
+			"NW interfaces of equipment in production for customer 'Demo'" => "SELECT PhysicalInterface AS if JOIN DatacenterDevice AS dev ON if.connectableci_id = dev.id WHERE dev.status = 'production' AND dev.organization_name = 'Demo'",
+			"My tickets" => "SELECT Ticket AS t WHERE t.agent_id = :current_contact_id",
+			"People being owner of an active ticket" => "SELECT Person AS p JOIN UserRequest AS u ON u.agent_id = p.id WHERE u.status != 'closed'",
+			"Contracts terminating in the next thirty days" => "SELECT Contract AS c WHERE c.end_date > NOW() AND c.end_date < DATE_ADD(NOW(), INTERVAL 30 DAY)",
+			"Orphan tickets (opened one hour ago, still not assigned)" => "SELECT UserRequest AS u WHERE u.start_date < DATE_SUB(NOW(), INTERVAL 60 MINUTE) AND u.status = 'new'",
+			"Long lasting incidents (duration > 8 hours)" => "SELECT UserRequest AS u WHERE u.close_date > DATE_ADD(u.start_date, INTERVAL 8 HOUR)",
+		),
+	);
+
+	$aDisplayData = array();
+	$oAppContext = new ApplicationContext();
+	$sContext = $oAppContext->GetForForm();
+	foreach ($aExamples as $sTopic => $aQueries)
+	{
+		foreach ($aQueries as $sDescription => $sOql)
+		{
+			$sHighlight = '';
+			$sDisable = '';
+			if ($sOql == $sExpression)
+			{
+				// this one is currently being tested, highlight it
+				$sHighlight = "background-color:yellow;";
+				$sDisable = 'disabled';
+				// and remember we are testing a query of the list
+				$bUsingExample = true;
+			}
+			//$aDisplayData[$sTopic][] = array(
+			$aDisplayData[Dict::S('UI:RunQuery:QueryExamples')][] = array(
+				'desc' => "<div style=\"$sHighlight\">".htmlentities($sDescription, ENT_QUOTES, 'UTF-8')."</div>",
+				'oql' => "<div style=\"$sHighlight\">".htmlentities($sOql, ENT_QUOTES, 'UTF-8')."</div>",
+				'go' => "<form method=\"get\"><input type=\"hidden\" name=\"expression\" value=\"$sOql\"><input type=\"submit\" value=\"".Dict::S('UI:Button:Test')."\" $sDisable>$sContext</form>\n",
+			);
+		}
+	}
+	$aDisplayConfig = array();
+	$aDisplayConfig['desc'] = array('label' => Dict::S('UI:RunQuery:HeaderPurpose'), 'description' => Dict::S('UI:RunQuery:HeaderPurpose+'));
+	$aDisplayConfig['oql'] = array('label' => Dict::S('UI:RunQuery:HeaderOQLExpression'), 'description' => Dict::S('UI:RunQuery:HeaderOQLExpression+'));
+	$aDisplayConfig['go'] = array('label' => '', 'description' => '');
+
+	foreach ($aDisplayData as $sTopic => $aQueriesDisplayData)
+	{
+		$bShowOpened = $bUsingExample;
+		$oP->StartCollapsibleSection($sTopic, $bShowOpened);
+		$oP->table($aDisplayConfig, $aQueriesDisplayData);
+		$oP->EndCollapsibleSection();
+	}
+}
+
+$sOperation = utils::ReadParam('operation', 'menu');
+$oAppContext = new ApplicationContext();
+
+$oP = new iTopWebPage(Dict::S('UI:RunQuery:Title'));
+$oP->SetBreadCrumbEntry('ui-tool-runquery', Dict::S('Menu:RunQueriesMenu'), Dict::S('Menu:RunQueriesMenu+'), '', utils::GetAbsoluteUrlAppRoot().'images/wrench.png');
+
+// Main program
+$sExpression = utils::ReadParam('expression', '', false, 'raw_data');
+$sEncoding = utils::ReadParam('encoding', 'oql');
+
+ShowExamples($oP, $sExpression);
+
+try
+{
+	if ($sEncoding == 'crypted')
+	{
+		// Translate $sExpression into a oql expression
+		$sClearText = base64_decode($sExpression);
+		echo "<strong>FYI: '$sClearText'</strong><br/>\n";
+		$oFilter = DBObjectSearch::unserialize($sExpression);
+		$sExpression = $oFilter->ToOQL();
+	}
+
+	$oFilter = null;
+	$aArgs = array();
+	$sSyntaxError = null;
+
+	if (!empty($sExpression))
+	{
+		try
+		{
+			$oFilter = DBObjectSearch::FromOQL($sExpression);
+		} catch (Exception $e)
+		{
+			if ($e instanceof OqlException)
+			{
+				$sSyntaxError = $e->getHtmlDesc();
+			}
+			else
+			{
+				$sSyntaxError = $e->getMessage();
+			}
+		}
+
+		if ($oFilter)
+		{
+			$aArgs = array();
+			foreach ($oFilter->GetQueryParams() as $sParam => $foo)
+			{
+				$value = utils::ReadParam('arg_'.$sParam, null, true, 'raw_data');
+				if (!is_null($value))
+				{
+					$aArgs[$sParam] = $value;
+				}
+				else
+				{
+					$aArgs[$sParam] = '';
+				}
+			}
+			$oFilter->SetInternalParams($aArgs);
+		}
+	}
+
+	$oP->add("<form method=\"post\">\n");
+	$oP->add(Dict::S('UI:RunQuery:ExpressionToEvaluate')."<br/>\n");
+	$oP->add("<textarea cols=\"120\" rows=\"8\" id=\"expression\" name=\"expression\">".htmlentities($sExpression, ENT_QUOTES, 'UTF-8')."</textarea>\n");
+	$oP->add_linked_script(utils::GetAbsoluteUrlAppRoot()."/js/jquery.hotkeys.js");
+	$oP->add_ready_script(<<<EOF
+$("#expression").select();
+$("#expression").on("keydown", null, "ctrl+return", function() {
+	$(this).closest("form").submit();
+});
+EOF
+	);
+
+	if (count($aArgs) > 0)
+	{
+		$oP->add("<div class=\"wizContainer\">\n");
+		$oP->add("<h3>Query arguments</h3>\n");
+		foreach ($aArgs as $sParam => $sValue)
+		{
+			$oP->p("$sParam: <input type=\"string\" name=\"arg_$sParam\" value=\"$sValue\">\n");
+		}
+		$oP->add("</div>\n");
+	}
+
+	$oP->add("<input type=\"submit\" value=\"".Dict::S('UI:Button:Evaluate')."\" title=\"".Dict::S('UI:Button:Evaluate:Title')."\">\n");
+	$oP->add($oAppContext->GetForForm());
+	$oP->add("</form>\n");
+
+
+	if ($oFilter)
+	{
+		$oP->add("<h3>Query results</h3>\n");
+
+		$oResultBlock = new DisplayBlock($oFilter, 'list', false);
+		$oResultBlock->Display($oP, 'runquery');
+
+		// Breadcrumb
+		//$iCount = $oResultBlock->GetDisplayedCount();
+		$sPageId = "ui-search-".$oFilter->GetClass();
+		$sLabel = MetaModel::GetName($oFilter->GetClass());
+		$aArgs = array();
+		foreach (array_merge($_POST, $_GET) as $sKey => $value)
+		{
+			if (is_array($value))
+			{
+				$aItems = array();
+				foreach ($value as $sItemKey => $sItemValue)
+				{
+					$aArgs[] = $sKey.'['.$sItemKey.']='.urlencode($sItemValue);
+				}
+			}
+			else
+			{
+				$aArgs[] = $sKey.'='.urlencode($value);
+			}
+		}
+		$sUrl = utils::GetAbsoluteUrlAppRoot().'pages/run_query.php?'.implode('&', $aArgs);
+		$oP->SetBreadCrumbEntry($sPageId, $sLabel, $oFilter->ToOQL(true), $sUrl, '../images/breadcrumb-search.png');
+
+		$oP->p('');
+		$oP->StartCollapsibleSection(Dict::S('UI:RunQuery:MoreInfo'), false, 'runQuery');
+		$oP->p('<pre>'.$oFilter->ToOQL().'</pre>');
+		$oP->EndCollapsibleSection();
+
+		$aModifierProperties = MetaModel::MakeModifierProperties($oFilter);
+
+		$oP->StartCollapsibleSection('OQL Developed');
+		$oSQLObjectQueryBuilder = new SQLObjectQueryBuilder($oFilter);
+		$oBuild = new QueryBuilderContext($oFilter, $aModifierProperties);
+		$oP->p('<pre>'.$oSQLObjectQueryBuilder->DebugOQLClassTree($oBuild).'</pre>');
+		$oP->EndCollapsibleSection();
+
+		$oP->StartCollapsibleSection('SQL Count');
+		$oSQLObjectQueryBuilder = new SQLObjectQueryBuilder($oFilter);
+		$oBuild = new QueryBuilderContext($oFilter, $aModifierProperties);
+		$oSQLQueryCount = $oSQLObjectQueryBuilder->BuildSQLQueryStruct(null, true, $aModifierProperties);
+		$oP->p('<pre>'.$oSQLQueryCount->RenderSelect(array(), array(), 0, 0, true, true).'</pre>');
+		$oP->EndCollapsibleSection();
+
+		$oP->StartCollapsibleSection('SQL');
+		$oSQLObjectQueryBuilder = new SQLObjectQueryBuilder($oFilter);
+		$oBuild = new QueryBuilderContext($oFilter, $aModifierProperties);
+		$oSQLQuery = $oSQLObjectQueryBuilder->BuildSQLQueryStruct(null, false, $aModifierProperties);
+		$oP->p('<pre>'.$oSQLQuery->RenderSelect(array(), array(), 10, 0, false, true).'</pre>');
+		$oP->EndCollapsibleSection();
+
+	}
+	elseif ($sSyntaxError)
+	{
+		if ($e instanceof OqlException)
+		{
+			$sWrongWord = $e->GetWrongWord();
+			$aSuggestedWords = $e->GetSuggestions();
+			if (count($aSuggestedWords) > 0)
+			{
+				$sSuggestedWord = OqlException::FindClosestString($sWrongWord, $aSuggestedWords);
+
+				if (strlen($sSuggestedWord) > 0)
+				{
+					$oP->p('<b>'.Dict::Format('UI:RunQuery:Error', $e->GetIssue().' <em>'.$sWrongWord).'</em></b>');
+					$sBefore = substr($sExpression, 0, $e->GetColumn());
+					$sAfter = substr($sExpression, $e->GetColumn() + strlen($sWrongWord));
+					$sFixedExpression = $sBefore.$sSuggestedWord.$sAfter;
+					$sFixedExpressionHtml = $sBefore.'<span style="background-color:yellow">'.$sSuggestedWord.'</span>'.$sAfter;
+					$oP->p("Suggesting: $sFixedExpressionHtml");
+					$oP->add('<button onClick="$(\'textarea[name=expression]\').val(\''.htmlentities(addslashes($sFixedExpression)).'\');">Use this query</button>');
+				}
+				else
+				{
+					$oP->p('<b>'.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).'</b>');
+				}
+			}
+			else
+			{
+				$oP->p('<b>'.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).'</b>');
+			}
+		}
+		else
+		{
+			$oP->p('<b>'.Dict::Format('UI:RunQuery:Error', $e->getMessage()).'</b>');
+		}
+	}
+} catch (Exception $e)
+{
+	$oP->p('<b>'.Dict::Format('UI:RunQuery:Error', $e->getMessage()).'</b>');
+}
+
+$oP->output();
+