5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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
58 * @throws NullPointerException When $applicationInstance is null
59 * @throws InvalidInterfaceException When $applicationInstance does not implement ManageableApplication
62 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
63 // Get a registry and the application instance from it
64 $applicationInstance = Registry::getRegistry()->getInstance('app');
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);
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.');
84 $nodeInstance = Registry::getRegistry()->getInstance('node');
87 if (is_null($nodeInstance)) {
88 // Throws a NullPointerException here
89 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
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);
97 // ----------------------------- Main loop ----------------------------
98 // This is the main loop. Queried calls should come back here very fast
99 // so the whole application runs on nice speed. This while-loop goes
100 // until the hub is no longer active.
101 //while ($nodeInstance->isHubActive()) {
106 * Adds extra filters to the given controller instance
108 * @param $controllerInstance A controller instance
109 * @param $requestInstance An instance of a class with an Requestable interface
111 * @todo Should we add some more filters?
113 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
115 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
116 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('console_welcome_teaser_filter'));
118 // Add bootstrap filters
119 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_aquire_hubid_filter'));
120 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_gen_sessionid_filter'));
121 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_restore_nodelist_filter'));
122 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_init_queues_filter'));
123 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_extra_bootstrap_filter'));
124 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_listener_pool_filter'));
126 // Add hub activation filters
128 // Add shutdown filters
129 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_flush_node_list_filter'));
130 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_deinit_queues_filter'));
131 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_listener_pool_filter'));
133 // This is the last filter
134 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_node_filter'));