qhttprequest.h

Go to the documentation of this file.

#ifndef QHTTPREQUEST_H
#define QHTTPREQUEST_H

/***************************************************************************
 * This file is part of the TTK Music Player project
 * Copyright (C) 2015 - 2024 Greedysky Studio

 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.

 * This program 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 General Public License for more details.

 * You should have received a copy of the GNU General Public License along
 * with this program; If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

#include <QUrl>
#include <QMetaEnum>
#include <QMetaType>
#include "qhttpserverfwd.h"

class QHttpRequestPrivate;

class TTK_MODULE_EXPORT QHttpRequest : public QObject
{
    Q_OBJECT
    Q_PROPERTY(HeaderHash headers READ headers)
    Q_PROPERTY(QString remoteAddress READ remoteAddress)
    Q_PROPERTY(quint16 remotePort READ remotePort)
    Q_PROPERTY(QString method READ method)
    Q_PROPERTY(QUrl url READ url)
    Q_PROPERTY(QString path READ path)
    Q_PROPERTY(QString httpVersion READ httpVersion)

    Q_ENUMS(HttpMethod)

    friend class QHttpConnection;
    friend class QHttpConnectionPrivate;

public:

    enum HttpMethod {
        HTTP_DELETE = 0,
        HTTP_GET,
        HTTP_HEAD,
        HTTP_POST,
        HTTP_PUT,
        // pathological
        HTTP_CONNECT,
        HTTP_OPTIONS,
        HTTP_TRACE,
        // webdav
        HTTP_COPY,
        HTTP_LOCK,
        HTTP_MKCOL,
        HTTP_MOVE,
        HTTP_PROPFIND,
        HTTP_PROPPATCH,
        HTTP_SEARCH,
        HTTP_UNLOCK,
        // subversion
        HTTP_REPORT,
        HTTP_MKACTIVITY,
        HTTP_CHECKOUT,
        HTTP_MERGE,
        // upnp
        HTTP_MSEARCH,
        HTTP_NOTIFY,
        HTTP_SUBSCRIBE,
        HTTP_UNSUBSCRIBE,
        // RFC-5789
        HTTP_PATCH,
        HTTP_PURGE
    };

    HttpMethod method() const;


    const QString methodString() const;


    const QUrl &url() const;


    const QString path() const;


    const QString &httpVersion() const;


    const HeaderHash &headers() const;


    QString header(const QString &field);

    const QString &remoteAddress() const;

    quint16 remotePort() const;


    const QByteArray &body() const;


    bool successful() const;


    void storeBody();

Q_SIGNALS:

    void data(const QByteArray &data);


    void end();

private Q_SLOTS:
    void appendBody(const QByteArray &body);

private:
    explicit QHttpRequest(QHttpConnection *connection, QObject *parent = nullptr);

    static QString MethodToString(HttpMethod method);
    void setMethod(HttpMethod method);
    void setVersion(const QString &version);
    void setUrl(const QUrl &url);
    void setHeaders(const HeaderHash headers);
    void setSuccessful(bool success);
    void setRemoteAddress(const QString &address);
    void setRemotePort(quint16 port);

private:
    TTK_DECLARE_PRIVATE(QHttpRequest)

};

#endif