src/config.c

   1 /*
   2  * Copyright (C) 2015 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18    References:
  19      https://www.gnu.org/software/libmicrohttpd/manual/html_node/index.html#Top
  20      http://www-01.ibm.com/support/knowledgecenter/SSB23S_1.1.0.9/com.ibm.ztpf-ztpfdf.doc_put.09/gtpc2/cpp_vsprintf.html?cp=SSB23S_1.1.0.9%2F0-3-8-1-0-16-8
  21
  22 */
  23
  24 #include "../include/local-def.h"
  25 #include <stdarg.h>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28
  29 #define AFB_CONFIG_JTYPE "AFB_config"
  30
  31 PUBLIC  char *ERROR_LABEL[]=ERROR_LABEL_DEF;
  32
  33 PUBLIC int verbose;
  34 STATIC AFB_errorT   AFBerr [AFB_SUCCESS+1];
  35 STATIC json_object *jTypeStatic;
  36
  37 /* ------------------------------------------------------------------------------
  38  * Get localtime and return in a string
  39  * ------------------------------------------------------------------------------ */
  40
  41 PUBLIC char * configTime (void) {
  42   static char reqTime [26];
  43   time_t tt;
  44   struct tm *rt;
  45
  46   /* Get actual Date and Time */
  47   time (&tt);
  48   rt = localtime (&tt);
  49
  50   strftime (reqTime, sizeof (reqTime), "(%d-%b %H:%M)",rt);
  51
  52   // return pointer on static data
  53   return (reqTime);
  54 }
  55
  56 // load config from disk and merge with CLI option
  57 PUBLIC AFB_error configLoadFile (AFB_session * session, AFB_config *cliconfig) {
  58    static char cacheTimeout [10];
  59    int fd;
  60    json_object * AFBConfig, *value;
  61
  62    // TBD integrate alias-dir array with config-file
  63    session->config->aliasdir = cliconfig->aliasdir;
  64
  65    // default HTTP port
  66    if (cliconfig->httpdPort == 0) session->config->httpdPort=1234;
  67    else session->config->httpdPort=cliconfig->httpdPort;
  68
  69    // default Plugin API timeout
  70    if (cliconfig->apiTimeout == 0) session->config->apiTimeout=DEFLT_API_TIMEOUT;
  71    else session->config->apiTimeout=cliconfig->apiTimeout;
  72
  73    // default AUTH_TOKEN
  74    if (cliconfig->token == NULL) session->config->token= DEFLT_AUTH_TOKEN;
  75    else session->config->token=cliconfig->token;
  76
  77    // cache timeout default one hour
  78    if (cliconfig->cacheTimeout == 0) session->config->cacheTimeout=DEFLT_CACHE_TIMEOUT;
  79    else session->config->cacheTimeout=cliconfig->cacheTimeout;
  80
  81    // cache timeout default one hour
  82    if (cliconfig->cntxTimeout == 0) session->config->cntxTimeout=DEFLT_CNTX_TIMEOUT;
  83    else session->config->cntxTimeout=cliconfig->cntxTimeout;
  84
  85    if (cliconfig->rootdir == NULL) {
  86        session->config->rootdir = getenv("AFBDIR");
  87        if (session->config->rootdir == NULL) {
  88            session->config->rootdir = malloc (512);
  89            strncpy  (session->config->rootdir, getenv("HOME"),512);
  90            strncat (session->config->rootdir, "/.AFB",512);
  91        }
  92        // if directory does not exist createit
  93        mkdir (session->config->rootdir,  O_RDWR | S_IRWXU | S_IRGRP);
  94    } else {
  95        session->config->rootdir =  cliconfig->rootdir;
  96    }
  97
  98    // if no Angular/HTML5 rootbase let's try '/' as default
  99    if  (cliconfig->rootbase == NULL) {
 100        session->config->rootbase = "/opa";
 101    } else {
 102        session->config->rootbase= cliconfig->rootbase;
 103    }
 104
 105    if  (cliconfig->rootapi == NULL) {
 106        session->config->rootapi = "/api";
 107    } else {
 108        session->config->rootapi= cliconfig->rootapi;
 109    }
 110
 111    if  (cliconfig->ldpaths == NULL) {
 112        session->config->ldpaths = PLUGIN_INSTALL_DIR;
 113    } else {
 114        session->config->ldpaths= cliconfig->ldpaths;
 115    }
 116
 117    // if no session dir create a default path from rootdir
 118    if  (cliconfig->sessiondir == NULL) {
 119        session->config->sessiondir = malloc (512);
 120        strncpy (session->config->sessiondir, session->config->rootdir, 512);
 121        strncat (session->config->sessiondir, "/sessions",512);
 122    } else {
 123        session->config->sessiondir = cliconfig->sessiondir;
 124    }
 125
 126    // if no config dir create a default path from sessiondir
 127    if  (cliconfig->configfile == NULL) {
 128        session->config->configfile = malloc (512);
 129        strncpy (session->config->configfile, session->config->sessiondir, 512);
 130        strncat (session->config->configfile, "/AFB-config.json",512);
 131    } else {
 132        session->config->configfile = cliconfig->configfile;
 133    }
 134
 135    // if no config dir create a default path from sessiondir
 136    if  (cliconfig->pidfile == NULL) {
 137        session->config->pidfile = malloc (512);
 138        strncpy (session->config->pidfile, session->config->sessiondir, 512);
 139        strncat (session->config->pidfile, "/AFB-process.pid",512);
 140    } else {
 141        session->config->pidfile= cliconfig->pidfile;
 142    }
 143
 144    // if no config dir create a default path from sessiondir
 145    if  (cliconfig->console == NULL) {
 146        session->config->console = malloc (512);
 147        strncpy (session->config->console, session->config->sessiondir, 512);
 148        strncat (session->config->console, "/AFB-console.out",512);
 149    } else {
 150        session->config->console= cliconfig->console;
 151    }
 152
 153    // just upload json object and return without any further processing
 154    if((fd = open(session->config->configfile, O_RDONLY)) < 0) {
 155       if (verbose) fprintf (stderr, "AFB:notice: config at %s: %s\n", session->config->configfile, strerror(errno));
 156       return AFB_EMPTY;
 157    }
 158
 159    // openjson from FD is not public API we need to reopen it !!!
 160    close(fd);
 161    AFBConfig = json_object_from_file (session->config->configfile);
 162
 163    // check it is an AFB_config
 164    if (json_object_object_get_ex (AFBConfig, "jtype", &value)) {
 165       if (strcmp (AFB_CONFIG_JTYPE, json_object_get_string (value))) {
 166          fprintf (stderr,"AFB: Error file [%s] is not a valid [%s] type\n ", session->config->configfile, AFB_CONFIG_JTYPE);
 167          return AFB_FAIL;
 168       }
 169    }
 170
 171    if (!cliconfig->rootdir && json_object_object_get_ex (AFBConfig, "rootdir", &value)) {
 172       session->config->rootdir =  strdup (json_object_get_string (value));
 173    }
 174
 175    if (!cliconfig->rootbase && json_object_object_get_ex (AFBConfig, "rootbase", &value)) {
 176       session->config->rootbase =  strdup (json_object_get_string (value));
 177    }
 178
 179    if (!cliconfig->rootapi && json_object_object_get_ex (AFBConfig, "rootapi", &value)) {
 180       session->config->rootapi =  strdup (json_object_get_string (value));
 181    }
 182
 183    if (!cliconfig->ldpaths && json_object_object_get_ex (AFBConfig, "plugins", &value)) {
 184       session->config->ldpaths =  strdup (json_object_get_string (value));
 185    }
 186
 187    if (!cliconfig->setuid && json_object_object_get_ex (AFBConfig, "setuid", &value)) {
 188       session->config->setuid = strdup (json_object_get_string (value));
 189    }
 190
 191    if (!cliconfig->sessiondir && json_object_object_get_ex (AFBConfig, "sessiondir", &value)) {
 192       session->config->sessiondir = strdup (json_object_get_string (value));
 193    }
 194
 195    if (!cliconfig->pidfile && json_object_object_get_ex (AFBConfig, "pidfile", &value)) {
 196       session->config->pidfile = strdup (json_object_get_string (value));
 197    }
 198
 199    if (!cliconfig->httpdPort && json_object_object_get_ex (AFBConfig, "httpdPort", &value)) {
 200       session->config->httpdPort = json_object_get_int (value);
 201    }
 202
 203
 204    if (!cliconfig->localhostOnly && json_object_object_get_ex (AFBConfig, "localhostonly", &value)) {
 205       session->config->localhostOnly = json_object_get_int (value);
 206    }
 207
 208    if (!cliconfig->cacheTimeout && json_object_object_get_ex (AFBConfig, "cachetimeout", &value)) {
 209       session->config->cacheTimeout = json_object_get_int (value);
 210    }
 211
 212    if (!cliconfig->apiTimeout && json_object_object_get_ex (AFBConfig, "apitimeout", &value)) {
 213       session->config->apiTimeout = json_object_get_int (value);
 214    }
 215
 216    if (!cliconfig->cntxTimeout && json_object_object_get_ex (AFBConfig, "cntxtimeout", &value)) {
 217       session->config->cntxTimeout = json_object_get_int (value);
 218    }
 219
 220    // cacheTimeout is an integer but HTTPd wants it as a string
 221    snprintf (cacheTimeout, sizeof (cacheTimeout),"%d", session->config->cacheTimeout);
 222    session->cacheTimeout = cacheTimeout; // httpd uses cacheTimeout string version
 223
 224    json_object_put   (AFBConfig);    // decrease reference count to free the json object
 225
 226
 227
 228    return AFB_SUCCESS;
 229 }
 230
 231 // Save the config on disk
 232 PUBLIC void configStoreFile (AFB_session * session) {
 233    json_object * AFBConfig;
 234    time_t rawtime;
 235    struct tm * timeinfo;
 236    int err;
 237
 238    AFBConfig =  json_object_new_object();
 239
 240    // add a timestamp and store session on disk
 241    time ( &rawtime );  timeinfo = localtime ( &rawtime );
 242    // A copy of the string is made and the memory is managed by the json_object
 243    json_object_object_add (AFBConfig, "jtype"         , json_object_new_string (AFB_CONFIG_JTYPE));
 244    json_object_object_add (AFBConfig, "timestamp"     , json_object_new_string (asctime (timeinfo)));
 245    json_object_object_add (AFBConfig, "rootdir"       , json_object_new_string (session->config->rootdir));
 246    json_object_object_add (AFBConfig, "rootapi"       , json_object_new_string (session->config->rootapi));
 247    json_object_object_add (AFBConfig, "rootbase"      , json_object_new_string (session->config->rootbase));
 248    json_object_object_add (AFBConfig, "plugins"       , json_object_new_string (session->config->ldpaths));
 249    json_object_object_add (AFBConfig, "sessiondir"    , json_object_new_string (session->config->sessiondir));
 250    json_object_object_add (AFBConfig, "pidfile"       , json_object_new_string (session->config->pidfile));
 251    json_object_object_add (AFBConfig, "setuid"        , json_object_new_string (session->config->setuid));
 252    json_object_object_add (AFBConfig, "httpdPort"     , json_object_new_int (session->config->httpdPort));
 253    json_object_object_add (AFBConfig, "localhostonly" , json_object_new_int (session->config->localhostOnly));
 254    json_object_object_add (AFBConfig, "cachetimeout"  , json_object_new_int (session->config->cacheTimeout));
 255    json_object_object_add (AFBConfig, "apitimeout"    , json_object_new_int (session->config->apiTimeout));
 256    json_object_object_add (AFBConfig, "cntxtimeout"   , json_object_new_int (session->config->cntxTimeout));
 257
 258    err = json_object_to_file (session->config->configfile, AFBConfig);
 259    json_object_put   (AFBConfig);    // decrease reference count to free the json object
 260    if (err < 0) {
 261       fprintf(stderr, "AFB: Fail to save config on disk [%s]\n ", session->config->configfile);
 262    }
 263 }
 264
 265
 266 PUBLIC AFB_session *configInit () {
 267
 268   AFB_session *session;
 269   AFB_config  *config;
 270   int idx, verbosesav;
 271
 272
 273   session = malloc (sizeof (AFB_session));
 274   memset (session,0, sizeof (AFB_session));
 275
 276   // create config handle
 277   config = malloc (sizeof (AFB_config));
 278   memset (config,0, sizeof (AFB_config));
 279
 280   // stack config handle into session
 281   session->config = config;
 282
 283   jTypeStatic = json_object_new_string ("AFB_message");
 284
 285   // initialise JSON constant messages and increase reference count to make them permanent
 286   verbosesav = verbose;
 287   verbose = 0;  // run initialisation in silent mode
 288
 289
 290   for (idx = 0; idx <= AFB_SUCCESS; idx++) {
 291      AFBerr[idx].level = idx;
 292      AFBerr[idx].label = ERROR_LABEL [idx];
 293      AFBerr[idx].json  = jsonNewMessage (idx, NULL);
 294   }
 295   verbose = verbosesav;
 296
 297   return (session);
 298 }
 299
 300
 301 // get JSON object from error level and increase its reference count
 302 PUBLIC json_object *jsonNewStatus (AFB_error level) {
 303
 304   json_object *target =  AFBerr[level].json;
 305   json_object_get (target);
 306
 307   return (target);
 308 }
 309
 310 // get AFB object type with adequate usage count
 311 PUBLIC json_object *jsonNewjtype (void) {
 312   json_object_get (jTypeStatic); // increase reference count
 313   return (jTypeStatic);
 314 }
 315
 316 // build an ERROR message and return it as a valid json object
 317 PUBLIC  json_object *jsonNewMessage (AFB_error level, char* format, ...) {
 318    static int count = 0;
 319    json_object * AFBResponse;
 320    va_list args;
 321    char message [512];
 322
 323    // format message
 324    if (format != NULL) {
 325        va_start(args, format);
 326        vsnprintf (message, sizeof (message), format, args);
 327        va_end(args);
 328    }
 329
 330    AFBResponse = json_object_new_object();
 331    json_object_object_add (AFBResponse, "jtype", jsonNewjtype ());
 332    json_object_object_add (AFBResponse, "status" , json_object_new_string (ERROR_LABEL[level]));
 333    if (format != NULL) {
 334         json_object_object_add (AFBResponse, "info"   , json_object_new_string (message));
 335    }
 336    if (verbose) {
 337         fprintf (stderr, "AFB:%-6s [%3d]: ", AFBerr [level].label, count++);
 338         if (format != NULL) {
 339             fprintf (stderr, "%s", message);
 340         } else {
 341             fprintf (stderr, "No Message");
 342         }
 343         fprintf (stderr, "\n");
 344    }
 345
 346    return (AFBResponse);
 347 }
 348
 349 // Dump a message on stderr
 350 PUBLIC void jsonDumpObject (json_object * jObject) {
 351
 352    if (verbose) {
 353         fprintf (stderr, "AFB:dump [%s]\n", json_object_to_json_string(jObject));
 354    }
 355 }
 356