/default_www/frontend/core/engine/url.php

<?php

/**
 * This class will handle the incomming URL.
 *
 * @package			frontend
 * @subpackage		core
 *
 * @author			Tijs Verkoyen <tijs@netlash.com>
 * @author			Davy Hellemans <davy@netlash.com>
 * @author			Dieter Vanden Eynde <dieter@netlash.com>
 * @since			2.0
 */
class FrontendURL
{
	/**
	 * The pages
	 *
	 * @var	array
	 */
	private $pages = array();


	/**
	 * The parameters
	 *
	 * @var	array
	 */
	private $parameters = array();


	/**
	 * The host, will be used for cookies
	 *
	 * @var	string
	 */
	private $host;


	/**
	 * The querystring
	 *
	 * @var	string
	 */
	private $queryString;


	/**
	 * Default constructor
	 *
	 * @return	void
	 */
	public function __construct()
	{
		// add ourself to the reference so other classes can retrieve us
		Spoon::set('url', $this);

		// if there is a trailing slash we permanent redirect to the page without slash
		if(mb_strlen($_SERVER['REQUEST_URI']) != 1 && mb_substr($_SERVER['REQUEST_URI'], -1) == '/') SpoonHTTP::redirect(mb_substr($_SERVER['REQUEST_URI'], 0, -1), 301);

		// set query-string for later use
		$this->setQueryString($_SERVER['REQUEST_URI']);

		// set host for later use
		$this->setHost($_SERVER['HTTP_HOST']);

		// process URL
		$this->processQueryString();

		// set constant
		define('SELF', SITE_URL . '/' . $this->queryString);
	}


	/**
	 * Get the domain
	 *
	 * @return	string	The current domain (without www.)
	 */
	public function getDomain()
	{
		// get host
		$host = $this->getHost();

		// replace
		return str_replace('www.', '', $host);
	}


	/**
	 * Get the host
	 *
	 * @return	string
	 */
	public function getHost()
	{
		return $this->host;
	}


	/**
	 * Get a page specified by the given index
	 *
	 * @return	mixed
	 * @param	int $index	The index (0-based).
	 */
	public function getPage($index)
	{
		// redefine
		$index = (int) $index;

		// does the index exists
		if(isset($this->pages[$index])) return $this->pages[$index];

		// fallback
		return null;
	}


	/**
	 * Return all the pages
	 *
	 * @return	array
	 */
	public function getPages()
	{
		return $this->pages;
	}


	/**
	 * Get a parameter specified by the given index
	 * The function will return null if the key is not available
	 * By default we will cast the return value into a string, if you want something else specify it by passing the wanted type.
	 *
	 * @return	mixed
	 * @param	mixed $index						The index of the parameter.
	 * @param	string[optional] $type				The return type, possible values are: bool, boolean, int, integer, float, double, string, array.
	 * @param	mixed[optional] $defaultValue		The value that should be returned if the key is not available.
	 */
	public function getParameter($index, $type = 'string', $defaultValue = null)
	{
		// does the index exists and isn't this parameter empty
		if(isset($this->parameters[$index]) && $this->parameters[$index] != '')
		{
			// parameter exists
			if(isset($this->parameters[$index])) return SpoonFilter::getValue($this->parameters[$index], null, null, $type);
		}

		// fallback
		return $defaultValue;
	}


	/**
	 * Return all the parameters
	 *
	 * @return	array
	 * @param	bool[optional] $includeGET		Should the GET-parameters be included?
	 */
	public function getParameters($includeGET = true)
	{
		return ($includeGET) ? $this->parameters : array_diff($this->parameters, $_GET);
	}


	/**
	 * Get the querystring
	 *
	 * @return	string
	 */
	public function getQueryString()
	{
		return $this->queryString;
	}


