/**
* 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, 2010 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
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-class BaseHubNode extends BaseHubSystem implements Updateable {
+class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
+ /**
+ * Node types
+ */
+ const NODE_TYPE_BOOT = 'boot';
+ const NODE_TYPE_MASTER = 'master';
+ const NODE_TYPE_LIST = 'list';
+ const NODE_TYPE_REGULAR = 'regular';
+
// Exception constants
const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00;
- /**
- * IP/port number of bootstrapping node
- */
- private $bootIpPort = '';
+ // Other constants
+ const OBJECT_LIST_SEPARATOR = ',';
/**
- * Query connector instance
+ * Universal node locator of bootstrap node
*/
- private $connectorInstance = null;
+ private $bootUnl = '';
/**
- * Listener pool instance
+ * Whether this node is anncounced (keep on FALSE!)
+ * @deprecated
*/
- private $listenerPoolInstance = null;
+ private $hubIsAnnounced = FALSE;
/**
- * Wether this node is anncounced (KEEP ON false!)
- * @deprecated
+ * Whether this hub is active (default: FALSE)
*/
- private $hubIsAnnounced = false;
+ private $isActive = FALSE;
/**
- * State instance
+ * Whether this node accepts announcements (default: FALSE)
*/
- private $stateInstance = null;
+ private $acceptAnnouncements = FALSE;
/**
- * Wether this hub is active
+ * Whether this node accepts DHT bootstrap requests (default: FALSE)
*/
- private $isActive = false;
+ private $acceptDhtBootstrap = FALSE;
/**
* Protected constructor
// 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');
+
+ // Set it here
+ $this->setCryptoInstance($cryptoInstance);
+
// Init state which sets the state to 'init'
$this->initState();
}
* @return void
*/
private function initState() {
- // Get the state factory and create the initial state, we don't need
- // the state instance here
- StateFactory::createStateInstanceByName('init', $this);
+ // Get the state factory and create the initial state.
+ NodeStateFactory::createNodeStateInstanceByName('init', $this);
}
/**
- * Setter for node id
+ * Generates a private key and hashes it (for speeding up things)
*
- * @param $nodeId Our new node id
+ * @param $searchInstance An instance of a LocalSearchCriteria class
* @return void
*/
- private final function setNodeId ($nodeId) {
- // Set it config now
- $this->getConfigInstance()->setConfigEntry('node_id', (string) $nodeId);
- }
+ private function generatePrivateKeyAndHash (LocalSearchCriteria $searchInstance) {
+ // Get an RNG instance
+ $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
- /**
- * Getter for node id
- *
- * @return $nodeId Current node id
- */
- private final function getNodeId () {
- // Get it from config
- return $this->getConfigInstance()->getConfigEntry('node_id');
- }
+ // Generate a pseudo-random string
+ $randomString = $rngInstance->randomString(255);
- /**
- * Setter for listener pool instance
- *
- * @param $listenerPoolInstance Our new listener pool instance
- * @return void
- */
- private final function setListenerPoolInstance (PoolableListener $listenerPoolInstance) {
- $this->listenerPoolInstance = $listenerPoolInstance;
- }
+ // 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()));
- /**
- * Getter for listener pool instance
- *
- * @return $listenerPoolInstance Our current listener pool instance
- */
- public final function getListenerPoolInstance () {
- return $this->listenerPoolInstance;
- }
-
- /**
- * Setter for state instance
- *
- * @param $stateInstance Node's current state instance
- * @return void
- */
- public final function setStateInstance (Stateable $stateInstance) {
- $this->stateInstance = $stateInstance;
- }
+ // Register the node id with our wrapper
+ $this->getWrapperInstance()->registerPrivateKey($this, $this->getRequestInstance(), $searchInstance);
- /**
- * Getter for state instance
- *
- * @return $stateInstance Node's current state instance
- */
- public final function getStateInstance () {
- return $this->stateInstance;
+ // Output message
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new private key with hash: ' . $this->getPrivateKeyHash() . '');
}
/**
- * Setter for session id
+ * Generates a random string from various data inluding UUID if PECL
+ * extension uuid is installed.
*
- * @param $sessionId Our new session id
- * @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 setSessionId ($sessionId) {
- $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId);
- }
+ protected function generateRamdomString ($length) {
+ // Get an RNG instance
+ $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
- /**
- * Getter for session id
- *
- * @return $sessionId Current session id
- */
- public final function getSessionId () {
- return $this->getConfigInstance()->getConfigEntry('session_id');
- }
+ // Generate a pseudo-random string
+ $randomString = $rngInstance->randomString($length) . ':' . $this->getBootUniversalNodeLocator() . ':' . $this->getRequestInstance()->getRequestElement('mode');
- /**
- * Setter for query instance
- *
- * @param $connectorInstance Our new query instance
- * @return void
- */
- private final function setQueryConnectorInstance (Connectable $connectorInstance) {
- $this->connectorInstance = $connectorInstance;
- }
+ // Add UUID for even more entropy for the hasher
+ $randomString .= $this->getCryptoInstance()->createUuid();
- /**
- * Getter for query instance
- *
- * @return $connectorInstance Our new query instance
- */
- public final function getQueryConnectorInstance () {
- return $this->connectorInstance;
+ // 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;
}
/**
- * "Getter" for a printable state name
- */
- public final function getPrintableState () {
- // Default is 'null'
- $stateName = 'null';
-
- // Get the state instance
- $stateInstance = $this->getStateInstance();
-
- // Is it an instance of Stateable?
- if ($stateInstance instanceof Stateable) {
- // Then use that state name
- $stateName = $stateInstance->getStateName();
- } // END - if
-
- // Return result
- return $stateName;
- }
-
- /**
- * Checks wether 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 Wether the IP is found
+ * @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(',', $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
- $this->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')) {
- // IP matches listen address. At this point we really don't care
- // if we can also listen on that address!
- $isFound = true;
+ } 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;
// Remember the port number
- $this->bootIpPort = $ipPort;
+ $this->bootUnl = $unl;
// Output message
- $this->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;
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.
$app = $this->getApplicationInstance();
// Output all lines
- $this->debugOutput(' ');
- $this->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
- $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009, 2010 Hub Developer Team');
- $this->debugOutput(' ');
- $this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
- $this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
- $this->debugOutput('conditions; see docs/COPYING for details.');
- $this->debugOutput(' ');
+ 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 - 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');
+ self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
+ self::createDebugInstance(__CLASS__)->debugOutput(' ');
}
/**
* @param $responseInstance A Responseable class
* @return void
*/
- public function bootstrapAcquireHubId (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 zero 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);
-
+ public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) {
+ // 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
- $this->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found node-id: ' . $this->getNodeId() . '');
} else {
- // Get an RNG instance (Random Number Generator)
+ // Get an RNG instance
$rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
// Generate a pseudo-random string
- $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
+ $randomString = $rngInstance->randomString(255);
- // Get a crypto instance
- $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
-
- // Hash and encrypt the string so we become a "node id" aka Hub-Id
- $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
+ // 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
- $this->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new node-id: ' . $this->getNodeId() . '');
}
}
/**
- * Generates a session id which will be sent to the other hubs and clients
+ * Generates a session id which will be sent to the other hubs and peers
*
* @return void
*/
public function bootstrapGenerateSessionId () {
- // Get an RNG instance
- $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
+ // Now get a search criteria instance
+ $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
- // Generate a pseudo-random string
- $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode');
+ // 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_MODE, $this->getRequestInstance()->getRequestElement('mode'));
+ $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID , $this->getNodeId());
+ $searchInstance->setLimit(1);
- // Get a crypto instance
- $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
+ // Remember it for later usage
+ $this->setSearchInstance($searchInstance);
- // Hash and encrypt the string so we become a "node id" aka Hub-Id
- $this->setSessionId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
+ // Get a random string
+ $randomString = $this->generateRamdomString(255);
- // Get a wrapper instance
- $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
+ // Hash and encrypt the string so we become a "node id" aka Hub-Id
+ $this->setSessionId($this->getCryptoInstance()->hashString($this->getCryptoInstance()->encryptString($randomString)));
// Register the node id with our wrapper
- $wrapperInstance->registerSessionId($this, $this->getRequestInstance());
+ $this->getWrapperInstance()->registerSessionId($this, $this->getRequestInstance(), $searchInstance);
// Output message
- $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
// Change the state because the node has auired a hub id
$this->getStateInstance()->nodeGeneratedSessionId();
}
/**
- * Initializes queues which every node needs
+ * Generate a private key for en-/decryption
*
* @return void
*/
- protected function initGenericQueues () {
- // Debug message
- $this->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();
+ public function bootstrapGeneratePrivateKey () {
+ // Is it valid?
+ if ($this->getWrapperInstance()->ifNodeDataIsFound($this)) {
+ // Is the element set?
+ if (is_null($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY))) {
+ /*
+ * Auto-generate the private key for e.g. out-dated database
+ * "tables". This allows a smooth update for the underlaying
+ * database table.
+ */
+ $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)));
+ $this->setPrivateKeyHash($this->getField(NodeInformationDatabaseWrapper::DB_COLUMN_PRIVATE_KEY_HASH));
- // Debug message
- $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
+ // Output message
+ self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Re-using found private key hash: ' . $this->getPrivateKeyHash() . '');
+ }
+ } else {
+ /*
+ * Generate it in a private method (no confusion with 'private
+ * method access' and 'private key' here! ;-)).
+ */
+ $this->generatePrivateKeyAndHash($this->getSearchInstance());
+ }
}
/**
* @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());
if ($this->getSessionId() != '') {
$criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId());
} // END - if
+
+ // Add the private key if acquired
+ if ($this->getPrivateKey() != '') {
+ $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());
}
/**
/**
* Announces this hub to the upper (bootstrap or list) hubs. After this is
- * successfully done the given task is unregistered from the handler.
+ * successfully done the given task is unregistered from the handler. This
+ * might look a bit overloaded here but the announcement phase isn't a
+ * simple "Hello there" message, it may later on also contain more
+ * informations like the object list.
*
* @param $taskInstance The task instance running this announcement
* @return void
- * @throws HubAlreadyAnnouncedException If this hub is already announced
+ * @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 HubAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED);
+ throw new NodeAlreadyAnnouncedException($this, self::EXCEPTION_HUB_ALREADY_ANNOUNCED);
} // END - if
// Debug output
- $this->debugOutput('HUB: Self-announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
+ self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
// Get a helper instance
- $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this));
+ $helperInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_helper_class');
// Load the announcement descriptor
- $helperInstance->loadAnnouncementDescriptor();
-
- // Set some dummy configuration entries, e.g. node_status
- $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
+ $helperInstance->loadDescriptorXml($this);
// Compile all variables
$helperInstance->getTemplateInstance()->compileConfigInVariables();
// "Publish" the descriptor by sending it to the bootstrap/list nodes
- $helperInstance->publishAnnouncementDescriptor();
+ $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');
+ }
+
+ /**
+ * Does a self-connect attempt on the public IP address. This should make
+ * it sure, we are reachable from outside world. For this kind of package we
+ * don't need that overload we have in the announcement phase.
+ *
+ * @param $taskInstance The task instance running this announcement
+ * @return void
+ */
+ public function doSelfConnection (Taskable $taskInstance) {
+ // Debug output
+ 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));
+
+ // Load the descriptor (XML) file
+ $helperInstance->loadDescriptorXml($this);
+
+ // Compile all variables
+ $helperInstance->getTemplateInstance()->compileConfigInVariables();
+
+ // And send the package away
+ $helperInstance->sendPackage($this);
// Debug output
- $this->debugOutput('HUB: Self-announcement: 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
* @return void
*/
- public function activateHub (Requestable $requestInstance, Responseable $responseInstance) {
- // Checks wether a listener is still active and shuts it down if one
+ public function activateNode (Requestable $requestInstance, Responseable $responseInstance) {
+ // Checks whether a listener is still active and shuts it down if one
// is still listening.
- if (($this->determineIfListenerIsActive()) && ($this->getIsActive())) {
+ if (($this->determineIfListenerIsActive()) && ($this->isNodeActive())) {
// Shutdown them down before they can hurt anything
$this->shutdownListenerPool();
} // END - if
*/
public function initializeListenerPool () {
// Debug output
- $this->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)));
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port');
+
+ /*
+ * All nodes can now use the same configuration entry because it can be
+ * customized in config-local.php.
+ */
+ $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);
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- $listenerInstance->setListenPortByConfiguration('node_udp_listen_port');
+
+ /*
+ * All nodes can now use the same configuration entry because it can be
+ * customized in config-local.php.
+ */
+ $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);
$this->getListenerPoolInstance()->addListener($decoratorInstance);
// Debug output
- $this->debugOutput('HUB: Initialize listener: FINISHED.');
+ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: FINISHED.');
}
/**
- * Restores a previously stored node list from database
+ * Getter for isActive attribute
+ *
+ * @return $isActive Whether the hub is active
+ */
+ public final function isNodeActive () {
+ return $this->isActive;
+ }
+
+ /**
+ * Enables (default) or disables isActive flag
*
+ * @param $isActive Whether the hub is active
* @return void
*/
- public function bootstrapRestoreNodeList () {
- // Debug output
- $this->debugOutput('HUB: Restore node list: START');
+ public final function enableIsActive ($isActive = TRUE) {
+ $this->isActive = (bool) $isActive;
+ }
- // Get a wrapper instance
- $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_db_wrapper_class');
+ /**
+ * Checks whether this node accepts announcements
+ *
+ * @return $acceptAnnouncements Whether this node accepts announcements
+ */
+ public final function isAcceptingAnnouncements () {
+ // Check it (this node must be active and not shutdown!)
+ $acceptAnnouncements = (($this->acceptAnnouncements === TRUE) && ($this->isNodeActive()));
- // Now get a search criteria instance
- $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+ // Return it
+ return $acceptAnnouncements;
+ }
- // Search for the node number zero which is hard-coded the default
- // @TODO Add some criteria, e.g. if the node is active or so
- //$searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_NR, 1);
- //$searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode'));
- //$searchInstance->setLimit(1);
+ /**
+ * 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()));
- // Get a result back
- $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance);
+ // Return it
+ return $acceptDhtBootstrap;
+ }
- // Is it valid?
- if ($resultInstance->next()) {
- $this->partialStub('Do something for restoring the list.');
- // Output message
- //$this->debugOutput('HUB: ');
- } else {
- // No previously saved node list found!
- $this->debugOutput('HUB: No previously saved node list found. This is fine.');
- }
+ /**
+ * 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 ifNodeIsAnnouncing () {
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeIsAnnouncing(): state=' . $this->getStateInstance()->getStateName());
- // Debug output
- $this->debugOutput('HUB: Restore node list: FINISHED.');
+ // Simply check the state of this node
+ $hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncingState);
+
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeIsAnnouncing(): hasAnnounced=' . intval($hasAnnounced));
+
+ // Return it
+ return $hasAnnounced;
}
/**
- * Getter for isActive attribute
+ * Checks whether this node has attempted to announce itself and completed it
*
- * @return $isActive Wether the hub is active
+ * @return $hasAnnouncementCompleted Whether this node has attempted to announce itself and completed it
+ * @todo Add checking if this node has been announced to the sender node
*/
- public final function getIsActive () {
- return $this->isActive;
+ public function ifNodeHasAnnouncementCompleted () {
+ // Debug message
+ //* 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
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
+
+ // Return it
+ return $hasAnnouncementCompleted;
}
/**
- * Enables (default) or disables isActive flag
+ * Enables whether this node accepts announcements
*
- * @param $isActive Wether the hub is active
+ * @param $acceptAnnouncements Whether this node accepts announcements (default: TRUE)
* @return void
*/
- public final function enableIsActive ($isActive = true) {
- $this->isActive = (bool) $isActive;
+ 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
+ *
+ * @return $acceptsRequest Wether this node accepts node-list requests
+ */
+ public function isAcceptingNodeListRequests () {
+ /*
+ * 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.
+ */
+ $acceptsRequest = ((!$this instanceof HubRegularNode) && ($this->getRequestInstance()->getRequestElement('mode') != self::NODE_TYPE_REGULAR));
+
+ // Return it
+ return $acceptsRequest;
+ }
+
+ /**
+ * 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
+ *
+ * @return $unlData An array from an instance of a LocateableNode class for this node
+ */
+ 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
+ // * DEBUG: */ $this->debugInstance('unlInstance[]=' . gettype($unlInstance));
+ assert($unlInstance instanceof LocateableNode);
+
+ // ... and the array from it
+ $unlData = $unlInstance->getUnlData();
+
+ // Return it
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: EXIT!');
+ return $unlData;
+ }
+
+ /**
+ * Updates/refreshes node data (e.g. status).
+ *
+ * @return void
+ * @todo Find more to do here
+ */
+ public function updateNodeData () {
+ // Set some dummy configuration entries, e.g. node_status
+ $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
+ }
+
+ /**
+ * Handles message answer by given data array
+ *
+ * @param $messageData A valid answer message data array
+ * @param $packageInstance An instance of a Receivable class
+ * @return void
+ * @todo Handle thrown exception
+ */
+ public function handleAnswerStatusByMessageData (array $messageData, Receivable $packageInstance) {
+ // Is it not empty?
+ assert(!empty($messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]));
+
+ // Construct configuration entry for handling class' name
+ $classConfigEntry = strtolower($messageData[NetworkPackage::MESSAGE_ARRAY_TYPE] . '_status_' . $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]) . '_handler_class';
+
+ // Try to get a class
+ $handlerInstance = ObjectFactory::createObjectByConfiguredName($classConfigEntry);
+
+ // Handle it there
+ $handlerInstance->handleAnswerMessageData($messageData, $packageInstance);
+ }
+
+ /**
+ * "Getter" for an array of all accepted object types
+ *
+ * @return $objectList Array of all accepted object types
+ */
+ public function getListFromAcceptedObjectTypes () {
+ // Get registry instance
+ $objectRegistryInstance = ObjectTypeRegistryFactory::createObjectTypeRegistryInstance();
+
+ // Get all entries
+ $objectList = $objectRegistryInstance->getEntries(XmlObjectRegistryTemplateEngine::OBJECT_TYPE_DATA_NAME);
+
+ // ... 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
}
}
projects / hub.git / blobdiff