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, 2010 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 final static function createPackageRecipientDiscovery () {
  41                 // Get an instance of this class
  42                 $discoveryInstance = new PackageRecipientDiscovery();
  43
  44                 // Output debug message
  45                 $discoveryInstance->debugOutput('RECIPIENT-DISCOVERY: Initialized.');
  46
  47                 // Return the prepared instance
  48                 return $discoveryInstance;
  49         }
  50
  51         /**
  52          * Tries to discover all recipients for given package data
  53          *
  54          * @param       $packageData    Raw package data array
  55          * @return      void
  56          */
  57         public function discoverRecipients (array $packageData) {
  58                 // Get recipients list instance
  59                 $listInstance = RecipientListFactory::createRecipientListInstance();
  60
  61                 // We do some rudimentary checks but this might be a bit ugly
  62                 switch ($packageData['recipient']) {
  63                         // All upper hubs, these are currently the bootstrap nodes and later on prepended list-nodes
  64                         case NetworkPackage::NETWORK_TARGET_UPPER_HUBS:
  65                                 // Get all bootstrap nodes
  66                                 foreach (explode(';', $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $node) {
  67                                         // Add the entry
  68                                         $listInstance->addEntry('ip_port', $node);
  69                                 } // END - foreach
  70                                 break;
  71
  72                         // The target 'self' is always the external IP address!
  73                         case NetworkPackage::NETWORK_TARGET_SELF:
  74                                 // Is the external_ip config entry set?
  75                                 if ($this->getConfigInstance()->getConfigEntry('external_ip') != '') {
  76                                         // Use it as external ip
  77                                         $ip = $this->getConfigInstance()->getConfigEntry('external_ip');
  78                                 } else {
  79                                         // Determine own external ip by connecting to my (coder) server at 217.172.186.31
  80                                         $ip = ConsoleTools::determineExternalIp();
  81                                 }
  82
  83                                 // Get mode
  84                                 $mode = Registry::getRegistry()->getInstance('app')->getRequestInstance()->getRequestElement('mode');
  85
  86                                 // Set prefix
  87                                 $prefix = '';
  88                                 if ($mode != 'regular') {
  89                                         // Is a special node
  90                                         $prefix = $mode . '_';
  91                                 } // END - if
  92
  93                                 // Get port and add it
  94                                 $ipPort = $ip . ':' . $this->getConfigInstance()->getConfigEntry($prefix . 'node_' . $this->determineProtocolByPackageData($packageData) . '_listen_port');
  95
  96                                 // Add it to the list
  97                                 $listInstance->addEntry('ip_port', $ipPort);
  98                                 break;
  99
 100                         // This may be a direct recipient (hub's session id)
 101                         default:
 102                                 $this->partialStub('Please add code handling recipients ' . $packageData['recipient']);
 103                                 break;
 104                 } // END - switch
 105         }
 106
 107         /**
 108          * "Getter" for recipient iterator
 109          *
 110          * @return      $iteratorInstance       An instance of a Iterateable object
 111          */
 112         public function getIterator () {
 113                 // Get list instance
 114                 $listInstance = RecipientListFactory::createRecipientListInstance();
 115
 116                 // Get iterator from it
 117                 $iteratorInstance = $listInstance->getIterator();
 118
 119                 // Return it
 120                 return $iteratorInstance;
 121         }
 122 }
 123
 124 // [EOF]
 125 ?>