nicer formatting for Geocode debug output

diff --git a/lib/DebugHtml.php b/lib/DebugHtml.php
new file mode 100644 (file)
index 0000000..ce2b836
--- /dev/null
+++ b/lib/DebugHtml.php
@@ -0,0 +1,159 @@
+<?php
+
+namespace Nominatim;
+
+class Debug
+{
+    public static function newFunction($sHeading)
+    {
+        echo "<pre><h2>Debug output for $sHeading</h2></pre>\n";
+    }
+
+    public static function newSection($sHeading)
+    {
+        echo "<hr><pre><h3>$sHeading</h3></pre>\n";
+    }
+
+    public static function printVar($sHeading, $mVar)
+    {
+        echo '<pre><b>'.$sHeading. ':</b>  ';
+        Debug::outputVar($mVar, str_repeat(' ', strlen($sHeading) + 3));
+        echo "</pre>\n";
+    }
+
+    public static function fmtArrayVals($aArr)
+    {
+        return array('__debug_format' => 'array_vals', 'data' => $aArr);
+    }
+
+    public static function printDebugArray($sHeading, $oVar)
+    {
+
+        if ($oVar === null) {
+            Debug::printVar($sHeading, 'null');
+        } else {
+            Debug::printVar($sHeading, $oVar->debugInfo());
+        }
+    }
+
+    public static function printDebugTable($sHeading, $aVar)
+    {
+        echo '<b>'.$sHeading.":</b>\n";
+        echo '<table border="1">';
+        if (!empty($aVar)) {
+            echo '<tr>';
+            $aKeys = array();
+            $aInfo = reset($aVar);
+            if (!is_array($aInfo)) {
+                $aInfo = $aInfo->debugInfo();
+            }
+            foreach ($aInfo as $sKey => $mVal) {
+                echo '<th><small>'.$sKey.'</small></th>';
+                $aKeys[] = $sKey;
+            }
+            echo '</tr>';
+            foreach ($aVar as $oRow) {
+                $aInfo = $oRow;
+                if (!is_array($oRow)) {
+                    $aInfo = $oRow->debugInfo();
+                }
+                echo '<tr>';
+                foreach ($aKeys as $sKey) {
+                    echo '<td><pre>';
+                    if (isset($aInfo[$sKey])) {
+                        Debug::outputVar($aInfo[$sKey], '');
+                    }
+                    echo '</pre></td>';
+                }
+                echo '<tr>';
+            }
+        }
+        echo '</table>';
+    }
+
+    public static function printGroupTable($sHeading, $aVar)
+    {
+        echo '<b>'.$sHeading.":</b>\n";
+        echo '<table border="1">';
+        if (!empty($aVar)) {
+            echo '<tr><th><small>Group</small></th>';
+            $aKeys = array();
+            $aInfo = reset(reset($aVar));
+            if (!is_array($aInfo)) {
+                $aInfo = $aInfo->debugInfo();
+            }
+            foreach ($aInfo as $sKey => $mVal) {
+                echo '<th><small>'.$sKey.'</small></th>';
+                $aKeys[] = $sKey;
+            }
+            echo '</tr>';
+            foreach ($aVar as $sGrpKey => $aGroup) {
+                foreach ($aGroup as $oRow) {
+                    $aInfo = $oRow;
+                    if (!is_array($oRow)) {
+                        $aInfo = $oRow->debugInfo();
+                    }
+                    echo '<tr><td><pre>'.$sGrpKey.'</pre></td>';
+                    foreach ($aKeys as $sKey) {
+                        echo '<td><pre>';
+                        if (!empty($aInfo[$sKey])) {
+                            Debug::outputVar($aInfo[$sKey], '');
+                        }
+                        echo '</pre></td>';
+                    }
+                    echo '<tr>';
+                }
+            }
+        }
+        echo '</table>';
+    }
+
+    public static function printSQL($sSQL)
+    {
+        echo '<p><tt><font color="#aaa">'.$sSQL.'</font></tt></p>'."\n";
+    }
+
+    private static function outputVar($mVar, $sPreNL)
+    {
+        if (is_array($mVar) && !isset($mVar['__debug_format'])) {
+            $sPre = '';
+            foreach ($mVar as $mKey => $aValue) {
+                echo $sPre;
+                $iKeyLen = Debug::outputSimpleVar($mKey);
+                echo ' => ';
+                Debug::outputVar(
+                    $aValue,
+                    $sPreNL.str_repeat(' ', $iKeyLen + 4)
+                );
+                $sPre = "\n".$sPreNL;
+            }
+        } elseif (is_array($mVar) && isset($mVar['__debug_format'])) {
+            if (!empty($mVar[data])) {
+                $sPre = '';
+                foreach ($mVar[data] as $mValue) {
+                    echo $sPre;
+                    Debug::outputSimpleVar($mValue);
+                    $sPre = ', ';
+                }
+            }
+        } else {
+            Debug::outputSimpleVar($mVar);
+        }
+    }
+
+    private static function outputSimpleVar($mVar)
+    {
+        if (is_bool($mVar)) {
+            echo '<i>'.($mVar ? 'True' : 'False').'</i>';
+            return $mVar ? 4 : 5;
+        }
+
+        if (is_string($mVar)) {
+            echo "'$mVar'";
+            return strlen($mVar) + 2;
+        }
+
+        echo (string)$mVar;
+        return strlen((string)$mVar);
+    }
+}

