2 * Copyright (C) 2016 "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 NO_PLUGIN_VERBOSE_MACRO
28 #include <sys/types.h>
31 #include <afb/afb-plugin.h>
32 #include <afb/afb-req-itf.h>
35 #include "afb-common.h"
36 #include "afb-context.h"
38 #include "afb-api-so.h"
39 #include "afb-sig-handler.h"
43 * Description of a plugin
46 struct AFB_plugin *plugin; /* descriptor */
47 size_t apilength; /* length of the API name */
48 void *handle; /* context of dlopen */
49 struct AFB_interface interface; /* interface for the plugin */
52 static int api_timeout = 15;
54 static const char plugin_register_function_v1[] = "pluginAfbV1Register";
56 void afb_api_so_set_timeout(int to)
61 static int afb_api_so_event_broadcast(struct api_so_desc *desc, const char *name, struct json_object *object)
66 assert(desc->plugin != NULL);
67 length = strlen(name);
68 event = alloca(length + 2 + desc->apilength);
69 memcpy(event, desc->plugin->v1.prefix, desc->apilength);
70 event[desc->apilength] = '/';
71 memcpy(event + desc->apilength + 1, name, length + 1);
72 return ctxClientEventSend(NULL, event, object);
75 static void afb_api_so_vverbose(struct api_so_desc *desc, int level, const char *file, int line, const char *fmt, va_list args)
79 if (vasprintf(&p, fmt, args) < 0)
80 vverbose(level, file, line, fmt, args);
82 verbose(level, file, line, "%s {plugin %s}", p, desc->plugin->v1.prefix);
87 static const struct afb_daemon_itf daemon_itf = {
88 .event_broadcast = (void*)afb_api_so_event_broadcast,
89 .get_event_loop = (void*)afb_common_get_event_loop,
90 .get_user_bus = (void*)afb_common_get_user_bus,
91 .get_system_bus = (void*)afb_common_get_system_bus,
92 .vverbose = (void*)afb_api_so_vverbose
97 void (*action)(struct afb_req);
100 static void monitored_call(int signum, struct monitoring *data)
103 afb_req_fail_f(data->req, "aborted", "signal %s(%d) caught", strsignal(signum), signum);
105 data->action(data->req);
108 static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb)
110 struct monitoring data;
112 int stag = (int)verb->session;
114 if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
115 if (!afb_context_check(context)) {
116 afb_context_close(context);
117 afb_req_fail(req, "failed", "invalid token's identity");
122 if ((stag & AFB_SESSION_CREATE) != 0) {
123 if (afb_context_check_loa(context, 1)) {
124 afb_req_fail(req, "failed", "invalid creation state");
127 afb_context_change_loa(context, 1);
128 afb_context_refresh(context);
131 if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
132 afb_context_refresh(context);
134 if ((stag & AFB_SESSION_CLOSE) != 0) {
135 afb_context_change_loa(context, 0);
136 afb_context_close(context);
139 if ((stag & AFB_SESSION_LOA_GE) != 0) {
140 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
141 if (!afb_context_check_loa(context, loa)) {
142 afb_req_fail(req, "failed", "invalid LOA");
147 if ((stag & AFB_SESSION_LOA_LE) != 0) {
148 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
149 if (afb_context_check_loa(context, loa + 1)) {
150 afb_req_fail(req, "failed", "invalid LOA");
156 data.action = verb->callback;
157 afb_sig_monitor((void*)monitored_call, &data, api_timeout);
160 static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
162 const struct AFB_verb_desc_v1 *v;
164 v = desc->plugin->v1.verbs;
165 while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
168 call_check(req, context, v);
170 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->v1.prefix);
173 int afb_api_so_add_plugin(const char *path)
177 struct api_so_desc *desc;
178 struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface);
180 // This is a loadable library let's check if it's a plugin
182 handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
183 if (handle == NULL) {
184 ERROR("plugin [%s] not loadable", path);
188 /* retrieves the register function */
189 pluginAfbV1RegisterFct = dlsym(handle, plugin_register_function_v1);
190 if (!pluginAfbV1RegisterFct) {
191 ERROR("plugin [%s] is not an AFB plugin", path);
194 INFO("plugin [%s] is a valid AFB plugin", path);
197 /* allocates the description */
198 desc = calloc(1, sizeof *desc);
200 ERROR("out of memory");
203 desc->handle = handle;
205 /* init the interface */
206 desc->interface.verbosity = verbosity;
207 desc->interface.mode = AFB_MODE_LOCAL;
208 desc->interface.daemon.itf = &daemon_itf;
209 desc->interface.daemon.closure = desc;
211 /* init the plugin */
212 NOTICE("plugin [%s] calling registering function %s", path, plugin_register_function_v1);
213 desc->plugin = pluginAfbV1RegisterFct(&desc->interface);
214 if (desc->plugin == NULL) {
215 ERROR("plugin [%s] register function failed. continuing...", path);
219 /* check the returned structure */
220 if (desc->plugin->type != AFB_PLUGIN_VERSION_1) {
221 ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type);
224 if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) {
225 ERROR("plugin [%s] bad prefix...", path);
228 if (!afb_apis_is_valid_api_name(desc->plugin->v1.prefix)) {
229 ERROR("plugin [%s] invalid prefix...", path);
232 if (desc->plugin->v1.info == NULL || *desc->plugin->v1.info == 0) {
233 ERROR("plugin [%s] bad description...", path);
236 if (desc->plugin->v1.verbs == NULL) {
237 ERROR("plugin [%s] no APIs...", path);
241 /* records the plugin */
242 desc->apilength = strlen(desc->plugin->v1.prefix);
243 if (afb_apis_add(desc->plugin->v1.prefix, (struct afb_api){
245 .call = (void*)call}) < 0) {
246 ERROR("plugin [%s] can't be registered...", path);
249 NOTICE("plugin %s loaded with API prefix %s", path, desc->plugin->v1.prefix);
260 static int adddirs(char path[PATH_MAX], size_t end)
263 struct dirent ent, *result;
266 /* open the DIR now */
269 ERROR("can't scan plugin directory %s, %m", path);
272 INFO("Scanning dir=[%s] for plugins", path);
274 /* scan each entry */
278 readdir_r(dir, &ent, &result);
282 len = strlen(ent.d_name);
283 if (len + end >= PATH_MAX) {
284 ERROR("path too long while scanning plugins for %s", ent.d_name);
287 memcpy(&path[end], ent.d_name, len+1);
288 if (ent.d_type == DT_DIR) {
289 /* case of directories */
290 if (ent.d_name[0] == '.') {
293 if (ent.d_name[1] == '.' && len == 2)
296 adddirs(path, end+len);;
297 } else if (ent.d_type == DT_REG) {
299 if (!strstr(ent.d_name, ".so"))
301 if (afb_api_so_add_plugin(path) < 0)
309 int afb_api_so_add_directory(const char *path)
312 char buffer[PATH_MAX];
314 length = strlen(path);
315 if (length >= sizeof(buffer)) {
316 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
320 memcpy(buffer, path, length + 1);
321 return adddirs(buffer, length);
324 int afb_api_so_add_path(const char *path)
329 rc = stat(path, &st);
331 ERROR("Invalid plugin path [%s]: %m", path);
332 else if (S_ISDIR(st.st_mode))
333 rc = afb_api_so_add_directory(path);
334 else if (strstr(path, ".so"))
335 rc = afb_api_so_add_plugin(path);
337 INFO("not a plugin [%s], skipped", path);
341 int afb_api_so_add_pathset(const char *pathset)
343 static char sep[] = ":";
346 ps = strdupa(pathset);
348 p = strsep(&ps, sep);
351 if (afb_api_so_add_path(p) < 0)