application/hub/main/handler/network/class_BaseRawDataHandler.php

   1 <?php
   2 /**
   3  * A general Handler for raw data from sockets
   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 BaseRawDataHandler extends BaseHandler {
  25         // Error codes:
  26         // - Socket raw data stream errors
  27         const SOCKET_ERROR_UNKNOWN                    = 'unknown_error';              // Unknown error (should not happen)
  28         const SOCKET_ERROR_TRANSPORT_ENDPOINT         = 'transport_endpoint';         // Transport endpoint has closed
  29         const SOCKET_ERROR_INVALID_BASE64_MODULO      = 'base64_modulo';              // Length is not modulo 4
  30         const SOCKET_ERROR_INVALID_BASE64_MESSAGE     = 'base64_message';             // Raw data is not Base64-encoded
  31         const SOCKET_ERROR_UNHANDLED                  = 'unhandled_package';          // Unhandled raw data (not bad)
  32         const SOCKET_ERROR_CONNECTION_REFUSED         = 'connection_refused';         // The name says it: connection refused
  33         const SOCKET_ERROR_CONNECTION_TIMED_OUT       = 'connection_timed_out';       // The name says it: connection attempt has timed-out
  34         const SOCKET_ERROR_OPERATION_IN_PROGRESS      = 'operation_in_progress';      // 'Operation now in progress'
  35         const SOCKET_ERROR_OPERATION_ALREADY_PROGRESS = 'operation_already_progress'; // 'Operation already in progress'
  36         const SOCKET_ERROR_RESOURCE_UNAVAILABLE       = 'resource_unavailable';       // 'Resource temporary unavailable'
  37         const SOCKET_ERROR_NO_ROUTE_TO_HOST           = 'no_route_to_host';           // The name says it: no route to host
  38         const SOCKET_CONNECTED                        = 'connected';                  // Nothing errorous happens, socket is connected
  39
  40         // - Package errors
  41         const PACKAGE_ERROR_INVALID_DATA       = 'invalid_data';    // Invalid data in package found
  42         const PACKAGE_ERROR_INCOMPLETE_DATA    = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
  43         const PACKAGE_ERROR_INVALID_CONTENT    = 'invalid_content'; // Content is invalid (e.g. not well-formed)
  44         const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us
  45         const PACKAGE_LEVEL_CHECK_OKAY         = 'checked_package'; // Package is fine
  46
  47         // Package data
  48         const PACKAGE_DECODED_DATA = 'decoded_data';
  49         const PACKAGE_ERROR_CODE   = 'error_code';
  50
  51         /**
  52          * Stacker for decoded data
  53          */
  54         const STACKER_NAME_DECODED_DATA = 'decoded_data';
  55
  56         /**
  57          * Error code from socket
  58          */
  59         private $errorCode = -1;
  60
  61         /**
  62          * Protected constructor
  63          *
  64          * @param       $className      Name of the class
  65          * @return      void
  66          */
  67         protected function __construct ($className) {
  68                 // Call parent constructor
  69                 parent::__construct($className);
  70
  71                 // Set error code to 'unknown'
  72                 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
  73
  74                 // Get an input stream instance
  75                 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class', array($this));
  76
  77                 // Set it in this network-package handler
  78                 $this->setInputStreamInstance($streamInstance);
  79
  80                 // Init stacker instance for processed raw data
  81                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
  82
  83                 // Remember this in this package handler
  84                 $this->setStackerInstance($stackerInstance);
  85
  86                 // Init stacker
  87                 $this->initStacker();
  88         }
  89
  90         /**
  91          * Initializes the stacker for raw data
  92          *
  93          * @return      void
  94          */
  95         protected function initStacker () {
  96                 $this->getStackerInstance()->initStacker(self::STACKER_NAME_DECODED_DATA);
  97         }
  98
  99         /**
 100          * Adds given decoded data to the raw data stacker
 101          *
 102          * @param       $decodedData    Decoded data from the socket resource
 103          * @return      void
 104          */
 105         protected function addDecodedDataToStacker ($decodedData) {
 106                 /*
 107                  * Add the deocoded data and error code to the stacker so other classes
 108                  * (e.g. NetworkPackage) can "pop" it from the stacker.
 109                  */
 110                 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_DATA, array(
 111                         self::PACKAGE_DECODED_DATA => $decodedData,
 112                         self::PACKAGE_ERROR_CODE   => $this->getErrorCode()
 113                 ));
 114         }
 115
 116         /**
 117          * Checks whether decoded data is pending for further processing.
 118          *
 119          * @return      $isPending      Whether decoded data is pending
 120          */
 121         public function isDecodedDataPending () {
 122                 // Does the stacker have some entries (not empty)?
 123                 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_DATA));
 124
 125                 // Return it
 126                 return $isPending;
 127         }
 128
 129         /**
 130          * "Getter" for next decoded data from the stacker
 131          *
 132          * @return      $decodedData    Decoded data from the stacker
 133          */
 134         public function getNextDecodedData () {
 135                 // "Pop" the decoded data from the stacker
 136                 $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_DATA);
 137
 138                 // And return it
 139                 return $decodedData;
 140         }
 141
 142         /**
 143          * Checks whether the 'recipient' field matches our own address:port
 144          * combination.
 145          *
 146          * @param       $packageData    Raw package data
 147          * @return      $matches                Whether it matches
 148          * @todo        This method will be moved to a better place
 149          */
 150         protected function ifRecipientMatchesOwnAddress (array $packageData) {
 151                 // Construct own address first
 152                 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
 153
 154                 // Does it match?
 155                 $matches = ($ownAddress === $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 156
 157                 // Return result
 158                 return $matches;
 159         }
 160
 161         /**
 162          * Setter for error code
 163          *
 164          * @param       $errorCode      The error code we shall set
 165          * @return      void
 166          */
 167         public final function setErrorCode ($errorCode) {
 168                 $this->errorCode = $errorCode;
 169         }
 170
 171         /**
 172          * Getter for error code
 173          *
 174          * @return      $errorCode      The error code
 175          */
 176         public final function getErrorCode () {
 177                 return $this->errorCode;
 178         }
 179 }
 180
 181 // [EOF]
 182 ?>