/*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2016, 2017 "IoT.bzh"
* Author "Fulup Ar Foll"
* Author José Bollo <jose.bollo@iot.bzh>
*
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
+ * 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
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- * Contain all generic part to handle REST/API
- *
- * https://www.gnu.org/software/libmicrohttpd/tutorial.html [search 'largepost.c']
+ * 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
+#include <stdlib.h>
#include <stdio.h>
-#include <assert.h>
#include <string.h>
-#include <dirent.h>
-#include <dlfcn.h>
-#include <unistd.h>
-#include <limits.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <signal.h>
-#include <time.h>
-#include <sys/syscall.h>
-#include <setjmp.h>
+#include <errno.h>
-#include "local-def.h"
-
-#include "afb-plugin.h"
-#include "afb-req-itf.h"
-#include "session.h"
+#include "afb-session.h"
+#include "verbose.h"
#include "afb-apis.h"
+#include "afb-context.h"
+#include "afb-hook.h"
+#include "afb-xreq.h"
+
+#include <afb/afb-req-itf.h>
+/**
+ * Internal description of an api
+ */
struct api_desc {
- struct AFB_plugin *plugin; /* descriptor */
- size_t prefixlen;
- const char *prefix;
- void *handle; /* context of dlopen */
- struct AFB_interface *interface;
+ const char *name; /**< name of the api */
+ struct afb_api api; /**< handler of the api */
};
-static int api_timeout = 15;
static struct api_desc *apis_array = NULL;
static int apis_count = 0;
-static const char plugin_register_function[] = "pluginRegister";
-
-int afb_apis_count()
-{
- return apis_count;
-}
-
-void afb_apis_free_context(int apiidx, void *context)
+/**
+ * Checks wether 'name' is a valid API name.
+ * @return 1 if valid, 0 otherwise
+ */
+int afb_apis_is_valid_api_name(const char *name)
{
- void (*cb)(void*);
-
- assert(0 <= apiidx && apiidx < apis_count);
- cb = apis_array[apiidx].plugin->freeCtxCB;
- if (cb)
- cb(context);
- else
- free(context);
+ unsigned char c;
+
+ c = (unsigned char)*name;
+ if (c == 0)
+ /* empty names aren't valid */
+ return 0;
+
+ do {
+ if (c < (unsigned char)'\x80') {
+ switch(c) {
+ default:
+ if (c > ' ')
+ break;
+ case '"':
+ case '#':
+ case '%':
+ case '&':
+ case '\'':
+ case '/':
+ case '?':
+ case '`':
+ case '\\':
+ case '\x7f':
+ return 0;
+ }
+ }
+ c = (unsigned char)*++name;
+ } while(c != 0);
+ return 1;
}
-int afb_apis_add_plugin(const char *path)
+/**
+ * Adds the api of 'name' described by 'api'.
+ * @param name the name of the api to add (have to survive, not copied!)
+ * @param api the api
+ * @returns 0 in case of success or -1 in case
+ * of error with errno set:
+ * - EINVAL if name isn't valid
+ * - EEXIST if name already registered
+ * - ENOMEM when out of memory
+ */
+int afb_apis_add(const char *name, struct afb_api api)
{
struct api_desc *apis;
- struct AFB_plugin *plugin;
- struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
- struct AFB_interface *interface;
- void *handle;
- int i;
+ int i, c;
- // This is a loadable library let's check if it's a plugin
- handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
- if (handle == NULL) {
- fprintf(stderr, "[%s] not loadable, continuing...\n", path);
+ /* Checks the api name */
+ if (!afb_apis_is_valid_api_name(name)) {
+ ERROR("invalid api name forbidden (name is '%s')", name);
+ errno = EINVAL;
goto error;
}
- /* retrieves the register function */
- pluginRegisterFct = dlsym(handle, plugin_register_function);
- if (!pluginRegisterFct) {
- fprintf(stderr, "[%s] not an AFB plugin, continuing...\n", path);
- goto error2;
+ /* check previously existing plugin */
+ for (i = 0 ; i < apis_count ; i++) {
+ c = strcasecmp(apis_array[i].name, name);
+ if (c == 0) {
+ ERROR("api of name %s already exists", name);
+ errno = EEXIST;
+ goto error;
+ }
+ if (c > 0)
+ break;
}
- if (verbose)
- fprintf(stderr, "[%s] is a valid AFB plugin\n", path);
/* allocates enough memory */
apis = realloc(apis_array, ((unsigned)apis_count + 1) * sizeof * apis);
if (apis == NULL) {
- fprintf(stderr, "ERROR: plugin [%s] memory missing. continuing...\n", path);
- goto error2;
+ ERROR("out of memory");
+ errno = ENOMEM;
+ goto error;
}
apis_array = apis;
- /* allocates the interface */
- interface = calloc(1, sizeof *interface);
- if (interface == NULL) {
- fprintf(stderr, "ERROR: plugin [%s] memory missing. continuing...\n", path);
- goto error2;
- }
- interface->verbose = 0;
- interface->mode = AFB_MODE_LOCAL;
-
- /* init the plugin */
- plugin = pluginRegisterFct(interface);
- if (plugin == NULL) {
- fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path);
- goto error3;
- }
-
- /* check the returned structure */
- if (plugin->type != AFB_PLUGIN_JSON) {
- fprintf(stderr, "ERROR: plugin [%s] invalid type %d...\n", path, plugin->type);
- goto error3;
- }
- if (plugin->prefix == NULL || *plugin->prefix == 0) {
- fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
- goto error3;
- }
- if (plugin->info == NULL || *plugin->info == 0) {
- fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path);
- goto error3;
- }
- if (plugin->apis == NULL) {
- fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
- goto error3;
- }
-
- /* check previously existing plugin */
- for (i = 0 ; i < apis_count ; i++) {
- if (!strcasecmp(apis_array[i].prefix, plugin->prefix)) {
- fprintf(stderr, "ERROR: plugin [%s] prefix %s duplicated...\n", path, plugin->prefix);
- goto error2;
- }
+ /* copy higher part of the array */
+ c = apis_count;
+ while (c > i) {
+ apis_array[c] = apis_array[c - 1];
+ c--;
}
/* record the plugin */
- if (verbose)
- fprintf(stderr, "Loading plugin[%lu] prefix=[%s] info=%s\n", (unsigned long)apis_count, plugin->prefix, plugin->info);
- apis = &apis_array[apis_count];
- apis->plugin = plugin;
- apis->prefixlen = strlen(plugin->prefix);
- apis->prefix = plugin->prefix;
- apis->handle = handle;
- apis->interface = interface;
+ apis = &apis_array[i];
+ apis->api = api;
+ apis->name = name;
apis_count++;
return 0;
-error3:
- free(interface);
-error2:
- dlclose(handle);
error:
return -1;
}
-static int adddirs(char path[PATH_MAX], size_t end)
+/**
+ * Search the 'api'.
+ * @param api the api of the verb
+ * @return the descriptor if found or NULL otherwise
+ */
+static const struct api_desc *search(const char *api)
{
- int rc;
- DIR *dir;
- struct dirent ent, *result;
- size_t len;
-
- /* open the DIR now */
- dir = opendir(path);
- if (dir == NULL) {
- fprintf(stderr, "ERROR in scanning plugin directory %s, %m\n", path);
- return -1;
- }
- if (verbose)
- fprintf(stderr, "Scanning dir=[%s] for plugins\n", path);
+ int i, c, up, lo;
+ const struct api_desc *a;
- /* scan each entry */
- if (end)
- path[end++] = '/';
+ /* dichotomic search of the api */
+ /* initial slice */
+ lo = 0;
+ up = apis_count;
for (;;) {
- readdir_r(dir, &ent, &result);
- if (result == NULL)
- break;
-
- len = strlen(ent.d_name);
- if (len + end >= PATH_MAX) {
- fprintf(stderr, "path too long for %s\n", ent.d_name);
- continue;
+ /* check remaining slice */
+ if (lo >= up) {
+ /* not found */
+ return NULL;
}
- memcpy(&path[end], ent.d_name, len+1);
- if (ent.d_type == DT_DIR) {
- /* case of directories */
- if (ent.d_name[0] == '.') {
- if (len == 1)
- continue;
- if (ent.d_name[1] == '.' && len == 2)
- continue;
- }
- rc = adddirs(path, end+len);;
- } else if (ent.d_type == DT_REG) {
- /* case of files */
- if (!strstr(ent.d_name, ".so"))
- continue;
- rc = afb_apis_add_plugin(path);
+ /* check the mid of the slice */
+ i = (lo + up) >> 1;
+ a = &apis_array[i];
+ c = strcasecmp(a->name, api);
+ if (c == 0) {
+ /* found */
+ return a;
}
+ /* update the slice */
+ if (c < 0)
+ lo = i + 1;
+ else
+ up = i;
}
- closedir(dir);
- return 0;
}
-int afb_apis_add_directory(const char *path)
-{
- size_t length;
- char buffer[PATH_MAX];
-
- length = strlen(path);
- if (length >= sizeof(buffer)) {
- fprintf(stderr, "path too long %lu [%.99s...]\n", (unsigned long)length, path);
- return -1;
- }
-
- memcpy(buffer, path, length + 1);
- return adddirs(buffer, length);
-}
-
-int afb_apis_add_path(const char *path)
+/**
+ * Dispatch the request 'req' with the 'context' to the
+ * method of 'api' and 'verb'.
+ * @param req the request to dispatch
+ * @param context the context of the request
+ * @param api the api of the verb
+ * @param verb the verb within the api
+ */
+void afb_apis_call(struct afb_req req, struct afb_context *context, const char *api, const char *verb)
{
- struct stat st;
- int rc;
+ const struct api_desc *a;
- rc = stat(path, &st);
- if (rc < 0)
- fprintf(stderr, "Invalid plugin path [%s]: %m\n", path);
- else if (S_ISDIR(st.st_mode))
- rc = afb_apis_add_directory(path);
- else
- rc = afb_apis_add_plugin(path);
- return rc;
-}
+ /* init hooking the request */
+ req = afb_hook_req_call(req, context, api, verb);
-int afb_apis_add_pathset(const char *pathset)
-{
- static char sep[] = ":";
- char *ps, *p;
- int rc;
-
- ps = strdupa(pathset);
- for (;;) {
- p = strsep(&ps, sep);
- if (!p)
- return 0;
- rc = afb_apis_add_path(p);
- };
+ /* search the api */
+ a = search(api);
+ if (!a)
+ afb_req_fail(req, "fail", "api not found");
+ else {
+ context->api_key = a->api.closure;
+ a->api.call(a->api.closure, req, context, verb);
+ }
}
-// Check of apiurl is declare in this plugin and call it
-extern __thread sigjmp_buf *error_handler;
-static void trapping_handle(struct afb_req req, void(*cb)(struct afb_req))
+/**
+ * Starts a service by its 'api' name.
+ * @param api name of the service to start
+ * @param share_session if true start the servic"e in a shared session
+ * if false start it in its own session
+ * @param onneed if true start the service if possible, if false the api
+ * must be a service
+ * @return a positive number on success
+ */
+int afb_apis_start_service(const char *api, int share_session, int onneed)
{
- volatile int signum, timerset;
- timer_t timerid;
- sigjmp_buf jmpbuf, *older;
- struct sigevent sevp;
- struct itimerspec its;
-
- // save context before calling the API
- timerset = 0;
- older = error_handler;
- signum = setjmp(jmpbuf);
- if (signum != 0) {
- afb_req_fail_f(req, "aborted", "signal %d caught", signum);
- }
- else {
- error_handler = &jmpbuf;
- if (api_timeout > 0) {
- timerset = 1; /* TODO: check statuses */
- sevp.sigev_notify = SIGEV_THREAD_ID;
- sevp.sigev_signo = SIGALRM;
-#if defined(sigev_notify_thread_id)
- sevp.sigev_notify_thread_id = (pid_t)syscall(SYS_gettid);
-#else
- sevp._sigev_un._tid = (pid_t)syscall(SYS_gettid);
-#endif
- timer_create(CLOCK_THREAD_CPUTIME_ID, &sevp, &timerid);
- its.it_interval.tv_sec = 0;
- its.it_interval.tv_nsec = 0;
- its.it_value.tv_sec = api_timeout;
- its.it_value.tv_nsec = 0;
- timer_settime(timerid, 0, &its, NULL);
- }
+ int i;
- cb(req);
+ for (i = 0 ; i < apis_count ; i++) {
+ if (!strcasecmp(apis_array[i].name, api))
+ return apis_array[i].api.service_start(apis_array[i].api.closure, share_session, onneed);
}
- if (timerset)
- timer_delete(timerid);
- error_handler = older;
+ ERROR("can't find service %s", api);
+ errno = ENOENT;
+ return -1;
}
-static void handle(struct afb_req req, const struct AFB_restapi *verb)
+/**
+ * Starts all possible services but stops at first error.
+ * @param share_session if true start the servic"e in a shared session
+ * if false start it in its own session
+ * @return 0 on success or a negative number when an error is found
+ */
+int afb_apis_start_all_services(int share_session)
{
- switch(verb->session) {
- case AFB_SESSION_CREATE:
- if (!afb_req_session_create(req))
- return;
- break;
- case AFB_SESSION_RENEW:
- if (!afb_req_session_check(req, 1))
- return;
- break;
- case AFB_SESSION_CLOSE:
- case AFB_SESSION_CHECK:
- if (!afb_req_session_check(req, 0))
- return;
- break;
- case AFB_SESSION_NONE:
- default:
- break;
- }
- trapping_handle(req, verb->callback);
+ int i, rc;
- if (verb->session == AFB_SESSION_CLOSE)
- afb_req_session_close(req);
+ for (i = 0 ; i < apis_count ; i++) {
+ rc = apis_array[i].api.service_start(apis_array[i].api.closure, share_session, 1);
+ if (rc < 0)
+ return rc;
+ }
+ return 0;
}
-int afb_apis_handle(struct afb_req req, struct AFB_clientCtx *context, const char *api, size_t lenapi, const char *verb, size_t lenverb)
+/**
+ * Dispatch the request 'req' with the 'context' to the
+ * method of 'api' and 'verb'.
+ * @param req the request to dispatch
+ * @param context the context of the request
+ * @param api the api of the verb
+ * @param verb the verb within the api
+ */
+void afb_apis_xcall(struct afb_xreq *xreq)
{
- int i, j;
const struct api_desc *a;
- const struct AFB_restapi *v;
- a = apis_array;
- for (i = 0 ; i < apis_count ; i++, a++) {
- if (a->prefixlen == lenapi && !strncasecmp(a->prefix, api, lenapi)) {
- v = a->plugin->apis;
- for (j = 0 ; v->name ; j++, v++) {
- if (!strncasecmp(v->name, verb, lenverb) && !v->name[lenverb]) {
- req.context = context->contexts[i];
- handle(req, v);
- context->contexts[i] = req.context;
- return 1;
- }
- }
- afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, a->prefix);
- return 1;
- }
+ /* init hooking the request */
+ // TODO req = afb_hook_req_call(req, context, api, verb);
+
+ /* search the api */
+ a = search(xreq->api);
+ if (!a)
+ afb_xreq_fail_f(xreq, "unknown-api", "api %s not found", xreq->api);
+ else {
+ xreq->context.api_key = a->api.closure;
+ a->api.xcall(a->api.closure, xreq);
}
- return 0;
}