#include <HttpHeader.h>

Inheritance diagram for HttpHeader:

Collaboration diagram for HttpHeader:

[legend]

Public Member Functions
	HttpHeader ()

	HttpHeader (const http_hdr_owner_type owner)

	HttpHeader (const HttpHeader &other)

	~HttpHeader ()

HttpHeader &	operator= (const HttpHeader &other)

void	clean ()

void	append (const HttpHeader *src)

void	update (const HttpHeader *fresh)

bool	needUpdate (const HttpHeader *fresh) const

void	compact ()

int	parse (const char *header_start, size_t len, Http::ContentLengthInterpreter &interpreter)

int	parse (const char *buf, size_t buf_len, bool atEnd, size_t &hdr_sz, Http::ContentLengthInterpreter &interpreter)

void	packInto (Packable *p, bool mask_sensitive_info=false) const

HttpHeaderEntry *	getEntry (HttpHeaderPos *pos) const

HttpHeaderEntry *	findEntry (Http::HdrType id) const

int	delByName (const SBuf &name)

int	delByName (const char *name)

int	delById (Http::HdrType id)

void	delAt (HttpHeaderPos pos, int &headers_deleted)

void	refreshMask ()

void	addEntry (HttpHeaderEntry *e)

void	insertEntry (HttpHeaderEntry *e)

String	getList (Http::HdrType id) const

bool	getList (Http::HdrType id, String *s) const

bool	conflictingContentLength () const

String	getStrOrList (Http::HdrType id) const

String	getByName (const SBuf &name) const

String	getByName (const char *name) const

String	getById (Http::HdrType id) const

bool	getByIdIfPresent (Http::HdrType id, String *result) const

bool	hasNamed (const SBuf &s, String *value=nullptr) const

bool	hasNamed (const char name, unsigned int namelen, String value=nullptr) const

SBuf	getByNameListMember (const char name, const char member, const char separator) const

SBuf	getListMember (Http::HdrType id, const char *member, const char separator) const

int	has (Http::HdrType id) const

void	addVia (const AnyP::ProtocolVersion &ver, const HttpHeader *from=nullptr)

void	putInt (Http::HdrType id, int number)

void	putInt64 (Http::HdrType id, int64_t number)

void	putTime (Http::HdrType id, time_t htime)

void	putStr (Http::HdrType 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::HdrType id) const

int64_t	getInt64 (Http::HdrType id) const

time_t	getTime (Http::HdrType id) const

const char *	getStr (Http::HdrType id) const

const char *	getLastStr (Http::HdrType id) const

HttpHdrCc *	getCc () const

HttpHdrRange *	getRange () const

HttpHdrSc *	getSc () const

HttpHdrContRange *	getContRange () const

SBuf	getAuthToken (Http::HdrType id, const char *auth_scheme) const

ETag	getETag (Http::HdrType id) const

TimeOrTag	getTimeOrTag (Http::HdrType id) const

int	hasListMember (Http::HdrType id, const char *member, const char separator) const

int	hasByNameListMember (const char name, const char member, const char separator) const

void	removeHopByHopEntries ()

bool	chunked () const

bool	unsupportedTe () const
	whether message used an unsupported and/or invalid Transfer-Encoding More...

Public Attributes
std::vector< HttpHeaderEntry , PoolingAllocator< HttpHeaderEntry > >	entries

HttpHeaderMask	mask

http_hdr_owner_type	owner

int	len

Protected Member Functions
void	removeConnectionHeaderEntries ()

bool	skipUpdateHeader (const Http::HdrType id) const

Static Protected Member Functions
static bool	Isolate (const char parse_start, size_t l, const char blk_start, const char **blk_end)

Private Member Functions
HttpHeaderEntry *	findLastEntry (Http::HdrType id) const

Private Attributes
bool	conflictingContentLength_

bool	teUnsupported_ = false

Detailed Description

Definition at line 71 of file HttpHeader.h.

Constructor & Destructor Documentation

◆ HttpHeader() [1/3]

