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 NO_BINDING_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 DISPLAY_HELP 'h'
91 #define SET_RNDTOKEN 'r'
92 #define SET_TRACEREQ 'T'
93 #define SET_AUTH_TOKEN 't'
94 #define SET_UPLOAD_DIR 'u'
95 #define DISPLAY_VERSION 'V'
96 #define SET_VERBOSE 'v'
97 #define SET_WORK_DIR 'w'
99 #define SHORTOPTS "ehqrT:t:u:Vvw:"
101 // Command line structure hold cli --command + help text
103 int val; // command number within application
104 int has_arg; // command number within application
105 char *name; // command as used in --xxxx cli
106 char *help; // help text
110 static AFB_options cliOptions[] = {
112 {SET_VERBOSE, 0, "verbose", "Verbose Mode, repeat to increase verbosity"},
113 {SET_QUIET, 0, "quiet", "Quiet Mode, repeat to decrease verbosity"},
115 {SET_FORGROUND, 0, "foreground", "Get all in foreground mode"},
116 {SET_BACKGROUND, 0, "daemon", "Get all in background mode"},
118 {SET_TCP_PORT, 1, "port", "HTTP listening TCP port [default 1234]"},
119 {SET_ROOT_HTTP, 1, "roothttp", "HTTP Root Directory [default no root http (files not served but apis still available)]"},
120 {SET_ROOT_BASE, 1, "rootbase", "Angular Base Root URL [default /opa]"},
121 {SET_ROOT_API, 1, "rootapi", "HTML Root API URL [default /api]"},
122 {SET_ALIAS, 1, "alias", "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
124 {SET_APITIMEOUT, 1, "apitimeout", "Binding API timeout in seconds [default 10]"},
125 {SET_CNTXTIMEOUT, 1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
126 {SET_CACHE_TIMEOUT, 1, "cache-eol", "Client cache end of live [default 3600]"},
128 {SET_WORK_DIR, 1, "workdir", "Set the working directory [default: $PWD or current working directory]"},
129 {SET_UPLOAD_DIR, 1, "uploaddir", "Directory for uploading files [default: workdir]"},
130 {SET_ROOT_DIR, 1, "rootdir", "Root Directory of the application [default: workdir]"},
131 {SET_SESSION_DIR, 1, "sessiondir", "OBSOLETE (was: Sessions file path)"},
133 {SET_LDPATH, 1, "ldpaths", "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
134 {SO_BINDING, 1, "binding", "Load the binding of path"},
136 {SET_AUTH_TOKEN, 1, "token", "Initial Secret [default=no-session, --token= for session without authentication]"},
137 {SET_RNDTOKEN, 0, "random-token","Creates a random token"},
139 {DISPLAY_VERSION, 0, "version", "Display version and copyright"},
140 {DISPLAY_HELP, 0, "help", "Display this help"},
142 {SET_MODE, 1, "mode", "Set the mode: either local, remote or global"},
144 {DBUS_CLIENT, 1, "dbus-client", "Bind to an afb service through dbus"},
145 {DBUS_SERVICE, 1, "dbus-server", "Provides an afb service through dbus"},
146 {WS_CLIENT, 1, "ws-client", "Bind to an afb service through websocket"},
147 {WS_SERVICE, 1, "ws-server", "Provides an afb service through websockets"},
149 {SET_SESSIONMAX, 1, "session-max", "Max count of session simultaneously [default 10]"},
151 {SET_TRACEREQ, 1, "tracereq", "Log the requests: no, common, extra, all"},
153 {SET_NO_HTTPD, 0, "no-httpd", "Forbids HTTP service"},
154 {SET_EXEC, 0, "exec", "Execute the remaining arguments"},
167 static struct enumdesc tracereq_desc[] = {
169 { "common", afb_hook_flags_req_common },
170 { "extra", afb_hook_flags_req_extra },
171 { "all", afb_hook_flags_req_all },
175 static struct enumdesc mode_desc[] = {
176 { "local", AFB_MODE_LOCAL },
177 { "remote", AFB_MODE_REMOTE },
178 { "global", AFB_MODE_GLOBAL },
182 /*----------------------------------------------------------
184 | print version and copyright
185 +--------------------------------------------------------- */
186 static void printVersion(FILE * file)
188 fprintf(file, "\n----------------------------------------- \n");
189 fprintf(file, " AFB [Application Framework Binder] version=%s |\n",
191 fprintf(file, " \n");
193 " Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
194 fprintf(file, " AFB comes with ABSOLUTELY NO WARRANTY.\n");
195 fprintf(file, " Licence Apache 2\n\n");
198 /*----------------------------------------------------------
200 | print information from long option array
201 +--------------------------------------------------------- */
203 static void printHelp(FILE * file, const char *name)
208 fprintf(file, "%s:\nallowed options\n", name);
209 for (ind = 0; cliOptions[ind].name != NULL; ind++) {
210 strcpy(command, cliOptions[ind].name);
211 if (cliOptions[ind].has_arg)
212 strcat(command, "=xxxx");
213 fprintf(file, " --%-15s %s\n", command, cliOptions[ind].help);
216 "Example:\n %s --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
221 /*----------------------------------------------------------
222 | adds a string to the list
223 +--------------------------------------------------------- */
224 static char *random_token()
226 static char uuidstr[37];
228 uuid_generate_random(uuid);
229 uuid_unparse(uuid, uuidstr);
233 /*----------------------------------------------------------
234 | adds a string to the list
235 +--------------------------------------------------------- */
236 static void list_add(struct afb_config_list **head, char *value)
238 struct afb_config_list *item;
244 while (item != NULL) {
252 item = malloc(sizeof *item);
254 ERROR("out of memory");
266 /*---------------------------------------------------------
267 | helpers for argument scanning
268 +--------------------------------------------------------- */
270 static const char *optname(int optc)
272 AFB_options *o = cliOptions;
273 while (o->name && o->val != optc)
275 return o->name ? : "<unknown-option-name>";
278 static char *argvalstr(int optc)
281 ERROR("option [--%s] needs a value i.e. --%s=xxx",
282 optname(optc), optname(optc));
288 static int argvalenum(int optc, struct enumdesc *desc)
292 char *list, *name = argvalstr(optc);
295 while(desc[i].name && strcmp(desc[i].name, name))
301 len += strlen(desc[i++].name);
302 list = malloc(len + i + i);
304 ERROR("option [--%s] bad value (found %s)",
305 optname(optc), name);
308 strcpy(list, desc[i].name ? : "");
309 while(desc[++i].name)
310 strcat(strcat(list, ", "), desc[i].name);
311 ERROR("option [--%s] bad value, only accepts values %s (found %s)",
312 optname(optc), list, name);
317 return desc[i].value;
320 static int argvalint(int optc, int mini, int maxi, int base)
324 beg = argvalstr(optc);
325 val = strtol(beg, &end, base);
326 if (*end || end == beg) {
327 ERROR("option [--%s] requires a valid integer (found %s)",
331 if (val < (long int)mini || val > (long int)maxi) {
332 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
333 optname(optc), mini, val, maxi);
339 static int argvalintdec(int optc, int mini, int maxi)
341 return argvalint(optc, mini, maxi, 10);
344 static void noarg(int optc)
347 ERROR("option [--%s] need no value (found %s)", optname(optc), optarg);
352 /*---------------------------------------------------------
353 | Parse option and launch action
354 +--------------------------------------------------------- */
356 static void parse_arguments(int argc, char **argv, struct afb_config *config)
358 char *programName = argv[0];
361 struct option *gnuOptions;
363 // ------------------ Process Command Line -----------------------
365 // build GNU getopt info from cliOptions
366 nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
367 gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
368 for (ind = 0; ind < nbcmd; ind++) {
369 gnuOptions[ind].name = cliOptions[ind].name;
370 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
371 gnuOptions[ind].flag = 0;
372 gnuOptions[ind].val = cliOptions[ind].val;
375 // get all options from command line
376 while ((optc = getopt_long(argc, argv, SHORTOPTS, gnuOptions, NULL)) != EOF) {
387 config->httpdPort = argvalintdec(optc, 1024, 32767);
391 config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
394 case SET_CNTXTIMEOUT:
395 config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
399 config->rootdir = argvalstr(optc);
400 INFO("Forcing Rootdir=%s", config->rootdir);
404 config->roothttp = argvalstr(optc);
405 INFO("Forcing Root HTTP=%s", config->roothttp);
409 config->rootbase = argvalstr(optc);
410 INFO("Forcing Rootbase=%s", config->rootbase);
414 config->rootapi = argvalstr(optc);
415 INFO("Forcing Rootapi=%s", config->rootapi);
419 list_add(&config->aliases, argvalstr(optc));
423 config->token = argvalstr(optc);
427 list_add(&config->ldpaths, argvalstr(optc));
430 case SET_SESSION_DIR:
431 /* config->sessiondir = argvalstr(optc); */
432 WARNING("Obsolete otpion %s ignored", optname(optc));
436 config->uploaddir = argvalstr(optc);
440 config->workdir = argvalstr(optc);
443 case SET_CACHE_TIMEOUT:
444 config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
448 config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
453 config->background = 0;
458 config->background = 1;
462 config->mode = argvalenum(optc, mode_desc);
466 list_add(&config->dbus_clients, argvalstr(optc));
470 list_add(&config->dbus_servers, argvalstr(optc));
474 list_add(&config->ws_clients, argvalstr(optc));
478 list_add(&config->ws_servers, argvalstr(optc));
482 list_add(&config->so_bindings, argvalstr(optc));
486 config->tracereq = argvalenum(optc, tracereq_desc);
495 config->exec = &argv[optind];
500 config->token = random_token();
503 case DISPLAY_VERSION:
505 printVersion(stdout);
509 printHelp(stdout, programName);
519 // load config from disk and merge with CLI option
520 static void config_set_default(struct afb_config *config)
523 if (config->httpdPort == 0)
524 config->httpdPort = 1234;
526 // default binding API timeout
527 if (config->apiTimeout == 0)
528 config->apiTimeout = DEFLT_API_TIMEOUT;
530 // default AUTH_TOKEN
531 if (config->token == NULL)
532 config->token = DEFLT_AUTH_TOKEN;
534 // cache timeout default one hour
535 if (config->cacheTimeout == 0)
536 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
538 // cache timeout default one hour
539 if (config->cntxTimeout == 0)
540 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
542 // max count of sessions
543 if (config->nbSessionMax == 0)
544 config->nbSessionMax = CTX_NBCLIENTS;
546 /* set directories */
547 if (config->workdir == NULL)
548 config->workdir = get_current_dir_name();
550 if (config->rootdir == NULL)
551 config->rootdir = config->workdir;
553 if (config->uploaddir == NULL)
554 config->uploaddir = config->workdir;
556 // if no Angular/HTML5 rootbase let's try '/' as default
557 if (config->rootbase == NULL)
558 config->rootbase = "/opa";
560 if (config->rootapi == NULL)
561 config->rootapi = "/api";
563 if (config->ldpaths == NULL)
564 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
566 // if no config dir create a default path from uploaddir
567 if (config->console == NULL) {
568 config->console = malloc(512);
569 strncpy(config->console, config->uploaddir, 512);
570 strncat(config->console, "/AFB-console.out", 512);
574 void afb_config_dump(struct afb_config *config)
576 struct afb_config_list *l;
580 #define NN(x) (x)?:""
581 #define P(...) fprintf(stderr, __VA_ARGS__)
582 #define PF(x) P("-- %15s: ", #x)
584 #define S(x) PF(x);P("%s",NN(config->x));PE;
585 #define D(x) PF(x);P("%d",config->x);PE;
586 #define H(x) PF(x);P("%x",config->x);PE;
587 #define B(x) PF(x);P("%s",config->x?"yes":"no");PE;
588 #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;
589 #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);}
590 #define V(x) P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
592 P("---BEGIN-OF-CONFIG---\n");
619 E(tracereq,tracereq_desc)
621 P("---END-OF-CONFIG---\n");
636 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
638 struct afb_config *result;
640 result = calloc(1, sizeof *result);
642 parse_arguments(argc, argv, result);
643 config_set_default(result);
645 afb_config_dump(result);