Some comments improved #2

[hub.git] / application / hub / main / tools / class_HubTools.php

diff --git a/application/hub/main/tools/class_HubTools.php b/application/hub/main/tools/class_HubTools.php
index 4c439ffe0fe159bdcb6ae01e87c5a53eac014657..855a59210ba76a55f50dd65623c5d65aac0531f4 100644 (file)
--- a/application/hub/main/tools/class_HubTools.php
+++ b/application/hub/main/tools/class_HubTools.php
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class HubTools extends BaseFrameworkSystem {
+class HubTools extends BaseHubSystem {
        // Constants for exceptions
        const EXCEPTION_SESSION_ID_IS_INVALID = 0x200;
        const EXCEPTION_HOSTNAME_NOT_FOUND    = 0x201;
@@ -59,7 +59,7 @@ class HubTools extends BaseFrameworkSystem {
         *
         * @retuen      $selfInstance   An instance of this class
         */
-       public static final function getInstance () {
+       public static final function getSelfInstance () {
                // Is the instance set
                if (is_null(self::$selfInstance)) {
                        // Then set it
@@ -108,6 +108,23 @@ class HubTools extends BaseFrameworkSystem {
                return $recipient;
        }
 
+       /**
+        * Resolves a ip:port combination into a session id
+        *
+        * @param       $ipPort         Ip:port combination
+        * @return      $sessionId      Valid session id
+        */
+       public static function resolveSessionIdByIpPort ($ipPort) {
+               // Get a wrapper instance
+               $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_list_db_wrapper_class');
+
+               // And ask it for the session id
+               $sessionId = $wrapperInstance->resolveSessionIdByIpPort($ipPort);
+
+               // Return result
+               return $sessionId;
+       }
+
        /**
         * Resolves given session id into an ip:port combination, if ip:port is set, it won't be translated
         *
@@ -118,7 +135,7 @@ class HubTools extends BaseFrameworkSystem {
         */
        public static function resolveSessionId ($sessionId) {
                // Get an own instance
-               $selfInstance = self::getInstance();
+               $selfInstance = self::getSelfInstance();
 
                // Default is direct ip:port
                $recipient = $sessionId;
@@ -133,12 +150,18 @@ class HubTools extends BaseFrameworkSystem {
 
                        // Found in cache!
                        $recipient = $selfInstance->sessionIdCache[$sessionId];
+
+                       // Debug message
+                       $selfInstance->debugOutput('HUB-TOOLS: sessionIdCache[' . $sessionId . ']=' . $recipient);
                } elseif (preg_match('/([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}:([0-9]{3,5})/', $sessionId)) {
+                       // Hostname:port found
+                       $selfInstance->debugOutput('HUB-TOOLS: hostname:port ' . $sessionId . ' detected.');
+
                        // Hostname:port found
                        $hostnameArray = explode(':', $sessionId);
 
                        // Try to resolve it and add port again
-                       // @TODO We may want to encapsulate this PHP call into an own class
+                       // @TODO Please try to encapsulate this PHP call into an own class
                        $recipient = gethostbyname($hostnameArray[0]) . ':' . $hostnameArray[1];
 
                        // Is it valid?
@@ -146,20 +169,23 @@ class HubTools extends BaseFrameworkSystem {
                                // Resolving hostname->IP failed!
                                throw new NoValidHostnameException($hostnameArray, self::EXCEPTION_HOSTNAME_NOT_FOUND);
                        } // END - if
+
+                       // Debug message
+                       $selfInstance->debugOutput('HUB-TOOLS: hostname:port ' . $sessionId . ' resolved to ' . $recipient);
                } elseif (preg_match('/([a-f0-9]{' . $selfInstance->getSessionIdLength() . '})/', $sessionId)) {
                        // Debug message
                        $selfInstance->debugOutput('HUB-TOOLS: Using internal session id resolver.');
 
                        // Resolve session id into a ip:port combination
                        $recipient = $selfInstance->resolveIpPortBySessionId($sessionId);
+
+                       // Debug message
+                       $selfInstance->debugOutput('HUB-TOOLS: session id ' . $sessionId . ' resolved to ' . $recipient);
                } else {
                        // Invalid session id
                        throw new InvalidSessionIdException($sessionId, self::EXCEPTION_SESSION_ID_IS_INVALID);
                }
 
-               // Output message
-               $selfInstance->debugOutput('HUB-TOOLS: Session id ' . $sessionId . ' resolved to ' . $recipient);
-
                // Return it
                return $recipient;
        }
@@ -171,9 +197,9 @@ class HubTools extends BaseFrameworkSystem {
         */
        public static function determineOwnExternalIp () {
                // Is the external_ip config entry set?
-               if (FrameworkConfiguration::getInstance()->getConfigEntry('external_ip') != '') {
+               if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip') != '') {
                        // Use it as external ip
-                       $ip = FrameworkConfiguration::getInstance()->getConfigEntry('external_ip');
+                       $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip');
                } else {
                        // Determine own external ip by connecting to my (coder) server at 188.138.90.169
                        $ip = ConsoleTools::determineExternalIp();