httpdefs.h

mini http server,可以集成嵌入到程序中,实现简单的web功能

/*____________________________________________________________________________*\
 *

 Copyright (c) 1997-2003 John Roy, Holger Zimmermann. All rights reserved.

 These sources, libraries and applications are
 FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
 as long as the following conditions are adhered to.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer. 

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.

 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHORS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.

 *____________________________________________________________________________*|
 *
 * $Source: /cvsroot/pi3web/Pi3Web_200/Source/Pi3API/HTTPDefs.h,v $
 * $Date: 2004/07/04 19:42:42 $
 *
 Description:
\*____________________________________________________________________________*/
/* $SourceTop:$ */

#ifndef HTTPDEFS_H_
#define HTTPDEFS_H_

/*____________________________________________________________________________*\
 *
 Description:
\*____________________________________________________________________________*/
#define KEY_CONF_DOCUMENTROOT		"DocumentRoot"
#define KEY_CONF_MIMEFILE			"MIMEFile"
#define KEY_CONF_ADDMIMEENTRY		"AddMIMEEntry"

/* --- HTTP headers (incoming), sent in rfc822 pairs --- */
#define KEY_HTTP_STATUS				"Status"
#define KEY_HTTP_IFMODIFIEDSINCE	"If-Modified-Since"
#define KEY_HTTP_CONNECTION			"Connection"
#define KEY_HTTP_URI				"URI"
#define KEY_HTTP_COOKIE				"Cookie" // RFC 2109 cookie
#define KEY_HTTP_ACCEPT				"Accept"
#define KEY_HTTP_RANGE				"Range"
#define KEY_HTTP_IFRANGE			"If-Range"

/* --- HTTP incoming components, not sent in rfc822 pairs --- */
#define KEY_HTTP_CLF				"CLF"			
#define KEY_HTTP_METHOD				"Method"
#define KEY_HTTP_PROTOCOL			"Protocol"
#define KEY_HTTP_QUERYSTRING		"QueryString"
#define KEY_HTTP_PROXYPROTOCOL		"ProxyProtocol"
#define KEY_HTTP_PROXYHOST			"ProxyHost"
#define KEY_HTTP_PROXYPORT			"ProxyPort"
#define KEY_HTTP_STATUSCODE			"StatusCode"

/* --- outgoing --- */
#define KEY_HTTP_CONTENTTYPE		"Content-Type"
#define KEY_HTTP_CONTENTLENGTH		"Content-Length"
#define KEY_HTTP_CONTENTENCODING	"Content-Encoding"
#define KEY_HTTP_SERVER				"Server"
#define KEY_HTTP_DATE				"Date"
#define KEY_HTTP_LASTMODIFIED		"Last-Modified"
#define KEY_HTTP_LOCATION			"Location"
#define KEY_HTTP_HOST				"Host"
#define KEY_HTTP_PRAGMA				"Pragma"
#define KEY_HTTP_EXPIRES			"Expires"
#define KEY_HTTP_WWW_AUTHENTICATE	"WWW-Authenticate"
#define KEY_HTTP_AUTHORIZATION		"Authorization"
#define KEY_HTTP_SETCOOKIE			"Set-Cookie" // cookie after RFC 2109
#define KEY_HTTP_ALLOW				"Allow" // HTTP/1.1 OPTIONS
#define KEY_HTTP_PUBLIC				"Public" // HTTP/1.1 OPTIONS
#define KEY_HTTP_TRANSFERENCODING	"Transfer-Encoding"
#define KEY_HTTP_CHUNKED		    "chunked"
#define KEY_HTTP_CONTENTRANGE		"Content-Range"
#define KEY_HTTP_ACCEPTRANGES		"Accept-Ranges"
#define KEY_HTTP_BYTES				"bytes"
#define KEY_HTTP_NONE				"none"
/* --- HTTP & SSL stuff --- */
#define KEY_HTTPS_KEYSIZE			"KeySize"
#define KEY_HTTPS_SECRETKEYSIZE		"SecretKeySize"
#define KEY_HTTPS_CIPHERNAME		"CipherName"

