lib/setup/SetupClass.php

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