lib/setup/SetupClass.php

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