]> git.mxchange.org Git - hub.git/commitdiff
Rewritten class structure to make it more OOP-friendly (stupid comment, I know)
authorRoland Häder <roland@mxchange.org>
Fri, 1 May 2009 20:07:34 +0000 (20:07 +0000)
committerRoland Häder <roland@mxchange.org>
Fri, 1 May 2009 20:07:34 +0000 (20:07 +0000)
application/hub/class_ApplicationHelper.php
application/hub/main/nodes/boot/class_HubBootNode.php
application/hub/main/nodes/class_
application/hub/main/nodes/class_BaseHubNode.php
application/hub/main/nodes/list/class_BootListNode.php
application/hub/main/nodes/master/class_HubMasterNode.php
application/hub/main/nodes/regular/class_HubRegularNode.php
index.php

index 4a39927202eaa44c04ac131f0d30673d019b0668..ed5f03642b97a330590abe037c5998b5ef6efb79 100644 (file)
@@ -185,16 +185,10 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
                        die('Node mode ' . $nodeMode . ' is invalid.' . "\n");
                }
 
-               // --------------------- Hub-id acquirement phase ---------------------
-               // Acquire a hub-id. This step generates on first launch anew 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.
-               $nodeInstance->acquireHubId($requestInstance);
-
                // --------------------- Bootstrapping phase ---------------------
                // Try to bootstrap the node and pass the request instance to it for
-               // extra arguments which mostly override config entries
+               // extra arguments which mostly override config entries or enable special
+               // features within the hub (none is ready at this development stage)
                $nodeInstance->doBootstrapping($requestInstance);
        }
 
index 0be26c3d3693ec5c82a760b6dd2453b99ed45909..32bb6366dd578839ef4a7f5a442239407235c038 100644 (file)
@@ -45,6 +45,13 @@ class HubBootNode extends BaseHubNode implements NodeHelper {
                // Set the request instance
                $nodeInstance->setRequestInstance($requestInstance);
 
+               // --------------------- 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.
+               $nodeInstance->acquireHubId();
+
                // Return the instance
                return $nodeInstance;
        }
@@ -58,12 +65,12 @@ class HubBootNode extends BaseHubNode implements NodeHelper {
         * @todo        add some more special bootstrap things for this boot node
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method
+               // Call generic (parent) bootstrapping method first
                parent::doGenericBootstrapping();
 
                // Now check if the IP address matches one of the bootstrap nodes
                if ($this->ifAddressMatchesBootstrappingNodes($_SERVER['REMOTE_ADDR'])) {
-                       // Get our port
+                       // Get our port from configuration
                        $ourPort = $this->getConfigInstance()->readConfig('node_listen_port');
 
                        // Is the port the same?
@@ -83,7 +90,10 @@ class HubBootNode extends BaseHubNode implements NodeHelper {
                } // END - if
 
                // This might not be all...
-               $this->partialStub("Please implement more bootsrapping steps.");
+               $this->partialStub('Please implement more bootsrapping steps.');
+
+               // This should be the last thing to do: output teaser lines
+               $this->outputConsoleTeaser();
        }
 }
 
index c357328a7010907166d42f64e9d5eb364ae39d2d..215ade831d97fb3ada617df6911cbabe6479ecb3 100644 (file)
@@ -58,9 +58,12 @@ class Hub???Node extends BaseHubNode implements NodeHelper {
         * @todo        Implement this method
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method
+               // Call generic (parent) bootstrapping method first
                parent::doGenericBootstrapping();
-               $this->partialStub("Please implement this method.");
+               $this->partialStub('Please implement this method.');
+
+               // This is the last line: output teaser
+               $this->outputTeaserLines();
        }
 }
 
index 03f8f5052393fed1020b9200240cf14442966035..319ae987a6be10b0506c2409e7eeb1cc7df9b46e 100644 (file)
@@ -120,7 +120,7 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
         *
         * @return      void
         */