HttpHeader::HttpHeader ( )

Definition at line 146 of file HttpHeader.cc.

References entries, httpHeaderMaskInit(), and mask.

◆ HttpHeader() [2/3]

HttpHeader::HttpHeader ( const http_hdr_owner_type owner )

explicit

Definition at line 152 of file HttpHeader.cc.

References assert, debugs, entries, hoEnd, hoNone, httpHeaderMaskInit(), mask, and owner.

◆ HttpHeader() [3/3]

HttpHeader::HttpHeader ( const HttpHeader & other )

Definition at line 161 of file HttpHeader.cc.

References entries, httpHeaderMaskInit(), mask, and update().

◆ ~HttpHeader()

HttpHeader::~HttpHeader ( )

Definition at line 168 of file HttpHeader.cc.

References clean().

Member Function Documentation

◆ addEntry()

void HttpHeader::addEntry ( HttpHeaderEntry * e )

Definition at line 741 of file HttpHeader.cc.

References Http::any_HdrType_enum_value(), assert, Http::BAD_HDR, CBIT_SET, CBIT_TEST, debugs, entries, headerStatsTable(), HttpHeaderEntry::id, len, SBuf::length(), mask, HttpHeaderEntry::name, String::size(), and HttpHeaderEntry::value.

Referenced by append(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), Adaptation::Icap::ModXact::encapsulateHead(), Ftp::Server::handleFeatReply(), HttpStateData::httpBuildRequestHeader(), httpHdrAdd(), HttpReply::make304(), parse(), putCc(), putContRange(), putExt(), putInt(), putInt64(), putRange(), putSc(), putStr(), putTime(), and update().

◆ addVia()

void HttpHeader::addVia	(	const AnyP::ProtocolVersion &	ver,
		const HttpHeader *	from = `nullptr`
	)

Appends "this cache" information to VIA header field. Takes the initial VIA value from "from" parameter, if provided.

Definition at line 975 of file HttpHeader.cc.

References SBuf::append(), SBuf::appendf(), SBuf::c_str(), Config, delById(), getList(), SBuf::isEmpty(), SBuf::length(), AnyP::ProtocolVersion::major, AnyP::ProtocolVersion::minor, Must, SquidConfig::onoff, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, AnyP::PROTO_NONE, AnyP::PROTO_UNKNOWN, AnyP::ProtocolVersion::protocol, AnyP::ProtocolType_str, putStr(), String::SizeMaxXXX(), StringToSBuf(), ThisCache, Http::VIA, and SquidConfig::via.

Referenced by clientReplyContext::buildReplyHeader(), and HttpStateData::httpBuildRequestHeader().

◆ append()

void HttpHeader::append ( const HttpHeader * src )

Definition at line 236 of file HttpHeader.cc.

References addEntry(), assert, debugs, and entries.

Referenced by ESIVarState::ESIVarState(), HttpReply::clone(), and HttpRequest::clone().

◆ chunked()

bool HttpHeader::chunked ( ) const

inline

whether the message uses chunked Transfer-Encoding optimized implementation relies on us rejecting/removing other codings

Definition at line 163 of file HttpHeader.h.

References has(), and Http::TRANSFER_ENCODING.

Referenced by HttpRequest::checkEntityFraming(), HttpReply::expectingBody(), HttpRequest::expectingBody(), and HttpStateData::processReplyHeader().

◆ clean()

void HttpHeader::clean ( )

Definition at line 190 of file HttpHeader.cc.

References Http::any_valid_header(), assert, conflictingContentLength_, DBG_CRITICAL, debugs, entries, hoEnd, hoNone, hoReply, httpHeaderMaskInit(), HttpHeaderStats, len, mask, owner, and teUnsupported_.

Referenced by ESIVarState::~ESIVarState(), ~HttpHeader(), HttpStateData::buildRequestPrefix(), HttpReply::clean(), HttpRequest::clean(), clientPackRangeHdr(), htcpClear(), htcpHandleTstResponse(), htcpQuery(), htcpTstReply(), operator=(), parse(), ESIInclude::Start(), and Http::Tunneler::writeRequest().

