]> git.openstreetmap.org Git - nominatim.git/blobdiff - utils/setup.php
add wiki link to osm2psql README
[nominatim.git] / utils / setup.php
old mode 100755 (executable)
new mode 100644 (file)
index 72dd9c9..8ad96a9
-#!/usr/bin/php -Cq
 <?php
 
-       require_once(dirname(dirname(__FILE__)).'/lib/init-cmd.php');
-       ini_set('memory_limit', '800M');
-
-       $aCMDOptions = array(
-               "Create and setup nominatim search system",
-               array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
-               array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
-               array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
-
-               array('all', '', 0, 1, 1, 1, 'realpath', 'Do the complete process'),
-
-               array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
-               array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
-               array('import-data', '', 0, 1, 1, 1, 'realpath', 'Import a osm file'),
-               array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
-               array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
-               array('create-partitions', '', 0, 1, 0, 0, 'bool', 'Create required partition tables and triggers'),
-               array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
-       );
-       getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
-
-       $bDidSomething = false;
-
-       if ($aCMDResult['create-db'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               $oDB =& DB::connect(CONST_Database_DSN, false);
-               if (!PEAR::isError($oDB))
-               {
-                       fail('database already exists');
-               }
-               passthru('createdb nominatim');
-       }
-
-       if ($aCMDResult['create-db'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               // TODO: path detection, detection memory, etc.
-
-               $oDB =& getDB();
-               passthru('createlang plpgsql nominatim');
-               pgsqlRunScriptFile(CONST_Path_Postgresql_Contrib.'/_int.sql');
-               pgsqlRunScriptFile(CONST_Path_Postgresql_Contrib.'/hstore.sql');
-               pgsqlRunScriptFile(CONST_Path_Postgresql_Postgis.'/postgis.sql');
-               pgsqlRunScriptFile(CONST_Path_Postgresql_Postgis.'/spatial_ref_sys.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/country_name.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/country_osm_grid.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/gb_postcode.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/us_statecounty.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/us_state.sql');
-               pgsqlRunScriptFile(CONST_BasePath.'/data/worldboundaries.sql');
-       }
-
-       if (isset($aCMDResult['all']) && !isset($aCMDResult['import-data'])) $aCMDResult['import-data'] = $aCMDResult['all'];
-       if (isset($aCMDResult['import-data']) && $aCMDResult['import-data'])
-       {
-               $bDidSomething = true;
-               passthru(CONST_BasePath.'/osm2pgsql/osm2pgsql -lsc -O gazetteer -C 10000 --hstore -d nominatim '.$aCMDResult['import-data']);
-       }
-
-       if ($aCMDResult['create-functions'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               $sTemplate = file_get_contents(CONST_BasePath.'/sql/functions.sql');
-               $sTemplate = str_replace('{modulepath}',CONST_BasePath.'/module', $sTemplate);
-               pgsqlRunScript($sTemplate);
-       }
-
-       if ($aCMDResult['create-tables'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               pgsqlRunScriptFile(CONST_BasePath.'/sql/tables.sql');
-       }
-
-       if ($aCMDResult['create-partitions'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               $oDB =& getDB();
-               $sSQL = 'select distinct country_code from country_name order by country_code';
-               $aPartitions = $oDB->getCol($sSQL);
-               if (PEAR::isError($aPartitions))
-               {
-                       fail($aPartitions->getMessage());
-               }
-               $aPartitions[] = 'none';
-
-               $sTemplate = file_get_contents(CONST_BasePath.'/sql/partitions.src.sql');
-               preg_match_all('#^-- start(.*?)^-- end#ms', $sTemplate, $aMatches, PREG_SET_ORDER);
-               foreach($aMatches as $aMatch)
-               {
-                       $sResult = '';
-                       foreach($aPartitions as $sPartitionName)
-                       {
-                               $sResult .= str_replace('-partition-', $sPartitionName, $aMatch[1]);
-                       }
-                       $sTemplate = str_replace($aMatch[0], $sResult, $sTemplate);
-               }
-               pgsqlRunScript($sTemplate);
-       }
-
-       if ($aCMDResult['load-data'] || isset($aCMDResult['all']))
-       {
-               $bDidSomething = true;
-               pgsqlRunScriptFile(CONST_BasePath.'/sql/loaddata.sql');
-       }
-
-       if (!$bDidSomething)
-       {
-               showUsage($aCMDOptions, true);
-       }
-
-       function pgsqlRunScriptFile($sFilename)
-       {
-               if (!file_exists($sFilename)) fail('unable to find '.$sFilename);
-
-               // Convert database DSN to psql paramaters
-               $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
-               $sCMD = 'psql -f '.$sFilename.' '.$aDSNInfo['database'];
-
-               $aDescriptors = array(
-                       0 => array('pipe', 'r'),
-                       1 => array('pipe', 'w'),
-                       2 => array('file', '/dev/null', 'a')
-               );
-               $ahPipes = null;
-               $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes);
-               if (!is_resource($hProcess)) fail('unable to start pgsql');
-
-               fclose($ahPipes[0]);
-
-               // TODO: error checking
-               while(!feof($ahPipes[1]))
-               {
-                       echo fread($ahPipes[1], 4096);
-               }
-               fclose($ahPipes[1]);
-
-               proc_close($hProcess);
-       }
-
-       function pgsqlRunScript($sScript)
-       {
-               // Convert database DSN to psql paramaters
-               $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
-               $sCMD = 'psql '.$aDSNInfo['database'];
-
-               $aDescriptors = array(
-                       0 => array('pipe', 'r'),
-                       1 => array('pipe', 'w'),
-                       2 => array('file', '/dev/null', 'a')
-               );
-               $ahPipes = null;
-               $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes);
-               if (!is_resource($hProcess)) fail('unable to start pgsql');
-
-               fwrite($ahPipes[0], $sScript);
-               fclose($ahPipes[0]);
-
-               // TODO: error checking
-               while(!feof($ahPipes[1]))
-               {
-                       echo fread($ahPipes[1], 4096);
-               }
-               fclose($ahPipes[1]);
-
-               proc_close($hProcess);
-       }
+require_once(CONST_BasePath.'/lib/init-cmd.php');
+require_once(CONST_BasePath.'/lib/setup/SetupClass.php');
+require_once(CONST_BasePath.'/lib/setup_functions.php');
+ini_set('memory_limit', '800M');
+
+use Nominatim\Setup\SetupFunctions as SetupFunctions;
+
+// (long-opt, short-opt, min-occurs, max-occurs, num-arguments, num-arguments, type, help)
+$aCMDOptions
+= array(
+   'Create and setup nominatim search system',
+   array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
+   array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
+   array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
+
+   array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
+   array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
+
+   array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
+
+   array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
+   array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
+   array('import-data', '', 0, 1, 0, 0, 'bool', 'Import a osm file'),
+   array('osm2pgsql-cache', '', 0, 1, 1, 1, 'int', 'Cache size used by osm2pgsql'),
+   array('reverse-only', '', 0, 1, 0, 0, 'bool', 'Do not create search tables and indexes'),
+   array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
+   array('enable-diff-updates', '', 0, 1, 0, 0, 'bool', 'Turn on the code required to make diff updates work'),
+   array('enable-debug-statements', '', 0, 1, 0, 0, 'bool', 'Include debug warning statements in pgsql commands'),
+   array('ignore-errors', '', 0, 1, 0, 0, 'bool', 'Continue import even when errors in SQL are present (EXPERT)'),
+   array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
+   array('create-partition-tables', '', 0, 1, 0, 0, 'bool', 'Create required partition tables'),
+   array('create-partition-functions', '', 0, 1, 0, 0, 'bool', 'Create required partition triggers'),
+   array('no-partitions', '', 0, 1, 0, 0, 'bool', 'Do not partition search indices (speeds up import of single country extracts)'),
+   array('import-wikipedia-articles', '', 0, 1, 0, 0, 'bool', 'Import wikipedia article dump'),
+   array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
+   array('disable-token-precalc', '', 0, 1, 0, 0, 'bool', 'Disable name precalculation (EXPERT)'),
+   array('import-tiger-data', '', 0, 1, 0, 0, 'bool', 'Import tiger data (not included in \'all\')'),
+   array('calculate-postcodes', '', 0, 1, 0, 0, 'bool', 'Calculate postcode centroids'),
+   array('osmosis-init', '', 0, 1, 0, 0, 'bool', 'Generate default osmosis configuration'),
+   array('index', '', 0, 1, 0, 0, 'bool', 'Index the data'),
+   array('index-noanalyse', '', 0, 1, 0, 0, 'bool', 'Do not perform analyse operations during index (EXPERT)'),
+   array('create-search-indices', '', 0, 1, 0, 0, 'bool', 'Create additional indices required for search and update'),
+   array('create-country-names', '', 0, 1, 0, 0, 'bool', 'Create default list of searchable country names'),
+   array('drop', '', 0, 1, 0, 0, 'bool', 'Drop tables needed for updates, making the database readonly (EXPERIMENTAL)'),
+  );
+
+// $aCMDOptions passed to getCmdOpt by reference
+getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
+
+$bDidSomething = false;
+
+//*******************************************************
+// Making some sanity check:
+// Check if osm-file is set and points to a valid file
+if ($aCMDResult['import-data'] || $aCMDResult['all']) {
+    // to remain in /lib/setup_functions.php function
+    checkInFile($aCMDResult['osm-file']);
+}
+
+// osmosis init is no longer supported
+if ($aCMDResult['osmosis-init']) {
+    $bDidSomething = true;
+    echo "Command 'osmosis-init' no longer available, please use utils/update.php --init-updates.\n";
+}
+
+// ******************************************************
+// instantiate Setup class
+$oSetup = new SetupFunctions($aCMDResult);
+
+// *******************************************************
+// go through complete process if 'all' is selected or start selected functions
+if ($aCMDResult['create-db'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createDB();
+}
+
+$oSetup->connect();
+
+if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->setupDB();
+}
+
+// Try accessing the C module, so we know early if something is wrong
+checkModulePresence(); // raises exception on failure
+
+if ($aCMDResult['import-data'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->importData($aCMDResult['osm-file']);
+}
+
+if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createFunctions();
+}
+
+if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createTables($aCMDResult['reverse-only']);
+    $oSetup->createFunctions();
+}
+
+if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createPartitionTables();
+}
+
+if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createPartitionFunctions();
+}
+
+if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->importWikipediaArticles();
+}
+
+if ($aCMDResult['load-data'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->loadData($aCMDResult['disable-token-precalc']);
+}
+
+if ($aCMDResult['import-tiger-data']) {
+    $bDidSomething = true;
+    $oSetup->importTigerData();
+}
+
+if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->calculatePostcodes($aCMDResult['all']);
+}
+
+if ($aCMDResult['index'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->index($aCMDResult['index-noanalyse']);
+}
+
+if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createSearchIndices();
+}
+
+if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createCountryNames($aCMDResult);
+}
+
+if ($aCMDResult['drop']) {
+    $bDidSomething = true;
+    $oSetup->drop($aCMDResult);
+}
+
+// ******************************************************
+// If we did something, repeat the warnings
+if (!$bDidSomething) {
+    showUsage($aCMDOptions, true);
+} else {
+    echo "Summary of warnings:\n\n";
+    repeatWarnings();
+    echo "\n";
+    info('Setup finished.');
+}