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

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