diff --git a/lib/DebugNone.php b/lib/DebugNone.php
new file mode 100644 (file)
index 0000000..e2d18b2
--- /dev/null
+++ b/lib/DebugNone.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Nominatim;
+
+class Debug
+{
+    public static function __callStatic($name, $arguments)
+    {
+        // nothing
+    }
+}

diff --git a/lib/Geocode.php b/lib/Geocode.php
index 9daaff84df73a04026c77cc8d95d67c30a5663fa..d00104178fe7459de78789977c82b9fff7ca9565 100644 (file)
--- a/lib/Geocode.php
+++ b/lib/Geocode.php
@@ -446,8 +446,6 @@ class Geocode
                 $aSearches = array_merge($aSearches, $aNewSearches);
                 if ($iSearchCount > 50) break;
             }
                 $aSearches = array_merge($aSearches, $aNewSearches);
                 if ($iSearchCount > 50) break;
             }

-
-            //if (CONST_Debug) _debugDumpGroupedSearches($aGroupedSearches, $aValidTokens);

         }
 
         // Revisit searches, drop bad searches and give penalty to unlikely combinations.
         }
 
         // Revisit searches, drop bad searches and give penalty to unlikely combinations.


@@ -502,8 +500,11 @@ class Geocode
 
     public function lookup()
     {
 
     public function lookup()
     {

+        Debug::newFunction('Geocode::lookup');

         if (!$this->sQuery && !$this->aStructuredQuery) return array();
 
         if (!$this->sQuery && !$this->aStructuredQuery) return array();
 

+        Debug::printDebugArray('Geocode', $this);
+

         $oCtx = new SearchContext();
 
         if ($this->aRoutePoints) {
         $oCtx = new SearchContext();
 
         if ($this->aRoutePoints) {


@@ -523,7 +524,11 @@ class Geocode
             $oCtx->setCountryList($this->aCountryCodes);
         }
 
             $oCtx->setCountryList($this->aCountryCodes);
         }
 

+        Debug::newSection('Query Preprocessing');
+

         $sNormQuery = $this->normTerm($this->sQuery);
         $sNormQuery = $this->normTerm($this->sQuery);

+        Debug::printVar('Normalized query', $sNormQuery);
+

         $sLanguagePrefArraySQL = getArraySQL(
             array_map('getDBQuoted', $this->aLangPrefOrder)
         );
         $sLanguagePrefArraySQL = getArraySQL(
             array_map('getDBQuoted', $this->aLangPrefOrder)
         );


@@ -560,6 +565,10 @@ class Geocode
                     $aSpecialTermsRaw,
                     PREG_SET_ORDER
                 );
                     $aSpecialTermsRaw,
                     PREG_SET_ORDER
                 );

