storage.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_CLOUD_STORAGE_H
#define BACKENDS_CLOUD_STORAGE_H

#include "backends/cloud/storagefile.h"
#include "backends/cloud/storageinfo.h"
#include "backends/networking/curl/request.h"
#include "backends/networking/curl/curlrequest.h"
#include "common/array.h"
#include "common/callback.h"
#include "common/mutex.h"
#include "common/path.h"
#include "common/stream.h"
#include "common/str.h"

namespace GUI {

class CommandReceiver;

}

namespace Cloud {

class SavesSyncRequest;
class FolderDownloadRequest;

class Storage {
public:
    typedef Networking::Response<const Common::Array<StorageFile> &> FileArrayResponse;
    typedef Networking::Response<const StorageInfo &> StorageInfoResponse;
    typedef Networking::Response<bool> BoolResponse;
    typedef Networking::Response<const StorageFile &> UploadResponse;
    typedef Networking::Response<const Common::Array<StorageFile> &> ListDirectoryResponse;

    typedef Common::BaseCallback<const FileArrayResponse &> *FileArrayCallback;
    typedef Common::BaseCallback<const StorageInfoResponse &> *StorageInfoCallback;
    typedef Common::BaseCallback<const BoolResponse &> *BoolCallback;
    typedef Common::BaseCallback<const UploadResponse &> *UploadCallback;
    typedef Common::BaseCallback<const ListDirectoryResponse &> *ListDirectoryCallback;

protected:
    uint32 _runningRequestsCount;
    Common::Mutex _runningRequestsMutex;

    SavesSyncRequest *_savesSyncRequest;
    bool _syncRestartRequestsed;

    FolderDownloadRequest *_downloadFolderRequest;

    bool _isEnabled;

    virtual Networking::ErrorCallback getErrorPrintingCallback();

    virtual void printErrorResponse(const Networking::ErrorResponse &error);

    virtual Networking::Request *addRequest(Networking::Request *request);

    virtual void requestFinishedCallback(Networking::Request *invalidRequestPointer);

public:
    Storage();
    virtual ~Storage();

    virtual void saveConfig(const Common::String  &keyPrefix) = 0;

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

    bool isEnabled() const;

    void enable();

    virtual Networking::Request *listDirectory(const Common::String &path, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback, bool recursive = false) = 0;

    virtual Networking::Request *upload(const Common::String &path, Common::SeekableReadStream *contents, UploadCallback callback, Networking::ErrorCallback errorCallback) = 0;
    virtual Networking::Request *upload(const Common::String &remotePath, const Common::Path &localPath, UploadCallback callback, Networking::ErrorCallback errorCallback);

    virtual bool uploadStreamSupported();

    virtual Networking::Request *streamFile(const Common::String &path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback);
    virtual Networking::Request *streamFileById(const Common::String &id, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback) = 0;

    virtual Networking::Request *download(const Common::String &remotePath, const Common::Path &localPath, BoolCallback callback, Networking::ErrorCallback errorCallback);
    virtual Networking::Request *downloadById(const Common::String &remoteId, const Common::Path &localPath, BoolCallback callback, Networking::ErrorCallback errorCallback);

    virtual Networking::Request *downloadFolder(const Common::String &remotePath, const Common::Path &localPath, FileArrayCallback callback, Networking::ErrorCallback errorCallback, bool recursive = false);

    virtual SavesSyncRequest *syncSaves(BoolCallback callback, Networking::ErrorCallback errorCallback);

    virtual Networking::Request *createDirectory(const Common::String &path, BoolCallback callback, Networking::ErrorCallback errorCallback) = 0;

    virtual Networking::Request *info(StorageInfoCallback callback, Networking::ErrorCallback errorCallback) = 0;

    virtual Common::String savesDirectoryPath() = 0;

    virtual bool isWorking();


    virtual bool isSyncing();

    virtual double getSyncDownloadingProgress();

    struct SyncDownloadingInfo {
        uint64 bytesDownloaded = 0, bytesToDownload = 0;
        uint64 filesDownloaded = 0, filesToDownload = 0;
        bool inProgress = false;
    };

    virtual void getSyncDownloadingInfo(SyncDownloadingInfo &info);

    virtual double getSyncProgress();

    virtual Common::Array<Common::String> getSyncingFiles();

    virtual void cancelSync();

protected:
    virtual void savesSyncDefaultCallback(const BoolResponse &response);

    virtual void savesSyncDefaultErrorCallback(const Networking::ErrorResponse &error);

public:

    virtual bool startDownload(const Common::String &remotePath, const Common::Path &localPath);

    virtual void cancelDownload();

    virtual void setDownloadTarget(GUI::CommandReceiver *target);

    virtual bool isDownloading();

    virtual double getDownloadingProgress();

    virtual uint64 getDownloadBytesNumber();

    virtual uint64 getDownloadTotalBytesNumber();

    virtual uint64 getDownloadSpeed();

    virtual Common::String getDownloadRemoteDirectory();

    virtual Common::Path getDownloadLocalDirectory();

protected:
    virtual void directoryDownloadedCallback(const FileArrayResponse &response);

    virtual void directoryDownloadedErrorCallback(const Networking::ErrorResponse &error);
};

} // End of namespace Cloud

#endif