/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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/>.
 *
 */

#ifndef BACKENDS_NETWORKING_HTTP_HTTPREQUEST_H
#define BACKENDS_NETWORKING_HTTP_HTTPREQUEST_H

#include "backends/networking/http/request.h"
#include "common/path.h"
#include "common/str.h"
#include "common/array.h"
#include "common/list.h"
#include "common/hashmap.h"
#include "common/hash-str.h"

namespace Networking {

typedef Common::Array<Common::String> RequestHeaders;

class NetworkReadStream;

typedef Response<NetworkReadStream *> NetworkReadStreamResponse;
typedef Common::BaseCallback<const NetworkReadStreamResponse &> *NetworkReadStreamCallback;

class HttpRequest: public Request {
protected:
	Common::String _url;
	NetworkReadStream *_stream;
	RequestHeaders _headersList;
	Common::String _postFields;
	Common::HashMap<Common::String, Common::String> _formFields;
	Common::HashMap<Common::String, Common::Path> _formFiles;
	byte *_bytesBuffer;
	uint32 _bytesBufferSize;
	bool _uploading; //using PUT method
	bool _usingPatch; //using PATCH method
	bool _keepAlive;
	long _keepAliveIdle, _keepAliveInterval;

	NetworkReadStream *makeStream();

public:
	HttpRequest(DataCallback cb, ErrorCallback ecb, const Common::String &url);
	~HttpRequest() override;

	void handle() override;
	void restart() override;
	Common::String date() const override;

	/** Replaces all headers with the passed array of headers. */
	virtual void setHeaders(const Common::Array<Common::String> &headers);

	/** Adds a header into headers list. */
	virtual void addHeader(const Common::String &header);

	/** Adds a post field (key=value pair). */
	virtual void addPostField(const Common::String &field);

	/** Adds a form/multipart field (name, value). */
	virtual void addFormField(const Common::String &name, const Common::String &value);

	/** Adds a form/multipart file (field name, file name). */
	virtual void addFormFile(const Common::String &name, const Common::Path &filename);

	/** Sets bytes buffer. */
	virtual void setBuffer(byte *buffer, uint32 size);

	/** Remembers to use PUT method when it would create NetworkReadStream. */
	virtual void usePut();

	/** Remembers to use PATCH method when it would create NetworkReadStream. */
	virtual void usePatch();

	/** Remembers to use Connection: keep-alive or close. */
	virtual void connectionKeepAlive(long idle = 120, long interval = 60);
	virtual void connectionClose();

	/**
	 * Starts this Request with ConnMan.
	 * @return its NetworkReadStream in NetworkReadStreamResponse.
	 */
	virtual NetworkReadStreamResponse execute();

	/** Returns Request's NetworkReadStream. */
	const NetworkReadStream *getNetworkReadStream() const;

	/** Waits for Request to be processed. Should be called after Request is put into ConnMan. */
	void wait(int spinlockDelay = 5);
};

} // End of namespace Networking

#endif