1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
|
/*
** Zabbix
** Copyright 2001-2022 Zabbix SIA
**
** Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
** documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
** rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
** permit persons to whom the Software is furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in all copies or substantial portions
** of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
** WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
** COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
** SOFTWARE.
**/
// Package conf provides .conf file loading and unmarshalling
package conf
import (
"bytes"
"fmt"
)
// Node structure is used to store parsed conf file parameters or parameter components.
type Node struct {
Name string
Nodes []interface{}
Line int
used bool
parent *Node
level int
includeFail bool
}
type Value struct {
Value []byte
Line int
}
// get returns child node by name
func (n *Node) get(name string) (node *Node) {
for _, v := range n.Nodes {
if child, ok := v.(*Node); ok && child.Name == name {
return child
}
}
return nil
}
// add appends new child node
func (n *Node) add(name []byte, value []byte, lineNum int) {
var node *Node
var key string
split := bytes.IndexByte(name, '.')
if split == -1 {
key = string(name)
} else {
key = string(name[:split])
}
if node = n.get(key); node == nil {
node = &Node{
Name: string(key),
used: false,
Nodes: make([]interface{}, 0),
parent: n,
Line: lineNum}
n.Nodes = append(n.Nodes, node)
}
if split != -1 {
node.add(name[split+1:], value, lineNum)
} else {
node.Nodes = append(node.Nodes, &Value{Value: value, Line: lineNum})
}
}
// checkUsage checks if all conf nodes were recognized.
// This is done by recursively checking 'used' flag for all nodes.
func (n *Node) checkUsage() (err error) {
for _, v := range n.Nodes {
if child, ok := v.(*Node); ok {
if !child.used {
return child.newError("unknown parameter")
}
if err = child.checkUsage(); err != nil {
return
}
}
}
return
}
// markUsed marks node and its children as used
func (n *Node) markUsed(used bool) {
n.used = used
for _, v := range n.Nodes {
if child, ok := v.(*Node); ok {
child.markUsed(used)
}
}
}
// getValue returns node value or meta data default value or nil if
// metadata 'optional' tag is set. Otherwise error is returned.
func (n *Node) getValue(meta *Meta) (value *string, err error) {
if n != nil {
var tmp string
for _, v := range n.Nodes {
if val, ok := v.(*Value); ok {
tmp = string(val.Value)
}
value = &tmp
}
}
if value == nil && meta != nil {
if meta.defaultValue != nil {
value = meta.defaultValue
} else if meta.optional {
return
} else {
return nil, fmt.Errorf("cannot find mandatory parameter %s", meta.name)
}
}
return
}
// newNodeError creates error based on the specified node. The error message will
// have full node name (parameter name up to the node, including it) and the line
// number where parameter was defined.
func (n *Node) newError(format string, a ...interface{}) (err error) {
if n == nil {
return fmt.Errorf(format, a...)
}
var name string
for parent := n; parent.parent != nil; parent = parent.parent {
if name == "" {
name = parent.Name
} else {
name = parent.Name + "." + name
}
}
desc := fmt.Sprintf(format, a...)
return fmt.Errorf("invalid parameter %s at line %d: %s", name, n.Line, desc)
}
|