X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=f82d4380d9ed3569ea7e5b7272d74e36c0de22b5;hb=86642f37458f91f78f50b5c7f063e737a5c478ce;hp=c3e4b7d21521497c420e7d5a2df2a95123a9caaf;hpb=3e5e829a9284c30b1a24b720f9c43a68d920d973;p=hub.git

diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php
index c3e4b7d21..f82d4380d 100644
--- a/application/hub/main/nodes/class_BaseHubNode.php
+++ b/application/hub/main/nodes/class_BaseHubNode.php
@@ -4,7 +4,7 @@
  *
  * @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.shipsimu.org
  *
@@ -37,19 +37,9 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	const OBJECT_LIST_SEPARATOR = ',';
 
 	/**
-	 * IP/port number of bootstrapping node
+	 * Universal node locator of bootstrap node
 	 */
-	private $bootIpPort = '';
-
-	/**
-	 * Query connector instance
-	 */
-	private $queryConnectorInstance = NULL;
-
-	/**
-	 * Queue connector instance
-	 */
-	private $queueConnectorInstance = NULL;
+	private $bootUnl = '';
 
 	/**
 	 * Whether this node is anncounced (keep on FALSE!)
@@ -67,6 +57,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 */
 	private $acceptAnnouncements = FALSE;
 
+	/**
+	 * Whether this node accepts DHT bootstrap requests (default: FALSE)
+	 */
+	private $acceptDhtBootstrap = FALSE;
+
 	/**
 	 * Protected constructor
 	 *
@@ -99,40 +94,15 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 * @return	void
 	 */
 	private function initState() {
-		/*
-		 * Get the state factory and create the initial state, we don't need
-		 * the state instance here
-		 */
-		NodeStateFactory::createNodeStateInstanceByName('init', $this);
-	}
-
-	/**
-	 * Generates a random string from various data inluding UUID if PECL
-	 * extension uuid is installed.
-	 *
-	 * @param	$length			Length of the random part
-	 * @return	$randomString	Random string
-	 * @todo	Make this code more generic and move it to CryptoHelper or
-	 */
-	protected function generateRamdomString ($length) {
-		// Get an RNG instance
-		$rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
-
-		// Generate a pseudo-random string
-		$randomString = $rngInstance->randomString($length) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
-
-		// Add UUID for even more entropy for the hasher
-		$randomString .= $this->getCryptoInstance()->createUuid();
-
-		// Return it
-		return $randomString;
+		// Get the state factory and create the initial state.
+		NodeStateFactory::createNodeStateInstanceByName('init');
 	}
 
 	/**
 	 * Generates a private key and hashes it (for speeding up things)
 	 *
 	 * @param	$searchInstance		An instance of a LocalSearchCriteria class
-	 * @return void
+	 * @return	void
 	 */
 	private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) {
 		// Get an RNG instance
@@ -153,81 +123,62 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	}
 
 	/**
-	 * Setter for query instance
+	 * Generates a random string from various data inluding UUID if PECL
+	 * extension uuid is installed.
 	 *
-	 * @param	$connectorInstance		Our new query instance
-	 * @return	void
+	 * @param	$length			Length of the random part
+	 * @return	$randomString	Random string
+	 * @todo	Make this code more generic and move it to CryptoHelper or
 	 */