+                if (!empty($aSpecialTermsRaw)) {
+                    Debug::printVar('Special terms', $aSpecialTermsRaw);
+                }
+

                 foreach ($aSpecialTermsRaw as $aSpecialTerm) {
                     $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
                     if (!$sSpecialTerm) {
                 foreach ($aSpecialTermsRaw as $aSpecialTerm) {
                     $sQuery = str_replace($aSpecialTerm[0], ' ', $sQuery);
                     if (!$sSpecialTerm) {


@@ -582,7 +591,8 @@ class Geocode
                 $sSQL = 'SELECT class, type FROM word ';
                 $sSQL .= '   WHERE word_token in (\' '.$sToken.'\')';
                 $sSQL .= '   AND class is not null AND class not in (\'place\')';
                 $sSQL = 'SELECT class, type FROM word ';
                 $sSQL .= '   WHERE word_token in (\' '.$sToken.'\')';
                 $sSQL .= '   AND class is not null AND class not in (\'place\')';

-                if (CONST_Debug) var_Dump($sSQL);
+
+                Debug::printSQL($sSQL);

                 $aSearchWords = chksql($this->oDB->getAll($sSQL));
                 $aNewSearches = array();
                 foreach ($aSearches as $oSearch) {
                 $aSearchWords = chksql($this->oDB->getAll($sSQL));
                 $aNewSearches = array();
                 foreach ($aSearches as $oSearch) {


@@ -609,10 +619,15 @@ class Geocode
                 $bStructuredPhrases = false;
             }
 
                 $bStructuredPhrases = false;
             }
 

+            Debug::printDebugArray('Search context', $oCtx);
+            Debug::printDebugArray('Base search', $aSearches[0]);
+            Debug::printVar('Final query phrases', $aInPhrases);
+

             // Convert each phrase to standard form
             // Create a list of standard words
             // Get all 'sets' of words
             // Generate a complete list of all
             // Convert each phrase to standard form
             // Create a list of standard words
             // Get all 'sets' of words
             // Generate a complete list of all

+            Debug::newSection('Tokenization');

             $aTokens = array();
             $aPhrases = array();
             foreach ($aInPhrases as $iPhrase => $sPhrase) {
             $aTokens = array();
             $aPhrases = array();
             foreach ($aInPhrases as $iPhrase => $sPhrase) {


@@ -627,13 +642,16 @@ class Geocode
                 }
             }
 
                 }
             }
 

+            Debug::printDebugTable('Phrases', $aPhrases);
+            Debug::printVar('Tokens', $aTokens);
+

             if (!empty($aTokens)) {
                 // Check which tokens we have, get the ID numbers
                 $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
                 $sSQL .= ' FROM word ';
                 $sSQL .= ' WHERE word_token in ('.join(',', array_map('getDBQuoted', $aTokens)).')';
 
             if (!empty($aTokens)) {
                 // Check which tokens we have, get the ID numbers
                 $sSQL = 'SELECT word_id, word_token, word, class, type, country_code, operator, search_name_count';
                 $sSQL .= ' FROM word ';
                 $sSQL .= ' WHERE word_token in ('.join(',', array_map('getDBQuoted', $aTokens)).')';
 

-                if (CONST_Debug) var_Dump($sSQL);
+                Debug::printSQL($sSQL);

 
                 $aValidTokens = array();
                 $aDatabaseWords = chksql(
 
                 $aValidTokens = array();
                 $aDatabaseWords = chksql(


@@ -665,7 +683,6 @@ class Geocode
                     }
                     $aWordFrequencyScores[$aToken['word_id']] = $aToken['search_name_count'] + 1;
                 }
                     }
                     $aWordFrequencyScores[$aToken['word_id']] = $aToken['search_name_count'] + 1;
                 }

-                if (CONST_Debug) var_Dump($aPhrases, $aValidTokens);

 
                 // US ZIP+4 codes - if there is no token, merge in the 5-digit ZIP code
                 foreach ($aTokens as $sToken) {
 
                 // US ZIP+4 codes - if there is no token, merge in the 5-digit ZIP code
                 foreach ($aTokens as $sToken) {


@@ -690,9 +707,11 @@ class Geocode
                         $aValidTokens[' '.$sToken] = array(array('class' => 'place', 'type' => 'house', 'word_token' => ' '.$sToken));
                     }
                 }
                         $aValidTokens[' '.$sToken] = array(array('class' => 'place', 'type' => 'house', 'word_token' => ' '.$sToken));
                     }
                 }

+                Debug::printGroupTable('Valid Tokens', $aValidTokens);

 
                 // Any words that have failed completely?
                 // TODO: suggestions
 
                 // Any words that have failed completely?
                 // TODO: suggestions

+                Debug::newSection('Search candidates');

 
                 $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $aValidTokens, $bStructuredPhrases);
 
 
                 $aGroupedSearches = $this->getGroupedSearches($aSearches, $aPhrases, $aValidTokens, $bStructuredPhrases);
 


@@ -806,7 +825,7 @@ class Geocode
                     $aFilteredIDs = array();
                     if ($aFilterSql) {
                         $sSQL = join(' UNION ', $aFilterSql);
                     $aFilteredIDs = array();
                     if ($aFilterSql) {
                         $sSQL = join(' UNION ', $aFilterSql);

-                        if (CONST_Debug) var_dump($sSQL);
+                        Debug::printSQL($sSQL);

                         $aFilteredIDs = chksql($this->oDB->getCol($sSQL));
                     }
 
                         $aFilteredIDs = chksql($this->oDB->getCol($sSQL));
                     }
 


@@ -835,7 +854,7 @@ class Geocode
 
             $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
 
 
             $oLookup = $oReverse->lookupPoint($oCtx->sqlNear, false);
 

