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_CURL_NETWORKREADSTREAM_H
#define BACKENDS_NETWORKING_CURL_NETWORKREADSTREAM_H

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

typedef void CURL;
struct curl_slist;

namespace Networking {

class NetworkReadStream : public Common::ReadStream {
    CURL *_easy;
    Common::MemoryReadWriteStream _backingStream;
    bool _keepAlive;
    long _keepAliveIdle, _keepAliveInterval;
    bool _eos, _requestComplete;
    char *_errorBuffer;
    uint32 _errorCode;
    const byte *_sendingContentsBuffer;
    uint32 _sendingContentsSize;
    uint32 _sendingContentsPos;
    byte *_bufferCopy; // To use with old curl version where CURLOPT_COPYPOSTFIELDS is not available
    Common::String _responseHeaders;
    uint64 _progressDownloaded, _progressTotal;

    void resetStream();
    void initCurl(const char *url, curl_slist *headersList);
    bool reuseCurl(const char *url, curl_slist *headersList);
    void setupBufferContents(const byte *buffer, uint32 bufferSize, bool uploading, bool usingPatch, bool post);
    void setupFormMultipart(const Common::HashMap<Common::String, Common::String> &formFields, const Common::HashMap<Common::String, Common::Path> &formFiles);

    uint32 fillWithSendingContents(char *bufferToFill, uint32 maxSize);

    uint32 addResponseHeaders(char *buffer, uint32 bufferSize);

    static size_t curlDataCallback(char *d, size_t n, size_t l, void *p);
    static size_t curlReadDataCallback(char *d, size_t n, size_t l, void *p);
    static size_t curlHeadersCallback(char *d, size_t n, size_t l, void *p);
    static int curlProgressCallbackOlder(void *p, double dltotal, double dlnow, double ultotal, double ulnow);
public:
    NetworkReadStream(const char *url, curl_slist *headersList, const Common::String &postFields, bool uploading = false, bool usingPatch = false, bool keepAlive = false, long keepAliveIdle = 120, long keepAliveInterval = 60);
    NetworkReadStream(
        const char *url, curl_slist *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);
    NetworkReadStream(const char *url, curl_slist *headersList, const byte *buffer, uint32 bufferSize, bool uploading = false, bool usingPatch = false, bool post = true, bool keepAlive = false, long keepAliveIdle = 120, long keepAliveInterval = 60);
    ~NetworkReadStream() override;

    bool reuse(const char *url, curl_slist *headersList, const Common::String &postFields, bool uploading = false, bool usingPatch = false);
    bool reuse(
        const char *url, curl_slist *headersList,
        const Common::HashMap<Common::String, Common::String> &formFields,
        const Common::HashMap<Common::String, Common::Path> &formFiles);
    bool reuse(const char *url, curl_slist *headersList, const byte *buffer, uint32 bufferSize, bool uploading = false, bool usingPatch = false, bool post = true);

    bool eos() const override;

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

    void finished(uint32 errorCode);

    long httpResponseCode() const;

    Common::String currentLocation() const;

    Common::String responseHeaders() const;

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

    double getProgress() const;

    void setProgress(uint64 downloaded, uint64 total);

    bool keepAlive() const { return _keepAlive; }

    bool hasError() const;
    uint32 getErrorCode() const { return _errorCode; }
    const char *getError() const;

};

} // End of namespace Networking

#endif