inc/main/classes/handler/raw_data/network/class_BaseRawDataHandler.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Handler\Raw;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7
   8 /**
   9  * A general Handler for raw data from sockets
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class BaseRawDataHandler extends BaseHandler {
  31         // Error codes:
  32         // - Socket raw data stream errors
  33         const SOCKET_ERROR_UNKNOWN                    = 'unknown_error';              // Unknown error (should not happen)
  34         const SOCKET_ERROR_TRANSPORT_ENDPOINT         = 'transport_endpoint';         // Transport endpoint has closed
  35         const SOCKET_ERROR_INVALID_BASE64_MODULO      = 'base64_modulo';              // Length is not modulo 4
  36         const SOCKET_ERROR_INVALID_BASE64_MESSAGE     = 'base64_message';             // Raw data is not Base64-encoded
  37         const SOCKET_ERROR_UNHANDLED                  = 'unhandled_package';          // Unhandled raw data (not bad)
  38         const SOCKET_ERROR_CONNECTION_REFUSED         = 'connection_refused';         // The name says it: connection refused
  39         const SOCKET_ERROR_CONNECTION_TIMED_OUT       = 'connection_timed_out';       // The name says it: connection attempt has timed-out
  40         const SOCKET_ERROR_OPERATION_IN_PROGRESS      = 'operation_in_progress';      // 'Operation now in progress'
  41         const SOCKET_ERROR_OPERATION_ALREADY_PROGRESS = 'operation_already_progress'; // 'Operation already in progress'
  42         const SOCKET_ERROR_RESOURCE_UNAVAILABLE       = 'resource_unavailable';       // 'Resource temporary unavailable'
  43         const SOCKET_ERROR_NO_ROUTE_TO_HOST           = 'no_route_to_host';           // The name says it: no route to host
  44         const SOCKET_ERROR_CONNECTION_RESET_BY_PEER   = 'connection_reset_by_peer';   // Connection reset by peer
  45         const SOCKET_ERROR_BROKEN_PIPE                = 'broken_pipe';                // Broken pipe
  46         const SOCKET_ERROR_PERMISSION_DENIED          = 'permission_denied';          // Permission denied
  47         const SOCKET_CONNECTED                        = 'connected';                  // Nothing errorous happens, socket is connected
  48
  49         // - Package errors
  50         const PACKAGE_ERROR_INVALID_DATA       = 'invalid_data';    // Invalid data in package found
  51         const PACKAGE_ERROR_INCOMPLETE_DATA    = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
  52         const PACKAGE_ERROR_INVALID_CONTENT    = 'invalid_content'; // Content is invalid (e.g. not well-formed)
  53         const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us
  54         const PACKAGE_LEVEL_CHECK_OKAY         = 'checked_package'; // Package is fine
  55
  56         // Package data
  57         const PACKAGE_RAW_DATA   = 'raw_data';
  58         const PACKAGE_ERROR_CODE = 'error_code';
  59
  60         // Start/end marker
  61         const STREAM_START_MARKER = '[[S]]';
  62         const STREAM_END_MARKER   = '[[E]]';
  63
  64         /**
  65          * Stacker for raw data
  66          */
  67         const STACKER_NAME_RAW_DATA = 'raw_data';
  68
  69         /**
  70          * Error code from socket
  71          */
  72         private $errorCode = -1;
  73
  74         /**
  75          * Protected constructor
  76          *
  77          * @param       $className      Name of the class
  78          * @return      void
  79          */
  80         protected function __construct ($className) {
  81                 // Call parent constructor
  82                 parent::__construct($className);
  83
  84                 // Set error code to 'unknown'
  85                 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
  86
  87                 // Init stacker instance for processed raw data
  88                 $stackInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
  89
  90                 // Remember this in this package handler
  91                 $this->setStackInstance($stackInstance);
  92
  93                 // Init stacker
  94                 $this->initStack();
  95         }
  96
  97         /**
  98          * Initializes the stacker for raw data
  99          *
 100          * @return      void
 101          */
 102         protected function initStack () {
 103                 $this->getStackInstance()->initStack(self::STACKER_NAME_RAW_DATA);
 104         }
 105
 106         /**
 107          * Adds given raw data to the raw data stacker
 108          *
 109          * @param       $rawData        raw data from the socket resource
 110          * @return      void
 111          */
 112         protected function addRawDataToStacker ($rawData) {
 113                 /*
 114                  * Add the deocoded data and error code to the stacker so other classes
 115                  * (e.g. NetworkPackage) can "pop" it from the stacker.
 116                  */
 117                 $this->getStackInstance()->pushNamed(self::STACKER_NAME_RAW_DATA, array(
 118                         self::PACKAGE_RAW_DATA   => $rawData,
 119                         self::PACKAGE_ERROR_CODE => $this->getErrorCode()
 120                 ));
 121         }
 122
 123         /**
 124          * Checks whether raw data is pending for further processing.
 125          *
 126          * @return      $isPending      Whether raw data is pending
 127          */
 128         public function isRawDataPending () {
 129                 // Does the stacker have some entries (not empty)?
 130                 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_RAW_DATA));
 131
 132                 // Return it
 133                 return $isPending;
 134         }
 135
 136         /**
 137          * "Getter" for next raw data from the stacker
 138          *
 139          * @return      $rawData        Raw data from the stacker
 140          */
 141         public function getNextRawData () {
 142                 // "Pop" the raw data from the stacker
 143                 $rawData = $this->getStackInstance()->popNamed(self::STACKER_NAME_RAW_DATA);
 144
 145                 // And return it
 146                 return $rawData;
 147         }
 148
 149         /**
 150          * Checks whether the 'recipient' field matches our own an universal node
 151          * locator.
 152          *
 153          * @param       $packageData    Raw package data
 154          * @return      $matches                Whether it matches
 155          * @todo        This method will be moved to a better place
 156          */
 157         protected function ifRecipientMatchesOwnUniversalNodeLocator (array $packageData) {
 158                 // Construct own address first
 159                 $ownAddress = NodeObjectFactory::createNodeInstance()->determineUniversalNodeLocator();
 160
 161                 // Does it match?
 162                 $matches = ($ownAddress === $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
 163
 164                 // Return result
 165                 return $matches;
 166         }
 167
 168         /**
 169          * Setter for error code
 170          *
 171          * @param       $errorCode      The error code we shall set
 172          * @return      void
 173          */
 174         public final function setErrorCode ($errorCode) {
 175                 $this->errorCode = $errorCode;
 176         }
 177
 178         /**
 179          * Getter for error code
 180          *
 181          * @return      $errorCode      The error code
 182          */
 183         public final function getErrorCode () {
 184                 return $this->errorCode;
 185         }
 186
 187 }