2 * Copyright (C) 2015 "IoT.bzh"
3 * Author "Fulup Ar Foll"
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.
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.
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/>.
21 * Author: "Fulup Ar Foll"
23 * Created on 05 December 2015, 15:38
26 #include "local-def.h"
34 static sigjmp_buf exitPoint; // context save for set/longjmp
36 /*----------------------------------------------------------
38 | print version and copyright
39 +--------------------------------------------------------- */
40 static void printVersion (void) {
42 fprintf (stderr,"\n----------------------------------------- \n");
43 fprintf (stderr,"| AFB [Application Framework Binder] version=%s |\n", AJQ_VERSION);
44 fprintf (stderr,"----------------------------------------- \n");
45 fprintf (stderr,"| Copyright(C) 2015 Fulup Ar Foll /IoT.bzh [fulup -at- iot.bzh]\n");
46 fprintf (stderr,"| AFB comes with ABSOLUTELY NO WARRANTY.\n");
47 fprintf (stderr,"| Licence [what ever makes you happy] until you fix bugs by yourself :)\n\n");
52 // Define command line option
53 #define SET_VERBOSE 101
54 #define SET_BACKGROUND 105
55 #define SET_FORGROUND 106
56 #define KILL_PREV_EXIT 107
57 #define KILL_PREV_REST 108
58 #define SET_FAKE_MOD 109
60 #define SET_TCP_PORT 120
61 #define SET_ROOT_DIR 121
62 #define SET_ROOT_BASE 122
63 #define SET_ROOT_API 123
64 #define SET_ROOT_ALIAS 124
66 #define SET_CACHE_TO 130
67 #define SET_USERID 131
68 #define SET_PID_FILE 132
69 #define SET_SESSION_DIR 133
70 #define SET_CONFIG_FILE 134
71 #define SET_CONFIG_SAVE 135
72 #define SET_CONFIG_EXIT 138
75 #define SET_AUTH_TOKEN 141
76 #define SET_PLUGINS 142
77 #define SET_APITIMEOUT 143
78 #define SET_CNTXTIMEOUT 144
80 #define DISPLAY_VERSION 150
81 #define DISPLAY_HELP 151
85 static AFB_options cliOptions [] = {
86 {SET_VERBOSE ,0,"verbose" , "Verbose Mode"},
88 {SET_FORGROUND ,0,"foreground" , "Get all in foreground mode"},
89 {SET_BACKGROUND ,0,"daemon" , "Get all in background mode"},
90 {KILL_PREV_EXIT ,0,"kill" , "Kill active process if any and exit"},
91 {KILL_PREV_REST ,0,"restart" , "Kill active process if any and restart"},
93 {SET_TCP_PORT ,1,"port" , "HTTP listening TCP port [default 1234]"},
94 {SET_ROOT_DIR ,1,"rootdir" , "HTTP Root Directory [default $HOME/.AFB]"},
95 {SET_ROOT_BASE ,1,"rootbase" , "Angular Base Root URL [default /opa]"},
96 {SET_ROOT_API ,1,"rootapi" , "HTML Root API URL [default /api]"},
97 {SET_ROOT_ALIAS ,1,"alias" , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"},
99 {SET_APITIMEOUT ,1,"apitimeout" , "Plugin API timeout in seconds [default 10]"},
100 {SET_CNTXTIMEOUT ,1,"cntxtimeout" , "Client Session Context Timeout [default 900]"},
101 {SET_CACHE_TO ,1,"cache-eol" , "Client cache end of live [default 3600s]"},
103 {SET_USERID ,1,"setuid" , "Change user id [default don't change]"},
104 {SET_PID_FILE ,1,"pidfile" , "PID file path [default none]"},
105 {SET_SESSION_DIR ,1,"sessiondir" , "Sessions file path [default rootdir/sessions]"},
106 {SET_CONFIG_FILE ,1,"config" , "Config Filename [default rootdir/sessions/configs/default.AFB]"},
107 {SET_CONFIG_SAVE ,0,"save" , "Save config on disk [default no]"},
108 {SET_CONFIG_EXIT ,0,"saveonly" , "Save config on disk and then exit"},
110 {SET_SMACK ,1,"smack" , "Set Smack Label [default demo]"},
111 {SET_PLUGINS ,1,"mods" , "Enable module [default all]"},
112 {SET_AUTH_TOKEN ,1,"token" , "Initial Secret [default=no-session, --token="" for session without authentication]"},
114 {DISPLAY_VERSION ,0,"version" , "Display version and copyright"},
115 {DISPLAY_HELP ,0,"help" , "Display this help"},
119 static AFB_aliasdir aliasdir[MAX_ALIAS];
120 static int aliascount=0;
122 /*----------------------------------------------------------
125 +--------------------------------------------------------- */
126 void signalQuit (int signum) {
130 // unlock timeout signal to allow a new signal to come
131 sigemptyset (&sigset);
132 sigaddset (&sigset, SIGABRT);
133 sigprocmask (SIG_UNBLOCK, &sigset, 0);
135 fprintf (stderr, "%s ERR:Received signal quit\n",configTime());
136 syslog (LOG_ERR, "Daemon got kill3 & quit [please report bug]");
137 longjmp (exitPoint, signum);
141 /*----------------------------------------------------------
143 | print information from long option array
144 +--------------------------------------------------------- */
146 static void printHelp(char *name) {
150 fprintf (stderr,"%s:\nallowed options\n", name);
151 for (ind=0; cliOptions [ind].name != NULL;ind++)
154 if (cliOptions [ind].has_arg == 0 )
156 fprintf (stderr," --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help);
158 sprintf(command,"%s=xxxx", cliOptions [ind].name);
159 fprintf (stderr," --%-15s %s\n", command, cliOptions[ind].help);
162 fprintf (stderr,"Example:\n %s\\\n --verbose --port=1234 --smack=xxxx --token='azerty' --mods=alsa:dbus\n", name);
165 /*----------------------------------------------------------
167 | write a file in /var/run/AFB with pid
168 +--------------------------------------------------------- */
169 static int writePidFile (AFB_config *config, int pid) {
172 // if no pid file configure just return
173 if (config->pidfile == NULL) return 0;
175 // open pid file in write mode
176 file = fopen(config->pidfile,"w");
178 fprintf (stderr,"%s ERR:writePidFile fail to open [%s]\n",configTime(), config->pidfile);
182 // write pid in file and close
183 fprintf (file, "%d\n", pid);
188 /*----------------------------------------------------------
190 | read file in /var/run/AFB with pid
191 +--------------------------------------------------------- */
192 static int readPidFile (AFB_config *config) {
197 if (config->pidfile == NULL) return -1;
199 // open pid file in write mode
200 file = fopen(config->pidfile,"r");
202 fprintf (stderr,"%s ERR:readPidFile fail to open [%s]\n",configTime(), config->pidfile);
206 // write pid in file and close
207 status = fscanf (file, "%d\n", &pid);
211 if (status != 1) return -1;
216 /*----------------------------------------------------------
218 | try to close everything before leaving
219 +--------------------------------------------------------- */
220 static void closeSession (AFB_session *session) {
225 /*----------------------------------------------------------
227 | Main listening HTTP loop
228 +--------------------------------------------------------- */
229 static void listenLoop (AFB_session *session) {
232 if (signal (SIGABRT, signalQuit) == SIG_ERR) {
233 fprintf (stderr, "%s ERR: main fail to install Signal handler\n", configTime());
237 // ------ Start httpd server
238 if (session->config->httpdPort > 0) {
240 err = httpdStart (session);
241 if (err != AFB_SUCCESS) return;
246 fprintf (stderr, "hoops returned from infinite loop [report bug]\n");
250 /*---------------------------------------------------------
252 | Parse option and launch action
253 +--------------------------------------------------------- */
255 int main(int argc, char *argv[]) {
256 AFB_session *session;
257 char* programName = argv [0];
259 int optc, ind, consoleFD;
260 int pid, nbcmd, status;
261 AFB_config cliconfig; // temp structure to store CLI option before file config upload
263 // ------------- Build session handler & init config -------
264 session = configInit ();
265 memset(&cliconfig,0,sizeof(cliconfig));
266 memset(&aliasdir ,0,sizeof(aliasdir));
267 cliconfig.aliasdir = aliasdir;
269 // GNU CLI getopts nterface.
270 struct option ggcOption;
271 struct option *gnuOptions;
273 // ------------------ Process Command Line -----------------------
275 // if no argument print help and return
277 printHelp(programName);
281 // build GNU getopt info from cliOptions
282 nbcmd = sizeof (cliOptions) / sizeof (AFB_options);
283 gnuOptions = malloc (sizeof (ggcOption) * nbcmd);
284 for (ind=0; ind < nbcmd;ind++) {
285 gnuOptions [ind].name = cliOptions[ind].name;
286 gnuOptions [ind].has_arg = cliOptions[ind].has_arg;
287 gnuOptions [ind].flag = 0;
288 gnuOptions [ind].val = cliOptions[ind].val;
291 // get all options from command line
292 while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex))
302 if (optarg == 0) goto needValueForOption;
303 if (!sscanf (optarg, "%d", &cliconfig.httpdPort)) goto notAnInteger;
307 if (optarg == 0) goto needValueForOption;
308 if (!sscanf (optarg, "%d", &cliconfig.apiTimeout)) goto notAnInteger;
311 case SET_CNTXTIMEOUT:
312 if (optarg == 0) goto needValueForOption;
313 if (!sscanf (optarg, "%d", &cliconfig.cntxTimeout)) goto notAnInteger;
317 if (optarg == 0) goto needValueForOption;
318 cliconfig.rootdir = optarg;
319 if (verbose) fprintf(stderr, "Forcing Rootdir=%s\n",cliconfig.rootdir);
323 if (optarg == 0) goto needValueForOption;
324 cliconfig.rootbase = optarg;
325 if (verbose) fprintf(stderr, "Forcing Rootbase=%s\n",cliconfig.rootbase);
329 if (optarg == 0) goto needValueForOption;
330 cliconfig.rootapi = optarg;
331 if (verbose) fprintf(stderr, "Forcing Rootapi=%s\n",cliconfig.rootapi);
335 if (optarg == 0) goto needValueForOption;
336 if (aliascount < MAX_ALIAS) {
337 aliasdir[aliascount].url = strsep(&optarg,":");
338 aliasdir[aliascount].path = strsep(&optarg,":");
339 aliasdir[aliascount].len = strlen(aliasdir[aliascount].url);
340 if (verbose) fprintf(stderr, "Alias url=%s path=%s\n", aliasdir[aliascount].url, aliasdir[aliascount].path);
343 fprintf(stderr, "Too many aliases [max:%s] %s ignored\n", optarg, MAX_ALIAS-1);
348 if (optarg == 0) goto needValueForOption;
349 fprintf (stderr, "Not Implemented yet\n");
350 cliconfig.smack = optarg;
354 if (optarg == 0) goto needValueForOption;
355 cliconfig.token = optarg;
359 if (optarg == 0) goto needValueForOption;
360 fprintf (stderr, "Not Implemented yet\n");
361 cliconfig.plugins = optarg;
365 if (optarg == 0) goto needValueForOption;
366 cliconfig.pidfile = optarg;
369 case SET_SESSION_DIR:
370 if (optarg == 0) goto needValueForOption;
371 cliconfig.sessiondir = optarg;
374 case SET_CONFIG_FILE:
375 if (optarg == 0) goto needValueForOption;
376 cliconfig.configfile = optarg;
380 if (optarg == 0) goto needValueForOption;
381 if (!sscanf (optarg, "%d", &cliconfig.cacheTimeout)) goto notAnInteger;
384 case SET_CONFIG_EXIT:
385 if (optarg != 0) goto noValueForOption;
386 session->configsave = 1;
387 session->forceexit = 1;
390 case SET_CONFIG_SAVE:
391 if (optarg != 0) goto noValueForOption;
392 session->configsave = 1;
396 if (optarg == 0) goto needValueForOption;
397 if (!sscanf (optarg, "%s", &cliconfig.setuid)) goto notAnInteger;
401 if (optarg != 0) goto noValueForOption;
402 session->fakemod = 1;
406 if (optarg != 0) goto noValueForOption;
407 session->foreground = 1;
411 if (optarg != 0) goto noValueForOption;
412 session->background = 1;
416 if (optarg != 0) goto noValueForOption;
417 session->killPrevious = 1;
421 if (optarg != 0) goto noValueForOption;
422 session->killPrevious = 2;
425 case DISPLAY_VERSION:
426 if (optarg != 0) goto noValueForOption;
432 printHelp(programName);
438 // if exist merge config file with CLI arguments
439 configLoadFile (session, &cliconfig);
440 initPlugins(session);
442 // ------------------ sanity check ----------------------------------------
443 if ((session->background) && (session->foreground)) {
444 fprintf (stderr, "%s ERR: cannot select foreground & background at the same time\n",configTime());
448 // ------------------ Some useful default values -------------------------
449 if ((session->background == 0) && (session->foreground == 0)) session->foreground=1;
451 // open syslog if ever needed
452 openlog("AGB-log", 0, LOG_DAEMON);
454 // -------------- Try to kill any previsou process if asked ---------------------
455 if (session->killPrevious) {
456 pid = readPidFile (session->config); // enforce commandline option
459 fprintf (stderr, "%s ERR:main --kill ignored no PID file [%s]\n",configTime(), session->config->pidfile);
462 fprintf (stderr, "%s ERR:main --kill ignored no active AFB process\n",configTime());
465 status = kill (pid,SIGINT );
467 if (verbose) printf ("%s INF:main signal INTR sent to pid:%d \n", configTime(), pid);
470 status = kill (pid,9);
471 if (status != 0) fprintf (stderr, "%s ERR:main failled to killed pid=%d \n",configTime(), pid);
475 if (session->killPrevious >= 2) goto normalExit;
476 } // end killPrevious
479 // ------------------ clean exit on CTR-C signal ------------------------
480 if (signal (SIGINT, signalQuit) == SIG_ERR) {
481 fprintf (stderr, "%s Quit Signal received.",configTime());
485 // save exitPoint context when returning from longjmp closeSession and exit
486 status = setjmp (exitPoint); // return !+ when coming from longjmp
488 if (verbose) printf ("INF:main returning from longjump after signal [%d]\n", status);
489 closeSession (session);
493 // let's run this program with a low priority
496 // ------------------ Finaly Process Commands -----------------------------
497 // if --save then store config on disk upfront
498 if (session->configsave) configStoreFile (session);
499 if (session->forceexit) exit (0);
501 if (session->config->setuid) {
503 struct passwd *passwd;
504 passwd=getpwnam(session->config->setuid);
506 if (passwd == NULL) goto errorSetuid;
508 err = setuid(passwd->pw_uid);
509 if (err) goto errorSetuid;
512 // let's not take the risk to run as ROOT
513 //if (getuid() == 0) goto errorNoRoot;
515 // check session dir and create if it does not exist
516 if (sessionCheckdir (session) != AFB_SUCCESS) goto errSessiondir;
517 if (verbose) fprintf (stderr, "AFB:notice Init config done\n");
521 // ---- run in foreground mode --------------------
522 if (session->foreground) {
524 if (verbose) fprintf (stderr,"AFB:notice Foreground mode\n");
526 // write a pid file for --kill-previous and --raise-debug option
527 status = writePidFile (session->config, getpid());
528 if (status == -1) goto errorPidFile;
530 // enter listening loop in foreground
536 // --------- run in background mode -----------
537 if (session->background) {
539 // if (status != 0) goto errorCommand;
540 if (verbose) printf ("AFB: Entering background mode\n");
542 // open /dev/console to redirect output messAFBes
543 consoleFD = open(session->config->console, O_WRONLY | O_APPEND | O_CREAT , 0640);
544 if (consoleFD < 0) goto errConsole;
546 // fork process when running background mode
549 // son process get all data in standalone mode
552 printf ("\nAFB: background mode [pid:%d console:%s]\n", getpid(),session->config->console);
553 if (verbose) printf ("AFB:info use '%s --restart --rootdir=%s # [--pidfile=%s] to restart daemon\n", programName,session->config->rootdir, session->config->pidfile);
555 // redirect default I/O on console
556 close (2); status=dup(consoleFD); // redirect stderr
557 close (1); status=dup(consoleFD); // redirect stdout
558 close (0); // no need for stdin
561 setsid(); // allow father process to fully exit
562 sleep (2); // allow main to leave and release port
564 fprintf (stderr, "----------------------------\n");
565 fprintf (stderr, "%s INF:main background pid=%d\n", configTime(), getpid());
568 // if everything look OK then look forever
569 syslog (LOG_ERR, "AFB: Entering infinite loop in background mode");
571 // should normally never return from this loop
573 syslog (LOG_ERR, "AFB:FAIL background infinite loop exited check [%s]\n", session->config->console);
578 // if fail nothing much to do
579 if (pid == -1) goto errorFork;
581 // fork worked and we are in father process
582 status = writePidFile (session->config, pid);
583 if (status == -1) goto errorPidFile;
585 // we are in father process, we don't need this one
588 } // end background-foreground
591 closeSession (session); // try to close everything before leaving
592 if (verbose) printf ("\n---- Application Framework Binder Normal End ------\n");
595 // ------------- Fatal ERROR display error and quit -------------
597 fprintf (stderr,"\nERR:AFB-daemon Failed to change UID to username=[%s]\n\n", session->config->setuid);
601 // fprintf (stderr,"\nERR:AFB-daemon Not allow to run as root [use --seteuid=username option]\n\n");
605 fprintf (stderr,"\nERR:AFB-daemon Failed to write pid file [%s]\n\n", session->config->pidfile);
609 fprintf (stderr,"\nERR:AFB-daemon Failed to fork son process\n\n");
613 fprintf (stderr,"\nERR:AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n"
614 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
618 fprintf (stderr,"\nERR:AFB-daemon option [--%s] don't take value\n\n"
619 ,gnuOptions[optionIndex].name);
623 fprintf (stderr,"\nERR:AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n"
624 ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
628 fprintf (stderr,"\n%s INF:AFB-daemon pid=%d received exit signal (Hopefully crtl-C or --kill-previous !!!)\n\n"
629 ,configTime(), getpid());
633 fprintf (stderr,"\nERR:AFB-daemon cannot open /dev/console (use --foreground)\n\n");
637 fprintf (stderr,"\nERR:AFB-daemon cannot read/write session dir\n\n");
641 fprintf (stderr,"\nERR:AFB-daemon fail to probe sound cards\n\n");
645 // try to unlink pid file if any
646 if (session->background && session->config->pidfile != NULL) unlink (session->config->pidfile);
649 }; /* END AFB-daemon() */