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
  68 //*******************************************************
  69 // Making some sanity check:
  70 // Check if osm-file is set and points to a valid file
  71 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  72     // to remain in /lib/setup_functions.php function
  73     checkInFile($aCMDResult['osm-file']);
  74 }
  75
  76 // ******************************************************
  77 // instantiate Setup class
  78 $oSetup = new SetupFunctions($aCMDResult);
  79
  80 // *******************************************************
  81 // go through complete process if 'all' is selected or start selected functions
  82 if ($aCMDResult['create-db'] || $aCMDResult['all']) {
  83     $bDidSomething = true;
  84     (clone($oNominatimCmd))->addParams('transition', '--create-db')->run(true);
  85 }
  86
  87 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
  88     $bDidSomething = true;
  89     (clone($oNominatimCmd))->addParams('transition', '--setup-db')->run(true);
  90 }
  91
  92 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
  93     $bDidSomething = true;
  94     $oSetup->importData($aCMDResult['osm-file']);
  95 }
  96
  97 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
  98     $bDidSomething = true;
  99     $oSetup->createFunctions();
 100 }
 101
 102 if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
 103     $bDidSomething = true;
 104     $oSetup->createTables($aCMDResult['reverse-only']);
 105     $oSetup->createFunctions();
 106     $oSetup->createTableTriggers();
 107 }
 108
 109 if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
 110     $bDidSomething = true;
 111     $oSetup->createPartitionTables();
 112 }
 113
 114 if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
 115     $bDidSomething = true;
 116     $oSetup->createPartitionFunctions();
 117 }
 118
 119 if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
 120     $bDidSomething = true;
 121     $oSetup->importWikipediaArticles();
 122 }
 123
 124 if ($aCMDResult['load-data'] || $aCMDResult['all']) {
 125     $bDidSomething = true;
 126     $oSetup->loadData($aCMDResult['disable-token-precalc']);
 127 }
 128
 129 if ($aCMDResult['import-tiger-data']) {
 130     $bDidSomething = true;
 131     $sTigerPath = getSetting('TIGER_DATA_PATH', CONST_InstallDir.'/tiger');
 132     $oSetup->importTigerData($sTigerPath);
 133 }
 134
 135 if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
 136     $bDidSomething = true;
 137     $oSetup->calculatePostcodes($aCMDResult['all']);
 138 }
 139
 140 if ($aCMDResult['index'] || $aCMDResult['all']) {
 141     $bDidSomething = true;
 142     $oSetup->index($aCMDResult['index-noanalyse']);
 143 }
 144
 145 if ($aCMDResult['drop']) {
 146     $bDidSomething = true;
 147     $oSetup->drop($aCMDResult);
 148 }
 149
 150 if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
 151     $bDidSomething = true;
 152     $oSetup->createSearchIndices();
 153 }
 154
 155 if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
 156     $bDidSomething = true;
 157     $oSetup->createCountryNames($aCMDResult);
 158 }
 159
 160 if ($aCMDResult['setup-website'] || $aCMDResult['all']) {
 161     $bDidSomething = true;
 162     $oSetup->setupWebsite();
 163 }
 164
 165 // ******************************************************
 166 // If we did something, repeat the warnings
 167 if (!$bDidSomething) {
 168     showUsage($aCMDOptions, true);
 169 } else {
 170     echo "Summary of warnings:\n\n";
 171     repeatWarnings();
 172     echo "\n";
 173     info('Setup finished.');
 174 }