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"
45 * The default timeout of sessions in seconds
47 #define DEFAULT_SESSION_TIMEOUT 32000000
50 * The default timeout of api calls in seconds
52 #define DEFAULT_API_TIMEOUT 20
55 * The default timeout of cache in seconds
57 #define DEFAULT_CACHE_TIMEOUT 100000
60 * The default maximum count of sessions
62 #define DEFAULT_MAX_SESSION_COUNT 200
65 * The default HTTP port to serve
67 #define DEFAULT_HTTP_PORT 1234
69 // Define command line option
70 #define SET_BACKGROUND 1
71 #define SET_FORGROUND 2
72 #define SET_ROOT_DIR 3
73 #define SET_ROOT_BASE 4
74 #define SET_ROOT_API 5
77 #define SET_CACHE_TIMEOUT 7
83 #define SET_APITIMEOUT 11
84 #define SET_CNTXTIMEOUT 12
85 #define SET_WEAK_LDPATH 13
88 #define SET_SESSIONMAX 15
93 #define SET_ROOT_HTTP 18
95 #define SET_NO_HTTPD 19
97 #define SET_TRACEEVT 20
98 #define SET_TRACESES 21
99 #define SET_TRACEREQ 22
100 #define SET_TRACEAPI 23
101 #if !defined(REMOVE_LEGACY_TRACE)
102 #define SET_TRACEDITF 24
103 #define SET_TRACESVC 25
106 #if defined(WITH_DBUS_TRANSPARENCY)
107 # define DBUS_CLIENT 30
108 # define DBUS_SERVICE 31
113 #define SO_BINDING 'b'
116 #define DISPLAY_HELP 'h'
118 #if defined(WITH_MONITORING_OPTION)
119 #define SET_MONITORING 'M'
122 #define SET_TCP_PORT 'p'
123 #define SET_QUIET 'q'
124 #define SET_RNDTOKEN 'r'
125 #define SET_AUTH_TOKEN 't'
126 #define SET_UPLOAD_DIR 'u'
127 #define DISPLAY_VERSION 'V'
128 #define SET_VERBOSE 'v'
129 #define SET_WORK_DIR 'w'
131 const char shortopts[] =
138 #if defined(WITH_MONITORING_OPTION)
152 // Command line structure hold cli --command + help text
154 int val; // command number within application
155 int has_arg; // command number within application
156 char *name; // command as used in --xxxx cli
157 char *help; // help text
161 static AFB_options cliOptions[] = {
163 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
164 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
165 {SET_LOG, 1, "log", "Tune log level"},
167 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
168 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
170 {SET_NAME, 1, "name", "Set the visible name"},
172 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default " d2s(DEFAULT_HTTP_PORT) "]"},
173 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
174 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
175 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
176 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
178 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default " d2s(DEFAULT_API_TIMEOUT) "]"},
179 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default " d2s(DEFAULT_SESSION_TIMEOUT) "]"},
180 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default " d2s(DEFAULT_CACHE_TIMEOUT) "]"},
182 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
183 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
184 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
186 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
187 {SO_BINDING, 1, "binding", "Load the binding of path"},
188 {SET_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
189 {NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
191 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=random, use --token="" to allow any token]"},
192 {SET_RNDTOKEN, 0, "random-token","Enforce a random token"},
194 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
195 {DISPLAY_HELP, 0, "help", "Display this help"},
197 #if defined(WITH_DBUS_TRANSPARENCY)
198 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
199 {DBUS_SERVICE, 1, "dbus-server", "Provide an afb service through dbus"},
201 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
202 {WS_SERVICE, 1, "ws-server", "Provide an afb service through websockets"},
204 {AUTO_API, 1, "auto-api", "Automatic load of api of the given directory"},
206 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default " d2s(DEFAULT_MAX_SESSION_COUNT) "]"},
208 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
209 #if !defined(REMOVE_LEGACY_TRACE)
210 {SET_TRACEDITF, 1, "traceditf", "Log the daemons: no, common, all"},
211 {SET_TRACESVC, 1, "tracesvc", "Log the services: no, all"},
213 {SET_TRACEEVT, 1, "traceevt", "Log the events: no, common, extra, all"},
214 {SET_TRACESES, 1, "traceses", "Log the sessions: no, all"},
215 {SET_TRACEAPI, 1, "traceapi", "Log the apis: no, common, api, event, all"},
217 {ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
219 {SET_NO_HTTPD, 0, "no-httpd", "Forbid HTTP service"},
220 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
222 #if defined(WITH_MONITORING_OPTION)
223 {SET_MONITORING, 0, "monitoring", "Enable HTTP monitoring at <ROOT>/monitoring/"},
236 static struct enumdesc tracereq_desc[] = {
238 { "common", afb_hook_flags_req_common },
239 { "extra", afb_hook_flags_req_extra },
240 { "all", afb_hook_flags_req_all },
244 #if !defined(REMOVE_LEGACY_TRACE)
245 static struct enumdesc traceditf_desc[] = {
247 { "common", afb_hook_flags_api_ditf_common },
248 { "all", afb_hook_flags_api_ditf_all },
252 static struct enumdesc tracesvc_desc[] = {
254 { "all", afb_hook_flags_api_svc_all },
259 static struct enumdesc traceevt_desc[] = {
261 { "common", afb_hook_flags_evt_common },
262 { "extra", afb_hook_flags_evt_extra },
263 { "all", afb_hook_flags_evt_all },
267 static struct enumdesc traceses_desc[] = {
269 { "common", afb_hook_flags_session_common },
270 { "all", afb_hook_flags_session_all },
274 static struct enumdesc traceapi_desc[] = {
276 { "common", afb_hook_flags_api_common },
277 { "api", afb_hook_flags_api_api|afb_hook_flag_api_start },
278 { "event", afb_hook_flags_api_event|afb_hook_flag_api_start },
279 { "all", afb_hook_flags_api_all },
283 /*----------------------------------------------------------
285 | print version and copyright
286 +--------------------------------------------------------- */
287 static void printVersion(FILE * file)
291 " AGL Framework Binder [AFB %s] "
292 #if defined(WITH_DBUS_TRANSPARENCY)
298 #if defined(WITH_MONITORING_OPTION)
304 #if defined(WITH_SUPERVISION)
309 "SUPERVISION [BINDINGS "
310 #if defined(WITH_LEGACY_BINDING_V1)
316 #if defined(WITH_LEGACY_BINDING_VDYN)
326 " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
327 " AFB comes with ABSOLUTELY NO WARRANTY.\n"
328 " Licence Apache 2\n"
332 /*----------------------------------------------------------
334 | print information from long option array
335 +--------------------------------------------------------- */
337 static void printHelp(FILE * file, const char *name)
340 char command[50], sht[4];
343 fprintf(file, "%s:\nallowed options\n", name);
344 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
345 if (((cliOptions[ind].val >= 'a' && cliOptions[ind].val <= 'z')
346 || (cliOptions[ind].val >= 'A' && cliOptions[ind].val <= 'Z')
347 || (cliOptions[ind].val >= '0' && cliOptions[ind].val <= '9'))
348 && strchr(shortopts, (char)cliOptions[ind].val)) {
350 sht[1] = (char)cliOptions[ind].val;
353 sht[0] = sht[1] = sht[2] = ' ';
355 strcpy(command, cliOptions[ind].name);
356 if (cliOptions[ind].has_arg)
357 strcat(command, "=xxxx");
358 fprintf(file, " %s --%-17s %s\n", sht, command, cliOptions[ind].help);
361 "Example:\n %s --verbose --port=" d2s(DEFAULT_HTTP_PORT) " --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
366 /*----------------------------------------------------------
367 | adds a string to the list
368 +--------------------------------------------------------- */
369 static void list_add(struct afb_config_list **head, char *value)
371 struct afb_config_list *item;
377 while (item != NULL) {
385 item = malloc(sizeof *item);
387 ERROR("out of memory");
399 /*---------------------------------------------------------
400 | helpers for argument scanning
401 +--------------------------------------------------------- */
403 static const char *name_of_option(int optc)
405 AFB_options *o = cliOptions;
406 while (o->name && o->val != optc)
408 return o->name ? : "<unknown-option-name>";
411 static const char *current_argument(int optc)
414 ERROR("option [--%s] needs a value i.e. --%s=xxx",
415 name_of_option(optc), name_of_option(optc));
421 static char *argvalstr(int optc)
423 char *result = strdup(current_argument(optc));
424 if (result == NULL) {
425 ERROR("can't alloc memory");
431 static int argvalenum(int optc, struct enumdesc *desc)
436 const char *name = current_argument(optc);
439 while(desc[i].name && strcmp(desc[i].name, name))
445 len += strlen(desc[i++].name);
446 list = malloc(len + i + i);
448 ERROR("option [--%s] bad value (found %s)",
449 name_of_option(optc), name);
452 strcpy(list, desc[i].name ? : "");
453 while(desc[++i].name)
454 strcat(strcat(list, ", "), desc[i].name);
455 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
456 name_of_option(optc), list, name);
461 return desc[i].value;
464 static int argvalint(int optc, int mini, int maxi, int base)
466 const char *beg, *end;
468 beg = current_argument(optc);
469 val = strtol(beg, (char**)&end, base);
470 if (*end || end == beg) {
471 ERROR("option [--%s] requires a valid integer (found %s)",
472 name_of_option(optc), beg);
475 if (val < (long int)mini || val > (long int)maxi) {
476 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
477 name_of_option(optc), mini, val, maxi);
483 static int argvalintdec(int optc, int mini, int maxi)
485 return argvalint(optc, mini, maxi, 10);
488 static void noarg(int optc)
491 ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
496 static char **make_exec(char **argv)
498 char **result, *iter;
503 for (i = 0 ; argv[i] ; i++)
504 length += strlen(argv[i]) + 1;
506 result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
507 if (result == NULL) {
508 ERROR("can't alloc memory");
512 iter = (char*)&result[i+1];
513 for (i = 0 ; argv[i] ; i++) {
515 iter = stpcpy(iter, argv[i]) + 1;
521 /*---------------------------------------------------------
523 +--------------------------------------------------------- */
525 static void set_log(char *args)
527 char o = 0, s, *p, *i = args;
530 for(;;) switch (*i) {
543 while (isalpha(*p)) p++;
546 lvl = verbose_level_of_name(i);
550 ERROR("Bad log name '%s' in %s", i, args);
568 /*---------------------------------------------------------
569 | Parse option and launch action
570 +--------------------------------------------------------- */
572 static void parse_arguments(int argc, char **argv, struct afb_config *config)
574 char *programName = argv[0];
577 struct option *gnuOptions;
579 // ------------------ Process Command Line -----------------------
581 // build GNU getopt info from cliOptions
582 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
583 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
584 for (ind = 0; ind < nbcmd; ind++) {
585 gnuOptions[ind].name = cliOptions[ind].name;
586 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
587 gnuOptions[ind].flag = 0;
588 gnuOptions[ind].val = cliOptions[ind].val;
591 // get all options from command line
592 while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
603 set_log(argvalstr(optc));
607 config->http_port = argvalintdec(optc, 1024, 32767);
611 config->api_timeout = argvalintdec(optc, 0, INT_MAX);
614 case SET_CNTXTIMEOUT:
615 config->session_timeout = argvalintdec(optc, 0, INT_MAX);
619 config->rootdir = argvalstr(optc);
620 INFO("Forcing Rootdir=%s", config->rootdir);
624 config->roothttp = argvalstr(optc);
625 INFO("Forcing Root HTTP=%s", config->roothttp);
629 config->rootbase = argvalstr(optc);
630 INFO("Forcing Rootbase=%s", config->rootbase);
634 config->rootapi = argvalstr(optc);
635 INFO("Forcing Rootapi=%s", config->rootapi);
639 list_add(&config->aliases, argvalstr(optc));
643 config->token = argvalstr(optc);
647 list_add(&config->ldpaths, argvalstr(optc));
650 case SET_WEAK_LDPATH:
651 list_add(&config->weak_ldpaths, argvalstr(optc));
656 config->no_ldpaths = 1;
660 list_add(&config->calls, argvalstr(optc));
664 config->uploaddir = argvalstr(optc);
668 config->workdir = argvalstr(optc);
671 case SET_CACHE_TIMEOUT:
672 config->cache_timeout = argvalintdec(optc, 0, INT_MAX);
676 config->max_session_count = argvalintdec(optc, 1, INT_MAX);
681 config->background = 0;
686 config->background = 1;
690 config->name = argvalstr(optc);
693 #if defined(WITH_DBUS_TRANSPARENCY)
695 list_add(&config->dbus_clients, argvalstr(optc));
699 list_add(&config->dbus_servers, argvalstr(optc));
704 list_add(&config->ws_clients, argvalstr(optc));
708 list_add(&config->ws_servers, argvalstr(optc));
712 list_add(&config->so_bindings, argvalstr(optc));
716 list_add(&config->auto_api, argvalstr(optc));
720 config->tracereq = argvalenum(optc, tracereq_desc);
723 #if !defined(REMOVE_LEGACY_TRACE)
725 config->traceditf = argvalenum(optc, traceditf_desc);
729 config->tracesvc = argvalenum(optc, tracesvc_desc);
734 config->traceevt = argvalenum(optc, traceevt_desc);
738 config->traceses = argvalenum(optc, traceses_desc);
742 config->traceapi = argvalenum(optc, traceapi_desc);
747 config->no_httpd = 1;
751 config->exec = make_exec(&argv[optind]);
752 optind = argc; /* stop option scanning */
756 config->random_token = 1;
759 #if defined(WITH_MONITORING_OPTION)
761 config->monitoring = 1;
765 case DISPLAY_VERSION:
767 printVersion(stdout);
771 printHelp(stdout, programName);
781 static void fulfill_config(struct afb_config *config)
784 if (config->http_port == 0)
785 config->http_port = DEFAULT_HTTP_PORT;
787 // default binding API timeout
788 if (config->api_timeout == 0)
789 config->api_timeout = DEFAULT_API_TIMEOUT;
791 // default AUTH_TOKEN
792 if (config->random_token)
793 config->token = NULL;
795 // cache timeout default one hour
796 if (config->cache_timeout == 0)
797 config->cache_timeout = DEFAULT_CACHE_TIMEOUT;
799 // cache timeout default one hour
800 if (config->session_timeout == 0)
801 config->session_timeout = DEFAULT_SESSION_TIMEOUT;
803 // max count of sessions
804 if (config->max_session_count == 0)
805 config->max_session_count = DEFAULT_MAX_SESSION_COUNT;
807 /* set directories */
808 if (config->workdir == NULL)
809 config->workdir = ".";
811 if (config->rootdir == NULL)
812 config->rootdir = ".";
814 if (config->uploaddir == NULL)
815 config->uploaddir = ".";
817 // if no Angular/HTML5 rootbase let's try '/' as default
818 if (config->rootbase == NULL)
819 config->rootbase = "/opa";
821 if (config->rootapi == NULL)
822 config->rootapi = "/api";
824 if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
825 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
827 #if defined(WITH_MONITORING_OPTION)
828 if (config->monitoring)
829 list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
832 // if no config dir create a default path from uploaddir
833 if (config->console == NULL) {
834 config->console = malloc(512);
835 strncpy(config->console, config->uploaddir, 512);
836 strncat(config->console, "/AFB-console.out", 512);
839 #if !defined(REMOVE_LEGACY_TRACE)
840 config->traceapi |= config->traceditf | config->tracesvc;
844 void afb_config_dump(struct afb_config *config)
846 struct afb_config_list *l;
850 #define NN(x) (x)?:""
851 #define P(...) fprintf(stderr, __VA_ARGS__)
852 #define PF(x) P("-- %15s: ", #x)
854 #define S(x) PF(x);P("%s",NN(config->x));PE;
855 #define D(x) PF(x);P("%d",config->x);PE;
856 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
857 #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;
858 #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);}
859 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
861 P("---BEGIN-OF-CONFIG---\n");
873 #if defined(WITH_DBUS_TRANSPARENCY)
893 E(tracereq,tracereq_desc)
894 #if !defined(REMOVE_LEGACY_TRACE)
895 E(traceditf,traceditf_desc)
896 E(tracesvc,tracesvc_desc)
898 E(traceevt,traceevt_desc)
899 E(traceses,traceses_desc)
900 E(traceapi,traceapi_desc)
905 #if defined(WITH_MONITORING_OPTION)
909 P("---END-OF-CONFIG---\n");
923 static void on_environment_list(struct afb_config_list **to, const char *name)
925 char *value = getenv(name);
931 static void on_environment_enum(int *to, const char *name, struct enumdesc *desc)
933 char *value = getenv(name);
937 if (strcmp(desc->name, value))
944 WARNING("Unknown value %s for environment variable %s, ignored", value, name);
948 static void parse_environment(struct afb_config *config)
950 on_environment_enum(&config->tracereq, "AFB_TRACEREQ", tracereq_desc);
951 #if !defined(REMOVE_LEGACY_TRACE)
952 on_environment_enum(&config->traceditf, "AFB_TRACEDITF", traceditf_desc);
953 on_environment_enum(&config->tracesvc, "AFB_TRACESVC", tracesvc_desc);
955 on_environment_enum(&config->traceevt, "AFB_TRACEEVT", traceevt_desc);
956 on_environment_enum(&config->traceses, "AFB_TRACESES", traceses_desc);
957 on_environment_enum(&config->traceapi, "AFB_TRACEAPI", traceapi_desc);
958 on_environment_list(&config->ldpaths, "AFB_LDPATHS");
961 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
963 struct afb_config *result;
965 result = calloc(1, sizeof *result);
967 parse_environment(result);
968 parse_arguments(argc, argv, result);
969 fulfill_config(result);
970 if (verbose_wants(Log_Level_Info))
971 afb_config_dump(result);
975 struct json_object *afb_config_json(struct afb_config *config)
977 struct json_object *r, *a;
978 struct afb_config_list *l;
982 #define XA(t,o) json_object_array_add(t,o);
983 #define XO(t,x,o) json_object_object_add(t,x,o);
984 #define YS(s) ((s)?json_object_new_string(s):NULL)
986 #define AO(o) XA(a,o)
987 #define AS(s) AO(YS(s))
988 #define RO(x,o) XO(r,x,o)
989 #define RS(x,s) RO(x,YS(s))
990 #define RA(x) RO(x,(a=json_object_new_array()))
991 #define RI(x,i) RO(x,json_object_new_int(i))
992 #define RB(x,b) RO(x,json_object_new_boolean(b))
994 #define S(x) RS(#x,config->x)
995 #define V(x) RA(#x);for(v=config->x;v&&*v;v++)AS(*v);
996 #define L(x) RA(#x);for(l=config->x;l;l=l->next)AS(l->value);
997 #define D(x) RI(#x,config->x)
998 #define B(x) RB(#x,config->x)
999 #define E(x,d) for(e=d;e->name&&e->value!=config->x;e++);if(e->name){RS(#x,e->name);}else{D(x);}
1001 r = json_object_new_object();
1013 #if defined(WITH_DBUS_TRANSPARENCY)
1031 D(max_session_count)
1033 E(tracereq,tracereq_desc)
1034 #if !defined(REMOVE_LEGACY_TRACE)
1035 E(traceditf,traceditf_desc)
1036 E(tracesvc,tracesvc_desc)
1038 E(traceevt,traceevt_desc)
1039 E(traceses,traceses_desc)
1040 E(traceapi,traceapi_desc)
1045 #if defined(WITH_MONITORING_OPTION)