request.h

/*
 * SPDX-FileCopyrightText: (C) 2013-2022 Daniel Nicoletti <dantti12@gmail.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYST_REQUEST_H
#define CUTELYST_REQUEST_H
 
#include <QtCore/qobject.h>
#include <QtCore/qstringlist.h>
 
#include <Cutelyst/cutelyst_global.h>
#include <Cutelyst/paramsmultimap.h>
#include <Cutelyst/headers.h>
 
class QIODevice;
class QHostAddress;
 
namespace Cutelyst {
 
class Engine;
class Upload;
class Context;
 
typedef QVector<Upload *> Uploads;
 
class EngineRequest;
class RequestPrivate;
class CUTELYST_LIBRARY Request final : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString hostname READ hostname CONSTANT)
    Q_PROPERTY(quint16 port READ port CONSTANT)
    Q_PROPERTY(QUrl uri READ uri CONSTANT)
    Q_PROPERTY(QString base READ base CONSTANT)
    Q_PROPERTY(QString path READ path CONSTANT)
    Q_PROPERTY(QString match READ match CONSTANT)
    Q_PROPERTY(QStringList arguments READ arguments CONSTANT)
    Q_PROPERTY(QStringList args READ arguments CONSTANT)
    Q_PROPERTY(bool secure READ secure CONSTANT)
    Q_PROPERTY(QVariant bodyData READ bodyData CONSTANT)
    Q_PROPERTY(Cutelyst::ParamsMultiMap bodyParams READ bodyParameters CONSTANT)
    Q_PROPERTY(Cutelyst::ParamsMultiMap queryParams READ queryParameters CONSTANT)
    Q_PROPERTY(QString contentEncoding READ contentEncoding CONSTANT)
    Q_PROPERTY(QString contentType READ contentType CONSTANT)
    Q_PROPERTY(QString method READ method CONSTANT)
    Q_PROPERTY(QString protocol READ protocol CONSTANT)
    Q_PROPERTY(QString userAgent READ userAgent CONSTANT)
    Q_PROPERTY(QString referer READ referer CONSTANT)
    Q_PROPERTY(QString remoteUser READ remoteUser CONSTANT)
public:
    virtual ~Request();
 
    QHostAddress address() const noexcept;
 
    QString addressString() const;
 
    QString hostname() const;
 
    quint16 port() const;
 
    QUrl uri() const;
 
    QString base() const;
 
    QString path() const noexcept;
 
    QString match() const noexcept;
 
    void setMatch(const QString &match);
 
    QStringList arguments() const noexcept;
 
    void setArguments(const QStringList &arguments);
 
    inline QStringList args() const;
 
    QStringList captures() const noexcept;
 
    void setCaptures(const QStringList &captures);
 
    bool secure() const noexcept;
 
    QIODevice *body() const;
 
    QVariant bodyData() const;
 
    QJsonDocument bodyJsonDocument() const;
 
    QJsonObject bodyJsonObject() const;
 
    QJsonArray bodyJsonArray() const;
 
    QVariantMap bodyParametersVariant() const;
 
    ParamsMultiMap bodyParameters() const;
 
    inline QString bodyParameter(const QString &key, const QString &defaultValue = {}) const;
 
    QStringList bodyParameters(const QString &key) const;
 
    inline ParamsMultiMap bodyParams() const;
 
    inline QString bodyParam(const QString &key, const QString &defaultValue = {}) const;
 
    inline QStringList bodyParams(const QString &key) const;
 
    QString queryKeywords() const;
 
    QVariantMap queryParametersVariant() const;
 
    ParamsMultiMap queryParameters() const;
 
    inline QString queryParameter(const QString &key, const QString &defaultValue = {}) const;
 
    QStringList queryParameters(const QString &key) const;
 
    inline ParamsMultiMap queryParams() const;
 
    inline QString queryParam(const QString &key, const QString &defaultValue = {}) const;
 
    inline QStringList queryParams(const QString &key) const;
 
    inline QString contentEncoding() const;
 
    inline QString contentType() const;
 
    QString cookie(const QString &name) const;
 
    QStringList cookies(const QString &name) const;
 
    ParamsMultiMap cookies() const;
 
    inline QString header(const QString &key) const;
 
    Headers headers() const noexcept;
 
    QString method() const noexcept;
 
    bool isPost() const noexcept;
 
    bool isGet() const noexcept;
 
    bool isHead() const noexcept;
 
    bool isPut() const noexcept;
 
    bool isPatch() const noexcept;
 
    bool isDelete() const noexcept;
 
    QString protocol() const noexcept;
 
    bool xhr() const noexcept;
 
    inline QString userAgent() const;
 
    inline QString referer() const;
 
    QString remoteUser() const noexcept;
 
    QVector<Upload *> uploads() const;
 
    QMultiMap<QString, Upload *> uploadsMap() const;
 
    Uploads uploads(const QString &name) const;
 
    inline Upload *upload(const QString &name) const;
 
    ParamsMultiMap mangleParams(const ParamsMultiMap &args, bool append = false) const;
 
    QUrl uriWith(const ParamsMultiMap &args, bool append = false) const;
 
    Engine *engine() const noexcept;
 
    Request(EngineRequest *engineRequest);
 
Q_SIGNALS:
    void webSocketTextFrame(const QString &message, bool isLastFrame, Cutelyst::Context *c);
 
    void webSocketTextMessage(const QString &message, Cutelyst::Context *c);
 
    void webSocketBinaryFrame(const QByteArray &message, bool isLastFrame, Cutelyst::Context *c);
 
    void webSocketBinaryMessage(const QByteArray &message, Cutelyst::Context *c);
 
    void webSocketPong(const QByteArray &payload, Cutelyst::Context *c);
 
    void webSocketClosed(quint16 closeCode, const QString &reason);
 
protected:
    RequestPrivate *d_ptr;
 
private:
    friend class Application;
    friend class Dispatcher;
    friend class DispatchType;
    friend class Context;
    Q_DECLARE_PRIVATE(Request)
};
 
inline QStringList Request::args() const
{ return arguments(); }
 
inline QString Request::bodyParameter(const QString &key, const QString &defaultValue) const
{ return bodyParameters().value(key, defaultValue); }
 
inline ParamsMultiMap Request::bodyParams() const
{ return bodyParameters(); }
 
inline QString Request::bodyParam(const QString &key, const QString &defaultValue) const
{ return bodyParameters().value(key, defaultValue); }
 
inline QStringList Request::bodyParams(const QString &key) const
{ return bodyParameters(key); }
 
inline QString Request::queryParameter(const QString &key, const QString &defaultValue) const
{ return queryParameters().value(key, defaultValue); }
 
inline ParamsMultiMap Request::queryParams() const
{ return queryParameters(); }
 
inline QString Request::queryParam(const QString &key, const QString &defaultValue) const
{ return queryParameters().value(key, defaultValue); }
 
inline QStringList Request::queryParams(const QString &key) const
{ return queryParameters(key); }
 
inline QString Request::contentEncoding() const
{ return headers().contentEncoding(); }
 
inline QString Request::contentType() const
{ return headers().contentType(); }
 
inline QString Request::header(const QString &key) const
{ return headers().header(key); }
 
inline QString Request::userAgent() const
{ return headers().userAgent(); }
 
inline QString Request::referer() const
{ return headers().referer(); }
 
inline Upload *Request::upload(const QString &name) const
{ return uploadsMap().value(name); }
 
}
 
#endif // CUTELYST_REQUEST_H