3 * A general Handler for raw data from sockets
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class BaseRawDataHandler extends BaseHandler {
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_CONNECTED = 'connected'; // Nothing errorous happens, socket is connected
43 const PACKAGE_ERROR_INVALID_DATA = 'invalid_data'; // Invalid data in package found
44 const PACKAGE_ERROR_INCOMPLETE_DATA = 'incomplete_data'; // Incomplete data sent (e.g. field is missing)
45 const PACKAGE_ERROR_INVALID_CONTENT = 'invalid_content'; // Content is invalid (e.g. not well-formed)
46 const PACKAGE_ERROR_RECIPIENT_MISMATCH = 'recipient_error'; // Recipient is not us
47 const PACKAGE_LEVEL_CHECK_OKAY = 'checked_package'; // Package is fine
50 const PACKAGE_RAW_DATA = 'raw_data';
51 const PACKAGE_ERROR_CODE = 'error_code';
54 const STREAM_START_MARKER = '[[S]]';
55 const STREAM_END_MARKER = '[[E]]';
58 * Stacker for raw data
60 const STACKER_NAME_RAW_DATA = 'raw_data';
63 * Error code from socket
65 private $errorCode = -1;
68 * Protected constructor
70 * @param $className Name of the class
73 protected function __construct ($className) {
74 // Call parent constructor
75 parent::__construct($className);
77 // Set error code to 'unknown'
78 $this->setErrorCode(self::SOCKET_ERROR_UNKNOWN);
80 // Init stacker instance for processed raw data
81 $stackInstance = ObjectFactory::createObjectByConfiguredName('node_raw_data_stacker_class');
83 // Remember this in this package handler
84 $this->setStackInstance($stackInstance);
91 * Initializes the stacker for raw data
95 protected function initStack () {
96 $this->getStackInstance()->initStack(self::STACKER_NAME_RAW_DATA);
100 * Adds given raw data to the raw data stacker
102 * @param $rawData raw data from the socket resource
105 protected function addRawDataToStacker ($rawData) {
107 * Add the deocoded data and error code to the stacker so other classes
108 * (e.g. NetworkPackage) can "pop" it from the stacker.
110 $this->getStackInstance()->pushNamed(self::STACKER_NAME_RAW_DATA, array(
111 self::PACKAGE_RAW_DATA => $rawData,
112 self::PACKAGE_ERROR_CODE => $this->getErrorCode()
117 * Checks whether raw data is pending for further processing.
119 * @return $isPending Whether raw data is pending
121 public function isRawDataPending () {
122 // Does the stacker have some entries (not empty)?
123 $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_RAW_DATA));
130 * "Getter" for next raw data from the stacker
132 * @return $rawData Raw data from the stacker
134 public function getNextRawData () {
135 // "Pop" the raw data from the stacker
136 $rawData = $this->getStackInstance()->popNamed(self::STACKER_NAME_RAW_DATA);
143 * Checks whether the 'recipient' field matches our own an universal node
146 * @param $packageData Raw package data
147 * @return $matches Whether it matches
148 * @todo This method will be moved to a better place
150 protected function ifRecipientMatchesOwnUniversalNodeLocator (array $packageData) {
151 // Construct own address first
152 $ownAddress = NodeObjectFactory::createNodeInstance()->determineUniversalNodeLocator();
155 $matches = ($ownAddress === $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
162 * Setter for error code
164 * @param $errorCode The error code we shall set
167 public final function setErrorCode ($errorCode) {
168 $this->errorCode = $errorCode;
172 * Getter for error code
174 * @return $errorCode The error code
176 public final function getErrorCode () {
177 return $this->errorCode;