application/hub/main/pools/peer/class_DefaultPeerPool.php

   1 <?php
   2 /**
   3  * A default peer pool 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 DefaultPeerPool extends BasePool implements PoolablePeer {
  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          * Creates an instance of this class
  37          *
  38          * @param       $listenerInstance       A Listenable instance
  39          * @return      $poolInstance           An instance a Poolable class
  40          */
  41         public static final function createDefaultPeerPool (Listenable $listenerInstance) {
  42                 // Get new instance
  43                 $poolInstance = new DefaultPeerPool();
  44
  45                 // Set the application instance
  46                 $poolInstance->setListenerInstance($listenerInstance);
  47
  48                 // Return the prepared instance
  49                 return $poolInstance;
  50         }
  51
  52         /**
  53          * Validates given socket
  54          *
  55          * @param       $socketResource         A valid socket resource
  56          * @return      void
  57          * @throws      InvalidSocketException  If the given socket has an error
  58          */
  59         private function validateSocket ($socketResource) {
  60                 // Is it a valid resource?
  61                 if (!is_resource($socketResource)) {
  62                         // Throw an exception
  63                         throw new InvalidSocketException(array($this, $socketResource), BaseListener::EXCEPTION_INVALID_SOCKET);
  64                 } // END - if
  65
  66                 // Get error code
  67                 $errorCode = socket_last_error($socketResource);
  68
  69                 // Is it without any errors?
  70                 if ($errorCode > 0) {
  71                         // Handle the socket error with a faked recipientData array
  72                         $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
  73                         /*
  74                         // Get error message
  75                         $errorMessage = socket_strerror($errorCode);
  76
  77                         // Shutdown this socket
  78                         $this->getListenerInstance()->shutdownSocket($socketResource);
  79
  80                         // And throw again
  81                         throw new InvalidSocketException(array($this, $socketResource, $errorCode, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
  82                         */
  83                 } // END - if
  84         }
  85
  86         /**
  87          * Adds a socket resource to the peer pool
  88          *
  89          * @param       $socketResource         A valid (must be!) socket resource
  90          * @param       $connectionType         Type of connection, can only be 'incoming', 'outgoing' or 'server'
  91          * @return      void
  92          * @throws      InvalidSocketException  If the given resource is invalid or errorous
  93          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
  94          */
  95         public function addPeer ($socketResource, $connectionType) {
  96                 // Debug message
  97                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('DEFAULT-PEER-POOL[' . __METHOD__ . ':' . __LINE__ . ']: socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',connectionType=' . $connectionType . ' - CALLED!');
  98
  99                 // Validate the socket
 100                 $this->validateSocket($socketResource);
 101
 102                 // Is the connection type valid?
 103                 if (!$this->isValidConnectionType($connectionType)) {
 104                         // Is not a valid connection type!
 105                         throw new InvalidConnectionTypeException(array($this, $connectionType), self::EXCEPTION_INVALID_CONNECTION_TYPE);
 106                 } // END - if
 107
 108                 // Default is this peer's IP
 109                 $peerName = '0.0.0.0';
 110
 111                 // The socket resource should not match server socket
 112                 if ($socketResource != $this->getListenerInstance()->getSocketResource()) {
 113                         // Try to determine the peer's IP number
 114                         if (!socket_getpeername($socketResource, $peerName)) {
 115                                 // Handle the socket error with a faked recipientData array
 116                                 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
 117                                 /*
 118                                 // Get last error
 119                                 $lastError = socket_last_error($socketResource);
 120
 121                                 // Doesn't work!
 122                                 throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 123                                 */
 124                         } // END - if
 125                 } else {
 126                         // Server sockets won't work with socket_getpeername()
 127                         self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Socket resource is server socket (' . $socketResource . '). This is not a bug.');
 128                 }
 129
 130                 // Debug message
 131                 self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Adding peer ' . $peerName . ',socketResource=' . $socketResource . ',type=' . $connectionType);
 132
 133                 // Construct the array
 134                 $socketArray = array(
 135                         self::SOCKET_ARRAY_RESOURCE  => $socketResource,
 136                         self::SOCKET_ARRAY_CONN_TYPE => $connectionType
 137                 );
 138
 139                 // Add it finally to the pool
 140                 $this->addPoolEntry($socketArray);
 141         }
 142
 143         /**
 144          * Getter for array of all socket resources
 145          *
 146          * @return      $sockets        An array with all sockets
 147          */
 148         public final function getAllSockets () {
 149                 // Get the list
 150                 $sockets = $this->getArrayFromList('pool');
 151
 152                 // Return it
 153                 return $sockets;
 154         }
 155
 156         /**
 157          * Getter for array of all socket arrays
 158          *
 159          * @return      $sockets        An array with all socket arrays
 160          */
 161         public final function getAllSingleSockets () {
 162                 // Get the array list
 163                 $socketArrays = $this->getArrayFromList('pool');
 164
 165                 // Init socket array
 166                 $sockets = array();
 167
 168                 // "Walk" through all socket arrays
 169                 foreach ($socketArrays as $socketArray) {
 170                         // Add the socket
 171                         array_push($sockets, $socketArray[self::SOCKET_ARRAY_RESOURCE]);
 172                 } // END - foreach
 173
 174                 // Return it
 175                 return $sockets;
 176         }
 177
 178         /**
 179          * "Getter" for all sockets of specified type
 180          *
 181          * @param       $connectionType         Type of connection, can only be 'incoming', 'outgoing' or 'server'
 182          * @return      $sockets                        An array with sockets of given type
 183          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
 184          */
 185         public function getSocketsByConnectionType ($connectionType) {
 186                 // Is the connection type valid?
 187                 if (!$this->isValidConnectionType($connectionType)) {
 188                         // Is not a valid connection type!
 189                         throw new InvalidConnectionTypeException(array($this, $connectionType), self::EXCEPTION_INVALID_CONNECTION_TYPE);
 190                 } // END - if
 191
 192                 // Get the array list
 193                 $socketArrays = $this->getArrayFromList('pool');
 194
 195                 // Init socket array
 196                 $sockets = array();
 197
 198                 // "Walk" through all socket arrays
 199                 foreach ($socketArrays as $socketArray) {
 200                         // Does it match?
 201                         if ($socketArray[self::SOCKET_ARRAY_CONN_TYPE] === $connectionType) {
 202                                 // Add the socket
 203                                 array_push($sockets, $socketArray[self::SOCKET_ARRAY_RESOURCE]);
 204                         } // END - if
 205                 } // END - foreach
 206
 207                 // Return it
 208                 return $sockets;
 209         }
 210
 211         /**
 212          * "Getter" for a valid socket resource from given packae data.
 213          *
 214          * @param       $packageData            Raw package data
 215          * @param       $connectionType         Type of connection, can be 'incoming', 'outgoing', 'server' or default
 216          * @return      $socketResource         Socket resource
 217          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
 218          */
 219         public function getSocketFromPackageData (array $packageData, $connectionType = NULL) {
 220                 // Default is no socket
 221                 $socketResource = FALSE;
 222
 223                 // Resolve recipient (UNL) into a handler instance
 224                 $handlerInstance = ProtocolHandlerFactory::createProtocolHandlerFromPackageData($packageData);
 225
 226                 // Get UNL data
 227                 $unlData = $handlerInstance->getUniversalNodeLocatorDataArray();
 228
 229                 // Make sure it is a valid Universal Node Locator array (3 elements)
 230                 assert(isset($unlData[UniversalNodeLocator::UNL_PART_PROTOCOL]));
 231                 assert(isset($unlData[UniversalNodeLocator::UNL_PART_ADDRESS]));
 232                 assert(isset($unlData[UniversalNodeLocator::UNL_PART_PORT]));
 233
 234                 // Debug message
 235                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Checking ' . count($this->getAllSockets()) . ' socket(s),unlData[' . UniversalNodeLocator::UNL_PART_ADDRESS . ']=' . $unlData[UniversalNodeLocator::UNL_PART_ADDRESS] . ',unlData[' . UniversalNodeLocator::UNL_PART_PORT . ']=' . $unlData[UniversalNodeLocator::UNL_PART_PORT] . ' ...');
 236
 237                 // Default is all sockets
 238                 $sockets = $this->getAllSockets();
 239
 240                 // Is connection type set?
 241                 if ((is_string($connectionType)) && ($this->isValidConnectionType($connectionType))) {
 242                         // Then get a list of this type
 243                         $sockets = $this->getSocketsByConnectionType($connectionType);
 244                 } elseif (is_string($connectionType)) {
 245                         // Is not a valid connection type!
 246                         throw new InvalidConnectionTypeException(array($this, $connectionType), self::EXCEPTION_INVALID_CONNECTION_TYPE);
 247                 }
 248
 249                 // Get all sockets and check them, skip the server socket
 250                 foreach ($sockets as $socketArray) {
 251                         // Is this a server socket?
 252                         if ($socketArray[self::SOCKET_ARRAY_RESOURCE] === $this->getListenerInstance()->getSocketResource()) {
 253                                 // Skip 'server' sockets (local socket)
 254                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: Skipping server socket ' . $socketArray[self::SOCKET_ARRAY_RESOURCE] . ' ...');
 255                                 continue;
 256                         } // END - if
 257
 258                         // Try to get the "peer"'s name
 259                         if (!socket_getpeername($socketArray[self::SOCKET_ARRAY_RESOURCE], $peerIp)) {
 260                                 // Handle the socket error with given package data
 261                                 $this->handleSocketError(__METHOD__, __LINE__, $socketArray[self::SOCKET_ARRAY_RESOURCE], explode(':', $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
 262                         } // END - if
 263
 264                         // Get
 265                         // If the "peer" IP and recipient is same, use it
 266                         if ($peerIp == $unlData[UniversalNodeLocator::UNL_PART_ADDRESS]) {
 267                                 // IPs match, so take the socket and quit this loop
 268                                 $socketResource = $socketArray[self::SOCKET_ARRAY_RESOURCE];
 269
 270                                 // Debug message
 271                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: peerIp=' . $peerIp . ' matches with recipient IP address. Taking socket=' . $socketArray[self::SOCKET_ARRAY_RESOURCE] . ',type=' . $socketArray[self::SOCKET_ARRAY_CONN_TYPE]);
 272                                 break;
 273                         } // END - if
 274                 } // END - foreach
 275
 276                 // Return the determined socket resource
 277                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('POOL[' . __METHOD__ . ':' . __LINE__ . ']: socketResource[' . gettype($socketResource) . ']=' . $socketResource);
 278                 return $socketResource;
 279         }
 280 }
 281
 282 // [EOF]
 283 ?>