replace database settings with dotenv variant

[nominatim.git] / lib / setup / SetupClass.php

diff --git a/lib/setup/SetupClass.php b/lib/setup/SetupClass.php
index 7a4ef533e36f03191fcafe526eeca3e5207be392..489ab2ec8672f3036a62d1731294947208683096 100755 (executable)
--- a/lib/setup/SetupClass.php
+++ b/lib/setup/SetupClass.php
@@ -2,8 +2,8 @@
 
 namespace Nominatim\Setup;
 
 
 namespace Nominatim\Setup;
 

-require_once(CONST_BasePath.'/lib/setup/AddressLevelParser.php');
-require_once(CONST_BasePath.'/lib/Shell.php');
+require_once(CONST_LibDir.'/setup/AddressLevelParser.php');
+require_once(CONST_LibDir.'/Shell.php');

 
 class SetupFunctions
 {
 
 class SetupFunctions
 {


@@ -42,11 +42,14 @@ class SetupFunctions
             $this->iCacheMemory = getCacheMemoryMB();
         }
 
             $this->iCacheMemory = getCacheMemoryMB();
         }
 

-        $this->sModulePath = CONST_Database_Module_Path;
+        $this->sModulePath = getSetting('DATABASE_MODULE_PATH');
+        if (strlen($this->sModulePath) == 0 || $this->sModulePath[0] != '/') {
+            $this->sModulePath = CONST_InstallDir.'/'.$this->sModulePath;
+        }

         info('module path: ' . $this->sModulePath);
 
         // parse database string
         info('module path: ' . $this->sModulePath);
 
         // parse database string

-        $this->aDSNInfo = \Nominatim\DB::parseDSN(CONST_Database_DSN);
+        $this->aDSNInfo = \Nominatim\DB::parseDSN(getSetting('DATABASE_DSN'));

         if (!isset($this->aDSNInfo['port'])) {
             $this->aDSNInfo['port'] = 5432;
         }
         if (!isset($this->aDSNInfo['port'])) {
             $this->aDSNInfo['port'] = 5432;
         }


@@ -86,7 +89,7 @@ class SetupFunctions
         $oDB = new \Nominatim\DB;
 
         if ($oDB->checkConnection()) {
         $oDB = new \Nominatim\DB;
 
         if ($oDB->checkConnection()) {

-            fail('database already exists ('.CONST_Database_DSN.')');
+            fail('database already exists ('.getSetting('DATABASE_DSN').')');

         }
 
         $oCmd = (new \Nominatim\Shell('createdb'))
         }
 
         $oCmd = (new \Nominatim\Shell('createdb'))


@@ -130,34 +133,35 @@ class SetupFunctions
             exit(1);
         }
 
             exit(1);
         }
 

-        $i = $this->db()->getOne("select count(*) from pg_user where usename = '".CONST_Database_Web_User."'");
+        $sPgUser = getSetting('DATABASE_WEBUSER');
+        $i = $this->db()->getOne("select count(*) from pg_user where usename = '$sPgUser'");

         if ($i == 0) {
         if ($i == 0) {

-            echo "\nERROR: Web user '".CONST_Database_Web_User."' does not exist. Create it with:\n";
-            echo "\n          createuser ".CONST_Database_Web_User."\n\n";
+            echo "\nERROR: Web user '".$sPgUser."' does not exist. Create it with:\n";
+            echo "\n          createuser ".$sPgUser."\n\n";

             exit(1);
         }
 
         // Try accessing the C module, so we know early if something is wrong
             exit(1);
         }
 
         // Try accessing the C module, so we know early if something is wrong

-        checkModulePresence(); // raises exception on failure
+        $this->checkModulePresence(); // raises exception on failure

 
 

