changed nominatim.so module path to be a runtime configuration setting as opposed...

[nominatim.git] / utils / setup.php

diff --git a/utils/setup.php b/utils/setup.php
index 106be6162ce99d674ffc35af9d7bc04ede46437f..95eda0f4a085726ef12a51b4f43d3e126ce0f33a 100755 (executable)
--- a/utils/setup.php
+++ b/utils/setup.php
@@ -16,7 +16,6 @@ $aCMDOptions
 
    array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
    array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
 
    array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
    array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),

-   array('module-path', '', 0, 1, 1, 1, 'string', 'Directory on Postgres server containing Nominatim module'),

 
    array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
 
 
    array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
 


@@ -80,11 +79,8 @@ if (isset($aCMDResult['osm2pgsql-cache'])) {
     $iCacheMemory = getCacheMemoryMB();
 }
 
     $iCacheMemory = getCacheMemoryMB();
 }
 

-$modulePath = CONST_InstallPath . '/module';
-if (isset($aCMDResult['module-path'])) {
-    $modulePath = $aCMDResult['module-path'];
-    echo 'module path: ' . $modulePath . '\n';
-}
+$sModulePath = CONST_Database_Module_Path;
+info('module path: ' . $sModulePath);

 
 $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
 
 $aDSNInfo = DB::parseDSN(CONST_Database_DSN);
 if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;


@@ -97,21 +93,21 @@ if ($aCMDResult['create-db'] || $aCMDResult['all']) {
         fail('database already exists ('.CONST_Database_DSN.')');
     }
 
         fail('database already exists ('.CONST_Database_DSN.')');
     }
 

-    $createdbCmd = 'createdb -E UTF-8 -p '.$aDSNInfo['port'].' '.$aDSNInfo['database'];
+    $sCreateDBCmd = 'createdb -E UTF-8 -p '.$aDSNInfo['port'].' '.$aDSNInfo['database'];

     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {

-        $createdbCmd .= ' -U ' . $aDSNInfo['username'];
+        $sCreateDBCmd .= ' -U ' . $aDSNInfo['username'];

     }
     if (isset($aDSNInfo['hostspec']) && $aDSNInfo['hostspec']) {
     }
     if (isset($aDSNInfo['hostspec']) && $aDSNInfo['hostspec']) {

-        $createdbCmd .= ' -h ' . $aDSNInfo['hostspec'];
+        $sCreateDBCmd .= ' -h ' . $aDSNInfo['hostspec'];

     }
 
     }
 

-    $procenv = null;
+    $aProcEnv = null;

     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {

-        $procenv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);
+        $aProcEnv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);

     }
 
     }
 

-    $result = runWithEnv($createdbCmd, $procenv);
-    if ($result != 0) fail('Error executing external command: '.$createdbCmd);
+    $result = runWithEnv($sCreateDBCmd, $aProcEnv);
+    if ($result != 0) fail('Error executing external command: '.$sCreateDBCmd);

 }
 
 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
 }
 
 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {


@@ -159,17 +155,8 @@ if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
         exit(1);
     }
 
         exit(1);
     }
 

-    // Try accessing the C module, so we know early if something is wrong
-    // and can simply error out.
-    $sSQL = "CREATE FUNCTION nominatim_test_import_func(text) RETURNS text AS '";
-    $sSQL .= $modulePath."/nominatim.so', 'transliteration' LANGUAGE c IMMUTABLE STRICT";
-    $sSQL .= ';DROP FUNCTION nominatim_test_import_func(text);';
-    $oResult = $oDB->query($sSQL);
-
-    if (PEAR::isError($oResult)) {
-        echo "\nERROR: Failed to load nominatim module. Reason:\n";
-        echo $oResult->userinfo."\n\n";
-        exit(1);
+    if (!checkModulePresence()) {
+        fail('error loading nominatim.so module');

     }
 
     if (!file_exists(CONST_ExtraDataPath.'/country_osm_grid.sql.gz')) {
     }
 
     if (!file_exists(CONST_ExtraDataPath.'/country_osm_grid.sql.gz')) {


@@ -235,13 +222,13 @@ if ($aCMDResult['import-data'] || $aCMDResult['all']) {
         $osm2pgsql .= ' -H ' . $aDSNInfo['hostspec'];
     }
 
         $osm2pgsql .= ' -H ' . $aDSNInfo['hostspec'];
     }
 

-    $procenv = null;
+    $aProcEnv = null;

     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {

-        $procenv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);
+        $aProcEnv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);

     }
 
     $osm2pgsql .= ' -d '.$aDSNInfo['database'].' '.$aCMDResult['osm-file'];
     }
 
     $osm2pgsql .= ' -d '.$aDSNInfo['database'].' '.$aCMDResult['osm-file'];

