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