lib-php/admin/setup.php

   1 <?php
   2 @define('CONST_LibDir', dirname(dirname(__FILE__)));
   3
   4 require_once(CONST_LibDir.'/init-cmd.php');
   5 require_once(CONST_LibDir.'/setup/SetupClass.php');
   6 require_once(CONST_LibDir.'/setup_functions.php');
   7 ini_set('memory_limit', '800M');
   8
   9 use Nominatim\Setup\SetupFunctions as SetupFunctions;
  10
  11 // (long-opt, short-opt, min-occurs, max-occurs, num-arguments, num-arguments, type, help)
  12 $aCMDOptions
  13 = array(
  14    'Create and setup nominatim search system',
  15    array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
  16    array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
  17    array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
  18
  19    array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
  20    array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
  21
  22    array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
  23
  24    array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
  25    array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
  26    array('import-data', '', 0, 1, 0, 0, 'bool', 'Import a osm file'),
  27    array('osm2pgsql-cache', '', 0, 1, 1, 1, 'int', 'Cache size used by osm2pgsql'),
  28    array('reverse-only', '', 0, 1, 0, 0, 'bool', 'Do not create search tables and indexes'),
  29    array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
  30    array('enable-diff-updates', '', 0, 1, 0, 0, 'bool', 'Turn on the code required to make diff updates work'),
  31    array('enable-debug-statements', '', 0, 1, 0, 0, 'bool', 'Include debug warning statements in pgsql commands'),
  32    array('ignore-errors', '', 0, 1, 0, 0, 'bool', 'Continue import even when errors in SQL are present (EXPERT)'),
  33    array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
  34    array('create-partition-tables', '', 0, 1, 0, 0, 'bool', 'Create required partition tables'),
  35    array('create-partition-functions', '', 0, 1, 0, 0, 'bool', 'Create required partition triggers'),
  36    array('no-partitions', '', 0, 1, 0, 0, 'bool', 'Do not partition search indices (speeds up import of single country extracts)'),
  37    array('import-wikipedia-articles', '', 0, 1, 0, 0, 'bool', 'Import wikipedia article dump'),
  38    array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
  39    array('disable-token-precalc', '', 0, 1, 0, 0, 'bool', 'Disable name precalculation (EXPERT)'),
  40    array('import-tiger-data', '', 0, 1, 0, 0, 'bool', 'Import tiger data (not included in \'all\')'),
  41    array('calculate-postcodes', '', 0, 1, 0, 0, 'bool', 'Calculate postcode centroids'),
  42    array('index', '', 0, 1, 0, 0, 'bool', 'Index the data'),
  43    array('index-noanalyse', '', 0, 1, 0, 0, 'bool', 'Do not perform analyse operations during index (EXPERT)'),
  44    array('create-search-indices', '', 0, 1, 0, 0, 'bool', 'Create additional indices required for search and update'),
  45    array('create-country-names', '', 0, 1, 0, 0, 'bool', 'Create default list of searchable country names'),
  46    array('drop', '', 0, 1, 0, 0, 'bool', 'Drop tables needed for updates, making the database readonly (EXPERIMENTAL)'),
  47    array('setup-website', '', 0, 1, 0, 0, 'bool', 'Used to compile environment variables for the website'),
  48    array('project-dir', '', 0, 1, 1, 1, 'realpath', 'Base directory of the Nominatim installation (default: .)'),
  49   );
  50
  51 // $aCMDOptions passed to getCmdOpt by reference
  52 getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
  53
  54 loadSettings($aCMDResult['project-dir'] ?? getcwd());
  55 setupHTTPProxy();
  56
  57 $bDidSomething = false;
  58
  59 //*******************************************************
  60 // Making some sanity check:
  61 // Check if osm-file is set and points to a valid file
  62 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  63     // to remain in /lib/setup_functions.php function
  64     checkInFile($aCMDResult['osm-file']);
  65 }
  66
  67 // ******************************************************
  68 // instantiate Setup class
  69 $oSetup = new SetupFunctions($aCMDResult);
  70
  71 // *******************************************************
  72 // go through complete process if 'all' is selected or start selected functions
  73 if ($aCMDResult['create-db'] || $aCMDResult['all']) {
  74     $bDidSomething = true;
  75     $oSetup->createDB();
  76 }
  77
  78 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
  79     $bDidSomething = true;
  80     $oSetup->setupDB();
  81 }
  82
  83 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  84     $bDidSomething = true;
  85     $oSetup->importData($aCMDResult['osm-file']);
  86 }
  87
  88 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
  89     $bDidSomething = true;
  90     $oSetup->createFunctions();
  91 }
  92
  93 if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
  94     $bDidSomething = true;
  95     $oSetup->createTables($aCMDResult['reverse-only']);
  96     $oSetup->createFunctions();
  97     $oSetup->createTableTriggers();
  98 }
  99
 100 if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
 101     $bDidSomething = true;
 102     $oSetup->createPartitionTables();
 103 }
 104
 105 if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
 106     $bDidSomething = true;
 107     $oSetup->createPartitionFunctions();
 108 }
 109
 110 if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
 111     $bDidSomething = true;
 112     $oSetup->importWikipediaArticles();
 113 }
 114
 115 if ($aCMDResult['load-data'] || $aCMDResult['all']) {
 116     $bDidSomething = true;
 117     $oSetup->loadData($aCMDResult['disable-token-precalc']);
 118 }
 119
 120 if ($aCMDResult['import-tiger-data']) {
 121     $bDidSomething = true;
 122     $sTigerPath = getSetting('TIGER_DATA_PATH', CONST_InstallDir.'/tiger');
 123     $oSetup->importTigerData($sTigerPath);
 124 }
 125
 126 if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
 127     $bDidSomething = true;
 128     $oSetup->calculatePostcodes($aCMDResult['all']);
 129 }
 130
 131 if ($aCMDResult['index'] || $aCMDResult['all']) {
 132     $bDidSomething = true;
 133     $oSetup->index($aCMDResult['index-noanalyse']);
 134 }
 135
 136 if ($aCMDResult['drop']) {
 137     $bDidSomething = true;
 138     $oSetup->drop($aCMDResult);
 139 }
 140
 141 if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
 142     $bDidSomething = true;
 143     $oSetup->createSearchIndices();
 144 }
 145
 146 if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
 147     $bDidSomething = true;
 148     $oSetup->createCountryNames($aCMDResult);
 149 }
 150
 151 if ($aCMDResult['setup-website'] || $aCMDResult['all']) {
 152     $bDidSomething = true;
 153     $oSetup->setupWebsite();
 154 }
 155
 156 // ******************************************************
 157 // If we did something, repeat the warnings
 158 if (!$bDidSomething) {
 159     showUsage($aCMDOptions, true);
 160 } else {
 161     echo "Summary of warnings:\n\n";
 162     repeatWarnings();
 163     echo "\n";
 164     info('Setup finished.');
 165 }