	/**
	 * Process the querystring
	 *
	 * @return	void
	 */
	private function processQueryString()
	{
		// store the querystring local, so we don't alter it.
		$queryString = $this->getQueryString();

		// fix GET-parameters
		$getChunks = explode('?', $queryString);

		// are there GET-parameters
		if(isset($getChunks[1]))
		{
			// get key-value pairs
			$get = explode('&', $getChunks[1]);

			// remove from querystring
			$queryString = str_replace('?' . $getChunks[1], '', $this->getQueryString());

			// loop pairs
			foreach($get as $getItem)
			{
				// get key and value
				$getChunks = explode('=', $getItem, 2);

				// key available?
				if(isset($getChunks[0]))
				{
					// reset in $_GET
					$_GET[$getChunks[0]] = (isset($getChunks[1])) ? (string) $getChunks[1] : '';

					// add into parameters
					if(isset($getChunks[1])) $this->parameters[(string) $getChunks[0]] = (string) $getChunks[1];
				}
			}
		}

		// split into chunks
		$chunks = (array) explode('/', $queryString);

		// single language
		if(!SITE_MULTILANGUAGE)
		{
			// set language id
			$language = FrontendModel::getModuleSetting('core', 'default_language', SITE_DEFAULT_LANGUAGE);
		}

		// multiple languages
		else
		{
			// default value
			$mustRedirect = false;

			// get possible languages
			$possibleLanguages = (array) FrontendLanguage::getActiveLanguages();
			$redirectLanguages = (array) FrontendLanguage::getRedirectLanguages();

			// the language is present in the URL
			if(isset($chunks[0]) && in_array($chunks[0], $possibleLanguages))
			{
				// define language
				$language = (string) $chunks[0];

				// try to set a cookie with the language
				try
				{
					// set cookie
					SpoonCookie::set('frontend_language', $language, (7 * 24 * 60 * 60), '/', '.' . $this->getDomain());
				}

				// fetch failed cookie
				catch(SpoonCookieException $e)
				{
					// settings cookies isn't allowed, because this isn't a real problem we ignore the exception
				}

				// set sessions
				SpoonSession::set('frontend_language', $language);

				// remove the language part
				array_shift($chunks);
			}

			// language set in the cookie
			elseif(SpoonCookie::exists('frontend_language') && in_array(SpoonCookie::get('frontend_language'), $redirectLanguages))
			{
				// set languageId
				$language = (string) SpoonCookie::get('frontend_language');

				// redirect is needed
				$mustRedirect = true;
			}

			// default browser language
			else
			{
				// set languageId & abbreviation
				$language = FrontendLanguage::getBrowserLanguage();

				// try to set a cookie with the language
				try
				{
					// set cookie
					SpoonCookie::set('frontend_language', $language, (7 * 24 * 60 * 60), '/', '.' . $this->getDomain());
				}

				// fetch failed cookie
				catch(SpoonCookieException $e)
				{
					// settings cookies isn't allowed, because this isn't a real problem we ignore the exception
				}

				// redirect is needed
				$mustRedirect = true;
			}

			// redirect is required
			if($mustRedirect)
			{
				// build URL
				$URL = rtrim('/' . $language . '/' . $this->getQueryString(), '/');

				// set header & redirect
				SpoonHTTP::redirect($URL, 301);
			}
		}

		// define the language
		define('FRONTEND_LANGUAGE', $language);

		// sets the localefile
		FrontendLanguage::setLocale($language);

		// list of pageIds & their full URL
		$keys = FrontendNavigation::getKeys();

		// full URL
		$URL = implode('/', $chunks);
		$startURL = $URL;

		// loop until we find the URL in the list of pages
		while(!in_array($URL, $keys))
		{
			// remove the last chunk
			array_pop($chunks);

			// redefine the URL
			$URL = implode('/', $chunks);
		}

		// remove language from querystring
		if(SITE_MULTILANGUAGE) $queryString = trim(substr($queryString, strlen($language)), '/');

		// if it's the homepage AND parameters were given (not allowed!)
		if($URL == '' && $queryString != '')
		{
			// get 404 URL
			$URL = FrontendNavigation::getURL(404);

			// remove language
			if(SITE_MULTILANGUAGE) $URL = str_replace('/' . $language, '', $URL);
		}

		// set pages
		$URL = trim($URL, '/');

		// currently not in the homepage
		if($URL != '')
		{
			// explode in pages
			$pages = explode('/', $URL);

			// reset pages
			$this->setPages($pages);

			// reset parameters
			$this->setParameters(array());
		}

		// set parameters
		$parameters = trim(substr($startURL, strlen($URL)), '/');

		// has at least one parameter
		if($parameters != '')
		{
			// parameters will be separated by /
			$parameters = explode('/', $parameters);

			// set parameters
			$this->setParameters($parameters);
		}

		// pageId, parentId & depth
		$pageId = FrontendNavigation::getPageId(implode('/', $this->getPages()));
		$pageInfo = FrontendNavigation::getPageInfo($pageId);

		// invalid page, or parameters but no extra
		if($pageInfo === false || (!empty($parameters) && !$pageInfo['has_extra']))
		{
			// get 404 URL
			$URL = FrontendNavigation::getURL(404);

			// remove language
			if(SITE_MULTILANGUAGE) $URL = trim(str_replace('/' . $language, '', $URL), '/');

			// currently not in the homepage
			if($URL != '')
			{
				// explode in pages
				$pages = explode('/', $URL);

				// reset pages
				$this->setPages($pages);

				// reset parameters
				$this->setParameters(array());
			}
		}

		// is this an internal redirect?
		if(isset($pageInfo['redirect_page_id']) && $pageInfo['redirect_page_id'] != '')
		{
			// get url for item
			$newPageURL = FrontendNavigation::getURL((int) $pageInfo['redirect_page_id']);
			$errorURL = FrontendNavigation::getURL(404);

			// not an error?
			if($newPageURL != $errorURL)
			{
				// redirect
				SpoonHTTP::redirect($newPageURL, $pageInfo['redirect_code']);
			}
		}

		// is this an external redirect?
		if(isset($pageInfo['redirect_url']) && $pageInfo['redirect_url'] != '')
		{
			// redirect
			SpoonHTTP::redirect($pageInfo['redirect_url'], $pageInfo['redirect_code']);
		}
	}


	/**
	 * Set the host
	 *
	 * @return	void
	 * @param	string $host	The value of the host.
	 */
	private function setHost($host)
	{
		$this->host = (string) $host;
	}


	/**
	 * Set the pages
	 *
	 * @return	void
	 * @param	array[optional] $pages		An array of all the pages to set.
	 */
	private function setPages(array $pages = array())
	{
		$this->pages = $pages;
	}


	/**
	 * Set the parameters
	 *
	 * @return	void
	 * @param	array[optional] $parameters	An array of all the parameters to set.
	 */
	private function setParameters(array $parameters = array())
	{
		foreach($parameters as $key => $value) $this->parameters[$key] = $value;
	}


	/**
	 * Set the querystring
	 *
	 * @return	void
	 * @param	string $queryString		The full querystring.
	 */
	private function setQueryString($queryString)
	{
		$this->queryString = trim((string) $queryString, '/');
	}
}

?>