Repository navigation
Expand file tree
/
Copy pathdScriptServer.py
More file actions
289 lines (264 loc) · 14.7 KB
/
Copy pathdScriptServer.py
File metadata and controls
289 lines (264 loc) · 14.7 KB
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
#!/usr/bin/python
# version: 2021.09.11
# author: Martin Kraemer, mk.maddin@gmail.com
# description:
# object capturing all incoming command triggers (protocol independend) and trowing events
from __future__ import annotations
import logging
_LOGGER = logging.getLogger(__name__)
from .dScriptObject import *
from threading import Thread
import asyncio
import _thread
import socket
class dScriptServer(dScriptObject):
_EventHandlers = { 'heartbeat':[], 'getstatus':[], 'getrelay':[], 'getinput':[], 'getanalogue':[], 'getcounter':[], 'getconfig':[], 'getlight':[], 'getshutter':[], 'getsocket':[], 'getmotion':[], 'getbutton':[], 'testonline':[] }
__server = None
__thread = None
__socketsize = 100
__mode = None
def __init__(self, TCP_IP='127.0.0.1', TCP_PORT=17123, PROTOCOL='binary'):
_LOGGER.debug("dScriptServer - %s:%s: __init__", TCP_IP, TCP_PORT)
self.IP = TCP_IP
self.Port = TCP_PORT
self.SetProtocol(PROTOCOL)
self.State = False
self.__server = None
self.__thread = None
def StartServer(self):
_LOGGER.debug("dScriptServer - %s:%s: StartServer", self.IP, self.Port)
if self.__mode == 'async':
return self.async_StartServer()
elif self.__mode == 'thread':
return self.StartServer_async()
if not self.__server is None or not self.__mode is None:
raise Exception("Server already started")
return False
try:
self.__mode = 'sync'
self.__thread = Thread(target=self.__ServerThread, daemon=True)
self.__thread.start()
_LOGGER.debug("dScriptServer - %s:%s: StartServer - completed", self.IP, self.Port)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: StartServer failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
async def async_StartServer(self):
_LOGGER.debug("dScriptServer - %s:%s: async_StartServer", self.IP, self.Port)
if self.__mode == 'sync':
return self.StartServer()
elif self.__mode == 'thread':
return self.StartServer_async()
if not self.__server is None or not self.__mode is None:
raise Exception("Server already running")
return False
try:
loop = asyncio.get_event_loop()
server_coro = await asyncio.start_server(self.__async_ClientConnected, self.IP, self.Port)
if not loop.is_running():
self.__server = loop.run_until_complete(server_coro)
else:
self.__server = server_coro
_LOGGER.info("dScriptServer - %s:%s: async_StartServer - serving on: %s:%s", self.IP, self.Port, self.IP, self.Port)
self.State = self.__server.is_serving()
self.__mode = 'async'
_LOGGER.debug("dScriptServer - %s:%s: async_StartServer - completed", self.IP, self.Port)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: async_StartServer failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
def StartServer_async(self):
self.StartServer_async_thread()
def StartServer_async_thread(self):
_LOGGER.debug("dScriptServer - %s:%s: StartServer_async_thread", self.IP, self.Port)
if self.__mode == 'sync':
return self.StartServer()
elif self.__mode == 'async':
return self.async_StartServer()
if not self.__server is None or not self.__mode is None:
raise Exception("Server already running")
return False
try:
self.__mode = 'thread'
self.__thread = Thread(target=self.__ServerThread_async, daemon=True)
self.__thread.start()
_LOGGER.debug("dScriptServer - %s:%s: StartServer_async_thread - completed", self.IP, self.Port)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: StartServer_async_thread failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
def StopServer(self):
_LOGGER.debug("dScriptServer - %s:%s: StopServer_async", self.IP, self.Port)
if self.__mode == 'async':
return self.async_StopServer()
elif self.__mode == 'thread':
return self.StopServer_async()
if self.__server is None:
raise Exception("Server already stopped")
self.State = False
try:
self.__server.shutdown(socket.SHUT_RDWR) # wakes up the thread blocked in accept()
except Exception:
pass
try:
self.__server.close()
except Exception as e:
_LOGGER.error("dScriptServer: StopServer: Exception on server socket close: %s (%s.%s)", str(e), e.__class__.__module__, type(e).__name__)
pass
self.State = False
self.__mode = None
self.__server = None
self.__thread = None
async def async_StopServer(self):
_LOGGER.debug("dScriptServer - %s:%s: async_StopServer", self.IP, self.Port)
if self.__mode == 'sync':
return self.StopServer()
elif self.__mode == 'thread':
return self.StopServer_async()
if self.__server is None:
raise Exception("Server already stopped")
try:
self.__server.close()
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: async_StopServer failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
pass
self.State = False
self.__mode = None
self.__server = None
def StopServer_async(self):
self.StopServer_async_thread()
def StopServer_async_thread(self):
_LOGGER.debug("dScriptServer - %s:%s: StopServer_async_thread", self.IP, self.Port)
if self.__mode == 'sync':
return self.StopServer()
elif self.__mode == 'async':
return self.async_StopServer()
if self.__server is None:
raise Exception("Server already stopped")
try:
self.__server.close()
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: StopServer_async_thread failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
pass
self.State = False
self.__mode = None
self.__server = None
self.__thread = None
def __ServerThread(self):
_LOGGER.debug("dScriptServer - %s:%s: ServerThread", self.IP, self.Port)
try:
self.__server = socket.socket() # Create a socket object
self.__server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: ServerThread failed on socket definition: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
return False
try:
self.__server.bind((self.IP, self.Port))
self.__server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
self.__server.listen(5) # Now wait for client connection.
self.State = True
_LOGGER.info("dScriptServer - %s:%s: ServerThread - serving on: (%s:%s)", self.IP, self.Port, self.IP, self.Port)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: ServerThread failed on socket bind: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
return False
try:
while self.State:
clientsocket, addr = self.__server.accept() # Establish connection with client.
_LOGGER.debug("dScriptServer - %s:%s: ServerThread: client connected: %s", self.IP, self.Port, addr)
clientsocket.settimeout(10) # never block a client thread forever
_thread.start_new_thread(self.__ClientConnected,(clientsocket,addr))
except Exception as e:
if self.State:
_LOGGER.error("dScriptServer - %s:%s: ServerThread failed on client connect: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
self.StopServer()
_LOGGER.debug("dScriptServer - %s:%s: ServerThread - stopped serving on: (%s:%s)", self.IP, self.Port, self.IP, self.Port)
def __ServerThread_async(self):
_LOGGER.debug("dScriptServer - %s:%s: ServerThread_async", self.IP, self.Port)
try:
asyncio.run(self.__async_RunServerThread())
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: ServerThread_async failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
async def __async_RunServerThread(self):
_LOGGER.debug("dScriptServer - %s:%s: async_RunServerThread", self.IP, self.Port)
try:
self.__server = await asyncio.start_server(self.__async_ClientConnected, self.IP, self.Port)
addr = self.__server.sockets[0].getsockname()
_LOGGER.info("dScriptServer - %s:%s: async_RunServerThread - serving on: %s", self.IP, self.Port, addr)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: async_RunServerThread failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
try:
await self.__server.start_serving()
self.State = self.__server.is_serving()
_LOGGER.debug("dScriptServer - %s:%s: async_RunServerThread - started serving (%s) on: %s", self.IP, self.Port, self.__server.is_serving(), addr)
while self.State:
self.State = self.__server.is_serving()
await asyncio.sleep(1) # do not spin - this is only a status watcher
_LOGGER.debug("dScriptServer - %s:%s: async_RunServerThread - stopped serving on: %s", self.IP, self.Port, addr)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: async_RunServerThread failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
self.StopServer_async()
def __ClientConnected(self,clientsocket,addr):
_LOGGER.debug("dScriptServer - %s:%s: ClientConnected: %s | %s", self.IP, self.Port, clientsocket, addr)
try:
data = clientsocket.recv(self.__socketsize) # firmware sends 3 bytes (cmd, id, state)
_LOGGER.debug("dScriptServer - %s:%s: ClientConnected: received data from: %s", self.IP, self.Port, addr)
_LOGGER.debug("dScriptServer - %s:%s: ClientConnected: closed connection: %s", self.IP, self.Port, addr)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: ClientConnected failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
return False
finally:
try: clientsocket.close()
except Exception: pass
self.__InterpreteData(data,addr[0])
async def __async_ClientConnected(self, reader, writer):
_LOGGER.debug("dScriptServer - %s:%s: async_ClientConnected: %s | %s", self.IP, self.Port, reader, writer)
try:
addr = writer.get_extra_info('peername')
data = await asyncio.wait_for(reader.read(self.__socketsize), timeout=10) # never wait forever for a (broken) client
_LOGGER.debug("dScriptServer - %s:%s: async_ClientConnected: received data from: %s", self.IP, self.Port, addr)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: async_ClientConnected failed: %s (%s.%s)", self.IP, self.Port, str(e), e.__class__.__module__, type(e).__name__)
return False
finally:
try:
writer.close()
await asyncio.wait_for(writer.wait_closed(), timeout=5)
except Exception:
pass
_LOGGER.debug("dScriptServer - %s:%s: async_ClientConnected: closed connection: %s", self.IP, self.Port, writer.get_extra_info('peername'))
self.__InterpreteData(data,addr[0])
def __InterpreteData(self,data,SenderIP):
_LOGGER.debug("dScriptServer - %s:%s: InterpreteData: %s | %s", self.IP, self.Port, data, SenderIP)
#TO-DO: identify protocol & select according action
#if self._Protocol == self._Protocols[4]: #BinaryAES
# data=self._AESDecrypt(data)
try:
databytes=self._ToDataBytes(data)
if len(databytes) == 0:
_LOGGER.debug("dScriptServer - %s:%s: InterpreteData: empty message from %s", self.IP, self.Port, SenderIP)
return False
self.__InterpreteBinary(databytes,SenderIP)
except Exception as e:
_LOGGER.error("dScriptServer - %s:%s: InterpreteData failed for %s from %s: %s (%s.%s)", self.IP, self.Port, data, SenderIP, str(e), e.__class__.__module__, type(e).__name__)
return False
def __InterpreteBinary(self,databytes,SenderIP):
_LOGGER.debug("dScriptServer - %s:%s: InterpreteBinary: %s | %s", self.IP, self.Port, databytes, SenderIP)
if not self._IsInList(databytes[0],self._DecimalCommands.keys()):
raise Exception("Unkown command: %s", databytes[0])
return False
cmd=self._DecimalCommands[databytes[0]].lower()
if cmd == 'stopserver':
_LOGGER.info("dScriptServer - %s:%s: %s requested to stop server", self.IP, self.Port, SenderIP)
self.StopServer()
elif cmd == 'heartbeat' or cmd == 'getstatus' or cmd == 'getconfig' or cmd == 'testonline': #all of these do not need an identifier
self._throwEvent(SenderIP, cmd)
else:
if len(databytes) >= 3:
if int(databytes[2]) < 0 or int(databytes[2]) == 255: # firmware sends -1 (=255 as unsigned byte) for 'no state'
self._throwEvent(SenderIP, cmd, int(databytes[1]))
elif cmd == 'getlight' or cmd == 'getsocket' or cmd == 'getmotion' or cmd == 'getrelay' or cmd == 'getinput':
if databytes[2] in self._OnOffStates:
self._throwEvent(SenderIP, cmd, int(databytes[1]), self._OnOffStates[databytes[2]])
else:
self._throwEvent(SenderIP, cmd, int(databytes[1]))
else:
self._throwEvent(SenderIP, cmd, int(databytes[1]), int(databytes[2]))
elif len(databytes) == 2:
self._throwEvent(SenderIP, cmd, int(databytes[1]))
else:
_LOGGER.debug("dScriptServer - %s:%s: InterpreteBinary: missing identifier for %s from %s", self.IP, self.Port, cmd, SenderIP)
#return True