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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
// --------------------------------------------------------------------------
//
// File
// Name: BackupClientDirectoryRecord.h
// Purpose: Implementation of record about directory for backup client
// Created: 2003/10/08
//
// --------------------------------------------------------------------------
#ifndef BACKUPCLIENTDIRECTORYRECORD__H
#define BACKUPCLIENTDIRECTORYRECORD__H
#include <string>
#include <map>
#include "BackupClientFileAttributes.h"
#include "BackupStoreDirectory.h"
#include "BoxTime.h"
#include "MD5Digest.h"
#include "ReadLoggingStream.h"
#include "RunStatusProvider.h"
class Archive;
class BackupClientContext;
class BackupDaemon;
// --------------------------------------------------------------------------
//
// Class
// Name: SysadminNotifier
// Purpose: Provides a NotifySysadmin() method to send mail to the sysadmin
// Created: 2005/11/15
//
// --------------------------------------------------------------------------
class SysadminNotifier
{
public:
virtual ~SysadminNotifier() { }
typedef enum
{
StoreFull = 0,
ReadError,
BackupError,
BackupStart,
BackupFinish,
BackupOK,
MAX
// When adding notifications, remember to add
// strings to NotifySysadmin()
}
EventCode;
virtual void NotifySysadmin(EventCode Event) = 0;
};
// --------------------------------------------------------------------------
//
// Class
// Name: ProgressNotifier
// Purpose: Provides methods for the backup library to inform the user
// interface about its progress with the backup
// Created: 2005/11/20
//
// --------------------------------------------------------------------------
class BackupClientDirectoryRecord;
class ProgressNotifier
{
public:
virtual ~ProgressNotifier() { }
virtual void NotifyIDMapsSetup(BackupClientContext& rContext) = 0;
virtual void NotifyScanDirectory(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyDirStatFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyFileStatFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyDirListFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyMountPointSkipped(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileExcluded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyDirExcluded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyUnsupportedFileType(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileReadFailed(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const std::string& rErrorMsg) = 0;
virtual void NotifyFileModifiedInFuture(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileSkippedServerFull(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploadException(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
const BoxException& rException) = 0;
virtual void NotifyFileUploadServerError(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int type, int subtype) = 0;
virtual void NotifyFileUploading(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploadingPatch(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath) = 0;
virtual void NotifyFileUploaded(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int64_t FileSize) = 0;
virtual void NotifyFileSynchronised(
const BackupClientDirectoryRecord* pDirRecord,
const std::string& rLocalPath,
int64_t FileSize) = 0;
virtual void NotifyDirectoryDeleted(
int64_t ObjectID,
const std::string& rRemotePath) = 0;
virtual void NotifyFileDeleted(
int64_t ObjectID,
const std::string& rRemotePath) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset,
int64_t length, box_time_t elapsed, box_time_t finish) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset,
int64_t length) = 0;
virtual void NotifyReadProgress(int64_t readSize, int64_t offset) = 0;
};
// --------------------------------------------------------------------------
//
// Class
// Name: BackupClientDirectoryRecord
// Purpose: Implementation of record about directory for backup client
// Created: 2003/10/08
//
// --------------------------------------------------------------------------
class BackupClientDirectoryRecord
{
public:
BackupClientDirectoryRecord(int64_t ObjectID, const std::string &rSubDirName);
~BackupClientDirectoryRecord();
void Deserialize(Archive & rArchive);
void Serialize(Archive & rArchive) const;
private:
BackupClientDirectoryRecord(const BackupClientDirectoryRecord &);
public:
enum
{
UnknownDirectoryID = 0
};
// --------------------------------------------------------------------------
//
// Class
// Name: BackupClientDirectoryRecord::SyncParams
// Purpose: Holds parameters etc for directory syncing. Not passed as
// const, some parameters may be modified during sync.
// Created: 8/3/04
//
// --------------------------------------------------------------------------
class SyncParams : public ReadLoggingStream::Logger
{
public:
SyncParams(
RunStatusProvider &rRunStatusProvider,
SysadminNotifier &rSysadminNotifier,
ProgressNotifier &rProgressNotifier,
BackupClientContext &rContext);
~SyncParams();
private:
// No copying
SyncParams(const SyncParams&);
SyncParams &operator=(const SyncParams&);
public:
// Data members are public, as accessors are not justified here
box_time_t mSyncPeriodStart;
box_time_t mSyncPeriodEnd;
box_time_t mMaxUploadWait;
box_time_t mMaxFileTimeInFuture;
int32_t mFileTrackingSizeThreshold;
int32_t mDiffingUploadSizeThreshold;
RunStatusProvider &mrRunStatusProvider;
SysadminNotifier &mrSysadminNotifier;
ProgressNotifier &mrProgressNotifier;
BackupClientContext &mrContext;
bool mReadErrorsOnFilesystemObjects;
// Member variables modified by syncing process
box_time_t mUploadAfterThisTimeInTheFuture;
bool mHaveLoggedWarningAboutFutureFileTimes;
bool StopRun() { return mrRunStatusProvider.StopRun(); }
void NotifySysadmin(SysadminNotifier::EventCode Event)
{
mrSysadminNotifier.NotifySysadmin(Event);
}
ProgressNotifier& GetProgressNotifier() const
{
return mrProgressNotifier;
}
/* ReadLoggingStream::Logger implementation */
virtual void Log(int64_t readSize, int64_t offset,
int64_t length, box_time_t elapsed, box_time_t finish)
{
mrProgressNotifier.NotifyReadProgress(readSize, offset,
length, elapsed, finish);
}
virtual void Log(int64_t readSize, int64_t offset,
int64_t length)
{
mrProgressNotifier.NotifyReadProgress(readSize, offset,
length);
}
virtual void Log(int64_t readSize, int64_t offset)
{
mrProgressNotifier.NotifyReadProgress(readSize, offset);
}
};
void SyncDirectory(SyncParams &rParams,
int64_t ContainingDirectoryID,
const std::string &rLocalPath,
const std::string &rRemotePath,
bool ThisDirHasJustBeenCreated = false);
private:
void DeleteSubDirectories();
BackupStoreDirectory *FetchDirectoryListing(SyncParams &rParams);
void UpdateAttributes(SyncParams &rParams,
BackupStoreDirectory *pDirOnStore,
const std::string &rLocalPath);
bool UpdateItems(SyncParams &rParams, const std::string &rLocalPath,
const std::string &rRemotePath,
BackupStoreDirectory *pDirOnStore,
std::vector<BackupStoreDirectory::Entry *> &rEntriesLeftOver,
std::vector<std::string> &rFiles,
const std::vector<std::string> &rDirs);
int64_t UploadFile(SyncParams &rParams,
const std::string &rFilename,
const BackupStoreFilename &rStoreFilename,
int64_t FileSize, box_time_t ModificationTime,
box_time_t AttributesHash, bool NoPreviousVersionOnServer);
void SetErrorWhenReadingFilesystemObject(SyncParams &rParams,
const char *Filename);
void RemoveDirectoryInPlaceOfFile(SyncParams &rParams,
BackupStoreDirectory* pDirOnStore,
BackupStoreDirectory::Entry* pEntry,
const std::string &rFilename);
private:
int64_t mObjectID;
std::string mSubDirName;
bool mInitialSyncDone;
bool mSyncDone;
// Checksum of directory contents and attributes, used to detect changes
uint8_t mStateChecksum[MD5Digest::DigestLength];
std::map<std::string, box_time_t> *mpPendingEntries;
std::map<std::string, BackupClientDirectoryRecord *> mSubDirectories;
// mpPendingEntries is a pointer rather than simple a member
// variable, because most of the time it'll be empty. This would
// waste a lot of memory because of STL allocation policies.
};
#endif // BACKUPCLIENTDIRECTORYRECORD__H
|
