3 * This class contains static helper functions for our hub
5 * @author Roland Haeder <webmaster@ship-simu.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.ship-simu.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 $this->sessionIdLength = 32 + $this->getConfigInstance()->getConfigEntry('salt_length');
58 * Singleton getter for self instance
60 * @retuen $selfInstance An instance of this class
62 public static final function getSelfInstance () {
63 // Is the instance set
64 if (is_null(self::$selfInstance)) {
66 self::$selfInstance = new HubTools();
69 // Return own instance
70 return self::$selfInstance;
74 * Getter for session id length
76 * @return $sessionIdLength Length of session ids
78 protected final function getSessionIdLength () {
79 return $this->sessionIdLength;
83 * Resolves a session id into an ip:port combination
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
89 protected function resolveIpPortBySessionId ($sessionId, $protocol) {
90 // Get a wrapper instance
91 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_list_db_wrapper_class');
93 // And ask it for the session id
94 $recipient = $wrapperInstance->resolveIpPortBySessionId($sessionId, $protocol);
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');
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');
113 * Resolves a ip:port combination into a session id
115 * @param $ipPort Ip:port combination
116 * @param $protocol Name of used protocol (TCP/UDP)
117 * @return $sessionId Valid session id
119 public static function resolveSessionIdByIpPort ($ipPort, $protocol) {
120 // Get a wrapper instance
121 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_list_db_wrapper_class');
123 // And ask it for the session id
124 $sessionId = $wrapperInstance->resolveSessionIdByIpPort($ipPort, $protocol);
131 * Resolves given session id into an ip:port combination, if ip:port is set, it won't be translated
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
139 public static function resolveSessionId ($sessionId, $protocol) {
140 // Get an own instance
141 $selfInstance = self::getSelfInstance();
143 // Default is direct ip:port
144 $recipient = $sessionId;
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])) {
152 $selfInstance->debugOutput('HUB-TOOLS: Using entry from sessionIdCache[] array.');
155 $recipient = $selfInstance->sessionIdCache[$sessionId];
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.');
163 // Hostname:port found
164 $hostnameArray = explode(':', $sessionId);
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];
171 if ($recipient == $sessionId) {
172 // Resolving hostname->IP failed!
173 throw new NoValidHostnameException($hostnameArray, self::EXCEPTION_HOSTNAME_NOT_FOUND);
177 $selfInstance->debugOutput('HUB-TOOLS: hostname:port ' . $sessionId . ' resolved to ' . $recipient);
178 } elseif (preg_match('/([a-f0-9]{' . $selfInstance->getSessionIdLength() . '})/', $sessionId)) {
180 $selfInstance->debugOutput('HUB-TOOLS: Using internal session id resolver.');
182 // Resolve session id into a ip:port combination
183 $recipient = $selfInstance->resolveIpPortBySessionId($sessionId, $protocol);
186 $selfInstance->debugOutput('HUB-TOOLS: session id ' . $sessionId . ' resolved to ' . $recipient);
188 // Invalid session id
189 throw new InvalidSessionIdException($sessionId, self::EXCEPTION_SESSION_ID_IS_INVALID);
197 * Determine IP or 'external_ip' if set
199 * @return $ip The determined external ip of this node
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');
207 // Determine own external ip by connecting to my (coder) server at 188.138.90.169
208 $ip = ConsoleTools::determineExternalIp();
216 * Determine IP or 'internal_ip' if set
218 * @return $ip The determined external ip of this node
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');
229 // Determine own internal ip by connecting to my (coder) server at 188.138.90.169
230 $ip = ConsoleTools::acquireSelfIPAddress();