[thirdparty/squid.git] / src / HttpHeader.h


/*
 * $Id: HttpHeader.h,v 1.23 2007/08/13 17:20:51 hno Exp $
 *
 *
 * SQUID Web Proxy Cache          http://www.squid-cache.org/
 * ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from
 *  the Internet community; see the CONTRIBUTORS file for full
 *  details.   Many organizations have provided support for Squid's
 *  development; see the SPONSORS file for full details.  Squid is
 *  Copyrighted (C) 2001 by the Regents of the University of
 *  California; see the COPYRIGHT file for full details.  Squid
 *  incorporates software developed and/or copyrighted by other
 *  sources; see the CREDITS file for full details.
 *
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 */

#ifndef SQUID_HTTPHEADER_H
#define SQUID_HTTPHEADER_H

/* forward decls */

class CacheManager;
/* because we pass a spec by value */
#include "HttpHeaderRange.h"
/* HttpHeader holds a HttpHeaderMask */
#include "HttpHeaderMask.h"

/* constant attributes of http header fields */

/* recognized or "known" header fields; @?@ add more! */
typedef enum {
    HDR_BAD_HDR = -1,
    HDR_ACCEPT = 0,
    HDR_ACCEPT_CHARSET,
    HDR_ACCEPT_ENCODING,
    HDR_ACCEPT_LANGUAGE,
    HDR_ACCEPT_RANGES,
    HDR_AGE,
    HDR_ALLOW,
    HDR_AUTHORIZATION,
    HDR_CACHE_CONTROL,
    HDR_CONNECTION,
    HDR_CONTENT_BASE,
    HDR_CONTENT_ENCODING,
    HDR_CONTENT_LANGUAGE,
    HDR_CONTENT_LENGTH,
    HDR_CONTENT_LOCATION,
    HDR_CONTENT_MD5,
    HDR_CONTENT_RANGE,
    HDR_CONTENT_TYPE,
    HDR_COOKIE,
    HDR_DATE,
    HDR_ETAG,
    HDR_EXPIRES,
    HDR_FROM,
    HDR_HOST,
    HDR_IF_MATCH,
    HDR_IF_MODIFIED_SINCE,
    HDR_IF_NONE_MATCH,
    HDR_IF_RANGE,
    HDR_KEEP_ALIVE,
    HDR_LAST_MODIFIED,
    HDR_LINK,
    HDR_LOCATION,
    HDR_MAX_FORWARDS,
    HDR_MIME_VERSION,
    HDR_PRAGMA,
    HDR_PROXY_AUTHENTICATE,
    HDR_PROXY_AUTHENTICATION_INFO,
    HDR_PROXY_AUTHORIZATION,
    HDR_PROXY_CONNECTION,
    HDR_PUBLIC,
    HDR_RANGE,
    HDR_REQUEST_RANGE,		/* some clients use this, sigh */
    HDR_REFERER,
    HDR_RETRY_AFTER,
    HDR_SERVER,
    HDR_SET_COOKIE,
    HDR_TE,
    HDR_TITLE,
    HDR_TRAILERS,
    HDR_TRANSFER_ENCODING,
    HDR_UPGRADE,
    HDR_USER_AGENT,
    HDR_VARY,
    HDR_VIA,
    HDR_WARNING,
    HDR_WWW_AUTHENTICATE,
    HDR_AUTHENTICATION_INFO,
    HDR_X_CACHE,
    HDR_X_CACHE_LOOKUP,		/* tmp hack, remove later */
    HDR_X_FORWARDED_FOR,
    HDR_X_REQUEST_URI,		/* appended if ADD_X_REQUEST_URI is #defined */
    HDR_X_SQUID_ERROR,
    HDR_NEGOTIATE,
#if X_ACCELERATOR_VARY
    HDR_X_ACCELERATOR_VARY,
#endif
    HDR_SURROGATE_CAPABILITY,
    HDR_SURROGATE_CONTROL,
    HDR_FRONT_END_HTTPS,
    HDR_OTHER,
    HDR_ENUM_END
} http_hdr_type;

/* possible types for http header fields */
typedef enum {
    ftInvalid = HDR_ENUM_END,	/* to catch nasty errors with hdr_id<->fld_type clashes */
    ftInt,
    ftInt64,
    ftStr,
    ftDate_1123,
    ftETag,
    ftPCc,
    ftPContRange,
    ftPRange,
    ftPSc,
    ftDate_1123_or_ETag
} field_type;