-        if (!file_exists(CONST_ExtraDataPath.'/country_osm_grid.sql.gz')) {
+        if (!file_exists(CONST_DataDir.'/data/country_osm_grid.sql.gz')) {

             echo 'Error: you need to download the country_osm_grid first:';
             echo 'Error: you need to download the country_osm_grid first:';

-            echo "\n    wget -O ".CONST_ExtraDataPath."/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz\n";
+            echo "\n    wget -O ".CONST_DataDir."/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz\n";

             exit(1);
         }
             exit(1);
         }

-        $this->pgsqlRunScriptFile(CONST_BasePath.'/data/country_name.sql');
-        $this->pgsqlRunScriptFile(CONST_ExtraDataPath.'/country_osm_grid.sql.gz');
-        $this->pgsqlRunScriptFile(CONST_BasePath.'/data/gb_postcode_table.sql');
-        $this->pgsqlRunScriptFile(CONST_BasePath.'/data/us_postcode_table.sql');
+        $this->pgsqlRunScriptFile(CONST_DataDir.'/data/country_name.sql');
+        $this->pgsqlRunScriptFile(CONST_DataDir.'/data/country_osm_grid.sql.gz');
+        $this->pgsqlRunScriptFile(CONST_DataDir.'/data/gb_postcode_table.sql');
+        $this->pgsqlRunScriptFile(CONST_DataDir.'/data/us_postcode_table.sql');

 
 

-        $sPostcodeFilename = CONST_BasePath.'/data/gb_postcode_data.sql.gz';
+        $sPostcodeFilename = CONST_DataDir.'/data/gb_postcode_data.sql.gz';

         if (file_exists($sPostcodeFilename)) {
             $this->pgsqlRunScriptFile($sPostcodeFilename);
         } else {
             warn('optional external GB postcode table file ('.$sPostcodeFilename.') not found. Skipping.');
         }
 
         if (file_exists($sPostcodeFilename)) {
             $this->pgsqlRunScriptFile($sPostcodeFilename);
         } else {
             warn('optional external GB postcode table file ('.$sPostcodeFilename.') not found. Skipping.');
         }
 

-        $sPostcodeFilename = CONST_BasePath.'/data/us_postcode_data.sql.gz';
+        $sPostcodeFilename = CONST_DataDir.'/data/us_postcode_data.sql.gz';

         if (file_exists($sPostcodeFilename)) {
             $this->pgsqlRunScriptFile($sPostcodeFilename);
         } else {
         if (file_exists($sPostcodeFilename)) {
             $this->pgsqlRunScriptFile($sPostcodeFilename);
         } else {


@@ -201,6 +205,8 @@ class SetupFunctions
         $oCmd->addParams('--output', 'gazetteer');
         $oCmd->addParams('--hstore');
         $oCmd->addParams('--number-processes', 1);
         $oCmd->addParams('--output', 'gazetteer');
         $oCmd->addParams('--hstore');
         $oCmd->addParams('--number-processes', 1);

+        $oCmd->addParams('--with-forward-dependencies', 'false');
+        $oCmd->addParams('--log-progress', 'true');

         $oCmd->addParams('--cache', $this->iCacheMemory);
         $oCmd->addParams('--port', $this->aDSNInfo['port']);
 
         $oCmd->addParams('--cache', $this->iCacheMemory);
         $oCmd->addParams('--port', $this->aDSNInfo['port']);
 


@@ -232,7 +238,7 @@ class SetupFunctions
         info('Create Functions');
 
         // Try accessing the C module, so we know early if something is wrong
         info('Create Functions');
 
         // Try accessing the C module, so we know early if something is wrong

-        checkModulePresence(); // raises exception on failure
+        $this->checkModulePresence(); // raises exception on failure

 
         $this->createSqlFunctions();
     }
 
         $this->createSqlFunctions();
     }


