X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fclass_BaseHubSystem.php;h=77bf1c3456bf5096e76cb203d92354e44a250413;hb=8d9a1956c3b9e27e37ba12810b165f41e7643196;hp=b1fdccdbd232cb763eab69b0554c1e1b01c2c9b4;hpb=4c4dbb818c6da362302cd02a601cce0c78413bfb;p=hub.git

diff --git a/application/hub/main/class_BaseHubSystem.php b/application/hub/main/class_BaseHubSystem.php
index b1fdccdbd..77bf1c345 100644
--- a/application/hub/main/class_BaseHubSystem.php
+++ b/application/hub/main/class_BaseHubSystem.php
@@ -2,11 +2,11 @@
 /**
  * A general hub system class
  *
- * @author		Roland Haeder <webmaster@ship-simu.org>
+ * @author		Roland Haeder <webmaster@shipsimu.org>
  * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license		GNU GPL 3.0 or any newer version
- * @link		http://www.ship-simu.org
+ * @link		http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,9 +23,18 @@
  */
 class BaseHubSystem extends BaseFrameworkSystem {
 	// Exception codes
-	const EXCEPTION_UNSUPPORTED_ERROR_HANDLER = 0x900;
-	const EXCEPTION_CHUNK_ALREADY_ASSEMBLED   = 0x901;
-	const EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED = 0x902;
+	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;
+	const EXCEPTION_NODE_SESSION_ID_NOT_VERIFYING = 0x906;
+	const EXCEPTION_REQUEST_NOT_ACCEPTED          = 0x907;
+	const EXCEPTION_DHT_BOOTSTRAP_NOT_ACCEPTED    = 0x908;
+	const EXCEPTION_MULTIPLE_MESSAGE_SENT         = 0x909;
+	const EXCEPTION_DHT_BOOTSTRAP_NOT_ATTEMPTED   = 0x90a;
+	const EXCEPTION_INVALID_UNL                   = 0x90b;
 
 	// Message status codes
 	const MESSAGE_STATUS_CODE_OKAY = 'OKAY';
@@ -40,16 +49,6 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 */
 	private $nodeInstance = NULL;
 
-	/**
-	 * An instance of a cruncher
-	 */
-	private $cruncherInstance = NULL;
-
-	/**
-	 * Listener instance
-	 */
-	private $listenerInstance = NULL;
-
 	/**
 	 * A network package handler instance
 	 */
@@ -60,11 +59,6 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 */
 	private $receiverInstance = NULL;
 
-	/**
-	 * State instance
-	 */
-	private $stateInstance = NULL;
-
 	/**
 	 * Listener pool instance
 	 */
@@ -76,14 +70,14 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	private $fragmenterInstance = NULL;
 
 	/**
-	 * Decoder instance
+	 * Assembler instance
 	 */
-	private $decoderInstance = NULL;
+	private $assemblerInstance = NULL;
 
 	/**
-	 * Assembler instance
+	 * Info instance
 	 */
-	private $assemblerInstance = NULL;
+	private $infoInstance = NULL;
 
 	/**
 	 * Protected constructor
@@ -96,63 +90,6 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		parent::__construct($className);
 	}
 
-	/**
-	 * Getter for node instance
-	 *
-	 * @return	$nodeInstance	An instance of a node node
-	 */
-	public final function getNodeInstance () {
-		return $this->nodeInstance;
-	}
-
-	/**
-	 * Setter for node instance
-	 *
-	 * @param	$nodeInstance	An instance of a node node
-	 * @return	void
-	 */
-	protected final function setNodeInstance (NodeHelper $nodeInstance) {
-		$this->nodeInstance = $nodeInstance;
-	}
-
-	/**
-	 * Getter for cruncher instance
-	 *
-	 * @return	$cruncherInstance	An instance of a cruncher cruncher
-	 */
-	public final function getCruncherInstance () {
-		return $this->cruncherInstance;
-	}
-
-	/**
-	 * Setter for cruncher instance
-	 *
-	 * @param	$cruncherInstance	An instance of a cruncher cruncher
-	 * @return	void
-	 */
-	protected final function setCruncherInstance (CruncherHelper $cruncherInstance) {
-		$this->cruncherInstance = $cruncherInstance;
-	}
-
-	/**
-	 * Setter for listener instance
-	 *
-	 * @param	$listenerInstance	A Listenable instance
-	 * @return	void
-	 */
-	protected final function setListenerInstance (Listenable $listenerInstance) {
-		$this->listenerInstance = $listenerInstance;
-	}
-
-	/**
-	 * Getter for listener instance
-	 *
-	 * @return	$listenerInstance	A Listenable instance
-	 */
-	protected final function getListenerInstance () {
-		return $this->listenerInstance;
-	}
-
 	/**
 	 * Setter for network package handler instance
 	 *
@@ -191,29 +128,10 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		return $this->receiverInstance;
 	}
 
-	/**
-	 * Setter for state instance
-	 *
-	 * @param	$stateInstance	A Stateable instance
-	 * @return	void
-	 */
-	public final function setStateInstance (Stateable $stateInstance) {
-		$this->stateInstance = $stateInstance;
-	}
-
-	/**
-	 * Getter for state instance
-	 *
-	 * @return	$stateInstance	A Stateable instance
-	 */
-	public final function getStateInstance () {
-		return $this->stateInstance;
-	}
-
 	/**
 	 * 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) {
@@ -249,47 +167,47 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	}
 
 	/**
-	 * Setter for decoder instance
+	 * Setter for assembler instance
 	 *
-	 * @param	$decoderInstance	A Decodeable instance
+	 * @param	$assemblerInstance	An instance of an Assembler class
 	 * @return	void
 	 */
-	protected final function setDecoderInstance (Decodeable $decoderInstance) {
-		$this->decoderInstance = $decoderInstance;
+	protected final function setAssemblerInstance (Assembler $assemblerInstance) {
+		$this->assemblerInstance = $assemblerInstance;
 	}
 
 	/**
-	 * Getter for decoder instance
+	 * Getter for assembler instance
 	 *
-	 * @return	$decoderInstance	A Decodeable instance
+	 * @return	$assemblerInstance	An instance of an Assembler class
 	 */
-	protected final function getDecoderInstance () {
-		return $this->decoderInstance;
+	protected final function getAssemblerInstance () {
+		return $this->assemblerInstance;
 	}
 
 	/**
-	 * Setter for assembler instance
+	 * Setter for info instance
 	 *
-	 * @param	$assemblerInstance	A Decodeable instance
+	 * @param	$infoInstance	A ShareableInfo instance
 	 * @return	void
 	 */
-	protected final function setAssemblerInstance (Assembler $assemblerInstance) {
-		$this->assemblerInstance = $assemblerInstance;
+	protected final function setInfoInstance (ShareableInfo $infoInstance) {
+		$this->infoInstance = $infoInstance;
 	}
 
 	/**
-	 * Getter for assembler instance
+	 * Getter for info instance
 	 *
-	 * @return	$assemblerInstance	A Decodeable instance
+	 * @return	$infoInstance	An instance of a ShareableInfo class
 	 */
-	protected final function getAssemblerInstance () {
-		return $this->assemblerInstance;
+	public final function getInfoInstance () {
+		return $this->infoInstance;
 	}
 
 	/**
 	 * Setter for node id
 	 *
-	 * @param	$nodeId		Our new node id
+	 * @param	$nodeId		The new node id
 	 * @return	void
 	 */
 	protected final function setNodeId ($nodeId) {
@@ -307,10 +225,52 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		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		Our new session id
+	 * @param	$sessionId	The new session id
 	 * @return	void
 	 */
 	protected final function setSessionId ($sessionId) {
@@ -320,7 +280,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	/**
 	 * Getter for session id
 	 *
-	 * @return	$sessionId		Current session id
+	 * @return	$sessionId	Current session id
 	 */
 	public final function getSessionId () {
 		return $this->getConfigInstance()->getConfigEntry('session_id');
@@ -336,7 +296,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 */
 	protected function getSocketErrorHandlerFromCode ($errorCode) {
 		// Create a name from translated error code
-		$handlerName = 'socketError' . $this->convertToClassName($this->translateSocketErrorCodeToName($errorCode)) . 'Handler';
+		$handlerName = 'socketError' . self::convertToClassName($this->translateSocketErrorCodeToName($errorCode)) . 'Handler';
 
 		// Is the call-back method there?
 		if (!method_exists($this, $handlerName)) {
@@ -354,21 +314,26 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 * 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
+	 * @param	$unlData			A valid UNL data array
 	 * @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 $unlData) {
 		// This method handles only socket resources
 		if (!is_resource($socketResource)) {
 			// No resource, abort here
 			throw new InvalidSocketException(array($this, $socketResource), BaseListener::EXCEPTION_INVALID_SOCKET);
 		} // END - if
 
-		// Check count of array, should be two
-		assert(count($recipientData) == 2);
+		// Check UNL array
+		//* DEBUG-DIE: */ die(__METHOD__ . ':unlData=' . print_r($unlData, TRUE));
+		assert(isset($unlData[UniversalNodeLocator::UNL_PART_PROTOCOL]));
+		assert(isset($unlData[UniversalNodeLocator::UNL_PART_ADDRESS]));
+		assert(isset($unlData[UniversalNodeLocator::UNL_PART_PORT]));
 
 		// Get error code for first validation (0 is not an error)
 		$errorCode = socket_last_error($socketResource);
@@ -383,42 +348,12 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		$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, $unlData));
 
 		// 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: */ $this->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.
@@ -439,6 +374,14 @@ class BaseHubSystem extends BaseFrameworkSystem {
 				$errorName = BaseRawDataHandler::SOCKET_ERROR_RESOURCE_UNAVAILABLE;
 				break;
 
+			case 32:  // "Broken pipe"
+				$errorName = BaseRawDataHandler::SOCKET_ERROR_BROKEN_PIPE;
+				break;
+
+			case 104: // "Connection reset by peer"
+				$errorName = BaseRawDataHandler::SOCKET_ERROR_CONNECTION_RESET_BY_PEER;
+				break;
+
 			case 107: // "Transport end-point not connected"
 			case 134: // On some (?) systems for 'transport end-point not connected'
 				// @TODO On some systems it is 134, on some 107?
@@ -467,7 +410,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 
 			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('BASE-HUB[' . __METHOD__ . ':' . __LINE__ . '] UNKNOWN ERROR CODE = ' . $errorCode . ', MESSAGE = ' . socket_strerror($errorCode));
 
 				// Change it only in this class
 				$errorName = BaseRawDataHandler::SOCKET_ERROR_UNKNOWN;
@@ -487,7 +430,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 */
 	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);
@@ -496,7 +439,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		$visitorInstance = ObjectFactory::createObjectByConfiguredName('shutdown_socket_visitor_class');
 
 		// Debug output
-		$this->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
+		self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
 
 		// Call the visitor
 		$this->accept($visitorInstance);
@@ -511,7 +454,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 	 */
 	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);
@@ -520,7 +463,7 @@ class BaseHubSystem extends BaseFrameworkSystem {
 		$visitorInstance = ObjectFactory::createObjectByConfiguredName('half_shutdown_socket_visitor_class');
 
 		// Debug output
-		$this->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
+		self::createDebugInstance(__CLASS__)->debugOutput('HUB-SYSTEM:' . $this->__toString() . ': visitorInstance=' . $visitorInstance->__toString());
 
 		// Call the visitor
 		$this->accept($visitorInstance);