HttpReply.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_HTTPREPLY_H
#define SQUID_SRC_HTTPREPLY_H
 
#include "http/StatusLine.h"
#include "HttpBody.h"
#include "HttpRequest.h"
 
void httpReplyInitModule(void);
 
/* Sync changes here with HttpReply.cc */
 
class HttpHdrContRange;
 
class HttpHdrSc;
 
class HttpReply: public Http::Message
{
    MEMPROXY_CLASS(HttpReply);
 
public:
    typedef RefCount<HttpReply> Pointer;
 
    HttpReply();
    ~HttpReply() override;
 
    void reset() override;
 
    /* Http::Message API */
    bool sanityCheckStartLine(const char *buf, const size_t hdr_len, Http::StatusCode *error) override;
 
    time_t date;
 
    time_t last_modified;
 
    time_t expires;
 
    String content_type;
 
    HttpHdrSc *surrogate_control;
 
    const HttpHdrContRange *contentRange() const;
 
    short int keep_alive;
 
    Http::StatusLine sline;
 
    HttpBody body;      
    String protoPrefix;         
    bool do_clean;
 
public:
    int httpMsgParseError() override;
 
    bool expectingBody(const HttpRequestMethod&, int64_t&) const override;
 
    bool inheritProperties(const Http::Message *) override;
 
    Pointer recreateOnNotModified(const HttpReply &reply304) const;
 
    void setHeaders(Http::StatusCode status,
                    const char *reason, const char *ctype, int64_t clen, time_t lmt, time_t expires);
 
    MemBuf *pack() const;
 
    static HttpReplyPointer MakeConnectionEstablished();
 
    HttpReplyPointer make304() const;
 
    void redirect(Http::StatusCode, const char *);
 
    int64_t bodySize(const HttpRequestMethod&) const;
 
    bool receivedBodyTooLarge(HttpRequest&, int64_t receivedBodySize);
 
    bool expectedBodyTooLarge(HttpRequest& request);
 
    int validatorsMatch (HttpReply const *other) const;
 
    void packHeadersUsingFastPacker(Packable &p) const;
    void packHeadersUsingSlowPacker(Packable &p) const;
 
    HttpReply *clone() const override;
 
    void hdrCacheInit() override;
 
    bool olderThan(const HttpReply *them) const;
 
    void removeIrrelevantContentLength();
 
    void configureContentLengthInterpreter(Http::ContentLengthInterpreter &) override;
    bool parseHeader(Http1::Parser &hp);
 
    size_t parseTerminatedPrefix(const char *, size_t);
 
    size_t prefixLen() const;
 
private:
    void init();
 
    void clean();
 
    void hdrCacheClean();
 
    void packInto(MemBuf &) const;
 
    /* ez-routines */
    MemBuf *packed304Reply() const;
 
    /* header manipulation */
    time_t hdrExpirationTime();
 
    void calcMaxBodySize(HttpRequest& request) const;
 
    mutable int64_t bodySizeMax; 
    HttpHdrContRange *content_range; 
 
protected:
    void packFirstLineInto(Packable * p, bool) const override { sline.packInto(p); }
 
    bool parseFirstLine(const char *start, const char *end) override;
};
 
#endif /* SQUID_SRC_HTTPREPLY_H */