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