application/hub/main/discovery/recipient/socket/class_PackageSocketDiscovery.php

   1 <?php
   2 /**
   3  * A socket discovery class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 PackageSocketDiscovery extends BaseRecipientDiscovery implements DiscoverableSocket, 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 createPackageSocketDiscovery () {
  41                 // Get an instance of this class
  42                 $discoveryInstance = new PackageSocketDiscovery();
  43
  44                 // Output debug message
  45                 self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Initialized.');
  46
  47                 // Return the prepared instance
  48                 return $discoveryInstance;
  49         }
  50
  51         /**
  52          * Tries to dicover the right listener instance
  53          *
  54          * @param       $protocolInstance       An instance of a HandleableProtocol class
  55          * @param       $packageData            Raw package data
  56          * @return      $listenerInstance       An instance of a Listenable instance or null
  57          */
  58         public function discoverListenerInstance (HandleableProtocol $protocolInstance, array $packageData) {
  59                 // Debug message
  60                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolInstance=' . $protocolInstance->__toString() . ' - CALLED!');
  61
  62                 /*
  63                  * Get the listener pool instance, we need to lookup the matching
  64                  * listener->poolInstance chain there.
  65                  */
  66                 $poolInstance = NodeObjectFactory::createNodeInstance()->getListenerPoolInstance();
  67
  68                 // Init listener instance
  69                 $listenerInstance = NULL;
  70
  71                 // Get handler name
  72                 $protocolName = $protocolInstance->getProtocolName();
  73
  74                 // Debug message
  75                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $protocolName . ',poolEntriesInstance=' . $poolInstance->getPoolEntriesInstance()->__toString());
  76
  77                 /*
  78                  * Now we need to choose again. It is whether we are speaking with a hub
  79                  * or with a client. So just handle it over to all listeners in this
  80                  * pool.
  81                  */
  82                 foreach ($poolInstance->getPoolEntriesInstance()->getArrayFromList($protocolName) as $listenerInstance) {
  83                         // Debug output
  84                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: protocolName=' . $protocolName . ',listenerInstance[' . gettype($listenerInstance) . ']=' . $listenerInstance);
  85
  86                         // Make sure the instance is valid
  87                         assert($listenerInstance instanceof Listenable);
  88
  89                         // Does the listener want that package?
  90                         if ($listenerInstance->ifListenerAcceptsPackageData($packageData)) {
  91                                 // This listener likes our package data, so abort here
  92                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Listener is accepting package data.');
  93                                 break;
  94                         } // END - if
  95
  96                         // Debug message
  97                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Listener is NOT accepting package data.');
  98                 } // END - foreach
  99
 100                 // Debug message
 101                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: listenerInstance=' . $listenerInstance->__toString());
 102
 103                 // Return it
 104                 return $listenerInstance;
 105         }
 106
 107         /**
 108          * Tries to discover the right socket for given package data and returns a
 109          * matching socket resource for that protocol.
 110          *
 111          * @param       $packageData            Raw package data array
 112          * @param       $connectionType         Type of connection, can be 'incoming' or 'outgoing', *NEVER* 'server'!
 113          * @return      $socketResource         A valid socket resource or FALSE if an error occured
 114          * @throws      NoListGroupException    If the procol group is not found in peer list
 115          * @throws      NullPointerException    If listenerInstance is NULL
 116          * @throws      InvalidUnlException             If the provided UNL cannot be validated by the protocol handler
 117          */
 118         public function discoverSocket (array $packageData, $connectionType) {
 119                 // Debug message
 120                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: connectionType=' . $connectionType . ' - CALLED!');
 121
 122                 // Assert on type and recipient
 123                 assert($connectionType != BaseConnectionHelper::CONNECTION_TYPE_SERVER);
 124                 assert(isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
 125
 126                 // Determine protocol instance
 127                 $protocolInstance = ProtocolDiscovery::determineProtocolByPackageData($packageData);
 128
 129                 // Is it valid?
 130                 assert($protocolInstance instanceof HandleableProtocol);
 131
 132                 // Does the UNL validate?
 133                 if (!$protocolInstance->isValidUniversalNodeLocatorByPackageData($packageData)) {
 134                         // Not valid, throw exception
 135                         throw new InvalidUnlException(array($this, $protocolInstance, $packageData), BaseHubSystem::EXCEPTION_INVALID_UNL);
 136                 } // END - if
 137
 138                 // Get the listener instance
 139                 $listenerInstance = $this->discoverListenerInstance($protocolInstance, $packageData);
 140
 141                 // If there is no listener who wants to have that package, we simply drop it here
 142                 if (is_null($listenerInstance)) {
 143                         // Abort with no resource
 144                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 145                 } // END - if
 146
 147                 // Debug message
 148                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('protocolInstance=' . $protocolInstance . ',packageData=' . print_r($packageData, TRUE));
 149
 150                 /*
 151                  * Now we have the listener instance, we can determine the right
 152                  * resource to continue. The first step is to get the attached pool
 153                  * instance and pass over the whole package data to get the right
 154                  * socket.
 155                  */
 156                 $socketResource = $listenerInstance->getPoolInstance()->getSocketFromPackageData($packageData, $connectionType);
 157
 158                 // Debug message
 159                 // @TODO FIXME: I don't like these abuse of variables, better strict types
 160                 if (is_resource($socketResource)) {
 161                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',error=' . socket_strerror(socket_last_error($socketResource)) . ',packageData=' . print_r($packageData, TRUE));
 162                 } else {
 163                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',packageData=' . print_r($packageData, TRUE));
 164                 }
 165
 166                 // Is it FALSE, the recipient isn't known to us and we have no connection to it
 167                 if (($socketResource === FALSE) || (!is_resource($socketResource)) || (socket_last_error($socketResource) > 0)) {
 168                         // Try to create a new socket resource
 169                         try {
 170                                 // Possibly noisy debug message
 171                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Trying to establish a ' . strtoupper($protocolInstance) . ' connection to ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ' ...');
 172
 173                                 // Get a socket resource from our factory (if succeeded)
 174                                 $socketResource = SocketFactory::createSocketFromPackageData($packageData, $protocolInstance);
 175                         } catch (SocketConnectionException $e) {
 176                                 // The connection fails of being established, so log it away
 177                                 self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
 178                         }
 179                 } // END - if
 180
 181                 // Try to resolve the socket resource
 182                 try {
 183                         // Get the helper instance from registry
 184                         $helperInstance = Registry::getRegistry()->getInstance('connection');
 185
 186                         // Possibly noisy debug message
 187                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Going to resolve socket from peer state and given package data ...');
 188
 189                         // Resolve the peer's state (but ignore return value)
 190                         PeerStateResolver::resolveStateByPackage($helperInstance, $packageData, $socketResource);
 191                 } catch (InvalidSocketException $e) {
 192                         // This cannot be fixed, so log it away
 193                         self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: Cannot discover socket resource for recipient ' . $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] . ': ' . $e->getMessage());
 194
 195                         // Make any failed attempts to 'FALSE'
 196                         $socketResource = FALSE;
 197                 }
 198
 199                 // And return it
 200                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-DISCOVERY[' . __METHOD__ . ':' . __LINE__ . ']: socketResource=' . $socketResource . ',packageData=' . print_r($packageData, TRUE));
 201                 return $socketResource;
 202         }
 203 }
 204
 205 // [EOF]
 206 ?>