]> git.pond.sub.org Git - empserver/blobdiff - src/client/play.c
client: Add a missing #include <string.h>
[empserver] / src / client / play.c
index 68a2f9ede19995b147a06c1251ab2c06343e74ef..4f7757173e955f9af5bcde3c8e7534e99c07921b 100644 (file)
@@ -1,11 +1,11 @@
 /*
  *  Empire - A multi-player, client/server Internet based war game.
- *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
- *                           Ken Stevens, Steve McClure
+ *  Copyright (C) 1986-2017, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ *                Ken Stevens, Steve McClure, Markus Armbruster
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  Empire is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -14,8 +14,7 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  *  ---
  *
  *  ---
  *
  *  play.c: Playing the game
- * 
+ *
  *  Known contributors to this file:
- *     Markus Armbruster, 2007
- *     Ron Koenderink, 2007
+ *     Markus Armbruster, 2007-2017
+ *     Ron Koenderink, 2007-2009
+ *     Martin Haukeli, 2015
  */
 
 #include <config.h>
 #include <signal.h>
 #include <stdio.h>
 #include <stdlib.h>
-#ifndef _WIN32
-#include <sys/time.h>
-#include <sys/types.h>
-#include <unistd.h>
+#include <string.h>
+#ifdef _WIN32
+#include <process.h>
+#include <sys/socket.h>
 #else
-#include <io.h>
+#include <sys/select.h>
 #endif
+#include <unistd.h>
 #include "linebuf.h"
 #include "misc.h"
 #include "proto.h"
 #include "ringbuf.h"
 #include "secure.h"
 
+#ifdef HAVE_LIBREADLINE
+#include <readline/readline.h>
+#include <readline/history.h>
+#endif
+
+#define EOF_COOKIE "ctld\n"
+#define INTR_COOKIE "aborted\n"
+
+/*
+ * Player input file descriptor
+ * 0 while reading interactive input
+ * >0 while reading a batch file
+ * <0 during error handling
+ */
+static int input_fd;
+
+static volatile sig_atomic_t send_intr; /* need to send INTR_COOKIE */
+
 #ifdef _WIN32
 static CRITICAL_SECTION signal_critical_section;
 static LPCRITICAL_SECTION signal_critical_section_ptr = NULL;
@@ -67,10 +86,15 @@ static HANDLE bounce_empty;
  * stdin thread and is available for recv_input
  */
 static HANDLE bounce_full;
- /* Ctrl-C (SIGINT) was detected, generate EINTR for the w32_select() */
+/* Ctrl-C (SIGINT) was detected, generate EINTR for the w32_select() */
 static HANDLE ctrl_c_event;
 static int bounce_status, bounce_error;
 
+struct sigaction {
+    int sa_flags;
+    void (*sa_handler)(int sig);
+};
+
 #define SIGPIPE -1
 static void (*ctrl_handler)(int sig) = { SIG_DFL };
 