-            if (CONST_Debug) var_dump('Reverse search', $aLookup);
+            Debug::printVar('Reverse search', $oLookup);

 
             if ($oLookup) {
                 $aResults = array($oLookup->iId => $oLookup);
 
             if ($oLookup) {
                 $aResults = array($oLookup->iId => $oLookup);


@@ -870,10 +889,7 @@ class Geocode
             if (!preg_match('/[\pL\pN]/', $sWord)) unset($aRecheckWords[$i]);
         }
 
             if (!preg_match('/[\pL\pN]/', $sWord)) unset($aRecheckWords[$i]);
         }
 

-        if (CONST_Debug) {
-            echo '<i>Recheck words:<\i>';
-            var_dump($aRecheckWords);
-        }
+        Debug::printVar('Recheck words', $aRecheckWords);

 
         foreach ($aSearchResults as $iIdx => $aResult) {
             // Default
 
         foreach ($aSearchResults as $iIdx => $aResult) {
             // Default


@@ -952,18 +968,16 @@ class Geocode
                     $aResult['foundorder'] += 0.01;
                 }
             }
                     $aResult['foundorder'] += 0.01;
                 }
             }

-            if (CONST_Debug) var_dump($aResult);

             $aSearchResults[$iIdx] = $aResult;
         }
         uasort($aSearchResults, 'byImportance');
             $aSearchResults[$iIdx] = $aResult;
         }
         uasort($aSearchResults, 'byImportance');

+        Debug::printVar('Pre-filter results', $aSearchResults);

 
         $aOSMIDDone = array();
         $aClassTypeNameDone = array();
         $aToFilter = $aSearchResults;
         $aSearchResults = array();
 
 
         $aOSMIDDone = array();
         $aClassTypeNameDone = array();
         $aToFilter = $aSearchResults;
         $aSearchResults = array();
 

-        if (CONST_Debug) var_dump($aToFilter);
-

         $bFirst = true;
         foreach ($aToFilter as $aResult) {
             $this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];
         $bFirst = true;
         foreach ($aToFilter as $aResult) {
             $this->aExcludePlaceIDs[$aResult['place_id']] = $aResult['place_id'];


@@ -985,7 +999,30 @@ class Geocode
             if (count($aSearchResults) >= $this->iFinalLimit) break;
         }
 
             if (count($aSearchResults) >= $this->iFinalLimit) break;
         }
 

-        if (CONST_Debug) var_dump($aSearchResults);
+        Debug::printVar('Post-filter results', $aSearchResults);

         return $aSearchResults;
     } // end lookup()
         return $aSearchResults;
     } // end lookup()

+
+    public function debugInfo()
+    {
+        return array(
+                'Query' => $this->sQuery,
+                'Structured query' => $this->aStructuredQuery,
+                'Name keys' => Debug::fmtArrayVals($this->aLangPrefOrder),
+                'Include address' => $this->bIncludeAddressDetails,
+                'Excluded place IDs' => Debug::fmtArrayVals($this->aExcludePlaceIDs),
+                'Try reversed query'=> $this->bReverseInPlan,
+                'Limit (for searches)' => $this->iLimit,
+                'Limit (for results)'=> $this->iFinalLimit,
+                'Country codes' => Debug::fmtArrayVals($this->aCountryCodes),
+                'Bounded search' => $this->bBoundedSearch,
+                'Viewbox' => Debug::fmtArrayVals($this->aViewBox),
+                'Route points' => Debug::fmtArrayVals($this->aRoutePoints),
+                'Route width' => $this->aRouteWidth,
+                'Max rank' => $this->iMaxRank,
+                'Min address rank' => $this->iMinAddressRank,
+                'Max address rank' => $this->iMaxAddressRank,
+                'Address rank list' => Debug::fmtArrayVals($this->aAddressRankList)
+               );
+    }

 } // end class
 } // end class

diff --git a/lib/Phrase.php b/lib/Phrase.php
index e8b31234bb21be37763e6e3c236f42e8476600bd..7cf3f29736d0f7cee944581b558a8bc2658d02cd 100644 (file)
--- a/lib/Phrase.php
+++ b/lib/Phrase.php
@@ -113,4 +113,14 @@ class Phrase
 
         return $aResult;
     }
 
         return $aResult;
     }

+
+    public function debugInfo()
+    {
+        return array(
+                'Type' => $this->sPhraseType,
+                'Phrase' => $this->sPhrase,
+                'Words' => $this->aWords,
+                'WordSets' => $this->aWordSets
+               );
+    }

 }
 }

