make HTTP proxy setup explicit

[nominatim.git] / lib / cmd.php

diff --git a/lib/cmd.php b/lib/cmd.php
index a5a6ba5bca7c4a7ec10a38eb9c963b7191e4804e..b72c1bb41726950b6772ae5ea0157c56331e3e47 100644 (file)
--- a/lib/cmd.php
+++ b/lib/cmd.php
@@ -1,14 +1,14 @@
 <?php
 
 <?php
 

+require_once(CONST_LibDir.'/Shell.php');
+

 function getCmdOpt($aArg, $aSpec, &$aResult, $bExitOnError = false, $bExitOnUnknown = false)
 {
     $aQuick = array();
     $aCounts = array();
 
 function getCmdOpt($aArg, $aSpec, &$aResult, $bExitOnError = false, $bExitOnUnknown = false)
 {
     $aQuick = array();
     $aCounts = array();
 

-    foreach($aSpec as $aLine)
-    {
-        if (is_array($aLine))
-        {
+    foreach ($aSpec as $aLine) {
+        if (is_array($aLine)) {

             if ($aLine[0]) $aQuick['--'.$aLine[0]] = $aLine;
             if ($aLine[1]) $aQuick['-'.$aLine[1]] = $aLine;
             $aCounts[$aLine[0]] = 0;
             if ($aLine[0]) $aQuick['--'.$aLine[0]] = $aLine;
             if ($aLine[1]) $aQuick['-'.$aLine[1]] = $aLine;
             $aCounts[$aLine[0]] = 0;


@@ -17,74 +17,60 @@ function getCmdOpt($aArg, $aSpec, &$aResult, $bExitOnError = false, $bExitOnUnkn
 
     $aResult = array();
     $bUnknown = false;
 
     $aResult = array();
     $bUnknown = false;

-    $iSize = sizeof($aArg);
-    for ($i = 1; $i < $iSize; $i++)
-    {
-        if (isset($aQuick[$aArg[$i]]))
-        {
+    $iSize = count($aArg);
+    for ($i = 1; $i < $iSize; $i++) {
+        if (isset($aQuick[$aArg[$i]])) {

             $aLine = $aQuick[$aArg[$i]];
             $aCounts[$aLine[0]]++;
             $xVal = null;
             $aLine = $aQuick[$aArg[$i]];
             $aCounts[$aLine[0]]++;
             $xVal = null;

-            if ($aLine[4] == $aLine[5])
-            {
-                if ($aLine[4])
-                {
+            if ($aLine[4] == $aLine[5]) {
+                if ($aLine[4]) {

                     $xVal = array();
                     $xVal = array();

-                    for($n = $aLine[4]; $i < $iSize && $n; $n--)
-                    {
+                    for ($n = $aLine[4]; $i < $iSize && $n; $n--) {

                         $i++;
                         if ($i >= $iSize || $aArg[$i][0] == '-') showUsage($aSpec, $bExitOnError, 'Parameter of  \''.$aLine[0].'\' is missing');
 
                         $i++;
                         if ($i >= $iSize || $aArg[$i][0] == '-') showUsage($aSpec, $bExitOnError, 'Parameter of  \''.$aLine[0].'\' is missing');
 

-                        switch ($aLine[6])
-                        {
-                        case 'realpath':
-                            $xVal[] = realpath($aArg[$i]);
-                            break;
-                        case 'realdir':
-                            $sPath = realpath(dirname($aArg[$i]));
-                            if ($sPath)
-                                $xVal[] = $sPath . '/' . basename($aArg[$i]);
-                            else
-                                $xVal[] = $sPath;
-                            break;
-                        case 'bool':
-                            $xVal[] = (bool)$aArg[$i];
-                            break;
-                        case 'int':
-                            $xVal[] = (int)$aArg[$i];
-                            break;
-                        case 'float':
-                            $xVal[] = (float)$aArg[$i];
-                            break;
-                        default:
-                            $xVal[] = $aArg[$i];
-                            break;
+                        switch ($aLine[6]) {
+                            case 'realpath':
+                                $xVal[] = realpath($aArg[$i]);
+                                break;
+                            case 'realdir':
+                                $sPath = realpath(dirname($aArg[$i]));
+                                if ($sPath) {
+                                    $xVal[] = $sPath . '/' . basename($aArg[$i]);
+                                } else {
+                                    $xVal[] = $sPath;
+                                }
+                                break;
+                            case 'bool':
+                                $xVal[] = (bool)$aArg[$i];
+                                break;
+                            case 'int':
+                                $xVal[] = (int)$aArg[$i];
+                                break;
+                            case 'float':
+                                $xVal[] = (float)$aArg[$i];
+                                break;
+                            default:
+                                $xVal[] = $aArg[$i];
+                                break;

                         }
                     }
                     if ($aLine[4] == 1) $xVal = $xVal[0];
                         }
                     }
                     if ($aLine[4] == 1) $xVal = $xVal[0];

-                }
-                else
-                {
+                } else {

                     $xVal = true;
                 }
                     $xVal = true;
                 }

-            }
-            else
-            {
+            } else {

                 fail('Variable numbers of params not yet supported');
             }
 
                 fail('Variable numbers of params not yet supported');
             }
 

-            if ($aLine[3] > 1)
-            {
+            if ($aLine[3] > 1) {

                 if (!array_key_exists($aLine[0], $aResult)) $aResult[$aLine[0]] = array();
                 $aResult[$aLine[0]][] = $xVal;
                 if (!array_key_exists($aLine[0], $aResult)) $aResult[$aLine[0]] = array();
                 $aResult[$aLine[0]][] = $xVal;

-            }
-            else
-            {
+            } else {

                 $aResult[$aLine[0]] = $xVal;
             }
                 $aResult[$aLine[0]] = $xVal;
             }

-        }
-        else
-        {
+        } else {

             $bUnknown = $aArg[$i];
         }
     }
             $bUnknown = $aArg[$i];
         }
     }


@@ -92,18 +78,15 @@ function getCmdOpt($aArg, $aSpec, &$aResult, $bExitOnError = false, $bExitOnUnkn
     if (array_key_exists('help', $aResult)) showUsage($aSpec);
     if ($bUnknown && $bExitOnUnknown) showUsage($aSpec, $bExitOnError, 'Unknown option \''.$bUnknown.'\'');
 
     if (array_key_exists('help', $aResult)) showUsage($aSpec);
     if ($bUnknown && $bExitOnUnknown) showUsage($aSpec, $bExitOnError, 'Unknown option \''.$bUnknown.'\'');
 

-    foreach($aSpec as $aLine)
-    {
-        if (is_array($aLine))
-        {
+    foreach ($aSpec as $aLine) {
+        if (is_array($aLine)) {

             if ($aCounts[$aLine[0]] < $aLine[2]) showUsage($aSpec, $bExitOnError, 'Option \''.$aLine[0].'\' is missing');
             if ($aCounts[$aLine[0]] > $aLine[3]) showUsage($aSpec, $bExitOnError, 'Option \''.$aLine[0].'\' is pressent too many times');
             if ($aCounts[$aLine[0]] < $aLine[2]) showUsage($aSpec, $bExitOnError, 'Option \''.$aLine[0].'\' is missing');
             if ($aCounts[$aLine[0]] > $aLine[3]) showUsage($aSpec, $bExitOnError, 'Option \''.$aLine[0].'\' is pressent too many times');

-            switch ($aLine[6])
-            {
-            case 'bool':
-                if (!array_key_exists($aLine[0], $aResult))
-                    $aResult[$aLine[0]] = false;
-                break;
+            switch ($aLine[6]) {
+                case 'bool':
+                    if (!array_key_exists($aLine[0], $aResult))
+                        $aResult[$aLine[0]] = false;
+                    break;

             }
         }
     }
             }
         }
     }


@@ -112,31 +95,25 @@ function getCmdOpt($aArg, $aSpec, &$aResult, $bExitOnError = false, $bExitOnUnkn
 
 function showUsage($aSpec, $bExit = false, $sError = false)
 {
 
 function showUsage($aSpec, $bExit = false, $sError = false)
 {

-    if ($sError)
-    {
+    if ($sError) {

         echo basename($_SERVER['argv'][0]).': '.$sError."\n";
         echo 'Try `'.basename($_SERVER['argv'][0]).' --help` for more information.'."\n";
         exit;
     }
         echo basename($_SERVER['argv'][0]).': '.$sError."\n";
         echo 'Try `'.basename($_SERVER['argv'][0]).' --help` for more information.'."\n";
         exit;
     }

-    echo "Usage: ".basename($_SERVER['argv'][0])."\n";
+    echo 'Usage: '.basename($_SERVER['argv'][0])."\n";

     $bFirst = true;
     $bFirst = true;

-    foreach($aSpec as $aLine)
-    {
-        if (is_array($aLine))
-        {
-            if ($bFirst)
-            {
+    foreach ($aSpec as $aLine) {
+        if (is_array($aLine)) {
+            if ($bFirst) {

                 $bFirst = false;
                 echo "\n";
             }
             $aNames = array();
             if ($aLine[1]) $aNames[] = '-'.$aLine[1];
             if ($aLine[0]) $aNames[] = '--'.$aLine[0];
                 $bFirst = false;
                 echo "\n";
             }
             $aNames = array();
             if ($aLine[1]) $aNames[] = '-'.$aLine[1];
             if ($aLine[0]) $aNames[] = '--'.$aLine[0];

-            $sName = join(', ',$aNames);
-            echo '  '.$sName.str_repeat(' ',30-strlen($sName)).$aLine[7]."\n";
-        }
-        else
-        {
+            $sName = join(', ', $aNames);
+            echo '  '.$sName.str_repeat(' ', 30-strlen($sName)).$aLine[7]."\n";
+        } else {

             echo $aLine."\n";
         }
     }
             echo $aLine."\n";
         }
     }


@@ -144,12 +121,105 @@ function showUsage($aSpec, $bExit = false, $sError = false)
     exit;
 }
 
     exit;
 }
 

-function chksql($oSql, $sMsg = false)
+function info($sMsg)
+{
+    echo date('Y-m-d H:i:s == ').$sMsg."\n";
+}
+
+$aWarnings = array();
+
+
+function warn($sMsg)
+{
+    $GLOBALS['aWarnings'][] = $sMsg;
+    echo date('Y-m-d H:i:s == ').'WARNING: '.$sMsg."\n";
+}
+
+
+function repeatWarnings()
+{
+    foreach ($GLOBALS['aWarnings'] as $sMsg) {
+        echo '  * ',$sMsg."\n";
+    }
+}
+
+
+function runSQLScript($sScript, $bfatal = true, $bVerbose = false, $bIgnoreErrors = false)
+{
+    // Convert database DSN to psql parameters
+    $aDSNInfo = \Nominatim\DB::parseDSN(CONST_Database_DSN);
+    if (!isset($aDSNInfo['port']) || !$aDSNInfo['port']) $aDSNInfo['port'] = 5432;
+
+    $oCmd = new \Nominatim\Shell('psql');
+    $oCmd->addParams('--port', $aDSNInfo['port']);
+    $oCmd->addParams('--dbname', $aDSNInfo['database']);
+    if (isset($aDSNInfo['hostspec']) && $aDSNInfo['hostspec']) {
+        $oCmd->addParams('--host', $aDSNInfo['hostspec']);
+    }
+    if (isset($aDSNInfo['username']) && $aDSNInfo['username']) {
+        $oCmd->addParams('--username', $aDSNInfo['username']);
+    }
+    if (isset($aDSNInfo['password'])) {
+        $oCmd->addEnvPair('PGPASSWORD', $aDSNInfo['password']);
+    }
+    if (!$bVerbose) {
+        $oCmd->addParams('--quiet');
+    }
+    if ($bfatal && !$bIgnoreErrors) {
+        $oCmd->addParams('-v', 'ON_ERROR_STOP=1');
+    }
+
+    $aDescriptors = array(
+                     0 => array('pipe', 'r'),
+                     1 => STDOUT,
+                     2 => STDERR
+                    );
+    $ahPipes = null;
+    $hProcess = @proc_open($oCmd->escapedCmd(), $aDescriptors, $ahPipes, null, $oCmd->aEnv);
+    if (!is_resource($hProcess)) {
+        fail('unable to start pgsql');
+    }
+
+    if (!$bVerbose) {
+        fwrite($ahPipes[0], 'set client_min_messages to WARNING;');
+    }
+
+    while (strlen($sScript)) {
+        $iWritten = fwrite($ahPipes[0], $sScript);
+        if ($iWritten <= 0) break;
+        $sScript = substr($sScript, $iWritten);
+    }
+    fclose($ahPipes[0]);
+    $iReturn = proc_close($hProcess);
+    if ($bfatal && $iReturn > 0) {
+        fail("pgsql returned with error code ($iReturn)");
+    }
+}
+
+function setupHTTPProxy()

 {
 {

-    if (PEAR::isError($oSql))
-    {
-        fail($sMsg || $oSql->getMessage(), $oSql->userinfo);
+    if (!CONST_HTTP_Proxy) {
+        return;

     }
 
     }
 

-    return $oSql;
+    $sProxy = 'tcp://'.CONST_HTTP_Proxy_Host.':'.CONST_HTTP_Proxy_Port;
+    $aHeaders = array();
+
+    if (CONST_HTTP_Proxy_Login != null
+        && CONST_HTTP_Proxy_Login != ''
+        && CONST_HTTP_Proxy_Password != null
+        && CONST_HTTP_Proxy_Password != ''
+    ) {
+        $sAuth = base64_encode(CONST_HTTP_Proxy_Login.':'.CONST_HTTP_Proxy_Password);
+        $aHeaders = array('Proxy-Authorization: Basic '.$sAuth);
+    }
+
+    $aProxyHeader = array(
+                     'proxy' => $sProxy,
+                     'request_fulluri' => true,
+                     'header' => $aHeaders
+                    );
+
+    $aContext = array('http' => $aProxyHeader, 'https' => $aProxyHeader);
+    stream_context_set_default($aContext);

 }
 }