lib/setup/SetupClass.php

   1 <?php
   2
   3 namespace Nominatim\Setup;
   4
   5 require_once(CONST_LibDir.'/setup/AddressLevelParser.php');
   6 require_once(CONST_LibDir.'/Shell.php');
   7
   8 class SetupFunctions
   9 {
  10     protected $iCacheMemory;
  11     protected $iInstances;
  12     protected $sModulePath;
  13     protected $aDSNInfo;
  14     protected $bQuiet;
  15     protected $bVerbose;
  16     protected $sIgnoreErrors;
  17     protected $bEnableDiffUpdates;
  18     protected $bEnableDebugStatements;
  19     protected $bNoPartitions;
  20     protected $bDrop;
  21     protected $oDB = null;
  22
  23     public function __construct(array $aCMDResult)
  24     {
  25         // by default, use all but one processor, but never more than 15.
  26         $this->iInstances = isset($aCMDResult['threads'])
  27             ? $aCMDResult['threads']
  28             : (min(16, getProcessorCount()) - 1);
  29
  30         if ($this->iInstances < 1) {
  31             $this->iInstances = 1;
  32             warn('resetting threads to '.$this->iInstances);
  33         }
  34
  35         if (isset($aCMDResult['osm2pgsql-cache'])) {
  36             $this->iCacheMemory = $aCMDResult['osm2pgsql-cache'];
  37         } elseif (getSetting('FLATNODE_FILE')) {
  38             // When flatnode files are enabled then disable cache per default.
  39             $this->iCacheMemory = 0;
  40         } else {
  41             // Otherwise: Assume we can steal all the cache memory in the box.
  42             $this->iCacheMemory = getCacheMemoryMB();
  43         }
  44
  45         $this->sModulePath = getSetting('DATABASE_MODULE_PATH');
  46         if (!$this->sModulePath) {
  47             $this->sModulePath = CONST_Default_ModulePath;
  48         }
  49         info('module path: ' . $this->sModulePath);
  50
  51         // parse database string
  52         $this->aDSNInfo = \Nominatim\DB::parseDSN(getSetting('DATABASE_DSN'));
  53         if (!isset($this->aDSNInfo['port'])) {
  54             $this->aDSNInfo['port'] = 5432;
  55         }
  56
  57         // setting member variables based on command line options stored in $aCMDResult
  58         $this->bQuiet = isset($aCMDResult['quiet']) && $aCMDResult['quiet'];
  59         $this->bVerbose = $aCMDResult['verbose'];
  60
  61         //setting default values which are not set by the update.php array
  62         if (isset($aCMDResult['ignore-errors'])) {
  63             $this->sIgnoreErrors = $aCMDResult['ignore-errors'];
  64         } else {
  65             $this->sIgnoreErrors = false;
  66         }
  67         if (isset($aCMDResult['enable-debug-statements'])) {
  68             $this->bEnableDebugStatements = $aCMDResult['enable-debug-statements'];
  69         } else {
  70             $this->bEnableDebugStatements = false;
  71         }
  72         if (isset($aCMDResult['no-partitions'])) {
  73             $this->bNoPartitions = $aCMDResult['no-partitions'];
  74         } else {
  75             $this->bNoPartitions = false;
  76         }
  77         if (isset($aCMDResult['enable-diff-updates'])) {
  78             $this->bEnableDiffUpdates = $aCMDResult['enable-diff-updates'];
  79         } else {
  80             $this->bEnableDiffUpdates = false;
  81         }
  82
  83         $this->bDrop = isset($aCMDResult['drop']) && $aCMDResult['drop'];
  84     }
  85
  86     public function createDB()
  87     {
  88         info('Create DB');
  89         $oDB = new \Nominatim\DB;
  90
  91         if ($oDB->checkConnection()) {
  92             fail('database already exists ('.getSetting('DATABASE_DSN').')');
  93         }
  94
  95         $oCmd = (new \Nominatim\Shell('createdb'))
  96                 ->addParams('-E', 'UTF-8')
  97                 ->addParams('-p', $this->aDSNInfo['port']);
  98
  99         if (isset($this->aDSNInfo['username'])) {
 100             $oCmd->addParams('-U', $this->aDSNInfo['username']);
 101         }
 102         if (isset($this->aDSNInfo['password'])) {
 103             $oCmd->addEnvPair('PGPASSWORD', $this->aDSNInfo['password']);
 104         }
 105         if (isset($this->aDSNInfo['hostspec'])) {
 106             $oCmd->addParams('-h', $this->aDSNInfo['hostspec']);
 107         }
 108         $oCmd->addParams($this->aDSNInfo['database']);
 109
 110         $result = $oCmd->run();
 111         if ($result != 0) fail('Error executing external command: '.$oCmd->escapedCmd());
 112     }
 113
 114     public function setupDB()
 115     {
 116         info('Setup DB');
 117
 118         $fPostgresVersion = $this->db()->getPostgresVersion();
 119         echo 'Postgres version found: '.$fPostgresVersion."\n";
 120
 121         if ($fPostgresVersion < 9.03) {
 122             fail('Minimum supported version of Postgresql is 9.3.');
 123         }
 124
 125         $this->pgsqlRunScript('CREATE EXTENSION IF NOT EXISTS hstore');
 126         $this->pgsqlRunScript('CREATE EXTENSION IF NOT EXISTS postgis');
 127
 128         $fPostgisVersion = $this->db()->getPostgisVersion();
 129         echo 'Postgis version found: '.$fPostgisVersion."\n";
 130
 131         if ($fPostgisVersion < 2.2) {
 132             echo "Minimum required Postgis version 2.2\n";
 133             exit(1);
 134         }
 135
 136         $sPgUser = getSetting('DATABASE_WEBUSER');
 137         $i = $this->db()->getOne("select count(*) from pg_user where usename = '$sPgUser'");
 138         if ($i == 0) {
 139             echo "\nERROR: Web user '".$sPgUser."' does not exist. Create it with:\n";
 140             echo "\n          createuser ".$sPgUser."\n\n";
 141             exit(1);
 142         }
 143
 144         // Try accessing the C module, so we know early if something is wrong
 145         $this->checkModulePresence(); // raises exception on failure
 146
 147         if (!file_exists(CONST_DataDir.'/data/country_osm_grid.sql.gz')) {
 148             echo 'Error: you need to download the country_osm_grid first:';
 149             echo "\n    wget -O ".CONST_DataDir."/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz\n";
 150             exit(1);
 151         }
 152         $this->pgsqlRunScriptFile(CONST_DataDir.'/data/country_name.sql');
 153         $this->pgsqlRunScriptFile(CONST_DataDir.'/data/country_osm_grid.sql.gz');
 154         $this->pgsqlRunScriptFile(CONST_DataDir.'/data/gb_postcode_table.sql');
 155         $this->pgsqlRunScriptFile(CONST_DataDir.'/data/us_postcode_table.sql');
 156
 157         $sPostcodeFilename = CONST_DataDir.'/data/gb_postcode_data.sql.gz';
 158         if (file_exists($sPostcodeFilename)) {
 159             $this->pgsqlRunScriptFile($sPostcodeFilename);
 160         } else {
 161             warn('optional external GB postcode table file ('.$sPostcodeFilename.') not found. Skipping.');
 162         }
 163
 164         $sPostcodeFilename = CONST_DataDir.'/data/us_postcode_data.sql.gz';
 165         if (file_exists($sPostcodeFilename)) {
 166             $this->pgsqlRunScriptFile($sPostcodeFilename);
 167         } else {
 168             warn('optional external US postcode table file ('.$sPostcodeFilename.') not found. Skipping.');
 169         }
 170
 171         if ($this->bNoPartitions) {
 172             $this->pgsqlRunScript('update country_name set partition = 0');
 173         }
 174     }
 175
 176     public function importData($sOSMFile)
 177     {
 178         info('Import data');
 179
 180         if (!file_exists(getOsm2pgsqlBinary())) {
 181             echo "Check NOMINATIM_OSM2PGSQL_BINARY in your local .env file.\n";
 182             echo "Normally you should not need to set this manually.\n";
 183             fail("osm2pgsql not found in '".getOsm2pgsqlBinary()."'");
 184         }
 185
 186         $oCmd = new \Nominatim\Shell(getOsm2pgsqlBinary());
 187         $oCmd->addParams('--style', getImportStyle());
 188
 189         if (getSetting('FLATNODE_FILE')) {
 190             $oCmd->addParams('--flat-nodes', getSetting('FLATNODE_FILE'));
 191         }
 192         if (getSetting('TABLESPACE_OSM_DATA')) {
 193             $oCmd->addParams('--tablespace-slim-data', getSetting('TABLESPACE_OSM_DATA'));
 194         }
 195         if (getSetting('TABLESPACE_OSM_INDEX')) {
 196             $oCmd->addParams('--tablespace-slim-index', getSetting('TABLESPACE_OSM_INDEX'));
 197         }
 198         if (getSetting('TABLESPACE_PLACE_DATA')) {
 199             $oCmd->addParams('--tablespace-main-data', getSetting('TABLESPACE_PLACE_DATA'));
 200         }
 201         if (getSetting('TABLESPACE_PLACE_INDEX')) {
 202             $oCmd->addParams('--tablespace-main-index', getSetting('TABLESPACE_PLACE_INDEX'));
 203         }
 204         $oCmd->addParams('--latlong', '--slim', '--create');
 205         $oCmd->addParams('--output', 'gazetteer');
 206         $oCmd->addParams('--hstore');
 207         $oCmd->addParams('--number-processes', 1);
 208         $oCmd->addParams('--with-forward-dependencies', 'false');
 209         $oCmd->addParams('--log-progress', 'true');
 210         $oCmd->addParams('--cache', $this->iCacheMemory);
 211         $oCmd->addParams('--port', $this->aDSNInfo['port']);
 212
 213         if (isset($this->aDSNInfo['username'])) {
 214             $oCmd->addParams('--username', $this->aDSNInfo['username']);
 215         }
 216         if (isset($this->aDSNInfo['password'])) {
 217             $oCmd->addEnvPair('PGPASSWORD', $this->aDSNInfo['password']);
 218         }
 219         if (isset($this->aDSNInfo['hostspec'])) {
 220             $oCmd->addParams('--host', $this->aDSNInfo['hostspec']);
 221         }
 222         $oCmd->addParams('--database', $this->aDSNInfo['database']);
 223         $oCmd->addParams($sOSMFile);
 224         $oCmd->run();
 225
 226         if (!$this->sIgnoreErrors && !$this->db()->getRow('select * from place limit 1')) {
 227             fail('No Data');
 228         }
 229
 230         if ($this->bDrop) {
 231             $this->dropTable('planet_osm_nodes');
 232             $this->removeFlatnodeFile();
 233         }
 234     }
 235
 236     public function createFunctions()
 237     {
 238         info('Create Functions');
 239
 240         // Try accessing the C module, so we know early if something is wrong
 241         $this->checkModulePresence(); // raises exception on failure
 242
 243         $this->createSqlFunctions();
 244     }
 245
 246     public function createTables($bReverseOnly = false)
 247     {
 248         info('Create Tables');
 249
 250         $sTemplate = file_get_contents(CONST_DataDir.'/sql/tables.sql');
 251         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 252
 253         $this->pgsqlRunScript($sTemplate, false);
 254
 255         if ($bReverseOnly) {
 256             $this->dropTable('search_name');
 257         }
 258
 259         $oAlParser = new AddressLevelParser(getSettingConfig('ADDRESS_LEVEL_CONFIG', 'address-levels.json'));
 260         $oAlParser->createTable($this->db(), 'address_levels');
 261     }
 262
 263     public function createTableTriggers()
 264     {
 265         info('Create Tables');
 266
 267         $sTemplate = file_get_contents(CONST_DataDir.'/sql/table-triggers.sql');
 268         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 269
 270         $this->pgsqlRunScript($sTemplate, false);
 271     }
 272
 273     public function createPartitionTables()
 274     {
 275         info('Create Partition Tables');
 276
 277         $sTemplate = file_get_contents(CONST_DataDir.'/sql/partition-tables.src.sql');
 278         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 279
 280         $this->pgsqlRunPartitionScript($sTemplate);
 281     }
 282
 283     public function createPartitionFunctions()
 284     {
 285         info('Create Partition Functions');
 286
 287         $sTemplate = file_get_contents(CONST_DataDir.'/sql/partition-functions.src.sql');
 288         $this->pgsqlRunPartitionScript($sTemplate);
 289     }
 290
 291     public function importWikipediaArticles()
 292     {
 293         $sWikiArticlePath = getSetting('WIKIPEDIA_DATA_PATH', CONST_DataDir.'/data');
 294         $sWikiArticlesFile = $sWikiArticlePath.'/wikimedia-importance.sql.gz';
 295         if (file_exists($sWikiArticlesFile)) {
 296             info('Importing wikipedia articles and redirects');
 297             $this->dropTable('wikipedia_article');
 298             $this->dropTable('wikipedia_redirect');
 299             $this->pgsqlRunScriptFile($sWikiArticlesFile);
 300         } else {
 301             warn('wikipedia importance dump file not found - places will have default importance');
 302         }
 303     }
 304
 305     public function loadData($bDisableTokenPrecalc)
 306     {
 307         info('Drop old Data');
 308
 309         $oDB = $this->db();
 310
 311         $oDB->exec('TRUNCATE word');
 312         echo '.';
 313         $oDB->exec('TRUNCATE placex');
 314         echo '.';
 315         $oDB->exec('TRUNCATE location_property_osmline');
 316         echo '.';
 317         $oDB->exec('TRUNCATE place_addressline');
 318         echo '.';
 319         $oDB->exec('TRUNCATE location_area');
 320         echo '.';
 321         if (!$this->dbReverseOnly()) {
 322             $oDB->exec('TRUNCATE search_name');
 323             echo '.';
 324         }
 325         $oDB->exec('TRUNCATE search_name_blank');
 326         echo '.';
 327         $oDB->exec('DROP SEQUENCE seq_place');
 328         echo '.';
 329         $oDB->exec('CREATE SEQUENCE seq_place start 100000');
 330         echo '.';
 331
 332         $sSQL = 'select distinct partition from country_name';
 333         $aPartitions = $oDB->getCol($sSQL);
 334
 335         if (!$this->bNoPartitions) $aPartitions[] = 0;
 336         foreach ($aPartitions as $sPartition) {
 337             $oDB->exec('TRUNCATE location_road_'.$sPartition);
 338             echo '.';
 339         }
 340
 341         // used by getorcreate_word_id to ignore frequent partial words
 342         $sSQL = 'CREATE OR REPLACE FUNCTION get_maxwordfreq() RETURNS integer AS ';
 343         $sSQL .= '$$ SELECT '.getSetting('MAX_WORD_FREQUENCY').' as maxwordfreq; $$ LANGUAGE SQL IMMUTABLE';
 344         $oDB->exec($sSQL);
 345         echo ".\n";
 346
 347         // pre-create the word list
 348         if (!$bDisableTokenPrecalc) {
 349             info('Loading word list');
 350             $this->pgsqlRunScriptFile(CONST_DataDir.'/data/words.sql');
 351         }
 352
 353         info('Load Data');
 354         $sColumns = 'osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry';
 355
 356         $aDBInstances = array();
 357         $iLoadThreads = max(1, $this->iInstances - 1);
 358         for ($i = 0; $i < $iLoadThreads; $i++) {
 359             // https://secure.php.net/manual/en/function.pg-connect.php
 360             $DSN = getSetting('DATABASE_DSN');
 361             $DSN = preg_replace('/^pgsql:/', '', $DSN);
 362             $DSN = preg_replace('/;/', ' ', $DSN);
 363             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
 364             pg_ping($aDBInstances[$i]);
 365         }
 366
 367         for ($i = 0; $i < $iLoadThreads; $i++) {
 368             $sSQL = "INSERT INTO placex ($sColumns) SELECT $sColumns FROM place WHERE osm_id % $iLoadThreads = $i";
 369             $sSQL .= " and not (class='place' and type='houses' and osm_type='W'";
 370             $sSQL .= "          and ST_GeometryType(geometry) = 'ST_LineString')";
 371             $sSQL .= ' and ST_IsValid(geometry)';
 372             if ($this->bVerbose) echo "$sSQL\n";
 373             if (!pg_send_query($aDBInstances[$i], $sSQL)) {
 374                 fail(pg_last_error($aDBInstances[$i]));
 375             }
 376         }
 377
 378         // last thread for interpolation lines
 379         // https://secure.php.net/manual/en/function.pg-connect.php
 380         $DSN = getSetting('DATABASE_DSN');
 381         $DSN = preg_replace('/^pgsql:/', '', $DSN);
 382         $DSN = preg_replace('/;/', ' ', $DSN);
 383         $aDBInstances[$iLoadThreads] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
 384         pg_ping($aDBInstances[$iLoadThreads]);
 385         $sSQL = 'insert into location_property_osmline';
 386         $sSQL .= ' (osm_id, address, linegeo)';
 387         $sSQL .= ' SELECT osm_id, address, geometry from place where ';
 388         $sSQL .= "class='place' and type='houses' and osm_type='W' and ST_GeometryType(geometry) = 'ST_LineString'";
 389         if ($this->bVerbose) echo "$sSQL\n";
 390         if (!pg_send_query($aDBInstances[$iLoadThreads], $sSQL)) {
 391             fail(pg_last_error($aDBInstances[$iLoadThreads]));
 392         }
 393
 394         $bFailed = false;
 395         for ($i = 0; $i <= $iLoadThreads; $i++) {
 396             while (($hPGresult = pg_get_result($aDBInstances[$i])) !== false) {
 397                 $resultStatus = pg_result_status($hPGresult);
 398                 // PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK,
 399                 // PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE,
 400                 // PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR
 401                 // echo 'Query result ' . $i . ' is: ' . $resultStatus . "\n";
 402                 if ($resultStatus != PGSQL_COMMAND_OK && $resultStatus != PGSQL_TUPLES_OK) {
 403                     $resultError = pg_result_error($hPGresult);
 404                     echo '-- error text ' . $i . ': ' . $resultError . "\n";
 405                     $bFailed = true;
 406                 }
 407             }
 408         }
 409         if ($bFailed) {
 410             fail('SQL errors loading placex and/or location_property_osmline tables');
 411         }
 412
 413         for ($i = 0; $i < $this->iInstances; $i++) {
 414             pg_close($aDBInstances[$i]);
 415         }
 416
 417         echo "\n";
 418         info('Reanalysing database');
 419         $this->pgsqlRunScript('ANALYSE');
 420
 421         $sDatabaseDate = getDatabaseDate($oDB);
 422         $oDB->exec('TRUNCATE import_status');
 423         if (!$sDatabaseDate) {
 424             warn('could not determine database date.');
 425         } else {
 426             $sSQL = "INSERT INTO import_status (lastimportdate) VALUES('".$sDatabaseDate."')";
 427             $oDB->exec($sSQL);
 428             echo "Latest data imported from $sDatabaseDate.\n";
 429         }
 430     }
 431
 432     public function importTigerData($sTigerPath)
 433     {
 434         info('Import Tiger data');
 435
 436         $aFilenames = glob($sTigerPath.'/*.sql');
 437         info('Found '.count($aFilenames).' SQL files in path '.$sTigerPath);
 438         if (empty($aFilenames)) {
 439             warn('Tiger data import selected but no files found in path '.$sTigerPath);
 440             return;
 441         }
 442         $sTemplate = file_get_contents(CONST_DataDir.'/sql/tiger_import_start.sql');
 443         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 444
 445         $this->pgsqlRunScript($sTemplate, false);
 446
 447         $aDBInstances = array();
 448         for ($i = 0; $i < $this->iInstances; $i++) {
 449             // https://secure.php.net/manual/en/function.pg-connect.php
 450             $DSN = getSetting('DATABASE_DSN');
 451             $DSN = preg_replace('/^pgsql:/', '', $DSN);
 452             $DSN = preg_replace('/;/', ' ', $DSN);
 453             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW | PGSQL_CONNECT_ASYNC);
 454             pg_ping($aDBInstances[$i]);
 455         }
 456
 457         foreach ($aFilenames as $sFile) {
 458             echo $sFile.': ';
 459             $hFile = fopen($sFile, 'r');
 460             $sSQL = fgets($hFile, 100000);
 461             $iLines = 0;
 462             while (true) {
 463                 for ($i = 0; $i < $this->iInstances; $i++) {
 464                     if (!pg_connection_busy($aDBInstances[$i])) {
 465                         while (pg_get_result($aDBInstances[$i]));
 466                         $sSQL = fgets($hFile, 100000);
 467                         if (!$sSQL) break 2;
 468                         if (!pg_send_query($aDBInstances[$i], $sSQL)) fail(pg_last_error($aDBInstances[$i]));
 469                         $iLines++;
 470                         if ($iLines == 1000) {
 471                             echo '.';
 472                             $iLines = 0;
 473                         }
 474                     }
 475                 }
 476                 usleep(10);
 477             }
 478             fclose($hFile);
 479
 480             $bAnyBusy = true;
 481             while ($bAnyBusy) {
 482                 $bAnyBusy = false;
 483                 for ($i = 0; $i < $this->iInstances; $i++) {
 484                     if (pg_connection_busy($aDBInstances[$i])) $bAnyBusy = true;
 485                 }
 486                 usleep(10);
 487             }
 488             echo "\n";
 489         }
 490
 491         for ($i = 0; $i < $this->iInstances; $i++) {
 492             pg_close($aDBInstances[$i]);
 493         }
 494
 495         info('Creating indexes on Tiger data');
 496         $sTemplate = file_get_contents(CONST_DataDir.'/sql/tiger_import_finish.sql');
 497         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 498
 499         $this->pgsqlRunScript($sTemplate, false);
 500     }
 501
 502     public function calculatePostcodes($bCMDResultAll)
 503     {
 504         info('Calculate Postcodes');
 505         $this->db()->exec('TRUNCATE location_postcode');
 506
 507         $sSQL  = 'INSERT INTO location_postcode';
 508         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 509         $sSQL .= "SELECT nextval('seq_place'), 1, country_code,";
 510         $sSQL .= "       upper(trim (both ' ' from address->'postcode')) as pc,";
 511         $sSQL .= '       ST_Centroid(ST_Collect(ST_Centroid(geometry)))';
 512         $sSQL .= '  FROM placex';
 513         $sSQL .= " WHERE address ? 'postcode' AND address->'postcode' NOT SIMILAR TO '%(,|;)%'";
 514         $sSQL .= '       AND geometry IS NOT null';
 515         $sSQL .= ' GROUP BY country_code, pc';
 516         $this->db()->exec($sSQL);
 517
 518         // only add postcodes that are not yet available in OSM
 519         $sSQL  = 'INSERT INTO location_postcode';
 520         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 521         $sSQL .= "SELECT nextval('seq_place'), 1, 'us', postcode,";
 522         $sSQL .= '       ST_SetSRID(ST_Point(x,y),4326)';
 523         $sSQL .= '  FROM us_postcode WHERE postcode NOT IN';
 524         $sSQL .= '        (SELECT postcode FROM location_postcode';
 525         $sSQL .= "          WHERE country_code = 'us')";
 526         $this->db()->exec($sSQL);
 527
 528         // add missing postcodes for GB (if available)
 529         $sSQL  = 'INSERT INTO location_postcode';
 530         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 531         $sSQL .= "SELECT nextval('seq_place'), 1, 'gb', postcode, geometry";
 532         $sSQL .= '  FROM gb_postcode WHERE postcode NOT IN';
 533         $sSQL .= '           (SELECT postcode FROM location_postcode';
 534         $sSQL .= "             WHERE country_code = 'gb')";
 535         $this->db()->exec($sSQL);
 536
 537         if (!$bCMDResultAll) {
 538             $sSQL = "DELETE FROM word WHERE class='place' and type='postcode'";
 539             $sSQL .= 'and word NOT IN (SELECT postcode FROM location_postcode)';
 540             $this->db()->exec($sSQL);
 541         }
 542
 543         $sSQL = 'SELECT count(getorcreate_postcode_id(v)) FROM ';
 544         $sSQL .= '(SELECT distinct(postcode) as v FROM location_postcode) p';
 545         $this->db()->exec($sSQL);
 546     }
 547
 548     public function index($bIndexNoanalyse)
 549     {
 550         $this->checkModulePresence(); // raises exception on failure
 551
 552         $oBaseCmd = (new \Nominatim\Shell(getSetting('NOMINATIM_TOOL')))
 553                     ->addParams('index');
 554
 555         if ($this->bQuiet) {
 556             $oBaseCmd->addParams('-q');
 557         }
 558         if ($this->bVerbose) {
 559             $oBaseCmd->addParams('-v');
 560         }
 561
 562         info('Index ranks 0 - 4');
 563         $oCmd = (clone $oBaseCmd)->addParams('--maxrank', 4);
 564         echo $oCmd->escapedCmd();
 565
 566         $iStatus = $oCmd->run();
 567         if ($iStatus != 0) {
 568             fail('error status ' . $iStatus . ' running nominatim!');
 569         }
 570         if (!$bIndexNoanalyse) $this->pgsqlRunScript('ANALYSE');
 571
 572         info('Index administrative boundaries');
 573         $oCmd = (clone $oBaseCmd)->addParams('--boundaries-only');
 574         $iStatus = $oCmd->run();
 575         if ($iStatus != 0) {
 576             fail('error status ' . $iStatus . ' running nominatim!');
 577         }
 578
 579         info('Index ranks 5 - 25');
 580         $oCmd = (clone $oBaseCmd)->addParams('--no-boundaries', '--minrank', 5, '--maxrank', 25);
 581         $iStatus = $oCmd->run();
 582         if ($iStatus != 0) {
 583             fail('error status ' . $iStatus . ' running nominatim!');
 584         }
 585
 586         if (!$bIndexNoanalyse) $this->pgsqlRunScript('ANALYSE');
 587
 588         info('Index ranks 26 - 30');
 589         $oCmd = (clone $oBaseCmd)->addParams('--no-boundaries', '--minrank', 26);
 590         $iStatus = $oCmd->run();
 591         if ($iStatus != 0) {
 592             fail('error status ' . $iStatus . ' running nominatim!');
 593         }
 594
 595         info('Index postcodes');
 596         $sSQL = 'UPDATE location_postcode SET indexed_status = 0';
 597         $this->db()->exec($sSQL);
 598     }
 599
 600     public function createSearchIndices()
 601     {
 602         info('Create Search indices');
 603
 604         $sSQL = 'SELECT relname FROM pg_class, pg_index ';
 605         $sSQL .= 'WHERE pg_index.indisvalid = false AND pg_index.indexrelid = pg_class.oid';
 606         $aInvalidIndices = $this->db()->getCol($sSQL);
 607
 608         foreach ($aInvalidIndices as $sIndexName) {
 609             info("Cleaning up invalid index $sIndexName");
 610             $this->db()->exec("DROP INDEX $sIndexName;");
 611         }
 612
 613         $sTemplate = file_get_contents(CONST_DataDir.'/sql/indices.src.sql');
 614         if (!$this->bDrop) {
 615             $sTemplate .= file_get_contents(CONST_DataDir.'/sql/indices_updates.src.sql');
 616         }
 617         if (!$this->dbReverseOnly()) {
 618             $sTemplate .= file_get_contents(CONST_DataDir.'/sql/indices_search.src.sql');
 619         }
 620         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 621
 622         $this->pgsqlRunScript($sTemplate);
 623     }
 624
 625     public function createCountryNames()
 626     {
 627         info('Create search index for default country names');
 628
 629         $this->pgsqlRunScript("select getorcreate_country(make_standard_name('uk'), 'gb')");
 630         $this->pgsqlRunScript("select getorcreate_country(make_standard_name('united states'), 'us')");
 631         $this->pgsqlRunScript('select count(*) from (select getorcreate_country(make_standard_name(country_code), country_code) from country_name where country_code is not null) as x');
 632         $this->pgsqlRunScript("select count(*) from (select getorcreate_country(make_standard_name(name->'name'), country_code) from country_name where name ? 'name') as x");
 633         $sSQL = 'select count(*) from (select getorcreate_country(make_standard_name(v),'
 634             .'country_code) from (select country_code, skeys(name) as k, svals(name) as v from country_name) x where k ';
 635         $sLanguages = getSetting('LANGUAGES');
 636         if ($sLanguages) {
 637             $sSQL .= 'in ';
 638             $sDelim = '(';
 639             foreach (explode(',', $sLanguages) as $sLang) {
 640                 $sSQL .= $sDelim."'name:$sLang'";
 641                 $sDelim = ',';
 642             }
 643             $sSQL .= ')';
 644         } else {
 645             // all include all simple name tags
 646             $sSQL .= "like 'name:%'";
 647         }
 648         $sSQL .= ') v';
 649         $this->pgsqlRunScript($sSQL);
 650     }
 651
 652     public function drop()
 653     {
 654         info('Drop tables only required for updates');
 655
 656         // The implementation is potentially a bit dangerous because it uses
 657         // a positive selection of tables to keep, and deletes everything else.
 658         // Including any tables that the unsuspecting user might have manually
 659         // created. USE AT YOUR OWN PERIL.
 660         // tables we want to keep. everything else goes.
 661         $aKeepTables = array(
 662                         '*columns',
 663                         'import_polygon_*',
 664                         'import_status',
 665                         'place_addressline',
 666                         'location_postcode',
 667                         'location_property*',
 668                         'placex',
 669                         'search_name',
 670                         'seq_*',
 671                         'word',
 672                         'query_log',
 673                         'new_query_log',
 674                         'spatial_ref_sys',
 675                         'country_name',
 676                         'place_classtype_*',
 677                         'country_osm_grid'
 678                        );
 679
 680         $aDropTables = array();
 681         $aHaveTables = $this->db()->getListOfTables();
 682
 683         foreach ($aHaveTables as $sTable) {
 684             $bFound = false;
 685             foreach ($aKeepTables as $sKeep) {
 686                 if (fnmatch($sKeep, $sTable)) {
 687                     $bFound = true;
 688                     break;
 689                 }
 690             }
 691             if (!$bFound) array_push($aDropTables, $sTable);
 692         }
 693         foreach ($aDropTables as $sDrop) {
 694             $this->dropTable($sDrop);
 695         }
 696
 697         $this->removeFlatnodeFile();
 698     }
 699
 700     /**
 701      * Setup the directory for the API scripts.
 702      *
 703      * @return null
 704      */
 705     public function setupWebsite()
 706     {
 707         if (!is_dir(CONST_InstallDir.'/website')) {
 708             info('Creating directory for website scripts at: '.CONST_InstallDir.'/website');
 709             mkdir(CONST_InstallDir.'/website');
 710         }
 711
 712         $aScripts = array(
 713           'deletable.php',
 714           'details.php',
 715           'lookup.php',
 716           'polygons.php',
 717           'reverse.php',
 718           'search.php',
 719           'status.php'
 720         );
 721
 722         foreach ($aScripts as $sScript) {
 723             $rFile = fopen(CONST_InstallDir.'/website/'.$sScript, 'w');
 724
 725             fwrite($rFile, "<?php\n\n");
 726             fwrite($rFile, '@define(\'CONST_Debug\', $_GET[\'debug\'] ?? false);'."\n\n");
 727
 728             fwriteConstDef($rFile, 'LibDir', CONST_LibDir);
 729             fwriteConstDef($rFile, 'DataDir', CONST_DataDir);
 730             fwriteConstDef($rFile, 'InstallDir', CONST_InstallDir);
 731             fwriteConstDef($rFile, 'Database_DSN', getSetting('DATABASE_DSN'));
 732             fwriteConstDef($rFile, 'Default_Language', getSetting('DEFAULT_LANGUAGE'));
 733             fwriteConstDef($rFile, 'Log_DB', getSettingBool('LOG_DB'));
 734             fwriteConstDef($rFile, 'Log_File', getSetting('LOG_FILE'));
 735             fwriteConstDef($rFile, 'Max_Word_Frequency', (int)getSetting('MAX_WORD_FREQUENCY'));
 736             fwriteConstDef($rFile, 'NoAccessControl', getSettingBool('CORS_NOACCESSCONTROL'));
 737             fwriteConstDef($rFile, 'Places_Max_ID_count', (int)getSetting('LOOKUP_MAX_COUNT'));
 738             fwriteConstDef($rFile, 'PolygonOutput_MaximumTypes', getSetting('POLYGON_OUTPUT_MAX_TYPES'));
 739             fwriteConstDef($rFile, 'Search_BatchMode', getSettingBool('SEARCH_BATCH_MODE'));
 740             fwriteConstDef($rFile, 'Search_NameOnlySearchFrequencyThreshold', getSetting('SEARCH_NAME_ONLY_THRESHOLD'));
 741             fwriteConstDef($rFile, 'Term_Normalization_Rules', getSetting('TERM_NORMALIZATION'));
 742             fwriteConstDef($rFile, 'Use_Aux_Location_data', getSettingBool('USE_AUX_LOCATION_DATA'));
 743             fwriteConstDef($rFile, 'Use_US_Tiger_Data', getSettingBool('USE_US_TIGER_DATA'));
 744             fwriteConstDef($rFile, 'MapIcon_URL', getSetting('MAPICON_URL'));
 745
 746             // XXX scripts should go into the library.
 747             fwrite($rFile, 'require_once(\''.CONST_DataDir.'/website/'.$sScript."');\n");
 748             fclose($rFile);
 749
 750             chmod(CONST_InstallDir.'/website/'.$sScript, 0755);
 751         }
 752     }
 753
 754     /**
 755      * Return the connection to the database.
 756      *
 757      * @return Database object.
 758      *
 759      * Creates a new connection if none exists yet. Otherwise reuses the
 760      * already established connection.
 761      */
 762     private function db()
 763     {
 764         if (is_null($this->oDB)) {
 765             $this->oDB = new \Nominatim\DB();
 766             $this->oDB->connect();
 767         }
 768
 769         return $this->oDB;
 770     }
 771
 772     private function removeFlatnodeFile()
 773     {
 774         $sFName = getSetting('FLATNODE_FILE');
 775         if ($sFName && file_exists($sFName)) {
 776             if ($this->bVerbose) echo 'Deleting '.$sFName."\n";
 777             unlink($sFName);
 778         }
 779     }
 780
 781     private function pgsqlRunScript($sScript, $bfatal = true)
 782     {
 783         runSQLScript(
 784             $sScript,
 785             $bfatal,
 786             $this->bVerbose,
 787             $this->sIgnoreErrors
 788         );
 789     }
 790
 791     private function createSqlFunctions()
 792     {
 793         $sBasePath = CONST_DataDir.'/sql/functions/';
 794         $sTemplate = file_get_contents($sBasePath.'utils.sql');
 795         $sTemplate .= file_get_contents($sBasePath.'normalization.sql');
 796         $sTemplate .= file_get_contents($sBasePath.'ranking.sql');
 797         $sTemplate .= file_get_contents($sBasePath.'importance.sql');
 798         $sTemplate .= file_get_contents($sBasePath.'address_lookup.sql');
 799         $sTemplate .= file_get_contents($sBasePath.'interpolation.sql');
 800         if ($this->db()->tableExists('place')) {
 801             $sTemplate .= file_get_contents($sBasePath.'place_triggers.sql');
 802         }
 803         if ($this->db()->tableExists('placex')) {
 804             $sTemplate .= file_get_contents($sBasePath.'placex_triggers.sql');
 805         }
 806         if ($this->db()->tableExists('location_postcode')) {
 807             $sTemplate .= file_get_contents($sBasePath.'postcode_triggers.sql');
 808         }
 809         $sTemplate = str_replace('{modulepath}', $this->sModulePath, $sTemplate);
 810         if ($this->bEnableDiffUpdates) {
 811             $sTemplate = str_replace('RETURN NEW; -- %DIFFUPDATES%', '--', $sTemplate);
 812         }
 813         if ($this->bEnableDebugStatements) {
 814             $sTemplate = str_replace('--DEBUG:', '', $sTemplate);
 815         }
 816         if (getSettingBool('LIMIT_REINDEXING')) {
 817             $sTemplate = str_replace('--LIMIT INDEXING:', '', $sTemplate);
 818         }
 819         if (!getSettingBool('USE_US_TIGER_DATA')) {
 820             $sTemplate = str_replace('-- %NOTIGERDATA% ', '', $sTemplate);
 821         }
 822         if (!getSettingBool('USE_AUX_LOCATION_DATA')) {
 823             $sTemplate = str_replace('-- %NOAUXDATA% ', '', $sTemplate);
 824         }
 825
 826         $sReverseOnly = $this->dbReverseOnly() ? 'true' : 'false';
 827         $sTemplate = str_replace('%REVERSE-ONLY%', $sReverseOnly, $sTemplate);
 828
 829         $this->pgsqlRunScript($sTemplate);
 830     }
 831
 832     private function pgsqlRunPartitionScript($sTemplate)
 833     {
 834         $sSQL = 'select distinct partition from country_name';
 835         $aPartitions = $this->db()->getCol($sSQL);
 836         if (!$this->bNoPartitions) $aPartitions[] = 0;
 837
 838         preg_match_all('#^-- start(.*?)^-- end#ms', $sTemplate, $aMatches, PREG_SET_ORDER);
 839         foreach ($aMatches as $aMatch) {
 840             $sResult = '';
 841             foreach ($aPartitions as $sPartitionName) {
 842                 $sResult .= str_replace('-partition-', $sPartitionName, $aMatch[1]);
 843             }
 844             $sTemplate = str_replace($aMatch[0], $sResult, $sTemplate);
 845         }
 846
 847         $this->pgsqlRunScript($sTemplate);
 848     }
 849
 850     private function pgsqlRunScriptFile($sFilename)
 851     {
 852         if (!file_exists($sFilename)) fail('unable to find '.$sFilename);
 853
 854         $oCmd = (new \Nominatim\Shell('psql'))
 855                 ->addParams('--port', $this->aDSNInfo['port'])
 856                 ->addParams('--dbname', $this->aDSNInfo['database']);
 857
 858         if (!$this->bVerbose) {
 859             $oCmd->addParams('--quiet');
 860         }
 861         if (isset($this->aDSNInfo['hostspec'])) {
 862             $oCmd->addParams('--host', $this->aDSNInfo['hostspec']);
 863         }
 864         if (isset($this->aDSNInfo['username'])) {
 865             $oCmd->addParams('--username', $this->aDSNInfo['username']);
 866         }
 867         if (isset($this->aDSNInfo['password'])) {
 868             $oCmd->addEnvPair('PGPASSWORD', $this->aDSNInfo['password']);
 869         }
 870         $ahGzipPipes = null;
 871         if (preg_match('/\\.gz$/', $sFilename)) {
 872             $aDescriptors = array(
 873                              0 => array('pipe', 'r'),
 874                              1 => array('pipe', 'w'),
 875                              2 => array('file', '/dev/null', 'a')
 876                             );
 877             $oZcatCmd = new \Nominatim\Shell('zcat', $sFilename);
 878
 879             $hGzipProcess = proc_open($oZcatCmd->escapedCmd(), $aDescriptors, $ahGzipPipes);
 880             if (!is_resource($hGzipProcess)) fail('unable to start zcat');
 881             $aReadPipe = $ahGzipPipes[1];
 882             fclose($ahGzipPipes[0]);
 883         } else {
 884             $oCmd->addParams('--file', $sFilename);
 885             $aReadPipe = array('pipe', 'r');
 886         }
 887         $aDescriptors = array(
 888                          0 => $aReadPipe,
 889                          1 => array('pipe', 'w'),
 890                          2 => array('file', '/dev/null', 'a')
 891                         );
 892         $ahPipes = null;
 893
 894         $hProcess = proc_open($oCmd->escapedCmd(), $aDescriptors, $ahPipes, null, $oCmd->aEnv);
 895         if (!is_resource($hProcess)) fail('unable to start pgsql');
 896         // TODO: error checking
 897         while (!feof($ahPipes[1])) {
 898             echo fread($ahPipes[1], 4096);
 899         }
 900         fclose($ahPipes[1]);
 901         $iReturn = proc_close($hProcess);
 902         if ($iReturn > 0) {
 903             fail("pgsql returned with error code ($iReturn)");
 904         }
 905         if ($ahGzipPipes) {
 906             fclose($ahGzipPipes[1]);
 907             proc_close($hGzipProcess);
 908         }
 909     }
 910
 911     private function replaceSqlPatterns($sSql)
 912     {
 913         $sSql = str_replace('{www-user}', getSetting('DATABASE_WEBUSER'), $sSql);
 914
 915         $aPatterns = array(
 916                       '{ts:address-data}' => getSetting('TABLESPACE_ADDRESS_DATA'),
 917                       '{ts:address-index}' => getSetting('TABLESPACE_ADDRESS_INDEX'),
 918                       '{ts:search-data}' => getSetting('TABLESPACE_SEARCH_DATA'),
 919                       '{ts:search-index}' =>  getSetting('TABLESPACE_SEARCH_INDEX'),
 920                       '{ts:aux-data}' =>  getSetting('TABLESPACE_AUX_DATA'),
 921                       '{ts:aux-index}' =>  getSetting('TABLESPACE_AUX_INDEX')
 922         );
 923
 924         foreach ($aPatterns as $sPattern => $sTablespace) {
 925             if ($sTablespace) {
 926                 $sSql = str_replace($sPattern, 'TABLESPACE "'.$sTablespace.'"', $sSql);
 927             } else {
 928                 $sSql = str_replace($sPattern, '', $sSql);
 929             }
 930         }
 931
 932         return $sSql;
 933     }
 934
 935     /**
 936      * Drop table with the given name if it exists.
 937      *
 938      * @param string $sName Name of table to remove.
 939      *
 940      * @return null
 941      */
 942     private function dropTable($sName)
 943     {
 944         if ($this->bVerbose) echo "Dropping table $sName\n";
 945         $this->db()->deleteTable($sName);
 946     }
 947
 948     /**
 949      * Check if the database is in reverse-only mode.
 950      *
 951      * @return True if there is no search_name table and infrastructure.
 952      */
 953     private function dbReverseOnly()
 954     {
 955         return !($this->db()->tableExists('search_name'));
 956     }
 957
 958     /**
 959      * Try accessing the C module, so we know early if something is wrong.
 960      *
 961      * Raises Nominatim\DatabaseError on failure
 962      */
 963     private function checkModulePresence()
 964     {
 965         $sSQL = "CREATE FUNCTION nominatim_test_import_func(text) RETURNS text AS '";
 966         $sSQL .= $this->sModulePath . "/nominatim.so', 'transliteration' LANGUAGE c IMMUTABLE STRICT";
 967         $sSQL .= ';DROP FUNCTION nominatim_test_import_func(text);';
 968
 969         $oDB = new \Nominatim\DB();
 970         $oDB->connect();
 971         $oDB->exec($sSQL, null, 'Database server failed to load '.$this->sModulePath.'/nominatim.so module');
 972     }
 973 }