X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fconsole%2Fclass_ConsoleTools.php;h=0dd5b93c5778533a085b3ac47a1e7926dda67b1f;hp=2dfe18ff9da8feef36ceb7f16330fe52c51e0e0c;hb=646c12d4e35593ac1d515066cda7f1833f368722;hpb=3ff00f264808bccde553b75fcd976cd47790d719 diff --git a/inc/classes/main/console/class_ConsoleTools.php b/inc/classes/main/console/class_ConsoleTools.php index 2dfe18ff..0dd5b93c 100644 --- a/inc/classes/main/console/class_ConsoleTools.php +++ b/inc/classes/main/console/class_ConsoleTools.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -22,6 +22,10 @@ * along with this program. If not, see . */ class ConsoleTools extends BaseFrameworkSystem { + // Constants + const HTTP_EOL = "\r\n"; + const HTTP_USER_AGENT = 'ConsoleTools/1.0'; + /** * Protected constructor * @@ -38,10 +42,11 @@ class ConsoleTools extends BaseFrameworkSystem { * * @param $hostname Host name we shall resolve * @return $ip IP address resolved from host name + * @todo We should connect this to a caching class to cache DNS requests */ protected function resolveIpAddress ($hostname) { // Debug message - $this->debugOutput(sprintf("[%s:] Our host name is: %s", + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] Host name to resolve is: %s', $this->__toString(), $hostname )); @@ -50,6 +55,7 @@ class ConsoleTools extends BaseFrameworkSystem { $ip = '0.0.0.0'; // Resolve it + // @TODO Here should the cacher be implemented $ipResolved = gethostbyname($hostname); // Was it fine? @@ -58,31 +64,104 @@ class ConsoleTools extends BaseFrameworkSystem { $ip = $ipResolved; // Debug message - $this->debugOutput(sprintf("[%s:] Resolved IP address is: %s\n", + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] Resolved IP address is: %s', $this->__toString(), $ip )); - } // END - if + } else { + // Problem while resolving IP address + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] Problem resolving IP address for host %s. Please check your /etc/hosts file.', + $this->__toString(), + $hostname + )); + } // Return resolved IP return $ip; } /** - * Aquires the IP address of this host by reading the /etc/hostname file and solving it + * Checks wether proxy configuration is used * - * @return $ip The resolved IP address + * @return $isUsed Wether proxy is used + */ + protected function isProxyUsed () { + // Do we have cache? + if (!isset($GLOBALS[__METHOD__])) { + // Determine it + $GLOBALS[__METHOD__] = (($this->getConfigInstance()->getConfigEntry('proxy_host') != '') && ($this->getConfigInstance()->getConfigEntry('proxy_port') > 0)); + } // END - if + + // Return cache + return $GLOBALS[__METHOD__]; + } + + /** + * Sets up a proxy tunnel for given hostname and through resource + * + * @param $host Host to connect to + * @param $port Port number to connect to + * @param $socketResource Resource of a socket + * @return $response Response array + */ + protected function setupProxyTunnel ($host, $port, $socketResource) { + // Initialize array + $response = array('', '', ''); + $proxyTunnel = ''; + + // Generate CONNECT request header + $proxyTunnel .= 'CONNECT ' . $host . ':' . $port . ' HTTP/1.1' . self::HTTP_EOL; + $proxyTunnel .= 'Host: ' . $host . ':' . $port . self::HTTP_EOL; + $proxyTunnel .= 'Proxy-Connection: Keep-Alive' . self::HTTP_EOL; + + // Use login data to proxy? (username at least!) + if ($this->getConfigInstance()->getConfigEntry('proxy_username') != '') { + // Add it as well + $encodedAuth = base64_encode($this->getConfigInstance()->getConfigEntry('proxy_username') . ':' . $this->getConfigInstance()->getConfigEntry('proxy_password')); + $proxyTunnel .= 'Proxy-Authorization: Basic ' . $encodedAuth . self::HTTP_EOL; + } // END - if + + // Add last new-line + $proxyTunnel .= self::HTTP_EOL; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONSOLE-TOOLS: proxyTunnel=' . $proxyTunnel); + + // Write request + fwrite($socketResource, $proxyTunnel); + + // Got response? + if (feof($socketResource)) { + // No response received + return $response; + } // END - if + + // Read the first line + $resp = trim(fgets($socketResource, 10240)); + $respArray = explode(' ', $resp); + if (((strtolower($respArray[0]) !== 'http/1.0') && (strtolower($respArray[0]) !== 'http/1.1')) || ($respArray[1] != '200')) { + // Invalid response! + return $response; + } // END - if + + // All fine! + return $respArray; + } + + /** + * Aquires the IP address of this host by reading the /etc/hostname file + * and solving it. It is now stored in configuration + * + * @return $ip Aquired IP address */ public static function acquireSelfIPAddress () { // Local IP by default $ip = '127.0.0.1'; // Get a new instance - $helper = new ConsoleTools(); + $helperInstance = new ConsoleTools(); try { // Get a file pointer - $io = FrameworkFileInputPointer::createFrameworkFileInputPointer('/etc/hostname'); + $io = FrameworkFileInputPointer::createFrameworkFileInputPointer($helperInstance->getConfigEntry('hostname_file')); // Read the file $hostname = trim($io->readFromFile()); @@ -91,31 +170,183 @@ class ConsoleTools extends BaseFrameworkSystem { $io->closeFile(); // Resolve the IP number - $ip = $helper->resolveIpAddress($hostname); - } catch (FileNotFoundException $e) { + $ip = $helperInstance->resolveIpAddress($hostname); + } catch (FileIoException $e) { // Fall-back to 'SESSION_SVR' which found on my Sun Station if (isset($_SERVER['SESSION_SVR'])) { // Resolve it - $ip = $helper->resolveIpAddress($_SERVER['SESSION_SVR']); + $ip = $helperInstance->resolveIpAddress($_SERVER['SESSION_SVR']); + } elseif (isset($_SERVER['COMPUTERNAME'])) { + // May happen on some XP systems, so also try this + $ip = $helperInstance->resolveIpAddress($_SERVER['COMPUTERNAME']); } else { // Could not find our hostname - $helper->debugOutput(sprintf("[%s:] WARNING: Cannot resolve my own IP address.", - $helper->__toString() + $helperInstance->debugOutput(sprintf('[%s:] WARNING: Cannot resolve my own IP address.', + $helperInstance->__toString() )); } } catch (FrameworkException $e) { // Output debug message - $helper->debugOutput(sprintf("[%s:] Problem while resolving own IP address: [%s|%s]:%s", - $helper->__toString(), + $helperInstance->debugOutput(sprintf('[%s:] Problem while resolving own IP address: [%s|%s]:%s', + $helperInstance->__toString(), $e->__toString(), $e->getHexCode(), $e->getMessage() )); } - // Return the IP address + // Set it in configuration + FrameworkConfiguration::getSelfInstance()->setServerAddress($ip); + + // Return it return $ip; } + + /** + * Determines own remote IP address (e.g. can be used to probe if we are + * reachable from outside by determining external IP and then connect to it. + * This is accomblished by connecting to the IP of www.ship-simu.org which + * should default to 188.138.90.169 and requesting /ip.php which does only + * return the content of $_SERVER['REMOTE_ADDR']. Of course, this method + * requires a working Internet connection. + * + * This method is taken from a user comment on php.net and heavily rewritten. + * Compare to following link: + * http://de.php.net/manual/en/function.socket-create.php#49368 + * + * @return $externalAddress The determined external IP address + * @throws InvalidSocketException If socket initialization wents wrong or if an errors occurs + * @todo This should be moved out to an external class, e.g. HttpClient + * @todo Make IP, host name, port and script name configurable + */ + public static function determineExternalIp () { + // Get helper instance + $helperInstance = new ConsoleTools(); + + // First get a socket + // @TODO Add some DNS caching here + + // Open connection + if ($helperInstance->isProxyUsed() === true) { + // Resolve hostname into IP address + $ip = $helperInstance->resolveIpAddress($helperInstance->getConfigInstance()->getConfigEntry('proxy_host')); + + // Connect to host through proxy connection + $socketResource = fsockopen($ip, $helperInstance->getConfigInstance()->getConfigEntry('proxy_port'), $errorNo, $errorStr, 30); + } else { + // Connect to host directly + $socketResource = fsockopen('188.138.90.169', 80, $errorNo, $errorStr, 30); + } + + // Check if there was an error else + if ($errorNo > 0) { + // Then throw again + throw new InvalidSocketException(array($helperInstance, $socketResource, $errorNo, $errorStr), BaseListener::EXCEPTION_INVALID_SOCKET); + } // END - if + + // Prepare the GET request + $request = 'GET ' . ($helperInstance->isProxyUsed() === true ? 'http://ship-simu.org' : '') . '/ip.php HTTP/1.0' . self::HTTP_EOL; + $request .= 'Host: ship-simu.org' . self::HTTP_EOL; + $request .= 'User-Agent: ' . self::HTTP_USER_AGENT . self::HTTP_EOL; + $request .= 'Connection: close' . self::HTTP_EOL; + + // Do we use proxy? + if ($helperInstance->isProxyUsed() === true) { + // CONNECT method? + if ($helperInstance->getConfigInstance()->getConfigEntry('proxy_connect_method') == 'Y') { + // Setup proxy tunnel + $response = $helperInstance->setupProxyTunnel('ship-simu.org', 80, $socketResource); + + // If the response is invalid, abort + if ((count($response) == 3) && (empty($response[0])) && (empty($response[1])) && (empty($response[2]))) { + // Invalid response! + $helperInstance->debugBackTrace('Proxy tunnel not working: response=' . print_r($response, true)); + } // END - if + } else { + // Add header for proxy + $request .= 'Proxy-Connection: Keep-Alive' . self::HTTP_EOL; + } + } // END - if + + // Add last HTTP_EOL + $request .= self::HTTP_EOL; + + // Send it to the socket + fwrite($socketResource, $request); + + // Init IP (this will always be the last line) + $externalAddress = 'invalid'; + + // And read the reply + while (!feof($socketResource)) { + // Get line + $externalAddress = trim(fgets($socketResource, 128)); + + // Detect HTTP response + if ((substr($externalAddress, 0, 7) == 'HTTP/1.') && (substr($externalAddress, -6, 6) != '200 OK')) { + // Stop processing + break; + } // END - if + } // END - while + + // Close socket + fclose($socketResource); + + + // Debug message + /* DEBUG: */ $helperInstance->debugOutput('CONSOLE-TOOLS: Resolved external address: ' . $externalAddress); + + // Return determined external IP + return $externalAddress; + } + + /** + * Analyzes the 'environment', mostly $_SERVER, for presence of elements + * which indicates clearly that e.g. this script has been executed from + * console or web. + * + * @return $type The analyzed type, can be 'http' or 'console' + */ + public static function analyzeEnvironmentForType () { + // Default is the console + $type = 'console'; + + // Now, do we have a request method, or query string set? + if ((isset($_SERVER['REQUEST_METHOD'])) || (isset($_SERVER['QUERY_STRING']))) { + // Possibly HTTP request + $type = 'http'; + } // END - if + + // Return it + return $type; + } + + /** + * Analyzes the 'environment', mostly $_SERVER, for presence of elements + * which indicates clearly that e.g. this script has been executed from + * console or web. This method should be used for class names, they + * currently are named differently. Here is a list to clarify this: + * + * Request type | Class type + * ----------------------------- + * http | web + * console | console + * + * @return $type The analyzed type, can be 'http' or 'console' + */ + public static function analyzeEnvironmentForClassType () { + // Default is the console + $type = 'console'; + + // Now, do we have a request method, or query string set? + if ((isset($_SERVER['REQUEST_METHOD'])) || (isset($_SERVER['QUERY_STRING']))) { + // Possibly HTTP request + $type = 'web'; + } // END - if + + // Return it + return $type; + } } // [EOF]