Various changes to appimage. Removed some old docs.
[citadel.git] / appimage / ctdlvisor.c
index 7bcf5efbd29d50bf5206237496d0d7677d851cfd..405a56bdaed68426601981707e640e7a29613387 100644 (file)
 #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 +71,28 @@ 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) {
+                       if (WIFEXITED(status)) {
+                               fprintf(stderr, "ctdlvisor: %d (%s) exited, exitcode=%d\n", who_exited, what_exited, WEXITSTATUS(status));
+                       }
+                       else if (WIFSIGNALED(status)) {
+                               fprintf(stderr, "ctdlvisor: %d (%s) crashed, signal=%d\n", who_exited, what_exited, WTERMSIG(status));
+                       }
+                       else {
+                               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) ||
@@ -105,12 +108,13 @@ pid_t start_citadel() {
        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);
+               execlp(bin, "citserver", "-x9", "-h", getenv("CTDL_DIR"), NULL);
                exit(errno);
        }
        else {
+               fprintf(stderr, "ctdlvisor: citserver running on pid=%d\n", pid);
                return(pid);
        }
 }
@@ -125,10 +129,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,94 +148,30 @@ 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");
+void test_binary_compatibility(void) {
+       char cmd[1024];
+       int ret;
+       fprintf(stderr, "ctdlvisor: testing compatibility...\n");
+       sprintf(cmd, "%s/usr/local/citadel/citserver -c", getenv("APPDIR"));
+       ret = system(cmd);
+       if (ret) {
+               fprintf(stderr, "ctdlvisor: this appimage cannot run on your system.\n"
+                               "           The reason may be indicated by any error messages appearing above.\n");
        }
        else {
-               fprintf(stderr, "%s", usage);
-               exit(1);
+               fprintf(stderr, "ctdlvisor: this appimage appears to be compatible with your system.\n");
        }
-
-       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);
+       exit(ret);
 }
 
 
@@ -240,7 +181,6 @@ void main_loop(void) {
        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));
 
@@ -273,6 +213,39 @@ void main_loop(void) {
                sleep(1);
 
        } while (who_exited >= 0);
-
        ctdlvisor_exit(citserver_exit_code);
 }
+
+
+int main(int argc, char **argv) {
+
+       if (getenv("APPDIR") == NULL) {
+               fprintf(stderr, "ctdlvisor: APPDIR is not set.  This program must be run from within an AppImage.\n");
+               ctdlvisor_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(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();
+       ctdlvisor_exit(0);
+}