-    runWithEnv($osm2pgsql, $procenv);
+    runWithEnv($osm2pgsql, $aProcEnv);

 
     $oDB =& getDB();
     if (!$aCMDResult['ignore-errors'] && !chksql($oDB->getRow('select * from place limit 1'))) {
 
     $oDB =& getDB();
     if (!$aCMDResult['ignore-errors'] && !chksql($oDB->getRow('select * from place limit 1'))) {


@@ -252,6 +239,11 @@ if ($aCMDResult['import-data'] || $aCMDResult['all']) {
 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
     info('Create Functions');
     $bDidSomething = true;
 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
     info('Create Functions');
     $bDidSomething = true;

+
+    if (!checkModulePresence()) {
+        fail('error loading nominatim.so module');
+    }
+

     create_sql_functions($aCMDResult);
 }
 
     create_sql_functions($aCMDResult);
 }
 


@@ -441,22 +433,22 @@ if ($aCMDResult['load-data'] || $aCMDResult['all']) {
         fail(pg_last_error($aDBInstances[$iLoadThreads]->connection));
     }
 
         fail(pg_last_error($aDBInstances[$iLoadThreads]->connection));
     }
 

-    $failed = false;
+    $bFailed = false;

     for ($i = 0; $i <= $iLoadThreads; $i++) {
     for ($i = 0; $i <= $iLoadThreads; $i++) {

-        while (($pgresult = pg_get_result($aDBInstances[$i]->connection)) !== false) {
-            $resultStatus = pg_result_status($pgresult);
+        while (($hPGresult = pg_get_result($aDBInstances[$i]->connection)) !== false) {
+            $resultStatus = pg_result_status($hPGresult);

             // PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK,
             // PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE,
             // PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR
             // PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK,
             // PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE,
             // PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR

-            echo 'Query result ' . $i . ' is: ' . $resultStatus . '\n';
+            echo 'Query result ' . $i . ' is: ' . $resultStatus . "\n";

             if ($resultStatus != PGSQL_COMMAND_OK && $resultStatus != PGSQL_TUPLES_OK) {
             if ($resultStatus != PGSQL_COMMAND_OK && $resultStatus != PGSQL_TUPLES_OK) {

-                $resultError = pg_result_error($pgresult);
-                echo '-- error text ' . $i . ': ' . $resultError . '\n';
-                $failed = true;
+                $resultError = pg_result_error($hPGresult);
+                echo '-- error text ' . $i . ': ' . $resultError . "\n";
+                $bFailed = true;

             }
         }
     }
             }
         }
     }

-    if ($failed) {
+    if ($bFailed) {

         fail('SQL errors loading placex and/or location_property_osmline tables');
     }
     echo "\n";
         fail('SQL errors loading placex and/or location_property_osmline tables');
     }
     echo "\n";


@@ -622,27 +614,27 @@ if ($aCMDResult['index'] || $aCMDResult['all']) {
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sBaseCmd .= ' -U ' . $aDSNInfo['username'];
     }
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sBaseCmd .= ' -U ' . $aDSNInfo['username'];
     }

-    $procenv = null;
+    $aProcEnv = null;

     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {

-        $procenv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);
+        $aProcEnv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);

     }
 
     info('Index ranks 0 - 4');
     }
 
     info('Index ranks 0 - 4');

-    $status = runWithEnv($sBaseCmd.' -R 4', $procenv);
-    if ($status != 0) {
-        fail('error status ' . $status . ' running nominatim!');
+    $iStatus = runWithEnv($sBaseCmd.' -R 4', $aProcEnv);
+    if ($iStatus != 0) {
+        fail('error status ' . $iStatus . ' running nominatim!');

     }
     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
     info('Index ranks 5 - 25');
     }
     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
     info('Index ranks 5 - 25');

-    $status = runWithEnv($sBaseCmd.' -r 5 -R 25', $procenv);
-    if ($status != 0) {
-        fail('error status ' . $status . ' running nominatim!');
+    $iStatus = runWithEnv($sBaseCmd.' -r 5 -R 25', $aProcEnv);
+    if ($iStatus != 0) {
+        fail('error status ' . $iStatus . ' running nominatim!');

     }
     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
     info('Index ranks 26 - 30');
     }
     if (!$aCMDResult['index-noanalyse']) pgsqlRunScript('ANALYSE');
     info('Index ranks 26 - 30');

