Parser.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2019 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_ONE_PARSER_H
#define _SQUID_SRC_HTTP_ONE_PARSER_H

#include "anyp/ProtocolVersion.h"
#include "http/one/forward.h"
#include "http/StatusCode.h"
#include "sbuf/SBuf.h"

namespace Http {
namespace One {

// Parser states
enum ParseState {
    HTTP_PARSE_NONE,      
    HTTP_PARSE_FIRST,     
    HTTP_PARSE_CHUNK_SZ,  
    HTTP_PARSE_CHUNK_EXT, 
    HTTP_PARSE_CHUNK,     
    HTTP_PARSE_MIME,      
    HTTP_PARSE_DONE       
};

class Parser : public RefCountable
{
public:
    typedef SBuf::size_type size_type;

    Parser() = default;
    Parser(const Parser &) = default;
    Parser &operator =(const Parser &) = default;
    Parser(Parser &&) = default;
    Parser &operator =(Parser &&) = default;
    virtual ~Parser() {}

    virtual void clear() = 0;

    virtual bool parse(const SBuf &aBuf) = 0;

    bool needsMoreData() const {return parsingStage_!=HTTP_PARSE_DONE;}

    virtual size_type firstLineSize() const = 0;

    size_type headerBlockSize() const {return mimeHeaderBlock_.length();}

    size_type messageHeaderSize() const {return firstLineSize() + headerBlockSize();}

    SBuf mimeHeader() const {return mimeHeaderBlock_;}

    const AnyP::ProtocolVersion & messageProtocol() const {return msgProtocol_;}

    char *getHeaderField(const char *name);

    const SBuf &remaining() const {return buf_;}

    Http::StatusCode parseStatusCode = Http::scNone;

    static const CharacterSet &WhitespaceCharacters();

    static const CharacterSet &DelimiterCharacters();

protected:
    bool skipLineTerminator(Http1::Tokenizer &tok) const;

    bool grabMimeBlock(const char *which, const size_t limit);

    static const SBuf Http1magic;

    SBuf buf_;

    ParseState parsingStage_ = HTTP_PARSE_NONE;

    AnyP::ProtocolVersion msgProtocol_;

    SBuf mimeHeaderBlock_;

    bool hackExpectsMime_ = false;

private:
    void cleanMimePrefix();
    void unfoldMime();
};

bool ParseBws(Tokenizer &tok);

int ErrorLevel();

} // namespace One
} // namespace Http

#endif /*  _SQUID_SRC_HTTP_ONE_PARSER_H */