/** * Tools to design OQL queries and test them * * @copyright Copyright (C) 2010-2012 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ require_once('../approot.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(true); // Check user rights and prompt if needed (must be admin) 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' => "
".htmlentities($sDescription, ENT_QUOTES, 'UTF-8')."
", 'oql' => "
".htmlentities($sOql, ENT_QUOTES, 'UTF-8')."
", 'go' => "
$sContext
\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')); // 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 "FYI: '$sClearText'
\n"; $oFilter = DBObjectSearch::unserialize($sExpression); $sExpression = $oFilter->ToOQL(); } else { // leave $sExpression as is } $oFilter = null; $aArgs = array(); $sSyntaxError = null; if (!empty($sExpression)) { try { $oFilter = DBObjectSearch::FromOQL($sExpression); } catch(OqlException $e) { $sSyntaxError = $e->getHtmlDesc(); } 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); } elseif ($sSyntaxError) { // Query arguments taken from the page args } } $oP->add("
\n"); $oP->add(Dict::S('UI:RunQuery:ExpressionToEvaluate')."
\n"); $oP->add("\n"); if (count($aArgs) > 0) { $oP->add("
\n"); $oP->add("

Query arguments

\n"); foreach($aArgs as $sParam => $sValue) { $oP->p("$sParam: \n"); } $oP->add("
\n"); } $oP->add("\n"); $oP->add($oAppContext->GetForForm()); $oP->add("
\n"); if ($oFilter) { $oP->add("

Query results

\n"); $oResultBlock = new DisplayBlock($oFilter, 'list', false); $oResultBlock->Display($oP, 'runquery'); $oP->p(''); $oP->StartCollapsibleSection(Dict::S('UI:RunQuery:MoreInfo'), false); $oP->p(Dict::S('UI:RunQuery:DevelopedQuery').htmlentities($oFilter->ToOQL(), ENT_QUOTES, 'UTF-8')); $oP->p(Dict::S('UI:RunQuery:SerializedFilter').$oFilter->serialize()); $oP->EndCollapsibleSection(); } elseif ($sSyntaxError) { $sWrongWord = $e->GetWrongWord(); $aSuggestedWords = $e->GetSuggestions(); if (count($aSuggestedWords) > 0) { $sSuggestedWord = OqlException::FindClosestString($sWrongWord, $aSuggestedWords); if (strlen($sSuggestedWord) > 0) { $oP->p(''.Dict::Format('UI:RunQuery:Error', $e->GetIssue().' '.$sWrongWord).''); $sBefore = substr($sExpression, 0, $e->GetColumn()); $sAfter = substr($sExpression, $e->GetColumn() + strlen($sWrongWord)); $sFixedExpression = $sBefore.$sSuggestedWord.$sAfter; $sFixedExpressionHtml = $sBefore.''.$sSuggestedWord.''.$sAfter; $oP->p("Suggesting: $sFixedExpressionHtml"); $oP->add(''); } else { $oP->p(''.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).''); } } else { $oP->p(''.Dict::Format('UI:RunQuery:Error', $e->getHtmlDesc()).''); } } } catch(Exception $e) { $oP->p(''.Dict::Format('UI:RunQuery:Error', $e->getMessage()).''); } ExecutionKPI::ReportStats(); $oP->output(); ?>