-
Notifications
You must be signed in to change notification settings - Fork 0
/
__init__.py
265 lines (217 loc) · 8.63 KB
/
__init__.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
from mycroft import MycroftSkill, intent_handler
#from datetime import date, timedelta, datetime, time, tzinfo
from datetime import datetime, timezone
import pytz
import subprocess
import re
import time
"""
Print support Mycroft Skill
"""
class Print(MycroftSkill):
def __init__(self):
MycroftSkill.__init__(self)
self.printer_active = False
self.print_dev = ""
self.print_time = True
self.print_all = False
self.print_lf = False
self.bucket_size = 50
self.msg_bucket = []
def initialize(self):
self.add_event('speak', self.handler_speak)
self.settings_change_callback = self.load_configuration
self.load_configuration()
self.register_entity_file('target.entity')
self.register_entity_file('action.entity')
self.register_entity_file('amount.entity')
def stop(self):
pass
def shutdown(self):
pass
def load_configuration(self):
self.printer_active = self.settings.get('printeractive', False)
self.print_dev = self.settings.get('printdev')
self.print_all = self.settings.get('printall', False)
self.print_lf = self.settings.get('printlf', False)
self.print_time = self.settings.get('printtime', True)
self.bucket_size = self.settings.get('bucketsize', 50)
if self.__valid_printdev(self.print_dev):
self.log.info("Printer device is: " + str(self.print_dev))
else:
self.printer_disable()
self.log.debug("Print out everything is set to: " + str(self.print_all))
self.log.debug("Past messages bucket size: " + str(self.bucket_size))
return
def bucket_add(self, message):
if self.bucket_size <= len(self.msg_bucket):
del self.msg_bucket[0]
self.msg_bucket.append((self.__get_datetime(), message))
def printer_status(self):
status = "disabled"
if self.printer_active:
status = "enabled"
self.speak_dialog('status', data={"target": "printer", "status": status})
if self.print_all is False and self.printer_active:
self.__print("The printer is " + status + ".")
return
def printer_enable(self):
self.printer_active = True
self.settings['printeractive'] = True
return
def printer_disable(self):
self.printer_active = False
self.settings['printeractive'] = False
return
def linefeed_status(self):
status = "disabled"
if self.print_lf:
status = "enabled"
self.speak_dialog('status', data={"target": "linefeed", "status": status})
if self.print_all is False and self.printer_active:
self.__print("Linefeed is " + status + ".")
def linefeed_enable(self):
self.print_lf = True
self.settings['printlf'] = True
return
def linefeed_disable(self):
self.print_lf = False
self.settings['printlf'] = False
return
""" Private: Get a nice date/time string """
def __get_datetime(self):
tz = pytz.timezone(self.location_timezone)
cur_time_obj = datetime.now(tz)
return str(cur_time_obj.strftime('%d.%m.%Y %H:%M:%S %Z %z'))
""" Private: Generic regex check returning True/False """
def __regex_match(self, chk_strg, search=re.compile(r'[^/a-z0-9.]').search):
return not bool(search(chk_strg))
""" Private: Some checking to avoid shell command injection and to make sure the device is active. """
def __valid_printdev(self, printdev):
if self.__regex_match(printdev):
""" There's not too much garbage in the string, thus giving it a shot to see if it exists..."""
try:
subprocess.run(["ls", printdev], stdout=subprocess.DEVNULL, check=True, timeout=1)
return True
except:
self.printer_disable()
self.log.error("Configured printer device is invalid.")
return False
""" Private: Simple check to see if string is a number... """
def __is_number(self, s):
if s is None:
return False
try:
float(s)
return True
except ValueError:
return False
""" Private: Send message to printer device """
def __print(self, msg):
self.log.debug("Printing line for message: " +str(msg))
if self.printer_active is False:
self.log.debug("Printer is not active.")
return False
if self.__valid_printdev(self.print_dev) is False:
return False
try:
printdev = open(self.print_dev, "a")
except:
self.printer_disable()
self.log.error("Could not start printer communication.")
return False
try:
subprocess.run(['echo', msg], stdout=printdev, check=True, timeout=1)
except:
self.printer_disable()
self.log.error("Failed to send message to printer.")
return False
printdev.close()
return True
""" Public: Prepare and send message """
def print_out(self, msg):
self.log.debug("Starting print out.")
if self.print_time:
if self.__print(self.__get_datetime()) is False:
self.speak_dialog('error')
return False
if self.__print(str(msg)) is False:
self.speak_dialog('error')
return False
if self.print_lf:
if self.__print(str(" ")) is False:
self.speak_dialog('error')
return False
return True
"""
Handle intents
"""
@intent_handler('print.intent')
def handler_print(self, message):
self.log.debug("Running print.intent handler.")
""" Fetch the target from the message """
target = message.data.get('target')
amount = message.data.get('amount')
""" Print an empty line... """
if target in ["linefeed", "feed"]:
self.__print(" ")
""" Print a local time/date stamp """
if target in ["time", "date"]:
self.__print(self.__get_datetime())
""" Print the printer status """
if target == "status":
self.printer_status()
if self.__is_number(amount):
self.print_out("TESTING AMOUNT: " + str(amount))
if target == "buffer":
self.speak("Printing message buffer.")
if len(self.msg_bucket) == 0:
self.speak("The message buffer is empty.")
return True
else:
for msg_item in self.msg_bucket:
(ts, msg) = msg_item
time.sleep(1)
self.__print("@" + ts)
time.sleep(1)
if msg is not None and msg != "":
self.__print(msg.data.get('utterance'))
else:
self.__print("blank message")
# TODO: Add locking on __print
@intent_handler('printerconfig.intent')
def handler_config(self, message):
self.log.debug("Running printerconfig.intent handler.")
action = message.data.get('action')
target = message.data.get('target')
if action is None or target is None:
self.speak_dialog('pleaserepeat')
return
if action in ["enable", "activate", "on"] and target == "printer":
self.printer_enable()
elif action in ["enable", "activate", "on"] and target in ["linefeed", "feed"]:
self.linefeed_enable()
elif action in ["disable", "deactivate", "off"] and target == "printer":
self.printer_disable()
elif action in ["disable", "deactivate", "off"] and target in ["linefeed", "feed"]:
self.linefeed_disable()
if target == "printer":
self.printer_status()
if target in ["linefeed", "feed"]:
self.linefeed_status()
def handler_speak(self, message):
self.bucket_add(message)
if self.printer_active:
if self.print_all:
try:
self.print_out(format(message.data.get('utterance')))
except:
self.printer_disable()
self.log.error("Error while printing.")
self.speak_dialog('error')
else:
self.log.debug("Skipping printout of message.")
else:
self.log.debug("Skipping printout because printer is not active.")
def create_skill():
return Print()