/trunk/ahttplib/ahttp/http_support.hpp

/*

This file is part of [ahttp] library. 



Author: Artem Kustikov (kustikoff[at]tut.by)





This code is provided 'as-is', without any express or implied

warranty. In no event will the authors be held liable for any

damages arising from the use of this code.



Permission is granted to anyone to use this code for any

purpose, including commercial applications, and to alter it and

redistribute it freely, subject to the following restrictions:



1. The origin of this code must not be misrepresented; you must

not claim that you wrote the original code. If you use this

code in a product, an acknowledgment in the product documentation

would be appreciated but is not required.



2. Altered source versions must be plainly marked as such, and

must not be misrepresented as being the original code.



3. This notice may not be removed or altered from any source

distribution.

*/



#ifndef AHTTP_HTTP_SUPPORT_H

#define AHTTP_HTTP_SUPPORT_H



#include <vector>

#include <boost/cstdint.hpp>



#include "aconnect/util.hpp"

#include "aconnect/types.hpp"

#include "aconnect/logger.hpp"

#include "aconnect/istoppable.hpp"



#include "ahttp/aconnect_types.hpp"



namespace ahttp 

{ 

	namespace port

	{

		const aconnect::port_type ftp = 21;

		const aconnect::port_type http = 80;

		const aconnect::port_type https = 443;

	};





	namespace HttpMethod

	{

		enum HttpMethodType

		{

			Unknown = 0,

			Get = 1,

			Post = 2,

			Head = 3,

		};

	};



	enum WebDirectoryItemType // defines sorting order

	{

		WdUnknown,

		WdVirtualDirectory,

		WdDirectory,

		WdFile,

	};



	enum WebDirectorySortType

	{

		WdSortByName,

		WdSortByTypeAndName,

	};





	struct WebDirectoryItem

	{

		WebDirectoryItemType	type;

		string		            name;

		string		            url;

		boost::uintmax_t		size;

		std::time_t				lastWriteTime;



		WebDirectoryItem () : type (WdUnknown), size(-1), lastWriteTime(-1) { }

		inline void clear()

		{

			type = WdUnknown;

			name.clear();

			url.clear();

			size = -1;

			lastWriteTime = -1;

		}

	};



	namespace HttpStatus

	{

		// HTTP Statuses

		enum HttpStatusType 

		{

			Continue = 100,

			SwitchingProtocols = 101,



			OK = 200,

			Created = 201,

			Accepted = 202,

			NonAuthoritativeInformation = 203,

			NoContent = 204,

			ResetContent = 205,

			PartialContent = 206,



			MultipleChoices = 300,

			MovedPermanently = 301,

			Found = 302,

			SeeOther = 303,

			NotModified = 304,

			UseProxy = 305,

			Unused = 306,

			TemporaryRedirect = 307,



			BadRequest = 400,

			Unauthorized = 401,

			PaymentRequired = 402,

			Forbidden = 403,

			NotFound = 404,

			MethodNotAllowed = 405,

			NotAcceptable = 406,

			ProxyAuthenticationRequired = 407,

			RequestTimeout = 408,

			Conflict = 409,

			Gone = 410,

			LengthRequired = 411,

			PreconditionFailed = 412,

			RequestEntityTooLarge = 413,

			RequestUriTooLong = 414,

			UnsupportedMediaType = 415,

			RequestedRangeNotSatisfiable = 416,

			ExpectationFailed = 417,



			InternalServerError = 500,

			NotImplemented = 501,

			BadGateway = 502,

			ServiceUnavailable = 503,

			GatewayTimeout = 504,

			HttpVersionNotSupported = 505

		};

	}



	namespace ContentEncoding

	{

		enum ContentEncodingType

		{

			Identity = 0,

			Gzip = 1,

			Compress = 2,

			Deflate = 3,

		};

	};



	namespace strings 

	{

		using namespace aconnect;



		const char_type WeekDays_RFC1123[7][4] = {

			"Sun", "Mon", "Tue", "Wed", "Thu" , "Fri" , "Sat"

		};

		const char_type Months_RFC1123[12][4] = {

			"Jan" , "Feb" , "Mar" , "Apr", 

			"May" , "Jun" , "Jul" , "Aug", 

			"Sep" , "Oct" , "Nov" , "Dec"

		};



	

		// HTTP Methods

		string_constant HttpMethodGet = "GET";

		string_constant HttpMethodPost = "POST";

		string_constant HttpMethodHead = "HEAD";



		// HTTP Headers

		string_constant HeaderAccept = "Accept";

		string_constant HeaderAcceptCharset = "Accept-Charset";

		string_constant HeaderAcceptEncoding = "Accept-Encoding";

