github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/internal/bucket/lifecycle/filter.go

// 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 lifecycle

import (
	"encoding/xml"
	"io"

	"github.com/minio/minio-go/v7/pkg/tags"
)

var errInvalidFilter = Errorf("Filter must have exactly one of Prefix, Tag, or And specified")

// Filter - a filter for a lifecycle configuration Rule.
type Filter struct {
	XMLName xml.Name `xml:"Filter"`
	set     bool

	Prefix Prefix

	ObjectSizeGreaterThan int64 `xml:"ObjectSizeGreaterThan,omitempty"`
	ObjectSizeLessThan    int64 `xml:"ObjectSizeLessThan,omitempty"`

	And    And
	andSet bool

	Tag    Tag
	tagSet bool

	// Caching tags, only once
	cachedTags map[string]string
}

// MarshalXML - produces the xml representation of the Filter struct
// only one of Prefix, And and Tag should be present in the output.
func (f Filter) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
	if err := e.EncodeToken(start); err != nil {
		return err
	}

	switch {
	case !f.And.isEmpty():
		if err := e.EncodeElement(f.And, xml.StartElement{Name: xml.Name{Local: "And"}}); err != nil {
			return err
		}
	case !f.Tag.IsEmpty():
		if err := e.EncodeElement(f.Tag, xml.StartElement{Name: xml.Name{Local: "Tag"}}); err != nil {
			return err
		}
	default:
		// Always print Prefix field when both And & Tag are empty
		if err := e.EncodeElement(f.Prefix, xml.StartElement{Name: xml.Name{Local: "Prefix"}}); err != nil {
			return err
		}

		if f.ObjectSizeLessThan > 0 {
			if err := e.EncodeElement(f.ObjectSizeLessThan, xml.StartElement{Name: xml.Name{Local: "ObjectSizeLessThan"}}); err != nil {
				return err
			}
		}
		if f.ObjectSizeGreaterThan > 0 {
			if err := e.EncodeElement(f.ObjectSizeGreaterThan, xml.StartElement{Name: xml.Name{Local: "ObjectSizeGreaterThan"}}); err != nil {
				return err
			}
		}
	}

	return e.EncodeToken(xml.EndElement{Name: start.Name})
}

// UnmarshalXML - decodes XML data.
func (f *Filter) UnmarshalXML(d *xml.Decoder, start xml.StartElement) (err error) {
	f.set = true
	for {
		// Read tokens from the XML document in a stream.
		t, err := d.Token()
		if err != nil {
			if err == io.EOF {
				break
			}
			return err
		}

		if se, ok := t.(xml.StartElement); ok {
			switch se.Name.Local {
			case "Prefix":
				var p Prefix
				if err = d.DecodeElement(&p, &se); err != nil {
					return err
				}
				f.Prefix = p
			case "And":
				var and And
				if err = d.DecodeElement(&and, &se); err != nil {
					return err
				}
				f.And = and
				f.andSet = true
			case "Tag":
				var tag Tag
				if err = d.DecodeElement(&tag, &se); err != nil {
					return err
				}
				f.Tag = tag
				f.tagSet = true
			case "ObjectSizeLessThan":
				var sz int64
				if err = d.DecodeElement(&sz, &se); err != nil {
					return err
				}
				f.ObjectSizeLessThan = sz
			case "ObjectSizeGreaterThan":
				var sz int64
				if err = d.DecodeElement(&sz, &se); err != nil {
					return err
				}
				f.ObjectSizeGreaterThan = sz
			default:
				return errUnknownXMLTag
			}
		}
	}
	return nil
}

// IsEmpty returns true if Filter is not specified in the XML
func (f Filter) IsEmpty() bool {
	return !f.set
}

// Validate - validates the filter element
func (f Filter) Validate() error {
	if f.IsEmpty() {
		return errXMLNotWellFormed
	}
	// A Filter must have exactly one of Prefix, Tag,
	// ObjectSize{LessThan,GreaterThan} or And specified.
	type predType uint8
	const (
		nonePred predType = iota
		prefixPred
		andPred
		tagPred
		sizeLtPred
		sizeGtPred
	)
	var predCount int
	var pType predType
	if !f.And.isEmpty() {
		pType = andPred
		predCount++
	}
	if f.Prefix.set {
		pType = prefixPred
		predCount++
	}
	if !f.Tag.IsEmpty() {
		pType = tagPred
		predCount++
	}
	if f.ObjectSizeGreaterThan != 0 {
		pType = sizeGtPred
		predCount++
	}
	if f.ObjectSizeLessThan != 0 {
		pType = sizeLtPred
		predCount++
	}
	// Note: S3 supports empty <Filter></Filter>, so predCount == 0 is
	// valid.
	if predCount > 1 {
		return errInvalidFilter
	}

	var err error
	switch pType {
	case nonePred:
	// S3 supports empty <Filter></Filter>
	case prefixPred:
	case andPred:
		err = f.And.Validate()
	case tagPred:
		err = f.Tag.Validate()
	case sizeLtPred:
		if f.ObjectSizeLessThan < 0 {
			err = errXMLNotWellFormed
		}
	case sizeGtPred:
		if f.ObjectSizeGreaterThan < 0 {
			err = errXMLNotWellFormed
		}
	}
	return err
}

// TestTags tests if the object tags satisfy the Filter tags requirement,
// it returns true if there is no tags in the underlying Filter.
func (f Filter) TestTags(userTags string) bool {
	if f.cachedTags == nil {
		cache := make(map[string]string)
		for _, t := range append(f.And.Tags, f.Tag) {
			if !t.IsEmpty() {
				cache[t.Key] = t.Value
			}
		}
		f.cachedTags = cache
	}

	// This filter does not have any tags, always return true
	if len(f.cachedTags) == 0 {
		return true
	}

	parsedTags, err := tags.ParseObjectTags(userTags)
	if err != nil {
		return false
	}
	tagsMap := parsedTags.ToMap()

	// Not enough tags on object to satisfy the rule filter's tags
	if len(tagsMap) < len(f.cachedTags) {
		return false
	}

	var mismatch bool
	for k, cv := range f.cachedTags {
		v, ok := tagsMap[k]
		if !ok || v != cv {
			mismatch = true
			break
		}
	}
	return !mismatch
}

// BySize returns true if sz satisfies one of ObjectSizeGreaterThan,
// ObjectSizeLessThan predicates or a combination of them via And.
func (f Filter) BySize(sz int64) bool {
	if f.ObjectSizeGreaterThan > 0 &&
		sz <= f.ObjectSizeGreaterThan {
		return false
	}
	if f.ObjectSizeLessThan > 0 &&
		sz >= f.ObjectSizeLessThan {
		return false
	}
	if !f.And.isEmpty() {
		return f.And.BySize(sz)
	}
	return true
}