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@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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                 // Get a DHT instance
  54                 $dhtInstance = DhtObjectFactory::createDhtInstance('node');
  55
  56                 // Set it here
  57                 $this->setDhtInstance($dhtInstance);
  58
  59                 // Init salt length
  60                 $this->sessionIdLength = 32 + $this->getConfigInstance()->getConfigEntry('salt_length');
  61         }
  62
  63         /**
  64          * Singleton getter for self instance
  65          *
  66          * @retuen      $selfInstance   An instance of this class
  67          */
  68         public static final function getSelfInstance () {
  69                 // Is the instance set
  70                 if (is_null(self::$selfInstance)) {
  71                         // Then set it
  72                         self::$selfInstance = new HubTools();
  73                 } // END - if
  74
  75                 // Return own instance
  76                 return self::$selfInstance;
  77         }
  78
  79         /**
  80          * Getter for session id length
  81          *
  82          * @return      $sessionIdLength        Length of session ids
  83          */
  84         protected final function getSessionIdLength () {
  85                 return $this->sessionIdLength;
  86         }
  87
  88         /**
  89          * Resolves a session id into an instance of a LocateableNode class. The opposite method
  90          * is resolveSessionIdByUniversalNodeLocator()
  91          *
  92          * @param       $sessionId                      A valid session id
  93          * @return      $recipientUniversalNodeLocator  Recipient as Universal Node Locator
  94          */
  95         protected function resolveUniversalNodeLocatorBySessionId ($sessionId) {
  96                 // Init variable
  97                 die(__METHOD__ . ': Unfinished' . PHP_EOL);
  98                 $recipientUniversalNodeLocator = 'invalid://invalid:invalid';
  99
 100                 // And ask it for Universal Node Locator by given session id
 101                 $recipient = $this->getDhtInstance()->findNodeLocalBySessionId($sessionId);
 102
 103                 // Is the recipient valid?
 104                 if (isset($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_ADDRESS])) {
 105                         // Then use this
 106                         $recipientUniversalNodeLocator = $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_ADDRESS];
 107                 } else {
 108                         // Get the instance, this might throw a NPE
 109                         $nodeInstance = NodeObjectFactory::createNodeInstance();
 110
 111                         // Is the session id the same?
 112                         if ($nodeInstance->getSessionId() == $sessionId) {
 113                                 // Then get an instance of a LocateableNode class from it, assume TCP by default
 114                                 $recipientUniversalNodeLocator = self::determineOwnExternalAddress() . ':' . $nodeInstance->getConfigInstance()->getConfigEntry('node_listen_port');
 115                         } // END - if
 116                 }
 117
 118                 // Return result
 119                 return $recipientUniversalNodeLocator;
 120         }
 121
 122         /**
 123          * Resolves a Universal Node Locator into a session id. The "opposite" method
 124          * is resolveUniversalNodeLocatorBySessionId().
 125          *
 126          * @param       $unlInstance    Universal Node Locator
 127          * @return      $sessionId              Valid session id
 128          */
 129         public static function resolveSessionIdByUniversalNodeLocator (LocateableNode $unlInstance) {
 130                 // Get an own instance
 131                 $selfInstance = self::getSelfInstance();
 132
 133                 // And ask it for session id by given Universal Node Locator
 134                 $recipient = $selfInstance->getDhtInstance()->findNodeByUniversalNodeLocator($unlInstance);
 135                 die(__METHOD__.':recipient='.print_r($recipient, TRUE));
 136
 137                 // Return result
 138                 return $sessionId;
 139         }
 140
 141         /**
 142          * Resolves given session id into an instance of a LocateableNode class, if Universal Node Locator is set, it won't be translated
 143          *
 144          * @param       $address        Session id or Universal Node Locator
 145          * @return      $recipient      Recipient as Universal Node Locator
 146          * @throws      InvalidSessionIdException       If the provided session id is invalid (and no Universal Node Locator)
 147          * @throws      NoValidHostnameException        If the provided hostname cannot be resolved into an IP address
 148          */
 149         public static function resolveSessionId ($address) {
 150                 // Get an own instance
 151                 $selfInstance = self::getSelfInstance();
 152
 153                 // Default is direct Universal Node Locator
 154                 $recipient = $address;
 155
 156                 // Does it match a direct Universal Node Locator? (hint: see www.regexlib.com for the regular expression)
 157                 if (preg_match('/([a-z0-9]{3,10})\/\/:([a-z0-9\.]{5,})/', $address)) {
 158                         // @TODO ((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})
 159                         // Direct Universal Node Locator found
 160                         self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Direct Universal Node Locator ' . $address . ' detected.');
 161                 } elseif (isset($selfInstance->sessionIdCache[$address])) {
 162                         // Debug message
 163                         self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Using entry from sessionIdCache[] array.');
 164
 165                         // Found in cache!
 166                         $recipient = $selfInstance->sessionIdCache[$address];
 167
 168                         // Debug message
 169                         self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: sessionIdCache[' . $address . ']=' . $recipient);
 170                 } elseif (preg_match('/([a-f0-9]{' . $selfInstance->getSessionIdLength() . '})/', $address)) {
 171                         // Debug message
 172                         self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Using internal session id resolver.');
 173
 174                         // Resolve session id into an instance of a LocateableNode class
 175                         $recipient = $selfInstance->resolveUniversalNodeLocatorBySessionId($address);
 176
 177                         // Debug message
 178                         self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Session id ' . $address . ' resolved to ' . $recipient);
 179                 } else {
 180                         // Invalid session id/UNL
 181                         throw new InvalidSessionIdException($address, self::EXCEPTION_SESSION_ID_IS_INVALID);
 182                 }
 183
 184                 // Return it
 185                 return $recipient;
 186         }
 187
 188         /**
 189          * Determine IP or 'external_address' if set
 190          *
 191          * @return      $ip             The determined external address of this node
 192          */
 193         public static function determineOwnExternalAddress () {
 194                 // Is the external_address config entry set?
 195                 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_address') != '') {
 196                         // Use it as external address
 197                         $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_address');
 198                 } else {
 199                         // Determine own external address by connecting to my (coder) server at 188.138.90.169
 200                         $ip = ConsoleTools::determineExternalAddress();
 201                 }
 202
 203                 // Return it
 204                 return $ip;
 205         }
 206
 207         /**
 208          * Determine IP or 'internal_address' if set
 209          *
 210          * @return      $ip             The determined external address of this node
 211          */
 212         public static function determineOwnInternalAddress () {
 213                 // Is the internal_address config entry set?
 214                 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('allow_publish_internal_address') == 'N') {
 215                         // Not allowed to publish internal address, so use external
 216                         $ip = self::determineOwnExternalAddress();
 217                 } elseif (FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_address') != '') {
 218                         // Use it as internal address
 219                         $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_address');
 220                 } else {
 221                         // Determine own internal address by connecting to my (coder) server at 188.138.90.169
 222                         $ip = ConsoleTools::acquireSelfIPAddress();
 223                 }
 224
 225                 // Return it
 226                 return $ip;
 227         }
 228 }
 229
 230 // [EOF]
 231 ?>