forked from minio/minio
-
Notifications
You must be signed in to change notification settings - Fork 14
/
gateway-s3x-ledger.go
432 lines (397 loc) · 11.1 KB
/
gateway-s3x-ledger.go
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
package s3x
import (
"sync"
"github.com/ipfs/go-datastore"
"github.com/ipfs/go-datastore/namespace"
)
/* Design Notes
---------------
Internal functions should never claim or release locks.
Any claiming or releasing of locks should be done in the public setter+getter functions.
The reason for this is so that we can enable easy reuse of internal code.
*/
var (
ledgerKey = datastore.NewKey("ledgerstatekey")
ledgerPrefix = datastore.NewKey("ledgerRoot")
)
// LedgerStore is an internal bookkeeper that
// maps ipfs cids to bucket and object names
type LedgerStore struct {
sync.RWMutex
ds datastore.Batching
}
func newLedgerStore(ds datastore.Batching) *LedgerStore {
ledger := &LedgerStore{
ds: namespace.Wrap(ds, ledgerPrefix),
}
ledger.createLedgerIfNotExist()
return ledger
}
/////////////////////
// SETTER FUNCTINS //
/////////////////////
// AbortMultipartUpload is used to abort a multipart upload
func (le *LedgerStore) AbortMultipartUpload(bucketName, multipartID string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if !le.bucketExists(ledger, bucketName) {
return ErrLedgerBucketDoesNotExist
}
if err := le.multipartExists(ledger, multipartID); err != nil {
return err
}
delete(ledger.MultipartUploads, multipartID)
return le.putLedger(ledger)
}
// NewMultipartUpload is used to store the initial start of a multipart upload request
func (le *LedgerStore) NewMultipartUpload(bucketName, objectName, multipartID string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if !le.bucketExists(ledger, bucketName) {
return ErrLedgerBucketDoesNotExist
}
if ledger.MultipartUploads == nil {
ledger.MultipartUploads = make(map[string]MultipartUpload)
}
ledger.MultipartUploads[multipartID] = MultipartUpload{
Bucket: bucketName,
Object: objectName,
Id: multipartID,
}
return le.putLedger(ledger)
}
// PutObjectPart is used to record an individual object part within a multipart upload
func (le *LedgerStore) PutObjectPart(bucketName, objectName, partHash, multipartID string, partNumber int64) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if !le.bucketExists(ledger, bucketName) {
return ErrLedgerBucketDoesNotExist
}
if err := le.multipartExists(ledger, multipartID); err != nil {
return err
}
mpart := ledger.MultipartUploads[multipartID]
mpart.ObjectParts = append(mpart.ObjectParts, ObjectPartInfo{
Number: partNumber,
DataHash: partHash,
})
ledger.MultipartUploads[multipartID] = mpart
return le.putLedger(ledger)
}
// NewBucket creates a new ledger bucket entry
func (le *LedgerStore) NewBucket(name, hash string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if le.bucketExists(ledger, name) {
return ErrLedgerBucketExists
}
if ledger.GetBuckets() == nil {
ledger.Buckets = make(map[string]LedgerBucketEntry)
}
ledger.Buckets[name] = LedgerBucketEntry{
Objects: make(map[string]LedgerObjectEntry),
Name: name,
IpfsHash: hash,
}
return le.putLedger(ledger)
}
// UpdateBucketHash is used to update the ledger bucket entry
// with a new IPFS hash
func (le *LedgerStore) UpdateBucketHash(name, hash string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if !le.bucketExists(ledger, name) {
return ErrLedgerBucketDoesNotExist
}
entry := ledger.Buckets[name]
entry.IpfsHash = hash
ledger.Buckets[name] = entry
return le.putLedger(ledger)
}
// RemoveObject is used to remove a ledger object entry from a ledger bucket entry
func (le *LedgerStore) RemoveObject(bucketName, objectName string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if err := le.objectExists(ledger, bucketName, objectName); err != nil {
return err
}
delete(ledger.Buckets[bucketName].Objects, objectName)
return nil
}
// AddObjectToBucket is used to update a ledger bucket entry with a new ledger object entry
func (le *LedgerStore) AddObjectToBucket(bucketName, objectName, objectHash string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if !le.bucketExists(ledger, bucketName) {
return ErrLedgerBucketDoesNotExist
}
// prevent nil map panic
if ledger.GetBuckets()[bucketName].Objects == nil {
bucket := ledger.Buckets[bucketName]
bucket.Objects = make(map[string]LedgerObjectEntry)
ledger.Buckets[bucketName] = bucket
}
ledger.Buckets[bucketName].Objects[objectName] = LedgerObjectEntry{
Name: objectName,
IpfsHash: objectHash,
}
return le.putLedger(ledger)
}
// DeleteBucket is used to remove a ledger bucket entry
func (le *LedgerStore) DeleteBucket(name string) error {
le.Lock()
defer le.Unlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if ledger.GetBuckets()[name].Name == "" {
return ErrLedgerBucketDoesNotExist
}
delete(ledger.Buckets, name)
return le.putLedger(ledger)
}
// Close shuts down the ledger datastore
func (le *LedgerStore) Close() error {
le.Lock()
defer le.Unlock()
return le.ds.Close()
}
/////////////////////
// GETTER FUNCTINS //
/////////////////////
// GetObjectParts is used to return multipart upload parts
func (le *LedgerStore) GetObjectParts(id string) ([]ObjectPartInfo, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return nil, err
}
if err := le.multipartExists(ledger, id); err != nil {
return nil, err
}
return ledger.GetMultipartUploads()[id].ObjectParts, nil
}
// MultipartIDExists is used to lookup if the given multipart id exists
func (le *LedgerStore) MultipartIDExists(id string) error {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
return le.multipartExists(ledger, id)
}
// IsEmptyBucket checks if a bucket is empty or not
func (le *LedgerStore) IsEmptyBucket(name string) error {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
if len(ledger.Buckets[name].Objects) == 0 {
return nil
}
return ErrLedgerNonEmptyBucket
}
// BucketExists is a public function to check if a bucket exists
func (le *LedgerStore) BucketExists(name string) bool {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return false
}
return le.bucketExists(ledger, name)
}
// ObjectExists is a public function to check if an object exists, and returns the reason
// the object can't be found if any
func (le *LedgerStore) ObjectExists(bucketName, objectName string) error {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return err
}
return le.objectExists(ledger, bucketName, objectName)
}
// GetBucketHash is used to get the corresponding IPFS CID for a bucket
func (le *LedgerStore) GetBucketHash(name string) (string, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return "", err
}
if ledger.GetBuckets()[name].Name == "" {
return "", ErrLedgerBucketDoesNotExist
}
return ledger.Buckets[name].IpfsHash, nil
}
// GetObjectHash is used to retrive the correspodning IPFS CID for an object
func (le *LedgerStore) GetObjectHash(bucketName, objectName string) (string, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return "", err
}
if ledger.GetBuckets()[bucketName].Name == "" {
return "", ErrLedgerBucketDoesNotExist
}
bucket := ledger.GetBuckets()[bucketName]
if bucket.GetObjects()[objectName].Name == "" {
return "", ErrLedgerObjectDoesNotExist
}
return bucket.GetObjects()[objectName].IpfsHash, nil
}
// GetObjectHashes gets a map of object names to object hashes for all objects in a bucket
func (le *LedgerStore) GetObjectHashes(bucket string) (map[string]string, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return nil, err
}
if !le.bucketExists(ledger, bucket) {
return nil, ErrLedgerBucketDoesNotExist
}
// maps object names to hashes
var hashes = make(map[string]string, len(ledger.Buckets[bucket].Objects))
for _, obj := range ledger.GetBuckets()[bucket].Objects {
hashes[obj.GetName()] = obj.GetIpfsHash()
}
return hashes, err
}
// GetMultipartHashes returns the hashes of all multipart upload object parts
func (le *LedgerStore) GetMultipartHashes(bucket, multipartID string) ([]string, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return nil, err
}
if !le.bucketExists(ledger, bucket) {
return nil, ErrLedgerBucketDoesNotExist
}
if err := le.multipartExists(ledger, multipartID); err != nil {
return nil, err
}
mpart := ledger.MultipartUploads[bucket]
var hashes = make([]string, len(mpart.ObjectParts))
for i, objpart := range mpart.ObjectParts {
hashes[i] = objpart.GetDataHash()
}
return hashes, nil
}
// GetBucketNames is used to a slice of all bucket names our ledger currently tracks
func (le *LedgerStore) GetBucketNames() ([]string, error) {
le.RLock()
defer le.RUnlock()
ledger, err := le.getLedger()
if err != nil {
return nil, err
}
var (
// maps bucket names to hashes
names = make([]string, len(ledger.Buckets))
count int
)
for _, b := range ledger.Buckets {
names[count] = b.GetName()
count++
}
return names, nil
}
///////////////////////
// INTERNAL FUNCTINS //
///////////////////////
// getLedger is used to return our Ledger object from storage
func (le *LedgerStore) getLedger() (*Ledger, error) {
ledgerBytes, err := le.ds.Get(ledgerKey)
if err != nil {
return nil, err
}
ledger := &Ledger{}
if err := ledger.Unmarshal(ledgerBytes); err != nil {
return nil, err
}
return ledger, nil
}
// createLEdgerIfNotExist is a helper function to create our
// internal ledger store if it does not exist.
func (le *LedgerStore) createLedgerIfNotExist() {
if _, err := le.getLedger(); err == nil {
return
}
ledger := new(Ledger)
ledgerBytes, err := ledger.Marshal()
if err != nil {
panic(err)
}
if err := le.ds.Put(ledgerKey, ledgerBytes); err != nil {
panic(err)
}
}
// multipartExists is a helper function to check if a multispart id exists in our ledger
func (le *LedgerStore) multipartExists(ledger *Ledger, id string) error {
if ledger.MultipartUploads == nil {
return ErrInvalidUploadID
}
if ledger.MultipartUploads[id].Id == "" {
return ErrInvalidUploadID
}
return nil
}
// objectExists is a helper function to check if an object exists in our ledger.
func (le *LedgerStore) objectExists(ledger *Ledger, bucket, object string) error {
if ledger.GetBuckets()[bucket].Name == "" {
return ErrLedgerBucketDoesNotExist
}
if ledger.GetBuckets()[bucket].Objects[object].Name == "" {
return ErrLedgerObjectDoesNotExist
}
return nil
}
// bucketExists is a helper function to check if a bucket exists in our ledger
func (le *LedgerStore) bucketExists(ledger *Ledger, name string) bool {
return ledger.GetBuckets()[name].Name != ""
}
// putLedger is a helper function used to update the ledger store on disk
func (le *LedgerStore) putLedger(ledger *Ledger) error {
ledgerBytes, err := ledger.Marshal()
if err != nil {
return err
}
return le.ds.Put(ledgerKey, ledgerBytes)
}