/*
- * 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");
#include <getopt.h>
#include <limits.h>
#include <unistd.h>
+#include <ctype.h>
#include <json-c/json.h>
#include "afb-config.h"
#include "afb-hook.h"
-#include <afb/afb-binding-v1.h>
+#define _d2s_(x) #x
+#define d2s(x) _d2s_(x)
#if !defined(BINDING_INSTALL_DIR)
#error "you should define BINDING_INSTALL_DIR"
#error "you should define AFB_VERSION"
#endif
-// default
-#define DEFLT_CNTX_TIMEOUT 32000000 // default Client Connection
- // Timeout: few more than one year
-#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
+/* 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
+
+/**
+ * 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
+
+/**
+ * The default HTTP port to serve
+ */
+#define DEFAULT_HTTP_PORT 1234
+
+
+
// Define command line option
-#define SET_BACKGROUND 2
-#define SET_FORGROUND 3
+#define SET_BACKGROUND 1
+#define SET_FORGROUND 2
+#define SET_ROOT_DIR 3
+#define SET_ROOT_BASE 4
+#define SET_ROOT_API 5
+#define SET_ALIAS 6
+
+#define SET_CACHE_TIMEOUT 7
-#define SET_ROOT_DIR 6
-#define SET_ROOT_BASE 7
-#define SET_ROOT_API 8
-#define SET_ALIAS 9
+#define AUTO_WS 8
+#define AUTO_LINK 9
-#define SET_CACHE_TIMEOUT 10
-#define SET_SESSION_DIR 11
+#define SET_LDPATH 10
+#define SET_APITIMEOUT 11
+#define SET_CNTXTIMEOUT 12
+#define SET_WEAK_LDPATH 13
+#define NO_LDPATH 14
-#define SET_LDPATH 13
-#define SET_APITIMEOUT 14
-#define SET_CNTXTIMEOUT 15
-#define SET_WEAK_LDPATH 16
-#define NO_LDPATH 17
+#define SET_SESSIONMAX 15
-#define SET_MODE 18
+#define WS_CLIENT 16
+#define WS_SERVICE 17
-#define DBUS_CLIENT 20
-#define DBUS_SERVICE 21
-#define SO_BINDING 22
+#define SET_ROOT_HTTP 18
-#define SET_SESSIONMAX 23
+#define SET_NO_HTTPD 19
-#define WS_CLIENT 24
-#define WS_SERVICE 25
+#define SET_TRACEEVT 20
+#define SET_TRACESES 21
+#define SET_TRACEREQ 22
+#define SET_TRACEAPI 23
+#if !defined(REMOVE_LEGACY_TRACE)
+#define SET_TRACEDITF 24
+#define SET_TRACESVC 25
+#endif
-#define SET_ROOT_HTTP 26
+#if HAS_DBUS
+# define DBUS_CLIENT 30
+# define DBUS_SERVICE 31
+#endif
-#define SET_NO_HTTPD 28
+#define AUTO_API 'A'
+#define SO_BINDING 'b'
#define ADD_CALL 'c'
-#define SET_TRACEDITF 'D'
-#define SET_TRACEEVT 'E'
#define SET_EXEC 'e'
#define DISPLAY_HELP 'h'
-#if defined(WITH_MONITORING_OPTION)
+#define SET_LOG 'l'
+#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'
-#define SET_TRACESVC 'S'
-#define SET_TRACESES 's'
-#define SET_TRACEREQ 'T'
#define SET_AUTH_TOKEN 't'
#define SET_UPLOAD_DIR 'u'
#define DISPLAY_VERSION 'V'
#define SET_WORK_DIR 'w'
const char shortopts[] =
- "c:D:E:ehn:p:qrS:s:T:t:u:Vvw:"
-#if defined(WITH_MONITORING_OPTION)
+ "A:"
+ "b:"
+ "c:"
+ "e"
+ "h"
+ "l:"
+#if HAS_MONITORING
"M"
#endif
+ "n:"
+ "p:"
+ "q"
+ "r"
+ "t:"
+ "u:"
+ "V"
+ "v"
+ "w:"
;
// Command line structure hold cli --command + help text
/* *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_TCP_PORT, 1, "port", "HTTP listening TCP port [default " d2s(DEFAULT_HTTP_PORT) "]"},
{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_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
{SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
- {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default 10]"},
- {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
- {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default 3600]"},
+ {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default " d2s(DEFAULT_API_TIMEOUT) "]"},
+ {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default " d2s(DEFAULT_SESSION_TIMEOUT) "]"},
+ {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default " d2s(DEFAULT_CACHE_TIMEOUT) "]"},
{SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
{SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
{SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
- {SET_SESSION_DIR, 1, "sessiondir", "OBSOLETE (was: Sessions file path)"},
{SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
{SO_BINDING, 1, "binding", "Load the binding of path"},
{DISPLAY_VERSION, 0, "version", "Display version and copyright"},
{DISPLAY_HELP, 0, "help", "Display this help"},
- {SET_MODE, 1, "mode", "Set the mode: either local, remote or global"},
-
+#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"},
+ {DBUS_SERVICE, 1, "dbus-server", "Provide 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"},
+ {WS_SERVICE, 1, "ws-server", "Provide an afb service through websockets"},
+
+ {AUTO_API, 1, "auto-api", "Automatic load of api of the given directory"},
- {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
+ {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default " d2s(DEFAULT_MAX_SESSION_COUNT) "]"},
{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_NO_HTTPD, 0, "no-httpd", "Forbid HTTP service"},
{SET_EXEC, 0, "exec", "Execute the remaining arguments"},
-#if defined(WITH_MONITORING_OPTION)
- {SET_MONITORING, 0, "monitoring", "enable HTTP monitoring at <ROOT>/monitoring/"},
+#if HAS_MONITORING
+ {SET_MONITORING, 0, "monitoring", "Enable HTTP monitoring at <ROOT>/monitoring/"},
#endif
{0, 0, NULL, NULL}
/* *INDENT-ON* */
{ 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 mode_desc[] = {
- { "local", AFB_MODE_LOCAL },
- { "remote", AFB_MODE_REMOTE },
- { "global", AFB_MODE_GLOBAL },
+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 }
};
+--------------------------------------------------------- */
static void printVersion(FILE * file)
{
- static const char version[] =
- "\n"
- " AFB [Application Framework Binder] version="AFB_VERSION"\n"
+ static char pm[2] = { '-', '+' };
+ fprintf(file,
"\n"
- " Copyright (C) 2015, 2016, 2017 \"IoT.bzh\"\n"
+ " AGL Framework Binder [AFB %s] %cDBUS %cMONITOR\n"
+ "\n",
+ AFB_VERSION,
+ pm[HAS_DBUS],
+ pm[HAS_MONITORING]
+ );
+ fprintf(file,
+ " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
" AFB comes with ABSOLUTELY NO WARRANTY.\n"
" Licence Apache 2\n"
- "\n";
-
- fprintf(file, "%s", version);
+ "\n");
}
/*----------------------------------------------------------
static void printHelp(FILE * file, const char *name)
{
int ind;
- char command[50];
+ char command[50], sht[4];
+ sht[3] = 0;
fprintf(file, "%s:\nallowed options\n", name);
for (ind = 0; cliOptions[ind].name != NULL; ind++) {
+ if (((cliOptions[ind].val >= 'a' && cliOptions[ind].val <= 'z')
+ || (cliOptions[ind].val >= 'A' && cliOptions[ind].val <= 'Z')
+ || (cliOptions[ind].val >= '0' && cliOptions[ind].val <= '9'))
+ && strchr(shortopts, (char)cliOptions[ind].val)) {
+ sht[0] = '-';
+ sht[1] = (char)cliOptions[ind].val;
+ sht[2] = ',';
+ } else {
+ sht[0] = sht[1] = sht[2] = ' ';
+ }
strcpy(command, cliOptions[ind].name);
if (cliOptions[ind].has_arg)
strcat(command, "=xxxx");
- fprintf(file, " --%-15s %s\n", command, cliOptions[ind].help);
+ fprintf(file, " %s --%-17s %s\n", sht, command, cliOptions[ind].help);
}
fprintf(file,
- "Example:\n %s --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
+ "Example:\n %s --verbose --port=" d2s(DEFAULT_HTTP_PORT) " --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
name);
}
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:
list_add(&config->calls, argvalstr(optc));
break;
- case SET_SESSION_DIR:
- /* config->sessiondir = argvalstr(optc); */
- WARNING("Obsolete option %s ignored", name_of_option(optc));
- break;
-
case SET_UPLOAD_DIR:
config->uploaddir = argvalstr(optc);
break;
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->name = argvalstr(optc);
break;
- case SET_MODE:
- config->mode = argvalenum(optc, mode_desc);
- break;
-
+#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_API:
+ list_add(&config->auto_api, 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);
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->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 = DEFAULT_HTTP_PORT;
// 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)
S(name)
L(aliases)
+#if HAS_DBUS
L(dbus_clients)
L(dbus_servers)
+#endif
L(ws_clients)
L(ws_servers)
L(so_bindings)
+ L(auto_api)
L(ldpaths)
L(weak_ldpaths)
L(calls)
V(exec)
- D(httpdPort)
- D(cacheTimeout)
- D(apiTimeout)
- D(cntxTimeout)
- D(nbSessionMax)
+ D(http_port)
+ D(cache_timeout)
+ D(api_timeout)
+ D(session_timeout)
+ D(max_session_count)
- E(mode,mode_desc)
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(noHttpd)
+ B(no_httpd)
B(background)
-#if defined(WITH_MONITORING_OPTION)
+#if HAS_MONITORING
B(monitoring)
#endif
B(random_token)
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");
}
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;
}
S(name)
L(aliases)
+#if HAS_DBUS
L(dbus_clients)
L(dbus_servers)
+#endif
L(ws_clients)
L(ws_servers)
L(so_bindings)
+ L(auto_api)
L(ldpaths)
L(weak_ldpaths)
L(calls)
V(exec)
- D(httpdPort)
- D(cacheTimeout)
- D(apiTimeout)
- D(cntxTimeout)
- D(nbSessionMax)
+ D(http_port)
+ D(cache_timeout)
+ D(api_timeout)
+ D(session_timeout)
+ D(max_session_count)
- E(mode,mode_desc)
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(noHttpd)
+ B(no_httpd)
B(background)
-#if defined(WITH_MONITORING_OPTION)
+#if HAS_MONITORING
B(monitoring)
#endif
B(random_token)