File: resource.py

package info (click to toggle)
aiocoap 0.4.14-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,756 kB
  • sloc: python: 16,846; makefile: 23; sh: 9
file content (331 lines) | stat: -rw-r--r-- 12,768 bytes parent folder | download | duplicates (2)
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# SPDX-FileCopyrightText: Christian Amsüss and the aiocoap contributors
#
# SPDX-License-Identifier: MIT

from collections import namedtuple, defaultdict
import functools
import inspect
import abc

import json
import cbor2 as cbor

from aiocoap import resource, numbers, interfaces
from aiocoap import GET, PUT, POST, Message, CONTENT, CHANGED
from aiocoap.error import BadRequest, UnsupportedContentFormat, UnallowedMethod


_ContenttypeRenderedHandler = namedtuple(
    "_ContenttypeRenderedHandler",
    ("method", "accept", "contentformat", "implementation", "responseformat"),
)

# this could become an alternative to the resource.Resource currently implemented in aiocoap.resource


class ContenttypeRendered(
    resource._ExposesWellknownAttributes, interfaces.Resource, metaclass=abc.ABCMeta
):
    def __init_subclass__(cls):
        # __new__ code moved in here to use __ properties
        cls.__handlers = defaultdict(lambda: {})
        for member in vars(cls).values():
            if isinstance(member, _ContenttypeRenderedHandler):
                for accept in member.accept:
                    for contentformat in member.contentformat:
                        cls.__handlers[member.method][(accept, contentformat)] = (
                            member.implementation,
                            member.responseformat,
                        )

    @staticmethod
    def get_handler(accept, *, default=False):
        """Decorate a method with this to make it the GET handler for a given
        method and Accept value (or additionally the empty one if default=True).

        FIXME move to ContenttypeRendered

        Methods that accept a payload will get the payload passed as an
        argument, and be decided based on the Content-Format header (with the
        Accept header being ignored; possibly, that's a reasons to split this
        decorator up per-method).

        The method will not be usable by its name any more. It is recommended
        to use a double-underscore name for thusly decorated methods (eg.
        __get_plain).

        The method has some freedom in the types it may return (None is treated
        as an empty payload, strings are encoded in UTF-8). It is unclear yet
        whether more complex conversions (eg. JSON, CBOR) will be supported by
        this or need additonal decorators."""

        def wrapper(func):
            cf = numbers.media_types_rev[accept]
            return _ContenttypeRenderedHandler(
                GET, (cf, None) if default else (cf,), (None,), func, cf
            )

        return wrapper

    @staticmethod
    def put_handler(contentformat, *, default=False):
        def wrapper(func):
            if isinstance(contentformat, str):
                cf = numbers.media_types_rev[contentformat]
            else:
                cf = contentformat
            return _ContenttypeRenderedHandler(
                PUT, (None,), (cf, None) if default else (cf,), func, None
            )

        return wrapper

    @staticmethod
    def empty_post_handler():
        # i suppose this'll be replaced with something more generic when i add something that needs request or response payloads
        def wrapper(func):
            return _ContenttypeRenderedHandler(POST, (None,), (None,), func, None)

        return wrapper

    async def needs_blockwise_assembly(self, request):
        return True

    async def render(self, request):
        cf = request.opt.content_format
        acc = request.opt.accept
        raise_class = UnallowedMethod
        method_would_have_worked = False

        # FIXME: manually walking the MRO is not a nice way to go about this;
        # is there no other way to query the registered handlers according to
        # the regular inheritance patterns?
        for cls in type(self).mro():
            if not issubclass(cls, ContenttypeRendered) or cls is ContenttypeRendered:
                continue
            for_method = cls.__handlers.get(request.code, None)
            if for_method is None:
                continue
            raise_class = UnsupportedContentFormat
            handler, responseformat = for_method.get((acc, cf), (None, None))
            if handler is not None:
                break
        else:
            raise raise_class()

        sig = inspect.signature(handler)
        parameters = set(sig.parameters.keys())
        parameters.remove("self")
        kwargs = {}
        if request.payload and "payload" not in parameters:
            raise BadRequest("Unexpected payload")
        if request.opt.uri_query and "query" not in parameters:
            raise BadRequest("Unexepcted query arguments")

        for p in parameters:
            if p == "payload":
                kwargs["payload"] = request.payload
            elif p == "request_uri":
                # BIG FIXME: This does not give the expected results due to the
                # URI path stripping in Site, and because Message gets the
                # requested authority wrong on the server side.
                kwargs["request_uri"] = request.get_request_uri()
            else:
                raise RuntimeError("Unexpected argument requested: %s" % p)
        payload = handler(self, **kwargs)

        if payload is None:
            payload = b""
        elif isinstance(payload, str):
            payload = payload.encode("utf8")

        return Message(
            code={GET: CONTENT, PUT: CHANGED}[request.code],
            payload=payload,
            content_format=responseformat,
            no_response=request.opt.no_response,
        )


class ObservableContenttypeRendered(ContenttypeRendered, interfaces.ObservableResource):
    def __init__(self):
        super().__init__()

        self._callbacks = set()

    async def add_observation(self, request, serverobservation):
        """Implementation of interfaces.ObservableResource"""
        callback = serverobservation.trigger
        self._callbacks.add(callback)
        remover = functools.partial(self._callbacks.remove, callback)
        serverobservation.accept(remover)

    def add_valuechange_callback(self, cb):
        """Call this when you want a callback outside of aiocoap called
        whenever value_change is called, typically because the callback
        recipient would extract the state of the resource in a non-CoAP way."""
        self._callbacks.add(cb)

    def value_changed(self):
        """Call this whenever the object was modified in such a way that any
        rendition might change."""
        for c in self._callbacks:
            c()


