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 $oNominatimCmd = new \Nominatim\Shell(getSetting('NOMINATIM_TOOL'));
  60 if (isset($aCMDResult['quiet']) && $aCMDResult['quiet']) {
  61     $oNominatimCmd->addParams('--quiet');
  62 }
  63 if ($aCMDResult['verbose']) {
  64     $oNominatimCmd->addParams('--verbose');
  65 }
  66
  67 // by default, use all but one processor, but never more than 15.
  68 $iInstances = max(1, $aCMDResult['threads'] ?? (min(16, getProcessorCount()) - 1));
  69
  70 function run($oCmd) {
  71     global $iInstances;
  72     $oCmd->addParams('--threads', $iInstances);
  73     $oCmd->run(true);
  74 }
  75
  76
  77 //*******************************************************
  78 // Making some sanity check:
  79 // Check if osm-file is set and points to a valid file
  80 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  81     // to remain in /lib/setup_functions.php function
  82     checkInFile($aCMDResult['osm-file']);
  83 }
  84
  85 // ******************************************************
  86 // instantiate Setup class
  87 $oSetup = new SetupFunctions($aCMDResult);
  88
  89 // *******************************************************
  90 // go through complete process if 'all' is selected or start selected functions
  91 if ($aCMDResult['create-db'] || $aCMDResult['all']) {
  92     $bDidSomething = true;
  93     run((clone($oNominatimCmd))->addParams('transition', '--create-db'));
  94 }
  95
  96 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
  97     $bDidSomething = true;
  98     $oCmd = (clone($oNominatimCmd))->addParams('transition', '--setup-db');
  99
 100     if ($aCMDResult['no-partitions'] ?? false) {
 101         $oCmd->addParams('--no-partitions');
 102     }
 103
 104     run($oCmd);
 105 }
 106
 107 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
 108     $bDidSomething = true;
 109     $oCmd = (clone($oNominatimCmd))
 110         ->addParams('transition', '--import-data')
 111         ->addParams('--osm-file', $aCMDResult['osm-file']);
 112     if ($aCMDResult['drop'] ?? false) {
 113         $oCmd->addParams('--drop');
 114     }
 115
 116     run($oCmd);
 117 }
 118
 119 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
 120     $bDidSomething = true;
 121     $oSetup->createFunctions();
 122 }
 123
 124 if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
 125     $bDidSomething = true;
 126     $oSetup->createTables($aCMDResult['reverse-only']);
 127     $oSetup->createFunctions();
 128     $oSetup->createTableTriggers();
 129 }
 130
 131 if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
 132     $bDidSomething = true;
 133     $oSetup->createPartitionTables();
 134 }
 135
 136 if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
 137     $bDidSomething = true;
 138     $oSetup->createFunctions(); // also create partition functions
 139 }
 140
 141 if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
 142     $bDidSomething = true;
 143     // ignore errors!
 144     (clone($oNominatimCmd))->addParams('refresh', '--wiki-data')->run();
 145 }
 146
 147 if ($aCMDResult['load-data'] || $aCMDResult['all']) {
 148     $bDidSomething = true;
 149     run((clone($oNominatimCmd))->addParams('transition', '--load-data'));
 150 }
 151
 152 if ($aCMDResult['import-tiger-data']) {
 153     $bDidSomething = true;
 154     $sTigerPath = getSetting('TIGER_DATA_PATH', CONST_InstallDir.'/tiger');
 155     $oSetup->importTigerData($sTigerPath);
 156 }
 157
 158 if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
 159     $bDidSomething = true;
 160     $oSetup->calculatePostcodes($aCMDResult['all']);
 161 }
 162
 163 if ($aCMDResult['index'] || $aCMDResult['all']) {
 164     $bDidSomething = true;
 165     $oCmd = (clone($oNominatimCmd))->addParams('transition', '--index');
 166     if ($aCMDResult['index-noanalyse'] ?? false) {
 167         $oCmd->addParams('--no-analyse');
 168     }
 169
 170     run($oCmd);
 171 }
 172
 173 if ($aCMDResult['drop']) {
 174     $bDidSomething = true;
 175     run((clone($oNominatimCmd))->addParams('freeze'));
 176 }
 177
 178 if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
 179     $bDidSomething = true;
 180     $oSetup->createSearchIndices();
 181 }
 182
 183 if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
 184     $bDidSomething = true;
 185     $oSetup->createCountryNames($aCMDResult);
 186 }
 187
 188 if ($aCMDResult['setup-website'] || $aCMDResult['all']) {
 189     $bDidSomething = true;
 190     run((clone($oNominatimCmd))->addParams('refresh', '--website'));
 191 }
 192
 193 // ******************************************************
 194 // If we did something, repeat the warnings
 195 if (!$bDidSomething) {
 196     showUsage($aCMDOptions, true);
 197 } else {
 198     echo "Summary of warnings:\n\n";
 199     repeatWarnings();
 200     echo "\n";
 201     info('Setup finished.');
 202 }