websocket.h

/*
  Copyright (c) 2012 Vinícius dos Santos Oliveira

  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 TUFAO_WEBSOCKET_H
#define TUFAO_WEBSOCKET_H

#include "abstractmessagesocket.h"
#include "headers.h"

#include <QtNetwork/QAbstractSocket>

#if defined(NO_ERROR) && defined(_WIN32)
# define TUFAO_WINERROR_WORKAROUND
# undef NO_ERROR
#endif

class QSslError;

namespace Tufao {

class HttpServerRequest;

enum class WebSocketError
{
    NO_ERROR = 0,
    CONNECTION_REFUSED,
    REMOTE_HOST_CLOSED,
    HOST_NOT_FOUND,
    ACCESS_ERROR,
    OUT_OF_RESOURCES,
    SOCKET_TIMEOUT,
    NETWORK_ERROR,
    UNSUPPORTED_SOCKET_OPERATION,
    PROXY_AUTHENTICATION_REQUIRED,
    SSL_HANDSHAKE_FAILED,
    PROXY_CONNECTION_REFUSED,
    PROXY_CONNECTION_CLOSED,
    PROXY_CONNECTION_TIMEOUT,
    PROXY_NOT_FOUND,
    PROXY_PROTOCOL_ERROR,
    WEBSOCKET_HANDSHAKE_FAILED,
    WEBSOCKET_PROTOCOL_ERROR,
    UNKNOWN_ERROR
};

enum class WebSocketMessageType
{
    TEXT_MESSAGE,
    BINARY_MESSAGE
};

class TUFAO_EXPORT WebSocket : public AbstractMessageSocket
{
    Q_OBJECT
public:
    explicit WebSocket(QObject *parent = 0);

    ~WebSocket();

    bool connectToHost(const QHostAddress &address, quint16 port,
                       const QByteArray &resource,
                       const Headers &headers = Headers());

    bool connectToHost(const QHostAddress &address, const QByteArray &resource,
                       const Headers &headers = Headers());

    bool connectToHost(const QString &hostname, quint16 port,
                       const QByteArray &resource,
                       const Headers &headers = Headers());

    bool connectToHost(const QString &hostname, const QByteArray &resource,
                       const Headers &headers = Headers());

    bool connectToHostEncrypted(const QString &hostname, quint16 port,
                                const QByteArray &resource,
                                const Headers &headers,
                                const QList<QSslError> &ignoredSslErrors);

    bool connectToHostEncrypted(const QString &hostname, quint16 port,
                                const QByteArray &resource,
                                const Headers &headers = Headers());

    bool connectToHostEncrypted(const QString &hostname,
                                const QByteArray &resource,
                                const Headers &headers = Headers());

    bool connectToHostEncrypted(const QHostAddress &address, quint16 port,
                                const QByteArray &resource,
                                const Headers &headers = Headers());

    bool connectToHostEncrypted(const QHostAddress &address,
                                const QByteArray &resource,
                                const Headers &headers = Headers());

    bool startServerHandshake(const HttpServerRequest &request,
                              const QByteArray &head,
                              const Headers &headers = Headers());

    bool startServerHandshake(HttpServerRequest &request,
                              const Headers &headers = Headers());

    void setMessagesType(WebSocketMessageType type);

    WebSocketMessageType messagesType() const;

    WebSocketError error() const;

    QString errorString() const;

    QHostAddress peerAddress() const;

    quint16 peerPort() const;

    static QList<QByteArray> supportedProtocols(const Headers &headers);

signals:
    void pong(QByteArray data);

public slots:
    void close() override;
    bool sendMessage(const QByteArray &msg) override;

    bool sendBinaryMessage(const QByteArray &msg);

    bool sendUtf8Message(const QByteArray &msg);

    bool ping(const QByteArray &data);

private slots:
    void onSocketError(QAbstractSocket::SocketError error);
    void onSslErrors(const QList<QSslError> &errors);
    void onConnected();
    void onReadyRead();
    void onDisconnected();

private:
    void connectToHost(QAbstractSocket *socket, const QByteArray &resource,
                       const Headers &headers = Headers());

    bool isResponseOkay();
    void onClientHandshakeError();

    void close(quint16 code);

    void readData(const QByteArray &data);
    void parseBuffer();
    bool parseFrame();
    bool parseSize16();
    bool parseSize64();
    bool parseMaskingKey();
    bool parsePayloadData();

    void decodeFragment(QByteArray &fragment);
    void evaluateControlFrame();

    struct Priv;
    Priv *priv;
};

} // namespace Tufao

#if defined(TUFAO_WINERROR_WORKAROUND)
# define NO_ERROR 0L
# undef TUFAO_WINERROR_WORKAROUND
#endif

#endif // TUFAO_WEBSOCKET_H