2 * Copyright (C) 2016, 2017, 2018 "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.
26 #include <json-c/json.h>
28 #define AFB_BINDING_VERSION 0
29 #include <afb/afb-binding.h>
32 #include "afb-api-v3.h"
33 #include "afb-apiset.h"
35 #include "afb-export.h"
38 #include "sig-monitor.h"
41 * Description of a binding
46 struct afb_verb_v3 **verbs;
47 const struct afb_verb_v2 *verbsv2;
48 const struct afb_verb_v3 *verbsv3;
49 struct afb_export *export;
53 static const char nulchar = 0;
55 static int verb_name_compare(const struct afb_verb_v3 *verb, const char *name)
58 ? fnmatch(verb->verb, name, FNM_NOESCAPE|FNM_PATHNAME|FNM_CASEFOLD|FNM_PERIOD)
59 : strcasecmp(verb->verb, name);
62 static struct afb_verb_v3 *search_dynamic_verb(struct afb_api_v3 *api, const char *name)
64 struct afb_verb_v3 **v, **e, *i;
70 if (!verb_name_compare(i, name))
77 void afb_api_v3_process_call(struct afb_api_v3 *api, struct afb_xreq *xreq)
79 const struct afb_verb_v3 *verbsv3;
80 const struct afb_verb_v2 *verbsv2;
83 name = xreq->request.called_verb;
85 /* look first in dynamic set */
86 verbsv3 = search_dynamic_verb(api, name);
88 /* look then in static set */
89 verbsv3 = api->verbsv3;
93 else if (!verb_name_compare(verbsv3, name))
99 /* is it a v3 verb ? */
102 xreq->request.vcbdata = verbsv3->vcbdata;
103 afb_xreq_call_verb_v3(xreq, verbsv3);
107 /* look in legacy set */
108 verbsv2 = api->verbsv2;
110 while (verbsv2->verb) {
111 if (strcasecmp(verbsv2->verb, name))
114 afb_xreq_call_verb_v2(xreq, verbsv2);
120 afb_xreq_reply_unknown_verb(xreq);
123 struct json_object *afb_api_v3_make_description_openAPIv3(struct afb_api_v3 *api, const char *apiname)
126 struct afb_verb_v3 **iter, **end, *verb;
127 struct json_object *r, *f, *a, *i, *p, *g;
129 r = json_object_new_object();
130 json_object_object_add(r, "openapi", json_object_new_string("3.0.0"));
132 i = json_object_new_object();
133 json_object_object_add(r, "info", i);
134 json_object_object_add(i, "title", json_object_new_string(apiname));
135 json_object_object_add(i, "version", json_object_new_string("0.0.0"));
136 json_object_object_add(i, "description", json_object_new_string(api->info));
138 p = json_object_new_object();
139 json_object_object_add(r, "paths", p);
141 end = iter + api->count;
142 while (iter != end) {
145 strncpy(buffer + 1, verb->verb, sizeof buffer - 1);
146 buffer[sizeof buffer - 1] = 0;
147 f = json_object_new_object();
148 json_object_object_add(p, buffer, f);
149 g = json_object_new_object();
150 json_object_object_add(f, "get", g);
152 a = afb_auth_json_v2(verb->auth, verb->session);
154 json_object_object_add(g, "x-permissions", a);
156 a = json_object_new_object();
157 json_object_object_add(g, "responses", a);
158 f = json_object_new_object();
159 json_object_object_add(a, "200", f);
160 json_object_object_add(f, "description", json_object_new_string(verb->info?:verb->verb));
165 struct afb_api_v3 *afb_api_v3_create(
166 struct afb_apiset *declare_set,
167 struct afb_apiset *call_set,
171 int (*preinit)(void*, struct afb_api_x3 *),
176 struct afb_api_v3 *api;
178 /* allocates the description */
179 api = calloc(1, sizeof *api + (copy_info && info ? 1 + strlen(info) : 0));
184 api->info = &nulchar;
186 api->info = strcpy((char*)(api + 1), info);
190 api->export = afb_export_create_v3(declare_set, call_set, apiname, api);
194 if (afb_export_declare(api->export, noconcurrency) < 0)
197 if (preinit && afb_export_preinit_x3(api->export, preinit, closure) < 0)
203 afb_export_undeclare(api->export);
205 afb_export_unref(api->export);
209 ERROR("out of memory");
213 struct afb_api_v3 *afb_api_v3_addref(struct afb_api_v3 *api)
216 __atomic_add_fetch(&api->refcount, 1, __ATOMIC_RELAXED);
220 void afb_api_v3_unref(struct afb_api_v3 *api)
222 if (api && !__atomic_sub_fetch(&api->refcount, 1, __ATOMIC_RELAXED)) {
223 afb_export_destroy(api->export);
228 struct afb_export *afb_api_v3_export(struct afb_api_v3 *api)
233 void afb_api_v3_set_verbs_v2(
234 struct afb_api_v3 *api,
235 const struct afb_verb_v2 *verbs)
237 api->verbsv2 = verbs;
240 void afb_api_v3_set_verbs_v3(
241 struct afb_api_v3 *api,
242 const struct afb_verb_v3 *verbs)
244 api->verbsv3 = verbs;
247 int afb_api_v3_add_verb(
248 struct afb_api_v3 *api,
251 void (*callback)(struct afb_req_x2 *req),
253 const struct afb_auth *auth,
257 struct afb_verb_v3 *v, **vv;
261 for (i = 0 ; i < api->count ; i++) {
263 if (glob == v->glob && !strcasecmp(verb, v->verb)) {
264 /* refuse to redefine a dynamic verb */
270 vv = realloc(api->verbs, (1 + api->count) * sizeof *vv);
275 v = malloc(sizeof *v + (1 + strlen(verb)) + (info ? 1 + strlen(info) : 0));
279 v->callback = callback;
280 v->vcbdata = vcbdata;
282 v->session = session;
285 txt = (char*)(v + 1);
287 txt = stpcpy(txt, verb);
295 api->verbs[api->count++] = v;
302 int afb_api_v3_del_verb(
303 struct afb_api_v3 *api,
307 struct afb_verb_v3 **v, **e, *i;
313 if (!strcasecmp(i->verb, verb)) {
316 *vcbdata = i->vcbdata;
328 int afb_api_v3_set_binding_fields(const struct afb_binding_v3 *desc, struct afb_api_x3 *api)
332 rc = afb_api_x3_set_verbs_v3(api, desc->verbs);
333 if (!rc && desc->onevent)
334 rc = afb_api_x3_on_event(api, desc->onevent);
335 if (!rc && desc->init)
336 rc = afb_api_x3_on_init(api, desc->init);
337 if (!rc && desc->provide_class)
338 rc = afb_api_x3_provide_class(api, desc->provide_class);
339 if (!rc && desc->require_class)
340 rc = afb_api_x3_require_class(api, desc->require_class);
341 if (!rc && desc->require_api)
342 rc = afb_api_x3_require_api(api, desc->require_api, 1);
346 struct safe_preinit_data
348 int (*preinit)(struct afb_api_x3 *);
349 struct afb_api_x3 *api;
353 static void safe_preinit(int sig, void *closure)
355 struct safe_preinit_data *spd = closure;
357 spd->result = spd->preinit(spd->api);
364 int afb_api_v3_safe_preinit(struct afb_api_x3 *api, int (*preinit)(struct afb_api_x3 *))
366 struct safe_preinit_data spd;
368 spd.preinit = preinit;
370 sig_monitor(60, safe_preinit, &spd);
374 static int init_binding(void *closure, struct afb_api_x3 *api)
376 const struct afb_binding_v3 *desc = closure;
377 int rc = afb_api_v3_set_binding_fields(desc, api);
378 if (!rc && desc->preinit)
379 rc = afb_api_v3_safe_preinit(api, desc->preinit);
383 struct afb_api_v3 *afb_api_v3_from_binding(const struct afb_binding_v3 *desc, struct afb_apiset *declare_set, struct afb_apiset * call_set)
385 return afb_api_v3_create(declare_set, call_set, desc->api, desc->info, desc->noconcurrency, init_binding, (void*)desc, 0);