utils/setup_functions.php

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