1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/* 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(const Common::String &code, Networking::ErrorCallback callback);
/**
* Handles JSON response which should contain access token requested
* with getAccessToken().
*/
virtual void codeFlowComplete(Networking::ErrorCallback callback, const Networking::JsonResponse &response);
/**
* Handles network errors occurred while getting access token requested
* with getAccessToken().
*/
virtual void codeFlowFailed(Networking::ErrorCallback callback, const 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, const 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(const Common::String &token, const Common::String &refreshToken, bool enabled = false);
~BaseStorage() override;
/**
* 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
|
