// See the file "COPYING" in the main distribution directory for copyright.

#pragma once

#include <cassert>
#include <cstdio>
#include <vector>

#include "zeek/Reporter.h"
#include "zeek/ZeekString.h"
#include "zeek/analyzer/Analyzer.h"
#include "zeek/digest.h"

namespace zeek {

class TableVal;
class StringVal;
using TableValPtr = IntrusivePtr<TableVal>;
using StringValPtr = IntrusivePtr<StringVal>;

namespace detail {
class Base64Converter;
}

namespace analyzer::mime {

// MIME: Multipurpose Internet Mail Extensions
// Follows RFC 822 & 2822 (Internet Mail), 2045-2049 (MIME)
// See related files: SMTP.h and SMTP.cc

// MIME Constants

constexpr char HT = '\011';
constexpr char SP = '\040';
constexpr char CR = '\015';
constexpr char LF = '\012';

enum MIME_CONTENT_TYPE : uint8_t {
    CONTENT_TYPE_MULTIPART,
    CONTENT_TYPE_MESSAGE,
    CONTENT_TYPE_TEXT,
    CONTENT_TYPE_OTHER, // image | audio | video | application | <other>
};

enum MIME_EVENT_TYPE : uint8_t {
    MIME_EVENT_ILLEGAL_FORMAT,
    MIME_EVENT_ILLEGAL_ENCODING,
    MIME_EVENT_CONTENT_GAP,
    MIME_EVENT_OTHER,
};

// MIME data structures.

class MIME_Multiline;
class MIME_Header;
class MIME_Body;
class MIME_Entity; // an "entity" contains headers and a body
class MIME_Mail;
class MIME_Message;

class MIME_Multiline {
public:
    MIME_Multiline();
    ~MIME_Multiline();

    void append(int len, const char* data);
    String* get_concatenated_line();

protected:
    std::vector<const String*> buffer;
    String* line;
};

class MIME_Header {
public:
    explicit MIME_Header(MIME_Multiline* hl);
    ~MIME_Header();

    data_chunk_t get_name() const { return name; }
    data_chunk_t get_value() const { return value; }

    data_chunk_t get_value_token();
    data_chunk_t get_value_after_token();

protected:
    int get_first_token();

    MIME_Multiline* lines;
    data_chunk_t name;
    data_chunk_t value;
    data_chunk_t value_token, rest_value;
};

using MIME_HeaderList = std::vector<MIME_Header*>;

class MIME_Entity {
public:
    MIME_Entity(MIME_Message* output_message, MIME_Entity* parent_entity);
    virtual ~MIME_Entity();

    virtual void Deliver(int len, const char* data, bool trailing_CRLF);
    virtual void EndOfData();

    MIME_Entity* Parent() const { return parent; }
    zeek_uint_t Depth() const { return depth; };
    int MIMEContentType() const { return content_type; }
    const StringValPtr& GetContentType() const { return content_type_str; }
    const StringValPtr& GetContentSubType() const { return content_subtype_str; }
    int ContentTransferEncoding() const { return content_encoding; }

protected:
    void init();

    // {begin, continuation, end} of a header.
    void NewHeader(int len, const char* data);
    void ContHeader(int len, const char* data);
    void FinishHeader();

    void ParseMIMEHeader(MIME_Header* h);
    int LookupMIMEHeaderName(data_chunk_t name);
    bool ParseContentTypeField(MIME_Header* h);
    bool ParseContentEncodingField(MIME_Header* h);
    bool ParseFieldParameters(int len, const char* data);

    void ParseContentType(data_chunk_t type, data_chunk_t sub_type);
    void ParseContentEncoding(data_chunk_t encoding_mechanism);

    void BeginBody();
    void NewDataLine(int len, const char* data, bool trailing_CRLF);

    int CheckBoundaryDelimiter(int len, const char* data);
    void DecodeDataLine(int len, const char* data, bool trailing_CRLF);
    void DecodeBinary(int len, const char* data, bool trailing_CRLF);
    void DecodeQuotedPrintable(int len, const char* data);
    void DecodeBase64(int len, const char* data);
    void StartDecodeBase64();
    void FinishDecodeBase64();

    bool GetDataBuffer();
    void DataOctet(char ch);
    void DataOctets(int len, const char* data);
    void FlushData();
    virtual void SubmitData(int len, const char* buf);

    virtual void SubmitHeader(MIME_Header* h);
    // Submit all headers in member "headers".
    virtual void SubmitAllHeaders();

    virtual MIME_Entity* NewChildEntity() { return new MIME_Entity(message, this); }
    void BeginChildEntity();
    void EndChildEntity();

    void IllegalFormat(const char* explanation);
    void IllegalEncoding(const char* explanation);

    void DebugPrintHeaders();