		string_constant HeaderAcceptLanguage = "Accept-Language";

		string_constant HeaderAcceptRanges = "Accept-Ranges";

		string_constant HeaderAge = "Age";

		string_constant HeaderAllow = "Allow";

		string_constant HeaderAuthorization = "Authorization";

		string_constant HeaderCacheControl = "Cache-Control";

		string_constant HeaderConnection = "Connection";

		string_constant HeaderContentEncoding = "Content-Encoding";

		string_constant HeaderContentDisposition = "Content-Disposition";

		string_constant HeaderContentLanguage = "Content-Language";

		string_constant HeaderContentLength = "Content-Length";

		string_constant HeaderContentLocation = "Content-Location";

		string_constant HeaderContentMD5 = "Content-MD5";

		string_constant HeaderContentRange = "Content-Range";

		string_constant HeaderContentType = "Content-Type";

		string_constant HeaderCookie = "Cookie";

		string_constant HeaderDate = "Date";

		string_constant HeaderETag = "ETag";

		string_constant HeaderExpect = "Expect";

		string_constant HeaderExpires = "Expires";

		string_constant HeaderFrom = "From";

		string_constant HeaderHost = "Host";

		string_constant HeaderIfMatch = "If-Match";

		string_constant HeaderIfModifiedSince = "If-Modified-Since";

		string_constant HeaderIfNoneMatch = "If-None-Match";

		string_constant HeaderIfRange = "If-Range";

		string_constant HeaderIfUnmodifiedSince = "If-Unmodified-Since";

		string_constant HeaderKeepAlive = "Keep-Alive";

		string_constant HeaderLastModified = "Last-Modified";

		string_constant HeaderLocation = "Location";

		string_constant HeaderMaxForwards = "Max-Forwards";

		string_constant HeaderPragma = "Pragma";

		string_constant HeaderProxyAuthenticate = "Proxy-Authenticate";

		string_constant HeaderProxyAuthorization = "Proxy-Authorization";

		string_constant HeaderProxyConnection = "Proxy-Connection";

		string_constant HeaderRange = "Range";

		string_constant HeaderReferer = "Referer";

		string_constant HeaderRetryAfter = "Retry-After";

		string_constant HeaderServer = "Server";

		string_constant HeaderStatus = "Status";

		string_constant HeaderTE = "TE";

		string_constant HeaderTrailer = "Trailer";

		string_constant HeaderTransferEncoding = "Transfer-Encoding";

		string_constant HeaderUpgrade = "Upgrade";

		string_constant HeaderUserAgent = "User-Agent";

		string_constant HeaderVary = "Vary";

		string_constant HeaderVia = "Via";

		string_constant HeaderWarning = "Warning";

		string_constant HeaderWWWAuthenticate = "WWW-Authenticate";



		// HTTP headers values

		string_constant ConnectionKeepAlive = "Keep-Alive";

		string_constant ConnectionClose = "Close";

		

		string_constant ContentTypeTextHtml = "text/html";

		string_constant ContentTypeOctetStream = "application/octet-stream";

		string_constant ContentTypeMultipartFormData = "multipart/form-data";



		string_constant ContentDispositionFormData = "form-data";

		string_constant ContentDispositionAttachment = "attachment";



		string_constant TransferEncodingChunked = "chunked";



		string_constant CacheControlNoCache = "no-cache";

		string_constant CacheControlPrivate = "private";



		string_constant HttpsDisabledValue = "off";



		string_constant AcceptRangesBytes = "bytes";



		//==================================================================//

		//	Content encoding support										//

		//==================================================================//

		

		string_constant ContentEncodingGzip = "gzip";

		string_constant ContentEncodingGzipX = "x-gzip";



		string_constant ContentEncodingCompress = "compress";

		string_constant ContentEncodingCompressX = "x-compress";



		string_constant ContentEncodingDeflate = "deflate";

        string_constant ContentEncodingIdentity = "identity";

	

		



		//////////////////////////////////////////////////////////////////////////

		//

		//			Server variables

		//

		namespace ServerVariables

		{

			string_constant 		ALL_RAW					=	"ALL_RAW";

			string_constant 		APPL_MD_PATH			=	"APPL_MD_PATH";

			string_constant 		APPL_PHYSICAL_PATH		=	"APPL_PHYSICAL_PATH";

			string_constant 		APPL_PATH				=	"APPL_PATH";

			string_constant 		AUTH_PASSWORD			=	"AUTH_PASSWORD";

			string_constant 		AUTH_TYPE				=	"AUTH_TYPE";

			string_constant 		AUTH_USER				=	"AUTH_USER";

			string_constant 		CERT_COOKIE				=	"CERT_COOKIE";

			string_constant 		CERT_FLAGS				=	"CERT_FLAGS";