-	private final function setQueryConnectorInstance (Connectable $connectorInstance) {
-		$this->queryConnectorInstance = $connectorInstance;
-	}
+	protected function generateRamdomString ($length) {
+		// Get an RNG instance
+		$rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
 
-	/**
-	 * Getter for query instance
-	 *
-	 * @return	$connectorInstance		Our new query instance
-	 */
-	public final function getQueryConnectorInstance () {
-		return $this->queryConnectorInstance;
-	}
+		// Generate a pseudo-random string
+		$randomString = $rngInstance->randomString($length) . ':' . $this->getBootUniversalNodeLocator() . ':' . $this->getRequestInstance()->getRequestElement('mode');
 
-	/**
-	 * Setter for queue instance
-	 *
-	 * @param	$connectorInstance		Our new queue instance
-	 * @return	void
-	 */
-	private final function setQueueConnectorInstance (Connectable $connectorInstance) {
-		$this->queueConnectorInstance = $connectorInstance;
-	}
+		// Add UUID for even more entropy for the hasher
+		$randomString .= $this->getCryptoInstance()->createUuid();
 
-	/**
-	 * Getter for queue instance
-	 *
-	 * @return	$connectorInstance		Our new queue instance
-	 */
-	public final function getQueueConnectorInstance () {
-		return $this->queueConnectorInstance;
+		// Return it
+		return $randomString;
 	}
 
 	/**
-	 * Getter for boot IP/port combination
+	 * Getter for boot UNL (Universal Node Locator)
 	 *
-	 * @return	$bootIpPort		The IP/port combination of the boot node
+	 * @return	$bootUnl	The UNL (Universal Node Locator) of the boot node
 	 */
-	protected final function getBootIpPort () {
-		return $this->bootIpPort;
+	protected final function getBootUniversalNodeLocator () {
+		return $this->bootUnl;
 	}
 
 	/**
-	 * Checks whether the given IP address matches one of the bootstrapping nodes
+	 * Checks whether the given IP address matches one of the bootstrap nodes
 	 *
 	 * @param	$remoteAddr		IP address to checkout against our bootstrapping list
 	 * @return	$isFound		Whether the IP is found
 	 */
-	protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
+	protected function ifAddressMatchesBootstrapNodes ($remoteAddr) {
 		// By default nothing is found
 		$isFound = FALSE;
 
 		// Run through all configured IPs
-		foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
-			// Split it up in IP/port
-			$ipPortArray = explode(':', $ipPort);
-
+		foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $unl) {
 			// Does it match?
-			if ($ipPortArray[0] == $remoteAddr) {
+			if ($unl == $remoteAddr) {
 				// Found it!
 				$isFound = TRUE;
 
-				// Remember the port number
-				$this->bootIpPort = $ipPort;
+				// Remember the UNL
+				$this->bootUnl = $unl;
 
 				// Output message
-				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
+				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: UNL matches remote address ' . $unl . '.');
 
 				// Stop further searching
 				break;
-			} elseif ($ipPortArray[0] == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) {
+			} elseif ($unl == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) {
 				/*
 				 * IP matches listen address. At this point we really don't care
 				 * if we can really listen on that address
@@ -235,10 +186,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 				$isFound = TRUE;
 
 				// Remember the port number
-				$this->bootIpPort = $ipPort;
+				$this->bootUnl = $unl;
 
 				// Output message
-				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
+				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: UNL matches listen address ' . $unl . '.');
 
 				// Stop further searching
 				break;
@@ -249,6 +200,31 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		return $isFound;
 	}
 
+	/**
+	 * Tries to detect own UNL (Universal Node Locator)
+	 *
+	 * @return	$unl	Node's own universal node locator
+	 */
+	public function detectOwnUniversalNodeLocator () {
+		// Is "cache" set?
+		if (!isset($GLOBALS[__METHOD__])) {
+			// Get the UNL array back
+			$unlData = $this->getUniversalNodeLocatorArray();
+
+			// There are 2 UNLs, internal and external.
+			if ($this->getConfigInstance()->getConfigEntry('allow_publish_internal_address') == 'N') {
+				// Public "external" UNL address
+				$GLOBALS[__METHOD__] = $unlData[NodeInformationDatabaseWrapper::DB_COLUMN_EXTERNAL_UNL];
+			} else {
+				// Non-public "internal" UNL address
+				$GLOBALS[__METHOD__] = $unlData[NodeInformationDatabaseWrapper::DB_COLUMN_INTERNAL_UNL];
+			}
+		} // END - if
+
+		// Return it
+		return $GLOBALS[__METHOD__];
+	}
+
 	/**
 	 * Outputs the console teaser. This should only be executed on startup or
 	 * full restarts. This method generates some space around the teaser.
@@ -262,7 +238,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		// Output all lines
 		self::createDebugInstance(__CLASS__)->debugOutput(' ');
 		self::createDebugInstance(__CLASS__)->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
-		self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team');
+		self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2015 Hub Developer Team');
 		self::createDebugInstance(__CLASS__)->debugOutput(' ');
 		self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
 		self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
@@ -380,7 +356,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 * @return	void
 	 */
 	public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) {
-		// Make sure request instance is set as it is not optional
+		// Make sure the request instance is set as it is not optional.
 		assert($requestInstance instanceof Requestable);
 
 		// Add node number and type
@@ -400,6 +376,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 			$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY, base64_encode($this->getPrivateKey()));
 			$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH, $this->getPrivateKeyHash());
 		} // END - if
+
+		// Add own external and internal addresses as UNLs
+		$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_INTERNAL_UNL, HubTools::determineOwnInternalAddress());
+		$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_EXTERNAL_UNL, HubTools::determineOwnExternalAddress());
 	}
 
 	/**
@@ -474,7 +454,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		$helperInstance->sendPackage($this);
 
 		// Change the state, this should be the last line except debug output
-		$this->getStateInstance()->nodeAnnouncedToUpperHubs();
+		$this->getStateInstance()->nodeAnnouncingToUpperHubs();
 
 		// Debug output
 		self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED');
@@ -490,7 +470,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 */
 	public function doSelfConnection (Taskable $taskInstance) {
 		// Debug output
-		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
+		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
 
 		// Get a helper instance
 		$helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this));
