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
|
// Copyright (c) 2015-2025 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 ilm
import (
"github.com/minio/minio-go/v7/pkg/lifecycle"
)
const defaultILMDateFormat string = "2006-01-02"
// LifecycleOptions - options for ILM rule
type LifecycleOptions struct {
ID string
Status *bool
Prefix *string
Tags *string
ObjectSizeLessThan *int64
ObjectSizeGreaterThan *int64
ExpiryDate *string
ExpiryDays *string
TransitionDate *string
TransitionDays *string
StorageClass *string
ExpiredObjectDeleteMarker *bool
NoncurrentVersionExpirationDays *int
NewerNoncurrentExpirationVersions *int
NoncurrentVersionTransitionDays *int
NewerNoncurrentTransitionVersions *int
NoncurrentVersionTransitionStorageClass *string
PurgeAllVersionsDays *string
PurgeAllVersionsDeleteMarker *bool
}
// Filter returns lifecycle.Filter appropriate for opts
func (opts LifecycleOptions) Filter() lifecycle.Filter {
var f lifecycle.Filter
var tags []lifecycle.Tag
var predCount int
if opts.Tags != nil {
tags = extractILMTags(*opts.Tags)
predCount += len(tags)
}
var prefix string
if opts.Prefix != nil {
prefix = *opts.Prefix
predCount++
}
var szLt, szGt int64
if opts.ObjectSizeLessThan != nil {
szLt = *opts.ObjectSizeLessThan
predCount++
}
if opts.ObjectSizeGreaterThan != nil {
szGt = *opts.ObjectSizeGreaterThan
predCount++
}
if predCount >= 2 {
f.And = lifecycle.And{
Tags: tags,
Prefix: prefix,
ObjectSizeLessThan: szLt,
ObjectSizeGreaterThan: szGt,
}
} else {
// In a valid lifecycle rule filter at most one of the
// following will only be set.
f.Prefix = prefix
f.ObjectSizeGreaterThan = szGt
f.ObjectSizeLessThan = szLt
if len(tags) >= 1 {
f.Tag = tags[0]
}
}
return f
}
// ToILMRule creates lifecycle.Configuration based on LifecycleOptions
func (opts LifecycleOptions) ToILMRule() (lifecycle.Rule, error) {
var (
id, status string
nonCurrentVersionExpirationDays lifecycle.ExpirationDays
newerNonCurrentExpirationVersions int
nonCurrentVersionTransitionDays lifecycle.ExpirationDays
newerNonCurrentTransitionVersions int
nonCurrentVersionTransitionStorageClass string
)
id = opts.ID
status = func() string {
if opts.Status != nil && !*opts.Status {
return "Disabled"
}
// Generating a new ILM rule without explicit status is enabled
return "Enabled"
}()
expiry, err := parseExpiry(opts.ExpiryDate, opts.ExpiryDays, opts.ExpiredObjectDeleteMarker)
if err != nil {
return lifecycle.Rule{}, err
}
allVersExpiry, err := parseAllVersionsExpiry(opts.PurgeAllVersionsDays, opts.PurgeAllVersionsDeleteMarker)
if err != nil {
return lifecycle.Rule{}, err
}
transition, err := parseTransition(opts.StorageClass, opts.TransitionDate, opts.TransitionDays)
if err != nil {
return lifecycle.Rule{}, err
}
if opts.NoncurrentVersionExpirationDays != nil {
nonCurrentVersionExpirationDays = lifecycle.ExpirationDays(*opts.NoncurrentVersionExpirationDays)
}
if opts.NewerNoncurrentExpirationVersions != nil {
newerNonCurrentExpirationVersions = *opts.NewerNoncurrentExpirationVersions
}
if opts.NoncurrentVersionTransitionDays != nil {
nonCurrentVersionTransitionDays = lifecycle.ExpirationDays(*opts.NoncurrentVersionTransitionDays)
}
if opts.NewerNoncurrentTransitionVersions != nil {
newerNonCurrentTransitionVersions = *opts.NewerNoncurrentTransitionVersions
}
if opts.NoncurrentVersionTransitionStorageClass != nil {
nonCurrentVersionTransitionStorageClass = *opts.NoncurrentVersionTransitionStorageClass
}
newRule := lifecycle.Rule{
ID: id,
RuleFilter: opts.Filter(),
Status: status,
Expiration: expiry,
Transition: transition,
AllVersionsExpiration: allVersExpiry,
NoncurrentVersionExpiration: lifecycle.NoncurrentVersionExpiration{
NoncurrentDays: nonCurrentVersionExpirationDays,
NewerNoncurrentVersions: newerNonCurrentExpirationVersions,
},
NoncurrentVersionTransition: lifecycle.NoncurrentVersionTransition{
NoncurrentDays: nonCurrentVersionTransitionDays,
NewerNoncurrentVersions: newerNonCurrentTransitionVersions,
StorageClass: nonCurrentVersionTransitionStorageClass,
},
}
if err := validateILMRule(newRule); err != nil {
return lifecycle.Rule{}, err
}
return newRule, nil
}
// ApplyRuleFields applies non nil fields of LifecycleOptions to the existing lifecycle rule
func ApplyRuleFields(dest *lifecycle.Rule, opts LifecycleOptions) error {
// If src has tags, it should override the destination
if opts.Tags != nil {
dest.RuleFilter.And.Tags = extractILMTags(*opts.Tags)
// If there are tag filters on the rule, the prefix filter must be in the And field, if tags are not used, prefix must be in the Prefix field
if len(dest.RuleFilter.And.Prefix) > 0 || len(dest.RuleFilter.Prefix) > 0 {
var p string
if len(dest.RuleFilter.And.Prefix) > 0 {
p = dest.RuleFilter.And.Prefix
}
if len(dest.RuleFilter.Prefix) > 0 {
p = dest.RuleFilter.Prefix
}
if len(*opts.Tags) > 0 {
dest.RuleFilter.And.Prefix = p
dest.RuleFilter.Prefix = ""
} else {
dest.RuleFilter.Prefix = p
dest.RuleFilter.And.Prefix = ""
}
}
}
// since prefix is a part of command args, it is always present in the src rule and
// it should be always set to the destination.
if opts.Prefix != nil {
// if there are tags, the prefix must go into the And field, and the Prefix field must be empty
if len(dest.RuleFilter.And.Tags) > 0 {
dest.RuleFilter.Prefix = ""
dest.RuleFilter.And.Prefix = *opts.Prefix
} else {
dest.RuleFilter.Prefix = *opts.Prefix
dest.RuleFilter.And.Prefix = ""
}
}
// only one of expiration day, date or transition day, date is expected
if opts.ExpiryDate != nil {
date, err := parseExpiryDate(*opts.ExpiryDate)
if err != nil {
return err
}
dest.Expiration.Date = date
// reset everything else
dest.Expiration.Days = 0
dest.Expiration.DeleteMarker = false
} else if opts.ExpiryDays != nil {
days, err := parseExpiryDays(*opts.ExpiryDays)
if err != nil {
return err
}
dest.Expiration.Days = days
// reset everything else
dest.Expiration.Date = lifecycle.ExpirationDate{}
} else if opts.ExpiredObjectDeleteMarker != nil {
dest.Expiration.DeleteMarker = lifecycle.ExpireDeleteMarker(*opts.ExpiredObjectDeleteMarker)
dest.Expiration.Days = 0
dest.Expiration.Date = lifecycle.ExpirationDate{}
}
if opts.PurgeAllVersionsDays != nil {
days, err := parseExpiryDays(*opts.PurgeAllVersionsDays)
if err != nil {
return err
}
dest.AllVersionsExpiration.Days = int(days)
}
if opts.PurgeAllVersionsDeleteMarker != nil {
dest.AllVersionsExpiration.DeleteMarker = lifecycle.ExpireDeleteMarker(*opts.PurgeAllVersionsDeleteMarker)
}
if opts.TransitionDate != nil {
date, err := parseTransitionDate(*opts.TransitionDate)
if err != nil {
return err
}
dest.Transition.Date = date
// reset everything else
dest.Transition.Days = 0
} else if opts.TransitionDays != nil {
days, err := parseTransitionDays(*opts.TransitionDays)
if err != nil {
return err
}
dest.Transition.Days = days
// reset everything else
dest.Transition.Date = lifecycle.ExpirationDate{}
}
if opts.NoncurrentVersionExpirationDays != nil {
dest.NoncurrentVersionExpiration.NoncurrentDays = lifecycle.ExpirationDays(*opts.NoncurrentVersionExpirationDays)
}
if opts.NewerNoncurrentExpirationVersions != nil {
dest.NoncurrentVersionExpiration.NewerNoncurrentVersions = *opts.NewerNoncurrentExpirationVersions
}
if opts.NoncurrentVersionTransitionDays != nil {
dest.NoncurrentVersionTransition.NoncurrentDays = lifecycle.ExpirationDays(*opts.NoncurrentVersionTransitionDays)
}
if opts.NewerNoncurrentTransitionVersions != nil {
dest.NoncurrentVersionTransition.NewerNoncurrentVersions = *opts.NewerNoncurrentTransitionVersions
}
if opts.NoncurrentVersionTransitionStorageClass != nil {
dest.NoncurrentVersionTransition.StorageClass = *opts.NoncurrentVersionTransitionStorageClass
}
if opts.StorageClass != nil {
dest.Transition.StorageClass = *opts.StorageClass
}
// Updated the status
if opts.Status != nil {
dest.Status = func() string {
if *opts.Status {
return "Enabled"
}
return "Disabled"
}()
}
return nil
}
|