<?php
/**
 * A Socket registry
 *
 * @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 SocketRegistry extends BaseRegistry implements Register, RegisterableSocket {
	// Exception constants
	const SOCKET_NOT_REGISTERED = 0xd00;

	/**
	 * Instance of this class
	 */
	private static $registryInstance = NULL;

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates a singleton instance of this registry class
	 *
	 * @return	$registryInstance	An instance of this class
	 */
	public static final function createSocketRegistry () {
		// Is an instance there?
		if (is_null(self::$registryInstance)) {
			// Not yet, so create one
			self::$registryInstance = new SocketRegistry();
		} // END - if

		// Return the instance
		return self::$registryInstance;
	}

	/**
	 * "Getter" to get a string respresentation for a key for the sub-registry
	 * in this format: class:protocol:port
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @return	$key				A string representation of the socket for the registry
	 */
	private function getSubRegistryKey (ProtocolHandler $protocolInstance) {
		// Default address is invalid
		$address = '*invalid*';

		// Which instance is it?
		// @TODO Tested again base class, rewrite it to a generic interface!
		if ($protocolInstance instanceof BaseConnectionHelper) {
			// Get address
			$address = $protocolInstance->getAddress();
		} elseif ($protocolInstance instanceof BaseListener) {
			// Get listen address
			$address = $protocolInstance->getListenAddress();
		} else {
			// Not supported!
			$this->debugBackTrace('Unsupported protocolInstance=' . $protocolInstance->__toString() . ' detected. Please fix this!');
		}

		// Get protocol and port number and add both together
		$key = sprintf("%s:%s:%s:%s",
			$protocolInstance->__toString(),
			$protocolInstance->getProtocol(),
			$address,
			$protocolInstance->getPort()
		);

		// Return resulting key
		return $key;
	}

	/**
	 * "Getter" to get a string respresentation of the protocol
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @return	$key				A string representation of the protocol for the registry
	 */
	private function getRegistryKeyFromProtocol (ProtocolHandler $protocolInstance) {
		// Get the key
		$key = $protocolInstance->getProtocol();

		// Return resulting key
		return $key;
	}

	/**
	 * Checks whether the given protocol is registered
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @return	$isRegistered		Whether the protocol is registered
	 */
	private function isProtocolRegistered (ProtocolHandler $protocolInstance) {
		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ' - ENTERED!');

		// Get the key
		$key = $this->getRegistryKeyFromProtocol($protocolInstance);

		// Determine it
		$isRegistered = $this->instanceExists($key);

		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ',isRegistered=' . intval($isRegistered) . ' - EXIT!');

		// Return result
		return $isRegistered;
	}

	/**
	 * Checks whether given socket resource is registered. If $socketResource is
	 * FALSE only the instance will be checked.
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @param	$socketResource		A valid socket resource
	 * @return	$isRegistered		Whether the given socket resource is registered
	 */
	public function isSocketRegistered (ProtocolHandler $protocolInstance, $socketResource) {
		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' - ENTERED!');

		// Default is not registered
		$isRegistered = FALSE;

		// First, check for the instance, there can be only once
		if ($this->isProtocolRegistered($protocolInstance)) {
			// That one is found so "get" a registry key from it
			$key = $this->getRegistryKeyFromProtocol($protocolInstance);

			// Debug message
			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',key=' . $key . ' - Trying to get instance ...');

			// Get the registry
			$registryInstance = $this->getInstance($key);

			// "Get" a key for the socket
			$socketKey = $this->getSubRegistryKey($protocolInstance);

			// Debug message
			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',key=' . $key . ',socketKey=' . $socketKey . ' - Checking existence ...');

			// Is it there?
			if ($registryInstance->instanceExists($socketKey)) {
				// Debug message
				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: Found instance for socketKey=' . $socketKey . ':' . $registryInstance->getInstance($socketKey));

				// Get the instance
				$registeredInstance = $registryInstance->getInstance($socketKey);

				// Is it SocketContainer and same socket?
				$isRegistered = (($registeredInstance instanceof SocketContainer) && ($registeredInstance->ifSocketResourceMatches($socketResource)));

				// Debug message
				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: Final result: isRegistered(' . $socketResource . ')=' . intval($isRegistered));
			} // END - if
		} // END - if

		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ',isRegistered=' . intval($isRegistered) . ' - EXIT!');

		// Return the result
		return $isRegistered;
	}

	/**
	 * Registeres given socket for listener or throws an exception if it is already registered
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @param	$socketResource		A valid socket resource
	 * @param	$packageData		Optional raw package data
	 * @throws	SocketAlreadyRegisteredException	If the given socket is already registered
	 * @return	void
	 */
	public function registerSocket (ProtocolHandler $protocolInstance, $socketResource, array $packageData = array()) {
		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' - ENTERED!');

		// Is the socket already registered?
		if ($this->isSocketRegistered($protocolInstance, $socketResource)) {
			// Throw the exception
			throw new SocketAlreadyRegisteredException(array($protocolInstance, $socketResource), BaseListener::EXCEPTION_SOCKET_ALREADY_REGISTERED);
		} // END - if

		// Does the instance exist?
		if (!$this->isProtocolRegistered($protocolInstance)) {
			// No, not found so we create a sub registry (not needed to configure!)
			$registryInstance = SubRegistry::createSubRegistry();

			// Now we can create the sub-registry for this protocol
			$this->addInstance($this->getRegistryKeyFromProtocol($protocolInstance), $registryInstance);
		} else {
			// Get the sub-registry back
			$registryInstance = $this->getInstance($this->getRegistryKeyFromProtocol($protocolInstance));
		}

		// Get a key for sub-registries
		$socketKey = $this->getSubRegistryKey($protocolInstance);

		// Get a socket container
		$socketInstance = ObjectFactory::CreateObjectByConfiguredName('socket_container_class', array($socketResource, $protocolInstance, $packageData));

		// We have a sub-registry, the socket key and the socket, now we need to put all together
		/* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: socketKey=' . $socketKey . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' - adding socket container instance ...');
		$registryInstance->addInstance($socketKey, $socketInstance);
	}

	/**
	 * Getter for given listener's socket resource
	 *
	 * @param	$protocolInstance	An instance of a ProtocolHandler class
	 * @return	$socketResource		A valid socket resource
	 * @throws	NoSocketRegisteredException		If the requested socket is not registered
	 */
	public function getRegisteredSocketResource (ProtocolHandler $protocolInstance) {
		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ' - ENTERED!');

		// The socket must be registered before we can return it
		if (!$this->isProtocolRegistered($protocolInstance)) {
			// Throw the exception
			throw new NoSocketRegisteredException ($protocolInstance, self::SOCKET_NOT_REGISTERED);
		} // END - if

		// Now get the key from the protocol
		$key = $this->getRegistryKeyFromProtocol($protocolInstance);

		// And get the registry
		$registryInstance = $this->getInstance($key);

		// Get a socket key
		$socketKey = $this->getSubRegistryKey($protocolInstance);

		// And the final socket resource
		$socketResource = $registryInstance->getInstance($socketKey)->getSocketResource();

		// Debug message
		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':protocol=' . $protocolInstance->getProtocol() . ',socketResource[' . gettype($socketResource) . ']=' . $socketResource . ' - EXIT!');

		// Return the resource
		return $socketResource;
	}

	/**
	 * "Getter" for protocol/connection instance from given package data
	 *
	 * @param	$packageData		Raw package data
	 * @return	$protocolInstance	An instance of a ProtocolHandler class
	 */
	public function getHandlerInstanceFromPackageData (array $packageData) {
		// Init protocol instance
		$protocolInstance = NULL;

		// Get all keys and check them
		foreach ($this->getInstanceRegistry() as $key => $registryInstance) {
			// Debug message
			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: key=' . $key . ',registryInstance=' . $registryInstance->__toString());

			// This is always a SubRegistry instance
			foreach ($registryInstance->getInstanceRegistry() as $subKey => $containerInstance) {
				// Debug message
				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-REGISTRY[' . __LINE__ . ']: key=' . $key . ',subKey=' . $subKey . ',containerInstance=' . $containerInstance->__toString());

				// Is this a SocketContainer instance and is the address the same?
				if (($containerInstance instanceof SocketContainer) && ($containerInstance->ifAddressMatches($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]))) {
					// Found one, so get the protocol instance and abort any further search
					$protocolInstance = $containerInstance->getProtocolInstance();
					break;
				} // END - if
			} // END - foreach
		} // END - foreach

		// Return the protocol instance
		return $protocolInstance;
	}
}

// [EOF]
?>