X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=appimage%2Fctdlvisor.c;h=3c7be88cc514159689e7012f2e8cccf4d2f65470;hb=8779ae0fd227b721c5244857956f578fc4af2149;hp=6257947644987840f9d4f58bc9a2624493909d4e;hpb=758608a1a004b60db17c960263036a73f5776adf;p=citadel.git diff --git a/appimage/ctdlvisor.c b/appimage/ctdlvisor.c index 625794764..3c7be88cc 100644 --- a/appimage/ctdlvisor.c +++ b/appimage/ctdlvisor.c @@ -1,20 +1,12 @@ -// // This is a supervisor program that handles start/stop/restart of // the various Citadel System components, when we are running on // an AppImage instance. // // Copyright (c) 2021 by the citadel.org team // -// 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. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. - +// This program is open source software. Use, duplication, or disclosure +// is subject to the terms of the GNU General Public License, version 3. +// The program is distributed without any warranty, expressed or implied. #include #include @@ -27,9 +19,6 @@ #include #include -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; @@ -74,9 +63,10 @@ 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); } @@ -102,12 +92,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); } } @@ -122,10 +113,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); } } @@ -140,39 +132,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); } } -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, "ctdlvisor: this appimage appears to be compatible with your system.\n"); - } - exit(ret); -} - - 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)); @@ -180,19 +155,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(); } } @@ -209,136 +187,72 @@ void main_loop(void) { } -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)); - 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); -} - - -void install_as_service(void) { - - // FIXME fail if some other citadel distribution is already there - // FIXME fail if any server processes are running - // FIXME interact with the user - // FIXME get port numbers and data directory - // FIXME create the data directory - // FIXME move the appimage into its permanent location - - fprintf(stderr, "Installing as service\n"); - - FILE *fp = fopen("/etc/systemd/system/ctdl.service", "w"); - fprintf(fp, "# This unit file starts all Citadel services via the AppImage distribution.\n" - "[Unit]\n" - "Description=Citadel\n" - "After=network.target\n" - "[Service]\n" - "ExecStart=/root/citadel/appimage/Citadel-x86_64.AppImage run -h %s -s %s -s %s\n" - "ExecStop=/bin/kill $MAINPID\n" - "KillMode=process\n" - "Restart=on-failure\n" - "LimitCORE=infinity\n" - "[Install]\n" - "WantedBy=multi-user.target\n" - , - data_directory, http_port, https_port - ); - fclose(fp); - - fprintf(stderr, "systemd unit file is installed. Type 'systemctl enable ctdl' to have it start at boot.\n"); -} - - -static char *usage = - "\n" - "ctdlvisor: usage: ctdlvisor [-h data_directory] [-p http_port] [-s https_port] command\n" - " 'command' must be one of: run, install, remove, upgrade, test, help\n" - "\n" -; - int main(int argc, char **argv) { - int c; + 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); } - while ((c = getopt (argc, argv, "h:p:s:")) != -1) switch(c) { - case 'h': - data_directory = optarg; - break; - case 'p': - http_port = optarg; + /* 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; - case 's': - https_port = optarg; + + // run ctdlmigrate only + case 'm': + migrate_mode = 1; break; + + // any other parameter makes it crash and burn default: - fprintf(stderr, "%s", usage); - ctdlvisor_exit(1); + 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 (argc != optind+1) { - fprintf(stderr, "%s", usage); - ctdlvisor_exit(1); + 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); } - if (!strcasecmp(argv[optind], "run")) { - run_in_foreground(); - } - else if (!strcasecmp(argv[optind], "install")) { - install_as_service(); - } - else if (!strcasecmp(argv[optind], "remove")) { - 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")) { - test_binary_compatibility(); - } - else if (!strcasecmp(argv[optind], "help")) { - fprintf(stderr, "%s", usage); - fprintf(stderr, "[-h dir] Use 'dir' as the Citadel data directory (this directory must exist)\n" - "[-p port] Listen for HTTP connections on 'port'\n" - "[-s port] Listen for HTTPS connections on 'port'\n" - "'command' must be one of:\n" - " run - launch Citadel services (does not detach from terminal)\n" - " install - create systemd unit files for automatic startup at boot\n" - " remove - delete systemd unit files to end automatic startup\n" - " upgrade - download and install a new version of this appimage\n" - " test - test the appimage for binary compatibility with this host\n" - " help - display this message\n" - "\n" - ); + 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 -h %s", getenv("APPDIR"), getenv("CTDL_DIR")); + system(bin); + kill(citserver_pid, SIGTERM); } + + // Otherwise, it's just a normal happy day in Citadel land. else { - fprintf(stderr, "%s", usage); - ctdlvisor_exit(1); + 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);