/* possible owners of http header */
typedef enum {
    hoNone =0,
#if USE_HTCP
    hoHtcpReply,
#endif
    hoRequest,
    hoReply
} http_hdr_owner_type;

struct _HttpHeaderFieldAttrs
{
    const char *name;
    http_hdr_type id;
    field_type type;
};

class HttpVersion;

class HttpHdrContRange;

class HttpHdrCc;

class HttpHdrSc;

/*iteration for headers; use HttpHeaderPos as opaque type, do not interpret */
typedef ssize_t HttpHeaderPos;

/* use this and only this to initialize HttpHeaderPos */
#define HttpHeaderInitPos (-1)

/* these two are defined in  structs.h */

typedef struct _TimeOrTag TimeOrTag;

typedef struct _ETag ETag;

class HttpHeaderEntry
{

public:
    HttpHeaderEntry(http_hdr_type id, const char *name, const char *value);
    ~HttpHeaderEntry();
    static HttpHeaderEntry *parse(const char *field_start, const char *field_end);
    HttpHeaderEntry *clone() const;
    void packInto(Packer *p) const;
    int getInt() const;
    int64_t getInt64() const;
    MEMPROXY_CLASS(HttpHeaderEntry);
    http_hdr_type id;
    String name;
    String value;
};

MEMPROXY_CLASS_INLINE(HttpHeaderEntry)

class HttpHeader
{

public:
    HttpHeader();
    HttpHeader(http_hdr_owner_type const &owner);
    ~HttpHeader();
    /* Interface functions */
    void clean();
    void append(const HttpHeader * src);
    void update (HttpHeader const *fresh, HttpHeaderMask const *denied_mask);
    int reset();
    int parse(const char *header_start, const char *header_end);
    void packInto(Packer * p) const;
    HttpHeaderEntry *getEntry(HttpHeaderPos * pos) const;
    HttpHeaderEntry *findEntry(http_hdr_type id) const;
    int delByName(const char *name);
    int delById(http_hdr_type id);
    void delAt(HttpHeaderPos pos, int &headers_deleted);
    void refreshMask();
    void addEntry(HttpHeaderEntry * e);
    void insertEntry(HttpHeaderEntry * e);
    String getList(http_hdr_type id) const;
    bool getList(http_hdr_type id, String *s) const;
    String getStrOrList(http_hdr_type id) const;
    String getByName(const char *name) const;
    String getByNameListMember(const char *name, const char *member, const char separator) const;
    String getListMember(http_hdr_type id, const char *member, const char separator) const;
    int has(http_hdr_type id) const;
    void putInt(http_hdr_type id, int number);
    void putInt64(http_hdr_type id, int64_t number);
    void putTime(http_hdr_type id, time_t htime);
    void insertTime(http_hdr_type id, time_t htime);
    void putStr(http_hdr_type id, const char *str);
    void putAuth(const char *auth_scheme, const char *realm);
    void putCc(const HttpHdrCc * cc);
    void putContRange(const HttpHdrContRange * cr);
    void putRange(const HttpHdrRange * range);
    void putSc(HttpHdrSc *sc);
    void putExt(const char *name, const char *value);
    int getInt(http_hdr_type id) const;
    int64_t getInt64(http_hdr_type id) const;
    time_t getTime(http_hdr_type id) const;
    const char *getStr(http_hdr_type id) const;
    const char *getLastStr(http_hdr_type id) const;
    HttpHdrCc *getCc() const;
    HttpHdrRange *getRange() const;
    HttpHdrSc *getSc() const;
    HttpHdrContRange *getContRange() const;
    const char *getAuth(http_hdr_type id, const char *auth_scheme) const;
    ETag getETag(http_hdr_type id) const;
    TimeOrTag getTimeOrTag(http_hdr_type id) const;
    int hasListMember(http_hdr_type id, const char *member, const char separator) const;
    int hasByNameListMember(const char *name, const char *member, const char separator) const;
    void removeConnectionHeaderEntries();
    /* protected, do not use these, use interface functions instead */
    Vector<HttpHeaderEntry *> entries;		/* parsed fields in raw format */
    HttpHeaderMask mask;	/* bit set <=> entry present */
    http_hdr_owner_type owner;	/* request or reply */
    int len;			/* length when packed, not counting terminating '\0' */

private:
    HttpHeaderEntry *findLastEntry(http_hdr_type id) const;
    // Make it non-copyable. Our destructor is a bit nasty...
    HttpHeader(const HttpHeader &);
    //assignment is used by the reset method, can't block it..
    //const HttpHeader operator=(const HttpHeader &);
};


