lib/setup/SetupClass.php

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