-
Notifications
You must be signed in to change notification settings - Fork 99
/
set_acl.go
523 lines (430 loc) · 16.7 KB
/
set_acl.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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
package lib
import (
"fmt"
"os"
"strings"
oss "github.com/aliyun/aliyun-oss-go-sdk/oss"
)
var aclMap = map[oss.ACLType][]string{
oss.ACLPublicReadWrite: []string{},
oss.ACLPublicRead: []string{},
oss.ACLPrivate: []string{},
oss.ACLDefault: []string{},
}
var bucketACLList = []oss.ACLType{
oss.ACLPublicReadWrite,
oss.ACLPublicRead,
oss.ACLPrivate,
}
var objectACLList = []oss.ACLType{
oss.ACLPublicReadWrite,
oss.ACLPublicRead,
oss.ACLPrivate,
oss.ACLDefault,
}
type setACLType int
const (
bucketACL setACLType = iota
objectACL
)
func formatACLString(aclType setACLType, sep string) string {
var list []oss.ACLType
if aclType == bucketACL {
list = bucketACLList
} else {
list = objectACLList
}
strList := []string{}
for _, acl := range list {
str := string(acl)
if len(aclMap[acl]) != 0 {
str += "(" + strings.Join(aclMap[acl][:], ",") + ")"
}
strList = append(strList, str)
}
return strings.Join(strList, sep)
}
var specChineseSetACL = SpecText{
synopsisText: "设置bucket或者objects的acl",
paramText: "cloud_url [acl] [options]",
syntaxText: `
ossutil set-acl oss://bucket[/prefix] [acl] [-r] [-b] [-f] [-c file] [--version-id versionId]
`,
detailHelpText: `
该命令设置指定bucket或者objects的acl。使用命令时若缺失了acl信息时,ossutil会询问用户acl信息。
(1)设置bucket的acl,参考用法1)
(2)设置单个object的acl,参考用法2)
(3)批量设置objects的acl,不设置bucket的acl,参考用法3)
对bucket设置acl,需要添加--bucket选项,否则视为对其中的objects设置acl。
该命令不支持同时设置bucket和objects的acl,请分开操作。
结果:显示命令耗时前未报错,则表示成功设置。
查看bucket或者object的acl信息,请使用stat命令。
ACL:
bucket的acl有三种,括号里为ossutil额外支持的简写模式:
` + formatACLString(bucketACL, "\n ") + `
object的acl有四种:
` + formatACLString(objectACL, "\n ") + `
acl的详细信息请参见:https://help.aliyun.com/document_detail/31867.html?spm=5176.doc31960.6.147.8dVwsh中的权限控制。
用法:
该命令有三种用法:
1) ossutil set-acl oss://bucket [acl] -b [-c file]
当设置了--bucket选项时,ossutil会尝试设置bucket的acl,此时不支持--recursive选项,并且请
确保输入的cloud_url精确匹配想要设置acl的bucket,无论--force选项是否指定,都不会进行询问提示。
如果用户在命令行中缺失acl信息,会进入交互模式,询问用户的acl信息。
2) ossutil set-acl oss://bucket/object [acl] [-c file] [--version-id versionId]
该用法设置指定单个object的acl,当指定object不存在时,ossutil会提示错误,此时请确保指定的
cloud_url精确匹配需要设置acl的object,并且不要指定--recursive选项(否则ossutil会进行前缀匹配,
设置多个objects的acl),无论--force选项是否指定,都不会进行询问提示。如果用户在命令行中缺失
acl信息,会进入交互模式,询问用户的acl信息。
3) ossutil set-acl oss://bucket[/prefix] [acl] -r [-f] [-c file]
该用法可批量设置objects的acl,此时必须输入--recursive选项,ossutil会查找所有前缀匹配cloud_url
的objects,设置它们的acl,当一个object操作出现错误时,会将出错object的错误信息记录到report文件,
并继续操作其他object,成功操作的object信息将不会被记录到report文件中(更多信息见cp命令的帮助)。
此时不支持--bucket选项,即ossutil不支持同时设置bucket和其中objects的acl,如有需要,请分开操作。
如果--force选项被指定,则不会进行询问提示。如果用户在命令行中缺失acl信息,会进入交互模式,询问
用户的acl信息。
如果指定了--include/--exclude选项,ossutil会查找所有匹配pattern的objects,批量设置。
--include和--exclude选项说明,请参考cp命令帮助。
`,
sampleText: `
(1)ossutil set-acl oss://bucket1 public-read-write -b
(2)ossutil set-acl oss://bucket1/obj1 private
(3)ossutil set-acl oss://bucket1/obj default -r
ossutil set-acl oss://bucket1/obj default -r --include "*.jpg"
ossutil set-acl oss://bucket1/obj default -r --exclude "*.jpg"
(4)ossutil set-acl oss://bucket1/%e4%b8%ad%e6%96%87 default --encoding-type url
(5)ossutil set-acl oss://bucket1/obj1 private --version-id versionId
`,
}
var specEnglishSetACL = SpecText{
synopsisText: "Set acl on bucket or objects",
paramText: "cloud_url [acl] [options]",
syntaxText: `
ossutil set-acl oss://bucket[/prefix] [acl] [-r] [-b] [-f] [-c file] [--version-id versionId]
`,
detailHelpText: `
The command set acl on the specified bucket or objects. If you use the command
witout acl information, ossutil will ask user for it.
(1) set acl on bucket, see usage 1)
(2) set acl on single object, see usage 2)
(3) batch set acl on many objects, see usage 3)
When set acl on bucket, the --bucket option must be specified.
Set acl on bucket an objects inside simultaneously is not supported, please
operate independently.
Result: if no error displayed before show elasped time, then the setting is completed successfully.
User can use stat command to check the acl information of bucket or objects.
ACL:
ossutil supports following bucket acls, shorthand versions in brackets:
` + formatACLString(bucketACL, "\n ") + `
ossutil support following objet acls:
` + formatACLString(objectACL, "\n ") + `
More information about acl see ACL Control in https://help.aliyun.com/document_detail/31867.html?spm=5176.doc31960.6.147.8dVwsh.
Usage:
There are three usages:
1) ossutil set-acl oss://bucket [acl] -b [-c file]
If --bucket option is specified, ossutil will try to set acl on bucket. In the
usage, please make sure cloud_url exactly specified the bucket you want to set acl
on, and --recursive option is not supported here. No matter --force option is specified
or not, ossutil will not show prompt question. If acl information is missed, ossutil
will enter interactive mode and ask you for it.
2) ossutil set-acl oss://bucket/object [acl] [-c file] [--version-id versionId]
The usage set acl on single object, if object not exist, error occurs. In the
usage, please make sure cloud_url exactly specified the object you want to set acl
on, and --recursive option is not specified(or ossutil will search for prefix-matching
objects and set acl on those objects). No matter --force option is specified or not,
ossutil will not show prompt question. If acl information is missed, ossutil will
enter interactive mode and ask you for it.
3) ossutil set-acl oss://bucket[/prefix] [acl] -r [-f] [-c file]
The usage can set acl on many objects, --recursive option is required for the
usage, ossutil will search for prefix-matching objects and set acl on those objects.
If an error occurs, ossutil will record the error message to report file, and ossutil
will continue to attempt to set acl on the remaining objects(more information see
help of cp command). In the usage, --bucket option is not supported, which means set
acl on bucket an objects inside simultaneously is not supported. If --force option
is specified, ossutil will not show prompt question. If acl information is missed,
ossutil will enter interactive mode and ask you for it.
If --include/--exclude option is specified, ossutil will search for pattern-matching
objects and set meta on those objects.
--include and --exclude option, please refer cp command help.
`,
sampleText: `
(1)ossutil set-acl oss://bucket1 public-read-write -b
(2)ossutil set-acl oss://bucket1/obj1 private
(3)ossutil set-acl oss://bucket1/obj default -r
ossutil set-acl oss://bucket1/obj default -r --include "*.jpg"
ossutil set-acl oss://bucket1/obj default -r --exclude "*.jpg"
(4)ossutil set-acl oss://bucket1/%e4%b8%ad%e6%96%87 default --encoding-type url
(5)ossutil set-acl oss://bucket1/obj1 private --version-id versionId
`,
}
// SetACLCommand is the command set acl
type SetACLCommand struct {
monitor Monitor //Put first for atomic op on some fileds
command Command
saOption batchOptionType
filters []filterOptionType
}
var setACLCommand = SetACLCommand{
command: Command{
name: "set-acl",
nameAlias: []string{"setacl", "set_acl"},
minArgc: 1,
maxArgc: 2,
specChinese: specChineseSetACL,
specEnglish: specEnglishSetACL,
group: GroupTypeNormalCommand,
validOptionNames: []string{
OptionRecursion,
OptionBucket,
OptionForce,
OptionEncodingType,
OptionConfigFile,
OptionInclude,
OptionExclude,
OptionEndpoint,
OptionAccessKeyID,
OptionAccessKeySecret,
OptionSTSToken,
OptionProxyHost,
OptionProxyUser,
OptionProxyPwd,
OptionRetryTimes,
OptionRoutines,
OptionOutputDir,
OptionLogLevel,
OptionVersionId,
OptionPassword,
OptionMode,
OptionECSRoleName,
OptionTokenTimeout,
OptionRamRoleArn,
OptionRoleSessionName,
OptionReadTimeout,
OptionConnectTimeout,
OptionSTSRegion,
OptionSkipVerfiyCert,
},
},
}
// function for FormatHelper interface
func (sc *SetACLCommand) formatHelpForWhole() string {
return sc.command.formatHelpForWhole()
}
func (sc *SetACLCommand) formatIndependHelp() string {
return sc.command.formatIndependHelp()
}
// Init simulate inheritance, and polymorphism
func (sc *SetACLCommand) Init(args []string, options OptionMapType) error {
return sc.command.Init(args, options, sc)
}
// RunCommand simulate inheritance, and polymorphism
func (sc *SetACLCommand) RunCommand() error {
sc.monitor.init("Setted acl on")
recursive, _ := GetBool(OptionRecursion, sc.command.options)
toBucket, _ := GetBool(OptionBucket, sc.command.options)
force, _ := GetBool(OptionForce, sc.command.options)
routines, _ := GetInt(OptionRoutines, sc.command.options)
encodingType, _ := GetString(OptionEncodingType, sc.command.options)
versionId, _ := GetString(OptionVersionId, sc.command.options)
var res bool
res, sc.filters = getFilter(os.Args)
if !res {
return fmt.Errorf("--include or --exclude does not support format containing dir info")
}
if !recursive && len(sc.filters) > 0 {
return fmt.Errorf("--include or --exclude only work with --recursive")
}
if recursive && len(versionId) > 0 {
return fmt.Errorf("--version-id only work on single object")
}
cloudURL, err := CloudURLFromString(sc.command.args[0], encodingType)
if err != nil {
return err
}
if cloudURL.bucket == "" {
return fmt.Errorf("invalid cloud url: %s, miss bucket", sc.command.args[0])
}
bucket, err := sc.command.ossBucket(cloudURL.bucket)
if err != nil {
return err
}
if toBucket {
return sc.setBucketACL(&bucket.Client, cloudURL, recursive)
}
if !recursive {
return sc.setObjectACL(bucket, cloudURL, versionId)
}
return sc.batchSetObjectACL(bucket, cloudURL, force, routines)
}
func (sc *SetACLCommand) setBucketACL(client *oss.Client, cloudURL CloudURL, recursive bool) error {
if cloudURL.object != "" {
return fmt.Errorf("set bucket acl invalid url: %s, object not empty, if you mean set object acl, you should not use --bucket option", sc.command.args[0])
}
if recursive {
return fmt.Errorf("set bucket acl do not support --recursive option, if you mean set object acl recursivlly, you should not use --bucket option")
}
acl, err := sc.getACL(bucketACL, recursive)
if err != nil {
return err
}
return sc.ossSetBucketACLRetry(client, cloudURL.bucket, acl)
}
func (sc *SetACLCommand) getACL(aclType setACLType, recursive bool) (oss.ACLType, error) {
var acl string
if len(sc.command.args) == 2 {
acl = sc.command.args[1]
} else {
str := "bucket"
if aclType == objectACL {
str = "object"
if recursive {
str = "objects"
}
}
fmt.Printf("Please enter the acl you want to set on the %s(%s):", str, formatACLString(aclType, ", "))
if _, err := fmt.Scanln(&acl); err != nil {
return "", fmt.Errorf("invalid acl: %s, please check", acl)
}
}
return sc.command.checkACL(acl, aclType)
}
func (cmd *Command) checkACL(acl string, aclType setACLType) (oss.ACLType, error) {
if aclType == bucketACL {
for _, item := range bucketACLList {
if acl == string(item) {
return item, nil
}
}
} else {
for _, item := range objectACLList {
if acl == string(item) {
return item, nil
}
}
}
return "", fmt.Errorf("invalid acl: %s, please check", acl)
}
func (sc *SetACLCommand) ossSetBucketACLRetry(client *oss.Client, bucket string, acl oss.ACLType) error {
retryTimes, _ := GetInt(OptionRetryTimes, sc.command.options)
for i := 1; ; i++ {
err := client.SetBucketACL(bucket, acl)
if err == nil {
return err
}
if int64(i) >= retryTimes {
return BucketError{err, bucket}
}
}
}
func (sc *SetACLCommand) setObjectACL(bucket *oss.Bucket, cloudURL CloudURL, versionId string) error {
if cloudURL.object == "" {
return fmt.Errorf("set object acl invalid url: %s, object empty, if you mean set bucket acl, you should use --bucket option", sc.command.args[0])
}
acl, err := sc.getACL(objectACL, false)
if err != nil {
return err
}
return sc.ossSetObjectACLRetry(bucket, cloudURL.object, acl, versionId)
}
func (sc *SetACLCommand) ossSetObjectACLRetry(bucket *oss.Bucket, object string, acl oss.ACLType, versionId string) error {
retryTimes, _ := GetInt(OptionRetryTimes, sc.command.options)
for i := 1; ; i++ {
var options []oss.Option
if len(versionId) > 0 {
options = append(options, oss.VersionId(versionId))
}
err := bucket.SetObjectACL(object, acl, options...)
if err == nil {
return err
}
if int64(i) >= retryTimes {
return ObjectError{err, bucket.BucketName, object}
}
}
}
func (sc *SetACLCommand) batchSetObjectACL(bucket *oss.Bucket, cloudURL CloudURL, force bool, routines int64) error {
if !force {
var val string
fmt.Printf("Do you really mean to recursivlly set acl on objects of %s(y or N)? ", sc.command.args[0])
if _, err := fmt.Scanln(&val); err != nil || (strings.ToLower(val) != "yes" && strings.ToLower(val) != "y") {
fmt.Println("operation is canceled.")
return nil
}
}
acl, err := sc.getACL(objectACL, true)
if err != nil {
return err
}
sc.saOption.ctnu = true
outputDir, _ := GetString(OptionOutputDir, sc.command.options)
// init reporter
if sc.saOption.reporter, err = GetReporter(sc.saOption.ctnu, outputDir, commandLine); err != nil {
return err
}
defer sc.saOption.reporter.Clear()
return sc.setObjectACLs(bucket, cloudURL, acl, force, routines)
}
func (sc *SetACLCommand) setObjectACLs(bucket *oss.Bucket, cloudURL CloudURL, acl oss.ACLType, force bool, routines int64) error {
// producer list objects
// consumer set acl
chObjects := make(chan string, ChannelBuf)
chError := make(chan error, routines+1)
chListError := make(chan error, 1)
go sc.command.objectStatistic(bucket, cloudURL, &sc.monitor, sc.filters)
go sc.command.objectProducer(bucket, cloudURL, chObjects, chListError, sc.filters)
for i := 0; int64(i) < routines; i++ {
go sc.setObjectACLConsumer(bucket, acl, chObjects, chError)
}
return sc.waitRoutinueComplete(chError, chListError, routines)
}
func (sc *SetACLCommand) setObjectACLConsumer(bucket *oss.Bucket, acl oss.ACLType, chObjects <-chan string, chError chan<- error) {
for object := range chObjects {
err := sc.setObjectACLWithReport(bucket, object, acl)
if err != nil {
chError <- err
if !sc.saOption.ctnu {
return
}
continue
}
}
chError <- nil
}
func (sc *SetACLCommand) setObjectACLWithReport(bucket *oss.Bucket, object string, acl oss.ACLType) error {
err := sc.ossSetObjectACLRetry(bucket, object, acl, "")
sc.command.updateMonitor(err, &sc.monitor)
msg := fmt.Sprintf("set acl on %s", CloudURLToString(bucket.BucketName, object))
sc.command.report(msg, err, &sc.saOption)
return err
}
func (sc *SetACLCommand) waitRoutinueComplete(chError, chListError <-chan error, routines int64) error {
completed := 0
var ferr error
for int64(completed) <= routines {
select {
case err := <-chListError:
if err != nil {
return err
}
completed++
case err := <-chError:
if err == nil {
completed++
} else {
ferr = err
if !sc.saOption.ctnu {
fmt.Printf(sc.monitor.progressBar(true, errExit))
return err
}
}
}
}
return sc.formatResultPrompt(ferr)
}
func (sc *SetACLCommand) formatResultPrompt(err error) error {
fmt.Printf(sc.monitor.progressBar(true, normalExit))
if err != nil && sc.saOption.ctnu {
return nil
}
return err
}