Hack --plugins=path
[src/app-framework-binder.git] / src / main.c
1 /* 
2  * Copyright (C) 2015 "IoT.bzh"
3  * Author "Fulup Ar Foll"
4  *
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.
9  *
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.
14  *
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/>.
17  */
18
19 /* 
20  * File:   main.c
21  * Author: "Fulup Ar Foll"
22  *
23  * Created on 05 December 2015, 15:38
24  */
25
26 #include "local-def.h"
27
28 #include <syslog.h>
29 #include <setjmp.h>
30 #include <signal.h>
31 #include <getopt.h>
32 #include <pwd.h>
33
34 static sigjmp_buf exitPoint; // context save for set/longjmp
35
36 /*----------------------------------------------------------
37  | printversion
38  |   print version and copyright
39  +--------------------------------------------------------- */
40  static void printVersion (void) {
41
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");
48    exit (0);
49  } // end printVersion
50
51
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
59
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
65
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
73
74  #define SET_SMACK          140
75  #define SET_AUTH_TOKEN     141
76  #define SET_PLUGINS        142
77  #define SET_APITIMEOUT     143
78  #define SET_CNTXTIMEOUT    144
79
80  #define DISPLAY_VERSION    150
81  #define DISPLAY_HELP       151
82
83
84 // Supported option
85 static  AFB_options cliOptions [] = {
86   {SET_VERBOSE      ,0,"verbose"         , "Verbose Mode"},
87
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"},
92
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]"},
98   
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]"},
102   
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"},
109
110   {SET_SMACK        ,1,"smack"           , "Set Smack Label [default demo]"},
111   {SET_PLUGINS      ,1,"plugins"         , "Load Plugins from dir [default = PLUGIN_INSTALL_DIR"},
112   {SET_AUTH_TOKEN   ,1,"token"           , "Initial Secret [default=no-session, --token="" for session without authentication]"},
113   
114   {DISPLAY_VERSION  ,0,"version"         , "Display version and copyright"},
115   {DISPLAY_HELP     ,0,"help"            , "Display this help"},
116   {0, 0, 0}
117  };
118
119 static AFB_aliasdir aliasdir[MAX_ALIAS];
120 static int aliascount=0;
121
122 /*----------------------------------------------------------
123  | timeout signalQuit
124  |
125  +--------------------------------------------------------- */
126 void signalQuit (int signum) {
127
128   sigset_t sigset;
129
130   // unlock timeout signal to allow a new signal to come
131   sigemptyset (&sigset);
132   sigaddset   (&sigset, SIGABRT);
133   sigprocmask (SIG_UNBLOCK, &sigset, 0);
134
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);
138 }
139
140
141 /*----------------------------------------------------------
142  | printHelp
143  |   print information from long option array
144  +--------------------------------------------------------- */
145
146  static void printHelp(char *name) {
147     int ind;
148     char command[20];
149
150     fprintf (stderr,"%s:\nallowed options\n", name);
151     for (ind=0; cliOptions [ind].name != NULL;ind++)
152     {
153       // display options
154       if (cliOptions [ind].has_arg == 0 )
155       {
156              fprintf (stderr,"  --%-15s %s\n", cliOptions [ind].name, cliOptions[ind].help);
157       } else {
158          sprintf(command,"%s=xxxx", cliOptions [ind].name);
159          fprintf (stderr,"  --%-15s %s\n", command, cliOptions[ind].help);
160       }
161     }
162     fprintf (stderr,"Example:\n  %s\\\n  --verbose --port=1234 --smack=xxxx --token='azerty' --plugins=build/plugins\n", name);
163 } // end printHelp
164
165 /*----------------------------------------------------------
166  | writePidFile
167  |   write a file in /var/run/AFB with pid
168  +--------------------------------------------------------- */
169 static int writePidFile (AFB_config *config, int pid) {
170   FILE *file;
171
172   // if no pid file configure just return
173   if (config->pidfile == NULL) return 0;
174
175   // open pid file in write mode
176   file = fopen(config->pidfile,"w");
177   if (file == NULL) {
178     fprintf (stderr,"%s ERR:writePidFile fail to open [%s]\n",configTime(), config->pidfile);
179     return -1;
180   }
181
182   // write pid in file and close
183   fprintf (file, "%d\n", pid);
184   fclose  (file);
185   return 0;
186 }
187
188 /*----------------------------------------------------------
189  | readPidFile
190  |   read file in /var/run/AFB with pid
191  +--------------------------------------------------------- */
192 static int readPidFile (AFB_config *config) {
193   int  pid;
194   FILE *file;
195   int  status;
196
197   if (config->pidfile == NULL) return -1;
198
199   // open pid file in write mode
200   file = fopen(config->pidfile,"r");
201   if (file == NULL) {
202     fprintf (stderr,"%s ERR:readPidFile fail to open [%s]\n",configTime(), config->pidfile);
203     return -1;
204   }
205
206   // write pid in file and close
207   status = fscanf  (file, "%d\n", &pid);
208   fclose  (file);
209
210   // never kill pid 0
211   if (status != 1) return -1;
212
213   return (pid);
214 }
215
216 /*----------------------------------------------------------
217  | closeSession
218  |   try to close everything before leaving
219  +--------------------------------------------------------- */
220 static void closeSession (AFB_session *session) {
221
222
223 }
224
225 /*----------------------------------------------------------
226  | listenLoop
227  |   Main listening HTTP loop
228  +--------------------------------------------------------- */
229 static void listenLoop (AFB_session *session) {
230   AFB_error  err;
231
232   if (signal (SIGABRT, signalQuit) == SIG_ERR) {
233         fprintf (stderr, "%s ERR: main fail to install Signal handler\n", configTime());
234         return;
235   }
236
237   // ------ Start httpd server
238   if (session->config->httpdPort > 0) {
239
240         err = httpdStart (session);
241         if (err != AFB_SUCCESS) return;
242
243         // infinite loop
244         httpdLoop(session);
245
246         fprintf (stderr, "hoops returned from infinite loop [report bug]\n");
247   }
248 }
249   
250 /*---------------------------------------------------------
251  | main
252  |   Parse option and launch action
253  +--------------------------------------------------------- */
254
255 int main(int argc, char *argv[])  {
256   AFB_session    *session;
257   char*          programName = argv [0];
258   int            optionIndex = 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
262
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;
268
269   // GNU CLI getopts nterface.
270   struct option ggcOption;
271   struct option *gnuOptions;
272
273   // ------------------ Process Command Line -----------------------
274
275   // if no argument print help and return
276   if (argc < 2) {
277        printHelp(programName);
278        return (-1);
279   }
280
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;
289   }
290
291   // get all options from command line
292   while ((optc = getopt_long (argc, argv, "vsp?", gnuOptions, &optionIndex))
293         != EOF)
294   {
295     switch (optc)
296     {
297      case SET_VERBOSE:
298        verbose = 1;
299        break;
300
301     case SET_TCP_PORT:
302        if (optarg == 0) goto needValueForOption;
303        if (!sscanf (optarg, "%d", &cliconfig.httpdPort)) goto notAnInteger;
304        break;
305        
306     case SET_APITIMEOUT:
307        if (optarg == 0) goto needValueForOption;
308        if (!sscanf (optarg, "%d", &cliconfig.apiTimeout)) goto notAnInteger;
309        break;
310
311     case SET_CNTXTIMEOUT:
312        if (optarg == 0) goto needValueForOption;
313        if (!sscanf (optarg, "%d", &cliconfig.cntxTimeout)) goto notAnInteger;
314        break;
315
316     case SET_ROOT_DIR:
317        if (optarg == 0) goto needValueForOption;
318        cliconfig.rootdir   = optarg;
319        if (verbose) fprintf(stderr, "Forcing Rootdir=%s\n",cliconfig.rootdir);
320        break;       
321        
322     case SET_ROOT_BASE:
323        if (optarg == 0) goto needValueForOption;
324        cliconfig.rootbase   = optarg;
325        if (verbose) fprintf(stderr, "Forcing Rootbase=%s\n",cliconfig.rootbase);
326        break;
327
328     case SET_ROOT_API:
329        if (optarg == 0) goto needValueForOption;
330        cliconfig.rootapi   = optarg;
331        if (verbose) fprintf(stderr, "Forcing Rootapi=%s\n",cliconfig.rootapi);
332        break;
333        
334     case SET_ROOT_ALIAS:
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);
341             aliascount++;
342        } else {
343            fprintf(stderr, "Too many aliases [max:%s] %s ignored\n", optarg, MAX_ALIAS-1);
344        }     
345        break;
346        
347     case SET_SMACK:
348        if (optarg == 0) goto needValueForOption;
349        fprintf (stderr, "Not Implemented yet\n");
350        cliconfig.smack   = optarg;
351        break;
352
353     case SET_AUTH_TOKEN:
354        if (optarg == 0) goto needValueForOption;
355        cliconfig.token   = optarg;
356        break;
357
358     case SET_PLUGINS:
359        if (optarg == 0) goto needValueForOption;
360        cliconfig.plugins = optarg;
361        break;
362
363     case SET_PID_FILE:
364        if (optarg == 0) goto needValueForOption;
365        cliconfig.pidfile   = optarg;
366        break;
367
368     case SET_SESSION_DIR:
369        if (optarg == 0) goto needValueForOption;
370        cliconfig.sessiondir   = optarg;
371        break;
372
373     case  SET_CONFIG_FILE:
374        if (optarg == 0) goto needValueForOption;
375        cliconfig.configfile   = optarg;
376        break;
377
378     case  SET_CACHE_TO:
379        if (optarg == 0) goto needValueForOption;
380        if (!sscanf (optarg, "%d", &cliconfig.cacheTimeout)) goto notAnInteger;
381        break;
382
383     case SET_CONFIG_EXIT:
384        if (optarg != 0) goto noValueForOption;
385        session->configsave  = 1;
386        session->forceexit   = 1;
387        break;
388
389     case SET_CONFIG_SAVE:
390        if (optarg != 0) goto noValueForOption;
391        session->configsave  = 1;
392        break;
393
394     case SET_USERID:
395        if (optarg == 0) goto needValueForOption;
396        if (!sscanf (optarg, "%s", &cliconfig.setuid)) goto notAnInteger;
397        break;
398
399     case SET_FAKE_MOD:
400        if (optarg != 0) goto noValueForOption;
401        session->fakemod  = 1;
402        break;
403
404     case SET_FORGROUND:
405        if (optarg != 0) goto noValueForOption;
406        session->foreground  = 1;
407        break;
408
409     case SET_BACKGROUND:
410        if (optarg != 0) goto noValueForOption;
411        session->background  = 1;
412        break;
413
414      case KILL_PREV_REST:
415        if (optarg != 0) goto noValueForOption;
416        session->killPrevious  = 1;
417        break;
418
419      case KILL_PREV_EXIT:
420        if (optarg != 0) goto noValueForOption;
421        session->killPrevious  = 2;
422        break;
423
424     case DISPLAY_VERSION:
425        if (optarg != 0) goto noValueForOption;
426        printVersion();
427        goto normalExit;
428
429     case DISPLAY_HELP:
430      default:
431        printHelp(programName);
432        goto normalExit;
433
434   }
435   }
436  
437   // if exist merge config file with CLI arguments
438   configLoadFile  (session, &cliconfig);
439   initPlugins(session);
440
441   // ------------------ sanity check ----------------------------------------
442   if  ((session->background) && (session->foreground)) {
443     fprintf (stderr, "%s ERR: cannot select foreground & background at the same time\n",configTime());
444      exit (-1);
445   }
446
447   // ------------------ Some useful default values -------------------------
448   if  ((session->background == 0) && (session->foreground == 0)) session->foreground=1;
449
450   // open syslog if ever needed
451   openlog("AGB-log", 0, LOG_DAEMON);
452
453   // -------------- Try to kill any previsou process if asked ---------------------
454   if (session->killPrevious) {
455     pid = readPidFile (session->config);  // enforce commandline option
456     switch (pid) {
457     case -1:
458       fprintf (stderr, "%s ERR:main --kill ignored no PID file [%s]\n",configTime(), session->config->pidfile);
459       break;
460     case 0:
461       fprintf (stderr, "%s ERR:main --kill ignored no active AFB process\n",configTime());
462       break;
463     default:
464       status = kill (pid,SIGINT );
465       if (status == 0) {
466              if (verbose) printf ("%s INF:main signal INTR sent to pid:%d \n", configTime(), pid);
467       } else {
468          // try kill -9
469          status = kill (pid,9);
470          if (status != 0)  fprintf (stderr, "%s ERR:main failled to killed pid=%d \n",configTime(), pid);
471       }
472     } // end switch pid
473
474     if (session->killPrevious >= 2) goto normalExit;
475   } // end killPrevious
476
477
478   // ------------------ clean exit on CTR-C signal ------------------------
479   if (signal (SIGINT, signalQuit) == SIG_ERR) {
480     fprintf (stderr, "%s Quit Signal received.",configTime());
481     return (-1);
482   }
483
484   // save exitPoint context when returning from longjmp closeSession and exit
485   status = setjmp (exitPoint); // return !+ when coming from longjmp
486   if (status != 0) {
487     if (verbose) printf ("INF:main returning from longjump after signal [%d]\n", status);
488     closeSession (session);
489     goto exitOnSignal;
490   }
491
492   // let's run this program with a low priority
493   status=nice (20);
494
495   // ------------------ Finaly Process Commands -----------------------------
496    // if --save then store config on disk upfront
497    if (session->configsave) configStoreFile (session);
498    if (session->forceexit)  exit (0);
499
500     if (session->config->setuid) {
501         int err;
502         struct passwd *passwd;
503         passwd=getpwnam(session->config->setuid);
504         
505         if (passwd == NULL) goto errorSetuid;
506         
507         err = setuid(passwd->pw_uid);
508         if (err) goto errorSetuid;
509     }
510
511     // let's not take the risk to run as ROOT
512     //if (getuid() == 0)  goto errorNoRoot;
513
514     // check session dir and create if it does not exist
515     if (sessionCheckdir (session) != AFB_SUCCESS) goto errSessiondir;
516     if (verbose) fprintf (stderr, "AFB:notice Init config done\n");
517
518
519
520     // ---- run in foreground mode --------------------
521     if (session->foreground) {
522
523         if (verbose) fprintf (stderr,"AFB:notice Foreground mode\n");
524
525         // write a pid file for --kill-previous and --raise-debug option
526         status = writePidFile (session->config, getpid());
527         if (status == -1) goto errorPidFile;
528
529         // enter listening loop in foreground
530         listenLoop(session);
531         goto exitInitLoop;
532   } // end foreground
533
534
535   // --------- run in background mode -----------
536   if (session->background) {
537
538        // if (status != 0) goto errorCommand;
539       if (verbose) printf ("AFB: Entering background mode\n");
540
541       // open /dev/console to redirect output messAFBes
542       consoleFD = open(session->config->console, O_WRONLY | O_APPEND | O_CREAT , 0640);
543       if (consoleFD < 0) goto errConsole;
544
545       // fork process when running background mode
546       pid = fork ();
547
548       // son process get all data in standalone mode
549       if (pid == 0) {
550
551              printf ("\nAFB: background mode [pid:%d console:%s]\n", getpid(),session->config->console);
552              if (verbose) printf ("AFB:info use '%s --restart --rootdir=%s # [--pidfile=%s] to restart daemon\n", programName,session->config->rootdir, session->config->pidfile);
553
554          // redirect default I/O on console
555          close (2); status=dup(consoleFD);  // redirect stderr
556          close (1); status=dup(consoleFD);  // redirect stdout
557          close (0);           // no need for stdin
558          close (consoleFD);
559
560          setsid();   // allow father process to fully exit
561              sleep (2);  // allow main to leave and release port
562
563          fprintf (stderr, "----------------------------\n");
564          fprintf (stderr, "%s INF:main background pid=%d\n", configTime(), getpid());
565          fflush  (stderr);
566
567          // if everything look OK then look forever
568          syslog (LOG_ERR, "AFB: Entering infinite loop in background mode");
569
570          // should normally never return from this loop
571          listenLoop(session);
572          syslog (LOG_ERR, "AFB:FAIL background infinite loop exited check [%s]\n", session->config->console);
573
574          goto exitInitLoop;
575       }
576
577       // if fail nothing much to do
578       if (pid == -1) goto errorFork;
579
580       // fork worked and we are in father process
581       status = writePidFile (session->config, pid);
582       if (status == -1) goto errorPidFile;
583
584       // we are in father process, we don't need this one
585       exit (0);
586
587   } // end background-foreground
588
589 normalExit:
590   closeSession (session);   // try to close everything before leaving
591   if (verbose) printf ("\n---- Application Framework Binder Normal End ------\n");
592   exit (0);
593
594 // ------------- Fatal ERROR display error and quit  -------------
595 errorSetuid:
596   fprintf (stderr,"\nERR:AFB-daemon Failed to change UID to username=[%s]\n\n", session->config->setuid);
597   exit (-1);
598   
599 //errorNoRoot:
600 //  fprintf (stderr,"\nERR:AFB-daemon Not allow to run as root [use --seteuid=username option]\n\n");
601 //  exit (-1);
602
603 errorPidFile:
604   fprintf (stderr,"\nERR:AFB-daemon Failed to write pid file [%s]\n\n", session->config->pidfile);
605   exit (-1);
606
607 errorFork:
608   fprintf (stderr,"\nERR:AFB-daemon Failed to fork son process\n\n");
609   exit (-1);
610
611 needValueForOption:
612   fprintf (stderr,"\nERR:AFB-daemon option [--%s] need a value i.e. --%s=xxx\n\n"
613           ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
614   exit (-1);
615
616 noValueForOption:
617   fprintf (stderr,"\nERR:AFB-daemon option [--%s] don't take value\n\n"
618           ,gnuOptions[optionIndex].name);
619   exit (-1);
620
621 notAnInteger:
622   fprintf (stderr,"\nERR:AFB-daemon option [--%s] requirer an interger i.e. --%s=9\n\n"
623           ,gnuOptions[optionIndex].name, gnuOptions[optionIndex].name);
624   exit (-1);
625
626 exitOnSignal:
627   fprintf (stderr,"\n%s INF:AFB-daemon pid=%d received exit signal (Hopefully crtl-C or --kill-previous !!!)\n\n"
628                  ,configTime(), getpid());
629   exit (-1);
630
631 errConsole:
632   fprintf (stderr,"\nERR:AFB-daemon cannot open /dev/console (use --foreground)\n\n");
633   exit (-1);
634
635 errSessiondir:
636   fprintf (stderr,"\nERR:AFB-daemon cannot read/write session dir\n\n");
637   exit (-1);
638
639 errSoundCard:
640   fprintf (stderr,"\nERR:AFB-daemon fail to probe sound cards\n\n");
641   exit (-1);
642
643 exitInitLoop:
644   // try to unlink pid file if any
645   if (session->background && session->config->pidfile != NULL)  unlink (session->config->pidfile);
646   exit (-1);
647
648 }; /* END AFB-daemon() */
649