lib/setup/SetupClass.php

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