@@ -104,7 +128,7 @@ sigaction(int signal, struct sigaction *action, struct sigaction *oaction)
 {
     assert(!oaction);
     assert(action);
-    
+
     if (signal == SIGPIPE)
        assert(action->sa_handler == SIG_IGN);
     else {
@@ -133,25 +157,26 @@ sigaction(int signal, struct sigaction *action, struct sigaction *oaction)
  * WIN32 does not support select type function on console input
  * so the client uses a separate thread to read input
  */
-static DWORD WINAPI
-stdin_read_thread(LPVOID lpParam)
+static void
+stdin_read_thread(void *dummy)
 {
     for (;;) {
-       if (WaitForSingleObject(bounce_empty, INFINITE) != WAIT_OBJECT_0)
+       switch (WaitForSingleObject(bounce_empty, INFINITE)) {
+       case WAIT_FAILED:
+           bounce_status = -1;
+           bounce_error = GetLastError();
            break;
-       bounce_status = _read(0, bounce_buf, sizeof(bounce_buf));
-       bounce_error = errno;
-       if (bounce_status == 0) {
-           if (_isatty(0)) {
-               SetEvent(bounce_empty);
-               continue;
-           } else
-               break;
+       case WAIT_OBJECT_0:
+           bounce_status = _read(0, bounce_buf, sizeof(bounce_buf));
+           bounce_error = errno;
+           break;
+       case WAIT_ABANDONED:
+           return;
+       default:
+           assert(0);
        }
        SetEvent(bounce_full);
     }
-    SetEvent(bounce_full);
-    return 0;
 }
 
 /*
@@ -160,47 +185,55 @@ stdin_read_thread(LPVOID lpParam)
 static void
 sysdep_stdin_init(void)
 {
-    bounce_empty = CreateEvent(NULL, FALSE, TRUE, "bounce_empty");
-    bounce_full = CreateEvent(NULL, TRUE, FALSE, "bounce_full");
-    ctrl_c_event = CreateEvent(NULL, FALSE, FALSE, "Ctrl_C");
-    CreateThread(NULL, 0, stdin_read_thread, NULL, 0, NULL);
+    bounce_empty = CreateEvent(NULL, FALSE, TRUE, NULL);
+    bounce_full = CreateEvent(NULL, TRUE, FALSE, NULL);
+    ctrl_c_event = CreateEvent(NULL, FALSE, FALSE, NULL);
+    _beginthread(stdin_read_thread, 0, NULL);
 }
 
 /*
  * This function uses to WaitForMultipleObjects to wait for both
  * stdin and socket reading or writing.
- * Stdin is treated special in WIN32. Waiting for stdin is done
+ * Stdin is treated special in WIN32.  Waiting for stdin is done
  * via a bounce_full event which is set in the stdin thread.
- * Execute command file reading is done via handle.  Execute
- * command is read via CreateFile/ReadFile instead open/read
- * because a file descriptor is not waitable.
- * WaitForMultipleObjects will only respond with one object
+ * Execute command file reading is done via handle.
+ * WaitForMultipleObjects will only respond with one object,
  * so an additonal select is also done to determine
- * which individual events are active for the sock.
+ * which individual events are active.
  */
 static int
-w32_select(int nfds, fd_set *rdfd, fd_set *wrfd, fd_set *errfd, struct timeval* time)
+w32_select(int nfds, fd_set *rdfd, fd_set *wrfd, fd_set *errfd,
+          struct timeval *time)
 {
     HANDLE handles[3];
     SOCKET sock;
-    int result, s_result, num_handles = 0;
+    int inp, sockfd, result, s_result, num_handles;
     struct timeval tv_time = {0, 0};
-    fd_set rdfd2;
-
-    if (rdfd->fd_count > 1) {
-       sock = rdfd->fd_array[1];
-       if (rdfd->fd_array[0])
-           handles[num_handles++] = (HANDLE)rdfd->fd_array[0];
-       else {
-           handles[num_handles++] = ctrl_c_event;
-           handles[num_handles++] = bounce_full;
-       }
-    } else {
-       assert(rdfd->fd_count == 1);
-       sock = rdfd->fd_array[0];
+    fd_set rdsock, wrsock;
+
+    switch (rdfd->fd_count) {
+    case 1:
+       inp = -1;
+       sockfd = rdfd->fd_array[0];
+       break;
+    case 2:
+       inp = rdfd->fd_array[0];
+       sockfd = rdfd->fd_array[1];
+       break;
+    default:
+       assert(0);
     }
-    assert(wrfd->fd_count == 0 ||
-          (wrfd->fd_count == 1 && wrfd->fd_array[0] == sock));
+    sock = w32_fd2socket(sockfd);
+
+    assert(wrfd->fd_count == 0
+          || (wrfd->fd_count == 1 && wrfd->fd_array[0] == (SOCKET)sockfd));
+    assert(inp < 0 || inp == input_fd);
+
+    num_handles = 0;
+    handles[num_handles++] = ctrl_c_event;
+    if (inp >= 0)
+       handles[num_handles++]
+           = inp ? (HANDLE)_get_osfhandle(inp) : bounce_full;
     /* always wait on the socket */
     handles[num_handles++] = WSACreateEvent();
 
@@ -218,30 +251,33 @@ w32_select(int nfds, fd_set *rdfd, fd_set *wrfd, fd_set *errfd, struct timeval*
        return -1;
     }
     WSACloseEvent(handles[num_handles - 1]);
-    
-    if (num_handles == 3 && result == WAIT_OBJECT_0) {
+
+    if (result == WAIT_OBJECT_0) {
        errno = EINTR;
        return -1;
     }
 
-    FD_ZERO(&rdfd2);
-    FD_SET(sock, &rdfd2);
-    s_result = select(sock + 1, &rdfd2, wrfd, NULL, &tv_time);
+    FD_ZERO(&rdsock);
+    FD_ZERO(&wrsock);
+    FD_SET(sock, &rdsock);
+    if (wrfd->fd_count)
+       FD_SET(sock, &wrsock);
+    s_result = select(sock + 1, &rdsock, &wrsock, NULL, &tv_time);
 
     if (s_result < 0) {
-       errno = WSAGetLastError();
+       w32_set_winsock_errno();
        return s_result;
     }
 
-    *rdfd = rdfd2;
-    if (num_handles == 3 && result == WAIT_OBJECT_0 + 1) {
-       FD_SET((SOCKET)0, rdfd);
-       s_result++;
-    }
-    if (num_handles == 2 && result == WAIT_OBJECT_0) {
-       FD_SET((SOCKET)handles[0], rdfd);
+    if (!FD_ISSET(sock, &rdsock))
+       FD_CLR((SOCKET)sockfd, rdfd);
+    if (!FD_ISSET(sock, &wrsock))
+       FD_CLR((SOCKET)sockfd, wrfd);
+    if (inp >= 0 && result == WAIT_OBJECT_0 + 1)
        s_result++;
-    }
+    else
+       FD_CLR((SOCKET)inp, rdfd);
+
     return s_result;
 }
 
@@ -256,21 +292,21 @@ w32_ring_from_file_or_bounce_buf(struct ring *r, int fd)
     int i, res;
 
     if (fd)
-        return ring_from_file(r, fd);
+       return ring_from_file(r, fd);
 
     if (bounce_status < 0) {
-        errno = bounce_error;
-        res = bounce_status;
+       errno = bounce_error;
+       res = bounce_status;
     } else {
-        for (i = 0; i < bounce_status; i++) {
-            if (ring_putc(r, bounce_buf[i]) == EOF) {
-                /* more work to do, hold on to bounce_buf */
-                memmove(bounce_buf, bounce_buf + i, bounce_status - i);
-                bounce_status -= i;
-                return i;
-            }
-        }
-        res = i;
+       for (i = 0; i < bounce_status; i++) {
+           if (ring_putc(r, bounce_buf[i]) == EOF) {
+               /* more work to do, hold on to bounce_buf */
+               memmove(bounce_buf, bounce_buf + i, bounce_status - i);
+               bounce_status -= i;
+               return i;
+           }
+       }
+       res = i;
     }
 
     ResetEvent(bounce_full);
@@ -278,9 +314,6 @@ w32_ring_from_file_or_bounce_buf(struct ring *r, int fd)
     return res;
 }
 #define ring_from_file w32_ring_from_file_or_bounce_buf
-#define close(fd) w32_close_handle((fd))
-#define read(sock, buffer, buf_size) \
-       w32_recv((sock), (buffer), (buf_size), 0)
 #define select(nfds, rd, wr, error, time) \
        w32_select((nfds), (rd), (wr), (error), (time))
 #define sigemptyset(mask) ((void)0)
@@ -288,15 +321,8 @@ w32_ring_from_file_or_bounce_buf(struct ring *r, int fd)
 #define sysdep_stdin_init() ((void)0)
 #endif
 
-#define EOF_COOKIE "ctld\n"
-#define INTR_COOKIE "\naborted\n"
-
-int input_fd;
-int send_eof;                          /* need to send EOF_COOKIE */
-static volatile sig_atomic_t send_intr; /* need to send INTR_COOKIE */
-
 /*
- * Receive and process server output from SOCK.
+ * Receive and process server output from @sock.
  * Return number of characters received on success, -1 on error.
  */
 static int
@@ -307,10 +333,10 @@ recv_output(int sock)
      * simple state machine.
      * Initial state is SCANNING_ID.
      * In state SCANNING_ID, buffer the character.  If it's a space,
-     * decode the id that has been buffered, and enter state BUFFERING
+     * decode the ID that has been buffered, and enter state BUFFERING
      * or COPYING depending on its value.
      * In state BUFFERING, buffer the character.  If it's newline,
-     * pass id and buffered text to servercmd(), then enter state
+     * pass ID and buffered text to servercmd(), then enter state
      * SCANNING_ID.
      * In state COPYING, pass the character to outch().  If it's
      * newline, enter state SCANNING_ID.
@@ -322,7 +348,7 @@ recv_output(int sock)
     static struct lbuf lbuf;
     char buf[4096];
     ssize_t n;
-    int i, ch, len;
+    int i, ch, len, fd;
     char *line;
 
     n = read(sock, buf, sizeof(buf));
@@ -357,7 +383,7 @@ recv_output(int sock)
                state = BUFFERING;
                break;
            default:
-               /* unknown or unexpected id, treat like C_DATA */
+               /* unknown or unexpected ID, treat like C_DATA */
            case C_DATA:
                state = COPYING;
                break;
@@ -368,7 +394,18 @@ recv_output(int sock)
            len = lbuf_putc(&lbuf, ch);
            if (len) {
                line = lbuf_line(&lbuf);
-               servercmd(id, line, len);
+               fd = servercmd(id, line, len);
+               if (fd < 0) {
+                   /* failed execute */
+                   if (input_fd)
+                       close(input_fd);
+                   input_fd = 0;
+                   send_intr = 1;
+               } else if (fd > 0) {
+                   /* successful execute, switch to batch file */
+                   assert(!input_fd);
+                   input_fd = fd;
+               }
                lbuf_init(&lbuf);
                state = SCANNING_ID;
            }
@@ -384,48 +421,110 @@ recv_output(int sock)
     return n;
 }
 
+#ifdef HAVE_LIBREADLINE
+static int use_readline;
+static char *input_from_rl;
+static int has_rl_input;
+
+static void
+input_handler(char *line)
+{
+    input_from_rl = line;
+    has_rl_input = 1;
+    if (line && *line)
+       add_history(line);
+}
+
+static int
+ring_from_rl(struct ring *inbuf)
+{
+    size_t len;
+    int n;
+
+    assert(has_rl_input && input_from_rl);
+
+    len = strlen(input_from_rl);
+    n = ring_space(inbuf);
+    assert(n);
+
+    if (len >= (size_t)n) {
+       ring_putm(inbuf, input_from_rl, n);
+       memmove(input_from_rl, input_from_rl + n, len - n + 1);
+    } else {
+       ring_putm(inbuf, input_from_rl, len);
+       ring_putc(inbuf, '\n');
+       free(input_from_rl);
+       has_rl_input = 0;
+       n = len + 1;
+    }
+
+    return n;
+}
+#endif /* HAVE_LIBREADLINE */
+
 /*
- * Receive command input from FD into INBUF.
+ * Receive player input from @fd into @inbuf.
  * Return 1 on receipt of input, zero on EOF, -1 on error.
  */
 static int
 recv_input(int fd, struct ring *inbuf)
 {
-    static struct lbuf cmdbuf;
-    int n, i, ch;
-    char *line;
+    int n;
     int res = 1;
 
-    n = ring_from_file(inbuf, fd);
+#ifdef HAVE_LIBREADLINE
+    if (fd == 0 && use_readline) {
+       if (!has_rl_input)
+           rl_callback_read_char();
+       if (!has_rl_input)
+           return 1;
+       if (input_from_rl) {
+           n = ring_from_rl(inbuf);
+       } else
+           n = 0;
+    } else
+#endif
+       n = ring_from_file(inbuf, fd);
     if (n < 0)
        return -1;
     if (n == 0) {
-       /* EOF on input */
-       if (lbuf_len(&cmdbuf)) {
-           /* incomplete line */
-           ring_putc(inbuf, '\n');
-           n++;
-       }
        /*
-        * Can't put EOF cookie into INBUF here, it may not fit.
+        * Can't put EOF cookie into @inbuf here, it may not fit.
         * Leave it to caller.
         */
        res = 0;
     }
 
-    /* copy input to AUXFP etc. */
-    for (i = -n; i < 0; i++) {
-       ch = ring_peek(inbuf, i);
+    return res;
+}
+
+static int
+send_input(int fd, struct ring *inbuf)
+{
+    struct iovec iov[2];
+    int cnt, i, ch;
+    ssize_t res;
+
+    cnt = ring_to_iovec(inbuf, iov);
+    res = writev(fd, iov, cnt);
+    if (res < 0)
+       return res;
+
+    /* Copy input to @auxfp etc. */
+    for (i = 0; i < res; i++) {
+       ch = ring_getc(inbuf);
        assert(ch != EOF);
-       if (ch != '\r' && lbuf_putc(&cmdbuf, ch)) {
-           line = lbuf_line(&cmdbuf);
-           if (auxfp)
-               fputs(line, auxfp);
-           save_input(line);
-           lbuf_init(&cmdbuf);
-       }
+       if (ch != '\r')
+           save_input(ch);
+       if (auxfp)
+           putc(ch, auxfp);
     }
 
+#ifdef HAVE_LIBREADLINE
+    if (fd == 0 && use_readline && has_rl_input && input_from_rl)
+       ring_from_rl(inbuf);
+#endif
+
     return res;
 }
 
@@ -436,24 +535,28 @@ intr(int sig)
 }
 
 /*
- * Play on SOCK.
+ * Play on @sock.
+ * @history_file is the name of the history file, or null.
  * The session must be in the playing phase.
  * Return 0 when the session ended, -1 on error.
  */
 int
-play(int sock)
+play(int sock, char *history_file)
 {
     /*
-     * Player input flows from INPUT_FD through recv_input() into ring
-     * buffer INBUF, which drains into SOCK.  This must not block.
-     * Server output flows from SOCK into recv_output().  Reading SOCK
-     * must not block.
+     * Player input flows from @input_fd through recv_input() into
+     * ring buffer @inbuf, which drains into @sock.  This must not
+     * block.  Server output flows from @sock into recv_output().
+     * Reading @sock must not block.
      */
     struct sigaction sa;
     struct ring inbuf;         /* input buffer, draining to SOCK */
     int eof_fd0;               /* read fd 0 hit EOF? */
+    int partial_line_sent;     /* partial input line sent? */
+    int send_eof;              /* need to send EOF_COOKIE */
     fd_set rdfd, wrfd;
     int n;
+    int ret = -1;
 
     sa.sa_flags = 0;
     sigemptyset(&sa.sa_mask);
@@ -461,9 +564,20 @@ play(int sock)
     sigaction(SIGINT, &sa, NULL);
     sa.sa_handler = SIG_IGN;
     sigaction(SIGPIPE, &sa, NULL);
+#ifdef HAVE_LIBREADLINE
+    if (isatty(0)) {
+       use_readline = 1;
+       rl_already_prompted = 1;
+       rl_readline_name = "Empire";
+       if (history_file)
+           read_history(history_file);
+       rl_bind_key('\t', rl_insert);  /* Disable tab completion */
+       rl_callback_handler_install("", input_handler);
+    }
+#endif /* HAVE_LIBREADLINE */
 
     ring_init(&inbuf);
-    eof_fd0 = send_eof = send_intr = 0;
+    eof_fd0 = partial_line_sent = send_eof = send_intr = 0;
     input_fd = 0;
     sysdep_stdin_init();
 
@@ -473,10 +587,11 @@ play(int sock)
 
        /*
         * Want to read player input only when we don't need to send
-        * cookies, and we haven't hit EOF on fd 0, and INBUF can
-        * accept some.
+        * cookies, haven't reached EOF on fd 0, and @inbuf can accept
+        * some.
         */
-       if (!send_intr && !send_eof && !eof_fd0 && ring_space(&inbuf))
+       if (!send_intr && !send_eof && (input_fd || !eof_fd0)
+           && ring_space(&inbuf))
            FD_SET(input_fd, &rdfd);
        /* Want to send player input only when we have something */
        if (send_intr || send_eof || ring_len(&inbuf))
@@ -488,49 +603,61 @@ play(int sock)
        if (n < 0) {
            if (errno != EINTR) {
                perror("select");
-               return -1;
+               break;
            }
        }
 
-       if (send_eof
+       if ((send_eof || send_intr) && partial_line_sent
+           && ring_putc(&inbuf, '\n') != EOF)
+           partial_line_sent = 0;
+       if (send_eof && !partial_line_sent
            && ring_putm(&inbuf, EOF_COOKIE, sizeof(EOF_COOKIE) - 1) >= 0)
-           send_eof--;
-       if (send_intr
-           && ring_putm(&inbuf, INTR_COOKIE, sizeof(INTR_COOKIE) - 1) >= 0)
+           send_eof = 0;
+       if (send_intr && !partial_line_sent
+           && ring_putm(&inbuf, INTR_COOKIE, sizeof(INTR_COOKIE) - 1) >= 0) {
            send_intr = 0;
-
+           if (input_fd) {
+               /* execute aborted, switch back to fd 0 */
+               close(input_fd);
+               input_fd = 0;
+           }
+       }
        if (n < 0)
            continue;
 
        /* read player input */
-       if (FD_ISSET(input_fd, &rdfd)) {
+       if (FD_ISSET(input_fd, &rdfd) && ring_space(&inbuf)) {
            n = recv_input(input_fd, &inbuf);
-           if (n < 0) {
-               perror("read stdin"); /* FIXME stdin misleading, could be execing */
-               n = 0;
-           }
-           if (n == 0) {
-               /* EOF on input */
-               send_eof++;
+           if (n <= 0) {
                if (input_fd) {
                    /* execute done, switch back to fd 0 */
+                   if (n < 0) {
+                       perror("read batch file");
+                       send_intr = 1;
+                   } else
+                       send_eof = 1;
                    close(input_fd);
                    input_fd = 0;
                } else {
                    /* stop reading input, drain socket ring buffers */
+                   if (n < 0)
+                       perror("read stdin");
+                   send_eof = 1;
                    eof_fd0 = 1;
                    sa.sa_handler = SIG_DFL;
                    sigaction(SIGINT, &sa, NULL);
+                   send_intr = 0;
                }
-           }
+           } else if (ring_len(&inbuf) > 0)
+               partial_line_sent = ring_peek(&inbuf, -1) != '\n';
        }
 
        /* send it to the server */
        if (FD_ISSET(sock, &wrfd)) {
-           n = ring_to_file(&inbuf, sock);
+           n = send_input(sock, &inbuf);
            if (n < 0) {
                perror("write socket");
-               return -1;
+               break;
            }
        }
 
@@ -539,10 +666,43 @@ play(int sock)
            n = recv_output(sock);
            if (n < 0) {
                perror("read socket");
-               return -1;
+               break;
+           }
+           if (n == 0) {
+               ret = 0;
+               break;
            }
-           if (n == 0)
-               return 0;
        }
     }
+
+#ifdef HAVE_LIBREADLINE
+    if (use_readline) {
+       rl_callback_handler_remove();
+       if (history_file)
+           write_history(history_file);
+    }
+#endif
+    return ret;
+}
+
+void
+prompt(int code, char *prompt, char *teles)
+{
+    char pr[1024];
+
+    snprintf(pr, sizeof(pr), "%s%s", teles, prompt);
+#ifdef HAVE_LIBREADLINE
+    if (use_readline) {
+       rl_set_prompt(pr);
+       rl_forced_update_display();
+    } else
+#endif /* HAVE_LIBREADLINE */
+    {
+       printf("%s", pr);
+       fflush(stdout);
+    }
+    if (auxfp) {
+       fprintf(auxfp, "%s%s", teles, prompt);
+       fflush(auxfp);
+    }
 }