headers.h

/*
 * SPDX-FileCopyrightText: (C) 2014-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef HEADERS_H
#define HEADERS_H
 
#include <Cutelyst/cutelyst_global.h>
 
#include <QtCore/QDateTime>
#include <QtCore/QMetaType>
#include <QtCore/QVariant>
 
namespace Cutelyst {
 
class CUTELYST_LIBRARY Headers
{
public:
    Headers() = default;

    Headers(const Headers &other);
 
#ifdef Q_COMPILER_INITIALIZER_LISTS
    inline Headers(std::initializer_list<std::pair<QString, QString>> list)
    {
        for (std::initializer_list<std::pair<QString, QString>>::const_iterator it = list.begin();
             it != list.end();
             ++it)
            pushHeader(it->first, it->second);
    }
#endif

    QString contentDisposition() const;

    void setCacheControl(const QString &value);

    void setContentDisposition(const QString &contentDisposition);

    void setContentDispositionAttachment(const QString &filename = QString());

    QString contentEncoding() const;

    void setContentEncoding(const QString &encoding);

    QString contentType() const;

    void setContentType(const QString &contentType);

    QString contentTypeCharset() const;

    void setContentTypeCharset(const QString &charset);

    bool contentIsText() const;

    bool contentIsHtml() const;

    bool contentIsXHtml() const;

    bool contentIsXml() const;

    bool contentIsJson() const;

    qint64 contentLength() const;

    void setContentLength(qint64 value);

    QString setDateWithDateTime(const QDateTime &date);

    QDateTime date() const;

    QString ifModifiedSince() const;

    QDateTime ifModifiedSinceDateTime() const;

    bool ifModifiedSince(const QDateTime &lastModified) const;

    bool ifMatch(const QString &etag) const;

    bool ifNoneMatch(const QString &etag) const;

    void setETag(const QString &etag);

    QString lastModified() const;

    void setLastModified(const QString &value);

    QString setLastModified(const QDateTime &lastModified);

    QString server() const;

    void setServer(const QString &value);

    QString connection() const;

    QString host() const;

    QString userAgent() const;

    QString referer() const;

    void setReferer(const QString &value);

    void setWwwAuthenticate(const QString &value);

    void setProxyAuthenticate(const QString &value);

    QString authorization() const;

    QString authorizationBearer() const;

    QString authorizationBasic() const;
 
    struct Authorization {
        QString user;
        QString password;
    };

    Authorization authorizationBasicObject() const;

    QString setAuthorizationBasic(const QString &username, const QString &password);

    QString proxyAuthorization() const;

    QString proxyAuthorizationBasic() const;

    Authorization proxyAuthorizationBasicObject() const;

    QString header(const QString &field) const;

    QString header(const QString &field, const QString &defaultValue) const;

    void setHeader(const QString &field, const QString &value);

    void setHeader(const QString &field, const QStringList &values);

    void pushHeader(const QString &field, const QString &value);

    inline void pushRawHeader(const QString &field, const QString &value);

    void pushHeader(const QString &field, const QStringList &values);

    void removeHeader(const QString &field);

    inline void clear() { m_data.clear(); }

    inline QMultiHash<QString, QString> data() const { return m_data; }

    bool contains(const QString &field) const;

    QString operator[](const QString &key) const;

    inline Headers &operator=(const Headers &other)
    {
        m_data = other.m_data;
        return *this;
    }

    inline bool operator==(const Headers &other) const { return m_data == other.m_data; }

    inline bool operator!=(const Headers &other) const { return m_data != other.m_data; }
 
private:
    QMultiHash<QString, QString> m_data;
};
 
void Headers::pushRawHeader(const QString &field, const QString &value)
{
    m_data.insert(field, value);
}
 
} // namespace Cutelyst
 
Q_DECLARE_METATYPE(Cutelyst::Headers)
 
QDebug CUTELYST_LIBRARY operator<<(QDebug dbg, const Cutelyst::Headers &headers);
 
#endif // HEADERS_H