HttpHeader.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 #ifndef SQUID_HTTPHEADER_H
10 #define SQUID_HTTPHEADER_H
11 
12 #include "anyp/ProtocolVersion.h"
13 #include "base/LookupTable.h"
14 #include "http/RegisteredHeaders.h"
15 /* because we pass a spec by value */
16 #include "HttpHeaderMask.h"
17 #include "mem/PoolingAllocator.h"
18 #include "sbuf/forward.h"
19 #include "SquidString.h"
20 
21 #include <vector>
22 
23 /* class forward declarations */
24 class HttpHdrCc;
25 class HttpHdrContRange;
26 class HttpHdrRange;
27 class HttpHdrSc;
28 class Packable;
29 
31 typedef enum {
32  hoNone =0,
33 #if USE_HTCP
35 #endif
38 #if USE_OPENSSL
40 #endif
43 
45 typedef ssize_t HttpHeaderPos;
46 
47 /* use this and only this to initialize HttpHeaderPos */
48 #define HttpHeaderInitPos (-1)
49 
51 {
53 
54 public:
55  HttpHeaderEntry(Http::HdrType id, const SBuf &name, const char *value);
57  static HttpHeaderEntry *parse(const char *field_start, const char *field_end, const http_hdr_owner_type msgType);
58  HttpHeaderEntry *clone() const;
59  void packInto(Packable *p) const;
60  int getInt() const;
61  int64_t getInt64() const;
62 
66 };
67 
68 class ETag;
69 class TimeOrTag;
70 
72 {
73 
74 public:
75  HttpHeader();
76  explicit HttpHeader(const http_hdr_owner_type owner);
77  HttpHeader(const HttpHeader &other);
78  ~HttpHeader();
79 
80  HttpHeader &operator =(const HttpHeader &other);
81 
82  /* Interface functions */
83  void clean();
84  void append(const HttpHeader * src);
88  void update(const HttpHeader *fresh);
90  bool needUpdate(const HttpHeader *fresh) const;
91  void compact();
92  int parse(const char *header_start, size_t len, Http::ContentLengthInterpreter &interpreter);
97  int parse(const char *buf, size_t buf_len, bool atEnd, size_t &hdr_sz, Http::ContentLengthInterpreter &interpreter);
98  void packInto(Packable * p, bool mask_sensitive_info=false) const;
103  int delByName(const SBuf &name);
105  int delByName(const char *name) { return delByName(SBuf(name)); }
106  int delById(Http::HdrType id);
107  void delAt(HttpHeaderPos pos, int &headers_deleted);
108  void refreshMask();
109  void addEntry(HttpHeaderEntry * e);
110  void insertEntry(HttpHeaderEntry * e);
111  String getList(Http::HdrType id) const;
112  bool getList(Http::HdrType id, String *s) const;
115  String getByName(const SBuf &name) const;
116  String getByName(const char *name) const;
117  String getById(Http::HdrType id) const;
120  bool getByIdIfPresent(Http::HdrType id, String *result) const;
123  bool hasNamed(const SBuf &s, String *value = 0) const;
125  bool hasNamed(const char *name, unsigned int namelen, String *value = 0) const;
128  SBuf getByNameListMember(const char *name, const char *member, const char separator) const;
131  SBuf getListMember(Http::HdrType id, const char *member, const char separator) const;
132  int has(Http::HdrType id) const;
135  void addVia(const AnyP::ProtocolVersion &ver, const HttpHeader *from = 0);
136  void putInt(Http::HdrType id, int number);
137  void putInt64(Http::HdrType id, int64_t number);
138  void putTime(Http::HdrType id, time_t htime);
139  void putStr(Http::HdrType id, const char *str);
140  void putAuth(const char *auth_scheme, const char *realm);
141  void putCc(const HttpHdrCc * cc);
142  void putContRange(const HttpHdrContRange * cr);
143  void putRange(const HttpHdrRange * range);
144  void putSc(HttpHdrSc *sc);
145  void putWarning(const int code, const char *const text);
146  void putExt(const char *name, const char *value);
147  int getInt(Http::HdrType id) const;
148  int64_t getInt64(Http::HdrType id) const;
149  time_t getTime(Http::HdrType id) const;
150  const char *getStr(Http::HdrType id) const;
151  const char *getLastStr(Http::HdrType id) const;
152  HttpHdrCc *getCc() const;
153  HttpHdrRange *getRange() const;
154  HttpHdrSc *getSc() const;
156  SBuf getAuthToken(Http::HdrType id, const char *auth_scheme) const;
157  ETag getETag(Http::HdrType id) const;
159  int hasListMember(Http::HdrType id, const char *member, const char separator) const;
160  int hasByNameListMember(const char *name, const char *member, const char separator) const;
161  void removeHopByHopEntries();
162  inline bool chunked() const;
163 
164  /* protected, do not use these, use interface functions instead */
165  std::vector<HttpHeaderEntry*, PoolingAllocator<HttpHeaderEntry*> > entries;
168  int len;
170 protected:
179  static bool Isolate(const char **parse_start, size_t l, const char **blk_start, const char **blk_end);
180  bool skipUpdateHeader(const Http::HdrType id) const;
181  void updateWarnings();
182 
183 private:
186 };
187 
188 int httpHeaderParseQuotedString(const char *start, const int len, String *val);
189 
191 SBuf httpHeaderQuoteString(const char *raw);
192 
193 void httpHeaderCalcMask(HttpHeaderMask * mask, Http::HdrType http_hdr_type_enums[], size_t count);
194 
195 inline bool
197 {
200 }
201 
202 void httpHeaderInitModule(void);
203 
204 #endif /* SQUID_HTTPHEADER_H */
205 
void append(const HttpHeader *src)
Definition: HttpHeader.cc:237
void refreshMask()
Definition: HttpHeader.cc:740
static HttpHeaderEntry * parse(const char *field_start, const char *field_end, const http_hdr_owner_type msgType)
Definition: HttpHeader.cc:1413
HttpHdrRange * getRange() const
Definition: HttpHeader.cc:1241
bool conflictingContentLength() const
Definition: HttpHeader.h:113
int delByName(const SBuf &name)
Definition: HttpHeader.cc:665
Definition: ETag.h:17
http_hdr_owner_type owner
Definition: HttpHeader.h:167
const char * getStr(Http::HdrType id) const
Definition: HttpHeader.cc:1181
void removeHopByHopEntries()
Definition: HttpHeader.cc:1716
int hasListMember(Http::HdrType id, const char *member, const char separator) const
Definition: HttpHeader.cc:1668
void packInto(Packable *p) const
Definition: HttpHeader.cc:1519
HttpHeader & operator=(const HttpHeader &other)
Definition: HttpHeader.cc:175
ssize_t HttpHeaderPos
Definition: HttpHeader.h:45
HttpHeaderMask mask
Definition: HttpHeader.h:166
String getById(Http::HdrType id) const
Definition: HttpHeader.cc:900
HttpHeaderEntry * findLastEntry(Http::HdrType id) const
Definition: HttpHeader.cc:645
bool conflictingContentLength_
found different Content-Length fields
Definition: HttpHeader.h:185
int parse(const char *header_start, size_t len, Http::ContentLengthInterpreter &interpreter)
Definition: HttpHeader.cc:376
Definition: SBuf.h:86
String getList(Http::HdrType id) const
Definition: HttpHeader.cc:831
bool needUpdate(const HttpHeader *fresh) const
Definition: HttpHeader.cc:250
static bool Isolate(const char **parse_start, size_t l, const char **blk_start, const char **blk_end)
Definition: HttpHeader.cc:331
String getStrOrList(Http::HdrType id) const
Definition: HttpHeader.cc:865
int hasByNameListMember(const char *name, const char *member, const char separator) const
Definition: HttpHeader.cc:1692
number
Definition: testStatHist.cc:16
bool chunked() const
whether message uses chunked Transfer-Encoding
Definition: HttpHeader.h:196
bool skipUpdateHeader(const Http::HdrType id) const
Definition: HttpHeader.cc:284
TimeOrTag getTimeOrTag(Http::HdrType id) const
Definition: HttpHeader.cc:1351
void putContRange(const HttpHdrContRange *cr)
Definition: HttpHeader.cc:1073
bool hasNamed(const SBuf &s, String *value=0) const
Definition: HttpHeader.cc:908
int64_t getInt64() const
Definition: HttpHeader.cc:1541
const char * getLastStr(Http::HdrType id) const
Definition: HttpHeader.cc:1197
void httpHeaderCalcMask(HttpHeaderMask *mask, Http::HdrType http_hdr_type_enums[], size_t count)
int httpHeaderParseQuotedString(const char *start, const int len, String *val)
const char * text
Definition: errorpage.cc:153
char HttpHeaderMask[12]
void putAuth(const char *auth_scheme, const char *realm)
Definition: HttpHeader.cc:1050
std::vector< HttpHeaderEntry *, PoolingAllocator< HttpHeaderEntry * > > entries
Definition: HttpHeader.h:165
void putWarning(const int code, const char *const text)
add a Warning header
Definition: HttpHeader.cc:1121
HttpHdrSc * getSc() const
Definition: HttpHeader.cc:1260
void insertEntry(HttpHeaderEntry *e)
Definition: HttpHeader.cc:780
unsigned char code
Definition: html_quote.c:20
int delById(Http::HdrType id)
Definition: HttpHeader.cc:684
Http::HdrType id
Definition: HttpHeader.h:63
void putExt(const char *name, const char *value)
Definition: HttpHeader.cc:1130
int64_t getInt64(Http::HdrType id) const
Definition: HttpHeader.cc:1151
void addEntry(HttpHeaderEntry *e)
Definition: HttpHeader.cc:754
time_t getTime(Http::HdrType id) const
Definition: HttpHeader.cc:1164
SBuf getAuthToken(Http::HdrType id, const char *auth_scheme) const
Definition: HttpHeader.cc:1296
void putTime(Http::HdrType id, time_t htime)
Definition: HttpHeader.cc:1032
SBuf httpHeaderQuoteString(const char *raw)
quotes string using RFC 7230 quoted-string rules
int getInt(Http::HdrType id) const
Definition: HttpHeader.cc:1138
void packInto(Packable *p, bool mask_sensitive_info=false) const
Definition: HttpHeader.cc:557
static int sc[16]
Definition: smbdes.c:121
char * p
Definition: membanger.c:43
void putCc(const HttpHdrCc *cc)
Definition: HttpHeader.cc:1057
void removeConnectionHeaderEntries()
Definition: HttpHeader.cc:1733
ETag getETag(Http::HdrType id) const
Definition: HttpHeader.cc:1338
void httpHeaderInitModule(void)
Definition: HttpHeader.cc:119
String getByName(const SBuf &name) const
Definition: HttpHeader.cc:891
void putInt(Http::HdrType id, int number)
Definition: HttpHeader.cc:1014
HttpHeaderEntry * findEntry(Http::HdrType id) const
Definition: HttpHeader.cc:620
#define MEMPROXY_CLASS(CLASS)
SBuf getByNameListMember(const char *name, const char *member, const char separator) const
Definition: HttpHeader.cc:960
int has(Http::HdrType id) const
Definition: HttpHeader.cc:980
bool getByIdIfPresent(Http::HdrType id, String *result) const
Definition: HttpHeader.cc:914
void putStr(Http::HdrType id, const char *str)
Definition: HttpHeader.cc:1041
int getInt() const
Definition: HttpHeader.cc:1529
void updateWarnings()
Definition: HttpHeader.cc:271
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
HttpHeaderEntry(Http::HdrType id, const SBuf &name, const char *value)
Definition: HttpHeader.cc:1381
SBuf getListMember(Http::HdrType id, const char *member, const char separator) const
Definition: HttpHeader.cc:971
void compact()
Definition: HttpHeader.cc:729
void update(const HttpHeader *fresh)
Definition: HttpHeader.cc:295
void putSc(HttpHdrSc *sc)
Definition: HttpHeader.cc:1105
void delAt(HttpHeaderPos pos, int &headers_deleted)
Definition: HttpHeader.cc:712
int delByName(const char *name)
Definition: HttpHeader.h:105
HttpHeaderEntry * getEntry(HttpHeaderPos *pos) const
Definition: HttpHeader.cc:601
HttpHdrContRange * getContRange() const
Definition: HttpHeader.cc:1282
void addVia(const AnyP::ProtocolVersion &ver, const HttpHeader *from=0)
Definition: HttpHeader.cc:988
void putRange(const HttpHdrRange *range)
Definition: HttpHeader.cc:1089
void clean()
Definition: HttpHeader.cc:189
void const char * buf
Definition: stub_helper.cc:16
HttpHdrCc * getCc() const
Definition: HttpHeader.cc:1212
void putInt64(Http::HdrType id, int64_t number)
Definition: HttpHeader.cc:1023
HttpHeaderEntry * clone() const
Definition: HttpHeader.cc:1513
http_hdr_owner_type
Definition: HttpHeader.h:31

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors