2 * Copyright (C) 2015-2018 "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.
28 #include <sys/types.h>
29 #include <sys/socket.h>
33 #include <json-c/json.h>
35 #include <afb/afb-event-x2.h>
37 #include "afb-session.h"
40 #include "afb-apiset.h"
41 #include "afb-proto-ws.h"
42 #include "afb-stub-ws.h"
43 #include "afb-context.h"
54 * structure for a ws request: requests on server side
57 struct afb_xreq xreq; /**< the xreq */
58 struct afb_stub_ws *stubws; /**< the client of the request */
59 struct afb_proto_ws_call *call; /**< the incoming call */
63 * structure for recording events on client side
67 struct client_event *next; /**< link to the next */
68 struct afb_event_x2 *event; /**< the local event */
69 int id; /**< the identifier */
70 int refcount; /**< a reference count */
74 * structure for recording describe requests on the client side
76 struct client_describe
78 struct afb_stub_ws *stubws; /**< the stub */
79 struct jobloop *jobloop; /**< the jobloop to leave */
80 struct json_object *result; /**< result */
84 * structure for jobs of describing
86 struct server_describe
88 struct afb_stub_ws *stubws;
89 struct afb_proto_ws_describe *describe;
93 * structure for recording sessions
97 struct server_session *next;
98 struct afb_session *session;
101 /******************* stub description for client or servers ******************/
106 struct afb_proto_ws *proto;
109 struct afb_apiset *apiset;
111 /* on hangup callback */
112 void (*on_hangup)(struct afb_stub_ws *);
117 /* listener for events */
118 struct afb_evt_listener *listener;
121 struct server_session *sessions;
123 /* credentials of the client */
124 struct afb_cred *cred;
130 struct client_event *events;
134 /* count of references */
137 /* type of the stub: 0=server, 1=client */
144 /******************* ws request part for server *****************/
146 /* decrement the reference count of the request and free/release it on falling to null */
147 static void server_req_destroy_cb(struct afb_xreq *xreq)
149 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
151 afb_context_disconnect(&wreq->xreq.context);
152 afb_cred_unref(wreq->xreq.cred);
153 json_object_put(wreq->xreq.json);
154 afb_proto_ws_call_unref(wreq->call);
155 afb_stub_ws_unref(wreq->stubws);
159 static void server_req_reply_cb(struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info)
162 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
164 rc = afb_proto_ws_call_reply(wreq->call, obj, error, info);
166 ERROR("error while sending reply");
167 json_object_put(obj);
170 static int server_req_subscribe_cb(struct afb_xreq *xreq, struct afb_event_x2 *event)
173 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
175 rc = afb_evt_event_x2_add_watch(wreq->stubws->listener, event);
177 rc = afb_proto_ws_call_subscribe(wreq->call, afb_evt_event_x2_fullname(event), afb_evt_event_x2_id(event));
179 ERROR("error while subscribing event");
183 static int server_req_unsubscribe_cb(struct afb_xreq *xreq, struct afb_event_x2 *event)
186 struct server_req *wreq = CONTAINER_OF_XREQ(struct server_req, xreq);
188 rc = afb_proto_ws_call_unsubscribe(wreq->call, afb_evt_event_x2_fullname(event), afb_evt_event_x2_id(event));
189 rc2 = afb_evt_event_x2_remove_watch(wreq->stubws->listener, event);
190 if (rc >= 0 && rc2 < 0)
193 ERROR("error while unsubscribing event");
197 static const struct afb_xreq_query_itf server_req_xreq_itf = {
198 .reply = server_req_reply_cb,
199 .unref = server_req_destroy_cb,
200 .subscribe = server_req_subscribe_cb,
201 .unsubscribe = server_req_unsubscribe_cb
204 /******************* client part **********************************/
206 /* destroy all events */
207 static void client_drop_all_events(struct afb_stub_ws *stubws)
209 struct client_event *ev, *nxt;
211 nxt = __atomic_exchange_n(&stubws->events, NULL, __ATOMIC_RELAXED);
215 afb_evt_event_x2_unref(ev->event);
220 /* search the event */
221 static struct client_event *client_event_search(struct afb_stub_ws *stubws, uint32_t eventid, const char *name)
223 struct client_event *ev;
226 while (ev != NULL && (ev->id != eventid || 0 != strcmp(afb_evt_event_x2_fullname(ev->event), name)))
232 /* on call, propagate it to the ws service */
233 static void client_api_call_cb(void * closure, struct afb_xreq *xreq)
236 struct afb_stub_ws *stubws = closure;
238 if (stubws->proto == NULL) {
239 afb_xreq_reply(xreq, NULL, "disconnected", "server hung up");
243 rc = afb_proto_ws_client_call(
245 xreq->request.called_verb,
247 afb_session_uuid(xreq->context.session),
249 xreq_on_behalf_cred_export(xreq));
251 afb_xreq_unhooked_addref(xreq);
253 afb_xreq_reply(xreq, NULL, "internal", "can't send message");
256 static void client_on_description_cb(void *closure, struct json_object *data)
258 struct client_describe *desc = closure;
261 jobs_leave(desc->jobloop);
264 static void client_send_describe_cb(int signum, void *closure, struct jobloop *jobloop)
266 struct client_describe *desc = closure;
268 if (signum || desc->stubws->proto == NULL)
271 desc->jobloop = jobloop;
272 afb_proto_ws_client_describe(desc->stubws->proto, client_on_description_cb, desc);
276 /* get the description */
277 static struct json_object *client_api_describe_cb(void * closure)
279 struct client_describe desc;
281 /* synchronous job: send the request and wait its result */
282 desc.stubws = closure;
284 jobs_enter(NULL, 0, client_send_describe_cb, &desc);
288 /******************* server part: manage events **********************************/
290 static void server_event_add_cb(void *closure, const char *event, int eventid)
292 struct afb_stub_ws *stubws = closure;
294 if (stubws->proto != NULL)
295 afb_proto_ws_server_event_create(stubws->proto, event, eventid);
298 static void server_event_remove_cb(void *closure, const char *event, int eventid)
300 struct afb_stub_ws *stubws = closure;
302 if (stubws->proto != NULL)
303 afb_proto_ws_server_event_remove(stubws->proto, event, eventid);
306 static void server_event_push_cb(void *closure, const char *event, int eventid, struct json_object *object)
308 struct afb_stub_ws *stubws = closure;
310 if (stubws->proto != NULL)
311 afb_proto_ws_server_event_push(stubws->proto, event, eventid, object);
312 json_object_put(object);
315 static void server_event_broadcast_cb(void *closure, const char *event, int eventid, struct json_object *object)
317 struct afb_stub_ws *stubws = closure;
319 if (stubws->proto != NULL)
320 afb_proto_ws_server_event_broadcast(stubws->proto, event, object);
321 json_object_put(object);
324 /*****************************************************/
326 static void client_on_reply_cb(void *closure, void *request, struct json_object *object, const char *error, const char *info)
328 struct afb_xreq *xreq = request;
330 afb_xreq_reply(xreq, object, error, info);
331 afb_xreq_unhooked_unref(xreq);
334 static void client_on_event_create_cb(void *closure, const char *event_name, int event_id)
336 struct afb_stub_ws *stubws = closure;
337 struct client_event *ev;
339 /* check conflicts */
340 ev = client_event_search(stubws, event_id, event_name);
342 __atomic_add_fetch(&ev->refcount, 1, __ATOMIC_RELAXED);
346 /* no conflict, try to add it */
347 ev = malloc(sizeof *ev);
349 ev->event = afb_evt_event_x2_create(event_name);
350 if (ev->event != NULL) {
353 ev->next = stubws->events;
359 ERROR("can't create event %s, out of memory", event_name);
362 static void client_on_event_remove_cb(void *closure, const char *event_name, int event_id)
364 struct afb_stub_ws *stubws = closure;
365 struct client_event *ev, **prv;
367 /* check conflicts */
368 ev = client_event_search(stubws, event_id, event_name);
372 /* decrease the reference count */
374 if (__atomic_sub_fetch(&ev->refcount, 1, __ATOMIC_RELAXED))
377 /* unlinks the event */
378 prv = &stubws->events;
383 /* destroys the event */
384 afb_evt_event_x2_unref(ev->event);
388 static void client_on_event_subscribe_cb(void *closure, void *request, const char *event_name, int event_id)
390 struct afb_stub_ws *stubws = closure;
391 struct afb_xreq *xreq = request;
392 struct client_event *ev;
394 /* check conflicts */
395 ev = client_event_search(stubws, event_id, event_name);
399 if (afb_xreq_subscribe(xreq, ev->event) < 0)
400 ERROR("can't subscribe: %m");
403 static void client_on_event_unsubscribe_cb(void *closure, void *request, const char *event_name, int event_id)
405 struct afb_stub_ws *stubws = closure;
406 struct afb_xreq *xreq = request;
407 struct client_event *ev;
409 /* check conflicts */
410 ev = client_event_search(stubws, event_id, event_name);
414 if (afb_xreq_unsubscribe(xreq, ev->event) < 0)
415 ERROR("can't unsubscribe: %m");
418 static void client_on_event_push_cb(void *closure, const char *event_name, int event_id, struct json_object *data)
420 struct afb_stub_ws *stubws = closure;
421 struct client_event *ev;
423 /* check conflicts */
424 ev = client_event_search(stubws, event_id, event_name);
426 afb_evt_event_x2_push(ev->event, data);
428 ERROR("unreadable push event");
431 static void client_on_event_broadcast_cb(void *closure, const char *event_name, struct json_object *data)
433 afb_evt_broadcast(event_name, data);
436 /*****************************************************/
438 static void server_record_session(struct afb_stub_ws *stubws, struct afb_session *session)
440 struct server_session *s, **prv;
443 prv = &stubws->sessions;
445 if (s->session == session)
447 if (afb_session_is_closed(s->session)) {
449 afb_session_unref(s->session);
457 s = malloc(sizeof *s);
459 s->session = afb_session_addref(session);
460 s->next = stubws->sessions;
461 stubws->sessions = s;
465 static void server_release_all_sessions(struct afb_stub_ws *stubws)
467 struct server_session *ses, *nses;
469 nses = __atomic_exchange_n(&stubws->sessions, NULL, __ATOMIC_RELAXED);
473 afb_session_unref(ses->session);
478 /*****************************************************/
480 static void server_on_call_cb(void *closure, struct afb_proto_ws_call *call, const char *verb, struct json_object *args, const char *sessionid, const char *user_creds)
482 struct afb_stub_ws *stubws = closure;
483 struct server_req *wreq;
485 afb_stub_ws_addref(stubws);
487 /* create the request */
488 wreq = malloc(sizeof *wreq);
492 afb_xreq_init(&wreq->xreq, &server_req_xreq_itf);
493 wreq->stubws = stubws;
496 /* init the context */
497 if (afb_context_connect(&wreq->xreq.context, sessionid, NULL) < 0)
499 wreq->xreq.context.validated = 1;
500 server_record_session(stubws, wreq->xreq.context.session);
501 if (wreq->xreq.context.created)
502 afb_session_set_autoclose(wreq->xreq.context.session, 1);
505 wreq->xreq.cred = afb_cred_mixed_on_behalf_import(stubws->cred, sessionid, user_creds);
506 wreq->xreq.request.called_api = stubws->apiname;
507 wreq->xreq.request.called_verb = verb;
508 wreq->xreq.json = args;
509 afb_xreq_process(&wreq->xreq, stubws->apiset);
515 json_object_put(args);
516 afb_stub_ws_unref(stubws);
517 afb_proto_ws_call_reply(call, NULL, "internal-error", NULL);
518 afb_proto_ws_call_unref(call);
521 static void server_describe_cb(int signum, void *closure)
523 struct json_object *obj;
524 struct server_describe *desc = closure;
526 /* get the description if possible */
527 obj = !signum ? afb_apiset_describe(desc->stubws->apiset, desc->stubws->apiname) : NULL;
530 afb_proto_ws_describe_put(desc->describe, obj);
531 json_object_put(obj);
532 afb_stub_ws_unref(desc->stubws);
535 static void server_describe_job(int signum, void *closure)
537 server_describe_cb(signum, closure);
541 static void server_on_describe_cb(void *closure, struct afb_proto_ws_describe *describe)
543 struct server_describe *desc, sdesc;
544 struct afb_stub_ws *stubws = closure;
546 /* allocate (if possible) and init */
547 desc = malloc(sizeof *desc);
550 desc->stubws = stubws;
551 desc->describe = describe;
552 afb_stub_ws_addref(stubws);
555 if (desc == &sdesc || jobs_queue(NULL, 0, server_describe_job, desc) < 0)
556 jobs_call(NULL, 0, server_describe_cb, desc);
559 /*****************************************************/
561 static const struct afb_proto_ws_client_itf client_itf =
563 .on_reply = client_on_reply_cb,
564 .on_event_create = client_on_event_create_cb,
565 .on_event_remove = client_on_event_remove_cb,
566 .on_event_subscribe = client_on_event_subscribe_cb,
567 .on_event_unsubscribe = client_on_event_unsubscribe_cb,
568 .on_event_push = client_on_event_push_cb,
569 .on_event_broadcast = client_on_event_broadcast_cb,
572 static struct afb_api_itf client_api_itf = {
573 .call = client_api_call_cb,
574 .describe = client_api_describe_cb
577 static const struct afb_proto_ws_server_itf server_itf =
579 .on_call = server_on_call_cb,
580 .on_describe = server_on_describe_cb
583 /* the interface for events pushing */
584 static const struct afb_evt_itf server_event_itf = {
585 .broadcast = server_event_broadcast_cb,
586 .push = server_event_push_cb,
587 .add = server_event_add_cb,
588 .remove = server_event_remove_cb
591 /*****************************************************/
594 static void disconnect(struct afb_stub_ws *stubws)
596 afb_proto_ws_unref(__atomic_exchange_n(&stubws->proto, NULL, __ATOMIC_RELAXED));
597 if (stubws->is_client)
598 client_drop_all_events(stubws);
600 afb_evt_listener_unref(__atomic_exchange_n(&stubws->listener, NULL, __ATOMIC_RELAXED));
601 afb_cred_unref(__atomic_exchange_n(&stubws->cred, NULL, __ATOMIC_RELAXED));
602 server_release_all_sessions(stubws);
607 /* callback when receiving a hangup */
608 static void on_hangup(void *closure)
610 struct afb_stub_ws *stubws = closure;
613 afb_stub_ws_addref(stubws);
615 if (stubws->on_hangup)
616 stubws->on_hangup(stubws);
617 afb_stub_ws_unref(stubws);
621 static int enqueue_processing(void (*callback)(int signum, void* arg), void *arg)
623 return jobs_queue(NULL, 0, callback, arg);
626 /*****************************************************/
628 static struct afb_proto_ws *afb_stub_ws_create_proto(struct afb_stub_ws *stubws, struct fdev *fdev, uint8_t is_client)
630 struct afb_proto_ws *proto;
632 stubws->proto = proto = is_client
633 ? afb_proto_ws_create_client(fdev, &client_itf, stubws)
634 : afb_proto_ws_create_server(fdev, &server_itf, stubws);
636 afb_proto_ws_on_hangup(proto, on_hangup);
637 afb_proto_ws_set_queuing(proto, enqueue_processing);
643 static struct afb_stub_ws *afb_stub_ws_create(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset, uint8_t is_client)
645 struct afb_stub_ws *stubws;
647 stubws = calloc(1, sizeof *stubws + strlen(apiname));
651 if (afb_stub_ws_create_proto(stubws, fdev, is_client)) {
652 stubws->refcount = 1;
653 stubws->is_client = is_client;
654 strcpy(stubws->apiname, apiname);
655 stubws->apiset = afb_apiset_addref(apiset);
664 struct afb_stub_ws *afb_stub_ws_create_client(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset)
666 return afb_stub_ws_create(fdev, apiname, apiset, 1);
669 struct afb_stub_ws *afb_stub_ws_create_server(struct fdev *fdev, const char *apiname, struct afb_apiset *apiset)
671 struct afb_stub_ws *stubws;
673 stubws = afb_stub_ws_create(fdev, apiname, apiset, 0);
675 stubws->cred = afb_cred_create_for_socket(fdev_fd(fdev));
676 stubws->listener = afb_evt_listener_create(&server_event_itf, stubws);
677 if (stubws->listener != NULL)
679 afb_stub_ws_unref(stubws);
684 void afb_stub_ws_unref(struct afb_stub_ws *stubws)
686 if (stubws && !__atomic_sub_fetch(&stubws->refcount, 1, __ATOMIC_RELAXED)) {
689 afb_apiset_unref(stubws->apiset);
694 void afb_stub_ws_addref(struct afb_stub_ws *stubws)
696 __atomic_add_fetch(&stubws->refcount, 1, __ATOMIC_RELAXED);
699 void afb_stub_ws_set_on_hangup(struct afb_stub_ws *stubws, void (*on_hangup)(struct afb_stub_ws*))
701 stubws->on_hangup = on_hangup;
704 const char *afb_stub_ws_name(struct afb_stub_ws *stubws)
706 return stubws->apiname;
709 struct afb_api_item afb_stub_ws_client_api(struct afb_stub_ws *stubws)
711 struct afb_api_item api;
713 assert(stubws->is_client); /* check client */
714 api.closure = stubws;
715 api.itf = &client_api_itf;
720 int afb_stub_ws_client_add(struct afb_stub_ws *stubws, struct afb_apiset *apiset)
722 return afb_apiset_add(apiset, stubws->apiname, afb_stub_ws_client_api(stubws));