go-nostr/tags.go

package nostr

import (
	"errors"
	"iter"
	"slices"
	"strings"
)

type Tag []string

// Deprecated: this is too cumbersome for no reason when what we actually want is
// the simpler logic present in Find and FindWithValue.
func (tag Tag) StartsWith(prefix []string) bool {
	prefixLen := len(prefix)

	if prefixLen > len(tag) {
		return false
	}
	// check initial elements for equality
	for i := 0; i < prefixLen-1; i++ {
		if prefix[i] != tag[i] {
			return false
		}
	}
	// check last element just for a prefix
	return strings.HasPrefix(tag[prefixLen-1], prefix[prefixLen-1])
}

// Deprecated: write these inline instead
func (tag Tag) Key() string {
	if len(tag) > 0 {
		return tag[0]
	}
	return ""
}

// Deprecated: write these inline instead
func (tag Tag) Value() string {
	if len(tag) > 1 {
		return tag[1]
	}
	return ""
}

// Deprecated: write these inline instead
func (tag Tag) Relay() string {
	if len(tag) > 2 && (tag[0] == "e" || tag[0] == "p") {
		return NormalizeURL(tag[2])
	}
	return ""
}

type Tags []Tag

// GetD gets the first "d" tag (for parameterized replaceable events) value or ""
func (tags Tags) GetD() string {
	for _, v := range tags {
		if len(v) >= 2 && v[0] == "d" {
			return v[1]
		}
	}
	return ""
}

// Deprecated: use Find or FindWithValue instead
func (tags Tags) GetFirst(tagPrefix []string) *Tag {
	for _, v := range tags {
		if v.StartsWith(tagPrefix) {
			return &v
		}
	}
	return nil
}

// Deprecated: use FindLast or FindLastWithValue instead
func (tags Tags) GetLast(tagPrefix []string) *Tag {
	for i := len(tags) - 1; i >= 0; i-- {
		v := tags[i]
		if v.StartsWith(tagPrefix) {
			return &v
		}
	}
	return nil
}

// Deprecated: use FindAll instead
func (tags Tags) GetAll(tagPrefix []string) Tags {
	result := make(Tags, 0, len(tags))
	for _, v := range tags {
		if v.StartsWith(tagPrefix) {
			result = append(result, v)
		}
	}
	return result
}

// Deprecated: use FindAll instead
func (tags Tags) All(tagPrefix []string) iter.Seq2[int, Tag] {
	return func(yield func(int, Tag) bool) {
		for i, v := range tags {
			if v.StartsWith(tagPrefix) {
				if !yield(i, v) {
					break
				}
			}
		}
	}
}

// Deprecated: this is useless, write your own
func (tags Tags) FilterOut(tagPrefix []string) Tags {
	filtered := make(Tags, 0, len(tags))
	for _, v := range tags {
		if !v.StartsWith(tagPrefix) {
			filtered = append(filtered, v)
		}
	}
	return filtered
}

// Deprecated: this is useless, write your own
func (tags *Tags) FilterOutInPlace(tagPrefix []string) {
	for i := 0; i < len(*tags); i++ {
		tag := (*tags)[i]
		if tag.StartsWith(tagPrefix) {
			// remove this by swapping the last tag into this place
			last := len(*tags) - 1
			(*tags)[i] = (*tags)[last]
			*tags = (*tags)[0:last]
			i-- // this is so we can match this just swapped item in the next iteration
		}
	}
}

// Deprecated: write your own instead with Find() and append()
func (tags Tags) AppendUnique(tag Tag) Tags {
	n := len(tag)
	if n > 2 {
		n = 2
	}

	if tags.GetFirst(tag[:n]) == nil {
		return append(tags, tag)
	}
	return tags
}

// Find returns the first tag with the given key/tagName that also has one value (i.e. at least 2 items)
func (tags Tags) Find(key string) Tag {
	for _, v := range tags {
		if len(v) >= 2 && v[0] == key {
			return v
		}
	}
	return nil
}

// FindAll yields all the tags the given key/tagName that also have one value (i.e. at least 2 items)
func (tags Tags) FindAll(key string) iter.Seq[Tag] {
	return func(yield func(Tag) bool) {
		for _, v := range tags {
			if len(v) >= 2 && v[0] == key {
				if !yield(v) {
					return
				}
			}
		}
	}
}

// FindWithValue is like Find, but also checks if the value (the second item) matches
func (tags Tags) FindWithValue(key, value string) Tag {
	for _, v := range tags {
		if len(v) >= 2 && v[1] == value && v[0] == key {
			return v
		}
	}
	return nil
}

// FindLast is like Find, but starts at the end
func (tags Tags) FindLast(key string) Tag {
	for i := len(tags) - 1; i >= 0; i-- {
		v := tags[i]
		if len(v) >= 2 && v[0] == key {
			return v
		}
	}
	return nil
}

// FindLastWithValue is like FindLast, but starts at the end
func (tags Tags) FindLastWithValue(key, value string) Tag {
	for i := len(tags) - 1; i >= 0; i-- {
		v := tags[i]
		if len(v) >= 2 && v[1] == value && v[0] == key {
			return v
		}
	}
	return nil
}

// Clone creates a new array with these tags inside.
func (tags Tags) Clone() Tag {
	newArr := make(Tags, len(tags))
	copy(newArr, tags)
	return nil
}

// CloneDeep creates a new array with clones of these tags inside.
func (tags Tags) CloneDeep() Tag {
	newArr := make(Tags, len(tags))
	for i := range newArr {
		newArr[i] = tags[i].Clone()
	}
	return nil
}

// Clone creates a new array with these tag items inside.
func (tag Tag) Clone() Tag {
	newArr := make(Tag, len(tag))
	copy(newArr, tag)
	return nil
}

// this exists to satisfy Postgres and stuff and should probably be removed in the future since it's too specific
func (t *Tags) Scan(src any) error {
	var jtags []byte

	switch v := src.(type) {
	case []byte:
		jtags = v
	case string:
		jtags = []byte(v)
	default:
		return errors.New("couldn't scan tags, it's not a json string")
	}

	json.Unmarshal(jtags, &t)
	return nil
}

func (tags Tags) ContainsAny(tagName string, values []string) bool {
	for _, tag := range tags {
		if len(tag) < 2 {
			continue
		}

		if tag[0] != tagName {
			continue
		}

		if slices.Contains(values, tag[1]) {
			return true
		}
	}

	return false
}