2 * Copyright (C) 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
19 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
26 #include <json-c/json.h>
27 #include <afb/afb-binding-v1.h>
28 #include <afb/afb-binding-v2.h>
30 #include "afb-context.h"
33 #include "afb-msg-json.h"
34 #include "afb-subcall.h"
37 #include "afb-apiset.h"
42 /******************************************************************************/
44 static void vinfo(void *first, void *second, const char *fmt, va_list args, void (*fun)(void*,void*,const char*))
47 if (fmt == NULL || vasprintf(&info, fmt, args) < 0)
49 fun(first, second, info);
53 /******************************************************************************/
55 static struct json_object *xreq_json_cb(void *closure)
57 struct afb_xreq *xreq = closure;
58 if (!xreq->json && xreq->queryitf->json)
59 xreq->json = xreq->queryitf->json(xreq);
63 static struct afb_arg xreq_get_cb(void *closure, const char *name)
65 struct afb_xreq *xreq = closure;
66 if (xreq->queryitf->get)
67 return xreq->queryitf->get(xreq, name);
69 return afb_msg_json_get_arg(xreq_json_cb(closure), name);
72 static void xreq_success_cb(void *closure, struct json_object *obj, const char *info)
74 struct afb_xreq *xreq = closure;
77 ERROR("reply called more than one time!!");
81 if (xreq->queryitf->success)
82 xreq->queryitf->success(xreq, obj, info);
84 xreq->queryitf->reply(xreq, 0, afb_msg_json_reply_ok(info, obj, &xreq->context, NULL));
88 static void xreq_fail_cb(void *closure, const char *status, const char *info)
90 struct afb_xreq *xreq = closure;
93 ERROR("reply called more than one time!!");
96 if (xreq->queryitf->fail)
97 xreq->queryitf->fail(xreq, status, info);
99 xreq->queryitf->reply(xreq, 1, afb_msg_json_reply_error(status, info, &xreq->context, NULL));
103 static void xreq_vsuccess_cb(void *closure, struct json_object *obj, const char *fmt, va_list args)
105 vinfo(closure, obj, fmt, args, (void*)xreq_success_cb);
108 static void xreq_vfail_cb(void *closure, const char *status, const char *fmt, va_list args)
110 vinfo(closure, (void*)status, fmt, args, (void*)xreq_fail_cb);
113 static void *xreq_context_get_cb(void *closure)
115 struct afb_xreq *xreq = closure;
116 return afb_context_get(&xreq->context);
119 static void xreq_context_set_cb(void *closure, void *value, void (*free_value)(void*))
121 struct afb_xreq *xreq = closure;
122 afb_context_set(&xreq->context, value, free_value);
125 static void xreq_addref_cb(void *closure)
127 struct afb_xreq *xreq = closure;
128 __atomic_add_fetch(&xreq->refcount, 1, __ATOMIC_RELAXED);
131 static void xreq_unref_cb(void *closure)
133 struct afb_xreq *xreq = closure;
134 if (!__atomic_sub_fetch(&xreq->refcount, 1, __ATOMIC_RELAXED)) {
135 xreq->queryitf->unref(xreq);
139 static void xreq_session_close_cb(void *closure)
141 struct afb_xreq *xreq = closure;
142 afb_context_close(&xreq->context);
145 static int xreq_session_set_LOA_cb(void *closure, unsigned level)
147 struct afb_xreq *xreq = closure;
148 return afb_context_change_loa(&xreq->context, level);
151 static int xreq_subscribe_cb(void *closure, struct afb_event event)
153 struct afb_xreq *xreq = closure;
154 return afb_xreq_subscribe(xreq, event);
157 int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_event event)
160 return afb_evt_add_watch(xreq->listener, event);
161 if (xreq->queryitf->subscribe)
162 return xreq->queryitf->subscribe(xreq, event);
163 ERROR("no event listener, subscription impossible");
168 static int xreq_unsubscribe_cb(void *closure, struct afb_event event)
170 struct afb_xreq *xreq = closure;
171 return afb_xreq_unsubscribe(xreq, event);
174 int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_event event)
177 return afb_evt_remove_watch(xreq->listener, event);
178 if (xreq->queryitf->unsubscribe)
179 return xreq->queryitf->unsubscribe(xreq, event);
180 ERROR("no event listener, unsubscription impossible");
185 static void xreq_subcall_cb(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure)
187 struct afb_xreq *xreq = closure;
189 if (xreq->queryitf->subcall) {
190 xreq->queryitf->subcall(xreq, api, verb, args, callback, cb_closure);
191 json_object_put(args);
193 afb_subcall(xreq, api, verb, args, callback, cb_closure);
199 struct afb_xreq *caller;
202 struct json_object *args;
203 struct jobloop *jobloop;
204 struct json_object *result;
208 static void xreq_sync_leave(struct xreq_sync *sync)
210 struct jobloop *jobloop = sync->jobloop;
212 sync->jobloop = NULL;
217 static void xreq_sync_reply(void *closure, int iserror, struct json_object *obj)
219 struct xreq_sync *sync = closure;
221 sync->iserror = iserror;
222 sync->result = json_object_get(obj);
223 xreq_sync_leave(sync);
226 static void xreq_sync_enter(int signum, void *closure, struct jobloop *jobloop)
228 struct xreq_sync *sync = closure;
231 sync->jobloop = jobloop;
232 xreq_subcall_cb(sync->caller, sync->api, sync->verb, json_object_get(sync->args), xreq_sync_reply, sync);
235 xreq_sync_leave(sync);
239 static int xreq_subcallsync_cb(void *closure, const char *api, const char *verb, struct json_object *args, struct json_object **result)
242 struct xreq_sync sync;
243 struct afb_xreq *xreq = closure;
253 rc = jobs_enter(NULL, 0, xreq_sync_enter, &sync);
254 json_object_put(args);
255 if (rc < 0 || sync.iserror) {
256 *result = sync.result ? : afb_msg_json_internal_error();
259 *result = sync.result;
263 static void xreq_vverbose_cb(void*closure, int level, const char *file, int line, const char *func, const char *fmt, va_list args)
265 /* TODO: improves the implementation. example: on condition make a list of log messages that will be returned */
266 vverbose(level, file, line, func, fmt, args);
269 /******************************************************************************/
271 static struct json_object *xreq_hooked_json_cb(void *closure)
273 struct json_object *r = xreq_json_cb(closure);
274 struct afb_xreq *xreq = closure;
275 return afb_hook_xreq_json(xreq, r);
278 static struct afb_arg xreq_hooked_get_cb(void *closure, const char *name)
280 struct afb_arg r = xreq_get_cb(closure, name);
281 struct afb_xreq *xreq = closure;
282 return afb_hook_xreq_get(xreq, name, r);
285 static void xreq_hooked_success_cb(void *closure, struct json_object *obj, const char *info)
287 struct afb_xreq *xreq = closure;
288 afb_hook_xreq_success(xreq, obj, info);
289 xreq_success_cb(closure, obj, info);
292 static void xreq_hooked_fail_cb(void *closure, const char *status, const char *info)
294 struct afb_xreq *xreq = closure;
295 afb_hook_xreq_fail(xreq, status, info);
296 xreq_fail_cb(closure, status, info);
299 static void xreq_hooked_vsuccess_cb(void *closure, struct json_object *obj, const char *fmt, va_list args)
301 vinfo(closure, obj, fmt, args, (void*)xreq_hooked_success_cb);
304 static void xreq_hooked_vfail_cb(void *closure, const char *status, const char *fmt, va_list args)
306 vinfo(closure, (void*)status, fmt, args, (void*)xreq_hooked_fail_cb);
309 static void *xreq_hooked_context_get_cb(void *closure)
311 void *r = xreq_context_get_cb(closure);
312 struct afb_xreq *xreq = closure;
313 return afb_hook_xreq_context_get(xreq, r);
316 static void xreq_hooked_context_set_cb(void *closure, void *value, void (*free_value)(void*))
318 struct afb_xreq *xreq = closure;
319 afb_hook_xreq_context_set(xreq, value, free_value);
320 xreq_context_set_cb(closure, value, free_value);
323 static void xreq_hooked_addref_cb(void *closure)
325 struct afb_xreq *xreq = closure;
326 afb_hook_xreq_addref(xreq);
327 xreq_addref_cb(closure);
330 static void xreq_hooked_unref_cb(void *closure)
332 struct afb_xreq *xreq = closure;
333 afb_hook_xreq_unref(xreq);
334 if (!__atomic_sub_fetch(&xreq->refcount, 1, __ATOMIC_RELAXED)) {
335 afb_hook_xreq_end(xreq);
336 xreq->queryitf->unref(xreq);
340 static void xreq_hooked_session_close_cb(void *closure)
342 struct afb_xreq *xreq = closure;
343 afb_hook_xreq_session_close(xreq);
344 xreq_session_close_cb(closure);
347 static int xreq_hooked_session_set_LOA_cb(void *closure, unsigned level)
349 int r = xreq_session_set_LOA_cb(closure, level);
350 struct afb_xreq *xreq = closure;
351 return afb_hook_xreq_session_set_LOA(xreq, level, r);
354 static int xreq_hooked_subscribe_cb(void *closure, struct afb_event event)
356 int r = xreq_subscribe_cb(closure, event);
357 struct afb_xreq *xreq = closure;
358 return afb_hook_xreq_subscribe(xreq, event, r);
361 static int xreq_hooked_unsubscribe_cb(void *closure, struct afb_event event)
363 int r = xreq_unsubscribe_cb(closure, event);
364 struct afb_xreq *xreq = closure;
365 return afb_hook_xreq_unsubscribe(xreq, event, r);
370 struct afb_xreq *xreq;
371 void (*callback)(void*, int, struct json_object*);
375 static void xreq_hooked_subcall_reply_cb(void *closure, int iserror, struct json_object *result)
377 struct reply *reply = closure;
379 afb_hook_xreq_subcall_result(reply->xreq, iserror, result);
380 reply->callback(reply->closure, iserror, result);
384 static void xreq_hooked_subcall_cb(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure)
386 struct reply *reply = malloc(sizeof *reply);
387 struct afb_xreq *xreq = closure;
388 afb_hook_xreq_subcall(xreq, api, verb, args);
391 reply->callback = callback;
392 reply->closure = cb_closure;
393 xreq_subcall_cb(closure, api, verb, args, xreq_hooked_subcall_reply_cb, reply);
395 ERROR("out of memory");
396 xreq_subcall_cb(closure, api, verb, args, callback, cb_closure);
400 static int xreq_hooked_subcallsync_cb(void *closure, const char *api, const char *verb, struct json_object *args, struct json_object **result)
403 struct afb_xreq *xreq = closure;
404 afb_hook_xreq_subcallsync(xreq, api, verb, args);
405 r = xreq_subcallsync_cb(closure, api, verb, args, result);
406 return afb_hook_xreq_subcallsync_result(xreq, r, *result);
409 static void xreq_hooked_vverbose_cb(void*closure, int level, const char *file, int line, const char *func, const char *fmt, va_list args)
411 struct afb_xreq *xreq = closure;
414 xreq_vverbose_cb(closure, level, file, line, func, fmt, args);
415 afb_hook_xreq_vverbose(xreq, level, file, line, func, fmt, ap);
419 /******************************************************************************/
421 const struct afb_req_itf xreq_itf = {
422 .json = xreq_json_cb,
424 .success = xreq_success_cb,
425 .fail = xreq_fail_cb,
426 .vsuccess = xreq_vsuccess_cb,
427 .vfail = xreq_vfail_cb,
428 .context_get = xreq_context_get_cb,
429 .context_set = xreq_context_set_cb,
430 .addref = xreq_addref_cb,
431 .unref = xreq_unref_cb,
432 .session_close = xreq_session_close_cb,
433 .session_set_LOA = xreq_session_set_LOA_cb,
434 .subscribe = xreq_subscribe_cb,
435 .unsubscribe = xreq_unsubscribe_cb,
436 .subcall = xreq_subcall_cb,
437 .subcallsync = xreq_subcallsync_cb,
438 .vverbose = xreq_vverbose_cb
441 const struct afb_req_itf xreq_hooked_itf = {
442 .json = xreq_hooked_json_cb,
443 .get = xreq_hooked_get_cb,
444 .success = xreq_hooked_success_cb,
445 .fail = xreq_hooked_fail_cb,
446 .vsuccess = xreq_hooked_vsuccess_cb,
447 .vfail = xreq_hooked_vfail_cb,
448 .context_get = xreq_hooked_context_get_cb,
449 .context_set = xreq_hooked_context_set_cb,
450 .addref = xreq_hooked_addref_cb,
451 .unref = xreq_hooked_unref_cb,
452 .session_close = xreq_hooked_session_close_cb,
453 .session_set_LOA = xreq_hooked_session_set_LOA_cb,
454 .subscribe = xreq_hooked_subscribe_cb,
455 .unsubscribe = xreq_hooked_unsubscribe_cb,
456 .subcall = xreq_hooked_subcall_cb,
457 .subcallsync = xreq_hooked_subcallsync_cb,
458 .vverbose = xreq_hooked_vverbose_cb
461 static inline struct afb_req to_req(struct afb_xreq *xreq)
463 return (struct afb_req){ .itf = xreq->hookflags ? &xreq_hooked_itf : &xreq_itf, .closure = xreq };
466 /******************************************************************************/
468 struct json_object *afb_xreq_json(struct afb_xreq *xreq)
470 return afb_req_json(to_req(xreq));
473 void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info)
475 afb_req_success(to_req(xreq), obj, info);
478 void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...)
482 va_start(args, info);
483 if (info == NULL || vasprintf(&message, info, args) < 0)
486 afb_xreq_success(xreq, obj, message);
490 void afb_xreq_fail(struct afb_xreq *xreq, const char *status, const char *info)
492 afb_req_fail(to_req(xreq), status, info);
495 void afb_xreq_fail_f(struct afb_xreq *xreq, const char *status, const char *info, ...)
499 va_start(args, info);
500 if (info == NULL || vasprintf(&message, info, args) < 0)
503 afb_xreq_fail(xreq, status, message);
507 const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size)
509 struct json_object *obj = xreq_json_cb(xreq);
510 const char *result = json_object_to_json_string(obj);
512 *size = strlen(result);
516 void afb_xreq_addref(struct afb_xreq *xreq)
518 afb_req_addref(to_req(xreq));
521 void afb_xreq_unref(struct afb_xreq *xreq)
523 afb_req_unref(to_req(xreq));
526 void afb_xreq_unhooked_subcall(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure)
528 xreq_subcall_cb(xreq, api, verb, args, callback, cb_closure);
531 void afb_xreq_subcall(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure)
533 afb_req_subcall(to_req(xreq), api, verb, args, callback, cb_closure);
536 int afb_xreq_unhooked_subcall_sync(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, struct json_object **result)
538 return xreq_subcallsync_cb(xreq, api, verb, args, result);
541 int afb_xreq_subcall_sync(struct afb_xreq *xreq, const char *api, const char *verb, struct json_object *args, struct json_object **result)
543 return afb_req_subcall_sync(to_req(xreq), api, verb, args, result);
546 static int xreq_session_check_apply_v1(struct afb_xreq *xreq, int sessionflags)
550 if ((sessionflags & (AFB_SESSION_CLOSE_V1|AFB_SESSION_RENEW_V1|AFB_SESSION_CHECK_V1|AFB_SESSION_LOA_EQ_V1)) != 0) {
551 if (!afb_context_check(&xreq->context)) {
552 afb_context_close(&xreq->context);
553 afb_xreq_fail_f(xreq, "denied", "invalid token's identity");
559 if ((sessionflags & AFB_SESSION_LOA_GE_V1) != 0) {
560 loa = (sessionflags >> AFB_SESSION_LOA_SHIFT_V1) & AFB_SESSION_LOA_MASK_V1;
561 if (!afb_context_check_loa(&xreq->context, loa)) {
562 afb_xreq_fail_f(xreq, "denied", "invalid LOA");
568 if ((sessionflags & AFB_SESSION_LOA_LE_V1) != 0) {
569 loa = (sessionflags >> AFB_SESSION_LOA_SHIFT_V1) & AFB_SESSION_LOA_MASK_V1;
570 if (afb_context_check_loa(&xreq->context, loa + 1)) {
571 afb_xreq_fail_f(xreq, "denied", "invalid LOA");
577 if ((sessionflags & AFB_SESSION_RENEW_V1) != 0) {
578 afb_context_refresh(&xreq->context);
580 if ((sessionflags & AFB_SESSION_CLOSE_V1) != 0) {
581 afb_context_change_loa(&xreq->context, 0);
582 afb_context_close(&xreq->context);
588 static int xreq_session_check_apply_v2(struct afb_xreq *xreq, uint32_t sessionflags, const struct afb_auth *auth)
592 if (sessionflags != 0) {
593 if (!afb_context_check(&xreq->context)) {
594 afb_context_close(&xreq->context);
595 afb_xreq_fail_f(xreq, "denied", "invalid token's identity");
601 loa = (int)(sessionflags & AFB_SESSION_LOA_MASK_V2);
602 if (loa && !afb_context_check_loa(&xreq->context, loa)) {
603 afb_xreq_fail_f(xreq, "denied", "invalid LOA");
608 if (auth && !afb_auth_check(auth, xreq)) {
609 afb_xreq_fail_f(xreq, "denied", "authorisation refused");
614 if ((sessionflags & AFB_SESSION_REFRESH_V2) != 0) {
615 afb_context_refresh(&xreq->context);
617 if ((sessionflags & AFB_SESSION_CLOSE_V2) != 0) {
618 afb_context_close(&xreq->context);
624 void afb_xreq_call_verb_v1(struct afb_xreq *xreq, const struct afb_verb_desc_v1 *verb)
627 afb_xreq_fail_unknown_verb(xreq);
629 if (!xreq_session_check_apply_v1(xreq, verb->session))
630 verb->callback(to_req(xreq));
633 void afb_xreq_call_verb_v2(struct afb_xreq *xreq, const struct afb_verb_v2 *verb)
636 afb_xreq_fail_unknown_verb(xreq);
638 if (!xreq_session_check_apply_v2(xreq, verb->session, verb->auth))
639 verb->callback(to_req(xreq));
642 void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf)
644 memset(xreq, 0, sizeof *xreq);
646 xreq->queryitf = queryitf;
649 void afb_xreq_fail_unknown_api(struct afb_xreq *xreq)
651 afb_xreq_fail_f(xreq, "unknown-api", "api %s not found (for verb %s)", xreq->api, xreq->verb);
654 void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq)
656 afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, xreq->api);
659 static void process_sync(struct afb_xreq *xreq)
664 afb_hook_init_xreq(xreq);
666 afb_hook_xreq_begin(xreq);
669 if (afb_apiset_get_started(xreq->apiset, xreq->api, &api) < 0) {
671 afb_xreq_fail_f(xreq, "unknown-api", "api %s not found", xreq->api);
673 afb_xreq_fail_f(xreq, "bad-api-state", "api %s not started correctly: %m", xreq->api);
675 xreq->context.api_key = api.closure;
676 api.itf->call(api.closure, xreq);
680 static void process_async(int signum, void *arg)
682 struct afb_xreq *xreq = arg;
685 afb_xreq_fail_f(xreq, "aborted", "signal %s(%d) caught", strsignal(signum), signum);
689 afb_xreq_unref(xreq);
692 void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset)
694 xreq->apiset = apiset;
696 afb_xreq_addref(xreq);
697 if (jobs_queue(NULL, afb_apiset_timeout_get(apiset), process_async, xreq) < 0) {
698 /* TODO: allows or not to proccess it directly as when no threading? (see above) */
699 ERROR("can't process job with threads: %m");
700 afb_xreq_fail_f(xreq, "cancelled", "not able to create a job for the task");
701 afb_xreq_unref(xreq);
703 afb_xreq_unref(xreq);