diff --git a/lib/PlaceLookup.php b/lib/PlaceLookup.php
index bd6fa171d22cf2eaac3bdd7f0e010b5fef0f9f0a..98af69f23b8c70b53747c69cabfce9d5a0c06e0e 100644 (file)
--- a/lib/PlaceLookup.php
+++ b/lib/PlaceLookup.php
@@ -169,14 +169,16 @@ class PlaceLookup
 
     public function lookup($aResults, $iMinRank = 0, $iMaxRank = 30)
     {
 
     public function lookup($aResults, $iMinRank = 0, $iMaxRank = 30)
     {

+        Debug::newFunction('Place lookup');
+

         if (empty($aResults)) {
             return array();
         }
         $aSubSelects = array();
 
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
         if (empty($aResults)) {
             return array();
         }
         $aSubSelects = array();
 
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);

-        if (CONST_Debug) var_dump('PLACEX', $sPlaceIDs);

         if ($sPlaceIDs) {
         if ($sPlaceIDs) {

+            Debug::printVar('Ids from placex', $sPlaceIDs);

             $sSQL  = 'SELECT ';
             $sSQL .= '    osm_type,';
             $sSQL .= '    osm_id,';
             $sSQL  = 'SELECT ';
             $sSQL .= '    osm_type,';
             $sSQL .= '    osm_id,';


@@ -246,6 +248,7 @@ class PlaceLookup
         // postcode table
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
         if ($sPlaceIDs) {
         // postcode table
         $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_POSTCODE);
         if ($sPlaceIDs) {

+            Debug::printVar('Ids from location_postcode', $sPlaceIDs);

             $sSQL = 'SELECT';
             $sSQL .= "  'P' as osm_type,";
             $sSQL .= '  (SELECT osm_id from placex p WHERE p.place_id = lp.parent_place_id) as osm_id,';
             $sSQL = 'SELECT';
             $sSQL .= "  'P' as osm_type,";
             $sSQL .= '  (SELECT osm_id from placex p WHERE p.place_id = lp.parent_place_id) as osm_id,';


@@ -276,6 +279,7 @@ class PlaceLookup
             if (CONST_Use_US_Tiger_Data) {
                 $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_TIGER);
                 if ($sPlaceIDs) {
             if (CONST_Use_US_Tiger_Data) {
                 $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_TIGER);
                 if ($sPlaceIDs) {

+                    Debug::printVar('Ids from Tiger table', $sPlaceIDs);

                     $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_TIGER);
                     // Tiger search only if a housenumber was searched and if it was found
                     // (realized through a join)
                     $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_TIGER);
                     // Tiger search only if a housenumber was searched and if it was found
                     // (realized through a join)


@@ -321,6 +325,7 @@ class PlaceLookup
             // osmline - interpolated housenumbers
             $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_OSMLINE);
             if ($sPlaceIDs) {
             // osmline - interpolated housenumbers
             $sPlaceIDs = Result::joinIdsByTable($aResults, Result::TABLE_OSMLINE);
             if ($sPlaceIDs) {

+                Debug::printVar('Ids from interpolation', $sPlaceIDs);

                 $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_OSMLINE);
                 // interpolation line search only if a housenumber was searched
                 // (realized through a join)
                 $sHousenumbers = Result::sqlHouseNumberTable($aResults, Result::TABLE_OSMLINE);
                 // interpolation line search only if a housenumber was searched
                 // (realized through a join)


@@ -406,16 +411,13 @@ class PlaceLookup
             }
         }
 
             }
         }
 

-        if (CONST_Debug) var_dump($aSubSelects);
-

         if (empty($aSubSelects)) {
             return array();
         }
 
         if (empty($aSubSelects)) {
             return array();
         }
 

-        $aPlaces = chksql(
-            $this->oDB->getAll(join(' UNION ', $aSubSelects)),
-            'Could not lookup place'
-        );
+        $sSQL = join(' UNION ', $aSubSelects);
+        Debug::printSQL($sSQL);
+        $aPlaces = chksql($this->oDB->getAll($sSQL), 'Could not lookup place');

 
         $aClassType = getClassTypes();
         foreach ($aPlaces as &$aPlace) {
 
         $aClassType = getClassTypes();
         foreach ($aPlaces as &$aPlace) {


@@ -457,7 +459,7 @@ class PlaceLookup
             $aPlace['addresstype'] = $sAddressType;
         }
 
             $aPlace['addresstype'] = $sAddressType;
         }
 

-        if (CONST_Debug) var_dump($aPlaces);
+        Debug::printVar('Places', $aPlaces);

 
         return $aPlaces;
     }
 
         return $aPlaces;
     }

diff --git a/lib/Result.php b/lib/Result.php
index 30c5985444b9cf7c0239e57e1d8557bf3b63a4f5..d69ac62f1f7b28cc731a49146b830a59f0323f05 100644 (file)
--- a/lib/Result.php
+++ b/lib/Result.php
@@ -27,6 +27,17 @@ class Result
     /// Subranking within the results (the higher the worse).
     public $iResultRank = 0;
 
     /// Subranking within the results (the higher the worse).
     public $iResultRank = 0;
 

