/
legalhold-info.go
249 lines (216 loc) · 7.72 KB
/
legalhold-info.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
// Copyright (c) 2015-2022 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"
"fmt"
"path/filepath"
"strings"
"time"
"github.com/fatih/color"
"github.com/minio/cli"
json "github.com/minio/colorjson"
"github.com/minio/mc/pkg/probe"
"github.com/minio/minio-go/v7"
"github.com/minio/pkg/v2/console"
)
var lhInfoFlags = []cli.Flag{
cli.BoolFlag{
Name: "recursive, r",
Usage: "show legal hold status recursively",
},
cli.StringFlag{
Name: "version-id, vid",
Usage: "show legal hold status of a specific object version",
},
cli.StringFlag{
Name: "rewind",
Usage: "show legal hold status of an object version at specified time",
},
cli.BoolFlag{
Name: "versions",
Usage: "show legal hold status of multiple versions of object(s)",
},
}
var legalHoldInfoCmd = cli.Command{
Name: "info",
Usage: "show legal hold info for object(s)",
Action: mainLegalHoldInfo,
OnUsageError: onUsageError,
Before: setGlobalsFromContext,
Flags: append(lhInfoFlags, globalFlags...),
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} [FLAGS] TARGET
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
EXAMPLES:
1. Show legal hold on a specific object
$ {{.HelpName}} myminio/mybucket/prefix/obj.csv
2. Show legal hold on a specific object version
$ {{.HelpName}} myminio/mybucket/prefix/obj.csv --version-id "HiMFUTOowG6ylfNi4LKxD3ieHbgfgrvC"
3. Show object legal hold recursively for all objects at a prefix
$ {{.HelpName}} myminio/mybucket/prefix --recursive
4. Show object legal hold recursively for all objects versions older than one year
$ {{.HelpName}} myminio/mybucket/prefix --recursive --rewind 365d --versions
`,
}
// Structured message depending on the type of console.
type legalHoldInfoMessage struct {
LegalHold minio.LegalHoldStatus `json:"legalhold"`
URLPath string `json:"urlpath"`
Key string `json:"key"`
VersionID string `json:"versionID"`
Status string `json:"status"`
Err error `json:"error,omitempty"`
}
// Colorized message for console printing.
func (l legalHoldInfoMessage) String() string {
if l.Err != nil {
return console.Colorize("LegalHoldMessageFailure", "Unable to get object legal hold status `"+l.Key+"`. "+l.Err.Error())
}
var msg string
var legalhold string
switch l.LegalHold {
case "":
legalhold = console.Colorize("LegalHoldNotSet", "Not set")
case minio.LegalHoldEnabled:
legalhold = console.Colorize("LegalHoldOn", l.LegalHold)
case minio.LegalHoldDisabled:
legalhold = console.Colorize("LegalHoldOff", l.LegalHold)
}
msg += "[ " + centerText(legalhold, 8) + " ] "
if l.VersionID != "" {
msg += " " + console.Colorize("LegalHoldVersion", l.VersionID) + " "
}
msg += " "
msg += l.Key
return msg
}
// JSON'ified message for scripting.
func (l legalHoldInfoMessage) JSON() string {
msgBytes, e := json.MarshalIndent(l, "", " ")
fatalIf(probe.NewError(e), "Unable to marshal into JSON.")
return string(msgBytes)
}
// showLegalHoldInfo - show legalhold for one or many objects within a given prefix, with or without versioning
func showLegalHoldInfo(ctx context.Context, urlStr, versionID string, timeRef time.Time, withOlderVersions, recursive bool) error {
clnt, err := newClient(urlStr)
if err != nil {
fatalIf(err.Trace(), "Unable to parse the provided url.")
}
prefixPath := clnt.GetURL().Path
prefixPath = filepath.ToSlash(prefixPath)
if !strings.HasSuffix(prefixPath, "/") {
prefixPath = prefixPath[:strings.LastIndex(prefixPath, "/")+1]
}
prefixPath = strings.TrimPrefix(prefixPath, "./")
if !recursive && !withOlderVersions {
lhold, err := clnt.GetObjectLegalHold(ctx, versionID)
if err != nil {
fatalIf(err.Trace(urlStr), "Failed to show legal hold information of `"+urlStr+"`.")
} else {
contentURL := filepath.ToSlash(clnt.GetURL().Path)
key := strings.TrimPrefix(contentURL, prefixPath)
printMsg(legalHoldInfoMessage{
LegalHold: lhold,
Status: "success",
URLPath: clnt.GetURL().String(),
Key: key,
VersionID: versionID,
})
}
return nil
}
alias, _, _ := mustExpandAlias(urlStr)
var cErr error
errorsFound := false
objectsFound := false
lstOptions := ListOptions{Recursive: recursive, ShowDir: DirNone}
if !timeRef.IsZero() {
lstOptions.WithOlderVersions = withOlderVersions
lstOptions.TimeRef = timeRef
}
for content := range clnt.List(ctx, lstOptions) {
if content.Err != nil {
errorIf(content.Err.Trace(clnt.GetURL().String()), "Unable to list folder.")
cErr = exitStatus(globalErrorExitStatus) // Set the exit status.
continue
}
if !recursive && alias+getKey(content) != getStandardizedURL(urlStr) {
break
}
objectsFound = true
newClnt, perr := newClientFromAlias(alias, content.URL.String())
if perr != nil {
errorIf(content.Err.Trace(clnt.GetURL().String()), "Invalid URL")
continue
}
lhold, probeErr := newClnt.GetObjectLegalHold(ctx, content.VersionID)
if probeErr != nil {
errorsFound = true
errorIf(probeErr.Trace(content.URL.Path), "Failed to get legal hold information on `"+content.URL.Path+"`")
} else {
if !globalJSON {
contentURL := filepath.ToSlash(content.URL.Path)
key := strings.TrimPrefix(contentURL, prefixPath)
printMsg(legalHoldInfoMessage{
LegalHold: lhold,
Status: "success",
URLPath: content.URL.String(),
Key: key,
VersionID: content.VersionID,
})
}
}
}
if cErr == nil && !globalJSON {
switch {
case errorsFound:
console.Print(console.Colorize("LegalHoldPartialFailure", fmt.Sprintf("Errors found while getting legal hold status on objects with prefix `%s`. \n", urlStr)))
case !objectsFound:
console.Print(console.Colorize("LegalHoldMessageFailure", fmt.Sprintf("No objects/versions found while getting legal hold status with prefix `%s`. \n", urlStr)))
}
}
return cErr
}
// main for legalhold info command.
func mainLegalHoldInfo(cliCtx *cli.Context) error {
console.SetColor("LegalHoldSuccess", color.New(color.FgGreen, color.Bold))
console.SetColor("LegalHoldNotSet", color.New(color.FgYellow))
console.SetColor("LegalHoldOn", color.New(color.FgGreen, color.Bold))
console.SetColor("LegalHoldOff", color.New(color.FgRed, color.Bold))
console.SetColor("LegalHoldVersion", color.New(color.FgGreen))
console.SetColor("LegalHoldPartialFailure", color.New(color.FgRed, color.Bold))
console.SetColor("LegalHoldMessageFailure", color.New(color.FgYellow))
targetURL, versionID, timeRef, recursive, withVersions := parseLegalHoldArgs(cliCtx)
if timeRef.IsZero() && withVersions {
timeRef = time.Now().UTC()
}
ctx, cancelLegalHold := context.WithCancel(globalContext)
defer cancelLegalHold()
enabled, err := isBucketLockEnabled(ctx, targetURL)
if err != nil {
fatalIf(err, "Unable to get legalhold info of `%s`", targetURL)
}
if !enabled {
fatalIf(errDummy().Trace(), "Bucket lock needs to be enabled in order to use this feature.")
}
return showLegalHoldInfo(ctx, targetURL, versionID, timeRef, withVersions, recursive)
}