2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
26 #include <json-c/json.h>
28 #include <afb/afb-binding-v1.h>
31 #include "afb-api-so-v1.h"
32 #include "afb-apiset.h"
35 #include "afb-common.h"
36 #include "afb-context.h"
37 #include "afb-api-so.h"
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";
50 * Description of a binding
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 */
60 static const struct afb_verb_desc_v1 *search(struct api_so_v1 *desc, const char *name)
62 const struct afb_verb_desc_v1 *verb;
64 verb = desc->binding->v1.verbs;
65 while (verb->name && strcasecmp(verb->name, name))
67 return verb->name ? verb : NULL;
70 static void call_cb(void *closure, struct afb_xreq *xreq)
72 const struct afb_verb_desc_v1 *verb;
73 struct api_so_v1 *desc = closure;
75 verb = search(desc, xreq->verb);
76 afb_xreq_call_verb_v1(xreq, verb);
79 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
81 int (*init)(struct afb_service service);
82 void (*onevent)(const char *event, struct json_object *object);
84 struct api_so_v1 *desc = closure;
87 if (desc->service != NULL) {
88 /* not an error when onneed */
92 /* already started: it is an error */
93 ERROR("Service %s already started", desc->binding->v1.prefix);
97 /* get the initialisation */
98 init = dlsym(desc->handle, afb_api_so_v1_service_init);
99 onevent = dlsym(desc->handle, afb_api_so_v1_service_event);
100 if (init == NULL && onevent == NULL) {
101 /* not an error when onneed */
105 /* no initialisation method */
106 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
110 /* get the event handler if any */
111 desc->service = afb_svc_create_v1(apiset, share_session, init, onevent);
112 if (desc->service == NULL) {
114 ERROR("Starting service %s failed", desc->binding->v1.prefix);
121 static void update_hooks_cb(void *closure)
123 struct api_so_v1 *desc = closure;
124 afb_ditf_update_hook(&desc->ditf);
127 static int get_verbosity_cb(void *closure)
129 struct api_so_v1 *desc = closure;
130 return desc->interface.verbosity;
133 static void set_verbosity_cb(void *closure, int level)
135 struct api_so_v1 *desc = closure;
136 desc->interface.verbosity = level;
139 struct json_object *describe_cb(void *closure)
141 struct api_so_v1 *desc = closure;
142 const struct afb_verb_desc_v1 *verb;
143 struct json_object *r, *v, *f, *a;
145 r = json_object_new_object();
146 json_object_object_add(r, "version", json_object_new_int(1));
147 json_object_object_add(r, "info", json_object_new_string(desc->binding->v1.info));
148 v = json_object_new_object();
149 json_object_object_add(r, "verbs", v);
150 verb = desc->binding->v1.verbs;
152 f = json_object_new_object();
153 a = json_object_new_array();
154 json_object_object_add(f, "name", json_object_new_string(verb->name));
155 json_object_object_add(f, "info", json_object_new_string(verb->info));
156 if (verb->session & AFB_SESSION_CLOSE_V1)
157 json_object_array_add(a, json_object_new_string("session-close"));
158 if (verb->session & AFB_SESSION_RENEW_V1)
159 json_object_array_add(a, json_object_new_string("session-renew"));
160 if (verb->session & AFB_SESSION_CHECK_V1)
161 json_object_array_add(a, json_object_new_string("session-check"));
162 if (verb->session & AFB_SESSION_LOA_EQ_V1) {
163 const char *rel = "?";
165 switch (verb->session & AFB_SESSION_LOA_EQ_V1) {
166 case AFB_SESSION_LOA_GE_V1: rel = ">="; break;
167 case AFB_SESSION_LOA_LE_V1: rel = "<="; break;
168 case AFB_SESSION_LOA_EQ_V1: rel = "=="; break;
170 snprintf(buffer, sizeof buffer, "LOA%s%d", rel, (int)((verb->session >> AFB_SESSION_LOA_SHIFT_V1) & AFB_SESSION_LOA_MASK_V1));
171 json_object_array_add(a, json_object_new_string(buffer));
173 json_object_object_add(f, "flags", a);
174 json_object_object_add(v, verb->name, f);
180 static struct afb_api_itf so_v1_api_itf = {
182 .service_start = service_start_cb,
183 .update_hooks = update_hooks_cb,
184 .get_verbosity = get_verbosity_cb,
185 .set_verbosity = set_verbosity_cb,
186 .describe = describe_cb
189 int afb_api_so_v1_add(const char *path, void *handle, struct afb_apiset *apiset)
191 struct api_so_v1 *desc;
192 struct afb_binding_v1 *(*register_function) (const struct afb_binding_interface_v1 *interface);
193 struct afb_api afb_api;
195 /* retrieves the register function */
196 register_function = dlsym(handle, afb_api_so_v1_register);
197 if (!register_function)
199 INFO("binding [%s] is a valid AFB binding V1", path);
201 /* allocates the description */
202 desc = calloc(1, sizeof *desc);
204 ERROR("out of memory");
207 desc->handle = handle;
209 /* init the interface */
210 afb_ditf_init_v1(&desc->ditf, path, &desc->interface);
212 /* init the binding */
213 INFO("binding [%s] calling registering function %s", path, afb_api_so_v1_register);
214 desc->binding = register_function(&desc->interface);
215 if (desc->binding == NULL) {
216 ERROR("binding [%s] register function failed. continuing...", path);
220 /* check the returned structure */
221 if (desc->binding->type != AFB_BINDING_VERSION_1) {
222 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
225 if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
226 ERROR("binding [%s] bad prefix...", path);
229 if (!afb_api_is_valid_name(desc->binding->v1.prefix)) {
230 ERROR("binding [%s] invalid prefix...", path);
233 if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
234 ERROR("binding [%s] bad description...", path);
237 if (desc->binding->v1.verbs == NULL) {
238 ERROR("binding [%s] no APIs...", path);
242 /* records the binding */
243 afb_ditf_rename(&desc->ditf, desc->binding->v1.prefix);
244 afb_api.closure = desc;
245 afb_api.itf = &so_v1_api_itf;
246 if (afb_apiset_add(apiset, desc->binding->v1.prefix, afb_api) < 0) {
247 ERROR("binding [%s] can't be registered...", path);
250 INFO("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);