socket.h

/*
 * Copyright (c) 2017 Nathan Osman
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
 
#ifndef QHTTPENGINE_SOCKET_H
#define QHTTPENGINE_SOCKET_H
 
#include <QHostAddress>
#include <QIODevice>
#include <QMultiMap>
 
#include <qhttpengine/ibytearray.h>
 
#include "qhttpengine_export.h"
 
class QJsonDocument;
class QTcpSocket;
 
namespace QHttpEngine
{
 
class QHTTPENGINE_EXPORT SocketPrivate;

class QHTTPENGINE_EXPORT Socket : public QIODevice
{
    Q_OBJECT
 
public:

    typedef QMultiMap<QString, QString> QueryStringMap;

    typedef QMultiMap<IByteArray, QByteArray> HeaderMap;

    enum Method {
        OPTIONS = 1,
        GET = 1 << 1,
        HEAD = 1 << 2,
        POST = 1 << 3,
        PUT = 1 << 4,
        DELETE = 1 << 5,
        TRACE = 1 << 6,
        CONNECT = 1 << 7
    };

    enum {
        OK = 200,
        Created = 201,
        Accepted = 202,
        PartialContent = 206,
        MovedPermanently = 301,
        Found = 302,
        BadRequest = 400,
        Unauthorized = 401,
        Forbidden = 403,
        NotFound = 404,
        MethodNotAllowed = 405,
        Conflict = 409,
        InternalServerError = 500,
        BadGateway = 502,
        ServiceUnavailable = 503,
        HttpVersionNotSupported = 505
    };

    Socket(QTcpSocket *socket, QObject *parent = 0);

    virtual qint64 bytesAvailable() const;

    virtual bool isSequential() const;

    virtual void close();

    QHostAddress peerAddress() const;

    bool isHeadersParsed() const;

    Method method() const;

    QByteArray rawPath() const;

    QString path() const;

    QueryStringMap queryString() const;

    HeaderMap headers() const;

    qint64 contentLength() const;

    bool readJson(QJsonDocument &document);

    void setStatusCode(int statusCode, const QByteArray &statusReason = QByteArray());

    void setHeader(const QByteArray &name, const QByteArray &value, bool replace = true);

    void setHeaders(const HeaderMap &headers);

    void writeHeaders();

    void writeRedirect(const QByteArray &path, bool permanent = false);

    void writeError(int statusCode, const QByteArray &statusReason = QByteArray());

    void writeJson(const QJsonDocument &document, int statusCode = OK);
 
Q_SIGNALS:

    void headersParsed();

    void disconnected();
 
protected:

    virtual qint64 readData(char *data, qint64 maxlen);

    virtual qint64 writeData(const char *data, qint64 len);
 
private:
 
    SocketPrivate *const d;
    friend class SocketPrivate;
};
 
}
 
#endif // QHTTPENGINE_SOCKET_H