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