#include <HttpReply.h>

Inheritance diagram for HttpReply:

Collaboration diagram for HttpReply:

Public Types
typedef RefCount< HttpReply >	Pointer

enum	Sources { srcUnknown = 0 , srcHttps = 1 << 0 , srcFtps = 1 << 1 , srcIcaps = 1 << 2 , srcEcaps = 1 << 3 , srcHttp = 1 << (16 + 0) , srcFtp = 1 << (16 + 1) , srcIcap = 1 << (16 + 2) , srcEcap = 1 << (16 + 3) , srcWhois = 1 << (16 + 15) , srcUnsafe = 0xFFFF0000 , srcSafe = 0x0000FFFF }
	Who may have created or modified this message? More...

enum	ParseState { psReadyToParseStartLine = 0 , psReadyToParseHeaders , psParsed , psError }
	parse state of HttpReply or HttpRequest More...

Public Member Functions
	HttpReply ()

	~HttpReply () override

void	reset () override

bool	sanityCheckStartLine (const char buf, const size_t hdr_len, Http::StatusCode error) override

const HttpHdrContRange *	contentRange () const

int	httpMsgParseError () override

bool	expectingBody (const HttpRequestMethod &, int64_t &) const override

bool	inheritProperties (const Http::Message *) override

Pointer	recreateOnNotModified (const HttpReply &reply304) const

void	setHeaders (Http::StatusCode status, const char reason, const char ctype, int64_t clen, time_t lmt, time_t expires)

MemBuf *	pack () const

HttpReplyPointer	make304 () const

void	redirect (Http::StatusCode, const char *)

int64_t	bodySize (const HttpRequestMethod &) const

bool	receivedBodyTooLarge (HttpRequest &, int64_t receivedBodySize)

bool	expectedBodyTooLarge (HttpRequest &request)

int	validatorsMatch (HttpReply const *other) const

void	packHeadersUsingFastPacker (Packable &p) const

void	packHeadersUsingSlowPacker (Packable &p) const
	same as packHeadersUsingFastPacker() but assumes that `p` cannot quickly process small additions

HttpReply *	clone () const override

void	hdrCacheInit () override

bool	olderThan (const HttpReply *them) const

void	removeIrrelevantContentLength ()
	Some response status codes prohibit sending Content-Length (RFC 7230 section 3.3.2).

void	configureContentLengthInterpreter (Http::ContentLengthInterpreter &) override
	configures the interpreter as needed

bool	parseHeader (Http1::Parser &hp)
	parses reply header using Parser

size_t	parseTerminatedPrefix (const char *, size_t)

size_t	prefixLen () const

void	packInto (Packable *, bool full_uri) const
	produce a message copy, except for a few connection-specific settings

void	setContentLength (int64_t)
	[re]sets Content-Length header and cached value

bool	persistent () const

void	putCc (const HttpHdrCc &)

bool	parse (const char buf, const size_t sz, bool eol, Http::StatusCode error)

bool	parseCharBuf (const char *buf, ssize_t end)

int	httpMsgParseStep (const char *buf, int len, int atEnd)

void	firstLineBuf (MemBuf &)
	useful for debugging

Static Public Member Functions
static HttpReplyPointer	MakeConnectionEstablished ()
	construct and return an HTTP/200 (Connection Established) response

Public Attributes
time_t	date

time_t	last_modified

time_t	expires

String	content_type

HttpHdrSc *	surrogate_control

short int	keep_alive

Http::StatusLine	sline

HttpBody	body

String	protoPrefix

bool	do_clean

AnyP::ProtocolVersion	http_ver

HttpHeader	header

HttpHdrCc *	cache_control = nullptr

int	hdr_sz = 0

int64_t	content_length = 0

ParseState	pstate = Http::Message::psReadyToParseStartLine
	the current parsing state

BodyPipe::Pointer	body_pipe
	optional pipeline to receive message body

