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

   1 <?php
   2 /**
   3  * A command for the 'main' routine
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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                 // ----------------------- Bootstrapping phase ------------------------
  65                 // Try to bootstrap the node and pass the request instance to it for
  66                 // extra arguments which mostly override config entries or enable special
  67                 // features within the hub (none is ready at this development stage)
  68                 $this->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
  69                 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
  70                 $this->debugOutput('BOOTSTRAP: Bootstrap finished.');
  71
  72                 // Get node instance
  73                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  74
  75                 // Add some node-specific filters, e.g. announcement
  76                 $nodeInstance->addExtraHubFilters();
  77
  78                 // -------------------------- Hub activation --------------------------
  79                 // Activates the hub by doing some final preparation steps and setting
  80                 // the attribute $hubIsActive to true
  81                 $nodeInstance->activateHub($requestInstance, $responseInstance);
  82
  83                 // Get task handler instance
  84                 $handlerInstance = Registry::getRegistry()->getInstance('task');
  85
  86                 // Debug message
  87                 $this->debugOutput('MAIN: --- Entering main loop. ---');
  88
  89                 // ----------------------------- Main loop ----------------------------
  90                 // This is the main loop. Queried calls should come back here very fast
  91                 // so the whole application runs on nice speed. This while-loop goes
  92                 // until the hub is no longer active or all tasks are killed.
  93                 while (($nodeInstance->getIsActive()) && ($handlerInstance->hasTasksLeft())) {
  94                         // Handle all tasks here
  95                         $handlerInstance->handleTasks();
  96                 } // END - while
  97
  98                 // Debug message
  99                 $this->debugOutput('MAIN: --- Leaving main loop. ---');
 100         }
 101
 102         /**
 103          * Adds extra filters to the given controller instance
 104          *
 105          * @param       $controllerInstance             A controller instance
 106          * @param       $requestInstance                An instance of a class with an Requestable interface
 107          * @return      void
 108          * @todo        Should we add some more filters?
 109          */
 110         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 111                 // Add pre filters
 112                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_php_requirements_filter'));
 113                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
 114                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('console_welcome_teaser_filter'));
 115
 116                 // Add bootstrap filters
 117                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_hubid_filter'));
 118                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_sessionid_filter'));
 119                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_restore_nodelist_filter'));
 120                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_init_queues_filter'));
 121                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_extra_bootstrap_filter'));
 122                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_listener_pool_filter'));
 123
 124                 // Add hub activation filters
 125                 $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('hub_activation_task_handler_initializer_filter'));
 126
 127                 // Add shutdown filters
 128                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_flush_node_list_filter'));
 129                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_deinit_queues_filter'));
 130                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_task_handler_filter'));
 131
 132                 // This is the last generic filter
 133                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_node_filter'));
 134         }
 135 }
 136
 137 // [EOF]
 138 ?>