@@ -505,7 +485,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		$helperInstance->sendPackage($this);
 
 		// Debug output
-		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Self Connection: FINISHED');
+		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Self Connection: FINISHED');
 	}
 
 	/**
@@ -543,7 +523,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 */
 	public function initializeListenerPool () {
 		// Debug output
-		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Initialize listener: START');
+		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: START');
 
 		// Get a new pool instance
 		$this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)));
@@ -603,7 +583,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		$this->getListenerPoolInstance()->addListener($decoratorInstance);
 
 		// Debug output
-		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Initialize listener: FINISHED.');
+		self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: FINISHED.');
 	}
 
 	/**
@@ -638,21 +618,34 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		return $acceptAnnouncements;
 	}
 
+	/**
+	 * Checks whether this node accepts DHT bootstrap requests
+	 *
+	 * @return	$acceptDhtBootstrap	Whether this node accepts DHT bootstrap requests
+	 */
+	public final function isAcceptingDhtBootstrap () {
+		// Check it (this node must be active and not shutdown!)
+		$acceptDhtBootstrap = (($this->acceptDhtBootstrap === TRUE) && ($this->isNodeActive()));
+
+		// Return it
+		return $acceptDhtBootstrap;
+	}
+
 	/**
 	 * Checks whether this node has attempted to announce itself
 	 *
 	 * @return	$hasAnnounced	Whether this node has attempted to announce itself
 	 * @todo	Add checking if this node has been announced to the sender node
 	 */
-	public function ifNodeHasAnnounced () {
+	public function ifNodeIsAnnouncing () {
 		// Debug message
-		/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeIsAnnouncing(): state=' . $this->getStateInstance()->getStateName());
 
 		// Simply check the state of this node
-		$hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncedState);
+		$hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncingState);
 
 		// Debug message
-		/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeIsAnnouncing(): hasAnnounced=' . intval($hasAnnounced));
 
 		// Return it
 		return $hasAnnounced;
