utils/setup.php

   1 #!/usr/bin/php -Cq
   2 <?php
   3
   4 require_once(dirname(dirname(__FILE__)).'/settings/settings.php');
   5 require_once(CONST_BasePath.'/lib/init-cmd.php');
   6 ini_set('memory_limit', '800M');
   7
   8 $aCMDOptions
   9 = array(
  10    "Create and setup nominatim search system",
  11    array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
  12    array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
  13    array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
  14
  15    array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
  16    array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
  17
  18    array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
  19
  20    array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
  21    array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
  22    array('import-data', '', 0, 1, 0, 0, 'bool', 'Import a osm file'),
  23    array('osm2pgsql-cache', '', 0, 1, 1, 1, 'int', 'Cache size used by osm2pgsql'),
  24    array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
  25    array('enable-diff-updates', '', 0, 1, 0, 0, 'bool', 'Turn on the code required to make diff updates work'),
  26    array('enable-debug-statements', '', 0, 1, 0, 0, 'bool', 'Include debug warning statements in pgsql commands'),
  27    array('ignore-errors', '', 0, 1, 0, 0, 'bool', 'Continue import even when errors in SQL are present (EXPERT)'),
  28    array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
  29    array('create-partition-tables', '', 0, 1, 0, 0, 'bool', 'Create required partition tables'),
  30    array('create-partition-functions', '', 0, 1, 0, 0, 'bool', 'Create required partition triggers'),
  31    array('no-partitions', '', 0, 1, 0, 0, 'bool', "Do not partition search indices (speeds up import of single country extracts)"),
  32    array('import-wikipedia-articles', '', 0, 1, 0, 0, 'bool', 'Import wikipedia article dump'),
  33    array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
  34    array('disable-token-precalc', '', 0, 1, 0, 0, 'bool', 'Disable name precalculation (EXPERT)'),
  35    array('import-tiger-data', '', 0, 1, 0, 0, 'bool', 'Import tiger data (not included in \'all\')'),
  36    array('calculate-postcodes', '', 0, 1, 0, 0, 'bool', 'Calculate postcode centroids'),
  37    array('osmosis-init', '', 0, 1, 0, 0, 'bool', 'Generate default osmosis configuration'),
  38    array('index', '', 0, 1, 0, 0, 'bool', 'Index the data'),
  39    array('index-noanalyse', '', 0, 1, 0, 0, 'bool', 'Do not perform analyse operations during index (EXPERT)'),
  40    array('create-search-indices', '', 0, 1, 0, 0, 'bool', 'Create additional indices required for search and update'),
  41    array('create-country-names', '', 0, 1, 0, 0, 'bool', 'Create default list of searchable country names'),
  42    array('drop', '', 0, 1, 0, 0, 'bool', 'Drop tables needed for updates, making the database readonly (EXPERIMENTAL)'),
  43   );
  44 getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
  45
  46 $bDidSomething = false;
  47
  48 // Check if osm-file is set and points to a valid file if --all or --import-data is given
  49 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  50     if (!isset($aCMDResult['osm-file'])) {
  51         fail('missing --osm-file for data import');
  52     }
  53
  54     if (!file_exists($aCMDResult['osm-file'])) {
  55         fail('the path supplied to --osm-file does not exist');
  56     }
  57
  58     if (!is_readable($aCMDResult['osm-file'])) {
  59         fail('osm-file "'.$aCMDResult['osm-file'].'" not readable');
  60     }
  61 }
  62
  63
  64 // This is a pretty hard core default - the number of processors in the box - 1
  65 $iInstances = isset($aCMDResult['threads'])?$aCMDResult['threads']:(getProcessorCount()-1);
  66 if ($iInstances < 1) {
  67     $iInstances = 1;
  68     echo "WARNING: resetting threads to $iInstances\n";
  69 }
  70 if ($iInstances > getProcessorCount()) {
  71     $iInstances = getProcessorCount();
  72     echo "WARNING: resetting threads to $iInstances\n";
  73 }
  74
  75 // Assume we can steal all the cache memory in the box (unless told otherwise)
  76 if (isset($aCMDResult['osm2pgsql-cache'])) {
  77     $iCacheMemory = $aCMDResult['osm2pgsql-cache'];
  78 } else {
  79     $iCacheMemory = getCacheMemoryMB();
  80 }
  81
  82 $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
  83 if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
  84
  85 if ($aCMDResult['create-db'] || $aCMDResult['all']) {
  86     echo "Create DB\n";
  87     $bDidSomething = true;
  88     $oDB = DB::connect(CONST_Database_DSN, false);
  89     if (!PEAR::isError($oDB)) {
  90         fail('database already exists ('.CONST_Database_DSN.')');
  91     }
  92     passthruCheckReturn('createdb -E UTF-8 -p '.$aDSNInfo['port'].' '.$aDSNInfo['database']);
  93 }
  94
  95 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
  96     echo "Setup DB\n";
  97     $bDidSomething = true;
  98
  99     // TODO: path detection, detection memory, etc.
 100     //
 101     $oDB =& getDB();
 102
 103     $fPostgresVersion = getPostgresVersion($oDB);
 104     echo 'Postgres version found: '.$fPostgresVersion."\n";
 105
 106     if ($fPostgresVersion < 9.1) {
 107         fail("Minimum supported version of Postgresql is 9.1.");
 108     }
 109
 110     pgsqlRunScript('CREATE EXTENSION IF NOT EXISTS hstore');
 111     pgsqlRunScript('CREATE EXTENSION IF NOT EXISTS postgis');
 112
 113     // For extratags and namedetails the hstore_to_json converter is
 114     // needed which is only available from Postgresql 9.3+. For older
 115     // versions add a dummy function that returns nothing.
 116     $iNumFunc = chksql($oDB->getOne("select count(*) from pg_proc where proname = 'hstore_to_json'"));
 117
 118     if ($iNumFunc == 0) {
 119         pgsqlRunScript("create function hstore_to_json(dummy hstore) returns text AS 'select null::text' language sql immutable");
 120         echo "WARNING: Postgresql is too old. extratags and namedetails API not available.";
 121     }
 122
 123     $fPostgisVersion = getPostgisVersion($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         pgsqlRunScript('ALTER FUNCTION st_line_interpolate_point(geometry, double precision) RENAME TO ST_LineInterpolatePoint');
 129         pgsqlRunScript('ALTER FUNCTION ST_Line_Locate_Point(geometry, geometry) RENAME TO ST_LineLocatePoint');
 130     }
 131     if ($fPostgisVersion < 2.2) {
 132         pgsqlRunScript('ALTER FUNCTION ST_Distance_Spheroid(geometry, geometry, spheroid) RENAME TO ST_DistanceSpheroid');
 133     }
 134
 135     pgsqlRunScriptFile(CONST_BasePath.'/data/country_name.sql');
 136     pgsqlRunScriptFile(CONST_BasePath.'/data/country_naturalearthdata.sql');
 137     pgsqlRunScriptFile(CONST_BasePath.'/data/country_osm_grid.sql');
 138     pgsqlRunScriptFile(CONST_BasePath.'/data/gb_postcode_table.sql');
 139     if (file_exists(CONST_BasePath.'/data/gb_postcode_data.sql.gz')) {
 140         pgsqlRunScriptFile(CONST_BasePath.'/data/gb_postcode_data.sql.gz');
 141     } else {
 142         echo "WARNING: external UK postcode table not found.\n";
 143     }
 144     if (CONST_Use_Extra_US_Postcodes) {
 145         pgsqlRunScriptFile(CONST_BasePath.'/data/us_postcode.sql');
 146     }
 147
 148     if ($aCMDResult['no-partitions']) {
 149         pgsqlRunScript('update country_name set partition = 0');
 150     }
 151
 152     // the following will be needed by create_functions later but
 153     // is only defined in the subsequently called create_tables.
 154     // Create dummies here that will be overwritten by the proper
 155     // versions in create-tables.
 156     pgsqlRunScript('CREATE TABLE place_boundingbox ()');
 157     pgsqlRunScript('create type wikipedia_article_match as ()');
 158 }
 159
 160 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
 161     echo "Import\n";
 162     $bDidSomething = true;
 163
 164     $osm2pgsql = CONST_Osm2pgsql_Binary;
 165     if (!file_exists($osm2pgsql)) {
 166         echo "Check CONST_Osm2pgsql_Binary in your local settings file.\n";
 167         echo "Normally you should not need to set this manually.\n";
 168         fail("osm2pgsql not found in '$osm2pgsql'");
 169     }
 170
 171     if (!is_null(CONST_Osm2pgsql_Flatnode_File)) {
 172         $osm2pgsql .= ' --flat-nodes '.CONST_Osm2pgsql_Flatnode_File;
 173     }
 174     if (CONST_Tablespace_Osm2pgsql_Data)
 175         $osm2pgsql .= ' --tablespace-slim-data '.CONST_Tablespace_Osm2pgsql_Data;
 176     if (CONST_Tablespace_Osm2pgsql_Index)
 177         $osm2pgsql .= ' --tablespace-slim-index '.CONST_Tablespace_Osm2pgsql_Index;
 178     if (CONST_Tablespace_Place_Data)
 179         $osm2pgsql .= ' --tablespace-main-data '.CONST_Tablespace_Place_Data;
 180     if (CONST_Tablespace_Place_Index)
 181         $osm2pgsql .= ' --tablespace-main-index '.CONST_Tablespace_Place_Index;
 182     $osm2pgsql .= ' -lsc -O gazetteer --hstore --number-processes 1';
 183     $osm2pgsql .= ' -C '.$iCacheMemory;
 184     $osm2pgsql .= ' -P '.$aDSNInfo['port'];
 185     $osm2pgsql .= ' -d '.$aDSNInfo['database'].' '.$aCMDResult['osm-file'];
 186     passthruCheckReturn($osm2pgsql);
 187
 188     $oDB =& getDB();
 189     if (!chksql($oDB->getRow('select * from place limit 1'))) {
 190         fail('No Data');
 191     }
 192 }
 193
 194 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
 195     echo "Functions\n";
 196     $bDidSomething = true;
 197     if (!file_exists(CONST_InstallPath.'/module/nominatim.so')) fail("nominatim module not built");
 198     create_sql_functions($aCMDResult);
 199 }
 200
 201 if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
 202     $bDidSomething = true;
 203
 204     echo "Tables\n";
 205     $sTemplate = file_get_contents(CONST_BasePath.'/sql/tables.sql');
 206     $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 207     $sTemplate = replace_tablespace(
 208         '{ts:address-data}',
 209         CONST_Tablespace_Address_Data,
 210         $sTemplate
 211     );
 212     $sTemplate = replace_tablespace(
 213         '{ts:address-index}',
 214         CONST_Tablespace_Address_Index,
 215         $sTemplate
 216     );
 217     $sTemplate = replace_tablespace(
 218         '{ts:search-data}',
 219         CONST_Tablespace_Search_Data,
 220         $sTemplate
 221     );
 222     $sTemplate = replace_tablespace(
 223         '{ts:search-index}',
 224         CONST_Tablespace_Search_Index,
 225         $sTemplate
 226     );
 227     $sTemplate = replace_tablespace(
 228         '{ts:aux-data}',
 229         CONST_Tablespace_Aux_Data,
 230         $sTemplate
 231     );
 232     $sTemplate = replace_tablespace(
 233         '{ts:aux-index}',
 234         CONST_Tablespace_Aux_Index,
 235         $sTemplate
 236     );
 237     pgsqlRunScript($sTemplate, false);
 238
 239     // re-run the functions
 240     echo "Functions\n";
 241     create_sql_functions($aCMDResult);
 242 }
 243
 244 if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
 245     echo "Partition Tables\n";
 246     $bDidSomething = true;
 247
 248     $sTemplate = file_get_contents(CONST_BasePath.'/sql/partition-tables.src.sql');
 249     $sTemplate = replace_tablespace(
 250         '{ts:address-data}',
 251         CONST_Tablespace_Address_Data,
 252         $sTemplate
 253     );
 254     $sTemplate = replace_tablespace(
 255         '{ts:address-index}',
 256         CONST_Tablespace_Address_Index,
 257         $sTemplate
 258     );
 259     $sTemplate = replace_tablespace(
 260         '{ts:search-data}',
 261         CONST_Tablespace_Search_Data,
 262         $sTemplate
 263     );
 264     $sTemplate = replace_tablespace(
 265         '{ts:search-index}',
 266         CONST_Tablespace_Search_Index,
 267         $sTemplate
 268     );
 269     $sTemplate = replace_tablespace(
 270         '{ts:aux-data}',
 271         CONST_Tablespace_Aux_Data,
 272         $sTemplate
 273     );
 274     $sTemplate = replace_tablespace(
 275         '{ts:aux-index}',
 276         CONST_Tablespace_Aux_Index,
 277         $sTemplate
 278     );
 279
 280     pgsqlRunPartitionScript($sTemplate);
 281 }
 282
 283
 284 if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
 285     echo "Partition Functions\n";
 286     $bDidSomething = true;
 287
 288     $sTemplate = file_get_contents(CONST_BasePath.'/sql/partition-functions.src.sql');
 289
 290     pgsqlRunPartitionScript($sTemplate);
 291 }
 292
 293 if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
 294     $bDidSomething = true;
 295     $sWikiArticlesFile = CONST_Wikipedia_Data_Path.'/wikipedia_article.sql.bin';
 296     $sWikiRedirectsFile = CONST_Wikipedia_Data_Path.'/wikipedia_redirect.sql.bin';
 297     if (file_exists($sWikiArticlesFile)) {
 298         echo "Importing wikipedia articles...";
 299         pgsqlRunDropAndRestore($sWikiArticlesFile);
 300         echo "...done\n";
 301     } else {
 302         echo "WARNING: wikipedia article dump file not found - places will have default importance\n";
 303     }
 304     if (file_exists($sWikiRedirectsFile)) {
 305         echo "Importing wikipedia redirects...";
 306         pgsqlRunDropAndRestore($sWikiRedirectsFile);
 307         echo "...done\n";
 308     } else {
 309         echo "WARNING: wikipedia redirect dump file not found - some place importance values may be missing\n";
 310     }
 311 }
 312
 313
 314 if ($aCMDResult['load-data'] || $aCMDResult['all']) {
 315     echo "Drop old Data\n";
 316     $bDidSomething = true;
 317
 318     $oDB =& getDB();
 319     if (!pg_query($oDB->connection, 'TRUNCATE word')) fail(pg_last_error($oDB->connection));
 320     echo '.';
 321     if (!pg_query($oDB->connection, 'TRUNCATE placex')) fail(pg_last_error($oDB->connection));
 322     echo '.';
 323     if (!pg_query($oDB->connection, 'TRUNCATE location_property_osmline')) fail(pg_last_error($oDB->connection));
 324     echo '.';
 325     if (!pg_query($oDB->connection, 'TRUNCATE place_addressline')) fail(pg_last_error($oDB->connection));
 326     echo '.';
 327     if (!pg_query($oDB->connection, 'TRUNCATE place_boundingbox')) fail(pg_last_error($oDB->connection));
 328     echo '.';
 329     if (!pg_query($oDB->connection, 'TRUNCATE location_area')) fail(pg_last_error($oDB->connection));
 330     echo '.';
 331     if (!pg_query($oDB->connection, 'TRUNCATE search_name')) fail(pg_last_error($oDB->connection));
 332     echo '.';
 333     if (!pg_query($oDB->connection, 'TRUNCATE search_name_blank')) fail(pg_last_error($oDB->connection));
 334     echo '.';
 335     if (!pg_query($oDB->connection, 'DROP SEQUENCE seq_place')) fail(pg_last_error($oDB->connection));
 336     echo '.';
 337     if (!pg_query($oDB->connection, 'CREATE SEQUENCE seq_place start 100000')) fail(pg_last_error($oDB->connection));
 338     echo '.';
 339
 340     $sSQL = 'select distinct partition from country_name';
 341     $aPartitions = chksql($oDB->getCol($sSQL));
 342     if (!$aCMDResult['no-partitions']) $aPartitions[] = 0;
 343     foreach ($aPartitions as $sPartition) {
 344         if (!pg_query($oDB->connection, 'TRUNCATE location_road_'.$sPartition)) fail(pg_last_error($oDB->connection));
 345         echo '.';
 346     }
 347
 348     // used by getorcreate_word_id to ignore frequent partial words
 349     $sSQL = 'CREATE OR REPLACE FUNCTION get_maxwordfreq() RETURNS integer AS ';
 350     $sSQL .= '$$ SELECT '.CONST_Max_Word_Frequency.' as maxwordfreq; $$ LANGUAGE SQL IMMUTABLE';
 351     if (!pg_query($oDB->connection, $sSQL)) {
 352         fail(pg_last_error($oDB->connection));
 353     }
 354     echo ".\n";
 355
 356     // pre-create the word list
 357     if (!$aCMDResult['disable-token-precalc']) {
 358         echo "Loading word list\n";
 359         pgsqlRunScriptFile(CONST_BasePath.'/data/words.sql');
 360     }
 361
 362     echo "Load Data\n";
 363     $aDBInstances = array();
 364     $iLoadThreads = max(1, $iInstances - 1);
 365     for ($i = 0; $i < $iLoadThreads; $i++) {
 366         $aDBInstances[$i] =& getDB(true);
 367         $sSQL = 'insert into placex (osm_type, osm_id, class, type, name, admin_level, ';
 368         $sSQL .= 'housenumber, street, addr_place, isin, postcode, country_code, extratags, ';
 369         $sSQL .= 'geometry) select * from place where osm_id % '.$iLoadThreads.' = '.$i;
 370         $sSQL .= " and not (class='place' and type='houses' and osm_type='W' and ST_GeometryType(geometry) = 'ST_LineString')";
 371         if ($aCMDResult['verbose']) echo "$sSQL\n";
 372         if (!pg_send_query($aDBInstances[$i]->connection, $sSQL)) fail(pg_last_error($oDB->connection));
 373     }
 374     // last thread for interpolation lines
 375     $aDBInstances[$iLoadThreads] =& getDB(true);
 376     $sSQL = 'select insert_osmline (osm_id, housenumber, street, addr_place, postcode, country_code, ';
 377     $sSQL .= 'geometry) from place where ';
 378     $sSQL .= "class='place' and type='houses' and osm_type='W' and ST_GeometryType(geometry) = 'ST_LineString'";
 379     if ($aCMDResult['verbose']) echo "$sSQL\n";
 380     if (!pg_send_query($aDBInstances[$i]->connection, $sSQL)) fail(pg_last_error($oDB->connection));
 381
 382     $bAnyBusy = true;
 383     while ($bAnyBusy) {
 384         $bAnyBusy = false;
 385         for ($i = 0; $i <= $iLoadThreads; $i++) {
 386             if (pg_connection_busy($aDBInstances[$i]->connection)) $bAnyBusy = true;
 387         }
 388         sleep(1);
 389         echo '.';
 390     }
 391     echo "\n";
 392     echo "Reanalysing database...\n";
 393     pgsqlRunScript('ANALYSE');
 394 }
 395
 396 if ($aCMDResult['import-tiger-data']) {
 397     $bDidSomething = true;
 398
 399     $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_start.sql');
 400     $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 401     $sTemplate = replace_tablespace(
 402         '{ts:aux-data}',
 403         CONST_Tablespace_Aux_Data,
 404         $sTemplate
 405     );
 406     $sTemplate = replace_tablespace(
 407         '{ts:aux-index}',
 408         CONST_Tablespace_Aux_Index,
 409         $sTemplate
 410     );
 411     pgsqlRunScript($sTemplate, false);
 412
 413     $aDBInstances = array();
 414     for ($i = 0; $i < $iInstances; $i++) {
 415         $aDBInstances[$i] =& getDB(true);
 416     }
 417
 418     foreach (glob(CONST_Tiger_Data_Path.'/*.sql') as $sFile) {
 419         echo $sFile.': ';
 420         $hFile = fopen($sFile, "r");
 421         $sSQL = fgets($hFile, 100000);
 422         $iLines = 0;
 423
 424         while (true) {
 425             for ($i = 0; $i < $iInstances; $i++) {
 426                 if (!pg_connection_busy($aDBInstances[$i]->connection)) {
 427                     while (pg_get_result($aDBInstances[$i]->connection));
 428                     $sSQL = fgets($hFile, 100000);
 429                     if (!$sSQL) break 2;
 430                     if (!pg_send_query($aDBInstances[$i]->connection, $sSQL)) fail(pg_last_error($oDB->connection));
 431                     $iLines++;
 432                     if ($iLines == 1000) {
 433                         echo ".";
 434                         $iLines = 0;
 435                     }
 436                 }
 437             }
 438             usleep(10);
 439         }
 440
 441         fclose($hFile);
 442
 443         $bAnyBusy = true;
 444         while ($bAnyBusy) {
 445             $bAnyBusy = false;
 446             for ($i = 0; $i < $iInstances; $i++) {
 447                 if (pg_connection_busy($aDBInstances[$i]->connection)) $bAnyBusy = true;
 448             }
 449             usleep(10);
 450         }
 451         echo "\n";
 452     }
 453
 454     echo "Creating indexes\n";
 455     $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_finish.sql');
 456     $sTemplate = str_replace('{www-user}', CONST_Database_Web_User, $sTemplate);
 457     $sTemplate = replace_tablespace(
 458         '{ts:aux-data}',
 459         CONST_Tablespace_Aux_Data,
 460         $sTemplate
 461     );
 462     $sTemplate = replace_tablespace(
 463         '{ts:aux-index}',
 464         CONST_Tablespace_Aux_Index,
 465         $sTemplate
 466     );
 467     pgsqlRunScript($sTemplate, false);
 468 }
 469
 470 if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
 471     $bDidSomething = true;
 472     $oDB =& getDB();
 473     if (!pg_query($oDB->connection, 'DELETE from placex where osm_type=\'P\'')) fail(pg_last_error($oDB->connection));
 474     $sSQL = "insert into placex (osm_type,osm_id,class,type,postcode,calculated_country_code,geometry) ";
 475     $sSQL .= "select 'P',nextval('seq_postcodes'),'place','postcode',postcode,calculated_country_code,";
 476     $sSQL .= "ST_SetSRID(ST_Point(x,y),4326) as geometry from (select calculated_country_code,postcode,";
 477     $sSQL .= "avg(st_x(st_centroid(geometry))) as x,avg(st_y(st_centroid(geometry))) as y ";
 478     $sSQL .= "from placex where postcode is not null group by calculated_country_code,postcode) as x";
 479     if (!pg_query($oDB->connection, $sSQL)) fail(pg_last_error($oDB->connection));
 480
 481     if (CONST_Use_Extra_US_Postcodes) {
 482         $sSQL = "insert into placex (osm_type,osm_id,class,type,postcode,calculated_country_code,geometry) ";
 483         $sSQL .= "select 'P',nextval('seq_postcodes'),'place','postcode',postcode,'us',";
 484         $sSQL .= "ST_SetSRID(ST_Point(x,y),4326) as geometry from us_postcode";
 485         if (!pg_query($oDB->connection, $sSQL)) fail(pg_last_error($oDB->connection));
 486     }
 487 }
 488
 489 if ($aCMDResult['osmosis-init'] || ($aCMDResult['all'] && !$aCMDResult['drop'])) { // no use doing osmosis-init when dropping update tables
 490     $bDidSomething = true;
 491     $oDB =& getDB();
 492
 493     if (!file_exists(CONST_Osmosis_Binary)) {
 494         echo "Please download osmosis.\nIf it is already installed, check the path in your local settings (settings/local.php) file.\n";
 495         if (!$aCMDResult['all']) {
 496             fail("osmosis not found in '".CONST_Osmosis_Binary."'");
 497         }
 498     } else {
 499         if (file_exists(CONST_InstallPath.'/settings/configuration.txt')) {
 500             echo "settings/configuration.txt already exists\n";
 501         } else {
 502             passthru(CONST_Osmosis_Binary.' --read-replication-interval-init '.CONST_InstallPath.'/settings');
 503             // update osmosis configuration.txt with our settings
 504             passthru("sed -i 's!baseUrl=.*!baseUrl=".CONST_Replication_Url."!' ".CONST_InstallPath.'/settings/configuration.txt');
 505             passthru("sed -i 's:maxInterval = .*:maxInterval = ".CONST_Replication_MaxInterval.":' ".CONST_InstallPath.'/settings/configuration.txt');
 506         }
 507
 508         // Find the last node in the DB
 509         $iLastOSMID = $oDB->getOne("select max(osm_id) from place where osm_type = 'N'");
 510
 511         // Lookup the timestamp that node was created (less 3 hours for margin for changsets to be closed)
 512         $sLastNodeURL = 'http://www.openstreetmap.org/api/0.6/node/'.$iLastOSMID."/1";
 513         $sLastNodeXML = file_get_contents($sLastNodeURL);
 514         preg_match('#timestamp="(([0-9]{4})-([0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})Z)"#', $sLastNodeXML, $aLastNodeDate);
 515         $iLastNodeTimestamp = strtotime($aLastNodeDate[1]) - (3*60*60);
 516
 517         // Search for the correct state file - uses file timestamps so need to sort by date descending
 518         $sRepURL = CONST_Replication_Url."/";
 519         $sRep = file_get_contents($sRepURL."?C=M;O=D;F=1");
 520         // download.geofabrik.de:    <a href="000/">000/</a></td><td align="right">26-Feb-2013 11:53  </td>
 521         // planet.openstreetmap.org: <a href="273/">273/</a>                    2013-03-11 07:41    -
 522         preg_match_all('#<a href="[0-9]{3}/">([0-9]{3}/)</a>\s*([-0-9a-zA-Z]+ [0-9]{2}:[0-9]{2})#', $sRep, $aRepMatches, PREG_SET_ORDER);
 523         if ($aRepMatches) {
 524             $aPrevRepMatch = false;
 525             foreach ($aRepMatches as $aRepMatch) {
 526                 if (strtotime($aRepMatch[2]) < $iLastNodeTimestamp) break;
 527                 $aPrevRepMatch = $aRepMatch;
 528             }
 529             if ($aPrevRepMatch) $aRepMatch = $aPrevRepMatch;
 530
 531             $sRepURL .= $aRepMatch[1];
 532             $sRep = file_get_contents($sRepURL."?C=M;O=D;F=1");
 533             preg_match_all('#<a href="[0-9]{3}/">([0-9]{3}/)</a>\s*([-0-9a-zA-Z]+ [0-9]{2}:[0-9]{2})#', $sRep, $aRepMatches, PREG_SET_ORDER);
 534             $aPrevRepMatch = false;
 535             foreach ($aRepMatches as $aRepMatch) {
 536                 if (strtotime($aRepMatch[2]) < $iLastNodeTimestamp) break;
 537                 $aPrevRepMatch = $aRepMatch;
 538             }
 539             if ($aPrevRepMatch) $aRepMatch = $aPrevRepMatch;
 540
 541             $sRepURL .= $aRepMatch[1];
 542             $sRep = file_get_contents($sRepURL."?C=M;O=D;F=1");
 543             preg_match_all('#<a href="[0-9]{3}.state.txt">([0-9]{3}).state.txt</a>\s*([-0-9a-zA-Z]+ [0-9]{2}:[0-9]{2})#', $sRep, $aRepMatches, PREG_SET_ORDER);
 544             $aPrevRepMatch = false;
 545             foreach ($aRepMatches as $aRepMatch) {
 546                 if (strtotime($aRepMatch[2]) < $iLastNodeTimestamp) break;
 547                 $aPrevRepMatch = $aRepMatch;
 548             }
 549             if ($aPrevRepMatch) $aRepMatch = $aPrevRepMatch;
 550
 551             $sRepURL .= $aRepMatch[1].'.state.txt';
 552             echo "Getting state file: $sRepURL\n";
 553             $sStateFile = file_get_contents($sRepURL);
 554             if (!$sStateFile || strlen($sStateFile) > 1000) fail("unable to obtain state file");
 555             file_put_contents(CONST_InstallPath.'/settings/state.txt', $sStateFile);
 556             echo "Updating DB status\n";
 557             pg_query($oDB->connection, 'TRUNCATE import_status');
 558             $sSQL = "INSERT INTO import_status VALUES('".$aRepMatch[2]."')";
 559             pg_query($oDB->connection, $sSQL);
 560         } else {
 561             if (!$aCMDResult['all']) {
 562                 fail("Cannot read state file directory.");
 563             }
 564         }
 565     }
 566 }
 567
 568 if ($aCMDResult['index'] || $aCMDResult['all']) {
 569     $bDidSomething = true;
 570     $sOutputFile = '';
 571     $sBaseCmd = CONST_InstallPath.'/nominatim/nominatim -i -d '.$aDSNInfo['database'].' -P '.$aDSNInfo['port'].' -t '.$iInstances.$sOutputFile;
 572     passthruCheckReturn($sBaseCmd.' -R 4');
 573     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
 574     passthruCheckReturn($sBaseCmd.' -r 5 -R 25');
 575     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
 576     passthruCheckReturn($sBaseCmd.' -r 26');
 577 }
 578
 579 if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
 580     echo "Search indices\n";
 581     $bDidSomething = true;
 582
 583     $sTemplate = file_get_contents(CONST_BasePath.'/sql/indices.src.sql');
 584     $sTemplate = replace_tablespace(
 585         '{ts:address-index}',
 586         CONST_Tablespace_Address_Index,
 587         $sTemplate
 588     );
 589     $sTemplate = replace_tablespace(
 590         '{ts:search-index}',
 591         CONST_Tablespace_Search_Index,
 592         $sTemplate
 593     );
 594     $sTemplate = replace_tablespace(
 595         '{ts:aux-index}',
 596         CONST_Tablespace_Aux_Index,
 597         $sTemplate
 598     );
 599
 600     pgsqlRunScript($sTemplate);
 601 }
 602
 603 if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
 604     echo 'Creating search index for default country names';
 605     $bDidSomething = true;
 606
 607     pgsqlRunScript("select getorcreate_country(make_standard_name('uk'), 'gb')");
 608     pgsqlRunScript("select getorcreate_country(make_standard_name('united states'), 'us')");
 609     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");
 610     pgsqlRunScript("select count(*) from (select getorcreate_country(make_standard_name(name->'name'), country_code) from country_name where name ? 'name') as x");
 611
 612     $sSQL = 'select count(*) from (select getorcreate_country(make_standard_name(v), country_code) from (select country_code, skeys(name) as k, svals(name) as v from country_name) x where k ';
 613     if (CONST_Languages) {
 614         $sSQL .= 'in ';
 615         $sDelim = '(';
 616         foreach (explode(',', CONST_Languages) as $sLang) {
 617             $sSQL .= $sDelim."'name:$sLang'";
 618             $sDelim = ',';
 619         }
 620         $sSQL .= ')';
 621     } else {
 622         // all include all simple name tags
 623         $sSQL .= "like 'name:%'";
 624     }
 625     $sSQL .= ') v';
 626     pgsqlRunScript($sSQL);
 627 }
 628
 629 if ($aCMDResult['drop']) {
 630     // The implementation is potentially a bit dangerous because it uses
 631     // a positive selection of tables to keep, and deletes everything else.
 632     // Including any tables that the unsuspecting user might have manually
 633     // created. USE AT YOUR OWN PERIL.
 634     $bDidSomething = true;
 635
 636     // tables we want to keep. everything else goes.
 637     $aKeepTables = array(
 638                     "*columns",
 639                     "import_polygon_*",
 640                     "import_status",
 641                     "place_addressline",
 642                     "location_property*",
 643                     "placex",
 644                     "search_name",
 645                     "seq_*",
 646                     "word",
 647                     "query_log",
 648                     "new_query_log",
 649                     "gb_postcode",
 650                     "spatial_ref_sys",
 651                     "country_name",
 652                     "place_classtype_*"
 653                    );
 654
 655     $oDB =& getDB();
 656     $aDropTables = array();
 657     $aHaveTables = chksql($oDB->getCol("SELECT tablename FROM pg_tables WHERE schemaname='public'"));
 658
 659     foreach ($aHaveTables as $sTable) {
 660         $bFound = false;
 661         foreach ($aKeepTables as $sKeep) {
 662             if (fnmatch($sKeep, $sTable)) {
 663                 $bFound = true;
 664                 break;
 665             }
 666         }
 667         if (!$bFound) array_push($aDropTables, $sTable);
 668     }
 669
 670     foreach ($aDropTables as $sDrop) {
 671         if ($aCMDResult['verbose']) echo "dropping table $sDrop\n";
 672         @pg_query($oDB->connection, "DROP TABLE $sDrop CASCADE");
 673         // ignore warnings/errors as they might be caused by a table having
 674         // been deleted already by CASCADE
 675     }
 676
 677     if (!is_null(CONST_Osm2pgsql_Flatnode_File)) {
 678         if ($aCMDResult['verbose']) echo "deleting ".CONST_Osm2pgsql_Flatnode_File."\n";
 679         unlink(CONST_Osm2pgsql_Flatnode_File);
 680     }
 681 }
 682
 683 if (!$bDidSomething) {
 684     showUsage($aCMDOptions, true);
 685 } else {
 686     echo "Setup finished.\n";
 687 }
 688
 689
 690 function pgsqlRunScriptFile($sFilename)
 691 {
 692     if (!file_exists($sFilename)) fail('unable to find '.$sFilename);
 693
 694     // Convert database DSN to psql parameters
 695     $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 696     if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 697     $sCMD = 'psql -p '.$aDSNInfo['port'].' -d '.$aDSNInfo['database'];
 698
 699     $ahGzipPipes = null;
 700     if (preg_match('/\\.gz$/', $sFilename)) {
 701         $aDescriptors = array(
 702                          0 => array('pipe', 'r'),
 703                          1 => array('pipe', 'w'),
 704                          2 => array('file', '/dev/null', 'a')
 705                         );
 706         $hGzipProcess = proc_open('zcat '.$sFilename, $aDescriptors, $ahGzipPipes);
 707         if (!is_resource($hGzipProcess)) fail('unable to start zcat');
 708         $aReadPipe = $ahGzipPipes[1];
 709         fclose($ahGzipPipes[0]);
 710     } else {
 711         $sCMD .= ' -f '.$sFilename;
 712         $aReadPipe = array('pipe', 'r');
 713     }
 714
 715     $aDescriptors = array(
 716                      0 => $aReadPipe,
 717                      1 => array('pipe', 'w'),
 718                      2 => array('file', '/dev/null', 'a')
 719                     );
 720     $ahPipes = null;
 721     $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes);
 722     if (!is_resource($hProcess)) fail('unable to start pgsql');
 723
 724
 725     // TODO: error checking
 726     while (!feof($ahPipes[1])) {
 727         echo fread($ahPipes[1], 4096);
 728     }
 729     fclose($ahPipes[1]);
 730
 731     $iReturn = proc_close($hProcess);
 732     if ($iReturn > 0) {
 733         fail("pgsql returned with error code ($iReturn)");
 734     }
 735     if ($ahGzipPipes) {
 736         fclose($ahGzipPipes[1]);
 737         proc_close($hGzipProcess);
 738     }
 739 }
 740
 741 function pgsqlRunScript($sScript, $bfatal = true)
 742 {
 743     global $aCMDResult;
 744     // Convert database DSN to psql parameters
 745     $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 746     if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 747     $sCMD = 'psql -p '.$aDSNInfo['port'].' -d '.$aDSNInfo['database'];
 748     if ($bfatal && !$aCMDResult['ignore-errors'])
 749         $sCMD .= ' -v ON_ERROR_STOP=1';
 750     $aDescriptors = array(
 751                      0 => array('pipe', 'r'),
 752                      1 => STDOUT,
 753                      2 => STDERR
 754                     );
 755     $ahPipes = null;
 756     $hProcess = @proc_open($sCMD, $aDescriptors, $ahPipes);
 757     if (!is_resource($hProcess)) fail('unable to start pgsql');
 758
 759     while (strlen($sScript)) {
 760         $written = fwrite($ahPipes[0], $sScript);
 761         if ($written <= 0) break;
 762         $sScript = substr($sScript, $written);
 763     }
 764     fclose($ahPipes[0]);
 765     $iReturn = proc_close($hProcess);
 766     if ($bfatal && $iReturn > 0) {
 767         fail("pgsql returned with error code ($iReturn)");
 768     }
 769 }
 770
 771 function pgsqlRunPartitionScript($sTemplate)
 772 {
 773     global $aCMDResult;
 774     $oDB =& getDB();
 775
 776     $sSQL = 'select distinct partition from country_name';
 777     $aPartitions = chksql($oDB->getCol($sSQL));
 778     if (!$aCMDResult['no-partitions']) $aPartitions[] = 0;
 779
 780     preg_match_all('#^-- start(.*?)^-- end#ms', $sTemplate, $aMatches, PREG_SET_ORDER);
 781     foreach ($aMatches as $aMatch) {
 782         $sResult = '';
 783         foreach ($aPartitions as $sPartitionName) {
 784             $sResult .= str_replace('-partition-', $sPartitionName, $aMatch[1]);
 785         }
 786         $sTemplate = str_replace($aMatch[0], $sResult, $sTemplate);
 787     }
 788
 789     pgsqlRunScript($sTemplate);
 790 }
 791
 792 function pgsqlRunRestoreData($sDumpFile)
 793 {
 794     // Convert database DSN to psql parameters
 795     $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 796     if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 797     $sCMD = 'pg_restore -p '.$aDSNInfo['port'].' -d '.$aDSNInfo['database'].' -Fc -a '.$sDumpFile;
 798
 799     $aDescriptors = array(
 800                      0 => array('pipe', 'r'),
 801                      1 => array('pipe', 'w'),
 802                      2 => array('file', '/dev/null', 'a')
 803                     );
 804     $ahPipes = null;
 805     $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes);
 806     if (!is_resource($hProcess)) fail('unable to start pg_restore');
 807
 808     fclose($ahPipes[0]);
 809
 810     // TODO: error checking
 811     while (!feof($ahPipes[1])) {
 812         echo fread($ahPipes[1], 4096);
 813     }
 814     fclose($ahPipes[1]);
 815
 816     $iReturn = proc_close($hProcess);
 817 }
 818
 819 function pgsqlRunDropAndRestore($sDumpFile)
 820 {
 821     // Convert database DSN to psql parameters
 822     $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 823     if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 824     $sCMD = 'pg_restore -p '.$aDSNInfo['port'].' -d '.$aDSNInfo['database'].' -Fc --clean '.$sDumpFile;
 825
 826     $aDescriptors = array(
 827                      0 => array('pipe', 'r'),
 828                      1 => array('pipe', 'w'),
 829                      2 => array('file', '/dev/null', 'a')
 830                     );
 831     $ahPipes = null;
 832     $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes);
 833     if (!is_resource($hProcess)) fail('unable to start pg_restore');
 834
 835     fclose($ahPipes[0]);
 836
 837     // TODO: error checking
 838     while (!feof($ahPipes[1])) {
 839         echo fread($ahPipes[1], 4096);
 840     }
 841     fclose($ahPipes[1]);
 842
 843     $iReturn = proc_close($hProcess);
 844 }
 845
 846 function passthruCheckReturn($cmd)
 847 {
 848     $result = -1;
 849     passthru($cmd, $result);
 850     if ($result != 0) fail('Error executing external command: '.$cmd);
 851 }
 852
 853 function replace_tablespace($sTemplate, $sTablespace, $sSql)
 854 {
 855     if ($sTablespace) {
 856         $sSql = str_replace($sTemplate, 'TABLESPACE "'.$sTablespace.'"', $sSql);
 857     } else {
 858         $sSql = str_replace($sTemplate, '', $sSql);
 859     }
 860
 861     return $sSql;
 862 }
 863
 864 function create_sql_functions($aCMDResult)
 865 {
 866     $sTemplate = file_get_contents(CONST_BasePath.'/sql/functions.sql');
 867     $sTemplate = str_replace('{modulepath}', CONST_InstallPath.'/module', $sTemplate);
 868     if ($aCMDResult['enable-diff-updates']) {
 869         $sTemplate = str_replace('RETURN NEW; -- %DIFFUPDATES%', '--', $sTemplate);
 870     }
 871     if ($aCMDResult['enable-debug-statements']) {
 872         $sTemplate = str_replace('--DEBUG:', '', $sTemplate);
 873     }
 874     if (CONST_Limit_Reindexing) {
 875         $sTemplate = str_replace('--LIMIT INDEXING:', '', $sTemplate);
 876     }
 877     if (!CONST_Use_US_Tiger_Data) {
 878         $sTemplate = str_replace('-- %NOTIGERDATA% ', '', $sTemplate);
 879     }
 880     if (!CONST_Use_Aux_Location_data) {
 881         $sTemplate = str_replace('-- %NOAUXDATA% ', '', $sTemplate);
 882     }
 883     pgsqlRunScript($sTemplate);
 884 }