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