Merge "Add package archive documentation to README.md"
[src/app-framework-binder.git] / src / afb-ws-json1.c
1 /*
2  * Copyright (C) 2016, 2017 "IoT.bzh"
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
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
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #define _GNU_SOURCE
19
20 #include <stdlib.h>
21 #include <unistd.h>
22 #include <assert.h>
23 #include <errno.h>
24 #include <string.h>
25
26 #include <json-c/json.h>
27
28 #include <afb/afb-event-itf.h>
29
30 #include "afb-wsj1.h"
31 #include "afb-ws-json1.h"
32 #include "afb-common.h"
33 #include "afb-msg-json.h"
34 #include "afb-session.h"
35 #include "afb-cred.h"
36 #include "afb-apiset.h"
37 #include "afb-xreq.h"
38 #include "afb-context.h"
39 #include "afb-evt.h"
40 #include "verbose.h"
41
42 /* predeclaration of structures */
43 struct afb_ws_json1;
44 struct afb_wsreq;
45
46 /* predeclaration of websocket callbacks */
47 static void aws_on_hangup(struct afb_ws_json1 *ws, struct afb_wsj1 *wsj1);
48 static void aws_on_call(struct afb_ws_json1 *ws, const char *api, const char *verb, struct afb_wsj1_msg *msg);
49 static void aws_on_event(struct afb_ws_json1 *ws, const char *event, int eventid, struct json_object *object);
50
51 /* predeclaration of wsreq callbacks */
52 static void wsreq_destroy(struct afb_xreq *xreq);
53 static void wsreq_reply(struct afb_xreq *xreq, int iserror, json_object *obj);
54
55 /* declaration of websocket structure */
56 struct afb_ws_json1
57 {
58         int refcount;
59         void (*cleanup)(void*);
60         void *cleanup_closure;
61         struct afb_session *session;
62         struct afb_evt_listener *listener;
63         struct afb_wsj1 *wsj1;
64         struct afb_cred *cred;
65         struct afb_apiset *apiset;
66         int new_session;
67 };
68
69 /* declaration of wsreq structure */
70 struct afb_wsreq
71 {
72         struct afb_xreq xreq;
73         struct afb_ws_json1 *aws;
74         struct afb_wsreq *next;
75         struct afb_wsj1_msg *msgj1;
76 };
77
78 /* interface for afb_ws_json1 / afb_wsj1 */
79 static struct afb_wsj1_itf wsj1_itf = {
80         .on_hangup = (void*)aws_on_hangup,
81         .on_call = (void*)aws_on_call
82 };
83
84 /* interface for xreq */
85 const struct afb_xreq_query_itf afb_ws_json1_xreq_itf = {
86         .reply = wsreq_reply,
87         .unref = wsreq_destroy
88 };
89
90 /* the interface for events */
91 static const struct afb_evt_itf evt_itf = {
92         .broadcast = (void*)aws_on_event,
93         .push = (void*)aws_on_event
94 };
95
96 /***************************************************************
97 ****************************************************************
98 **
99 **  functions of afb_ws_json1 / afb_wsj1
100 **
101 ****************************************************************
102 ***************************************************************/
103
104 struct afb_ws_json1 *afb_ws_json1_create(int fd, struct afb_apiset *apiset, struct afb_context *context, void (*cleanup)(void*), void *cleanup_closure)
105 {
106         struct afb_ws_json1 *result;
107
108         assert(fd >= 0);
109         assert(context != NULL);
110
111         result = malloc(sizeof * result);
112         if (result == NULL)
113                 goto error;
114
115         result->refcount = 1;
116         result->cleanup = cleanup;
117         result->cleanup_closure = cleanup_closure;
118         result->session = afb_session_addref(context->session);
119         result->new_session = context->created != 0;
120         if (result->session == NULL)
121                 goto error2;
122
123         result->wsj1 = afb_wsj1_create(afb_common_get_event_loop(), fd, &wsj1_itf, result);
124         if (result->wsj1 == NULL)
125                 goto error3;
126
127         result->listener = afb_evt_listener_create(&evt_itf, result);
128         if (result->listener == NULL)
129                 goto error4;
130
131         result->cred = afb_cred_create_for_socket(fd);
132         result->apiset = afb_apiset_addref(apiset);
133         return result;
134
135 error4:
136         afb_wsj1_unref(result->wsj1);
137 error3:
138         afb_session_unref(result->session);
139 error2:
140         free(result);
141 error:
142         close(fd);
143         return NULL;
144 }
145
146 static struct afb_ws_json1 *aws_addref(struct afb_ws_json1 *ws)
147 {
148         __atomic_add_fetch(&ws->refcount, 1, __ATOMIC_RELAXED);
149         return ws;
150 }
151
152 static void aws_unref(struct afb_ws_json1 *ws)
153 {
154         if (!__atomic_sub_fetch(&ws->refcount, 1, __ATOMIC_RELAXED)) {
155                 afb_evt_listener_unref(ws->listener);
156                 afb_wsj1_unref(ws->wsj1);
157                 if (ws->cleanup != NULL)
158                         ws->cleanup(ws->cleanup_closure);
159                 afb_session_unref(ws->session);
160                 afb_cred_unref(ws->cred);
161                 afb_apiset_unref(ws->apiset);
162                 free(ws);
163         }
164 }
165
166 static void aws_on_hangup(struct afb_ws_json1 *ws, struct afb_wsj1 *wsj1)
167 {
168         aws_unref(ws);
169 }
170
171 static void aws_on_call(struct afb_ws_json1 *ws, const char *api, const char *verb, struct afb_wsj1_msg *msg)
172 {
173         struct afb_wsreq *wsreq;
174
175         DEBUG("received websocket request for %s/%s: %s", api, verb, afb_wsj1_msg_object_s(msg));
176
177         /* allocate */
178         wsreq = calloc(1, sizeof *wsreq);
179         if (wsreq == NULL) {
180                 afb_wsj1_close(ws->wsj1, 1008, NULL);
181                 return;
182         }
183
184         /* init the context */
185         afb_xreq_init(&wsreq->xreq, &afb_ws_json1_xreq_itf);
186         afb_context_init(&wsreq->xreq.context, ws->session, afb_wsj1_msg_token(msg));
187         if (!wsreq->xreq.context.invalidated)
188                 wsreq->xreq.context.validated = 1;
189         if (ws->new_session != 0) {
190                 wsreq->xreq.context.created = 1;
191                 ws->new_session = 0;
192         }
193
194         /* fill and record the request */
195         afb_wsj1_msg_addref(msg);
196         wsreq->msgj1 = msg;
197         wsreq->xreq.cred = afb_cred_addref(ws->cred);
198         wsreq->xreq.api = api;
199         wsreq->xreq.verb = verb;
200         wsreq->xreq.json = afb_wsj1_msg_object_j(wsreq->msgj1);
201         wsreq->aws = aws_addref(ws);
202         wsreq->xreq.listener = wsreq->aws->listener;
203
204         /* emits the call */
205         afb_xreq_process(&wsreq->xreq, ws->apiset);
206 }
207
208 static void aws_on_event(struct afb_ws_json1 *aws, const char *event, int eventid, struct json_object *object)
209 {
210         afb_wsj1_send_event_j(aws->wsj1, event, afb_msg_json_event(event, object));
211 }
212
213 /***************************************************************
214 ****************************************************************
215 **
216 **  functions of wsreq / afb_req
217 **
218 ****************************************************************
219 ***************************************************************/
220
221 static void wsreq_destroy(struct afb_xreq *xreq)
222 {
223         struct afb_wsreq *wsreq = CONTAINER_OF_XREQ(struct afb_wsreq, xreq);
224
225         afb_context_disconnect(&wsreq->xreq.context);
226         afb_wsj1_msg_unref(wsreq->msgj1);
227         afb_cred_unref(wsreq->xreq.cred);
228         aws_unref(wsreq->aws);
229         free(wsreq);
230 }
231
232 static void wsreq_reply(struct afb_xreq *xreq, int iserror, json_object *obj)
233 {
234         struct afb_wsreq *wsreq = CONTAINER_OF_XREQ(struct afb_wsreq, xreq);
235         int rc;
236
237         rc = (iserror ? afb_wsj1_reply_error_j : afb_wsj1_reply_ok_j)(
238                         wsreq->msgj1, obj, afb_context_sent_token(&wsreq->xreq.context));
239         if (rc)
240                 ERROR("Can't send reply: %m");
241 }
242