]> git.openstreetmap.org Git - nominatim.git/blobdiff - utils/update.php
switch all utils to initialising dotenv
[nominatim.git] / utils / update.php
index fdc955ea26fa9a7e680f7f6d243c0f3d90752d58..931ca179819cd9b8577062dca3ac9785069c0c67 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 
-require_once(CONST_BasePath.'/lib/init-cmd.php');
-require_once(CONST_BasePath.'/lib/setup_functions.php');
-require_once(CONST_BasePath.'/lib/setup/SetupClass.php');
-require_once(CONST_BasePath.'/lib/setup/AddressLevelParser.php');
+require_once(CONST_LibDir.'/init-cmd.php');
+require_once(CONST_LibDir.'/setup_functions.php');
+require_once(CONST_LibDir.'/setup/SetupClass.php');
+require_once(CONST_LibDir.'/setup/AddressLevelParser.php');
 
 ini_set('memory_limit', '800M');
 
@@ -39,15 +39,18 @@ $aCMDOptions
    array('index-rank', '', 0, 1, 1, 1, 'int', 'Rank to start indexing from'),
    array('index-instances', '', 0, 1, 1, 1, 'int', 'Number of indexing instances (threads)'),
 
-   array('deduplicate', '', 0, 1, 0, 0, 'bool', 'Deduplicate tokens'),
    array('recompute-word-counts', '', 0, 1, 0, 0, 'bool', 'Compute frequency of full-word search terms'),
    array('update-address-levels', '', 0, 1, 0, 0, 'bool', 'Reimport address level configuration (EXPERT)'),
    array('recompute-importance', '', 0, 1, 0, 0, 'bool', 'Recompute place importances'),
-   array('no-npi', '', 0, 1, 0, 0, 'bool', '(obsolete)'),
+
+   array('project-dir', '', 0, 1, 1, 1, 'realpath', 'Base directory of the Nominatim installation (default: .)'),
   );
 
 getCmdOpt($_SERVER['argv'], $aCMDOptions, $aResult, true, true);
 
+loadSettings($aCMDResult['project-dir'] ?? getcwd());
+setupHTTPProxy();
+
 if (!isset($aResult['index-instances'])) $aResult['index-instances'] = 1;
 if (!isset($aResult['index-rank'])) $aResult['index-rank'] = 0;
 
@@ -57,7 +60,7 @@ $oDB = new Nominatim\DB();
 $oDB->connect();
 $fPostgresVersion = $oDB->getPostgresVersion();
 
-$aDSNInfo = Nominatim\DB::parseDSN(CONST_Database_DSN);
+$aDSNInfo = Nominatim\DB::parseDSN(getSetting('DATABASE_DSN'));
 if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 
 // cache memory to be used by osm2pgsql, should not be more than the available memory
@@ -67,15 +70,17 @@ if ($iCacheMemory + 500 > getTotalMemoryMB()) {
     echo "WARNING: resetting cache memory to $iCacheMemory\n";
 }
 
-$oOsm2pgsqlCmd = (new \Nominatim\Shell(CONST_Osm2pgsql_Binary))
+$oOsm2pgsqlCmd = (new \Nominatim\Shell(getOsm2pgsqlBinary()))
                  ->addParams('--hstore')
                  ->addParams('--latlong')
                  ->addParams('--append')
                  ->addParams('--slim')
+                 ->addParams('--with-forward-dependencies', 'false')
+                 ->addParams('--log-progress', 'true')
                  ->addParams('--number-processes', 1)
                  ->addParams('--cache', $iCacheMemory)
                  ->addParams('--output', 'gazetteer')
-                 ->addParams('--style', CONST_Import_Style)
+                 ->addParams('--style', getImportStyle())
                  ->addParams('--database', $aDSNInfo['database'])
                  ->addParams('--port', $aDSNInfo['port']);
 
@@ -88,8 +93,8 @@ if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
 if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     $oOsm2pgsqlCmd->addEnvPair('PGPASSWORD', $aDSNInfo['password']);
 }
