*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
class BaseHubSystem extends BaseFrameworkSystem {
// Exception codes
- const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x900;
+ const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x900;
+ const EXCEPTION_CHUNK_ALREADY_ASSEMBLED = 0x901;
+ const EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED = 0x902;
+ const EXCEPTION_INVALID_CONNECTION_TYPE = 0x903;
+ const EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED = 0x904;
+ const EXCEPTION_BASE64_ENCODING_NOT_MODULO_4 = 0x905;
+
+ // Message status codes
+ const MESSAGE_STATUS_CODE_OKAY = 'OKAY';
/**
* Separator for all bootstrap node entries
*/
private $listenerPoolInstance = NULL;
+ /**
+ * Fragmenter instance
+ */
+ private $fragmenterInstance = NULL;
+
+ /**
+ * Decoder instance
+ */
+ private $decoderInstance = NULL;
+
+ /**
+ * Assembler instance
+ */
+ private $assemblerInstance = NULL;
+
/**
* Protected constructor
*
/**
* Setter for network package handler instance
*
- * @param $packageInstance The network package handler instance we shall set
+ * @param $packageInstance The network package instance we shall set
* @return void
*/
- protected final function setPackageInstance (Networkable $packageInstance) {
+ protected final function setPackageInstance (Deliverable $packageInstance) {
$this->packageInstance = $packageInstance;
}
/**
* Setter for listener pool instance
*
- * @param $listenerPoolInstance Our new listener pool instance
+ * @param $listenerPoolInstance The new listener pool instance
* @return void
*/
protected final function setListenerPoolInstance (PoolableListener $listenerPoolInstance) {
return $this->listenerPoolInstance;
}
+ /**
+ * Setter for fragmenter instance
+ *
+ * @param $fragmenterInstance A Fragmentable instance
+ * @return void
+ */
+ protected final function setFragmenterInstance (Fragmentable $fragmenterInstance) {
+ $this->fragmenterInstance = $fragmenterInstance;
+ }
+
+ /**
+ * Getter for fragmenter instance
+ *
+ * @return $fragmenterInstance A Fragmentable instance
+ */
+ protected final function getFragmenterInstance () {
+ return $this->fragmenterInstance;
+ }
+
+ /**
+ * Setter for decoder instance
+ *
+ * @param $decoderInstance A Decodeable instance
+ * @return void
+ */
+ protected final function setDecoderInstance (Decodeable $decoderInstance) {
+ $this->decoderInstance = $decoderInstance;
+ }
+
+ /**
+ * Getter for decoder instance
+ *
+ * @return $decoderInstance A Decodeable instance
+ */
+ protected final function getDecoderInstance () {
+ return $this->decoderInstance;
+ }
+
+ /**
+ * Setter for assembler instance
+ *
+ * @param $assemblerInstance A Decodeable instance
+ * @return void
+ */
+ protected final function setAssemblerInstance (Assembler $assemblerInstance) {
+ $this->assemblerInstance = $assemblerInstance;
+ }
+
+ /**
+ * Getter for assembler instance
+ *
+ * @return $assemblerInstance A Decodeable instance
+ */
+ protected final function getAssemblerInstance () {
+ return $this->assemblerInstance;
+ }
+
+ /**
+ * Setter for node id
+ *
+ * @param $nodeId The new node id
+ * @return void
+ */
+ protected final function setNodeId ($nodeId) {
+ // Set it config now
+ $this->getConfigInstance()->setConfigEntry('node_id', (string) $nodeId);
+ }
+
+ /**
+ * Getter for node id
+ *
+ * @return $nodeId Current node id
+ */
+ public final function getNodeId () {
+ // Get it from config
+ return $this->getConfigInstance()->getConfigEntry('node_id');
+ }
+
+ /**
+ * Setter for private key
+ *
+ * @param $privateKey The new private key
+ * @return void
+ */
+ protected final function setPrivateKey ($privateKey) {
+ // Set it config now
+ $this->getConfigInstance()->setConfigEntry('private_key', (string) $privateKey);
+ }
+
+ /**
+ * Getter for private key
+ *
+ * @return $privateKey Current private key
+ */
+ public final function getPrivateKey () {
+ // Get it from config
+ return $this->getConfigInstance()->getConfigEntry('private_key');
+ }
+
+ /**
+ * Setter for private key hash
+ *
+ * @param $privateKeyHash The new private key hash
+ * @return void
+ */
+ protected final function setPrivateKeyHash ($privateKeyHash) {
+ // Set it config now
+ $this->getConfigInstance()->setConfigEntry('private_key_hash', (string) $privateKeyHash);
+ }
+
+ /**
+ * Getter for private key hash
+ *
+ * @return $privateKeyHash Current private key hash
+ */
+ public final function getPrivateKeyHash () {
+ // Get it from config
+ return $this->getConfigInstance()->getConfigEntry('private_key_hash');
+ }
+
+ /**
+ * Setter for session id
+ *
+ * @param $sessionId The new session id
+ * @return void
+ */
+ protected final function setSessionId ($sessionId) {
+ $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId);
+ }
+
+ /**
+ * Getter for session id
+ *
+ * @return $sessionId Current session id
+ */
+ public final function getSessionId () {
+ return $this->getConfigInstance()->getConfigEntry('session_id');
+ }
+
/**
* Constructs a callable method name from given socket error code. If the
* method is not found, a generic one is used.
*
* @param $errorCode Error code from socket_last_error()
- * @return $methodName Call-back method name for the error handler
+ * @return $handlerName Call-back method name for the error handler
* @throws UnsupportedSocketErrorHandlerException If the error handler is not implemented
*/
protected function getSocketErrorHandlerFromCode ($errorCode) {
- // Set NULL, so everyone is forced to implement socket error handlers
- $handlerName = NULL;
-
- // Temporary create a possible name from translated error code
+ // Create a name from translated error code
$handlerName = 'socketError' . $this->convertToClassName($this->translateSocketErrorCodeToName($errorCode)) . 'Handler';
// Is the call-back method there?
* but assumes valid data in array $recipientData, except that
* count($recipientData) is always 2.
*
+ * @param $method Value of __METHOD__ from calling method
+ * @param $line Value of __LINE__ from calling method
* @param $socketResource A valid socket resource
* @param $recipientData An array with two elements: 0=IP number, 1=port number
* @return void
* @throws InvalidSocketException If $socketResource is no socket resource
* @throws NoSocketErrorDetectedException If socket_last_error() gives zero back
*/
- protected final function handleSocketError ($socketResource, array $recipientData) {
+ protected final function handleSocketError ($method, $line, $socketResource, array $recipientData) {
// This method handles only socket resources
if (!is_resource($socketResource)) {
// No resource, abort here
$handlerName = $this->getSocketErrorHandlerFromCode($errorCode);
// Call-back the error handler method
- call_user_func(array($this, $handlerName), $socketResource);
+ call_user_func_array(array($this, $handlerName), array($socketResource, $recipientData));
// Finally clear the error because it has been handled
socket_clear_error($socketResource);
}
+ /**
+ * Checks whether the final (last) chunk is valid
+ *
+ * @param $chunks An array with chunks and (hopefully) a valid final chunk
+ * @return $isValid Whether the final (last) chunk is valid
+ */
+ protected function isValidFinalChunk (array $chunks) {
+ // Default is all fine
+ $isValid = true;
+
+ // Split the (possible) EOP chunk
+ $chunkSplits = explode(PackageFragmenter::CHUNK_DATA_HASH_SEPARATOR, $chunks[count($chunks) - 1]);
+
+ // Make sure chunks with only 3 elements are parsed (for details see ChunkHandler)
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('eopChunk=' . $chunks[count($chunks) - 1] . ',chunkSplits=' . print_r($chunkSplits, true));
+ assert(count($chunkSplits) == 3);
+
+ // Validate final chunk
+ if (substr($chunkSplits[ChunkHandler::CHUNK_SPLITS_INDEX_RAW_DATA], 0, strlen(PackageFragmenter::END_OF_PACKAGE_IDENTIFIER)) != PackageFragmenter::END_OF_PACKAGE_IDENTIFIER) {
+ // Not fine
+ $isValid = false;
+ } elseif (substr_count($chunkSplits[ChunkHandler::CHUNK_SPLITS_INDEX_RAW_DATA], PackageFragmenter::CHUNK_HASH_SEPARATOR) != 1) {
+ // CHUNK_HASH_SEPARATOR shall only be found once
+ $isValid = false;
+ }
+
+ // Return status
+ return $isValid;
+ }
+
/**
* Translates socket error codes into our own internal names which can be
* used for call-backs.
default: // Everything else <> 0
// Unhandled error code detected, so first debug it because we may want to handle it like the others
- $this->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] UNKNOWN ERROR CODE = ' . $errorCode . ', MESSAGE = ' . socket_strerror($errorCode));
+ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] UNKNOWN ERROR CODE = ' . $errorCode . ', MESSAGE = ' . socket_strerror($errorCode));
// Change it only in this class
$errorName = BaseRawDataHandler::SOCKET_ERROR_UNKNOWN;
*/
public function shutdownSocket ($socketResource) {
// Debug message
- $this->debugOutput('HUB-SYSTEM: Shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM: Shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
// Set socket resource
$this->setSocketResource($socketResource);
// Get a visitor instance
$visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_socket_visitor_class');
+ // Debug output
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
+
// Call the visitor
$this->accept($visitorInstance);
}
*/
public function halfShutdownSocket ($socketResource) {
// Debug message
- $this->debugOutput('HUB-SYSTEM: Half-shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM: Half-shutting down socket resource ' . $socketResource . ' with state ' . $this->getPrintableState() . ' ...');
// Set socket resource
$this->setSocketResource($socketResource);
// Get a visitor instance
$visitorInstance = ObjectFactory::createObjectByConfiguredName('half_shutdown_socket_visitor_class');
+ // Debug output
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
+
// Call the visitor
$this->accept($visitorInstance);
}
projects / hub.git / blobdiff