@@ -666,13 +659,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	 */
 	public function ifNodeHasAnnouncementCompleted () {
 		// Debug message
-		/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
 
 		// Simply check the state of this node
 		$hasAnnouncementCompleted = ($this->getStateInstance() instanceof NodeAnnouncementCompletedState);
 
 		// Debug message
-		/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
 
 		// Return it
 		return $hasAnnouncementCompleted;
@@ -688,6 +681,17 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		$this->acceptAnnouncements = $acceptAnnouncements;
 	}
 
+	/**
+	 * Enables whether this node accepts DHT bootstrap requests
+	 *
+	 * @param	$acceptDhtBootstrap	Whether this node accepts DHT bootstrap requests (default: TRUE)
+	 * @return	void
+	 */
+	public final function enableAcceptDhtBootstrap ($acceptDhtBootstrap = TRUE) {
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Enabling DHT bootstrap requests ...');
+		$this->acceptDhtBootstrap = $acceptDhtBootstrap;
+	}
+
 	/**
 	 * Checks wether this node is accepting node-list requests
 	 *
@@ -706,29 +710,50 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	}
 
 	/**
-	 * "Getter" for address:port combination
+	 * Determines an instance of a LocateableNode class
 	 *
-	 * @return	$addressPort	A address:port combination for this node
+	 * @return	$unlInstance	An instance of a LocateableNode class for this node
 	 */
-	public final function getAddressPort () {
-		// Get IP and port
-		$addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry('node_listen_port');
+	public function determineUniversalNodeLocator () {
+		// Debug message
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
 
-		// Return it
-		return $addressPort;
+		// Determine UNL based on this node:
+		// 1) Get discovery class
+		$discoveryInstance = ObjectFactory::createObjectByConfiguredName('unl_discovery_class');
+
+		// 2) "Determine" it
+		$unlInstance = $discoveryInstance->discoverUniversalNodeLocatorByNode($this);
+
+		// 3) Return it
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: unlInstance= ' . $unlInstance->__toString() . ' - EXIT!');
+		return $unlInstance;
 	}
 
 	/**
-	 * "Getter" for address:port array
+	 * "Getter" for an array of an instance of a LocateableNode class
 	 *
-	 * @return	$addressPortArray	An array of a address:port combination for this node
+	 * @return	$unlData	An array from an instance of a LocateableNode class for this node
 	 */
-	public final function getAddressPortArray () {
-		// Get IP and port
-		$addressPortArray = explode(':', $this->getAddressPort());
+	public final function getUniversalNodeLocatorArray () {
+		// Debug message
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!');
+
+		// Get the Universal Node Locator (UNL) instance
+		$unlInstance = $this->determineUniversalNodeLocator();
+
+		// Make sure the instance is valid
+		if (!$unlInstance instanceof LocateableNode) {
+			// No valid instance, so better debug this
+			$this->debugBackTrace('unlInstance[' . gettype($unlInstance) . ']=' . $unlInstance);
+		} // END - if
+
+		// ... and the array from it
+		$unlData = $unlInstance->getUnlData();
 
 		// Return it
-		return $addressPortArray;
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
+		return $unlData;
 	}
 
 	/**
@@ -779,6 +804,27 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		// ... and return it
 		return $objectList;
 	}
+
+	/**
+	 * Adds all required elements from given array into data set instance
+	 *
+	 * @param	$dataSetInstance	An instance of a StoreableCriteria class
+	 * @param	$nodeData			An array with valid node data
+	 * @return	void
+	 */
+	public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $nodeData) {
+		// Add all data the array provides
+		foreach (NodeDistributedHashTableDatabaseWrapper::getAllElements() as $element) {
+			// Is the element there?
+			if (isset($nodeData[$element])) {
+				// Add it
+				$dataSetInstance->addCriteria($element, $nodeData[$element]);
+			} else {
+				// Output warning message
+				/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: addArrayToDataSet(): Element ' . $element . ' not found in nodeData array.');
+			}
+		} // END - foreac
+	}
 }
 
 // [EOF]