Message.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_HTTP_MESSAGE_H
#define SQUID_SRC_HTTP_MESSAGE_H
 
#include "base/Lock.h"
#include "BodyPipe.h"
#include "enums.h"
#include "http/forward.h"
#include "http/ProtocolVersion.h"
#include "http/StatusCode.h"
#include "HttpHeader.h"
#include <type_traits>
 
namespace Http
{
 
class Message : public RefCountable
{
public:
    enum Sources {
        srcUnknown = 0,
 
        /* flags in 0xFFFF zone are for "secure" or "encrypted" sources */
        srcHttps = 1 << 0, 
        srcFtps = 1 << 1, 
        srcIcaps = 1 << 2, 
        srcEcaps = 1 << 3, 
 
        /* these flags "taint" the message: it may have been observed or mangled outside Squid */
        srcHttp = 1 << (16 + 0), 
        srcFtp = 1 << (16 + 1), 
        srcIcap = 1 << (16 + 2), 
        srcEcap = 1 << (16 + 3), 
        srcWhois = 1 << (16 + 15), 
        srcUnsafe = 0xFFFF0000,  
        srcSafe = 0x0000FFFF 
    };
 
    Message(http_hdr_owner_type);
    ~Message() override;
 
    virtual void reset() = 0; // will have body when http*Clean()s are gone
 
    void packInto(Packable *, bool full_uri) const;
 
    virtual Http::Message *clone() const = 0; // TODO rename: not a true copy?
 
    void setContentLength(int64_t);
 
    bool persistent() const;
 
public:
    AnyP::ProtocolVersion http_ver;
 
    HttpHeader header;
 
    HttpHdrCc *cache_control = nullptr;
 
    /* Unsupported, writable, may disappear/change in the future
     * For replies, sums _stored_ status-line, headers, and <CRLF>.
     * Also used to report parsed header size if parse() is successful */
    int hdr_sz = 0;
 
    int64_t content_length = 0;
 
    enum ParseState {
        psReadyToParseStartLine = 0,
        psReadyToParseHeaders,
        psParsed,
        psError
    };
 
    ParseState pstate = Http::Message::psReadyToParseStartLine;
 
    BodyPipe::Pointer body_pipe;
 
    uint32_t sources = 0; 
 
    void putCc(const HttpHdrCc &);
 
    // returns true and sets hdr_sz on success
    // returns false and sets *error to zero when needs more data
    // returns false and sets *error to a positive Http::StatusCode on error
    bool parse(const char *buf, const size_t sz, bool eol, Http::StatusCode *error);
 
    bool parseCharBuf(const char *buf, ssize_t end);
 
    int httpMsgParseStep(const char *buf, int len, int atEnd);
 
    virtual int httpMsgParseError();
 
    virtual bool expectingBody(const HttpRequestMethod&, int64_t&) const = 0;
 
    void firstLineBuf(MemBuf&);
 
    virtual bool inheritProperties(const Http::Message *) = 0;
 
protected:
    virtual bool sanityCheckStartLine(const char *buf, const size_t hdr_len, Http::StatusCode *error) = 0;
 
    virtual void packFirstLineInto(Packable * p, bool full_uri) const = 0;
 
    virtual bool parseFirstLine(const char *blk_start, const char *blk_end) = 0;
 
    virtual void hdrCacheInit();
 
    virtual void configureContentLengthInterpreter(Http::ContentLengthInterpreter &) = 0;
 
    // Parser-NG transitional parsing of mime headers
    bool parseHeader(Http1::Parser &, Http::ContentLengthInterpreter &); // TODO move this function to the parser
};
 
} // namespace Http
 
template <class M>
inline void
HTTPMSGUNLOCK(M *&a)
{
    static_assert(std::is_base_of<Http::Message, M>::value, "M must inherit from Http::Message");
    if (a) {
        if (a->unlock() == 0)
            delete a;
        a = nullptr;
    }
}
 
inline void
HTTPMSGLOCK(Http::Message *a)
{
    if (a)
        a->lock();
}
 
#endif /* SQUID_SRC_HTTP_MESSAGE_H */