inc/classes/main/handler/raw_data/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_RAW_DATA   = 'raw_data';
  49         const PACKAGE_ERROR_CODE = 'error_code';
  50
  51         // Start/end marker
  52         const STREAM_START_MARKER = '[[S]]';
  53         const STREAM_END_MARKER   = '[[E]]';
  54
  55         /**
  56          * Stacker for raw data
  57          */
  58         const STACKER_NAME_RAW_DATA = 'raw_data';
  59
  60         /**
  61          * Error code from socket
  62          */
  63         private $errorCode = -1;
  64
  65         /**
  66          * Protected constructor
  67          *
  68          * @param       $className      Name of the class
  69          * @return      void
  70          */
  71         protected function __construct ($className) {
  72                 // Call parent constructor
  73                 parent::__construct($className);
  74
  75                 // Set error code to 'unknown'
  76                 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
  77
  78                 // Init stacker instance for processed raw data
  79                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
  80
  81                 // Remember this in this package handler
  82                 $this->setStackerInstance($stackerInstance);
  83
  84                 // Init stacker
  85                 $this->initStacker();
  86         }
  87
  88         /**
  89          * Initializes the stacker for raw data
  90          *
  91          * @return      void
  92          */
  93         protected function initStacker () {
  94                 $this->getStackerInstance()->initStacker(self::STACKER_NAME_RAW_DATA);
  95         }
  96
  97         /**
  98          * Adds given raw data to the raw data stacker
  99          *
 100          * @param       $rawData        raw data from the socket resource
 101          * @return      void
 102          */
 103         protected function addRawDataToStacker ($rawData) {
 104                 /*
 105                  * Add the deocoded data and error code to the stacker so other classes
 106                  * (e.g. NetworkPackage) can "pop" it from the stacker.
 107                  */
 108                 $this->getStackerInstance()->pushNamed(self::STACKER_NAME_RAW_DATA, array(
 109                         self::PACKAGE_RAW_DATA   => $rawData,
 110                         self::PACKAGE_ERROR_CODE => $this->getErrorCode()
 111                 ));
 112         }
 113
 114         /**
 115          * Checks whether raw data is pending for further processing.
 116          *
 117          * @return      $isPending      Whether raw data is pending
 118          */
 119         public function isRawDataPending () {
 120                 // Does the stacker have some entries (not empty)?
 121                 $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_RAW_DATA));
 122
 123                 // Return it
 124                 return $isPending;
 125         }
 126
 127         /**
 128          * "Getter" for next raw data from the stacker
 129          *
 130          * @return      $rawData        Raw data from the stacker
 131          */
 132         public function getNextRawData () {
 133                 // "Pop" the raw data from the stacker
 134                 $rawData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_RAW_DATA);
 135
 136                 // And return it
 137                 return $rawData;
 138         }
 139
 140         /**
 141          * Checks whether the 'recipient' field matches our own address:port
 142          * combination.
 143          *
 144          * @param       $packageData    Raw package data
 145          * @return      $matches                Whether it matches
 146          * @todo        This method will be moved to a better place
 147          */
 148         protected function ifRecipientMatchesOwnAddress (array $packageData) {
 149                 // Construct own address first
 150                 $ownAddress = Registry::getRegistry()->getInstance('node')->getAddressPort($this);
 151
 152                 // Does it match?
 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         public 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 ?>