◆ compact()

void HttpHeader::compact ( )

Definition at line 716 of file HttpHeader.cc.

References entries.

Referenced by HttpReply::recreateOnNotModified().

◆ conflictingContentLength()

bool HttpHeader::conflictingContentLength ( ) const

inline

Definition at line 112 of file HttpHeader.h.

References conflictingContentLength_.

Referenced by HttpRequest::checkEntityFraming().

◆ delAt()

void HttpHeader::delAt	(	HttpHeaderPos	pos,
		int &	headers_deleted
	)

Definition at line 699 of file HttpHeader.cc.

References assert, entries, HttpHeaderInitPos, len, SBuf::length(), HttpHeaderEntry::name, String::size(), and HttpHeaderEntry::value.

Referenced by clientReplyContext::buildReplyHeader(), delById(), delByName(), httpHdrMangleList(), removeConnectionHeaderEntries(), and removeHopByHopEntries().

◆ delById()

int HttpHeader::delById ( Http::HdrType id )

◆ delByName() [1/2]

int HttpHeader::delByName ( const char * name )

inline

Deprecated:: use SBuf method instead. performance regression: reallocates

Definition at line 104 of file HttpHeader.h.

References delByName().

Referenced by delByName().

◆ delByName() [2/2]

int HttpHeader::delByName ( const SBuf & name )

deletes all fields with a given name, if any.

Returns: #fields deleted

Definition at line 652 of file HttpHeader.cc.

References CBIT_SET, debugs, delAt(), getEntry(), HttpHeaderInitPos, httpHeaderMaskInit(), and mask.

Referenced by update().

◆ findEntry()

HttpHeaderEntry * HttpHeader::findEntry ( Http::HdrType id ) const

Definition at line 607 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, entries, Http::HeaderLookupTable, and mask.

Referenced by clientReplyContext::buildReplyHeader(), getContRange(), getETag(), getInt(), getInt64(), getRange(), getStr(), getStrOrList(), getTime(), getTimeOrTag(), Ftp::Server::handleRequest(), HttpReply::make304(), packInto(), and Ftp::Relay::sendCommand().

◆ findLastEntry()

HttpHeaderEntry * HttpHeader::findLastEntry ( Http::HdrType id ) const

private

Definition at line 632 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, entries, Http::HeaderLookupTable, and mask.

Referenced by getLastStr().

◆ getAuthToken()

SBuf HttpHeader::getAuthToken	(	Http::HdrType	id,
		const char *	auth_scheme
	)		const

Definition at line 1272 of file HttpHeader.cc.

References assert, base64_decode_final(), base64_decode_init(), BASE64_DECODE_LENGTH, base64_decode_update(), getStr(), Store::nil, SBuf::rawAppendFinish(), SBuf::rawAppendStart(), and xisspace.

Referenced by Ftp::Gateway::checkAuth().

◆ getById()

String HttpHeader::getById ( Http::HdrType id ) const

Definition at line 887 of file HttpHeader.cc.

References getByIdIfPresent().

◆ getByIdIfPresent()

bool HttpHeader::getByIdIfPresent	(	Http::HdrType	id,
		String *	result
	)		const

returns true iff a [possibly empty] field identified by id is there when returning true, also sets the result parameter (if it is not nil)

Definition at line 901 of file HttpHeader.cc.

References Http::BAD_HDR, getStrOrList(), and has().

Referenced by getById(), hasNamed(), and parse().

◆ getByName() [1/2]

String HttpHeader::getByName ( const char * name ) const

Definition at line 869 of file HttpHeader.cc.

References hasNamed().

◆ getByName() [2/2]

String HttpHeader::getByName ( const SBuf & name ) const

Definition at line 878 of file HttpHeader.cc.

References hasNamed().

