/*
- * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Copyright (C) 2015-2020 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* limitations under the License.
*/
+#if WITH_LEGACY_BINDING_V2 && WITH_DYNAMIC_BINDING
+
#define _GNU_SOURCE
-#define NO_BINDING_VERBOSE_MACRO
+#include <stdlib.h>
#include <string.h>
#include <dlfcn.h>
#include <assert.h>
+#include <stdarg.h>
+#include <errno.h>
-#include <afb/afb-binding.h>
+#include <json-c/json.h>
+#include <afb/afb-binding-v2.h>
-#include "afb-apis.h"
-#include "afb-svc.h"
+#include "afb-api.h"
+#include "afb-api-so-v2.h"
+#include "afb-apiset.h"
+#include "afb-auth.h"
+#include "afb-export.h"
#include "afb-evt.h"
-#include "afb-common.h"
#include "afb-context.h"
#include "afb-api-so.h"
-#include "afb-thread.h"
#include "afb-xreq.h"
+#include "sig-monitor.h"
#include "verbose.h"
/*
* names of symbols
*/
static const char afb_api_so_v2_descriptor[] = "afbBindingV2";
+static const char afb_api_so_v2_data[] = "afbBindingV2data";
-/*
- * Description of a binding
- */
-struct api_so_v2 {
- struct afb_binding_v2 *binding; /* descriptor */
- size_t apilength; /* length of the API name */
- void *handle; /* context of dlopen */
- struct afb_svc *service; /* handler for service started */
- struct afb_binding_interface interface; /* interface for the binding */
-};
-
-static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name);
-static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object);
-static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args);
-static int afb_api_so_rootdir_get_fd(void *closure);
-static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale);
-
-static const struct afb_daemon_itf daemon_itf = {
- .event_broadcast = afb_api_so_event_broadcast_cb,
- .get_event_loop = afb_common_get_event_loop,
- .get_user_bus = afb_common_get_user_bus,
- .get_system_bus = afb_common_get_system_bus,
- .vverbose = afb_api_so_vverbose_cb,
- .event_make = afb_api_so_event_make_cb,
- .rootdir_get_fd = afb_api_so_rootdir_get_fd,
- .rootdir_open_locale = afb_api_so_rootdir_open_locale
-};
-
-static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name)
-{
- size_t length;
- char *event;
- struct api_so_v2 *desc = closure;
-
- /* makes the event name */
- assert(desc->binding != NULL);
- length = strlen(name);
- event = alloca(length + 2 + desc->apilength);
- memcpy(event, desc->binding->api, desc->apilength);
- event[desc->apilength] = '/';
- memcpy(event + desc->apilength + 1, name, length + 1);
-
- /* crate the event */
- return afb_evt_create_event(event);
-}
-
-static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object)
-{
- size_t length;
- char *event;
- struct api_so_v2 *desc = closure;
-
- /* makes the event name */
- assert(desc->binding != NULL);
- length = strlen(name);
- event = alloca(length + 2 + desc->apilength);
- memcpy(event, desc->binding->api, desc->apilength);
- event[desc->apilength] = '/';
- memcpy(event + desc->apilength + 1, name, length + 1);
-
- return afb_evt_broadcast(event, object);
-}
-
-static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args)
-{
- char *p;
- struct api_so_v2 *desc = closure;
-
- if (vasprintf(&p, fmt, args) < 0)
- vverbose(level, file, line, fmt, args);
- else {
- verbose(level, file, line, "%s {binding %s}", p, desc->binding->api);
- free(p);
- }
-}
-
-static int afb_api_so_rootdir_get_fd(void *closure)
-{
- return afb_common_rootdir_get_fd();
-}
-
-static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale)
+struct preinit
{
- return afb_common_rootdir_open_locale(filename, flags, locale);
-}
+ int return_code;
+ const struct afb_binding_v2 *binding;
+};
-static int call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_v2 *verb)
+static const struct afb_verb_v2 *search(const struct afb_binding_v2 *binding, const char *name)
{
- int stag = (int)verb->session;
-
- if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
- if (!afb_context_check(context)) {
- afb_context_close(context);
- afb_req_fail(req, "failed", "invalid token's identity");
- return 0;
- }
- }
-
- if ((stag & AFB_SESSION_CREATE) != 0) {
- if (afb_context_check_loa(context, 1)) {
- afb_req_fail(req, "failed", "invalid creation state");
- return 0;
- }
- afb_context_change_loa(context, 1);
- afb_context_refresh(context);
- }
-
- if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
- afb_context_refresh(context);
-
- if ((stag & AFB_SESSION_CLOSE) != 0) {
- afb_context_change_loa(context, 0);
- afb_context_close(context);
- }
-
- if ((stag & AFB_SESSION_LOA_GE) != 0) {
- int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
- if (!afb_context_check_loa(context, loa)) {
- afb_req_fail(req, "failed", "invalid LOA");
- return 0;
- }
- }
+ const struct afb_verb_v2 *verb;
- if ((stag & AFB_SESSION_LOA_LE) != 0) {
- int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
- if (afb_context_check_loa(context, loa + 1)) {
- afb_req_fail(req, "failed", "invalid LOA");
- return 0;
- }
- }
- return 1;
+ verb = binding->verbs;
+ while (verb->verb && strcasecmp(verb->verb, name))
+ verb++;
+ return verb->verb ? verb : NULL;
+ return NULL;
}
-static const struct afb_verb_v2 *search(struct api_so_v2 *desc, const char *verb)
+void afb_api_so_v2_process_call(const struct afb_binding_v2 *binding, struct afb_xreq *xreq)
{
- const struct afb_verb_v2 *result;
+ const struct afb_verb_v2 *verb;
- result = desc->binding->verbs;
- while (result->verb && strcasecmp(result->verb, verb))
- result++;
- return result->verb ? result : NULL;
+ verb = search(binding, xreq->request.called_verb);
+ afb_xreq_call_verb_v2(xreq, verb);
}
-static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *name)
+struct json_object *afb_api_so_v2_make_description_openAPIv3(const struct afb_binding_v2 *binding, const char *apiname)
{
- struct api_so_v2 *desc = closure;
+ char buffer[256];
const struct afb_verb_v2 *verb;
-
- verb = search(desc, name);
- if (!verb)
- afb_req_fail_f(req, "unknown-verb", "verb %s unknown within api %s", name, desc->binding->api);
- else if (call_check(req, context, verb)) {
- afb_thread_req_call(req, verb->callback, afb_api_so_timeout, desc);
- }
+ struct json_object *r, *f, *a, *i, *p, *g;
+ enum json_tokener_error jerr;
+
+ if (binding->specification) {
+ r = json_tokener_parse_verbose(binding->specification, &jerr);
+ if (jerr == json_tokener_success)
+ return r;
+ }
+
+ r = json_object_new_object();
+ json_object_object_add(r, "openapi", json_object_new_string("3.0.0"));
+
+ i = json_object_new_object();
+ json_object_object_add(r, "info", i);
+ json_object_object_add(i, "title", json_object_new_string(apiname));
+ json_object_object_add(i, "version", json_object_new_string("0.0.0"));
+ json_object_object_add(i, "description", json_object_new_string(binding->info ?: apiname));
+
+ p = json_object_new_object();
+ json_object_object_add(r, "paths", p);
+ verb = binding->verbs;
+ while (verb->verb) {
+ buffer[0] = '/';
+ strncpy(buffer + 1, verb->verb, sizeof buffer - 1);
+ buffer[sizeof buffer - 1] = 0;
+ f = json_object_new_object();
+ json_object_object_add(p, buffer, f);
+ g = json_object_new_object();
+ json_object_object_add(f, "get", g);
+
+ a = afb_auth_json_x2(verb->auth, verb->session);
+ if (a)
+ json_object_object_add(g, "x-permissions", a);
+
+ a = json_object_new_object();
+ json_object_object_add(g, "responses", a);
+ f = json_object_new_object();
+ json_object_object_add(a, "200", f);
+ json_object_object_add(f, "description", json_object_new_string(verb->info?:verb->verb));
+ verb++;
+ }
+ return r;
}
-static void xcall_cb(void *closure, struct afb_xreq *xreq)
+static void do_preinit(int sig, void *closure)
{
- struct api_so_v2 *desc = closure;
- const struct afb_verb_v2 *verb;
+ struct preinit *preinit = closure;
- verb = search(desc, xreq->verb);
- if (!verb)
- afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, desc->binding->api);
+ if (!sig)
+ preinit->return_code = preinit->binding->preinit();
else {
- xreq->timeout = afb_api_so_timeout;
- xreq->sessionflags = (int)verb->session;
- xreq->group = desc;
- xreq->callback = verb->callback;
- afb_xreq_call(xreq);
+ errno = EINTR;
+ preinit->return_code = -1;
}
-}
+};
-static int service_start_cb(void *closure, int share_session, int onneed)
+int afb_api_so_v2_add_binding(
+ const struct afb_binding_v2 *binding,
+ void *handle,
+ struct afb_apiset *declare_set,
+ struct afb_apiset * call_set,
+ struct afb_binding_data_v2 *data,
+ const char *path)
{
- int (*start)(const struct afb_binding_interface *interface, struct afb_service service);
- void (*onevent)(const char *event, struct json_object *object);
-
- struct api_so_v2 *desc = closure;
+ int rc;
+ struct afb_export *export;
+ struct preinit preinit;
- /* check state */
- if (desc->service != NULL) {
- /* not an error when onneed */
- if (onneed != 0)
- return 0;
+ /* basic checks */
+ assert(binding);
+ assert(binding->api);
+ assert(binding->verbs);
+ assert(data);
- /* already started: it is an error */
- ERROR("Service %s already started", desc->binding->api);
- return -1;
+ /* allocates the description */
+ export = afb_export_create_v2(declare_set, call_set, binding->api, binding, data, binding->init, binding->onevent, path);
+ if (!export) {
+ ERROR("out of memory");
+ goto error;
}
- /* get the initialisation */
- start = desc->binding->start;
- if (start == NULL) {
- /* not an error when onneed */
- if (onneed != 0)
- return 0;
-
- /* no initialisation method */
- ERROR("Binding %s is not a service", desc->binding->api);
- return -1;
+ /* records the binding */
+ if (afb_export_declare(export, binding->noconcurrency) < 0) {
+ ERROR("binding %s can't be registered to set %s...", afb_export_apiname(export), afb_apiset_name(declare_set));
+ goto error;
}
-
- /* get the event handler if any */
- onevent = desc->binding->onevent;
- desc->service = afb_svc_create_v2(share_session, onevent, start, &desc->interface);
- if (desc->service == NULL) {
- /* starting error */
- ERROR("Starting service %s failed", desc->binding->api);
- return -1;
+ /* init the binding */
+ if (binding->preinit) {
+ INFO("binding %s calling preinit function", binding->api);
+ preinit.binding = binding;
+ sig_monitor(0, do_preinit, &preinit);
+ rc = preinit.return_code;
+ if (rc < 0) {
+ ERROR("binding %s preinit function failed...", afb_export_apiname(export));
+ afb_export_undeclare(export);
+ goto error;
+ }
}
- return 0;
+ INFO("binding %s added to set %s", afb_export_apiname(export), afb_apiset_name(declare_set));
+ return 1;
+
+error:
+ afb_export_unref(export);
+
+ return -1;
}
-int afb_api_so_v2_add(const char *path, void *handle)
+int afb_api_so_v2_add(const char *path, void *handle, struct afb_apiset *declare_set, struct afb_apiset * call_set)
{
- int rc;
- struct api_so_v2 *desc;
- struct afb_binding_v2 *binding;
+ const struct afb_binding_v2 *binding;
+ struct afb_binding_data_v2 *data;
/* retrieves the register function */
binding = dlsym(handle, afb_api_so_v2_descriptor);
- if (!binding)
+ data = dlsym(handle, afb_api_so_v2_data);
+ if (!binding && !data)
return 0;
INFO("binding [%s] looks like an AFB binding V2", path);
/* basic checks */
+ if (!binding || !data) {
+ ERROR("binding [%s] incomplete symbol set: %s is missing",
+ path, binding ? afb_api_so_v2_data : afb_api_so_v2_descriptor);
+ goto error;
+ }
if (binding->api == NULL || *binding->api == 0) {
ERROR("binding [%s] bad api name...", path);
goto error;
}
- if (!afb_apis_is_valid_api_name(binding->api)) {
+ if (!afb_api_is_valid_name(binding->api)) {
ERROR("binding [%s] invalid api name...", path);
goto error;
}
- if (binding->specification == NULL || *binding->specification == 0) {
- ERROR("binding [%s] bad specification...", path);
- goto error;
- }
+
if (binding->verbs == NULL) {
ERROR("binding [%s] no verbs...", path);
goto error;
}
- /* allocates the description */
- desc = calloc(1, sizeof *desc);
- if (desc == NULL) {
- ERROR("out of memory");
- goto error;
- }
- desc->binding = binding;
- desc->handle = handle;
-
- /* init the interface */
- desc->interface.verbosity = verbosity;
- desc->interface.mode = AFB_MODE_LOCAL;
- desc->interface.daemon.itf = &daemon_itf;
- desc->interface.daemon.closure = desc;
-
- /* for log purpose, a fake binding is needed here */
+ return afb_api_so_v2_add_binding(binding, handle, declare_set, call_set, data, path);
- /* init the binding */
- if (binding->init) {
- NOTICE("binding %s [%s] calling init function", binding->api, path);
- rc = binding->init(&desc->interface);
- if (rc < 0) {
- ERROR("binding %s [%s] initialisation function failed...", binding->api, path);
- goto error2;
- }
- }
-
- /* records the binding */
- desc->apilength = strlen(binding->api);
- if (afb_apis_add(binding->api, (struct afb_api){
- .closure = desc,
- .call = call_cb,
- .xcall = xcall_cb,
- .service_start = service_start_cb }) < 0) {
- ERROR("binding [%s] can't be registered...", path);
- goto error2;
- }
- NOTICE("binding %s loaded with API prefix %s", path, binding->api);
- return 1;
-
-error2:
- free(desc);
-error:
+ error:
return -1;
}
+#endif
Code Review / src / app-framework-binder.git / blobdiff