/* * Copyright (C) 2015 "IoT.bzh" * Author "Fulup Ar Foll" * Author José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #define _GNU_SOURCE #include #include #include #include #include #include #include #include #include #include #include #include #include #include "afb-config.h" #include "afb-hswitch.h" #include "afb-apis.h" #include "afb-api-so.h" #include "afb-hsrv.h" #include "afb-hreq.h" #include "session.h" #include "verbose.h" #include "afb-common.h" #include "afb-plugin.h" #if !defined(PLUGIN_INSTALL_DIR) #error "you should define PLUGIN_INSTALL_DIR" #endif #define AFB_VERSION "0.1" // Define command line option #define SET_VERBOSE 1 #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 #define SET_ALIAS 9 #define SET_CACHE_TIMEOUT 10 #define SET_SESSION_DIR 11 #define SET_AUTH_TOKEN 12 #define SET_LDPATH 13 #define SET_APITIMEOUT 14 #define SET_CNTXTIMEOUT 15 #define DISPLAY_VERSION 16 #define DISPLAY_HELP 17 #define SET_MODE 18 #define SET_READYFD 19 // Command line structure hold cli --command + help text typedef struct { int val; // command number within application int has_arg; // command number within application char *name; // command as used in --xxxx cli char *help; // help text } AFB_options; // Supported option static AFB_options cliOptions [] = { {SET_VERBOSE ,0,"verbose" , "Verbose Mode"}, {SET_FORGROUND ,0,"foreground" , "Get all in foreground mode"}, {SET_BACKGROUND ,0,"daemon" , "Get all in background mode"}, {SET_TCP_PORT ,1,"port" , "HTTP listening TCP port [default 1234]"}, {SET_ROOT_DIR ,1,"rootdir" , "HTTP Root Directory [default $HOME/.AFB]"}, {SET_ROOT_BASE ,1,"rootbase" , "Angular Base Root URL [default /opa]"}, {SET_ROOT_API ,1,"rootapi" , "HTML Root API URL [default /api]"}, {SET_ALIAS ,1,"alias" , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"}, {SET_APITIMEOUT ,1,"apitimeout" , "Plugin API timeout in seconds [default 10]"}, {SET_CNTXTIMEOUT ,1,"cntxtimeout" , "Client Session Context Timeout [default 900]"}, {SET_CACHE_TIMEOUT,1,"cache-eol" , "Client cache end of live [default 3600s]"}, {SET_SESSION_DIR ,1,"sessiondir" , "Sessions file path [default rootdir/sessions]"}, {SET_LDPATH ,1,"ldpaths" , "Load Plugins from dir1:dir2:... [default = PLUGIN_INSTALL_DIR"}, {SET_AUTH_TOKEN ,1,"token" , "Initial Secret [default=no-session, --token="" for session without authentication]"}, {DISPLAY_VERSION ,0,"version" , "Display version and copyright"}, {DISPLAY_HELP ,0,"help" , "Display this help"}, {SET_MODE ,1,"mode" , "set the mode: either local, remote or global"}, {SET_READYFD ,1,"readyfd" , "set the #fd to signal when ready"}, {0, 0, NULL, NULL} }; /*---------------------------------------------------------- | printversion | print version and copyright +--------------------------------------------------------- */ static void printVersion (void) { fprintf (stderr,"\n----------------------------------------- \n"); fprintf (stderr,"| AFB [Application Framework Binder] version=%s |\n", AFB_VERSION); fprintf (stderr,"----------------------------------------- \n"); fprintf (stderr,"| Copyright(C) 2016 /IoT.bzh [fulup -at- iot.bzh]\n"); fprintf (stderr,"| AFB comes with ABSOLUTELY NO WARRANTY.\n"); fprintf (stderr,"| Licence Apache 2\n\n"); exit (0); } // load config from disk and merge with CLI option static void config_set_default (struct afb_config * config) { // default HTTP port if (config->httpdPort == 0) config->httpdPort = 1234; // default Plugin API timeout if (config->apiTimeout == 0) config->apiTimeout = DEFLT_API_TIMEOUT; // default AUTH_TOKEN if (config->token == NULL) config->token = DEFLT_AUTH_TOKEN; // cache timeout default one hour if (config->cacheTimeout == 0) config->cacheTimeout = DEFLT_CACHE_TIMEOUT; // cache timeout default one hour if (config->cntxTimeout == 0) config->cntxTimeout = DEFLT_CNTX_TIMEOUT; if (config->rootdir == NULL) { config->rootdir = getenv("AFBDIR"); if (config->rootdir == NULL) { config->rootdir = malloc (512); strncpy (config->rootdir, getenv("HOME"),512); strncat (config->rootdir, "/.AFB",512); } // if directory does not exist createit mkdir (config->rootdir, O_RDWR | S_IRWXU | S_IRGRP); } // if no Angular/HTML5 rootbase let's try '/' as default if (config->rootbase == NULL) config->rootbase = "/opa"; if (config->rootapi == NULL) config->rootapi = "/api"; if (config->ldpaths == NULL) config->ldpaths = PLUGIN_INSTALL_DIR; // if no session dir create a default path from rootdir if (config->sessiondir == NULL) { config->sessiondir = malloc (512); strncpy (config->sessiondir, config->rootdir, 512); strncat (config->sessiondir, "/sessions",512); } // if no config dir create a default path from sessiondir if (config->console == NULL) { config->console = malloc (512); strncpy (config->console, config->sessiondir, 512); strncat (config->console, "/AFB-console.out",512); } } /*---------------------------------------------------------- | printHelp | print information from long option array +--------------------------------------------------------- */ static void printHelp(char *name) { int ind; char command[20]; fprintf (stderr,"%s:\nallowed options\n", name); for (ind=0; cliOptions [ind].name != NULL;ind++) { // display options if (cliOptions [ind].has_arg == 0 ) { fprintf (stderr," --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help); } else { sprintf(command,"%s=xxxx", cliOptions [ind].name); fprintf (stderr," --%-15s %s\n", command, cliOptions[ind].help); } } fprintf (stderr,"Example:\n %s\\\n --verbose --port=1234 --token='azerty' --ldpaths=build/plugins:/usr/lib64/agl/plugins\n", name); } // end printHelp /*--------------------------------------------------------- | main | Parse option and launch action +--------------------------------------------------------- */ static void parse_arguments(int argc, char *argv[], struct afb_config *config) { char* programName = argv [0]; int optionIndex = 0; int optc, ind; int nbcmd; struct option *gnuOptions; // ------------------ Process Command Line ----------------------- // if no argument print help and return if (argc < 2) { printHelp(programName); exit(1); } // build GNU getopt info from cliOptions nbcmd = sizeof (cliOptions) / sizeof (AFB_options); gnuOptions = malloc (sizeof (*gnuOptions) * (unsigned)nbcmd); for (ind=0; ind < nbcmd;ind++) { gnuOptions [ind].name = cliOptions[ind].name; gnuOptions [ind].has_arg = cliOptions[ind].has_arg; gnuOptions [ind].flag = 0; gnuOptions [ind].val = cliOptions[ind].val; } // get all options from command line while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex)) != EOF) { switch (optc) { case SET_VERBOSE: verbosity++; break; case SET_TCP_PORT: if (optarg == 0) goto needValueForOption; if (!sscanf (optarg, "%d", &config->httpdPort)) goto notAnInteger; break; case SET_APITIMEOUT: if (optarg == 0) goto needValueForOption; if (!sscanf (optarg, "%d", &config->apiTimeout)) goto notAnInteger; break; case SET_CNTXTIMEOUT: if (optarg == 0) goto needValueForOption; if (!sscanf (optarg, "%d", &config->cntxTimeout)) goto notAnInteger; break; case SET_ROOT_DIR: if (optarg == 0) goto needValueForOption; config->rootdir = optarg; if (verbosity) fprintf(stderr, "Forcing Rootdir=%s\n",config->rootdir); break; case SET_ROOT_BASE: if (optarg == 0) goto needValueForOption; config->rootbase = optarg; if (verbosity) fprintf(stderr, "Forcing Rootbase=%s\n",config->rootbase); break; case SET_ROOT_API: if (optarg == 0) goto needValueForOption; config->rootapi = optarg; if (verbosity) fprintf(stderr, "Forcing Rootapi=%s\n",config->rootapi); break; case SET_ALIAS: if (optarg == 0) goto needValueForOption; if ((unsigned)config->aliascount < sizeof (config->aliasdir) / sizeof (config->aliasdir[0])) { config->aliasdir[config->aliascount].url = strsep(&optarg,":"); if (optarg == NULL) { fprintf(stderr, "missing ':' in alias %s, ignored\n", config->aliasdir[config->aliascount].url); } else { config->aliasdir[config->aliascount].path = optarg; if (verbosity) fprintf(stderr, "Alias url=%s path=%s\n", config->aliasdir[config->aliascount].url, config->aliasdir[config->aliascount].path); config->aliascount++; } } else { fprintf(stderr, "Too many aliases [max:%d] %s ignored\n", MAX_ALIAS, optarg); } break; case SET_AUTH_TOKEN: if (optarg == 0) goto needValueForOption; config->token = optarg; break; case SET_LDPATH: if (optarg == 0) goto needValueForOption; config->ldpaths = optarg; break; case SET_SESSION_DIR: if (optarg == 0) goto needValueForOption; config->sessiondir = optarg; break; case SET_CACHE_TIMEOUT: if (optarg == 0) goto needValueForOption; if (!sscanf (optarg, "%d", &config->cacheTimeout)) goto notAnInteger; break; case SET_FORGROUND: if (optarg != 0) goto noValueForOption; config->background = 0; break; case SET_BACKGROUND: if (optarg != 0) goto noValueForOption; config->background = 1; break; case SET_MODE: if (optarg == 0) goto needValueForOption; if (!strcmp(optarg, "local")) config->mode = AFB_MODE_LOCAL; else if (!strcmp(optarg, "remote")) config->mode = AFB_MODE_REMOTE; else if (!strcmp(optarg, "global")) config->mode = AFB_MODE_GLOBAL; else goto badMode; break; case SET_READYFD: if (optarg == 0) goto needValueForOption; if (!sscanf (optarg, "%u", &config->readyfd)) goto notAnInteger; break; case DISPLAY_VERSION: if (optarg != 0) goto noValueForOption; printVersion(); exit(0); case DISPLAY_HELP: default: printHelp(programName); exit(0); } } free(gnuOptions); config_set_default (config); return; needValueForOption: fprintf (stderr,"\nERR: AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n" ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name); exit (1); notAnInteger: fprintf (stderr,"\nERR: AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n" ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name); exit (1); noValueForOption: fprintf (stderr,"\nERR: AFB-daemon option [--%s] don't take value\n\n" ,gnuOptions[optionIndex].name); exit (1); badMode: fprintf (stderr,"\nERR: AFB-daemon option [--%s] only accepts local, global or remote.\n\n" ,gnuOptions[optionIndex].name); exit (1); } /*---------------------------------------------------------- | closeSession | try to close everything before leaving +--------------------------------------------------------- */ static void closeSession (int status, void *data) { /* struct afb_config *config = data; */ } /*---------------------------------------------------------- | timeout signalQuit +--------------------------------------------------------- */ void signalQuit (int signum) { fprintf(stderr, "Terminating signal received %s\n", strsignal(signum)); exit(1); } /*---------------------------------------------------------- | Error signals | +--------------------------------------------------------- */ __thread sigjmp_buf *error_handler; static void signalError(int signum) { sigset_t sigset; // unlock signal to allow a new signal to come if (error_handler != NULL) { sigemptyset(&sigset); sigaddset(&sigset, signum); sigprocmask(SIG_UNBLOCK, &sigset, 0); longjmp(*error_handler, signum); } if (signum == SIGALRM) return; fprintf(stderr, "Unmonitored signal received %s\n", strsignal(signum)); exit(2); } static void install_error_handlers() { int i, signals[] = { SIGALRM, SIGSEGV, SIGFPE, 0 }; for (i = 0; signals[i] != 0; i++) { if (signal(signals[i], signalError) == SIG_ERR) { fprintf(stderr, "Signal handler error\n"); exit(1); } } } /*---------------------------------------------------------- | daemonize | set the process in background +--------------------------------------------------------- */ static void daemonize(struct afb_config *config) { int consoleFD; int pid; // open /dev/console to redirect output messAFBes consoleFD = open(config->console, O_WRONLY | O_APPEND | O_CREAT , 0640); if (consoleFD < 0) { fprintf (stderr,"\nERR: AFB-daemon cannot open /dev/console (use --foreground)\n\n"); exit (1); } // fork process when running background mode pid = fork (); // if fail nothing much to do if (pid == -1) { fprintf (stderr,"\nERR: AFB-daemon Failed to fork son process\n\n"); exit (1); } // if in father process, just leave if (pid != 0) _exit (0); // son process get all data in standalone mode fprintf (stderr, "\nAFB: background mode [pid:%d console:%s]\n", getpid(),config->console); // redirect default I/O on console close (2); dup(consoleFD); // redirect stderr close (1); dup(consoleFD); // redirect stdout close (0); // no need for stdin close (consoleFD); #if 0 setsid(); // allow father process to fully exit sleep (2); // allow main to leave and release port #endif fprintf (stderr, "----------------------------\n"); fprintf (stderr, "INF: main background pid=%d\n", getpid()); fflush (stderr); } /*--------------------------------------------------------- | http server | Handles the HTTP server +--------------------------------------------------------- */ static int init_http_server(struct afb_hsrv *hsrv, struct afb_config * config) { int idx; if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_websocket_switch, NULL, 20)) return 0; if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_apis, NULL, 10)) return 0; for (idx = 0; idx < config->aliascount; idx++) if (!afb_hsrv_add_alias (hsrv, config->aliasdir[idx].url, config->aliasdir[idx].path, 0)) return 0; if (!afb_hsrv_add_alias(hsrv, "", config->rootdir, -10)) return 0; if (!afb_hsrv_add_handler(hsrv, config->rootbase, afb_hswitch_one_page_api_redirect, NULL, -20)) return 0; return 1; } static struct afb_hsrv *start_http_server(struct afb_config * config) { int rc; struct afb_hsrv *hsrv; if (afb_hreq_init_download_path("/tmp")) { /* TODO: sessiondir? */ fprintf(stderr, "unable to set the tmp directory\n"); return NULL; } hsrv = afb_hsrv_create(); if (hsrv == NULL) { fprintf(stderr, "memory allocation failure\n"); return NULL; } if (!afb_hsrv_set_cache_timeout(hsrv, config->cacheTimeout) || !init_http_server(hsrv, config)) { fprintf (stderr, "Error: initialisation of httpd failed"); afb_hsrv_put(hsrv); return NULL; } if (verbosity) { fprintf (stderr, "AFB:notice Waiting port=%d rootdir=%s\n", config->httpdPort, config->rootdir); fprintf (stderr, "AFB:notice Browser URL= http:/*localhost:%d\n", config->httpdPort); } rc = afb_hsrv_start(hsrv, (uint16_t) config->httpdPort, 15); if (!rc) { fprintf (stderr, "Error: starting of httpd failed"); afb_hsrv_put(hsrv); return NULL; } return hsrv; } /*--------------------------------------------------------- | main | Parse option and launch action +--------------------------------------------------------- */ int main(int argc, char *argv[]) { struct afb_hsrv *hsrv; struct afb_config *config; struct sd_event *eventloop; // open syslog if ever needed openlog("afb-daemon", 0, LOG_DAEMON); // ------------- Build session handler & init config ------- config = calloc (1, sizeof (struct afb_config)); on_exit(closeSession, config); parse_arguments(argc, argv, config); // ------------------ sanity check ---------------------------------------- if (config->httpdPort <= 0) { fprintf (stderr, "ERR: no port is defined\n"); exit (1); } if (config->ldpaths) afb_api_so_add_pathset(config->ldpaths); ctxStoreInit(CTX_NBCLIENTS, config->cntxTimeout, config->token, afb_apis_count()); if (!afb_hreq_init_cookie(config->httpdPort, config->rootapi, DEFLT_CNTX_TIMEOUT)) { fprintf (stderr, "ERR: initialisation of cookies failed\n"); exit (1); } install_error_handlers(); // ------------------ clean exit on CTR-C signal ------------------------ if (signal (SIGINT, signalQuit) == SIG_ERR || signal (SIGABRT, signalQuit) == SIG_ERR) { fprintf (stderr, "ERR: main fail to install Signal handler\n"); return 1; } // let's run this program with a low priority nice (20); // ------------------ Finaly Process Commands ----------------------------- // let's not take the risk to run as ROOT //if (getuid() == 0) goto errorNoRoot; if (verbosity) fprintf (stderr, "AFB: notice Init config done\n"); // --------- run ----------- if (config->background) { // --------- in background mode ----------- if (verbosity) fprintf (stderr, "AFB: Entering background mode\n"); daemonize(config); } else { // ---- in foreground mode -------------------- if (verbosity) fprintf (stderr,"AFB: notice Foreground mode\n"); } hsrv = start_http_server(config); if (hsrv == NULL) exit(1); if (config->readyfd != 0) { static const char readystr[] = "READY=1"; write(config->readyfd, readystr, sizeof(readystr) - 1); close(config->readyfd); } // infinite loop eventloop = afb_common_get_event_loop(); for(;;) sd_event_run(eventloop, 30000000); if (verbosity) fprintf (stderr, "hoops returned from infinite loop [report bug]\n"); return 0; }