uint32_t	sources = 0
	The message sources.

Protected Member Functions
void	packFirstLineInto (Packable *p, bool) const override

bool	parseFirstLine (const char start, const char end) override

bool	parseHeader (Http1::Parser &, Http::ContentLengthInterpreter &)

Private Member Functions
	MEMPROXY_CLASS (HttpReply)

void	init ()

void	clean ()

void	hdrCacheClean ()

void	packInto (MemBuf &) const

MemBuf *	packed304Reply () const

time_t	hdrExpirationTime ()

void	calcMaxBodySize (HttpRequest &request) const

Private Attributes
int64_t	bodySizeMax

HttpHdrContRange *	content_range
	parsed Content-Range; nil for non-206 responses!

Detailed Description

Definition at line 24 of file HttpReply.h.

Member Typedef Documentation

◆ Pointer

typedef RefCount<HttpReply> HttpReply::Pointer

Definition at line 29 of file HttpReply.h.

Member Enumeration Documentation

◆ ParseState

enum Http::Message::ParseState

inherited

Enumerator
psReadyToParseStartLine
psReadyToParseHeaders
psParsed
psError

Definition at line 86 of file Message.h.

◆ Sources

enum Http::Message::Sources

inherited

Enumerator
srcUnknown
srcHttps	https_port or bumped http_port tunnel; HTTPS server
srcFtps	ftps_port or SFTP server; currently unused
srcIcaps	Secure ICAP service.
srcEcaps	eCAP service that is considered secure; currently unused
srcHttp	http_port or HTTP server
srcFtp	ftp_port or FTP server
srcIcap	traditional ICAP service without encryption
srcEcap	eCAP service that uses insecure libraries/daemons
srcWhois	Whois server.
srcUnsafe	Unsafe sources mask.
srcSafe	Safe sources mask.

Definition at line 29 of file Message.h.

Constructor & Destructor Documentation

◆ HttpReply()

HttpReply::HttpReply ( )

Definition at line 30 of file HttpReply.cc.

References init().

Referenced by clone().

◆ ~HttpReply()

HttpReply::~HttpReply ( )

override

Definition at line 44 of file HttpReply.cc.

References clean(), and do_clean.

Member Function Documentation

◆ bodySize()

int64_t HttpReply::bodySize ( const HttpRequestMethod & method ) const

Definition at line 377 of file HttpReply.cc.

References Http::Message::content_length, HttpRequestMethod::id(), AnyP::ProtocolVersion::major, Http::METHOD_HEAD, Http::scNoContent, Http::scNotModified, Http::scOkay, sline, Http::StatusLine::status(), and Http::StatusLine::version.

Referenced by clientReplyContext::buildReplyHeader(), MemObject::expectedReplySize(), ClientHttpRequest::gotEnough(), HttpStateData::keepaliveAccounting(), HttpStateData::persistentConnStatus(), and clientReplyContext::replyStatus().

◆ calcMaxBodySize()

void HttpReply::calcMaxBodySize ( HttpRequest & request ) const

private

Calculates and stores maximum body size if needed. Used by receivedBodyTooLarge() and expectedBodyTooLarge().

Definition at line 586 of file HttpReply.cc.

References Acl::Answer::allowed(), bodySizeMax, Config, debugs, ACLChecklist::fastCheck(), SquidConfig::ReplyBodySize, and ACLFilledChecklist::updateReply().

Referenced by expectedBodyTooLarge(), and receivedBodyTooLarge().

◆ clean()

void HttpReply::clean ( )

private

Definition at line 73 of file HttpReply.cc.

References body, Http::Message::body_pipe, bodySizeMax, Http::StatusLine::clean(), HttpHeader::clean(), HttpBody::clear(), hdrCacheClean(), Http::Message::header, and sline.

Referenced by ~HttpReply(), and reset().

◆ clone()

HttpReply * HttpReply::clone ( ) const

overridevirtual

Clone this reply. Could be done as a copy-contructor but we do not want to accidentally copy a HttpReply..

Implements Http::Message.

Definition at line 611 of file HttpReply.cc.

References HttpReply(), HttpHeader::append(), Http::Message::body_pipe, Http::Message::hdr_sz, hdrCacheInit(), Http::Message::header, Http::Message::http_ver, Http::Message::pstate, and sline.

Referenced by clientReplyContext::cloneReply(), and recreateOnNotModified().

◆ configureContentLengthInterpreter()

void HttpReply::configureContentLengthInterpreter ( Http::ContentLengthInterpreter & )

overridevirtual

Implements Http::Message.

Definition at line 501 of file HttpReply.cc.

References Http::ContentLengthInterpreter::applyStatusCodeRules(), sline, and Http::StatusLine::status().

◆ contentRange()

const HttpHdrContRange * HttpReply::contentRange ( ) const

Returns: parsed Content-Range for a 206 response and nil for others

Definition at line 345 of file HttpReply.cc.

References assert, content_range, Http::scPartialContent, sline, and Http::StatusLine::status().

Referenced by Http::Stream::buildRangeHeader(), HttpHdrRange::canonize(), and Client::haveParsedReplyHeaders().

◆ expectedBodyTooLarge()

bool HttpReply::expectedBodyTooLarge ( HttpRequest & request )

Checks whether expected body exceeds known maximum size. Requires a prior call to calcMaxBodySize().

Definition at line 565 of file HttpReply.cc.

References bodySizeMax, calcMaxBodySize(), debugs, expectingBody(), and HttpRequest::method.

Referenced by clientReplyContext::processReplyAccess().

◆ expectingBody()

bool HttpReply::expectingBody	(	const HttpRequestMethod &	req_method,
		int64_t &	theSize
	)		const

overridevirtual

Implements Http::Message.

Definition at line 528 of file HttpReply.cc.

References HttpHeader::chunked(), Http::Message::content_length, Http::Message::header, Http::METHOD_HEAD, Http::scNoContent, Http::scNotModified, Http::scOkay, sline, and Http::StatusLine::status().

Referenced by expectedBodyTooLarge(), Client::startAdaptation(), and HttpStateData::truncateVirginBody().

◆ firstLineBuf()

void Http::Message::firstLineBuf ( MemBuf & mb )

inherited

Definition at line 270 of file Message.cc.

◆ hdrCacheClean()

void HttpReply::hdrCacheClean ( )

private

Definition at line 353 of file HttpReply.cc.

References Http::Message::cache_control, String::clean(), content_range, content_type, and surrogate_control.

Referenced by clean(), and recreateOnNotModified().

◆ hdrCacheInit()

void HttpReply::hdrCacheInit ( )

overridevirtual

Reimplemented from Http::Message.

Definition at line 321 of file HttpReply.cc.

References String::assign(), Http::Message::content_length, Http::CONTENT_LENGTH, content_range, Http::CONTENT_TYPE, content_type, Http::DATE, date, expires, HttpHeader::getContRange(), HttpHeader::getInt64(), HttpHeader::getSc(), HttpHeader::getStr(), HttpHeader::getTime(), Http::Message::hdrCacheInit(), hdrExpirationTime(), Http::Message::header, Http::Message::http_ver, keep_alive, Http::LAST_MODIFIED, last_modified, Http::Message::persistent(), Http::scPartialContent, sline, Http::StatusLine::status(), surrogate_control, and Http::StatusLine::version.

Referenced by clone(), Ftp::HttpReplyWrapper(), init(), and recreateOnNotModified().

◆ hdrExpirationTime()

time_t HttpReply::hdrExpirationTime ( )

private

Definition at line 283 of file HttpReply.cc.

References Http::Message::cache_control, Config, Http::DATE, date, Http::EXPIRES, HttpHeader::getTime(), HttpHeader::has(), HttpHdrCc::hasMaxAge(), HttpHdrCc::hasSMaxAge(), Http::Message::header, SquidConfig::onoff, squid_curtime, Http::VARY, and SquidConfig::vary_ignore_expire.

Referenced by hdrCacheInit().

◆ httpMsgParseError()

int HttpReply::httpMsgParseError ( )

overridevirtual

Reimplemented from Http::Message.

Definition at line 515 of file HttpReply.cc.

References Http::Message::httpMsgParseError(), Http::ProtocolVersion(), Http::scInvalidHeader, Http::StatusLine::set(), and sline.

◆ httpMsgParseStep()

int Http::Message::httpMsgParseStep	(	const char *	buf,
		int	len,
		int	atEnd
	)

inherited

parses a 0-terminated buffer into Http::Message.

Return values

1	success
0	need more data (partial parse)
-1	parse error

Definition at line 151 of file Message.cc.

References assert, httpMsgIsolateStart(), Http::Message::psParsed, Http::Message::psReadyToParseHeaders, and Http::Message::psReadyToParseStartLine.

◆ inheritProperties()

bool HttpReply::inheritProperties ( const Http::Message * aMsg )

overridevirtual

Implements Http::Message.

Definition at line 627 of file HttpReply.cc.

References keep_alive, and Http::Message::sources.

◆ init()

void HttpReply::init ( )

private

initialize

Definition at line 51 of file HttpReply.cc.

References do_clean, hdrCacheInit(), Http::StatusLine::init(), Http::Message::psReadyToParseStartLine, Http::Message::pstate, and sline.

Referenced by HttpReply(), and reset().

◆ make304()

HttpReplyPointer HttpReply::make304 ( ) const

construct a 304 reply and return it

Definition at line 129 of file HttpReply.cc.

References HttpHeader::addEntry(), Http::Message::cache_control, HttpHeaderEntry::clone(), Http::CONTENT_TYPE, content_type, Http::DATE, date, Http::EXPIRES, expires, HttpHeader::findEntry(), Http::Message::header, Http::LAST_MODIFIED, last_modified, Http::OTHER, Http::ProtocolVersion(), Http::Message::putCc(), Http::scNotModified, Http::StatusLine::set(), and sline.

Referenced by packed304Reply(), and clientReplyContext::sendNotModified().

◆ MakeConnectionEstablished()

HttpReplyPointer HttpReply::MakeConnectionEstablished ( )

static

Definition at line 121 of file HttpReply.cc.

References Http::ProtocolVersion(), Http::scOkay, Http::StatusLine::set(), and sline.

Referenced by TunnelStateData::notePeerReadyToShovel(), and ClientHttpRequest::sslBumpStart().

◆ MEMPROXY_CLASS()

HttpReply::MEMPROXY_CLASS ( HttpReply )

private

◆ olderThan()

bool HttpReply::olderThan ( const HttpReply * them ) const

whether our Date header value is smaller than theirs

Returns: false if any information is missing

Definition at line 638 of file HttpReply.cc.

References date.

Referenced by HttpStateData::haveParsedReplyHeaders().

◆ pack()

MemBuf * HttpReply::pack ( ) const

Returns: a ready to use mem buffer with a packed reply

Definition at line 112 of file HttpReply.cc.

References MemBuf::init(), and packInto().

Referenced by errorSend(), TunnelStateData::notePeerReadyToShovel(), Http::Stream::sendStartOfMessage(), ClientHttpRequest::sslBumpStart(), and Http::One::Server::writeControlMsgAndCall().

◆ packed304Reply()

MemBuf * HttpReply::packed304Reply ( ) const

private

Returns: construct 304 reply and pack it into a MemBuf

Definition at line 159 of file HttpReply.cc.

References make304().

◆ packFirstLineInto()

void HttpReply::packFirstLineInto	(	Packable *	p,
		bool
	)		const

inlineoverrideprotectedvirtual

Implements Http::Message.

