curlrequest.h

/* 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_CURL_CURLREQUEST_H
#define BACKENDS_NETWORKING_CURL_CURLREQUEST_H

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

struct curl_slist;

namespace Networking {

class NetworkReadStream;

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

class CurlRequest: public Request {
protected:
    Common::String _url;
    NetworkReadStream *_stream;
    curl_slist *_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:
    CurlRequest(DataCallback cb, ErrorCallback ecb, const Common::String &url);
    ~CurlRequest() override;

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

    virtual void setHeaders(const Common::Array<Common::String> &headers);

    virtual void addHeader(const Common::String &header);

    virtual void addPostField(const Common::String &field);

    virtual void addFormField(const Common::String &name, const Common::String &value);

    virtual void addFormFile(const Common::String &name, const Common::Path &filename);

    virtual void setBuffer(byte *buffer, uint32 size);

    virtual void usePut();

    virtual void usePatch();

    virtual void connectionKeepAlive(long idle = 120, long interval = 60);
    virtual void connectionClose();

    virtual NetworkReadStreamResponse execute();

    const NetworkReadStream *getNetworkReadStream() const;

    void wait(int spinlockDelay = 5);
};

} // End of namespace Networking

#endif