client_side_request.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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_CLIENTSIDEREQUEST_H
#define SQUID_CLIENTSIDEREQUEST_H
 
#include "AccessLogEntry.h"
#include "client_side.h"
#include "clientStream.h"
#include "http/forward.h"
#include "HttpHeaderRange.h"
#include "log/forward.h"
#include "LogTags.h"
#include "Store.h"
 
#if USE_ADAPTATION
#include "adaptation/forward.h"
#include "adaptation/Initiator.h"
#endif
 
class ClientRequestContext;
class ConnStateData;
class MemObject;
 
/* client_side_request.c - client side request related routines (pure logic) */
int clientBeginRequest(const HttpRequestMethod&, char const *, CSCB *, CSD *, ClientStreamData, HttpHeader const *, char *, size_t, const MasterXactionPointer &);
 
class ClientHttpRequest
#if USE_ADAPTATION
    : public Adaptation::Initiator, // to start adaptation transactions
      public BodyConsumer     // to receive reply bodies in request satisf. mode
#endif
{
#if USE_ADAPTATION
    CBDATA_CHILD(ClientHttpRequest);
#else
    CBDATA_CLASS(ClientHttpRequest);
#endif
 
public:
    ClientHttpRequest(ConnStateData *);
    ClientHttpRequest(ClientHttpRequest &&) = delete;
#if USE_ADAPTATION
    ~ClientHttpRequest() override;
#else
    ~ClientHttpRequest();
#endif
 
    String rangeBoundaryStr() const;
    void freeResources();
    void updateCounters();
    void logRequest();
    MemObject * memObject() const {
        return (storeEntry() ? storeEntry()->mem_obj : nullptr);
    }
    bool multipartRangeRequest() const;
    void processRequest();
    void httpStart();
    bool onlyIfCached()const;
    bool gotEnough() const;
    StoreEntry *storeEntry() const { return entry_; }
    void storeEntry(StoreEntry *);
    StoreEntry *loggingEntry() const { return loggingEntry_; }
    void loggingEntry(StoreEntry *);
 
    ConnStateData *getConn() const {
        return (cbdataReferenceValid(conn_) ? conn_ : nullptr);
    }
 
    void initRequest(HttpRequest *);
 
    void resetRequest(HttpRequest *);
 
    void updateLoggingTags(const LogTags_ot code) { al->cache.code.update(code); }
 
    const LogTags &loggingTags() const { return al->cache.code; }
 
    int64_t mRangeCLen() const;
 
    void doCallouts();
 
    // The three methods below prepare log_uri and friends for future logging.
    // Call the best-fit method whenever the current request or its URI changes.
 
    void setLogUriToRequestUri();
 
    void setLogUriToRawUri(const char *, const HttpRequestMethod &);
 
    void setErrorUri(const char *);
 
    int64_t prepPartialResponseGeneration();
 
    void calloutsError(const err_type, const ErrorDetail::Pointer &);
 
    void updateError(const Error &);
 
public:
    HttpRequest * const request = nullptr;
 
    char *uri = nullptr;
 
    // TODO: remove this field and store the URI directly in al->url
    char * const log_uri = nullptr;
 
    String store_id; /* StoreID for transactions where the request member is nil */
 
    struct Out {
        int64_t offset = 0;
        uint64_t size = 0;
        size_t headers_sz = 0;
    } out;
 
    HttpHdrRangeIter range_iter;    /* data for iterating thru range specs */
    size_t req_sz = 0; 
 
    const AccessLogEntry::Pointer al; 
 
    struct Flags {
        bool accel = false;
        bool done_copying = false;
    } flags;
 
    struct Redirect {
        Http::StatusCode status = Http::scNone;
        char *location = nullptr;
    } redirect;
 
    dlink_node active;
    dlink_list client_stream;
 
    ClientRequestContext *calloutContext = nullptr;
 
private:
    void absorbLogUri(char *);
    void clearRequest();
    void assignRequest(HttpRequest *);
 
    int64_t maxReplyBodySize_ = 0;
    StoreEntry *entry_ = nullptr;
    StoreEntry *loggingEntry_ = nullptr;
    ConnStateData * conn_ = nullptr;
 
#if USE_OPENSSL
public:
    Ssl::BumpMode sslBumpNeed() const { return sslBumpNeed_; }
    bool sslBumpNeeded() const { return sslBumpNeed_ == Ssl::bumpServerFirst || sslBumpNeed_ == Ssl::bumpClientFirst || sslBumpNeed_ == Ssl::bumpBump || sslBumpNeed_ == Ssl::bumpPeek || sslBumpNeed_ == Ssl::bumpStare; }
    void sslBumpNeed(Ssl::BumpMode);
    void sslBumpStart();
    void sslBumpEstablish(Comm::Flag);
 
private:
    Ssl::BumpMode sslBumpNeed_ = Ssl::bumpEnd;
#endif
 
#if USE_ADAPTATION
public:
    void startAdaptation(const Adaptation::ServiceGroupPointer &);
    bool requestSatisfactionMode() const { return request_satisfaction_mode; }
 
    /* AsyncJob API */
    bool doneAll() const override {
        return Initiator::doneAll() &&
               BodyConsumer::doneAll() &&
               false; // TODO: Refactor into a proper AsyncJob
    }
    void callException(const std::exception &) override;
 
private:
    void handleAdaptationFailure(const ErrorDetail::Pointer &, bool bypassable = false);
 
    void handleAdaptedHeader(Http::Message *);
    void handleAdaptationBlock(const Adaptation::Answer &);
 
    /* Adaptation::Initiator API */
    void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer) override;
    void noteAdaptationAnswer(const Adaptation::Answer &) override;
 
    /* BodyConsumer API */
    void noteMoreBodyDataAvailable(BodyPipe::Pointer) override;
    void noteBodyProductionEnded(BodyPipe::Pointer) override;
    void noteBodyProducerAborted(BodyPipe::Pointer) override;
 
    void endRequestSatisfaction();
    void resumeBodyStorage();
 
private:
    CbcPointer<Adaptation::Initiate> virginHeadSource;
    BodyPipe::Pointer adaptedBodySource;
 
    bool receivedWholeAdaptedReply = false;
 
    bool request_satisfaction_mode = false;
    int64_t request_satisfaction_offset = 0;
#endif
};
 
/* client http based routines */
char *clientConstructTraceEcho(ClientHttpRequest *);
 
ACLFilledChecklist *clientAclChecklistCreate(const acl_access *, ClientHttpRequest *);
void clientAclChecklistFill(ACLFilledChecklist &, ClientHttpRequest *);
void clientAccessCheck(ClientHttpRequest *);
 
/* ones that should be elsewhere */
void tunnelStart(ClientHttpRequest *);
 
#endif /* SQUID_CLIENTSIDEREQUEST_H */