networkreadstream.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_HTTP_NETWORKREADSTREAM_H
#define BACKENDS_NETWORKING_HTTP_NETWORKREADSTREAM_H

#include "common/array.h"
#include "common/hash-str.h"
#include "common/hashmap.h"
#include "common/memstream.h"
#include "common/path.h"
#include "common/str.h"
#include "common/stream.h"

namespace Networking {
typedef Common::Array<Common::String> RequestHeaders;

// Simple interface for platform-specific NetworkReadStream implementations
class NetworkReadStream : public Common::ReadStream {
protected:
    Common::MemoryReadWriteStream _backingStream;
    bool _keepAlive;
    long _keepAliveIdle, _keepAliveInterval;
    bool _eos, _requestComplete;
    const byte *_sendingContentsBuffer;
    uint32 _sendingContentsSize;
    uint32 _sendingContentsPos;
    Common::String _responseHeaders;
    uint64 _progressDownloaded, _progressTotal;

    virtual void resetStream() = 0;

    virtual void setupBufferContents(const byte *buffer, uint32 bufferSize, bool uploading, bool usingPatch, bool post) = 0;
    virtual void setupFormMultipart(const Common::HashMap<Common::String, Common::String> &formFields, const Common::HashMap<Common::String, Common::Path> &formFiles) = 0;

    uint32 fillWithSendingContents(char *bufferToFill, uint32 maxSize);

    uint32 addResponseHeaders(char *buffer, uint32 bufferSize);

    NetworkReadStream(bool keepAlive, long keepAliveIdle, long keepAliveInterval)
        : _backingStream(DisposeAfterUse::YES), _eos(false), _requestComplete(false), _sendingContentsBuffer(nullptr),
          _sendingContentsSize(0), _sendingContentsPos(0), _progressDownloaded(0), _progressTotal(0),
          _keepAlive(keepAlive), _keepAliveIdle(keepAliveIdle), _keepAliveInterval(keepAliveInterval) {
    }

public:
    /* Implementation-defined Constructors */

    static NetworkReadStream *make(const char *url, RequestHeaders *headersList, const Common::String &postFields,
            bool uploading = false, bool usingPatch = false,
            bool keepAlive = false, long keepAliveIdle = 120, long keepAliveInterval = 60);

    static NetworkReadStream *make(const char *url, RequestHeaders *headersList,
            const Common::HashMap<Common::String, Common::String> &formFields, const Common::HashMap<Common::String, Common::Path> &formFiles,
            bool keepAlive = false, long keepAliveIdle = 120, long keepAliveInterval = 60);

    static NetworkReadStream *make(const char *url, RequestHeaders *headersList, const byte *buffer, uint32 bufferSize,
            bool uploading = false, bool usingPatch = false, bool post = true,
            bool keepAlive = false, long keepAliveIdle = 120, long keepAliveInterval = 60);

    virtual bool reuse(const char *url, RequestHeaders *headersList, const Common::String &postFields, bool uploading = false, bool usingPatch = false) = 0;
    virtual bool reuse(
        const char *url, RequestHeaders *headersList,
        const Common::HashMap<Common::String, Common::String> &formFields,
        const Common::HashMap<Common::String, Common::Path> &formFiles) = 0;
    virtual bool reuse(const char *url, RequestHeaders *headersList, const byte *buffer, uint32 bufferSize, bool uploading = false, bool usingPatch = false, bool post = true) = 0;
    bool eos() const override { return _eos; }

    uint32 read(void *dataPtr, uint32 dataSize) override;

    virtual long httpResponseCode() const = 0;

    virtual Common::String currentLocation() const = 0;

    Common::String responseHeaders() const {
        return _responseHeaders;
    }

    virtual Common::HashMap<Common::String, Common::String> responseHeadersMap() const = 0;

    double getProgress() const;

    void setProgress(uint64 downloaded, uint64 total);

    bool keepAlive() const { return _keepAlive; }

    virtual bool hasError() const = 0;
    virtual const char *getError() const = 0;
};

} // End of namespace Networking

#endif