]> git.mxchange.org Git - hub.git/blob - application/hub/main/discovery/package/class_PackageRecipientDiscovery.php
One to much ...
[hub.git] / application / hub / main / discovery / package / class_PackageRecipientDiscovery.php
1 <?php
2 /**
3  * A PackageRecipient discovery class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
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
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 PackageRecipientDiscovery extends BaseHubDiscovery implements DiscoverableRecipient, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Create an instance of this class
37          *
38          * @return      $discoveryInstance      An instance of this discovery class
39          */
40         public static final function createPackageRecipientDiscovery () {
41                 // Get an instance of this class
42                 $discoveryInstance = new PackageRecipientDiscovery();
43
44                 // Get recipients list instance and set it
45                 $listInstance = RecipientListFactory::createRecipientListInstance();
46                 $discoveryInstance->setListInstance($listInstance);
47
48                 // Output debug message
49                 self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY[' . __LINE__ . ']: Initialized.');
50
51                 // Return the prepared instance
52                 return $discoveryInstance;
53         }
54
55         /**
56          * Tries to discover all recipients for given package data
57          *
58          * @param       $packageData    Raw package data array
59          * @return      void
60          */
61         public function discoverRecipients (array $packageData) {
62                 // This must be available
63                 //* DEBUG: */ print $this->__toString() . ': packageData=' . print_r($packageData, TRUE);
64                 assert(isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
65
66                 // First try out the direct recipient (session id)
67                 try {
68                         // Get instance (should not break)
69                         $recipientInstance = ObjectFactory::createObjectByConfiguredName('direct_recipient_class');
70
71                         // Try to solve it
72                         $recipientInstance->resolveRecipient($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $this->getListInstance());
73                 } catch (FrameworkException $e) {
74                         // Didn't work, so try the non-generic, depending recipient field itself (this may fail)
75                         try {
76                                 // Try to find the right class
77                                 $recipientInstance = ObjectFactory::createObjectByConfiguredName(strtolower($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]) . '_recipient_class');
78
79                                 // And try to solve again
80                                 $recipientInstance->resolveRecipient($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $this->getListInstance());
81                         } catch (FrameworkException $e) {
82                                 // Could not find class, what ever failed
83                                 $this->debugInstance($e->getMessage());
84                         }
85                 }
86         }
87
88         /**
89          * Tries to discover all recipients by given decoded package data.
90          *
91          * @param       $decodedData    Raw raw package data array
92          * @return      void
93          * @todo        Add some validation of recipient field, e.g. ip:port is found
94          * @todo        The if() does only check for TCP, not UDP, e.g. try to get a $handlerInstance here
95          */
96         public function discoverRawRecipients (array $decodedData) {
97                 // This must be available
98                 assert(isset($decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
99
100                 // First clear all recipients
101                 $this->clearRecipients();
102
103                 // Explode 'recipient', first element is the IP/hostname
104                 $recipient = explode(':', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
105
106                 // Is the 'recipient' field same as this peer's IP?
107                 if ((($recipient[0] == HubTools::determineOwnExternalIp()) && ($recipient[1] == $this->getConfigInstance()->getConfigEntry('node_listen_port'))) || ($recipient[0] == $this->getConfigInstance()->getServerAddress())) {
108                         /*
109                          * Is same as own external IP + TCP/UDP listen port or internal IP, don't do anything here so other
110                          * classes found an empty recipient list for internal (own) handling
111                          * of the original content.
112                          */
113
114                         // Debug output (may flood)
115                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY[' . __LINE__ . ']: Recipient ' . $recipient[0] . ' matches own ip (' .  HubTools::determineOwnExternalIp() . ' or ' . $this->getConfigInstance()->getServerAddress() . ')');
116                 } else {
117                         // Debug output (may flood)
118                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY[' . __LINE__ . ']: Recipient ' . $recipient[0] . ' is different than own external ip (' .  HubTools::determineOwnExternalIp() . ') nor internal ip (' . $this->getConfigInstance()->getServerAddress() . '), need to forward (not yet implemented)!');
119
120                         // This package is to be delivered to someone else, so add it
121                         $this->getListInstance()->addEntry('ip_port', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
122                 }
123         }
124
125         /**
126          * "Getter" for recipient iterator
127          *
128          * @return      $iteratorInstance       An instance of a Iterateable object
129          */
130         public function getIterator () {
131                 // Get iterator from it
132                 $iteratorInstance = $this->getListInstance()->getIterator();
133
134                 // Return it
135                 return $iteratorInstance;
136         }
137
138         /**
139          * Checks whether the recipient list is empty
140          *
141          * @return      $isEmpty        Whether the recipient list is empty
142          */
143         public function isRecipientListEmpty () {
144                 // Check it ...
145                 $isEmpty = ($this->getListInstance()->count() == 0);
146
147                 // Return it
148                 return $isEmpty;
149         }
150
151         /**
152          * Clears all recipients for e.g. another package to deliver. This method
153          * simply clears the inner list instance.
154          *
155          * @return      void
156          */
157         public function clearRecipients () {
158                 // Clear the list
159                 $this->getListInstance()->clearList();
160         }
161 }
162
163 // [EOF]
164 ?>