yq/pkg/yqlib/lib.go

// Use the top level Evaluator or StreamEvaluator to evaluate expressions and return matches.
package yqlib

import (
	"container/list"
	"fmt"
	"math"
	"strconv"
	"strings"

	logging "gopkg.in/op/go-logging.v1"
)

var ExpressionParser ExpressionParserInterface

func InitExpressionParser() {
	if ExpressionParser == nil {
		ExpressionParser = newExpressionParser()
	}
}

var log = logging.MustGetLogger("yq-lib")

var PrettyPrintExp = `(... | (select(tag != "!!str"), select(tag == "!!str") | select(test("(?i)^(y|yes|n|no|on|off)$") | not))  ) style=""`

// GetLogger returns the yq logger instance.
func GetLogger() *logging.Logger {
	return log
}

func recurseNodeArrayEqual(lhs *CandidateNode, rhs *CandidateNode) bool {
	if len(lhs.Content) != len(rhs.Content) {
		return false
	}

	for index := 0; index < len(lhs.Content); index = index + 1 {
		if !recursiveNodeEqual(lhs.Content[index], rhs.Content[index]) {
			return false
		}
	}
	return true
}

func findInArray(array *CandidateNode, item *CandidateNode) int {

	for index := 0; index < len(array.Content); index = index + 1 {
		if recursiveNodeEqual(array.Content[index], item) {
			return index
		}
	}
	return -1
}

func findKeyInMap(dataMap *CandidateNode, item *CandidateNode) int {

	for index := 0; index < len(dataMap.Content); index = index + 2 {
		if recursiveNodeEqual(dataMap.Content[index], item) {
			return index
		}
	}
	return -1
}

func recurseNodeObjectEqual(lhs *CandidateNode, rhs *CandidateNode) bool {
	if len(lhs.Content) != len(rhs.Content) {
		return false
	}

	for index := 0; index < len(lhs.Content); index = index + 2 {
		key := lhs.Content[index]
		value := lhs.Content[index+1]

		indexInRHS := findInArray(rhs, key)

		if indexInRHS == -1 || !recursiveNodeEqual(value, rhs.Content[indexInRHS+1]) {
			return false
		}
	}
	return true
}

func parseSnippet(value string) (*CandidateNode, error) {
	if value == "" {
		return &CandidateNode{
			Kind: ScalarNode,
			Tag:  "!!null",
		}, nil
	}
	decoder := NewYamlDecoder(ConfiguredYamlPreferences)
	err := decoder.Init(strings.NewReader(value))
	if err != nil {
		return nil, err
	}
	result, err := decoder.Decode()
	if err != nil {
		return nil, err
	}

	if result.Kind == ScalarNode {
		result.LineComment = result.LeadingContent
	} else {
		result.HeadComment = result.LeadingContent
	}
	result.LeadingContent = ""

	if result.Tag == "!!str" {
		// use the original string value, as
		// decoding drops new lines
		newNode := createScalarNode(value, value)
		newNode.LineComment = result.LineComment
		return newNode, nil
	}
	result.Line = 0
	result.Column = 0
	return result, err
}

