application/hub/classes/commands/console/class_HubConsoleMainCommand.php

   1 <?php
   2 /**
   3  * A command for the 'main' routine
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class HubConsoleMainCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @param       $resolverInstance       An instance of a command resolver class
  39          * @return      $commandInstance        An instance a prepared command class
  40          */
  41         public static final function createHubConsoleMainCommand (CommandResolver $resolverInstance) {
  42                 // Get new instance
  43                 $commandInstance = new HubConsoleMainCommand();
  44
  45                 // Set the application instance
  46                 $commandInstance->setResolverInstance($resolverInstance);
  47
  48                 // Return the prepared instance
  49                 return $commandInstance;
  50         }
  51
  52         /**
  53          * Executes the given command with given request and response objects
  54          *
  55          * @param       $requestInstance        An instance of a class with an Requestable interface
  56          * @param       $responseInstance       An instance of a class with an Responseable interface
  57          * @return      void
  58          * @todo        Try to create a HubActivationTask or so
  59          */
  60         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  61                 // Get a registry and the application instance from it
  62                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  63
  64                 /*
  65                  * ----------------------- Bootstrapping phase ------------------------
  66                  * Try to bootstrap the node and pass the request instance to it for
  67                  * extra arguments which mostly override config entries or enable special
  68                  * features within the hub (none is ready at this development stage)
  69                  */
  70                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
  71                 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
  72                 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Bootstrap finished.');
  73
  74                 // Get node instance
  75                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  76
  77                 // Add some node-specific filters, e.g. announcement
  78                 $nodeInstance->addExtraNodeFilters();
  79
  80                 /*
  81                  * -------------------------- Hub activation --------------------------
  82                  * Activates the node by doing some final preparation steps and setting
  83                  * the attribute $hubIsActive to TRUE.
  84                  */
  85                 $nodeInstance->activateNode($requestInstance, $responseInstance);
  86
  87                 // Get task handler instance
  88                 $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
  89
  90                 // Debug message
  91                 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Entering main loop. ---');
  92
  93                 /*
  94                  * ----------------------------- Main loop ----------------------------
  95                  * This is the main loop. Queried calls should come back here very fast
  96                  * so the whole application runs on nice speed. This while-loop goes
  97                  * until the hub is no longer active or all tasks are killed.
  98                  */
  99                 while (($nodeInstance->isNodeActive()) && ($handlerInstance->hasTasksLeft())) {
 100                         // Handle all tasks here
 101                         $handlerInstance->handleTasks();
 102                 } // END - while
 103
 104                 // Debug message
 105                 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Leaving main loop. ---');
 106         }
 107
 108         /**
 109          * Adds extra filters to the given controller instance
 110          *
 111          * @param       $controllerInstance             A controller instance
 112          * @param       $requestInstance                An instance of a class with an Requestable interface
 113          * @return      void
 114          * @todo        Should we add some more filters?
 115          */
 116         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 117                 // Add pre filters
 118                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_php_requirements_filter'));
 119                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
 120                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_welcome_teaser_filter'));
 121
 122                 // Add bootstrap filters
 123                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('node_bootstrap_generate_nodeid_filter'));
 124                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('node_bootstrap_generate_sessionid_filter'));
 125                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('node_bootstrap_generate_private_key_filter'));
 126                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('node_bootstrap_extra_bootstrapping_filter'));
 127                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('node_bootstrap_listener_pool_filter'));
 128
 129                 // Add node activation filters
 130                 $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('node_activation_task_handler_initializer_filter'));
 131
 132                 // Add shutdown filters
 133                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('node_shutdown_flush_node_list_filter'));
 134                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('node_shutdown_task_handler_filter'));
 135
 136                 // This is the last generic shutdown filter
 137                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('node_shutdown_node_filter'));
 138         }
 139 }
 140
 141 // [EOF]
 142 ?>