-
Notifications
You must be signed in to change notification settings - Fork 0
/
_nodered.py
275 lines (226 loc) · 10 KB
/
_nodered.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
# -*- coding: utf-8 -*-
import os, sys, subprocess, shutil, json, traceback
from types import MethodType
from typing import Type, List
from glob import glob
from .templates import package_json, node_html, node_js
from ._property import Property
from . import __path__
class RED:
"""
Node-RED manager class
"""
registered_nodes:List["Node"] = []
def __init__(self, user_dir:str, node_red_dir:str = None, admin_root:str = "/node-red-py", port:int = 1880, show_default_category:bool = True, editor_theme:dict = {}):
"""
Set configs of Node-RED and setup
Parameters
----------
user_dir: str, required
userDir of Node-RED settings
node_red_dir: str, default None
directory for Node-RED starter
admin_root: str, default "node-red-py"
httpAdminRoot of Node-RED settings
port: int, default 1880
port of Node-RED server
show_default_category: bool, default True
show default categories of Node-RED or not
editor_theme: dict, default {}
editorTheme of Node-RED server (for detail information, see https://github.com/node-red/node-red/wiki/Design:-Editor-Themes)
"""
self.user_dir, self.admin_root, self.port, self.show_default_category, self.editor_theme =\
user_dir, admin_root, port, show_default_category, self.__default_editor_theme(editor_theme)
# set node_red_dir
if node_red_dir is None:
self.node_red_dir = os.path.join(__path__[0], "node-red-starter")
else:
self.node_red_dir = node_red_dir = os.path.realpath(node_red_dir)
if os.path.exists(node_red_dir):
if not { "index.js", "package.json" }.issubset(set(os.listdir(node_red_dir))):
raise RuntimeError("Target `node_red_dir` is not Node-RED dir format!")
else:
os.mkdir(node_red_dir)
shutil.copyfile(os.path.join(__path__[0], "node-red-starter", "index.js"), os.path.join(node_red_dir, "index.js"))
shutil.copyfile(os.path.join(__path__[0], "node-red-starter", "package.json"), os.path.join(node_red_dir, "package.json"))
# setup Node-RED starter
subprocess.call(
[ "npm", "install" ],
stdout = subprocess.DEVNULL,
cwd = self.node_red_dir
)
# create default editor_theme
def __default_editor_theme(self, editor_theme:dict):
page_theme = editor_theme.pop("page", {})
page_theme.update({
"title": page_theme.pop("title", "Node-RED.py"),
"favicon": page_theme.pop("favicon", os.path.join(__path__[0], "assets", "python-logo.png"))
})
header_theme = editor_theme.pop("header", {})
header_theme.update({
"title": "Node-RED.py",
"image": None
})
project_feature = editor_theme.pop("projects", {})
project_feature.update({
"enabled": project_feature.pop("enabled", False)
})
editor_theme.update({
"page": page_theme,
"header": header_theme,
"userMenu": editor_theme.pop("userMenu", False),
"projects": project_feature
})
return editor_theme
def register(self, node_func:MethodType, name:str, category:str = "nodered_py", properties:List[Property] = []):
"""
Function to register Node function
Parameters
----------
node_func: MethodType, required
Node function to register
name: str, required
name of Node to register
category: str, default nodered_py
category of Node
properties: List[noderedpy._property.Property]
propertis of Node
"""
node = Node(name if name.startswith("nodered-py") else f"nodered-py-{name}", category, properties, node_func)
RED.registered_nodes.append(node)
# check input and run node
def __check_input_from_node(self):
input_file, output_file = os.path.join(self.__cache_dir, "input.json"), os.path.join(self.__cache_dir, "output.json")
while True:
if os.path.exists(input_file):
# read input file
while True:
# if cannot read file or read during file writing, read file until can read
try:
with open(input_file, "r", encoding = "utf-8") as ifr:
input_data = json.load(ifr)
os.remove(input_file)
break
except json.JSONDecodeError:
pass
node = list(filter(lambda n: n.name == input_data["name"], RED.registered_nodes))[0]
with open(output_file, "w", encoding = "utf-8") as ofw:
json.dump(node.run(input_data["props"], input_data["msg"]), ofw, indent = 4)
def start(self, debug:bool = True, callback:MethodType = None):
"""
Start Node-RED server
Parameters
----------
debug: bool, default True
show outputs on console or not
callback: MethodType, default None
callback when Node-RED server started
"""
# setup user_dir
self.__start_for_ready()
# set started flag file
self.__started_file = os.path.join(self.node_red_dir, "started")
# kill if process listen on port
self.stop()
# set cache_dir
self.__cache_dir = os.path.join(self.user_dir, ".cache")
if os.path.exists(self.__cache_dir):
shutil.rmtree(self.__cache_dir)
os.mkdir(self.__cache_dir)
# save editor_theme
with open(os.path.join(self.node_red_dir, "editorTheme.json"), "w", encoding = "utf-8") as tjw:
json.dump(self.editor_theme, tjw)
# remove existing nodes
for node_dir in glob(os.path.join(self.user_dir, "node_modules", "nodered-py-*")):
shutil.rmtree(node_dir)
# create custom nodes
for node in RED.registered_nodes:
node.create(self.user_dir, self.__cache_dir)
# run Node-RED server
subprocess.Popen([
"node",
"index.js",
f"--user-dir={self.user_dir}",
f"--admin-root={self.admin_root}",
f"--port={self.port}",
f"--show-default-category={'true' if self.show_default_category else 'false'}"
f"--user-category={','.join(list(set([ node.category for node in RED.registered_nodes ])))}"
], shell = False, stdout = sys.stdout if debug else subprocess.DEVNULL, cwd = self.node_red_dir)
while True:
if os.path.exists(self.__started_file):
if callback:
callback()
break
try:
self.__check_input_from_node()
except KeyboardInterrupt:
self.stop()
def __start_for_ready(self):
"""
Start Node-RED for setup default userDir
"""
import time
self.__started_file = os.path.join(self.node_red_dir, "started")
if os.path.exists(self.__started_file):
os.remove(self.__started_file)
subprocess.Popen([
"node",
"index.js",
f"--user-dir={self.user_dir}",
f"--admin-root={self.admin_root}",
f"--port={self.port}",
f"--show-default-category={'true' if self.show_default_category else 'false'}"
f"--user-category={','.join(list(set([ node.category for node in RED.registered_nodes ])))}"
], shell = False, stdout = subprocess.DEVNULL, cwd = self.node_red_dir)
while True:
if os.path.exists(self.__started_file):
self.stop()
break
time.sleep(1)
def stop(self):
"""
Stop Node-RED server
"""
import psutil, signal
if os.path.exists(self.__started_file):
os.remove(self.__started_file)
killed = False
for process in psutil.process_iter():
try:
for conns in process.connections(kind = "inet"):
if conns.laddr.port == self.port:
process.send_signal(signal.SIGTERM)
killed = True
break
except ( psutil.AccessDenied, psutil.ZombieProcess ):
pass
if killed:
break
class Node:
def __init__(self, name:str, category:str, properties:List[Property], node_func:MethodType):
if " " in name.strip():
raise NameError("Node name cannot contain spaces!")
if "-" in category.strip() or "," in category.strip():
raise NameError("Category cannot contain '-' or ','!")
self.name, self.category, self.properties =\
name, category, properties
self.__node_func = node_func
def create(self, node_red_user_dir:str, node_red_user_cache_dir:str):
node_dir = os.path.join(node_red_user_dir, "node_modules", self.name)
os.makedirs(os.path.join(node_dir, "lib"))
with open(os.path.join(node_dir, "package.json"), "w", encoding = "utf-8") as pjw:
pjw.write(package_json(self))
with open(os.path.join(node_dir, "lib", f"{self.name}.html"), "w", encoding = "utf-8") as nhw:
nhw.write(node_html(self))
with open(os.path.join(node_dir, "lib", f"{self.name}.js"), "w", encoding = "utf-8") as njw:
njw.write(node_js(self, node_red_user_cache_dir))
def run(self, props:dict, msg:dict) -> dict:
print(f"\n{self.name} started\n===================================")
try:
resp = self.__node_func(props, msg)
print("============================= ended\n")
resp.update({ "state": "success" })
return resp
except:
print("============================= error\n")
return { "state": "fail", "message": traceback.format_exc() }