X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=7aa54834be2b47c24af8b7dcd4aadcea3cf9b692;hb=62f2546efa5ec7585c5ce216e6a9676595b1b30b;hp=1b052c5b909073397a5c4135d050f209078b1522;hpb=df030ed5e35a394da292188307e40eb8d8779509;p=hub.git

diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php
index 1b052c5b9..7aa54834b 100644
--- a/application/hub/main/nodes/class_BaseHubNode.php
+++ b/application/hub/main/nodes/class_BaseHubNode.php
@@ -2,11 +2,11 @@
 /**
  * A general hub node 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 - 2014 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
@@ -37,7 +37,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	const OBJECT_LIST_SEPARATOR = ',';
 
 	/**
-	 * IP/port number of bootstrapping node
+	 * IP/port number of bootstrap node
 	 */
 	private $bootIpPort = '';
 
@@ -52,21 +52,26 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	private $queueConnectorInstance = NULL;
 
 	/**
-	 * Whether this node is anncounced (KEEP ON false!)
+	 * Whether this node is anncounced (keep on FALSE!)
 	 * @deprecated
 	 */
 	private $hubIsAnnounced = FALSE;
 
 	/**
-	 * Whether this hub is active (default: false)
+	 * Whether this hub is active (default: FALSE)
 	 */
 	private $isActive = FALSE;
 
 	/**
-	 * Whether this node accepts announcements (default: false)
+	 * Whether this node accepts announcements (default: FALSE)
 	 */
 	private $acceptAnnouncements = FALSE;
 
+	/**
+	 * Whether this node accepts DHT bootstrap requests (default: FALSE)
+	 */
+	private $acceptDhtBootstrap = FALSE;
+
 	/**
 	 * Protected constructor
 	 *
@@ -99,10 +104,7 @@ 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
-		 */
+		// Get the state factory and create the initial state.
 		NodeStateFactory::createNodeStateInstanceByName('init', $this);
 	}
 
@@ -200,12 +202,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	}
 
 	/**
-	 * 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;
 
@@ -223,7 +225,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 				$this->bootIpPort = $ipPort;
 
 				// Output message
-				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
+				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
 
 				// Stop further searching
 				break;
@@ -238,7 +240,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 				$this->bootIpPort = $ipPort;
 
 				// Output message
-				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
+				self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
 
 				// Stop further searching
 				break;
@@ -262,7 +264,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 - 2014 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');
@@ -474,7 +476,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 +492,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,12 +507,12 @@ 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');
 	}
 
 	/**
 	 * Activates the hub by doing some final preparation and setting
-	 * $hubIsActive to true
+	 * $hubIsActive to TRUE.
 	 *
 	 * @param	$requestInstance	A Requestable class
 	 * @param	$responseInstance	A Responseable class
@@ -543,7 +545,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 +605,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 +640,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 +681,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;
@@ -681,13 +696,24 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 	/**
 	 * Enables whether this node accepts announcements
 	 *
-	 * @param	$acceptAnnouncements	Whether this node accepts announcements (default: true)
+	 * @param	$acceptAnnouncements	Whether this node accepts announcements (default: TRUE)
 	 * @return	void
 	 */
 	protected final function enableAcceptingAnnouncements ($acceptAnnouncements = TRUE) {
 		$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
 	 *
@@ -697,7 +723,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
 		/*
 		 * Only 'regular' nodes does not accept such requests, checking
 		 * HubRegularNode is faster, but if e.g. HubRegularI2PNode will be
-		 * added then the next check will be true.
+		 * added then the next check will be TRUE.
 		 */
 		$acceptsRequest = ((!$this instanceof HubRegularNode) && ($this->getRequestInstance()->getRequestElement('mode') != self::NODE_TYPE_REGULAR));
 
@@ -779,6 +805,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]