Add backtrace to the appimage
[citadel.git] / appimage / ctdlvisor.c
index 7bcf5efbd29d50bf5206237496d0d7677d851cfd..c7a073a708d0f5e80f2d89aa5240c778784eb3e2 100644 (file)
@@ -1,4 +1,3 @@
-//
 // This is a supervisor program that handles start/stop/restart of
 // the various Citadel System components, when we are running on
 // an AppImage instance.
@@ -8,7 +7,7 @@
 // This program is open source software.  It runs great on the
 // Linux operating system (and probably elsewhere).  You can use,
 // copy, and run it under the terms of the GNU General Public
-// License version 3.  Richard Stallman is an asshole communist.
+// License version 3.
 //
 // This program is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 #include <sys/types.h>
 #include <sys/stat.h>
 
-void main_loop(void);
-void run_in_foreground(void);
-
-char *data_directory = "/usr/local/citadel";
-char *http_port = "80";
-char *https_port = "443";
 pid_t citserver_pid;
 pid_t webcit_pid;
 pid_t webcits_pid;
 int shutting_down = 0;
 
-
+// Call this instead of exit() just for common diagnostics etc.
 void ctdlvisor_exit(int code) {
        printf("ctdlvisor: exit code %d\n", code);
        exit(code);
 }
 
 
+// Interrupting this program with a signal will begin an orderly shutdown.
 void signal_handler(int signal) {
        fprintf(stderr, "ctdlvisor: caught signal %d\n", signal);
 
@@ -76,20 +70,20 @@ void signal_handler(int signal) {
                else {
                        what_exited = "unknown";
                }
-               fprintf(stderr, "ctdlvisor: pid=%d (%s) exited, status=%d, exitcode=%d\n", who_exited, what_exited, status, WEXITSTATUS(status));
+               if (who_exited >= 0) {
+                       fprintf(stderr, "ctdlvisor: %d (%s) ended, status=%d\n", who_exited, what_exited, status);
+               }
        } while (who_exited >= 0);
-
        ctdlvisor_exit(0);
 }
 
 