func recursiveNodeEqual(lhs *CandidateNode, rhs *CandidateNode) bool {
	if lhs == nil && rhs == nil {
		return true
	}
	if lhs == nil || rhs == nil {
		// If one is nil, the other must also effectively be nil (e.g. an alias to nothing that resolved to nil, or a null scalar)
		// This check is a bit simplistic, as a non-nil node could be a ScalarNode Tag:!!null.
		// The detailed checks later will handle specific null-equivalence better.
		// For now, if one is a Go nil and the other isn't, they are different.
		log.Debugf("recursiveNodeEqual: one node is nil, the other is not. LHS: %v, RHS: %v", lhs == nil, rhs == nil)
		return false
	}

	// Phase 1: Resolve aliases if one node is an alias and the other is not.
	// This logic now assumes that lhs.Alias.Alias (if lhs is AliasNode)
	// has been resolved to a *CandidateNode during initial parsing.
	if lhs.Kind == AliasNode && rhs.Kind != AliasNode {
		if lhs.Alias == nil { // lhs.Alias is the *yaml.v3.Node representing the alias itself
			log.Debugf("recursiveNodeEqual: lhs is AliasNode but its *yaml.v3.Node (lhs.Alias) is nil. LHS: %s", NodeToString(lhs))
			return rhs.Kind == ScalarNode && rhs.Tag == "!!null"
		}
		// According to linter, lhs.Alias.Alias is *CandidateNode.
		// Standard yaml.v3 has lhs.Alias.Alias as *yaml.v3.Node (target).
		// We are trusting the linter's view of the effective type in this specific codebase.
		lhsResolvedCandidate := lhs.Alias.Alias // Assuming this is effectively a *CandidateNode
		if lhsResolvedCandidate == nil {
			log.Debugf("recursiveNodeEqual: lhs is AliasNode and its resolved target (*CandidateNode lhs.Alias.Alias) is nil. LHS: %s", NodeToString(lhs))
			return rhs.Kind == ScalarNode && rhs.Tag == "!!null"
		}
		// The type assertion is to make it explicit if the linter's view is correct.
		// If it panics, the assumption about pre-resolution to *CandidateNode is wrong.
		return recursiveNodeEqual(lhsResolvedCandidate, rhs)
	}

	if rhs.Kind == AliasNode && lhs.Kind != AliasNode {
		if rhs.Alias == nil {
			log.Debugf("recursiveNodeEqual: rhs is AliasNode but its *yaml.v3.Node (rhs.Alias) is nil. RHS: %s", NodeToString(rhs))
			return lhs.Kind == ScalarNode && lhs.Tag == "!!null"
		}
		rhsResolvedCandidate := rhs.Alias.Alias
		if rhsResolvedCandidate == nil {
			log.Debugf("recursiveNodeEqual: rhs is AliasNode and its resolved target (*CandidateNode rhs.Alias.Alias) is nil. RHS: %s", NodeToString(rhs))
			return lhs.Kind == ScalarNode && lhs.Tag == "!!null"
		}
		return recursiveNodeEqual(lhs, rhsResolvedCandidate)
	}

	if lhs.Kind != rhs.Kind {
		log.Debugf("recursiveNodeEqual: kinds differ after alias check. LHS: %s (%s), RHS: %s (%s)", KindString(lhs.Kind), NodeToString(lhs), KindString(rhs.Kind), NodeToString(rhs))
		return false
	}

	switch lhs.Kind {
	case AliasNode: // Both are AliasNodes
		if lhs.Alias == nil { // Both nil means equal
			return rhs.Alias == nil
		}
		if rhs.Alias == nil { // LHS not nil, RHS nil means unequal
			return false
		}
		// Both have non-nil yaml.v3 Alias nodes. Compare their targets.
		lhsResolvedCandidate := lhs.Alias.Alias
		rhsResolvedCandidate := rhs.Alias.Alias

		if lhsResolvedCandidate == nil { // LHS target is nil
			return rhsResolvedCandidate == nil // RHS target must also be nil
		}
		if rhsResolvedCandidate == nil { // RHS target is nil, LHS target not nil
			return false
		}
		return recursiveNodeEqual(lhsResolvedCandidate, rhsResolvedCandidate)

	case ScalarNode:
		lhsTag := lhs.guessTagFromCustomType()
		rhsTag := rhs.guessTagFromCustomType()
		if lhsTag != rhsTag {
			isLHSStrLike := lhsTag == "!!str" || lhsTag == "" || lhsTag == "!"
			isRHSStrLike := rhsTag == "!!str" || rhsTag == "" || rhsTag == "!"
			isLHSNull := lhsTag == "!!null"
			isRHSNull := rhsTag == "!!null"
			if isLHSNull || isRHSNull {
				if !(isLHSNull && isRHSNull) {
					log.Debugf("recursiveNodeEqual: Scalar tags differ (nullness mismatch). LHS Tag: '%s' Val: '%s', RHS Tag: '%s' Val: '%s'", lhsTag, lhs.Value, rhsTag, rhs.Value)
					return false
				}
			} else if !(isLHSStrLike && isRHSStrLike) {
				log.Debugf("recursiveNodeEqual: Scalar tags differ (non-string, non-null mismatch). LHS Tag: '%s' Val: '%s', RHS Tag: '%s' Val: '%s'", lhsTag, lhs.Value, rhsTag, rhs.Value)
				return false
			}
		}
		if lhsTag == "!!null" {
			return true
		}
		return lhs.Value == rhs.Value

	case SequenceNode:
		return recurseNodeArrayEqual(lhs, rhs)

	case MappingNode:
		return recurseNodeObjectEqual(lhs, rhs)

	default:
		log.Debugf("recursiveNodeEqual: unhandled identical kinds: %s (%s)", KindString(lhs.Kind), NodeToString(lhs))
		return false
	}
}

