aboutsummaryrefslogtreecommitdiffstats
path: root/fg21sim/webui/handlers/configs.py
blob: 296bd11ef3f754cbf81c3b995007d305bb2fb133 (plain)
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
# Copyright (c) 2016 Weitian LI <liweitianux@live.com>
# MIT license

"""
Handle the configurations operations with the client.
"""

import os
import logging

import tornado.web
from tornado.escape import json_decode, json_encode

from .base import BaseRequestHandler
from ...errors import ConfigError


logger = logging.getLogger(__name__)


class ConfigsAJAXHandler(BaseRequestHandler):
    """
    Handle the AJAX requests from the client to manipulate the configurations.
    """
    def initialize(self):
        """Hook for subclass initialization.  Called for each request."""
        self.configs = self.application.configmanager

    def get(self):
        """
        Handle the READ-ONLY configuration manipulations.

        Supported actions:
        - get: Get the specified/all configuration values
        - validate: Validate the configurations and response the errors
        - exists: Whether the file already exists

        NOTE
        ----
        READ-WRITE configuration manipulations should be handled by
        the ``self.post()`` method.
        """
        action = self.get_argument("action", "get")
        data = {}
        errors = {}
        if action == "get":
            keys = json_decode(self.get_argument("keys", "null"))
            data, errors = self._get_configs(keys=keys)
            success = True
        elif action == "validate":
            __, errors = self.configs.check_all(raise_exception=False)
            success = True
        elif action == "exists":
            filepath = json_decode(self.get_argument("filepath", "null"))
            exists, error = self._exists_file(filepath)
            if exists is None:
                success = False
                reason = error
            else:
                success = True
                data["exists"] = exists
        else:
            # ERROR: bad action
            success = False
            reason = "Bad request action: {0}".format(action)
        #
        if success:
            response = {"action": action,
                        "data": data,
                        "errors": errors}
            logger.debug("Response: {0}".format(response))
            self.set_header("Content-Type", "application/json; charset=UTF-8")
            self.write(json_encode(response))
        else:
            logger.warning("Request failed: {0}".format(reason))
            self.send_error(400, reason=reason)

    @tornado.web.authenticated
    def post(self):
        """
        Handle the READ-WRITE configuration manipulations.

        Supported actions:
        - set: Set the specified configuration(s) to the posted value(s)
        - reset: Reset the configurations to its backup defaults
        - load: Load the supplied user configuration file
        - save: Save current configurations to file

        NOTE
        ----
        READ-ONLY configuration manipulations should be handled by
        the ``self.get()`` method.
        """
        request = json_decode(self.request.body)
        logger.debug("Received request: {0}".format(request))
        action = request.get("action")
        data = {}
        errors = {}
        if action == "set":
            # Set the values of the specified options
            try:
                errors = self._set_configs(data=request["data"])
                success = True
            except KeyError:
                success = False
                reason = "'data' is missing"
        elif action == "reset":
            # Reset the configurations to the defaults
            success = self._reset_configs()
        elif action == "load":
            # Load the supplied user configuration file
            try:
                success, reason = self._load_configs(request["userconfig"])
            except KeyError:
                success = False
                reason = "'userconfig' is missing"
        elif action == "save":
            # Save current configurations to file
            try:
                success, reason = self._save_configs(request["outfile"],
                                                     request["clobber"])
            except KeyError:
                success = False
                reason = "'outfile' or 'clobber' is missing"
        else:
            # ERROR: bad action
            success = False
            reason = "Bad request action: {0}".format(action)
        #
        if success:
            response = {"action": action,
                        "data": data,
                        "errors": errors}
            logger.debug("Response: {0}".format(response))
            self.set_header("Content-Type", "application/json; charset=UTF-8")
            self.write(json_encode(response))
        else:
            logger.warning("Request failed: {0}".format(reason))
            self.send_error(400, reason=reason)

    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.
        """
        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, ConfigError) as e:
                    errors[key] = str(e)
        #
        return errors

    def _reset_configs(self):
        """Reset the configurations to the defaults."""
        self.configs.reset()
        return True

    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)

    @staticmethod
    def _exists_file(filepath):
        """Check whether the given filepath already exists?

        Parameters
        ----------
        filepath: str
            The input filepath to check its existence, must be
            an *absolute path*.

        Returns
        -------
        exists : bool
            ``True`` if the filepath already exists, ``False`` if not exists,
            and ``None`` if error occurs.
        error : str
            The error information, and ``None`` if no errors.
        """
        exists = None
        error = None
        try:
            filepath = os.path.expanduser(filepath)
            if os.path.isabs(filepath):
                exists = os.path.exists(filepath)
            else:
                error = "Not an absolute path: {0}".format(filepath)
        except AttributeError:
            error = "Invalid input filepath: {0}".format(filepath)
        return (exists, error)