<?php
/**
 * Middleware class for selecting the right compressor channel
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 CompressorChannel extends BaseMiddleware implements Registerable {
	/**
	 * Real compressor instance
	 */
	private $compressor = NULL;

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

	/**
	 * Create a new compressor channel.
	 *
	 * @return	$compressorInstance		A prepared instance of this class
	 */
	public static final function createCompressorChannel () {
		// Get new instance
		$compressorInstance = new CompressorChannel();

		// Is the compressor handler set?
		if (
			   (is_null($compressorInstance->getCompressor()))
			|| (!is_object($compressorInstance->getCompressor()))
			|| (!method_exists($compressorInstance->getCompressor(), 'compressStream'))
			|| (!method_exists($compressorInstance->getCompressor(), 'decompressStream'))
		) {
			// Init base directory
			$baseDir =
				$compressorInstance->getConfigInstance()->getConfigEntry('base_path') .
				$compressorInstance->getConfigInstance()->getConfigEntry('compressor_base_path');

			// Get a directory pointer
			$dirPointer = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($baseDir);

			// Read all directories but no sub directories
			while ($directoryEntry = $dirPointer->readDirectoryExcept(array('..', '.', '.htaccess', '.svn', 'class_NullCompressor.php'))) {
				// Is this a class file?
				if ((substr($directoryEntry, 0, 6) == 'class_') && (substr($directoryEntry, -4, 4) == '.php')) {
					/* Get the compressor's name. That's why you must name
					 * your files like your classes and also that's why you
					 * must keep on class in one file.
					 */
					$className = substr($directoryEntry, 6, -4);

					// Get an instance from our object factory
					$tempInstance = ObjectFactory::createObjectByName($className);

					// Is it null?
					if (is_null($tempInstance)) {
						// Then skip to the next one
						continue;
					} // END - if

					// Set the compressor
					$compressorInstance->setCompressor($tempInstance);

					// No more searches required because we have found a valid compressor stream
					break;
				} // END - if
			} // END - while

			// Close the directory
			$dirPointer->closeDirectory();
		} // END - if

		// Check again if there is a compressor
		if (
			   (is_null($compressorInstance->getCompressor()))
			|| (!is_object($compressorInstance->getCompressor()))
			|| (!method_exists($compressorInstance->getCompressor(), 'compressStream'))
			|| (!method_exists($compressorInstance->getCompressor(), 'decompressStream'))
		) {
			// Set the null compressor handler. This should not be configureable!
			$compressorInstance->setCompressor(ObjectFactory::createObjectByName('NullCompressor'));
		} // END - if

		// Return the compressor instance
		return $compressorInstance;
	}

	/**
	 * Getter for compressor instance
	 *
	 * @return	$compressor	The compressor instance
	 */
	public final function getCompressor () {
		return $this->compressor;
	}

	/**
	 * Setter for compressor
	 *
	 * @param		$compressorInstance	The compressor instance we shall use
	 * @return	void
	 */
	public final function setCompressor (Compressor $compressorInstance = NULL) {
		$this->compressor = $compressorInstance;
	}

	/**
	 * Getter for the file extension of the current compressor
	 */
	public final function getCompressorExtension () {
		// Get compressor extension from current compressor
		return $this->getCompressor()->getCompressorExtension();
	}
}

// [EOF]
?>