senml.go

package senml

import (
	"encoding/json"
	"encoding/xml"
	"errors"
	"sort"

	"github.com/fxamacker/cbor/v2"
)

const (
	xmlns          = "urn:ietf:params:xml:ns:senml"
	defaultVersion = 10
)

// Format represents SenML message format.
type Format int

// Supported formats are JSON, XML, and CBOR.
const (
	JSON Format = 1 + iota
	XML
	CBOR
)

var (
	// ErrVersionChange indicates that records with different BaseVersion are present in Pack.
	ErrVersionChange = errors.New("version change")

	// ErrUnsupportedFormat indicates the wrong message format (format other than JSON, XML or CBOR).
	ErrUnsupportedFormat = errors.New("unsupported format")

	// ErrEmptyName indicates empty record name.
	ErrEmptyName = errors.New("empty name")

	// ErrBadChar indicates invalid char or that char is not allowed at the given position.
	ErrBadChar = errors.New("invalid char")

	// ErrTooManyValues indicates that there is more than one value field.
	ErrTooManyValues = errors.New("more than one value in the record")

	// ErrNoValues indicates that there is no value nor sum field present.
	ErrNoValues = errors.New("no value or sum field found")
)

// Record represents one senML record.
type Record struct {
	XMLName     *bool    `json:"-" xml:"senml" cbor:"-"`
	Link        string   `json:"l,omitempty"  xml:"l,attr,omitempty" cbor:"-"`
	BaseName    string   `json:"bn,omitempty" xml:"bn,attr,omitempty" cbor:"-2,keyasint,omitempty"`
	BaseTime    float64  `json:"bt,omitempty" xml:"bt,attr,omitempty" cbor:"-3,keyasint,omitempty"`
	BaseUnit    string   `json:"bu,omitempty" xml:"bu,attr,omitempty" cbor:"-4,keyasint,omitempty"`
	BaseVersion uint     `json:"bver,omitempty" xml:"bver,attr,omitempty" cbor:"-1,keyasint,omitempty"`
	BaseValue   float64  `json:"bv,omitempty" xml:"bv,attr,omitempty" cbor:"-5,keyasint,omitempty"`
	BaseSum     float64  `json:"bs,omitempty" xml:"bs,attr,omitempty" cbor:"-6,keyasint,omitempty"`
	Name        string   `json:"n,omitempty" xml:"n,attr,omitempty" cbor:"0,keyasint,omitempty"`
	Unit        string   `json:"u,omitempty" xml:"u,attr,omitempty" cbor:"1,keyasint,omitempty"`
	Time        float64  `json:"t,omitempty" xml:"t,attr,omitempty" cbor:"6,keyasint,omitempty"`
	UpdateTime  float64  `json:"ut,omitempty" xml:"ut,attr,omitempty" cbor:"7,keyasint,omitempty"`
	Value       *float64 `json:"v,omitempty" xml:"v,attr,omitempty" cbor:"2,keyasint,omitempty"`
	StringValue *string  `json:"vs,omitempty" xml:"vs,attr,omitempty" cbor:"3,keyasint,omitempty"`
	DataValue   *string  `json:"vd,omitempty" xml:"vd,attr,omitempty" cbor:"8,keyasint,omitempty"`
	BoolValue   *bool    `json:"vb,omitempty" xml:"vb,attr,omitempty" cbor:"4,keyasint,omitempty"`
	Sum         *float64 `json:"s,omitempty" xml:"s,attr,omitempty" cbor:"5,keyasint,omitempty"`
}

// Pack consists of SenML records array.
type Pack struct {
	XMLName *bool    `json:"-" xml:"sensml"`
	Xmlns   string   `json:"-" xml:"xmlns,attr"`
	Records []Record `xml:"senml"`
}

// Implement sort.Interface so that resolved recods can easily be sorted.
func (p *Pack) Len() int {
	return len(p.Records)
}

func (p *Pack) Less(i, j int) bool {
	return p.Records[i].Time < p.Records[j].Time
}

func (p *Pack) Swap(i, j int) {
	p.Records[i], p.Records[j] = p.Records[j], p.Records[i]
}

