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                 assert(isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
  64
  65                 // First try out the direct recipient (session id)
  66                 try {
  67                         // Get instance (should not break)
  68                         $recipientInstance = ObjectFactory::createObjectByConfiguredName('direct_recipient_class');
  69
  70                         // Try to solve it
  71                         $recipientInstance->resolveRecipient($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $this->getListInstance());
  72                 } catch (FrameworkException $e) {
  73                         // Didn't work, so try the non-generic, depending recipient field itself (this may fail)
  74                         try {
  75                                 // Try to find the right class
  76                                 $recipientInstance = ObjectFactory::createObjectByConfiguredName(strtolower($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]) . '_recipient_class');
  77
  78                                 // And try to solve again
  79                                 $recipientInstance->resolveRecipient($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $this->getListInstance());
  80                         } catch (FrameworkException $e) {
  81                                 // Could not find class, what ever failed
  82                                 $this->debugInstance($e->getMessage());
  83                         }
  84                 }
  85         }
  86
  87         /**
  88          * Tries to discover all recipients by given decoded package data.
  89          *
  90          * @param       $decodedData    Raw raw package data array
  91          * @return      void
  92          * @todo        Add some validation of recipient field, e.g. ip:port is found
  93          * @todo        The if() does only check for TCP, not UDP, e.g. try to get a $handlerInstance here
  94          */
  95         public function discoverRawRecipients (array $decodedData) {
  96                 // This must be available
  97                 assert(isset($decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
  98
  99                 // First clear all recipients
 100                 $this->clearRecipients();
 101
 102                 // Explode 'recipient', first element is the IP/hostname
 103                 $recipient = explode(':', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 104
 105                 // Is the 'recipient' field same as this peer's IP?
 106                 if ((($recipient[0] == HubTools::determineOwnExternalIp()) && ($recipient[1] == $this->getConfigInstance()->getConfigEntry('node_listen_port'))) || ($recipient[0] == $this->getConfigInstance()->getServerAddress())) {
 107                         /*
 108                          * Is same as own external IP + TCP/UDP listen port or internal IP, don't do anything here so other
 109                          * classes found an empty recipient list for internal (own) handling
 110                          * of the original content.
 111                          */
 112
 113                         // Debug output (may flood)
 114                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY[' . __LINE__ . ']: Recipient ' . $recipient[0] . ' matches own ip (' .  HubTools::determineOwnExternalIp() . ' or ' . $this->getConfigInstance()->getServerAddress() . ')');
 115                 } else {
 116                         // Debug output (may flood)
 117                         /* 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)!');
 118
 119                         // This package is to be delivered to someone else, so add it
 120                         $this->getListInstance()->addEntry('ip_port', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 121                 }
 122         }
 123
 124         /**
 125          * "Getter" for recipient iterator
 126          *
 127          * @return      $iteratorInstance       An instance of a Iterateable object
 128          */
 129         public function getIterator () {
 130                 // Get iterator from it
 131                 $iteratorInstance = $this->getListInstance()->getIterator();
 132
 133                 // Return it
 134                 return $iteratorInstance;
 135         }
 136
 137         /**
 138          * Checks whether the recipient list is empty
 139          *
 140          * @return      $isEmpty        Whether the recipient list is empty
 141          */
 142         public function isRecipientListEmpty () {
 143                 // Check it ...
 144                 $isEmpty = ($this->getListInstance()->count() == 0);
 145
 146                 // Return it
 147                 return $isEmpty;
 148         }
 149
 150         /**
 151          * Clears all recipients for e.g. another package to deliver. This method
 152          * simply clears the inner list instance.
 153          *
 154          * @return      void
 155          */
 156         public function clearRecipients () {
 157                 // Clear the list
 158                 $this->getListInstance()->clearList();
 159         }
 160 }
 161
 162 // [EOF]
 163 ?>