-
Notifications
You must be signed in to change notification settings - Fork 1
/
RattConfig.py
522 lines (412 loc) · 19.4 KB
/
RattConfig.py
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
# -*- coding: utf-8 -*-
# --------------------------------------------------------------------------
# _____ ______________
# | __ \ /\|__ ____ __|
# | |__) | / \ | | | |
# | _ / / /\ \ | | | |
# | | \ \/ ____ \| | | |
# |_| \_\/ \_\_| |_| ... RFID ALL THE THINGS!
#
# A resource access control and telemetry solution for Makerspaces
#
# Developed at MakeIt Labs - New Hampshire's First & Largest Makerspace
# http://www.makeitlabs.com/
#
# Copyright 2018 MakeIt Labs
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and assoceiated 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.
#
# --------------------------------------------------------------------------
#
# Author: Steve Richardson (steve.richardson@makeitlabs.com)
#
from PyQt5.QtCore import QObject, QMutex, QIODevice, pyqtSlot, pyqtSignal, pyqtProperty, QVariant, QUrl
from PyQt5.QtCore import QFile, QFileInfo
from PyQt5.QtNetwork import QNetworkRequest, QNetworkReply
from PyQt5.QtQml import QQmlListProperty, qmlRegisterType
import configparser
from Logger import Logger
import json
from CachedRemoteFile import CachedRemoteFile
class Issue(QObject):
nameChanged = pyqtSignal()
def __init__(self, name='', *args, **kwargs):
super(Issue, self).__init__(*args, **kwargs)
self._name = name
@pyqtProperty('QString', notify=nameChanged)
def name(self):
return self._name
@name.setter
def name(self, name):
if name != self._name:
self._name = name
self.nameChanged.emit()
class RattConfig(QObject):
configChanged = pyqtSignal()
configError = pyqtSignal()
@pyqtProperty(bool, notify=configChanged)
def haveInitialRemoteConfig(self):
return self._haveInitialRemoteConfig
def __init__(self, inifile, loglevel='INFO'):
QObject.__init__(self)
self.logger = Logger(name='ratt.config')
self.logger.setLogLevelStr(loglevel)
self.debug = self.logger.isDebug()
self._inifile = inifile
self._haveInitialRemoteConfig = False
qmlRegisterType(Issue, 'RATT', 1, 0, 'Issue')
self.loadBootstrapConfig()
self.remoteConfig = None
def setNetWorker(self, netWorker=None):
assert netWorker
self.remoteConfig = CachedRemoteFile()
self.remoteConfig.update.connect(self.slotRemoteConfigUpdate)
self.remoteConfig.updateError.connect(self.slotRemoteConfigUpdateError)
self.remoteConfig.setup(logger=self.logger, netWorker=netWorker, url=self.config['Auth.ConfigUrl'], cacheFile=self.config['Auth.ConfigCacheFile'])
self.remoteConfig.download()
def setMQTT(self, mqtt=None):
assert mqtt
self.mqtt = mqtt
self.mqtt.broadcastEvent.connect(self.__slotBroadcastMQTTEvent)
self.mqtt.targetedEvent.connect(self.__slotTargetedMQTTEvent)
@pyqtSlot()
def slotRemoteConfigUpdate(self):
self.logger.info('REMOTE CONFIG UPDATE!')
obj = self.remoteConfig.getObj()
if obj['status'] == 'success':
p = obj['params']
for section, params in p.items():
if type(params) is dict:
for key, value in params.items():
if type(value) is dict:
self.logger.warning('cannot parse dict values in remote config section=%s key=%s -> %s' % (section, key, value))
else:
self.config['%s.%s' % (section, key)] = value
else:
self.logger.warning('cannot parse remote option %s (Key Name must be in form of Section.KeyName)' % (section))
if self.remoteConfig.status != 'same_hash':
self.configChanged.emit()
if not self._haveInitialRemoteConfig:
self._haveInitialRemoteConfig = True
else:
if self.mqtt:
o = { 'status': self.remoteConfig.status, 'source': self.remoteConfig.source, 'hash': self.remoteConfig.hash}
self.mqtt.slotPublishSubtopic('config/update', json.dumps(o))
@pyqtSlot()
def slotRemoteConfigUpdateError(self):
self.logger.error('REMOTE CONFIG UPDATE ERROR!')
self.configError.emit()
# MQTT targeted event
@pyqtSlot(str, str)
def __slotTargetedMQTTEvent(self, subtopic, message):
tsplit = subtopic.split('/')
if len(tsplit) >= 2 and tsplit[0] == 'config':
cmd = tsplit[1]
if cmd == 'update':
self.remoteConfig.download()
# MQTT broadcast event
@pyqtSlot(str, str)
def __slotBroadcastMQTTEvent(self, subtopic, message):
tsplit = subtopic.split('/')
if len(tsplit) >= 2 and tsplit[0] == 'config':
cmd = tsplit[1]
if cmd == 'update':
self.remoteConfig.download()
#---------------------------------------------------------------------------------------------
# if any config variables need to be exposed to QML they need to be defined here as properties
# naming convention to translate from "Section.Key" is to name the property "Section_Key"
#
@pyqtProperty(QVariant, notify=configChanged)
def General_Debug(self):
return self.config['General.Debug']
@pyqtProperty(QVariant, notify=configChanged)
def General_Diags(self):
return self.config['General.Diags']
@pyqtProperty(list, notify=configChanged)
def GPIO_InputNames(self):
return self.config['GPIO.InputNames'].split(',')
@pyqtProperty(list, notify=configChanged)
def GPIO_OutputNames(self):
return self.config['GPIO.OutputNames'].split(',')
@pyqtProperty(str, notify=configChanged)
def Personality_Class(self):
return self.config['Personality.Class']
@pyqtProperty(int, notify=configChanged)
def Personality_TimeoutSeconds(self):
return self.config['Personality.TimeoutSeconds']
@pyqtProperty(int, notify=configChanged)
def Personality_AdminTimeoutSeconds(self):
return self.config['Personality.AdminTimeoutSeconds']
@pyqtProperty(int, notify=configChanged)
def Personality_TimeoutWarningSeconds(self):
return self.config['Personality.TimeoutWarningSeconds']
@pyqtProperty(bool, notify=configChanged)
def Personality_MonitorEstopEnabled(self):
return self.config['Personality.MonitorEstopEnabled']
@pyqtProperty(bool, notify=configChanged)
def Personality_SafetyCheckEnabled(self):
return self.config['Personality.SafetyCheckEnabled']
@pyqtProperty(bool, notify=configChanged)
def Personality_MonitorToolPowerEnabled(self):
return self.config['Personality.MonitorToolPowerEnabled']
@pyqtProperty(bool, notify=configChanged)
def Personality_HomingManualOverrideEnabled(self):
return self.config['Personality.HomingManualOverrideEnabled']
@pyqtProperty(bool, notify=configChanged)
def Personality_HomingExternalOverrideEnabled(self):
return self.config['Personality.HomingExternalOverrideEnabled']
@pyqtProperty(str, notify=configChanged)
def Personality_Password(self):
return self.config['Personality.Password']
@pyqtProperty(str, notify=configChanged)
def Personality_PasswordPrompt(self):
return self.config['Personality.PasswordPrompt']
@pyqtProperty(bool, notify=configChanged)
def Personality_PasswordEnabled(self):
return self.config['Personality.PasswordEnabled']
@pyqtProperty(str, notify=configChanged)
def Personality_PasswordCorrectText(self):
return self.config['Personality.PasswordCorrectText']
@pyqtProperty(str, notify=configChanged)
def Personality_PasswordIncorrectText(self):
return self.config['Personality.PasswordIncorrectText']
@pyqtProperty(bool, notify=configChanged)
def Personality_AllowForceLogout(self):
return self.config['Personality.AllowForceLogout']
@pyqtProperty(bool, notify=configChanged)
def Personality_UseEndorsements(self):
return self.config['Personality.UseEndorsements']
@pyqtProperty(str, notify=configChanged)
def Personality_AdvancedEndorsement(self):
return self.config['Personality.AdvancedEndorsement']
@pyqtProperty(str, notify=configChanged)
def Personality_AdvancedDescription(self):
return self.config['Personality.AdvancedDescription']
@pyqtProperty(str, notify=configChanged)
def Personality_NonAdvancedDescription(self):
return self.config['Personality.NonAdvancedDescription']
@pyqtProperty(str, notify=configChanged)
def General_ToolDesc(self):
return self.config['General.ToolDesc']
@pyqtProperty(int, notify=configChanged)
def RFID_SimulatedTag(self):
return self.config['RFID.SimulatedTag']
@pyqtProperty(bool, notify=configChanged)
def Sound_EnableSilenceLoop(self):
return self.config['Sound.EnableSilenceLoop']
@pyqtProperty(str, notify=configChanged)
def Sound_Silence(self):
return self.config['Sound.Silence']
@pyqtProperty(str, notify=configChanged)
def Sound_KeyPress(self):
return self.config['Sound.KeyPress']
@pyqtProperty(str, notify=configChanged)
def Sound_GeneralAlert(self):
return self.config['Sound.GeneralAlert']
@pyqtProperty(str, notify=configChanged)
def Sound_General2Alert(self):
return self.config['Sound.General2Alert']
@pyqtProperty(str, notify=configChanged)
def Sound_General3Alert(self):
return self.config['Sound.General3Alert']
@pyqtProperty(str, notify=configChanged)
def Sound_General4Alert(self):
return self.config['Sound.General4Alert']
@pyqtProperty(str, notify=configChanged)
def Sound_RFIDSuccess(self):
return self.config['Sound.RFIDSuccess']
@pyqtProperty(str, notify=configChanged)
def Sound_RFIDFailure(self):
return self.config['Sound.RFIDFailure']
@pyqtProperty(str, notify=configChanged)
def Sound_RFIDError(self):
return self.config['Sound.RFIDError']
@pyqtProperty(str, notify=configChanged)
def Sound_SafetyFailed(self):
return self.config['Sound.SafetyFailed']
@pyqtProperty(str, notify=configChanged)
def Sound_Enable(self):
return self.config['Sound.Enable']
@pyqtProperty(str, notify=configChanged)
def Sound_Disable(self):
return self.config['Sound.Disable']
@pyqtProperty(str, notify=configChanged)
def Sound_TimeoutWarning(self):
return self.config['Sound.TimeoutWarning']
@pyqtProperty(str, notify=configChanged)
def Sound_ReportSuccess(self):
return self.config['Sound.ReportSuccess']
@pyqtProperty(str, notify=configChanged)
def Sound_LiftInstructions(self):
return self.config['Sound.LiftInstructions']
@pyqtProperty(str, notify=configChanged)
def Sound_LiftCorrect(self):
return self.config['Sound.LiftCorrect']
@pyqtProperty(str, notify=configChanged)
def Sound_LiftIncorrect(self):
return self.config['Sound.LiftIncorrect']
@pyqtProperty(str, notify=configChanged)
def Sound_HomingInstructions(self):
return self.config['Sound.HomingInstructions']
@pyqtProperty(str, notify=configChanged)
def Sound_HomingWarning(self):
return self.config['Sound.HomingWarning']
@pyqtProperty(str, notify=configChanged)
def Sound_HomingOverride(self):
return self.config['Sound.HomingOverride']
@pyqtProperty(str, notify=configChanged)
def Sound_EnableEstop(self):
return self.config['Sound.EnableEstop']
@pyqtProperty(str, notify=configChanged)
def Issues_Count(self):
return len(self.parser.items('Issues'))
@pyqtProperty(QQmlListProperty, notify=configChanged)
def Issues(self):
list = [Issue(name='Exit (no issue to report)')]
keys = []
for pair in self.config.items():
(name, descr) = pair
if name.startswith('Issues'):
keys.append(name)
keys.sort()
for key in keys:
descr = self.config[key]
list.append(Issue(name=descr))
return QQmlListProperty(Issue, self, list)
#---------------------------------------------------------------------------------------------
def value(self, key):
return self.config[key]
def addConfig(self, section, key, default=''):
try:
self.config['%s.%s' % (section, key)] = self.parser.get(section, key)
except configparser.NoOptionError:
self.config['%s.%s' % (section, key)] = default
def addConfigBool(self, section, key, default=False):
try:
self.config['%s.%s' % (section, key)] = self.parser.getboolean(section, key)
except configparser.NoOptionError:
self.config['%s.%s' % (section, key)] = default
def addConfigInt(self, section, key, default=0):
try:
self.config['%s.%s' % (section, key)] = self.parser.getint(section, key)
except configparser.NoOptionError:
self.config['%s.%s' % (section, key)] = default
def addConfigFloat(self, section, key, default=0.0):
try:
self.config['%s.%s' % (section, key)] = self.parser.getfloat(section, key)
except configparser.NoOptionError:
self.config['%s.%s' % (section, key)] = default
def addSection(self, section):
if not section in self.parser.sections():
self.parser.add_section(section)
def loadBootstrapConfig(self):
self.parser = configparser.ConfigParser()
self.parser.read(self._inifile)
self.config = { }
self.addSection('General')
self.addConfigBool('General', 'Diags', True)
self.addConfig('General', 'ToolDesc', 'Tool')
self.addConfig('General', 'NetworkInterfaceName', 'wlan0')
self.addConfig('General', 'NodeId', None)
self.addSection('GPIO')
self.addConfigBool('GPIO', 'Simulated', False)
self.addConfig('GPIO', 'InputNames', 'IN1,IN2,IN3,IN4')
self.addConfig('GPIO', 'OutputNames', 'OUT1,OUT2,OUT3,OUT4')
self.addSection('Log')
self.addConfig('Log', 'File')
self.addConfigBool('Log', 'Console', True)
self.addConfigBool('Log', 'Qt', True)
self.addConfigBool('Log', 'QtVerbose', False)
self.addConfig('Log', 'LogLevel', 'INFO')
self.addSection('Personality')
self.addConfig('Personality', 'Class', 'Simple')
self.addConfig('Personality', 'LogLevel', 'INFO')
self.addConfigInt('Personality', 'TimeoutSeconds', 300)
self.addConfigInt('Personality', 'AdminTimeoutSeconds', 600)
self.addConfigInt('Personality', 'TimeoutWarningSeconds', 30)
self.addConfigBool('Personality', 'MonitorEstopEnabled', False)
self.addConfigBool('Personality', 'SafetyCheckEnabled', False)
self.addConfigBool('Personality', 'MonitorToolPowerEnabled', False)
self.addConfigBool('Personality', 'HomingManualOverrideEnabled', False)
self.addConfigBool('Personality', 'HomingExternalOverrideEnabled', False)
self.addConfigBool('Personality', 'PasswordEnabled', False)
self.addConfig('Personality', 'Password', 'RATT')
self.addConfig('Personality', 'PasswordPrompt', 'Password')
self.addConfig('Personality', 'PasswordCorrectText', 'Thank you, that is correct.')
self.addConfig('Personality', 'PasswordIncorrectText', 'Sorry, that is incorrect.')
self.addConfigBool('Personality', 'AllowForceLogout', False)
self.addConfigBool('Personality', 'UseEndorsements', False)
self.addConfig('Personality', 'AdvancedEndorsement')
self.addConfig('Personality', 'AdvancedDescription', 'ADVANCED')
self.addConfig('Personality', 'NonAdvancedDescription', 'BASIC')
self.addSection('Auth')
self.addConfig('Auth', 'LogLevel', 'INFO')
self.addConfig('Auth', 'ResourceId', 'frontdoor')
self.addConfig('Auth', 'HttpAuthUser', 'user')
self.addConfig('Auth', 'HttpAuthPassword', 'password')
self.addConfig('Auth', 'AclUrl')
self.addConfig('Auth', 'AclCacheFile', '/data/ratt/ratt.acl')
self.addConfig('Auth', 'ConfigUrl')
self.addConfig('Auth', 'ConfigCacheFile', '/data/ratt/ratt-remote.conf')
self.addSection('MQTT')
self.addConfig('MQTT', 'LogLevel', 'INFO')
self.addConfig('MQTT', 'SSLEnabled', False)
self.addConfig('MQTT', 'CACertFile', '/data/certs/ca.crt')
self.addConfig('MQTT', 'ClientCertFile', '/data/certs/client.crt')
self.addConfig('MQTT', 'ClientKeyFile', '/data/certs/client.key')
self.addConfig('MQTT', 'BrokerHost')
self.addConfigInt('MQTT', 'BrokerPort', 1883)
self.addConfigInt('MQTT', 'ReconnectTime', 2000)
self.addConfig('MQTT', 'BaseTopic', 'ratt')
self.addSection('HTTPS')
self.addConfigBool('HTTPS', 'ClientCertsEnabled', False)
self.addConfig('HTTPS', 'CaCertFile', '/data/certs/ca.crt')
self.addConfig('HTTPS', 'ClientCertFile', '/data/certs/client.crt')
self.addConfig('HTTPS', 'ClientKeyFile', '/data/certs/client.key')
self.addSection('RFID')
self.addConfig('RFID', 'LogLevel', 'INFO')
self.addConfig('RFID', 'SerialPort', '/dev/ttyS0')
self.addConfigInt('RFID', 'SimulatedTag', 0)
self.addSection('Sound')
self.addConfigBool('Sound', 'EnableSilenceLoop', True)
self.addConfig('Sound', 'Silence', '')
self.addConfig('Sound', 'KeyPress', '')
self.addConfig('Sound', 'GeneralAlert', '')
self.addConfig('Sound', 'General2Alert', '')
self.addConfig('Sound', 'General3Alert', '')
self.addConfig('Sound', 'General4Alert', '')
self.addConfig('Sound', 'RFIDSuccess', '')
self.addConfig('Sound', 'RFIDFailure', '')
self.addConfig('Sound', 'RFIDError', '')
self.addConfig('Sound', 'SafetyFailed', '')
self.addConfig('Sound', 'Enable', '')
self.addConfig('Sound', 'Disable', '')
self.addConfig('Sound', 'TimeoutWarning', '')
self.addConfig('Sound', 'ReportSuccess', '')
self.addConfig('Sound', 'LiftInstructions', '')
self.addConfig('Sound', 'LiftCorrect', '')
self.addConfig('Sound', 'LiftIncorrect', '')
self.addConfig('Sound', 'HomingInstructions', '')
self.addConfig('Sound', 'HomingWarning', '')
self.addConfig('Sound', 'HomingOverride', '')
self.addConfig('Sound', 'EnableEstop', '')
self.addSection('Issues')
for i in self.parser.items('Issues'):
(n, v) = i
self.addConfig('Issues', n)
self.configChanged.emit()