-    $status = runWithEnv($sBaseCmd.' -r 26', $procenv);
-    if ($status != 0) {
-        fail('error status ' . $status . ' running nominatim!');
+    $iStatus = runWithEnv($sBaseCmd.' -r 26', $aProcEnv);
+    if ($iStatus != 0) {
+        fail('error status ' . $iStatus . ' running nominatim!');

     }
 
     info('Index postcodes');
     }
 
     info('Index postcodes');


@@ -785,9 +777,9 @@ function pgsqlRunScriptFile($sFilename)
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sCMD .= ' -U ' . $aDSNInfo['username'];
     }
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sCMD .= ' -U ' . $aDSNInfo['username'];
     }

-    $procenv = null;
+    $aProcEnv = null;

     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {

-        $procenv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);
+        $aProcEnv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);

     }
 
     $ahGzipPipes = null;
     }
 
     $ahGzipPipes = null;


@@ -812,7 +804,7 @@ function pgsqlRunScriptFile($sFilename)
                      2 => array('file', '/dev/null', 'a')
                     );
     $ahPipes = null;
                      2 => array('file', '/dev/null', 'a')
                     );
     $ahPipes = null;

-    $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes, null, $procenv);
+    $hProcess = proc_open($sCMD, $aDescriptors, $ahPipes, null, $aProcEnv);

     if (!is_resource($hProcess)) fail('unable to start pgsql');
 
     // TODO: error checking
     if (!is_resource($hProcess)) fail('unable to start pgsql');
 
     // TODO: error checking


@@ -902,18 +894,18 @@ function pgsqlRunDropAndRestore($sDumpFile)
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sCMD .= ' -U ' . $aDSNInfo['username'];
     }
     if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
         $sCMD .= ' -U ' . $aDSNInfo['username'];
     }

-    $procenv = null;
+    $aProcEnv = null;

     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {
     if (isset($aDSNInfo['password']) && $aDSNInfo['password']) {

-        $procenv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);
+        $aProcEnv = array_merge(array('PGPASSWORD' => $aDSNInfo['password']), $_ENV);

     }
 
     }
 

-    $iReturn = runWithEnv($sCMD, $procenv);
+    $iReturn = runWithEnv($sCMD, $aProcEnv);

 }
 
 }
 

-function passthruCheckReturn($cmd)
+function passthruCheckReturn($sCmd)

 {
 {

-    $result = -1;
-    passthru($cmd, $result);
+    $iResult = -1;
+    passthru($sCmd, $iResult);

 }
 
 function replace_tablespace($sTemplate, $sTablespace, $sSql)
 }
 
 function replace_tablespace($sTemplate, $sTablespace, $sSql)


@@ -929,9 +921,9 @@ function replace_tablespace($sTemplate, $sTablespace, $sSql)
 
 function create_sql_functions($aCMDResult)
 {
 
 function create_sql_functions($aCMDResult)
 {

-    global $modulePath;
+    global $sModulePath;

     $sTemplate = file_get_contents(CONST_BasePath.'/sql/functions.sql');
     $sTemplate = file_get_contents(CONST_BasePath.'/sql/functions.sql');

-    $sTemplate = str_replace('{modulepath}', $modulePath, $sTemplate);
+    $sTemplate = str_replace('{modulepath}', $sModulePath, $sTemplate);

     if ($aCMDResult['enable-diff-updates']) {
         $sTemplate = str_replace('RETURN NEW; -- %DIFFUPDATES%', '--', $sTemplate);
     }
     if ($aCMDResult['enable-diff-updates']) {
         $sTemplate = str_replace('RETURN NEW; -- %DIFFUPDATES%', '--', $sTemplate);
     }


@@ -949,3 +941,26 @@ function create_sql_functions($aCMDResult)
     }
     pgsqlRunScript($sTemplate);
 }
     }
     pgsqlRunScript($sTemplate);
 }

+
+function checkModulePresence()
+{
+    // Try accessing the C module, so we know early if something is wrong
+    // and can simply error out.
+    global $sModulePath;
+    $sSQL = "CREATE FUNCTION nominatim_test_import_func(text) RETURNS text AS '";
+    $sSQL .= $sModulePath."/nominatim.so', 'transliteration' LANGUAGE c IMMUTABLE STRICT";
+    $sSQL .= ';DROP FUNCTION nominatim_test_import_func(text);';
+
+    $oDB =& getDB();
+    $oResult = $oDB->query($sSQL);
+
+    $bResult = true;
+
+    if (PEAR::isError($oResult)) {
+        echo "\nERROR: Failed to load nominatim module. Reason:\n";
+        echo $oResult->userinfo."\n\n";
+        $bResult = false;
+    }
+
+    return $bResult;
+}