-
Notifications
You must be signed in to change notification settings - Fork 99
/
bucket_inventory.go
445 lines (375 loc) · 13.3 KB
/
bucket_inventory.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
package lib
import (
"encoding/xml"
"fmt"
"io/ioutil"
"os"
"strings"
oss "github.com/aliyun/aliyun-oss-go-sdk/oss"
)
var specChineseBucketInventory = SpecText{
synopsisText: "添加、查询、删除或者列举bucket的清单配置",
paramText: "bucket_url [local_xml_file] [id] [options]",
syntaxText: `
ossutil inventory --method put oss://bucket local_xml_file [options]
ossutil inventory --method get oss://bucket id [local_file] [options]
ossuitl inventory --method delete oss://bucket id [options]
ossuitl inventory --method list oss://bucket [local_file] [--marker marker] [options]
`,
detailHelpText: `
inventory命令通过设置method选项值为put、get、delete、list,可以添加、查询、删除、列举bucket的清单配置
用法:
该命令有四种用法:
1) ossutil inventory --method put oss://bucket local_xml_file [options]
这个命令从配置文件local_xml_file中读取清单配置,然后添加一个bucket的清单规则
配置文件是一个xml格式的文件,如果已经存在标识为配置文件中id的配置,则报错
下面是一个配置文件例子
<?xml version="1.0" encoding="UTF-8"?>
<InventoryConfiguration>
<Id>report1</Id>
<IsEnabled>true</IsEnabled>
<Filter>
<Prefix>filterPrefix/</Prefix>
</Filter>
<Destination>
<OSSBucketDestination>
<Format>CSV</Format>
<AccountId>123456789012</AccountId>
<RoleArn>acs:ram::1287905056319499:role/fsr7hs5tjnxkiepp2ka6</RoleArn>
<Bucket>acs:oss:::destination-bucket</Bucket>
<Prefix>prefix1</Prefix>
<Encryption>
<SSE-KMS>
<KeyId>keyId</KeyId>
</SSE-KMS>
</Encryption>
</OSSBucketDestination>
</Destination>
<Schedule>
<Frequency>Daily</Frequency>
</Schedule>
<IncludedObjectVersions>All</IncludedObjectVersions>
<OptionalFields>
<Field>Size</Field>
<Field>LastModifiedDate</Field>
<Field>ETag</Field>
<Field>StorageClass</Field>
<Field>IsMultipartUploaded</Field>
<Field>EncryptionStatus</Field>
</OptionalFields>
</InventoryConfiguration>
2) ossutil inventory --method get oss://bucket id [local_xml_file] [options]
这个命令查询bucket的标识为id的清单配置
如果输入参数local_xml_file,清单配置将输出到该文件,否则输出到屏幕上
3) ossutil inventory --method delete oss://bucket id [options]
这个命令删除bucket的标识为id的清单配置
4) ossutil inventory --method list oss://bucket [local_file] [--marker marker] [options]
这个命令列举bucket的清单配置
`,
sampleText: `
1) 添加bucket的inventory配置
ossutil inventory --method put oss://bucket local_xml_file
2) 查询bucket的标识为id的inventory配置,结果输出到标准输出
ossutil inventory --method get oss://bucket id
3) 删除bucket的标识为id的inventory配置
ossutil inventory --method delete oss://bucket id
4) 列举bucket的所有inventory配置
ossutil inventory --method list oss://bucket
`,
}
var specEnglishBucketInventory = SpecText{
synopsisText: "Add, get, delete, or list bucket inventory configuration",
paramText: "bucket_url [local_xml_file] [id] [options]",
syntaxText: `
ossutil inventory --method put oss://bucket local_xml_file [options]
ossutil inventory --method get oss://bucket id [local_file] [options]
ossuitl inventory --method delete oss://bucket id [options]
ossuitl inventory --method list oss://bucket [local_file] [--marker marker] [options]
`,
detailHelpText: `
inventory command can add, get, delete or list the inventory configuration of the oss bucket by
set method option value to put, get, delete, list
Usage:
There are four usages for this command:
1) ossutil inventory --method put oss://bucket local_xml_file [options]
The command adds the inventory configuration of bucket from local file local_xml_file
the local_xml_file is xml format, if there is exist same id of configuration, an error occurs.
The following is an example xml file
<?xml version="1.0" encoding="UTF-8"?>
<InventoryConfiguration>
<Id>report1</Id>
<IsEnabled>true</IsEnabled>
<Filter>
<Prefix>filterPrefix/</Prefix>
</Filter>
<Destination>
<OSSBucketDestination>
<Format>CSV</Format>
<AccountId>123456789012</AccountId>
<RoleArn>acs:ram::1287905056319499:role/fsr7hs5tjnxkiepp2ka6</RoleArn>
<Bucket>acs:oss:::destination-bucket</Bucket>
<Prefix>prefix1</Prefix>
<Encryption>
<SSE-KMS>
<KeyId>keyId</KeyId>
</SSE-KMS>
</Encryption>
</OSSBucketDestination>
</Destination>
<Schedule>
<Frequency>Daily</Frequency>
</Schedule>
<IncludedObjectVersions>All</IncludedObjectVersions>
<OptionalFields>
<Field>Size</Field>
<Field>LastModifiedDate</Field>
<Field>ETag</Field>
<Field>StorageClass</Field>
<Field>IsMultipartUploaded</Field>
<Field>EncryptionStatus</Field>
</OptionalFields>
</InventoryConfiguration>
2) ossutil inventory --method get oss://bucket id [local_xml_file] [options]
The command gets the inventory configuration of bucket, The identifier of the inventory is id
If you input parameter local_xml_file,the configuration will be output to local_xml_file
If you don't input parameter local_xml_file,the configuration will be output to stdout
3) ossutil inventory --method delete oss://bucket id [options]
The command deletes the inventory configuration of bucket, The identifier of the inventory is id
4) ossutil inventory --method list oss://bucket [local_file] [--marker marker] [options]
List the bucket's all inventory configuration
`,
sampleText: `
1) add bucket inventory
ossutil inventory --method put oss://bucket local_xml_file
2) get inventory configuration to stdout, The identifier of the inventory is id
ossutil inventory --method get oss://bucket id
3) delete inventory configuration, The identifier of the inventory is id
ossutil inventory --method delete oss://bucket id
4) list the bucket's all inventory configuration
ossutil inventory --method list oss://bucket
`,
}
type BucketInventoryOptionType struct {
bucketName string
}
type BucketInventoryCommand struct {
command Command
bwOption BucketInventoryOptionType
}
var bucketInventoryCommand = BucketInventoryCommand{
command: Command{
name: "inventory",
nameAlias: []string{"inventory"},
minArgc: 1,
maxArgc: 3,
specChinese: specChineseBucketInventory,
specEnglish: specEnglishBucketInventory,
group: GroupTypeNormalCommand,
validOptionNames: []string{
OptionConfigFile,
OptionEndpoint,
OptionAccessKeyID,
OptionAccessKeySecret,
OptionSTSToken,
OptionProxyHost,
OptionProxyUser,
OptionProxyPwd,
OptionLogLevel,
OptionMethod,
OptionMarker,
OptionPassword,
OptionMode,
OptionECSRoleName,
OptionTokenTimeout,
OptionRamRoleArn,
OptionRoleSessionName,
OptionReadTimeout,
OptionConnectTimeout,
OptionSTSRegion,
OptionSkipVerfiyCert,
},
},
}
// function for FormatHelper interface
func (bic *BucketInventoryCommand) formatHelpForWhole() string {
return bic.command.formatHelpForWhole()
}
func (bic *BucketInventoryCommand) formatIndependHelp() string {
return bic.command.formatIndependHelp()
}
// Init simulate inheritance, and polymorphism
func (bic *BucketInventoryCommand) Init(args []string, options OptionMapType) error {
return bic.command.Init(args, options, bic)
}
// RunCommand simulate inheritance, and polymorphism
func (bic *BucketInventoryCommand) RunCommand() error {
strMethod, _ := GetString(OptionMethod, bic.command.options)
if strMethod == "" {
return fmt.Errorf("--method value is empty")
}
strMethod = strings.ToLower(strMethod)
if strMethod != "put" && strMethod != "get" && strMethod != "delete" && strMethod != "list" {
return fmt.Errorf("--method value is not in the optional value:put|get|delete|list")
}
srcBucketUrL, err := GetCloudUrl(bic.command.args[0], "")
if err != nil {
return err
}
bic.bwOption.bucketName = srcBucketUrL.bucket
if strMethod == "put" {
err = bic.PutBucketInventory()
} else if strMethod == "get" {
err = bic.GetBucketInventory()
} else if strMethod == "delete" {
err = bic.DeleteBucketInventory()
} else if strMethod == "list" {
err = bic.ListBucketInventory()
}
return err
}
func (bic *BucketInventoryCommand) PutBucketInventory() error {
if len(bic.command.args) < 2 {
return fmt.Errorf("put bucket inventory need at least 2 parameters,the local xml file is empty")
}
xmlFile := bic.command.args[1]
fileInfo, err := os.Stat(xmlFile)
if err != nil {
return err
}
if fileInfo.IsDir() {
return fmt.Errorf("%s is dir,not the expected file", xmlFile)
}
if fileInfo.Size() == 0 {
return fmt.Errorf("%s is empty file", xmlFile)
}
// parsing the xml file
file, err := os.Open(xmlFile)
if err != nil {
return err
}
defer file.Close()
text, err := ioutil.ReadAll(file)
if err != nil {
return err
}
inventoryConfig := oss.InventoryConfiguration{}
err = xml.Unmarshal(text, &inventoryConfig)
if err != nil {
return err
}
//if len(bic.command.args) == 3 {
// inventoryConfig.Id = bic.command.args[2]
//}
// put bucket inventory
client, err := bic.command.ossClient(bic.bwOption.bucketName)
if err != nil {
return err
}
return client.SetBucketInventory(bic.bwOption.bucketName, inventoryConfig)
}
func (bic *BucketInventoryCommand) confirm(str string) bool {
var val string
fmt.Printf(getClearStr(fmt.Sprintf("bucket inventory: overwrite \"%s\"(y or N)? ", str)))
if _, err := fmt.Scanln(&val); err != nil || (strings.ToLower(val) != "yes" && strings.ToLower(val) != "y") {
return false
}
return true
}
func (bic *BucketInventoryCommand) GetBucketInventory() error {
if len(bic.command.args) < 2 {
return fmt.Errorf("get bucket inventory need at least 2 parameters,the parameter id is empty")
}
inventoryId := bic.command.args[1]
client, err := bic.command.ossClient(bic.bwOption.bucketName)
if err != nil {
return err
}
inventoryRes, err := client.GetBucketInventory(bic.bwOption.bucketName, inventoryId)
if err != nil {
return err
}
output, err := xml.MarshalIndent(inventoryRes, " ", " ")
if err != nil {
return err
}
var outFile *os.File
if len(bic.command.args) >= 3 {
fileName := bic.command.args[2]
_, err = os.Stat(fileName)
if err == nil {
bConitnue := bic.confirm(fileName)
if !bConitnue {
return nil
}
}
outFile, err = os.OpenFile(fileName, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0660)
if err != nil {
return err
}
defer outFile.Close()
} else {
outFile = os.Stdout
}
outFile.Write([]byte(xml.Header))
outFile.Write(output)
fmt.Printf("\n\n")
return nil
}
func (bic *BucketInventoryCommand) DeleteBucketInventory() error {
if len(bic.command.args) < 2 {
return fmt.Errorf("delete bucket inventory need at least 2 parameters,the parameter id is empty")
}
inventoryId := bic.command.args[1]
// delete bucket inventory
client, err := bic.command.ossClient(bic.bwOption.bucketName)
if err != nil {
return err
}
return client.DeleteBucketInventory(bic.bwOption.bucketName, inventoryId)
}
func (bic *BucketInventoryCommand) ListBucketInventory() error {
vmarker, _ := GetString(OptionMarker, bic.command.options)
client, err := bic.command.ossClient(bic.bwOption.bucketName)
if err != nil {
return err
}
var sumResult oss.ListInventoryConfigurationsResult
for {
listResult, err := client.ListBucketInventory(bic.bwOption.bucketName, vmarker)
if err != nil {
return err
}
sumResult.InventoryConfiguration = append(sumResult.InventoryConfiguration, listResult.InventoryConfiguration...)
if listResult.IsTruncated != nil && *listResult.IsTruncated {
vmarker = listResult.NextContinuationToken
} else {
break
}
}
output, err := xml.MarshalIndent(sumResult, " ", " ")
if err != nil {
return err
}
var outFile *os.File
if len(bic.command.args) >= 2 {
fileName := bic.command.args[1]
_, err = os.Stat(fileName)
if err == nil {
bConitnue := bic.confirm(fileName)
if !bConitnue {
return nil
}
}
outFile, err = os.OpenFile(fileName, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0660)
if err != nil {
return err
}
defer outFile.Close()
} else {
outFile = os.Stdout
}
outFile.Write([]byte(xml.Header))
outFile.Write(output)
fmt.Printf("\n\ntotal inventory rule count:%d\n", len(sumResult.InventoryConfiguration))
return nil
}