<?php
/**
 * A hub-node class for the 'Boot' mode
 *
 * @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 HubBootNode extends BaseHubNode implements NodeHelper {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this hub-node class
	 *
	 * @param	$requestInstance	An instance of a Requestable class
	 * @return	$nodeInstance		An instance of this hub-node class
	 */
	public final static function createHubBootNode (Requestable $requestInstance) {
		// Get a new instance
		$nodeInstance = new HubBootNode();

		// Set the request instance
		$nodeInstance->setRequestInstance($requestInstance);

		// --------------------- Hub-id acquirement phase ---------------------
		// Acquire a hub-id. This step generates on first launch a new one and
		// on any later launches it will restore the hub-id from the database.
		// A passed 'nickname=xxx' argument will be used to add some
		// 'personality' to the hub.
		$nodeInstance->acquireHubId();

		// Return the instance
		return $nodeInstance;
	}

	/**
	 * Method to "bootstrap" the node. This step does also apply provided
	 * command-line arguments stored in the request instance. The regular node
	 * should communicate with the bootstrap-nodes at this point.
	 *
	 * @return	void
	 * @todo	add some more special bootstrap things for this boot node
	 */
	public function doBootstrapping () {
		// Call generic (parent) bootstrapping method first
		parent::doGenericBootstrapping();

		// Now check if the IP address matches one of the bootstrap nodes
		if ($this->ifAddressMatchesBootstrappingNodes($_SERVER['REMOTE_ADDR'])) {
			// Get our port from configuration
			$ourPort = $this->getConfigInstance()->readConfig('node_listen_port');

			// Is the port the same?
			if (substr($this->bootIpPort, -strlen($ourPort), strlen($ourPort)) == $ourPort) {
				// It is the same!
				$this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: IP/port matches bootstrapping node ' . $this->bootIpPort . '.');

				// Now, does the mode match (should be 'boot'!)
				if ($this->getRequestInstance()->getRequestElement('mode') == 'boot') {
					// Output debug message
					$this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: Our node is a valid bootstrapping node.');
				} else {
					// Output warning
					$this->getDebugInstance()->output(__FUNCTION__.'['.__LINE__.']: WARNING! Mismatching mode ' . $this->getRequestInstance()->getRequestElement('mode') . '!=boot detected.');
				}
			} // END - if
		} // END - if

		// This might not be all...
		$this->partialStub('Please implement more bootsrapping steps.');
	}

	/**
	 * Initializes hub-specific queues
	 *
	 * @return	void
	 * @todo	Unfinished method
	 */
	public function initQueues () {
		// Call generic queues every hub may have, like the core queue
		parent::initGenericQueues();
		$this->partialStub('Please add some more hub-specific queues.');
	}
}

//
?>