src/main.c

   1 /*
   2  * Copyright (C) 2015 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  * Author José Bollo <jose.bollo@iot.bzh>
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *   http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <stdio.h>
  21 #include <string.h>
  22 #include <getopt.h>
  23 #include <setjmp.h>
  24 #include <signal.h>
  25 #include <syslog.h>
  26 #include <fcntl.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29
  30 #include "afb-plugin.h"
  31
  32 #include "local-def.h"
  33 #include "afb-hswitch.h"
  34 #include "afb-api-so.h"
  35 #include "afb-hsrv.h"
  36 #include "afb-hreq.h"
  37 #include "session.h"
  38 #include "verbose.h"
  39 #include "utils-upoll.h"
  40
  41 #if !defined(PLUGIN_INSTALL_DIR)
  42 #error "you should define PLUGIN_INSTALL_DIR"
  43 #endif
  44
  45 #define AFB_VERSION    "0.1"
  46
  47 // Define command line option
  48 #define SET_VERBOSE        1
  49 #define SET_BACKGROUND     2
  50 #define SET_FORGROUND      3
  51
  52 #define SET_TCP_PORT       5
  53 #define SET_ROOT_DIR       6
  54 #define SET_ROOT_BASE      7
  55 #define SET_ROOT_API       8
  56 #define SET_ALIAS          9
  57
  58 #define SET_CACHE_TIMEOUT  10
  59 #define SET_SESSION_DIR    11
  60
  61 #define SET_AUTH_TOKEN     12
  62 #define SET_LDPATH         13
  63 #define SET_APITIMEOUT     14
  64 #define SET_CNTXTIMEOUT    15
  65
  66 #define DISPLAY_VERSION    16
  67 #define DISPLAY_HELP       17
  68
  69 #define SET_MODE           18
  70 #define SET_READYFD        19
  71
  72 static struct afb_hsrv *start(AFB_config * config);
  73
  74 // Command line structure hold cli --command + help text
  75 typedef struct {
  76   int  val;        // command number within application
  77   int  has_arg;    // command number within application
  78   char *name;      // command as used in --xxxx cli
  79   char *help;      // help text
  80 } AFB_options;
  81
  82
  83 // Supported option
  84 static  AFB_options cliOptions [] = {
  85   {SET_VERBOSE      ,0,"verbose"         , "Verbose Mode"},
  86
  87   {SET_FORGROUND    ,0,"foreground"      , "Get all in foreground mode"},
  88   {SET_BACKGROUND   ,0,"daemon"          , "Get all in background mode"},
  89
  90   {SET_TCP_PORT     ,1,"port"            , "HTTP listening TCP port  [default 1234]"},
  91   {SET_ROOT_DIR     ,1,"rootdir"         , "HTTP Root Directory [default $HOME/.AFB]"},
  92   {SET_ROOT_BASE    ,1,"rootbase"        , "Angular Base Root URL [default /opa]"},
  93   {SET_ROOT_API     ,1,"rootapi"         , "HTML Root API URL [default /api]"},
  94   {SET_ALIAS        ,1,"alias"           , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
  95
  96   {SET_APITIMEOUT   ,1,"apitimeout"      , "Plugin API timeout in seconds [default 10]"},
  97   {SET_CNTXTIMEOUT  ,1,"cntxtimeout"     , "Client Session Context Timeout [default 900]"},
  98   {SET_CACHE_TIMEOUT,1,"cache-eol"       , "Client cache end of live [default 3600s]"},
  99
 100   {SET_SESSION_DIR  ,1,"sessiondir"      , "Sessions file path [default rootdir/sessions]"},
 101
 102   {SET_LDPATH       ,1,"ldpaths"         , "Load Plugins from dir1:dir2:... [default = PLUGIN_INSTALL_DIR"},
 103   {SET_AUTH_TOKEN   ,1,"token"           , "Initial Secret [default=no-session, --token="" for session without authentication]"},
 104
 105   {DISPLAY_VERSION  ,0,"version"         , "Display version and copyright"},
 106   {DISPLAY_HELP     ,0,"help"            , "Display this help"},
 107
 108   {SET_MODE         ,1,"mode"            , "set the mode: either local, remote or global"},
 109   {SET_READYFD      ,1,"readyfd"         , "set the #fd to signal when ready"},
 110   {0, 0, NULL, NULL}
 111  };
 112
 113 static AFB_aliasdir aliasdir[MAX_ALIAS];
 114 static int aliascount = 0;
 115
 116
 117 /*----------------------------------------------------------
 118  | printversion
 119  |   print version and copyright
 120  +--------------------------------------------------------- */
 121 static void printVersion (void)
 122 {
 123    fprintf (stderr,"\n----------------------------------------- \n");
 124    fprintf (stderr,"|  AFB [Application Framework Binder] version=%s |\n", AFB_VERSION);
 125    fprintf (stderr,"----------------------------------------- \n");
 126    fprintf (stderr,"|  Copyright(C) 2016 /IoT.bzh [fulup -at- iot.bzh]\n");
 127    fprintf (stderr,"|  AFB comes with ABSOLUTELY NO WARRANTY.\n");
 128    fprintf (stderr,"|  Licence Apache 2\n\n");
 129    exit (0);
 130 }
 131
 132 // load config from disk and merge with CLI option
 133 static void config_set_default (AFB_config * config)
 134 {
 135    // default HTTP port
 136    if (config->httpdPort == 0)
 137         config->httpdPort = 1234;
 138
 139    // default Plugin API timeout
 140    if (config->apiTimeout == 0)
 141         config->apiTimeout = DEFLT_API_TIMEOUT;
 142
 143    // default AUTH_TOKEN
 144    if (config->token == NULL)
 145                 config->token = DEFLT_AUTH_TOKEN;
 146
 147    // cache timeout default one hour
 148    if (config->cacheTimeout == 0)
 149                 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
 150
 151    // cache timeout default one hour
 152    if (config->cntxTimeout == 0)
 153                 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
 154
 155    if (config->rootdir == NULL) {
 156        config->rootdir = getenv("AFBDIR");
 157        if (config->rootdir == NULL) {
 158            config->rootdir = malloc (512);
 159            strncpy (config->rootdir, getenv("HOME"),512);
 160            strncat (config->rootdir, "/.AFB",512);
 161        }
 162        // if directory does not exist createit
 163        mkdir (config->rootdir,  O_RDWR | S_IRWXU | S_IRGRP);
 164    }
 165
 166    // if no Angular/HTML5 rootbase let's try '/' as default
 167    if  (config->rootbase == NULL)
 168        config->rootbase = "/opa";
 169
 170    if  (config->rootapi == NULL)
 171        config->rootapi = "/api";
 172
 173    if  (config->ldpaths == NULL)
 174        config->ldpaths = PLUGIN_INSTALL_DIR;
 175
 176    // if no session dir create a default path from rootdir
 177    if  (config->sessiondir == NULL) {
 178        config->sessiondir = malloc (512);
 179        strncpy (config->sessiondir, config->rootdir, 512);
 180        strncat (config->sessiondir, "/sessions",512);
 181    }
 182
 183    // if no config dir create a default path from sessiondir
 184    if  (config->console == NULL) {
 185        config->console = malloc (512);
 186        strncpy (config->console, config->sessiondir, 512);
 187        strncat (config->console, "/AFB-console.out",512);
 188    }
 189 }
 190
 191
 192 /*----------------------------------------------------------
 193  | printHelp
 194  |   print information from long option array
 195  +--------------------------------------------------------- */
 196
 197  static void printHelp(char *name) {
 198     int ind;
 199     char command[20];
 200
 201     fprintf (stderr,"%s:\nallowed options\n", name);
 202     for (ind=0; cliOptions [ind].name != NULL;ind++)
 203     {
 204       // display options
 205       if (cliOptions [ind].has_arg == 0 )
 206       {
 207              fprintf (stderr,"  --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help);
 208       } else {
 209          sprintf(command,"%s=xxxx", cliOptions [ind].name);
 210          fprintf (stderr,"  --%-15s %s\n", command, cliOptions[ind].help);
 211       }
 212     }
 213     fprintf (stderr,"Example:\n  %s\\\n  --verbose --port=1234 --token='azerty' --ldpaths=build/plugins:/usr/lib64/agl/plugins\n", name);
 214 } // end printHelp
 215
 216 /*---------------------------------------------------------
 217  | main
 218  |   Parse option and launch action
 219  +--------------------------------------------------------- */
 220
 221 static void parse_arguments(int argc, char *argv[], AFB_session *session)
 222 {
 223   char*          programName = argv [0];
 224   int            optionIndex = 0;
 225   int            optc, ind;
 226   int            nbcmd;
 227   struct option *gnuOptions;
 228
 229   // ------------- Build session handler & init config -------
 230   memset(&aliasdir  ,0,sizeof(aliasdir));
 231   session->config->aliasdir = aliasdir;
 232
 233   // ------------------ Process Command Line -----------------------
 234
 235   // if no argument print help and return
 236   if (argc < 2) {
 237        printHelp(programName);
 238        exit(1);
 239   }
 240
 241   // build GNU getopt info from cliOptions
 242   nbcmd = sizeof (cliOptions) / sizeof (AFB_options);
 243   gnuOptions = malloc (sizeof (*gnuOptions) * (unsigned)nbcmd);
 244   for (ind=0; ind < nbcmd;ind++) {
 245     gnuOptions [ind].name    = cliOptions[ind].name;
 246     gnuOptions [ind].has_arg = cliOptions[ind].has_arg;
 247     gnuOptions [ind].flag    = 0;
 248     gnuOptions [ind].val     = cliOptions[ind].val;
 249   }
 250
 251   // get all options from command line
 252   while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex))
 253         != EOF)
 254   {
 255     switch (optc)
 256     {
 257      case SET_VERBOSE:
 258        verbosity++;
 259        break;
 260
 261     case SET_TCP_PORT:
 262        if (optarg == 0) goto needValueForOption;
 263        if (!sscanf (optarg, "%d", &session->config->httpdPort)) goto notAnInteger;
 264        break;
 265
 266     case SET_APITIMEOUT:
 267        if (optarg == 0) goto needValueForOption;
 268        if (!sscanf (optarg, "%d", &session->config->apiTimeout)) goto notAnInteger;
 269        break;
 270
 271     case SET_CNTXTIMEOUT:
 272        if (optarg == 0) goto needValueForOption;
 273        if (!sscanf (optarg, "%d", &session->config->cntxTimeout)) goto notAnInteger;
 274        break;
 275
 276     case SET_ROOT_DIR:
 277        if (optarg == 0) goto needValueForOption;
 278        session->config->rootdir   = optarg;
 279        if (verbosity) fprintf(stderr, "Forcing Rootdir=%s\n",session->config->rootdir);
 280        break;
 281
 282     case SET_ROOT_BASE:
 283        if (optarg == 0) goto needValueForOption;
 284        session->config->rootbase   = optarg;
 285        if (verbosity) fprintf(stderr, "Forcing Rootbase=%s\n",session->config->rootbase);
 286        break;
 287
 288     case SET_ROOT_API:
 289        if (optarg == 0) goto needValueForOption;
 290        session->config->rootapi   = optarg;
 291        if (verbosity) fprintf(stderr, "Forcing Rootapi=%s\n",session->config->rootapi);
 292        break;
 293
 294     case SET_ALIAS:
 295        if (optarg == 0) goto needValueForOption;
 296        if (aliascount < MAX_ALIAS) {
 297             aliasdir[aliascount].url  = strsep(&optarg,":");
 298             if (optarg == NULL) {
 299               fprintf(stderr, "missing ':' in alias %s, ignored\n", aliasdir[aliascount].url);
 300             } else {
 301               aliasdir[aliascount].path = optarg;
 302               aliasdir[aliascount].len  = strlen(aliasdir[aliascount].url);
 303               if (verbosity) fprintf(stderr, "Alias url=%s path=%s\n", aliasdir[aliascount].url, aliasdir[aliascount].path);
 304               aliascount++;
 305             }
 306        } else {
 307            fprintf(stderr, "Too many aliases [max:%d] %s ignored\n", MAX_ALIAS, optarg);
 308        }
 309        break;
 310
 311     case SET_AUTH_TOKEN:
 312        if (optarg == 0) goto needValueForOption;
 313        session->config->token   = optarg;
 314        break;
 315
 316     case SET_LDPATH:
 317        if (optarg == 0) goto needValueForOption;
 318        session->config->ldpaths = optarg;
 319        break;
 320
 321     case SET_SESSION_DIR:
 322        if (optarg == 0) goto needValueForOption;
 323        session->config->sessiondir   = optarg;
 324        break;
 325
 326     case  SET_CACHE_TIMEOUT:
 327        if (optarg == 0) goto needValueForOption;
 328        if (!sscanf (optarg, "%d", &session->config->cacheTimeout)) goto notAnInteger;
 329        break;
 330
 331     case SET_FORGROUND:
 332        if (optarg != 0) goto noValueForOption;
 333        session->background  = 0;
 334        break;
 335
 336     case SET_BACKGROUND:
 337        if (optarg != 0) goto noValueForOption;
 338        session->background  = 1;
 339        break;
 340
 341     case SET_MODE:
 342        if (optarg == 0) goto needValueForOption;
 343        if (!strcmp(optarg, "local")) session->config->mode = AFB_MODE_LOCAL;
 344        else if (!strcmp(optarg, "remote")) session->config->mode = AFB_MODE_REMOTE;
 345        else if (!strcmp(optarg, "global")) session->config->mode = AFB_MODE_GLOBAL;
 346        else goto badMode;
 347        break;
 348
 349     case SET_READYFD:
 350        if (optarg == 0) goto needValueForOption;
 351        if (!sscanf (optarg, "%u", &session->readyfd)) goto notAnInteger;
 352        break;
 353
 354     case DISPLAY_VERSION:
 355        if (optarg != 0) goto noValueForOption;
 356        printVersion();
 357        exit(0);
 358
 359     case DISPLAY_HELP:
 360      default:
 361        printHelp(programName);
 362        exit(0);
 363     }
 364   }
 365   free(gnuOptions);
 366
 367   config_set_default  (session->config);
 368   return;
 369
 370
 371 needValueForOption:
 372   fprintf (stderr,"\nERR: AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n"
 373           ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
 374   exit (1);
 375
 376 notAnInteger:
 377   fprintf (stderr,"\nERR: AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n"
 378           ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
 379   exit (1);
 380
 381 noValueForOption:
 382   fprintf (stderr,"\nERR: AFB-daemon option [--%s] don't take value\n\n"
 383           ,gnuOptions[optionIndex].name);
 384   exit (1);
 385
 386 badMode:
 387   fprintf (stderr,"\nERR: AFB-daemon option [--%s] only accepts local, global or remote.\n\n"
 388           ,gnuOptions[optionIndex].name);
 389   exit (1);
 390 }
 391
 392 /*----------------------------------------------------------
 393  | closeSession
 394  |   try to close everything before leaving
 395  +--------------------------------------------------------- */
 396 static void closeSession (int status, void *data) {
 397         /* AFB_session *session = data; */
 398 }
 399
 400 /*----------------------------------------------------------
 401  | timeout signalQuit
 402  +--------------------------------------------------------- */
 403 void signalQuit (int signum)
 404 {
 405         fprintf(stderr, "Terminating signal received %s\n", strsignal(signum));
 406         exit(1);
 407 }
 408
 409
 410 /*----------------------------------------------------------
 411  | Error signals
 412  |
 413  +--------------------------------------------------------- */
 414 __thread sigjmp_buf *error_handler;
 415 static void signalError(int signum)
 416 {
 417         sigset_t sigset;
 418
 419         // unlock signal to allow a new signal to come
 420         if (error_handler != NULL) {
 421                 sigemptyset(&sigset);
 422                 sigaddset(&sigset, signum);
 423                 sigprocmask(SIG_UNBLOCK, &sigset, 0);
 424                 longjmp(*error_handler, signum);
 425         }
 426         if (signum == SIGALRM)
 427                 return;
 428         fprintf(stderr, "Unmonitored signal received %s\n", strsignal(signum));
 429         exit(2);
 430 }
 431
 432 static void install_error_handlers()
 433 {
 434         int i, signals[] = { SIGALRM, SIGSEGV, SIGFPE, 0 };
 435
 436         for (i = 0; signals[i] != 0; i++) {
 437                 if (signal(signals[i], signalError) == SIG_ERR) {
 438                         fprintf(stderr, "Signal handler error\n");
 439                         exit(1);
 440                 }
 441         }
 442 }
 443
 444 /*----------------------------------------------------------
 445  | daemonize
 446  |   set the process in background
 447  +--------------------------------------------------------- */
 448 static void daemonize(AFB_session *session)
 449 {
 450   int            consoleFD;
 451   int            pid;
 452
 453       // open /dev/console to redirect output messAFBes
 454       consoleFD = open(session->config->console, O_WRONLY | O_APPEND | O_CREAT , 0640);
 455       if (consoleFD < 0) {
 456                 fprintf (stderr,"\nERR: AFB-daemon cannot open /dev/console (use --foreground)\n\n");
 457                 exit (1);
 458       }
 459
 460       // fork process when running background mode
 461       pid = fork ();
 462
 463       // if fail nothing much to do
 464       if (pid == -1) {
 465                 fprintf (stderr,"\nERR: AFB-daemon Failed to fork son process\n\n");
 466                 exit (1);
 467         }
 468
 469       // if in father process, just leave
 470       if (pid != 0) _exit (0);
 471
 472       // son process get all data in standalone mode
 473      fprintf (stderr, "\nAFB: background mode [pid:%d console:%s]\n", getpid(),session->config->console);
 474
 475       // redirect default I/O on console
 476       close (2); dup(consoleFD);  // redirect stderr
 477       close (1); dup(consoleFD);  // redirect stdout
 478       close (0);           // no need for stdin
 479       close (consoleFD);
 480
 481 #if 0
 482          setsid();   // allow father process to fully exit
 483      sleep (2);  // allow main to leave and release port
 484 #endif
 485
 486          fprintf (stderr, "----------------------------\n");
 487          fprintf (stderr, "INF: main background pid=%d\n", getpid());
 488          fflush  (stderr);
 489 }
 490
 491 /*---------------------------------------------------------
 492  | main
 493  |   Parse option and launch action
 494  +--------------------------------------------------------- */
 495
 496 int main(int argc, char *argv[])  {
 497   AFB_session    *session;
 498   struct afb_hsrv *hsrv;
 499
 500   // open syslog if ever needed
 501   openlog("afb-daemon", 0, LOG_DAEMON);
 502
 503   // ------------- Build session handler & init config -------
 504   session = calloc (1, sizeof (AFB_session));
 505   session->config = calloc (1, sizeof (AFB_config));
 506
 507   on_exit(closeSession, session);
 508   parse_arguments(argc, argv, session);
 509
 510   // ------------------ sanity check ----------------------------------------
 511   if (session->config->httpdPort <= 0) {
 512     fprintf (stderr, "ERR: no port is defined\n");
 513      exit (1);
 514   }
 515
 516   if (session->config->ldpaths)
 517     afb_api_so_add_pathset(session->config->ldpaths);
 518
 519   ctxStoreInit(CTX_NBCLIENTS, session->config->cntxTimeout, session->config->token);
 520   if (!afb_hreq_init_cookie(session->config->httpdPort, session->config->rootapi, DEFLT_CNTX_TIMEOUT)) {
 521     fprintf (stderr, "ERR: initialisation of cookies failed\n");
 522      exit (1);
 523   }
 524
 525   install_error_handlers();
 526
 527   // ------------------ clean exit on CTR-C signal ------------------------
 528   if (signal (SIGINT, signalQuit) == SIG_ERR || signal (SIGABRT, signalQuit) == SIG_ERR) {
 529      fprintf (stderr, "ERR: main fail to install Signal handler\n");
 530      return 1;
 531   }
 532
 533   // let's run this program with a low priority
 534   nice (20);
 535
 536   // ------------------ Finaly Process Commands -----------------------------
 537   // let's not take the risk to run as ROOT
 538   //if (getuid() == 0)  goto errorNoRoot;
 539
 540   if (verbosity) fprintf (stderr, "AFB: notice Init config done\n");
 541
 542   // --------- run -----------
 543   if (session->background) {
 544       // --------- in background mode -----------
 545       if (verbosity) fprintf (stderr, "AFB: Entering background mode\n");
 546       daemonize(session);
 547   } else {
 548       // ---- in foreground mode --------------------
 549       if (verbosity) fprintf (stderr,"AFB: notice Foreground mode\n");
 550
 551   }
 552
 553    hsrv = start (session->config);
 554    if (hsrv == NULL)
 555         exit(1);
 556
 557    if (session->readyfd != 0) {
 558                 static const char readystr[] = "READY=1";
 559                 write(session->readyfd, readystr, sizeof(readystr) - 1);
 560                 close(session->readyfd);
 561   }
 562
 563    // infinite loop
 564   for(;;)
 565     upoll_wait(30000);
 566
 567    if (verbosity)
 568        fprintf (stderr, "hoops returned from infinite loop [report bug]\n");
 569
 570   return 0;
 571 }
 572
 573 static int init(struct afb_hsrv *hsrv, AFB_config * config)
 574 {
 575         int idx;
 576
 577         if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_websocket_switch, NULL, 20))
 578                 return 0;
 579
 580         if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_apis, NULL, 10))
 581                 return 0;
 582
 583         for (idx = 0; config->aliasdir[idx].url != NULL; idx++)
 584                 if (!afb_hsrv_add_alias (hsrv, config->aliasdir[idx].url, config->aliasdir[idx].path, 0))
 585                         return 0;
 586
 587         if (!afb_hsrv_add_alias(hsrv, "", config->rootdir, -10))
 588                 return 0;
 589
 590         if (!afb_hsrv_add_handler(hsrv, config->rootbase, afb_hswitch_one_page_api_redirect, NULL, -20))
 591                 return 0;
 592
 593         return 1;
 594 }
 595
 596 static struct afb_hsrv *start(AFB_config * config)
 597 {
 598         int rc;
 599         struct afb_hsrv *hsrv;
 600
 601         hsrv = afb_hsrv_create();
 602         if (hsrv == NULL) {
 603                 fprintf(stderr, "memory allocation failure\n");
 604                 return NULL;
 605         }
 606
 607         if (!afb_hsrv_set_cache_timeout(hsrv, config->cacheTimeout)
 608         || !init(hsrv, config)) {
 609                 fprintf (stderr, "Error: initialisation of httpd failed");
 610                 afb_hsrv_put(hsrv);
 611                 return NULL;
 612         }
 613
 614         if (verbosity) {
 615                 fprintf (stderr, "AFB:notice Waiting port=%d rootdir=%s\n", config->httpdPort, config->rootdir);
 616                 fprintf (stderr, "AFB:notice Browser URL= http:/*localhost:%d\n", config->httpdPort);
 617         }
 618
 619         rc = afb_hsrv_start(hsrv, (uint16_t) config->httpdPort, 15);
 620         if (!rc) {
 621                 fprintf (stderr, "Error: starting of httpd failed");
 622                 afb_hsrv_put(hsrv);
 623                 return NULL;
 624         }
 625
 626         return hsrv;
 627 }
 628
 629