X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fconsole%2Fclass_ConsoleTools.php;h=e43c96946aeb640280d95e675e96fd727c66ce24;hp=e00e757e8100211028ed9c0c16dc5051ae697420;hb=768cc231b262ebeaa5aec373d9b7d97cc6b6ac95;hpb=8c1bdfb7ad5d15f6d390b6c7b57e47aecac26a01 diff --git a/inc/classes/main/console/class_ConsoleTools.php b/inc/classes/main/console/class_ConsoleTools.php index e00e757e..e43c9694 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 - 2011 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 * @@ -77,16 +81,17 @@ class ConsoleTools extends BaseFrameworkSystem { } /** - * Aquires the IP address of this host by reading the /etc/hostname file and solving it + * Aquires the IP address of this host by reading the /etc/hostname file + * and solving it. It is now stored in configuration * - * @return $ip The resolved IP address + * @return void */ 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 @@ -99,66 +104,135 @@ 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']); } 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 - return $ip; + // Set it in configuration + FrameworkConfiguration::getSelfInstance()->setServerAddress($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 217.172.186.31. + * 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 and lightly rewritten from a user comment on php.net: + * 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 * - * @param $dest IP destination we should connect to - * @param $port Port destination we should connect to * @return $externalAddress The determined external IP address - * @throws InvalidSocketException If socket initialization wents wrong + * @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 function determineExternalIp ($dest = '217.172.186.31', $port = 80) { + public static function determineExternalIp () { + // Get helper instance + $helperInstance = new ConsoleTools(); + // First get a socket - $socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP); - if (!is_resource($socket)) { - // Throw InvalidSocketException - throw new InvalidSocketException (array($this, gettype($socket), 0, 'unknown')); + // @TODO Add some DNS caching here + $socketResource = fsockopen('188.138.90.169', 80, $errorNo, $errorStr, 5); + + // Check if there was an error else + if ($errorNo > 0) { + // Then throw again + throw new InvalidSocketException(array($helperInstance, gettype($socketResource), $errorNo, $errorStr), BaseListener::EXCEPTION_INVALID_SOCKET); } // END - if - // Connect to the destination - socket_connect($socket, $dest, $port); + // Prepare the GET request + $request = 'GET /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; + $request .= self::HTTP_EOL; + + // Send it to the socket + fwrite($socketResource, $request); - // Get the socket address (our external IP) and port (ignored) - socket_getsockname($socket, $externalAddress, $ourPort); + // Init IP (this will always be the last line) + $externalAddress = 'invalid'; - // Close the socket - socket_close($socket); + // And read the reply + while (!feof($socketResource)) { + $externalAddress = fgets($socketResource, 128); + } // END - while + + // Close socket + fclose($socketResource); // 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]