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         $this->pgExec('DROP TABLE wikipedia_article');
 327         $this->pgExec('DROP TABLE wikipedia_redirect');
 328         $sWikiArticlesFile = CONST_Wikipedia_Data_Path.'/wikimedia-importance.sql.gz';
 329         if (file_exists($sWikiArticlesFile)) {
 330             info('Importing wikipedia articles and redirects');
 331             $this->pgsqlRunScriptFile($sWikiArticlesFile);
 332         } else {
 333             warn('wikipedia importance dump file not found - places will have default importance');
 334         }
 335     }
 336
 337     public function loadData($bDisableTokenPrecalc)
 338     {
 339         info('Drop old Data');
 340
 341         $this->pgExec('TRUNCATE word');
 342         echo '.';
 343         $this->pgExec('TRUNCATE placex');
 344         echo '.';
 345         $this->pgExec('TRUNCATE location_property_osmline');
 346         echo '.';
 347         $this->pgExec('TRUNCATE place_addressline');
 348         echo '.';
 349         $this->pgExec('TRUNCATE place_boundingbox');
 350         echo '.';
 351         $this->pgExec('TRUNCATE location_area');
 352         echo '.';
 353         if (!$this->dbReverseOnly()) {
 354             $this->pgExec('TRUNCATE search_name');
 355             echo '.';
 356         }
 357         $this->pgExec('TRUNCATE search_name_blank');
 358         echo '.';
 359         $this->pgExec('DROP SEQUENCE seq_place');
 360         echo '.';
 361         $this->pgExec('CREATE SEQUENCE seq_place start 100000');
 362         echo '.';
 363
 364         $sSQL = 'select distinct partition from country_name';
 365         $aPartitions = $this->oDB->getCol($sSQL);
 366
 367         if (!$this->bNoPartitions) $aPartitions[] = 0;
 368         foreach ($aPartitions as $sPartition) {
 369             $this->pgExec('TRUNCATE location_road_'.$sPartition);
 370             echo '.';
 371         }
 372
 373         // used by getorcreate_word_id to ignore frequent partial words
 374         $sSQL = 'CREATE OR REPLACE FUNCTION get_maxwordfreq() RETURNS integer AS ';
 375         $sSQL .= '$$ SELECT '.CONST_Max_Word_Frequency.' as maxwordfreq; $$ LANGUAGE SQL IMMUTABLE';
 376         $this->pgExec($sSQL);
 377         echo ".\n";
 378
 379         // pre-create the word list
 380         if (!$bDisableTokenPrecalc) {
 381             info('Loading word list');
 382             $this->pgsqlRunScriptFile(CONST_BasePath.'/data/words.sql');
 383         }
 384
 385         info('Load Data');
 386         $sColumns = 'osm_type, osm_id, class, type, name, admin_level, address, extratags, geometry';
 387
 388         $aDBInstances = array();
 389         $iLoadThreads = max(1, $this->iInstances - 1);
 390         for ($i = 0; $i < $iLoadThreads; $i++) {
 391             // https://secure.php.net/manual/en/function.pg-connect.php
 392             $DSN = CONST_Database_DSN;
 393             $DSN = preg_replace('/^pgsql:/', '', $DSN);
 394             $DSN = preg_replace('/;/', ' ', $DSN);
 395             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
 396             pg_ping($aDBInstances[$i]);
 397         }
 398
 399         for ($i = 0; $i < $iLoadThreads; $i++) {
 400             $sSQL = "INSERT INTO placex ($sColumns) SELECT $sColumns FROM place WHERE osm_id % $iLoadThreads = $i";
 401             $sSQL .= " and not (class='place' and type='houses' and osm_type='W'";
 402             $sSQL .= "          and ST_GeometryType(geometry) = 'ST_LineString')";
 403             $sSQL .= ' and ST_IsValid(geometry)';
 404             if ($this->bVerbose) echo "$sSQL\n";
 405             if (!pg_send_query($aDBInstances[$i], $sSQL)) {
 406                 fail(pg_last_error($aDBInstances[$i]));
 407             }
 408         }
 409
 410         // last thread for interpolation lines
 411         // https://secure.php.net/manual/en/function.pg-connect.php
 412         $DSN = CONST_Database_DSN;
 413         $DSN = preg_replace('/^pgsql:/', '', $DSN);
 414         $DSN = preg_replace('/;/', ' ', $DSN);
 415         $aDBInstances[$iLoadThreads] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
 416         pg_ping($aDBInstances[$iLoadThreads]);
 417         $sSQL = 'insert into location_property_osmline';
 418         $sSQL .= ' (osm_id, address, linegeo)';
 419         $sSQL .= ' SELECT osm_id, address, geometry from place where ';
 420         $sSQL .= "class='place' and type='houses' and osm_type='W' and ST_GeometryType(geometry) = 'ST_LineString'";
 421         if ($this->bVerbose) echo "$sSQL\n";
 422         if (!pg_send_query($aDBInstances[$iLoadThreads], $sSQL)) {
 423             fail(pg_last_error($aDBInstances[$iLoadThreads]));
 424         }
 425
 426         $bFailed = false;
 427         for ($i = 0; $i <= $iLoadThreads; $i++) {
 428             while (($hPGresult = pg_get_result($aDBInstances[$i])) !== false) {
 429                 $resultStatus = pg_result_status($hPGresult);
 430                 // PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK,
 431                 // PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE,
 432                 // PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR
 433                 // echo 'Query result ' . $i . ' is: ' . $resultStatus . "\n";
 434                 if ($resultStatus != PGSQL_COMMAND_OK && $resultStatus != PGSQL_TUPLES_OK) {
 435                     $resultError = pg_result_error($hPGresult);
 436                     echo '-- error text ' . $i . ': ' . $resultError . "\n";
 437                     $bFailed = true;
 438                 }
 439             }
 440         }
 441         if ($bFailed) {
 442             fail('SQL errors loading placex and/or location_property_osmline tables');
 443         }
 444
 445         for ($i = 0; $i < $this->iInstances; $i++) {
 446             pg_close($aDBInstances[$i]);
 447         }
 448
 449         echo "\n";
 450         info('Reanalysing database');
 451         $this->pgsqlRunScript('ANALYSE');
 452
 453         $sDatabaseDate = getDatabaseDate($this->oDB);
 454         $this->oDB->exec('TRUNCATE import_status');
 455         if (!$sDatabaseDate) {
 456             warn('could not determine database date.');
 457         } else {
 458             $sSQL = "INSERT INTO import_status (lastimportdate) VALUES('".$sDatabaseDate."')";
 459             $this->oDB->exec($sSQL);
 460             echo "Latest data imported from $sDatabaseDate.\n";
 461         }
 462     }
 463
 464     public function importTigerData()
 465     {
 466         info('Import Tiger data');
 467
 468         $aFilenames = glob(CONST_Tiger_Data_Path.'/*.sql');
 469         info('Found '.count($aFilenames).' SQL files in path '.CONST_Tiger_Data_Path);
 470         if (empty($aFilenames)) return;
 471
 472         $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_start.sql');
 473         $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 474         $sTemplate = $this->replaceTablespace(
 475             '{ts:aux-data}',
 476             CONST_Tablespace_Aux_Data,
 477             $sTemplate
 478         );
 479         $sTemplate = $this->replaceTablespace(
 480             '{ts:aux-index}',
 481             CONST_Tablespace_Aux_Index,
 482             $sTemplate
 483         );
 484         $this->pgsqlRunScript($sTemplate, false);
 485
 486         $aDBInstances = array();
 487         for ($i = 0; $i < $this->iInstances; $i++) {
 488             // https://secure.php.net/manual/en/function.pg-connect.php
 489             $DSN = CONST_Database_DSN;
 490             $DSN = preg_replace('/^pgsql:/', '', $DSN);
 491             $DSN = preg_replace('/;/', ' ', $DSN);
 492             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW | PGSQL_CONNECT_ASYNC);
 493             pg_ping($aDBInstances[$i]);
 494         }
 495
 496         foreach ($aFilenames as $sFile) {
 497             echo $sFile.': ';
 498             $hFile = fopen($sFile, 'r');
 499             $sSQL = fgets($hFile, 100000);
 500             $iLines = 0;
 501             while (true) {
 502                 for ($i = 0; $i < $this->iInstances; $i++) {
 503                     if (!pg_connection_busy($aDBInstances[$i])) {
 504                         while (pg_get_result($aDBInstances[$i]));
 505                         $sSQL = fgets($hFile, 100000);
 506                         if (!$sSQL) break 2;
 507                         if (!pg_send_query($aDBInstances[$i], $sSQL)) fail(pg_last_error($aDBInstances[$i]));
 508                         $iLines++;
 509                         if ($iLines == 1000) {
 510                             echo '.';
 511                             $iLines = 0;
 512                         }
 513                     }
 514                 }
 515                 usleep(10);
 516             }
 517             fclose($hFile);
 518
 519             $bAnyBusy = true;
 520             while ($bAnyBusy) {
 521                 $bAnyBusy = false;
 522                 for ($i = 0; $i < $this->iInstances; $i++) {
 523                     if (pg_connection_busy($aDBInstances[$i])) $bAnyBusy = true;
 524                 }
 525                 usleep(10);
 526             }
 527             echo "\n";
 528         }
 529
 530         for ($i = 0; $i < $this->iInstances; $i++) {
 531             pg_close($aDBInstances[$i]);
 532         }
 533
 534         info('Creating indexes on Tiger data');
 535         $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_finish.sql');
 536         $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 537         $sTemplate = $this->replaceTablespace(
 538             '{ts:aux-data}',
 539             CONST_Tablespace_Aux_Data,
 540             $sTemplate
 541         );
 542         $sTemplate = $this->replaceTablespace(
 543             '{ts:aux-index}',
 544             CONST_Tablespace_Aux_Index,
 545             $sTemplate
 546         );
 547         $this->pgsqlRunScript($sTemplate, false);
 548     }
 549
 550     public function calculatePostcodes($bCMDResultAll)
 551     {
 552         info('Calculate Postcodes');
 553         $this->pgExec('TRUNCATE location_postcode');
 554
 555         $sSQL  = 'INSERT INTO location_postcode';
 556         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 557         $sSQL .= "SELECT nextval('seq_place'), 1, country_code,";
 558         $sSQL .= "       upper(trim (both ' ' from address->'postcode')) as pc,";
 559         $sSQL .= '       ST_Centroid(ST_Collect(ST_Centroid(geometry)))';
 560         $sSQL .= '  FROM placex';
 561         $sSQL .= " WHERE address ? 'postcode' AND address->'postcode' NOT SIMILAR TO '%(,|;)%'";
 562         $sSQL .= '       AND geometry IS NOT null';
 563         $sSQL .= ' GROUP BY country_code, pc';
 564         $this->pgExec($sSQL);
 565
 566         // only add postcodes that are not yet available in OSM
 567         $sSQL  = 'INSERT INTO location_postcode';
 568         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 569         $sSQL .= "SELECT nextval('seq_place'), 1, 'us', postcode,";
 570         $sSQL .= '       ST_SetSRID(ST_Point(x,y),4326)';
 571         $sSQL .= '  FROM us_postcode WHERE postcode NOT IN';
 572         $sSQL .= '        (SELECT postcode FROM location_postcode';
 573         $sSQL .= "          WHERE country_code = 'us')";
 574         $this->pgExec($sSQL);
 575
 576         // add missing postcodes for GB (if available)
 577         $sSQL  = 'INSERT INTO location_postcode';
 578         $sSQL .= ' (place_id, indexed_status, country_code, postcode, geometry) ';
 579         $sSQL .= "SELECT nextval('seq_place'), 1, 'gb', postcode, geometry";
 580         $sSQL .= '  FROM gb_postcode WHERE postcode NOT IN';
 581         $sSQL .= '           (SELECT postcode FROM location_postcode';
 582         $sSQL .= "             WHERE country_code = 'gb')";
 583         $this->pgExec($sSQL);
 584
 585         if (!$bCMDResultAll) {
 586             $sSQL = "DELETE FROM word WHERE class='place' and type='postcode'";
 587             $sSQL .= 'and word NOT IN (SELECT postcode FROM location_postcode)';
 588             $this->pgExec($sSQL);
 589         }
 590
 591         $sSQL = 'SELECT count(getorcreate_postcode_id(v)) FROM ';
 592         $sSQL .= '(SELECT distinct(postcode) as v FROM location_postcode) p';
 593         $this->pgExec($sSQL);
 594     }
 595
 596     public function index($bIndexNoanalyse)
 597     {
 598         $sOutputFile = '';
 599         $sBaseCmd = CONST_InstallPath.'/nominatim/nominatim -i'
 600             .' -d '.escapeshellarg($this->aDSNInfo['database'])
 601             .' -P '.escapeshellarg($this->aDSNInfo['port'])
 602             .' -t '.escapeshellarg($this->iInstances.$sOutputFile);
 603         if (isset($this->aDSNInfo['hostspec'])) {
 604             $sBaseCmd .= ' -H '.escapeshellarg($this->aDSNInfo['hostspec']);
 605         }
 606         if (isset($this->aDSNInfo['username'])) {
 607             $sBaseCmd .= ' -U '.escapeshellarg($this->aDSNInfo['username']);
 608         }
 609
 610         info('Index ranks 0 - 4');
 611         $iStatus = $this->runWithPgEnv($sBaseCmd.' -R 4');
 612         if ($iStatus != 0) {
 613             fail('error status ' . $iStatus . ' running nominatim!');
 614         }
 615         if (!$bIndexNoanalyse) $this->pgsqlRunScript('ANALYSE');
 616
 617         info('Index ranks 5 - 25');
 618         $iStatus = $this->runWithPgEnv($sBaseCmd.' -r 5 -R 25');
 619         if ($iStatus != 0) {
 620             fail('error status ' . $iStatus . ' running nominatim!');
 621         }
 622         if (!$bIndexNoanalyse) $this->pgsqlRunScript('ANALYSE');
 623
 624         info('Index ranks 26 - 30');
 625         $iStatus = $this->runWithPgEnv($sBaseCmd.' -r 26');
 626         if ($iStatus != 0) {
 627             fail('error status ' . $iStatus . ' running nominatim!');
 628         }
 629
 630         info('Index postcodes');
 631         $sSQL = 'UPDATE location_postcode SET indexed_status = 0';
 632         $this->pgExec($sSQL);
 633     }
 634
 635     public function createSearchIndices()
 636     {
 637         info('Create Search indices');
 638
 639         $sTemplate = file_get_contents(CONST_BasePath.'/sql/indices.src.sql');
 640         if (!$this->dbReverseOnly()) {
 641             $sTemplate .= file_get_contents(CONST_BasePath.'/sql/indices_search.src.sql');
 642         }
 643         $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 644         $sTemplate = $this->replaceTablespace(
 645             '{ts:address-index}',
 646             CONST_Tablespace_Address_Index,
 647             $sTemplate
 648         );
 649         $sTemplate = $this->replaceTablespace(
 650             '{ts:search-index}',
 651             CONST_Tablespace_Search_Index,
 652             $sTemplate
 653         );
 654         $sTemplate = $this->replaceTablespace(
 655             '{ts:aux-index}',
 656             CONST_Tablespace_Aux_Index,
 657             $sTemplate
 658         );
 659         $this->pgsqlRunScript($sTemplate);
 660     }
 661
 662     public function createCountryNames()
 663     {
 664         info('Create search index for default country names');
 665
 666         $this->pgsqlRunScript("select getorcreate_country(make_standard_name('uk'), 'gb')");
 667         $this->pgsqlRunScript("select getorcreate_country(make_standard_name('united states'), 'us')");
 668         $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');
 669         $this->pgsqlRunScript("select count(*) from (select getorcreate_country(make_standard_name(name->'name'), country_code) from country_name where name ? 'name') as x");
 670         $sSQL = 'select count(*) from (select getorcreate_country(make_standard_name(v),'
 671             .'country_code) from (select country_code, skeys(name) as k, svals(name) as v from country_name) x where k ';
 672         if (CONST_Languages) {
 673             $sSQL .= 'in ';
 674             $sDelim = '(';
 675             foreach (explode(',', CONST_Languages) as $sLang) {
 676                 $sSQL .= $sDelim."'name:$sLang'";
 677                 $sDelim = ',';
 678             }
 679             $sSQL .= ')';
 680         } else {
 681             // all include all simple name tags
 682             $sSQL .= "like 'name:%'";
 683         }
 684         $sSQL .= ') v';
 685         $this->pgsqlRunScript($sSQL);
 686     }
 687
 688     public function drop()
 689     {
 690         info('Drop tables only required for updates');
 691
 692         // The implementation is potentially a bit dangerous because it uses
 693         // a positive selection of tables to keep, and deletes everything else.
 694         // Including any tables that the unsuspecting user might have manually
 695         // created. USE AT YOUR OWN PERIL.
 696         // tables we want to keep. everything else goes.
 697         $aKeepTables = array(
 698                         '*columns',
 699                         'import_polygon_*',
 700                         'import_status',
 701                         'place_addressline',
 702                         'location_postcode',
 703                         'location_property*',
 704                         'placex',
 705                         'search_name',
 706                         'seq_*',
 707                         'word',
 708                         'query_log',
 709                         'new_query_log',
 710                         'spatial_ref_sys',
 711                         'country_name',
 712                         'place_classtype_*',
 713                         'country_osm_grid'
 714                        );
 715
 716         $aDropTables = array();
 717         $aHaveTables = $this->oDB->getCol("SELECT tablename FROM pg_tables WHERE schemaname='public'");
 718
 719         foreach ($aHaveTables as $sTable) {
 720             $bFound = false;
 721             foreach ($aKeepTables as $sKeep) {
 722                 if (fnmatch($sKeep, $sTable)) {
 723                     $bFound = true;
 724                     break;
 725                 }
 726             }
 727             if (!$bFound) array_push($aDropTables, $sTable);
 728         }
 729         foreach ($aDropTables as $sDrop) {
 730             if ($this->bVerbose) echo "Dropping table $sDrop\n";
 731             $this->oDB->exec("DROP TABLE IF EXISTS $sDrop CASCADE");
 732         }
 733
 734         if (!is_null(CONST_Osm2pgsql_Flatnode_File) && CONST_Osm2pgsql_Flatnode_File) {
 735             if (file_exists(CONST_Osm2pgsql_Flatnode_File)) {
 736                 if ($this->bVerbose) echo 'Deleting '.CONST_Osm2pgsql_Flatnode_File."\n";
 737                 unlink(CONST_Osm2pgsql_Flatnode_File);
 738             }
 739         }
 740     }
 741
 742     private function pgsqlRunScript($sScript, $bfatal = true)
 743     {
 744         runSQLScript(
 745             $sScript,
 746             $bfatal,
 747             $this->bVerbose,
 748             $this->sIgnoreErrors
 749         );
 750     }
 751
 752     private function createSqlFunctions()
 753     {
 754         $sTemplate = file_get_contents(CONST_BasePath.'/sql/functions.sql');
 755         $sTemplate = str_replace('{modulepath}', $this->sModulePath, $sTemplate);
 756         if ($this->bEnableDiffUpdates) {
 757             $sTemplate = str_replace('RETURN NEW; -- %DIFFUPDATES%', '--', $sTemplate);
 758         }
 759         if ($this->bEnableDebugStatements) {
 760             $sTemplate = str_replace('--DEBUG:', '', $sTemplate);
 761         }
 762         if (CONST_Limit_Reindexing) {
 763             $sTemplate = str_replace('--LIMIT INDEXING:', '', $sTemplate);
 764         }
 765         if (!CONST_Use_US_Tiger_Data) {
 766             $sTemplate = str_replace('-- %NOTIGERDATA% ', '', $sTemplate);
 767         }
 768         if (!CONST_Use_Aux_Location_data) {
 769             $sTemplate = str_replace('-- %NOAUXDATA% ', '', $sTemplate);
 770         }
 771
 772         $sReverseOnly = $this->dbReverseOnly() ? 'true' : 'false';
 773         $sTemplate = str_replace('%REVERSE-ONLY%', $sReverseOnly, $sTemplate);
 774
 775         $this->pgsqlRunScript($sTemplate);
 776     }
 777
 778     private function pgsqlRunPartitionScript($sTemplate)
 779     {
 780         $sSQL = 'select distinct partition from country_name';
 781         $aPartitions = $this->oDB->getCol($sSQL);
 782         if (!$this->bNoPartitions) $aPartitions[] = 0;
 783
 784         preg_match_all('#^-- start(.*?)^-- end#ms', $sTemplate, $aMatches, PREG_SET_ORDER);
 785         foreach ($aMatches as $aMatch) {
 786             $sResult = '';
 787             foreach ($aPartitions as $sPartitionName) {
 788                 $sResult .= str_replace('-partition-', $sPartitionName, $aMatch[1]);
 789             }
 790             $sTemplate = str_replace($aMatch[0], $sResult, $sTemplate);
 791         }
 792
 793         $this->pgsqlRunScript($sTemplate);
 794     }
 795
 796     private function pgsqlRunScriptFile($sFilename)
 797     {
 798         if (!file_exists($sFilename)) fail('unable to find '.$sFilename);
 799
 800         $sCMD = 'psql'
 801             .' -p '.escapeshellarg($this->aDSNInfo['port'])
 802             .' -d '.escapeshellarg($this->aDSNInfo['database']);
 803         if (!$this->bVerbose) {
 804             $sCMD .= ' -q';
 805         }
 806         if (isset($this->aDSNInfo['hostspec'])) {
 807             $sCMD .= ' -h '.escapeshellarg($this->aDSNInfo['hostspec']);
 808         }
 809         if (isset($this->aDSNInfo['username'])) {
 810             $sCMD .= ' -U '.escapeshellarg($this->aDSNInfo['username']);
 811         }
 812         $aProcEnv = null;
 813         if (isset($this->aDSNInfo['password'])) {
 814             $aProcEnv = array_merge(array('PGPASSWORD' => $this->aDSNInfo['password']), $_ENV);
 815         }
 816         $ahGzipPipes = null;
 817         if (preg_match('/\\.gz$/', $sFilename)) {
 818             $aDescriptors = array(
 819                              0 => array('pipe', 'r'),
 820                              1 => array('pipe', 'w'),
 821                              2 => array('file', '/dev/null', 'a')
 822                             );
 823             $hGzipProcess = proc_open('zcat '.escapeshellarg($sFilename), $aDescriptors, $ahGzipPipes);
 824             if (!is_resource($hGzipProcess)) fail('unable to start zcat');
 825             $aReadPipe = $ahGzipPipes[1];
 826             fclose($ahGzipPipes[0]);
 827         } else {
 828             $sCMD .= ' -f '.escapeshellarg($sFilename);
 829             $aReadPipe = array('pipe', 'r');
 830         }
 831         $aDescriptors = array(
 832                          0 => $aReadPipe,
 833                          1 => array('pipe', 'w'),
 834                          2 => array('file', '/dev/null', 'a')
 835                         );
 836         $ahPipes = null;
 837         $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes, null, $aProcEnv);
 838         if (!is_resource($hProcess)) fail('unable to start pgsql');
 839         // TODO: error checking
 840         while (!feof($ahPipes[1])) {
 841             echo fread($ahPipes[1], 4096);
 842         }
 843         fclose($ahPipes[1]);
 844         $iReturn = proc_close($hProcess);
 845         if ($iReturn > 0) {
 846             fail("pgsql returned with error code ($iReturn)");
 847         }
 848         if ($ahGzipPipes) {
 849             fclose($ahGzipPipes[1]);
 850             proc_close($hGzipProcess);
 851         }
 852     }
 853
 854     private function replaceTablespace($sTemplate, $sTablespace, $sSql)
 855     {
 856         if ($sTablespace) {
 857             $sSql = str_replace($sTemplate, 'TABLESPACE "'.$sTablespace.'"', $sSql);
 858         } else {
 859             $sSql = str_replace($sTemplate, '', $sSql);
 860         }
 861         return $sSql;
 862     }
 863
 864     private function runWithPgEnv($sCmd)
 865     {
 866         if ($this->bVerbose) {
 867             echo "Execute: $sCmd\n";
 868         }
 869
 870         $aProcEnv = null;
 871
 872         if (isset($this->aDSNInfo['password'])) {
 873             $aProcEnv = array_merge(array('PGPASSWORD' => $this->aDSNInfo['password']), $_ENV);
 874         }
 875
 876         return runWithEnv($sCmd, $aProcEnv);
 877     }
 878
 879     /**
 880      * Execute the SQL command on the open database.
 881      *
 882      * @param string $sSQL SQL command to execute.
 883      *
 884      * @return null
 885      *
 886      * @pre connect() must have been called.
 887      */
 888     private function pgExec($sSQL)
 889     {
 890         $this->oDB->exec($sSQL);
 891     }
 892
 893     /**
 894      * Check if the database is in reverse-only mode.
 895      *
 896      * @return True if there is no search_name table and infrastructure.
 897      */
 898     private function dbReverseOnly()
 899     {
 900         return !($this->oDB->tableExists('search_name'));
 901     }
 902 }