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