Referenced by Format::Format::assemble(), Adaptation::Icap::Options::cfgIntHeader(), Adaptation::Icap::Options::cfgTransferList(), Adaptation::Icap::Options::configure(), getByNameListMember(), hasByNameListMember(), needUpdate(), Ssl::ErrorDetailFile::parse(), and Ftp::Server::writeErrorReply().

◆ getByNameListMember()

SBuf HttpHeader::getByNameListMember	(	const char *	name,
		const char *	member,
		const char	separator
	)		const

searches for the first matching key=value pair within the name-identified field

Returns: the value of the found pair or an empty string

Definition at line 947 of file HttpHeader.cc.

References assert, getByName(), and getListMember().

Referenced by Format::Format::assemble().

◆ getCc()

HttpHdrCc * HttpHeader::getCc ( ) const

Definition at line 1191 of file HttpHeader.cc.

References Http::CACHE_CONTROL, CBIT_TEST, getList(), httpHdrCcUpdateStats(), httpHeaderNoteParsedEntry(), HttpHeaderStats, mask, owner, and HttpHdrCc::parse().

Referenced by HttpStateData::httpBuildRequestHeader().

◆ getContRange()

HttpHdrContRange * HttpHeader::getContRange ( ) const

Definition at line 1258 of file HttpHeader.cc.

References Http::CONTENT_RANGE, findEntry(), httpHdrContRangeParseCreate(), httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, String::termedBuf(), and HttpHeaderEntry::value.

Referenced by HttpReply::hdrCacheInit().

◆ getEntry()

HttpHeaderEntry * HttpHeader::getEntry ( HttpHeaderPos * pos ) const

Definition at line 588 of file HttpHeader.cc.

References assert, entries, and HttpHeaderInitPos.

Referenced by Format::Format::assemble(), clientReplyContext::buildReplyHeader(), clientCheckPinning(), delById(), delByName(), getList(), Ftp::Server::handleFeatReply(), hasNamed(), HttpStateData::httpBuildRequestHeader(), httpHdrMangleList(), packInto(), Ftp::PrintReply(), removeConnectionHeaderEntries(), removeHopByHopEntries(), and update().

◆ getETag()

ETag HttpHeader::getETag ( Http::HdrType id ) const

Definition at line 1314 of file HttpHeader.cc.

References assert, etagParseInit(), findEntry(), Http::ftETag, Http::HeaderLookupTable, String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by clientIfRangeMatch(), and StoreEntry::hasOneOfEtags().

◆ getInt()

int HttpHeader::getInt ( Http::HdrType id ) const

Definition at line 1117 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftInt, HttpHeaderEntry::getInt(), Http::HeaderLookupTable, and type.

Referenced by Ftp::Server::handleFeatReply(), Ftp::PrintReply(), and Ftp::Server::writeForwardedReplyAndCall().

◆ getInt64()

int64_t HttpHeader::getInt64 ( Http::HdrType id ) const

Definition at line 1130 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftInt64, HttpHeaderEntry::getInt64(), Http::HeaderLookupTable, and type.

Referenced by clientGetMoreData(), ftpSendStor(), HttpReply::hdrCacheInit(), and urlCheckRequest().

◆ getLastStr()

const char * HttpHeader::getLastStr ( Http::HdrType id ) const

Definition at line 1176 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findLastEntry(), Http::ftStr, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, String::termedBuf(), type, and HttpHeaderEntry::value.

◆ getList() [1/2]

String HttpHeader::getList ( Http::HdrType id ) const

◆ getList() [2/2]

bool HttpHeader::getList	(	Http::HdrType	id,
		String *	s
	)		const

Definition at line 788 of file HttpHeader.cc.

References assert, CBIT_TEST, debugs, entries, Http::HeaderLookupTable, mask, String::size(), strListAdd(), and String::termedBuf().

◆ getListMember()

SBuf HttpHeader::getListMember	(	Http::HdrType	id,
		const char *	member,
		const char	separator
	)		const

searches for the first matching key=value pair within the field

Returns: the value of the found pair or an empty string

Definition at line 958 of file HttpHeader.cc.