-       private function outputConsoleTeaser () {
+       protected function outputConsoleTeaser () {
                // Get the app instance (for shortening our code)
                $app = $this->getApplicationInstance();
 
@@ -139,12 +139,12 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
         * 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.
         *
-        * @todo        This method is maybe not yet finished.
         * @return      void
+        * @todo        This method is maybe not yet finished.
         */
        protected function doGenericBootstrapping () {
-               // Finally output our teaser. This should be the last line!
-               $this->outputConsoleTeaser();
+               // @TODO Empty method
+               $this->partialStub('Add some generic bootstrap steps here.');
        }
 
        /**
@@ -152,10 +152,9 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
         * based on many pseudo-random data. On any later run, unless the id
         * got not removed from database, it will be restored from the database.
         *
-        * @param       $requestInstance        An instance of a Requestable class
         * @return      void
         */
-       public function acquireHubId (Requestable $requestInstance) {
+       protected function acquireHubId () {
                // Get a wrapper instance
                $wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
 
@@ -164,7 +163,7 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
 
                // 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, $requestInstance->getRequestElement('mode'));
+               $searchInstance->addCriteria(NodeInformationDatabaseWrapper::DB_COLUMN_NODE_TYPE, $this->getRequestInstance()->getRequestElement('mode'));
                $searchInstance->setLimit(1);
 
                // Get a result back
@@ -185,7 +184,7 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
                        $rngInstance = ObjectFactory::createObjectByConfiguredName('rng_class');
 
                        // Generate a pseudo-random string
-                       $randomString = $rngInstance->randomString(255) . ':' . $requestInstance->getRequestElement('mode');
+                       $randomString = $rngInstance->randomString(255) . ':' . $this->getRequestInstance()->getRequestElement('mode');
 
                        // Get a crypto instance
                        $cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
@@ -194,7 +193,7 @@ class BaseHubNode extends BaseFrameworkSystem implements Updateable {
                        $this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
 
                        // Register the node id with our wrapper
-                       $wrapperInstance->registerNodeId($this, $requestInstance);
+                       $wrapperInstance->registerNodeId($this, $this->getRequestInstance());
 
                        // Output message
                        $this->getDebugInstance()->output('Created new node-id: ' . $this->getNodeId() . '');
index d0addef0dc11cc4a9cb489513eb8c12bc85fdaa5..2b5257fe72f6b7efc44f552239d588a2e44c1a83 100644 (file)
@@ -45,6 +45,13 @@ class HubListNode extends BaseHubNode implements NodeHelper {
                // Set the request instance
                $nodeInstance->setRequestInstance($requestInstance);
 
+               // --------------------- 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.
+               $nodeInstance->acquireHubId();
+
                // Return the instance
                return $nodeInstance;
        }
@@ -58,9 +65,12 @@ class HubListNode extends BaseHubNode implements NodeHelper {
         * @todo        Implement this method
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method
+               // Call generic (parent) bootstrapping method first
                parent::doGenericBootstrapping();
-               $this->partialStub("Please implement this method.");
+               $this->partialStub('Please implement this method.');
+
+               // This should be the last line: output teaser
+               $this->outputConsoleTeaser();
        }
 }
 
index 9f41a0311e70d0120a14905839d824e162f1edd0..5de2a59ddcd889fbede98d03a7339bcfffede0a8 100644 (file)
@@ -45,6 +45,13 @@ class HubMasterNode extends BaseHubNode implements NodeHelper {
                // Set the request instance
                $nodeInstance->setRequestInstance($requestInstance);
 
+               // --------------------- 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.
+               $nodeInstance->acquireHubId();
+
                // Return the instance
                return $nodeInstance;
        }
@@ -58,9 +65,12 @@ class HubMasterNode extends BaseHubNode implements NodeHelper {
         * @todo        Implement this method
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method
+               // Call generic (parent) bootstrapping method first
                parent::doGenericBootstrapping();
-               $this->partialStub("Please implement this method.");
+               $this->partialStub('Please implement this method.');
+
+               // This should be the last line: output teaser
+               $this->outputConsoleTeaser();
        }
 }
 
index fd3dbab98bbafa6854dbfda51377e6508388e273..4c497e6136ffc4a94d31311034f9e4e44362a500 100644 (file)
@@ -45,6 +45,13 @@ class HubRegularNode extends BaseHubNode implements NodeHelper {
                // Set the request instance
                $nodeInstance->setRequestInstance($requestInstance);
 
+               // --------------------- 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.
+               $nodeInstance->acquireHubId();
+
                // Return the instance
                return $nodeInstance;
        }
@@ -58,9 +65,12 @@ class HubRegularNode extends BaseHubNode implements NodeHelper {
         * @todo        Implement this method
         */
        public function doBootstrapping () {
-               // Call generic (parent) bootstrapping method
+               // Call generic (parent) bootstrapping method first
                parent::doGenericBootstrapping();
-               $this->partialStub("Please implement this method.");
+               $this->partialStub('Please implement this method.');
+
+               // This is the last line: output teaser
+               $this->outputConsoleTeaser();
        }
 }
 
index b77289f9a3356ca3aa09b77e8b3e175cd5ba10ae..005004646b5cee9d87e2ae89b499f8f675e6604d 100644 (file)
--- a/index.php
+++ b/index.php
@@ -161,7 +161,8 @@ final class ApplicationEntryPoint {
        }
 
        /**
-        * Determines the correct absolute path for all includes
+        * Determines the correct absolute path for all includes only once per run.
+        * Other calls of this method are being "cached".
         *
         * @return      $basePath       Base path (core) for all includes
         */