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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/* 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_STORAGE_H
#define BACKENDS_CLOUD_STORAGE_H
#include "backends/cloud/storagefile.h"
#include "backends/cloud/storageinfo.h"
#include "backends/networking/curl/request.h"
#include "backends/networking/curl/curlrequest.h"
#include "common/array.h"
#include "common/stream.h"
#include "common/str.h"
#include "common/callback.h"
namespace Cloud {
/** Struct to represent upload() resulting status. */
struct UploadStatus {
/** true if Request was interrupted (finished by user with finish()) */
bool interrupted;
/** true if Request has failed (bad server response or some other error occurred) */
bool failed;
/** Contains uploaded file description (empty if failed) */
StorageFile file;
/** Server's original response (empty if not failed) */
Common::String response;
/** Server's HTTP response code. */
long httpResponseCode;
UploadStatus():
interrupted(false), failed(false), file(), response(), httpResponseCode(-1) {}
UploadStatus(bool interrupt, bool failure, StorageFile f, Common::String resp, long code):
interrupted(interrupt), failed(failure), file(f), response(resp), httpResponseCode(code) {}
};
/** Struct to represent upload() resulting status. */
struct ListDirectoryStatus {
/** true if Request was interrupted (finished by user with finish()) */
bool interrupted;
/** true if Request has failed (bad server response or some other error occurred) */
bool failed;
/** Contains listed files (might be incomplete if failed or interrupted) */
Common::Array<StorageFile> &files;
/** Server's original response (empty if not failed) */
Common::String response;
/** Server's HTTP response code. */
long httpResponseCode;
ListDirectoryStatus(Common::Array<StorageFile> &f) :
interrupted(false), failed(false), files(f), response(), httpResponseCode(-1) {}
ListDirectoryStatus(bool interrupt, bool failure, Common::Array<StorageFile> &f, Common::String resp, long code) :
interrupted(interrupt), failed(failure), files(f), response(resp), httpResponseCode(code) {}
};
class Storage {
public:
typedef Networking::Response<Common::Array<StorageFile>&> FileArrayResponse;
typedef Networking::Response<StorageInfo> StorageInfoResponse;
typedef Networking::Response<bool> BoolResponse;
typedef Networking::Response<UploadStatus> UploadResponse;
typedef Networking::Response<ListDirectoryStatus> ListDirectoryResponse;
typedef Common::BaseCallback<FileArrayResponse> *FileArrayCallback;
typedef Common::BaseCallback<StorageInfoResponse> *StorageInfoCallback;
typedef Common::BaseCallback<BoolResponse> *BoolCallback;
typedef Common::BaseCallback<UploadResponse> *UploadCallback;
typedef Common::BaseCallback<ListDirectoryResponse> *ListDirectoryCallback;
Storage() {}
virtual ~Storage() {}
/**
* Storage methods, which are used by CloudManager to save
* storage in configuration file.
*/
/**
* Save storage data using ConfMan.
* @param keyPrefix all saved keys must start with this prefix.
* @note every Storage must write keyPrefix + "type" key
* with common value (e.g. "Dropbox").
*/
virtual void saveConfig(Common::String keyPrefix) = 0;
/**
* Public Cloud API comes down there.
*
* All Cloud API methods return Networking::Request *, which
* might be used to control request. All methods also accept
* a callback, which is called, when request is complete.
*/
/** Returns ListDirectoryStatus struct with list of files. */
virtual Networking::Request *listDirectory(Common::String path, ListDirectoryCallback callback, bool recursive = false) = 0;
/** Returns UploadStatus struct with info about uploaded file. */
virtual Networking::Request *upload(Common::String path, Common::SeekableReadStream *contents, UploadCallback callback) = 0;
virtual Networking::Request *upload(Common::String remotePath, Common::String localPath, UploadCallback callback) = 0;
/** Returns pointer to Networking::NetworkReadStream. */
virtual Networking::Request *streamFile(Common::String path, Networking::NetworkReadStreamCallback callback) = 0;
/** Calls the callback when finished. */
virtual Networking::Request *download(Common::String remotePath, Common::String localPath, BoolCallback callback) = 0;
/** Returns Common::Array<StorageFile> with list of files, which were not downloaded. */
virtual Networking::Request *downloadFolder(Common::String remotePath, Common::String localPath, FileArrayCallback callback, bool recursive = false) = 0;
/** Calls the callback when finished. */
virtual Networking::Request *remove(Common::String path, BoolCallback callback) = 0;
/** Calls the callback when finished. */
virtual Networking::Request *syncSaves(BoolCallback callback) = 0;
/** Calls the callback when finished. */
virtual Networking::Request *createDirectory(Common::String path, BoolCallback callback) = 0;
/** Calls the callback when finished. */
virtual Networking::Request *touch(Common::String path, BoolCallback callback) = 0;
/** Returns the StorageInfo struct. */
virtual Networking::Request *info(StorageInfoCallback callback) = 0;
/** Returns whether saves sync process is running. */
virtual bool isSyncing() = 0;
/** Returns whether there are any requests running. */
virtual bool isWorking() = 0;
};
} // End of namespace Cloud
#endif
|
