lang/core/list/list_lookup.go

// Mgmt
// Copyright (C) 2013-2024+ James Shubin and the project contributors
// Written by James Shubin <james@shubin.ca> and the project contributors
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
// Additional permission under GNU GPL version 3 section 7
//
// If you modify this program, or any covered work, by linking or combining it
// with embedded mcl code and modules (and that the embedded mcl code and
// modules which link with this program, contain a copy of their source code in
// the authoritative form) containing parts covered by the terms of any other
// license, the licensors of this program grant you additional permission to
// convey the resulting work. Furthermore, the licensors of this program grant
// the original author, James Shubin, additional permission to update this
// additional permission if he deems it necessary to achieve the goals of this
// additional permission.

package corelist

import (
	"context"
	"fmt"
	"math"

	"github.com/purpleidea/mgmt/lang/funcs"
	"github.com/purpleidea/mgmt/lang/funcs/wrapped"
	"github.com/purpleidea/mgmt/lang/interfaces"
	"github.com/purpleidea/mgmt/lang/types"
	"github.com/purpleidea/mgmt/util/errwrap"
)

const (
	// ListLookupFuncName is the name this function is registered as.
	ListLookupFuncName = "lookup" // list.lookup

	// arg names...
	listLookupArgNameList    = "list"
	listLookupArgNameIndex   = "index"
	listLookupArgNameDefault = "default"
)

func init() {
	funcs.ModuleRegister(ModuleName, ListLookupFuncName, func() interfaces.Func { return &ListLookupFunc{} }) // must register the func and name
}

var _ interfaces.BuildableFunc = &ListLookupFunc{} // ensure it meets this expectation

// ListLookupFunc is a list index lookup function. It can take either two or
// three arguments. The first argument is the list to lookup a value in. The
// second is the integer index. If you specify a third argument, then this value
// will be returned if the list index is not present. If the third argument is
// omitted, then this function errors if the list index is not present. Passing
// a negative index will always result in an error.
type ListLookupFunc struct {
	*wrapped.Func // *wrapped.Func as a type alias to pull in the base impl.

	Type *types.Type // Kind == List, that is used as the list we lookup in

	hasDefault *bool // does this function take a third arg?

	init *interfaces.Init
	last types.Value // last value received to use for diff

	result types.Value // last calculated output
}

// String returns a simple name for this function. This is needed so this struct
// can satisfy the pgraph.Vertex interface.
func (obj *ListLookupFunc) String() string {
	return ListLookupFuncName
}

// ArgGen returns the Nth arg name for this function.
func (obj *ListLookupFunc) ArgGen(index int) (string, error) {
	seq := []string{listLookupArgNameList, listLookupArgNameIndex, listLookupArgNameDefault}
	if l := len(seq); index >= l {
		return "", fmt.Errorf("index %d exceeds arg length of %d", index, l)
	}
	return seq[index], nil
}

// helper
func (obj *ListLookupFunc) sig() *types.Type {
	// func(list []?1, index int) ?1
	// OR
	// func(list []?1, index int, default ?1) ?1

	if obj.hasDefault == nil { // not yet known
		return nil
	}

	v := "?1"
	if obj.Type != nil { // don't panic if called speculatively
		v = obj.Type.Val.String()
	}

	if *obj.hasDefault {
		return types.NewType(fmt.Sprintf(
			"func(%s []%s, %s int, %s %s) %s",
			listLookupArgNameList, v,
			listLookupArgNameIndex,
			listLookupArgNameDefault, v,
			v,
		))
	}

	return types.NewType(fmt.Sprintf(
		"func(%s []%s, %s int) %s",
		listLookupArgNameList, v,
		listLookupArgNameIndex,
		v,
	))
}

// FuncInfer takes partial type and value information from the call site of this
// function so that it can build an appropriate type signature for it. The type
// signature may include unification variables.
func (obj *ListLookupFunc) FuncInfer(partialType *types.Type, partialValues []types.Value) (*types.Type, []*interfaces.UnificationInvariant, error) {
	if l := len(partialValues); l != 2 && l != 3 {
		return nil, nil, fmt.Errorf("function must have either 2 or 3 args")
	}

	b := false
	//if len(partialValues) == 2 {
	//	b = false
	//}
	if len(partialValues) == 3 {
		b = true
	}
	obj.hasDefault = &b // store for later

	return obj.sig(), []*interfaces.UnificationInvariant{}, nil
}

