HttpHeader.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2019 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);
85  bool update(HttpHeader const *fresh);
86  void compact();
87  int parse(const char *header_start, size_t len, Http::ContentLengthInterpreter &interpreter);
92  int parse(const char *buf, size_t buf_len, bool atEnd, size_t &hdr_sz, Http::ContentLengthInterpreter &interpreter);
93  void packInto(Packable * p, bool mask_sensitive_info=false) const;
94  HttpHeaderEntry *getEntry(HttpHeaderPos * pos) const;
95  HttpHeaderEntry *findEntry(Http::HdrType id) const;
98  int delByName(const SBuf &name);
100  int delByName(const char *name) { return delByName(SBuf(name)); }
101  int delById(Http::HdrType id);
102  void delAt(HttpHeaderPos pos, int &headers_deleted);
103  void refreshMask();
104  void addEntry(HttpHeaderEntry * e);
105  void insertEntry(HttpHeaderEntry * e);
106  String getList(Http::HdrType id) const;
107  bool getList(Http::HdrType id, String *s) const;
108  bool conflictingContentLength() const { return conflictingContentLength_; }
109  String getStrOrList(Http::HdrType id) const;
110  String getByName(const SBuf &name) const;
111  String getByName(const char *name) const;
112  String getById(Http::HdrType id) const;
115  bool getByIdIfPresent(Http::HdrType id, String *result) const;
118  bool hasNamed(const SBuf &s, String *value = 0) const;
120  bool hasNamed(const char *name, unsigned int namelen, String *value = 0) const;
123  SBuf getByNameListMember(const char *name, const char *member, const char separator) const;
126  SBuf getListMember(Http::HdrType id, const char *member, const char separator) const;
127  int has(Http::HdrType id) const;
130  void addVia(const AnyP::ProtocolVersion &ver, const HttpHeader *from = 0);
131  void putInt(Http::HdrType id, int number);
132  void putInt64(Http::HdrType id, int64_t number);
133  void putTime(Http::HdrType id, time_t htime);
134  void putStr(Http::HdrType id, const char *str);
135  void putAuth(const char *auth_scheme, const char *realm);
136  void putCc(const HttpHdrCc * cc);
137  void putContRange(const HttpHdrContRange * cr);
138  void putRange(const HttpHdrRange * range);
139  void putSc(HttpHdrSc *sc);
140  void putWarning(const int code, const char *const text);
141  void putExt(const char *name, const char *value);
142  int getInt(Http::HdrType id) const;
143  int64_t getInt64(Http::HdrType id) const;
144  time_t getTime(Http::HdrType id) const;
145  const char *getStr(Http::HdrType id) const;
146  const char *getLastStr(Http::HdrType id) const;
147  HttpHdrCc *getCc() const;
148  HttpHdrRange *getRange() const;
149  HttpHdrSc *getSc() const;
150  HttpHdrContRange *getContRange() const;
151  SBuf getAuthToken(Http::HdrType id, const char *auth_scheme) const;
152  ETag getETag(Http::HdrType id) const;
153  TimeOrTag getTimeOrTag(Http::HdrType id) const;
154  int hasListMember(Http::HdrType id, const char *member, const char separator) const;
155  int hasByNameListMember(const char *name, const char *member, const char separator) const;
156  void removeHopByHopEntries();
157  inline bool chunked() const;
158 
159  /* protected, do not use these, use interface functions instead */
160  std::vector<HttpHeaderEntry*, PoolingAllocator<HttpHeaderEntry*> > entries;
163  int len;
165 protected:
167  void removeConnectionHeaderEntries();
174  static bool Isolate(const char **parse_start, size_t l, const char **blk_start, const char **blk_end);
175  bool needUpdate(const HttpHeader *fresh) const;
176  bool skipUpdateHeader(const Http::HdrType id) const;
177  void updateWarnings();
178 
179 private:
180  HttpHeaderEntry *findLastEntry(Http::HdrType id) const;
182 };
183 
184 int httpHeaderParseQuotedString(const char *start, const int len, String *val);
185 
187 SBuf httpHeaderQuoteString(const char *raw);
188 
189 void httpHeaderCalcMask(HttpHeaderMask * mask, Http::HdrType http_hdr_type_enums[], size_t count);
190 
191 inline bool
193 {
194  return has(Http::HdrType::TRANSFER_ENCODING) &&
195  hasListMember(Http::HdrType::TRANSFER_ENCODING, "chunked", ',');
196 }
197 
198 void httpHeaderInitModule(void);
199 
200 #endif /* SQUID_HTTPHEADER_H */
201 
static int sc[16]
Definition: smbdes.c:121
http_hdr_owner_type
Definition: HttpHeader.h:31
#define MEMPROXY_CLASS(CLASS)
Definition: ETag.h:17
bool conflictingContentLength() const
Definition: HttpHeader.h:108
std::vector< HttpHeaderEntry *, PoolingAllocator< HttpHeaderEntry * > > entries
Definition: HttpHeader.h:160
int httpHeaderParseQuotedString(const char *start, const int len, String *val)
void httpHeaderCalcMask(HttpHeaderMask *mask, Http::HdrType http_hdr_type_enums[], size_t count)
Definition: SBuf.h:86
SBuf getListMember(const String &list, const char *key, const char delimiter)
Definition: StrList.cc:135
HttpHeaderMask mask
Definition: HttpHeader.h:161
HttpHeaderEntry * clone() const
Definition: HttpHeader.cc:1507
bool conflictingContentLength_
found different Content-Length fields
Definition: HttpHeader.h:181
char * p
Definition: membanger.c:43
Http::HdrType id
Definition: HttpHeader.h:63
int getInt() const
Definition: HttpHeader.cc:1523
int64_t getInt64() const
Definition: HttpHeader.cc:1535
bool chunked() const
whether message uses chunked Transfer-Encoding
Definition: HttpHeader.h:192
HttpHeaderEntry(Http::HdrType id, const SBuf &name, const char *value)
Definition: HttpHeader.cc:1375
int delByName(const char *name)
Definition: HttpHeader.h:100
http_hdr_owner_type owner
Definition: HttpHeader.h:162
char HttpHeaderMask[12]
static HttpHeaderEntry * parse(const char *field_start, const char *field_end, const http_hdr_owner_type msgType)
Definition: HttpHeader.cc:1407
int unsigned int const char *desc STUB void int len
Definition: stub_fd.cc:20
unsigned char code
Definition: html_quote.c:20
void const char * buf
Definition: stub_helper.cc:16
ssize_t HttpHeaderPos
Definition: HttpHeader.h:45
number
Definition: testStatHist.cc:16
void packInto(Packable *p) const
Definition: HttpHeader.cc:1513
SBuf httpHeaderQuoteString(const char *raw)
quotes string using RFC 7230 quoted-string rules
const char * text
Definition: errorpage.cc:153
void httpHeaderInitModule(void)
Definition: HttpHeader.cc:119

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors