/*
+ * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
*
- * 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.
- *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
*/
+
#ifndef SQUID_HTTPREPLY_H
#define SQUID_HTTPREPLY_H
+#include "http/StatusLine.h"
#include "HttpBody.h"
-#include "HttpMsg.h"
#include "HttpRequest.h"
-#include "HttpStatusLine.h"
void httpReplyInitModule(void);
-#if DEAD_CODE
-/** do everything in one call: init, set, pack, clean, return MemBuf */
-MemBuf *httpPackedReply(HttpVersion ver, http_status status, const char *ctype, int64_t clen, time_t lmt, time_t expires);
-#endif
-
/* Sync changes here with HttpReply.cc */
class HttpHdrContRange;
class HttpHdrSc;
-class HttpReply: public HttpMsg
+class HttpReply: public Http::Message
{
+ MEMPROXY_CLASS(HttpReply);
public:
- typedef HttpMsgPointerT<HttpReply> Pointer;
+ typedef RefCount<HttpReply> Pointer;
- MEMPROXY_CLASS(HttpReply);
HttpReply();
~HttpReply();
virtual void reset();
- /// \par use HTTPMSGLOCK() instead of calling this directly
- virtual HttpReply *_lock() {
- return static_cast<HttpReply*>(HttpMsg::_lock());
- };
-
- //virtual void unlock(); // only needed for debugging
-
/**
\retval true on success
\retval false and sets *error to zero when needs more data
- \retval false and sets *error to a positive http_status code on error
+ \retval false and sets *error to a positive Http::StatusCode on error
*/
- virtual bool sanityCheckStartLine(MemBuf *buf, const size_t hdr_len, http_status *error);
+ virtual bool sanityCheckStartLine(const char *buf, const size_t hdr_len, Http::StatusCode *error);
/** \par public, readable; never update these or their .hdr equivalents directly */
time_t date;
HttpHdrSc *surrogate_control;
- HttpHdrContRange *content_range;
+ /// \returns parsed Content-Range for a 206 response and nil for others
+ const HttpHdrContRange *contentRange() const;
short int keep_alive;
/** \par public, writable, but use httpReply* interfaces when possible */
- HttpStatusLine sline;
+ Http::StatusLine sline;
- HttpBody body; /**< for small constant memory-resident text bodies only */
+ HttpBody body; /**< for small constant memory-resident text bodies only */
String protoPrefix; /**< e.g., "HTTP/" */
virtual bool expectingBody(const HttpRequestMethod&, int64_t&) const;
- virtual bool inheritProperties(const HttpMsg *aMsg);
+ virtual bool inheritProperties(const Http::Message *);
- void updateOnNotModified(HttpReply const *other);
+ /// \returns nil (if no updates are necessary)
+ /// \returns a new reply combining this reply with 304 updates (otherwise)
+ Pointer recreateOnNotModified(const HttpReply &reply304) const;
/** set commonly used info with one call */
- void setHeaders(http_status status,
+ void setHeaders(Http::StatusCode status,
const char *reason, const char *ctype, int64_t clen, time_t lmt, time_t expires);
/** \return a ready to use mem buffer with a packed reply */
- MemBuf *pack();
+ MemBuf *pack() const;
+
+ /// construct and return an HTTP/200 (Connection Established) response
+ static HttpReplyPointer MakeConnectionEstablished();
/** construct a 304 reply and return it */
- HttpReply *make304() const;
+ HttpReplyPointer make304() const;
- void redirect(http_status, const char *);
+ void redirect(Http::StatusCode, const char *);
int64_t bodySize(const HttpRequestMethod&) const;
int validatorsMatch (HttpReply const *other) const;
- void packHeadersInto(Packer * p) const;
+ /// adds status line and header to the given Packable
+ /// assumes that `p` can quickly process small additions
+ void packHeadersUsingFastPacker(Packable &p) const;
+ /// same as packHeadersUsingFastPacker() but assumes that `p` cannot quickly process small additions
+ void packHeadersUsingSlowPacker(Packable &p) const;
/** Clone this reply.
- * Could be done as a copy-contructor but we do not want to accidently copy a HttpReply..
+ * Could be done as a copy-contructor but we do not want to accidentally copy a HttpReply..
*/
HttpReply *clone() const;
/// Remove Warnings with warn-date different from Date value
void removeStaleWarnings();
+ virtual void hdrCacheInit();
+
+ /// whether our Date header value is smaller than theirs
+ /// \returns false if any information is missing
+ bool olderThan(const HttpReply *them) const;
+
+ /// Some response status codes prohibit sending Content-Length (RFC 7230 section 3.3.2).
+ void removeIrrelevantContentLength();
+
+ virtual void configureContentLengthInterpreter(Http::ContentLengthInterpreter &);
+ /// parses reply header using Parser
+ bool parseHeader(Http1::Parser &hp);
+
private:
/** initialize */
void init();
void hdrCacheClean();
- void packInto(Packer * p);
+ void packInto(MemBuf &) const;
/* ez-routines */
/** \return construct 304 reply and pack it into a MemBuf */
- MemBuf *packed304Reply();
+ MemBuf *packed304Reply() const;
/* header manipulation */
time_t hdrExpirationTime();
/** Calculates and stores maximum body size if needed.
* Used by receivedBodyTooLarge() and expectedBodyTooLarge().
*/
- void calcMaxBodySize(HttpRequest& request);
+ void calcMaxBodySize(HttpRequest& request) const;
String removeStaleWarningValues(const String &value);
mutable int64_t bodySizeMax; /**< cached result of calcMaxBodySize */
+ HttpHdrContRange *content_range; ///< parsed Content-Range; nil for non-206 responses!
+
protected:
- virtual void packFirstLineInto(Packer * p, bool) const;
+ virtual void packFirstLineInto(Packable * p, bool) const { sline.packInto(p); }
virtual bool parseFirstLine(const char *start, const char *end);
-
- virtual void hdrCacheInit();
};
-MEMPROXY_CLASS_INLINE(HttpReply);
-
#endif /* SQUID_HTTPREPLY_H */
+
projects / thirdparty / squid.git / blobdiff