+    public function debugInfo()
+    {
+        return array(
+                'Table' => $this->iTable,
+                'ID' => $this->iId,
+                'House number' => $this->iHouseNumber,
+                'Exact Matches' => $this->iExactMatches,
+                'Result rank' => $this->iResultRank
+               );
+    }
+

 
     public function __construct($sId, $iTable = Result::TABLE_PLACEX)
     {
 
     public function __construct($sId, $iTable = Result::TABLE_PLACEX)
     {

diff --git a/lib/SearchContext.php b/lib/SearchContext.php
index b0ff38d85c05e70a003968571cfa207445ebd8f8..c0ae903295073b237bb44e19bc30b440ba48f46c 100644 (file)
--- a/lib/SearchContext.php
+++ b/lib/SearchContext.php
@@ -267,4 +267,18 @@ class SearchContext
 
         return '';
     }
 
         return '';
     }

+
+    public function debugInfo()
+    {
+        return array(
+                'Near radius' => $this->fNearRadius,
+                'Near point (SQL)' => $this->sqlNear,
+                'Bounded viewbox' => $this->bViewboxBounded,
+                'Viewbox (SQL, small)' => $this->sqlViewboxSmall,
+                'Viewbox (SQL, large)' => $this->sqlViewboxLarge,
+                'Viewbox (SQL, centre)' => $this->sqlViewboxCentre,
+                'Countries (SQL)' => $this->sqlCountryList,
+                'Excluded IDs (SQL)' => $this->sqlExcludeList
+               );
+    }

 }
 }

diff --git a/lib/SearchDescription.php b/lib/SearchDescription.php
index c4f05a0eb6840e510e8dac88f9100676cc053a94..276f4c98fb481b51a66e6df0748d599720384d37 100644 (file)
--- a/lib/SearchDescription.php
+++ b/lib/SearchDescription.php
@@ -43,7 +43,6 @@ class SearchDescription
     /// Index of phrase currently processed.
     private $iNamePhrase = -1;
 
     /// Index of phrase currently processed.
     private $iNamePhrase = -1;
 

