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

   1 <?php
   2 /**
   3  * A command for 'main'
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core 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 final static 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          * @throws      NullPointerException    When $applicationInstance is null
  59          * @throws      InvalidInterfaceException       When $applicationInstance does not implement ManageableApplication
  60          * @todo        ~10% done
  61          */
  62         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  63                 // Get a registry and the application instance from it
  64                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  65
  66                 // Is this a ManageableApplication instance?
  67                 if (is_null($applicationInstance)) {
  68                         // Something really bad went wrong
  69                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  70                 } elseif (!$applicationInstance instanceof ManageableApplication) {
  71                         // Something went badly wrong
  72                         throw new InvalidInterfaceException(array($this, 'ManageableApplication'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
  73                 } // END - if
  74
  75                 // ----------------------- Bootstrapping phase ------------------------
  76                 // Try to bootstrap the node and pass the request instance to it for
  77                 // extra arguments which mostly override config entries or enable special
  78                 // features within the hub (none is ready at this development stage)
  79                 $this->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
  80                 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
  81                 $this->debugOutput('BOOTSTRAP: Bootstrap finished.');
  82
  83                 // Get node instance
  84                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  85
  86                 // Sanity-check on it
  87                 if (is_null($nodeInstance)) {
  88                         // Throws a NullPointerException here
  89                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  90                 } // END - if
  91
  92                 // -------------------------- Hub activation --------------------------
  93                 // Activates the hub by doing some final preparation steps and setting
  94                 // the attribute $hubIsActive to true
  95                 $nodeInstance->activateHub($requestInstance, $responseInstance);
  96
  97                 // Debug message
  98                 $this->debugOutput('MAIN: --- Entering main loop. ---');
  99
 100                 // ----------------------------- Main loop ----------------------------
 101                 // This is the main loop. Queried calls should come back here very fast
 102                 // so the whole application runs on nice speed. This while-loop goes
 103                 // until the hub is no longer active.
 104                 while ($nodeInstance->isHubActive()) {
 105                         // Handle the listeners
 106                         // @TODO We may have to catch some exceptions here
 107                         $nodeInstance->getListenerPoolInstance()->handleListenerPool();
 108
 109                         // Handle the qeues
 110                         $nodeInstance->getQueryInstance()->handleQueues();
 111                 } // END - while
 112
 113                 // Debug message
 114                 $this->debugOutput('MAIN: --- Leaving main loop. ---');
 115         }
 116
 117         /**
 118          * Adds extra filters to the given controller instance
 119          *
 120          * @param       $controllerInstance             A controller instance
 121          * @param       $requestInstance                An instance of a class with an Requestable interface
 122          * @return      void
 123          * @todo        Should we add some more filters?
 124          */
 125         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 126                 // Add pre filters
 127                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
 128                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('console_welcome_teaser_filter'));
 129
 130                 // Add bootstrap filters
 131                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_hubid_filter'));
 132                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_sessionid_filter'));
 133                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_restore_nodelist_filter'));
 134                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_init_queues_filter'));
 135                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_extra_bootstrap_filter'));
 136                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_listener_pool_filter'));
 137
 138                 // Add hub activation filters
 139
 140                 // Add shutdown filters
 141                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_flush_node_list_filter'));
 142                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_deinit_queues_filter'));
 143                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_listener_pool_filter'));
 144
 145                 // This is the last generic filter
 146                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_node_filter'));
 147         }
 148 }
 149
 150 // [EOF]
 151 ?>