3 * A command for the 'chat client' routine
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2012 Chat Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 HubConsoleChatCommand 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 createHubConsoleChatCommand (CommandResolver $resolverInstance) {
43 $commandInstance = new HubConsoleChatCommand();
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 ChatActivationTask 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');
65 * ----------------------- Bootstrapping phase ------------------------
66 * Try to bootstrap the node and pass the request instance to it for
67 * extra arguments which mostly override config entries or enable special
68 * features within the hub (none is ready at this development stage)
70 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
71 $applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
72 self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: Bootstrap finished.');
75 $chatInstance = Registry::getRegistry()->getInstance('chat');
77 // Add some chat-specific filters
78 $chatInstance->addExtraChatFilters();
80 // Get task handler instance
81 $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
84 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Entering main loop. ---');
87 * ----------------------------- Main loop ----------------------------
88 * This is the main loop. Queried calls should come back here very fast
89 * so the whole application runs on nice speed. This while-loop goes
90 * until the chat is no longer active or all tasks are killed.
92 while (($chatInstance->isActive()) && ($handlerInstance->hasTasksLeft())) {
93 // Handle all tasks here
94 $handlerInstance->handleTasks();
98 self::createDebugInstance(__CLASS__)->debugOutput('MAIN: --- Leaving main loop. ---');
102 * Adds extra filters to the given controller instance
104 * @param $controllerInstance A controller instance
105 * @param $requestInstance An instance of a class with an Requestable interface
107 * @todo Should we add some more filters?
109 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
111 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('chat_php_requirements_filter'));
112 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('chat_initializer_filter'));
113 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('chat_welcome_teaser_filter'));
115 // Add bootstrap filters
116 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('chat_bootstrap_task_handler_initializer_filter'));
117 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('chat_bootstrap_extra_bootstrapping_filter'));
119 // This is the last generic boostrap filter
120 $controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('chat_bootstrap_generic_activation_filter'));
122 // Add shutdown filters
123 //$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('chat_shutdown_task_handler_filter'));
125 // This is the last generic shutdown filter
126 $controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('chat_shutdown_filter'));