lib-php/tokenizer/legacy_tokenizer.php

   1 <?php
   2
   3 namespace Nominatim;
   4
   5 class Tokenizer
   6 {
   7     private $oDB;
   8
   9     private $oNormalizer = null;
  10     private $aCountryRestriction = null;
  11
  12     public function __construct(&$oDB)
  13     {
  14         $this->oDB =& $oDB;
  15         $this->oNormalizer = \Transliterator::createFromRules(CONST_Term_Normalization_Rules);
  16     }
  17
  18
  19     public function setCountryRestriction($aCountries)
  20     {
  21         $this->aCountryRestriction = $aCountries;
  22     }
  23
  24
  25     public function normalizeString($sTerm)
  26     {
  27         if ($this->oNormalizer === null) {
  28             return $sTerm;
  29         }
  30
  31         return $this->oNormalizer->transliterate($sTerm);
  32     }
  33
  34
  35     public function tokensForSpecialTerm($sTerm)
  36     {
  37         $aResults = array();
  38
  39         $sSQL = 'SELECT word_id, class, type FROM word ';
  40         $sSQL .= '   WHERE word_token = \' \' || make_standard_name(:term)';
  41         $sSQL .= '   AND class is not null AND class not in (\'place\')';
  42
  43         Debug::printVar('Term', $sTerm);
  44         Debug::printSQL($sSQL);
  45         $aSearchWords = $this->oDB->getAll($sSQL, array(':term' => $sTerm));
  46
  47         Debug::printVar('Results', $aSearchWords);
  48
  49         foreach ($aSearchWords as $aSearchTerm) {
  50             $aResults[] = new \Nominatim\Token\SpecialTerm(
  51                 $aSearchTerm['word_id'],
  52                 $aSearchTerm['class'],
  53                 $aSearchTerm['type'],
  54                 \Nominatim\Operator::TYPE
  55             );
  56         }
  57
  58         Debug::printVar('Special term tokens', $aResults);
  59
  60         return $aResults;
  61     }
  62
  63
  64     public function extractTokensFromPhrases(&$aPhrases)
  65     {
  66         // First get the normalized version of all phrases
  67         $sNormQuery = '';
  68         $sSQL = 'SELECT ';
  69         $aParams = array();
  70         foreach ($aPhrases as $iPhrase => $oPhrase) {
  71             $sNormQuery .= ','.$this->normalizeString($oPhrase->getPhrase());
  72             $sSQL .= 'make_standard_name(:' .$iPhrase.') as p'.$iPhrase.',';
  73             $aParams[':'.$iPhrase] = $oPhrase->getPhrase();
  74         }
  75         $sSQL = substr($sSQL, 0, -1);
  76
  77         Debug::printSQL($sSQL);
  78         Debug::printVar('SQL parameters', $aParams);
  79
  80         $aNormPhrases = $this->oDB->getRow($sSQL, $aParams);
  81
  82         Debug::printVar('SQL result', $aNormPhrases);
  83
  84         // now compute all possible tokens
  85         $aWordLists = array();
  86         $aTokens = array();
  87         foreach ($aNormPhrases as $sTitle => $sPhrase) {
  88             if (strlen($sPhrase) > 0) {
  89                 $aWords = explode(' ', $sPhrase);
  90                 Tokenizer::addTokens($aTokens, $aWords);
  91                 $aWordLists[] = $aWords;
  92             } else {
  93                 $aWordLists[] = array();
  94             }
  95         }
  96
  97         Debug::printVar('Tokens', $aTokens);
  98         Debug::printVar('WordLists', $aWordLists);
  99
 100         $oValidTokens = $this->computeValidTokens($aTokens, $sNormQuery);
 101
 102         foreach ($aPhrases as $iPhrase => $oPhrase) {
 103             $oPhrase->computeWordSets($aWordLists[$iPhrase], $oValidTokens);
 104         }
 105
 106         return $oValidTokens;
 107     }
 108
 109
 110     private function computeValidTokens($aTokens, $sNormQuery)
 111     {
 112         $oValidTokens = new TokenList();
 113
 114         if (!empty($aTokens)) {
 115             $this->addTokensFromDB($oValidTokens, $aTokens, $sNormQuery);
 116
 117             // Try more interpretations for Tokens that could not be matched.
 118             foreach ($aTokens as $sToken) {
 119                 if ($sToken[0] == ' ' && !$oValidTokens->contains($sToken)) {
 120                     if (preg_match('/^ ([0-9]{5}) [0-9]{4}$/', $sToken, $aData)) {
 121                         // US ZIP+4 codes - merge in the 5-digit ZIP code
 122                         $oValidTokens->addToken(
 123                             $sToken,
 124                             new Token\Postcode(null, $aData[1], 'us')
 125                         );
 126                     } elseif (preg_match('/^ [0-9]+$/', $sToken)) {
 127                         // Unknown single word token with a number.
 128                         // Assume it is a house number.
 129                         $oValidTokens->addToken(
 130                             $sToken,
 131                             new Token\HouseNumber(null, trim($sToken))
 132                         );
 133                     }
 134                 }
 135             }
 136         }
 137
 138         return $oValidTokens;
 139     }
 140
 141
 142     private function addTokensFromDB(&$oValidTokens, $aTokens, $sNormQuery)
 143     {
 144         // Check which tokens we have, get the ID numbers
 145         $sSQL = 'SELECT word_id, word_token, word, class, type, country_code,';
 146         $sSQL .= ' operator, coalesce(search_name_count, 0) as count';
 147         $sSQL .= ' FROM word WHERE word_token in (';
 148         $sSQL .= join(',', $this->oDB->getDBQuotedList($aTokens)).')';
 149
 150         Debug::printSQL($sSQL);
 151
 152         $aDBWords = $this->oDB->getAll($sSQL, null, 'Could not get word tokens.');
 153
 154         foreach ($aDBWords as $aWord) {
 155             $oToken = null;
 156             $iId = (int) $aWord['word_id'];
 157
 158             if ($aWord['class']) {
 159                 // Special terms need to appear in their normalized form.
 160                 // (postcodes are not normalized in the word table)
 161                 $sNormWord = $this->normalizeString($aWord['word']);
 162                 if ($aWord['word'] && strpos($sNormQuery, $sNormWord) === false) {
 163                     continue;
 164                 }
 165
 166                 if ($aWord['class'] == 'place' && $aWord['type'] == 'house') {
 167                     $oToken = new Token\HouseNumber($iId, trim($aWord['word_token']));
 168                 } elseif ($aWord['class'] == 'place' && $aWord['type'] == 'postcode') {
 169                     if ($aWord['word']
 170                         && pg_escape_string($aWord['word']) == $aWord['word']
 171                     ) {
 172                         $oToken = new Token\Postcode(
 173                             $iId,
 174                             $aWord['word'],
 175                             $aWord['country_code']
 176                         );
 177                     }
 178                 } else {
 179                     // near and in operator the same at the moment
 180                     $oToken = new Token\SpecialTerm(
 181                         $iId,
 182                         $aWord['class'],
 183                         $aWord['type'],
 184                         $aWord['operator'] ? Operator::NEAR : Operator::NONE
 185                     );
 186                 }
 187             } elseif ($aWord['country_code']) {
 188                 // Filter country tokens that do not match restricted countries.
 189                 if (!$this->aCountryRestriction
 190                     || in_array($aWord['country_code'], $this->aCountryRestriction)
 191                 ) {
 192                     $oToken = new Token\Country($iId, $aWord['country_code']);
 193                 }
 194             } else {
 195                 $oToken = new Token\Word(
 196                     $iId,
 197                     $aWord['word_token'][0] != ' ',
 198                     (int) $aWord['count'],
 199                     substr_count($aWord['word_token'], ' ')
 200                 );
 201             }
 202
 203             if ($oToken) {
 204                 $oValidTokens->addToken($aWord['word_token'], $oToken);
 205             }
 206         }
 207     }
 208
 209
 210     /**
 211      * Add the tokens from this phrase to the given list of tokens.
 212      *
 213      * @param string[] $aTokens List of tokens to append.
 214      *
 215      * @return void
 216      */
 217     private static function addTokens(&$aTokens, $aWords)
 218     {
 219         $iNumWords = count($aWords);
 220
 221         for ($i = 0; $i < $iNumWords; $i++) {
 222             $sPhrase = $aWords[$i];
 223             $aTokens[' '.$sPhrase] = ' '.$sPhrase;
 224             $aTokens[$sPhrase] = $sPhrase;
 225
 226             for ($j = $i + 1; $j < $iNumWords; $j++) {
 227                 $sPhrase .= ' '.$aWords[$j];
 228                 $aTokens[' '.$sPhrase] = ' '.$sPhrase;
 229                 $aTokens[$sPhrase] = $sPhrase;
 230             }
 231         }
 232     }
 233 }