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
|
// --------------------------------------------------------------------------
//
// File
// Name: BackupStoreFilename.cpp
// Purpose: Filename for the backup store
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
#include "Box.h"
#include "BackupStoreFilename.h"
#include "Protocol.h"
#include "BackupStoreException.h"
#include "IOStream.h"
#include "Guards.h"
#include "MemLeakFindOn.h"
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::BackupStoreFilename()
// Purpose: Default constructor -- creates an invalid filename
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
BackupStoreFilename::BackupStoreFilename()
{
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::BackupStoreFilename(const BackupStoreFilename &)
// Purpose: Copy constructor
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
BackupStoreFilename::BackupStoreFilename(const BackupStoreFilename &rToCopy)
: mEncryptedName(rToCopy.mEncryptedName)
{
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::~BackupStoreFilename()
// Purpose: Destructor
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
BackupStoreFilename::~BackupStoreFilename()
{
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::CheckValid(bool)
// Purpose: Checks the encoded filename for validity
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
bool BackupStoreFilename::CheckValid(bool ExceptionIfInvalid) const
{
bool ok = true;
if(mEncryptedName.size() < 2)
{
// Isn't long enough to have a header
ok = false;
}
else
{
// Check size is consistent
unsigned int dsize = BACKUPSTOREFILENAME_GET_SIZE(this->mEncryptedName);
if(dsize != mEncryptedName.size())
{
ok = false;
}
// And encoding is an accepted value
unsigned int encoding = BACKUPSTOREFILENAME_GET_ENCODING(this->mEncryptedName);
if(encoding < Encoding_Min || encoding > Encoding_Max)
{
ok = false;
}
}
// Exception?
if(!ok && ExceptionIfInvalid)
{
THROW_EXCEPTION(BackupStoreException, InvalidBackupStoreFilename)
}
return ok;
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::ReadFromProtocol(Protocol &)
// Purpose: Reads the filename from the protocol object
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
void BackupStoreFilename::ReadFromProtocol(Protocol &rProtocol)
{
// Read the header
char hdr[2];
rProtocol.Read(hdr, 2);
// How big is it?
int dsize = BACKUPSTOREFILENAME_GET_SIZE(hdr);
// Fetch rest of data, relying on the Protocol to error on stupidly large sizes for us
std::string data;
rProtocol.Read(data, dsize - 2);
// assign to this string, storing the header and the extra data
mEncryptedName.assign(hdr, 2);
mEncryptedName.append(data.c_str(), data.size());
// Check it
CheckValid();
// Alert derived classes
EncodedFilenameChanged();
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::WriteToProtocol(Protocol &)
// Purpose: Writes the filename to the protocol object
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
void BackupStoreFilename::WriteToProtocol(Protocol &rProtocol) const
{
CheckValid();
rProtocol.Write(mEncryptedName.c_str(), mEncryptedName.size());
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::ReadFromStream(IOStream &)
// Purpose: Reads the filename from a stream
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
void BackupStoreFilename::ReadFromStream(IOStream &rStream, int Timeout)
{
// Read the header
char hdr[2];
if(!rStream.ReadFullBuffer(hdr, 2, 0 /* not interested in bytes read if this fails */, Timeout))
{
THROW_EXCEPTION(BackupStoreException, CouldntReadEntireStructureFromStream)
}
// How big is it?
unsigned int dsize = BACKUPSTOREFILENAME_GET_SIZE(hdr);
// Assume most filenames are small
char buf[256];
if(dsize < sizeof(buf))
{
// Fetch rest of data, relying on the Protocol to error on stupidly large sizes for us
if(!rStream.ReadFullBuffer(buf + 2, dsize - 2, 0 /* not interested in bytes read if this fails */, Timeout))
{
THROW_EXCEPTION(BackupStoreException, CouldntReadEntireStructureFromStream)
}
// Copy in header
buf[0] = hdr[0]; buf[1] = hdr[1];
// assign to this string, storing the header and the extra data
mEncryptedName.assign(buf, dsize);
}
else
{
// Block of memory to hold it
MemoryBlockGuard<char*> dataB(dsize+2);
char *data = dataB;
// Fetch rest of data, relying on the Protocol to error on stupidly large sizes for us
if(!rStream.ReadFullBuffer(data + 2, dsize - 2, 0 /* not interested in bytes read if this fails */, Timeout))
{
THROW_EXCEPTION(BackupStoreException, CouldntReadEntireStructureFromStream)
}
// Copy in header
data[0] = hdr[0]; data[1] = hdr[1];
// assign to this string, storing the header and the extra data
mEncryptedName.assign(data, dsize);
}
// Check it
CheckValid();
// Alert derived classes
EncodedFilenameChanged();
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::WriteToStream(IOStream &)
// Purpose: Writes the filename to a stream
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
void BackupStoreFilename::WriteToStream(IOStream &rStream) const
{
CheckValid();
rStream.Write(mEncryptedName.c_str(), mEncryptedName.size());
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::EncodedFilenameChanged()
// Purpose: The encoded filename stored has changed
// Created: 2003/08/26
//
// --------------------------------------------------------------------------
void BackupStoreFilename::EncodedFilenameChanged()
{
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::IsEncrypted()
// Purpose: Returns true if the filename is stored using an encrypting encoding
// Created: 1/12/03
//
// --------------------------------------------------------------------------
bool BackupStoreFilename::IsEncrypted() const
{
return BACKUPSTOREFILENAME_GET_ENCODING(this->mEncryptedName) !=
Encoding_Clear;
}
// --------------------------------------------------------------------------
//
// Function
// Name: BackupStoreFilename::SetAsClearFilename(const char *)
// Purpose: Sets this object to be a valid filename, but with a
// filename in the clear. Used on the server to create
// filenames when there's no way of encrypting it.
// Created: 22/4/04
//
// --------------------------------------------------------------------------
void BackupStoreFilename::SetAsClearFilename(const char *Clear)
{
// Make std::string from the clear name
std::string toEncode(Clear);
// Make an encoded string
char hdr[2];
BACKUPSTOREFILENAME_MAKE_HDR(hdr, toEncode.size()+2, Encoding_Clear);
std::string encoded(hdr, 2);
encoded += toEncode;
ASSERT(encoded.size() == toEncode.size() + 2);
// Store the encoded string
mEncryptedName.assign(encoded);
// Stuff which must be done
EncodedFilenameChanged();
CheckValid(false);
}
|