			string_constant 		CERT_ISSUER				=	"CERT_ISSUER";

			string_constant 		CERT_KEYSIZE			=	"CERT_KEYSIZE";

			string_constant 		CERT_SECRETKEYSIZE		=	"CERT_SECRETKEYSIZE";

			string_constant 		CERT_SERIALNUMBER		=	"CERT_SERIALNUMBER";

			string_constant 		CERT_SERVER_ISSUER		=	"CERT_SERVER_ISSUER";

			string_constant 		CERT_SERVER_SUBJECT		=	"CERT_SERVER_SUBJECT";

			string_constant 		CERT_SUBJECT			=	"CERT_SUBJECT";

			string_constant 		CONTENT_LENGTH			=	"CONTENT_LENGTH";

			string_constant 		CONTENT_TYPE			=	"CONTENT_TYPE";

			string_constant 		DOCUMENT_ROOT			=	"DOCUMENT_ROOT";

			string_constant 		GATEWAY_INTERFACE		=	"GATEWAY_INTERFACE";

			string_constant 		HTTPS					=	"HTTPS";

			string_constant 		HTTPS_KEYSIZE			=	"HTTPS_KEYSIZE";

			string_constant 		HTTPS_SECRETKEYSIZE		=	"HTTPS_SECRETKEYSIZE";

			string_constant 		HTTPS_SERVER_ISSUER		=	"HTTPS_SERVER_ISSUER";

			string_constant 		HTTPS_SERVER_SUBJECT	=	"HTTPS_SERVER_SUBJECT";

			string_constant 		INSTANCE_ID				=	"INSTANCE_ID";

			string_constant 		INSTANCE_META_PATH		=	"INSTANCE_META_PATH";

			string_constant 		LOCAL_ADDR				=	"LOCAL_ADDR";

			string_constant 		LOGON_USER				=	"LOGON_USER";

			string_constant 		PATH_INFO				=	"PATH_INFO";

			string_constant 		PATH_TRANSLATED			=	"PATH_TRANSLATED";

			string_constant 		QUERY_STRING			=	"QUERY_STRING";

			string_constant 		REMOTE_ADDR				=	"REMOTE_ADDR";

			string_constant 		REMOTE_HOST				=	"REMOTE_HOST";

			string_constant 		REMOTE_USER				=	"REMOTE_USER";

			string_constant 		REQUEST_METHOD			=	"REQUEST_METHOD";

			string_constant 		REQUEST_URI				=	"REQUEST_URI";

			string_constant 		SCRIPT_NAME				=	"SCRIPT_NAME";

			string_constant 		SCRIPT_FILENAME			=	"SCRIPT_FILENAME";

			string_constant 		SERVER_NAME				=	"SERVER_NAME";

			string_constant 		SERVER_ADDR				=	"SERVER_ADDR";

			string_constant 		SERVER_PORT				=	"SERVER_PORT";

			string_constant 		SERVER_PORT_SECURE		=	"SERVER_PORT_SECURE";

			string_constant 		SERVER_PROTOCOL			=	"SERVER_PROTOCOL";

			string_constant 		SERVER_SOFTWARE			=	"SERVER_SOFTWARE";

			string_constant 		URL						=	"URL";

			string_constant 		URL_ENCODED				=	"URL_ENCODED";

			string_constant 		HTTP_ACCEPT				=	"HTTP_ACCEPT";

			string_constant 		HTTP_ACCEPT_LANGUAGE 	=	"HTTP_ACCEPT_LANGUAGE";

			string_constant 		HTTP_COOKIE 			=	"HTTP_COOKIE";

			string_constant 		HTTP_CONNECTION			=	"HTTP_CONNECTION";

			string_constant 		HTTP_HOST				=	"HTTP_HOST";

			string_constant 		HTTP_REFERER			=	"HTTP_REFERER";

			string_constant 		HTTP_USER_AGENT			=	"HTTP_USER_AGENT";

			string_constant 		HTTP_ACCEPT_ENCODING 	=	"HTTP_ACCEPT_ENCODING";

			string_constant 		HTTP_ACCEPT_CHARSET		=	"HTTP_ACCEPT_CHARSET";

			string_constant 		HTTP_KEEP_ALIVE			=	"HTTP_KEEP_ALIVE";



			extern const char_type* AllVariablesList[];



			extern const int AllVariablesCount;



			extern const char_type* CgiVariablesList[];



			extern const int CgiVariablesCount;

		}

		

		//////////////////////////////////////////////////////////////////////////

		//

		//		Common server definitions  

		//

		string_constant Slash = "/";

		string_constant WindowsSlash = "\\";

		const char_type SlashCh = '/';



