CLOUD: Add IdStorage

This is a special base class for Storages which are using ids instead of
paths in their APIs, like Box or Google Drive.

This commit makes Box derived from IdStorage.

6 files changed, 539 insertions, 0 deletions

diff --git a/backends/cloud/id/idlistdirectoryrequest.cpp b/backends/cloud/id/idlistdirectoryrequest.cpp
new file mode 100644
index 0000000000..012065dc77
--- /dev/null
+++ b/backends/cloud/id/idlistdirectoryrequest.cpp
@@ -0,0 +1,129 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+
+#include "backends/cloud/id/idlistdirectoryrequest.h"
+#include "backends/cloud/id/idstorage.h"
+
+namespace Cloud {
+namespace Id {
+
+IdListDirectoryRequest::IdListDirectoryRequest(IdStorage *storage, Common::String path, Storage::ListDirectoryCallback cb, Networking::ErrorCallback ecb, bool recursive):
+	Networking::Request(nullptr, ecb),
+	_requestedPath(path), _requestedRecursive(recursive), _storage(storage), _listDirectoryCallback(cb),
+	_workingRequest(nullptr), _ignoreCallback(false) {
+	start();
+}
+
+IdListDirectoryRequest::~IdListDirectoryRequest() {
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	delete _listDirectoryCallback;
+}
+
+void IdListDirectoryRequest::start() {
+	//cleanup
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	_workingRequest = nullptr;
+	_files.clear();
+	_directoriesQueue.clear();
+	_currentDirectory = StorageFile();
+	_ignoreCallback = false;
+
+	//find out that directory's id
+	Storage::UploadCallback innerCallback = new Common::Callback<IdListDirectoryRequest, Storage::UploadResponse>(this, &IdListDirectoryRequest::idResolvedCallback);
+	Networking::ErrorCallback innerErrorCallback = new Common::Callback<IdListDirectoryRequest, Networking::ErrorResponse>(this, &IdListDirectoryRequest::idResolveErrorCallback);
+	_workingRequest = _storage->resolveFileId(_requestedPath, innerCallback, innerErrorCallback);
+}
+
+void IdListDirectoryRequest::idResolvedCallback(Storage::UploadResponse response) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	if (response.request) _date = response.request->date();
+
+	StorageFile directory = response.value;
+	directory.setPath(_requestedPath);
+	_directoriesQueue.push_back(directory);
+	listNextDirectory();
+}
+
+void IdListDirectoryRequest::idResolveErrorCallback(Networking::ErrorResponse error) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	if (error.request) _date = error.request->date();
+	finishError(error);
+}
+
+void IdListDirectoryRequest::listNextDirectory() {
+	if (_directoriesQueue.empty()) {
+		finishListing(_files);
+		return;
+	}
+
+	_currentDirectory = _directoriesQueue.back();
+	_directoriesQueue.pop_back();
+
+	Storage::FileArrayCallback callback = new Common::Callback<IdListDirectoryRequest, Storage::FileArrayResponse>(this, &IdListDirectoryRequest::listedDirectoryCallback);
+	Networking::ErrorCallback failureCallback = new Common::Callback<IdListDirectoryRequest, Networking::ErrorResponse>(this, &IdListDirectoryRequest::listedDirectoryErrorCallback);	
+	_workingRequest = _storage->listDirectoryById(_currentDirectory.id(), callback, failureCallback);
+}
+
+void IdListDirectoryRequest::listedDirectoryCallback(Storage::FileArrayResponse response) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	if (response.request) _date = response.request->date();
+
+	for (uint32 i = 0; i < response.value.size(); ++i) {
+		StorageFile &file = response.value[i];
+		Common::String path = _currentDirectory.path();
+		if (path.size() && path.lastChar() != '/' && path.lastChar() != '\\') path += '/';
+		path += file.name();
+		file.setPath(path);
+		_files.push_back(file);
+		if (_requestedRecursive && file.isDirectory()) {
+			_directoriesQueue.push_back(file);
+		}
+	}
+
+	listNextDirectory();
+}
+
+void IdListDirectoryRequest::listedDirectoryErrorCallback(Networking::ErrorResponse error) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	if (error.request) _date = error.request->date();
+	finishError(error);
+}
+
+void IdListDirectoryRequest::handle() {}
+
+void IdListDirectoryRequest::restart() { start(); }
+
+Common::String IdListDirectoryRequest::date() const { return _date; }
+
+void IdListDirectoryRequest::finishListing(Common::Array<StorageFile> &files) {
+	Request::finishSuccess();
+	if (_listDirectoryCallback) (*_listDirectoryCallback)(Storage::ListDirectoryResponse(this, files));
+}
+
+} // End of namespace Id
+} // End of namespace Cloud
diff --git a/backends/cloud/id/idlistdirectoryrequest.h b/backends/cloud/id/idlistdirectoryrequest.h
new file mode 100644
index 0000000000..58c5d2c864
--- /dev/null
+++ b/backends/cloud/id/idlistdirectoryrequest.h
@@ -0,0 +1,66 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+
+#ifndef BACKENDS_CLOUD_ID_IDLISTDIRECTORYREQUEST_H
+#define BACKENDS_CLOUD_ID_IDLISTDIRECTORYREQUEST_H
+
+#include "backends/cloud/storage.h"
+#include "backends/networking/curl/request.h"
+#include "common/callback.h"
+
+namespace Cloud {
+namespace Id {
+
+class IdStorage;
+
+class IdListDirectoryRequest: public Networking::Request {
+	Common::String _requestedPath;
+	bool _requestedRecursive;
+	IdStorage *_storage;
+	Storage::ListDirectoryCallback _listDirectoryCallback;
+	Common::Array<StorageFile> _files;
+	Common::Array<StorageFile> _directoriesQueue;
+	StorageFile _currentDirectory;
+	Request *_workingRequest;
+	bool _ignoreCallback;
+	Common::String _date;
+
+	void start();
+	void idResolvedCallback(Storage::UploadResponse response);
+	void idResolveErrorCallback(Networking::ErrorResponse error);
+	void listNextDirectory();
+	void listedDirectoryCallback(Storage::FileArrayResponse response);
+	void listedDirectoryErrorCallback(Networking::ErrorResponse error);
+	void finishListing(Common::Array<StorageFile> &files);
+public:
+	IdListDirectoryRequest(IdStorage *storage, Common::String path, Storage::ListDirectoryCallback cb, Networking::ErrorCallback ecb, bool recursive = false);
+	virtual ~IdListDirectoryRequest();
+
+	virtual void handle();
+	virtual void restart();
+	virtual Common::String date() const;
+};
+
+} // End of namespace Id
+} // End of namespace Cloud
+
+#endif
diff --git a/backends/cloud/id/idresolveidrequest.cpp b/backends/cloud/id/idresolveidrequest.cpp
new file mode 100644
index 0000000000..fc61137088
--- /dev/null
+++ b/backends/cloud/id/idresolveidrequest.cpp
@@ -0,0 +1,125 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+
+#include "backends/cloud/id/idresolveidrequest.h"
+#include "backends/cloud/id/idstorage.h"
+
+namespace Cloud {
+namespace Id {
+
+IdResolveIdRequest::IdResolveIdRequest(IdStorage *storage, Common::String path, Storage::UploadCallback cb, Networking::ErrorCallback ecb, bool recursive):
+	Networking::Request(nullptr, ecb),
+	_requestedPath(path), _storage(storage), _uploadCallback(cb),
+	_workingRequest(nullptr), _ignoreCallback(false) {
+	start();
+}
+
+IdResolveIdRequest::~IdResolveIdRequest() {
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	delete _uploadCallback;
+}
+
+void IdResolveIdRequest::start() {
+	//cleanup
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	_workingRequest = nullptr;
+	_currentDirectory = "";
+	_currentDirectoryId = _storage->getRootDirectoryId();
+	_ignoreCallback = false;
+	
+	listNextDirectory(StorageFile(_currentDirectoryId, 0, 0, true));
+}
+
+void IdResolveIdRequest::listNextDirectory(StorageFile fileToReturn) {
+	if (_currentDirectory.equalsIgnoreCase(_requestedPath)) {
+		finishFile(fileToReturn);
+		return;
+	}
+
+	Storage::FileArrayCallback callback = new Common::Callback<IdResolveIdRequest, Storage::FileArrayResponse>(this, &IdResolveIdRequest::listedDirectoryCallback);
+	Networking::ErrorCallback failureCallback = new Common::Callback<IdResolveIdRequest, Networking::ErrorResponse>(this, &IdResolveIdRequest::listedDirectoryErrorCallback);
+	_workingRequest = _storage->listDirectoryById(_currentDirectoryId, callback, failureCallback);
+}
+
+void IdResolveIdRequest::listedDirectoryCallback(Storage::FileArrayResponse response) {	
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	
+	Common::String currentLevelName = _requestedPath;
+	///debug("'%s'", currentLevelName.c_str());
+	if (_currentDirectory.size()) currentLevelName.erase(0, _currentDirectory.size());
+	if (currentLevelName.size() && (currentLevelName[0] == '/' || currentLevelName[0] == '\\')) currentLevelName.erase(0, 1);
+	///debug("'%s'", currentLevelName.c_str());
+	for (uint32 i = 0; i < currentLevelName.size(); ++i) {
+		if (currentLevelName[i] == '/' || currentLevelName[i] == '\\') {
+			currentLevelName.erase(i);
+			///debug("'%s'", currentLevelName.c_str());
+			break;
+		}
+	}
+
+	Common::String path = _currentDirectory;
+	if (path != "") path += "/";
+	path += currentLevelName;
+	bool lastLevel = (path.equalsIgnoreCase(_requestedPath));
+
+	///debug("so, searching for '%s' in '%s'", currentLevelName.c_str(), _currentDirectory.c_str());
+
+	Common::Array<StorageFile> &files = response.value;
+	bool found = false;
+	for (uint32 i = 0; i < files.size(); ++i) {
+		if ((files[i].isDirectory() || lastLevel) && files[i].name().equalsIgnoreCase(currentLevelName)) {
+			if (_currentDirectory != "") _currentDirectory += "/";
+			_currentDirectory += files[i].name();
+			_currentDirectoryId = files[i].id();
+			///debug("found it! new directory and its id: '%s', '%s'", _currentDirectory.c_str(), _currentDirectoryId.c_str());
+			listNextDirectory(files[i]);
+			found = true;
+			break;
+		}
+	}
+
+	if (!found) {
+		if (lastLevel) finishError(Networking::ErrorResponse(this, false, true, Common::String("no such file found in its parent directory\n")+_currentDirectoryId, 404));
+		else finishError(Networking::ErrorResponse(this, false, true, "subdirectory not found", 400));
+	}
+}
+
+void IdResolveIdRequest::listedDirectoryErrorCallback(Networking::ErrorResponse error) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	finishError(error);
+}
+
+void IdResolveIdRequest::handle() {}
+
+void IdResolveIdRequest::restart() { start(); }
+
+void IdResolveIdRequest::finishFile(StorageFile file) {
+	Request::finishSuccess();
+	if (_uploadCallback) (*_uploadCallback)(Storage::UploadResponse(this, file));
+}
+
+} // End of namespace Id
+} // End of namespace Cloud
diff --git a/backends/cloud/id/idresolveidrequest.h b/backends/cloud/id/idresolveidrequest.h
new file mode 100644
index 0000000000..94d4af5030
--- /dev/null
+++ b/backends/cloud/id/idresolveidrequest.h
@@ -0,0 +1,60 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+
+#ifndef BACKENDS_CLOUD_ID_IDRESOLVEIDREQUEST_H
+#define BACKENDS_CLOUD_ID_IDRESOLVEIDREQUEST_H
+
+#include "backends/cloud/storage.h"
+#include "backends/networking/curl/request.h"
+#include "common/callback.h"
+
+namespace Cloud {
+namespace Id {
+
+class IdStorage;
+
+class IdResolveIdRequest: public Networking::Request {
+	Common::String _requestedPath;	
+	IdStorage *_storage;
+	Storage::UploadCallback _uploadCallback;
+	Common::String _currentDirectory;
+	Common::String _currentDirectoryId;
+	Request *_workingRequest;
+	bool _ignoreCallback;
+
+	void start();
+	void listNextDirectory(StorageFile fileToReturn);
+	void listedDirectoryCallback(Storage::FileArrayResponse response);
+	void listedDirectoryErrorCallback(Networking::ErrorResponse error);
+	void finishFile(StorageFile file);
+public:
+	IdResolveIdRequest(IdStorage *storage, Common::String path, Storage::UploadCallback cb, Networking::ErrorCallback ecb, bool recursive = false); //TODO: why upload?
+	virtual ~IdResolveIdRequest();
+
+	virtual void handle();
+	virtual void restart();
+};
+
+} // End of namespace Id
+} // End of namespace Cloud
+
+#endif
diff --git a/backends/cloud/id/idstorage.cpp b/backends/cloud/id/idstorage.cpp
new file mode 100644
index 0000000000..aed1738d4f
--- /dev/null
+++ b/backends/cloud/id/idstorage.cpp
@@ -0,0 +1,86 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+#define FORBIDDEN_SYMBOL_ALLOW_ALL
+
+#include "backends/cloud/id/idstorage.h"
+#include "backends/cloud/id/idlistdirectoryrequest.h"
+#include "backends/cloud/id/idresolveidrequest.h"
+#include "common/debug.h"
+#include "common/json.h"
+
+namespace Cloud {
+namespace Id {
+
+IdStorage::~IdStorage() {}
+
+void IdStorage::printJson(Networking::JsonResponse response) {
+	Common::JSONValue *json = response.value;
+	if (!json) {
+		warning("printJson: NULL");
+		return;
+	}
+
+	debug("%s", json->stringify().c_str());
+	delete json;
+}
+
+void IdStorage::printFiles(FileArrayResponse response) {
+	debug("files:");
+	Common::Array<StorageFile> &files = response.value;
+	for (uint32 i = 0; i < files.size(); ++i) {
+		debug("\t%s%s", files[i].name().c_str(), files[i].isDirectory() ? " (directory)" : "");
+		debug("\t%s", files[i].path().c_str());
+		debug("\t%s", files[i].id().c_str());
+		debug(" ");
+	}
+}
+
+void IdStorage::printBool(BoolResponse response) {
+	debug("bool: %s", response.value ? "true" : "false");
+}
+
+void IdStorage::printFile(UploadResponse response) {
+	debug("\nuploaded file info:");
+	debug("\tid: %s", response.value.path().c_str());
+	debug("\tname: %s", response.value.name().c_str());
+	debug("\tsize: %u", response.value.size());
+	debug("\ttimestamp: %u", response.value.timestamp());
+}
+
+Storage::ListDirectoryCallback IdStorage::getPrintFilesCallback() {
+	return new Common::Callback<IdStorage, FileArrayResponse>(this, &IdStorage::printFiles);
+}
+
+Networking::Request *IdStorage::resolveFileId(Common::String path, UploadCallback callback, Networking::ErrorCallback errorCallback) {
+	if (!errorCallback) errorCallback = getErrorPrintingCallback();
+	if (!callback) callback = new Common::Callback<IdStorage, UploadResponse>(this, &IdStorage::printFile);
+	return addRequest(new IdResolveIdRequest(this, path, callback, errorCallback));
+}
+
+Networking::Request *IdStorage::listDirectory(Common::String path, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback, bool recursive) {
+	if (!errorCallback) errorCallback = getErrorPrintingCallback();
+	if (!callback) callback = new Common::Callback<IdStorage, FileArrayResponse>(this, &IdStorage::printFiles);
+	return addRequest(new IdListDirectoryRequest(this, path, callback, errorCallback, recursive));
+}
+
+} // End of namespace Id
+} // End of namespace Cloud
diff --git a/backends/cloud/id/idstorage.h b/backends/cloud/id/idstorage.h
new file mode 100644
index 0000000000..a5e1c1e22c
--- /dev/null
+++ b/backends/cloud/id/idstorage.h
@@ -0,0 +1,73 @@
+/* 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 2
+* 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, write to the Free Software
+* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+*
+*/
+
+#ifndef BACKENDS_CLOUD_ID_IDSTORAGE_H
+#define BACKENDS_CLOUD_ID_IDSTORAGE_H
+
+#include "backends/cloud/storage.h"
+#include "backends/networking/curl/curljsonrequest.h"
+
+/*
+ * Id::IdStorage is a special base class, which is created
+ * to simplify adding new storages which use ids instead of
+ * paths in their API.
+ *
+ * Some Requests are already implemented, and Storage based
+ * on IdStorage needs to override/implement a few basic things.
+ *
+ * For example, ListDirectoryRequest and ResolveIdRequests are
+ * based on listDirectoryById() and getRootDirectoryId() methods.
+ * Implementing these you'll get id resolving and directory
+ * listing by path.
+ */
+
+namespace Cloud {
+namespace Id {
+
+class IdStorage: public Cloud::Storage {
+protected:
+	void printJson(Networking::JsonResponse response);
+	void printFiles(FileArrayResponse response);
+	void printBool(BoolResponse response);
+	void printFile(UploadResponse response);
+
+	ListDirectoryCallback getPrintFilesCallback();
+	
+public:
+	virtual ~IdStorage();
+
+	/** Public Cloud API comes down there. */
+
+	/** Returns StorageFile with the resolved file's id. */
+	virtual Networking::Request *resolveFileId(Common::String path, UploadCallback callback, Networking::ErrorCallback errorCallback);
+
+	/** Returns ListDirectoryStatus struct with list of files. */
+	virtual Networking::Request *listDirectory(Common::String path, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback, bool recursive = false);
+	virtual Networking::Request *listDirectoryById(Common::String id, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback) = 0;
+
+	virtual Common::String getRootDirectoryId() = 0;
+};
+
+} // End of namespace Id
+} // End of namespace Cloud
+
+#endif