/*
- * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
+ * Copyright (C) 2015-2018 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
*/
#define _GNU_SOURCE
-#define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
#include <stdlib.h>
#include <stdio.h>
#include <getopt.h>
#include <limits.h>
#include <unistd.h>
+#include <ctype.h>
+
+#include <json-c/json.h>
#include "verbose.h"
#include "afb-config.h"
#include "afb-hook.h"
-#include <afb/afb-binding-v1.h>
-
#if !defined(BINDING_INSTALL_DIR)
#error "you should define BINDING_INSTALL_DIR"
#endif
+#if !defined(AFB_VERSION)
+#error "you should define AFB_VERSION"
+#endif
-#define AFB_VERSION "0.6"
+/* set the HAS_ options */
+#if defined(WITH_MONITORING_OPTION)
+# define HAS_MONITORING 1
+#else
+# define HAS_MONITORING 0
+#endif
+#if defined(WITH_DBUS_TRANSPARENCY)
+# define HAS_DBUS 1
+#else
+# define HAS_DBUS 0
+#endif
-// default
-#define DEFLT_CNTX_TIMEOUT 3600 // default Client Connection
- // Timeout
-#define DEFLT_API_TIMEOUT 20 // default Plugin API Timeout [0=NoLimit
- // for Debug Only]
-#define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache
- // [Client Side Cache
- // 100000~=1day]
-#define CTX_NBCLIENTS 10 // allow a default of 10 authenticated
- // clients
+/**
+ * The default timeout of sessions in seconds
+ */
+#define DEFAULT_SESSION_TIMEOUT 32000000
+/**
+ * The default timeout of api calls in seconds
+ */
+#define DEFAULT_API_TIMEOUT 20
+
+/**
+ * The default timeout of cache in seconds
+ */
+#define DEFAULT_CACHE_TIMEOUT 100000
+
+/**
+ * The default maximum count of sessions
+ */
+#define DEFAULT_MAX_SESSION_COUNT 200
// Define command line option
#define SET_BACKGROUND 2
#define SET_WEAK_LDPATH 16
#define NO_LDPATH 17
+#if defined(KEEP_LEGACY_MODE)
#define SET_MODE 18
+#endif
+
+#if HAS_DBUS
+# define DBUS_CLIENT 20
+# define DBUS_SERVICE 21
+#endif
-#define DBUS_CLIENT 20
-#define DBUS_SERVICE 21
-#define SO_BINDING 22
#define SET_SESSIONMAX 23
#define SET_NO_HTTPD 28
+#define AUTO_WS 'a'
+#define AUTO_LINK 'A'
+#define SO_BINDING 'b'
#define ADD_CALL 'c'
+#if !defined(REMOVE_LEGACY_TRACE)
#define SET_TRACEDITF 'D'
+#endif
#define SET_TRACEEVT 'E'
#define SET_EXEC 'e'
#define DISPLAY_HELP 'h'
-#if defined(WITH_MONITORING_OPTION)
-#define SET_MONITORING 'M'
+#define SET_LOG 'l'
+#define SET_TRACEAPI 'I'
+#if HAS_MONITORING
+# define SET_MONITORING 'M'
#endif
+#define SET_NAME 'n'
#define SET_TCP_PORT 'p'
#define SET_QUIET 'q'
#define SET_RNDTOKEN 'r'
+#if !defined(REMOVE_LEGACY_TRACE)
#define SET_TRACESVC 'S'
+#endif
+#define SET_TRACESES 's'
#define SET_TRACEREQ 'T'
#define SET_AUTH_TOKEN 't'
#define SET_UPLOAD_DIR 'u'
#define SET_WORK_DIR 'w'
const char shortopts[] =
- "c:D:E:ehp:qrT:t:u:Vvw:"
-#if defined(WITH_MONITORING_OPTION)
+ "a:A:b:c:"
+#if !defined(REMOVE_LEGACY_TRACE)
+ "D:"
+#endif
+ "E:ehl:n:p:qr"
+#if !defined(REMOVE_LEGACY_TRACE)
+ "S:"
+#endif
+ "s:T:t:u:Vvw:"
+#if HAS_MONITORING
"M"
#endif
;
/* *INDENT-OFF* */
{SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
{SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
+ {SET_LOG, 1, "log", "tune log level"},
{SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
{SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
+ {SET_NAME, 1, "name", "Set the visible name"},
+
{SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default 1234]"},
{SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
{SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
{SET_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
{NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
- {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=no-session, --token= for session without authentication]"},
+ {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=random, use --token="" to allow any token]"},
{SET_RNDTOKEN, 0, "random-token","Enforce a random token"},
{DISPLAY_VERSION, 0, "version", "Display version and copyright"},
{DISPLAY_HELP, 0, "help", "Display this help"},
+#if defined(KEEP_LEGACY_MODE)
{SET_MODE, 1, "mode", "Set the mode: either local, remote or global"},
+#endif
+#if HAS_DBUS
{DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
{DBUS_SERVICE, 1, "dbus-server", "Provides an afb service through dbus"},
+#endif
{WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
{WS_SERVICE, 1, "ws-server", "Provides an afb service through websockets"},
+ {AUTO_WS, 1, "auto-ws", "Automatic bind on need to remote service through websocket"},
+ {AUTO_LINK, 1, "auto-link", "Automatic load on need to binding shared objects"},
+
{SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
{SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
- {SET_TRACEDITF, 1, "traceditf", "Log the requests: no, common, extra, all"},
- {SET_TRACESVC, 1, "tracesvc", "Log the requests: no, all"},
- {SET_TRACEEVT, 1, "traceevt", "Log the requests: no, common, extra, all"},
+#if !defined(REMOVE_LEGACY_TRACE)
+ {SET_TRACEDITF, 1, "traceditf", "Log the daemons: no, common, all"},
+ {SET_TRACESVC, 1, "tracesvc", "Log the services: no, all"},
+#endif
+ {SET_TRACEEVT, 1, "traceevt", "Log the events: no, common, extra, all"},
+ {SET_TRACESES, 1, "traceses", "Log the sessions: no, all"},
+ {SET_TRACEAPI, 1, "traceapi", "Log the apis: no, common, api, event, all"},
{ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
{SET_NO_HTTPD, 0, "no-httpd", "Forbids HTTP service"},
{SET_EXEC, 0, "exec", "Execute the remaining arguments"},
-#if defined(WITH_MONITORING_OPTION)
+#if HAS_MONITORING
{SET_MONITORING, 0, "monitoring", "enable HTTP monitoring at <ROOT>/monitoring/"},
#endif
{0, 0, NULL, NULL}
{ NULL, 0 }
};
+#if !defined(REMOVE_LEGACY_TRACE)
static struct enumdesc traceditf_desc[] = {
{ "no", 0 },
- { "common", afb_hook_flags_ditf_common },
- { "extra", afb_hook_flags_ditf_extra },
- { "all", afb_hook_flags_ditf_all },
+ { "common", afb_hook_flags_api_ditf_common },
+ { "all", afb_hook_flags_api_ditf_all },
{ NULL, 0 }
};
static struct enumdesc tracesvc_desc[] = {
{ "no", 0 },
- { "all", afb_hook_flags_svc_all },
+ { "all", afb_hook_flags_api_svc_all },
{ NULL, 0 }
};
+#endif
static struct enumdesc traceevt_desc[] = {
{ "no", 0 },
{ NULL, 0 }
};
+static struct enumdesc traceses_desc[] = {
+ { "no", 0 },
+ { "common", afb_hook_flags_session_common },
+ { "all", afb_hook_flags_session_all },
+ { NULL, 0 }
+};
+
+static struct enumdesc traceapi_desc[] = {
+ { "no", 0 },
+ { "common", afb_hook_flags_api_common },
+ { "api", afb_hook_flags_api_api|afb_hook_flag_api_start },
+ { "event", afb_hook_flags_api_event|afb_hook_flag_api_start },
+ { "all", afb_hook_flags_api_all },
+ { NULL, 0 }
+};
+
+#if defined(KEEP_LEGACY_MODE)
+#include <afb/afb-binding-v1.h>
+
static struct enumdesc mode_desc[] = {
{ "local", AFB_MODE_LOCAL },
{ "remote", AFB_MODE_REMOTE },
{ "global", AFB_MODE_GLOBAL },
{ NULL, 0 }
};
+#endif
/*----------------------------------------------------------
| printversion
+--------------------------------------------------------- */
static void printVersion(FILE * file)
{
- fprintf(file, "\n----------------------------------------- \n");
- fprintf(file, " AFB [Application Framework Binder] version=%s |\n",
- AFB_VERSION);
- fprintf(file, " \n");
+ static char pm[2] = { '-', '+' };
+ fprintf(file,
+ "\n"
+ " AGL Framework Binder [AFB %s] %cDBUS %cMONITOR\n"
+ "\n",
+ AFB_VERSION,
+ pm[HAS_DBUS],
+ pm[HAS_MONITORING]
+ );
fprintf(file,
- " Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
- fprintf(file, " AFB comes with ABSOLUTELY NO WARRANTY.\n");
- fprintf(file, " Licence Apache 2\n\n");
+ " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
+ " AFB comes with ABSOLUTELY NO WARRANTY.\n"
+ " Licence Apache 2\n"
+ "\n");
}
/*----------------------------------------------------------
}
}
+static char **make_exec(char **argv)
+{
+ char **result, *iter;
+ size_t length;
+ int i;
+
+ length = 0;
+ for (i = 0 ; argv[i] ; i++)
+ length += strlen(argv[i]) + 1;
+
+ result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
+ if (result == NULL) {
+ ERROR("can't alloc memory");
+ exit(1);
+ }
+
+ iter = (char*)&result[i+1];
+ for (i = 0 ; argv[i] ; i++) {
+ result[i] = iter;
+ iter = stpcpy(iter, argv[i]) + 1;
+ }
+ result[i] = NULL;
+ return result;
+}
+
+/*---------------------------------------------------------
+ | set the log levels
+ +--------------------------------------------------------- */
+
+static void set_log(char *args)
+{
+ char o = 0, s, *p, *i = args;
+ int lvl;
+
+ for(;;) switch (*i) {
+ case 0:
+ return;
+ case '+':
+ case '-':
+ o = *i;
+ /*@fallthrough@*/
+ case ' ':
+ case ',':
+ i++;
+ break;
+ default:
+ p = i;
+ while (isalpha(*p)) p++;
+ s = *p;
+ *p = 0;
+ lvl = verbose_level_of_name(i);
+ if (lvl < 0) {
+ i = strdupa(p);
+ *p = s;
+ ERROR("Bad log name '%s' in %s", i, args);
+ exit(1);
+ }
+ *p = s;
+ i = p;
+ if (o == '-')
+ verbose_sub(lvl);
+ else {
+ if (!o) {
+ verbose_clear();
+ o = '+';
+ }
+ verbose_add(lvl);
+ }
+ break;
+ }
+}
+
/*---------------------------------------------------------
| Parse option and launch action
+--------------------------------------------------------- */
while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
switch (optc) {
case SET_VERBOSE:
- verbosity++;
+ verbose_inc();
break;
case SET_QUIET:
- verbosity--;
+ verbose_dec();
+ break;
+
+ case SET_LOG:
+ set_log(argvalstr(optc));
break;
case SET_TCP_PORT:
- config->httpdPort = argvalintdec(optc, 1024, 32767);
+ config->http_port = argvalintdec(optc, 1024, 32767);
break;
case SET_APITIMEOUT:
- config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
+ config->api_timeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_CNTXTIMEOUT:
- config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
+ config->session_timeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_ROOT_DIR:
break;
case SET_CACHE_TIMEOUT:
- config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
+ config->cache_timeout = argvalintdec(optc, 0, INT_MAX);
break;
case SET_SESSIONMAX:
- config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
+ config->max_session_count = argvalintdec(optc, 1, INT_MAX);
break;
case SET_FORGROUND:
config->background = 1;
break;
+ case SET_NAME:
+ config->name = argvalstr(optc);
+ break;
+
+#if defined(KEEP_LEGACY_MODE)
case SET_MODE:
config->mode = argvalenum(optc, mode_desc);
break;
+#endif
+#if HAS_DBUS
case DBUS_CLIENT:
list_add(&config->dbus_clients, argvalstr(optc));
break;
case DBUS_SERVICE:
list_add(&config->dbus_servers, argvalstr(optc));
break;
+#endif
case WS_CLIENT:
list_add(&config->ws_clients, argvalstr(optc));
list_add(&config->so_bindings, argvalstr(optc));
break;
+ case AUTO_WS:
+ list_add(&config->auto_ws, argvalstr(optc));
+ break;
+
+ case AUTO_LINK:
+ list_add(&config->auto_link, argvalstr(optc));
+ break;
+
case SET_TRACEREQ:
config->tracereq = argvalenum(optc, tracereq_desc);
break;
+#if !defined(REMOVE_LEGACY_TRACE)
case SET_TRACEDITF:
config->traceditf = argvalenum(optc, traceditf_desc);
break;
case SET_TRACESVC:
config->tracesvc = argvalenum(optc, tracesvc_desc);
break;
+#endif
case SET_TRACEEVT:
config->traceevt = argvalenum(optc, traceevt_desc);
break;
+ case SET_TRACESES:
+ config->traceses = argvalenum(optc, traceses_desc);
+ break;
+
+ case SET_TRACEAPI:
+ config->traceapi = argvalenum(optc, traceapi_desc);
+ break;
+
case SET_NO_HTTPD:
noarg(optc);
- config->noHttpd = 1;
+ config->no_httpd = 1;
break;
case SET_EXEC:
- config->exec = &argv[optind];
- optind = argc;
+ config->exec = make_exec(&argv[optind]);
+ optind = argc; /* stop option scanning */
break;
case SET_RNDTOKEN:
config->random_token = 1;
break;
-#if defined(WITH_MONITORING_OPTION)
+#if HAS_MONITORING
case SET_MONITORING:
config->monitoring = 1;
break;
static void fulfill_config(struct afb_config *config)
{
// default HTTP port
- if (config->httpdPort == 0)
- config->httpdPort = 1234;
+ if (config->http_port == 0)
+ config->http_port = 1234;
// default binding API timeout
- if (config->apiTimeout == 0)
- config->apiTimeout = DEFLT_API_TIMEOUT;
+ if (config->api_timeout == 0)
+ config->api_timeout = DEFAULT_API_TIMEOUT;
// default AUTH_TOKEN
if (config->random_token)
config->token = NULL;
// cache timeout default one hour
- if (config->cacheTimeout == 0)
- config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
+ if (config->cache_timeout == 0)
+ config->cache_timeout = DEFAULT_CACHE_TIMEOUT;
// cache timeout default one hour
- if (config->cntxTimeout == 0)
- config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
+ if (config->session_timeout == 0)
+ config->session_timeout = DEFAULT_SESSION_TIMEOUT;
// max count of sessions
- if (config->nbSessionMax == 0)
- config->nbSessionMax = CTX_NBCLIENTS;
+ if (config->max_session_count == 0)
+ config->max_session_count = DEFAULT_MAX_SESSION_COUNT;
/* set directories */
if (config->workdir == NULL)
if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
list_add(&config->ldpaths, BINDING_INSTALL_DIR);
-#if defined(WITH_MONITORING_OPTION)
+#if HAS_MONITORING
if (config->monitoring)
list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
#endif
strncpy(config->console, config->uploaddir, 512);
strncat(config->console, "/AFB-console.out", 512);
}
+
+#if !defined(REMOVE_LEGACY_TRACE)
+ config->traceapi |= config->traceditf | config->tracesvc;
+#endif
}
void afb_config_dump(struct afb_config *config)
#define PE P("\n")
#define S(x) PF(x);P("%s",NN(config->x));PE;
#define D(x) PF(x);P("%d",config->x);PE;
-#define H(x) PF(x);P("%x",config->x);PE;
#define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
#define L(x) PF(x);l=config->x;if(l){P("%s\n",NN(l->value));for(l=l->next;l;l=l->next)P("-- %15s %s\n","",NN(l->value));}else PE;
#define E(x,d) for(e=d;e->name&&e->value!=config->x;e++);if(e->name){PF(x);P("%s",e->name);PE;}else{D(x);}
S(workdir)
S(uploaddir)
S(token)
+ S(name)
L(aliases)
+#if HAS_DBUS
L(dbus_clients)
L(dbus_servers)
+#endif
L(ws_clients)
L(ws_servers)
L(so_bindings)
L(ldpaths)
+ L(weak_ldpaths)
L(calls)
V(exec)
- D(httpdPort)
- B(background)
- D(cacheTimeout)
- D(apiTimeout)
- D(cntxTimeout)
- D(nbSessionMax)
+ D(http_port)
+ D(cache_timeout)
+ D(api_timeout)
+ D(session_timeout)
+ D(max_session_count)
+
+#if defined(KEEP_LEGACY_MODE)
E(mode,mode_desc)
+#endif
E(tracereq,tracereq_desc)
+#if !defined(REMOVE_LEGACY_TRACE)
E(traceditf,traceditf_desc)
- B(noHttpd)
+ E(tracesvc,tracesvc_desc)
+#endif
+ E(traceevt,traceevt_desc)
+ E(traceses,traceses_desc)
+ E(traceapi,traceapi_desc)
+
+ B(no_ldpaths)
+ B(no_httpd)
+ B(background)
+#if HAS_MONITORING
+ B(monitoring)
+#endif
+ B(random_token)
P("---END-OF-CONFIG---\n");
#undef V
#undef E
#undef L
#undef B
-#undef H
#undef D
#undef S
#undef PE
#undef NN
}
+static void on_environment_list(struct afb_config_list **to, const char *name)
+{
+ char *value = getenv(name);
+
+ if (value)
+ list_add(to, value);
+}
+
+static void on_environment_enum(int *to, const char *name, struct enumdesc *desc)
+{
+ char *value = getenv(name);
+
+ if (value) {
+ while (desc->name) {
+ if (strcmp(desc->name, value))
+ desc++;
+ else {
+ *to = desc->value;
+ return;
+ }
+ }
+ WARNING("Unknown value %s for environment variable %s, ignored", value, name);
+ }
+}
+
+static void parse_environment(struct afb_config *config)
+{
+ on_environment_enum(&config->tracereq, "AFB_TRACEREQ", tracereq_desc);
+#if !defined(REMOVE_LEGACY_TRACE)
+ on_environment_enum(&config->traceditf, "AFB_TRACEDITF", traceditf_desc);
+ on_environment_enum(&config->tracesvc, "AFB_TRACESVC", tracesvc_desc);
+#endif
+ on_environment_enum(&config->traceevt, "AFB_TRACEEVT", traceevt_desc);
+ on_environment_enum(&config->traceses, "AFB_TRACESES", traceses_desc);
+ on_environment_enum(&config->traceapi, "AFB_TRACEAPI", traceapi_desc);
+ on_environment_list(&config->ldpaths, "AFB_LDPATHS");
+}
+
struct afb_config *afb_config_parse_arguments(int argc, char **argv)
{
struct afb_config *result;
result = calloc(1, sizeof *result);
+ parse_environment(result);
parse_arguments(argc, argv, result);
fulfill_config(result);
- if (verbosity >= 3)
+ if (verbose_wants(Log_Level_Info))
afb_config_dump(result);
return result;
}
+struct json_object *afb_config_json(struct afb_config *config)
+{
+ struct json_object *r, *a;
+ struct afb_config_list *l;
+ struct enumdesc *e;
+ char **v;
+
+#define XA(t,o) json_object_array_add(t,o);
+#define XO(t,x,o) json_object_object_add(t,x,o);
+#define YS(s) ((s)?json_object_new_string(s):NULL)
+
+#define AO(o) XA(a,o)
+#define AS(s) AO(YS(s))
+#define RO(x,o) XO(r,x,o)
+#define RS(x,s) RO(x,YS(s))
+#define RA(x) RO(x,(a=json_object_new_array()))
+#define RI(x,i) RO(x,json_object_new_int(i))
+#define RB(x,b) RO(x,json_object_new_boolean(b))
+
+#define S(x) RS(#x,config->x)
+#define V(x) RA(#x);for(v=config->x;v&&*v;v++)AS(*v);
+#define L(x) RA(#x);for(l=config->x;l;l=l->next)AS(l->value);
+#define D(x) RI(#x,config->x)
+#define B(x) RB(#x,config->x)
+#define E(x,d) for(e=d;e->name&&e->value!=config->x;e++);if(e->name){RS(#x,e->name);}else{D(x);}
+
+ r = json_object_new_object();
+ S(console)
+ S(rootdir)
+ S(roothttp)
+ S(rootbase)
+ S(rootapi)
+ S(workdir)
+ S(uploaddir)
+ S(token)
+ S(name)
+
+ L(aliases)
+#if HAS_DBUS
+ L(dbus_clients)
+ L(dbus_servers)
+#endif
+ L(ws_clients)
+ L(ws_servers)
+ L(so_bindings)
+ L(ldpaths)
+ L(weak_ldpaths)
+ L(calls)
+
+ V(exec)
+
+ D(http_port)
+ D(cache_timeout)
+ D(api_timeout)
+ D(session_timeout)
+ D(max_session_count)
+
+#if defined(KEEP_LEGACY_MODE)
+ E(mode,mode_desc)
+#endif
+ E(tracereq,tracereq_desc)
+#if !defined(REMOVE_LEGACY_TRACE)
+ E(traceditf,traceditf_desc)
+ E(tracesvc,tracesvc_desc)
+#endif
+ E(traceevt,traceevt_desc)
+ E(traceses,traceses_desc)
+ E(traceapi,traceapi_desc)
+
+ B(no_ldpaths)
+ B(no_httpd)
+ B(background)
+#if HAS_MONITORING
+ B(monitoring)
+#endif
+ B(random_token)
+
+#undef E
+#undef B
+#undef D
+#undef L
+#undef V
+#undef S
+
+#undef RB
+#undef RI
+#undef RA
+#undef RS
+#undef RS
+#undef AS
+#undef AO
+
+#undef YS
+#undef XO
+#undef XA
+
+ return r;
+}
+