<?php
/**
 * A command for the 'main' routine
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class HubConsoleMainCommand extends BaseCommand implements Commandable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this class
	 *
	 * @param	$resolverInstance	An instance of a command resolver class
	 * @return	$commandInstance	An instance a prepared command class
	 */
	public final static function createHubConsoleMainCommand (CommandResolver $resolverInstance) {
		// Get new instance
		$commandInstance = new HubConsoleMainCommand();

		// Set the application instance
		$commandInstance->setResolverInstance($resolverInstance);

		// Return the prepared instance
		return $commandInstance;
	}

	/**
	 * Executes the given command with given request and response objects
	 *
	 * @param	$requestInstance	An instance of a class with an Requestable interface
	 * @param	$responseInstance	An instance of a class with an Responseable interface
	 * @return	void
	 */
	public function execute (Requestable $requestInstance, Responseable $responseInstance) {
		// Get a registry and the application instance from it
		$applicationInstance = Registry::getRegistry()->getInstance('app');

		// ----------------------- Bootstrapping phase ------------------------
		// Try to bootstrap the node and pass the request instance to it for
		// extra arguments which mostly override config entries or enable special
		// features within the hub (none is ready at this development stage)
		$this->debugOutput('BOOTSTRAP: Beginning with bootstrap...');
		$applicationInstance->getControllerInstance()->executeBootstrapFilters($requestInstance, $responseInstance);
		$this->debugOutput('BOOTSTRAP: Bootstrap finished.');

		// Get node instance
		$nodeInstance = Registry::getRegistry()->getInstance('node');

		// -------------------------- Hub activation --------------------------
		// Activates the hub by doing some final preparation steps and setting
		// the attribute $hubIsActive to true
		$nodeInstance->activateHub($requestInstance, $responseInstance);

		// Get task handler instance
		$handlerInstance = Registry::getRegistry()->getInstance('task');

		// Debug message
		$this->debugOutput('MAIN: --- Entering main loop. ---');

		// ----------------------------- Main loop ----------------------------
		// This is the main loop. Queried calls should come back here very fast
		// so the whole application runs on nice speed. This while-loop goes
		// until the hub is no longer active.
		while (($nodeInstance->isHubActive()) && ($handlerInstance->hasTasksLeft())) {
			// Handle all tasks here
			$handlerInstance->handleTasks();

			// Handle the listeners
			// @TODO We may have to catch some exceptions here
			//$nodeInstance->getListenerPoolInstance()->handleListenerPool();
		} // END - while

		// Debug message
		$this->debugOutput('MAIN: --- Leaving main loop. ---');
	}

	/**
	 * Adds extra filters to the given controller instance
	 *
	 * @param	$controllerInstance		A controller instance
	 * @param	$requestInstance		An instance of a class with an Requestable interface
	 * @return	void
	 * @todo	Should we add some more filters?
	 */
	public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
		// Add pre filters
		$controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('node_initializer_filter'));
		$controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('console_welcome_teaser_filter'));

		// Add bootstrap filters
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_hubid_filter'));
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_generate_sessionid_filter'));
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_restore_nodelist_filter'));
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_init_queues_filter'));
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_extra_bootstrap_filter'));
		$controllerInstance->addBootstrapFilter(ObjectFactory::createObjectByConfiguredName('hub_bootstrap_listener_pool_filter'));

		// Add hub activation filters
		$controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('hub_activation_task_handler_initializer_filter'));

		// Add shutdown filters
		$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_flush_node_list_filter'));
		$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_deinit_queues_filter'));
		$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_listener_pool_filter'));

		// This is the last generic filter
		$controllerInstance->addShutdownFilter(ObjectFactory::createObjectByConfiguredName('hub_shutdown_node_filter'));
	}
}

// [EOF]
?>