forked from TRON-US/interface-go-btfs-core
/
unixfs.go
471 lines (398 loc) · 10.8 KB
/
unixfs.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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
package options
import (
"errors"
"fmt"
cid "github.com/ipfs/go-cid"
dag "github.com/ipfs/go-merkledag"
mh "github.com/multiformats/go-multihash"
)
type Layout int
const (
BalancedLayout Layout = iota
TrickleLayout
)
type UnixfsAddSettings struct {
CidVersion int
MhType uint64
Inline bool
InlineLimit int
RawLeaves bool
RawLeavesSet bool
Chunker string
Layout Layout
Pin bool
OnlyHash bool
FsCache bool
NoCopy bool
TokenMetadata string
Events chan<- interface{}
Silent bool
Progress bool
Encrypt bool
Pubkey string
PeerId string
PinDuration int64
}
type UnixfsGetSettings struct {
Decrypt bool
PrivateKey string
Metadata bool
Repairs []cid.Cid
}
type UnixfsLsSettings struct {
ResolveChildren bool
}
type UnixfsAddMetaSettings struct {
Pin bool
Overwrite bool
Events chan<- interface{}
Silent bool
}
type UnixfsRemoveMetaSettings struct {
Pin bool
Events chan<- interface{}
Silent bool
}
type UnixfsAddOption func(*UnixfsAddSettings) error
type UnixfsGetOption func(*UnixfsGetSettings) error
type UnixfsLsOption func(*UnixfsLsSettings) error
type UnixfsAddMetaOption func(*UnixfsAddMetaSettings) error
type UnixfsRemoveMetaOption func(*UnixfsRemoveMetaSettings) error
func UnixfsAddOptions(opts ...UnixfsAddOption) (*UnixfsAddSettings, cid.Prefix, error) {
options := &UnixfsAddSettings{
CidVersion: -1,
MhType: mh.SHA2_256,
Inline: false,
InlineLimit: 32,
RawLeaves: false,
RawLeavesSet: false,
Chunker: "size-262144",
Layout: BalancedLayout,
Pin: false,
OnlyHash: false,
FsCache: false,
NoCopy: false,
TokenMetadata: "",
Events: nil,
Silent: false,
Progress: false,
Encrypt: false,
Pubkey: "",
PeerId: "",
PinDuration: 0,
}
for _, opt := range opts {
err := opt(options)
if err != nil {
return nil, cid.Prefix{}, err
}
}
// nocopy -> rawblocks
if options.NoCopy && !options.RawLeaves {
// fixed?
if options.RawLeavesSet {
return nil, cid.Prefix{}, fmt.Errorf("nocopy option requires '--raw-leaves' to be enabled as well")
}
// No, satisfy mandatory constraint.
options.RawLeaves = true
}
// (hash != "sha2-256") -> CIDv1
if options.MhType != mh.SHA2_256 {
switch options.CidVersion {
case 0:
return nil, cid.Prefix{}, errors.New("CIDv0 only supports sha2-256")
case 1, -1:
options.CidVersion = 1
default:
return nil, cid.Prefix{}, fmt.Errorf("unknown CID version: %d", options.CidVersion)
}
} else {
if options.CidVersion < 0 {
// Default to CIDv0
options.CidVersion = 0
}
}
// cidV1 -> raw blocks (by default)
if options.CidVersion > 0 && !options.RawLeavesSet {
options.RawLeaves = true
}
prefix, err := dag.PrefixForCidVersion(options.CidVersion)
if err != nil {
return nil, cid.Prefix{}, err
}
prefix.MhType = options.MhType
prefix.MhLength = -1
return options, prefix, nil
}
func UnixfsGetOptions(opts ...UnixfsGetOption) (*UnixfsGetSettings, error) {
options := &UnixfsGetSettings{
Decrypt: false,
PrivateKey: "",
Metadata: false,
Repairs: nil,
}
for _, opt := range opts {
err := opt(options)
if err != nil {
return nil, err
}
}
return options, nil
}
func UnixfsLsOptions(opts ...UnixfsLsOption) (*UnixfsLsSettings, error) {
options := &UnixfsLsSettings{
ResolveChildren: true,
}
for _, opt := range opts {
err := opt(options)
if err != nil {
return nil, err
}
}
return options, nil
}
func UnixfsAddMetaOptions(opts ...UnixfsAddMetaOption) (*UnixfsAddMetaSettings, error) {
options := &UnixfsAddMetaSettings{
Pin: false,
Events: nil,
Silent: false,
Overwrite: false,
}
for _, opt := range opts {
err := opt(options)
if err != nil {
return nil, err
}
}
return options, nil
}
func UnixfsRemoveMetaOptions(opts ...UnixfsRemoveMetaOption) (*UnixfsRemoveMetaSettings, error) {
options := &UnixfsRemoveMetaSettings{
Pin: false,
Events: nil,
Silent: false,
}
for _, opt := range opts {
err := opt(options)
if err != nil {
return nil, err
}
}
return options, nil
}
func (unixfsOpts) Encrypt(encrypt bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Encrypt = encrypt
return nil
}
}
func (unixfsOpts) Pubkey(pubkey string) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Pubkey = pubkey
return nil
}
}
func (unixfsOpts) PeerId(peerId string) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.PeerId = peerId
return nil
}
}
func (unixfsOpts) Decrypt(decrypt bool) UnixfsGetOption {
return func(settings *UnixfsGetSettings) error {
settings.Decrypt = decrypt
return nil
}
}
func (unixfsOpts) PrivateKey(privateKey string) UnixfsGetOption {
return func(settings *UnixfsGetSettings) error {
settings.PrivateKey = privateKey
return nil
}
}
func (unixfsOpts) Metadata(metadata bool) UnixfsGetOption {
return func(settings *UnixfsGetSettings) error {
settings.Metadata = metadata
return nil
}
}
func (unixfsOpts) Repairs(repairs []cid.Cid) UnixfsGetOption {
return func(settings *UnixfsGetSettings) error {
settings.Repairs = repairs
return nil
}
}
type unixfsOpts struct{}
var Unixfs unixfsOpts
// CidVersion specifies which CID version to use. Defaults to 0 unless an option
// that depends on CIDv1 is passed.
func (unixfsOpts) CidVersion(version int) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.CidVersion = version
return nil
}
}
// Hash function to use. Implies CIDv1 if not set to sha2-256 (default).
//
// Table of functions is declared in https://github.com/multiformats/go-multihash/blob/master/multihash.go
func (unixfsOpts) Hash(mhtype uint64) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.MhType = mhtype
return nil
}
}
// RawLeaves specifies whether to use raw blocks for leaves (data nodes with no
// links) instead of wrapping them with unixfs structures.
func (unixfsOpts) RawLeaves(enable bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.RawLeaves = enable
settings.RawLeavesSet = true
return nil
}
}
// Inline tells the adder to inline small blocks into CIDs
func (unixfsOpts) Inline(enable bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Inline = enable
return nil
}
}
// InlineLimit sets the amount of bytes below which blocks will be encoded
// directly into CID instead of being stored and addressed by it's hash.
// Specifying this option won't enable block inlining. For that use `Inline`
// option. Default: 32 bytes
//
// Note that while there is no hard limit on the number of bytes, it should be
// kept at a reasonably low value, such as 64; implementations may choose to
// reject anything larger.
func (unixfsOpts) InlineLimit(limit int) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.InlineLimit = limit
return nil
}
}
// Chunker specifies settings for the chunking algorithm to use.
//
// Default: size-262144, formats:
// size-[bytes] - Simple chunker splitting data into blocks of n bytes
// rabin-[min]-[avg]-[max] - Rabin chunker
func (unixfsOpts) Chunker(chunker string) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Chunker = chunker
return nil
}
}
// Layout tells the adder how to balance data between leaves.
// options.BalancedLayout is the default, it's optimized for static seekable
// files.
// options.TrickleLayout is optimized for streaming data,
func (unixfsOpts) Layout(layout Layout) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Layout = layout
return nil
}
}
// Pin tells the adder to pin the file root recursively after adding
func (unixfsOpts) Pin(pin bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Pin = pin
return nil
}
}
// HashOnly will make the adder calculate data hash without storing it in the
// blockstore or announcing it to the network
func (unixfsOpts) HashOnly(hashOnly bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.OnlyHash = hashOnly
return nil
}
}
// Events specifies channel which will be used to report events about ongoing
// Add operation.
//
// Note that if this channel blocks it may slowdown the adder
func (unixfsOpts) Events(sink chan<- interface{}) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Events = sink
return nil
}
}
// TokenMetadata specifies settings for the token metadata to add.
func (unixfsOpts) TokenMetadata(tokenMetadata string) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.TokenMetadata = tokenMetadata
return nil
}
}
// Silent reduces event output
func (unixfsOpts) Silent(silent bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Silent = silent
return nil
}
}
// Progress tells the adder whether to enable progress events
func (unixfsOpts) Progress(enable bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.Progress = enable
return nil
}
}
// FsCache tells the adder to check the filestore for pre-existing blocks
//
// Experimental
func (unixfsOpts) FsCache(enable bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.FsCache = enable
return nil
}
}
// NoCopy tells the adder to add the files using filestore. Implies RawLeaves.
//
// Experimental
func (unixfsOpts) Nocopy(enable bool) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.NoCopy = enable
return nil
}
}
func (unixfsOpts) ResolveChildren(resolve bool) UnixfsLsOption {
return func(settings *UnixfsLsSettings) error {
settings.ResolveChildren = resolve
return nil
}
}
// Pin tells the meta modifier to pin the file root after adding metadata items
func (unixfsOpts) PinToAdd(pin bool) UnixfsAddMetaOption {
return func(settings *UnixfsAddMetaSettings) error {
settings.Pin = pin
return nil
}
}
func (unixfsOpts) OverwriteToAdd(overwrite bool) UnixfsAddMetaOption {
return func(settings *UnixfsAddMetaSettings) error {
settings.Overwrite = overwrite
return nil
}
}
// Events specifies channel which will be used to report events about ongoing
// Add operation.
func (unixfsOpts) EventsToAdd(sink chan<- interface{}) UnixfsAddMetaOption {
return func(settings *UnixfsAddMetaSettings) error {
settings.Events = sink
return nil
}
}
// Pin tells the meta modifier to pin the file root after removing metadata items
func (unixfsOpts) PinToRemove(pin bool) UnixfsRemoveMetaOption {
return func(settings *UnixfsRemoveMetaSettings) error {
settings.Pin = pin
return nil
}
}
func (unixfsOpts) PinDuration(dur int64) UnixfsAddOption {
return func(settings *UnixfsAddSettings) error {
settings.PinDuration = dur
return nil
}
}