application/hub/main/handler/network/tcp/class_TcpNetworkPackageHandler.php

   1 <?php
   2 /**
   3  * A TCP network package handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 TcpNetworkPackageHandler extends BaseNetworkPackageHandler implements Networkable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set handler name
  35                 $this->setHandlerName('tcp');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $handlerInstance        An instance of a Networkable class
  42          */
  43         public final static function createTcpNetworkPackageHandler () {
  44                 // Get new instance
  45                 $handlerInstance = new TcpNetworkPackageHandler();
  46
  47                 // Initialize new resolver instance
  48                 $resolverInstance = ObjectFactory::createObjectByConfiguredName('network_state_resolver_class');
  49
  50                 // Set it in this class
  51                 $handlerInstance->setResolverInstance($resolverInstance);
  52
  53                 // Return the prepared instance
  54                 return $handlerInstance;
  55         }
  56
  57         /**
  58          * Verifies the package data itself (only rudymentary check)
  59          *
  60          * @param       $rawData        Raw package data (as string
  61          * @return      $isValid        Wether the package data is valid
  62          */
  63         private function isPackageDataValid ($rawData) {
  64                 // Default is not valid
  65                 $isValid = false;
  66
  67                 // Convert it back into an array
  68                 $packageData = explode(NetworkPackage::PACKAGE_DATA_SEPERATOR, $rawData);
  69
  70                 // This should be at least three entries: sender|recipient|raw data
  71                 if (count($packageData) < 3) {
  72                         // Not enougth fields in $packageData!
  73                         $this->setErrorCode(self::PACKAGE_ERROR_INCOMPLETE_DATA);
  74                 } elseif (count(explode(NetworkPackage::PACKAGE_MASK_SEPERATOR, $packageData[NetworkPackage::INDEX_PACKAGE_CONTENT])) < 2) {
  75                         // Not entougth fields in content
  76                         $this->setErrorCode(self::PACKAGE_ERROR_INVALID_CONTENT);
  77                 } elseif (!$this->ifRecipientMatchesOwnAddress($packageData)) {
  78                         // Field 'recipient' doesn't match our address, this must always be the case
  79                         $this->setErrorCode(self::PACKAGE_ERROR_RECIPIENT_MISMATCH);
  80                 } else {
  81                         // This check went fine...
  82                         $isValid = true;
  83                 }
  84
  85                 // Return the result
  86                 return $isValid;
  87         }
  88
  89         /**
  90          * Processes a package from given resource. This is mostly useful for TCP
  91          * package handling and is implemented in the TcpListener class
  92          *
  93          * @param       $resource       A valid resource identifier
  94          * @return      void
  95          * @throws      InvalidResourceException        If the given resource is invalid
  96          * @todo        ~10% done
  97          */
  98         public function processResourcePackage ($resource) {
  99                 // Check the resource
 100                 if (!is_resource($resource)) {
 101                         // Throw an exception
 102                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 103                 } // END - if
 104
 105                 // Init package data array
 106                 $packageData = array();
 107
 108                 // Reset error code to unhandled
 109                 $this->setErrorCode(self::SOCKET_ERROR_UNHANDLED);
 110
 111                 // Debug message
 112                 $this->debugOutput('HANDLER: Handling TCP package from peer ' . $resource);
 113
 114                 // Read the raw data from socket
 115                 $rawData = socket_read($resource, $this->getConfigInstance()->getConfigEntry('tcp_buffer_length'), PHP_NORMAL_READ);
 116
 117                 // Is it valid?
 118                 if (($rawData === false) || (socket_last_error($resource) > 0)) {
 119                         // Network error or connection lost
 120                         $this->setErrorCode(socket_last_error($resource));
 121                 } elseif (empty($rawData)) {
 122                         // The peer did send nothing to us
 123                         $this->setErrorCode(self::SOCKET_ERROR_EMPTY_DATA);
 124                 } elseif (!$this->isPackageDataValid($rawData)) {
 125                         // Invalid package data
 126                         if ($this->getErrorCode() == self::SOCKET_ERROR_UNHANDLED) {
 127                                 // Set it to PACKAGE_ERROR_INVALID_DATA, because SOCKET_ERROR_UNHANDLED should not be used
 128                                 $this->setErrorCode(self::PACKAGE_ERROR_INVALID_DATA);
 129                         } // END - if
 130                 } else {
 131                         // Prepare the package data
 132                         $packageData = explode(NetworkPackage::PACKAGE_DATA_SEPERATOR, $rawData);
 133
 134                         // Low-level checks are all green
 135                         $this->setErrorCode(self::PACKAGE_LEVEL_CHECK_OKAY);
 136                 }
 137
 138                 // Get a state from the resolver for this package
 139                 $stateInstance = $this->getResolverInstance()->resolveStateByPackage($this, $packageData, $resource);
 140                 die('UNFINISHED:'.$stateInstance->__toString()."\n");
 141         }
 142 }
 143
 144 // [EOF]
 145 ?>