qhttpresponse.h

/*
 * Copyright 2011 Nikhil Marathe <nsm.nikhil@gmail.com>
 *
 * 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 Q_HTTP_RESPONSE
#define Q_HTTP_RESPONSE

#include <QObject>
#include <QHash>

//
class QTcpSocket;

class QHttpConnection;

typedef QHash<QString, QString> HeaderHash;

/*!
 * The QHttpResponse class handles sending
 * data back to the client in response to a request.
 *
 * The way to respond is to:
 * <ol>
 * <li>Set headers (optional).</li>
 * <li>Call writeHead() with the HTTP status code.</li>
 * <li>Call write() zero or more times.</li>
 * <li>Call end() when you are ready to end the request.</li>
 * </ol>
 *
 */
class QHttpResponse : public QObject
{
	Q_OBJECT

public:
	enum StatusCode {
	  STATUS_CONTINUE = 100,
	  STATUS_SWITCH_PROTOCOLS = 101,
	  STATUS_OK = 200,
	  STATUS_CREATED = 201,
	  STATUS_ACCEPTED = 202,
	  STATUS_NON_AUTHORITATIVE_INFORMATION = 203,
	  STATUS_NO_CONTENT = 204,
	  STATUS_RESET_CONTENT = 205,
	  STATUS_PARTIAL_CONTENT = 206,
	  STATUS_MULTIPLE_CHOICES = 300,
	  STATUS_MOVED_PERMANENTLY = 301,
	  STATUS_FOUND = 302,
	  STATUS_SEE_OTHER = 303,
	  STATUS_NOT_MODIFIED = 304,
	  STATUS_USE_PROXY = 305,
	  STATUS_TEMPORARY_REDIRECT = 307,
	  STATUS_BAD_REQUEST = 400,
	  STATUS_UNAUTHORIZED = 401,
	  STATUS_PAYMENT_REQUIRED = 402,
	  STATUS_FORBIDDEN = 403,
	  STATUS_NOT_FOUND = 404,
	  STATUS_METHOD_NOT_ALLOWED = 405,
	  STATUS_NOT_ACCEPTABLE = 406,
	  STATUS_PROXY_AUTHENTICATION_REQUIRED = 407,
	  STATUS_REQUEST_TIMEOUT = 408,
	  STATUS_CONFLICT = 409,
	  STATUS_GONE = 410,
	  STATUS_LENGTH_REQUIRED = 411,
	  STATUS_PRECONDITION_FAILED = 412,
	  STATUS_REQUEST_ENTITY_TOO_LARGE = 413,
	  STATUS_REQUEST_URI_TOO_LONG = 414,
	  STATUS_REQUEST_UNSUPPORTED_MEDIA_TYPE = 415,
	  STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
	  STATUS_EXPECTATION_FAILED = 417,
	  STATUS_INTERNAL_SERVER_ERROR = 500,
	  STATUS_NOT_IMPLEMENTED = 501,
	  STATUS_BAD_GATEWAY = 502,
	  STATUS_SERVICE_UNAVAILABLE = 503,
	  STATUS_GATEWAY_TIMEOUT = 504,
	  STATUS_HTTP_VERSION_NOT_SUPPORTED = 505
	};

	virtual ~QHttpResponse();

public slots:
	/*!
	 * Write the header of the response
	 * using @c status as the response status
	 * code. Any headers should be set before this
	 * is called.
	 */
	void writeHead(int status);

	/*!
	 * Write the block of data to the client.
	 *
	 * \note
	 * writeHead() has to be called before write(), otherwise the call will
	 * fail.
	 */
	void write(const QByteArray &data);

	/*!
	 * Write a QString instead of a QByteArray.
	 * \see write(const QByteArray &);
	 */
	void write(const QString &data);

	/*!
	 * End the response. Data will be flushed
	 * to the underlying socket and the connection
	 * itself will be closed if this is the last
	 * response.
	 *
	 * This will emit done() and queue this object
	 * for deletion. For details see \ref memorymanagement
	 */
	void end(const QString &data=QString());

	/*!
	 * Set a response header @c field to @c value
	 */
	void setHeader(const QString &field, const QString &value);

signals:
	/*!
	 * Emitted once the response is finished.
	 * You should NOT interact with this object
	 * after done() has been emitted as the object
	 * is scheduled for deletion at any time.
	 */
	void done();

private:
	QHttpResponse(QHttpConnection *connection);

	void writeHeaders();
	void writeHeader(const char *field, const QString &value);

	QHttpConnection *m_connection;

	bool m_headerWritten;
	HeaderHash m_headers;
	friend class QHttpConnection;

	bool m_sentConnectionHeader;
	bool m_sentContentLengthHeader;
	bool m_sentTransferEncodingHeader;
	bool m_sentDate;
	bool m_keepAlive;
	bool m_last;
	bool m_useChunkedEncoding;
	bool m_finished;

private slots:
	void connectionClosed();

};

#endif