3 * A PackageRecipient discovery class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 PackageRecipientDiscovery extends BaseHubDiscovery implements DiscoverableRecipient, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Create an instance of this class
38 * @return $discoveryInstance An instance of this discovery class
40 public static final function createPackageRecipientDiscovery () {
41 // Get an instance of this class
42 $discoveryInstance = new PackageRecipientDiscovery();
44 // Get recipients list instance and set it
45 $listInstance = RecipientListFactory::createRecipientListInstance();
46 $discoveryInstance->setListInstance($listInstance);
48 // Output debug message
49 $discoveryInstance->debugOutput('RECIPIENT-DISCOVERY: Initialized.');
51 // Return the prepared instance
52 return $discoveryInstance;
56 * Tries to discover all recipients for given package data
58 * @param $packageData Raw package data array
61 public function discoverRecipients (array $packageData) {
62 // We do some rudimentary checks but this might be a bit ugly
63 switch ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]) {
64 // All upper hubs, these are currently the bootstrap nodes and later on prepended list-nodes
65 case NetworkPackage::NETWORK_TARGET_UPPER_NODES:
66 // Get all bootstrap nodes
67 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
68 // Is maximum reached?
69 if ($this->getListInstance()->count() == $this->getConfigInstance()->getConfigEntry('package_recipient_max_count')) {
71 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DISCOVERY: Going to abort at maximum of ' . $this->getConfigInstance()->getConfigEntry('package_recipient_max_count') . ' recipients!');
73 // Then stop adding more
78 /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DISCOVERY: Adding node ' . $ipPort . ' as recipient.');
81 $this->getListInstance()->addEntry('ip_port', $ipPort);
85 // The target 'self' is always the external IP address!
86 case NetworkPackage::NETWORK_TARGET_SELF:
88 $port = $this->getConfigInstance()->getConfigEntry('node_' . $this->determineProtocolByPackageData($packageData) . '_listen_port');
90 // Determine IP or 'external_ip' if set
91 $ip = HubTools::determineOwnExternalIp();
96 $this->getListInstance()->addEntry('ip_port', $ip . ':' . $port);
100 // This may be a direct recipient (node's session id)
103 * Try to solve it, if an exception comes back, it is not a
104 * session-id, nor IP:port and not a hostname:port combination.
107 // "Explode" all recipients
108 $recipients = explode(NetworkPackage::PACKAGE_RECIPIENT_SEPARATOR, $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
110 // Is maximum reached?
111 assert(count($recipients) <= $this->getConfigInstance()->getConfigEntry('package_recipient_max_count'));
114 foreach ($recipients as $recipient) {
115 // Try to sole a single recipient
116 $ipPort = HubTools::resolveSessionId($recipient, $packageData[NetworkPackage::PACKAGE_DATA_PROTOCOL]);
118 // Add it as recipient
119 $this->getListInstance()->addEntry('ip_port', $ipPort);
121 } catch (FrameworkException $e) {
122 // Didn't work, pleace add more code
123 $this->partialStub('Please add code handling recipients ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ',packageData=' . print_r($packageData, true) . ',exception=' . $e->__toString() . ',message=' . $e->getMessage());
130 * Tries to discover all recipients by given decoded package data.
132 * @param $decodedData Raw raw package data array
134 * @todo Add some validation of recipient field, e.g. ip:port is found
135 * @todo The if() does only check for TCP, not UDP, e.g. try to get a $handlerInstance here
137 public function discoverRawRecipients (array $decodedData) {
138 // First clear all recipients
139 $this->clearRecipients();
141 // Explode 'recipient', first element is the IP/hostname
142 $recipient = explode(':', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
144 // Is the 'recipient' field same as this peer's IP?
145 if ((($recipient[0] == HubTools::determineOwnExternalIp()) && ($recipient[1] == $this->getConfigInstance()->getConfigEntry('node_tcp_listen_port'))) || ($recipient[0] == $this->getConfigInstance()->getServerAddress())) {
147 * Is same as own external IP+TCP port or internal IP, don't do anything here so other
148 * classes found an empty recipient list for internal (own) handling
149 * of the original content.
152 // Debug output (may flood)
153 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' matches own ip (' . HubTools::determineOwnExternalIp() . ' or ' . $this->getConfigInstance()->getServerAddress() . ')');
155 // Debug output (may flood)
156 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' is different than own external ip (' . HubTools::determineOwnExternalIp() . ') nor internal ip (' . $this->getConfigInstance()->getServerAddress() . '), need to forward (not yet implemented)!');
158 // This package is to be delivered to someone else, so add it
159 $this->getListInstance()->addEntry('ip_port', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
164 * "Getter" for recipient iterator
166 * @return $iteratorInstance An instance of a Iterateable object
168 public function getIterator () {
169 // Get iterator from it
170 $iteratorInstance = $this->getListInstance()->getIterator();
173 return $iteratorInstance;
177 * Checks whether the recipient list is empty
179 * @return $isEmpty Whether the recipient list is empty
181 public function isRecipientListEmpty () {
183 $isEmpty = ($this->getListInstance()->count() == 0);
190 * Clears all recipients for e.g. another package to deliver. This method
191 * simply clears the inner list instance.
195 public function clearRecipients () {
197 $this->getListInstance()->clearList();