@@ -241,7 +247,7 @@ class SetupFunctions
     {
         info('Create Tables');
 
     {
         info('Create Tables');
 

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/tables.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/tables.sql');

         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);


@@ -258,7 +264,7 @@ class SetupFunctions
     {
         info('Create Tables');
 
     {
         info('Create Tables');
 

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/table-triggers.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/table-triggers.sql');

         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);


@@ -268,7 +274,7 @@ class SetupFunctions
     {
         info('Create Partition Tables');
 
     {
         info('Create Partition Tables');
 

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/partition-tables.src.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/partition-tables.src.sql');

         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunPartitionScript($sTemplate);
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunPartitionScript($sTemplate);


@@ -278,7 +284,7 @@ class SetupFunctions
     {
         info('Create Partition Functions');
 
     {
         info('Create Partition Functions');
 

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/partition-functions.src.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/partition-functions.src.sql');

         $this->pgsqlRunPartitionScript($sTemplate);
     }
 
         $this->pgsqlRunPartitionScript($sTemplate);
     }
 


@@ -340,7 +346,7 @@ class SetupFunctions
         // pre-create the word list
         if (!$bDisableTokenPrecalc) {
             info('Loading word list');
         // pre-create the word list
         if (!$bDisableTokenPrecalc) {
             info('Loading word list');

-            $this->pgsqlRunScriptFile(CONST_BasePath.'/data/words.sql');
+            $this->pgsqlRunScriptFile(CONST_DataDir.'/data/words.sql');

         }
 
         info('Load Data');
         }
 
         info('Load Data');


@@ -350,7 +356,7 @@ class SetupFunctions
         $iLoadThreads = max(1, $this->iInstances - 1);
         for ($i = 0; $i < $iLoadThreads; $i++) {
             // https://secure.php.net/manual/en/function.pg-connect.php
         $iLoadThreads = max(1, $this->iInstances - 1);
         for ($i = 0; $i < $iLoadThreads; $i++) {
             // https://secure.php.net/manual/en/function.pg-connect.php

-            $DSN = CONST_Database_DSN;
+            $DSN = getSetting('DATABASE_DSN');

             $DSN = preg_replace('/^pgsql:/', '', $DSN);
             $DSN = preg_replace('/;/', ' ', $DSN);
             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
             $DSN = preg_replace('/^pgsql:/', '', $DSN);
             $DSN = preg_replace('/;/', ' ', $DSN);
             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);


@@ -370,7 +376,7 @@ class SetupFunctions
 
         // last thread for interpolation lines
         // https://secure.php.net/manual/en/function.pg-connect.php
 
         // last thread for interpolation lines
         // https://secure.php.net/manual/en/function.pg-connect.php

-        $DSN = CONST_Database_DSN;
+        $DSN = getSetting('DATABASE_DSN');

         $DSN = preg_replace('/^pgsql:/', '', $DSN);
         $DSN = preg_replace('/;/', ' ', $DSN);
         $aDBInstances[$iLoadThreads] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);
         $DSN = preg_replace('/^pgsql:/', '', $DSN);
         $DSN = preg_replace('/;/', ' ', $DSN);
         $aDBInstances[$iLoadThreads] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW);


@@ -432,7 +438,7 @@ class SetupFunctions
             warn('Tiger data import selected but no files found in path '.CONST_Tiger_Data_Path);
             return;
         }
             warn('Tiger data import selected but no files found in path '.CONST_Tiger_Data_Path);
             return;
         }

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_start.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/tiger_import_start.sql');

         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);


@@ -440,7 +446,7 @@ class SetupFunctions
         $aDBInstances = array();
         for ($i = 0; $i < $this->iInstances; $i++) {
             // https://secure.php.net/manual/en/function.pg-connect.php
         $aDBInstances = array();
         for ($i = 0; $i < $this->iInstances; $i++) {
             // https://secure.php.net/manual/en/function.pg-connect.php

-            $DSN = CONST_Database_DSN;
+            $DSN = getSetting('DATABASE_DSN');

             $DSN = preg_replace('/^pgsql:/', '', $DSN);
             $DSN = preg_replace('/;/', ' ', $DSN);
             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW | PGSQL_CONNECT_ASYNC);
             $DSN = preg_replace('/^pgsql:/', '', $DSN);
             $DSN = preg_replace('/;/', ' ', $DSN);
             $aDBInstances[$i] = pg_connect($DSN, PGSQL_CONNECT_FORCE_NEW | PGSQL_CONNECT_ASYNC);


@@ -486,7 +492,7 @@ class SetupFunctions
         }
 
         info('Creating indexes on Tiger data');
         }
 
         info('Creating indexes on Tiger data');

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/tiger_import_finish.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/tiger_import_finish.sql');

         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         $this->pgsqlRunScript($sTemplate, false);


