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