Update date of copyright notices
[src/app-framework-binder.git] / src / afb-config.c
index dc3388e..b23619e 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
+ * Copyright (C) 2015-2018 "IoT.bzh"
  * Author José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,7 +16,6 @@
  */
 
 #define _GNU_SOURCE
-#define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
 
 #include <stdlib.h>
 #include <stdio.h>
@@ -25,7 +24,7 @@
 #include <limits.h>
 #include <unistd.h>
 
-#include <uuid/uuid.h>
+#include <json-c/json.h>
 
 #include "verbose.h"
 #include "afb-config.h"
 #if !defined(BINDING_INSTALL_DIR)
 #error "you should define BINDING_INSTALL_DIR"
 #endif
-
-#define AFB_VERSION    "0.6"
+#if !defined(AFB_VERSION)
+#error "you should define AFB_VERSION"
+#endif
 
 // default
-#define DEFLT_CNTX_TIMEOUT  3600       // default Client Connection
-                                       // Timeout
+#define DEFLT_CNTX_TIMEOUT  32000000   // default Client Connection
+                                       // Timeout: few more than one year
 #define DEFLT_API_TIMEOUT   20         // default Plugin API Timeout [0=NoLimit
                                        // for Debug Only]
 #define DEFLT_CACHE_TIMEOUT 100000     // default Static File Chache
                                        // [Client Side Cache
                                        // 100000~=1day]
-#define DEFLT_AUTH_TOKEN    NULL       // expect for debug should == NULL
 #define CTX_NBCLIENTS       10         // allow a default of 10 authenticated
                                        // clients
 
@@ -56,7 +55,6 @@
 #define SET_BACKGROUND     2
 #define SET_FORGROUND      3
 
-#define SET_TCP_PORT       5
 #define SET_ROOT_DIR       6
 #define SET_ROOT_BASE      7
 #define SET_ROOT_API       8
@@ -68,7 +66,8 @@
 #define SET_LDPATH         13
 #define SET_APITIMEOUT     14
 #define SET_CNTXTIMEOUT    15
-
+#define SET_WEAK_LDPATH    16
+#define NO_LDPATH          17
 
 #define SET_MODE           18
 
 
 #define ADD_CALL           'c'
 #define SET_TRACEDITF      'D'
+#define SET_TRACEEVT       'E'
 #define SET_EXEC           'e'
 #define DISPLAY_HELP       'h'
+#if defined(WITH_MONITORING_OPTION)
+#define SET_MONITORING     'M'
+#endif
+#define SET_NAME           'n'
+#define SET_TCP_PORT       'p'
 #define SET_QUIET          'q'
 #define SET_RNDTOKEN       'r'
 #define SET_TRACESVC       'S'
+#define SET_TRACESES       's'
 #define SET_TRACEREQ       'T'
 #define SET_AUTH_TOKEN     't'
 #define SET_UPLOAD_DIR     'u'
 #define SET_VERBOSE        'v'
 #define SET_WORK_DIR       'w'
 
