]> git.mxchange.org Git - hub.git/blobdiff - application/hub/class_ApplicationHelper.php
Added also here ...
[hub.git] / application / hub / class_ApplicationHelper.php
index 96d955ace9315cd7489548917999b0968d215dce..299754ec2c5b37bf9aee36fd6c7db32dc43cd7e2 100644 (file)
@@ -20,9 +20,9 @@
  * Please remember that this include file is being loaded *before* the class
  * loader is loading classes from "exceptions", "interfaces" and "main"!
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0
- * @copyright  Copyright (c) 2007 - 2008 Roland Haeder, 2009 Hub Developer Team
+ * @copyright  Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
  *
  * This program is free software: you can redistribute it and/or modify
@@ -42,22 +42,22 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        /**
         * The version number of this application
         */
-       private $appVersion = "";
+       private $appVersion = '';
 
        /**
         * The human-readable name for this application
         */
-       private $appName = "";
+       private $appName = '';
 
        /**
         * The short uni*-like name for this application
         */
-       private $shortName = "";
+       private $shortName = '';
 
        /**
         * An instance of this class
         */
-       private static $thisInstance = null;
+       private static $selfInstance = NULL;
 
        /**
         * Private constructor
@@ -67,25 +67,21 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Tidy up a little
-               $this->removeSystemArray();
-               $this->removeNumberFormaters();
        }
 
        /**
         * Getter for an instance of this class
         *
-        * @return      $thisInstance   An instance of this class
+        * @return      $selfInstance   An instance of this class
         */