-

     /**
      * Create an empty search description.
      *
     /**
      * Create an empty search description.
      *


@@ -450,10 +449,7 @@ class SearchDescription
             }
         }
 
             }
         }
 

-        if (CONST_Debug) {
-            echo '<br><b>Place IDs:</b> ';
-            var_dump(array_keys($aResults));
-        }
+        Debug::printDebugTable('Place IDs', $aResults);

 
         if (!empty($aResults) && $this->sPostcode) {
             $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);
 
         if (!empty($aResults) && $this->sPostcode) {
             $sPlaceIds = Result::joinIdsByTable($aResults, Result::TABLE_PLACEX);


@@ -461,7 +457,7 @@ class SearchDescription
                 $sSQL = 'SELECT place_id FROM placex';
                 $sSQL .= ' WHERE place_id in ('.$sPlaceIds.')';
                 $sSQL .= " AND postcode = '".$this->sPostcode."'";
                 $sSQL = 'SELECT place_id FROM placex';
                 $sSQL .= ' WHERE place_id in ('.$sPlaceIds.')';
                 $sSQL .= " AND postcode = '".$this->sPostcode."'";

-                if (CONST_Debug) var_dump($sSQL);
+                Debug::printSQL($sSQL);

                 $aFilteredPlaceIDs = chksql($oDB->getCol($sSQL));
                 if ($aFilteredPlaceIDs) {
                     $aNewResults = array();
                 $aFilteredPlaceIDs = chksql($oDB->getCol($sSQL));
                 if ($aFilteredPlaceIDs) {
                     $aNewResults = array();


@@ -469,10 +465,7 @@ class SearchDescription
                         $aNewResults[$iPlaceId] = $aResults[$iPlaceId];
                     }
                     $aResults = $aNewResults;
                         $aNewResults[$iPlaceId] = $aResults[$iPlaceId];
                     }
                     $aResults = $aNewResults;

-                    if (CONST_Debug) {
-                        echo '<br><b>Place IDs after postcode filtering:</b> ';
-                        var_dump(array_keys($aResults));
-                    }
+                    Debug::printVar('Place IDs after postcode filtering', $aResults);

                 }
             }
         }
                 }
             }
         }


@@ -491,7 +484,7 @@ class SearchDescription
         }
         $sSQL .= ' ORDER BY st_area(geometry) DESC LIMIT 1';
 
         }
         $sSQL .= ' ORDER BY st_area(geometry) DESC LIMIT 1';
 

-        if (CONST_Debug) var_dump($sSQL);
+        Debug::printSQL($sSQL);

 
         $aResults = array();
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 
         $aResults = array();
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {


@@ -532,7 +525,7 @@ class SearchDescription
                 $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('ct.centroid').' ASC';
             }
             $sSQL .= " limit $iLimit";
                 $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('ct.centroid').' ASC';
             }
             $sSQL .= " limit $iLimit";

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

             $aDBResults = chksql($oDB->getCol($sSQL));
         }
 
             $aDBResults = chksql($oDB->getCol($sSQL));
         }
 


@@ -546,7 +539,7 @@ class SearchDescription
             }
             $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid').' ASC';
             $sSQL .= " LIMIT $iLimit";
             }
             $sSQL .= ' ORDER BY '.$this->oContext->distanceSQL('centroid').' ASC';
             $sSQL .= " LIMIT $iLimit";

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

             $aDBResults = chksql($oDB->getCol($sSQL));
         }
 
             $aDBResults = chksql($oDB->getCol($sSQL));
         }
 


@@ -576,7 +569,7 @@ class SearchDescription
         $sSQL .= $this->oContext->excludeSQL(' AND p.place_id');
         $sSQL .= " LIMIT $iLimit";
 
         $sSQL .= $this->oContext->excludeSQL(' AND p.place_id');
         $sSQL .= " LIMIT $iLimit";
 

-        if (CONST_Debug) var_dump($sSQL);
+        Debug::printSQL($sSQL);

 
         $aResults = array();
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 
         $aResults = array();
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {


@@ -707,7 +700,7 @@ class SearchDescription
             $sSQL .= ' ORDER BY '.join(', ', $aOrder);
             $sSQL .= ' LIMIT '.$iLimit;
 
             $sSQL .= ' ORDER BY '.join(', ', $aOrder);
             $sSQL .= ' LIMIT '.$iLimit;
 

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

 
             $aDBResults = chksql(
                 $oDB->getAll($sSQL),
 
             $aDBResults = chksql(
                 $oDB->getAll($sSQL),


@@ -740,7 +733,7 @@ class SearchDescription
         $sSQL .= $this->oContext->excludeSQL(' AND place_id');
         $sSQL .= " LIMIT $iLimit";
 
         $sSQL .= $this->oContext->excludeSQL(' AND place_id');
         $sSQL .= " LIMIT $iLimit";
 

-        if (CONST_Debug) var_dump($sSQL);
+        Debug::printSQL($sSQL);

 
         // XXX should inherit the exactMatches from its parent
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
 
         // XXX should inherit the exactMatches from its parent
         foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {


@@ -768,7 +761,7 @@ class SearchDescription
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $oResult = new Result($iPlaceId, Result::TABLE_OSMLINE);
 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $oResult = new Result($iPlaceId, Result::TABLE_OSMLINE);


@@ -785,7 +778,7 @@ class SearchDescription
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_AUX);
 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $aResults[$iPlaceId] = new Result($iPlaceId, Result::TABLE_AUX);


@@ -807,7 +800,7 @@ class SearchDescription
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 
             $sSQL .= $this->oContext->excludeSQL(' AND place_id');
             $sSQL .= " limit $iLimit";
 

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $oResult = new Result($iPlaceId, Result::TABLE_TIGER);
 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $oResult = new Result($iPlaceId, Result::TABLE_TIGER);


@@ -841,7 +834,7 @@ class SearchDescription
             $sSQL .= ' ORDER BY rank_search ASC ';
             $sSQL .= " LIMIT $iLimit";
 
             $sSQL .= ' ORDER BY rank_search ASC ';
             $sSQL .= " LIMIT $iLimit";
 

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $aResults[$iPlaceId] = new Result($iPlaceId);
 
             foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                 $aResults[$iPlaceId] = new Result($iPlaceId);


@@ -855,7 +848,7 @@ class SearchDescription
             $bCacheTable = (bool) chksql($oDB->getOne($sSQL));
 
             $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)";
             $bCacheTable = (bool) chksql($oDB->getOne($sSQL));
 
             $sSQL = "SELECT min(rank_search) FROM placex WHERE place_id in ($sPlaceIDs)";

-            if (CONST_Debug) var_dump($sSQL);
+            Debug::printSQL($sSQL);

             $iMaxRank = (int)chksql($oDB->getOne($sSQL));
 
             // For state / country level searches the normal radius search doesn't work very well
             $iMaxRank = (int)chksql($oDB->getOne($sSQL));
 
             // For state / country level searches the normal radius search doesn't work very well


@@ -868,7 +861,7 @@ class SearchDescription
                 $sSQL .= "   AND ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon')";
                 $sSQL .= ' ORDER BY rank_search ASC ';
                 $sSQL .= ' LIMIT 1';
                 $sSQL .= "   AND ST_GeometryType(geometry) in ('ST_Polygon','ST_MultiPolygon')";
                 $sSQL .= ' ORDER BY rank_search ASC ';
                 $sSQL .= ' LIMIT 1';

-                if (CONST_Debug) var_dump($sSQL);
+                Debug::printSQL($sSQL);

                 $sPlaceGeom = chksql($oDB->getOne($sSQL));
             }
 
                 $sPlaceGeom = chksql($oDB->getOne($sSQL));
             }
 


@@ -878,7 +871,7 @@ class SearchDescription
                 $iMaxRank += 5;
                 $sSQL = 'SELECT place_id FROM placex';
                 $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank";
                 $iMaxRank += 5;
                 $sSQL = 'SELECT place_id FROM placex';
                 $sSQL .= " WHERE place_id in ($sPlaceIDs) and rank_search < $iMaxRank";

-                if (CONST_Debug) var_dump($sSQL);
+                Debug::printSQL($sSQL);

                 $aPlaceIDs = chksql($oDB->getCol($sSQL));
                 $sPlaceIDs = join(',', $aPlaceIDs);
             }
                 $aPlaceIDs = chksql($oDB->getCol($sSQL));
                 $sPlaceIDs = join(',', $aPlaceIDs);
             }


@@ -923,7 +916,7 @@ class SearchDescription
                     }
                     $sSQL .= " limit $iLimit";
 
                     }
                     $sSQL .= " limit $iLimit";
 

-                    if (CONST_Debug) var_dump($sSQL);
+                    Debug::printSQL($sSQL);

 
                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                         $aResults[$iPlaceId] = new Result($iPlaceId);
 
                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                         $aResults[$iPlaceId] = new Result($iPlaceId);


@@ -955,7 +948,7 @@ class SearchDescription
                     }
                     $sSQL .= " limit $iLimit";
 
                     }
                     $sSQL .= " limit $iLimit";
 

-                    if (CONST_Debug) var_dump($sSQL);
+                    Debug::printSQL($sSQL);

 
                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                         $aResults[$iPlaceId] = new Result($iPlaceId);
 
                     foreach (chksql($oDB->getCol($sSQL)) as $iPlaceId) {
                         $aResults[$iPlaceId] = new Result($iPlaceId);


@@ -1000,6 +993,24 @@ class SearchDescription
     //////////// Debugging functions
 
 
     //////////// Debugging functions
 
 

+    public function debugInfo()
+    {
+        return array(
+                'Search rank' => $this->iSearchRank,
+                'Country code' => $this->sCountryCode,
+                'Name terms' => $this->aName,
+                'Name terms (stop words)' => $this->aNameNonSearch,
+                'Address terms' => $this->aAddress,
+                'Address terms (stop words)' => $this->aAddressNonSearch,
+                'Address terms (full words)' => $this->aFullNameAddress,
+                'Special search' => $this->iOperator,
+                'Class' => $this->sClass,
+                'Type' => $this->sType,
+                'House number' => $this->sHouseNumber,
+                'Postcode' => $this->sPostcode
+               );
+    }
+

     public function dumpAsHtmlTableRow(&$aWordIDs)
     {
         $kf = function ($k) use (&$aWordIDs) {
     public function dumpAsHtmlTableRow(&$aWordIDs)
     {
         $kf = function ($k) use (&$aWordIDs) {

diff --git a/lib/init-cmd.php b/lib/init-cmd.php
index 860ef2158264b5a9c910af85388079111eac5ec1..50c709c9ad16d1c89dfc359a1f083abfb3623dfa 100644 (file)
--- a/lib/init-cmd.php
+++ b/lib/init-cmd.php
@@ -2,6 +2,7 @@
 
 require_once('init.php');
 require_once('cmd.php');
 
 require_once('init.php');
 require_once('cmd.php');

+require_once('DebugNone.php');

 
 // handle http proxy when using file_get_contents
 if (CONST_HTTP_Proxy) {
 
 // handle http proxy when using file_get_contents
 if (CONST_HTTP_Proxy) {

diff --git a/lib/init-website.php b/lib/init-website.php
index d8c012a422152232853b07c09f431352398b54b7..ca5214da07fd50530ae5abec74bb3cba1afa5e1c 100644 (file)
--- a/lib/init-website.php
+++ b/lib/init-website.php
@@ -2,6 +2,7 @@
 
 require_once('init.php');
 require_once('ParameterParser.php');
 
 require_once('init.php');
 require_once('ParameterParser.php');

+require_once(CONST_Debug ? 'DebugHtml.php' : 'DebugNone.php');

 
 /***************************************************************************
  *
 
 /***************************************************************************
  *