Initial commit

backends/cloud/box/boxlistdirectorybyidrequest.cpp

@@ -0,0 +1,194 @@
+/* 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/>.
+ *
+ */
+
+#include "backends/cloud/box/boxlistdirectorybyidrequest.h"
+#include "backends/cloud/box/boxstorage.h"
+#include "backends/cloud/box/boxtokenrefresher.h"
+#include "backends/cloud/iso8601.h"
+#include "backends/cloud/storage.h"
+#include "backends/networking/http/connectionmanager.h"
+#include "backends/networking/http/httpjsonrequest.h"
+#include "backends/networking/http/networkreadstream.h"
+#include "common/formats/json.h"
+
+namespace Cloud {
+namespace Box {
+
+#define BOX_LIST_DIRECTORY_LIMIT 1000
+#define BOX_FOLDERS_API_LINK "https://api.box.com/2.0/folders/%s/items?offset=%u&limit=%u&fields=%s"
+
+BoxListDirectoryByIdRequest::BoxListDirectoryByIdRequest(BoxStorage *storage, const Common::String &id, Storage::ListDirectoryCallback cb, Networking::ErrorCallback ecb):
+	Networking::Request(nullptr, ecb), _requestedId(id), _storage(storage), _listDirectoryCallback(cb),
+	_workingRequest(nullptr), _ignoreCallback(false) {
+	start();
+}
+
+BoxListDirectoryByIdRequest::~BoxListDirectoryByIdRequest() {
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	delete _listDirectoryCallback;
+}
+
+void BoxListDirectoryByIdRequest::start() {
+	_ignoreCallback = true;
+	if (_workingRequest) _workingRequest->finish();
+	_files.clear();
+	_ignoreCallback = false;
+
+	makeRequest(0);
+}
+
+void BoxListDirectoryByIdRequest::makeRequest(uint32 offset) {
+	Common::String url = Common::String::format(
+		BOX_FOLDERS_API_LINK,
+		_requestedId.c_str(),
+		offset,
+		BOX_LIST_DIRECTORY_LIMIT,
+		"id,type,name,size,modified_at"
+	);
+
+	Networking::JsonCallback callback = new Common::Callback<BoxListDirectoryByIdRequest, const Networking::JsonResponse &>(this, &BoxListDirectoryByIdRequest::responseCallback);
+	Networking::ErrorCallback failureCallback = new Common::Callback<BoxListDirectoryByIdRequest, const Networking::ErrorResponse &>(this, &BoxListDirectoryByIdRequest::errorCallback);
+	Networking::HttpJsonRequest *request = new BoxTokenRefresher(_storage, callback, failureCallback, url.c_str());
+	request->addHeader("Authorization: Bearer " + _storage->accessToken());
+	_workingRequest = ConnMan.addRequest(request);
+}
+
+void BoxListDirectoryByIdRequest::responseCallback(const Networking::JsonResponse &response) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) {
+		delete response.value;
+		return;
+	}
+
+	if (response.request)
+		_date = response.request->date();
+
+	Networking::ErrorResponse error(this, "BoxListDirectoryByIdRequest::responseCallback: unknown error");
+	const Networking::HttpJsonRequest *rq = (const Networking::HttpJsonRequest *)response.request;
+	if (rq && rq->getNetworkReadStream())
+		error.httpResponseCode = rq->getNetworkReadStream()->httpResponseCode();
+
+	const Common::JSONValue *json = response.value;
+	if (json == nullptr) {
+		error.response = "Failed to parse JSON, null passed!";
+		finishError(error);
+		return;
+	}
+
+	if (!json->isObject()) {
+		error.response = "Passed JSON is not an object!";
+		finishError(error);
+		delete json;
+		return;
+	}
+
+	Common::JSONObject responseObject = json->asObject();
+	//debug(9, "%s", json->stringify(true).c_str());
+
+	//TODO: handle error messages passed as JSON
+	/*
+	if (responseObject.contains("error") || responseObject.contains("error_summary")) {
+		warning("Box returned error: %s", responseObject.getVal("error_summary")->asString().c_str());
+		error.failed = true;
+		error.response = json->stringify();
+		finishError(error);
+		delete json;
+		return;
+	}
+	*/
+
+	//check that ALL keys exist AND HAVE RIGHT TYPE to avoid segfaults
+	if (responseObject.contains("entries")) {
+		if (!responseObject.getVal("entries")->isArray()) {
+			error.response = Common::String::format(
+				"\"entries\" found, but that's not an array!\n%s",
+				responseObject.getVal("entries")->stringify(true).c_str()
+			);
+			finishError(error);
+			delete json;
+			return;
+		}
+
+		Common::JSONArray items = responseObject.getVal("entries")->asArray();
+		for (uint32 i = 0; i < items.size(); ++i) {
+			if (!Networking::HttpJsonRequest::jsonIsObject(items[i], "BoxListDirectoryByIdRequest")) continue;
+
+			Common::JSONObject item = items[i]->asObject();
+
+			if (!Networking::HttpJsonRequest::jsonContainsString(item, "id", "BoxListDirectoryByIdRequest")) continue;
+			if (!Networking::HttpJsonRequest::jsonContainsString(item, "name", "BoxListDirectoryByIdRequest")) continue;
+			if (!Networking::HttpJsonRequest::jsonContainsString(item, "type", "BoxListDirectoryByIdRequest")) continue;
+			if (!Networking::HttpJsonRequest::jsonContainsString(item, "modified_at", "BoxListDirectoryByIdRequest")) continue;
+			if (!Networking::HttpJsonRequest::jsonContainsStringOrIntegerNumber(item, "size", "BoxListDirectoryByIdRequest")) continue;
+
+			Common::String id = item.getVal("id")->asString();
+			Common::String name = item.getVal("name")->asString();
+			bool isDirectory = (item.getVal("type")->asString() == "folder");
+			uint32 size;
+			if (item.getVal("size")->isString()) {
+				size = item.getVal("size")->asString().asUint64();
+			} else {
+				size = item.getVal("size")->asIntegerNumber();
+			}
+			uint32 timestamp = ISO8601::convertToTimestamp(item.getVal("modified_at")->asString());
+
+			//as we list directory by id, we can't determine full path for the file, so we leave it empty
+			_files.push_back(StorageFile(id, "", name, size, timestamp, isDirectory));
+		}
+	}
+
+	uint32 received = 0;
+	uint32 totalCount = 0;
+	if (responseObject.contains("total_count") && responseObject.getVal("total_count")->isIntegerNumber())
+		totalCount = responseObject.getVal("total_count")->asIntegerNumber();
+	if (responseObject.contains("offset") && responseObject.getVal("offset")->isIntegerNumber())
+		received = responseObject.getVal("offset")->asIntegerNumber();
+	if (responseObject.contains("limit") && responseObject.getVal("limit")->isIntegerNumber())
+		received += responseObject.getVal("limit")->asIntegerNumber();
+	bool hasMore = (received < totalCount);
+
+	if (hasMore) makeRequest(received);
+	else finishListing(_files);
+
+	delete json;
+}
+
+void BoxListDirectoryByIdRequest::errorCallback(const Networking::ErrorResponse &error) {
+	_workingRequest = nullptr;
+	if (_ignoreCallback) return;
+	if (error.request) _date = error.request->date();
+	finishError(error);
+}
+
+void BoxListDirectoryByIdRequest::handle() {}
+
+void BoxListDirectoryByIdRequest::restart() { start(); }
+
+Common::String BoxListDirectoryByIdRequest::date() const { return _date; }
+
+void BoxListDirectoryByIdRequest::finishListing(Common::Array<StorageFile> &files) {
+	Request::finishSuccess();
+	if (_listDirectoryCallback) (*_listDirectoryCallback)(Storage::ListDirectoryResponse(this, files));
+}
+
+} // End of namespace Box
+} // End of namespace Cloud