application/hub/main/tools/class_HubTools.php

   1 <?php
   2 /**
   3  * This class contains static helper functions for our hub
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class HubTools extends BaseHubSystem {
  25         // Constants for exceptions
  26         const EXCEPTION_SESSION_ID_IS_INVALID = 0x200;
  27         const EXCEPTION_HOSTNAME_NOT_FOUND    = 0x201;
  28
  29         /**
  30          * Cache for session ids
  31          */
  32         private $sessionIdCache = array();
  33
  34         /**
  35          * Length for session id (should be 32+salt_length
  36          */
  37         private $sessionIdLength = 0;
  38
  39         /**
  40          * Self instance
  41          */
  42         private static $selfInstance = NULL;
  43
  44         /**
  45          * Protected constructor
  46          *
  47          * @return      void
  48          */
  49         protected function __construct () {
  50                 // Call parent constructor
  51                 parent::__construct(__CLASS__);
  52
  53                 // Init salt length
  54                 $this->sessionIdLength = 32 + $this->getConfigInstance()->getConfigEntry('salt_length');
  55         }
  56
  57         /**
  58          * Singleton getter for self instance
  59          *
  60          * @retuen      $selfInstance   An instance of this class
  61          */
  62         public static final function getSelfInstance () {
  63                 // Is the instance set
  64                 if (is_null(self::$selfInstance)) {
  65                         // Then set it
  66                         self::$selfInstance = new HubTools();
  67                 } // END - if
  68
  69                 // Return own instance
  70                 return self::$selfInstance;
  71         }
  72
  73         /**
  74          * Getter for session id length
  75          *
  76          * @return      $sessionIdLength        Length of session ids
  77          */
  78         protected final function getSessionIdLength () {
  79                 return $this->sessionIdLength;
  80         }
  81
  82         /**
  83          * Resolves a session id into an ip:port combination
  84          *
  85          * @param       $sessionId      A valid session id
  86          * @param       $protocol       Name of the used protocol: TCP/UDP
  87          * @return      $recipient      Recipient as ip:port combination
  88          */
  89         protected function resolveIpPortBySessionId ($sessionId, $protocol) {
  90                 // Get a wrapper instance
  91                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_list_db_wrapper_class');
  92
  93                 // And ask it for the session id
  94                 $recipient = $wrapperInstance->resolveIpPortBySessionId($sessionId, $protocol);
  95
  96                 // Is the recipient invalid?
  97                 if ($recipient == 'invalid:invalid') {
  98                         // Get the instance, this might throw a NPE
  99                         $nodeInstance = Registry::getRegistry()->getInstance('node');
 100
 101                         // Is the session id the same?
 102                         if ($nodeInstance->getSessionId() == $sessionId) {
 103                                 // Then get the ip:port from it, assume TCP by default
 104                                 $recipient = self::determineOwnExternalIp() . ':' . $nodeInstance->getConfigInstance()->getConfigEntry('node_' . strtolower($protocol) . '_listen_port');
 105                         } // END - if
 106                 } // END - if
 107
 108                 // Return result
 109                 return $recipient;
 110         }
 111
 112         /**
 113          * Resolves a ip:port combination into a session id
 114          *
 115          * @param       $ipPort         Ip:port combination
 116          * @param       $protocol       Name of used protocol (TCP/UDP)
 117          * @return      $sessionId      Valid session id
 118          */
 119         public static function resolveSessionIdByIpPort ($ipPort, $protocol) {
 120                 // Get a wrapper instance
 121                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_list_db_wrapper_class');
 122
 123                 // And ask it for the session id
 124                 $sessionId = $wrapperInstance->resolveSessionIdByIpPort($ipPort, $protocol);
 125
 126                 // Return result
 127                 return $sessionId;
 128         }
 129
 130         /**
 131          * Resolves given session id into an ip:port combination, if ip:port is set, it won't be translated
 132          *
 133          * @param       $sessionId      Session id or ip:port combination
 134          * @param       $protocol       Name of the used protocol (TCP/UDP)
 135          * @return      $recipient      Recipient as ip:port combination
 136          * @throws      InvalidSessionIdException       If the provided session id is invalid (and no ip:port combination)
 137          * @throws      NoValidHostnameException        If the provided hostname cannot be resolved into an IP address
 138          */
 139         public static function resolveSessionId ($sessionId, $protocol) {
 140                 // Get an own instance
 141                 $selfInstance = self::getSelfInstance();
 142
 143                 // Default is direct ip:port
 144                 $recipient = $sessionId;
 145
 146                 // Does it match a direct ip:port? (hint: see www.regexlib.com for the regular expression)
 147                 if (preg_match('/((25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9])\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[0-9])):([0-9]{3,5})/', $sessionId)) {
 148                         // Direct ip:port found
 149                         $selfInstance->debugOutput('HUB-TOOLS: Direct ip:port ' . $sessionId . ' detected.');
 150                 } elseif (isset($selfInstance->sessionIdCache[$sessionId])) {
 151                         // Debug message
 152                         $selfInstance->debugOutput('HUB-TOOLS: Using entry from sessionIdCache[] array.');
 153
 154                         // Found in cache!
 155                         $recipient = $selfInstance->sessionIdCache[$sessionId];
 156
 157                         // Debug message
 158                         $selfInstance->debugOutput('HUB-TOOLS: sessionIdCache[' . $sessionId . ']=' . $recipient);
 159                 } 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)) {
 160                         // Hostname:port found
 161                         $selfInstance->debugOutput('HUB-TOOLS: hostname:port ' . $sessionId . ' detected.');
 162
 163                         // Hostname:port found
 164                         $hostnameArray = explode(':', $sessionId);
 165
 166                         // Try to resolve it and add port again
 167                         // @TODO Please try to encapsulate this PHP call into an own class
 168                         $recipient = gethostbyname($hostnameArray[0]) . ':' . $hostnameArray[1];
 169
 170                         // Is it valid?
 171                         if ($recipient == $sessionId) {
 172                                 // Resolving hostname->IP failed!
 173                                 throw new NoValidHostnameException($hostnameArray, self::EXCEPTION_HOSTNAME_NOT_FOUND);
 174                         } // END - if
 175
 176                         // Debug message
 177                         $selfInstance->debugOutput('HUB-TOOLS: hostname:port ' . $sessionId . ' resolved to ' . $recipient);
 178                 } elseif (preg_match('/([a-f0-9]{' . $selfInstance->getSessionIdLength() . '})/', $sessionId)) {
 179                         // Debug message
 180                         $selfInstance->debugOutput('HUB-TOOLS: Using internal session id resolver.');
 181
 182                         // Resolve session id into a ip:port combination
 183                         $recipient = $selfInstance->resolveIpPortBySessionId($sessionId, $protocol);
 184
 185                         // Debug message
 186                         $selfInstance->debugOutput('HUB-TOOLS: session id ' . $sessionId . ' resolved to ' . $recipient);
 187                 } else {
 188                         // Invalid session id
 189                         throw new InvalidSessionIdException($sessionId, self::EXCEPTION_SESSION_ID_IS_INVALID);
 190                 }
 191
 192                 // Return it
 193                 return $recipient;
 194         }
 195
 196         /**
 197          * Determine IP or 'external_ip' if set
 198          *
 199          * @return      $ip             The determined external ip of this node
 200          */
 201         public static function determineOwnExternalIp () {
 202                 // Is the external_ip config entry set?
 203                 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip') != '') {
 204                         // Use it as external ip
 205                         $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip');
 206                 } else {
 207                         // Determine own external ip by connecting to my (coder) server at 188.138.90.169
 208                         $ip = ConsoleTools::determineExternalIp();
 209                 }
 210
 211                 // Return it
 212                 return $ip;
 213         }
 214
 215         /**
 216          * Determine IP or 'internal_ip' if set
 217          *
 218          * @return      $ip             The determined external ip of this node
 219          */
 220         public static function determineOwnInternalIp () {
 221                 // Is the internal_ip config entry set?
 222                 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('allow_publish_internal_ip') == 'N') {
 223                         // Not allowed to publish internal IP, so use external
 224                         $ip = self::determineOwnExternalIp();
 225                 } elseif (FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_ip') != '') {
 226                         // Use it as internal ip
 227                         $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_ip');
 228                 } else {
 229                         // Determine own internal ip by connecting to my (coder) server at 188.138.90.169
 230                         $ip = ConsoleTools::acquireSelfIPAddress();
 231                 }
 232
 233                 // Return it
 234                 return $ip;
 235         }
 236 }
 237
 238 // [EOF]
 239 ?>