2 * Copyright (C) 2015, 2016, 2017 "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.
19 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
28 #include <uuid/uuid.h>
31 #include "afb-config.h"
34 #include <afb/afb-binding-v1.h>
36 #if !defined(BINDING_INSTALL_DIR)
37 #error "you should define BINDING_INSTALL_DIR"
40 #define AFB_VERSION "0.6"
43 #define DEFLT_CNTX_TIMEOUT 3600 // default Client Connection
45 #define DEFLT_API_TIMEOUT 20 // default Plugin API Timeout [0=NoLimit
47 #define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache
50 #define DEFLT_AUTH_TOKEN NULL // expect for debug should == NULL
51 #define CTX_NBCLIENTS 10 // allow a default of 10 authenticated
55 // Define command line option
56 #define SET_BACKGROUND 2
57 #define SET_FORGROUND 3
59 #define SET_ROOT_DIR 6
60 #define SET_ROOT_BASE 7
61 #define SET_ROOT_API 8
64 #define SET_CACHE_TIMEOUT 10
65 #define SET_SESSION_DIR 11
68 #define SET_APITIMEOUT 14
69 #define SET_CNTXTIMEOUT 15
70 #define SET_WEAK_LDPATH 16
75 #define DBUS_CLIENT 20
76 #define DBUS_SERVICE 21
79 #define SET_SESSIONMAX 23
84 #define SET_ROOT_HTTP 26
86 #define SET_NO_HTTPD 28
89 #define SET_TRACEDITF 'D'
90 #define SET_TRACEEVT 'E'
92 #define DISPLAY_HELP 'h'
93 #if defined(WITH_MONITORING_OTPION)
94 #define SET_MONITORING 'M'
96 #define SET_TCP_PORT 'p'
98 #define SET_RNDTOKEN 'r'
99 #define SET_TRACESVC 'S'
100 #define SET_TRACEREQ 'T'
101 #define SET_AUTH_TOKEN 't'
102 #define SET_UPLOAD_DIR 'u'
103 #define DISPLAY_VERSION 'V'
104 #define SET_VERBOSE 'v'
105 #define SET_WORK_DIR 'w'
107 const char shortopts[] =
108 "c:D:E:ehp:qrT:t:u:Vvw:"
109 #if defined(WITH_MONITORING_OTPION)
114 // Command line structure hold cli --command + help text
116 int val; // command number within application
117 int has_arg; // command number within application
118 char *name; // command as used in --xxxx cli
119 char *help; // help text
123 static AFB_options cliOptions[] = {
125 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
126 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
128 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
129 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
131 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default 1234]"},
132 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
133 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
134 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
135 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
137 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default 10]"},
138 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
139 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default 3600]"},
141 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
142 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
143 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
144 {SET_SESSION_DIR, 1, "sessiondir", "OBSOLETE (was: Sessions file path)"},
146 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
147 {SO_BINDING, 1, "binding", "Load the binding of path"},
148 {SET_WEAK_LDPATH, 1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
149 {NO_LDPATH, 0, "no-ldpaths", "Discard default ldpaths loading"},
151 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=no-session, --token= for session without authentication]"},
152 {SET_RNDTOKEN, 0, "random-token","Creates a random token"},
154 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
155 {DISPLAY_HELP, 0, "help", "Display this help"},
157 {SET_MODE, 1, "mode", "Set the mode: either local, remote or global"},
159 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
160 {DBUS_SERVICE, 1, "dbus-server", "Provides an afb service through dbus"},
161 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
162 {WS_SERVICE, 1, "ws-server", "Provides an afb service through websockets"},
164 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
166 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
167 {SET_TRACEDITF, 1, "traceditf", "Log the requests: no, common, extra, all"},
168 {SET_TRACESVC, 1, "tracesvc", "Log the requests: no, all"},
169 {SET_TRACEEVT, 1, "traceevt", "Log the requests: no, common, extra, all"},
171 {ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
173 {SET_NO_HTTPD, 0, "no-httpd", "Forbids HTTP service"},
174 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
176 #if defined(WITH_MONITORING_OTPION)
177 {SET_MONITORING, 0, "monitoring", "enable HTTP monitoring at <ROOT>/monitoring/monitor.html"},
190 static struct enumdesc tracereq_desc[] = {
192 { "common", afb_hook_flags_req_common },
193 { "extra", afb_hook_flags_req_extra },
194 { "all", afb_hook_flags_req_all },
198 static struct enumdesc traceditf_desc[] = {
200 { "common", afb_hook_flags_ditf_common },
201 { "extra", afb_hook_flags_ditf_extra },
202 { "all", afb_hook_flags_ditf_all },
206 static struct enumdesc tracesvc_desc[] = {
208 { "all", afb_hook_flags_svc_all },
212 static struct enumdesc traceevt_desc[] = {
214 { "common", afb_hook_flags_evt_common },
215 { "extra", afb_hook_flags_evt_extra },
216 { "all", afb_hook_flags_evt_all },
220 static struct enumdesc mode_desc[] = {
221 { "local", AFB_MODE_LOCAL },
222 { "remote", AFB_MODE_REMOTE },
223 { "global", AFB_MODE_GLOBAL },
227 /*----------------------------------------------------------
229 | print version and copyright
230 +--------------------------------------------------------- */
231 static void printVersion(FILE * file)
233 fprintf(file, "\n----------------------------------------- \n");
234 fprintf(file, " AFB [Application Framework Binder] version=%s |\n",
236 fprintf(file, " \n");
238 " Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
239 fprintf(file, " AFB comes with ABSOLUTELY NO WARRANTY.\n");
240 fprintf(file, " Licence Apache 2\n\n");
243 /*----------------------------------------------------------
245 | print information from long option array
246 +--------------------------------------------------------- */
248 static void printHelp(FILE * file, const char *name)
253 fprintf(file, "%s:\nallowed options\n", name);
254 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
255 strcpy(command, cliOptions[ind].name);
256 if (cliOptions[ind].has_arg)
257 strcat(command, "=xxxx");
258 fprintf(file, " --%-15s %s\n", command, cliOptions[ind].help);
261 "Example:\n %s --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
266 /*----------------------------------------------------------
267 | adds a string to the list
268 +--------------------------------------------------------- */
269 static char *random_token()
271 static char uuidstr[37];
273 uuid_generate_random(uuid);
274 uuid_unparse(uuid, uuidstr);
278 /*----------------------------------------------------------
279 | adds a string to the list
280 +--------------------------------------------------------- */
281 static void list_add(struct afb_config_list **head, char *value)
283 struct afb_config_list *item;
289 while (item != NULL) {
297 item = malloc(sizeof *item);
299 ERROR("out of memory");
311 /*---------------------------------------------------------
312 | helpers for argument scanning
313 +--------------------------------------------------------- */
315 static const char *name_of_option(int optc)
317 AFB_options *o = cliOptions;
318 while (o->name && o->val != optc)
320 return o->name ? : "<unknown-option-name>";
323 static const char *current_argument(int optc)
326 ERROR("option [--%s] needs a value i.e. --%s=xxx",
327 name_of_option(optc), name_of_option(optc));
333 static char *argvalstr(int optc)
335 char *result = strdup(current_argument(optc));
336 if (result == NULL) {
337 ERROR("can't alloc memory");
343 static int argvalenum(int optc, struct enumdesc *desc)
348 const char *name = current_argument(optc);
351 while(desc[i].name && strcmp(desc[i].name, name))
357 len += strlen(desc[i++].name);
358 list = malloc(len + i + i);
360 ERROR("option [--%s] bad value (found %s)",
361 name_of_option(optc), name);
364 strcpy(list, desc[i].name ? : "");
365 while(desc[++i].name)
366 strcat(strcat(list, ", "), desc[i].name);
367 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
368 name_of_option(optc), list, name);
373 return desc[i].value;
376 static int argvalint(int optc, int mini, int maxi, int base)
378 const char *beg, *end;
380 beg = current_argument(optc);
381 val = strtol(beg, (char**)&end, base);
382 if (*end || end == beg) {
383 ERROR("option [--%s] requires a valid integer (found %s)",
384 name_of_option(optc), beg);
387 if (val < (long int)mini || val > (long int)maxi) {
388 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
389 name_of_option(optc), mini, val, maxi);
395 static int argvalintdec(int optc, int mini, int maxi)
397 return argvalint(optc, mini, maxi, 10);
400 static void noarg(int optc)
403 ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
408 /*---------------------------------------------------------
409 | Parse option and launch action
410 +--------------------------------------------------------- */
412 static void parse_arguments(int argc, char **argv, struct afb_config *config)
414 char *programName = argv[0];
417 struct option *gnuOptions;
419 // ------------------ Process Command Line -----------------------
421 // build GNU getopt info from cliOptions
422 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
423 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
424 for (ind = 0; ind < nbcmd; ind++) {
425 gnuOptions[ind].name = cliOptions[ind].name;
426 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
427 gnuOptions[ind].flag = 0;
428 gnuOptions[ind].val = cliOptions[ind].val;
431 // get all options from command line
432 while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
443 config->httpdPort = argvalintdec(optc, 1024, 32767);
447 config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
450 case SET_CNTXTIMEOUT:
451 config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
455 config->rootdir = argvalstr(optc);
456 INFO("Forcing Rootdir=%s", config->rootdir);
460 config->roothttp = argvalstr(optc);
461 INFO("Forcing Root HTTP=%s", config->roothttp);
465 config->rootbase = argvalstr(optc);
466 INFO("Forcing Rootbase=%s", config->rootbase);
470 config->rootapi = argvalstr(optc);
471 INFO("Forcing Rootapi=%s", config->rootapi);
475 list_add(&config->aliases, argvalstr(optc));
479 config->token = argvalstr(optc);
483 list_add(&config->ldpaths, argvalstr(optc));
486 case SET_WEAK_LDPATH:
487 list_add(&config->weak_ldpaths, argvalstr(optc));
492 config->no_ldpaths = 1;
496 list_add(&config->calls, argvalstr(optc));
499 case SET_SESSION_DIR:
500 /* config->sessiondir = argvalstr(optc); */
501 WARNING("Obsolete otpion %s ignored", name_of_option(optc));
505 config->uploaddir = argvalstr(optc);
509 config->workdir = argvalstr(optc);
512 case SET_CACHE_TIMEOUT:
513 config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
517 config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
522 config->background = 0;
527 config->background = 1;
531 config->mode = argvalenum(optc, mode_desc);
535 list_add(&config->dbus_clients, argvalstr(optc));
539 list_add(&config->dbus_servers, argvalstr(optc));
543 list_add(&config->ws_clients, argvalstr(optc));
547 list_add(&config->ws_servers, argvalstr(optc));
551 list_add(&config->so_bindings, argvalstr(optc));
555 config->tracereq = argvalenum(optc, tracereq_desc);
559 config->traceditf = argvalenum(optc, traceditf_desc);
563 config->tracesvc = argvalenum(optc, tracesvc_desc);
567 config->traceevt = argvalenum(optc, traceevt_desc);
576 config->exec = &argv[optind];
581 config->token = random_token();
583 #if defined(WITH_MONITORING_OTPION)
585 config->monitoring = 1;
589 case DISPLAY_VERSION:
591 printVersion(stdout);
595 printHelp(stdout, programName);
605 // load config from disk and merge with CLI option
606 static void config_set_default(struct afb_config *config)
609 if (config->httpdPort == 0)
610 config->httpdPort = 1234;
612 // default binding API timeout
613 if (config->apiTimeout == 0)
614 config->apiTimeout = DEFLT_API_TIMEOUT;
616 // default AUTH_TOKEN
617 if (config->token == NULL)
618 config->token = DEFLT_AUTH_TOKEN;
620 // cache timeout default one hour
621 if (config->cacheTimeout == 0)
622 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
624 // cache timeout default one hour
625 if (config->cntxTimeout == 0)
626 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
628 // max count of sessions
629 if (config->nbSessionMax == 0)
630 config->nbSessionMax = CTX_NBCLIENTS;
632 /* set directories */
633 if (config->workdir == NULL)
634 config->workdir = ".";
636 if (config->rootdir == NULL)
637 config->rootdir = ".";
639 if (config->uploaddir == NULL)
640 config->uploaddir = ".";
642 // if no Angular/HTML5 rootbase let's try '/' as default
643 if (config->rootbase == NULL)
644 config->rootbase = "/opa";
646 if (config->rootapi == NULL)
647 config->rootapi = "/api";
649 if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
650 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
652 #if defined(WITH_MONITORING_OTPION)
653 if (config->monitoring)
654 list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
657 // if no config dir create a default path from uploaddir
658 if (config->console == NULL) {
659 config->console = malloc(512);
660 strncpy(config->console, config->uploaddir, 512);
661 strncat(config->console, "/AFB-console.out", 512);
665 void afb_config_dump(struct afb_config *config)
667 struct afb_config_list *l;
671 #define NN(x) (x)?:""
672 #define P(...) fprintf(stderr, __VA_ARGS__)
673 #define PF(x) P("-- %15s: ", #x)
675 #define S(x) PF(x);P("%s",NN(config->x));PE;
676 #define D(x) PF(x);P("%d",config->x);PE;
677 #define H(x) PF(x);P("%x",config->x);PE;
678 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
679 #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;
680 #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);}
681 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
683 P("---BEGIN-OF-CONFIG---\n");
711 E(tracereq,tracereq_desc)
712 E(traceditf,traceditf_desc)
714 P("---END-OF-CONFIG---\n");
729 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
731 struct afb_config *result;
733 result = calloc(1, sizeof *result);
735 parse_arguments(argc, argv, result);
736 config_set_default(result);
738 afb_config_dump(result);