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>
29 #if !defined(JSON_C_TO_STRING_NOSLASHESCAPE)
30 #define JSON_C_TO_STRING_NOSLASHESCAPE 0
34 #include "afb-config.h"
38 #define d2s(x) _d2s_(x)
40 #if !defined(BINDING_INSTALL_DIR)
41 #error "you should define BINDING_INSTALL_DIR"
43 #if !defined(AFB_VERSION)
44 #error "you should define AFB_VERSION"
48 * The default timeout of sessions in seconds
50 #define DEFAULT_SESSION_TIMEOUT 32000000
53 * The default timeout of api calls in seconds
55 #define DEFAULT_API_TIMEOUT 20
58 * The default timeout of cache in seconds
60 #define DEFAULT_CACHE_TIMEOUT 100000
63 * The default maximum count of sessions
65 #define DEFAULT_MAX_SESSION_COUNT 200
68 * The default HTTP port to serve
70 #define DEFAULT_HTTP_PORT 1234
72 // Define command line option
73 #define SET_BACKGROUND 1
74 #define SET_FORGROUND 2
75 #define SET_ROOT_DIR 3
76 #define SET_ROOT_BASE 4
77 #define SET_ROOT_API 5
80 #define SET_CACHE_TIMEOUT 7
86 #define SET_APITIMEOUT 11
87 #define SET_CNTXTIMEOUT 12
88 #define SET_WEAK_LDPATH 13
91 #define SET_SESSIONMAX 15
96 #define SET_ROOT_HTTP 18
98 #define SET_NO_HTTPD 19
100 #define SET_TRACEEVT 20
101 #define SET_TRACESES 21
102 #define SET_TRACEREQ 22
103 #define SET_TRACEAPI 23
104 #if !defined(REMOVE_LEGACY_TRACE)
105 #define SET_TRACEDITF 24
106 #define SET_TRACESVC 25
109 #if defined(WITH_DBUS_TRANSPARENCY)
110 # define DBUS_CLIENT 30
111 # define DBUS_SERVICE 31
116 #define SO_BINDING 'b'
119 #define DISPLAY_HELP 'h'
121 #if defined(WITH_MONITORING_OPTION)
122 #define SET_MONITORING 'M'
125 #define SET_TCP_PORT 'p'
126 #define SET_QUIET 'q'
127 #define SET_RNDTOKEN 'r'
128 #define SET_AUTH_TOKEN 't'
129 #define SET_UPLOAD_DIR 'u'
130 #define DISPLAY_VERSION 'V'
131 #define SET_VERBOSE 'v'
132 #define SET_WORK_DIR 'w'
134 const char shortopts[] =
141 #if defined(WITH_MONITORING_OPTION)
155 // Command line structure hold cli --command + help text
157 int val; // command number within application
158 int has_arg; // command number within application
159 char *name; // command as used in --xxxx cli
160 char *help; // help text
164 static AFB_options cliOptions[] = {
166 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
167 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
168 {SET_LOG, 1, "log", "Tune log level"},
170 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
171 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
173 {SET_NAME, 1, "name", "Set the visible name"},
175 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default " d2s(DEFAULT_HTTP_PORT) "]"},
176 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
177 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
178 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
179 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
181 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default " d2s(DEFAULT_API_TIMEOUT) "]"},
182 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default " d2s(DEFAULT_SESSION_TIMEOUT) "]"},
183 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default " d2s(DEFAULT_CACHE_TIMEOUT) "]"},
185 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
186 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
187 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
189 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
190 {SO_BINDING, 1, "binding", "Load the binding of path"},
191 {SET_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
192 {NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
194 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=random, use --token="" to allow any token]"},
195 {SET_RNDTOKEN, 0, "random-token","Enforce a random token"},
197 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
198 {DISPLAY_HELP, 0, "help", "Display this help"},
200 #if defined(WITH_DBUS_TRANSPARENCY)
201 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
202 {DBUS_SERVICE, 1, "dbus-server", "Provide an afb service through dbus"},
204 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
205 {WS_SERVICE, 1, "ws-server", "Provide an afb service through websockets"},
207 {AUTO_API, 1, "auto-api", "Automatic load of api of the given directory"},
209 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default " d2s(DEFAULT_MAX_SESSION_COUNT) "]"},
211 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
212 #if !defined(REMOVE_LEGACY_TRACE)
213 {SET_TRACEDITF, 1, "traceditf", "Log the daemons: no, common, all"},
214 {SET_TRACESVC, 1, "tracesvc", "Log the services: no, all"},
216 {SET_TRACEEVT, 1, "traceevt", "Log the events: no, common, extra, all"},
217 {SET_TRACESES, 1, "traceses", "Log the sessions: no, all"},
218 {SET_TRACEAPI, 1, "traceapi", "Log the apis: no, common, api, event, all"},
220 {ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
222 {SET_NO_HTTPD, 0, "no-httpd", "Forbid HTTP service"},
223 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
225 #if defined(WITH_MONITORING_OPTION)
226 {SET_MONITORING, 0, "monitoring", "Enable HTTP monitoring at <ROOT>/monitoring/"},
239 static struct enumdesc tracereq_desc[] = {
241 { "common", afb_hook_flags_req_common },
242 { "extra", afb_hook_flags_req_extra },
243 { "all", afb_hook_flags_req_all },
247 #if !defined(REMOVE_LEGACY_TRACE)
248 static struct enumdesc traceditf_desc[] = {
250 { "common", afb_hook_flags_api_ditf_common },
251 { "all", afb_hook_flags_api_ditf_all },
255 static struct enumdesc tracesvc_desc[] = {
257 { "all", afb_hook_flags_api_svc_all },
262 static struct enumdesc traceevt_desc[] = {
264 { "common", afb_hook_flags_evt_common },
265 { "extra", afb_hook_flags_evt_extra },
266 { "all", afb_hook_flags_evt_all },
270 static struct enumdesc traceses_desc[] = {
272 { "common", afb_hook_flags_session_common },
273 { "all", afb_hook_flags_session_all },
277 static struct enumdesc traceapi_desc[] = {
279 { "common", afb_hook_flags_api_common },
280 { "api", afb_hook_flags_api_api|afb_hook_flag_api_start },
281 { "event", afb_hook_flags_api_event|afb_hook_flag_api_start },
282 { "all", afb_hook_flags_api_all },
286 /*----------------------------------------------------------
288 | print version and copyright
289 +--------------------------------------------------------- */
290 static void printVersion(FILE * file)
294 " AGL Framework Binder [AFB %s] "
295 #if defined(WITH_DBUS_TRANSPARENCY)
301 #if defined(WITH_MONITORING_OPTION)
307 #if defined(WITH_SUPERVISION)
312 "SUPERVISION [BINDINGS "
313 #if defined(WITH_LEGACY_BINDING_V1)
319 #if defined(WITH_LEGACY_BINDING_VDYN)
329 " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
330 " AFB comes with ABSOLUTELY NO WARRANTY.\n"
331 " Licence Apache 2\n"
335 /*----------------------------------------------------------
337 | print information from long option array
338 +--------------------------------------------------------- */
340 static void printHelp(FILE * file, const char *name)
343 char command[50], sht[4];
346 fprintf(file, "%s:\nallowed options\n", name);
347 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
348 if (((cliOptions[ind].val >= 'a' && cliOptions[ind].val <= 'z')
349 || (cliOptions[ind].val >= 'A' && cliOptions[ind].val <= 'Z')
350 || (cliOptions[ind].val >= '0' && cliOptions[ind].val <= '9'))
351 && strchr(shortopts, (char)cliOptions[ind].val)) {
353 sht[1] = (char)cliOptions[ind].val;
356 sht[0] = sht[1] = sht[2] = ' ';
358 strcpy(command, cliOptions[ind].name);
359 if (cliOptions[ind].has_arg)
360 strcat(command, "=xxxx");
361 fprintf(file, " %s --%-17s %s\n", sht, command, cliOptions[ind].help);
364 "Example:\n %s --verbose --port=" d2s(DEFAULT_HTTP_PORT) " --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
369 /*----------------------------------------------------------
370 | adds a string to the list
371 +--------------------------------------------------------- */
372 static void list_add(struct afb_config_list **head, char *value)
374 struct afb_config_list *item;
380 while (item != NULL) {
388 item = malloc(sizeof *item);
390 ERROR("out of memory");
402 /*---------------------------------------------------------
403 | helpers for argument scanning
404 +--------------------------------------------------------- */
406 static const char *name_of_option(int optc)
408 AFB_options *o = cliOptions;
409 while (o->name && o->val != optc)
411 return o->name ? : "<unknown-option-name>";
414 static const char *current_argument(int optc)
417 ERROR("option [--%s] needs a value i.e. --%s=xxx",
418 name_of_option(optc), name_of_option(optc));
424 static char *argvalstr(int optc)
426 char *result = strdup(current_argument(optc));
427 if (result == NULL) {
428 ERROR("can't alloc memory");
434 static int argvalenum(int optc, struct enumdesc *desc)
439 const char *name = current_argument(optc);
442 while(desc[i].name && strcmp(desc[i].name, name))
448 len += strlen(desc[i++].name);
449 list = malloc(len + i + i);
451 ERROR("option [--%s] bad value (found %s)",
452 name_of_option(optc), name);
455 strcpy(list, desc[i].name ? : "");
456 while(desc[++i].name)
457 strcat(strcat(list, ", "), desc[i].name);
458 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
459 name_of_option(optc), list, name);
464 return desc[i].value;
467 static int argvalint(int optc, int mini, int maxi, int base)
469 const char *beg, *end;
471 beg = current_argument(optc);
472 val = strtol(beg, (char**)&end, base);
473 if (*end || end == beg) {
474 ERROR("option [--%s] requires a valid integer (found %s)",
475 name_of_option(optc), beg);
478 if (val < (long int)mini || val > (long int)maxi) {
479 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
480 name_of_option(optc), mini, val, maxi);
486 static int argvalintdec(int optc, int mini, int maxi)
488 return argvalint(optc, mini, maxi, 10);
491 static void noarg(int optc)
494 ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
499 static char **make_exec(char **argv)
501 char **result, *iter;
506 for (i = 0 ; argv[i] ; i++)
507 length += strlen(argv[i]) + 1;
509 result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
510 if (result == NULL) {
511 ERROR("can't alloc memory");
515 iter = (char*)&result[i+1];
516 for (i = 0 ; argv[i] ; i++) {
518 iter = stpcpy(iter, argv[i]) + 1;
524 /*---------------------------------------------------------
526 +--------------------------------------------------------- */
528 static void set_log(char *args)
530 char o = 0, s, *p, *i = args;
533 for(;;) switch (*i) {
546 while (isalpha(*p)) p++;
549 lvl = verbose_level_of_name(i);
553 ERROR("Bad log name '%s' in %s", i, args);
571 /*---------------------------------------------------------
572 | Parse option and launch action
573 +--------------------------------------------------------- */
575 static void parse_arguments(int argc, char **argv, struct afb_config *config)
577 char *programName = argv[0];
580 struct option *gnuOptions;
582 // ------------------ Process Command Line -----------------------
584 // build GNU getopt info from cliOptions
585 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
586 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
587 for (ind = 0; ind < nbcmd; ind++) {
588 gnuOptions[ind].name = cliOptions[ind].name;
589 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
590 gnuOptions[ind].flag = 0;
591 gnuOptions[ind].val = cliOptions[ind].val;
594 // get all options from command line
595 while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
606 set_log(argvalstr(optc));
610 config->http_port = argvalintdec(optc, 1024, 32767);
614 config->api_timeout = argvalintdec(optc, 0, INT_MAX);
617 case SET_CNTXTIMEOUT:
618 config->session_timeout = argvalintdec(optc, 0, INT_MAX);
622 config->rootdir = argvalstr(optc);
623 INFO("Forcing Rootdir=%s", config->rootdir);
627 config->roothttp = argvalstr(optc);
628 INFO("Forcing Root HTTP=%s", config->roothttp);
632 config->rootbase = argvalstr(optc);
633 INFO("Forcing Rootbase=%s", config->rootbase);
637 config->rootapi = argvalstr(optc);
638 INFO("Forcing Rootapi=%s", config->rootapi);
642 list_add(&config->aliases, argvalstr(optc));
646 config->token = argvalstr(optc);
650 list_add(&config->ldpaths, argvalstr(optc));
653 case SET_WEAK_LDPATH:
654 list_add(&config->weak_ldpaths, argvalstr(optc));
659 config->no_ldpaths = 1;
663 list_add(&config->calls, argvalstr(optc));
667 config->uploaddir = argvalstr(optc);
671 config->workdir = argvalstr(optc);
674 case SET_CACHE_TIMEOUT:
675 config->cache_timeout = argvalintdec(optc, 0, INT_MAX);
679 config->max_session_count = argvalintdec(optc, 1, INT_MAX);
684 config->background = 0;
689 config->background = 1;
693 config->name = argvalstr(optc);
696 #if defined(WITH_DBUS_TRANSPARENCY)
698 list_add(&config->dbus_clients, argvalstr(optc));
702 list_add(&config->dbus_servers, argvalstr(optc));
707 list_add(&config->ws_clients, argvalstr(optc));
711 list_add(&config->ws_servers, argvalstr(optc));
715 list_add(&config->so_bindings, argvalstr(optc));
719 list_add(&config->auto_api, argvalstr(optc));
723 config->tracereq = argvalenum(optc, tracereq_desc);
726 #if !defined(REMOVE_LEGACY_TRACE)
728 config->traceditf = argvalenum(optc, traceditf_desc);
732 config->tracesvc = argvalenum(optc, tracesvc_desc);
737 config->traceevt = argvalenum(optc, traceevt_desc);
741 config->traceses = argvalenum(optc, traceses_desc);
745 config->traceapi = argvalenum(optc, traceapi_desc);
750 config->no_httpd = 1;
754 config->exec = make_exec(&argv[optind]);
755 optind = argc; /* stop option scanning */
759 config->random_token = 1;
762 #if defined(WITH_MONITORING_OPTION)
764 config->monitoring = 1;
768 case DISPLAY_VERSION:
770 printVersion(stdout);
774 printHelp(stdout, programName);
784 static void fulfill_config(struct afb_config *config)
787 if (config->http_port == 0)
788 config->http_port = DEFAULT_HTTP_PORT;
790 // default binding API timeout
791 if (config->api_timeout == 0)
792 config->api_timeout = DEFAULT_API_TIMEOUT;
794 // default AUTH_TOKEN
795 if (config->random_token)
796 config->token = NULL;
798 // cache timeout default one hour
799 if (config->cache_timeout == 0)
800 config->cache_timeout = DEFAULT_CACHE_TIMEOUT;
802 // cache timeout default one hour
803 if (config->session_timeout == 0)
804 config->session_timeout = DEFAULT_SESSION_TIMEOUT;
806 // max count of sessions
807 if (config->max_session_count == 0)
808 config->max_session_count = DEFAULT_MAX_SESSION_COUNT;
810 /* set directories */
811 if (config->workdir == NULL)
812 config->workdir = ".";
814 if (config->rootdir == NULL)
815 config->rootdir = ".";
817 if (config->uploaddir == NULL)
818 config->uploaddir = ".";
820 // if no Angular/HTML5 rootbase let's try '/' as default
821 if (config->rootbase == NULL)
822 config->rootbase = "/opa";
824 if (config->rootapi == NULL)
825 config->rootapi = "/api";
827 if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
828 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
830 #if defined(WITH_MONITORING_OPTION)
831 if (config->monitoring)
832 list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
835 // if no config dir create a default path from uploaddir
836 if (config->console == NULL) {
837 config->console = malloc(512);
838 strncpy(config->console, config->uploaddir, 512);
839 strncat(config->console, "/AFB-console.out", 512);
842 #if !defined(REMOVE_LEGACY_TRACE)
843 config->traceapi |= config->traceditf | config->tracesvc;
847 void afb_config_dump(struct afb_config *config)
849 struct afb_config_list *l;
853 #define NN(x) (x)?:""
854 #define P(...) fprintf(stderr, __VA_ARGS__)
855 #define PF(x) P("-- %15s: ", #x)
857 #define S(x) PF(x);P("%s",NN(config->x));PE;
858 #define D(x) PF(x);P("%d",config->x);PE;
859 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
860 #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;
861 #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);}
862 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
864 P("---BEGIN-OF-CONFIG---\n");
876 #if defined(WITH_DBUS_TRANSPARENCY)
896 E(tracereq,tracereq_desc)
897 #if !defined(REMOVE_LEGACY_TRACE)
898 E(traceditf,traceditf_desc)
899 E(tracesvc,tracesvc_desc)
901 E(traceevt,traceevt_desc)
902 E(traceses,traceses_desc)
903 E(traceapi,traceapi_desc)
908 #if defined(WITH_MONITORING_OPTION)
912 P("---END-OF-CONFIG---\n");
926 static void on_environment_list(struct afb_config_list **to, const char *name)
928 char *value = getenv(name);
934 static void on_environment_enum(int *to, const char *name, struct enumdesc *desc)
936 char *value = getenv(name);
940 if (strcmp(desc->name, value))
947 WARNING("Unknown value %s for environment variable %s, ignored", value, name);
951 static void parse_environment(struct afb_config *config)
953 on_environment_enum(&config->tracereq, "AFB_TRACEREQ", tracereq_desc);
954 #if !defined(REMOVE_LEGACY_TRACE)
955 on_environment_enum(&config->traceditf, "AFB_TRACEDITF", traceditf_desc);
956 on_environment_enum(&config->tracesvc, "AFB_TRACESVC", tracesvc_desc);
958 on_environment_enum(&config->traceevt, "AFB_TRACEEVT", traceevt_desc);
959 on_environment_enum(&config->traceses, "AFB_TRACESES", traceses_desc);
960 on_environment_enum(&config->traceapi, "AFB_TRACEAPI", traceapi_desc);
961 on_environment_list(&config->ldpaths, "AFB_LDPATHS");
964 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
966 struct afb_config *result;
968 result = calloc(1, sizeof *result);
970 parse_environment(result);
971 parse_arguments(argc, argv, result);
972 fulfill_config(result);
973 if (verbose_wants(Log_Level_Info))
974 afb_config_dump(result);
978 struct json_object *afb_config_json(struct afb_config *config)
980 struct json_object *r, *a;
981 struct afb_config_list *l;
985 #define XA(t,o) json_object_array_add(t,o);
986 #define XO(t,x,o) json_object_object_add(t,x,o);
987 #define YS(s) ((s)?json_object_new_string(s):NULL)
989 #define AO(o) XA(a,o)
990 #define AS(s) AO(YS(s))
991 #define RO(x,o) XO(r,x,o)
992 #define RS(x,s) RO(x,YS(s))
993 #define RA(x) RO(x,(a=json_object_new_array()))
994 #define RI(x,i) RO(x,json_object_new_int(i))
995 #define RB(x,b) RO(x,json_object_new_boolean(b))
997 #define S(x) RS(#x,config->x)
998 #define V(x) RA(#x);for(v=config->x;v&&*v;v++)AS(*v);
999 #define L(x) RA(#x);for(l=config->x;l;l=l->next)AS(l->value);
1000 #define D(x) RI(#x,config->x)
1001 #define B(x) RB(#x,config->x)
1002 #define E(x,d) for(e=d;e->name&&e->value!=config->x;e++);if(e->name){RS(#x,e->name);}else{D(x);}
1004 r = json_object_new_object();
1016 #if defined(WITH_DBUS_TRANSPARENCY)
1034 D(max_session_count)
1036 E(tracereq,tracereq_desc)
1037 #if !defined(REMOVE_LEGACY_TRACE)
1038 E(traceditf,traceditf_desc)
1039 E(tracesvc,tracesvc_desc)
1041 E(traceevt,traceevt_desc)
1042 E(traceses,traceses_desc)
1043 E(traceapi,traceapi_desc)
1048 #if defined(WITH_MONITORING_OPTION)