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