headers.cpp

/*
 * Copyright (C) 2014-2018 Daniel Nicoletti <dantti12@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#include "headers.h"
 
#include "common.h"
 
#include "engine.h"
 
#include <QStringList>
 
using namespace Cutelyst;
 
inline QString normalizeHeaderKey(const QString &field);
inline QByteArray decodeBasicAuth(const QString &auth);
inline Headers::Authorization decodeBasicAuthPair(const QString &auth);
 
Headers::Headers(const Headers &other) : m_data(other.m_data)
{
}
 
QString Headers::contentDisposition() const
{
    return m_data.value(QStringLiteral("CONTENT_DISPOSITION"));
}
 
void Headers::setCacheControl(const QString &value)
{
    m_data.replace(QStringLiteral("CACHE_CONTROL"), value);
}
 
void Headers::setContentDisposition(const QString &contentDisposition)
{
    m_data.replace(QStringLiteral("CONTENT_DISPOSITION"), contentDisposition);
}
 
void Headers::setContentDispositionAttachment(const QString &filename)
{
    if (filename.isEmpty()) {
        setContentDisposition(QStringLiteral("attachment"));
    } else {
        setContentDisposition(QLatin1String("attachment; filename=\"") + filename + QLatin1Char('"'));
    }
}
 
QString Headers::contentEncoding() const
{
    return m_data.value(QStringLiteral("CONTENT_ENCODING"));
}
 
void Headers::setContentEncoding(const QString &encoding)
{
    m_data.replace(QStringLiteral("CONTENT_ENCODING"), encoding);
}
 
QString Headers::contentType() const
{
    QString ret;
    const auto it = m_data.constFind(QStringLiteral("CONTENT_TYPE"));
    if (it != m_data.constEnd()) {
        const QString &ct = it.value();
        ret = ct.mid(0, ct.indexOf(QLatin1Char(';'))).toLower();
    }
    return ret;
}
 
void Headers::setContentType(const QString &contentType)
{
    m_data.replace(QStringLiteral("CONTENT_TYPE"), contentType);
}
 
QString Headers::contentTypeCharset() const
{
    QString ret;
    const auto it = m_data.constFind(QStringLiteral("CONTENT_TYPE"));
    if (it != m_data.constEnd()) {
        const QString &contentType = it.value();
        int pos = contentType.indexOf(QLatin1String("charset="), 0, Qt::CaseInsensitive);
        if (pos != -1) {
            int endPos = contentType.indexOf(QLatin1Char(';'), pos);
            ret = contentType.mid(pos + 8, endPos).trimmed().toUpper();
        }
    }
 
    return ret;
}
 
void Headers::setContentTypeCharset(const QString &charset)
{
    const auto it = m_data.constFind(QStringLiteral("CONTENT_TYPE"));
    if (it == m_data.constEnd() || (it.value().isEmpty() && !charset.isEmpty())) {
        m_data.replace(QStringLiteral("CONTENT_TYPE"), QLatin1String("charset=") + charset);
        return;
    }
 
    QString contentType = it.value();
    int pos = contentType.indexOf(QLatin1String("charset="), 0, Qt::CaseInsensitive);
    if (pos != -1) {
        int endPos = contentType.indexOf(QLatin1Char(';'), pos);
        if (endPos == -1) {
            if (charset.isEmpty()) {
                int lastPos = contentType.lastIndexOf(QLatin1Char(';'), pos);
                if (lastPos == -1) {
                    m_data.remove(QStringLiteral("CONTENT_TYPE"));
                    return;
                } else {
                    contentType.remove(lastPos, contentType.length() - lastPos);
                }
            } else {
                contentType.replace(pos + 8, contentType.length() - pos + 8, charset);
            }
        } else {
            contentType.replace(pos + 8, endPos, charset);
        }
    } else if (!charset.isEmpty()) {
        contentType.append(QLatin1String("; charset=") + charset);
    }
    m_data.replace(QStringLiteral("CONTENT_TYPE"), contentType);
}
 
bool Headers::contentIsText() const
{
    return m_data.value(QStringLiteral("CONTENT_TYPE")).startsWith(QLatin1String("text/"));
}
 
bool Headers::contentIsHtml() const
{
    const QString ct = contentType();
    return ct == QLatin1String("text/html") ||
            ct == QLatin1String("application/xhtml+xml") ||
            ct == QLatin1String("application/vnd.wap.xhtml+xml");
}
 
bool Headers::contentIsXHtml() const
{
    const QString ct = contentType();
    return ct == QLatin1String("application/xhtml+xml") ||
            ct == QLatin1String("application/vnd.wap.xhtml+xml");
}
 
bool Headers::contentIsXml() const
{
    const QString ct = contentType();
    return ct == QLatin1String("text/xml") ||
            ct == QLatin1String("application/xml") ||
            ct.endsWith(QLatin1String("xml"));
}
 
bool Headers::contentIsJson() const
{
    const auto it = m_data.constFind(QStringLiteral("CONTENT_TYPE"));
    if (it != m_data.constEnd()) {
        return it.value() == QLatin1String("application/json");
    }
    return false;
}
 
qint64 Headers::contentLength() const
{
    auto it = m_data.constFind(QStringLiteral("CONTENT_LENGTH"));
    if (it != m_data.constEnd()) {
        return it.value().toLongLong();
    }
    return -1;
}
 
void Headers::setContentLength(qint64 value)
{
    m_data.replace(QStringLiteral("CONTENT_LENGTH"), QString::number(value));
}
 
QString Headers::setDateWithDateTime(const QDateTime &date)
{
    // ALL dates must be in GMT timezone http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html
    // and follow RFC 822
    QString dt = QLocale::c().toString(date.toUTC(),
                                       QStringLiteral("ddd, dd MMM yyyy hh:mm:ss 'GMT"));
    m_data.replace(QStringLiteral("DATE"), dt);
    return dt;
}
 
QDateTime Headers::date() const
{
    QDateTime ret;
    auto it = m_data.constFind(QStringLiteral("DATE"));
    if (it != m_data.constEnd()) {
        const QString &date = it.value();
 
        if (date.endsWith(QLatin1String(" GMT"))) {
            ret = QLocale::c().toDateTime(date.left(date.size() - 4),
                                          QStringLiteral("ddd, dd MMM yyyy hh:mm:ss"));
        } else {
            ret = QLocale::c().toDateTime(date,
                                          QStringLiteral("ddd, dd MMM yyyy hh:mm:ss"));
        }
        ret.setTimeSpec(Qt::UTC);
    }
 
    return ret;
}
 
QString Headers::ifModifiedSince() const
{
    return m_data.value(QStringLiteral("IF_MODIFIED_SINCE"));
}
 
QDateTime Headers::ifModifiedSinceDateTime() const
{
    QDateTime ret;
    auto it = m_data.constFind(QStringLiteral("IF_MODIFIED_SINCE"));
    if (it != m_data.constEnd()) {
        const QString &ifModifiedStr = it.value();
 
        if (ifModifiedStr.endsWith(QLatin1String(" GMT"))) {
            ret = QLocale::c().toDateTime(ifModifiedStr.left(ifModifiedStr.size() - 4),
                                          QStringLiteral("ddd, dd MMM yyyy hh:mm:ss"));
        } else {
            ret = QLocale::c().toDateTime(ifModifiedStr,
                                          QStringLiteral("ddd, dd MMM yyyy hh:mm:ss"));
        }
        ret.setTimeSpec(Qt::UTC);
    }
 
    return ret;
}
 
bool Headers::ifModifiedSince(const QDateTime &lastModified) const
{
    auto it = m_data.constFind(QStringLiteral("IF_MODIFIED_SINCE"));
    if (it != m_data.constEnd()) {
        return it.value() != QLocale::c().toString(lastModified.toUTC(),
                                                   QStringLiteral("ddd, dd MMM yyyy hh:mm:ss 'GMT"));
    }
    return true;
}
 
bool Headers::ifMatch(const QString &etag) const
{
    auto it = m_data.constFind(QStringLiteral("IF_MATCH"));
    if (it != m_data.constEnd()) {
        const QString &clientETag = it.value();
        return clientETag.mid(1, clientETag.size() - 2) == etag ||
                clientETag.mid(3, clientETag.size() - 4) == etag; // Weak ETag
    }
    return true;
}
 
bool Headers::ifNoneMatch(const QString &etag) const
{
    auto it = m_data.constFind(QStringLiteral("IF_NONE_MATCH"));
    if (it != m_data.constEnd()) {
        const QString &clientETag = it.value();
        return clientETag.mid(1, clientETag.size() - 2) == etag ||
                clientETag.mid(3, clientETag.size() - 4) == etag; // Weak ETag
    }
    return false;
}
 
void Headers::setETag(const QString &etag)
{
    m_data.replace(QStringLiteral("ETAG"), QLatin1Char('"') + etag + QLatin1Char('"'));
}
 
QString Headers::lastModified() const
{
    return m_data.value(QStringLiteral("LAST_MODIFIED"));
}
 
void Headers::setLastModified(const QString &value)
{
    m_data.replace(QStringLiteral("LAST_MODIFIED"), value);
}
 
QString Headers::setLastModified(const QDateTime &lastModified)
{
    // ALL dates must be in GMT timezone http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html
    // and follow RFC 822
    auto dt = QLocale::c().toString(lastModified.toUTC(),
                                    QStringLiteral("ddd, dd MMM yyyy hh:mm:ss 'GMT"));
    setLastModified(dt);
    return dt;
}
 
QString Headers::server() const
{
    return m_data.value(QStringLiteral("SERVER"));
}
 
void Headers::setServer(const QString &value)
{
    m_data.replace(QStringLiteral("SERVER"), value);
}
 
QString Headers::connection() const
{
    return m_data.value(QStringLiteral("CONNECTION"));
}
 
QString Headers::host() const
{
    return m_data.value(QStringLiteral("HOST"));
}
 
QString Headers::userAgent() const
{
    return m_data.value(QStringLiteral("USER_AGENT"));
}
 
QString Headers::referer() const
{
    return m_data.value(QStringLiteral("REFERER"));
}
 
void Headers::setReferer(const QString &uri)
{
    int fragmentPos = uri.indexOf(QLatin1Char('#'));
    if (fragmentPos != -1) {
        // Strip fragment per RFC 2616, section 14.36.
        m_data.replace(QStringLiteral("REFERER"), uri.mid(0, fragmentPos));
    } else {
        m_data.replace(QStringLiteral("REFERER"), uri);
    }
}
 
void Headers::setWwwAuthenticate(const QString &value)
{
    m_data.replace(QStringLiteral("WWW_AUTHENTICATE"), value);
}
 
void Headers::setProxyAuthenticate(const QString &value)
{
    m_data.replace(QStringLiteral("PROXY_AUTHENTICATE"), value);
}
 
QString Headers::authorization() const
{
    return m_data.value(QStringLiteral("AUTHORIZATION"));
}
 
QString Headers::authorizationBearer() const
{
    QString ret;
    auto it = m_data.constFind(QStringLiteral("AUTHORIZATION"));
    if (it != m_data.constEnd() && it.value().startsWith(QLatin1String("Bearer "))) {
        ret = it.value().mid(7);
    }
    return ret;
}
 
QString Headers::authorizationBasic() const
{
    return QString::fromLatin1(decodeBasicAuth(authorization()));
}
 
Headers::Authorization Headers::authorizationBasicObject() const
{
    return decodeBasicAuthPair(authorization());
}
 
QString Headers::setAuthorizationBasic(const QString &username, const QString &password)
{
    QString ret;
    if (username.contains(QLatin1Char(':'))) {
        qCWarning(CUTELYST_CORE) << "Headers::Basic authorization user name can't contain ':'";
        return ret;
    }
 
    const QString result = username + QLatin1Char(':') + password;
    ret = QLatin1String("Basic ") + QString::fromLatin1(result.toLatin1().toBase64());
    m_data.replace(QStringLiteral("AUTHORIZATION"), ret);
    return ret;
}
 
QString Headers::proxyAuthorization() const
{
    return m_data.value(QStringLiteral("PROXY_AUTHORIZATION"));
}
 
QString Headers::proxyAuthorizationBasic() const
{
    return QString::fromLatin1(decodeBasicAuth(proxyAuthorization()));
}
 
Headers::Authorization Headers::proxyAuthorizationBasicObject() const
{
    return decodeBasicAuthPair(proxyAuthorization());
}
 
QString Headers::header(const QString &field) const
{
    return m_data.value(normalizeHeaderKey(field));
}
 
QString Headers::header(const QString &field, const QString &defaultValue) const
{
    return m_data.value(normalizeHeaderKey(field), defaultValue);
}
 
void Headers::setHeader(const QString &field, const QString &value)
{
    m_data.replace(normalizeHeaderKey(field), value);
}
 
void Headers::setHeader(const QString &field, const QStringList &values)
{
    setHeader(field, values.join(QLatin1String(", ")));
}
 
void Headers::pushHeader(const QString &field, const QString &value)
{
    m_data.insert(normalizeHeaderKey(field), value);
}
 
void Headers::pushHeader(const QString &field, const QStringList &values)
{
    m_data.insert(normalizeHeaderKey(field), values.join(QLatin1String(", ")));
}
 
void Headers::removeHeader(const QString &field)
{
    m_data.remove(normalizeHeaderKey(field));
}
 
bool Headers::contains(const QString &field)
{
    return m_data.contains(normalizeHeaderKey(field));
}
 
QString Headers::operator[](const QString &key) const
{
    return m_data.value(normalizeHeaderKey(key));
}
 
QString normalizeHeaderKey(const QString &field)
{
    QString key = field;
    int i = 0;
    while (i < key.size()) {
        QChar c = key[i];
        if (c.isLetter()) {
            if (c.isLower()) {
                key[i] = c.toUpper();
            }
        } else if (c == QLatin1Char('-')) {
            key[i] = QLatin1Char('_');
        }
        ++i;
    }
    return key;
}
 
QByteArray decodeBasicAuth(const QString &auth)
{
    QByteArray ret;
    if (!auth.isEmpty() && auth.startsWith(QLatin1String("Basic "))) {
        int pos = auth.lastIndexOf(QLatin1Char(' '));
        if (pos != -1) {
            ret = QByteArray::fromBase64(auth.mid(pos).toLatin1());
        }
    }
    return ret;
}
 
Headers::Authorization decodeBasicAuthPair(const QString &auth)
{
    Headers::Authorization ret;
    const QByteArray authorization = decodeBasicAuth(auth);
    if (!authorization.isEmpty()) {
        int pos = authorization.indexOf(':');
        if (pos == -1) {
            ret.user = QString::fromLatin1(authorization);
        } else {
            ret.user = QString::fromLatin1(authorization.left(pos));
            ret.password = QString::fromLatin1(authorization.mid(pos + 1));
        }
    }
    return ret;
}
 
QDebug operator<<(QDebug debug, const Headers &headers)
{
    const QMultiHash<QString, QString> data = headers.data();
    const bool oldSetting = debug.autoInsertSpaces();
    debug.nospace() << "Headers[";
    for (auto it = data.constBegin();
         it != data.constEnd(); ++it) {
        debug << '(' << Engine::camelCaseHeader(it.key()) + QLatin1Char('=') + it.value() << ')';
    }
    debug << ']';
    debug.setAutoInsertSpaces(oldSetting);
    return debug.maybeSpace();
}