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"
35 #include "afb-hook-flags.h"
36 #include "wrap-json.h"
39 #define d2s(x) _d2s_(x)
41 #if !defined(BINDING_INSTALL_DIR)
42 #error "you should define BINDING_INSTALL_DIR"
44 #if !defined(AFB_VERSION)
45 #error "you should define AFB_VERSION"
49 * The default timeout of sessions in seconds
51 #define DEFAULT_SESSION_TIMEOUT 32000000
54 * The default timeout of api calls in seconds
56 #define DEFAULT_API_TIMEOUT 20
59 * The default timeout of cache in seconds
61 #define DEFAULT_CACHE_TIMEOUT 100000
64 * The default maximum count of sessions
66 #define DEFAULT_MAX_SESSION_COUNT 200
69 * The default HTTP port to serve
71 #define DEFAULT_HTTP_PORT 1234
73 // Define command line option
74 #define SET_BACKGROUND 1
75 #define SET_FOREGROUND 2
76 #define SET_ROOT_DIR 3
77 #define SET_ROOT_BASE 4
78 #define SET_ROOT_API 5
81 #define SET_CACHE_TIMEOUT 7
87 #define SET_API_TIMEOUT 11
88 #define SET_SESSION_TIMEOUT 12
89 #define ADD_WEAK_LDPATH 13
90 #define SET_NO_LDPATH 14
92 #define SET_SESSIONMAX 15
94 #define ADD_WS_CLIENT 16
95 #define ADD_WS_SERVICE 17
97 #define SET_ROOT_HTTP 18
99 #define SET_NO_HTTPD 19
101 #define SET_TRACEEVT 20
102 #define SET_TRACESES 21
103 #define SET_TRACEREQ 22
104 #define SET_TRACEAPI 23
105 #define SET_TRACEGLOB 24
106 #if !defined(REMOVE_LEGACY_TRACE)
107 #define SET_TRACEDITF 25
108 #define SET_TRACESVC 26
111 #if defined(WITH_DBUS_TRANSPARENCY)
112 # define ADD_DBUS_CLIENT 30
113 # define ADD_DBUS_SERVICE 31
117 #define ADD_AUTO_API 'A'
118 #define ADD_BINDING 'b'
119 #define SET_CONFIG 'C'
121 #define SET_DAEMON 'D'
125 #if defined(WITH_MONITORING_OPTION)
126 #define SET_MONITORING 'M'
129 #define SET_OUTPUT 'o'
131 #define SET_QUIET 'q'
132 #define SET_RANDOM_TOKEN 'r'
133 #define SET_TOKEN 't'
134 #define SET_UPLOAD_DIR 'u'
135 #define GET_VERSION 'V'
136 #define SET_VERBOSE 'v'
137 #define SET_WORK_DIR 'w'
139 /* structure for defining of options */
141 int id; /* id of the option */
142 int has_arg; /* is a value required */
143 char *name; /* long name of the option */
144 char *help; /* help text */
147 /* definition of options */
148 static struct option_desc optdefs[] = {
150 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
151 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
152 {SET_LOG, 1, "log", "Tune log level"},
154 {SET_FOREGROUND, 0, "foreground", "Get all in foreground mode"},
155 {SET_BACKGROUND, 0, "background", "Get all in background mode"},
156 {SET_DAEMON, 0, "daemon", "Get all in background mode"},
158 {SET_NAME, 1, "name", "Set the visible name"},
160 {SET_PORT, 1, "port", "HTTP listening TCP port [default " d2s(DEFAULT_HTTP_PORT) "]"},
161 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
162 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
163 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
164 {ADD_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
166 {SET_API_TIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default " d2s(DEFAULT_API_TIMEOUT) "]"},
167 {SET_SESSION_TIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default " d2s(DEFAULT_SESSION_TIMEOUT) "]"},
168 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default " d2s(DEFAULT_CACHE_TIMEOUT) "]"},
170 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
171 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
172 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
174 {ADD_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
175 {ADD_BINDING, 1, "binding", "Load the binding of path"},
176 {ADD_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
177 {SET_NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
179 {SET_TOKEN, 1, "token", "Initial Secret [default=random, use --token="" to allow any token]"},
180 {SET_RANDOM_TOKEN, 0, "random-token","Enforce a random token"},
182 {GET_VERSION, 0, "version", "Display version and copyright"},
183 {GET_HELP, 0, "help", "Display this help"},
185 #if defined(WITH_DBUS_TRANSPARENCY)
186 {ADD_DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
187 {ADD_DBUS_SERVICE, 1, "dbus-server", "Provide an afb service through dbus"},
189 {ADD_WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
190 {ADD_WS_SERVICE, 1, "ws-server", "Provide an afb service through websockets"},
192 {ADD_AUTO_API, 1, "auto-api", "Automatic load of api of the given directory"},
194 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default " d2s(DEFAULT_MAX_SESSION_COUNT) "]"},
196 {SET_TRACEREQ, 1, "tracereq", "Log the requests: none, common, extra, all"},
197 {SET_TRACEEVT, 1, "traceevt", "Log the events: none, common, extra, all"},
198 {SET_TRACESES, 1, "traceses", "Log the sessions: none, all"},
199 {SET_TRACEAPI, 1, "traceapi", "Log the apis: none, common, api, event, all"},
200 {SET_TRACEGLOB, 1, "traceglob", "Log the globals: none, all"},
201 #if !defined(REMOVE_LEGACY_TRACE)
202 {SET_TRACEDITF, 1, "traceditf", "Log the daemons: no, common, all"},
203 {SET_TRACESVC, 1, "tracesvc", "Log the services: no, all"},
206 {ADD_CALL, 1, "call", "Call at start, format of val: API/VERB:json-args"},
208 {SET_NO_HTTPD, 0, "no-httpd", "Forbid HTTP service"},
209 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
211 #if defined(WITH_MONITORING_OPTION)
212 {SET_MONITORING, 0, "monitoring", "Enable HTTP monitoring at <ROOT>/monitoring/"},
215 {SET_CONFIG, 1, "config", "Load options from the given config file"},
216 {SET_OUTPUT, 1, "output", "Redirect stdout and stderr to output file (when --daemon)"},
222 #if defined(WITH_MONITORING_OPTION)
223 static const char MONITORING_ALIAS[] = "/monitoring:"BINDING_INSTALL_DIR"/monitoring";
226 static const struct {
229 } default_optint_values[] = {
230 { SET_PORT, DEFAULT_HTTP_PORT },
231 { SET_API_TIMEOUT, DEFAULT_API_TIMEOUT },
232 { SET_CACHE_TIMEOUT, DEFAULT_CACHE_TIMEOUT },
233 { SET_SESSION_TIMEOUT, DEFAULT_SESSION_TIMEOUT },
234 { SET_SESSIONMAX, DEFAULT_MAX_SESSION_COUNT }
237 static const struct {
240 } default_optstr_values[] = {
241 { SET_WORK_DIR, "." },
242 { SET_ROOT_DIR, "." },
243 { SET_UPLOAD_DIR, "." },
244 { SET_ROOT_BASE, "/opa" },
245 { SET_ROOT_API, "/api" }
248 /**********************************
250 ***********************************/
252 static char *shortopts = NULL;
253 static int *id2idx = NULL;
255 static void *oomchk(void *ptr)
258 ERROR("Out of memory");
264 static char is_short_option(int val)
266 return (val >= 'a' && val <= 'z') || (val >= 'A' && val <= 'Z') || (val >= '0' && val <= '9');
269 static void init_options()
276 for (i = 0 ; optdefs[i].name ; i++) {
280 if (is_short_option(id))
281 ns += 1 + !!optdefs[i].has_arg;
283 shortopts = oomchk(malloc(2 + ns));
284 id2idx = oomchk(calloc(1 + mi, sizeof *id2idx));
285 shortopts[ns = 0] = ':';
286 for (i = 0 ; optdefs[i].name ; i++) {
289 if (is_short_option(id)) {
290 shortopts[++ns] = (char)id;
291 if (optdefs[i].has_arg)
292 shortopts[++ns] = ':';
299 static const char *name_of_optid(int optid)
301 return optdefs[id2idx[optid]].name;
304 static int get_enum_val(const char *name, int optid, int (*func)(const char*))
310 ERROR("option [--%s] bad value (found %s)",
311 name_of_optid(optid), name);
318 /*----------------------------------------------------------
320 | print version and copyright
321 +--------------------------------------------------------- */
322 static void printVersion(FILE * file)
326 " AGL Framework Binder [AFB %s] "
327 #if defined(WITH_DBUS_TRANSPARENCY)
333 #if defined(WITH_MONITORING_OPTION)
339 #if defined(WITH_SUPERVISION)
344 "SUPERVISION [BINDINGS "
345 #if defined(WITH_LEGACY_BINDING_V1)
351 #if defined(WITH_LEGACY_BINDING_VDYN)
361 " Copyright (C) 2015-2018 \"IoT.bzh\"\n"
362 " AFB comes with ABSOLUTELY NO WARRANTY.\n"
363 " Licence Apache 2\n"
367 /*----------------------------------------------------------
369 | print information from long option array
370 +--------------------------------------------------------- */
372 static void printHelp(FILE * file, const char *name)
375 char command[50], sht[4];
377 fprintf(file, "%s:\nallowed options\n", strrchr(name, '/') ? strrchr(name, '/') + 1 : name);
379 for (ind = 0; optdefs[ind].name != NULL; ind++) {
380 if (is_short_option(optdefs[ind].id)) {
382 sht[1] = (char)optdefs[ind].id;
385 sht[0] = sht[1] = sht[2] = ' ';
387 strcpy(command, optdefs[ind].name);
388 if (optdefs[ind].has_arg)
389 strcat(command, "=xxxx");
390 fprintf(file, " %s --%-17s %s\n", sht, command, optdefs[ind].help);
393 "Example:\n %s --verbose --port="
394 d2s(DEFAULT_HTTP_PORT)
395 " --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
399 /**********************************
401 ***********************************/
403 static struct json_object *joomchk(struct json_object *value)
405 return oomchk(value);
408 static struct json_object *to_jstr(const char *value)
410 return joomchk(json_object_new_string(value));
413 static struct json_object *to_jint(int value)
415 return joomchk(json_object_new_int(value));
418 static struct json_object *to_jbool(int value)
420 return joomchk(json_object_new_boolean(value));
423 /**********************************
425 ***********************************/
427 static void noarg(int optid)
430 ERROR("option [--%s] need no value (found %s)", name_of_optid(optid), optarg);
435 static const char *get_arg(int optid)
438 ERROR("option [--%s] needs a value i.e. --%s=xxx",
439 name_of_optid(optid), name_of_optid(optid));
445 static void config_del(struct json_object *config, int optid)
447 return json_object_object_del(config, name_of_optid(optid));
450 static int config_has(struct json_object *config, int optid)
452 return json_object_object_get_ex(config, name_of_optid(optid), NULL);
455 static int config_has_bool(struct json_object *config, int optid)
457 struct json_object *x;
458 return json_object_object_get_ex(config, name_of_optid(optid), &x)
459 && json_object_get_boolean(x);
462 static int config_has_str(struct json_object *config, int optid, const char *val)
465 struct json_object *a;
467 if (!json_object_object_get_ex(config, name_of_optid(optid), &a))
470 if (!json_object_is_type(a, json_type_array))
471 return !strcmp(val, json_object_get_string(a));
473 n = (int)json_object_array_length(a);
474 for (i = 0 ; i < n ; i++) {
475 if (!strcmp(val, json_object_get_string(json_object_array_get_idx(a, i))))
481 static void config_set(struct json_object *config, int optid, struct json_object *val)
483 json_object_object_add(config, name_of_optid(optid), val);
486 static void config_set_str(struct json_object *config, int optid, const char *val)
488 config_set(config, optid, to_jstr(val));
491 static void config_set_optstr(struct json_object *config, int optid)
493 config_set_str(config, optid, get_arg(optid));
496 static void config_set_int(struct json_object *config, int optid, int value)
498 config_set(config, optid, to_jint(value));
501 static void config_set_bool(struct json_object *config, int optid, int value)
503 config_set(config, optid, to_jbool(value));
506 static void config_set_optint_base(struct json_object *config, int optid, int mini, int maxi, int base)
508 const char *beg, *end;
511 beg = get_arg(optid);
512 val = strtol(beg, (char**)&end, base);
513 if (*end || end == beg) {
514 ERROR("option [--%s] requires a valid integer (found %s)",
515 name_of_optid(optid), beg);
518 if (val < (long int)mini || val > (long int)maxi) {
519 ERROR("option [--%s] value %ld out of bounds (not in [%d , %d])",
520 name_of_optid(optid), val, mini, maxi);
523 config_set_int(config, optid, (int)val);
526 static void config_set_optint(struct json_object *config, int optid, int mini, int maxi)
528 return config_set_optint_base(config, optid, mini, maxi, 10);
531 static void config_set_optenum(struct json_object *config, int optid, int (*func)(const char*))
533 const char *name = get_arg(optid);
534 get_enum_val(name, optid, func);
535 config_set_str(config, optid, name);
538 static void config_add(struct json_object *config, int optid, struct json_object *val)
540 struct json_object *a;
541 if (!json_object_object_get_ex(config, name_of_optid(optid), &a)) {
542 a = json_object_new_array();
544 json_object_object_add(config, name_of_optid(optid), a);
546 json_object_array_add(a, val);
549 static void config_add_str(struct json_object *config, int optid, const char *val)
551 config_add(config, optid, to_jstr(val));
554 static void config_add_optstr(struct json_object *config, int optid)
556 config_add_str(config, optid, get_arg(optid));
559 /*---------------------------------------------------------
561 +--------------------------------------------------------- */
563 static void set_log(const char *args)
565 char o = 0, s, *p, *i = strdupa(args);
568 for(;;) switch (*i) {
581 while (isalpha(*p)) p++;
584 lvl = verbose_level_of_name(i);
588 ERROR("Bad log name '%s' in %s", i, args);
606 /*---------------------------------------------------------
607 | Parse option and launch action
608 +--------------------------------------------------------- */
610 static void parse_arguments_inner(int argc, char **argv, struct json_object *config, struct option *options)
612 struct json_object *conf;
617 optid = getopt_long(argc, argv, shortopts, options, NULL);
632 set_log(get_arg(optid));
636 config_set_optint(config, optid, 1024, 32767);
639 case SET_API_TIMEOUT:
640 case SET_SESSION_TIMEOUT:
641 case SET_CACHE_TIMEOUT:
642 config_set_optint(config, optid, 0, INT_MAX);
646 config_set_optint(config, optid, 1, INT_MAX);
657 config_set_optstr(config, optid);
660 #if defined(WITH_DBUS_TRANSPARENCY)
661 case ADD_DBUS_CLIENT:
662 case ADD_DBUS_SERVICE:
666 case ADD_WEAK_LDPATH:
672 config_add_optstr(config, optid);
675 #if defined(WITH_MONITORING_OPTION)
678 case SET_RANDOM_TOKEN:
682 config_set_bool(config, optid, 1);
690 config_set_bool(config, SET_DAEMON, optid != SET_FOREGROUND);
694 config_set_optenum(config, optid, afb_hook_flags_xreq_from_text);
698 config_set_optenum(config, optid, afb_hook_flags_evt_from_text);
702 config_set_optenum(config, optid, afb_hook_flags_session_from_text);
706 config_set_optenum(config, optid, afb_hook_flags_api_from_text);
710 config_set_optenum(config, optid, afb_hook_flags_global_from_text);
713 #if !defined(REMOVE_LEGACY_TRACE)
715 config_set_optenum(config, optid, afb_hook_flags_legacy_ditf_from_text);
719 config_set_optenum(config, optid, afb_hook_flags_legacy_svc_from_text);
724 if (optind == argc) {
725 ERROR("The option --exec requires arguments");
728 while (optind != argc)
729 config_add_str(config, optid, argv[optind++]);
733 conf = json_object_from_file(get_arg(optid));
735 ERROR("Can't read config file %s", get_arg(optid));
738 wrap_json_object_add(config, conf);
739 json_object_put(conf);
744 printVersion(stdout);
748 printHelp(stdout, argv[0]);
752 ERROR("Bad option detected, check %s", argv[cind]);
756 /* TODO: check for extra value */
759 static void parse_arguments(int argc, char **argv, struct json_object *config)
762 struct option *options;
764 /* create GNU getopt options from optdefs */
765 options = malloc((sizeof optdefs / sizeof * optdefs) * sizeof * options);
766 for (ind = 0; optdefs[ind].name; ind++) {
767 options[ind].name = optdefs[ind].name;
768 options[ind].has_arg = optdefs[ind].has_arg;
769 options[ind].flag = NULL;
770 options[ind].val = optdefs[ind].id;
772 memset(&options[ind], 0, sizeof options[ind]);
774 /* parse the arguments */
775 parse_arguments_inner(argc, argv, config, options);
777 /* release the memory of options */
781 static void fulfill_config(struct json_object *config)
785 for (i = 0 ; i < sizeof default_optint_values / sizeof * default_optint_values ; i++)
786 if (!config_has(config, default_optint_values[i].optid))
787 config_set_int(config, default_optint_values[i].optid, default_optint_values[i].valdef);
789 for (i = 0 ; i < sizeof default_optstr_values / sizeof * default_optstr_values ; i++)
790 if (!config_has(config, default_optstr_values[i].optid))
791 config_set_str(config, default_optstr_values[i].optid, default_optstr_values[i].valdef);
793 // default AUTH_TOKEN
794 if (config_has_bool(config, SET_RANDOM_TOKEN))
795 config_del(config, SET_TOKEN);
797 if (!config_has(config, ADD_LDPATH) && !config_has(config, ADD_WEAK_LDPATH) && !config_has_bool(config, SET_NO_LDPATH))
798 config_add_str(config, ADD_LDPATH, BINDING_INSTALL_DIR);
800 #if defined(WITH_MONITORING_OPTION)
801 if (config_has_bool(config, SET_MONITORING) && !config_has_str(config, ADD_ALIAS, MONITORING_ALIAS))
802 config_add_str(config, ADD_ALIAS, MONITORING_ALIAS);
805 #if !defined(REMOVE_LEGACY_TRACE) && 0
806 config->traceapi |= config->traceditf | config->tracesvc;
810 static void dump(struct json_object *config, FILE *file, const char *prefix, const char *title)
813 const char *head, *tail;
821 fprintf(file, "%s----BEGIN OF %s-----\n", prefix, title);
823 head = json_object_to_json_string_ext(config, JSON_C_TO_STRING_PRETTY
824 |JSON_C_TO_STRING_SPACED|JSON_C_TO_STRING_NOSLASHESCAPE);
828 for (tail = head ; *tail && *tail != '\n' ; tail++);
829 fprintf(file, "%s %.*s\n", prefix, (int)(tail - head), head);
830 head = tail + !!*tail;
835 fprintf(file, "%s----END OF %s-----\n", prefix, title);
838 void afb_config_dump(struct json_object *config)
840 dump(config, stderr, "--", "CONFIG");
843 static void on_environment_add(struct json_object *config, int optid, const char *name)
845 char *value = getenv(name);
848 config_add_str(config, optid, value);
851 static void on_environment_enum(struct json_object *config, int optid, const char *name, int (*func)(const char*))
853 char *value = getenv(name);
856 if (func(value) == -1)
857 WARNING("Unknown value %s for environment variable %s, ignored", value, name);
859 config_set_str(config, optid, value);
863 static void parse_environment(struct json_object *config)
865 on_environment_enum(config, SET_TRACEREQ, "AFB_TRACEREQ", afb_hook_flags_xreq_from_text);
866 on_environment_enum(config, SET_TRACEEVT, "AFB_TRACEEVT", afb_hook_flags_evt_from_text);
867 on_environment_enum(config, SET_TRACESES, "AFB_TRACESES", afb_hook_flags_session_from_text);
868 on_environment_enum(config, SET_TRACEAPI, "AFB_TRACEAPI", afb_hook_flags_api_from_text);
869 on_environment_enum(config, SET_TRACEGLOB, "AFB_TRACEGLOB", afb_hook_flags_global_from_text);
870 on_environment_add(config, ADD_LDPATH, "AFB_LDPATHS");
871 #if !defined(REMOVE_LEGACY_TRACE)
872 on_environment_enum(config, SET_TRACEDITF, "AFB_TRACEDITF", afb_hook_flags_legacy_ditf_from_text);
873 on_environment_enum(config, SET_TRACESVC, "AFB_TRACESVC", afb_hook_flags_legacy_svc_from_text);
877 struct json_object *afb_config_parse_arguments(int argc, char **argv)
879 struct json_object *result;
883 result = json_object_new_object();
885 parse_environment(result);
886 parse_arguments(argc, argv, result);
887 fulfill_config(result);
888 if (verbose_wants(Log_Level_Info))
889 afb_config_dump(result);
893 struct json_object *afb_config_json(struct json_object *config)