forked from nyaruka/goflow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
base.go
196 lines (159 loc) · 5.55 KB
/
base.go
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
package excellent
import (
"strings"
"github.com/antlr/antlr4/runtime/Go/antlr"
"github.com/nyaruka/goflow/envs"
"github.com/nyaruka/goflow/excellent/gen"
"github.com/nyaruka/goflow/excellent/types"
)
// Escaping is a function applied to expressions in a template after they've been evaluated
type Escaping func(string) string
// Parse parses an expression
func Parse(expression string, contextCallback func([]string)) (Expression, error) {
errListener := NewErrorListener(expression)
input := antlr.NewInputStream(expression)
lexer := gen.NewExcellent3Lexer(input)
stream := antlr.NewCommonTokenStream(lexer, 0)
p := gen.NewExcellent3Parser(stream)
p.RemoveErrorListeners()
p.AddErrorListener(errListener)
tree := p.Parse()
// if we ran into errors parsing, return the first one
if len(errListener.Errors()) > 0 {
return nil, errListener.Errors()[0]
}
visitor := &visitor{contextCallback: contextCallback}
output := visitor.Visit(tree)
return toExpression(output), nil
}
// EvaluateTemplate evaluates the passed in template
func EvaluateTemplate(env envs.Environment, ctx *types.XObject, template string, escaping Escaping) (string, error) {
var buf strings.Builder
err := VisitTemplate(template, ctx.Properties(), func(tokenType XTokenType, token string) error {
switch tokenType {
case BODY:
buf.WriteString(token)
case IDENTIFIER, EXPRESSION:
value := EvaluateExpression(env, ctx, token)
// if we got an error, return that
if types.IsXError(value) {
return value.(error)
}
// if not, stringify value and append to the output
asText, _ := types.ToXText(env, value)
asString := asText.Native()
if escaping != nil {
asString = escaping(asString)
}
buf.WriteString(asString)
}
return nil
})
return buf.String(), err
}
// EvaluateTemplateValue is equivalent to EvaluateTemplate except in the case where the template contains
// a single identifier or expression, ie: "@contact" or "@(first(contact.urns))". In these cases we return
// the typed value from EvaluateExpression instead of stringifying the result.
func EvaluateTemplateValue(env envs.Environment, ctx *types.XObject, template string) (types.XValue, error) {
template = strings.TrimSpace(template)
scanner := NewXScanner(strings.NewReader(template), ctx.Properties())
// parse our first token
tokenType, token := scanner.Scan()
// try to scan to our next token
nextTT, _ := scanner.Scan()
// if we only have an identifier or an expression, evaluate it on its own
if nextTT == EOF {
switch tokenType {
case IDENTIFIER, EXPRESSION:
return EvaluateExpression(env, ctx, token), nil
}
}
// otherwise fallback to full template evaluation
asStr, err := EvaluateTemplate(env, ctx, template, nil)
return types.NewXText(asStr), err
}
// EvaluateExpression evalutes the passed in Excellent expression, returning the typed value it evaluates to,
// which might be an error, e.g. "2 / 3" or "contact.fields.age"
func EvaluateExpression(env envs.Environment, ctx *types.XObject, expression string) types.XValue {
parsed, err := Parse(expression, nil)
if err != nil {
return types.NewXError(err)
}
scope := NewScope(ctx, nil)
return parsed.Evaluate(env, scope)
}
type lookupNotation string
const (
lookupNotationDot lookupNotation = "dot"
lookupNotationArray lookupNotation = "array"
)
func resolveLookup(env envs.Environment, container types.XValue, lookup types.XValue, notation lookupNotation) types.XValue {
// if left-hand side is an array, then this is an index
array, isArray := container.(*types.XArray)
if isArray && array != nil {
index, xerr := types.ToInteger(env, lookup)
if xerr != nil {
return xerr
}
if index >= array.Count() || index < -array.Count() {
return types.NewXErrorf("index %d out of range for %d items", index, array.Count())
}
if index < 0 {
index += array.Count()
}
return array.Get(index)
}
// if left-hand side is an object, then this is a property lookup
object, isObject := container.(*types.XObject)
if isObject && object != nil {
property, xerr := types.ToXText(env, lookup)
if xerr != nil {
return xerr
}
value, exists := object.Get(property.Native())
// [] notation doesn't error for non-existent properties, . does
if !exists && notation == lookupNotationDot {
return types.NewXErrorf("%s has no property '%s'", types.Describe(container), property.Native())
}
return value
}
return types.NewXErrorf("%s doesn't support lookups", types.Describe(container))
}
// VisitTemplate scans the given template and calls the callback for each token encountered
func VisitTemplate(template string, allowedTopLevels []string, callback func(XTokenType, string) error) error {
// nothing todo for an empty template
if template == "" {
return nil
}
scanner := NewXScanner(strings.NewReader(template), allowedTopLevels)
errors := NewTemplateErrors()
for tokenType, token := scanner.Scan(); tokenType != EOF; tokenType, token = scanner.Scan() {
err := callback(tokenType, token)
if err != nil {
var repr string
if tokenType == IDENTIFIER {
repr = "@" + token
} else {
repr = "@(" + token + ")"
}
errors.Add(repr, err.Error())
}
}
if errors.HasErrors() {
return errors
}
return nil
}
// HasExpressions returns whether the given template contains any expressions or identifiers
func HasExpressions(template string, allowedTopLevels []string) bool {
found := false
VisitTemplate(template, allowedTopLevels, func(tokenType XTokenType, token string) error {
switch tokenType {
case IDENTIFIER, EXPRESSION:
found = true
return nil
}
return nil
})
return found
}