extern void httpHeaderRegisterWithCacheManager(CacheManager & manager);
extern int httpHeaderParseQuotedString (const char *start, String *val);
SQUIDCEXTERN int httpHeaderHasByNameListMember(const HttpHeader * hdr, const char *name, const char *member, const char separator);
SQUIDCEXTERN void httpHeaderUpdate(HttpHeader * old, const HttpHeader * fresh, const HttpHeaderMask * denied_mask);
int httpMsgIsPersistent(HttpVersion const &http_ver, const HttpHeader * hdr);

SQUIDCEXTERN void httpHeaderCalcMask(HttpHeaderMask * mask, http_hdr_type http_hdr_type_enums[], size_t count);

#endif /* SQUID_HTTPHEADER_H */
Commit	Line	Data
e6ccf245	1
e6ccf245	2	/*
47f6e231	3	* $Id: HttpHeader.h,v 1.23 2007/08/13 17:20:51 hno Exp $
e6ccf245	4	*
	5	*
	6	* SQUID Web Proxy Cache http://www.squid-cache.org/
	7	* ----------------------------------------------------------
	8	*
	9	* Squid is the result of efforts by numerous individuals from
	10	* the Internet community; see the CONTRIBUTORS file for full
	11	* details. Many organizations have provided support for Squid's
	12	* development; see the SPONSORS file for full details. Squid is
	13	* Copyrighted (C) 2001 by the Regents of the University of
	14	* California; see the COPYRIGHT file for full details. Squid
	15	* incorporates software developed and/or copyrighted by other
	16	* sources; see the CREDITS file for full details.
	17	*
	18	* This program is free software; you can redistribute it and/or modify
	19	* it under the terms of the GNU General Public License as published by
	20	* the Free Software Foundation; either version 2 of the License, or
	21	* (at your option) any later version.
	22	*
	23	* This program is distributed in the hope that it will be useful,
	24	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	25	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	26	* GNU General Public License for more details.
	27	*
	28	* You should have received a copy of the GNU General Public License
	29	* along with this program; if not, write to the Free Software
	30	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
	31	*
	32	*/
	33
	34	#ifndef SQUID_HTTPHEADER_H
	35	#define SQUID_HTTPHEADER_H
	36
62ee09ca	37	/* forward decls */
	38
	39	class CacheManager;
