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