X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Fnodes%2Fclass_BaseHubNode.php;h=cebc45bdeb2078bd100a07397de70a9310b1e275;hb=16aca39aad42749527919c6baf50dfdc7aa96d4c;hp=ff1cf1306920000172abd021ff8079824ec15528;hpb=9cb3c72a99fe8d5fe4f5413ec98affc68b125f64;p=hub.git diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php index ff1cf1306..cebc45bde 100644 --- a/application/hub/main/nodes/class_BaseHubNode.php +++ b/application/hub/main/nodes/class_BaseHubNode.php @@ -27,6 +27,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { */ private $nodeId = ''; + /** + * Session id + */ + private $sessionId = ''; + /** * IP/port number of bootstrapping node */ @@ -35,7 +40,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { /** * Query connector instance */ - private $queryInstance = null; + private $connectorInstance = null; /** * Listener pool instance @@ -77,23 +82,70 @@ class BaseHubNode extends BaseHubSystem implements Updateable { return $this->nodeId; } + /** + * Setter for listener pool instance + * + * @param $listenerPoolInstance Our new listener pool instance + * @return void + */ + private final function setListenerPoolInstance (PoolableListener $listenerPoolInstance) { + $this->listenerPoolInstance = $listenerPoolInstance; + } + + /** + * Getter for listener pool instance + * + * @return $listenerPoolInstance Our current listener pool instance + */ + public final function getListenerPoolInstance () { + return $this->listenerPoolInstance; + } + + /** + * Setter for session id + * + * @param $sessionId Our new session id + * @return void + */ + private final function setSessionId ($sessionId) { + $this->sessionId = (string) $sessionId; + } + + /** + * Getter for session id + * + * @return $sessionId Our new session id + */ + public final function getSessionId () { + return $this->sessionId; + } + /** * Setter for query instance * - * @param $queryInstance Our new query instance + * @param $connectorInstance Our new query instance * @return void */ - private final function setQueryInstance (Queryable $queryInstance) { - $this->queryInstance = $queryInstance; + private final function setQueryConnectorInstance (Connectable $connectorInstance) { + $this->connectorInstance = $connectorInstance; } /** * Getter for query instance * - * @return $queryInstance Our new query instance + * @return $connectorInstance Our new query instance */ - protected final function getQueryInstance () { - return $this->queryInstance; + public final function getQueryConnectorInstance () { + return $this->connectorInstance; + } + + /** + * Getter for boot IP/port combination + * + * @return $bootIpPort The IP/port combination of the boot node + */ + protected final function getBootIpPort () { + return $this->bootIpPort; } /** @@ -107,7 +159,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $isFound = false; // Run through all configured IPs - foreach (explode(',', $this->getConfigInstance()->readConfig('hub_bootstrap_nodes')) as $ipPort) { + foreach (explode(',', $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) { // Split it up in IP/port $ipPortArray = explode(':', $ipPort); @@ -124,7 +176,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Stop further searching break; - } elseif ($ipPortArray[0] == $this->getConfigInstance()->readConfig('node_listen_addr')) { + } 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; @@ -172,7 +224,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * * @return void */ - private function bootstrapAcquireHubId () { + public function bootstrapAcquireHubId () { // Get a wrapper instance $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class'); @@ -202,7 +254,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); // Generate a pseudo-random string - $randomString = $rngInstance->randomString(255) . ':' . $this->getRequestInstance()->getRequestElement('mode'); + $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode'); // Get a crypto instance $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); @@ -219,12 +271,31 @@ class BaseHubNode extends BaseHubSystem implements Updateable { } /** - * Getter for boot IP/port combination + * Generates a session id which will be sent to the other hubs and clients * - * @return $bootIpPort The IP/port combination of the boot node + * @return void */ - protected final function getBootIpPort () { - return $this->bootIpPort; + public function bootstrapGenerateSessionId () { + // Get an RNG instance + $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class'); + + // Generate a pseudo-random string + $randomString = $rngInstance->randomString(255) . ':' . $this->getBootIpPort() . ':' . $this->getRequestInstance()->getRequestElement('mode'); + + // Get a crypto instance + $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class'); + + // Hash and encrypt the string so we become a "node id" aka Hub-Id + $this->setSessionId($cryptoInstance->hashString($cryptoInstance->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()); + + // Output message + $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . ''); } /** @@ -233,13 +304,29 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * @return void */ protected function initGenericQueues () { + // Debug message + $this->debugOutput('BOOTSTRAP: Initialize queues: START'); + // Set the query connector instance - $this->setQueryInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); + $this->setQueryConnectorInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this))); // Run a test query - $this->getQueryInstance()->doTestQuery(); + $this->getQueryConnectorInstance()->doTestQuery(); + + // Debug message + $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED'); + } + + /** + * Publish our hub descriptor to the upper hub(s) + * + * @return void + * @todo This should be implemented in a generic way to keep things easy. + */ + protected function publishHubDescriptor () { + $this->partialStub('Unfinished method.'); } - + /** * Adds hub data elements to a given dataset instance * @@ -254,6 +341,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable { // Add the node id $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_ID, $this->getNodeId()); + + // Add the session id if acquired + if ($this->getSessionId() != '') { + $criteriaInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_SESSION_ID, $this->getSessionId()); + } // END - if } /** @@ -302,13 +394,24 @@ class BaseHubNode extends BaseHubSystem implements Updateable { return $this->hubIsActive; } + /** + * Setter for $hubIsActive attribute + * + * @param $hubIsActive Wether the hub is activer + */ + public final function enableHubIsActive ($hubIsActive = true) { + $this->hubIsActive = $hubIsActive; + } + /** * Activates the hub by doing some final preparation and setting * $hubIsActive to true * + * @param $requestInstance A Requestable class + * @param $responseInstance A Responseable class * @return void */ - public function activateHub () { + public function activateHub (Requestable $requestInstance, Responseable $responseInstance) { // Checks wether a listener is still active and shuts it down if one // is still listening if (($this->determineIfListenerIsActive()) && ($this->isHubActive())) { @@ -316,15 +419,15 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $this->shutdownListenerPool(); } // END - if - // Initialize the TCP/UDP listener pool - $this->initializeListenerPool(); + // Get the controller here + $controllerInstance = Registry::getRegistry()->getInstance('controller'); - // @TODO Do some final preparation - $this->partialStub('Do some final preparation before the hub gots activated.'); + // Run all filters for the hub activation + $controllerInstance->executeActivationFilters($requestInstance, $responseInstance); // ----------------------- Last step from here ------------------------ // Activate the hub. This is ALWAYS the last step in this method - $this->hubIsActive = true; + $this->enableHubIsActive(); // ---------------------- Last step until here ------------------------ } @@ -333,9 +436,12 @@ class BaseHubNode extends BaseHubSystem implements Updateable { * * @return void */ - private function initializeListenerPool () { + public function initializeListenerPool () { + // Debug output + $this->debugOutput('HUB: Initialize listener: START'); + // Get a new pool instance - $this->listenerPoolInstance = ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)); + $this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this))); // Get an instance of the low-level listener $listenerInstance = ObjectFactory::createObjectByConfiguredName('tcp_listener_class', array($this)); @@ -351,13 +457,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get an instance of the low-level listener $listenerInstance = ObjectFactory::createObjectByConfiguredName('udp_listener_class', array($this)); @@ -373,13 +479,54 @@ class BaseHubNode extends BaseHubSystem implements Updateable { $decoratorInstance = ObjectFactory::createObjectByConfiguredName('hub_udp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); // Get a decorator class $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance)); // Add this listener to the pool - $this->listenerPoolInstance->addListener($decoratorInstance); + $this->getListenerPoolInstance()->addListener($decoratorInstance); + + // Debug output + $this->debugOutput('HUB: Initialize listener: FINISHED.'); + } + + /** + * Restores a previously stored node list from database + * + * @return void + */ + public function bootstrapRestoreNodeList () { + // Debug output + $this->debugOutput('HUB: Restore node list: START'); + + // Get a wrapper instance + $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_list_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 + // @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); + + // Get a result back + $resultInstance = $wrapperInstance->doSelectByCriteria($searchInstance); + + // 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.'); + } + + // Debug output + $this->debugOutput('HUB: Restore node list: FINISHED.'); } }