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.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_TCP_PORT 5
60 #define SET_ROOT_DIR 6
61 #define SET_ROOT_BASE 7
62 #define SET_ROOT_API 8
65 #define SET_CACHE_TIMEOUT 10
66 #define SET_SESSION_DIR 11
69 #define SET_APITIMEOUT 14
70 #define SET_CNTXTIMEOUT 15
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'
91 #define DISPLAY_HELP 'h'
93 #define SET_RNDTOKEN 'r'
94 #define SET_TRACESVC 'S'
95 #define SET_TRACEREQ 'T'
96 #define SET_AUTH_TOKEN 't'
97 #define SET_UPLOAD_DIR 'u'
98 #define DISPLAY_VERSION 'V'
99 #define SET_VERBOSE 'v'
100 #define SET_WORK_DIR 'w'
102 #define SHORTOPTS "c:D:ehqrT:t:u:Vvw:"
104 // Command line structure hold cli --command + help text
106 int val; // command number within application
107 int has_arg; // command number within application
108 char *name; // command as used in --xxxx cli
109 char *help; // help text
113 static AFB_options cliOptions[] = {
115 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
116 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
118 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
119 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
121 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default 1234]"},
122 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
123 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
124 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
125 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
127 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default 10]"},
128 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
129 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default 3600]"},
131 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
132 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
133 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
134 {SET_SESSION_DIR, 1, "sessiondir", "OBSOLETE (was: Sessions file path)"},
136 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
137 {SO_BINDING, 1, "binding", "Load the binding of path"},
139 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=no-session, --token= for session without authentication]"},
140 {SET_RNDTOKEN, 0, "random-token","Creates a random token"},
142 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
143 {DISPLAY_HELP, 0, "help", "Display this help"},
145 {SET_MODE, 1, "mode", "Set the mode: either local, remote or global"},
147 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
148 {DBUS_SERVICE, 1, "dbus-server", "Provides an afb service through dbus"},
149 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
150 {WS_SERVICE, 1, "ws-server", "Provides an afb service through websockets"},
152 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
154 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
155 {SET_TRACEDITF, 1, "traceditf", "Log the requests: no, common, extra, all"},
156 {SET_TRACESVC, 1, "tracesvc", "Log the requests: no, all"},
157 {ADD_CALL, 1, "call", "call at start format of val: API/VERB:json-args"},
159 {SET_NO_HTTPD, 0, "no-httpd", "Forbids HTTP service"},
160 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
173 static struct enumdesc tracereq_desc[] = {
175 { "common", afb_hook_flags_req_common },
176 { "extra", afb_hook_flags_req_extra },
177 { "all", afb_hook_flags_req_all },
181 static struct enumdesc traceditf_desc[] = {
183 { "common", afb_hook_flags_ditf_common },
184 { "extra", afb_hook_flags_ditf_extra },
185 { "all", afb_hook_flags_ditf_all },
189 static struct enumdesc tracesvc_desc[] = {
191 { "all", afb_hook_flags_svc_all },
195 static struct enumdesc mode_desc[] = {
196 { "local", AFB_MODE_LOCAL },
197 { "remote", AFB_MODE_REMOTE },
198 { "global", AFB_MODE_GLOBAL },
202 /*----------------------------------------------------------
204 | print version and copyright
205 +--------------------------------------------------------- */
206 static void printVersion(FILE * file)
208 fprintf(file, "\n----------------------------------------- \n");
209 fprintf(file, " AFB [Application Framework Binder] version=%s |\n",
211 fprintf(file, " \n");
213 " Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
214 fprintf(file, " AFB comes with ABSOLUTELY NO WARRANTY.\n");
215 fprintf(file, " Licence Apache 2\n\n");
218 /*----------------------------------------------------------
220 | print information from long option array
221 +--------------------------------------------------------- */
223 static void printHelp(FILE * file, const char *name)
228 fprintf(file, "%s:\nallowed options\n", name);
229 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
230 strcpy(command, cliOptions[ind].name);
231 if (cliOptions[ind].has_arg)
232 strcat(command, "=xxxx");
233 fprintf(file, " --%-15s %s\n", command, cliOptions[ind].help);
236 "Example:\n %s --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
241 /*----------------------------------------------------------
242 | adds a string to the list
243 +--------------------------------------------------------- */
244 static char *random_token()
246 static char uuidstr[37];
248 uuid_generate_random(uuid);
249 uuid_unparse(uuid, uuidstr);
253 /*----------------------------------------------------------
254 | adds a string to the list
255 +--------------------------------------------------------- */
256 static void list_add(struct afb_config_list **head, char *value)
258 struct afb_config_list *item;
264 while (item != NULL) {
272 item = malloc(sizeof *item);
274 ERROR("out of memory");
286 /*---------------------------------------------------------
287 | helpers for argument scanning
288 +--------------------------------------------------------- */
290 static const char *optname(int optc)
292 AFB_options *o = cliOptions;
293 while (o->name && o->val != optc)
295 return o->name ? : "<unknown-option-name>";
298 static char *argvalstr(int optc)
301 ERROR("option [--%s] needs a value i.e. --%s=xxx",
302 optname(optc), optname(optc));
308 static int argvalenum(int optc, struct enumdesc *desc)
312 char *list, *name = argvalstr(optc);
315 while(desc[i].name && strcmp(desc[i].name, name))
321 len += strlen(desc[i++].name);
322 list = malloc(len + i + i);
324 ERROR("option [--%s] bad value (found %s)",
325 optname(optc), name);
328 strcpy(list, desc[i].name ? : "");
329 while(desc[++i].name)
330 strcat(strcat(list, ", "), desc[i].name);
331 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
332 optname(optc), list, name);
337 return desc[i].value;
340 static int argvalint(int optc, int mini, int maxi, int base)
344 beg = argvalstr(optc);
345 val = strtol(beg, &end, base);
346 if (*end || end == beg) {
347 ERROR("option [--%s] requires a valid integer (found %s)",
351 if (val < (long int)mini || val > (long int)maxi) {
352 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
353 optname(optc), mini, val, maxi);
359 static int argvalintdec(int optc, int mini, int maxi)
361 return argvalint(optc, mini, maxi, 10);
364 static void noarg(int optc)
367 ERROR("option [--%s] need no value (found %s)", optname(optc), optarg);
372 /*---------------------------------------------------------
373 | Parse option and launch action
374 +--------------------------------------------------------- */
376 static void parse_arguments(int argc, char **argv, struct afb_config *config)
378 char *programName = argv[0];
381 struct option *gnuOptions;
383 // ------------------ Process Command Line -----------------------
385 // build GNU getopt info from cliOptions
386 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
387 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
388 for (ind = 0; ind < nbcmd; ind++) {
389 gnuOptions[ind].name = cliOptions[ind].name;
390 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
391 gnuOptions[ind].flag = 0;
392 gnuOptions[ind].val = cliOptions[ind].val;
395 // get all options from command line
396 while ((optc = getopt_long(argc, argv, SHORTOPTS, gnuOptions, NULL)) != EOF) {
407 config->httpdPort = argvalintdec(optc, 1024, 32767);
411 config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
414 case SET_CNTXTIMEOUT:
415 config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
419 config->rootdir = argvalstr(optc);
420 INFO("Forcing Rootdir=%s", config->rootdir);
424 config->roothttp = argvalstr(optc);
425 INFO("Forcing Root HTTP=%s", config->roothttp);
429 config->rootbase = argvalstr(optc);
430 INFO("Forcing Rootbase=%s", config->rootbase);
434 config->rootapi = argvalstr(optc);
435 INFO("Forcing Rootapi=%s", config->rootapi);
439 list_add(&config->aliases, argvalstr(optc));
443 config->token = argvalstr(optc);
447 list_add(&config->ldpaths, argvalstr(optc));
451 list_add(&config->calls, argvalstr(optc));
454 case SET_SESSION_DIR:
455 /* config->sessiondir = argvalstr(optc); */
456 WARNING("Obsolete otpion %s ignored", optname(optc));
460 config->uploaddir = argvalstr(optc);
464 config->workdir = argvalstr(optc);
467 case SET_CACHE_TIMEOUT:
468 config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
472 config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
477 config->background = 0;
482 config->background = 1;
486 config->mode = argvalenum(optc, mode_desc);
490 list_add(&config->dbus_clients, argvalstr(optc));
494 list_add(&config->dbus_servers, argvalstr(optc));
498 list_add(&config->ws_clients, argvalstr(optc));
502 list_add(&config->ws_servers, argvalstr(optc));
506 list_add(&config->so_bindings, argvalstr(optc));
510 config->tracereq = argvalenum(optc, tracereq_desc);
514 config->traceditf = argvalenum(optc, traceditf_desc);
518 config->tracesvc = argvalenum(optc, tracesvc_desc);
527 config->exec = &argv[optind];
532 config->token = random_token();
535 case DISPLAY_VERSION:
537 printVersion(stdout);
541 printHelp(stdout, programName);
551 // load config from disk and merge with CLI option
552 static void config_set_default(struct afb_config *config)
555 if (config->httpdPort == 0)
556 config->httpdPort = 1234;
558 // default binding API timeout
559 if (config->apiTimeout == 0)
560 config->apiTimeout = DEFLT_API_TIMEOUT;
562 // default AUTH_TOKEN
563 if (config->token == NULL)
564 config->token = DEFLT_AUTH_TOKEN;
566 // cache timeout default one hour
567 if (config->cacheTimeout == 0)
568 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
570 // cache timeout default one hour
571 if (config->cntxTimeout == 0)
572 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
574 // max count of sessions
575 if (config->nbSessionMax == 0)
576 config->nbSessionMax = CTX_NBCLIENTS;
578 /* set directories */
579 if (config->workdir == NULL)
580 config->workdir = ".";
582 if (config->rootdir == NULL)
583 config->rootdir = ".";
585 if (config->uploaddir == NULL)
586 config->uploaddir = ".";
588 // if no Angular/HTML5 rootbase let's try '/' as default
589 if (config->rootbase == NULL)
590 config->rootbase = "/opa";
592 if (config->rootapi == NULL)
593 config->rootapi = "/api";
595 if (config->ldpaths == NULL)
596 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
598 // if no config dir create a default path from uploaddir
599 if (config->console == NULL) {
600 config->console = malloc(512);
601 strncpy(config->console, config->uploaddir, 512);
602 strncat(config->console, "/AFB-console.out", 512);
606 void afb_config_dump(struct afb_config *config)
608 struct afb_config_list *l;
612 #define NN(x) (x)?:""
613 #define P(...) fprintf(stderr, __VA_ARGS__)
614 #define PF(x) P("-- %15s: ", #x)
616 #define S(x) PF(x);P("%s",NN(config->x));PE;
617 #define D(x) PF(x);P("%d",config->x);PE;
618 #define H(x) PF(x);P("%x",config->x);PE;
619 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
620 #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;
621 #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);}
622 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
624 P("---BEGIN-OF-CONFIG---\n");
652 E(tracereq,tracereq_desc)
653 E(traceditf,traceditf_desc)
655 P("---END-OF-CONFIG---\n");
670 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
672 struct afb_config *result;
674 result = calloc(1, sizeof *result);
676 parse_arguments(argc, argv, result);
677 config_set_default(result);
679 afb_config_dump(result);