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
|
# Copyright (c) 2016 Weitian LI <liweitianux@live.com>
# MIT license
"""
Handle the configurations operations with the client.
"""
import os
import logging
from ...errors import ConfigError
logger = logging.getLogger(__name__)
class ConfigsHandler:
"""
Handle the "configs" type of messages from the client.
"""
def __init__(self, configs):
self.configs = configs
def handle_message(self, msg):
"""
Handle the message of type "configs", which request to get or
set some configurations by the client.
TODO:
* improve the description ...
* split these handling functions into a separate class in a module
Parameters
----------
msg : dict
A dictionary parsed from the incoming JSON message, which
generally has the following syntax:
``{"type": "configs", "action": <action>, "data": <data>}``
where the ``<action>`` is ``set`` or ``get``, and the ``<data>``
is a list of config keys or a dict of config key-value pairs.
Returns
-------
response : dict
A dictionary parsed from the incoming JSON message, which
generally has the following syntax:
``{"type": "configs", "action": <action>,
"data": <data>, "errors": <errors>}``
where the ``<action>`` is the same as input, the ``<data>`` is
a list of config keys or a dict of config key-value pairs, and
``<errors>`` contains the error message for the invalid config
values.
"""
try:
msg_type = msg["type"]
msg_action = msg["action"]
response = {"type": msg_type, "action": msg_action}
logger.info("WebSocket: handle message: " +
"type: {0}, action: {1}".format(msg_type, msg_action))
if msg_action == "get":
# Get the values of the specified options
try:
data, errors = self._get_configs(keys=msg["keys"])
response["success"] = True
response["data"] = data
response["errors"] = errors
except KeyError:
response["success"] = False
response["error"] = "'keys' is missing"
elif msg_action == "set":
# Set the values of the specified options
try:
errors = self._set_configs(data=msg["data"])
response["success"] = True
response["data"] = {} # be more consistent
response["errors"] = errors
except KeyError:
response["success"] = False
response["error"] = "'data' is missing"
elif msg_action == "reset":
# Reset the configurations to the defaults
self._reset_configs()
response["success"] = True
elif msg_action == "load":
# Load the supplied user configuration file
try:
success, error = self._load_configs(msg["userconfig"])
response["success"] = success
if not success:
response["error"] = error
except KeyError:
response["success"] = False
response["error"] = "'userconfig' is missing"
elif msg_action == "save":
# Save current configurations to file
try:
success, error = self._save_configs(msg["outfile"],
msg["clobber"])
response["success"] = success
if not success:
response["error"] = error
except KeyError:
response["success"] = False
response["error"] = "'outfile' or 'clobber' is missing"
else:
logger.warning("WebSocket: " +
"unknown action: {0}".format(msg_action))
response["success"] = False
response["error"] = "unknown action: {0}".format(msg_action)
except KeyError:
# Received message has wrong syntax/format
response = {"success": False,
"type": msg_type,
"error": "no action specified"}
#
logger.debug("WebSocket: response: {0}".format(response))
return response
def _get_configs(self, keys=None):
"""Get the values of the config options specified by the given keys.
Parameters
----------
keys : list[str], optional
A list of keys specifying the config options whose values will
be obtained.
If ``keys=None``, then all the configurations values are dumped.
Returns
-------
data : dict
A dictionary with keys the same as the input keys, and values
the corresponding config option values.
errors : dict
When error occurs (e.g., invalid key), then the specific errors
with details are stored in this dictionary.
NOTE
----
Do not forget the ``userconfig`` option.
"""
if keys is None:
# Dump all the configurations
data = self.configs.dump(flatten=True)
data["userconfig"] = self.configs.userconfig
errors = {}
else:
data = {}
errors = {}
for key in keys:
if key == "userconfig":
data["userconfig"] = self.configs.userconfig
else:
try:
data[key] = self.configs.getn(key)
except KeyError as e:
errors[key] = str(e)
#
return (data, errors)
def _set_configs(self, data):
"""Set the values of the config options specified by the given keys
to the corresponding supplied data.
NOTE
----
The ``userconfig`` needs special handle.
The ``workdir`` and ``configfile`` options should be ignored.
Parameters
----------
data : dict
A dictionary of key-value pairs, with keys specifying the config
options whose value will be changed, and values the new values
to which config options will be set.
NOTE:
If want to set the ``userconfig`` option, an *absolute path*
must be provided.
Returns
-------
errors : dict
When error occurs (e.g., invalid key, invalid values), then the
specific errors with details are stored in this dictionary.
"""
errors = {}
for key, value in data.items():
if key in ["workdir", "configfile"]:
# Ignore "workdir" and "configfile"
continue
elif key == "userconfig":
if os.path.isabs(os.path.expanduser(value)):
self.configs.userconfig = value
else:
errors[key] = "Not an absolute path"
else:
try:
self.configs.setn(key, value)
except KeyError as e:
errors[key] = str(e)
# NOTE:
# Check the whole configurations after all provided options are
# updated, and merge the validation errors.
__, cherr = self.configs.check_all(raise_exception=False)
errors.update(cherr)
return errors
def _reset_configs(self):
"""Reset the configurations to the defaults."""
self.configs.reset()
def _load_configs(self, userconfig):
"""Load configurations from the provided user configuration file.
Parameters
----------
userconfig: str
The filepath to the user configuration file, which must be
an *absolute path*.
Returns
-------
success : bool
``True`` if the operation succeeded, otherwise, ``False``.
error : str
If failed, this ``error`` saves the details, otherwise, ``None``.
"""
success = False
error = None
if os.path.isabs(os.path.expanduser(userconfig)):
try:
self.configs.read_userconfig(userconfig)
success = True
except ConfigError as e:
error = str(e)
else:
error = "Not an absolute path"
return (success, error)
def _save_configs(self, outfile, clobber=False):
"""Save current configurations to file.
Parameters
----------
outfile: str
The filepath to the output configuration file, which must be
an *absolute path*.
clobber : bool, optional
Whether overwrite the output file if already exists?
Returns
-------
success : bool
``True`` if the operation succeeded, otherwise, ``False``.
error : str
If failed, this ``error`` saves the details, otherwise, ``None``.
"""
success = False
error = None
try:
self.configs.save(outfile, clobber=clobber)
success = True
except (ValueError, OSError) as e:
error = str(e)
return (success, error)
|