Definition at line 166 of file HttpReply.h.

References Http::StatusLine::packInto(), and sline.

◆ packHeadersUsingFastPacker()

void HttpReply::packHeadersUsingFastPacker ( Packable & p ) const

adds status line and header to the given Packable assumes that p can quickly process small additions

Definition at line 87 of file HttpReply.cc.

References Packable::append(), Http::Message::header, Http::StatusLine::packInto(), HttpHeader::packInto(), and sline.

Referenced by packHeadersUsingSlowPacker(), packInto(), and AccessLogEntry::packReplyHeaders().

◆ packHeadersUsingSlowPacker()

void HttpReply::packHeadersUsingSlowPacker ( Packable & p ) const

Definition at line 95 of file HttpReply.cc.

References Packable::append(), MemBuf::content(), MemBuf::contentSize(), MemBuf::init(), and packHeadersUsingFastPacker().

Referenced by TestRock::addEntry(), TestUfs::testUfsSearch(), and MemStore::updateHeadersOrThrow().

◆ packInto() [1/2]

void HttpReply::packInto ( MemBuf & buf ) const

private

Definition at line 104 of file HttpReply.cc.

References body, packHeadersUsingFastPacker(), and HttpBody::packInto().

Referenced by pack().

◆ packInto() [2/2]

void Http::Message::packInto	(	Packable *	p,
		bool	full_uri
	)		const

inherited

Definition at line 253 of file Message.cc.

References Packable::append().

◆ parse()

bool Http::Message::parse	(	const char *	buf,
		const size_t	sz,
		bool	eol,
		Http::StatusCode *	error
	)

inherited

Definition at line 68 of file Message.cc.

References assert, Config, DBG_IMPORTANT, debugs, error(), headersEnd(), int, SquidConfig::maxReplyHeaderSize, Http::scHeaderTooLarge, Http::scInvalidHeader, and Http::scNone.

Referenced by Adaptation::Icap::Xaction::parseHttpMsg(), and parseTerminatedPrefix().

◆ parseCharBuf()

bool Http::Message::parseCharBuf	(	const char *	buf,
		ssize_t	end
	)

inherited

parseCharBuf() takes character buffer of HTTP headers (buf), which may not be NULL-terminated, and fills in an Http::Message structure. The parameter 'end' specifies the offset to the end of the reply headers. The caller may know where the end is, but is unable to NULL-terminate the buffer. This function returns true on success.

Definition at line 129 of file Message.cc.

References MemBuf::append(), MemBuf::buf, MemBuf::clean(), MemBuf::init(), MemBuf::size, and MemBuf::terminate().

◆ parseFirstLine()

bool HttpReply::parseFirstLine	(	const char *	start,
		const char *	end
	)

overrideprotectedvirtual

Implements Http::Message.

Definition at line 457 of file HttpReply.cc.

References Http::StatusLine::parse(), protoPrefix, and sline.

◆ parseHeader() [1/2]

bool Http::Message::parseHeader	(	Http1::Parser &	hp,
		Http::ContentLengthInterpreter &	clen
	)

protectedinherited

Definition at line 201 of file Message.cc.

References SBuf::c_str(), Http::One::Parser::headerBlockSize(), Http::One::Parser::messageHeaderSize(), Http::One::Parser::mimeHeader(), Http::Message::psError, and Http::Message::psParsed.

◆ parseHeader() [2/2]

bool HttpReply::parseHeader ( Http1::Parser & hp )

Definition at line 507 of file HttpReply.cc.

Referenced by Http::Tunneler::handleResponse().

◆ parseTerminatedPrefix()

size_t HttpReply::parseTerminatedPrefix	(	const char *	terminatedBuf,
		size_t	bufSize
	)

Parses response status line and headers at the start of the given NUL-terminated buffer of the given size. Respects reply_header_max_size. Assures pstate becomes Http::Message::psParsed on (and only on) success.