X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=f82d4380d9ed3569ea7e5b7272d74e36c0de22b5;hb=86642f37458f91f78f50b5c7f063e737a5c478ce;hp=3795850cabc5b05742845c7f832023d928e0919a;hpb=e9dc00de46c8a00a5f1a05956f012d61eb1c1918;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index 3795850ca..f82d4380d 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 + * @author Roland Haeder * @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 @@ -21,7 +21,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class BaseHubNode extends BaseHubSystem implements Updateable { +class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria { /** * Node types */ @@ -37,35 +37,30 @@ class BaseHubNode extends BaseHubSystem implements Updateable { const OBJECT_LIST_SEPARATOR = ','; /** - * IP/port number of bootstrapping node + * Universal node locator of bootstrap node */ - private $bootIpPort = ''; + private $bootUnl = ''; /** - * Query connector instance - */ - private $queryConnectorInstance = NULL; - - /** - * Queue connector instance + * Whether this node is anncounced (keep on FALSE!) + * @deprecated */ - private $queueConnectorInstance = NULL; + private $hubIsAnnounced = FALSE; /** - * Whether this node is anncounced (KEEP ON false!) - * @deprecated + * Whether this hub is active (default: FALSE) */ - private $hubIsAnnounced = false; + private $isActive = FALSE; /** - * Whether this hub is active (default: false) + * Whether this node accepts announcements (default: FALSE) */ - private $isActive = false; + private $acceptAnnouncements = FALSE; /** - * Whether this node accepts announcements (default: false) + * Whether this node accepts DHT bootstrap requests (default: FALSE) */ - private $acceptAnnouncements = false; + private $acceptDhtBootstrap = FALSE; /** * Protected constructor @@ -77,6 +72,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Call parent constructor parent::__construct($className); + // Get a wrapper instance + $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('node_info_db_wrapper_class'); + + // Set it here + $this->setWrapperInstance($wrapperInstance); + // Get a crypto instance $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); @@ -93,146 +94,102 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @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 + $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); + // Generate a pseudo-random string - $randomString = $this->generateRandomString(255); + $randomString = $rngInstance->randomString(255); // Hash and encrypt the string so we become a node id (also documented as "hub id") $this->setPrivateKey($this->getCryptoInstance()->encryptString($randomString)); $this->setPrivateKeyHash($this->getCryptoInstance()->hashString($this->getPrivateKey())); - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); - // Register the node id with our wrapper - $wrapperInstance->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance); + $this->getWrapperInstance()->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance); // Output message self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . ''); } /** - * 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; + $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; + $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 */ - $isFound = true; + $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; @@ -243,6 +200,31 @@ class BaseHubNode extends BaseHubSystem implements Updateable { 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. @@ -256,7 +238,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // 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'); @@ -274,39 +256,25 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) { - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); - - // Now get a search criteria instance - $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); - - // Search for the node number one which is hard-coded the default - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode')); - $searchInstance->setLimit(1); - - // Get a result back - $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance); - - // Is it valid? - if ($resultInstance->next()) { - // Save the result instance in this class - $this->setResultInstance($resultInstance); - + // Is there a node id? + if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) { // Get the node id from result and set it $this->setNodeId($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID)); // Output message self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . ''); } else { + // Get an RNG instance + $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); + // Generate a pseudo-random string - $randomString = $this->generateRandomString(255); + $randomString = $rngInstance->randomString(255); // Hash and encrypt the string so we become a node id (also documented as "hub id") $this->setNodeId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString))); // Register the node id with our wrapper - $wrapperInstance->registerNodeId($this, $this->getRequestInstance()); + $this->getWrapperInstance()->registerNodeId($this, $this->getRequestInstance()); // Output message self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . ''); @@ -323,21 +291,22 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); // Search for the node number one which is hard-coded the default - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode')); + $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR , 1); + $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $this->getRequestInstance()->getRequestElement('mode')); + $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID , $this->getNodeId()); $searchInstance->setLimit(1); + // Remember it for later usage + $this->setSearchInstance($searchInstance); + // Get a random string $randomString = $this->generateRamdomString(255); // Hash and encrypt the string so we become a "node id" aka Hub-Id $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString))); - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); - // Register the node id with our wrapper - $wrapperInstance->registerSessionId($this, $this->getRequestInstance(), $searchInstance); + $this->getWrapperInstance()->registerSessionId($this, $this->getRequestInstance(), $searchInstance); // Output message self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . ''); @@ -352,25 +321,8 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ public function bootstrapGeneratePrivateKey () { - // Get a wrapper instance - $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); - - // Now get a search criteria instance - $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); - - // Search for the node number one which is hard-coded the default - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode')); - $searchInstance->setLimit(1); - - // Get a result back - $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance); - // Is it valid? - if ($resultInstance->next()) { - // Save the result instance in this class - $this->setResultInstance($resultInstance); - + if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) { // Is the element set? if (is_null($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))) { /* @@ -378,7 +330,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * "tables". This allows a smooth update for the underlaying * database table. */ - $this->generatePrivateKeyAndHash($searchInstance); + $this->generatePrivateKeyAndHash($this->getSearchInstance()); } else { // Get the node id from result and set it $this->setPrivateKey(base64_decode($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))); @@ -392,35 +344,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * Generate it in a private method (no confusion with 'private * method access' and 'private key' here! ;-)). */ - $this->generatePrivateKeyAndHash($searchInstance); + $this->generatePrivateKeyAndHash($this->getSearchInstance()); } } - /** - * Initializes queues which every node needs - * - * @return void - */ - protected function initGenericQueues () { - // Debug message - self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Initialize queues: START'); - - // Set the query connector instance - $this->setQueryConnectorInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); - - // Run a test query - $this->getQueryConnectorInstance()->doTestQuery(); - - // Set the queue connector instance - $this->setQueueConnectorInstance(ObjectFactory::createObjectByConfiguredName('queue_connector_class', array($this))); - - // Run a test queue - $this->getQueueConnectorInstance()->doTestQueue(); - - // Debug message - self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Initialize queues: FINISHED'); - } - /** * Adds hub data elements to a given dataset instance * @@ -428,10 +355,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @param $requestInstance An instance of a Requestable class * @return void */ - public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance) { + public function addElementsToDataSet (StoreableCriteria $criteriaInstance, Requestable $requestInstance = NULL) { + // Make sure the request instance is set as it is not optional. + assert($requestInstance instanceof Requestable); + // Add node number and type - $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR, 1); - $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $requestInstance->getRequestElement('mode')); + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_NR , 1); + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_MODE, $requestInstance->getRequestElement('mode')); // Add the node id $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId()); @@ -446,6 +376,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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()); } /** @@ -497,9 +431,9 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @throws NodeAlreadyAnnouncedException If this hub is already announced * @todo Change the first if() block to check for a specific state */ - public function announceSelfToUpperNodes (Taskable $taskInstance) { + public function announceToUpperNodes (Taskable $taskInstance) { // Is this hub node announced? - if ($this->hubIsAnnounced === true) { + if ($this->hubIsAnnounced === TRUE) { // Already announced! throw new NodeAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED); } // END - if @@ -508,7 +442,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')'); // Get a helper instance - $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class'); + $helperInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_helper_class'); // Load the announcement descriptor $helperInstance->loadDescriptorXml($this); @@ -520,7 +454,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $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'); @@ -536,10 +470,10 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ public function doSelfConnection (Taskable $taskInstance) { // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: 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('hub_self_connect_helper_class', array($this)); + $helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this)); // Load the descriptor (XML) file $helperInstance->loadDescriptorXml($this); @@ -551,12 +485,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $helperInstance->sendPackage($this); // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: 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 @@ -589,7 +523,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ public function initializeListenerPool () { // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: 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))); @@ -604,13 +538,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * All nodes can now use the same configuration entry because it can be * customized in config-local.php. */ - $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port'); + $listenerInstance->setListenPortByConfiguration('node_listen_port'); // Initialize the listener $listenerInstance->initListener(); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_tcp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -631,13 +565,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * All nodes can now use the same configuration entry because it can be * customized in config-local.php. */ - $listenerInstance->setListenPortByConfiguration('node_udp_listen_port'); + $listenerInstance->setListenPortByConfiguration('node_listen_port'); // Initialize the listener $listenerInstance->initListener(); // Get a decorator class - $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_udp_listener_class', array($listenerInstance)); + $decoratorInstance = ObjectFactory::createObjectByConfiguredName('node_udp_listener_class', array($listenerInstance)); // Add this listener to the pool $this->getListenerPoolInstance()->addListener($decoratorInstance); @@ -649,21 +583,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->getListenerPoolInstance()->addListener($decoratorInstance); // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: Initialize listener: FINISHED.'); - } - - /** - * Restores a previously stored node list from database - * - * @return void - * @todo Rewrite this to use DHT instead - */ - public function bootstrapRestoreNodeList () { - // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: Restore node list: START'); - - // Debug output - self::createDebugInstance(__CLASS__)->debugOutput('HUB: Restore node list: FINISHED.'); + self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: FINISHED.'); } /** @@ -681,7 +601,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @param $isActive Whether the hub is active * @return void */ - public final function enableIsActive ($isActive = true) { + public final function enableIsActive ($isActive = TRUE) { $this->isActive = (bool) $isActive; } @@ -692,27 +612,40 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ public final function isAcceptingAnnouncements () { // Check it (this node must be active and not shutdown!) - $acceptAnnouncements = (($this->acceptAnnouncements === true) && ($this->isNodeActive())); + $acceptAnnouncements = (($this->acceptAnnouncements === TRUE) && ($this->isNodeActive())); // Return it 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: 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: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeIsAnnouncing(): hasAnnounced=' . intval($hasAnnounced)); // Return it return $hasAnnounced; @@ -726,13 +659,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ public function ifNodeHasAnnouncementCompleted () { // Debug message - /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE: 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: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted)); // Return it return $hasAnnouncementCompleted; @@ -741,13 +674,24 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * 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) { + 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 * @@ -757,7 +701,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /* * 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)); @@ -766,20 +710,50 @@ class BaseHubNode extends BaseHubSystem implements Updateable { } /** - * "Getter" for address:port combination + * Determines an instance of a LocateableNode class + * + * @return $unlInstance An instance of a LocateableNode class for this node + */ + public function determineUniversalNodeLocator () { + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: CALLED!'); + + // 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 an array of an instance of a LocateableNode class * - * @param $handlerInstance An instance of a Networkable class - * @return $addressPort A address:port combination for this node + * @return $unlData An array from an instance of a LocateableNode class for this node */ - public final function getAddressPort (Networkable $handlerInstance) { - // Construct config entry - $configEntry = 'node_' . $handlerInstance->getHandlerName() . '_listen_port'; + 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(); - // Get IP and port - $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry($configEntry); + // 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 $addressPort; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!'); + return $unlData; } /** @@ -830,6 +804,27 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // ... 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]