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
29 #include "afb-config.h"
32 #include <afb/afb-binding-v1.h>
34 #if !defined(BINDING_INSTALL_DIR)
35 #error "you should define BINDING_INSTALL_DIR"
38 #define AFB_VERSION "0.6"
41 #define DEFLT_CNTX_TIMEOUT 3600 // default Client Connection
43 #define DEFLT_API_TIMEOUT 20 // default Plugin API Timeout [0=NoLimit
45 #define DEFLT_CACHE_TIMEOUT 100000 // default Static File Chache
48 #define CTX_NBCLIENTS 10 // allow a default of 10 authenticated
52 // Define command line option
53 #define SET_BACKGROUND 2
54 #define SET_FORGROUND 3
56 #define SET_ROOT_DIR 6
57 #define SET_ROOT_BASE 7
58 #define SET_ROOT_API 8
61 #define SET_CACHE_TIMEOUT 10
62 #define SET_SESSION_DIR 11
65 #define SET_APITIMEOUT 14
66 #define SET_CNTXTIMEOUT 15
67 #define SET_WEAK_LDPATH 16
72 #define DBUS_CLIENT 20
73 #define DBUS_SERVICE 21
76 #define SET_SESSIONMAX 23
81 #define SET_ROOT_HTTP 26
83 #define SET_NO_HTTPD 28
86 #define SET_TRACEDITF 'D'
87 #define SET_TRACEEVT 'E'
89 #define DISPLAY_HELP 'h'
90 #if defined(WITH_MONITORING_OPTION)
91 #define SET_MONITORING 'M'
94 #define SET_TCP_PORT 'p'
96 #define SET_RNDTOKEN 'r'
97 #define SET_TRACESVC 'S'
98 #define SET_TRACEREQ 'T'
99 #define SET_AUTH_TOKEN 't'
100 #define SET_UPLOAD_DIR 'u'
101 #define DISPLAY_VERSION 'V'
102 #define SET_VERBOSE 'v'
103 #define SET_WORK_DIR 'w'
105 const char shortopts[] =
106 "c:D:E:ehn:p:qrT:t:u:Vvw:"
107 #if defined(WITH_MONITORING_OPTION)
112 // Command line structure hold cli --command + help text
114 int val; // command number within application
115 int has_arg; // command number within application
116 char *name; // command as used in --xxxx cli
117 char *help; // help text
121 static AFB_options cliOptions[] = {
123 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
124 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
126 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
127 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
129 {SET_NAME, 1, "name", "Set the visible name"},
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","Enforce 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_OPTION)
177 {SET_MONITORING, 0, "monitoring", "enable HTTP monitoring at <ROOT>/monitoring/"},
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 void list_add(struct afb_config_list **head, char *value)
271 struct afb_config_list *item;
277 while (item != NULL) {
285 item = malloc(sizeof *item);
287 ERROR("out of memory");
299 /*---------------------------------------------------------
300 | helpers for argument scanning
301 +--------------------------------------------------------- */
303 static const char *name_of_option(int optc)
305 AFB_options *o = cliOptions;
306 while (o->name && o->val != optc)
308 return o->name ? : "<unknown-option-name>";
311 static const char *current_argument(int optc)
314 ERROR("option [--%s] needs a value i.e. --%s=xxx",
315 name_of_option(optc), name_of_option(optc));
321 static char *argvalstr(int optc)
323 char *result = strdup(current_argument(optc));
324 if (result == NULL) {
325 ERROR("can't alloc memory");
331 static int argvalenum(int optc, struct enumdesc *desc)
336 const char *name = current_argument(optc);
339 while(desc[i].name && strcmp(desc[i].name, name))
345 len += strlen(desc[i++].name);
346 list = malloc(len + i + i);
348 ERROR("option [--%s] bad value (found %s)",
349 name_of_option(optc), name);
352 strcpy(list, desc[i].name ? : "");
353 while(desc[++i].name)
354 strcat(strcat(list, ", "), desc[i].name);
355 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
356 name_of_option(optc), list, name);
361 return desc[i].value;
364 static int argvalint(int optc, int mini, int maxi, int base)
366 const char *beg, *end;
368 beg = current_argument(optc);
369 val = strtol(beg, (char**)&end, base);
370 if (*end || end == beg) {
371 ERROR("option [--%s] requires a valid integer (found %s)",
372 name_of_option(optc), beg);
375 if (val < (long int)mini || val > (long int)maxi) {
376 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
377 name_of_option(optc), mini, val, maxi);
383 static int argvalintdec(int optc, int mini, int maxi)
385 return argvalint(optc, mini, maxi, 10);
388 static void noarg(int optc)
391 ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
396 static char **make_exec(char **argv)
398 char **result, *iter;
403 for (i = 0 ; argv[i] ; i++)
404 length += strlen(argv[i]) + 1;
406 result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
407 if (result == NULL) {
408 ERROR("can't alloc memory");
412 iter = (char*)&result[i+1];
413 for (i = 0 ; argv[i] ; i++) {
415 iter = stpcpy(iter, argv[i]) + 1;
421 /*---------------------------------------------------------
422 | Parse option and launch action
423 +--------------------------------------------------------- */
425 static void parse_arguments(int argc, char **argv, struct afb_config *config)
427 char *programName = argv[0];
430 struct option *gnuOptions;
432 // ------------------ Process Command Line -----------------------
434 // build GNU getopt info from cliOptions
435 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
436 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
437 for (ind = 0; ind < nbcmd; ind++) {
438 gnuOptions[ind].name = cliOptions[ind].name;
439 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
440 gnuOptions[ind].flag = 0;
441 gnuOptions[ind].val = cliOptions[ind].val;
444 // get all options from command line
445 while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
456 config->httpdPort = argvalintdec(optc, 1024, 32767);
460 config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
463 case SET_CNTXTIMEOUT:
464 config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
468 config->rootdir = argvalstr(optc);
469 INFO("Forcing Rootdir=%s", config->rootdir);
473 config->roothttp = argvalstr(optc);
474 INFO("Forcing Root HTTP=%s", config->roothttp);
478 config->rootbase = argvalstr(optc);
479 INFO("Forcing Rootbase=%s", config->rootbase);
483 config->rootapi = argvalstr(optc);
484 INFO("Forcing Rootapi=%s", config->rootapi);
488 list_add(&config->aliases, argvalstr(optc));
492 config->token = argvalstr(optc);
496 list_add(&config->ldpaths, argvalstr(optc));
499 case SET_WEAK_LDPATH:
500 list_add(&config->weak_ldpaths, argvalstr(optc));
505 config->no_ldpaths = 1;
509 list_add(&config->calls, argvalstr(optc));
512 case SET_SESSION_DIR:
513 /* config->sessiondir = argvalstr(optc); */
514 WARNING("Obsolete option %s ignored", name_of_option(optc));
518 config->uploaddir = argvalstr(optc);
522 config->workdir = argvalstr(optc);
525 case SET_CACHE_TIMEOUT:
526 config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
530 config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
535 config->background = 0;
540 config->background = 1;
544 config->name = argvalstr(optc);
548 config->mode = argvalenum(optc, mode_desc);
552 list_add(&config->dbus_clients, argvalstr(optc));
556 list_add(&config->dbus_servers, argvalstr(optc));
560 list_add(&config->ws_clients, argvalstr(optc));
564 list_add(&config->ws_servers, argvalstr(optc));
568 list_add(&config->so_bindings, argvalstr(optc));
572 config->tracereq = argvalenum(optc, tracereq_desc);
576 config->traceditf = argvalenum(optc, traceditf_desc);
580 config->tracesvc = argvalenum(optc, tracesvc_desc);
584 config->traceevt = argvalenum(optc, traceevt_desc);
593 config->exec = make_exec(&argv[optind]);
594 optind = argc; /* stop option scanning */
598 config->random_token = 1;
601 #if defined(WITH_MONITORING_OPTION)
603 config->monitoring = 1;
607 case DISPLAY_VERSION:
609 printVersion(stdout);
613 printHelp(stdout, programName);
623 static void fulfill_config(struct afb_config *config)
626 if (config->httpdPort == 0)
627 config->httpdPort = 1234;
629 // default binding API timeout
630 if (config->apiTimeout == 0)
631 config->apiTimeout = DEFLT_API_TIMEOUT;
633 // default AUTH_TOKEN
634 if (config->random_token)
635 config->token = NULL;
637 // cache timeout default one hour
638 if (config->cacheTimeout == 0)
639 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
641 // cache timeout default one hour
642 if (config->cntxTimeout == 0)
643 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
645 // max count of sessions
646 if (config->nbSessionMax == 0)
647 config->nbSessionMax = CTX_NBCLIENTS;
649 /* set directories */
650 if (config->workdir == NULL)
651 config->workdir = ".";
653 if (config->rootdir == NULL)
654 config->rootdir = ".";
656 if (config->uploaddir == NULL)
657 config->uploaddir = ".";
659 // if no Angular/HTML5 rootbase let's try '/' as default
660 if (config->rootbase == NULL)
661 config->rootbase = "/opa";
663 if (config->rootapi == NULL)
664 config->rootapi = "/api";
666 if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
667 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
669 #if defined(WITH_MONITORING_OPTION)
670 if (config->monitoring)
671 list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
674 // if no config dir create a default path from uploaddir
675 if (config->console == NULL) {
676 config->console = malloc(512);
677 strncpy(config->console, config->uploaddir, 512);
678 strncat(config->console, "/AFB-console.out", 512);
682 void afb_config_dump(struct afb_config *config)
684 struct afb_config_list *l;
688 #define NN(x) (x)?:""
689 #define P(...) fprintf(stderr, __VA_ARGS__)
690 #define PF(x) P("-- %15s: ", #x)
692 #define S(x) PF(x);P("%s",NN(config->x));PE;
693 #define D(x) PF(x);P("%d",config->x);PE;
694 #define H(x) PF(x);P("%x",config->x);PE;
695 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
696 #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;
697 #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);}
698 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
700 P("---BEGIN-OF-CONFIG---\n");
730 E(tracereq,tracereq_desc)
731 E(traceditf,traceditf_desc)
732 E(tracesvc,tracesvc_desc)
733 E(traceevt,traceevt_desc)
740 P("---END-OF-CONFIG---\n");
755 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
757 struct afb_config *result;
759 result = calloc(1, sizeof *result);
761 parse_arguments(argc, argv, result);
762 fulfill_config(result);
764 afb_config_dump(result);