github.com/vmware/govmomi@v0.51.0/property/match.go

// © Broadcom. All Rights Reserved.
// The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
// SPDX-License-Identifier: Apache-2.0

package property

import (
	"fmt"
	"path"
	"reflect"
	"strconv"
	"strings"

	"github.com/vmware/govmomi/vim25/types"
)

// Match provides methods for matching against types.DynamicProperty
type Match map[string]types.AnyType

// Keys returns the Match map keys as a []string
func (m Match) Keys() []string {
	keys := make([]string, 0, len(m))

	for key := range m {
		keys = append(keys, key)
	}

	return keys
}

// Property returns true if an entry matches the given prop.
func (m Match) Property(prop types.DynamicProperty) bool {
	if prop.Val == nil {
		return false
	}
	match, ok := m[prop.Name]
	if !ok {
		return false
	}

	if match == prop.Val {
		return true
	}

	if matchFunc, ok := match.(func(any) bool); ok {
		if matchFunc(prop.Val) {
			return true
		}
	}

	ptype := reflect.TypeOf(prop.Val)

	if strings.HasPrefix(ptype.Name(), "ArrayOf") {
		pval := reflect.ValueOf(prop.Val).Field(0)

		for i := 0; i < pval.Len(); i++ {
			prop.Val = pval.Index(i).Interface()

			if m.Property(prop) {
				return true
			}
		}

		return false
	}

	if reflect.TypeOf(match) != ptype {
		s, ok := match.(string)
		if !ok {
			return false
		}

		// convert if we can
		switch val := prop.Val.(type) {
		case bool:
			match, _ = strconv.ParseBool(s)
		case int16:
			x, _ := strconv.ParseInt(s, 10, 16)
			match = int16(x)
		case int32:
			x, _ := strconv.ParseInt(s, 10, 32)
			match = int32(x)
		case int64:
			match, _ = strconv.ParseInt(s, 10, 64)
		case float32:
			x, _ := strconv.ParseFloat(s, 32)
			match = float32(x)
		case float64:
			match, _ = strconv.ParseFloat(s, 64)
		case fmt.Stringer:
			prop.Val = val.String()
		case *types.CustomFieldStringValue:
			prop.Val = fmt.Sprintf("%d:%s", val.Key, val.Value)
		default:
			if ptype.Kind() != reflect.String {
				return false
			}
			// An enum type we can convert to a string type
			prop.Val = reflect.ValueOf(prop.Val).String()
		}
	}

	switch pval := prop.Val.(type) {
	case string:
		s := match.(string)
		if s == "*" {
			return true // TODO: path.Match fails if s contains a '/'
		}
		m, _ := path.Match(s, pval)
		return m
	default:
		return reflect.DeepEqual(match, pval)
	}
}

// List returns true if all given props match.
func (m Match) List(props []types.DynamicProperty) bool {
	for _, p := range props {
		if !m.Property(p) {
			return false
		}
	}

	return len(m) == len(props) // false if a property such as VM "guest" is unset
}

// ObjectContent returns a list of ObjectContent.Obj where the
// ObjectContent.PropSet matches all properties the Filter.
func (m Match) ObjectContent(objects []types.ObjectContent) []types.ManagedObjectReference {
	var refs []types.ManagedObjectReference

	for _, o := range objects {
		if m.List(o.PropSet) {
			refs = append(refs, o.Obj)
		}
	}

	return refs
}

// AnyList returns true if any given props match.
func (m Match) AnyList(props []types.DynamicProperty) bool {
	for _, p := range props {
		if m.Property(p) {
			return true
		}
	}

	return false
}

// AnyObjectContent returns a list of ObjectContent.Obj where the
// ObjectContent.PropSet matches any property.
func (m Match) AnyObjectContent(objects []types.ObjectContent) []types.ManagedObjectReference {
	var refs []types.ManagedObjectReference

	for _, o := range objects {
		if m.AnyList(o.PropSet) {
			refs = append(refs, o.Obj)
		}
	}

	return refs
}