src/afb-api-so-v1.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 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
  20
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <dlfcn.h>
  24 #include <assert.h>
  25
  26 #include <json-c/json.h>
  27
  28 #include <afb/afb-binding-v1.h>
  29
  30 #include "afb-api.h"
  31 #include "afb-api-so-v1.h"
  32 #include "afb-apiset.h"
  33 #include "afb-svc.h"
  34 #include "afb-evt.h"
  35 #include "afb-common.h"
  36 #include "afb-context.h"
  37 #include "afb-api-so.h"
  38 #include "afb-xreq.h"
  39 #include "afb-ditf.h"
  40 #include "verbose.h"
  41
  42 /*
  43  * names of symbols
  44  */
  45 static const char afb_api_so_v1_register[] = "afbBindingV1Register";
  46 static const char afb_api_so_v1_service_init[] = "afbBindingV1ServiceInit";
  47 static const char afb_api_so_v1_service_event[] = "afbBindingV1ServiceEvent";
  48
  49 /*
  50  * Description of a binding
  51  */
  52 struct api_so_v1 {
  53         struct afb_binding_v1 *binding; /* descriptor */
  54         void *handle;                   /* context of dlopen */
  55         struct afb_svc *service;        /* handler for service started */
  56         struct afb_binding_interface_v1 interface;
  57         struct afb_ditf ditf;           /* daemon interface */
  58 };
  59
  60 static const struct afb_verb_desc_v1 *search(struct api_so_v1 *desc, const char *name)
  61 {
  62         const struct afb_verb_desc_v1 *verb;
  63
  64         verb = desc->binding->v1.verbs;
  65         while (verb->name && strcasecmp(verb->name, name))
  66                 verb++;
  67         return verb->name ? verb : NULL;
  68 }
  69
  70 static void call_cb(void *closure, struct afb_xreq *xreq)
  71 {
  72         const struct afb_verb_desc_v1 *verb;
  73         struct api_so_v1 *desc = closure;
  74
  75         verb = search(desc, xreq->verb);
  76         afb_xreq_call_verb_v1(xreq, verb);
  77 }
  78
  79 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
  80 {
  81         int rc;
  82         int (*init)(struct afb_service service);
  83         void (*onevent)(const char *event, struct json_object *object);
  84
  85         struct api_so_v1 *desc = closure;
  86
  87         /* check state */
  88         if (desc->service != NULL) {
  89                 /* not an error when onneed */
  90                 if (onneed != 0)
  91                         return 0;
  92
  93                 /* already started: it is an error */
  94                 ERROR("Service %s already started", desc->binding->v1.prefix);
  95                 return -1;
  96         }
  97
  98         /* get the initialisation */
  99         init = dlsym(desc->handle, afb_api_so_v1_service_init);
 100         onevent = dlsym(desc->handle, afb_api_so_v1_service_event);
 101         if (init == NULL && onevent == NULL) {
 102                 /* not an error when onneed */
 103                 if (onneed != 0)
 104                         return 0;
 105
 106                 /* no initialisation method */
 107                 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
 108                 return -1;
 109         }
 110
 111         /* get the event handler if any */
 112         desc->service = afb_svc_create(desc->binding->v1.prefix, apiset, share_session, onevent, NULL);
 113         if (desc->service == NULL) {
 114                 ERROR("Creation of service %s failed", desc->binding->v1.prefix);
 115                 return -1;
 116         }
 117
 118         /* Starts the service */
 119         rc = afb_svc_start_v1(desc->service, init);
 120         if (rc < 0) {
 121                 /* initialisation error */
 122                 ERROR("Initialisation of service %s failed (%d): %m", desc->binding->v1.prefix, rc);
 123                 afb_svc_destroy(desc->service, NULL);
 124                 desc->service = NULL;
 125                 return rc;
 126         }
 127
 128         return 0;
 129 }
 130
 131 static void update_hooks_cb(void *closure)
 132 {
 133         struct api_so_v1 *desc = closure;
 134         afb_ditf_update_hook(&desc->ditf);
 135         if (desc->service)
 136                 afb_svc_update_hook(desc->service);
 137 }
 138
 139 static int get_verbosity_cb(void *closure)
 140 {
 141         struct api_so_v1 *desc = closure;
 142         return desc->interface.verbosity;
 143 }
 144
 145 static void set_verbosity_cb(void *closure, int level)
 146 {
 147         struct api_so_v1 *desc = closure;
 148         desc->interface.verbosity = level;
 149 }
 150
 151 static struct json_object *addperm(struct json_object *o, struct json_object *x)
 152 {
 153         struct json_object *a;
 154
 155         if (!o)
 156                 return x;
 157
 158         if (!json_object_object_get_ex(o, "allOf", &a)) {
 159                 a = json_object_new_array();
 160                 json_object_array_add(a, o);
 161                 o = json_object_new_object();
 162                 json_object_object_add(o, "allOf", a);
 163         }
 164         json_object_array_add(a, x);
 165         return o;
 166 }
 167
 168 static struct json_object *addperm_key_val(struct json_object *o, const char *key, struct json_object *val)
 169 {
 170         struct json_object *x = json_object_new_object();
 171         json_object_object_add(x, key, val);
 172         return addperm(o, x);
 173 }
 174
 175 static struct json_object *addperm_key_valstr(struct json_object *o, const char *key, const char *val)
 176 {
 177         return addperm_key_val(o, key, json_object_new_string(val));
 178 }
 179
 180 static struct json_object *addperm_key_valint(struct json_object *o, const char *key, int val)
 181 {
 182         return addperm_key_val(o, key, json_object_new_int(val));
 183 }
 184
 185 static struct json_object *make_description_openAPIv3(struct api_so_v1 *desc)
 186 {
 187         char buffer[256];
 188         const struct afb_verb_desc_v1 *verb;
 189         struct json_object *r, *f, *a, *i, *p, *g;
 190
 191         r = json_object_new_object();
 192         json_object_object_add(r, "openapi", json_object_new_string("3.0.0"));
 193
 194         i = json_object_new_object();
 195         json_object_object_add(r, "info", i);
 196         json_object_object_add(i, "title", json_object_new_string(desc->binding->v1.prefix));
 197         json_object_object_add(i, "version", json_object_new_string("0.0.0"));
 198         json_object_object_add(i, "description", json_object_new_string(desc->binding->v1.info ?: desc->binding->v1.prefix));
 199
 200         p = json_object_new_object();
 201         json_object_object_add(r, "paths", p);
 202         verb = desc->binding->v1.verbs;
 203         while (verb->name) {
 204                 buffer[0] = '/';
 205                 strncpy(buffer + 1, verb->name, sizeof buffer - 1);
 206                 buffer[sizeof buffer - 1] = 0;
 207                 f = json_object_new_object();
 208                 json_object_object_add(p, buffer, f);
 209                 g = json_object_new_object();
 210                 json_object_object_add(f, "get", g);
 211
 212                 a = NULL;
 213                 if (verb->session & AFB_SESSION_CLOSE_V1)
 214                         a = addperm_key_valstr(a, "session", "close");
 215                 if (verb->session & AFB_SESSION_CHECK_V1)
 216                         a = addperm_key_valstr(a, "session", "check");
 217                 if (verb->session & AFB_SESSION_RENEW_V1)
 218                         a = addperm_key_valstr(a, "token", "refresh");
 219                 if (verb->session & AFB_SESSION_LOA_MASK_V1)
 220                         a = addperm_key_valint(a, "LOA", (verb->session >> AFB_SESSION_LOA_SHIFT_V1) & AFB_SESSION_LOA_MASK_V1);
 221                 if (a)
 222                         json_object_object_add(g, "x-permissions", a);
 223
 224                 a = json_object_new_object();
 225                 json_object_object_add(g, "responses", a);
 226                 f = json_object_new_object();
 227                 json_object_object_add(a, "200", f);
 228                 json_object_object_add(f, "description", json_object_new_string(verb->info));
 229                 verb++;
 230         }
 231         return r;
 232 }
 233
 234 static struct json_object *describe_cb(void *closure)
 235 {
 236         struct api_so_v1 *desc = closure;
 237
 238         return make_description_openAPIv3(desc);
 239 }
 240
 241 static struct afb_api_itf so_v1_api_itf = {
 242         .call = call_cb,
 243         .service_start = service_start_cb,
 244         .update_hooks = update_hooks_cb,
 245         .get_verbosity = get_verbosity_cb,
 246         .set_verbosity = set_verbosity_cb,
 247         .describe = describe_cb
 248 };
 249
 250 int afb_api_so_v1_add(const char *path, void *handle, struct afb_apiset *apiset)
 251 {
 252         struct api_so_v1 *desc;
 253         struct afb_binding_v1 *(*register_function) (const struct afb_binding_interface_v1 *interface);
 254         struct afb_api afb_api;
 255
 256         /* retrieves the register function */
 257         register_function = dlsym(handle, afb_api_so_v1_register);
 258         if (!register_function)
 259                 return 0;
 260         INFO("binding [%s] is a valid AFB binding V1", path);
 261
 262         /* allocates the description */
 263         desc = calloc(1, sizeof *desc);
 264         if (desc == NULL) {
 265                 ERROR("out of memory");
 266                 goto error;
 267         }
 268         desc->handle = handle;
 269
 270         /* init the interface */
 271         afb_ditf_init_v1(&desc->ditf, path, &desc->interface);
 272
 273         /* init the binding */
 274         INFO("binding [%s] calling registering function %s", path, afb_api_so_v1_register);
 275         desc->binding = register_function(&desc->interface);
 276         if (desc->binding == NULL) {
 277                 ERROR("binding [%s] register function failed. continuing...", path);
 278                 goto error2;
 279         }
 280
 281         /* check the returned structure */
 282         if (desc->binding->type != AFB_BINDING_VERSION_1) {
 283                 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
 284                 goto error2;
 285         }
 286         if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
 287                 ERROR("binding [%s] bad prefix...", path);
 288                 goto error2;
 289         }
 290         if (!afb_api_is_valid_name(desc->binding->v1.prefix)) {
 291                 ERROR("binding [%s] invalid prefix...", path);
 292                 goto error2;
 293         }
 294         if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
 295                 ERROR("binding [%s] bad description...", path);
 296                 goto error2;
 297         }
 298         if (desc->binding->v1.verbs == NULL) {
 299                 ERROR("binding [%s] no APIs...", path);
 300                 goto error2;
 301         }
 302
 303         /* records the binding */
 304         afb_ditf_rename(&desc->ditf, desc->binding->v1.prefix);
 305         afb_api.closure = desc;
 306         afb_api.itf = &so_v1_api_itf;
 307         if (afb_apiset_add(apiset, desc->binding->v1.prefix, afb_api) < 0) {
 308                 ERROR("binding [%s] can't be registered...", path);
 309                 goto error2;
 310         }
 311         INFO("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);
 312         return 1;
 313
 314 error2:
 315         free(desc);
 316 error:
 317         return -1;
 318 }
 319