-if (!is_null(CONST_Osm2pgsql_Flatnode_File) && CONST_Osm2pgsql_Flatnode_File) {
-    $oOsm2pgsqlCmd->addParams('--flat-nodes', CONST_Osm2pgsql_Flatnode_File);
+if (getSetting('FLATNODE_FILE')) {
+    $oOsm2pgsqlCmd->addParams('--flat-nodes', getSetting('FLATNODE_FILE'));
 }
 if ($fPostgresVersion >= 11.0) {
     $oOsm2pgsqlCmd->addEnvPair(
@@ -99,11 +104,13 @@ if ($fPostgresVersion >= 11.0) {
 }
 
 
-$oIndexCmd = (new \Nominatim\Shell(CONST_BasePath.'/nominatim/nominatim.py'))
+$oIndexCmd = (new \Nominatim\Shell(CONST_DataDir.'/nominatim/nominatim.py'))
              ->addParams('--database', $aDSNInfo['database'])
              ->addParams('--port', $aDSNInfo['port'])
              ->addParams('--threads', $aResult['index-instances']);
-
+if (!$aResult['quiet']) {
+    $oIndexCmd->addParams('--verbose');
+}
 if ($aResult['verbose']) {
     $oIndexCmd->addParams('--verbose');
 }
@@ -117,31 +124,34 @@ if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     $oIndexCmd->addEnvPair('PGPASSWORD', $aDSNInfo['password']);
 }
 
+$sPyosmiumBin = getSetting('PYOSMIUM_BINARY');
+$sBaseURL = getSetting('REPLICATION_URL');
+
 
 if ($aResult['init-updates']) {
     // sanity check that the replication URL is correct
-    $sBaseState = file_get_contents(CONST_Replication_Url.'/state.txt');
+    $sBaseState = file_get_contents($sBaseURL.'/state.txt');
     if ($sBaseState === false) {
         echo "\nCannot find state.txt file at the configured replication URL.\n";
         echo "Does the URL point to a directory containing OSM update data?\n\n";
         fail('replication URL not reachable.');
     }
     // sanity check for pyosmium-get-changes
-    if (!CONST_Pyosmium_Binary) {
-        echo "\nCONST_Pyosmium_Binary not configured.\n";
+    if (!$sPyosmiumBin) {
+        echo "\nNOMINATIM_PYOSMIUM_BINARY not configured.\n";
         echo "You need to install pyosmium and set up the path to pyosmium-get-changes\n";
-        echo "in your local settings file.\n\n";
-        fail('CONST_Pyosmium_Binary not configured');
+        echo "in your local .env file.\n\n";
+        fail('NOMINATIM_PYOSMIUM_BINARY not configured');
     }
 
     $aOutput = 0;
-    $oCMD = new \Nominatim\Shell(CONST_Pyosmium_Binary, '--help');
+    $oCMD = new \Nominatim\Shell($sPyosmiumBin, '--help');
     exec($oCMD->escapedCmd(), $aOutput, $iRet);
 
     if ($iRet != 0) {
         echo "Cannot execute pyosmium-get-changes.\n";
         echo "Make sure you have pyosmium installed correctly\n";
-        echo "and have set up CONST_Pyosmium_Binary to point to pyosmium-get-changes.\n";
+        echo "and have set up NOMINATIM_PYOSMIUM_BINARY to point to pyosmium-get-changes.\n";
         fail('pyosmium-get-changes not found or not usable');
     }
 
@@ -162,9 +172,9 @@ if ($aResult['init-updates']) {
 
     // get the appropriate state id
     $aOutput = 0;
-    $oCMD = (new \Nominatim\Shell(CONST_Pyosmium_Binary))
+    $oCMD = (new \Nominatim\Shell($sPyosmiumBin))
             ->addParams('--start-date', $sWindBack)
-            ->addParams('--server', CONST_Replication_Url);
+            ->addParams('--server', $sBaseURL);
 
     exec($oCMD->escapedCmd(), $aOutput, $iRet);
     if ($iRet != 0 || $aOutput[0] == 'None') {
@@ -191,8 +201,8 @@ if ($aResult['check-for-updates']) {
         fail('Updates not set up. Please run ./utils/update.php --init-updates.');
     }
 
-    $oCmd = (new \Nominatim\Shell(CONST_BasePath.'/utils/check_server_for_updates.py'))
-            ->addParams(CONST_Replication_Url)
+    $oCmd = (new \Nominatim\Shell(CONST_BinDir.'/check_server_for_updates.py'))
+            ->addParams($sBaseURL)
             ->addParams($aLastState['sequence_id']);
     $iRet = $oCmd->run();
 
@@ -221,11 +231,11 @@ if (isset($aResult['import-diff']) || isset($aResult['import-file'])) {
 
 if ($aResult['calculate-postcodes']) {
     info('Update postcodes centroids');
-    $sTemplate = file_get_contents(CONST_BasePath.'/sql/update-postcodes.sql');
+    $sTemplate = file_get_contents(CONST_DataDir.'/sql/update-postcodes.sql');
     runSQLScript($sTemplate, true, true);
 }
 
-$sTemporaryFile = CONST_BasePath.'/data/osmosischange.osc';
+$sTemporaryFile = CONST_InstallDir.'/osmosischange.osc';
 $bHaveDiff = false;
 $bUseOSMApi = isset($aResult['import-from-main-api']) && $aResult['import-from-main-api'];
 $sContentURL = '';
@@ -241,15 +251,15 @@ if (isset($aResult['import-way']) && $aResult['import-way']) {
     if ($bUseOSMApi) {
         $sContentURL = 'https://www.openstreetmap.org/api/0.6/way/'.$aResult['import-way'].'/full';
     } else {
-        $sContentURL = 'https://overpass-api.de/api/interpreter?data=(way('.$aResult['import-way'].');node(w););out%20meta;';
+        $sContentURL = 'https://overpass-api.de/api/interpreter?data=(way('.$aResult['import-way'].');%3E;);out%20meta;';
     }
 }
 
 if (isset($aResult['import-relation']) && $aResult['import-relation']) {
     if ($bUseOSMApi) {
-        $sContentURLsModifyXMLstr = 'https://www.openstreetmap.org/api/0.6/relation/'.$aResult['import-relation'].'/full';
+        $sContentURL = 'https://www.openstreetmap.org/api/0.6/relation/'.$aResult['import-relation'].'/full';
     } else {
-        $sContentURL = 'https://overpass-api.de/api/interpreter?data=((rel('.$aResult['import-relation'].');way(r);node(w));node(r));out%20meta;';
+        $sContentURL = 'https://overpass-api.de/api/interpreter?data=(rel(id:'.$aResult['import-relation'].');%3E;);out%20meta;';
     }
 }
 
@@ -270,97 +280,28 @@ if ($bHaveDiff) {
     }
 }
 
-if ($aResult['deduplicate']) {
-    $oDB = new Nominatim\DB();
-    $oDB->connect();
-
-    if ($oDB->getPostgresVersion() < 9.3) {
-        fail('ERROR: deduplicate is only currently supported in postgresql 9.3');
-    }
-
-    $sSQL = 'select partition from country_name order by country_code';
-    $aPartitions = $oDB->getCol($sSQL);
-    $aPartitions[] = 0;
-
-    // we don't care about empty search_name_* partitions, they can't contain mentions of duplicates
-    foreach ($aPartitions as $i => $sPartition) {
-        $sSQL = 'select count(*) from search_name_'.$sPartition;
-        $nEntries = $oDB->getOne($sSQL);
-        if ($nEntries == 0) {
-            unset($aPartitions[$i]);
-        }
-    }
-
-    $sSQL = "select word_token,count(*) from word where substr(word_token, 1, 1) = ' '";
-    $sSQL .= ' and class is null and type is null and country_code is null';
-    $sSQL .= ' group by word_token having count(*) > 1 order by word_token';
-    $aDuplicateTokens = $oDB->getAll($sSQL);
-    foreach ($aDuplicateTokens as $aToken) {
-        if (trim($aToken['word_token']) == '' || trim($aToken['word_token']) == '-') continue;
-        echo 'Deduping '.$aToken['word_token']."\n";
-        $sSQL = 'select word_id,';
-        $sSQL .= ' (select count(*) from search_name where nameaddress_vector @> ARRAY[word_id]) as num';
-        $sSQL .= " from word where word_token = '".$aToken['word_token'];
-        $sSQL .= "' and class is null and type is null and country_code is null order by num desc";
-        $aTokenSet = $oDB->getAll($sSQL);
-
-        $aKeep = array_shift($aTokenSet);
-        $iKeepID = $aKeep['word_id'];
-
-        foreach ($aTokenSet as $aRemove) {
-            $sSQL = 'update search_name set';
-            $sSQL .= ' name_vector = array_replace(name_vector,'.$aRemove['word_id'].','.$iKeepID.'),';
-            $sSQL .= ' nameaddress_vector = array_replace(nameaddress_vector,'.$aRemove['word_id'].','.$iKeepID.')';
-            $sSQL .= ' where name_vector @> ARRAY['.$aRemove['word_id'].']';
-            $oDB->exec($sSQL);
-
-            $sSQL = 'update search_name set';
-            $sSQL .= ' nameaddress_vector = array_replace(nameaddress_vector,'.$aRemove['word_id'].','.$iKeepID.')';
-            $sSQL .= ' where nameaddress_vector @> ARRAY['.$aRemove['word_id'].']';
-            $oDB->exec($sSQL);
-
-            $sSQL = 'update location_area_country set';
-            $sSQL .= ' keywords = array_replace(keywords,'.$aRemove['word_id'].','.$iKeepID.')';
-            $sSQL .= ' where keywords @> ARRAY['.$aRemove['word_id'].']';
-            $oDB->exec($sSQL);
-
-            foreach ($aPartitions as $sPartition) {
-                $sSQL = 'update search_name_'.$sPartition.' set';
-                $sSQL .= ' name_vector = array_replace(name_vector,'.$aRemove['word_id'].','.$iKeepID.')';
-                $sSQL .= ' where name_vector @> ARRAY['.$aRemove['word_id'].']';
-                $oDB->exec($sSQL);
-
-                $sSQL = 'update location_area_country set';
-                $sSQL .= ' keywords = array_replace(keywords,'.$aRemove['word_id'].','.$iKeepID.')';
-                $sSQL .= ' where keywords @> ARRAY['.$aRemove['word_id'].']';
-                $oDB->exec($sSQL);
-            }
-
-            $sSQL = 'delete from word where word_id = '.$aRemove['word_id'];
-            $oDB->exec($sSQL);
-        }
-    }
-}
-
 if ($aResult['recompute-word-counts']) {
     info('Recompute frequency of full-word search terms');
-    $sTemplate = file_get_contents(CONST_BasePath.'/sql/words_from_search_name.sql');
+    $sTemplate = file_get_contents(CONST_DataDir.'/sql/words_from_search_name.sql');
     runSQLScript($sTemplate, true, true);
 }
 
 if ($aResult['index']) {
     $oCmd = (clone $oIndexCmd)
-            ->addParams('--minrank', $aResult['index-rank']);
+            ->addParams('--minrank', $aResult['index-rank'], '-b');
+    $oCmd->run();
 
-    // echo $oCmd->escapedCmd()."\n";
+    $oCmd = (clone $oIndexCmd)
+            ->addParams('--minrank', $aResult['index-rank']);
     $oCmd->run();
 
     $oDB->exec('update import_status set indexed = true');
 }
 
 if ($aResult['update-address-levels']) {
-    echo 'Updating address levels from '.CONST_Address_Level_Config.".\n";
-    $oAlParser = new \Nominatim\Setup\AddressLevelParser(CONST_Address_Level_Config);
+    $sAddressLevelConfig = getSettingConfig('ADDRESS_LEVEL_CONFIG', 'address-levels.json');
+    echo 'Updating address levels from '.$sAddressLevelConfig.".\n";
+    $oAlParser = new \Nominatim\Setup\AddressLevelParser($sAddressLevelConfig);
     $oAlParser->createTable($oDB, 'address_levels');
 }
 
@@ -383,17 +324,17 @@ if ($aResult['recompute-importance']) {
 
 if ($aResult['import-osmosis'] || $aResult['import-osmosis-all']) {
     //
-    if (strpos(CONST_Replication_Url, 'download.geofabrik.de') !== false && CONST_Replication_Update_Interval < 86400) {
+    if (strpos($sBaseURL, 'download.geofabrik.de') !== false && getSetting('REPLICATION_UPDATE_INTERVAL') < 86400) {
         fail('Error: Update interval too low for download.geofabrik.de. ' .
              "Please check install documentation (https://nominatim.org/release-docs/latest/admin/Import-and-Update#setting-up-the-update-process)\n");
     }
 
-    $sImportFile = CONST_InstallPath.'/osmosischange.osc';
+    $sImportFile = CONST_InstallDir.'/osmosischange.osc';
 
-    $oCMDDownload = (new \Nominatim\Shell(CONST_Pyosmium_Binary))
-                    ->addParams('--server', CONST_Replication_Url)
+    $oCMDDownload = (new \Nominatim\Shell($sPyosmiumBin))
+                    ->addParams('--server', $sBaseURL)
                     ->addParams('--outfile', $sImportFile)
-                    ->addParams('--size', CONST_Replication_Max_Diff_size);
+                    ->addParams('--size', getSetting('REPLICATION_MAX_DIFF'));
 
     $oCMDImport = (clone $oOsm2pgsqlCmd)->addParams($sImportFile);
 
@@ -413,7 +354,7 @@ if ($aResult['import-osmosis'] || $aResult['import-osmosis-all']) {
 
         if ($aLastState['indexed']) {
             // Sleep if the update interval has not yet been reached.
-            $fNextUpdate = $aLastState['unix_ts'] + CONST_Replication_Update_Interval;
+            $fNextUpdate = $aLastState['unix_ts'] + getSetting('REPLICATION_UPDATE_INTERVAL');
             if ($fNextUpdate > $fStartTime) {
                 $iSleepTime = $fNextUpdate - $fStartTime;
                 echo "Waiting for next update for $iSleepTime sec.";
@@ -434,8 +375,9 @@ if ($aResult['import-osmosis'] || $aResult['import-osmosis-all']) {
                 exec($oCMD->escapedCmd(), $aOutput, $iResult);
 
                 if ($iResult == 3) {
-                    echo 'No new updates. Sleeping for '.CONST_Replication_Recheck_Interval." sec.\n";
-                    sleep(CONST_Replication_Recheck_Interval);
+                    $sSleep = getSetting('REPLICATION_RECHECK_INTERVAL');
+                    echo 'No new updates. Sleeping for '.$sSleep." sec.\n";
+                    sleep($sSleep);
                 } elseif ($iResult != 0) {
                     echo 'ERROR: updates failed.';
                     exit($iResult);
@@ -447,7 +389,7 @@ if ($aResult['import-osmosis'] || $aResult['import-osmosis-all']) {
             // get the newest object from the diff file
             $sBatchEnd = 0;
             $iRet = 0;
-            $oCMD = new \Nominatim\Shell(CONST_BasePath.'/utils/osm_file_date.py', $sImportFile);
+            $oCMD = new \Nominatim\Shell(CONST_BinDir.'/osm_file_date.py', $sImportFile);
             exec($oCMD->escapedCmd(), $sBatchEnd, $iRet);
             if ($iRet == 5) {
                 echo "Diff file is empty. skipping import.\n";
@@ -493,9 +435,18 @@ if ($aResult['import-osmosis'] || $aResult['import-osmosis-all']) {
 
         // Index file
         if (!$aResult['no-index']) {
-            $oThisIndexCmd = clone($oIndexCmd);
             $fCMDStartTime = time();
 
+            $oThisIndexCmd = clone($oIndexCmd);
+            $oThisIndexCmd->addParams('-b');
+            echo $oThisIndexCmd->escapedCmd()."\n";
+            $iErrorLevel = $oThisIndexCmd->run();
+            if ($iErrorLevel) {
+                echo "Error: $iErrorLevel\n";
+                exit($iErrorLevel);
+            }
+
+            $oThisIndexCmd = clone($oIndexCmd);
             echo $oThisIndexCmd->escapedCmd()."\n";
             $iErrorLevel = $oThisIndexCmd->run();
             if ($iErrorLevel) {