2 * Copyright (C) 2015 "IoT.bzh"
3 * Author "Fulup Ar Foll"
4 * Author José Bollo <jose.bollo@iot.bzh>
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
28 #include <sys/types.h>
35 #include "afb-config.h"
36 #include "afb-hswitch.h"
37 #include "afb-api-so.h"
42 #include "utils-upoll.h"
44 #include "afb-plugin.h"
46 #if !defined(PLUGIN_INSTALL_DIR)
47 #error "you should define PLUGIN_INSTALL_DIR"
50 #define AFB_VERSION "0.1"
52 // Define command line option
54 #define SET_BACKGROUND 2
55 #define SET_FORGROUND 3
57 #define SET_TCP_PORT 5
58 #define SET_ROOT_DIR 6
59 #define SET_ROOT_BASE 7
60 #define SET_ROOT_API 8
63 #define SET_CACHE_TIMEOUT 10
64 #define SET_SESSION_DIR 11
66 #define SET_AUTH_TOKEN 12
68 #define SET_APITIMEOUT 14
69 #define SET_CNTXTIMEOUT 15
71 #define DISPLAY_VERSION 16
72 #define DISPLAY_HELP 17
75 #define SET_READYFD 19
77 static struct afb_hsrv *start(struct afb_config * config);
79 // Command line structure hold cli --command + help text
81 int val; // command number within application
82 int has_arg; // command number within application
83 char *name; // command as used in --xxxx cli
84 char *help; // help text
89 static AFB_options cliOptions [] = {
90 {SET_VERBOSE ,0,"verbose" , "Verbose Mode"},
92 {SET_FORGROUND ,0,"foreground" , "Get all in foreground mode"},
93 {SET_BACKGROUND ,0,"daemon" , "Get all in background mode"},
95 {SET_TCP_PORT ,1,"port" , "HTTP listening TCP port [default 1234]"},
96 {SET_ROOT_DIR ,1,"rootdir" , "HTTP Root Directory [default $HOME/.AFB]"},
97 {SET_ROOT_BASE ,1,"rootbase" , "Angular Base Root URL [default /opa]"},
98 {SET_ROOT_API ,1,"rootapi" , "HTML Root API URL [default /api]"},
99 {SET_ALIAS ,1,"alias" , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
101 {SET_APITIMEOUT ,1,"apitimeout" , "Plugin API timeout in seconds [default 10]"},
102 {SET_CNTXTIMEOUT ,1,"cntxtimeout" , "Client Session Context Timeout [default 900]"},
103 {SET_CACHE_TIMEOUT,1,"cache-eol" , "Client cache end of live [default 3600s]"},
105 {SET_SESSION_DIR ,1,"sessiondir" , "Sessions file path [default rootdir/sessions]"},
107 {SET_LDPATH ,1,"ldpaths" , "Load Plugins from dir1:dir2:... [default = PLUGIN_INSTALL_DIR"},
108 {SET_AUTH_TOKEN ,1,"token" , "Initial Secret [default=no-session, --token="" for session without authentication]"},
110 {DISPLAY_VERSION ,0,"version" , "Display version and copyright"},
111 {DISPLAY_HELP ,0,"help" , "Display this help"},
113 {SET_MODE ,1,"mode" , "set the mode: either local, remote or global"},
114 {SET_READYFD ,1,"readyfd" , "set the #fd to signal when ready"},
120 /*----------------------------------------------------------
122 | print version and copyright
123 +--------------------------------------------------------- */
124 static void printVersion (void)
126 fprintf (stderr,"\n----------------------------------------- \n");
127 fprintf (stderr,"| AFB [Application Framework Binder] version=%s |\n", AFB_VERSION);
128 fprintf (stderr,"----------------------------------------- \n");
129 fprintf (stderr,"| Copyright(C) 2016 /IoT.bzh [fulup -at- iot.bzh]\n");
130 fprintf (stderr,"| AFB comes with ABSOLUTELY NO WARRANTY.\n");
131 fprintf (stderr,"| Licence Apache 2\n\n");
135 // load config from disk and merge with CLI option
136 static void config_set_default (struct afb_config * config)
139 if (config->httpdPort == 0)
140 config->httpdPort = 1234;
142 // default Plugin API timeout
143 if (config->apiTimeout == 0)
144 config->apiTimeout = DEFLT_API_TIMEOUT;
146 // default AUTH_TOKEN
147 if (config->token == NULL)
148 config->token = DEFLT_AUTH_TOKEN;
150 // cache timeout default one hour
151 if (config->cacheTimeout == 0)
152 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
154 // cache timeout default one hour
155 if (config->cntxTimeout == 0)
156 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
158 if (config->rootdir == NULL) {
159 config->rootdir = getenv("AFBDIR");
160 if (config->rootdir == NULL) {
161 config->rootdir = malloc (512);
162 strncpy (config->rootdir, getenv("HOME"),512);
163 strncat (config->rootdir, "/.AFB",512);
165 // if directory does not exist createit
166 mkdir (config->rootdir, O_RDWR | S_IRWXU | S_IRGRP);
169 // if no Angular/HTML5 rootbase let's try '/' as default
170 if (config->rootbase == NULL)
171 config->rootbase = "/opa";
173 if (config->rootapi == NULL)
174 config->rootapi = "/api";
176 if (config->ldpaths == NULL)
177 config->ldpaths = PLUGIN_INSTALL_DIR;
179 // if no session dir create a default path from rootdir
180 if (config->sessiondir == NULL) {
181 config->sessiondir = malloc (512);
182 strncpy (config->sessiondir, config->rootdir, 512);
183 strncat (config->sessiondir, "/sessions",512);
186 // if no config dir create a default path from sessiondir
187 if (config->console == NULL) {
188 config->console = malloc (512);
189 strncpy (config->console, config->sessiondir, 512);
190 strncat (config->console, "/AFB-console.out",512);
195 /*----------------------------------------------------------
197 | print information from long option array
198 +--------------------------------------------------------- */
200 static void printHelp(char *name) {
204 fprintf (stderr,"%s:\nallowed options\n", name);
205 for (ind=0; cliOptions [ind].name != NULL;ind++)
208 if (cliOptions [ind].has_arg == 0 )
210 fprintf (stderr," --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help);
212 sprintf(command,"%s=xxxx", cliOptions [ind].name);
213 fprintf (stderr," --%-15s %s\n", command, cliOptions[ind].help);
216 fprintf (stderr,"Example:\n %s\\\n --verbose --port=1234 --token='azerty' --ldpaths=build/plugins:/usr/lib64/agl/plugins\n", name);
219 /*---------------------------------------------------------
221 | Parse option and launch action
222 +--------------------------------------------------------- */
224 static void parse_arguments(int argc, char *argv[], struct afb_config *config)
226 char* programName = argv [0];
230 struct option *gnuOptions;
232 // ------------------ Process Command Line -----------------------
234 // if no argument print help and return
236 printHelp(programName);
240 // build GNU getopt info from cliOptions
241 nbcmd = sizeof (cliOptions) / sizeof (AFB_options);
242 gnuOptions = malloc (sizeof (*gnuOptions) * (unsigned)nbcmd);
243 for (ind=0; ind < nbcmd;ind++) {
244 gnuOptions [ind].name = cliOptions[ind].name;
245 gnuOptions [ind].has_arg = cliOptions[ind].has_arg;
246 gnuOptions [ind].flag = 0;
247 gnuOptions [ind].val = cliOptions[ind].val;
250 // get all options from command line
251 while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex))
261 if (optarg == 0) goto needValueForOption;
262 if (!sscanf (optarg, "%d", &config->httpdPort)) goto notAnInteger;
266 if (optarg == 0) goto needValueForOption;
267 if (!sscanf (optarg, "%d", &config->apiTimeout)) goto notAnInteger;
270 case SET_CNTXTIMEOUT:
271 if (optarg == 0) goto needValueForOption;
272 if (!sscanf (optarg, "%d", &config->cntxTimeout)) goto notAnInteger;
276 if (optarg == 0) goto needValueForOption;
277 config->rootdir = optarg;
278 if (verbosity) fprintf(stderr, "Forcing Rootdir=%s\n",config->rootdir);
282 if (optarg == 0) goto needValueForOption;
283 config->rootbase = optarg;
284 if (verbosity) fprintf(stderr, "Forcing Rootbase=%s\n",config->rootbase);
288 if (optarg == 0) goto needValueForOption;
289 config->rootapi = optarg;
290 if (verbosity) fprintf(stderr, "Forcing Rootapi=%s\n",config->rootapi);
294 if (optarg == 0) goto needValueForOption;
295 if ((unsigned)config->aliascount < sizeof (config->aliasdir) / sizeof (config->aliasdir[0])) {
296 config->aliasdir[config->aliascount].url = strsep(&optarg,":");
297 if (optarg == NULL) {
298 fprintf(stderr, "missing ':' in alias %s, ignored\n", config->aliasdir[config->aliascount].url);
300 config->aliasdir[config->aliascount].path = optarg;
301 if (verbosity) fprintf(stderr, "Alias url=%s path=%s\n", config->aliasdir[config->aliascount].url, config->aliasdir[config->aliascount].path);
302 config->aliascount++;
305 fprintf(stderr, "Too many aliases [max:%d] %s ignored\n", MAX_ALIAS, optarg);
310 if (optarg == 0) goto needValueForOption;
311 config->token = optarg;
315 if (optarg == 0) goto needValueForOption;
316 config->ldpaths = optarg;
319 case SET_SESSION_DIR:
320 if (optarg == 0) goto needValueForOption;
321 config->sessiondir = optarg;
324 case SET_CACHE_TIMEOUT:
325 if (optarg == 0) goto needValueForOption;
326 if (!sscanf (optarg, "%d", &config->cacheTimeout)) goto notAnInteger;
330 if (optarg != 0) goto noValueForOption;
331 config->background = 0;
335 if (optarg != 0) goto noValueForOption;
336 config->background = 1;
340 if (optarg == 0) goto needValueForOption;
341 if (!strcmp(optarg, "local")) config->mode = AFB_MODE_LOCAL;
342 else if (!strcmp(optarg, "remote")) config->mode = AFB_MODE_REMOTE;
343 else if (!strcmp(optarg, "global")) config->mode = AFB_MODE_GLOBAL;
348 if (optarg == 0) goto needValueForOption;
349 if (!sscanf (optarg, "%u", &config->readyfd)) goto notAnInteger;
352 case DISPLAY_VERSION:
353 if (optarg != 0) goto noValueForOption;
359 printHelp(programName);
365 config_set_default (config);
370 fprintf (stderr,"\nERR: AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n"
371 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
375 fprintf (stderr,"\nERR: AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n"
376 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
380 fprintf (stderr,"\nERR: AFB-daemon option [--%s] don't take value\n\n"
381 ,gnuOptions[optionIndex].name);
385 fprintf (stderr,"\nERR: AFB-daemon option [--%s] only accepts local, global or remote.\n\n"
386 ,gnuOptions[optionIndex].name);
390 /*----------------------------------------------------------
392 | try to close everything before leaving
393 +--------------------------------------------------------- */
394 static void closeSession (int status, void *data) {
395 /* struct afb_config *config = data; */
398 /*----------------------------------------------------------
400 +--------------------------------------------------------- */
401 void signalQuit (int signum)
403 fprintf(stderr, "Terminating signal received %s\n", strsignal(signum));
408 /*----------------------------------------------------------
411 +--------------------------------------------------------- */
412 __thread sigjmp_buf *error_handler;
413 static void signalError(int signum)
417 // unlock signal to allow a new signal to come
418 if (error_handler != NULL) {
419 sigemptyset(&sigset);
420 sigaddset(&sigset, signum);
421 sigprocmask(SIG_UNBLOCK, &sigset, 0);
422 longjmp(*error_handler, signum);
424 if (signum == SIGALRM)
426 fprintf(stderr, "Unmonitored signal received %s\n", strsignal(signum));
430 static void install_error_handlers()
432 int i, signals[] = { SIGALRM, SIGSEGV, SIGFPE, 0 };
434 for (i = 0; signals[i] != 0; i++) {
435 if (signal(signals[i], signalError) == SIG_ERR) {
436 fprintf(stderr, "Signal handler error\n");
442 /*----------------------------------------------------------
444 | set the process in background
445 +--------------------------------------------------------- */
446 static void daemonize(struct afb_config *config)
451 // open /dev/console to redirect output messAFBes
452 consoleFD = open(config->console, O_WRONLY | O_APPEND | O_CREAT , 0640);
454 fprintf (stderr,"\nERR: AFB-daemon cannot open /dev/console (use --foreground)\n\n");
458 // fork process when running background mode
461 // if fail nothing much to do
463 fprintf (stderr,"\nERR: AFB-daemon Failed to fork son process\n\n");
467 // if in father process, just leave
468 if (pid != 0) _exit (0);
470 // son process get all data in standalone mode
471 fprintf (stderr, "\nAFB: background mode [pid:%d console:%s]\n", getpid(),config->console);
473 // redirect default I/O on console
474 close (2); dup(consoleFD); // redirect stderr
475 close (1); dup(consoleFD); // redirect stdout
476 close (0); // no need for stdin
480 setsid(); // allow father process to fully exit
481 sleep (2); // allow main to leave and release port
484 fprintf (stderr, "----------------------------\n");
485 fprintf (stderr, "INF: main background pid=%d\n", getpid());
489 /*---------------------------------------------------------
491 | Parse option and launch action
492 +--------------------------------------------------------- */
494 int main(int argc, char *argv[]) {
495 struct afb_hsrv *hsrv;
496 struct afb_config *config;
498 // open syslog if ever needed
499 openlog("afb-daemon", 0, LOG_DAEMON);
501 // ------------- Build session handler & init config -------
502 config = calloc (1, sizeof (struct afb_config));
504 on_exit(closeSession, config);
505 parse_arguments(argc, argv, config);
507 // ------------------ sanity check ----------------------------------------
508 if (config->httpdPort <= 0) {
509 fprintf (stderr, "ERR: no port is defined\n");
514 afb_api_so_add_pathset(config->ldpaths);
516 ctxStoreInit(CTX_NBCLIENTS, config->cntxTimeout, config->token);
517 if (!afb_hreq_init_cookie(config->httpdPort, config->rootapi, DEFLT_CNTX_TIMEOUT)) {
518 fprintf (stderr, "ERR: initialisation of cookies failed\n");
522 install_error_handlers();
524 // ------------------ clean exit on CTR-C signal ------------------------
525 if (signal (SIGINT, signalQuit) == SIG_ERR || signal (SIGABRT, signalQuit) == SIG_ERR) {
526 fprintf (stderr, "ERR: main fail to install Signal handler\n");
530 // let's run this program with a low priority
533 // ------------------ Finaly Process Commands -----------------------------
534 // let's not take the risk to run as ROOT
535 //if (getuid() == 0) goto errorNoRoot;
537 if (verbosity) fprintf (stderr, "AFB: notice Init config done\n");
539 // --------- run -----------
540 if (config->background) {
541 // --------- in background mode -----------
542 if (verbosity) fprintf (stderr, "AFB: Entering background mode\n");
545 // ---- in foreground mode --------------------
546 if (verbosity) fprintf (stderr,"AFB: notice Foreground mode\n");
550 hsrv = start (config);
554 if (config->readyfd != 0) {
555 static const char readystr[] = "READY=1";
556 write(config->readyfd, readystr, sizeof(readystr) - 1);
557 close(config->readyfd);
565 fprintf (stderr, "hoops returned from infinite loop [report bug]\n");
570 static int init(struct afb_hsrv *hsrv, struct afb_config * config)
574 if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_websocket_switch, NULL, 20))
577 if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_apis, NULL, 10))
580 for (idx = 0; idx < config->aliascount; idx++)
581 if (!afb_hsrv_add_alias (hsrv, config->aliasdir[idx].url, config->aliasdir[idx].path, 0))
584 if (!afb_hsrv_add_alias(hsrv, "", config->rootdir, -10))
587 if (!afb_hsrv_add_handler(hsrv, config->rootbase, afb_hswitch_one_page_api_redirect, NULL, -20))
593 static struct afb_hsrv *start(struct afb_config * config)
596 struct afb_hsrv *hsrv;
598 hsrv = afb_hsrv_create();
600 fprintf(stderr, "memory allocation failure\n");
604 if (!afb_hsrv_set_cache_timeout(hsrv, config->cacheTimeout)
605 || !init(hsrv, config)) {
606 fprintf (stderr, "Error: initialisation of httpd failed");
612 fprintf (stderr, "AFB:notice Waiting port=%d rootdir=%s\n", config->httpdPort, config->rootdir);
613 fprintf (stderr, "AFB:notice Browser URL= http:/*localhost:%d\n", config->httpdPort);
616 rc = afb_hsrv_start(hsrv, (uint16_t) config->httpdPort, 15);
618 fprintf (stderr, "Error: starting of httpd failed");