-
 void detach_from_tty(void) {
        signal(SIGHUP, SIG_IGN);
        signal(SIGINT, SIG_IGN);
        signal(SIGQUIT, SIG_IGN);
 
-       setsid();
+       setsid();       // become our own process group leader
        umask(0);
        if (    (freopen("/dev/null", "r", stdin) != stdin) ||
                (freopen("/dev/null", "w", stdout) != stdout) ||
@@ -102,15 +96,18 @@ void detach_from_tty(void) {
 
 pid_t start_citadel() {
        char bin[1024];
+       char backtrace_filename[PATH_MAX];
        sprintf(bin, "%s/usr/local/citadel/citserver", getenv("APPDIR"));
        pid_t pid = fork();
        if (pid == 0) {
-               fprintf(stderr, "ctdlvisor: executing %s\n", bin);
+               fprintf(stderr, "ctdlvisor: executing %s with data directory %s\n", bin, getenv("CTDL_DIR"));
                detach_from_tty();
-               execlp(bin, "citserver", "-x9", "-h", data_directory, NULL);
+               sprintf(backtrace_filename, "/tmp/citserver-backtrace.%d", getpid());
+               execlp(bin, "citserver", "-x9", "-h", getenv("CTDL_DIR"), "-b", backtrace_filename, NULL);
                exit(errno);
        }
        else {
+               fprintf(stderr, "ctdlvisor: citserver running on pid=%d\n", pid);
                return(pid);
        }
 }
@@ -125,10 +122,11 @@ pid_t start_webcit() {
        if (pid == 0) {
                fprintf(stderr, "ctdlvisor: executing %s\n", bin);
                detach_from_tty();
-               execlp(bin, "webcit", "-x9", wchome, "-p", http_port, "uds", data_directory, NULL);
+               execlp(bin, "webcit", "-x9", wchome, "-p", getenv("HTTP_PORT"), "uds", getenv("CTDL_DIR"), NULL);
                exit(errno);
        }
        else {
+               fprintf(stderr, "ctdlvisor: webcit (HTTP) running on pid=%d\n", pid);
                return(pid);
        }
 }
@@ -143,104 +141,22 @@ pid_t start_webcits() {
        if (pid == 0) {
                fprintf(stderr, "ctdlvisor: executing %s\n", bin);
                detach_from_tty();
-               execlp(bin, "webcit", "-x9", wchome, "-s", "-p", https_port, "uds", data_directory, NULL);
+               execlp(bin, "webcit", "-x9", wchome, "-s", "-p", getenv("HTTPS_PORT"), "uds", getenv("CTDL_DIR"), NULL);
                exit(errno);
        }
        else {
+               fprintf(stderr, "ctdlvisor: webcit (HTTPS) running on pid=%d\n", pid);
                return(pid);
        }
 }
 
 
-static char *usage =
-       "ctdlvisor: usage: ctdlvisor [-h data_directory] [-p http_port] [-s https_port] command\n"
-       "           'command' must be one of:\n"
-       "           run     - start Citadel services in the foreground without detaching\n"
-       "           install - deploy systemd unit files for automatic startup at boot\n"
-       "           upgrade - check for new version of the software\n"
-       "           test    - check this appimage for compatibility with your system\n"
-;
-
-int main(int argc, char **argv) {
-       int c;
-
-       while ((c = getopt (argc, argv, "h:p:s:")) != -1)  switch(c) {
-               case 'h':
-                       data_directory = optarg;
-                       break;
-               case 'p':
-                       http_port = optarg;
-                       break;
-               case 's':
-                       https_port = optarg;
-                       break;
-               default:
-                       fprintf(stderr, "%s", usage);
-                       exit(1);
-       }
-
-
-       if (argc != optind+1) {
-               fprintf(stderr, "%s", usage);
-               exit(1);
-       }
-
-       if (!strcasecmp(argv[optind], "run")) {
-               run_in_foreground();
-       }
-       else if (!strcasecmp(argv[optind], "install")) {
-               fprintf(stderr, "oops, this is not implemented yet\n");
-       }
-       else if (!strcasecmp(argv[optind], "upgrade")) {
-               fprintf(stderr, "oops, this is not implemented yet\n");
-       }
-       else if (!strcasecmp(argv[optind], "test")) {
-               fprintf(stderr, "oops, this is not implemented yet\n");
-       }
-       else {
-               fprintf(stderr, "%s", usage);
-               exit(1);
-       }
-
-       exit(0);
-}
-
-
-void run_in_foreground(void) {
-       fprintf(stderr, "ctdlvisor: Welcome to the Citadel System, brought to you using AppImage.\n");
-       fprintf(stderr, "ctdlvisor: LD_LIBRARY_PATH = %s\n", getenv("LD_LIBRARY_PATH"));
-       fprintf(stderr, "ctdlvisor:            PATH = %s\n", getenv("PATH"));
-       fprintf(stderr, "ctdlvisor:          APPDIR = %s\n", getenv("APPDIR"));
-       fprintf(stderr, "ctdlvisor:  data directory = %s\n", data_directory);
-       fprintf(stderr, "ctdlvisor:       HTTP port = %s\n", http_port);
-       fprintf(stderr, "ctdlvisor:      HTTPS port = %s\n", https_port);
-
-       if (access(data_directory, R_OK|W_OK|X_OK)) {
-               fprintf(stderr, "ctdlvisor: %s: %s\n", data_directory, strerror(errno));
-               exit(errno);
-       }
-
-       signal(SIGTERM, signal_handler);
-       signal(SIGHUP, signal_handler);
-       signal(SIGINT, signal_handler);
-       signal(SIGQUIT, signal_handler);
-
-       citserver_pid = start_citadel();
-       webcit_pid = start_webcit();
-       webcits_pid = start_webcits();
-
-       main_loop();
-       exit(0);
-}
-
-
 void main_loop(void) {
        int status;
        pid_t who_exited;
        int citserver_exit_code = 0;
 
        do {
-               fprintf(stderr, "ctdlvisor: waiting for any child process to exit...\n");
                who_exited = waitpid(-1, &status, 0);
                fprintf(stderr, "ctdlvisor: pid=%d exited, status=%d, exitcode=%d\n", who_exited, status, WEXITSTATUS(status));
 
@@ -248,19 +164,22 @@ void main_loop(void) {
                // If it crashes, however, we will start it back up.
                if (who_exited == citserver_pid) {
                        citserver_exit_code = WEXITSTATUS(status);
-                       if (citserver_exit_code == 0) {
+                       if ((WIFEXITED(status)) && (citserver_exit_code == 0)) {
                                fprintf(stderr, "ctdlvisor: citserver exited normally - ending AppImage session\n");
                                shutting_down = 1;
                                kill(webcit_pid, SIGTERM);
                                kill(webcits_pid, SIGTERM);
                        }
-                       else if ((citserver_exit_code >= 101) && (citserver_exit_code <= 109)) {
+                       else if ((WIFEXITED(status)) && (citserver_exit_code >= 101) && (citserver_exit_code <= 109)) {
                                fprintf(stderr, "ctdlvisor: citserver exited intentionally - ending AppImage session\n");
                                shutting_down = 1;
                                kill(webcit_pid, SIGTERM);
                                kill(webcits_pid, SIGTERM);
                        }
                        else {
+                               if (WIFSIGNALED(status)) {
+                                       fprintf(stderr, "ctdlvisor: citserver crashed on signal %d\n", WTERMSIG(status));
+                               }
                                citserver_pid = start_citadel();
                        }
                }
@@ -273,6 +192,77 @@ void main_loop(void) {
                sleep(1);
 
        } while (who_exited >= 0);
-
        ctdlvisor_exit(citserver_exit_code);
 }
+
+
+int main(int argc, char **argv) {
+       int a;
+       int migrate_mode = 0;
+
+       if (getenv("APPDIR") == NULL) {
+               fprintf(stderr, "ctdlvisor: APPDIR is not set.  This program must be run from within an AppImage.\n");
+               ctdlvisor_exit(1);
+       }
+
+       /* parse command-line arguments */
+       while ((a=getopt(argc, argv, "cm")) != EOF) switch(a) {
+
+               // test this binary for compatibility and exit
+               case 'c':
+                       fprintf(stderr, "%s: binary compatibility confirmed\n", argv[0]);
+                       exit(0);
+                       break;
+
+               // run ctdlmigrate only
+               case 'm':
+                       migrate_mode = 1;
+                       break;
+
+               // any other parameter makes it crash and burn
+               default:
+                       fprintf(stderr, "usage\n");
+                       exit(1);
+       }
+
+       fprintf(stderr, "ctdlvisor: Welcome to the Citadel System, brought to you using AppImage.\n");
+       fprintf(stderr, "ctdlvisor: LD_LIBRARY_PATH = %s\n", getenv("LD_LIBRARY_PATH"));
+       fprintf(stderr, "ctdlvisor:            PATH = %s\n", getenv("PATH"));
+       fprintf(stderr, "ctdlvisor:          APPDIR = %s\n", getenv("APPDIR"));
+       fprintf(stderr, "ctdlvisor:  data directory = %s\n", getenv("CTDL_DIR"));
+       fprintf(stderr, "ctdlvisor:       HTTP port = %s\n", getenv("HTTP_PORT"));
+       fprintf(stderr, "ctdlvisor:      HTTPS port = %s\n", getenv("HTTPS_PORT"));
+
+       if (access(getenv("CTDL_DIR"), R_OK|W_OK|X_OK)) {
+               fprintf(stderr, "ctdlvisor: %s: %s\n", getenv("CTDL_DIR"), strerror(errno));
+               ctdlvisor_exit(errno);
+       }
+
+       signal(SIGHUP, signal_handler);
+
+       // "migrate mode" means we just start the server and then run ctdlmigrate interactively.
+       if (migrate_mode) {
+               citserver_pid = start_citadel();
+               fprintf(stderr, "ctdlvisor: waiting a moment for citserver to initialize...\n");
+               sleep(5);
+               char bin[1024];
+               sprintf(bin, "%s/usr/local/citadel/ctdlmigrate", getenv("APPDIR"));
+               system(bin);
+               kill(citserver_pid, SIGTERM);
+       }
+
+       // Otherwise, it's just a normal happy day in Citadel land.
+       else {
+               signal(SIGTERM, signal_handler);
+               signal(SIGINT, signal_handler);
+               signal(SIGQUIT, signal_handler);
+       
+               citserver_pid = start_citadel();
+               webcit_pid = start_webcit();
+               webcits_pid = start_webcits();
+       
+               main_loop();
+       }
+
+       ctdlvisor_exit(0);
+}