/* --- misc --- */
#define HTTP_DIRSEPERATOR			'/'
#define HTTP_DEFAULT_PORT			(80)
#define HTTPS_DEFAULT_PORT			(443)

/* --- keys to data structures and internal values --- */
#define KEY_DS_FILEINFO				"FileInfo"
#define KEY_DS_FILEMAP				"FileMap"
#define KEY_INT_PATH				"Path"
#define KEY_INT_OLDPATH				"OldPath"
#define KEY_INT_PATHINFO			"PathInfo"
#define KEY_INT_AUTHTYPE			"AuthType"
#define KEY_INT_AUTHPASS			"AuthPass"
#define KEY_INT_REMOTEADDR			"RemoteAddr"
#define KEY_INT_REMOTEHOST			"RemoteHost"
#define KEY_INT_REMOTEIDENT			"RemoteIdent"
#define KEY_INT_REMOTEUSER			"RemoteUser"
#define KEY_INT_LOCALADDR			"LocalAddr"
#define KEY_INT_SERVERPORT			"ServerPort"
#define KEY_INT_HOSTNAME			"HostName"
#define KEY_INT_KEEPOPEN			"KeepOpen"
#define KEY_INT_OBJECTNAME			"ObjectName"
#define KEY_INT_OBJECTMAP			"ObjectMap"
#define KEY_INT_TEMPORARYFILE		"TemporaryFile"
#define KEY_INT_DEBUGGING			"Debugging"
#define KEY_INT_PATHTRANSLATED		"PathTranslated"
#define KEY_INT_SCRIPTNAME			"ScriptName"
#define KEY_INT_ERRORMESSAGE		"ErrorMessage"
#define KEY_INT_AUTHENTICATIONREALM	"AuthenticationRealm"
#define KEY_INT_RECVTIMEOUT			"RecvTimeout"
#define KEY_INT_HOSTROOT            "HostRoot"

/* --- really internal values specific internal operation and profiling --- */
#define KEY_INT_SECONDS				"Seconds"
#define KEY_INT_MICROSECONDS		"MicroSeconds"
#define KEY_INT_BYTESSENT			"BytesSent"

#define HTTP_LF						(10)
#define HTTP_CR						(13)
#define HTTP_CRLF					"\r\n"

/* ---
Phases in request/response cycle
--- */
#define PH_INVALID					(-1)
#define PH_INIT						0
#define PH_HEADERS					1
#define PH_HOSTMAP					2
#define PH_MAPPING					3
#define PH_CHECKPATH				4
#define PH_CHECKAUTH				5
#define PH_CHECKACCESS				6
#define PH_CHECKTYPE				7
#define	PH_HANDLE					8
#define PH_LOG						9
#define PH_DESTROY					10	
#define PH_NUMBER					11

/* ---
HTTP 1.0 Status codes
--- */
#define ST_OK						200
#define ST_CREATED					201
#define ST_ACCEPTED					202
#define ST_NOCONTENT				204

#define ST_PERMANENTREDIRECT		301
#define ST_FOUND					302
#define ST_NOTMODIFIED				304

#define ST_BADREQUEST				400
#define ST_UNAUTHORIZED				401
#define ST_FORBIDDEN				403
#define ST_NOTFOUND					404

#define ST_INTERNALERROR			500
#define ST_NOTIMPLEMENTED			501
#define ST_BADGATEWAY				502
#define ST_SERVICEUNAVAILABLE		503

/* ---
HTTP 1.1 Status codes
--- */
#define ST_CONTINUE					100
#define ST_SWITCHINGPROTOCOLS		101

#define ST_NONAUTHORITATIVEINFO		203
#define ST_RESETCONTENT				205
#define ST_PARTIALCONTENT			206

#define ST_MULTIPLECHOICES			300
#define ST_SEEOTHER					303
#define ST_USEPROXY					305
#define ST_UNUSED					306
#define ST_TEMPORARYREDIRECT		307

