1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
|
/*
* Copyright (C) 2016, 2017 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#define _GNU_SOURCE
#define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
#include <string.h>
#include <dlfcn.h>
#include <assert.h>
#include <afb/afb-binding-v2.h>
#include <json-c/json.h>
#include "afb-api.h"
#include "afb-api-so-v2.h"
#include "afb-apiset.h"
#include "afb-svc.h"
#include "afb-ditf.h"
#include "afb-evt.h"
#include "afb-common.h"
#include "afb-context.h"
#include "afb-api-so.h"
#include "afb-xreq.h"
#include "jobs.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 {
const struct afb_binding_v2 *binding; /* descriptor */
struct afb_binding_data_v2 *data; /* data */
void *handle; /* context of dlopen */
struct afb_svc *service; /* handler for service started */
struct afb_ditf ditf; /* daemon interface */
};
static const struct afb_verb_v2 *search(struct api_so_v2 *desc, const char *name)
{
const struct afb_verb_v2 *verb;
verb = desc->binding->verbs;
while (verb->verb && strcasecmp(verb->verb, name))
verb++;
return verb->verb ? verb : NULL;
return NULL;
}
static void call_cb(void *closure, struct afb_xreq *xreq)
{
struct api_so_v2 *desc = closure;
const struct afb_verb_v2 *verb;
verb = search(desc, xreq->verb);
afb_xreq_call_verb_v2(xreq, verb);
}
struct call_sync
{
struct api_so_v2 *desc;
struct afb_xreq *xreq;
};
static void call_sync_cb_cb(int signum, void *closure)
{
struct call_sync *cs = closure;
if (!signum)
call_cb(cs->desc, cs->xreq);
else {
if (!cs->xreq->replied)
afb_xreq_fail(cs->xreq, "aborted", "internal error");
}
}
static void call_sync_cb(void *closure, struct afb_xreq *xreq)
{
struct call_sync cs = { .desc = closure, .xreq = xreq };
if (jobs_call(closure, 0, call_sync_cb_cb, &cs))
call_cb(closure, xreq);
}
static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
{
int (*start)();
void (*onevent)(const char *event, struct json_object *object);
struct api_so_v2 *desc = closure;
/* check state */
if (desc->service != NULL) {
/* not an error when onneed */
if (onneed != 0)
return 0;
/* already started: it is an error */
ERROR("Service %s already started", desc->binding->api);
return -1;
}
/* get the initialisation */
start = desc->binding->init;
onevent = desc->binding->onevent;
if (start == NULL && onevent == 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;
}
/* get the event handler if any */
desc->service = afb_svc_create_v2(apiset, share_session, start, onevent, desc->data);
if (desc->service == NULL) {
/* starting error */
ERROR("Starting service %s failed", desc->binding->api);
return -1;
}
return 0;
}
static void update_hooks_cb(void *closure)
{
struct api_so_v2 *desc = closure;
afb_ditf_update_hook(&desc->ditf);
}
static int get_verbosity_cb(void *closure)
{
struct api_so_v2 *desc = closure;
return desc->data->verbosity;
}
static void set_verbosity_cb(void *closure, int level)
{
struct api_so_v2 *desc = closure;
desc->data->verbosity = level;
}
static struct json_object *addperm(struct json_object *o, struct json_object *x)
{
struct json_object *a;
if (!o)
return x;
if (!json_object_object_get_ex(o, "allOf", &a)) {
a = json_object_new_array();
json_object_array_add(a, o);
o = json_object_new_object();
json_object_object_add(o, "allOf", a);
}
json_object_array_add(a, x);
return o;
}
static struct json_object *addperm_key_val(struct json_object *o, const char *key, struct json_object *val)
{
struct json_object *x = json_object_new_object();
json_object_object_add(x, key, val);
return addperm(o, x);
}
static struct json_object *addperm_key_valstr(struct json_object *o, const char *key, const char *val)
{
return addperm_key_val(o, key, json_object_new_string(val));
}
static struct json_object *addperm_key_valint(struct json_object *o, const char *key, int val)
{
return addperm_key_val(o, key, json_object_new_int(val));
}
static struct json_object *make_description(struct api_so_v2 *desc)
{
char buffer[256];
const struct afb_verb_v2 *verb;
struct json_object *r, *f, *a, *i, *p, *g;
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(desc->binding->api));
json_object_object_add(i, "version", json_object_new_string("0.0.0"));
p = json_object_new_object();
json_object_object_add(r, "paths", p);
verb = desc->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 = NULL;
if (verb->session & AFB_SESSION_CLOSE_V2)
a = addperm_key_valstr(a, "session", "close");
if (verb->session & AFB_SESSION_CHECK_V2)
a = addperm_key_valstr(a, "session", "check");
if (verb->session & AFB_SESSION_REFRESH_V2)
a = addperm_key_valstr(a, "token", "refresh");
if (verb->session & AFB_SESSION_LOA_MASK_V2)
a = addperm_key_valint(a, "LOA", verb->session & AFB_SESSION_LOA_MASK_V2);
#if 0
if (verb->auth)
a =
#endif
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->verb));
verb++;
}
return r;
}
static struct json_object *describe_cb(void *closure)
{
struct api_so_v2 *desc = closure;
struct json_object *r = desc->binding->specification ? json_tokener_parse(desc->binding->specification) : NULL;
if (!r)
r = make_description(desc);
return r;
}
static struct afb_api_itf so_v2_api_itf = {
.call = call_cb,
.service_start = service_start_cb,
.update_hooks = update_hooks_cb,
.get_verbosity = get_verbosity_cb,
.set_verbosity = set_verbosity_cb,
.describe = describe_cb
};
static struct afb_api_itf so_v2_sync_api_itf = {
.call = call_sync_cb,
.service_start = service_start_cb,
.update_hooks = update_hooks_cb,
.get_verbosity = get_verbosity_cb,
.set_verbosity = set_verbosity_cb,
.describe = describe_cb
};
int afb_api_so_v2_add_binding(const struct afb_binding_v2 *binding, void *handle, struct afb_apiset *apiset, struct afb_binding_data_v2 *data)
{
int rc;
struct api_so_v2 *desc;
struct afb_api afb_api;
/* basic checks */
assert(binding);
assert(binding->api);
assert(binding->verbs);
assert(data);
/* allocates the description */
desc = calloc(1, sizeof *desc);
if (desc == NULL) {
ERROR("out of memory");
goto error;
}
desc->binding = binding;
desc->data = data;
desc->handle = handle;
desc->service = NULL;
/* init the interface */
desc->data->verbosity = verbosity;
afb_ditf_init_v2(&desc->ditf, binding->api, data);
/* init the binding */
if (binding->preinit) {
INFO("binding %s calling preinit function", binding->api);
rc = binding->preinit();
if (rc < 0) {
ERROR("binding %s preinit function failed...", binding->api);
goto error2;
}
}
/* records the binding */
afb_api.closure = desc;
afb_api.itf = binding->noconcurrency ? &so_v2_sync_api_itf : &so_v2_api_itf;
if (afb_apiset_add(apiset, binding->api, afb_api) < 0) {
ERROR("binding %s can't be registered to set %s...", binding->api, afb_apiset_name(apiset));
goto error2;
}
INFO("binding %s added to set %s", binding->api, afb_apiset_name(apiset));
return 1;
error2:
free(desc);
error:
return -1;
}
int afb_api_so_v2_add(const char *path, void *handle, struct afb_apiset *apiset)
{
const struct afb_binding_v2 *binding;
struct afb_binding_data_v2 *data;
/* retrieves the register function */
binding = dlsym(handle, afb_api_so_v2_descriptor);
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_api_is_valid_name(binding->api)) {
ERROR("binding [%s] invalid api name...", path);
goto error;
}
#if 0
if (binding->specification == NULL || *binding->specification == 0) {
ERROR("binding [%s] bad specification...", path);
goto error;
}
#endif
if (binding->verbs == NULL) {
ERROR("binding [%s] no verbs...", path);
goto error;
}
return afb_api_so_v2_add_binding(binding, handle, apiset, data);
error:
return -1;
}
|