readeck/pkg/xml2map/decoder.go

// SPDX-FileCopyrightText: Copyright (c) 2018 Babiv Sergey
//
// SPDX-License-Identifier: MIT

// Original code: https://github.com/sbabiv/xml2map/

// Package xml2map provides an XML decoder returning a map of properties
// parsed from a given XML input.
package xml2map

import (
	"encoding/xml"
	"errors"
	"fmt"
	"io"
	"path"
	"strings"
)

const (
	attrPrefix = "@"
	textPrefix = "#text"
)

var (
	// ErrInvalidDocument invalid document err.
	ErrInvalidDocument = errors.New("invalid document")

	// ErrInvalidRoot data at the root level is invalid err.
	ErrInvalidRoot = errors.New("data at the root level is invalid")
)

type node struct {
	Parent  *node
	Value   map[string]any
	Attrs   []xml.Attr
	Label   string
	Space   string
	Text    string
	HasMany bool
}

// Decoder instance.
type Decoder struct {
	r          io.Reader
	attrPrefix string
	textPrefix string
}

// NewDecoder create new decoder instance.
func NewDecoder(reader io.Reader) *Decoder {
	return NewDecoderWithPrefix(reader, attrPrefix, textPrefix)
}

// NewDecoderWithPrefix create new decoder instance with custom attribute prefix and text prefix.
func NewDecoderWithPrefix(reader io.Reader, attrPrefix, textPrefix string) *Decoder {
	return &Decoder{r: reader, attrPrefix: attrPrefix, textPrefix: textPrefix}
}

// Decode xml string to map[string]any.
func (d *Decoder) Decode() (map[string]any, error) {
	decoder := xml.NewDecoder(d.r)
	n := &node{}
	stack := make([]*node, 0)

	for {
		token, err := decoder.Token()
		if err != nil && err != io.EOF {
			return nil, err
		}

		if token == nil {
			break
		}

		switch tok := token.(type) {
		case xml.StartElement:
			{
				label := tok.Name.Local
				if tok.Name.Space != "" {
					label = fmt.Sprintf("%s:%s", strings.ToLower(path.Base(tok.Name.Space)), tok.Name.Local)
				}
				n = &node{
					Label:  label,
					Space:  tok.Name.Space,
					Parent: n,
					Value:  map[string]any{label: map[string]any{}},
					Attrs:  tok.Attr,
				}

				setAttrs(n, &tok, d.attrPrefix)
				stack = append(stack, n)

				if n.Parent != nil {
					n.Parent.HasMany = true
				}
			}

		case xml.CharData:
			data := strings.TrimSpace(string(tok))
			if len(stack) > 0 {
				stack[len(stack)-1].Text = data
			} else if len(data) > 0 {
				return nil, ErrInvalidRoot
			}

		case xml.EndElement:
			{
				length := len(stack)
				stack, n = stack[:length-1], stack[length-1]

				if !n.HasMany {
					if len(n.Attrs) > 0 {
						m := n.Value[n.Label].(map[string]any)
						m[d.textPrefix] = n.Text
					} else {
						n.Value[n.Label] = n.Text
					}
				}

				if len(stack) == 0 {
					return n.Value, nil
				}

				setNodeValue(n)
				n = n.Parent
			}
		}
	}

	return nil, ErrInvalidDocument
}

func setAttrs(n *node, tok *xml.StartElement, attrPrefix string) {
	if len(tok.Attr) > 0 {
		m := make(map[string]any)
		for _, attr := range tok.Attr {
			if len(attr.Name.Space) > 0 {
				m[attrPrefix+attr.Name.Space+":"+attr.Name.Local] = attr.Value
			} else {
				m[attrPrefix+attr.Name.Local] = attr.Value
			}
		}
		n.Value[tok.Name.Local] = m
	}
}

func setNodeValue(n *node) {
	if v, ok := n.Parent.Value[n.Parent.Label]; ok {
		m := v.(map[string]any)
		if v, ok = m[n.Label]; ok {
			switch item := v.(type) {
			case string:
				m[n.Label] = []string{item, n.Value[n.Label].(string)}
			case []string:
				m[n.Label] = append(item, n.Value[n.Label].(string))
			case map[string]any:
				vm := getMap(n)
				if vm != nil {
					m[n.Label] = []map[string]any{item, vm}
				}
			case []map[string]any:
				vm := getMap(n)
				if vm != nil {
					m[n.Label] = append(item, vm)
				}
			}
		} else {
			m[n.Label] = n.Value[n.Label]
		}

	} else {
		n.Parent.Value[n.Parent.Label] = n.Value[n.Label]
	}
}

func getMap(node *node) map[string]any {
	if v, ok := node.Value[node.Label]; ok {
		switch v.(type) {
		case string:
			return map[string]any{node.Label: v}
		case map[string]any:
			return node.Value[node.Label].(map[string]any)
		}
	}

	return nil
}