headers.h

/*
 * SPDX-FileCopyrightText: (C) 2014-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#pragma once
 
#include <Cutelyst/cutelyst_global.h>
 
#include <QtCore/QDateTime>
#include <QtCore/QMetaType>
#include <QtCore/QVariant>
 
namespace Cutelyst {
 
class CUTELYST_LIBRARY Headers
{
public:
    struct HeaderKeyValue {
        QByteArray key;
        QByteArray value;
 
        inline bool operator==(const HeaderKeyValue &other) const
        {
            return (key.compare(other.key, Qt::CaseInsensitive) == 0) && value == other.value;
        }
    };
 
    Headers() noexcept = default;
 
    Headers(const Headers &other) noexcept;
 
    inline Headers(std::initializer_list<std::pair<QByteArray, QByteArray>> list)
    {
        for (std::initializer_list<std::pair<QByteArray, QByteArray>>::const_iterator it =
                 list.begin();
             it != list.end();
             ++it)
            m_data.emplace_back(HeaderKeyValue{it->first, it->second});
    }
 
    [[nodiscard]] QByteArray contentDisposition() const noexcept;
 
    void setCacheControl(const QByteArray &value);
 
    void setContentDisposition(const QByteArray &contentDisposition);
 
    void setContentDispositionAttachment(const QByteArray &filename = {});
 
    [[nodiscard]] QByteArray contentEncoding() const noexcept;
 
    void setContentEncoding(const QByteArray &encoding);
 
    [[nodiscard]] QByteArray contentType() const;
 
    void setContentType(const QByteArray &contentType);
 
    [[nodiscard]] QByteArray contentTypeCharset() const;
 
    void setContentTypeCharset(const QByteArray &charset);
 
    [[nodiscard]] bool contentIsText() const;
 
    [[nodiscard]] bool contentIsHtml() const;
 
    [[nodiscard]] bool contentIsXHtml() const;
 
    [[nodiscard]] bool contentIsXml() const;
 
    [[nodiscard]] bool contentIsJson() const;
 
    [[nodiscard]] qint64 contentLength() const;
 
    void setContentLength(qint64 value);
 
    QByteArray setDateWithDateTime(const QDateTime &date);
 
    [[nodiscard]] QDateTime date() const;
 
    [[nodiscard]] QByteArray ifModifiedSince() const noexcept;
 
    [[nodiscard]] QDateTime ifModifiedSinceDateTime() const;
 
    [[nodiscard]] bool ifModifiedSince(const QDateTime &lastModified) const;
 
    [[nodiscard]] bool ifMatch(const QByteArray &etag) const;
 
    [[nodiscard]] bool ifNoneMatch(const QByteArray &etag) const;
 
    void setETag(const QByteArray &etag);
 
    [[nodiscard]] QByteArray lastModified() const noexcept;
 
    void setLastModified(const QByteArray &value);
 
    QString setLastModified(const QDateTime &lastModified);
 
    [[nodiscard]] QByteArray server() const noexcept;
 
    void setServer(const QByteArray &value);
 
    [[nodiscard]] QByteArray connection() const noexcept;
 
    [[nodiscard]] QByteArray host() const noexcept;
 
    [[nodiscard]] QByteArray userAgent() const noexcept;
 
    [[nodiscard]] QByteArray referer() const noexcept;
 
    void setReferer(const QByteArray &value);
 
    void setWwwAuthenticate(const QByteArray &value);
 
    void setProxyAuthenticate(const QByteArray &value);
 
    [[nodiscard]] QByteArray authorization() const noexcept;
 
    [[nodiscard]] QByteArray authorizationBearer() const;
 
    [[nodiscard]] QByteArray authorizationBasic() const;
 
    struct Authorization {
        QString user;
        QString password;
    };
 
    [[nodiscard]] Authorization authorizationBasicObject() const;
 
    QByteArray setAuthorizationBasic(const QString &username, const QString &password);
 
    [[nodiscard]] QByteArray proxyAuthorization() const noexcept;
 
    [[nodiscard]] QByteArray proxyAuthorizationBasic() const;
 
    [[nodiscard]] Authorization proxyAuthorizationBasicObject() const;
 
    [[nodiscard]] QByteArray header(QByteArrayView key) const noexcept;
 
    [[nodiscard]] QString headerAsString(QByteArrayView key) const;
 
    [[nodiscard]] QByteArray header(QByteArrayView key,
                                    const QByteArray &defaultValue) const noexcept;
 
    [[nodiscard]] QString headerAsString(QByteArrayView key, const QByteArray &defaultValue) const;
 
    [[nodiscard]] QByteArrayList headers(QByteArrayView key) const;
 
    [[nodiscard]] QStringList headersAsStrings(QByteArrayView key) const;
 
    void setHeader(const QByteArray &key, const QByteArray &value);
 
    void setHeader(const QByteArray &field, const QByteArrayList &values);
 
    void pushHeader(const QByteArray &key, const QByteArray &value);
 
    void pushHeader(const QByteArray &key, const QByteArrayList &values);
 
    void removeHeader(QByteArrayView key);
 
    inline void clear() { m_data.clear(); }
 
    [[nodiscard]] inline QVector<HeaderKeyValue> data() const { return m_data; }
 
    [[nodiscard]] bool contains(QByteArrayView key) const noexcept;
 
    [[nodiscard]] QByteArrayList keys() const;
 
    QByteArray operator[](QByteArrayView key) const noexcept;
 
    inline Headers &operator=(const Headers &other) noexcept
    {
        m_data = other.m_data;
        return *this;
    }
 
    bool operator==(const Headers &other) const noexcept;
 
private:
    QVector<HeaderKeyValue> m_data;
};
 
} // namespace Cutelyst
 
Q_DECLARE_METATYPE(Cutelyst::Headers)
 
QDebug CUTELYST_LIBRARY operator<<(QDebug dbg, const Cutelyst::Headers &headers);