client_side_reply.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_SRC_CLIENT_SIDE_REPLY_H
#define SQUID_SRC_CLIENT_SIDE_REPLY_H
 
#include "acl/forward.h"
#include "client_side_request.h"
#include "ip/forward.h"
#include "RequestFlags.h"
#include "StoreClient.h"
 
class ErrorState;
 
/* XXX make static method */
 
class clientReplyContext : public RefCountable, public StoreClient
{
    CBDATA_CLASS(clientReplyContext);
 
public:
    static STCB CacheHit;
    static STCB HandleIMSReply;
    static STCB SendMoreData;
 
    clientReplyContext(ClientHttpRequest *);
    ~clientReplyContext() override;
 
    void saveState();
    void restoreState();
    void purgeRequest ();
    void doGetMoreData();
    void identifyStoreObject();
    void identifyFoundObject(StoreEntry *entry, const char *detail);
    int storeOKTransferDone() const;
    int storeNotOKTransferDone() const;
    void setReplyToStoreEntry(StoreEntry *e, const char *reason);
    void setReplyToError(err_type, Http::StatusCode, char const *, const ConnStateData *, HttpRequest *, const char *,
#if USE_AUTH
                         Auth::UserRequest::Pointer);
#else
                         void * unused);
#endif
    void setReplyToError(const HttpRequestMethod& method, ErrorState *err);
    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);
    void processExpired();
    clientStream_status_t replyStatus();
    void processMiss();
    void traceReply();
    const char *storeId() const { return (http->store_id.size() > 0 ? http->store_id.termedBuf() : http->uri); }
 
    Http::StatusCode purgeStatus;
 
    /* StoreClient API */
    LogTags *loggingTags() const override;
 
    ClientHttpRequest *http;
    store_client *sc;       /* The store_client we're using */
 
    char tempbuf[HTTP_REQBUF_SZ];
 
    struct Flags {
        Flags() : storelogiccomplete(0), complete(0), headersSent(false) {}
 
        unsigned storelogiccomplete:1;
        unsigned complete:1;        
        bool headersSent;
    } flags;
    clientStreamNode *ourNode;  /* This will go away if/when this file gets refactored some more */
 
private:
    /* StoreClient API */
    void fillChecklist(ACLFilledChecklist &) const override;
 
    clientStreamNode *getNextNode() const;
    void makeThisHead();
    bool errorInStream(const StoreIOBuffer &result) const;
    bool matchesStreamBodyBuffer(const StoreIOBuffer &) const;
    void sendStreamError(StoreIOBuffer const &result);
    void pushStreamData(const StoreIOBuffer &);
    clientStreamNode * next() const;
    HttpReply *reply;
    void processReplyAccess();
    static ACLCB ProcessReplyAccessResult;
    void processReplyAccessResult(const Acl::Answer &accessAllowed);
    void cloneReply();
    void buildReplyHeader ();
    bool alwaysAllowResponse(Http::StatusCode sline) const;
    int checkTransferDone();
    void processOnlyIfCachedMiss();
    bool processConditional();
    void noteStreamBufferredBytes(const StoreIOBuffer &);
    void cacheHit(StoreIOBuffer result);
    void handleIMSReply(StoreIOBuffer result);
    void sendMoreData(StoreIOBuffer result);
    void triggerInitialStoreRead(STCB = SendMoreData);
    void requestMoreBodyFromStore();
    void sendClientOldEntry();
    void purgeAllCached();
    bool purgeEntry(StoreEntry &, const Http::MethodType, const char *descriptionPrefix = "");
    void purgeDoPurge();
    void forgetHit();
    bool blockedHit() const;
    const char *storeLookupString(bool found) const { return found ? "match" : "mismatch"; }
    void detailStoreLookup(const char *detail);
 
    void sendBodyTooLargeError();
    void sendPreconditionFailedError();
    void sendNotModified();
    void sendNotModifiedOrPreconditionFailedError();
    void sendClientUpstreamResponse(const StoreIOBuffer &upstreamResponse);
 
    static decltype(::storeClientCopy) storeClientCopy [[deprecated]];
 
    const char *firstStoreLookup_ = nullptr;
 
    /* (stale) cache hit information preserved during IMS revalidation */
    StoreEntry *old_entry;
    store_client *old_sc;
    time_t old_lastmod;
    String old_etag;
 
    bool deleting;
 
    typedef enum {
        crNone = 0, 
        crInitiator, 
        crSlave 
    } CollapsedRevalidation;
 
    CollapsedRevalidation collapsedRevalidation;
 
    StoreIOBuffer lastStreamBufferedBytes;
 
    // TODO: Remove after moving the meat of this function into a method.
    friend CSR clientGetMoreData;
};
 
// TODO: move to SideAgent parent, when we have one
void purgeEntriesByUrl(HttpRequest *, const char *);
 
#endif /* SQUID_SRC_CLIENT_SIDE_REPLY_H */