mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-15 22:28:10 +00:00
104 lines
3.3 KiB
C++
104 lines
3.3 KiB
C++
/* 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_BASE_STORAGE_H
|
|
#define BACKENDS_CLOUD_BASE_STORAGE_H
|
|
|
|
#include "backends/cloud/storage.h"
|
|
#include "backends/networking/curl/curljsonrequest.h"
|
|
|
|
namespace Cloud {
|
|
|
|
class BaseStorage: public Cloud::Storage {
|
|
protected:
|
|
/** Storage's access and refresh tokens. */
|
|
Common::String _token, _refreshToken;
|
|
|
|
/**
|
|
* Gets token from cloud.scummvm.org using given code.
|
|
* Base implementation for storages with common auth procedure.
|
|
*/
|
|
virtual void getAccessToken(Common::String code, Networking::ErrorCallback callback);
|
|
|
|
/**
|
|
* Handles JSON response which should contain access token requested
|
|
* with getAccessToken().
|
|
*/
|
|
virtual void codeFlowComplete(Networking::ErrorCallback callback, Networking::JsonResponse response);
|
|
|
|
/**
|
|
* Handles network errors occurred while getting access token requested
|
|
* with getAccessToken().
|
|
*/
|
|
virtual void codeFlowFailed(Networking::ErrorCallback callback, Networking::ErrorResponse error);
|
|
|
|
/**
|
|
* Return cloud provider name, used in cloud.scummvm.org endpoints.
|
|
* @return cloud provider (for example, "dropbox").
|
|
*/
|
|
virtual Common::String cloudProvider() = 0;
|
|
|
|
/**
|
|
* Return CloudManager's StorageID for this storage.
|
|
* @return StorageID corresponding to this storage (for example,
|
|
* kStorageDropboxId).
|
|
*/
|
|
virtual uint32 storageIndex() = 0;
|
|
|
|
/**
|
|
* Return whether storage needs refresh_token to work.
|
|
*/
|
|
virtual bool needsRefreshToken() = 0;
|
|
|
|
/**
|
|
* Return whether to expect new refresh_token on refresh.
|
|
*/
|
|
virtual bool canReuseRefreshToken() = 0;
|
|
|
|
private:
|
|
void tokenRefreshed(BoolCallback callback, Networking::JsonResponse response);
|
|
|
|
protected:
|
|
/** Helper function to save Storage::_isEnabled into config. */
|
|
void saveIsEnabledFlag(const Common::String &keyPrefix) const;
|
|
|
|
/** Helper function to load Storage::_isEnabled value from config. */
|
|
static bool loadIsEnabledFlag(const Common::String &keyPrefix);
|
|
|
|
/** Helper function to remove Storage::_isEnabled from config. */
|
|
static void removeIsEnabledFlag(const Common::String &keyPrefix);
|
|
|
|
public:
|
|
BaseStorage();
|
|
BaseStorage(Common::String token, Common::String refreshToken, bool enabled = false);
|
|
virtual ~BaseStorage();
|
|
|
|
/**
|
|
* Gets new access_token. Pass a callback, so you could
|
|
* continue your work when new token is available.
|
|
*/
|
|
virtual void refreshAccessToken(BoolCallback callback, Networking::ErrorCallback errorCallback = nullptr);
|
|
};
|
|
|
|
} // End of namespace Cloud
|
|
|
|
#endif
|