<?php
/**
 * A PackageRecipient discovery class
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 PackageRecipientDiscovery extends BaseHubDiscovery implements DiscoverableRecipient, Registerable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Create an instance of this class
	 *
	 * @return	$discoveryInstance	An instance of this discovery class
	 */
	public static final function createPackageRecipientDiscovery () {
		// Get an instance of this class
		$discoveryInstance = new PackageRecipientDiscovery();

		// Get recipients list instance and set it
		$listInstance = RecipientListFactory::createRecipientListInstance();
		$discoveryInstance->setListInstance($listInstance);

		// Output debug message
		self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY: Initialized.');

		// Return the prepared instance
		return $discoveryInstance;
	}

	/**
	 * Tries to discover all recipients for given package data
	 *
	 * @param	$packageData	Raw package data array
	 * @return	void
	 */
	public function discoverRecipients (array $packageData) {
		// This must be available
		assert($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);

		// First try out the direct recipient (session id)
		try {
			// Get instance (should not break)
			$recipientInstance = ObjectFactory::createObjectByConfiguredName('direct_recipient_class');

			// Try to solve it
			$recipientInstance->resolveRecipient($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $this->getListInstance());
		} catch (FrameworkException $e) {
			// Didn't work, so try the non-generic, depending recipient field itself (this may fail)
			try {
				// Try to find the right class
				$recipientInstance = ObjectFactory::createObjectByConfiguredName(strtolower($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]) . '_recipient_class');

				// And try to solve again
				$recipientInstance->resolveRecipient('', $this->getListInstance());
			} catch (FrameworkException $e) {
				// Could not find class, what ever failed
				$this->debugInstance($e->getMessage());
			}
		}
	}

	/**
	 * Tries to discover all recipients by given decoded package data.
	 *
	 * @param	$decodedData	Raw raw package data array
	 * @return	void
	 * @todo	Add some validation of recipient field, e.g. ip:port is found
	 * @todo	The if() does only check for TCP, not UDP, e.g. try to get a $handlerInstance here
	 */
	public function discoverRawRecipients (array $decodedData) {
		// This must be available
		assert($decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);

		// First clear all recipients
		$this->clearRecipients();

		// Explode 'recipient', first element is the IP/hostname
		$recipient = explode(':', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);

		// Is the 'recipient' field same as this peer's IP?
		if ((($recipient[0] == HubTools::determineOwnExternalIp()) && ($recipient[1] == $this->getConfigInstance()->getConfigEntry('node_listen_port'))) || ($recipient[0] == $this->getConfigInstance()->getServerAddress())) {
			/*
			 * Is same as own external IP + TCP/UDP listen port or internal IP, don't do anything here so other
			 * classes found an empty recipient list for internal (own) handling
			 * of the original content.
			 */

			// Debug output (may flood)
			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' matches own ip (' .  HubTools::determineOwnExternalIp() . ' or ' . $this->getConfigInstance()->getServerAddress() . ')');
		} else {
			// Debug output (may flood)
			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('RECIPIENT-DISCOVERY: Recipient ' . $recipient[0] . ' is different than own external ip (' .  HubTools::determineOwnExternalIp() . ') nor internal ip (' . $this->getConfigInstance()->getServerAddress() . '), need to forward (not yet implemented)!');

			// This package is to be delivered to someone else, so add it
			$this->getListInstance()->addEntry('ip_port', $decodedData[NetworkPackage::PACKAGE_DATA_RECIPIENT]);
		}
	}

	/**
	 * "Getter" for recipient iterator
	 *
	 * @return	$iteratorInstance	An instance of a Iterateable object
	 */
	public function getIterator () {
		// Get iterator from it
		$iteratorInstance = $this->getListInstance()->getIterator();

		// Return it
		return $iteratorInstance;
	}

	/**
	 * Checks whether the recipient list is empty
	 *
	 * @return	$isEmpty	Whether the recipient list is empty
	 */
	public function isRecipientListEmpty () {
		// Check it ...
		$isEmpty = ($this->getListInstance()->count() == 0);

		// Return it
		return $isEmpty;
	}

	/**
	 * Clears all recipients for e.g. another package to deliver. This method
	 * simply clears the inner list instance.
	 *
	 * @return	void
	 */
	public function clearRecipients () {
		// Clear the list
		$this->getListInstance()->clearList();
	}
}

// [EOF]
?>