-
Notifications
You must be signed in to change notification settings - Fork 0
/
opt.go
345 lines (321 loc) · 11.9 KB
/
opt.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
package pubsubmodel
import (
"encoding/json"
"errors"
"fmt"
"strconv"
"strings"
"github.com/dantin/cubit/module/xep0004"
)
const nodeConfigNamespace = "http://jabber.org/protocol/pubsub#node_config"
const (
titleFieldVar = "pubsub#title"
deliverNotificationsFieldVar = "pubsub#deliver_notifications"
deliverPayloadsFieldVar = "pubsub#deliver_payloads"
persistItemsFieldVar = "pubsub#persist_items"
maxItemsFieldVar = "pubsub#max_items"
accessModelFieldVar = "pubsub#access_model"
sendLastPublishedItemFieldVar = "pubsub#send_last_published_item"
rosterGroupsAllowedFieldVar = "pubsub#roster_groups_allowed"
notificationTypeFieldVar = "pubsub#notification_type"
notifyConfigFieldVar = "pubsub#notify_config"
notifyDeleteFieldVar = "pubsub#notify_delete"
notifyRetractFieldVar = "pubsub#notify_retract"
notifySubFieldVar = "pubsub#notify_sub"
)
const (
// Open represents 'open' access model.
Open = "open"
// Presence represents 'presence' access model.
Presence = "presence"
// Roster represents 'roster' access model.
Roster = "roster"
// WhiteList represents 'whitelist' access model.
WhiteList = "whitelist"
// Never represents 'never' send last published item option.
Never = "never"
// OnSub represents 'on_sub' send last published item option.
OnSub = "on_sub"
// OnSubAndPresence represents 'on_sub_and_presence' send last published item option.
OnSubAndPresence = "on_sub_and_presence"
)
// Options represents pubsub node configuration options.
type Options struct {
Title string
DeliverNotifications bool
DeliverPayloads bool
PersistItems bool
MaxItems int64
AccessModel string
SendLastPublishedItem string
RosterGroupsAllowed []string
NotificationType string
NotifyConfig bool
NotifyDelete bool
NotifySub bool
}
// NewOptionsFromMap returns a new node Options instance derived from an input map.
func NewOptionsFromMap(m map[string]string) (*Options, error) {
opt := &Options{}
// extract options values.
opt.Title = m[titleFieldVar]
opt.DeliverNotifications, _ = strconv.ParseBool(m[deliverNotificationsFieldVar])
opt.DeliverPayloads, _ = strconv.ParseBool(m[deliverPayloadsFieldVar])
opt.PersistItems, _ = strconv.ParseBool(m[persistItemsFieldVar])
opt.MaxItems, _ = strconv.ParseInt(m[maxItemsFieldVar], 10, 32)
opt.NotificationType = m[notificationTypeFieldVar]
opt.NotifyConfig, _ = strconv.ParseBool(m[notifyRetractFieldVar])
opt.NotifyDelete, _ = strconv.ParseBool(m[notifyDeleteFieldVar])
opt.NotifySub, _ = strconv.ParseBool(m[notifySubFieldVar])
// extract roster allowed groups.
allowedRosterGroupsJSON := m[rosterGroupsAllowedFieldVar]
if len(allowedRosterGroupsJSON) > 0 {
if err := json.NewDecoder(strings.NewReader(allowedRosterGroupsJSON)).Decode(&opt.RosterGroupsAllowed); err != nil {
return nil, err
}
}
// extract options values.
accessModel := m[accessModelFieldVar]
switch accessModel {
case Open, Presence, Roster, WhiteList:
opt.AccessModel = accessModel
default:
return nil, fmt.Errorf("invalid access_model value: %s", accessModel)
}
sendLastPublishedItem := m[sendLastPublishedItemFieldVar]
switch sendLastPublishedItem {
case Never, OnSub, OnSubAndPresence:
opt.SendLastPublishedItem = sendLastPublishedItem
default:
return nil, fmt.Errorf("invalid send_last_published_item value: %s", sendLastPublishedItem)
}
return opt, nil
}
// NewOptionsFromSubmitForm returns a new node Options instance derived from a submit form.
func NewOptionsFromSubmitForm(form *xep0004.DataForm) (*Options, error) {
opt := &Options{}
fields := form.Fields
if len(fields) == 0 {
return nil, errors.New("form empty fields")
}
// validate form type
formType := fields.ValueForFieldOfType(xep0004.FormType, xep0004.Hidden)
if form.Type != xep0004.Submit || formType != nodeConfigNamespace {
return nil, errors.New("invalid form type")
}
// extract options values
accessModel := fields.ValueForField(accessModelFieldVar)
switch accessModel {
case Open, Presence, Roster, WhiteList:
opt.AccessModel = accessModel
default:
return nil, fmt.Errorf("invalid access_model value: %s", accessModel)
}
sendLastPublishedItem := fields.ValueForField(sendLastPublishedItemFieldVar)
switch sendLastPublishedItem {
case Never, OnSub, OnSubAndPresence:
opt.SendLastPublishedItem = sendLastPublishedItem
default:
return nil, fmt.Errorf("invalid send_last_published_item value: %s", sendLastPublishedItem)
}
opt.Title = fields.ValueForField(titleFieldVar)
opt.DeliverNotifications, _ = strconv.ParseBool(fields.ValueForField(deliverNotificationsFieldVar))
opt.DeliverPayloads, _ = strconv.ParseBool(fields.ValueForField(deliverPayloadsFieldVar))
opt.PersistItems, _ = strconv.ParseBool(fields.ValueForField(persistItemsFieldVar))
opt.RosterGroupsAllowed = fields.ValuesForField(rosterGroupsAllowedFieldVar)
opt.MaxItems, _ = strconv.ParseInt(fields.ValueForField(maxItemsFieldVar), 10, 32)
opt.NotificationType = fields.ValueForField(notificationTypeFieldVar)
opt.NotifyConfig, _ = strconv.ParseBool(fields.ValueForField(notifyConfigFieldVar))
opt.NotifyDelete, _ = strconv.ParseBool(fields.ValueForField(notifyDeleteFieldVar))
opt.NotifySub, _ = strconv.ParseBool(fields.ValueForField(notifySubFieldVar))
return opt, nil
}
// Map returns Options map representation.
func (opt *Options) Map() (map[string]string, error) {
// marshal roster allowed groups.
b, err := json.Marshal(&opt.RosterGroupsAllowed)
if err != nil {
return nil, err
}
m := make(map[string]string)
m[titleFieldVar] = opt.Title
m[deliverNotificationsFieldVar] = strconv.FormatBool(opt.DeliverNotifications)
m[deliverPayloadsFieldVar] = strconv.FormatBool(opt.DeliverPayloads)
m[persistItemsFieldVar] = strconv.FormatBool(opt.PersistItems)
m[maxItemsFieldVar] = strconv.Itoa(int(opt.MaxItems))
m[accessModelFieldVar] = opt.AccessModel
m[rosterGroupsAllowedFieldVar] = string(b)
m[sendLastPublishedItemFieldVar] = opt.SendLastPublishedItem
m[notificationTypeFieldVar] = opt.NotificationType
m[notifyConfigFieldVar] = strconv.FormatBool(opt.NotifyConfig)
m[notifyDeleteFieldVar] = strconv.FormatBool(opt.NotifyDelete)
m[notifySubFieldVar] = strconv.FormatBool(opt.NotifySub)
return m, nil
}
// Form returns Options form representation.
func (opt *Options) Form(rosterGroups []string) *xep0004.DataForm {
form := xep0004.DataForm{
Type: xep0004.Form,
}
// include form type
form.Fields = append(form.Fields, xep0004.Field{
Var: xep0004.FormType,
Type: xep0004.Hidden,
Values: []string{nodeConfigNamespace},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: titleFieldVar,
Type: xep0004.TextSingle,
Label: "Node title",
Values: []string{opt.Title},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: deliverNotificationsFieldVar,
Type: xep0004.Boolean,
Label: "Whether to deliver event notifications",
Values: []string{strconv.FormatBool(opt.DeliverNotifications)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: deliverPayloadsFieldVar,
Type: xep0004.Boolean,
Label: "Whether to deliver payloads with event notifications",
Values: []string{strconv.FormatBool(opt.DeliverPayloads)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: persistItemsFieldVar,
Type: xep0004.Boolean,
Label: "Whether to persist items to storage",
Values: []string{strconv.FormatBool(opt.PersistItems)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: maxItemsFieldVar,
Type: xep0004.Boolean,
Label: "Max number of items to persist",
Values: []string{strconv.FormatInt(opt.MaxItems, 10)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: accessModelFieldVar,
Type: xep0004.ListSingle,
Values: []string{opt.AccessModel},
Label: "Specify the subscriber model",
Options: []xep0004.Option{
{Label: "Open", Value: Open},
{Label: "Presence Sharing", Value: Presence},
{Label: "Roster Groups", Value: Roster},
{Label: "Whitelist", Value: WhiteList},
},
})
// roster groups allowed
var rosterGroupOpts []xep0004.Option
for _, rg := range rosterGroups {
rosterGroupOpts = append(rosterGroupOpts, xep0004.Option{Label: rg, Value: rg})
}
form.Fields = append(form.Fields, xep0004.Field{
Var: rosterGroupsAllowedFieldVar,
Type: xep0004.ListMulti,
Values: opt.RosterGroupsAllowed,
Label: "Roster groups allowed to subscribe",
Options: rosterGroupOpts,
})
form.Fields = append(form.Fields, xep0004.Field{
Var: sendLastPublishedItemFieldVar,
Type: xep0004.ListSingle,
Label: "When to send the last published item",
Values: []string{opt.SendLastPublishedItem},
Options: []xep0004.Option{
{Label: "Never", Value: Never},
{Label: "When a new subscription is processed", Value: OnSub},
{Label: "When a new subscription is processed and whenever a subscriber comes online", Value: OnSubAndPresence},
},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notificationTypeFieldVar,
Type: xep0004.ListSingle,
Label: "Specify the delivery style for event notifications",
Values: []string{opt.NotificationType},
Options: []xep0004.Option{
{Value: "normal"},
{Value: "headline"},
},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifyConfigFieldVar,
Type: xep0004.Boolean,
Label: "Notify subscribers when the node configuration changes",
Values: []string{strconv.FormatBool(opt.NotifyConfig)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifyDeleteFieldVar,
Type: xep0004.Boolean,
Label: "Notify subscribers when the node is deleted",
Values: []string{strconv.FormatBool(opt.NotifyDelete)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifySubFieldVar,
Type: xep0004.Boolean,
Label: "Notify owners about new subscribers and unsubscribes",
Values: []string{strconv.FormatBool(opt.NotifySub)},
})
return &form
}
// ResultForm returns Options result form representation.
func (opt *Options) ResultForm() *xep0004.DataForm {
form := xep0004.DataForm{
Type: xep0004.Result,
}
// include form type
form.Fields = append(form.Fields, xep0004.Field{
Var: xep0004.FormType,
Type: xep0004.Hidden,
Values: []string{nodeConfigNamespace},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: titleFieldVar,
Values: []string{opt.Title},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: deliverNotificationsFieldVar,
Values: []string{strconv.FormatBool(opt.DeliverNotifications)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: deliverPayloadsFieldVar,
Values: []string{strconv.FormatBool(opt.DeliverPayloads)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: persistItemsFieldVar,
Values: []string{strconv.FormatBool(opt.PersistItems)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: maxItemsFieldVar,
Values: []string{strconv.Itoa(int(opt.MaxItems))},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: accessModelFieldVar,
Values: []string{opt.AccessModel},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: accessModelFieldVar,
Values: []string{opt.AccessModel},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: sendLastPublishedItemFieldVar,
Values: []string{opt.SendLastPublishedItem},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notificationTypeFieldVar,
Values: []string{opt.NotificationType},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifyConfigFieldVar,
Values: []string{strconv.FormatBool(opt.NotifyConfig)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifyDeleteFieldVar,
Values: []string{strconv.FormatBool(opt.NotifyDelete)},
})
form.Fields = append(form.Fields, xep0004.Field{
Var: notifySubFieldVar,
Values: []string{strconv.FormatBool(opt.NotifySub)},
})
return &form
}