References Http::any_registered_header(), assert, getListMember(), and getStrOrList().

Referenced by ESIVariableCookie::eval().

◆ getRange()

HttpHdrRange * HttpHeader::getRange ( ) const

Definition at line 1217 of file HttpHeader.cc.

References findEntry(), httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, HttpHdrRange::ParseCreate(), Http::RANGE, Http::REQUEST_RANGE, and HttpHeaderEntry::value.

Referenced by clientInterpretRequestHeaders(), and HttpRequest::hdrCacheInit().

◆ getSc()

HttpHdrSc * HttpHeader::getSc ( ) const

Definition at line 1236 of file HttpHeader.cc.

References CBIT_TEST, getList(), httpHdrScParseCreate(), httpHeaderNoteParsedEntry(), HttpHeaderStats, mask, owner, sc, and Http::SURROGATE_CONTROL.

Referenced by HttpReply::hdrCacheInit().

◆ getStr()

const char * HttpHeader::getStr ( Http::HdrType id ) const

Definition at line 1160 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftStr, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by ESIVariableUserAgent::ESIVariableUserAgent(), clientPackRangeHdr(), ESIVariableCookie::eval(), ESIVariableHost::eval(), ESIVariableReferer::eval(), ESIVariableUserAgent::eval(), getAuthToken(), HttpReply::hdrCacheInit(), ClientRequestContext::hostHeaderVerify(), ClientRequestContext::hostHeaderVerifyFailed(), Log::Format::HttpdCombined(), httpFixupAuthentication(), ACLReplyHeaderStrategy< header >::match(), ACLRequestHeaderStrategy< header >::match(), Ftp::PrintReply(), purgeEntriesByHeader(), HttpStateData::reusableReply(), Log::Format::SquidReferer(), Log::Format::SquidUserAgent(), and Ftp::Server::writeErrorReply().

◆ getStrOrList()

String HttpHeader::getStrOrList ( Http::HdrType id ) const

Definition at line 852 of file HttpHeader.cc.

References findEntry(), getList(), Http::HeaderLookupTable, and HttpHeaderEntry::value.

Referenced by getByIdIfPresent(), getListMember(), hasListMember(), ACLHTTPHeaderData::match(), and HttpReply::validatorsMatch().

◆ getTime()

time_t HttpHeader::getTime ( Http::HdrType id ) const

Definition at line 1143 of file HttpHeader.cc.

References Http::any_registered_header(), assert, findEntry(), Http::ftDate_1123, Http::HeaderLookupTable, httpHeaderNoteParsedEntry(), HttpHeaderEntry::id, Time::ParseRfc1123(), String::termedBuf(), type, and HttpHeaderEntry::value.

Referenced by clientInterpretRequestHeaders(), Adaptation::Icap::Options::configure(), HttpReply::hdrCacheInit(), and HttpReply::hdrExpirationTime().

◆ getTimeOrTag()

TimeOrTag HttpHeader::getTimeOrTag ( Http::HdrType id ) const

Definition at line 1327 of file HttpHeader.cc.

References assert, etagParseInit(), findEntry(), Http::ftDate_1123_or_ETag, Http::HeaderLookupTable, Time::ParseRfc1123(), ETag::str, TimeOrTag::tag, String::termedBuf(), TimeOrTag::time, type, TimeOrTag::valid, and HttpHeaderEntry::value.

Referenced by clientIfRangeMatch().

◆ has()

int HttpHeader::has ( Http::HdrType id ) const

Definition at line 967 of file HttpHeader.cc.

References Http::any_registered_header(), assert, CBIT_TEST, debugs, and mask.