// Decode takes a SenML message in the given format and parses it and decodes it
// into the returned SenML record.
func Decode(msg []byte, format Format) (Pack, error) {
	var p Pack
	switch format {
	case JSON:
		if err := json.Unmarshal(msg, &p.Records); err != nil {
			return Pack{}, err
		}
	case XML:
		if err := xml.Unmarshal(msg, &p); err != nil {
			return Pack{}, err
		}
		p.Xmlns = xmlns
	case CBOR:
		if err := cbor.Unmarshal(msg, &p.Records); err != nil {
			return Pack{}, err
		}
	default:
		return Pack{}, ErrUnsupportedFormat
	}

	return p, Validate(p)
}

// Encode takes a SenML Pack and encodes it using the given format.
func Encode(p Pack, format Format) ([]byte, error) {
	switch format {
	case JSON:
		return json.Marshal(p.Records)
	case XML:
		p.Xmlns = xmlns
		return xml.Marshal(p)
	case CBOR:
		return cbor.Marshal(p.Records)
	default:
		return nil, ErrUnsupportedFormat
	}
}

// Normalize removes all the base values and expands records values with the base items.
// The base fields apply to the entries in the Record and also to all Records after
// it up to, but not including, the next Record that has that same base field.
func Normalize(p Pack) (Pack, error) {
	// Validate ensures that all the BaseVersions are equal.
	if err := Validate(p); err != nil {
		return Pack{}, err
	}
	records := make([]Record, len(p.Records))
	var bname string
	var btime float64
	var bsum float64
	var bunit string

	for i, r := range p.Records {
		if r.BaseTime != 0 {
			btime = r.BaseTime
		}
		if r.BaseSum != 0 {
			bsum = r.BaseSum
		}
		if r.BaseUnit != "" {
			bunit = r.BaseUnit
		}
		if len(r.BaseName) > 0 {
			bname = r.BaseName
		}
		r.Name = bname + r.Name
		r.Time = btime + r.Time
		if r.Sum != nil {
			*r.Sum = bsum + *r.Sum
		}
		if r.Unit == "" {
			r.Unit = bunit
		}
		if r.Value != nil && r.BaseValue != 0 {
			*r.Value = r.BaseValue + *r.Value
		}
		// If the version is default, it must not be present in resolved records.
		// Validate method takes care that the version is the same on all the records.
		if r.BaseVersion == defaultVersion {
			r.BaseVersion = 0
		}

		// Remove Base Values from the Record.
		r.BaseTime = 0
		r.BaseValue = 0
		r.BaseUnit = ""
		r.BaseName = ""
		r.BaseSum = 0
		records[i] = r
	}
	p.Records = records
	sort.Sort(&p)
	return p, nil
}

// Validate validates SenML records.
func Validate(p Pack) error {
	var bver uint
	var bname string
	var bsum float64
	for _, r := range p.Records {
		// Check if version is the same for all the records.
		if bver == 0 && r.BaseVersion != 0 {
			bver = r.BaseVersion
		}
		if bver != 0 && r.BaseVersion == 0 {
			r.BaseVersion = bver
		}
		if r.BaseVersion != bver {
			return ErrVersionChange
		}
		if r.BaseName != "" {
			bname = r.BaseName
		}
		if r.BaseSum != 0 {
			bsum = r.BaseSum
		}
		name := bname + r.Name
		if len(name) == 0 {
			return ErrEmptyName
		}
		var valCnt int
		if r.Value != nil {
			valCnt++
		}
		if r.BoolValue != nil {
			valCnt++
		}
		if r.DataValue != nil {
			valCnt++
		}
		if r.StringValue != nil {
			valCnt++
		}
		if valCnt > 1 {
			return ErrTooManyValues
		}
		if r.Sum != nil || bsum != 0 {
			valCnt++
		}
		if valCnt < 1 {
			return ErrNoValues
		}
		if err := validateName(name); err != nil {
			return err
		}
	}
	return nil
}

func validateName(name string) error {
	l := name[0]
	if (l == '-') || (l == ':') || (l == '.') || (l == '/') || (l == '_') {
		return ErrBadChar
	}
	for _, l := range name {
		if (l < 'a' || l > 'z') && (l < 'A' || l > 'Z') && (l < '0' || l > '9') && (l != '-') && (l != ':') && (l != '.') && (l != '/') && (l != '_') {
			return ErrBadChar
		}
	}
	return nil
}