2 * Copyright (C) 2015-2018 "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.
28 #include <json-c/json.h>
31 #include "afb-config.h"
35 #define d2s(x) _d2s_(x)
37 #if !defined(BINDING_INSTALL_DIR)
38 #error "you should define BINDING_INSTALL_DIR"
40 #if !defined(AFB_VERSION)
41 #error "you should define AFB_VERSION"
44 /* set the HAS_ options */
45 #if defined(WITH_MONITORING_OPTION)
46 # define HAS_MONITORING 1
48 # define HAS_MONITORING 0
50 #if defined(WITH_DBUS_TRANSPARENCY)
55 #if defined(WITH_LEGACY_BINDING_V1)
56 # define HAS_BINDING_V1 1
58 # define HAS_BINDING_V1 0
60 #if defined(WITH_LEGACY_BINDING_VDYN)
61 # define HAS_BINDING_VDYN 1
63 # define HAS_BINDING_VDYN 0
65 #if defined(WITH_SUPERVISION)
66 # define HAS_SUPERVISION 1
68 # define HAS_SUPERVISION 0
72 * The default timeout of sessions in seconds
74 #define DEFAULT_SESSION_TIMEOUT 32000000
77 * The default timeout of api calls in seconds
79 #define DEFAULT_API_TIMEOUT 20
82 * The default timeout of cache in seconds
84 #define DEFAULT_CACHE_TIMEOUT 100000
87 * The default maximum count of sessions
89 #define DEFAULT_MAX_SESSION_COUNT 200
92 * The default HTTP port to serve
94 #define DEFAULT_HTTP_PORT 1234
100 // Define command line option
101 #define SET_BACKGROUND 1
102 #define SET_FORGROUND 2
103 #define SET_ROOT_DIR 3
104 #define SET_ROOT_BASE 4
105 #define SET_ROOT_API 5
108 #define SET_CACHE_TIMEOUT 7
113 #define SET_LDPATH 10
114 #define SET_APITIMEOUT 11
115 #define SET_CNTXTIMEOUT 12
116 #define SET_WEAK_LDPATH 13
119 #define SET_SESSIONMAX 15
122 #define WS_SERVICE 17
124 #define SET_ROOT_HTTP 18
126 #define SET_NO_HTTPD 19
128 #define SET_TRACEEVT 20
129 #define SET_TRACESES 21
130 #define SET_TRACEREQ 22
131 #define SET_TRACEAPI 23
132 #if !defined(REMOVE_LEGACY_TRACE)
133 #define SET_TRACEDITF 24
134 #define SET_TRACESVC 25
138 # define DBUS_CLIENT 30
139 # define DBUS_SERVICE 31
144 #define SO_BINDING 'b'
147 #define DISPLAY_HELP 'h'
150 #define SET_MONITORING 'M'
153 #define SET_TCP_PORT 'p'
154 #define SET_QUIET 'q'
155 #define SET_RNDTOKEN 'r'
156 #define SET_AUTH_TOKEN 't'
157 #define SET_UPLOAD_DIR 'u'
158 #define DISPLAY_VERSION 'V'
159 #define SET_VERBOSE 'v'
160 #define SET_WORK_DIR 'w'
162 const char shortopts[] =
183 // Command line structure hold cli --command + help text
185 int val; // command number within application
186 int has_arg; // command number within application
187 char *name; // command as used in --xxxx cli
188 char *help; // help text
192 static AFB_options cliOptions[] = {
194 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
195 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
196 {SET_LOG, 1, "log", "Tune log level"},
198 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
199 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
201 {SET_NAME, 1, "name", "Set the visible name"},
203 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default " d2s(DEFAULT_HTTP_PORT) "]"},
204 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
205 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
206 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
207 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
209 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default " d2s(DEFAULT_API_TIMEOUT) "]"},
210 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default " d2s(DEFAULT_SESSION_TIMEOUT) "]"},
211 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default " d2s(DEFAULT_CACHE_TIMEOUT) "]"},
213 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
214 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
215 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
217 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
218 {SO_BINDING, 1, "binding", "Load the binding of path"},
219 {SET_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
220 {NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
222 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=random, use --token="" to allow any token]"},
223 {SET_RNDTOKEN, 0, "random-token","Enforce a random token"},
225 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
226 {DISPLAY_HELP, 0, "help", "Display this help"},
229 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
230 {DBUS_SERVICE, 1, "dbus-server", "Provide an afb service through dbus"},
232 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
233 {WS_SERVICE, 1, "ws-server", "Provide an afb service through websockets"},
235 {AUTO_API, 1, "auto-api", "Automatic load of api of the given directory"},
237 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default " d2s(DEFAULT_MAX_SESSION_COUNT) "]"},
239 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
240 #if !defined(REMOVE_LEGACY_TRACE)
241 {SET_TRACEDITF, 1, "traceditf", "Log the daemons: no, common, all"},
242 {SET_TRACESVC, 1, "tracesvc", "Log the services: no, all"},
244 {SET_TRACEEVT, 1, "traceevt", "Log the events: no, common, extra, all"},
245 {SET_TRACESES, 1, "traceses", "Log the sessions: no, all"},
246 {SET_TRACEAPI, 1, "traceapi", "Log the apis: no, common, api, event, all"},
248 {ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
250 {SET_NO_HTTPD, 0, "no-httpd", "Forbid HTTP service"},
251 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
254 {SET_MONITORING, 0, "monitoring", "Enable HTTP monitoring at <ROOT>/monitoring/"},
267 static struct enumdesc tracereq_desc[] = {
269 { "common", afb_hook_flags_req_common },
270 { "extra", afb_hook_flags_req_extra },
271 { "all", afb_hook_flags_req_all },
275 #if !defined(REMOVE_LEGACY_TRACE)
276 static struct enumdesc traceditf_desc[] = {
278 { "common", afb_hook_flags_api_ditf_common },
279 { "all", afb_hook_flags_api_ditf_all },
283 static struct enumdesc tracesvc_desc[] = {
285 { "all", afb_hook_flags_api_svc_all },
290 static struct enumdesc traceevt_desc[] = {
292 { "common", afb_hook_flags_evt_common },
293 { "extra", afb_hook_flags_evt_extra },
294 { "all", afb_hook_flags_evt_all },
298 static struct enumdesc traceses_desc[] = {
300 { "common", afb_hook_flags_session_common },
301 { "all", afb_hook_flags_session_all },
305 static struct enumdesc traceapi_desc[] = {
307 { "common", afb_hook_flags_api_common },
308 { "api", afb_hook_flags_api_api|afb_hook_flag_api_start },
309 { "event", afb_hook_flags_api_event|afb_hook_flag_api_start },
310 { "all", afb_hook_flags_api_all },
314 /*----------------------------------------------------------
316 | print version and copyright
317 +--------------------------------------------------------- */
318 static void printVersion(FILE * file)
320 static char pm[2] = { '-', '+' };
323 " AGL Framework Binder [AFB %s] %cDBUS %cMONITOR %cSUPERVISION [BINDINGS %cV1 %cVDYN +V2 +V3]\n"
333 " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
334 " AFB comes with ABSOLUTELY NO WARRANTY.\n"
335 " Licence Apache 2\n"
339 /*----------------------------------------------------------
341 | print information from long option array
342 +--------------------------------------------------------- */
344 static void printHelp(FILE * file, const char *name)
347 char command[50], sht[4];
350 fprintf(file, "%s:\nallowed options\n", name);
351 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
352 if (((cliOptions[ind].val >= 'a' && cliOptions[ind].val <= 'z')
353 || (cliOptions[ind].val >= 'A' && cliOptions[ind].val <= 'Z')
354 || (cliOptions[ind].val >= '0' && cliOptions[ind].val <= '9'))
355 && strchr(shortopts, (char)cliOptions[ind].val)) {
357 sht[1] = (char)cliOptions[ind].val;
360 sht[0] = sht[1] = sht[2] = ' ';
362 strcpy(command, cliOptions[ind].name);
363 if (cliOptions[ind].has_arg)
364 strcat(command, "=xxxx");
365 fprintf(file, " %s --%-17s %s\n", sht, command, cliOptions[ind].help);
368 "Example:\n %s --verbose --port=" d2s(DEFAULT_HTTP_PORT) " --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
373 /*----------------------------------------------------------
374 | adds a string to the list
375 +--------------------------------------------------------- */
376 static void list_add(struct afb_config_list **head, char *value)
378 struct afb_config_list *item;
384 while (item != NULL) {
392 item = malloc(sizeof *item);
394 ERROR("out of memory");
406 /*---------------------------------------------------------
407 | helpers for argument scanning
408 +--------------------------------------------------------- */
410 static const char *name_of_option(int optc)
412 AFB_options *o = cliOptions;
413 while (o->name && o->val != optc)
415 return o->name ? : "<unknown-option-name>";
418 static const char *current_argument(int optc)
421 ERROR("option [--%s] needs a value i.e. --%s=xxx",
422 name_of_option(optc), name_of_option(optc));
428 static char *argvalstr(int optc)
430 char *result = strdup(current_argument(optc));
431 if (result == NULL) {
432 ERROR("can't alloc memory");
438 static int argvalenum(int optc, struct enumdesc *desc)
443 const char *name = current_argument(optc);
446 while(desc[i].name && strcmp(desc[i].name, name))
452 len += strlen(desc[i++].name);
453 list = malloc(len + i + i);
455 ERROR("option [--%s] bad value (found %s)",
456 name_of_option(optc), name);
459 strcpy(list, desc[i].name ? : "");
460 while(desc[++i].name)
461 strcat(strcat(list, ", "), desc[i].name);
462 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
463 name_of_option(optc), list, name);
468 return desc[i].value;
471 static int argvalint(int optc, int mini, int maxi, int base)
473 const char *beg, *end;
475 beg = current_argument(optc);
476 val = strtol(beg, (char**)&end, base);
477 if (*end || end == beg) {
478 ERROR("option [--%s] requires a valid integer (found %s)",
479 name_of_option(optc), beg);
482 if (val < (long int)mini || val > (long int)maxi) {
483 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
484 name_of_option(optc), mini, val, maxi);
490 static int argvalintdec(int optc, int mini, int maxi)
492 return argvalint(optc, mini, maxi, 10);
495 static void noarg(int optc)
498 ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
503 static char **make_exec(char **argv)
505 char **result, *iter;
510 for (i = 0 ; argv[i] ; i++)
511 length += strlen(argv[i]) + 1;
513 result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
514 if (result == NULL) {
515 ERROR("can't alloc memory");
519 iter = (char*)&result[i+1];
520 for (i = 0 ; argv[i] ; i++) {
522 iter = stpcpy(iter, argv[i]) + 1;
528 /*---------------------------------------------------------
530 +--------------------------------------------------------- */
532 static void set_log(char *args)
534 char o = 0, s, *p, *i = args;
537 for(;;) switch (*i) {
550 while (isalpha(*p)) p++;
553 lvl = verbose_level_of_name(i);
557 ERROR("Bad log name '%s' in %s", i, args);
575 /*---------------------------------------------------------
576 | Parse option and launch action
577 +--------------------------------------------------------- */
579 static void parse_arguments(int argc, char **argv, struct afb_config *config)
581 char *programName = argv[0];
584 struct option *gnuOptions;
586 // ------------------ Process Command Line -----------------------
588 // build GNU getopt info from cliOptions
589 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
590 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
591 for (ind = 0; ind < nbcmd; ind++) {
592 gnuOptions[ind].name = cliOptions[ind].name;
593 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
594 gnuOptions[ind].flag = 0;
595 gnuOptions[ind].val = cliOptions[ind].val;
598 // get all options from command line
599 while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
610 set_log(argvalstr(optc));
614 config->http_port = argvalintdec(optc, 1024, 32767);
618 config->api_timeout = argvalintdec(optc, 0, INT_MAX);
621 case SET_CNTXTIMEOUT:
622 config->session_timeout = argvalintdec(optc, 0, INT_MAX);
626 config->rootdir = argvalstr(optc);
627 INFO("Forcing Rootdir=%s", config->rootdir);
631 config->roothttp = argvalstr(optc);
632 INFO("Forcing Root HTTP=%s", config->roothttp);
636 config->rootbase = argvalstr(optc);
637 INFO("Forcing Rootbase=%s", config->rootbase);
641 config->rootapi = argvalstr(optc);
642 INFO("Forcing Rootapi=%s", config->rootapi);
646 list_add(&config->aliases, argvalstr(optc));
650 config->token = argvalstr(optc);
654 list_add(&config->ldpaths, argvalstr(optc));
657 case SET_WEAK_LDPATH:
658 list_add(&config->weak_ldpaths, argvalstr(optc));
663 config->no_ldpaths = 1;
667 list_add(&config->calls, argvalstr(optc));
671 config->uploaddir = argvalstr(optc);
675 config->workdir = argvalstr(optc);
678 case SET_CACHE_TIMEOUT:
679 config->cache_timeout = argvalintdec(optc, 0, INT_MAX);
683 config->max_session_count = argvalintdec(optc, 1, INT_MAX);
688 config->background = 0;
693 config->background = 1;
697 config->name = argvalstr(optc);
702 list_add(&config->dbus_clients, argvalstr(optc));
706 list_add(&config->dbus_servers, argvalstr(optc));
711 list_add(&config->ws_clients, argvalstr(optc));
715 list_add(&config->ws_servers, argvalstr(optc));
719 list_add(&config->so_bindings, argvalstr(optc));
723 list_add(&config->auto_api, argvalstr(optc));
727 config->tracereq = argvalenum(optc, tracereq_desc);
730 #if !defined(REMOVE_LEGACY_TRACE)
732 config->traceditf = argvalenum(optc, traceditf_desc);
736 config->tracesvc = argvalenum(optc, tracesvc_desc);
741 config->traceevt = argvalenum(optc, traceevt_desc);
745 config->traceses = argvalenum(optc, traceses_desc);
749 config->traceapi = argvalenum(optc, traceapi_desc);
754 config->no_httpd = 1;
758 config->exec = make_exec(&argv[optind]);
759 optind = argc; /* stop option scanning */
763 config->random_token = 1;
768 config->monitoring = 1;
772 case DISPLAY_VERSION:
774 printVersion(stdout);
778 printHelp(stdout, programName);
788 static void fulfill_config(struct afb_config *config)
791 if (config->http_port == 0)
792 config->http_port = DEFAULT_HTTP_PORT;
794 // default binding API timeout
795 if (config->api_timeout == 0)
796 config->api_timeout = DEFAULT_API_TIMEOUT;
798 // default AUTH_TOKEN
799 if (config->random_token)
800 config->token = NULL;
802 // cache timeout default one hour
803 if (config->cache_timeout == 0)
804 config->cache_timeout = DEFAULT_CACHE_TIMEOUT;
806 // cache timeout default one hour
807 if (config->session_timeout == 0)
808 config->session_timeout = DEFAULT_SESSION_TIMEOUT;
810 // max count of sessions
811 if (config->max_session_count == 0)
812 config->max_session_count = DEFAULT_MAX_SESSION_COUNT;
814 /* set directories */
815 if (config->workdir == NULL)
816 config->workdir = ".";
818 if (config->rootdir == NULL)
819 config->rootdir = ".";
821 if (config->uploaddir == NULL)
822 config->uploaddir = ".";
824 // if no Angular/HTML5 rootbase let's try '/' as default
825 if (config->rootbase == NULL)
826 config->rootbase = "/opa";
828 if (config->rootapi == NULL)
829 config->rootapi = "/api";
831 if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
832 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
835 if (config->monitoring)
836 list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
839 // if no config dir create a default path from uploaddir
840 if (config->console == NULL) {
841 config->console = malloc(512);
842 strncpy(config->console, config->uploaddir, 512);
843 strncat(config->console, "/AFB-console.out", 512);
846 #if !defined(REMOVE_LEGACY_TRACE)
847 config->traceapi |= config->traceditf | config->tracesvc;
851 void afb_config_dump(struct afb_config *config)
853 struct afb_config_list *l;
857 #define NN(x) (x)?:""
858 #define P(...) fprintf(stderr, __VA_ARGS__)
859 #define PF(x) P("-- %15s: ", #x)
861 #define S(x) PF(x);P("%s",NN(config->x));PE;
862 #define D(x) PF(x);P("%d",config->x);PE;
863 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
864 #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;
865 #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);}
866 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
868 P("---BEGIN-OF-CONFIG---\n");
900 E(tracereq,tracereq_desc)
901 #if !defined(REMOVE_LEGACY_TRACE)
902 E(traceditf,traceditf_desc)
903 E(tracesvc,tracesvc_desc)
905 E(traceevt,traceevt_desc)
906 E(traceses,traceses_desc)
907 E(traceapi,traceapi_desc)
916 P("---END-OF-CONFIG---\n");
930 static void on_environment_list(struct afb_config_list **to, const char *name)
932 char *value = getenv(name);
938 static void on_environment_enum(int *to, const char *name, struct enumdesc *desc)
940 char *value = getenv(name);
944 if (strcmp(desc->name, value))
951 WARNING("Unknown value %s for environment variable %s, ignored", value, name);
955 static void parse_environment(struct afb_config *config)
957 on_environment_enum(&config->tracereq, "AFB_TRACEREQ", tracereq_desc);
958 #if !defined(REMOVE_LEGACY_TRACE)
959 on_environment_enum(&config->traceditf, "AFB_TRACEDITF", traceditf_desc);
960 on_environment_enum(&config->tracesvc, "AFB_TRACESVC", tracesvc_desc);
962 on_environment_enum(&config->traceevt, "AFB_TRACEEVT", traceevt_desc);
963 on_environment_enum(&config->traceses, "AFB_TRACESES", traceses_desc);
964 on_environment_enum(&config->traceapi, "AFB_TRACEAPI", traceapi_desc);
965 on_environment_list(&config->ldpaths, "AFB_LDPATHS");
968 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
970 struct afb_config *result;
972 result = calloc(1, sizeof *result);
974 parse_environment(result);
975 parse_arguments(argc, argv, result);
976 fulfill_config(result);
977 if (verbose_wants(Log_Level_Info))
978 afb_config_dump(result);
982 struct json_object *afb_config_json(struct afb_config *config)
984 struct json_object *r, *a;
985 struct afb_config_list *l;
989 #define XA(t,o) json_object_array_add(t,o);
990 #define XO(t,x,o) json_object_object_add(t,x,o);
991 #define YS(s) ((s)?json_object_new_string(s):NULL)
993 #define AO(o) XA(a,o)
994 #define AS(s) AO(YS(s))
995 #define RO(x,o) XO(r,x,o)
996 #define RS(x,s) RO(x,YS(s))
997 #define RA(x) RO(x,(a=json_object_new_array()))
998 #define RI(x,i) RO(x,json_object_new_int(i))
999 #define RB(x,b) RO(x,json_object_new_boolean(b))
1001 #define S(x) RS(#x,config->x)
1002 #define V(x) RA(#x);for(v=config->x;v&&*v;v++)AS(*v);
1003 #define L(x) RA(#x);for(l=config->x;l;l=l->next)AS(l->value);
1004 #define D(x) RI(#x,config->x)
1005 #define B(x) RB(#x,config->x)
1006 #define E(x,d) for(e=d;e->name&&e->value!=config->x;e++);if(e->name){RS(#x,e->name);}else{D(x);}
1008 r = json_object_new_object();
1038 D(max_session_count)
1040 E(tracereq,tracereq_desc)
1041 #if !defined(REMOVE_LEGACY_TRACE)
1042 E(traceditf,traceditf_desc)
1043 E(tracesvc,tracesvc_desc)
1045 E(traceevt,traceevt_desc)
1046 E(traceses,traceses_desc)
1047 E(traceapi,traceapi_desc)