Message added when no hostname resolved into an IP
[core.git] / inc / classes / main / console / class_ConsoleTools.php
index 1cba2f1c1686baea16621cf96e51d01bd30ac6f0..e00e757e8100211028ed9c0c16dc5051ae697420 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -32,51 +32,133 @@ class ConsoleTools extends BaseFrameworkSystem {
                parent::__construct(__CLASS__);
        }
 
+       /**
+        * Tries to resolve an IP address from given hostname. Currently only IPv
+        * addresses are resolved.
+        *
+        * @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: <span class=\"data\">%s</span>",
+                       $this->__toString(),
+                       $hostname
+               ));
+
+               // Default is an invalid one
+               $ip = '0.0.0.0';
+
+               // Resolve it
+               // @TODO Here should the cacher be implemented
+               $ipResolved = gethostbyname($hostname);
+
+               // Was it fine?
+               if (($ipResolved !== false) && ($ipResolved != $hostname)) {
+                       // Okay, this works!
+                       $ip = $ipResolved;
+
+                       // Debug message
+                       $this->debugOutput(sprintf("[%s:] Resolved IP address is: <span class=\"data\">%s</span>\n",
+                               $this->__toString(),
+                               $ip
+                       ));
+               } else {
+                       // Problem while resolving IP address
+                       $this->debugOutput(sprintf("[%s:] Problem resolving IP address for host <span class=\"data\">%s</span>. 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
         *
         * @return      $ip             The resolved IP address
         */
-       public static function aquireSelfIPAddress () {
+       public static function acquireSelfIPAddress () {
                // Local IP by default
-               $ip = "127.0.0.1";
+               $ip = '127.0.0.1';
 
                // Get a new instance
                $helper = new ConsoleTools();
 
                try {
                        // Get a file pointer
-                       $io = FrameworkFileInputPointer::createFrameworkFileInputPointer("/etc/hostname");
+                       $io = FrameworkFileInputPointer::createFrameworkFileInputPointer('/etc/hostname');
 
                        // Read the file
                        $hostname = trim($io->readFromFile());
-                       $helper->debugOutput(sprintf("[%s:] Our host name is: <span class=\"data\">%s</span>",
-                               $helper->__toString(),
-                               $hostname
-                       ));
 
                        // Close the file
                        $io->closeFile();
 
-                       // Resolve it
-                       $ipResolved = gethostbyname($hostname);
-                       if (($ipResolved !== false) && ($ipResolved != $hostname)) {
-                               // Okay, this works!
-                               $ip = $ipResolved;
-
-                               // Debug message
-                               $helper->debugOutput(sprintf("[%s:] Resolved IP address is: <span class=\"data\">%s</span>\n",
-                                       $helper->__toString(),
-                                       $ip
+                       // Resolve the IP number
+                       $ip = $helper->resolveIpAddress($hostname);
+               } catch (FileNotFoundException $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']);
+                       } else {
+                               // Could not find our hostname
+                               $helper->debugOutput(sprintf("[%s:] WARNING: Cannot resolve my own IP address.",
+                                       $helper->__toString()
                                ));
                        }
                } catch (FrameworkException $e) {
-                       // Do nothing here
+                       // Output debug message
+                       $helper->debugOutput(sprintf("[%s:] Problem while resolving own IP address: [%s|%s]:%s",
+                               $helper->__toString(),
+                               $e->__toString(),
+                               $e->getHexCode(),
+                               $e->getMessage()
+                       ));
                }
 
                // Return the IP address
                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 217.172.186.31.
+        *
+        * This method is taken and lightly rewritten from a user comment on php.net:
+        * 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
+        */
+       public function determineExternalIp ($dest = '217.172.186.31', $port = 80) {
+               // 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'));
+               } // END - if
+
+               // Connect to the destination
+               socket_connect($socket, $dest, $port);
+
+               // Get the socket address (our external IP) and port (ignored)
+               socket_getsockname($socket, $externalAddress, $ourPort);
+
+               // Close the socket
+               socket_close($socket);
+
+               // Return determined external IP
+               return $externalAddress;
+       }
 }
 
 // [EOF]