httpserverresponse.h

/*
  Copyright (c) 2012, 2013 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_HTTPSERVERRESPONSE_H
#define TUFAO_HTTPSERVERRESPONSE_H

#include <QtCore/QObject>
#include "tufao_global.h"

class QIODevice;

namespace Tufao {

struct Headers;

enum class HttpResponseStatus
{
    // 1xx Informational
    CONTINUE                        = 100,
    SWITCHING_PROTOCOLS             = 101,
    PROCESSING                      = 102,
    CHECKPOINT                      = 103,
    // 2xx Successful
    OK                              = 200,
    CREATED                         = 201,
    ACCEPTED                        = 202,
    NON_AUTHORITATIVE_INFORMATION   = 203,
    NO_CONTENT                      = 204,
    RESET_CONTENT                   = 205,
    PARTIAL_CONTENT                 = 206,
    MULTI_STATUS                    = 207,
    ALREADY_REPORTED                = 208,
    IM_USED                         = 226,
    // 3xx Redirection
    MULTIPLE_CHOICES                = 300,
    MOVED_PERMANENTLY               = 301,
    FOUND                           = 302,
    SEE_OTHER                       = 303,
    NOT_MODIFIED                    = 304,
    USE_PROXY                       = 305,
    SWITCH_PROXY                    = 306,
    TEMPORARY_REDIRECT              = 307,
    RESUME_INCOMPLETE               = 308,
    // 4xx Client Error
    BAD_REQUEST                     = 400,
    UNAUTHORIZED                    = 401,
    PAYMENT_REQUIRED                = 402,
    FORBIDDEN                       = 403,
    NOT_FOUND                       = 404,
    METHOD_NOT_ALLOWED              = 405,
    NOT_ACCEPTABLE                  = 406,
    PROXY_AUTHENTICATION_REQUIRED   = 407,
    REQUEST_TIMEOUT                 = 408,
    CONFLICT                        = 409,
    GONE                            = 410,
    LENGTH_REQUIRED                 = 411,
    PRECONDITION_FAILED             = 412,
    REQUEST_ENTITY_TOO_LARGE        = 413,
    REQUEST_URI_TOO_LONG            = 414,
    UNSUPPORTED_MEDIA_TYPE          = 415,
    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
    EXPECTATION_FAILED              = 417,
    I_AM_A_TEAPOT                   = 418,
    UNPROCESSABLE_ENTITY            = 422,
    LOCKED                          = 423,
    FAILED_DEPENDENCY               = 424,
    UNORDERED_COLLECTION            = 425,
    UPGRADE_REQUIRED                = 426,
    PRECONDITION_REQUIRED           = 428,
    TOO_MANY_REQUESTS               = 429,
    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
    NO_RESPONSE                     = 444,
    RETRY_WITH                      = 449,
    CLIENT_CLOSED_REQUEST           = 499,
    // 5xx Internal Server Error
    INTERNAL_SERVER_ERROR           = 500,
    NOT_IMPLEMENTED                 = 501,
    BAD_GATEWAY                     = 502,
    SERVICE_UNAVAILABLE             = 503,
    GATEWAY_TIMEOUT                 = 504,
    HTTP_VERSION_NOT_SUPPORTED      = 505,
    VARIANT_ALSO_NEGOTIATES         = 506,
    INSUFFICIENT_STORAGE            = 507,
    LOOP_DETECTED                   = 508,
    BANDWIDTH_LIMIT_EXCEEDED        = 509,
    NOT_EXTENDED                    = 510
};

class TUFAO_EXPORT HttpServerResponse : public QObject
{
    Q_OBJECT
public:
    enum Option
    {
        HTTP_1_0           = 1,
        HTTP_1_1           = 1 << 1,
        KEEP_ALIVE         = 1 << 2
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    explicit HttpServerResponse(QIODevice &device,
                                Options options = Options(),
                                QObject *parent = 0);

    ~HttpServerResponse();

    Options options() const;

    bool setOptions(Options options);

    const Headers &headers() const;

    Headers &headers();

    bool flush();

signals:
    void finished();

public slots:
    bool writeContinue();

    bool writeHead(int statusCode, const QByteArray &reasonPhrase,
                   const Headers &headers);

    bool writeHead(int statusCode, const QByteArray &reasonPhrase);

    bool writeHead(HttpResponseStatus statusCode,
                   const QByteArray &reasonPhrase, const Headers &headers);

    bool writeHead(HttpResponseStatus statusCode,
                   const QByteArray &reasonPhrase);

    bool writeHead(HttpResponseStatus statusCode, const Headers &headers);

    bool writeHead(HttpResponseStatus statusCode);

    bool write(const QByteArray &chunk);

    bool addTrailers(const Headers &headers);

    bool addTrailer(const QByteArray &headerName,
                    const QByteArray &headerValue);

    bool end(const QByteArray &chunk = QByteArray());

private:
    struct Priv;
    Priv *priv;
};

inline HttpServerResponse &operator <<(HttpServerResponse &response,
                                       const QByteArray &chunk)
{
    response.write(chunk);
    return response;
}

} // namespace Tufao

#endif // TUFAO_HTTPSERVERRESPONSE_H