client_side_request.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2021 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
{
    CBDATA_CLASS(ClientHttpRequest);
 
public:
    ClientHttpRequest(ConnStateData *csd);
    ~ClientHttpRequest();
    /* Not implemented - present to prevent synthetic operations */
    ClientHttpRequest(ClientHttpRequest const &);
    ClientHttpRequest& operator=(ClientHttpRequest const &);
 
    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; }
 
    Comm::ConnectionPointer clientConnection;
 
    HttpRequest * const request;
 
    char *uri;
 
    // TODO: remove this field and store the URI directly in al->url
    char * const log_uri;
 
    String store_id; /* StoreID for transactions where the request member is nil */
 
    struct Out {
        Out() : offset(0), size(0), headers_sz(0) {}
 
        int64_t offset;
        uint64_t size;
        size_t headers_sz;
    } out;
 
    HttpHdrRangeIter range_iter;    /* data for iterating thru range specs */
    size_t req_sz;      /* raw request size on input, not current request size */
 
    const AccessLogEntry::Pointer al; 
 
    struct Flags {
        Flags() : accel(false), internal(false), done_copying(false) {}
 
        bool accel;
        bool internal;
        bool done_copying;
    } flags;
 
    struct Redirect {
        Redirect() : status(Http::scNone), location(NULL) {}
 
        Http::StatusCode status;
        char *location;
    } redirect;
 
    dlink_node active;
    dlink_list client_stream;
    int64_t mRangeCLen() const;
 
    ClientRequestContext *calloutContext;
    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 *rawUri, const HttpRequestMethod &);
    void setErrorUri(const char *errorUri);
 
    int64_t prepPartialResponseGeneration();
 
    void calloutsError(const err_type error, const ErrorDetail::Pointer &errDetail);
 
    void updateError(const Error &error);
 
#if USE_ADAPTATION
    // AsyncJob virtual methods
    virtual bool doneAll() const {
        return Initiator::doneAll() &&
               BodyConsumer::doneAll() && false;
    }
    virtual void callException(const std::exception &ex);
#endif
 
private:
    void absorbLogUri(char *aUri);
    void clearRequest();
    void assignRequest(HttpRequest *aRequest);
 
    int64_t maxReplyBodySize_;
    StoreEntry *entry_;
    StoreEntry *loggingEntry_;
    ConnStateData * conn_;
 
#if USE_OPENSSL
    Ssl::BumpMode sslBumpNeed_;
 
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 mode);
    void sslBumpStart();
    void sslBumpEstablish(Comm::Flag errflag);
#endif
 
#if USE_ADAPTATION
 
public:
    void startAdaptation(const Adaptation::ServiceGroupPointer &g);
    bool requestSatisfactionMode() const { return request_satisfaction_mode; }
 
private:
    void handleAdaptationFailure(const ErrorDetail::Pointer &errDetail, bool bypassable = false);
 
    // Adaptation::Initiator API
    virtual void noteAdaptationAnswer(const Adaptation::Answer &answer);
    void handleAdaptedHeader(Http::Message *msg);
    void handleAdaptationBlock(const Adaptation::Answer &answer);
    virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group);
 
    // BodyConsumer API, called by BodyPipe
    virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer);
    virtual void noteBodyProductionEnded(BodyPipe::Pointer);
    virtual void noteBodyProducerAborted(BodyPipe::Pointer);
 
    void endRequestSatisfaction();
    void resumeBodyStorage();
 
private:
    CbcPointer<Adaptation::Initiate> virginHeadSource;
    BodyPipe::Pointer adaptedBodySource;
 
    bool receivedWholeAdaptedReply;
 
    bool request_satisfaction_mode;
    int64_t request_satisfaction_offset;
#endif
};
 
/* client http based routines */
char *clientConstructTraceEcho(ClientHttpRequest *);
 
ACLFilledChecklist *clientAclChecklistCreate(const acl_access * acl,ClientHttpRequest * http);
void clientAclChecklistFill(ACLFilledChecklist &, ClientHttpRequest *);
void clientAccessCheck(ClientHttpRequest *);
 
/* ones that should be elsewhere */
void tunnelStart(ClientHttpRequest *);
 
#endif /* SQUID_CLIENTSIDEREQUEST_H */