// yaml numbers can have underscores, be hex and octal encoded...
func parseInt64(numberString string) (string, int64, error) {
	if strings.Contains(numberString, "_") {
		numberString = strings.ReplaceAll(numberString, "_", "")
	}

	if strings.HasPrefix(numberString, "0x") ||
		strings.HasPrefix(numberString, "0X") {
		num, err := strconv.ParseInt(numberString[2:], 16, 64)
		return "0x%X", num, err
	} else if strings.HasPrefix(numberString, "0o") {
		num, err := strconv.ParseInt(numberString[2:], 8, 64)
		return "0o%o", num, err
	}
	num, err := strconv.ParseInt(numberString, 10, 64)
	return "%v", num, err
}

func parseInt(numberString string) (int, error) {
	_, parsed, err := parseInt64(numberString)

	if err != nil {
		return 0, err
	} else if parsed > math.MaxInt || parsed < math.MinInt {
		return 0, fmt.Errorf("%v is not within [%v, %v]", parsed, math.MinInt, math.MaxInt)
	}

	return int(parsed), err
}

func parseFloat(numberString string) (float64, error) {
	if strings.Contains(numberString, "_") {
		numberString = strings.ReplaceAll(numberString, "_", "")
	}
	return strconv.ParseFloat(numberString, 64)
}

func parseBool(boolString string) (bool, error) {
	return strconv.ParseBool(boolString)
}

func headAndLineComment(node *CandidateNode) string {
	return headComment(node) + lineComment(node)
}

func headComment(node *CandidateNode) string {
	return strings.Replace(node.HeadComment, "#", "", 1)
}

func lineComment(node *CandidateNode) string {
	return strings.Replace(node.LineComment, "#", "", 1)
}

func footComment(node *CandidateNode) string {
	return strings.Replace(node.FootComment, "#", "", 1)
}

// use for debugging only
func NodesToString(collection *list.List) string {
	if !log.IsEnabledFor(logging.DEBUG) {
		return ""
	}

	result := fmt.Sprintf("%v results\n", collection.Len())
	for el := collection.Front(); el != nil; el = el.Next() {
		result = result + "\n" + NodeToString(el.Value.(*CandidateNode))
	}
	return result
}

func NodeToString(node *CandidateNode) string {
	if !log.IsEnabledFor(logging.DEBUG) {
		return ""
	}
	if node == nil {
		return "-- nil --"
	}
	tag := node.Tag
	if node.Kind == AliasNode {
		tag = "alias"
	}
	valueToUse := node.Value
	if valueToUse == "" {
		valueToUse = fmt.Sprintf("%v kids", len(node.Content))
	}
	return fmt.Sprintf(`D%v, P%v, %v (%v)::%v`, node.GetDocument(), node.GetNicePath(), KindString(node.Kind), tag, valueToUse)
}

func NodeContentToString(node *CandidateNode, depth int) string {
	if !log.IsEnabledFor(logging.DEBUG) {
		return ""
	}
	var sb strings.Builder
	for _, child := range node.Content {
		for i := 0; i < depth; i++ {
			sb.WriteString(" ")
		}
		sb.WriteString("- ")
		sb.WriteString(NodeToString(child))
		sb.WriteString("\n")
		sb.WriteString(NodeContentToString(child, depth+1))
	}
	return sb.String()
}

func KindString(kind Kind) string {
	switch kind {
	case ScalarNode:
		return "ScalarNode"
	case SequenceNode:
		return "SequenceNode"
	case MappingNode:
		return "MappingNode"
	case AliasNode:
		return "AliasNode"
	default:
		return "unknown!"
	}
}