<?php
/**
 * A NodeMessageAnnouncement handler
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 NodeMessageAnnouncementHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set handler name
		$this->setHandlerName('message_announcement');

		// Init message data array
		$this->messageDataElements = array(
			XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
			XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
			XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
			XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT,
			XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT
		);
	}

	/**
	 * Creates an instance of this class
	 *
	 * @return	$handlerInstance	An instance of a HandleableMessage class
	 */
	public final static function createNodeMessageAnnouncementHandler () {
		// Get new instance
		$handlerInstance = new NodeMessageAnnouncementHandler();

		// Return the prepared instance
		return $handlerInstance;
	}

	/**
	 * Handles data array of the message
	 *
	 * @param	$messageData		An array with message data to handle
	 * @param	$packageInstance	An instance of a Receivable class
	 * @return	void
	 * @throws	AnnouncementNotAcceptedException	If this node does not accept announcements
	 */
	public function handleMessageData (array $messageData, Receivable $packageInstance) {
		// Get node instance
		$nodeInstance = Registry::getRegistry()->getInstance('node');

		// Is this node accepting announcements?
		if (!$nodeInstance->isAcceptingAnnouncements()) {
			/*
			 * This node is not accepting announcements, then someone wants to
			 * announce his node to a non-bootstrap and non-master node.
			 */
			throw new AnnouncementNotAcceptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ACCEPTED);
		} // END - if

		// Register the announcing node with this node
		$this->registerNodeByMessageData($messageData);

		// Prepare answer message to be delivered back to the other node
		$this->prepareAnswerMessage($messageData, $packageInstance);
	}

	/**
	 * Adds all required elements from given array into data set instance
	 *
	 * @param	$dataSetInstance	An instance of a StoreableCriteria class
	 * @param	$messageData		An array with all message data
	 * @return	void
	 */
	public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
		// Add all ements
		foreach ($this->messageDataElements as $key) {
			// Is it there?
			assert(isset($messageData[$key]));

			// Add it
			$dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
		} // END - foreach
	}
}

// [EOF]
?>