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"
38 #include "afb-api-so.h"
43 #include "utils-upoll.h"
45 #include "afb-plugin.h"
47 #if !defined(PLUGIN_INSTALL_DIR)
48 #error "you should define PLUGIN_INSTALL_DIR"
51 #define AFB_VERSION "0.1"
53 // Define command line option
55 #define SET_BACKGROUND 2
56 #define SET_FORGROUND 3
58 #define SET_TCP_PORT 5
59 #define SET_ROOT_DIR 6
60 #define SET_ROOT_BASE 7
61 #define SET_ROOT_API 8
64 #define SET_CACHE_TIMEOUT 10
65 #define SET_SESSION_DIR 11
67 #define SET_AUTH_TOKEN 12
69 #define SET_APITIMEOUT 14
70 #define SET_CNTXTIMEOUT 15
72 #define DISPLAY_VERSION 16
73 #define DISPLAY_HELP 17
76 #define SET_READYFD 19
78 // Command line structure hold cli --command + help text
80 int val; // command number within application
81 int has_arg; // command number within application
82 char *name; // command as used in --xxxx cli
83 char *help; // help text
88 static AFB_options cliOptions [] = {
89 {SET_VERBOSE ,0,"verbose" , "Verbose Mode"},
91 {SET_FORGROUND ,0,"foreground" , "Get all in foreground mode"},
92 {SET_BACKGROUND ,0,"daemon" , "Get all in background mode"},
94 {SET_TCP_PORT ,1,"port" , "HTTP listening TCP port [default 1234]"},
95 {SET_ROOT_DIR ,1,"rootdir" , "HTTP Root Directory [default $HOME/.AFB]"},
96 {SET_ROOT_BASE ,1,"rootbase" , "Angular Base Root URL [default /opa]"},
97 {SET_ROOT_API ,1,"rootapi" , "HTML Root API URL [default /api]"},
98 {SET_ALIAS ,1,"alias" , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
100 {SET_APITIMEOUT ,1,"apitimeout" , "Plugin API timeout in seconds [default 10]"},
101 {SET_CNTXTIMEOUT ,1,"cntxtimeout" , "Client Session Context Timeout [default 900]"},
102 {SET_CACHE_TIMEOUT,1,"cache-eol" , "Client cache end of live [default 3600s]"},
104 {SET_SESSION_DIR ,1,"sessiondir" , "Sessions file path [default rootdir/sessions]"},
106 {SET_LDPATH ,1,"ldpaths" , "Load Plugins from dir1:dir2:... [default = PLUGIN_INSTALL_DIR"},
107 {SET_AUTH_TOKEN ,1,"token" , "Initial Secret [default=no-session, --token="" for session without authentication]"},
109 {DISPLAY_VERSION ,0,"version" , "Display version and copyright"},
110 {DISPLAY_HELP ,0,"help" , "Display this help"},
112 {SET_MODE ,1,"mode" , "set the mode: either local, remote or global"},
113 {SET_READYFD ,1,"readyfd" , "set the #fd to signal when ready"},
119 /*----------------------------------------------------------
121 | print version and copyright
122 +--------------------------------------------------------- */
123 static void printVersion (void)
125 fprintf (stderr,"\n----------------------------------------- \n");
126 fprintf (stderr,"| AFB [Application Framework Binder] version=%s |\n", AFB_VERSION);
127 fprintf (stderr,"----------------------------------------- \n");
128 fprintf (stderr,"| Copyright(C) 2016 /IoT.bzh [fulup -at- iot.bzh]\n");
129 fprintf (stderr,"| AFB comes with ABSOLUTELY NO WARRANTY.\n");
130 fprintf (stderr,"| Licence Apache 2\n\n");
134 // load config from disk and merge with CLI option
135 static void config_set_default (struct afb_config * config)
138 if (config->httpdPort == 0)
139 config->httpdPort = 1234;
141 // default Plugin API timeout
142 if (config->apiTimeout == 0)
143 config->apiTimeout = DEFLT_API_TIMEOUT;
145 // default AUTH_TOKEN
146 if (config->token == NULL)
147 config->token = DEFLT_AUTH_TOKEN;
149 // cache timeout default one hour
150 if (config->cacheTimeout == 0)
151 config->cacheTimeout = DEFLT_CACHE_TIMEOUT;
153 // cache timeout default one hour
154 if (config->cntxTimeout == 0)
155 config->cntxTimeout = DEFLT_CNTX_TIMEOUT;
157 if (config->rootdir == NULL) {
158 config->rootdir = getenv("AFBDIR");
159 if (config->rootdir == NULL) {
160 config->rootdir = malloc (512);
161 strncpy (config->rootdir, getenv("HOME"),512);
162 strncat (config->rootdir, "/.AFB",512);
164 // if directory does not exist createit
165 mkdir (config->rootdir, O_RDWR | S_IRWXU | S_IRGRP);
168 // if no Angular/HTML5 rootbase let's try '/' as default
169 if (config->rootbase == NULL)
170 config->rootbase = "/opa";
172 if (config->rootapi == NULL)
173 config->rootapi = "/api";
175 if (config->ldpaths == NULL)
176 config->ldpaths = PLUGIN_INSTALL_DIR;
178 // if no session dir create a default path from rootdir
179 if (config->sessiondir == NULL) {
180 config->sessiondir = malloc (512);
181 strncpy (config->sessiondir, config->rootdir, 512);
182 strncat (config->sessiondir, "/sessions",512);
185 // if no config dir create a default path from sessiondir
186 if (config->console == NULL) {
187 config->console = malloc (512);
188 strncpy (config->console, config->sessiondir, 512);
189 strncat (config->console, "/AFB-console.out",512);
194 /*----------------------------------------------------------
196 | print information from long option array
197 +--------------------------------------------------------- */
199 static void printHelp(char *name) {
203 fprintf (stderr,"%s:\nallowed options\n", name);
204 for (ind=0; cliOptions [ind].name != NULL;ind++)
207 if (cliOptions [ind].has_arg == 0 )
209 fprintf (stderr," --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help);
211 sprintf(command,"%s=xxxx", cliOptions [ind].name);
212 fprintf (stderr," --%-15s %s\n", command, cliOptions[ind].help);
215 fprintf (stderr,"Example:\n %s\\\n --verbose --port=1234 --token='azerty' --ldpaths=build/plugins:/usr/lib64/agl/plugins\n", name);
218 /*---------------------------------------------------------
220 | Parse option and launch action
221 +--------------------------------------------------------- */
223 static void parse_arguments(int argc, char *argv[], struct afb_config *config)
225 char* programName = argv [0];
229 struct option *gnuOptions;
231 // ------------------ Process Command Line -----------------------
233 // if no argument print help and return
235 printHelp(programName);
239 // build GNU getopt info from cliOptions
240 nbcmd = sizeof (cliOptions) / sizeof (AFB_options);
241 gnuOptions = malloc (sizeof (*gnuOptions) * (unsigned)nbcmd);
242 for (ind=0; ind < nbcmd;ind++) {
243 gnuOptions [ind].name = cliOptions[ind].name;
244 gnuOptions [ind].has_arg = cliOptions[ind].has_arg;
245 gnuOptions [ind].flag = 0;
246 gnuOptions [ind].val = cliOptions[ind].val;
249 // get all options from command line
250 while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex))
260 if (optarg == 0) goto needValueForOption;
261 if (!sscanf (optarg, "%d", &config->httpdPort)) goto notAnInteger;
265 if (optarg == 0) goto needValueForOption;
266 if (!sscanf (optarg, "%d", &config->apiTimeout)) goto notAnInteger;
269 case SET_CNTXTIMEOUT:
270 if (optarg == 0) goto needValueForOption;
271 if (!sscanf (optarg, "%d", &config->cntxTimeout)) goto notAnInteger;
275 if (optarg == 0) goto needValueForOption;
276 config->rootdir = optarg;
277 if (verbosity) fprintf(stderr, "Forcing Rootdir=%s\n",config->rootdir);
281 if (optarg == 0) goto needValueForOption;
282 config->rootbase = optarg;
283 if (verbosity) fprintf(stderr, "Forcing Rootbase=%s\n",config->rootbase);
287 if (optarg == 0) goto needValueForOption;
288 config->rootapi = optarg;
289 if (verbosity) fprintf(stderr, "Forcing Rootapi=%s\n",config->rootapi);
293 if (optarg == 0) goto needValueForOption;
294 if ((unsigned)config->aliascount < sizeof (config->aliasdir) / sizeof (config->aliasdir[0])) {
295 config->aliasdir[config->aliascount].url = strsep(&optarg,":");
296 if (optarg == NULL) {
297 fprintf(stderr, "missing ':' in alias %s, ignored\n", config->aliasdir[config->aliascount].url);
299 config->aliasdir[config->aliascount].path = optarg;
300 if (verbosity) fprintf(stderr, "Alias url=%s path=%s\n", config->aliasdir[config->aliascount].url, config->aliasdir[config->aliascount].path);
301 config->aliascount++;
304 fprintf(stderr, "Too many aliases [max:%d] %s ignored\n", MAX_ALIAS, optarg);
309 if (optarg == 0) goto needValueForOption;
310 config->token = optarg;
314 if (optarg == 0) goto needValueForOption;
315 config->ldpaths = optarg;
318 case SET_SESSION_DIR:
319 if (optarg == 0) goto needValueForOption;
320 config->sessiondir = optarg;
323 case SET_CACHE_TIMEOUT:
324 if (optarg == 0) goto needValueForOption;
325 if (!sscanf (optarg, "%d", &config->cacheTimeout)) goto notAnInteger;
329 if (optarg != 0) goto noValueForOption;
330 config->background = 0;
334 if (optarg != 0) goto noValueForOption;
335 config->background = 1;
339 if (optarg == 0) goto needValueForOption;
340 if (!strcmp(optarg, "local")) config->mode = AFB_MODE_LOCAL;
341 else if (!strcmp(optarg, "remote")) config->mode = AFB_MODE_REMOTE;
342 else if (!strcmp(optarg, "global")) config->mode = AFB_MODE_GLOBAL;
347 if (optarg == 0) goto needValueForOption;
348 if (!sscanf (optarg, "%u", &config->readyfd)) goto notAnInteger;
351 case DISPLAY_VERSION:
352 if (optarg != 0) goto noValueForOption;
358 printHelp(programName);
364 config_set_default (config);
369 fprintf (stderr,"\nERR: AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n"
370 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
374 fprintf (stderr,"\nERR: AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n"
375 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
379 fprintf (stderr,"\nERR: AFB-daemon option [--%s] don't take value\n\n"
380 ,gnuOptions[optionIndex].name);
384 fprintf (stderr,"\nERR: AFB-daemon option [--%s] only accepts local, global or remote.\n\n"
385 ,gnuOptions[optionIndex].name);
389 /*----------------------------------------------------------
391 | try to close everything before leaving
392 +--------------------------------------------------------- */
393 static void closeSession (int status, void *data) {
394 /* struct afb_config *config = data; */
397 /*----------------------------------------------------------
399 +--------------------------------------------------------- */
400 void signalQuit (int signum)
402 fprintf(stderr, "Terminating signal received %s\n", strsignal(signum));
407 /*----------------------------------------------------------
410 +--------------------------------------------------------- */
411 __thread sigjmp_buf *error_handler;
412 static void signalError(int signum)
416 // unlock signal to allow a new signal to come
417 if (error_handler != NULL) {
418 sigemptyset(&sigset);
419 sigaddset(&sigset, signum);
420 sigprocmask(SIG_UNBLOCK, &sigset, 0);
421 longjmp(*error_handler, signum);
423 if (signum == SIGALRM)
425 fprintf(stderr, "Unmonitored signal received %s\n", strsignal(signum));
429 static void install_error_handlers()
431 int i, signals[] = { SIGALRM, SIGSEGV, SIGFPE, 0 };
433 for (i = 0; signals[i] != 0; i++) {
434 if (signal(signals[i], signalError) == SIG_ERR) {
435 fprintf(stderr, "Signal handler error\n");
441 /*----------------------------------------------------------
443 | set the process in background
444 +--------------------------------------------------------- */
445 static void daemonize(struct afb_config *config)
450 // open /dev/console to redirect output messAFBes
451 consoleFD = open(config->console, O_WRONLY | O_APPEND | O_CREAT , 0640);
453 fprintf (stderr,"\nERR: AFB-daemon cannot open /dev/console (use --foreground)\n\n");
457 // fork process when running background mode
460 // if fail nothing much to do
462 fprintf (stderr,"\nERR: AFB-daemon Failed to fork son process\n\n");
466 // if in father process, just leave
467 if (pid != 0) _exit (0);
469 // son process get all data in standalone mode
470 fprintf (stderr, "\nAFB: background mode [pid:%d console:%s]\n", getpid(),config->console);
472 // redirect default I/O on console
473 close (2); dup(consoleFD); // redirect stderr
474 close (1); dup(consoleFD); // redirect stdout
475 close (0); // no need for stdin
479 setsid(); // allow father process to fully exit
480 sleep (2); // allow main to leave and release port
483 fprintf (stderr, "----------------------------\n");
484 fprintf (stderr, "INF: main background pid=%d\n", getpid());
488 /*---------------------------------------------------------
490 | Handles the HTTP server
491 +--------------------------------------------------------- */
492 static int init_http_server(struct afb_hsrv *hsrv, struct afb_config * config)
496 if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_websocket_switch, NULL, 20))
499 if (!afb_hsrv_add_handler(hsrv, config->rootapi, afb_hswitch_apis, NULL, 10))
502 for (idx = 0; idx < config->aliascount; idx++)
503 if (!afb_hsrv_add_alias (hsrv, config->aliasdir[idx].url, config->aliasdir[idx].path, 0))
506 if (!afb_hsrv_add_alias(hsrv, "", config->rootdir, -10))
509 if (!afb_hsrv_add_handler(hsrv, config->rootbase, afb_hswitch_one_page_api_redirect, NULL, -20))
515 static struct afb_hsrv *start_http_server(struct afb_config * config)
518 struct afb_hsrv *hsrv;
520 if (afb_hreq_init_download_path("/tmp")) { /* TODO: sessiondir? */
521 fprintf(stderr, "unable to set the tmp directory\n");
525 hsrv = afb_hsrv_create();
527 fprintf(stderr, "memory allocation failure\n");
531 if (!afb_hsrv_set_cache_timeout(hsrv, config->cacheTimeout)
532 || !init_http_server(hsrv, config)) {
533 fprintf (stderr, "Error: initialisation of httpd failed");
539 fprintf (stderr, "AFB:notice Waiting port=%d rootdir=%s\n", config->httpdPort, config->rootdir);
540 fprintf (stderr, "AFB:notice Browser URL= http:/*localhost:%d\n", config->httpdPort);
543 rc = afb_hsrv_start(hsrv, (uint16_t) config->httpdPort, 15);
545 fprintf (stderr, "Error: starting of httpd failed");
554 /*---------------------------------------------------------
556 | Parse option and launch action
557 +--------------------------------------------------------- */
559 int main(int argc, char *argv[]) {
560 struct afb_hsrv *hsrv;
561 struct afb_config *config;
563 // open syslog if ever needed
564 openlog("afb-daemon", 0, LOG_DAEMON);
566 // ------------- Build session handler & init config -------
567 config = calloc (1, sizeof (struct afb_config));
569 on_exit(closeSession, config);
570 parse_arguments(argc, argv, config);
572 // ------------------ sanity check ----------------------------------------
573 if (config->httpdPort <= 0) {
574 fprintf (stderr, "ERR: no port is defined\n");
579 afb_api_so_add_pathset(config->ldpaths);
581 ctxStoreInit(CTX_NBCLIENTS, config->cntxTimeout, config->token, afb_apis_count());
582 if (!afb_hreq_init_cookie(config->httpdPort, config->rootapi, DEFLT_CNTX_TIMEOUT)) {
583 fprintf (stderr, "ERR: initialisation of cookies failed\n");
587 install_error_handlers();
589 // ------------------ clean exit on CTR-C signal ------------------------
590 if (signal (SIGINT, signalQuit) == SIG_ERR || signal (SIGABRT, signalQuit) == SIG_ERR) {
591 fprintf (stderr, "ERR: main fail to install Signal handler\n");
595 // let's run this program with a low priority
598 // ------------------ Finaly Process Commands -----------------------------
599 // let's not take the risk to run as ROOT
600 //if (getuid() == 0) goto errorNoRoot;
602 if (verbosity) fprintf (stderr, "AFB: notice Init config done\n");
604 // --------- run -----------
605 if (config->background) {
606 // --------- in background mode -----------
607 if (verbosity) fprintf (stderr, "AFB: Entering background mode\n");
610 // ---- in foreground mode --------------------
611 if (verbosity) fprintf (stderr,"AFB: notice Foreground mode\n");
615 hsrv = start_http_server(config);
619 if (config->readyfd != 0) {
620 static const char readystr[] = "READY=1";
621 write(config->readyfd, readystr, sizeof(readystr) - 1);
622 close(config->readyfd);
630 fprintf (stderr, "hoops returned from infinite loop [report bug]\n");