3 * This class contains static helper functions for our hub
5 * @author Roland Haeder <webmaster@shipsimu.org>
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.shipsimu.org
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.
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.
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/>.
24 class HubTools extends BaseHubSystem {
25 // Constants for exceptions
26 const EXCEPTION_SESSION_ID_IS_INVALID = 0x200;
27 const EXCEPTION_HOSTNAME_NOT_FOUND = 0x201;
30 * Cache for session ids
32 private $sessionIdCache = array();
35 * Length for session id (should be 32+salt_length
37 private $sessionIdLength = 0;
42 private static $selfInstance = NULL;
45 * Protected constructor
49 protected function __construct () {
50 // Call parent constructor
51 parent::__construct(__CLASS__);
54 $dhtInstance = DhtObjectFactory::createDhtObjectInstance('node');
57 $this->setDhtInstance($dhtInstance);
60 $this->sessionIdLength = 32 + $this->getConfigInstance()->getConfigEntry('salt_length');
64 * Singleton getter for self instance
66 * @retuen $selfInstance An instance of this class
68 public static final function getSelfInstance () {
69 // Is the instance set
70 if (is_null(self::$selfInstance)) {
72 self::$selfInstance = new HubTools();
75 // Return own instance
76 return self::$selfInstance;
80 * Getter for session id length
82 * @return $sessionIdLength Length of session ids
84 protected final function getSessionIdLength () {
85 return $this->sessionIdLength;
89 * Resolves a session id into an ip:port combination. The opposite method
90 * is resolveSessionIdByIpPort()
92 * @param $sessionId A valid session id
93 * @return $recipientIpPort Recipient as ip:port combination
95 protected function resolveIpPortBySessionId ($sessionId) {
97 $recipientIpPort = 'invalid:invalid';
99 // And ask it for ip:port by given session id
100 $recipient = $this->getDhtInstance()->findNodeLocalBySessionId($sessionId);
102 // Is the recipient valid?
103 if ((isset($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP])) && (isset($recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT]))) {
105 $recipientIpPort = $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_EXTERNAL_IP] . ':' . $recipient[NodeDistributedHashTableDatabaseWrapper::DB_COLUMN_LISTEN_PORT];
107 // Get the instance, this might throw a NPE
108 $nodeInstance = Registry::getRegistry()->getInstance('node');
110 // Is the session id the same?
111 if ($nodeInstance->getSessionId() == $sessionId) {
112 // Then get the ip:port from it, assume TCP by default
113 $recipientIpPort = self::determineOwnExternalIp() . ':' . $nodeInstance->getConfigInstance()->getConfigEntry('node_listen_port');
118 return $recipientIpPort;
122 * Resolves a ip:port combination into a session id. The "opposite" method
123 * is resolveIpPortBySessionId().
125 * @param $ipPort Ip:port combination
126 * @return $sessionId Valid session id
128 public static function resolveSessionIdByIpPort ($ipPort) {
129 // Get an own instance
130 $selfInstance = self::getSelfInstance();
132 // And ask it for session id by given ip:port
133 $recipient = $selfInstance->getDhtInstance()->findNodeByIpPort($ipPort);
134 die(__METHOD__.':recipient=<pre>'.print_r($recipient, TRUE).'</pre>' . PHP_EOL);
141 * Resolves given session id into an ip:port combination, if ip:port is set, it won't be translated
143 * @param $sessionId Session id or ip:port combination
144 * @return $recipient Recipient as ip:port combination
145 * @throws InvalidSessionIdException If the provided session id is invalid (and no ip:port combination)
146 * @throws NoValidHostnameException If the provided hostname cannot be resolved into an IP address
148 public static function resolveSessionId ($sessionId) {
149 // Get an own instance
150 $selfInstance = self::getSelfInstance();
152 // Default is direct ip:port
153 $recipient = $sessionId;
155 // Does it match a direct ip:port? (hint: see www.regexlib.com for the regular expression)
156 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)) {
157 // Direct ip:port found
158 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Direct ip:port ' . $sessionId . ' detected.');
159 } elseif (isset($selfInstance->sessionIdCache[$sessionId])) {
161 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Using entry from sessionIdCache[] array.');
164 $recipient = $selfInstance->sessionIdCache[$sessionId];
167 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: sessionIdCache[' . $sessionId . ']=' . $recipient);
168 } 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)) {
169 // Hostname:port found
170 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: hostname:port ' . $sessionId . ' detected.');
172 // Hostname:port found
173 $hostnameArray = explode(':', $sessionId);
176 * Try to resolve it and add port again
177 * @TODO Please try to encapsulate this PHP call into an own class
179 $recipient = gethostbyname($hostnameArray[0]) . ':' . $hostnameArray[1];
182 if ($recipient == $sessionId) {
183 // Resolving hostname->IP failed!
184 throw new NoValidHostnameException($hostnameArray, self::EXCEPTION_HOSTNAME_NOT_FOUND);
188 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: hostname:port ' . $sessionId . ' resolved to ' . $recipient);
189 } elseif (preg_match('/([a-f0-9]{' . $selfInstance->getSessionIdLength() . '})/', $sessionId)) {
191 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Using internal session id resolver.');
193 // Resolve session id into a ip:port combination
194 $recipient = $selfInstance->resolveIpPortBySessionId($sessionId);
197 self::createDebugInstance(__CLASS__)->debugOutput('HUB-TOOLS[' . __METHOD__ . ':' . __LINE__ . ']: Session id ' . $sessionId . ' resolved to ' . $recipient);
199 // Invalid session id
200 throw new InvalidSessionIdException($sessionId, self::EXCEPTION_SESSION_ID_IS_INVALID);
208 * Determine IP or 'external_ip' if set
210 * @return $ip The determined external ip of this node
212 public static function determineOwnExternalIp () {
213 // Is the external_ip config entry set?
214 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip') != '') {
215 // Use it as external ip
216 $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('external_ip');
218 // Determine own external ip by connecting to my (coder) server at 188.138.90.169
219 $ip = ConsoleTools::determineExternalIp();
227 * Determine IP or 'internal_ip' if set
229 * @return $ip The determined external ip of this node
231 public static function determineOwnInternalIp () {
232 // Is the internal_ip config entry set?
233 if (FrameworkConfiguration::getSelfInstance()->getConfigEntry('allow_publish_internal_ip') == 'N') {
234 // Not allowed to publish internal IP, so use external
235 $ip = self::determineOwnExternalIp();
236 } elseif (FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_ip') != '') {
237 // Use it as internal ip
238 $ip = FrameworkConfiguration::getSelfInstance()->getConfigEntry('internal_ip');
240 // Determine own internal ip by connecting to my (coder) server at 188.138.90.169
241 $ip = ConsoleTools::acquireSelfIPAddress();