]> git.mxchange.org Git - hub.git/blobdiff - application/hub/main/nodes/class_BaseHubNode.php
Wrapper added for node list
[hub.git] / application / hub / main / nodes / class_BaseHubNode.php
index 08e6fbdd2adbeeec59fa092fca723e3b5b5f81a9..13bdbf75b22fd7a382f72679c84f9d7b00d660c2 100644 (file)
@@ -27,6 +27,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
         */
        private $nodeId = '';
 
+       /**
+        * Session id
+        */
+       private $sessionId = '';
+
        /**
         * IP/port number of bootstrapping node
         */
@@ -77,6 +82,44 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
                return $this->nodeId;
        }
 
+       /**
+        * 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
+        */
+       private final function getSessionId () {
+               return $this->sessionId;
+       }
+
+       /**
+        * Setter for query instance
+        *
+        * @param       $queryInstance          Our new query instance
+        * @return      void
+        */
+       private final function setQueryInstance (Queryable $queryInstance) {
+               $this->queryInstance = $queryInstance;
+       }
+
+       /**
+        * Getter for query instance
+        *
+        * @return      $queryInstance          Our new query instance
+        */
+       protected final function getQueryInstance () {
+               return $this->queryInstance;
+       }
+
        /**
         * Checks wether the given IP address matches one of the bootstrapping nodes
         *
@@ -88,7 +131,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);
 
@@ -105,7 +148,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;
@@ -146,33 +189,6 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
                $this->debugOutput(' ');
        }
 
-       /**
-        * Do generic things for bootup phase. This can be e.g. checking if the
-        * right node mode is selected for this hub's IP number.
-        *
-        * @return      void
-        * @todo        This method is maybe not yet finished.
-        */
-       protected function bootstrapGenericBootstrapping () {
-               // --------------------- Hub-id acquirement phase ---------------------
-               // Acquire a hub-id. This step generates on first launch a new one and
-               // on any later launches it will restore the hub-id from the database.
-               // A passed 'nickname=xxx' argument will be used to add some
-               // 'personality' to the hub.
-               $this->bootstrapAcquireHubId();
-
-               // ------------------- More generic bootstrap steps -------------------
-               // Generate the session id which will only be stored in RAM and kept for
-               // the whole "session".
-               $this->bootstrapGenerateSessionId();
-
-               // Restore a previously downloaded bootstrap-node list.
-               $this->bootstrapRestoreNodeList();
-
-               // @TODO Add some generic bootstrap steps
-               $this->partialStub('Add some generic bootstrap steps here.');
-       }
-
        /**
         * Generic method to acquire a hub-id. On first run this generates a new one
         * based on many pseudo-random data. On any later run, unless the id
@@ -180,7 +196,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');
 
@@ -210,7 +226,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');
@@ -226,6 +242,34 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
                }
        }
 
+       /**
+        * Generates a session id which will be sent to the other hubs and clients
+        *
+        * @return      void
+        */
+       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->registerNodeId($this, $this->getRequestInstance());
+
+               // Output message
+               $this->debugOutput('BOOTSTRAP: Created new session-id: ' . $this->getSessionId() . '');
+       }
+
        /**
         * Getter for boot IP/port combination
         *
@@ -241,8 +285,17 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
         * @return      void
         */
        protected function initGenericQueues () {
-               // Set it
-               $this->queryInstance = ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this));
+               // Debug message
+               $this->debugOutput('BOOTSTRAP: Initialize queues: START');
+
+               // Set the query connector instance
+               $this->setQueryInstance(ObjectFactory::createObjectByConfiguredName('query_connector_class', array($this)));
+
+               // Run a test query
+               $this->getQueryInstance()->doTestQuery();
+
+               // Debug message
+               $this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
        }
        
        /**
@@ -307,13 +360,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())) {
@@ -321,15 +385,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->executeHubActivationFilters($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 ------------------------
        }
 
@@ -338,7 +402,10 @@ 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));
 
@@ -385,6 +452,44 @@ class BaseHubNode extends BaseHubSystem implements Updateable {
 
                // Add this listener to the pool
                $this->listenerPoolInstance->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('BOOTSTRAP: ');
+               } // END - if
+
+               // Debug output
+               $this->debugOutput('HUB: Restore node list: FINISHED.');
        }
 }