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

   1 <?php
   2 /**
   3  * A command for the 'cruncher client' routine
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 HubConsoleCruncherCommand 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 createHubConsoleCruncherCommand (CommandResolver $resolverInstance) {
  42                 // Get new instance
  43                 $commandInstance = new HubConsoleCruncherCommand();
  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 CruncherActivationTask 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 cruncher instance
  73                 $cruncherInstance = Registry::getRegistry()->getInstance('cruncher');
  74
  75                 // Add some cruncher-specific filters, e.g. announcement
  76                 $cruncherInstance->addExtraCruncherFilters();
  77
  78                 // Get task handler instance
  79                 $handlerInstance = Registry::getRegistry()->getInstance('task');
  80
  81                 // Debug message
  82                 $this->debugOutput('MAIN: --- Entering main loop. ---');
  83
  84                 // ----------------------------- Main loop ----------------------------
  85                 // This is the main loop. Queried calls should come back here very fast
  86                 // so the whole application runs on nice speed. This while-loop goes
  87                 // until the cruncher is no longer active or all tasks are killed.
  88                 while ($handlerInstance->hasTasksLeft()) {
  89                         // Handle all tasks here
  90                         $handlerInstance->handleTasks();
  91                 } // END - while
  92
  93                 // Debug message
  94                 $this->debugOutput('MAIN: --- Leaving main loop. ---');
  95         }
  96
  97         /**
  98          * Adds extra filters to the given controller instance
  99          *
 100          * @param       $controllerInstance             A controller instance
 101          * @param       $requestInstance                An instance of a class with an Requestable interface
 102          * @return      void
 103          * @todo        Should we add some more filters?
 104          */
 105         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 106                 // Add pre filters
 107                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('cruncher_php_requirements_filter'));
 108                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('cruncher_initializer_filter'));
 109                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('cruncher_welcome_teaser_filter'));
 110
 111                 // Add bootstrap filters
 112                 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('cruncher_bootstrap_task_handler_initializer_filter'));
 113                 //$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_hubid_filter'));
 114
 115                 // Add shutdown filters
 116                 //$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_task_handler_filter'));
 117
 118                 // This is the last generic filter
 119                 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_cruncher_filter'));
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>