@@ -540,9 +546,9 @@ class SetupFunctions
 
     public function index($bIndexNoanalyse)
     {
 
     public function index($bIndexNoanalyse)
     {

-        checkModulePresence(); // raises exception on failure
+        $this->checkModulePresence(); // raises exception on failure

 
 

-        $oBaseCmd = (new \Nominatim\Shell(CONST_BasePath.'/nominatim/nominatim.py'))
+        $oBaseCmd = (new \Nominatim\Shell(CONST_DataDir.'/nominatim/nominatim.py'))

                     ->addParams('--database', $this->aDSNInfo['database'])
                     ->addParams('--port', $this->aDSNInfo['port'])
                     ->addParams('--threads', $this->iInstances);
                     ->addParams('--database', $this->aDSNInfo['database'])
                     ->addParams('--port', $this->aDSNInfo['port'])
                     ->addParams('--threads', $this->iInstances);


@@ -614,12 +620,12 @@ class SetupFunctions
             $this->db()->exec("DROP INDEX $sIndexName;");
         }
 
             $this->db()->exec("DROP INDEX $sIndexName;");
         }
 

-        $sTemplate = file_get_contents(CONST_BasePath.'/sql/indices.src.sql');
+        $sTemplate = file_get_contents(CONST_DataDir.'/sql/indices.src.sql');

         if (!$this->bDrop) {
         if (!$this->bDrop) {

-            $sTemplate .= file_get_contents(CONST_BasePath.'/sql/indices_updates.src.sql');
+            $sTemplate .= file_get_contents(CONST_DataDir.'/sql/indices_updates.src.sql');

         }
         if (!$this->dbReverseOnly()) {
         }
         if (!$this->dbReverseOnly()) {

-            $sTemplate .= file_get_contents(CONST_BasePath.'/sql/indices_search.src.sql');
+            $sTemplate .= file_get_contents(CONST_DataDir.'/sql/indices_search.src.sql');

         }
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 
         }
         $sTemplate = $this->replaceSqlPatterns($sTemplate);
 


