Websocket: improves overall integration
[src/app-framework-binder.git] / src / afb-ws-json1.c
1 /*
2  * Copyright (C) 2016 "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-wsj1.h"
29 #include "afb-ws-json1.h"
30 #include "afb-msg-json.h"
31 #include "session.h"
32 #include <afb/afb-req-itf.h>
33 #include "afb-apis.h"
34 #include "afb-context.h"
35 #include "verbose.h"
36
37 static void aws_on_hangup(struct afb_ws_json1 *ws, struct afb_wsj1 *wsj1);
38 static void aws_on_call(struct afb_ws_json1 *ws, const char *api, const char *verb, struct afb_wsj1_msg *msg);
39
40 static struct afb_wsj1_itf wsj1_itf = {
41         .on_hangup = (void*)aws_on_hangup,
42         .on_call = (void*)aws_on_call
43 };
44
45 struct afb_wsreq;
46
47 struct afb_ws_json1
48 {
49         int refcount;
50         void (*cleanup)(void*);
51         void *cleanup_closure;
52         struct AFB_clientCtx *session;
53         struct afb_wsj1 *wsj1;
54         int new_session;
55 };
56
57 static void aws_send_event(struct afb_ws_json1 *ws, const char *event, struct json_object *object);
58
59 static const struct afb_event_listener_itf event_listener_itf = {
60         .send = (void*)aws_send_event,
61         .expects = NULL
62 };
63
64 static inline struct afb_event_listener listener_for(struct afb_ws_json1 *aws)
65 {
66         return (struct afb_event_listener){ .itf = &event_listener_itf, .closure = aws };
67 }
68
69 struct afb_ws_json1 *afb_ws_json1_create(int fd, struct afb_context *context, void (*cleanup)(void*), void *cleanup_closure)
70 {
71         struct afb_ws_json1 *result;
72
73         assert(fd >= 0);
74         assert(context != NULL);
75
76         result = malloc(sizeof * result);
77         if (result == NULL)
78                 goto error;
79
80         result->refcount = 1;
81         result->cleanup = cleanup;
82         result->cleanup_closure = cleanup_closure;
83         result->session = ctxClientAddRef(context->session);
84         result->new_session = context->created != 0;
85         if (result->session == NULL)
86                 goto error2;
87
88         result->wsj1 = afb_wsj1_create(fd, &wsj1_itf, result);
89         if (result->wsj1 == NULL)
90                 goto error3;
91
92         if (0 > ctxClientEventListenerAdd(result->session, listener_for(result)))
93                 goto error4;
94
95         return result;
96
97 error4:
98         afb_wsj1_unref(result->wsj1);
99 error3:
100         ctxClientUnref(result->session);
101 error2:
102         free(result);
103 error:
104         close(fd);
105         return NULL;
106 }
107
108 static struct afb_ws_json1 *aws_addref(struct afb_ws_json1 *ws)
109 {
110         ws->refcount++;
111         return ws;
112 }
113
114 static void aws_unref(struct afb_ws_json1 *ws)
115 {
116         if (--ws->refcount == 0) {
117                 ctxClientEventListenerRemove(ws->session, listener_for(ws));
118                 afb_wsj1_unref(ws->wsj1);
119                 if (ws->cleanup != NULL)
120                         ws->cleanup(ws->cleanup_closure);
121                 ctxClientUnref(ws->session);
122                 free(ws);
123         }
124 }
125
126 static void aws_on_hangup(struct afb_ws_json1 *ws, struct afb_wsj1 *wsj1)
127 {
128         aws_unref(ws);
129 }
130
131 struct afb_wsreq
132 {
133         /*
134          * CAUTION: 'context' field should be the first because there
135          * is an implicit convertion to struct afb_context
136          */
137         struct afb_context context;
138         int refcount;
139         struct afb_ws_json1 *aws;
140         struct afb_wsreq *next;
141         struct afb_wsj1_msg *msgj1;
142 };
143
144 static void wsreq_addref(struct afb_wsreq *wsreq);
145 static void wsreq_unref(struct afb_wsreq *wsreq);
146 static struct json_object *wsreq_json(struct afb_wsreq *wsreq);
147 static struct afb_arg wsreq_get(struct afb_wsreq *wsreq, const char *name);
148 static void wsreq_fail(struct afb_wsreq *wsreq, const char *status, const char *info);
149 static void wsreq_success(struct afb_wsreq *wsreq, struct json_object *obj, const char *info);
150 static const char *wsreq_raw(struct afb_wsreq *wsreq, size_t *size);
151 static void wsreq_send(struct afb_wsreq *wsreq, const char *buffer, size_t size);
152
153
154 static const struct afb_req_itf wsreq_itf = {
155         .json = (void*)wsreq_json,
156         .get = (void*)wsreq_get,
157         .success = (void*)wsreq_success,
158         .fail = (void*)wsreq_fail,
159         .raw = (void*)wsreq_raw,
160         .send = (void*)wsreq_send,
161         .context_get = (void*)afb_context_get,
162         .context_set = (void*)afb_context_set,
163         .addref = (void*)wsreq_addref,
164         .unref = (void*)wsreq_unref,
165         .session_close = (void*)afb_context_close,
166         .session_set_LOA = (void*)afb_context_change_loa
167 };
168
169 static void aws_on_call(struct afb_ws_json1 *ws, const char *api, const char *verb, struct afb_wsj1_msg *msg)
170 {
171         struct afb_req r;
172         struct afb_wsreq *wsreq;
173
174         DEBUG("received websocket request for %s/%s: %s", api, verb, afb_wsj1_msg_object_s(msg));
175
176         /* allocate */
177         wsreq = calloc(1, sizeof *wsreq);
178         if (wsreq == NULL) {
179                 afb_wsj1_close(ws->wsj1, 1008, NULL);
180                 return;
181         }
182
183         /* init the context */
184         afb_context_init(&wsreq->context, ws->session, afb_wsj1_msg_token(msg));
185         if (!wsreq->context.invalidated)
186                 wsreq->context.validated = 1;
187         if (ws->new_session != 0) {
188                 wsreq->context.created = 1;
189                 ws->new_session = 0;
190         }
191
192         /* fill and record the request */
193         afb_wsj1_msg_addref(msg);
194         wsreq->msgj1 = msg;
195         wsreq->refcount = 1;
196         wsreq->aws = aws_addref(ws);
197
198         /* emits the call */
199         r.closure = wsreq;
200         r.itf = &wsreq_itf;
201         afb_apis_call_(r, &wsreq->context, api, verb);
202         wsreq_unref(wsreq);
203 }
204
205 static void wsreq_addref(struct afb_wsreq *wsreq)
206 {
207         wsreq->refcount++;
208 }
209
210 static void wsreq_unref(struct afb_wsreq *wsreq)
211 {
212         if (--wsreq->refcount == 0) {
213                 afb_context_disconnect(&wsreq->context);
214                 afb_wsj1_msg_unref(wsreq->msgj1);
215                 aws_unref(wsreq->aws);
216                 free(wsreq);
217         }
218 }
219
220 static struct json_object *wsreq_json(struct afb_wsreq *wsreq)
221 {
222         return afb_wsj1_msg_object_j(wsreq->msgj1);
223 }
224
225 static struct afb_arg wsreq_get(struct afb_wsreq *wsreq, const char *name)
226 {
227         struct afb_arg arg;
228         struct json_object *value, *root;
229
230         root = wsreq_json(wsreq);
231         if (json_object_object_get_ex(root, name, &value)) {
232                 arg.name = name;
233                 arg.value = json_object_get_string(value);
234         } else {
235                 arg.name = NULL;
236                 arg.value = NULL;
237         }
238         arg.path = NULL;
239         return arg;
240 }
241
242 static void wsreq_fail(struct afb_wsreq *wsreq, const char *status, const char *info)
243 {
244         int rc;
245         rc = afb_wsj1_reply_error_j(wsreq->msgj1, afb_msg_json_reply_error(status, info, &wsreq->context, NULL), afb_context_sent_token(&wsreq->context));
246         if (rc)
247                 ERROR("Can't send fail reply: %m");
248 }
249
250 static void wsreq_success(struct afb_wsreq *wsreq, json_object *obj, const char *info)
251 {
252         int rc;
253         rc = afb_wsj1_reply_ok_j(wsreq->msgj1, afb_msg_json_reply_ok(info, obj, &wsreq->context, NULL), afb_context_sent_token(&wsreq->context));
254         if (rc)
255                 ERROR("Can't send success reply: %m");
256 }
257
258 static const char *wsreq_raw(struct afb_wsreq *wsreq, size_t *size)
259 {
260         const char *result = afb_wsj1_msg_object_s(wsreq->msgj1);
261         if (size != NULL)
262                 *size = strlen(result);
263         return result;
264 }
265
266 static void wsreq_send(struct afb_wsreq *wsreq, const char *buffer, size_t size)
267 {
268         int rc;
269         rc = afb_wsj1_reply_ok_s(wsreq->msgj1, buffer, afb_context_sent_token(&wsreq->context));
270         if (rc)
271                 ERROR("Can't send raw reply: %m");
272 }
273
274 static void aws_send_event(struct afb_ws_json1 *aws, const char *event, struct json_object *object)
275 {
276         afb_wsj1_send_event_j(aws->wsj1, event, afb_msg_json_event(event, object));
277 }
278