-#define SHORTOPTS      "c:D:ehqrT:t:u:Vvw:"
+const char shortopts[] =
+       "c:D:E:ehn:p:qrS:s:T:t:u:Vvw:"
+#if defined(WITH_MONITORING_OPTION)
+       "M"
+#endif
+;
 
 // Command line structure hold cli --command + help text
 typedef struct {
@@ -118,6 +129,8 @@ static AFB_options cliOptions[] = {
        {SET_FORGROUND,     0, "foreground",  "Get all in foreground mode"},
        {SET_BACKGROUND,    0, "daemon",      "Get all in background mode"},
 
+       {SET_NAME,          1, "name",        "Set the visible name"},
+
        {SET_TCP_PORT,      1, "port",        "HTTP listening TCP port  [default 1234]"},
        {SET_ROOT_HTTP,     1, "roothttp",    "HTTP Root Directory [default no root http (files not served but apis still available)]"},
        {SET_ROOT_BASE,     1, "rootbase",    "Angular Base Root URL [default /opa]"},
@@ -135,9 +148,11 @@ static AFB_options cliOptions[] = {
 
        {SET_LDPATH,        1, "ldpaths",     "Load bindings from dir1:dir2:... [default = " BINDING_INSTALL_DIR "]"},
        {SO_BINDING,        1, "binding",     "Load the binding of path"},
+       {SET_WEAK_LDPATH,   1, "weak-ldpaths","Same as --ldpaths but ignore errors"},
+       {NO_LDPATH,         0, "no-ldpaths",  "Discard default ldpaths loading"},
 
-       {SET_AUTH_TOKEN,    1, "token",       "Initial Secret [default=no-session, --token= for session without authentication]"},
-       {SET_RNDTOKEN,      0, "random-token","Creates a random token"},
+       {SET_AUTH_TOKEN,    1, "token",       "Initial Secret [default=random, use --token="" to allow any token]"},
+       {SET_RNDTOKEN,      0, "random-token","Enforce a random token"},
 
        {DISPLAY_VERSION,   0, "version",     "Display version and copyright"},
        {DISPLAY_HELP,      0, "help",        "Display this help"},
@@ -154,11 +169,17 @@ static AFB_options cliOptions[] = {
        {SET_TRACEREQ,      1, "tracereq",    "Log the requests: no, common, extra, all"},
        {SET_TRACEDITF,     1, "traceditf",   "Log the requests: no, common, extra, all"},
        {SET_TRACESVC,      1, "tracesvc",    "Log the requests: no, all"},
+       {SET_TRACEEVT,      1, "traceevt",    "Log the requests: no, common, extra, all"},
+       {SET_TRACESES,      1, "traceses",    "Log the sessions: no, all"},
+
        {ADD_CALL,          1, "call",        "call at start format of val: API/VERB:json-args"},
 
        {SET_NO_HTTPD,      0, "no-httpd",    "Forbids HTTP service"},
        {SET_EXEC,          0, "exec",        "Execute the remaining arguments"},
 
+#if defined(WITH_MONITORING_OPTION)
+       {SET_MONITORING,    0, "monitoring",  "enable HTTP monitoring at <ROOT>/monitoring/"},
+#endif
        {0, 0, NULL, NULL}
 /* *INDENT-ON* */
 };
@@ -192,6 +213,21 @@ static struct enumdesc tracesvc_desc[] = {
        { NULL, 0 }
 };
 
+static struct enumdesc traceevt_desc[] = {
+       { "no",     0 },
+       { "common", afb_hook_flags_evt_common },
+       { "extra",  afb_hook_flags_evt_extra },
+       { "all",    afb_hook_flags_evt_all },
+       { NULL, 0 }
+};
+
+static struct enumdesc traceses_desc[] = {
+       { "no",     0 },
+       { "common", afb_hook_flags_session_common },
+       { "all",    afb_hook_flags_session_all },
+       { NULL, 0 }
+};
+
 static struct enumdesc mode_desc[] = {
        { "local",  AFB_MODE_LOCAL },
        { "remote", AFB_MODE_REMOTE },
@@ -205,14 +241,16 @@ static struct enumdesc mode_desc[] = {
  +--------------------------------------------------------- */
 static void printVersion(FILE * file)
 {
-       fprintf(file, "\n----------------------------------------- \n");
-       fprintf(file, "  AFB [Application Framework Binder] version=%s |\n",
-               AFB_VERSION);
-       fprintf(file, " \n");
-       fprintf(file,
-               "  Copyright (C) 2015, 2016, 2017 \"IoT.bzh\" [fulup -at- iot.bzh]\n");
-       fprintf(file, "  AFB comes with ABSOLUTELY NO WARRANTY.\n");
-       fprintf(file, "  Licence Apache 2\n\n");
+       static const char version[] =
+               "\n"
+               "  AFB [Application Framework Binder] version="AFB_VERSION"\n"
+               "\n"
+               "  Copyright (C) 2015, 2016, 2017 \"IoT.bzh\"\n"
+               "  AFB comes with ABSOLUTELY NO WARRANTY.\n"
+               "  Licence Apache 2\n"
+               "\n";
+
+       fprintf(file, "%s", version);
 }
 
 /*----------------------------------------------------------
@@ -238,18 +276,6 @@ static void printHelp(FILE * file, const char *name)
 }
 
 
-/*----------------------------------------------------------
- |   adds a string to the list
- +--------------------------------------------------------- */
-static char *random_token()
-{
-       static char uuidstr[37];
-       uuid_t uuid;
-       uuid_generate_random(uuid);
-       uuid_unparse(uuid, uuidstr);
-       return uuidstr;
-}
-
 /*----------------------------------------------------------
  |   adds a string to the list
  +--------------------------------------------------------- */
@@ -287,7 +313,7 @@ static void list_add(struct afb_config_list **head, char *value)
  |   helpers for argument scanning
  +--------------------------------------------------------- */
 
-static const char *optname(int optc)
+static const char *name_of_option(int optc)
 {
        AFB_options *o = cliOptions;
        while (o->name && o->val != optc)
@@ -295,21 +321,32 @@ static const char *optname(int optc)
        return o->name ? : "<unknown-option-name>";
 }
 
-static char *argvalstr(int optc)
+static const char *current_argument(int optc)
 {
        if (optarg == 0) {
                ERROR("option [--%s] needs a value i.e. --%s=xxx",
-                     optname(optc), optname(optc));
+                     name_of_option(optc), name_of_option(optc));
                exit(1);
        }
        return optarg;
 }
 
+static char *argvalstr(int optc)
+{
+       char *result = strdup(current_argument(optc));
+       if (result == NULL) {
+               ERROR("can't alloc memory");
+               exit(1);
+       }
+       return result;
+}
+
 static int argvalenum(int optc, struct enumdesc *desc)
 {
        int i;
        size_t len;
-       char *list, *name = argvalstr(optc);
+       char *list;
+       const char *name = current_argument(optc);
 
        i = 0;
        while(desc[i].name && strcmp(desc[i].name, name))
@@ -322,14 +359,14 @@ static int argvalenum(int optc, struct enumdesc *desc)
                list = malloc(len + i + i);
                if (!i || !list)
                        ERROR("option [--%s] bad value (found %s)",
-                               optname(optc), name);
+                               name_of_option(optc), name);
                else {
                        i = 0;
                        strcpy(list, desc[i].name ? : "");
                        while(desc[++i].name)
                                strcat(strcat(list, ", "), desc[i].name);
                        ERROR("option [--%s] bad value, only accepts values %s (found %s)",
-                               optname(optc), list, name);
+                               name_of_option(optc), list, name);
                }
                free(list);
                exit(1);
@@ -339,18 +376,18 @@ static int argvalenum(int optc, struct enumdesc *desc)
 
 static int argvalint(int optc, int mini, int maxi, int base)
 {
-       char *beg, *end;
+       const char *beg, *end;
        long int val;
-       beg = argvalstr(optc);
-       val = strtol(beg, &end, base);
+       beg = current_argument(optc);
+       val = strtol(beg, (char**)&end, base);
        if (*end || end == beg) {
                ERROR("option [--%s] requires a valid integer (found %s)",
-                       optname(optc), beg);
+                       name_of_option(optc), beg);
                exit(1);
        }
        if (val < (long int)mini || val > (long int)maxi) {
                ERROR("option [--%s] value out of bounds (not %d<=%ld<=%d)",
-                       optname(optc), mini, val, maxi);
+                       name_of_option(optc), mini, val, maxi);
                exit(1);
        }
        return (int)val;
@@ -364,11 +401,36 @@ static int argvalintdec(int optc, int mini, int maxi)
 static void noarg(int optc)
 {
        if (optarg != 0) {
-               ERROR("option [--%s] need no value (found %s)", optname(optc), optarg);
+               ERROR("option [--%s] need no value (found %s)", name_of_option(optc), optarg);
                exit(1);
        }
 }
 
+static char **make_exec(char **argv)
+{
+       char **result, *iter;
+       size_t length;
+       int i;
+
+       length = 0;
+       for (i = 0 ; argv[i] ; i++)
+               length += strlen(argv[i]) + 1;
+
+       result = malloc(length + ((unsigned)(i + 1)) * sizeof *result);
+       if (result == NULL) {
+               ERROR("can't alloc memory");
+               exit(1);
+       }
+
+       iter = (char*)&result[i+1];
+       for (i = 0 ; argv[i] ; i++) {
+               result[i] = iter;
+               iter = stpcpy(iter, argv[i]) + 1;
+       }
+       result[i] = NULL;
+       return result;
+}
+
 /*---------------------------------------------------------
  |   Parse option and launch action
  +--------------------------------------------------------- */
@@ -393,7 +455,7 @@ static void parse_arguments(int argc, char **argv, struct afb_config *config)
        }
 
        // get all options from command line
-       while ((optc = getopt_long(argc, argv, SHORTOPTS, gnuOptions, NULL)) != EOF) {
+       while ((optc = getopt_long(argc, argv, shortopts, gnuOptions, NULL)) != EOF) {
                switch (optc) {
                case SET_VERBOSE:
                        verbosity++;
@@ -447,13 +509,22 @@ static void parse_arguments(int argc, char **argv, struct afb_config *config)
                        list_add(&config->ldpaths, argvalstr(optc));
                        break;
 
+               case SET_WEAK_LDPATH:
+                       list_add(&config->weak_ldpaths, argvalstr(optc));
+                       break;
+
+               case NO_LDPATH:
+                       noarg(optc);
+                       config->no_ldpaths = 1;
+                       break;
+
                case ADD_CALL:
                        list_add(&config->calls, argvalstr(optc));
                        break;
 
                case SET_SESSION_DIR:
                        /* config->sessiondir = argvalstr(optc); */
-                       WARNING("Obsolete otpion %s ignored", optname(optc));
+                       WARNING("Obsolete option %s ignored", name_of_option(optc));
                        break;
 
                case SET_UPLOAD_DIR:
@@ -482,6 +553,10 @@ static void parse_arguments(int argc, char **argv, struct afb_config *config)
                        config->background = 1;
                        break;
 
+               case SET_NAME:
+                       config->name = argvalstr(optc);
+                       break;
+
                case SET_MODE:
                        config->mode = argvalenum(optc, mode_desc);
                        break;
@@ -518,19 +593,33 @@ static void parse_arguments(int argc, char **argv, struct afb_config *config)
                        config->tracesvc = argvalenum(optc, tracesvc_desc);
                        break;
 
+               case SET_TRACEEVT:
+                       config->traceevt = argvalenum(optc, traceevt_desc);
+                       break;
+
+               case SET_TRACESES:
+                       config->traceses = argvalenum(optc, traceses_desc);
+                       break;
+
                case SET_NO_HTTPD:
                        noarg(optc);
                        config->noHttpd = 1;
                        break;
 
                case SET_EXEC:
-                       config->exec = &argv[optind];
-                       optind = argc;
+                       config->exec = make_exec(&argv[optind]);
+                       optind = argc; /* stop option scanning */
                        break;
 
                case SET_RNDTOKEN:
-                       config->token = random_token();
+                       config->random_token = 1;
+                       break;
+
+#if defined(WITH_MONITORING_OPTION)
+               case SET_MONITORING:
+                       config->monitoring = 1;
                        break;
+#endif
 
                case DISPLAY_VERSION:
                        noarg(optc);
@@ -548,8 +637,7 @@ static void parse_arguments(int argc, char **argv, struct afb_config *config)
        free(gnuOptions);
 }
 
-// load config from disk and merge with CLI option
-static void config_set_default(struct afb_config *config)
+static void fulfill_config(struct afb_config *config)
 {
        // default HTTP port
        if (config->httpdPort == 0)
@@ -560,8 +648,8 @@ static void config_set_default(struct afb_config *config)
                config->apiTimeout = DEFLT_API_TIMEOUT;
 
        // default AUTH_TOKEN
-       if (config->token == NULL)
-               config->token = DEFLT_AUTH_TOKEN;
+       if (config->random_token)
+               config->token = NULL;
 
        // cache timeout default one hour
        if (config->cacheTimeout == 0)
@@ -592,9 +680,14 @@ static void config_set_default(struct afb_config *config)
        if (config->rootapi == NULL)
                config->rootapi = "/api";
 
-       if (config->ldpaths == NULL)
+       if (config->ldpaths == NULL && config->weak_ldpaths == NULL && !config->no_ldpaths)
                list_add(&config->ldpaths, BINDING_INSTALL_DIR);
 
+#if defined(WITH_MONITORING_OPTION)
+       if (config->monitoring)
+               list_add(&config->aliases, strdup("/monitoring:"BINDING_INSTALL_DIR"/monitoring"));
+#endif
+
        // if no config dir create a default path from uploaddir
        if (config->console == NULL) {
                config->console = malloc(512);
@@ -615,7 +708,6 @@ void afb_config_dump(struct afb_config *config)
 #define PE      P("\n")
 #define S(x)   PF(x);P("%s",NN(config->x));PE;
 #define D(x)   PF(x);P("%d",config->x);PE;
-#define H(x)   PF(x);P("%x",config->x);PE;
 #define B(x)   PF(x);P("%s",config->x?"yes":"no");PE;
 #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;
 #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);}
@@ -630,6 +722,7 @@ void afb_config_dump(struct afb_config *config)
        S(workdir)
        S(uploaddir)
        S(token)
+       S(name)
 
        L(aliases)
        L(dbus_clients)
@@ -638,27 +731,37 @@ void afb_config_dump(struct afb_config *config)
        L(ws_servers)
        L(so_bindings)
        L(ldpaths)
+       L(weak_ldpaths)
        L(calls)
 
        V(exec)
 
        D(httpdPort)
-       B(background)
        D(cacheTimeout)
        D(apiTimeout)
        D(cntxTimeout)
        D(nbSessionMax)
+
        E(mode,mode_desc)
        E(tracereq,tracereq_desc)
        E(traceditf,traceditf_desc)
+       E(tracesvc,tracesvc_desc)
+       E(traceevt,traceevt_desc)
+       E(traceses,traceses_desc)
+
+       B(no_ldpaths)
        B(noHttpd)
+       B(background)
+#if defined(WITH_MONITORING_OPTION)
+       B(monitoring)
+#endif
+       B(random_token)
        P("---END-OF-CONFIG---\n");
 
 #undef V
 #undef E
 #undef L
 #undef B
-#undef H
 #undef D
 #undef S
 #undef PE
@@ -667,16 +770,144 @@ void afb_config_dump(struct afb_config *config)
 #undef NN
 }
 
+static void on_environment_list(struct afb_config_list **to, const char *name)
+{
+       char *value = getenv(name);
+
+       if (value)
+               list_add(to, value);
+}
+
+static void on_environment_enum(int *to, const char *name, struct enumdesc *desc)
+{
+       char *value = getenv(name);
+
+       if (value) {
+               while (desc->name) {
+                       if (strcmp(desc->name, value))
+                               desc++;
+                       else {
+                               *to = desc->value;
+                               return;
+                       }
+               }
+               WARNING("Unknown value %s for environment variable %s, ignored", value, name);
+       }
+}
+
+static void parse_environment(struct afb_config *config)
+{
+       on_environment_enum(&config->tracereq, "AFB_TRACEREQ", tracereq_desc);
+       on_environment_enum(&config->traceditf, "AFB_TRACEDITF", traceditf_desc);
+       on_environment_enum(&config->tracesvc, "AFB_TRACESVC", tracesvc_desc);
+       on_environment_enum(&config->traceevt, "AFB_TRACEEVT", traceevt_desc);
+       on_environment_enum(&config->traceses, "AFB_TRACESES", traceses_desc);
+       on_environment_list(&config->ldpaths, "AFB_LDPATHS");
+}
+
 struct afb_config *afb_config_parse_arguments(int argc, char **argv)
 {
        struct afb_config *result;
 
        result = calloc(1, sizeof *result);
 
+       parse_environment(result);
        parse_arguments(argc, argv, result);
-       config_set_default(result);
+       fulfill_config(result);
        if (verbosity >= 3)
                afb_config_dump(result);
        return result;
 }
 
+struct json_object *afb_config_json(struct afb_config *config)
+{
+       struct json_object *r, *a;
+       struct afb_config_list *l;
+       struct enumdesc *e;
+       char **v;
+
+#define XA(t,o)                json_object_array_add(t,o);
+#define XO(t,x,o)      json_object_object_add(t,x,o);
+#define YS(s)          ((s)?json_object_new_string(s):NULL)
+
+#define AO(o)          XA(a,o)
+#define AS(s)          AO(YS(s))
+#define RO(x,o)                XO(r,x,o)
+#define RS(x,s)                RO(x,YS(s))
+#define RA(x)          RO(x,(a=json_object_new_array()))
+#define RI(x,i)                RO(x,json_object_new_int(i))
+#define RB(x,b)                RO(x,json_object_new_boolean(b))
+
+#define S(x)           RS(#x,config->x)
+#define V(x)           RA(#x);for(v=config->x;v&&*v;v++)AS(*v);
+#define L(x)           RA(#x);for(l=config->x;l;l=l->next)AS(l->value);
+#define D(x)           RI(#x,config->x)
+#define B(x)           RB(#x,config->x)
+#define E(x,d)         for(e=d;e->name&&e->value!=config->x;e++);if(e->name){RS(#x,e->name);}else{D(x);}
+
+       r = json_object_new_object();
+       S(console)
+       S(rootdir)
+       S(roothttp)
+       S(rootbase)
+       S(rootapi)
+       S(workdir)
+       S(uploaddir)
+       S(token)
+       S(name)
+
+       L(aliases)
+       L(dbus_clients)
+       L(dbus_servers)
+       L(ws_clients)
+       L(ws_servers)
+       L(so_bindings)
+       L(ldpaths)
+       L(weak_ldpaths)
+       L(calls)
+
+       V(exec)
+
+       D(httpdPort)
+       D(cacheTimeout)
+       D(apiTimeout)
+       D(cntxTimeout)
+       D(nbSessionMax)
+
+       E(mode,mode_desc)
+       E(tracereq,tracereq_desc)
+       E(traceditf,traceditf_desc)
+       E(tracesvc,tracesvc_desc)
+       E(traceevt,traceevt_desc)
+       E(traceses,traceses_desc)
+
+       B(no_ldpaths)
+       B(noHttpd)
+       B(background)
+#if defined(WITH_MONITORING_OPTION)
+       B(monitoring)
+#endif
+       B(random_token)
+
+#undef E
+#undef B
+#undef D
+#undef L
+#undef V
+#undef S
+
+#undef RB
+#undef RI
+#undef RA
+#undef RS
+#undef RS
+#undef AS
+#undef AO
+
+#undef YS
+#undef XO
+#undef XA
+
+       return r;
+}
+