Add hooking for events
[src/app-framework-binder.git] / src / afb-config.c
1 /*
2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
3  * Author José Bollo <jose.bollo@iot.bzh>
4  *
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
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #define _GNU_SOURCE
19 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
20
21 #include <stdlib.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include <getopt.h>
25 #include <limits.h>
26 #include <unistd.h>
27
28 #include <uuid/uuid.h>
29
30 #include "verbose.h"
31 #include "afb-config.h"
32 #include "afb-hook.h"
33
34 #include <afb/afb-binding-v1.h>
35
36 #if !defined(BINDING_INSTALL_DIR)
37 #error "you should define BINDING_INSTALL_DIR"
38 #endif
39
40 #define AFB_VERSION    "0.6"
41
42 // default
43 #define DEFLT_CNTX_TIMEOUT  3600        // default Client Connection
44                                         // Timeout
45 #define DEFLT_API_TIMEOUT   20          // default Plugin API Timeout [0=NoLimit
46                                         // for Debug Only]
47 #define DEFLT_CACHE_TIMEOUT 100000      // default Static File Chache
48                                         // [Client Side Cache
49                                         // 100000~=1day]
50 #define DEFLT_AUTH_TOKEN    NULL        // expect for debug should == NULL
51 #define CTX_NBCLIENTS       10          // allow a default of 10 authenticated
52                                         // clients
53
54
55 // Define command line option
56 #define SET_BACKGROUND     2
57 #define SET_FORGROUND      3
58
59 #define SET_TCP_PORT       5
60 #define SET_ROOT_DIR       6
61 #define SET_ROOT_BASE      7
62 #define SET_ROOT_API       8
63 #define SET_ALIAS          9
64
65 #define SET_CACHE_TIMEOUT  10
66 #define SET_SESSION_DIR    11
67
68 #define SET_LDPATH         13
69 #define SET_APITIMEOUT     14
70 #define SET_CNTXTIMEOUT    15
71
72
73 #define SET_MODE           18
74
75 #define DBUS_CLIENT        20
76 #define DBUS_SERVICE       21
77 #define SO_BINDING         22
78
79 #define SET_SESSIONMAX     23
80
81 #define WS_CLIENT          24
82 #define WS_SERVICE         25
83
84 #define SET_ROOT_HTTP      26
85
86 #define SET_NO_HTTPD       28
87
88 #define ADD_CALL           'c'
89 #define SET_TRACEDITF      'D'
90 #define SET_TRACEEVT       'E'
91 #define SET_EXEC           'e'
92 #define DISPLAY_HELP       'h'
93 #define SET_QUIET          'q'
94 #define SET_RNDTOKEN       'r'
95 #define SET_TRACESVC       'S'
96 #define SET_TRACEREQ       'T'
97 #define SET_AUTH_TOKEN     't'
98 #define SET_UPLOAD_DIR     'u'
99 #define DISPLAY_VERSION    'V'
100 #define SET_VERBOSE        'v'
101 #define SET_WORK_DIR       'w'
102
103 #define SHORTOPTS       "c:D:E:ehqrT:t:u:Vvw:"
104
105 // Command line structure hold cli --command + help text
106 typedef struct {
107         int val;                // command number within application
108         int has_arg;            // command number within application
109         char *name;             // command as used in --xxxx cli
110         char *help;             // help text
111 } AFB_options;
112
113 // Supported option
114 static AFB_options cliOptions[] = {
115 /* *INDENT-OFF* */
116         {SET_VERBOSE,       0, "verbose",     "Verbose Mode, repeat to increase verbosity"},
117         {SET_QUIET,         0, "quiet",       "Quiet Mode, repeat to decrease verbosity"},
118
119         {SET_FORGROUND,     0, "foreground",  "Get all in foreground mode"},
120         {SET_BACKGROUND,    0, "daemon",      "Get all in background mode"},
121
122         {SET_TCP_PORT,      1, "port",        "HTTP listening TCP port  [default 1234]"},
123         {SET_ROOT_HTTP,     1, "roothttp",    "HTTP Root Directory [default no root http (files not served but apis still available)]"},
124         {SET_ROOT_BASE,     1, "rootbase",    "Angular Base Root URL [default /opa]"},
125         {SET_ROOT_API,      1, "rootapi",     "HTML Root API URL [default /api]"},
126         {SET_ALIAS,         1, "alias",       "Multiple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
127
128         {SET_APITIMEOUT,    1, "apitimeout",  "Binding API timeout in seconds [default 10]"},
129         {SET_CNTXTIMEOUT,   1, "cntxtimeout", "Client Session Context Timeout [default 900]"},
130         {SET_CACHE_TIMEOUT, 1, "cache-eol",   "Client cache end of live [default 3600]"},
131
132         {SET_WORK_DIR,      1, "workdir",     "Set the working directory [default: $PWD or current working directory]"},
133         {SET_UPLOAD_DIR,    1, "uploaddir",   "Directory for uploading files [default: workdir]"},
134         {SET_ROOT_DIR,      1, "rootdir",     "Root Directory of the application [default: workdir]"},
135         {SET_SESSION_DIR,   1, "sessiondir",  "OBSOLETE (was: Sessions file path)"},
136
137         {SET_LDPATH,        1, "ldpaths",     "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
138         {SO_BINDING,        1, "binding",     "Load the binding of path"},
139
140         {SET_AUTH_TOKEN,    1, "token",       "Initial Secret [default=no-session, --token= for session without authentication]"},
141         {SET_RNDTOKEN,      0, "random-token","Creates a random token"},
142
143         {DISPLAY_VERSION,   0, "version",     "Display version and copyright"},
144         {DISPLAY_HELP,      0, "help",        "Display this help"},
145
146         {SET_MODE,          1, "mode",        "Set the mode: either local, remote or global"},
147
148         {DBUS_CLIENT,       1, "dbus-client", "Bind to an afb service through dbus"},
149         {DBUS_SERVICE,      1, "dbus-server", "Provides an afb service through dbus"},
150         {WS_CLIENT,         1, "ws-client",   "Bind to an afb service through websocket"},
151         {WS_SERVICE,        1, "ws-server",   "Provides an afb service through websockets"},
152
153         {SET_SESSIONMAX,    1, "session-max", "Max count of session simultaneously [default 10]"},
154
155         {SET_TRACEREQ,      1, "tracereq",    "Log the requests: no, common, extra, all"},
156         {SET_TRACEDITF,     1, "traceditf",   "Log the requests: no, common, extra, all"},
157         {SET_TRACESVC,      1, "tracesvc",    "Log the requests: no, all"},
158         {SET_TRACEEVT,      1, "traceevt",    "Log the requests: no, common, extra, all"},
159
160         {ADD_CALL,          1, "call",        "call at start format of val: API/VERB:json-args"},
161
162         {SET_NO_HTTPD,      0, "no-httpd",    "Forbids HTTP service"},
163         {SET_EXEC,          0, "exec",        "Execute the remaining arguments"},
164
165         {0, 0, NULL, NULL}
166 /* *INDENT-ON* */
167 };
168
169
170 struct enumdesc
171 {
172         const char *name;
173         int value;
174 };
175
176 static struct enumdesc tracereq_desc[] = {
177         { "no",     0 },
178         { "common", afb_hook_flags_req_common },
179         { "extra",  afb_hook_flags_req_extra },
180         { "all",    afb_hook_flags_req_all },
181         { NULL, 0 }
182 };
183
184 static struct enumdesc traceditf_desc[] = {
185         { "no",     0 },
186         { "common", afb_hook_flags_ditf_common },
187         { "extra",  afb_hook_flags_ditf_extra },
188         { "all",    afb_hook_flags_ditf_all },
189         { NULL, 0 }
190 };
191
192 static struct enumdesc tracesvc_desc[] = {
193         { "no",     0 },
194         { "all",    afb_hook_flags_svc_all },
195         { NULL, 0 }
196 };
197
198 static struct enumdesc traceevt_desc[] = {
199         { "no",     0 },
200         { "common", afb_hook_flags_evt_common },
201         { "extra",  afb_hook_flags_evt_extra },
202         { "all",    afb_hook_flags_evt_all },
203         { NULL, 0 }
204 };
205
206 static struct enumdesc mode_desc[] = {
207         { "local",  AFB_MODE_LOCAL },
208         { "remote", AFB_MODE_REMOTE },
209         { "global", AFB_MODE_GLOBAL },
210         { NULL, 0 }
211 };
212
213 /*----------------------------------------------------------
214  | printversion
215  |   print version and copyright
216  +--------------------------------------------------------- */
217 static void printVersion(FILE * file)
218 {
219         fprintf(file, "\n----------------------------------------- \n");
220         fprintf(file, "  AFB [Application Framework Binder] version=%s |\n",
221                 AFB_VERSION);
222         fprintf(file, " \n");
223         fprintf(file,
224                 "  Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
225         fprintf(file, "  AFB comes with ABSOLUTELY NO WARRANTY.\n");
226         fprintf(file, "  Licence Apache 2\n\n");
227 }
228
229 /*----------------------------------------------------------
230  | printHelp
231  |   print information from long option array
232  +--------------------------------------------------------- */
233
234 static void printHelp(FILE * file, const char *name)
235 {
236         int ind;
237         char command[50];
238
239         fprintf(file, "%s:\nallowed options\n", name);
240         for (ind = 0; cliOptions[ind].name != NULL; ind++) {
241                 strcpy(command, cliOptions[ind].name);
242                 if (cliOptions[ind].has_arg)
243                         strcat(command, "=xxxx");
244                 fprintf(file, "  --%-15s %s\n", command, cliOptions[ind].help);
245         }
246         fprintf(file,
247                 "Example:\n  %s  --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n",
248                 name);
249 }
250
251
252 /*----------------------------------------------------------
253  |   adds a string to the list
254  +--------------------------------------------------------- */
255 static char *random_token()
256 {
257         static char uuidstr[37];
258         uuid_t uuid;
259         uuid_generate_random(uuid);
260         uuid_unparse(uuid, uuidstr);
261         return uuidstr;
262 }
263
264 /*----------------------------------------------------------
265  |   adds a string to the list
266  +--------------------------------------------------------- */
267 static void list_add(struct afb_config_list **head, char *value)
268 {
269         struct afb_config_list *item;
270
271         /*
272          * search tail
273          */
274         item = *head;
275         while (item != NULL) {
276                 head = &item->next;
277                 item = item->next;
278         }
279
280         /*
281          * alloc the item
282          */
283         item = malloc(sizeof *item);
284         if (item == NULL) {
285                 ERROR("out of memory");
286                 exit(1);
287         }
288
289         /*
290          * init the item
291          */
292         *head = item;
293         item->value = value;
294         item->next = NULL;
295 }
296
297 /*---------------------------------------------------------
298  |   helpers for argument scanning
299  +--------------------------------------------------------- */
300
301 static const char *optname(int optc)
302 {
303         AFB_options *o = cliOptions;
304         while (o->name && o->val != optc)
305                 o++;
306         return o->name ? : "<unknown-option-name>";
307 }
308
309 static char *argvalstr(int optc)
310 {
311         if (optarg == 0) {
312                 ERROR("option [--%s] needs a value i.e. --%s=xxx",
313                       optname(optc), optname(optc));
314                 exit(1);
315         }
316         return optarg;
317 }
318
319 static int argvalenum(int optc, struct enumdesc *desc)
320 {
321         int i;
322         size_t len;
323         char *list, *name = argvalstr(optc);
324
325         i = 0;
326         while(desc[i].name && strcmp(desc[i].name, name))
327                 i++;
328         if (!desc[i].name) {
329                 len = 0;
330                 i = 0;
331                 while(desc[i].name)
332                         len += strlen(desc[i++].name);
333                 list = malloc(len + i + i);
334                 if (!i || !list)
335                         ERROR("option [--%s] bad value (found %s)",
336                                 optname(optc), name);
337                 else {
338                         i = 0;
339                         strcpy(list, desc[i].name ? : "");
340                         while(desc[++i].name)
341                                 strcat(strcat(list, ", "), desc[i].name);
342                         ERROR("option [--%s] bad value, only accepts values %s (found %s)",
343                                 optname(optc), list, name);
344                 }
345                 free(list);
346                 exit(1);
347         }
348         return desc[i].value;
349 }
350
351 static int argvalint(int optc, int mini, int maxi, int base)
352 {
353         char *beg, *end;
354         long int val;
355         beg = argvalstr(optc);
356         val = strtol(beg, &end, base);
357         if (*end || end == beg) {
358                 ERROR("option [--%s] requires a valid integer (found %s)",
359                         optname(optc), beg);
360                 exit(1);
361         }
362         if (val < (long int)mini || val > (long int)maxi) {
363                 ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
364                         optname(optc), mini, val, maxi);
365                 exit(1);
366         }
367         return (int)val;
368 }
369
370 static int argvalintdec(int optc, int mini, int maxi)
371 {
372         return argvalint(optc, mini, maxi, 10);
373 }
374
375 static void noarg(int optc)
376 {
377         if (optarg != 0) {
378                 ERROR("option [--%s] need no value (found %s)", optname(optc), optarg);
379                 exit(1);
380         }
381 }
382
383 /*---------------------------------------------------------
384  |   Parse option and launch action
385  +--------------------------------------------------------- */
386
387 static void parse_arguments(int argc, char **argv, struct afb_config *config)
388 {
389         char *programName = argv[0];
390         int optc, ind;
391         int nbcmd;
392         struct option *gnuOptions;
393
394         // ------------------ Process Command Line -----------------------
395
396         // build GNU getopt info from cliOptions
397         nbcmd = sizeof(cliOptions) / sizeof(AFB_options);
398         gnuOptions = malloc(sizeof(*gnuOptions) * (unsigned)nbcmd);
399         for (ind = 0; ind < nbcmd; ind++) {
400                 gnuOptions[ind].name = cliOptions[ind].name;
401                 gnuOptions[ind].has_arg = cliOptions[ind].has_arg;
402                 gnuOptions[ind].flag = 0;
403                 gnuOptions[ind].val = cliOptions[ind].val;
404         }
405
406         // get all options from command line
407         while ((optc = getopt_long(argc, argv, SHORTOPTS, gnuOptions, NULL)) != EOF) {
408                 switch (optc) {
409                 case SET_VERBOSE:
410                         verbosity++;
411                         break;
412
413                 case SET_QUIET:
414                         verbosity--;
415                         break;
416
417                 case SET_TCP_PORT:
418                         config->httpdPort = argvalintdec(optc, 1024, 32767);
419                         break;
420
421                 case SET_APITIMEOUT:
422                         config->apiTimeout = argvalintdec(optc, 0, INT_MAX);
423                         break;
424
425                 case SET_CNTXTIMEOUT:
426                         config->cntxTimeout = argvalintdec(optc, 0, INT_MAX);
427                         break;
428
429                 case SET_ROOT_DIR:
430                         config->rootdir = argvalstr(optc);
431                         INFO("Forcing Rootdir=%s", config->rootdir);
432                         break;
433
434                 case SET_ROOT_HTTP:
435                         config->roothttp = argvalstr(optc);
436                         INFO("Forcing Root HTTP=%s", config->roothttp);
437                         break;
438
439                 case SET_ROOT_BASE:
440                         config->rootbase = argvalstr(optc);
441                         INFO("Forcing Rootbase=%s", config->rootbase);
442                         break;
443
444                 case SET_ROOT_API:
445                         config->rootapi = argvalstr(optc);
446                         INFO("Forcing Rootapi=%s", config->rootapi);
447                         break;
448
449                 case SET_ALIAS:
450                         list_add(&config->aliases, argvalstr(optc));
451                         break;
452
453                 case SET_AUTH_TOKEN:
454                         config->token = argvalstr(optc);
455                         break;
456
457                 case SET_LDPATH:
458                         list_add(&config->ldpaths, argvalstr(optc));
459                         break;
460
461                 case ADD_CALL:
462                         list_add(&config->calls, argvalstr(optc));
463                         break;
464
465                 case SET_SESSION_DIR:
466                         /* config->sessiondir = argvalstr(optc); */
467                         WARNING("Obsolete otpion %s ignored", optname(optc));
468                         break;
469
470                 case SET_UPLOAD_DIR:
471                         config->uploaddir = argvalstr(optc);
472                         break;
473
474                 case SET_WORK_DIR:
475                         config->workdir = argvalstr(optc);
476                         break;
477
478                 case SET_CACHE_TIMEOUT:
479                         config->cacheTimeout = argvalintdec(optc, 0, INT_MAX);
480                         break;
481
482                 case SET_SESSIONMAX:
483                         config->nbSessionMax = argvalintdec(optc, 1, INT_MAX);
484                         break;
485
486                 case SET_FORGROUND:
487                         noarg(optc);
488                         config->background = 0;
489                         break;
490
491                 case SET_BACKGROUND:
492                         noarg(optc);
493                         config->background = 1;
494                         break;
495
496                 case SET_MODE:
497                         config->mode = argvalenum(optc, mode_desc);
498                         break;
499
500                 case DBUS_CLIENT:
501                         list_add(&config->dbus_clients, argvalstr(optc));
502                         break;
503
504                 case DBUS_SERVICE:
505                         list_add(&config->dbus_servers, argvalstr(optc));
506                         break;
507
508                 case WS_CLIENT:
509                         list_add(&config->ws_clients, argvalstr(optc));
510                         break;
511
512                 case WS_SERVICE:
513                         list_add(&config->ws_servers, argvalstr(optc));
514                         break;
515
516                 case SO_BINDING:
517                         list_add(&config->so_bindings, argvalstr(optc));
518                         break;
519
520                 case SET_TRACEREQ:
521                         config->tracereq = argvalenum(optc, tracereq_desc);
522                         break;
523
524                 case SET_TRACEDITF:
525                         config->traceditf = argvalenum(optc, traceditf_desc);
526                         break;
527
528                 case SET_TRACESVC:
529                         config->tracesvc = argvalenum(optc, tracesvc_desc);
530                         break;
531
532                 case SET_TRACEEVT:
533                         config->traceevt = argvalenum(optc, traceevt_desc);
534                         break;
535
536                 case SET_NO_HTTPD:
537                         noarg(optc);
538                         config->noHttpd = 1;
539                         break;
540
541                 case SET_EXEC:
542                         config->exec = &argv[optind];
543                         optind = argc;
544                         break;
545
546                 case SET_RNDTOKEN:
547                         config->token = random_token();
548                         break;
549
550                 case DISPLAY_VERSION:
551                         noarg(optc);
552                         printVersion(stdout);
553                         exit(0);
554
555                 case DISPLAY_HELP:
556                         printHelp(stdout, programName);
557                         exit(0);
558
559                 default:
560                         exit(1);
561                 }
562         }
563         free(gnuOptions);
564 }
565
566 // load config from disk and merge with CLI option
567 static void config_set_default(struct afb_config *config)
568 {
569         // default HTTP port
570         if (config->httpdPort == 0)
571                 config->httpdPort = 1234;
572
573         // default binding API timeout
574         if (config->apiTimeout == 0)
575                 config->apiTimeout = DEFLT_API_TIMEOUT;
576
577         // default AUTH_TOKEN
578         if (config->token == NULL)
579                 config->token = DEFLT_AUTH_TOKEN;
580
581         // cache timeout default one hour
582         if (config->cacheTimeout == 0)
583                 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
584
585         // cache timeout default one hour
586         if (config->cntxTimeout == 0)
587                 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
588
589         // max count of sessions
590         if (config->nbSessionMax == 0)
591                 config->nbSessionMax = CTX_NBCLIENTS;
592
593         /* set directories */
594         if (config->workdir == NULL)
595                 config->workdir = ".";
596
597         if (config->rootdir == NULL)
598                 config->rootdir = ".";
599
600         if (config->uploaddir == NULL)
601                 config->uploaddir = ".";
602
603         // if no Angular/HTML5 rootbase let's try '/' as default
604         if (config->rootbase == NULL)
605                 config->rootbase = "/opa";
606
607         if (config->rootapi == NULL)
608                 config->rootapi = "/api";
609
610         if (config->ldpaths == NULL)
611                 list_add(&config->ldpaths, BINDING_INSTALL_DIR);
612
613         // if no config dir create a default path from uploaddir
614         if (config->console == NULL) {
615                 config->console = malloc(512);
616                 strncpy(config->console, config->uploaddir, 512);
617                 strncat(config->console, "/AFB-console.out", 512);
618         }
619 }
620
621 void afb_config_dump(struct afb_config *config)
622 {
623         struct afb_config_list *l;
624         struct enumdesc *e;
625         char **v;
626
627 #define NN(x)   (x)?:""
628 #define P(...)  fprintf(stderr, __VA_ARGS__)
629 #define PF(x)   P("-- %15s: ", #x)
630 #define PE      P("\n")
631 #define S(x)    PF(x);P("%s",NN(config->x));PE;
632 #define D(x)    PF(x);P("%d",config->x);PE;
633 #define H(x)    PF(x);P("%x",config->x);PE;
634 #define B(x)    PF(x);P("%s",config->x?"yes":"no");PE;
635 #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;
636 #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);}
637 #define V(x)    P("-- %15s:", #x);for(v=config->x;v&&*v;v++)P(" %s",*v); PE;
638
639         P("---BEGIN-OF-CONFIG---\n");
640         S(console)
641         S(rootdir)
642         S(roothttp)
643         S(rootbase)
644         S(rootapi)
645         S(workdir)
646         S(uploaddir)
647         S(token)
648
649         L(aliases)
650         L(dbus_clients)
651         L(dbus_servers)
652         L(ws_clients)
653         L(ws_servers)
654         L(so_bindings)
655         L(ldpaths)
656         L(calls)
657
658         V(exec)
659
660         D(httpdPort)
661         B(background)
662         D(cacheTimeout)
663         D(apiTimeout)
664         D(cntxTimeout)
665         D(nbSessionMax)
666         E(mode,mode_desc)
667         E(tracereq,tracereq_desc)
668         E(traceditf,traceditf_desc)
669         B(noHttpd)
670         P("---END-OF-CONFIG---\n");
671
672 #undef V
673 #undef E
674 #undef L
675 #undef B
676 #undef H
677 #undef D
678 #undef S
679 #undef PE
680 #undef PF
681 #undef P
682 #undef NN
683 }
684
685 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
686 {
687         struct afb_config *result;
688
689         result = calloc(1, sizeof *result);
690
691         parse_arguments(argc, argv, result);
692         config_set_default(result);
693         if (verbosity >= 3)
694                 afb_config_dump(result);
695         return result;
696 }
697