// This file is part of MinIO Console Server // Copyright (c) 2021 MinIO, Inc. // // 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 . package restapi import ( "context" "errors" "fmt" "strconv" "strings" "time" "github.com/rs/xid" "github.com/minio/mc/pkg/probe" "github.com/minio/mc/cmd/ilm" "github.com/minio/minio-go/v7" "github.com/minio/minio-go/v7/pkg/lifecycle" "github.com/go-openapi/runtime/middleware" "github.com/minio/console/models" "github.com/minio/console/restapi/operations" "github.com/minio/console/restapi/operations/user_api" ) type MultiLifecycleResult struct { BucketName string Error string } func registerBucketsLifecycleHandlers(api *operations.ConsoleAPI) { api.UserAPIGetBucketLifecycleHandler = user_api.GetBucketLifecycleHandlerFunc(func(params user_api.GetBucketLifecycleParams, session *models.Principal) middleware.Responder { listBucketLifecycleResponse, err := getBucketLifecycleResponse(session, params) if err != nil { return user_api.NewGetBucketLifecycleDefault(int(err.Code)).WithPayload(err) } return user_api.NewGetBucketLifecycleOK().WithPayload(listBucketLifecycleResponse) }) api.UserAPIAddBucketLifecycleHandler = user_api.AddBucketLifecycleHandlerFunc(func(params user_api.AddBucketLifecycleParams, session *models.Principal) middleware.Responder { err := getAddBucketLifecycleResponse(session, params) if err != nil { return user_api.NewAddBucketLifecycleDefault(int(err.Code)).WithPayload(err) } return user_api.NewAddBucketLifecycleCreated() }) api.UserAPIUpdateBucketLifecycleHandler = user_api.UpdateBucketLifecycleHandlerFunc(func(params user_api.UpdateBucketLifecycleParams, session *models.Principal) middleware.Responder { err := getEditBucketLifecycleRule(session, params) if err != nil { return user_api.NewUpdateBucketLifecycleDefault(int(err.Code)).WithPayload(err) } return user_api.NewUpdateBucketLifecycleOK() }) api.UserAPIDeleteBucketLifecycleRuleHandler = user_api.DeleteBucketLifecycleRuleHandlerFunc(func(params user_api.DeleteBucketLifecycleRuleParams, session *models.Principal) middleware.Responder { err := getDeleteBucketLifecycleRule(session, params) if err != nil { return user_api.NewDeleteBucketLifecycleRuleDefault(int(err.Code)).WithPayload(err) } return user_api.NewDeleteBucketLifecycleRuleNoContent() }) api.UserAPIAddMultiBucketLifecycleHandler = user_api.AddMultiBucketLifecycleHandlerFunc(func(params user_api.AddMultiBucketLifecycleParams, session *models.Principal) middleware.Responder { multiBucketResponse, err := getAddMultiBucketLifecycleResponse(session, params) if err != nil { user_api.NewAddMultiBucketLifecycleDefault(int(err.Code)).WithPayload(err) } return user_api.NewAddMultiBucketLifecycleOK().WithPayload(multiBucketResponse) }) } // getBucketLifecycle() gets lifecycle lists for a bucket from MinIO API and returns their implementations func getBucketLifecycle(ctx context.Context, client MinioClient, bucketName string) (*models.BucketLifecycleResponse, error) { lifecycleList, err := client.getLifecycleRules(ctx, bucketName) if err != nil { return nil, err } var rules []*models.ObjectBucketLifecycle for _, rule := range lifecycleList.Rules { var tags []*models.LifecycleTag for _, tagData := range rule.RuleFilter.And.Tags { tags = append(tags, &models.LifecycleTag{ Key: tagData.Key, Value: tagData.Value, }) } rulePrefix := rule.RuleFilter.And.Prefix if rulePrefix == "" { rulePrefix = rule.RuleFilter.Prefix } rules = append(rules, &models.ObjectBucketLifecycle{ ID: rule.ID, Status: rule.Status, Prefix: rulePrefix, Expiration: &models.ExpirationResponse{ Date: rule.Expiration.Date.Format(time.RFC3339), Days: int64(rule.Expiration.Days), DeleteMarker: rule.Expiration.DeleteMarker.IsEnabled(), NoncurrentExpirationDays: int64(rule.NoncurrentVersionExpiration.NoncurrentDays), }, Transition: &models.TransitionResponse{ Date: rule.Transition.Date.Format(time.RFC3339), Days: int64(rule.Transition.Days), StorageClass: rule.Transition.StorageClass, NoncurrentStorageClass: rule.NoncurrentVersionTransition.StorageClass, NoncurrentTransitionDays: int64(rule.NoncurrentVersionTransition.NoncurrentDays), }, Tags: tags, }) } // serialize output lifecycleBucketsResponse := &models.BucketLifecycleResponse{ Lifecycle: rules, } return lifecycleBucketsResponse, nil } // getBucketLifecycleResponse performs getBucketLifecycle() and serializes it to the handler's output func getBucketLifecycleResponse(session *models.Principal, params user_api.GetBucketLifecycleParams) (*models.BucketLifecycleResponse, *models.Error) { ctx := context.Background() mClient, err := newMinioClient(session) if err != nil { return nil, prepareError(err) } // create a minioClient interface implementation // defining the client to be used minioClient := minioClient{client: mClient} bucketEvents, err := getBucketLifecycle(ctx, minioClient, params.BucketName) if err != nil { return nil, prepareError(errBucketLifeCycleNotConfigured, err) } return bucketEvents, nil } // addBucketLifecycle gets lifecycle lists for a bucket from MinIO API and returns their implementations func addBucketLifecycle(ctx context.Context, client MinioClient, params user_api.AddBucketLifecycleParams) error { // Configuration that is already set. lfcCfg, err := client.getLifecycleRules(ctx, params.BucketName) if err != nil { if e := err; minio.ToErrorResponse(e).Code == "NoSuchLifecycleConfiguration" { lfcCfg = lifecycle.NewConfiguration() } else { return err } } id := xid.New().String() opts := ilm.LifecycleOptions{} // Verify if transition rule is requested if params.Body.Type == models.AddBucketLifecycleTypeTransition { if params.Body.TransitionDays == 0 && params.Body.NoncurrentversionTransitionDays == 0 { return errors.New("only one expiry configuration can be set (days or date)") } opts = ilm.LifecycleOptions{ ID: id, Prefix: params.Body.Prefix, Status: !params.Body.Disable, IsTagsSet: params.Body.Tags != "", Tags: params.Body.Tags, TransitionDays: strconv.Itoa(int(params.Body.TransitionDays)), StorageClass: strings.ToUpper(params.Body.StorageClass), ExpiredObjectDeleteMarker: params.Body.ExpiredObjectDeleteMarker, NoncurrentVersionTransitionDays: int(params.Body.NoncurrentversionTransitionDays), NoncurrentVersionTransitionStorageClass: strings.ToUpper(params.Body.NoncurrentversionTransitionStorageClass), IsTransitionDaysSet: params.Body.TransitionDays != 0, IsNoncurrentVersionTransitionDaysSet: params.Body.NoncurrentversionTransitionDays != 0, } } else if params.Body.Type == models.AddBucketLifecycleTypeExpiry { // Verify if expiry items are set if params.Body.NoncurrentversionTransitionDays != 0 { return errors.New("non current version Transition Days cannot be set when expiry is being configured") } if params.Body.NoncurrentversionTransitionStorageClass != "" { return errors.New("non current version Transition Storage Class cannot be set when expiry is being configured") } opts = ilm.LifecycleOptions{ ID: id, Prefix: params.Body.Prefix, Status: !params.Body.Disable, IsTagsSet: params.Body.Tags != "", Tags: params.Body.Tags, ExpiryDays: strconv.Itoa(int(params.Body.ExpiryDays)), ExpiredObjectDeleteMarker: params.Body.ExpiredObjectDeleteMarker, NoncurrentVersionExpirationDays: int(params.Body.NoncurrentversionExpirationDays), } } else { // Non set, we return error return errors.New("no valid configuration requested") } var err2 *probe.Error lfcCfg, err2 = opts.ToConfig(lfcCfg) if err2.ToGoError() != nil { return err2.ToGoError() } return client.setBucketLifecycle(ctx, params.BucketName, lfcCfg) } // getAddBucketLifecycleResponse returns the response of adding a bucket lifecycle response func getAddBucketLifecycleResponse(session *models.Principal, params user_api.AddBucketLifecycleParams) *models.Error { ctx := context.Background() mClient, err := newMinioClient(session) if err != nil { return prepareError(err) } // create a minioClient interface implementation // defining the client to be used minioClient := minioClient{client: mClient} err = addBucketLifecycle(ctx, minioClient, params) if err != nil { return prepareError(err) } return nil } // editBucketLifecycle gets lifecycle lists for a bucket from MinIO API and updates the selected lifecycle rule func editBucketLifecycle(ctx context.Context, client MinioClient, params user_api.UpdateBucketLifecycleParams) error { // Configuration that is already set. lfcCfg, err := client.getLifecycleRules(ctx, params.BucketName) if err != nil { if e := err; minio.ToErrorResponse(e).Code == "NoSuchLifecycleConfiguration" { lfcCfg = lifecycle.NewConfiguration() } else { return err } } id := params.LifecycleID opts := ilm.LifecycleOptions{} // Verify if transition items are set if *params.Body.Type == models.UpdateBucketLifecycleTypeTransition { if params.Body.TransitionDays == 0 && params.Body.NoncurrentversionTransitionDays == 0 { return errors.New("you must select transition days or non-current transition days configuration") } opts = ilm.LifecycleOptions{ ID: id, Prefix: params.Body.Prefix, Status: !params.Body.Disable, IsTagsSet: params.Body.Tags != "", Tags: params.Body.Tags, TransitionDays: strconv.Itoa(int(params.Body.TransitionDays)), StorageClass: strings.ToUpper(params.Body.StorageClass), ExpiredObjectDeleteMarker: params.Body.ExpiredObjectDeleteMarker, NoncurrentVersionTransitionDays: int(params.Body.NoncurrentversionTransitionDays), NoncurrentVersionTransitionStorageClass: strings.ToUpper(params.Body.NoncurrentversionTransitionStorageClass), IsTransitionDaysSet: params.Body.TransitionDays != 0, IsNoncurrentVersionTransitionDaysSet: params.Body.NoncurrentversionTransitionDays != 0, } } else if *params.Body.Type == models.UpdateBucketLifecycleTypeExpiry { // Verify if expiry configuration is set if params.Body.NoncurrentversionTransitionDays != 0 { return errors.New("non current version Transition Days cannot be set when expiry is being configured") } if params.Body.NoncurrentversionTransitionStorageClass != "" { return errors.New("non current version Transition Storage Class cannot be set when expiry is being configured") } opts = ilm.LifecycleOptions{ ID: id, Prefix: params.Body.Prefix, Status: !params.Body.Disable, IsTagsSet: params.Body.Tags != "", Tags: params.Body.Tags, ExpiryDays: strconv.Itoa(int(params.Body.ExpiryDays)), ExpiredObjectDeleteMarker: params.Body.ExpiredObjectDeleteMarker, NoncurrentVersionExpirationDays: int(params.Body.NoncurrentversionExpirationDays), } } else { // Non set, we return error return errors.New("no valid configuration requested") } var err2 *probe.Error lfcCfg, err2 = opts.ToConfig(lfcCfg) if err2.ToGoError() != nil { return err2.ToGoError() } return client.setBucketLifecycle(ctx, params.BucketName, lfcCfg) } // getEditBucketLifecycleRule returns the response of bucket lifecycle tier edit func getEditBucketLifecycleRule(session *models.Principal, params user_api.UpdateBucketLifecycleParams) *models.Error { ctx := context.Background() mClient, err := newMinioClient(session) if err != nil { return prepareError(err) } // create a minioClient interface implementation // defining the client to be used minioClient := minioClient{client: mClient} err = editBucketLifecycle(ctx, minioClient, params) if err != nil { return prepareError(err) } return nil } // deleteBucketLifecycle deletes lifecycle rule by passing an empty rule to a selected ID func deleteBucketLifecycle(ctx context.Context, client MinioClient, params user_api.DeleteBucketLifecycleRuleParams) error { // Configuration that is already set. lfcCfg, err := client.getLifecycleRules(ctx, params.BucketName) if err != nil { if e := err; minio.ToErrorResponse(e).Code == "NoSuchLifecycleConfiguration" { lfcCfg = lifecycle.NewConfiguration() } else { return err } } if len(lfcCfg.Rules) == 0 { return errors.New("no rules available to delete") } var newRules []lifecycle.Rule for _, rule := range lfcCfg.Rules { if rule.ID != params.LifecycleID { newRules = append(newRules, rule) } } if len(newRules) == len(lfcCfg.Rules) && len(lfcCfg.Rules) > 0 { // rule doesn't exist return fmt.Errorf("lifecycle rule for id '%s' doesn't exist", params.LifecycleID) } lfcCfg.Rules = newRules return client.setBucketLifecycle(ctx, params.BucketName, lfcCfg) } // getDeleteBucketLifecycleRule returns the response of bucket lifecycle tier delete func getDeleteBucketLifecycleRule(session *models.Principal, params user_api.DeleteBucketLifecycleRuleParams) *models.Error { ctx := context.Background() mClient, err := newMinioClient(session) if err != nil { return prepareError(err) } // create a minioClient interface implementation // defining the client to be used minioClient := minioClient{client: mClient} err = deleteBucketLifecycle(ctx, minioClient, params) if err != nil { return prepareError(err) } return nil } // addMultiBucketLifecycle creates multibuckets lifecycle assignments func addMultiBucketLifecycle(ctx context.Context, client MinioClient, params user_api.AddMultiBucketLifecycleParams) []MultiLifecycleResult { bucketsRelation := params.Body.Buckets // Parallel Lifecycle rules set parallelLifecycleBucket := func(bucketName string) chan MultiLifecycleResult { remoteProc := make(chan MultiLifecycleResult) lifecycleParams := models.AddBucketLifecycle{ Type: *params.Body.Type, StorageClass: params.Body.StorageClass, TransitionDays: params.Body.TransitionDays, Prefix: params.Body.Prefix, NoncurrentversionTransitionDays: params.Body.NoncurrentversionTransitionDays, NoncurrentversionTransitionStorageClass: params.Body.NoncurrentversionTransitionStorageClass, NoncurrentversionExpirationDays: params.Body.NoncurrentversionExpirationDays, Tags: params.Body.Tags, ExpiryDays: params.Body.ExpiryDays, Disable: false, ExpiredObjectDeleteMarker: params.Body.ExpiredObjectDeleteMarker, } go func() { defer close(remoteProc) lifecycleParams := user_api.AddBucketLifecycleParams{ BucketName: bucketName, Body: &lifecycleParams, } // We add lifecycle rule & expect a response err := addBucketLifecycle(ctx, client, lifecycleParams) var errorReturn = "" if err != nil { errorReturn = err.Error() } retParams := MultiLifecycleResult{ BucketName: bucketName, Error: errorReturn, } remoteProc <- retParams }() return remoteProc } var lifecycleManagement []chan MultiLifecycleResult for _, bucketName := range bucketsRelation { rBucket := parallelLifecycleBucket(bucketName) lifecycleManagement = append(lifecycleManagement, rBucket) } var resultsList []MultiLifecycleResult for _, result := range lifecycleManagement { res := <-result resultsList = append(resultsList, res) } return resultsList } // getAddMultiBucketLifecycleResponse returns the response of multibucket lifecycle assignment func getAddMultiBucketLifecycleResponse(session *models.Principal, params user_api.AddMultiBucketLifecycleParams) (*models.MultiLifecycleResult, *models.Error) { ctx := context.Background() mClient, err := newMinioClient(session) if err != nil { return nil, prepareError(err) } // create a minioClient interface implementation // defining the client to be used minioClient := minioClient{client: mClient} multiCycleResult := addMultiBucketLifecycle(ctx, minioClient, params) var returnList []*models.MulticycleResultItem for _, resultItem := range multiCycleResult { multicycleRS := models.MulticycleResultItem{ BucketName: resultItem.BucketName, Error: resultItem.Error, } returnList = append(returnList, &multicycleRS) } finalResult := models.MultiLifecycleResult{Results: returnList} return &finalResult, nil }