X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-apis.c;h=ba8e0ddce61bbafc7db4df2744e2acbc09405417;hb=b529ded85a3e50a1aa6529e870b2e2f43e377ca2;hp=561b2752bf20cbeb5d1131c81f7569bb5552f5ed;hpb=83ce3b29a598141f8f28afde655beb07ec78c312;p=src%2Fapp-framework-binder.git diff --git a/src/afb-apis.c b/src/afb-apis.c index 561b2752..ba8e0ddc 100644 --- a/src/afb-apis.c +++ b/src/afb-apis.c @@ -1,127 +1,311 @@ /* - * Copyright (C) 2016 "IoT.bzh" + * Copyright (C) 2016, 2017 "IoT.bzh" * Author "Fulup Ar Foll" * Author José Bollo * - * 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 . - * - * 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 #include -#include #include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "afb-plugin.h" -#include "afb-req-itf.h" -#include "afb-poll-itf.h" - -#include "session.h" -#include "afb-apis.h" +#include + +#include "afb-session.h" #include "verbose.h" -#include "utils-upoll.h" +#include "afb-apis.h" +#include "afb-context.h" +#include "afb-xreq.h" +#include "jobs.h" + +#include +/** + * Internal description of an api + */ struct api_desc { - struct afb_api api; - const char *name; - size_t namelen; + const char *name; /**< name of the api */ + struct afb_api api; /**< handler of the api */ }; static struct api_desc *apis_array = NULL; static int apis_count = 0; +static int apis_timeout = 15; -int afb_apis_count() +/** + * Set the API timeout + * @param to the timeout in seconds + */ +void afb_apis_set_timeout(int to) { - return apis_count; + apis_timeout = to; } -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) { - const struct afb_api *api; - api = &apis_array[apiidx].api; - api->free_context(api->closure, 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; } +/** + * 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; - size_t len; - int i; + int i, c; - /* check existing or not */ - len = strlen(name); - if (len == 0) { - fprintf(stderr, "empty api name forbidden\n"); + /* 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; } /* check previously existing plugin */ for (i = 0 ; i < apis_count ; i++) { - if (!strcasecmp(apis_array[i].name, name)) { - fprintf(stderr, "ERROR: api of name %s already exists\n", name); + 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; } /* allocates enough memory */ apis = realloc(apis_array, ((unsigned)apis_count + 1) * sizeof * apis); if (apis == NULL) { - fprintf(stderr, "out of memory\n"); + ERROR("out of memory"); + errno = ENOMEM; goto error; } apis_array = apis; + /* copy higher part of the array */ + c = apis_count; + while (c > i) { + apis_array[c] = apis_array[c - 1]; + c--; + } + /* record the plugin */ - apis = &apis_array[apis_count]; + apis = &apis_array[i]; apis->api = api; - apis->namelen = len; apis->name = name; apis_count++; + NOTICE("API %s added", name); + return 0; error: return -1; } -void afb_apis_call(struct afb_req req, struct AFB_clientCtx *context, const char *api, size_t lenapi, const char *verb, size_t lenverb) +/** + * 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 i; + int i, c, up, lo; const struct api_desc *a; - a = apis_array; - for (i = 0 ; i < apis_count ; i++, a++) { - if (a->namelen == lenapi && !strncasecmp(a->name, api, lenapi)) { - req.context = &context->contexts[i]; - a->api.call(a->api.closure, req, verb, lenverb); - return; + /* dichotomic search of the api */ + /* initial slice */ + lo = 0; + up = apis_count; + for (;;) { + /* check remaining slice */ + if (lo >= up) { + /* not found */ + return NULL; + } + /* 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; + } +} + +/** + * 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) +{ + int i; + + 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); + } + ERROR("can't find service %s", api); + errno = ENOENT; + return -1; +} + +/** + * 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) +{ + int i, rc; + + 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; +} + +/** + * Internal direct dispatch of the request 'xreq' + * @param xreq the request to dispatch + */ +static void do_call_direct(struct afb_xreq *xreq) +{ + const struct api_desc *a; + + /* 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.call(a->api.closure, xreq); + } +} + +/** + * Asynchronous dispatch callback for the request 'xreq' + * @param signum 0 on normal flow or the signal number that interupted the normal flow + */ +static void do_call_async(int signum, void *arg) +{ + struct afb_xreq *xreq = arg; + + if (signum != 0) + afb_xreq_fail_f(xreq, "aborted", "signal %s(%d) caught", strsignal(signum), signum); + else { + do_call_direct(xreq); + } + afb_xreq_unref(xreq); +} + +/** + * Dispatch the request 'xreq' synchronously and directly. + * @param xreq the request to dispatch + */ +void afb_apis_call_direct(struct afb_xreq *xreq) +{ + afb_xreq_begin(xreq); + do_call_direct(xreq); +} + +/** + * Dispatch the request 'xreq' asynchronously. + * @param xreq the request to dispatch + */ +void afb_apis_call(struct afb_xreq *xreq) +{ + int rc; + + afb_xreq_begin(xreq); + afb_xreq_addref(xreq); + rc = jobs_queue(NULL, apis_timeout, do_call_async, xreq); + if (rc < 0) { + /* TODO: allows or not to proccess it directly as when no threading? (see above) */ + ERROR("can't process job with threads: %m"); + afb_xreq_fail_f(xreq, "cancelled", "not able to create a job for the task"); + afb_xreq_unref(xreq); + } +} + +/** + * Ask to update the hook flags + */ +void afb_apis_update_hooks() +{ + const struct api_desc *i, *e; + + i = apis_array; + e = &apis_array[apis_count]; + while (i != e) { + if (i->api.update_hooks) + i->api.update_hooks(i->api.closure); + i++; } - afb_req_fail(req, "fail", "api not found"); }