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 - 2011 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                 $discoveryInstance->debugOutput('RECIPIENT-DISCOVERY: 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                 // 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_HUBS:
  66                                 // Get all bootstrap nodes
  67                                 foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $node) {
  68                                         // Debug message
  69                                         /* DEBUG: */ $this->debugOutput('DISCOVERY: Adding node ' . $node . ' as recipient.');
  70
  71                                         // Add the entry
  72                                         $this->getListInstance()->addEntry('ip_port', $node);
  73                                 } // END - foreach
  74                                 break;
  75
  76                         // The target 'self' is always the external IP address!
  77                         case NetworkPackage::NETWORK_TARGET_SELF:
  78                                 // Determine IP or 'external_ip' if set
  79                                 $ip = HubTools::determineOwnExternalIp();
  80
  81                                 // Get port and add it
  82                                 $ipPort = $ip . ':' . $this->getConfigInstance()->getConfigEntry('node_' . $this->determineProtocolByPackageData($packageData) . '_listen_port');
  83
  84                                 // Add it to the list
  85                                 $this->getListInstance()->addEntry('ip_port', $ipPort);
  86                                 break;
  87
  88                         // This may be a direct recipient (node's session id)
  89                         default:
  90                                 $this->partialStub('Please add code handling recipients ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
  91                                 break;
  92                 } // END - switch
  93         }
  94
  95         /**
  96          * Tries to discover all recipients by given decoded package data.
  97          *
  98          * @param       $decodedData    Decoded raw package data array
  99          * @return      void
 100          * @todo        Add some validation of recipient field, e.g. ip:port is found
 101          */
 102         public function discoverDecodedRecipients (array $decodedData) {
 103                 // First clear all recipients
 104                 $this->clearRecipients();
 105
 106                 // Explode 'recipient', first element is the IP/hostname
 107                 $recipient = explode(':', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 108
 109                 // Is the 'recipient' field same as this peer's IP?
 110                 if ($recipient[0] == HubTools::determineOwnExternalIp()) {
 111                         /*
 112                          * Is same as own external IP, don't do anything here so other
 113                          * classes found an empty recipient list for internal (own) handling
 114                          * of the original content.
 115                          */
 116
 117                         // Debug output (may flood)
 118                         /* NOISY-DEBUG: */ $this->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' matches own ip (' .  HubTools::determineOwnExternalIp() . ')');
 119                 } else {
 120                         // Debug output (may flood)
 121                         /* NOISY-DEBUG: */ $this->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' is different than own ip (' .  HubTools::determineOwnExternalIp() . '), need to forward (not yet implemented)!');
 122
 123                         // This package is to be delivered to someone else, so add it
 124                         $this->getListInstance()->addEntry('ip_port', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 125                 }
 126         }
 127
 128         /**
 129          * "Getter" for recipient iterator
 130          *
 131          * @return      $iteratorInstance       An instance of a Iterateable object
 132          */
 133         public function getIterator () {
 134                 // Get iterator from it
 135                 $iteratorInstance = $this->getListInstance()->getIterator();
 136
 137                 // Return it
 138                 return $iteratorInstance;
 139         }
 140
 141         /**
 142          * Checks whether the recipient list is empty
 143          *
 144          * @return      $isEmpty        Whether the recipient list is empty
 145          */
 146         public function isRecipientListEmpty () {
 147                 // Check it ...
 148                 $isEmpty = ($this->getListInstance()->count() == 0);
 149
 150                 // Return it
 151                 return $isEmpty;
 152         }
 153
 154         /**
 155          * Clears all recipients for e.g. another package to deliver. This method
 156          * simply clears the inner list instance.
 157          *
 158          * @return      void
 159          */
 160         public function clearRecipients () {
 161                 // Clear the list
 162                 $this->getListInstance()->clearList();
 163         }
 164 }
 165
 166 // [EOF]
 167 ?>