/
retention-set.go
156 lines (130 loc) · 5.11 KB
/
retention-set.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
// Copyright (c) 2015-2021 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package cmd
import (
"context"
"strings"
"time"
"github.com/fatih/color"
"github.com/minio/cli"
"github.com/filswan/fs3-mc/pkg/probe"
minio "github.com/minio/minio-go/v7"
"github.com/minio/minio/pkg/console"
)
var (
retentionSetFlags = []cli.Flag{
cli.BoolFlag{
Name: "recursive, r",
Usage: "apply retention recursively",
},
cli.BoolFlag{
Name: "bypass",
Usage: "bypass governance",
},
cli.StringFlag{
Name: "version-id, vid",
Usage: "apply retention to a specific object version",
},
cli.StringFlag{
Name: "rewind",
Usage: "roll back object(s) to current version at specified time",
},
cli.BoolFlag{
Name: "versions",
Usage: "apply retention object(s) and all its versions",
},
cli.BoolFlag{
Name: "default",
Usage: "set bucket default retention mode",
},
}
)
var retentionSetCmd = cli.Command{
Name: "set",
Usage: "set retention for object(s)",
Action: mainRetentionSet,
OnUsageError: onUsageError,
Before: setGlobalsFromContext,
Flags: append(retentionSetFlags, globalFlags...),
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} [FLAGS] [governance | compliance] VALIDITY TARGET
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
VALIDITY:
This argument must be formatted like Nd or Ny where 'd' denotes days and 'y' denotes years e.g. 10d, 3y.
EXAMPLES:
1. Set object retention for a specific object
$ {{.HelpName}} compliance 30d myminio/mybucket/prefix/obj.csv
2. Set object retention for recursively for all objects at a given prefix
$ {{.HelpName}} governance 30d myminio/mybucket/prefix --recursive
3. Set object retention to a specific version of a specific object
$ {{.HelpName}} governance 30d myminio/mybucket/prefix/obj.csv --version-id "3Jr2x6fqlBUsVzbvPihBO3HgNpgZgAnp"
4. Set object retention for recursively for all versions of all objects
$ {{.HelpName}} governance 30d myminio/mybucket/prefix --recursive --versions
5. Set default lock retention configuration for a bucket
$ {{.HelpName}} --default governance 30d myminio/mybucket/
`}
func parseSetRetentionArgs(cliCtx *cli.Context) (target, versionID string, recursive bool, timeRef time.Time, withVersions bool, mode minio.RetentionMode, validity uint64, unit minio.ValidityUnit, bypass, bucketMode bool) {
args := cliCtx.Args()
mode = minio.RetentionMode(strings.ToUpper(args[0]))
if !mode.IsValid() {
fatalIf(errInvalidArgument().Trace(args...), "invalid retention mode '%v'", mode)
}
var err *probe.Error
validity, unit, err = parseRetentionValidity(args[1])
fatalIf(err.Trace(args[1]), "invalid validity argument")
target = args[2]
if target == "" {
fatalIf(errInvalidArgument().Trace(), "invalid target url '%v'", target)
}
versionID = cliCtx.String("version-id")
timeRef = parseRewindFlag(cliCtx.String("rewind"))
withVersions = cliCtx.Bool("versions")
recursive = cliCtx.Bool("recursive")
bucketMode = cliCtx.Bool("default")
return
}
// Set Retention for one object/version or many objects within a given prefix.
func setRetention(ctx context.Context, target, versionID string, timeRef time.Time, withOlderVersions, isRecursive bool,
mode minio.RetentionMode, validity uint64, unit minio.ValidityUnit, bypassGovernance bool) error {
return applyRetention(ctx, lockOpSet, target, versionID, timeRef, withOlderVersions, isRecursive, mode, validity, unit, bypassGovernance)
}
func setBucketLock(urlStr string, mode minio.RetentionMode, validity uint64, unit minio.ValidityUnit) error {
return applyBucketLock(lockOpSet, urlStr, mode, validity, unit)
}
// main for retention set command.
func mainRetentionSet(cliCtx *cli.Context) error {
ctx, cancelSetRetention := context.WithCancel(globalContext)
defer cancelSetRetention()
console.SetColor("RetentionSuccess", color.New(color.FgGreen, color.Bold))
console.SetColor("RetentionFailure", color.New(color.FgYellow))
if len(cliCtx.Args()) != 3 {
cli.ShowCommandHelpAndExit(cliCtx, "set", 1)
}
target, versionID, recursive, rewind, withVersions, mode, validity, unit, bypass, bucketMode := parseSetRetentionArgs(cliCtx)
checkObjectLockSupport(ctx, target)
if bucketMode {
return setBucketLock(target, mode, validity, unit)
}
if withVersions && rewind.IsZero() {
rewind = time.Now().UTC()
}
return setRetention(ctx, target, versionID, rewind, withVersions, recursive, mode, validity, unit, bypass)
}