-
/*
- * $Id$
- *
- *
- * 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.
+ * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
*
+ * 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_HTTP_H
#define SQUID_HTTP_H
-#include "StoreIOBuffer.h"
+#include "clients/Client.h"
#include "comm.h"
-#include "comm/forward.h"
-#include "forward.h"
-#include "Server.h"
-#include "ChunkedCodingParser.h"
+#include "http/forward.h"
+#include "http/StateFlags.h"
+#include "sbuf/SBuf.h"
+
+class FwdState;
+class HttpHeader;
-class HttpStateData : public ServerStateData
+class HttpStateData : public Client
{
+ CBDATA_CLASS(HttpStateData);
public:
+
+ /// assists in making and relaying entry caching/sharing decision
+ class ReuseDecision
+ {
+ public:
+ enum Answers { reuseNot = 0, cachePositively, cacheNegatively, doNotCacheButShare };
+
+ ReuseDecision(const StoreEntry *e, const Http::StatusCode code);
+ /// stores the corresponding decision
+ Answers make(const Answers ans, const char *why);
+
+ Answers answer; ///< the decision id
+ const char *reason; ///< the decision reason
+ const StoreEntry *entry; ///< entry for debugging
+ const Http::StatusCode statusCode; ///< HTTP status for debugging
+ };
+
HttpStateData(FwdState *);
~HttpStateData();
StoreEntry * entry,
const AccessLogEntryPointer &al,
HttpHeader * hdr_out,
- const http_state_flags flags);
+ const Http::StateFlags &flags);
virtual const Comm::ConnectionPointer & dataConnection() const;
/* should be private */
void processReplyBody();
void readReply(const CommIoCbParams &io);
virtual void maybeReadVirginBody(); // read response data from the network
- int cacheableReply();
- peer *_peer; /* peer request made to */
- int eof; /* reached end-of-object? */
- int lastChunk; /* reached last chunk of a chunk-encoded reply */
- http_state_flags flags;
+ // Checks whether the response is cacheable/shareable.
+ ReuseDecision::Answers reusableReply(ReuseDecision &decision);
+
+ CachePeer *_peer; /* CachePeer request made to */
+ int eof; /* reached end-of-object? */
+ int lastChunk; /* reached last chunk of a chunk-encoded reply */
+ Http::StateFlags flags;
size_t read_sz;
- int header_bytes_read; // to find end of response,
- int64_t reply_bytes_read; // without relying on StoreEntry
- int body_bytes_truncated; // positive when we read more than we wanted
- MemBuf *readBuf;
+ SBuf inBuf; ///< I/O buffer for receiving server responses
bool ignoreCacheControl;
bool surrogateNoStore;
virtual bool getMoreRequestBody(MemBuf &buf);
virtual void closeServer(); // end communication with the server
virtual bool doneWithServer() const; // did we end communication?
- virtual void abortTransaction(const char *reason); // abnormal termination
+ virtual void abortAll(const char *reason); // abnormal termination
+ virtual bool mayReadVirginReplyBody() const;
+
+ void abortTransaction(const char *reason) { abortAll(reason); } // abnormal termination
+
+ /**
+ * determine if read buffer can have space made available
+ * for a read.
+ *
+ * \param grow whether to actually expand the buffer
+ *
+ * \return whether the buffer can be grown to provide space
+ * regardless of whether the grow actually happened.
+ */
+ bool maybeMakeSpaceAvailable(bool grow);
// consuming request body
virtual void handleMoreRequestBodyAvailable();
static bool decideIfWeDoRanges (HttpRequest * orig_request);
bool peerSupportsConnectionPinning() const;
- ChunkedCodingParser *httpChunkDecoder;
-private:
- CBDATA_CLASS2(HttpStateData);
+ /// Parser being used at present to parse the HTTP/ICY server response.
+ Http1::ResponseParserPointer hp;
+ Http1::TeChunkedParser *httpChunkDecoder;
+
+ /// amount of message payload/body received so far.
+ int64_t payloadSeen;
+ /// positive when we read more than we wanted
+ int64_t payloadTruncated;
+
+ /// Whether we received a Date header older than that of a matching
+ /// cached response.
+ bool sawDateGoBack;
};
-extern int httpCachable(const HttpRequestMethod&);
-extern void httpStart(FwdState *);
-extern const char *httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
+std::ostream &operator <<(std::ostream &os, const HttpStateData::ReuseDecision &d);
+
+int httpCachable(const HttpRequestMethod&);
+void httpStart(FwdState *);
+SBuf httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
#endif /* SQUID_HTTP_H */
+
projects / thirdparty / squid.git / blobdiff