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