    int in_header;
    int end_of_data;
    MIME_Multiline* current_header_line;
    int current_field_type;
    int need_to_parse_parameters;

    StringValPtr content_type_str;
    StringValPtr content_subtype_str;
    String* content_encoding_str;
    String* multipart_boundary;

    int content_type, content_subtype, content_encoding;

    MIME_HeaderList headers;
    MIME_Entity* parent;
    MIME_Entity* current_child_entity;

    zeek::detail::Base64Converter* base64_decoder;

    zeek_uint_t depth;
    int data_buf_length;
    char* data_buf_data;
    int data_buf_offset;

    MIME_Message* message;
    bool delay_adding_implicit_CRLF;
    bool want_all_headers;
};

// The reason I separate MIME_Message as an abstract class is to
// present the *interface* separated from its implementation to
// generate Zeek events.

class MIME_Message {
public:
    explicit MIME_Message(analyzer::Analyzer* arg_analyzer) {
        // Cannot initialize top_level entity because we do
        // not know its type yet (MIME_Entity / MIME_Mail /
        // etc.).
        top_level = nullptr;
        finished = false;
        analyzer = arg_analyzer;
    }

    virtual ~MIME_Message() {
        if ( ! finished )
            reporter->AnalyzerError(analyzer, "missing MIME_Message::Done() call");
    }

    virtual void Done() { finished = true; }

    bool Finished() const { return finished; }

    virtual void Deliver(int len, const char* data, bool trailing_CRLF) {
        top_level->Deliver(len, data, trailing_CRLF);
    }

    analyzer::Analyzer* GetAnalyzer() const { return analyzer; }

    // Events generated by MIME_Entity
    virtual void BeginEntity(MIME_Entity*) = 0;
    virtual void EndEntity(MIME_Entity*) = 0;
    virtual void SubmitHeader(MIME_Header* h) = 0;
    virtual void SubmitAllHeaders(MIME_HeaderList& hlist) = 0;
    virtual void SubmitData(int len, const char* buf) = 0;
    virtual bool RequestBuffer(int* plen, char** pbuf) = 0;
    virtual void SubmitEvent(int event_type, const char* detail) = 0;

protected:
    analyzer::Analyzer* analyzer;

    MIME_Entity* top_level;
    bool finished;

    RecordValPtr ToHeaderVal(MIME_Header* h);
    TableValPtr ToHeaderTable(MIME_HeaderList& hlist);
};

class MIME_Mail final : public MIME_Message {
public:
    MIME_Mail(analyzer::Analyzer* mail_conn, bool is_orig, int buf_size = 0);
    ~MIME_Mail() override;
    void Done() override;

    void BeginEntity(MIME_Entity* entity) override;
    void EndEntity(MIME_Entity* entity) override;
    void SubmitHeader(MIME_Header* h) override;
    void SubmitAllHeaders(MIME_HeaderList& hlist) override;
    void SubmitData(int len, const char* buf) override;
    bool RequestBuffer(int* plen, char** pbuf) override;
    void SubmitAllData();
    void SubmitEvent(int event_type, const char* detail) override;
    void Undelivered(int len);

protected:
    int min_overlap_length;
    int max_chunk_length;
    bool is_orig;
    int buffer_start;
    int data_start;
    int compute_content_hash;
    int content_hash_length;
    detail::HashDigestState* md5_hash = nullptr;
    std::vector<const String*> entity_content;
    std::vector<const String*> all_content;

    String* data_buffer;

    uint64_t cur_entity_len;
    std::string cur_entity_id;
};

extern bool is_null_data_chunk(data_chunk_t b);
extern StringValPtr to_string_val(int length, const char* data);
extern StringValPtr to_string_val(const char* data, const char* end_of_data);
extern StringValPtr to_string_val(const data_chunk_t buf);
extern int fputs(data_chunk_t b, FILE* fp);
extern bool istrequal(data_chunk_t s, const char* t);
extern bool is_lws(char ch);
extern bool MIME_is_field_name_char(char ch);
extern int MIME_count_leading_lws(int len, const char* data);
extern int MIME_count_trailing_lws(int len, const char* data);
extern int MIME_skip_comments(int len, const char* data);
extern int MIME_skip_lws_comments(int len, const char* data);
extern int MIME_get_token(int len, const char* data, data_chunk_t* token, bool is_boundary = false);
extern int MIME_get_slash_token_pair(int len, const char* data, data_chunk_t* first, data_chunk_t* second);
extern int MIME_get_value(int len, const char* data, String*& buf, bool is_boundary = false);
extern int MIME_get_field_name(int len, const char* data, data_chunk_t* name);
extern String* MIME_decode_quoted_pairs(data_chunk_t buf);

} // namespace analyzer::mime
} // namespace zeek