		string_constant ChunkHeaderFormat = "%x\r\n";

		string_constant ChunkEndMark = "\r\n";

		string_constant LastChunkFormat = "0\r\n\r\n";

			

		string_constant HttpVersion = "HTTP/1.1";

		string_constant HeadersDelimiter = "\r\n";

		string_constant HeadersEndMark = "\r\n\r\n";

		string_constant HeaderValueDelimiter = ": ";

		

		string_constant DefaultContentCharset = "ISO-8859-1"; // q=1 by default: HTTP RFC

		string_constant ContentCharsetUtf8 = "UTF-8";

		string_constant AnyContentCharsetMark = "*";

		string_constant MultipartBoundaryMark = "boundary=";

		string_constant MultipartBoundaryPrefix = "--";



		string_constant GatewayInterfaceCgi1_1 = "CGI/1.1";

	

		//

		//////////////////////////////////////////////////////////////////////////



		inline string httpMethodName (int status) 

		{

			switch (status)

			{

				case HttpMethod::Get: return HttpMethodGet;

				case HttpMethod::Post: return HttpMethodPost;

				case HttpMethod::Head: return HttpMethodHead;



				default:

					return "";

			};

		}



		inline string_constptr contentEncodingName (ContentEncoding::ContentEncodingType encoding) 

		{

			switch (encoding)

			{

				case ContentEncoding::Gzip: 

					return ContentEncodingGzip;

				

				case ContentEncoding::Deflate: 

					return ContentEncodingDeflate;

				

				case ContentEncoding::Compress: 

					return ContentEncodingCompress;



				default:

					return NULL;

			};

		}



		inline string httpStatusDesc (int status) 

		{

			string desc;



			switch(status) 

			{



			case 100 : desc = ("Continue"); break;

			case 101 : desc = ("Switching Protocols"); break;



			case 200 : desc = ("OK"); break;

			case 201 : desc = ("Created"); break;

			case 202 : desc = ("Accepted"); break;

			case 203 : desc = ("Non-Authoritative Information"); break;

			case 204 : desc = ("No Content"); break;

			case 205 : desc = ("Reset Content"); break;

			case 206 : desc = ("Partial Content"); break;



			case 300 : desc = ("Multiple Choices"); break;

			case 301 : desc = ("Moved Permanently"); break;

			case 302 : desc = ("Found"); break;

			case 303 : desc = ("See Other"); break;

			case 304 : desc = ("Not Modified"); break;

			case 305 : desc = ("Use Proxy"); break;

			case 306 : desc = ("(Unused)"); break;

			case 307 : desc = ("Temporary Redirect"); break;



			case 400 : desc = ("Bad Request"); break;

			case 401 : desc = ("Unauthorized"); break;

			case 402 : desc = ("Payment Required"); break;

			case 403 : desc = ("Forbidden"); break;

			case 404 : desc = ("Not Found"); break;

			case 405 : desc = ("Method Not Allowed"); break;

			case 406 : desc = ("Not Acceptable"); break;

			case 407 : desc = ("Proxy Authentication Required"); break;

			case 408 : desc = ("Request Timeout"); break;

			case 409 : desc = ("Conflict"); break;

			case 410 : desc = ("Gone"); break;

			case 411 : desc = ("Length Required"); break;

			case 412 : desc = ("Precondition Failed"); break;

			case 413 : desc = ("Request Entity Too Large"); break;

			case 414 : desc = ("Request-URI Too Long"); break;

			case 415 : desc = ("Unsupported Media Type"); break;

			case 416 : desc = ("Requested Range Not Satisfiable"); break;

			case 417 : desc = ("Expectation Failed"); break;



			case 500 : desc = ("Internal Server Error"); break;

			case 501 : desc = ("Not Implemented"); break;

			case 502 : desc = ("Bad Gateway"); break;

			case 503 : desc = ("Service Unavailable"); break;

			case 504 : desc = ("Gateway Timeout"); break;

			case 505 : desc = ("HTTP Version Not Supported"); break;



			default:

				desc = ("Undefined");

			}

			return desc;

		};

	}



	//////////////////////////////////////////////////////////////////////////

	//

	//		Support functions



	void readDirectoryContent (string_constref dirPath,

		string_constref dirVirtPath,

		std::vector<WebDirectoryItem> &items,

		class aconnect::Logger& logger,

		size_t &errCount,

		aconnect::IStoppable *stopable,

		bool showHiddenFiles = false,

		WebDirectorySortType sortType = WdSortByName);



	// sample: Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123

	string formatDate_RFC1123 (const struct tm& dateTime);



	// sample: Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123

	std::time_t getDateFrom_RFC1123 (string_constref date);

} 



#endif // AHTTP_HTTP_SUPPORT_H