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
  34         // - Package errors
  35         const PACKAGE_ERROR_INVALID_DATA       = 'invalid_data';    // Invalid data in package found
  36         const PACKAGE_ERROR_INCOMPLETE_DATA    = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
  37         const PACKAGE_ERROR_INVALID_CONTENT    = 'invalid_content'; // Content is invalid (e.g. not well-formed)
  38         const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us
  39         const PACKAGE_LEVEL_CHECK_OKAY         = 'checked_package'; // Package is fine
  40
  41         // Package data
  42         const PACKAGE_DECODED_DATA = 'decoded_data';
  43         const PACKAGE_ERROR_CODE   = 'error_code';
  44
  45         /**
  46          * Error code from socket
  47          */
  48         private $errorCode = -1;
  49
  50         /**
  51          * Protected constructor
  52          *
  53          * @param       $className      Name of the class
  54          * @return      void
  55          */
  56         protected function __construct ($className) {
  57                 // Call parent constructor
  58                 parent::__construct($className);
  59
  60                 // Set error code to 'unknown'
  61                 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
  62
  63                 // Get an input stream instance
  64                 $streamInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_input_stream_class', array($this));
  65
  66                 // Set it in this network-package handler
  67                 $this->setInputStreamInstance($streamInstance);
  68
  69                 // Init stacker instance for processed raw data
  70                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
  71
  72                 // Remember this in this package handler
  73                 $this->setStackerInstance($stackerInstance);
  74
  75                 // Init stacker
  76                 $this->initStacker();
  77         }
  78
  79         /**
  80          * Initializes the stacker for raw data
  81          *
  82          * @return      void
  83          */
  84         protected function initStacker () {
  85                 $this->getStackerInstance()->initStacker('raw_data');
  86         }
  87
  88         /**
  89          * Adds given decoded data to the raw data stacker
  90          *
  91          * @param       $decodedData    Decoded data from the socket resource
  92          * @return      void
  93          */
  94         protected function addDecodedDataToStacker ($decodedData) {
  95                 /*
  96                  * Add the deocoded data and error code to the stacker so other classes
  97                  * (e.g. NetworkPackage) can "pop" it from the stacker.
  98                  */
  99                 $this->getStackerInstance()->pushNamed('raw_data', array(
 100                         self::PACKAGE_DECODED_DATA => $decodedData,
 101                         self::PACKAGE_ERROR_CODE   => $this->getErrorCode()
 102                 ));
 103         }
 104
 105         /**
 106          * Checks wether the 'recipient' field matches our own address:port
 107          * combination.
 108          *
 109          * @param       $packageData    Raw package data
 110          * @return      $matches                Wether it matches
 111          * @todo        This method will be moved to a better place
 112          */
 113         protected function ifRecipientMatchesOwnAddress (array $packageData) {
 114                 // Construct own address first
 115                 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
 116
 117                 // Does it match?
 118                 // @TODO Numeric or alpha-numeric index?
 119                 $matches = ($ownAddress === $packageData[NetworkPackage::INDEX_PACKAGE_RECIPIENT]);
 120
 121                 // Return result
 122                 return $matches;
 123         }
 124
 125         /**
 126          * Setter for error code
 127          *
 128          * @param       $errorCode      The error code we shall set
 129          * @return      void
 130          */
 131         protected final function setErrorCode ($errorCode) {
 132                 $this->errorCode = $errorCode;
 133         }
 134
 135         /**
 136          * Getter for error code
 137          *
 138          * @return      $errorCode      The error code
 139          */
 140         public final function getErrorCode () {
 141                 return $this->errorCode;
 142         }
 143 }
 144
 145 // [EOF]
 146 ?>