Additional logging, moderate cleanup.
[guacd.git] / src / daemon.c
index 2e7b9f5..bd30a8e 100644 (file)
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
+#include <signal.h>
 #include <sys/types.h>
 
-#ifdef __MINGW32__
-#include <winsock2.h>
-#else
 #include <sys/socket.h>
 #include <netinet/in.h>
-#endif
-
-#ifdef HAVE_LIBPTHREAD
-#include <pthread.h>
-#elif defined(__MINGW32__)
-#include <windows.h>
-#include <process.h>
-#endif
 
 #include <errno.h>
+#include <syslog.h>
 
 #include <guacamole/client.h>
-#include <guacamole/log.h>
-
-/* Windows / MINGW32 handles closing sockets differently */ 
-#ifdef __MINGW32__
-#define CLOSE_SOCKET(socket) closesocket(socket)
-#else
-#define CLOSE_SOCKET(socket) close(socket)
-#endif
-
-
-/* Cross-platform strerror()/errno clone */
-char error[65536];
-char* lasterror() {
-#ifdef __MINGW32__
-    snprintf(error, sizeof(error)-1, "ERROR #%i", GetLastError());
-    return error;
-#else
-    return strerror(errno);
-#endif
-}
+#include <guacamole/error.h>
 
+#include "client.h"
 
 typedef struct client_thread_data {
 
@@ -90,30 +63,129 @@ typedef struct client_thread_data {
 void* start_client_thread(void* data) {
 
     guac_client* client;
+    guac_client_plugin* plugin;
+    guac_instruction* select;
+    guac_instruction* connect;
+
+    /* Get thread data */
     client_thread_data* thread_data = (client_thread_data*) data;
 
-    GUAC_LOG_INFO("Spawning client");
+    /* Open guac_socket */
+    guac_socket* socket = guac_socket_open(thread_data->fd);
 
-    /* Load and start client */
-    client = guac_get_client(thread_data->fd); 
+    /* Get protocol from select instruction */
+    select = guac_protocol_expect_instruction(
+            socket, GUAC_USEC_TIMEOUT, "select");
+    if (select == NULL) {
 
-    if (client == NULL) {
-        GUAC_LOG_ERROR("Client retrieval failed");
+        /* Log error */
+        syslog(LOG_ERR, "Error reading \"select\": %s",
+                guac_status_string(guac_error));
+
+        /* Free resources */
+        guac_socket_close(socket);
+        free(data);
         return NULL;
     }
 
-    guac_start_client(client);
+    /* Validate args to select */
+    if (select->argc != 1) {
 
-    guac_free_client(client);
+        /* Log error */
+        syslog(LOG_ERR, "Bad number of arguments to \"select\" (%i)",
+                select->argc);
 
-    /* Close socket */
-    if (CLOSE_SOCKET(thread_data->fd) < 0) {
-        GUAC_LOG_ERROR("Error closing connection: %s", lasterror());
+        /* Free resources */
+        guac_socket_close(socket);
+        free(data);
+        return NULL;
+    }
+
+    syslog(LOG_INFO, "Protocol \"%s\" selected", select->argv[0]);
+
+    /* Get plugin from protocol in select */
+    plugin = guac_client_plugin_open(select->argv[0]);
+    guac_instruction_free(select);
+
+    if (plugin == NULL) {
+
+        /* Log error */
+        syslog(LOG_ERR, "Error loading client plugin: %s",
+                guac_status_string(guac_error));
+
+        /* Free resources */
+        guac_socket_close(socket);
+        free(data);
+        return NULL;
+    }
+
+    /* Send args response */
+    if (guac_protocol_send_args(socket, plugin->args)
+            || guac_socket_flush(socket)) {
+
+        /* Log error */
+        syslog(LOG_ERR, "Error sending \"args\": %s",
+                guac_status_string(guac_error));
+
+        if (guac_client_plugin_close(plugin))
+            syslog(LOG_ERR, "Error closing client plugin");
+
+        guac_socket_close(socket);
+        free(data);
+        return NULL;
+    }
+
+    /* Get args from connect instruction */
+    connect = guac_protocol_expect_instruction(
+            socket, GUAC_USEC_TIMEOUT, "connect");
+    if (connect == NULL) {
+
+        /* Log error */
+        syslog(LOG_ERR, "Error reading \"connect\": %s",
+                guac_status_string(guac_error));
+
+        if (guac_client_plugin_close(plugin))
+            syslog(LOG_ERR, "Error closing client plugin");
+
+        guac_socket_close(socket);
+        free(data);
+        return NULL;
+    }
+
+    /* Load and init client */
+    client = guac_client_plugin_get_client(plugin, socket,
+            connect->argc, connect->argv); 
+    guac_instruction_free(connect);
+
+    if (client == NULL) {
+
+        syslog(LOG_ERR, "Error instantiating client: %s",
+                guac_status_string(guac_error));
+
+        if (guac_client_plugin_close(plugin))
+            syslog(LOG_ERR, "Error closing client plugin");
+
+        guac_socket_close(socket);
         free(data);
         return NULL;
     }
 
-    GUAC_LOG_INFO("Client finished");
+    /* Start client threads */
+    syslog(LOG_INFO, "Starting client");
+    if (guac_start_client(client))
+        syslog(LOG_ERR, "Client finished abnormally");
+    else
+        syslog(LOG_INFO, "Client finished normally");
+
+    /* Clean up */
+    guac_client_free(client);
+    if (guac_client_plugin_close(plugin))
+        syslog(LOG_ERR, "Error closing client plugin");
+
+    /* Close socket */
+    guac_socket_close(socket);
+    close(thread_data->fd);
+
     free(data);
     return NULL;
 
@@ -128,23 +200,20 @@ int main(int argc, char* argv[]) {
 
     /* Client */
     struct sockaddr_in client_addr;
-    unsigned int client_addr_len;
+    socklen_t client_addr_len;
     int connected_socket_fd;
 
     /* Arguments */
     int listen_port = 4822; /* Default port */
     int opt;
 
+    char* pidfile = NULL;
+
     /* Daemon Process */
     pid_t daemon_pid;
 
-#ifdef __MINGW32__
-    /* Structure for holding winsock version info */
-    WSADATA wsadata;
-#endif
-
     /* Parse arguments */
-    while ((opt = getopt(argc, argv, "l:")) != -1) {
+    while ((opt = getopt(argc, argv, "l:p:")) != -1) {
         if (opt == 'l') {
             listen_port = atoi(optarg);
             if (listen_port <= 0) {
@@ -152,8 +221,11 @@ int main(int argc, char* argv[]) {
                 exit(EXIT_FAILURE);
             }
         }
+        else if (opt == 'p') {
+            pidfile = strdup(optarg);
+        }
         else {
-            fprintf(stderr, "USAGE: %s [-l LISTENPORT]\n", argv[0]);
+            fprintf(stderr, "USAGE: %s [-l LISTENPORT] [-p PIDFILE]\n", argv[0]);
             exit(EXIT_FAILURE);
         }
     }
@@ -164,29 +236,21 @@ int main(int argc, char* argv[]) {
     server_addr.sin_addr.s_addr = INADDR_ANY;
     server_addr.sin_port = htons(listen_port);
 
-#ifdef __MINGW32__
-    /* If compiling for Windows, init winsock. */
-    if (WSAStartup(MAKEWORD(1,1), &wsadata) == SOCKET_ERROR) {
-        fprintf(stderr, "Error creating socket.");
-        exit(EXIT_FAILURE);
-    }
-#endif
-
     /* Get socket */
     socket_fd = socket(AF_INET, SOCK_STREAM, 0);
     if (socket_fd < 0) {
-        fprintf(stderr, "Error opening socket: %s\n", lasterror());
+        fprintf(stderr, "Error opening socket: %s\n", strerror(errno));
         exit(EXIT_FAILURE);
     }
 
-    if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, &opt_on, sizeof(opt_on))) {
-        fprintf(stderr, "Warning: Unable to set socket options for reuse: %s\n", lasterror());
+    if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, (void*) &opt_on, sizeof(opt_on))) {
+        fprintf(stderr, "Warning: Unable to set socket options for reuse: %s\n", strerror(errno));
     }
 
     /* Bind socket to address */
     if (bind(socket_fd, (struct sockaddr*) &server_addr,
                 sizeof(server_addr)) < 0) {
-        fprintf(stderr, "Error binding socket: %s\n", lasterror());
+        fprintf(stderr, "Error binding socket: %s\n", strerror(errno));
         exit(EXIT_FAILURE);
     } 
 
@@ -196,33 +260,64 @@ int main(int argc, char* argv[]) {
 
     /* If error, fail */
     if (daemon_pid == -1) {
-        fprintf(stderr, "Error forking daemon process: %s\n", lasterror());
+        fprintf(stderr, "Error forking daemon process: %s\n", strerror(errno));
         exit(EXIT_FAILURE);
     }
 
-    /* If parent, exit */
+    /* If parent, write PID file and exit */
     else if (daemon_pid != 0) {
+
+        if (pidfile != NULL) {
+
+            /* Attempt to open pidfile and write PID */
+            FILE* pidf = fopen(pidfile, "w");
+            if (pidf) {
+                fprintf(pidf, "%d\n", daemon_pid);
+                fclose(pidf);
+            }
+
+            /* Warn on failure */
+            else {
+                fprintf(stderr, "WARNING: Could not write PID file: %s\n", strerror(errno));
+                exit(EXIT_FAILURE);
+            }
+
+        }
+
         exit(EXIT_SUCCESS);
     }
 #else
-    GUAC_LOG_INFO("fork() not defined at compile time.");
-    GUAC_LOG_INFO("guacd running in foreground only.");
+    daemon_pid = getpid();
+    syslog(LOG_INFO, "fork() not defined at compile time.");
+    syslog(LOG_INFO, "guacd running in foreground only.");
 #endif
 
     /* Otherwise, this is the daemon */
-    GUAC_LOG_INFO("Started, listening on port %i", listen_port);
+    syslog(LOG_INFO, "Listening on port %i", listen_port);
+
+    /* Ignore SIGPIPE */
+    if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {
+        syslog(LOG_ERR, "Could not set handler for SIGPIPE to ignore. SIGPIPE may cause termination of the daemon.");
+    }
+
+    /* Ignore SIGCHLD (force automatic removal of children) */
+    if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
+        syslog(LOG_ERR, "Could not set handler for SIGCHLD to ignore. Child processes may pile up in the process table.");
+    }
 
     /* Daemon loop */
     for (;;) {
 
-#ifdef HAVE_LIBPTHREAD
-        pthread_t thread;
+#ifdef HAVE_FORK
+        pid_t child_pid;
+#else
+        guac_thread_t thread;
 #endif
         client_thread_data* data;
 
         /* Listen for connections */
         if (listen(socket_fd, 5) < 0) {
-            GUAC_LOG_ERROR("Could not listen on socket: %s", lasterror());
+            syslog(LOG_ERR, "Could not listen on socket: %s", strerror(errno));
             return 3;
         }
 
@@ -230,35 +325,60 @@ int main(int argc, char* argv[]) {
         client_addr_len = sizeof(client_addr);
         connected_socket_fd = accept(socket_fd, (struct sockaddr*) &client_addr, &client_addr_len);
         if (connected_socket_fd < 0) {
-            GUAC_LOG_ERROR("Could not accept client connection: %s", lasterror());
+            syslog(LOG_ERR, "Could not accept client connection: %s", strerror(errno));
             return 3;
         }
 
         data = malloc(sizeof(client_thread_data));
         data->fd = connected_socket_fd;
 
-#ifdef HAVE_LIBPTHREAD
-        if (pthread_create(&thread, NULL, start_client_thread, (void*) data)) {
-            GUAC_LOG_ERROR("Could not create client thread: %s", lasterror());
-            return 3;
+        /* 
+         * Once connection is accepted, send child into background, whether through
+         * fork() or through creating a thread. If thead support is not present on
+         * the platform, guacd will still work, but will only be able to handle one
+         * connection at a time.
+         */
+
+#ifdef HAVE_FORK
+
+        /*** FORK ***/
+
+        /*
+         * Note that we prefer fork() over threads for connection-handling
+         * processes as they give each connection its own memory area, and
+         * isolate the main daemon and other connections from errors in any
+         * particular client plugin.
+         */
+
+        child_pid = fork();
+
+        /* If error, log */
+        if (child_pid == -1)
+            syslog(LOG_ERR, "Error forking child process: %s\n", strerror(errno));
+
+        /* If child, start client, and exit when finished */
+        else if (child_pid == 0) {
+            start_client_thread(data);
+            return 0;
         }
-#elif __MINGW32__
-        if (_beginthread(start_client_thread, 0, (void*) data) == -1L) { 
-            GUAC_LOG_ERROR("Could not create client thread: %s", lasterror());
-            return 3;
+
+        /* If parent, close reference to child's descriptor */
+        else if (close(connected_socket_fd) < 0) {
+            syslog(LOG_ERR, "Error closing daemon reference to child descriptor: %s", strerror(errno));
         }
+
 #else
-#warning THREAD SUPPORT NOT FOUND! guacd will only be able to handle one connection at a time.
-        GUAC_LOG_INFO("Thread support not present at compile time.");
-        GUAC_LOG_INFO("guacd handling one connection at a time.");
-        start_client_thread(data);
+
+        if (guac_thread_create(&thread, start_client_thread, (void*) data))
+            syslog(LOG_ERR, "Could not create client thread: %s", strerror(errno));
+
 #endif
 
     }
 
     /* Close socket */
-    if (CLOSE_SOCKET(socket_fd) < 0) {
-        GUAC_LOG_ERROR("Could not close socket: %s", lasterror());
+    if (close(socket_fd) < 0) {
+        syslog(LOG_ERR, "Could not close socket: %s", strerror(errno));
         return 3;
     }