class SenmlResource(ObservableContenttypeRendered):
    """A resource that has its state in .value; this class implements SenML
    getters and setters as well as plain text.

    Implementors need to provide a .value instance property as well as
    .jsonsenml_key / .cborsenml_key class properties for picking the right
    value key in the respective SenML serialization, and a .valuetype type that
    is used both for converting any text/plain'ly PUT string as well as for
    filtering (typically copy-constructing) data from SenML."""

    @ContenttypeRendered.get_handler("application/senml+json")
    def __jsonsenml_get(self, request_uri):
        return json.dumps([{"n": request_uri, self.jsonsenml_key: self.value}])

    @ContenttypeRendered.get_handler("application/senml+cbor")
    def __cborsenml_get(self, request_uri):
        return cbor.dumps([{0: request_uri, self.cborsenml_key: self.value}])

    @ContenttypeRendered.get_handler("text/plain;charset=utf-8", default=True)
    def __textplain_get(self):
        return str(self.value)

    @ContenttypeRendered.put_handler("application/senml+json")
    def __jsonsenml_set(self, payload, request_uri):
        try:
            new = json.loads(payload.decode("utf8"))
            if (
                len(new) != 1
                or new[0].get("bn", "") + new[0].get("n", "") != request_uri
            ):
                raise BadRequest("Not a single record pertaining to this resource")
            self.value = self.valuetype(new[0][self.jsonsenml_key])
        except (KeyError, ValueError):
            raise BadRequest()

    @ContenttypeRendered.put_handler("application/senml+cbor")
    def __cborsenml_set(self, payload, request_uri):
        try:
            new = cbor.loads(payload)
            if len(new) != 1 or new[0].get(-2, "") + new[0].get(0, "") != request_uri:
                raise BadRequest("Not a single record pertaining to this resource")
            self.value = self.valuetype(new[self.cborsenml_key])
        except (KeyError, ValueError):
            raise BadRequest()

    @ContenttypeRendered.put_handler("text/plain;charset=utf-8", default=True)
    def __textplain_set(self, payload):
        try:
            self.value = self.valuetype(payload.decode("utf8").strip())
        except ValueError:
            raise BadRequest()


class BooleanResource(SenmlResource):
    jsonsenml_key = "vb"
    cborsenml_key = 4
    valuetype = bool

    @ContenttypeRendered.get_handler("text/plain;charset=utf-8", default=True)
    def __textplain_get(self):
        return "01"[self.value]

    @ContenttypeRendered.put_handler("text/plain;charset=utf-8", default=True)
    def __textplain_set(self, payload):
        try:
            self.value = {"0": False, "1": True}[payload.decode("utf8").strip()]
        except (KeyError, ValueError):
            raise BadRequest()


class FloatResource(SenmlResource):
    jsonsenml_key = "v"
    cborsenml_key = 2
    valuetype = float


class StringResource(SenmlResource):
    jsonsenml_key = "vs"
    cborsenml_key = 3
    valuetype = str


class SubsiteBatch(ObservableContenttypeRendered):
    """An implementation of a CoRE interfaces batch that is the root resource
    of a subsite

    This currently depends on being added to the site after all other
    resources; it could enumerate them later, but it installs its own
    value_changed callbacks of other members at initialization time."""

    if_ = "core.b"

    def __init__(self, site):
        self.site = site
        super().__init__()

        # FIXME this ties in directly into resource.Site's privates, AND it
        # should actually react to changes in the site, AND overriding the
        # callback to install an own hook is not compatible with any other
        # ObservableResource implementations
        for subres in self.site._resources.values():
            if isinstance(subres, ObservableContenttypeRendered):
                subres.add_valuechange_callback(self.value_changed)
        for subsite in self.site._subsites.values():
            if not isinstance(subsite, resource.Site):
                continue  # can't access privates
            if () not in subsite._resources:
                continue  # no root, better not try
            rootres = subsite._resources[()]
            if not isinstance(rootres, SubsiteBatch):
                continue
            rootres.add_valuechange_callback(self.value_changed)

    def __get_records(self, request_uri):
        records = []
        # FIXME this ties in directly into resource.Site's privates
        for path, subres in self.site._resources.items():
            if isinstance(
                subres, SenmlResource
            ):  # this conveniently filters out self as well
                records.append(
                    {"n": "/".join(path), subres.jsonsenml_key: subres.value}
                )
        print(self.site, vars(self.site))
        for path, subsite in self.site._subsites.items():
            if not isinstance(subsite, resource.Site):
                continue  # can't access privates
            if () not in subsite._resources:
                continue  # no root, better not try
            rootres = subsite._resources[()]
            if not isinstance(rootres, SubsiteBatch):
                continue
            for r in rootres.__get_records(request_uri):
                r = dict(**r)
                r.pop("bn", None)
                r["n"] = "/".join(path) + "/" + r["n"]
                records.append(r)
        records[0]["bn"] = request_uri
        return records

    @ContenttypeRendered.get_handler("application/senml+json", default=True)
    def __regular_get(self, request_uri):
        return json.dumps(self.__get_records(request_uri))


class PythonBacked(SenmlResource):
    """Provides a .value stored in regular Python, but pulls the
    .value_changed() trigger on every change"""

    def _set_value(self, value):
        changed = not hasattr(self, "_value") or self._value != value
        self._value = value
        if changed:
            self.value_changed()

    value = property(lambda self: self._value, _set_value)