528b2c61	40	/* because we pass a spec by value */
528b2c61	41	#include "HttpHeaderRange.h"
25b6a907	42	/* HttpHeader holds a HttpHeaderMask */
25b6a907	43	#include "HttpHeaderMask.h"
e6ccf245	44
e6ccf245	45	/* constant attributes of http header fields */
62e76326	46
25b6a907	47	/* recognized or "known" header fields; @?@ add more! */
	48	typedef enum {
	49	HDR_BAD_HDR = -1,
	50	HDR_ACCEPT = 0,
	51	HDR_ACCEPT_CHARSET,
	52	HDR_ACCEPT_ENCODING,
	53	HDR_ACCEPT_LANGUAGE,
	54	HDR_ACCEPT_RANGES,
	55	HDR_AGE,
	56	HDR_ALLOW,
	57	HDR_AUTHORIZATION,
	58	HDR_CACHE_CONTROL,
	59	HDR_CONNECTION,
	60	HDR_CONTENT_BASE,
	61	HDR_CONTENT_ENCODING,
	62	HDR_CONTENT_LANGUAGE,
	63	HDR_CONTENT_LENGTH,
	64	HDR_CONTENT_LOCATION,
	65	HDR_CONTENT_MD5,
	66	HDR_CONTENT_RANGE,
	67	HDR_CONTENT_TYPE,
	68	HDR_COOKIE,
	69	HDR_DATE,
	70	HDR_ETAG,
	71	HDR_EXPIRES,
	72	HDR_FROM,
	73	HDR_HOST,
	74	HDR_IF_MATCH,
	75	HDR_IF_MODIFIED_SINCE,
	76	HDR_IF_NONE_MATCH,
	77	HDR_IF_RANGE,
1d7ab0f4	78	HDR_KEEP_ALIVE,
25b6a907	79	HDR_LAST_MODIFIED,
	80	HDR_LINK,
	81	HDR_LOCATION,
	82	HDR_MAX_FORWARDS,
	83	HDR_MIME_VERSION,
	84	HDR_PRAGMA,
	85	HDR_PROXY_AUTHENTICATE,
	86	HDR_PROXY_AUTHENTICATION_INFO,
	87	HDR_PROXY_AUTHORIZATION,
	88	HDR_PROXY_CONNECTION,
	89	HDR_PUBLIC,
	90	HDR_RANGE,
	91	HDR_REQUEST_RANGE, /* some clients use this, sigh */
	92	HDR_REFERER,
	93	HDR_RETRY_AFTER,
	94	HDR_SERVER,
	95	HDR_SET_COOKIE,
1d7ab0f4	96	HDR_TE,
25b6a907	97	HDR_TITLE,
1d7ab0f4	98	HDR_TRAILERS,
25b6a907	99	HDR_TRANSFER_ENCODING,
	100	HDR_UPGRADE,
	101	HDR_USER_AGENT,
	102	HDR_VARY,
	103	HDR_VIA,
	104	HDR_WARNING,
	105	HDR_WWW_AUTHENTICATE,
	106	HDR_AUTHENTICATION_INFO,
	107	HDR_X_CACHE,
	108	HDR_X_CACHE_LOOKUP, /* tmp hack, remove later */
	109	HDR_X_FORWARDED_FOR,
	110	HDR_X_REQUEST_URI, /* appended if ADD_X_REQUEST_URI is #defined */
	111	HDR_X_SQUID_ERROR,
	112	HDR_NEGOTIATE,
	113	#if X_ACCELERATOR_VARY
	114	HDR_X_ACCELERATOR_VARY,
	115	#endif
	116	HDR_SURROGATE_CAPABILITY,
	117	HDR_SURROGATE_CONTROL,
	118	HDR_FRONT_END_HTTPS,
	119	HDR_OTHER,
	120	HDR_ENUM_END
	121	} http_hdr_type;
	122
	123	/* possible types for http header fields */
	124	typedef enum {
	125	ftInvalid = HDR_ENUM_END, /* to catch nasty errors with hdr_id<->fld_type clashes */
	126	ftInt,
47f6e231	127	ftInt64,
25b6a907	128	ftStr,
	129	ftDate_1123,
	130	ftETag,
	131	ftPCc,
	132	ftPContRange,
	133	ftPRange,
	134	ftPSc,
	135	ftDate_1123_or_ETag
	136	} field_type;
	137
	138	/* possible owners of http header */
	139	typedef enum {
0b57cb3d	140	hoNone =0,
25b6a907	141	#if USE_HTCP
	142	hoHtcpReply,
	143	#endif
	144	hoRequest,
	145	hoReply
	146	} http_hdr_owner_type;
	147
62e76326	148	struct _HttpHeaderFieldAttrs
62e76326	149	{
e6ccf245	150	const char *name;
	151	http_hdr_type id;
	152	field_type type;
	153	};
	154
450e0c10	155	class HttpVersion;
450e0c10	156
a9925b40	157	class HttpHdrContRange;
a9925b40	158
985c86bc	159	class HttpHdrCc;
985c86bc	160
a9925b40	161	class HttpHdrSc;
a9925b40	162
985c86bc	163	/iteration for headers; use HttpHeaderPos as opaque type, do not interpret /
	164	typedef ssize_t HttpHeaderPos;
	165
	166	/* use this and only this to initialize HttpHeaderPos */
	167	#define HttpHeaderInitPos (-1)
	168
	169	/* these two are defined in structs.h */
	170
	171	typedef struct _TimeOrTag TimeOrTag;
	172
	173	typedef struct _ETag ETag;
	174
eede25e7	175	class HttpHeaderEntry
	176	{
	177
	178	public:
eede25e7	179	HttpHeaderEntry(http_hdr_type id, const char name, const char value);
eede25e7	180	~HttpHeaderEntry();
cdce6c61	181	static HttpHeaderEntry parse(const char field_start, const char *field_end);
eede25e7	182	HttpHeaderEntry *clone() const;
	183	void packInto(Packer *p) const;
	184	int getInt() const;
47f6e231	185	int64_t getInt64() const;
eede25e7	186	MEMPROXY_CLASS(HttpHeaderEntry);
eede25e7	187	http_hdr_type id;
30abd221	188	String name;
30abd221	189	String value;
eede25e7	190	};
	191
	192	MEMPROXY_CLASS_INLINE(HttpHeaderEntry)
	193
