3 * A command for the 'main' routine
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 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 HubConsoleMainCommand 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 final static function createHubConsoleMainCommand (CommandResolver $resolverInstance) {
43 $commandInstance = new HubConsoleMainCommand();
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
59 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60 // Get a registry and the application instance from it
61 $applicationInstance = Registry::getRegistry()->getInstance('app');
63 // ----------------------- Bootstrapping phase ------------------------
64 // Try to bootstrap the node and pass the request instance to it for
65 // extra arguments which mostly override config entries or enable special
66 // features within the hub (none is ready at this development stage)
67 $this->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
68 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
69 $this->debugOutput('BOOTSTRAP: Bootstrap finished.');
72 $nodeInstance = Registry::getRegistry()->getInstance('node');
74 // -------------------------- Hub activation --------------------------
75 // Activates the hub by doing some final preparation steps and setting
76 // the attribute $hubIsActive to true
77 $nodeInstance->activateHub($requestInstance, $responseInstance);
79 // Get task handler instance
80 $handlerInstance = Registry::getRegistry()->getInstance('task');
83 $this->debugOutput('MAIN: --- Entering main loop. ---');
85 // ----------------------------- Main loop ----------------------------
86 // This is the main loop. Queried calls should come back here very fast
87 // so the whole application runs on nice speed. This while-loop goes
88 // until the hub is no longer active.
89 while (($nodeInstance->isHubActive()) && ($handlerInstance->hasTasksLeft())) {
90 // Handle all tasks here
91 $handlerInstance->handleTasks();
95 $this->debugOutput('MAIN: --- Leaving main loop. ---');
99 * Adds extra filters to the given controller instance
101 * @param $controllerInstance A controller instance
102 * @param $requestInstance An instance of a class with an Requestable interface
104 * @todo Should we add some more filters?
106 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
108 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
109 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('console_welcome_teaser_filter'));
111 // Add bootstrap filters
112 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_hubid_filter'));
113 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_sessionid_filter'));
114 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_restore_nodelist_filter'));
115 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_init_queues_filter'));
116 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_extra_bootstrap_filter'));
117 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_listener_pool_filter'));
119 // Add hub activation filters
120 $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('hub_activation_task_handler_initializer_filter'));
122 // Add shutdown filters
123 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_flush_node_list_filter'));
124 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_deinit_queues_filter'));
125 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_listener_pool_filter'));
127 // This is the last generic filter
128 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_node_filter'));