-       public final static function getInstance () {
+       public static final function getSelfInstance () {
                // Is the instance there?
-               if (is_null(self::$thisInstance)) {
-                       self::$thisInstance = new ApplicationHelper();
-               }
+               if (is_null(self::$selfInstance)) {
+                       self::$selfInstance = new ApplicationHelper();
+               } // END - if
 
                // Return the instance
-               return self::$thisInstance;
+               return self::$selfInstance;
        }
 
        /**
@@ -153,16 +149,25 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         * @return      void
         */
        public final function entryPoint () {
+               // Set this application in registry
+               Registry::getRegistry()->addInstance('app', $this);
+
+               // Is no external address set?
+               if ($this->getConfigInstance()->getConfigEntry('external_address') == '') {
+                       // Determine external address
+                       $this->getConfigInstance()->setConfigEntry('external_address', HubTools::determineOwnExternalAddress());
+               } // END - if
+
+               // Default response is console
+               $response = self::getResponseTypeFromSystem();
+               $responseType = self::getResponseTypeFromSystem();
+
                // Create a new request object
-               $requestInstance = ObjectFactory::createObjectByName('ConsoleRequest');
+               $requestInstance = ObjectFactory::createObjectByName($this->convertToClassName($response) . 'Request');
 
                // Remember request instance here
                $this->setRequestInstance($requestInstance);
 
-               // Default response is console
-               $response = 'console';
-               $responseType = 'console';
-
                // Do we have another response?
                if ($requestInstance->isRequestElementSet('request')) {
                        // Then use it
@@ -171,105 +176,50 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
                } // END - if
 
                // ... and a new response object
-               $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
+               $responseClass = sprintf('%sResponse', $this->convertToClassName($response));
                $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
 
                // Remember response instance here
                $this->setResponseInstance($responseInstance);
 
                // Get the parameter from the request
-               $commandName = $requestInstance->getRequestElement('page');
+               $commandName = $requestInstance->getRequestElement('command');
 
                // If it is null then get default command
                if (is_null($commandName)) {
                        // Get default command
-                       $commandName = $responseInstance->getDefaultCommand();
+                       $commandName = $responseInstance->determineDefaultCommand();
 
                        // Set it in request
                        $requestInstance->setRequestElement('command', $commandName);
                } // END - if
 
-               // Get a resolver
-               $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
+               // Get a controller resolver
+               $resolverClass = $this->convertToClassName($this->getAppShortName() . '_' . $responseType . '_controller_resolver');
                $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
 
                // Get a controller instance as well
-               $this->controllerInstance = $resolverInstance->resolveController();
-
-               // Handle the request
-               $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
-               // ----------------------------- Init phase ---------------------------
-
-               // The default node-mode is from our configuration
-               $nodeMode = $this->getConfigInstance()->readConfig('node_mode');
-               die("Until here!\n");
-
-               // Prepare a ConsoleRequest class to catch all parameters
-               $requestInstance = ObjectFactory::createObjectByName('ConsoleRequest');
-
-               // Is the node 'mode' parameter set?
-               if ($requestInstance->isRequestElementSet('mode')) {
-                       // Then use this which overrides the config entry temporarily
-                       $nodeMode = $requestInstance->getRequestElement('mode');
-               } else {
-                       // Set it for easier re-usage
-                       $requestInstance->setRequestElement('mode', $nodeMode);
-               }
-
-               // Now convert the node-mode in a class name
-               $className = 'Hub' . $this->convertToClassName($nodeMode) . 'Node';
+               $this->setControllerInstance($resolverInstance->resolveController());
 
-               // And try to instance it
-               try {
-                       // Get an instance
-                       $nodeInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
-
-                       // Set the app instance
-                       $nodeInstance->setApplicationInstance($this);
-
-                       // Initialize all filters
-                       $nodeInstance->initializeFilters();
-               } catch (ClassNotFoundException $e) {
-                       // This exception means, the node mode is invalid.
-                       // @TODO Can we rewrite this to app_die() ?
-                       die('Node mode ' . $nodeMode . ' is invalid.' . "\n");
-               }
-
-               // ----------------------- Output teaser lines ------------------------
-               // Output some introducing lines to the console. This should be later
-               // be switched off if this is a productive release because it would be
-               // only visible to the logfile.
-               $nodeInstance->outputConsoleTeaser();
-
-               // ----------------------- Bootstrapping phase ------------------------
-               // Try to bootstrap the node and pass the request instance to it for
-               // extra arguments which mostly override config entries or enable special
-               // features within the hub (none is ready at this development stage)
-               $this->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
-               $nodeInstance->doBootstrapping();
-               $this->debugOutput('BOOTSTRAP: Bootstrap finished.');
-
-               // ----------------------- Init all query queues ----------------------
-               // After the bootstrap is done we need to initialize the queues which
-               // will help us to communicate between the "tasks" a hub needs to do.
-               $nodeInstance->initQueues();
-
-               // -------------------------- Hub activation --------------------------
-               // Activates the hub by doing some final preparation steps and setting
-               // the attribute $hubIsActive to true
-               $nodeInstance->activateHub();
-
-               // ----------------------------- Main loop ----------------------------
-               // This is the main loop. Queried calls should come back here very fast
-               // so the whole application runs on nice speed. This while-loop goes
-               // until the hub is no longer active.
-               while ($nodeInstance->isHubActive()) {
-               } // END - while
+               // Launch the hub main routine here
+               $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
 
                // -------------------------- Shutdown phase --------------------------
-               // Shutting down the hub by saying "good bye" to all connected clients
+               // Shutting down the hub by saying "good bye" to all connected peers
                // and other hubs, flushing all queues and caches.
-               $nodeInstance->doShutdown();
+               self::createDebugInstance(__CLASS__)->debugOutput('MAIN: Shutdown in progress, main loop exited.');
+               $this->getControllerInstance()->executeShutdownFilters($requestInstance, $responseInstance);
+               self::createDebugInstance(__CLASS__)->debugOutput('MAIN: Shutdown completed. (This is the last line.)');
+       }
+
+       /**
+        * Assigns extra application-depending data
+        *
+        * @param       $templateInstance       An instance of a CompileableTemplate
+        * @return      void
+        * @todo        Nothing to add?
+        */
+       public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
        }
 
        /**
@@ -282,8 +232,8 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        public function handleFatalMessages (array $messageList) {
                // Walk through all messages
                foreach ($messageList as $message) {
-                       die("MSG:" . $message);
-               }
+                       exit(__METHOD__ . ':MSG:' . $message);
+               } // END - foreach
        }
 
        /**