@@ -707,13 +713,12 @@ class SetupFunctions
      */
     public function setupWebsite()
     {
      */
     public function setupWebsite()
     {

-        $rOutputFile = fopen(CONST_InstallPath.'/settings/settings-frontend.php', 'w');
+        $rOutputFile = fopen(CONST_InstallDir.'/settings/settings-frontend.php', 'w');

 
         fwrite($rOutputFile, "<?php
 
         fwrite($rOutputFile, "<?php

-@define('CONST_BasePath', '".CONST_BasePath."');

 if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SETTINGS'));
 
 if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SETTINGS'));
 

-@define('CONST_Database_DSN', '".CONST_Database_DSN."');
+@define('CONST_Database_DSN', '".getSetting('DATABASE_DSN')."');

 @define('CONST_Default_Language', ".(CONST_Default_Language ? ("'".CONST_Default_Language."'") : 'false').");
 @define('CONST_Log_DB', ".(CONST_Log_DB ? 'true' : 'false').");
 @define('CONST_Log_File', ".(CONST_Log_File ? ("'".CONST_Log_File."'")  : 'false').");
 @define('CONST_Default_Language', ".(CONST_Default_Language ? ("'".CONST_Default_Language."'") : 'false').");
 @define('CONST_Log_DB', ".(CONST_Log_DB ? 'true' : 'false').");
 @define('CONST_Log_File', ".(CONST_Log_File ? ("'".CONST_Log_File."'")  : 'false').");


@@ -728,9 +733,9 @@ if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SE
 @define('CONST_Term_Normalization_Rules', \"".CONST_Term_Normalization_Rules."\");
 @define('CONST_Use_Aux_Location_data', ".(CONST_Use_Aux_Location_data ? 'true' : 'false').");
 @define('CONST_Use_US_Tiger_Data', ".(CONST_Use_US_Tiger_Data ? 'true' : 'false').");
 @define('CONST_Term_Normalization_Rules', \"".CONST_Term_Normalization_Rules."\");
 @define('CONST_Use_Aux_Location_data', ".(CONST_Use_Aux_Location_data ? 'true' : 'false').");
 @define('CONST_Use_US_Tiger_Data', ".(CONST_Use_US_Tiger_Data ? 'true' : 'false').");

-@define('CONST_MapIcon_URL', ".(CONST_MapIcon_URL ? ("'".CONST_MapIcon_URL."'") : 'false').");
-");
-        info(CONST_InstallPath.'/settings/settings-frontend.php has been set up successfully');
+@define('CONST_MapIcon_URL', ".(CONST_MapIcon_URL ? ("'".CONST_MapIcon_URL."'") : 'false').');
+');
+        info(CONST_InstallDir.'/settings/settings-frontend.php has been set up successfully');

     }
 
     /**
     }
 
     /**


@@ -773,7 +778,7 @@ if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SE
 
     private function createSqlFunctions()
     {
 
     private function createSqlFunctions()
     {

-        $sBasePath = CONST_BasePath.'/sql/functions/';
+        $sBasePath = CONST_DataDir.'/sql/functions/';

         $sTemplate = file_get_contents($sBasePath.'utils.sql');
         $sTemplate .= file_get_contents($sBasePath.'normalization.sql');
         $sTemplate .= file_get_contents($sBasePath.'ranking.sql');
         $sTemplate = file_get_contents($sBasePath.'utils.sql');
         $sTemplate .= file_get_contents($sBasePath.'normalization.sql');
         $sTemplate .= file_get_contents($sBasePath.'ranking.sql');


@@ -893,7 +898,7 @@ if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SE
 
     private function replaceSqlPatterns($sSql)
     {
 
     private function replaceSqlPatterns($sSql)
     {

-        $sSql = str_replace('{www-user}', CONST_Database_Web_User, $sSql);
+        $sSql = str_replace('{www-user}', getSetting('DATABASE_WEBUSER'), $sSql);

 
         $aPatterns = array(
                       '{ts:address-data}' => CONST_Tablespace_Address_Data,
 
         $aPatterns = array(
                       '{ts:address-data}' => CONST_Tablespace_Address_Data,


@@ -937,4 +942,20 @@ if (file_exists(getenv('NOMINATIM_SETTINGS'))) require_once(getenv('NOMINATIM_SE
     {
         return !($this->db()->tableExists('search_name'));
     }
     {
         return !($this->db()->tableExists('search_name'));
     }

+
+    /**
+     * Try accessing the C module, so we know early if something is wrong.
+     *
+     * Raises Nominatim\DatabaseError on failure
+     */
+    private function checkModulePresence()
+    {
+        $sSQL = "CREATE FUNCTION nominatim_test_import_func(text) RETURNS text AS '";
+        $sSQL .= $this->sModulePath . "/nominatim.so', 'transliteration' LANGUAGE c IMMUTABLE STRICT";
+        $sSQL .= ';DROP FUNCTION nominatim_test_import_func(text);';
+
+        $oDB = new \Nominatim\DB();
+        $oDB->connect();
+        $oDB->exec($sSQL, null, 'Database server failed to load '.$this->sModulePath.'/nominatim.so module');
+    }

 }
 }