<?php
/*
*	Pt (PHP Toolkit)
*	Copyright (C) 2008  Dinu Florin
*
*	Pt is free software: you can redistribute it and/or modify
*	it under the terms of the GNU Lesser General Public License as published by
*	the Free Software Foundation, either version 3 of the License, or
*	any later version.
*
*	Pt 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 Lesser General Public License for more details.
*
*	You should have received a copy of the GNU Lesser General Public License
*	along with Pt.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
*	This file contains the HTTP helper class.
*
*	@author		Dinu Florin <contact@florindinu.ro>
*	@package	Core
*/

/**
*	HTTP class.
*
*	@author		Dinu Florin <contact@florindinu.ro>
*	@package	Core
*/
final class HTTP
{
	/**#@+
	*	HTTP response codes.
	*/
	const CONT								= 100;
	const SWITCHING_PROTOCOLS				= 101;
	
	const OK								= 200;
	const CREATED							= 201;
	const ACCEPTED							= 202;
	const NON_AUTHORITATIVE_INFORMATION		= 203;
	const NO_CONTENT						= 204;
	const RESET_CONTENT						= 205;
	const PARTIAL_CONTENT					= 206;
	
	const MULTIPLE_CHOICES					= 300;
	const MOVED_PERMANENTLY					= 301;
	const FOUND								= 302;
	const SEE_OTHER							= 303;
	const NOT_MODIFIED						= 304;
	const USE_PROXY							= 305;
	const TEMPORARY_REDIRECT				= 307;
	
	const BAD_REQUEST						= 400;
	const UNAUTHORIZED						= 401;
	const PAYMENT_REQUIRED					= 402;
	const FORBIDDEN							= 403;
	const NOT_FOUND							= 404;
	const METHOD_NOT_ALLOWED				= 405;
	const NOT_ACCEPTABLE					= 406;
	const PROXY_AUTHENTICATION_REQUIRED		= 407;
	const REQUEST_TIMEOUT					= 408;
	const CONFLICT							= 409;
	const GONE								= 410;
	const LENGTH_REQUIRED					= 411;
	const PRECONDITION_FAILED				= 412;
	const REQUEST_ENTITY_TO_LARGE			= 413;
	const REQUEST_URI_TO_LONG				= 414;
	const UNSUPPORTED_MEDIA_TYPE			= 415;
	const REQUESTED_RANGE_NOT_SATISFIABLE	= 416;
	const EXPECTATION_FAILED				= 417;
	
	const INTERNAL_SERVER_ERROR 			= 500;
	const NOT_IMPLEMENTED					= 501;
	const BAD_GATEWAY						= 502;
	const SERVICE_UNAVAILABLE				= 503;
	const GATEWAY_TIMEOUT					= 504;
	const HTTP_VERSION_NOT_SUPPORTED		= 505;
	/**#@-*/
	
	/**#@+
	*	Response code messages.
	*	@ignore
	*/
	protected static $statusText 		= array(
		self::CONT								=> 'Continue',
		self::SWITCHING_PROTOCOLS				=> 'Switching Protocols',
		
		self::OK								=> 'OK',
		self::CREATED							=> 'Created',
		self::ACCEPTED							=> 'Accepted',
		self::NON_AUTHORITATIVE_INFORMATION		=> 'Non-Authoritative Information',
		self::NO_CONTENT						=> 'No Content',
		self::RESET_CONTENT						=> 'Reset Content',
		self::PARTIAL_CONTENT					=> 'Partial Content',
	
		self::MULTIPLE_CHOICES					=> 'Multiple Choices',
		self::MOVED_PERMANENTLY					=> 'Moved Permanently',
		self::FOUND								=> 'Found',
		self::SEE_OTHER							=> 'See Other',
		self::NOT_MODIFIED						=> 'Not Modified',
		self::USE_PROXY							=> 'Use Proxy',
		self::TEMPORARY_REDIRECT				=> 'Temporary Redirect',
		
		self::BAD_REQUEST						=> 'Bad Request',
		self::UNAUTHORIZED						=> 'Unauthorized',
		self::PAYMENT_REQUIRED					=> 'Payment Required',
		self::FORBIDDEN							=> 'Forbidden',
		self::NOT_FOUND							=> 'Not Found',
		self::METHOD_NOT_ALLOWED				=> 'Method Not Allowed',
		self::NOT_ACCEPTABLE					=> 'Not Acceptable',
		self::PROXY_AUTHENTICATION_REQUIRED		=> 'Proxy Authentication Required',
		self::REQUEST_TIMEOUT					=> 'Request Timeout',
		self::CONFLICT							=> 'Conflict',
		self::GONE								=> 'Gone',
		self::LENGTH_REQUIRED					=> 'Length Required',
		self::PRECONDITION_FAILED				=> 'Precondition Failed',
		self::REQUEST_ENTITY_TO_LARGE			=> 'Request Entity Too Large',
		self::REQUEST_URI_TO_LONG				=> 'Request-URI Too Long',
		self::UNSUPPORTED_MEDIA_TYPE			=> 'Unsupported Media Type',
		self::REQUESTED_RANGE_NOT_SATISFIABLE	=> 'Requested Range Not Satisfiable',
		self::EXPECTATION_FAILED				=> 'Expectation Failed',
		
		self::INTERNAL_SERVER_ERROR 			=> 'Internal Server Error',
		self::NOT_IMPLEMENTED					=> 'Not Implemented',
		self::BAD_GATEWAY						=> 'Bad Gateway',
		self::SERVICE_UNAVAILABLE				=> 'Service Unavailable',
		self::GATEWAY_TIMEOUT					=> 'Gateway Timeout',
		self::HTTP_VERSION_NOT_SUPPORTED		=> 'HTTP Version Not Supported',
	);
	/**#@-*/
	
	/**#@+
	*	Protocols
	*/
	const HTTP1_0	= 'HTTP/1.0';
	const HTTP1_1	= 'HTTP/1.1';
	/**#@-*/
	
	/**#@+
	*	Resquest methods.
	*/
	const GET		= 'GET';
	const POST		= 'POST';
	const PUT		= 'PUT';
	const HEAD		= 'HEAD';
	const DELETE	= 'DELETE';
	const OPTIONS	= 'OPTIONS';
	const TRACE		= 'TRACE';
	const CONNECT	= 'CONNECT';
	/**#@-*/
	
	/**
	*	Return the text associated with a HTTP status.
	*
	*	@deprecated		This method is deprecated, please use HTTP::getStatusMessage() instead.
	*	@see HTTP::getStatusMessage()
	*	@param	number	A HTTP status.
	*	@return	string.
	*/
	public static function getStatusMsg($status)
	{
		assert('is_numeric($status)');
		trigger_error('This method is deprecated, please use HTTP::getStatusMessage() instead.', E_USER_NOTICE);
		
		return self::$statusText[$status];
	}
	
	/**
	*	Return the text associated with a HTTP status.
	*
	*	@param	number	A HTTP status.
	*	@return	string.
	*/
	public static function getStatusMessage($status)
	{
		assert('is_numeric($status)');
		
		return self::$statusText[$status];
	}
	
	/**
	*	Standardize a header name. Eg. CONTENT-TYPE becomes Content-Type. It also works with custom headers.
	*
	*	@param	string	$name	The header name.
	*	@return	string
	*/
	public static function makeStdHeaderName($name)
	{
		assert('is_string($name)');
		
		$name = trim($name);
		$name = str_replace('-', ' ', $name);
		$name = ucwords(strtolower($name));
		$name = str_replace(' ', '-', $name);
		
		return $name;
	}
}
?>