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

   1 <?php
   2 /**
   3  * A default peer pool 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 Hub 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 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          */
  94         public function addPeer ($socketResource, $connectionType) {
  95                 // Validate the socket
  96                 $this->validateSocket($socketResource);
  97
  98                 // Default is this peer's IP
  99                 $peerName = '0.0.0.0';
 100
 101                 // The socket resource should not match server socket
 102                 if ($socketResource != $this->getListenerInstance()->getSocketResource()) {
 103                         // Try to determine the peer's IP number
 104                         if (!socket_getpeername($socketResource, $peerName)) {
 105                                 // Handle the socket error with a faked recipientData array
 106                                 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
 107                                 /*
 108                                 // Get last error
 109                                 $lastError = socket_last_error($socketResource);
 110
 111                                 // Doesn't work!
 112                                 throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
 113                                 */
 114                         } // END - if
 115                 } else {
 116                         // Server sockets won't work with socket_getpeername()
 117                         $this->debugOutput('POOL: Socket resource is server socket (' . $socketResource . '). This is not a bug.');
 118                 }
 119
 120                 // Debug message
 121                 $this->debugOutput('POOL: Adding peer ' . $peerName . ',socketResource=' . $socketResource);
 122
 123                 // Construct the array
 124                 $socketArray = array(
 125                         self::SOCKET_ARRAY_RESOURCE  => $socketResource,
 126                         self::SOCKET_ARRAY_CONN_TYPE => $connectionType
 127                 );
 128
 129                 // Add it finally to the pool
 130                 $this->addPoolEntry($socketArray);
 131         }
 132
 133         /**
 134          * Getter for array of all socket resources
 135          *
 136          * @return      $sockets        An array with all sockets
 137          */
 138         public final function getAllSockets () {
 139                 // Get the list
 140                 $sockets = $this->getArrayFromList('pool');
 141
 142                 // Return it
 143                 return $sockets;
 144         }
 145
 146         /**
 147          * Getter for array of all socket arrays
 148          *
 149          * @return      $sockets        An array with all socket arrays
 150          */
 151         public final function getAllSingleSockets () {
 152                 // Get the array list
 153                 $socketArrays = $this->getArrayFromList('pool');
 154
 155                 // Init socket array
 156                 $sockets = array();
 157
 158                 // "Walk" through all socket arrays
 159                 foreach ($socketArrays as $socketArray) {
 160                         // Add the socket
 161                         $sockets[] = $socketArray[self::SOCKET_ARRAY_RESOURCE];
 162                 } // END - foreach
 163
 164                 // Return it
 165                 return $sockets;
 166         }
 167
 168         /**
 169          * "Getter" for all sockets of specified type
 170          *
 171          * @param       $connectionType         Type of connection, can only be 'incoming', 'outgoing' or 'server'
 172          * @return      $sockets                        An array with sockets of given type
 173          */
 174         public function getSocketsByConnectionType ($connectionType) {
 175                 // Get the array list
 176                 $socketArrays = $this->getArrayFromList('pool');
 177
 178                 // Init socket array
 179                 $sockets = array();
 180
 181                 // "Walk" through all socket arrays
 182                 foreach ($socketArrays as $socketArray) {
 183                         // Does it match?
 184                         if ($socketArray[self::SOCKET_ARRAY_CONN_TYPE] === $connectionType) {
 185                                 // Add the socket
 186                                 $sockets[] = $socketArray[self::SOCKET_ARRAY_RESOURCE];
 187                         } // END - if
 188                 } // END - foreach
 189
 190                 // Return it
 191                 return $sockets;
 192         }
 193
 194         /**
 195          * "Getter" for a valid socket resource from given packae data.
 196          *
 197          * @param       $packageData            Raw package data
 198          * @param       $connectionType         Type of connection, can be 'incoming', 'outgoing', 'server' or default
 199          * @return      $socketResource         Socket resource
 200          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
 201          */
 202         public function getSocketFromPackageData (array $packageData, $connectionType = NULL) {
 203                 // Default is no socket
 204                 $socketResource = false;
 205
 206                 // Temporary resolve recipient field
 207                 $recipientIpArray = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $packageData[NetworkPackage::PACKAGE_DATA_PROTOCOL]));
 208
 209                 // Make sure it is a valid ip:port array (2 elements)
 210                 assert(count($recipientIpArray) == 2);
 211
 212                 // Debug message
 213                 /* NOISY-DEBUG: */ $this->debugOutput('POOL: Checking ' . count($this->getAllSockets()) . ' socket(s),recipientIpArray[0]=' . $recipientIpArray[0] . ',recipientIpArray[1]=' . $recipientIpArray[1] . ' ...');
 214
 215                 // Default is all sockets
 216                 $sockets = $this->getAllSockets();
 217
 218                 // Is connection type set?
 219                 if ((is_string($connectionType)) && ($this->isValidConnectionType($connectionType))) {
 220                         // Then get a list of this type
 221                         $sockets = $this->getSocketsByConnectionType($connectionType);
 222                 } elseif (is_string($connectionType)) {
 223                         // Is not a valid connection type!
 224                         throw new InvalidConnectionTypeException(array($this, $connectionType), self::EXCEPTION_INVALID_CONNECTION_TYPE);
 225                 }
 226
 227                 // Get all sockets and check them, skip the server socket
 228                 foreach ($sockets as $socketArray) {
 229                         // Is this a server socket?
 230                         if ($socketArray[self::SOCKET_ARRAY_RESOURCE] === $this->getListenerInstance()->getSocketResource()) {
 231                                 // Skip 'server' sockets (local socket)
 232                                 /* NOISY-DEBUG: */ $this->debugOutput('POOL: Skipping server socket ' . $socketArray[self::SOCKET_ARRAY_RESOURCE] . ' ...');
 233                                 continue;
 234                         } // END - if
 235
 236                         // Try to get the "peer"'s name
 237                         if (!socket_getpeername($socketArray[self::SOCKET_ARRAY_RESOURCE], $peerIp)) {
 238                                 // Handle the socket error with given package data
 239                                 $this->handleSocketError(__METHOD__, __LINE__, $socketArray[self::SOCKET_ARRAY_RESOURCE], explode(':', $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
 240                         } // END - if
 241
 242                         // Get
 243                         // If the "peer" IP and recipient is same, use it
 244                         if ($peerIp == $recipientIpArray[0]) {
 245                                 // IPs match, so take the socket and quit this loop
 246                                 $socketResource = $socketArray[self::SOCKET_ARRAY_RESOURCE];
 247
 248                                 // Debug message
 249                                 /* NOISY-DEBUG: */ $this->debugOutput('POOL: peerIp=' . $peerIp . ' matches with recipient IP address. Taking socket=' . $socketArray[self::SOCKET_ARRAY_RESOURCE] . ',type=' . $socketArray[self::SOCKET_ARRAY_CONN_TYPE]);
 250                                 break;
 251                         } // END - if
 252                 } // END - foreach
 253
 254                 // Return the determined socket resource
 255                 /* NOISY-DEBUG: */ $this->debugOutput('POOL: socketResource[' . gettype($socketResource) . ']=' . $socketResource);
 256                 return $socketResource;
 257         }
 258 }
 259
 260 // [EOF]
 261 ?>