// Build is run to turn the polymorphic, undetermined function, into the
// specific statically typed version. It is usually run after Unify completes,
// and must be run before Info() and any of the other Func interface methods are
// used. This function is idempotent, as long as the arg isn't changed between
// runs.
func (obj *ListLookupFunc) Build(typ *types.Type) (*types.Type, error) {
	// typ is the KindFunc signature we're trying to build...
	if typ.Kind != types.KindFunc {
		return nil, fmt.Errorf("input type must be of kind func")
	}

	if obj.hasDefault == nil {
		return nil, fmt.Errorf("the listlookup function needs exactly two or three args")
	}
	if *obj.hasDefault && len(typ.Ord) != 3 {
		return nil, fmt.Errorf("the listlookup function needs exactly three args")
	}
	if !*obj.hasDefault && len(typ.Ord) != 2 {
		return nil, fmt.Errorf("the listlookup function needs exactly two args")
	}

	if typ.Out == nil {
		return nil, fmt.Errorf("return type of function must be specified")
	}
	if typ.Map == nil {
		return nil, fmt.Errorf("invalid input type")
	}

	tList, exists := typ.Map[typ.Ord[0]]
	if !exists || tList == nil {
		return nil, fmt.Errorf("first arg must be specified")
	}

	tIndex, exists := typ.Map[typ.Ord[1]]
	if !exists || tIndex == nil {
		return nil, fmt.Errorf("second arg must be specified")
	}

	if tIndex != nil && tIndex.Kind != types.KindInt {
		return nil, fmt.Errorf("index must be int kind")
	}

	if err := tList.Val.Cmp(typ.Out); err != nil {
		return nil, errwrap.Wrapf(err, "return type must match list val type")
	}

	if *obj.hasDefault {
		tDefault, exists := typ.Map[typ.Ord[2]]
		if !exists || tDefault == nil {
			return nil, fmt.Errorf("third arg must be specified")
		}
		if err := tList.Val.Cmp(tDefault); err != nil {
			return nil, errwrap.Wrapf(err, "default must match list val type")
		}
	}

	obj.Func = &wrapped.Func{
		Name: obj.String(),
		Type: typ, // .Copy(),
	}

	obj.Type = tList // list type
	fn := &types.FuncValue{
		T: typ,
		V: obj.Function, // implementation
	}
	obj.Fn = fn // inside wrapper.Func
	//return obj.Fn.T, nil
	return obj.sig(), nil
}

// Copy is implemented so that the obj.hasDefault value is not lost if we copy
// this function. That value is learned during FuncInfer, and previously would
// have been lost by the time we used it in Build.
func (obj *ListLookupFunc) Copy() interfaces.Func {
	return &ListLookupFunc{
		Type:       obj.Type, // don't copy because we use this after unification
		hasDefault: obj.hasDefault,

		init: obj.init, // likely gets overwritten anyways
	}
}

// Function is the actual implementation here. This is used in lieu of the
// Stream function which we'd have these contents within.
func (obj *ListLookupFunc) Function(ctx context.Context, input []types.Value) (types.Value, error) {
	l := (input[0]).(*types.ListValue)
	index := input[1].Int()
	//zero := l.Type().Val.New() // the zero value

	// TODO: should we handle overflow by returning zero?
	if index > math.MaxInt { // max int size varies by arch
		return nil, fmt.Errorf("list index overflow, got: %d, max is: %d", index, math.MaxInt)
	}
	if index < 0 {
		return nil, fmt.Errorf("list index was negative, got: %d", index)
	}

	// negative index values are "not found" here!
	val, exists := l.Lookup(int(index))
	if exists {
		return val, nil
	}
	if len(input) == 3 { // default value since lookup is missing
		return input[2], nil
	}

	return nil, fmt.Errorf("list index not present, got: %d, len is: %d", index, len(l.List()))
}

// Validate tells us if the input struct takes a valid form.
func (obj *ListLookupFunc) Validate() error {
	if obj.Type == nil { // build must be run first
		return fmt.Errorf("type is still unspecified")
	}
	if obj.Type.Kind != types.KindList {
		return fmt.Errorf("type must be a kind of list")
	}
	if obj.hasDefault == nil {
		return fmt.Errorf("function not built correctly")
	}
	return nil
}

// Info returns some static info about itself. Build must be called before this
// will return correct data.
func (obj *ListLookupFunc) Info() *interfaces.Info {
	return &interfaces.Info{
		Pure: true,
		Memo: false,
		Sig:  obj.sig(), // helper
		Err:  obj.Validate(),
	}
}