Referenced by ESIVariableUserAgent::ESIVariableUserAgent(), HttpStateData::blockSwitchingProtocols(), Http::Stream::buildRangeHeader(), clientReplyContext::buildReplyHeader(), HttpStateData::buildRequestPrefix(), HttpRequest::canHandle1xx(), chunked(), ClientRequestContext::clientAccessCheck(), clientCheckPinning(), clientInterpretRequestHeaders(), clientPackRangeHdr(), HttpRequest::conditional(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), ESIVariableCookie::eval(), ESIVariableHost::eval(), ESIVariableLanguage::eval(), ESIVariableReferer::eval(), ESIVariableUserAgent::eval(), getByIdIfPresent(), Ftp::Server::handleRequest(), HttpStateData::haveParsedReplyHeaders(), HttpReply::hdrExpirationTime(), HttpStateData::httpBuildRequestHeader(), httpFixupAuthentication(), ACLHTTPHeaderData::match(), Ftp::PrintReply(), clientReplyContext::processConditional(), clientReplyContext::processExpired(), removeConnectionHeaderEntries(), Ftp::Relay::sendCommand(), varyEvaluateMatch(), Ftp::Server::writeCustomReply(), Ftp::Server::writeErrorReply(), Ftp::Server::writeForwardedReply(), and Ftp::Server::writeForwardedReplyAndCall().

◆ hasByNameListMember()

int HttpHeader::hasByNameListMember	(	const char *	name,
		const char *	member,
		const char	separator
	)		const

Definition at line 1683 of file HttpHeader.cc.

References assert, getByName(), and strListGetItem().

Referenced by Adaptation::Icap::Options::configure().

◆ hasListMember()

int HttpHeader::hasListMember	(	Http::HdrType	id,
		const char *	member,
		const char	separator
	)		const

Definition at line 1659 of file HttpHeader.cc.

References Http::any_registered_header(), assert, getStrOrList(), and strListGetItem().

Referenced by HttpStateData::blockSwitchingProtocols(), clientInterpretRequestHeaders(), Adaptation::Icap::Options::configure(), copyOneHeaderFromClientsideRequestToUpstreamRequest(), ESIVariableLanguage::eval(), and HttpStateData::haveParsedReplyHeaders().

◆ hasNamed() [1/2]

bool HttpHeader::hasNamed	(	const char *	name,
		unsigned int	namelen,
		String *	value = `nullptr`
	)		const

Deprecated:: use SBuf method instead.

Definition at line 913 of file HttpHeader.cc.

References assert, Http::BAD_HDR, SBuf::caseCmp(), getByIdIfPresent(), getEntry(), Http::HeaderLookupTable, HttpHeaderInitPos, Http::HeaderTableRecord::id, HttpHeaderEntry::id, SBuf::length(), Http::HeaderLookupTable_t::lookup(), HttpHeaderEntry::name, Http::OTHER, strListAdd(), String::termedBuf(), and HttpHeaderEntry::value.

◆ hasNamed() [2/2]

bool HttpHeader::hasNamed	(	const SBuf &	s,
		String *	value = `nullptr`
	)		const

returns true iff a [possibly empty] named field is there when returning true, also sets the value parameter (if it is not nil)

Definition at line 895 of file HttpHeader.cc.

References hasNamed(), SBuf::length(), and SBuf::rawContent().

Referenced by getByName(), hasNamed(), ACLHTTPHeaderData::match(), and needUpdate().

◆ insertEntry()

void HttpHeader::insertEntry ( HttpHeaderEntry * e )

Definition at line 767 of file HttpHeader.cc.

References Http::any_valid_header(), assert, CBIT_SET, CBIT_TEST, debugs, entries, headerStatsTable(), HttpHeaderEntry::id, len, SBuf::length(), mask, HttpHeaderEntry::name, String::size(), and HttpHeaderEntry::value.

◆ Isolate()

bool HttpHeader::Isolate	(	const char **	parse_start,
		size_t	l,
		const char **	blk_start,
		const char **	blk_end
	)

staticprotected

either finds the end of headers or returns false If the end was found: *parse_start points to the first character after the header delimiter *blk_start points to the first header character (i.e. old parse_start value) *blk_end points to the first header delimiter character (CR or LF in CR?LF). If block starts where it ends, then there are no fields in the header.

Definition at line 306 of file HttpHeader.cc.

References assert, and headersEnd().

Referenced by parse().