-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.go
564 lines (471 loc) · 14.1 KB
/
config.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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
package config
import (
"fmt"
"github.com/google/uuid"
"gopkg.in/yaml.v2"
"log"
"net/url"
"os"
"regexp"
"sort"
"strings"
"time"
)
const NameRegexp = "^[a-zA-Z0-9\\-]{1,32}$"
var nameMatcher = regexp.MustCompile(NameRegexp)
func ReadConfigFile(exe, source string) (config Config, err []error) {
yamlStr, e := os.ReadFile(source)
if e != nil {
return config, []error{fmt.Errorf("cannot read configuration: %v; use see `%s --help`", err, exe)}
}
return ReadConfig(yamlStr)
}
func ReadConfig(yamlStr []byte) (config Config, err []error) {
var configRead configRead
yamlStr = []byte(os.ExpandEnv(string(yamlStr)))
e := yaml.Unmarshal(yamlStr, &configRead)
if e != nil {
return config, []error{fmt.Errorf("cannot parse yaml: %s", e)}
}
return configRead.TransformAndValidate()
}
func (c Config) PrintConfig() (err error) {
newYamlStr, err := yaml.Marshal(c)
if err != nil {
return fmt.Errorf("cannot encode yaml again: %s", err)
}
log.Print("config: use the following config:")
for _, line := range strings.Split(string(newYamlStr), "\n") {
log.Print("config: ", line)
}
return nil
}
func (c configRead) TransformAndValidate() (ret Config, err []error) {
var e []error
ret.auth, e = c.Auth.TransformAndValidate()
err = append(err, e...)
ret.mqttClients, e = c.MqttClients.TransformAndValidate()
err = append(err, e...)
ret.devices, e = c.Devices.TransformAndValidate()
err = append(err, e...)
ret.views, e = c.Views.TransformAndValidate(ret.devices)
err = append(err, e...)
ret.httpServer, e = c.HttpServer.TransformAndValidate()
err = append(err, e...)
if c.Version == nil {
err = append(err, fmt.Errorf("Version must be defined. Use Version=0."))
} else {
ret.version = *c.Version
if ret.version != 0 {
err = append(err, fmt.Errorf("Version=%d is not supported.", ret.version))
}
}
if len(c.ProjectTitle) > 0 {
ret.projectTitle = c.ProjectTitle
} else {
ret.projectTitle = "go-iotdevice"
}
if c.LogConfig != nil && *c.LogConfig {
ret.logConfig = true
}
if c.LogWorkerStart != nil && *c.LogWorkerStart {
ret.logWorkerStart = true
}
if c.LogDebug != nil && *c.LogDebug {
ret.logDebug = true
}
return
}
func (c *authConfigRead) TransformAndValidate() (ret AuthConfig, err []error) {
ret.enabled = false
ret.jwtValidityPeriod = time.Hour
if randString, e := randomString(64); err == nil {
ret.jwtSecret = []byte(randString)
} else {
err = append(err, fmt.Errorf("Auth->JwtSecret: error while generating random secret: %s", e))
}
if c == nil {
return
}
ret.enabled = true
if c.JwtSecret != nil {
if len(*c.JwtSecret) < 32 {
err = append(err, fmt.Errorf("Auth->JwtSecret must be empty ot >= 32 chars"))
} else {
ret.jwtSecret = []byte(*c.JwtSecret)
}
}
if len(c.JwtValidityPeriod) < 1 {
// use default
} else if authJwtValidityPeriod, e := time.ParseDuration(c.JwtValidityPeriod); e != nil {
err = append(err, fmt.Errorf("Auth->JwtValidityPeriod='%s' parse error: %s",
c.JwtValidityPeriod, e,
))
} else if authJwtValidityPeriod < 0 {
err = append(err, fmt.Errorf("Auth->JwtValidityPeriod='%s' must be positive",
c.JwtValidityPeriod,
))
} else {
ret.jwtValidityPeriod = authJwtValidityPeriod
}
if c.HtaccessFile != nil && len(*c.HtaccessFile) > 0 {
if info, e := os.Stat(*c.HtaccessFile); e != nil {
err = append(err, fmt.Errorf("Auth->HtaccessFile='%s' cannot open file. error: %s",
*c.HtaccessFile, e,
))
} else if info.IsDir() {
err = append(err, fmt.Errorf("Auth->HtaccessFile='%s' must be a file, not a directory",
*c.HtaccessFile,
))
}
ret.htaccessFile = *c.HtaccessFile
}
return
}
func (c *httpServerConfigRead) TransformAndValidate() (ret HttpServerConfig, err []error) {
ret.enabled = false
ret.bind = "[::1]"
ret.port = 8000
if c == nil {
return
}
ret.enabled = true
if len(c.Bind) > 0 {
ret.bind = c.Bind
}
if c.Port != nil {
ret.port = *c.Port
}
if c.LogRequests != nil && *c.LogRequests {
ret.logRequests = true
}
ret.enableDocs = true
if c.EnableDocs != nil && !*c.EnableDocs {
ret.enableDocs = false
}
if len(c.FrontendProxy) > 0 {
u, parseError := url.Parse(c.FrontendProxy)
if parseError == nil {
ret.frontendProxy = u
} else {
err = append(err, fmt.Errorf("HttpServerConfig->FrontendProxy must not be empty (=disabled) or a valid URL, err: %s", parseError))
}
}
if len(c.FrontendPath) > 0 {
ret.frontendPath = c.FrontendPath
} else {
ret.frontendPath = "frontend-build"
}
if len(c.FrontendExpires) < 1 {
// use default 5min
ret.frontendExpires = 5 * time.Minute
} else if frontendExpires, e := time.ParseDuration(c.FrontendExpires); e != nil {
err = append(err, fmt.Errorf("HttpServerConfig->FrontendExpires='%s' parse error: %s", c.FrontendExpires, e))
} else if frontendExpires < 0 {
err = append(err, fmt.Errorf("HttpServerConfig->FrontendExpires='%s' must be positive", c.FrontendExpires))
} else {
ret.frontendExpires = frontendExpires
}
if len(c.ConfigExpires) < 1 {
// use default 1min
ret.configExpires = 1 * time.Minute
} else if configExpires, e := time.ParseDuration(c.ConfigExpires); e != nil {
err = append(err, fmt.Errorf("HttpServerConfig->ConfigExpires='%s' parse error: %s", c.ConfigExpires, e))
} else if configExpires < 0 {
err = append(err, fmt.Errorf("HttpServerConfig->ConfigExpires='%s' must be positive", c.ConfigExpires))
} else {
ret.configExpires = configExpires
}
return
}
func (c mqttClientConfigReadMap) getOrderedKeys() (ret []string) {
ret = make([]string, len(c))
i := 0
for k := range c {
ret[i] = k
i++
}
sort.Strings(ret)
return
}
func (c mqttClientConfigReadMap) TransformAndValidate() (ret []*MqttClientConfig, err []error) {
ret = make([]*MqttClientConfig, len(c))
j := 0
for _, name := range c.getOrderedKeys() {
r, e := c[name].TransformAndValidate(name)
ret[j] = &r
err = append(err, e...)
j++
}
return
}
func (c mqttClientConfigRead) TransformAndValidate(name string) (ret MqttClientConfig, err []error) {
ret = MqttClientConfig{
name: name,
user: c.User,
password: c.Password,
topicPrefix: c.TopicPrefix,
}
if !nameMatcher.MatchString(ret.name) {
err = append(err, fmt.Errorf("MqttClientConfig->Name='%s' does not match %s", ret.name, NameRegexp))
}
if len(c.Broker) < 1 {
err = append(err, fmt.Errorf("MqttClientConfig->%s->Broker must not be empty", name))
} else {
if broker, e := url.ParseRequestURI(c.Broker); e != nil {
err = append(err, fmt.Errorf("MqttClientConfig->%s->Broker invalid url: %s", name, e))
} else if broker == nil {
err = append(err, fmt.Errorf("MqttClientConfig->%s->Broker cannot parse broker", name))
} else {
ret.broker = broker
}
}
if c.ProtocolVersion == nil {
ret.protocolVersion = 5
} else if *c.ProtocolVersion == 3 || *c.ProtocolVersion == 5 {
ret.protocolVersion = *c.ProtocolVersion
} else {
err = append(err, fmt.Errorf("MqttClientConfig->%s->Protocol=%d but must be 3 or 5", name, *c.ProtocolVersion))
}
if c.ClientId == nil {
ret.clientId = "go-mqtt-to-influx-" + uuid.New().String()
} else {
ret.clientId = *c.ClientId
}
if c.Qos == nil {
ret.qos = 1 // default qos is 1
} else if *c.Qos == 0 || *c.Qos == 1 || *c.Qos == 2 {
ret.qos = *c.Qos
} else {
err = append(err, fmt.Errorf("MqttClientConfig->%s->Qos=%d but must be 0, 1 or 2", name, *c.Qos))
}
if len(c.KeepAlive) < 1 {
// use default 60s
ret.keepAlive = time.Minute
} else if keepAlive, e := time.ParseDuration(c.KeepAlive); e != nil {
err = append(err, fmt.Errorf("MqttClientConfig->%s->KeepAlive='%s' parse error: %s",
name, c.KeepAlive, e,
))
} else if keepAlive < time.Second {
err = append(err, fmt.Errorf("MqttClientConfig->%s->KeepAlive='%s' must be >=1s",
name, c.KeepAlive,
))
} else if keepAlive%time.Second != 0 {
err = append(err, fmt.Errorf("MqttClientConfig->%s->KeepAlive='%s' must be a multiple of a second",
name, c.KeepAlive,
))
} else {
ret.keepAlive = keepAlive
}
if len(c.ConnectRetryDelay) < 1 {
// use default 10s
ret.connectRetryDelay = 10 * time.Second
} else if connectRetryDelay, e := time.ParseDuration(c.ConnectRetryDelay); e != nil {
err = append(err, fmt.Errorf("MqttClientConfig->%s->ConnectRetryDelay='%s' parse error: %s",
name, c.ConnectRetryDelay, e,
))
} else if connectRetryDelay < 100*time.Millisecond {
err = append(err, fmt.Errorf("MqttClientConfig->%s->ConnectRetryDelay='%s' must be >=100ms",
name, c.ConnectRetryDelay,
))
} else {
ret.connectRetryDelay = connectRetryDelay
}
if len(c.ConnectTimeout) < 1 {
// use default 5s
ret.connectTimeout = 5 * time.Second
} else if connectTimeout, e := time.ParseDuration(c.ConnectTimeout); e != nil {
err = append(err, fmt.Errorf("MqttClientConfig->%s->ConnectTimeout='%s' parse error: %s",
name, c.ConnectTimeout, e,
))
} else if connectTimeout < 100*time.Millisecond {
err = append(err, fmt.Errorf("MqttClientConfig->%s->ConnectTimeout='%s' must be >=100ms",
name, c.ConnectTimeout,
))
} else {
ret.connectTimeout = connectTimeout
}
if c.AvailabilityTopic == nil {
// use default
ret.availabilityTopic = "%Prefix%tele/%ClientId%/status"
} else {
ret.availabilityTopic = *c.AvailabilityTopic
}
if len(c.TelemetryInterval) < 1 {
// use default 10s
ret.telemetryInterval = 10 * time.Second
} else if telemetryInterval, e := time.ParseDuration(c.TelemetryInterval); e != nil {
err = append(err, fmt.Errorf("HttpServerConfig->TelemetryInterval='%s' parse error: %s", c.TelemetryInterval, e))
} else if telemetryInterval < 0 {
err = append(err, fmt.Errorf("HttpServerConfig->TelemetryInterval='%s' must be positive", c.TelemetryInterval))
} else {
ret.telemetryInterval = telemetryInterval
}
if c.TelemetryTopic == nil {
ret.telemetryTopic = "%Prefix%tele/go-iotdevice/%DeviceName%/state"
} else {
ret.telemetryTopic = *c.TelemetryTopic
}
if c.TelemetryRetain == nil {
ret.realtimeRetain = false
} else {
ret.telemetryRetain = *c.TelemetryRetain
}
if c.RealtimeEnable == nil {
ret.realtimeRetain = false
} else {
ret.realtimeEnable = *c.RealtimeEnable
}
if c.RealtimeTopic == nil {
ret.realtimeTopic = "%Prefix%stat/go-iotdevice/%DeviceName%/%ValueName%"
} else {
ret.realtimeTopic = *c.RealtimeTopic
}
if c.RealtimeRetain == nil {
ret.realtimeRetain = true
} else {
ret.realtimeRetain = *c.RealtimeRetain
}
if c.LogDebug != nil && *c.LogDebug {
ret.logDebug = true
}
if c.LogMessages != nil && *c.LogMessages {
ret.logMessages = true
}
return
}
func (c deviceConfigReadMap) getOrderedKeys() (ret []string) {
ret = make([]string, len(c))
i := 0
for k := range c {
ret[i] = k
i++
}
sort.Strings(ret)
return
}
func (c deviceConfigReadMap) TransformAndValidate() (ret []*DeviceConfig, err []error) {
if len(c) < 1 {
return ret, []error{fmt.Errorf("Clients section must no be empty")}
}
ret = make([]*DeviceConfig, len(c))
j := 0
for _, name := range c.getOrderedKeys() {
r, e := c[name].TransformAndValidate(name)
ret[j] = &r
err = append(err, e...)
j++
}
return
}
func (c deviceConfigRead) TransformAndValidate(name string) (ret DeviceConfig, err []error) {
ret = DeviceConfig{
name: name,
kind: DeviceKindFromString(c.Kind),
device: c.Device,
skipFields: c.SkipFields,
skipCategories: c.SkipCategories,
}
if !nameMatcher.MatchString(ret.name) {
err = append(err, fmt.Errorf("DeviceConfig->Name='%s' does not match %s", ret.name, NameRegexp))
}
if ret.kind == UndefinedKind {
err = append(err, fmt.Errorf("DeviceConfig->%s->Kind='%s' is invalid", name, c.Kind))
}
if ret.kind == VedirectKind && len(c.Device) < 1 {
err = append(err, fmt.Errorf("DeviceConfig->%s->Device must not be empty", name))
}
if c.LogDebug != nil && *c.LogDebug {
ret.logDebug = true
}
if c.LogComDebug != nil && *c.LogComDebug {
ret.logComDebug = true
}
return
}
func (c viewConfigReadList) TransformAndValidate(devices []*DeviceConfig) (ret []*ViewConfig, err []error) {
if len(c) < 1 {
return ret, []error{fmt.Errorf("Views section must no be empty.")}
}
ret = make([]*ViewConfig, len(c))
j := 0
for _, cr := range c {
r, e := cr.TransformAndValidate(devices)
// check for duplicate name
for i := 0; i < j; i++ {
if r.Name() == ret[i].Name() {
err = append(err, fmt.Errorf("Views->Name='%s': name must be unique", r.Name()))
}
}
ret[j] = &r
err = append(err, e...)
j++
}
return
}
func (c viewConfigRead) TransformAndValidate(devices []*DeviceConfig) (ret ViewConfig, err []error) {
ret = ViewConfig{
name: c.Name,
title: c.Title,
allowedUsers: make(map[string]struct{}),
hidden: false,
skipFields: c.SkipFields,
skipCategories: c.SkipCategories,
}
if !nameMatcher.MatchString(ret.name) {
err = append(err, fmt.Errorf("Views->Name='%s' does not match %s", ret.name, NameRegexp))
}
if len(c.Title) < 1 {
err = append(err, fmt.Errorf("Views->%s->Title must not be empty", c.Name))
}
{
var devicesErr []error
ret.devices, devicesErr = c.Devices.TransformAndValidate(devices)
for _, ce := range devicesErr {
err = append(err, fmt.Errorf("Views->%s: %s", c.Name, ce))
}
}
if c.Autoplay != nil && *c.Autoplay {
ret.autoplay = true
}
for _, user := range c.AllowedUsers {
ret.allowedUsers[user] = struct{}{}
}
if c.Hidden != nil && *c.Hidden {
ret.hidden = true
}
return
}
func (c viewDeviceConfigReadList) TransformAndValidate(devices []*DeviceConfig) (ret []*ViewDeviceConfig, err []error) {
if len(c) < 1 {
return ret, []error{fmt.Errorf("Clients section must no be empty.")}
}
ret = make([]*ViewDeviceConfig, len(c))
for i, device := range c {
r, e := device.TransformAndValidate(devices)
ret[i] = &r
err = append(err, e...)
}
return
}
func (c viewDeviceConfigRead) TransformAndValidate(
devices []*DeviceConfig,
) (ret ViewDeviceConfig, err []error) {
if !deviceExists(c.Name, devices) {
err = append(err, fmt.Errorf("Device='%s' is not defined", c.Name))
}
ret = ViewDeviceConfig{
name: c.Name,
title: c.Title,
}
return
}
func deviceExists(deviceName string,
devices []*DeviceConfig) bool {
for _, client := range devices {
if deviceName == client.name {
return true
}
}
return false
}