#define ST_PAYMENTREQUIRED			402
#define ST_METHODNOTALLOWED			405
#define ST_NOTACCEPTABLE			406
#define ST_PROXYAUTHREQUIRED		407
#define ST_REQUESTTIMEOUT			408
#define ST_CONFLICT					409
#define ST_GONE						410
#define ST_LENGTHREQUIRED			411
#define ST_PRECONDITIONFAILED		412
#define ST_REQUESTENTITYTOOLARGE	413
#define ST_REQUESTURITOOLONG		414
#define ST_UNSUPPORTEDMEDIATYPE		415
#define ST_RANGENOTSATISFIABLE		416
#define ST_EXPECTATIONFAILED		417

#define ST_GATEWAYTIMEOUT			504
#define ST_UNSUPPORTEDVERSION		505

/* --- 
Return codes
--- */
#define INT_CONTINUE				0
#define INT_REDIRECT				1
	
/* ---
HTTP/1.0 Methods
--- */
#define MD_NAME_GET					"GET"
#define MD_NAME_POST				"POST"
#define MD_NAME_HEAD				"HEAD"
/* ---
HTTP/1.1 Methods
--- */
#define MD_NAME_PUT	    			"PUT"
#define MD_NAME_DELETE	   			"DELETE"
#define MD_NAME_OPTIONS	   			"OPTIONS"
#define MD_NAME_TRACE	   			"TRACE"
#define MD_NAME_CONNECT	   			"CONNECT"

#define MD_UNKNOWN					0	
#define MD_GET						1
#define MD_POST						2
#define MD_HEAD						3
#define MD_PUT						4
#define MD_DELETE					5
#define MD_OPTIONS					6
#define MD_TRACE					7
#define MD_CONNECT					8
#define MD_LAST						8

/* ---
HTTP Protocols
--- */
#define PR_NAME_HTTP09				"HTTP/0.9"
#define PR_NAME_HTTP10				"HTTP/1.0"
#define PR_NAME_HTTP11				"HTTP/1.1"
#define PR_NAME_UNKNOWN				"Unknown"
#define PR_UNKNOWN					0
#define PR_HTTP09					1
#define PR_HTTP10					2
#define PR_HTTP11					3

/* ---
Internal Content-Types
--- */
#define TYPE_MAGIC_DIRECTORY		"internal/x-directory"
#define TYPE_MAGIC_CGI				"internal/x-cgi"
#define TYPE_MAGIC_SSI				"internal/x-server-parsed-html"

/* ---
Content-Type for TRACE response
--- */
#define TYPE_MSG_HTTP				"message/http"

/* ---
Defaults
--- */
#define HTTP_DEFAULT_MIME_TYPE		"application/octet-stream"

/* ---
CGI/1.1 and some extensions
--- */
#define CGI_ALL_HTTP		"ALL_HTTP"
#define CGI_AUTH_PASS		"AUTH_PASS"
#define CGI_AUTH_TYPE		"AUTH_TYPE"
#define CGI_CONTENT_LENGTH	"CONTENT_LENGTH"
#define CGI_CONTENT_TYPE	"CONTENT_TYPE"
#define CGI_GATEWAY_INTERFACE	"GATEWAY_INTERFACE"
#define CGI_PATH_INFO		"PATH_INFO"
#define CGI_PATH_TRANSLATED	"PATH_TRANSLATED"
#define CGI_QUERY_STRING	"QUERY_STRING"
#define CGI_REMOTE_ADDR		"REMOTE_ADDR"
#define CGI_REMOTE_HOST		"REMOTE_HOST"
#define CGI_REMOTE_USER		"REMOTE_USER"
#define CGI_REQUEST_METHOD	"REQUEST_METHOD"
#define CGI_SCRIPT_NAME		"SCRIPT_NAME"
#define CGI_SERVER_NAME		"SERVER_NAME"
#define CGI_SERVER_PORT		"SERVER_PORT"
#define CGI_SERVER_PROTOCOL	"SERVER_PROTOCOL"
#define CGI_SERVER_SOFTWARE	"SERVER_SOFTWARE"

#endif /* HTTPDEFS_H_ */