924f73bc	194	class HttpHeader
	195	{
	196
	197	public:
75faaa7a	198	HttpHeader();
	199	HttpHeader(http_hdr_owner_type const &owner);
	200	~HttpHeader();
924f73bc	201	/* Interface functions */
519e0948	202	void clean();
a9925b40	203	void append(const HttpHeader * src);
	204	void update (HttpHeader const fresh, HttpHeaderMask const denied_mask);
	205	int reset();
	206	int parse(const char header_start, const char header_end);
	207	void packInto(Packer * p) const;
	208	HttpHeaderEntry getEntry(HttpHeaderPos pos) const;
	209	HttpHeaderEntry *findEntry(http_hdr_type id) const;
	210	int delByName(const char *name);
	211	int delById(http_hdr_type id);
ba9fb01d	212	void delAt(HttpHeaderPos pos, int &headers_deleted);
ba9fb01d	213	void refreshMask();
a9925b40	214	void addEntry(HttpHeaderEntry * e);
a9925b40	215	void insertEntry(HttpHeaderEntry * e);
30abd221	216	String getList(http_hdr_type id) const;
	217	bool getList(http_hdr_type id, String *s) const;
	218	String getStrOrList(http_hdr_type id) const;
	219	String getByName(const char *name) const;
	220	String getByNameListMember(const char name, const char member, const char separator) const;
	221	String getListMember(http_hdr_type id, const char *member, const char separator) const;
a9925b40	222	int has(http_hdr_type id) const;
a9925b40	223	void putInt(http_hdr_type id, int number);
47f6e231	224	void putInt64(http_hdr_type id, int64_t number);
a9925b40	225	void putTime(http_hdr_type id, time_t htime);
	226	void insertTime(http_hdr_type id, time_t htime);
	227	void putStr(http_hdr_type id, const char *str);
	228	void putAuth(const char auth_scheme, const char realm);
	229	void putCc(const HttpHdrCc * cc);
	230	void putContRange(const HttpHdrContRange * cr);
	231	void putRange(const HttpHdrRange * range);
	232	void putSc(HttpHdrSc *sc);
	233	void putExt(const char name, const char value);
	234	int getInt(http_hdr_type id) const;
47f6e231	235	int64_t getInt64(http_hdr_type id) const;
a9925b40	236	time_t getTime(http_hdr_type id) const;
	237	const char *getStr(http_hdr_type id) const;
	238	const char *getLastStr(http_hdr_type id) const;
	239	HttpHdrCc *getCc() const;
	240	HttpHdrRange *getRange() const;
	241	HttpHdrSc *getSc() const;
	242	HttpHdrContRange *getContRange() const;
	243	const char getAuth(http_hdr_type id, const char auth_scheme) const;
	244	ETag getETag(http_hdr_type id) const;
	245	TimeOrTag getTimeOrTag(http_hdr_type id) const;
	246	int hasListMember(http_hdr_type id, const char *member, const char separator) const;
	247	int hasByNameListMember(const char name, const char member, const char separator) const;
924f73bc	248	void removeConnectionHeaderEntries();
924f73bc	249	/* protected, do not use these, use interface functions instead */
75faaa7a	250	Vector<HttpHeaderEntry > entries; / parsed fields in raw format */
924f73bc	251	HttpHeaderMask mask; /* bit set <=> entry present */
	252	http_hdr_owner_type owner; /* request or reply */
	253	int len; /* length when packed, not counting terminating '\0' */
a9925b40	254
	255	private:
	256	HttpHeaderEntry *findLastEntry(http_hdr_type id) const;
6e26baea	257	// Make it non-copyable. Our destructor is a bit nasty...
	258	HttpHeader(const HttpHeader &);
	259	//assignment is used by the reset method, can't block it..
	260	//const HttpHeader operator=(const HttpHeader &);
924f73bc	261	};
528b2c61	262
62ee09ca	263
62ee09ca	264	extern void httpHeaderRegisterWithCacheManager(CacheManager & manager);
30abd221	265	extern int httpHeaderParseQuotedString (const char start, String val);
25b6a907	266	SQUIDCEXTERN int httpHeaderHasByNameListMember(const HttpHeader * hdr, const char name, const char member, const char separator);
	267	SQUIDCEXTERN void httpHeaderUpdate(HttpHeader * old, const HttpHeader * fresh, const HttpHeaderMask * denied_mask);
	268	int httpMsgIsPersistent(HttpVersion const &http_ver, const HttpHeader * hdr);
	269
	270	SQUIDCEXTERN void httpHeaderCalcMask(HttpHeaderMask * mask, http_hdr_type http_hdr_type_enums[], size_t count);
	271
e6ccf245	272	#endif /* SQUID_HTTPHEADER_H */