/*
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
+ * Copyright (C) 1996-2020 The Squid Software Foundation and contributors
*
- * 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) 2003, Robert Collins <robertc@squid-cache.org>
+ * 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_CLIENTSIDEREPLY_H
#define SQUID_CLIENTSIDEREPLY_H
-#include "RefCount.h"
-#include "HttpHeader.h"
-#include "clientStream.h"
-#include "StoreClient.h"
+#include "acl/forward.h"
#include "client_side_request.h"
+#include "ip/forward.h"
+#include "RequestFlags.h"
+#include "StoreClient.h"
class ErrorState;
-#include "ip/forward.h"
/* XXX make static method */
class clientReplyContext : public RefCountable, public StoreClient
{
+ CBDATA_CLASS(clientReplyContext);
public:
- void *operator new (size_t byteCount);
- void operator delete (void *address);
static STCB CacheHit;
static STCB HandleIMSReply;
static STCB SendMoreData;
void identifyFoundObject(StoreEntry *entry);
int storeOKTransferDone() const;
int storeNotOKTransferDone() const;
- /// Replaces the store entry with the given and awaiting the client side to read it
- void setReplyToStoreEntry(StoreEntry *entry);
- void setReplyToError(err_type, http_status, const HttpRequestMethod&, char const *, Ip::Address &, HttpRequest *, const char *,
+ /// replaces current response store entry with the given one
+ void setReplyToStoreEntry(StoreEntry *e, const char *reason);
+ /// builds error using clientBuildError() and calls setReplyToError() below
+ void setReplyToError(err_type, Http::StatusCode, const HttpRequestMethod&, char const *, Ip::Address &, HttpRequest *, const char *,
#if USE_AUTH
Auth::UserRequest::Pointer);
#else
void * unused);
#endif
- void setReplyToError(const HttpRequestMethod& method, ErrorState *errstate);
- void createStoreEntry(const HttpRequestMethod& m, request_flags flags);
+ /// creates a store entry for the reply and appends err to it
+ void setReplyToError(const HttpRequestMethod& method, ErrorState *err);
+ /// creates a store entry for the reply and appends error reply to it
+ void setReplyToReply(HttpReply *reply);
+ void createStoreEntry(const HttpRequestMethod& m, RequestFlags flags);
void removeStoreReference(store_client ** scp, StoreEntry ** ep);
void removeClientStoreReference(store_client **scp, ClientHttpRequest *http);
void startError(ErrorState * err);
clientStream_status_t replyStatus();
void processMiss();
void traceReply(clientStreamNode * node);
+ const char *storeId() const { return (http->store_id.size() > 0 ? http->store_id.termedBuf() : http->uri); }
- http_status purgeStatus;
+ Http::StatusCode purgeStatus;
/* state variable - replace with class to handle storeentries at some point */
int lookingforstore;
+
+ /* StoreClient API */
virtual void created (StoreEntry *newEntry);
+ virtual LogTags *loggingTags();
ClientHttpRequest *http;
+ /// Base reply header bytes received from Store.
+ /// Compatible with ClientHttpRequest::Out::offset.
+ /// Not to be confused with ClientHttpRequest::Out::headers_sz.
int headers_sz;
- store_client *sc; /* The store_client we're using */
- StoreIOBuffer tempBuffer; /* For use in validating requests via IMS */
- int old_reqsize; /* ... again, for the buffer */
+ store_client *sc; /* The store_client we're using */
+ StoreIOBuffer tempBuffer; /* For use in validating requests via IMS */
+ int old_reqsize; /* ... again, for the buffer */
size_t reqsize;
size_t reqofs;
- char tempbuf[HTTP_REQBUF_SZ]; /* a temporary buffer if we need working storage */
+ char tempbuf[HTTP_REQBUF_SZ]; ///< a temporary buffer if we need working storage
#if USE_CACHE_DIGESTS
- const char *lookup_type; /* temporary hack: storeGet() result: HIT/MISS/NONE */
+ const char *lookup_type; /* temporary hack: storeGet() result: HIT/MISS/NONE */
#endif
- struct {
+ struct Flags {
+ Flags() : storelogiccomplete(0), complete(0), headersSent(false) {}
unsigned storelogiccomplete:1;
-
- unsigned complete:1; /* we have read all we can from upstream */
+ unsigned complete:1; ///< we have read all we can from upstream
bool headersSent;
} flags;
- clientStreamNode *ourNode; /* This will go away if/when this file gets refactored some more */
+ clientStreamNode *ourNode; /* This will go away if/when this file gets refactored some more */
private:
- CBDATA_CLASS(clientReplyContext);
+ /* StoreClient API */
+ virtual void fillChecklist(ACLFilledChecklist &) const;
+
clientStreamNode *getNextNode() const;
void makeThisHead();
bool errorInStream(StoreIOBuffer const &result, size_t const &sizeToProcess)const ;
HttpReply *reply;
void processReplyAccess();
static ACLCB ProcessReplyAccessResult;
- void processReplyAccessResult(const allow_t &accessAllowed);
+ void processReplyAccessResult(const Acl::Answer &accessAllowed);
void cloneReply();
void buildReplyHeader ();
- bool alwaysAllowResponse(http_status sline) const;
+ bool alwaysAllowResponse(Http::StatusCode sline) const;
int checkTransferDone();
void processOnlyIfCachedMiss();
- void processConditional(StoreIOBuffer &result);
+ bool processConditional(StoreIOBuffer &result);
void cacheHit(StoreIOBuffer result);
void handleIMSReply(StoreIOBuffer result);
void sendMoreData(StoreIOBuffer result);
void triggerInitialStoreRead();
void sendClientOldEntry();
void purgeAllCached();
+ void forgetHit();
+ bool blockedHit() const;
void sendBodyTooLargeError();
void sendPreconditionFailedError();
void sendNotModifiedOrPreconditionFailedError();
StoreEntry *old_entry;
- store_client *old_sc; /* ... for entry to be validated */
+ /* ... for entry to be validated */
+ store_client *old_sc;
+ time_t old_lastmod;
+ String old_etag;
+
bool deleting;
+
+ typedef enum {
+ crNone = 0, ///< collapsed revalidation is not allowed for this context
+ crInitiator, ///< we initiated collapsed revalidation request
+ crSlave ///< we collapsed on the existing revalidation request
+ } CollapsedRevalidation;
+
+ CollapsedRevalidation collapsedRevalidation;
};
#endif /* SQUID_CLIENTSIDEREPLY_H */
+
projects / thirdparty / squid.git / blobdiff