dropboxstorage.cpp

Go to the documentation of this file.

/* 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 <curl/curl.h>
#include "backends/cloud/dropbox/dropboxstorage.h"
#include "backends/cloud/dropbox/dropboxcreatedirectoryrequest.h"
#include "backends/cloud/dropbox/dropboxinforequest.h"
#include "backends/cloud/dropbox/dropboxlistdirectoryrequest.h"
#include "backends/cloud/dropbox/dropboxuploadrequest.h"
#include "backends/cloud/cloudmanager.h"
#include "backends/networking/curl/connectionmanager.h"
#include "backends/networking/curl/curljsonrequest.h"
#include "common/config-manager.h"
#include "common/debug.h"
#include "common/json.h"

#ifdef ENABLE_RELEASE
#include "dists/clouds/cloud_keys.h"
#endif

namespace Cloud {
namespace Dropbox {

#define DROPBOX_OAUTH2_TOKEN "https://api.dropboxapi.com/oauth2/token"
#define DROPBOX_API_FILES_DOWNLOAD "https://content.dropboxapi.com/2/files/download"

char *DropboxStorage::KEY = nullptr; //can't use CloudConfig there yet, loading it on instance creation/auth
char *DropboxStorage::SECRET = nullptr;

void DropboxStorage::loadKeyAndSecret() {
#ifdef ENABLE_RELEASE
    KEY = RELEASE_DROPBOX_KEY;
    SECRET = RELEASE_DROPBOX_SECRET;
#else
    Common::String k = ConfMan.get("DROPBOX_KEY", ConfMan.kCloudDomain);
    KEY = new char[k.size() + 1];
    memcpy(KEY, k.c_str(), k.size());
    KEY[k.size()] = 0;

    k = ConfMan.get("DROPBOX_SECRET", ConfMan.kCloudDomain);
    SECRET = new char[k.size() + 1];
    memcpy(SECRET, k.c_str(), k.size());
    SECRET[k.size()] = 0;
#endif
}

DropboxStorage::DropboxStorage(Common::String accessToken, Common::String userId): _token(accessToken), _uid(userId) {}

DropboxStorage::DropboxStorage(Common::String code) {
    getAccessToken(code);
}

DropboxStorage::~DropboxStorage() {}

void DropboxStorage::getAccessToken(Common::String code) {
    if (!KEY || !SECRET)
        loadKeyAndSecret();
    Networking::JsonCallback callback = new Common::Callback<DropboxStorage, Networking::JsonResponse>(this, &DropboxStorage::codeFlowComplete);
    Networking::ErrorCallback errorCallback = new Common::Callback<DropboxStorage, Networking::ErrorResponse>(this, &DropboxStorage::codeFlowFailed);
    Networking::CurlJsonRequest *request = new Networking::CurlJsonRequest(callback, errorCallback, DROPBOX_OAUTH2_TOKEN);
    request->addPostField("code=" + code);
    request->addPostField("grant_type=authorization_code");
    request->addPostField("client_id=" + Common::String(KEY));
    request->addPostField("client_secret=" + Common::String(SECRET));
    if (Cloud::CloudManager::couldUseLocalServer()) {
        request->addPostField("&redirect_uri=http%3A%2F%2Flocalhost%3A12345%2F");
    } else {
        request->addPostField("&redirect_uri=https%3A%2F%2Fwww.scummvm.org/c/code");
    }
    addRequest(request);
}

void DropboxStorage::codeFlowComplete(Networking::JsonResponse response) {
    Common::JSONValue *json = (Common::JSONValue *)response.value;
    if (json == nullptr) {
        debug(9, "DropboxStorage::codeFlowComplete: got NULL instead of JSON!");
        CloudMan.removeStorage(this);
        return;
    }

    if (!json->isObject()) {
        debug(9, "DropboxStorage::codeFlowComplete: Passed JSON is not an object!");
        CloudMan.removeStorage(this);
        delete json;
        return;
    }

    Common::JSONObject result = json->asObject();
    if (!Networking::CurlJsonRequest::jsonContainsString(result, "access_token", "DropboxStorage::codeFlowComplete") ||
        !Networking::CurlJsonRequest::jsonContainsString(result, "uid", "DropboxStorage::codeFlowComplete")) {
        warning("DropboxStorage: bad response, no token/uid passed");
        debug(9, "%s", json->stringify(true).c_str());
        CloudMan.removeStorage(this);
    } else {
        _token = result.getVal("access_token")->asString();
        _uid = result.getVal("uid")->asString();
        ConfMan.removeKey("dropbox_code", ConfMan.kCloudDomain);
        CloudMan.replaceStorage(this, kStorageDropboxId);
        ConfMan.flushToDisk();
    }

    delete json;
}

void DropboxStorage::codeFlowFailed(Networking::ErrorResponse error) {
    debug(9, "DropboxStorage: code flow failed (%s, %ld):", (error.failed ? "failed" : "interrupted"), error.httpResponseCode);
    debug(9, "%s", error.response.c_str());
    CloudMan.removeStorage(this);
}

void DropboxStorage::saveConfig(Common::String keyPrefix) {
    ConfMan.set(keyPrefix + "access_token", _token, ConfMan.kCloudDomain);
    ConfMan.set(keyPrefix + "user_id", _uid, ConfMan.kCloudDomain);
}

Common::String DropboxStorage::name() const {
    return "Dropbox";
}

Networking::Request *DropboxStorage::listDirectory(Common::String path, ListDirectoryCallback outerCallback, Networking::ErrorCallback errorCallback, bool recursive) {
    return addRequest(new DropboxListDirectoryRequest(_token, path, outerCallback, errorCallback, recursive));
}

Networking::Request *DropboxStorage::upload(Common::String path, Common::SeekableReadStream *contents, UploadCallback callback, Networking::ErrorCallback errorCallback) {
    return addRequest(new DropboxUploadRequest(_token, path, contents, callback, errorCallback));
}

Networking::Request *DropboxStorage::streamFileById(Common::String path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback) {
    Common::JSONObject jsonRequestParameters;
    jsonRequestParameters.setVal("path", new Common::JSONValue(path));
    Common::JSONValue value(jsonRequestParameters);

    Networking::CurlRequest *request = new Networking::CurlRequest(nullptr, nullptr, DROPBOX_API_FILES_DOWNLOAD); //TODO: is it OK to pass no callbacks?
    request->addHeader("Authorization: Bearer " + _token);
    request->addHeader("Dropbox-API-Arg: " + Common::JSON::stringify(&value));
    request->addHeader("Content-Type: "); //required to be empty (as we do POST, it's usually app/form-url-encoded)

    Networking::NetworkReadStreamResponse response = request->execute();
    if (callback)
        (*callback)(response);
    return response.request; // no leak here, response.request == request
}

Networking::Request *DropboxStorage::createDirectory(Common::String path, BoolCallback callback, Networking::ErrorCallback errorCallback) {
    if (!errorCallback)
        errorCallback = getErrorPrintingCallback();
    return addRequest(new DropboxCreateDirectoryRequest(_token, path, callback, errorCallback));
}

Networking::Request *DropboxStorage::info(StorageInfoCallback callback, Networking::ErrorCallback errorCallback) {
    if (!errorCallback)
        errorCallback = getErrorPrintingCallback();
    return addRequest(new DropboxInfoRequest(_token, callback, errorCallback));
}

Common::String DropboxStorage::savesDirectoryPath() { return "/saves/"; }

DropboxStorage *DropboxStorage::loadFromConfig(Common::String keyPrefix) {
    loadKeyAndSecret();

    if (!ConfMan.hasKey(keyPrefix + "access_token", ConfMan.kCloudDomain)) {
        warning("DropboxStorage: no access_token found");
        return nullptr;
    }

    if (!ConfMan.hasKey(keyPrefix + "user_id", ConfMan.kCloudDomain)) {
        warning("DropboxStorage: no user_id found");
        return nullptr;
    }

    Common::String accessToken = ConfMan.get(keyPrefix + "access_token", ConfMan.kCloudDomain);
    Common::String userId = ConfMan.get(keyPrefix + "user_id", ConfMan.kCloudDomain);

    return new DropboxStorage(accessToken, userId);
}

} // End of namespace Dropbox
} // End of namespace Cloud