-
Notifications
You must be signed in to change notification settings - Fork 19
/
contact.go
541 lines (466 loc) · 14.9 KB
/
contact.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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
package flows
import (
"encoding/json"
"strconv"
"strings"
"time"
"github.com/nyaruka/gocommon/urns"
"github.com/nyaruka/goflow/assets"
"github.com/nyaruka/goflow/contactql"
"github.com/nyaruka/goflow/excellent/types"
"github.com/nyaruka/goflow/utils"
"github.com/pkg/errors"
)
// Contact represents a person who is interacting with the flow. It renders as the person's name
// (or perferred URN if name isn't set) in a template, and has the following properties which can be accessed:
//
// * `uuid` the UUID of the contact
// * `name` the full name of the contact
// * `first_name` the first name of the contact
// * `language` the [ISO-639-3](http://www-01.sil.org/iso639-3/) language code of the contact
// * `timezone` the timezone name of the contact
// * `created_on` the datetime when the contact was created
// * `urns` all [URNs](#context:urn) the contact has set
// * `urns.[scheme]` all the [URNs](#context:urn) the contact has set for the particular URN scheme
// * `urn` shorthand for `@(format_urn(c.urns.0))`, i.e. the contact's preferred [URN](#context:urn) in friendly formatting
// * `groups` all the [groups](#context:group) that the contact belongs to
// * `fields` all the custom contact fields the contact has set
// * `fields.[snaked_field_name]` the value of the specific field
// * `channel` shorthand for `contact.urns.0.channel`, i.e. the [channel](#context:channel) of the contact's preferred URN
//
// Examples:
//
// @contact -> Ryan Lewis
// @contact.name -> Ryan Lewis
// @contact.first_name -> Ryan
// @contact.language -> eng
// @contact.timezone -> America/Guayaquil
// @contact.created_on -> 2018-06-20T11:40:30.123456Z
// @contact.urns -> ["tel:+12065551212","twitterid:54784326227#nyaruka","mailto:foo@bar.com"]
// @contact.urns.0 -> tel:+12065551212
// @contact.urns.tel -> ["tel:+12065551212"]
// @contact.urns.mailto.0 -> mailto:foo@bar.com
// @contact.urn -> tel:+12065551212
// @contact.groups -> ["Testers","Males"]
// @contact.fields -> {"activation_token":"AACC55","age":23,"gender":"Male","join_date":"2017-12-02T00:00:00-02:00","not_set":null}
// @contact.fields.activation_token -> AACC55
// @contact.fields.gender -> Male
//
// @context contact
type Contact struct {
uuid ContactUUID
id ContactID
name string
language utils.Language
timezone *time.Location
createdOn time.Time
urns URNList
groups *GroupList
fields FieldValues
}
// NewContact creates a new contact with the passed in attributes
func NewContact(
uuid ContactUUID, id ContactID, name string, language utils.Language, timezone *time.Location, createdOn time.Time,
urns URNList, groups *GroupList, fields FieldValues) *Contact {
return &Contact{
uuid: uuid,
id: id,
name: name,
language: language,
timezone: timezone,
createdOn: createdOn,
urns: urns,
groups: groups,
fields: fields,
}
}
// NewContactFromAssets creates a new contact using assets
func NewContactFromAssets(
a SessionAssets,
uuid ContactUUID,
id ContactID,
name string,
language utils.Language,
timezone *time.Location,
createdOn time.Time,
urns []urns.URN,
groups []assets.Group,
fields map[string]*Value) (*Contact, error) {
urnList, err := ReadURNList(a, urns, assets.IgnoreMissing)
if err != nil {
return nil, err
}
groupList, err := NewGroupListFromAssets(a, groups)
if err != nil {
return nil, err
}
fieldValues, err := NewFieldValues(a, fields, assets.IgnoreMissing)
if err != nil {
return nil, err
}
return &Contact{
uuid: uuid,
id: id,
name: name,
language: language,
timezone: timezone,
createdOn: createdOn,
urns: urnList,
groups: groupList,
fields: fieldValues,
}, nil
}
// NewEmptyContact creates a new empy contact with the passed in name, language and location
func NewEmptyContact(name string, language utils.Language, timezone *time.Location) *Contact {
return &Contact{
uuid: ContactUUID(utils.NewUUID()),
name: name,
language: language,
timezone: timezone,
createdOn: utils.Now(),
urns: URNList{},
groups: NewGroupList([]*Group{}),
fields: make(FieldValues),
}
}
// Clone creates a copy of this contact
func (c *Contact) Clone() *Contact {
if c == nil {
return nil
}
return &Contact{
uuid: c.uuid,
id: c.id,
name: c.name,
language: c.language,
timezone: c.timezone,
createdOn: c.createdOn,
urns: c.urns.clone(),
groups: c.groups.clone(),
fields: c.fields.clone(),
}
}
// Equal returns true if this instance is equal to the given instance
func (c *Contact) Equal(other *Contact) bool {
asJSON1, _ := json.Marshal(c)
asJSON2, _ := json.Marshal(other)
return string(asJSON1) == string(asJSON2)
}
// UUID returns the UUID of this contact
func (c *Contact) UUID() ContactUUID { return c.uuid }
// ID returns the numeric ID of this contact
func (c *Contact) ID() ContactID { return c.id }
// SetLanguage sets the language for this contact
func (c *Contact) SetLanguage(lang utils.Language) { c.language = lang }
// Language gets the language for this contact
func (c *Contact) Language() utils.Language { return c.language }
// SetTimezone sets the timezone of this contact
func (c *Contact) SetTimezone(tz *time.Location) {
c.timezone = tz
}
// Timezone returns the timezone of this contact
func (c *Contact) Timezone() *time.Location { return c.timezone }
// SetCreatedOn sets the created on time of this contact
func (c *Contact) SetCreatedOn(createdOn time.Time) {
c.createdOn = createdOn
}
// CreatedOn returns the created on time of this contact
func (c *Contact) CreatedOn() time.Time { return c.createdOn }
// SetName sets the name of this contact
func (c *Contact) SetName(name string) { c.name = name }
// Name returns the name of this contact
func (c *Contact) Name() string { return c.name }
// URNs returns the URNs of this contact
func (c *Contact) URNs() URNList { return c.urns }
// AddURN adds a new URN to this contact
func (c *Contact) AddURN(urn *ContactURN) bool {
if c.HasURN(urn.URN()) {
return false
}
c.urns = append(c.urns, urn)
return true
}
// HasURN checks whether the contact has the given URN
func (c *Contact) HasURN(urn urns.URN) bool {
urn = urn.Normalize("")
for _, u := range c.urns {
if u.URN().Identity() == urn.Identity() {
return true
}
}
return false
}
// Groups returns the groups that this contact belongs to
func (c *Contact) Groups() *GroupList { return c.groups }
// Fields returns this contact's field values
func (c *Contact) Fields() FieldValues { return c.fields }
// Reference returns a reference to this contact
func (c *Contact) Reference() *ContactReference {
if c == nil {
return nil
}
return NewContactReference(c.uuid, c.name)
}
// Format returns a friendly string version of this contact depending on what fields are set
func (c *Contact) Format(env utils.Environment) string {
// if contact has a name set, use that
if c.name != "" {
return c.name
}
// otherwise use either id or the higest priority URN depending on the env
if env.RedactionPolicy() == utils.RedactionPolicyURNs {
return strconv.Itoa(int(c.id))
}
if len(c.urns) > 0 {
return c.urns[0].URN().Format()
}
return ""
}
// Resolve resolves the given key when this contact is referenced in an expression
func (c *Contact) Resolve(env utils.Environment, key string) types.XValue {
switch strings.ToLower(key) {
case "uuid":
return types.NewXText(string(c.uuid))
case "id":
return types.NewXNumberFromInt(int(c.id))
case "name":
return types.NewXText(c.name)
case "first_name":
names := utils.TokenizeString(c.name)
if len(names) >= 1 {
return types.NewXText(names[0])
}
return nil
case "language":
return types.NewXText(string(c.language))
case "timezone":
if c.timezone != nil {
return types.NewXText(c.timezone.String())
}
return nil
case "created_on":
return types.NewXDateTime(c.createdOn)
case "urns":
return c.urns
case "urn":
if len(c.urns) > 0 {
return c.urns[0]
}
return nil
case "groups":
return c.groups
case "fields":
return c.fields
case "channel":
return c.PreferredChannel()
}
return types.NewXResolveError(c, key)
}
// Describe returns a representation of this type for error messages
func (c *Contact) Describe() string { return "contact" }
// Reduce is called when this object needs to be reduced to a primitive
func (c *Contact) Reduce(env utils.Environment) types.XPrimitive {
return types.NewXText(c.Format(env))
}
// ToXJSON is called when this type is passed to @(json(...))
func (c *Contact) ToXJSON(env utils.Environment) types.XText {
return types.ResolveKeys(env, c, "uuid", "name", "language", "timezone", "created_on", "urns", "groups", "fields", "channel").ToXJSON(env)
}
var _ types.XValue = (*Contact)(nil)
var _ types.XResolvable = (*Contact)(nil)
// PreferredChannel gets the preferred channel for this contact, i.e. the preferred channel of their highest priority URN
func (c *Contact) PreferredChannel() *Channel {
if len(c.urns) > 0 {
return c.urns[0].Channel()
}
return nil
}
// UpdatePreferredChannel updates the preferred channel and returns whether any change was made
func (c *Contact) UpdatePreferredChannel(channel *Channel) bool {
oldURNs := c.urns.clone()
// setting preferred channel to nil means clearing affinity on all URNs
if channel == nil {
for _, urn := range c.urns {
urn.SetChannel(nil)
}
} else {
priorityURNs := make([]*ContactURN, 0)
otherURNs := make([]*ContactURN, 0)
for _, urn := range c.urns {
// tel URNs can be re-assigned, other URN schemes are considered channel specific
if urn.URN().Scheme() == urns.TelScheme && channel.SupportsScheme(urns.TelScheme) {
urn.SetChannel(channel)
}
// move any URNs with this channel to the front of the list
if urn.Channel() == channel {
priorityURNs = append(priorityURNs, urn)
} else {
otherURNs = append(otherURNs, urn)
}
}
c.urns = append(priorityURNs, otherURNs...)
}
return !oldURNs.Equal(c.urns)
}
// ReevaluateDynamicGroups reevaluates membership of all dynamic groups for this contact
func (c *Contact) ReevaluateDynamicGroups(env utils.Environment, allGroups *GroupAssets) ([]*Group, []*Group, []error) {
added := make([]*Group, 0)
removed := make([]*Group, 0)
errors := make([]error, 0)
for _, group := range allGroups.All() {
if !group.IsDynamic() {
continue
}
qualifies, err := group.CheckDynamicMembership(env, c)
if err != nil {
errors = append(errors, err)
} else if qualifies {
if c.groups.Add(group) {
added = append(added, group)
}
} else {
if c.groups.Remove(group) {
removed = append(removed, group)
}
}
}
return added, removed, errors
}
// ResolveQueryKey resolves a contact query search key for this contact
func (c *Contact) ResolveQueryKey(env utils.Environment, key string) []interface{} {
switch key {
case "name":
if c.name != "" {
return []interface{}{c.name}
}
return nil
case "language":
if c.language != utils.NilLanguage {
return []interface{}{string(c.language)}
}
return nil
case "created_on":
return []interface{}{c.createdOn}
}
// try as a URN scheme
if urns.IsValidScheme(key) {
if env.RedactionPolicy() != utils.RedactionPolicyURNs {
urnsWithScheme := c.urns.WithScheme(key)
vals := make([]interface{}, len(urnsWithScheme))
for u := range urnsWithScheme {
vals[u] = string(urnsWithScheme[u].URN())
}
return vals
}
return nil
}
// try as a contact field
var nativeValue interface{}
switch typed := c.fields[key].TypedValue().(type) {
case nil:
return nil
case LocationPath:
nativeValue = typed.Name()
case types.XText:
nativeValue = typed.Native()
case types.XNumber:
nativeValue = typed.Native()
case types.XDateTime:
nativeValue = typed.Native()
}
return []interface{}{nativeValue}
}
var _ contactql.Queryable = (*Contact)(nil)
// ContactReference is used to reference a contact
type ContactReference struct {
UUID ContactUUID `json:"uuid" validate:"required,uuid4"`
Name string `json:"name"`
}
// NewContactReference creates a new contact reference with the given UUID and name
func NewContactReference(uuid ContactUUID, name string) *ContactReference {
return &ContactReference{UUID: uuid, Name: name}
}
//------------------------------------------------------------------------------------------
// JSON Encoding / Decoding
//------------------------------------------------------------------------------------------
type contactEnvelope struct {
UUID ContactUUID `json:"uuid" validate:"required,uuid4"`
ID ContactID `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Language utils.Language `json:"language,omitempty"`
Timezone string `json:"timezone,omitempty"`
CreatedOn time.Time `json:"created_on" validate:"required"`
URNs []urns.URN `json:"urns,omitempty" validate:"dive,urn"`
Groups []*assets.GroupReference `json:"groups,omitempty" validate:"dive"`
Fields map[string]*Value `json:"fields,omitempty"`
}
// ReadContact decodes a contact from the passed in JSON
func ReadContact(assets SessionAssets, data json.RawMessage, missing assets.MissingCallback) (*Contact, error) {
var envelope contactEnvelope
var err error
if err := utils.UnmarshalAndValidate(data, &envelope); err != nil {
return nil, errors.Wrap(err, "unable to read contact")
}
c := &Contact{
uuid: envelope.UUID,
id: envelope.ID,
name: envelope.Name,
language: envelope.Language,
createdOn: envelope.CreatedOn,
}
if envelope.Timezone != "" {
if c.timezone, err = time.LoadLocation(envelope.Timezone); err != nil {
return nil, err
}
}
if envelope.URNs == nil {
c.urns = make(URNList, 0)
} else {
if c.urns, err = ReadURNList(assets, envelope.URNs, missing); err != nil {
return nil, errors.Wrap(err, "error reading urns")
}
}
if envelope.Groups == nil {
c.groups = NewGroupList([]*Group{})
} else {
groups := make([]*Group, 0, len(envelope.Groups))
for _, g := range envelope.Groups {
group, err := assets.Groups().Get(g.UUID)
if err != nil {
missing(g)
} else {
groups = append(groups, group)
}
}
c.groups = NewGroupList(groups)
}
if c.fields, err = NewFieldValues(assets, envelope.Fields, missing); err != nil {
return nil, errors.Wrap(err, "error reading fields")
}
return c, nil
}
// MarshalJSON marshals this contact into JSON
func (c *Contact) MarshalJSON() ([]byte, error) {
ce := &contactEnvelope{
Name: c.name,
UUID: c.uuid,
ID: c.id,
Language: c.language,
CreatedOn: c.createdOn,
}
ce.URNs = c.urns.RawURNs()
if c.timezone != nil {
ce.Timezone = c.timezone.String()
}
ce.Groups = make([]*assets.GroupReference, c.groups.Count())
for g, group := range c.groups.All() {
ce.Groups[g] = group.Reference()
}
ce.Fields = make(map[string]*Value)
for _, v := range c.fields {
if v != nil {
ce.Fields[v.field.Key()] = v.Value
}
}
return json.Marshal(ce)
}