3 * A command for the 'cruncher client' routine
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class HubConsoleCruncherCommand extends BaseCommand implements Commandable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $resolverInstance An instance of a command resolver class
39 * @return $commandInstance An instance a prepared command class
41 public static final function createHubConsoleCruncherCommand (CommandResolver $resolverInstance) {
43 $commandInstance = new HubConsoleCruncherCommand();
45 // Set the application instance
46 $commandInstance->setResolverInstance($resolverInstance);
48 // Return the prepared instance
49 return $commandInstance;
53 * Executes the given command with given request and response objects
55 * @param $requestInstance An instance of a class with an Requestable interface
56 * @param $responseInstance An instance of a class with an Responseable interface
58 * @todo Try to create a CruncherActivationTask or so
60 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
61 // Get a registry and the application instance from it
62 $applicationInstance = Registry::getRegistry()->getInstance('app');
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.');
72 // Get cruncher instance
73 $cruncherInstance = Registry::getRegistry()->getInstance('cruncher');
75 // Add some cruncher-specific filters, e.g. announcement
76 $cruncherInstance->addExtraCruncherFilters();
78 // Get task handler instance
79 $handlerInstance = Registry::getRegistry()->getInstance('task');
82 $this->debugOutput('MAIN: --- Entering main loop. ---');
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();
94 $this->debugOutput('MAIN: --- Leaving main loop. ---');
98 * Adds extra filters to the given controller instance
100 * @param $controllerInstance A controller instance
101 * @param $requestInstance An instance of a class with an Requestable interface
103 * @todo Should we add some more filters?
105 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
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'));
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'));
115 // Add shutdown filters
116 //$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_task_handler_filter'));
118 // This is the last generic filter
119 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_cruncher_filter'));