# HG changeset patch # User Juanma Barranquero # Date 1162254079 0 # Node ID 368665ce6f357c382be7a1448ed687a7126ec888 # Parent cdd279778a20eb872db7c662956bb1620e47f020 Add support for TCP sockets. (SEND_STRING, SEND_QUOTED, HSOCKET, CLOSE_SOCKET, IOCTL, INITIALIZE): New macros. (IOCTL_BOOL_ARG): New typedef. (server_file): New global variable. (longopts): New option --server-file. (decode_options): Process new option --server-file and environment variable EMACS_SERVER_FILE. (print_help_and_exit): Document new option. (fail): If no connection available and no alternate editor, suggest using options to make them explicit. (AUTH_KEY_LENGTH, SEND_BUFFER_SIZE): New constants. (send_buffer, sblen): New variables. (send_to_emacs): New function to buffer output and send it with send(). (quote_file_name): Use SEND_STRING. (close_winsock, initialize_sockets): New functions to load and unload Winsock. (get_server_config, set_tcp_socket): New functions to create and set up TCP sockets. (set_local_socket): New function to create and set up Unix socket (code moved from previous implementation). (set_socket): New function to chose between TCP and Unix sockets. (main): Use SEND_STRING and SEND_QUOTED. Most code moved to set_local_socket. Use set_socket. Get answers from server.el with recv(), not file stream functions. diff -r cdd279778a20 -r 368665ce6f35 lib-src/emacsclient.c --- a/lib-src/emacsclient.c Tue Oct 31 00:19:38 2006 +0000 +++ b/lib-src/emacsclient.c Tue Oct 31 00:21:19 2006 +0000 @@ -26,19 +26,42 @@ #include #endif +#ifdef WINDOWSNT +#define HAVE_SOCKETS +#define NO_SOCKETS_IN_FILE_SYSTEM +#endif + +#ifdef WINDOWSNT +# define HSOCKET SOCKET +# define CLOSE_SOCKET closesocket +# define IOCTL ioctlsocket +# define INITIALIZE() (initialize_sockets ()) +typedef unsigned long IOCTL_BOOL_ARG; +#else +# define HSOCKET int +# define CLOSE_SOCKET close +# define IOCTL ioctl +# define INITIALIZE() +typedef int IOCTL_BOOL_ARG; +#endif + #undef signal #include #include -#include +#include "getopt.h" #ifdef HAVE_UNISTD_H #include #endif #ifdef VMS # include "vms-pwd.h" -#else +#else /* not VMS */ +#ifdef WINDOWSNT +# include +#else /* not WINDOWSNT */ # include +#endif /* not WINDOWSNT */ #endif /* not VMS */ char *getenv (), *getwd (); @@ -48,6 +71,29 @@ #define VERSION "unspecified" #endif +#define SEND_STRING(data) (send_to_emacs (s, (data))) +#define SEND_QUOTED(data) (quote_file_name (s, (data))) + +#ifndef EXIT_SUCCESS +#define EXIT_SUCCESS 0 +#endif + +#ifndef EXIT_FAILURE +#define EXIT_FAILURE 1 +#endif + +#ifndef FALSE +#define FALSE 0 +#endif + +#ifndef TRUE +#define TRUE 1 +#endif + +#ifndef NO_RETURN +#define NO_RETURN +#endif + /* Name used to invoke this program. */ char *progname; @@ -67,6 +113,9 @@ /* If non-NULL, the filename of the UNIX socket. */ char *socket_name = NULL; +/* If non-NULL, the filename of the authentication file. */ +char *server_file = NULL; + void print_help_and_exit () NO_RETURN; struct option longopts[] = @@ -77,6 +126,7 @@ { "version", no_argument, NULL, 'V' }, { "alternate-editor", required_argument, NULL, 'a' }, { "socket-name", required_argument, NULL, 's' }, + { "server-file", required_argument, NULL, 'f' }, { "display", required_argument, NULL, 'd' }, { 0, 0, 0, 0 } }; @@ -90,11 +140,12 @@ char **argv; { alternate_editor = getenv ("ALTERNATE_EDITOR"); + server_file = getenv ("EMACS_SERVER_FILE"); while (1) { int opt = getopt_long (argc, argv, - "VHnea:s:d:", longopts, 0); + "VHnea:s:f:d:", longopts, 0); if (opt == EOF) break; @@ -114,6 +165,10 @@ socket_name = optarg; break; + case 'f': + server_file = optarg; + break; + case 'd': display = optarg; break; @@ -156,9 +211,13 @@ -H, --help Print this usage information message\n\ -n, --no-wait Don't wait for the server to return\n\ -e, --eval Evaluate the FILE arguments as ELisp expressions\n\ --d, --display=DISPLAY Visit the file in the given display\n\ --s, --socket-name=FILENAME\n\ - Set the filename of the UNIX socket for communication\n\ +-d, --display=DISPLAY Visit the file in the given display\n" +#ifndef NO_SOCKETS_IN_FILE_SYSTEM +"-s, --socket-name=FILENAME\n\ + Set the filename of the UNIX socket for communication\n" +#endif +"-f, --server-file=FILENAME\n\ + Set the filename of the TCP configuration file\n\ -a, --alternate-editor=EDITOR\n\ Editor to fallback to if the server is not running\n\ \n\ @@ -166,14 +225,118 @@ exit (EXIT_SUCCESS); } + +/* + Try to run a different command, or --if no alternate editor is + defined-- exit with an errorcode. +*/ +void +fail (argc, argv) + int argc; + char **argv; +{ + if (alternate_editor) + { + int i = optind - 1; + execvp (alternate_editor, argv + i); + fprintf (stderr, "%s: error executing alternate editor \"%s\"\n", + progname, alternate_editor); + } + else + { + fprintf (stderr, "%s: No socket or alternate editor. Please use:\n\n" +#if !defined (NO_SOCKETS_IN_FILE_SYSTEM) +"\t--socket-name\n" +#endif +"\t--server-file (or environment variable EMACS_SERVER_FILE)\n\ +\t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n", + progname); + } + exit (EXIT_FAILURE); +} + + +#if !defined (HAVE_SOCKETS) + +int +main (argc, argv) + int argc; + char **argv; +{ + fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n", + argv[0]); + fprintf (stderr, "on systems with Berkeley sockets.\n"); + + fail (argc, argv); +} + +#else /* HAVE_SOCKETS */ + +#ifdef WINDOWSNT +# include +#else +# include +# include +# include +# include +# include +#endif + +#define AUTH_KEY_LENGTH 64 +#define SEND_BUFFER_SIZE 4096 + +extern char *strerror (); +extern int errno; + +/* Buffer to accumulate data to send in TCP connections. */ +char send_buffer[SEND_BUFFER_SIZE + 1]; +int sblen = 0; /* Fill pointer for the send buffer. */ + +/* Let's send the data to Emacs when either + - the data ends in "\n", or + - the buffer is full (but this shouldn't happen) + Otherwise, we just accumulate it. */ +void send_to_emacs (s, data) + HSOCKET s; + char *data; +{ + while (data) + { + int dlen = strlen (data); + if (dlen + sblen >= SEND_BUFFER_SIZE) + { + int part = SEND_BUFFER_SIZE - sblen; + strncpy (&send_buffer[sblen], data, part); + data += part; + sblen = SEND_BUFFER_SIZE; + } + else if (dlen) + { + strcpy (&send_buffer[sblen], data); + data = NULL; + sblen += dlen; + } + else + break; + + if (sblen == SEND_BUFFER_SIZE + || (sblen > 0 && send_buffer[sblen-1] == '\n')) + { + int sent = send (s, send_buffer, sblen, 0); + if (sent != sblen) + strcpy (send_buffer, &send_buffer[sent]); + sblen -= sent; + } + } +} + /* In NAME, insert a & before each &, each space, each newline, and any initial -. Change spaces to underscores, too, so that the return value never contains a space. */ - void -quote_file_name (name, stream) +quote_file_name (s, name) + HSOCKET s; char *name; - FILE *stream; { char *copy = (char *) malloc (strlen (name) * 2 + 1); char *p, *q; @@ -203,73 +366,139 @@ } *q++ = 0; - fprintf (stream, "%s", copy); + SEND_STRING (copy); free (copy); } -/* Like malloc but get fatal error if memory is exhausted. */ +#ifdef WINDOWSNT +/* Wrapper to make WSACleanup a cdecl, as required by atexit(). */ +void close_winsock () +{ + WSACleanup (); +} -long * -xmalloc (size) - unsigned int size; +void initialize_sockets () { - long *result = (long *) malloc (size); - if (result == NULL) - { - perror ("malloc"); - exit (EXIT_FAILURE); - } - return result; + WSADATA wsaData; + + /* Initialize the WinSock2 library. */ + if (WSAStartup (MAKEWORD (2, 0), &wsaData)) + { + fprintf (stderr, "%s: error initializing WinSock2", progname); + exit (EXIT_FAILURE); + } + + atexit (close_winsock); +#endif /* WINDOWSNT */ } /* - Try to run a different command, or --if no alternate editor is - defined-- exit with an errorcode. + * Read the information needed to set up a TCP comm channel with + * the Emacs server: host, port and authentication string. */ -void -fail (argc, argv) - int argc; - char **argv; +int get_server_config (server, authentication) + struct sockaddr_in *server; + char *authentication; { - if (alternate_editor) + FILE *config; + char dotted[32]; + char *port; + + if (! (config = fopen (server_file, "rb"))) { - int i = optind - 1; - execvp (alternate_editor, argv + i); - return; + char *home = getenv ("HOME"); +#ifdef WINDOWSNT + if (! home) + home = getenv ("APPDATA"); +#endif + if (home) + { + char *path = alloca (32 + strlen (home) + strlen (server_file)); + sprintf (path, "%s/.emacs.d/server/%s", home, server_file); + config = fopen (path, "rb"); + } + } + + if (! config) + return FALSE; + + if (fgets (dotted, sizeof dotted, config) + && (port = strchr (dotted, ':'))) + { + *port++ = '\0'; } else { + fprintf (stderr, "%s: invalid configuration info", progname); exit (EXIT_FAILURE); } + + server->sin_family = AF_INET; + server->sin_addr.s_addr = inet_addr (dotted); + server->sin_port = htons (atoi (port)); + + if (! fread (authentication, AUTH_KEY_LENGTH, 1, config)) + { + fprintf (stderr, "%s: cannot read authentication info", progname); + exit (EXIT_FAILURE); + } + + fclose (config); + + return TRUE; } +HSOCKET +set_tcp_socket () +{ + HSOCKET s; + struct sockaddr_in server; + IOCTL_BOOL_ARG c_arg = 0; + struct linger l_arg = {1, 1}; + char auth_string[AUTH_KEY_LENGTH + 1]; - -#if !defined (HAVE_SOCKETS) || defined (NO_SOCKETS_IN_FILE_SYSTEM) + INITIALIZE (); + + if (! get_server_config (&server, auth_string)) + return INVALID_SOCKET; + + /* + * Open up an AF_INET socket + */ + if ((s = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0) + { + fprintf (stderr, "%s: ", progname); + perror ("socket"); + return INVALID_SOCKET; + } -int -main (argc, argv) - int argc; - char **argv; -{ - fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n", - argv[0]); - fprintf (stderr, "on systems with Berkeley sockets.\n"); + /* + * Set up the socket + */ + if (connect (s, (struct sockaddr *) &server, sizeof server) < 0) + { + fprintf (stderr, "%s: ", progname); + perror ("connect"); + return INVALID_SOCKET; + } - fail (argc, argv); + IOCTL (s, FIONBIO, &c_arg); + setsockopt (s, SOL_SOCKET, SO_LINGER, (char *) &l_arg, sizeof l_arg); + + /* + * Send the authentication + */ + auth_string[AUTH_KEY_LENGTH] = '\0'; + + SEND_STRING ("-auth "); + SEND_STRING (auth_string); + SEND_STRING ("\n"); + + return s; } -#else /* HAVE_SOCKETS */ - -#include -#include -#include -#include -#include - -extern char *strerror (); -extern int errno; +#if !defined (NO_SOCKETS_IN_FILE_SYSTEM) /* Three possibilities: 2 - can't be `stat'ed (sets errno) @@ -291,28 +520,11 @@ return 0; } -int -main (argc, argv) - int argc; - char **argv; +HSOCKET +set_local_socket () { - int s, i, needlf = 0; - FILE *out, *in; + HSOCKET s; struct sockaddr_un server; - char *cwd, *str; - char string[BUFSIZ]; - - progname = argv[0]; - - /* Process options. */ - decode_options (argc, argv); - - if ((argc - optind < 1) && !eval) - { - fprintf (stderr, "%s: file name or argument required\n", progname); - fprintf (stderr, "Try `%s --help' for more information\n", progname); - exit (EXIT_FAILURE); - } /* * Open up an AF_UNIX socket in this person's home directory @@ -320,9 +532,9 @@ if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0) { - fprintf (stderr, "%s: ", argv[0]); + fprintf (stderr, "%s: ", progname); perror ("socket"); - fail (argc, argv); + return INVALID_SOCKET; } server.sun_family = AF_UNIX; @@ -352,7 +564,7 @@ else { fprintf (stderr, "%s: socket-name %s too long", - argv[0], socket_name); + progname, socket_name); exit (EXIT_FAILURE); } @@ -387,7 +599,7 @@ else { fprintf (stderr, "%s: socket-name %s too long", - argv[0], socket_name); + progname, socket_name); exit (EXIT_FAILURE); } @@ -399,60 +611,84 @@ } } - switch (sock_status) - { - case 1: - /* There's a socket, but it isn't owned by us. This is OK if - we are root. */ - if (0 != geteuid ()) - { - fprintf (stderr, "%s: Invalid socket owner\n", argv[0]); - fail (argc, argv); - } - break; + switch (sock_status) + { + case 1: + /* There's a socket, but it isn't owned by us. This is OK if + we are root. */ + if (0 != geteuid ()) + { + fprintf (stderr, "%s: Invalid socket owner\n", argv[0]); + return INVALID_SOCKET; + } + break; - case 2: - /* `stat' failed */ - if (saved_errno == ENOENT) - fprintf (stderr, - "%s: can't find socket; have you started the server?\n\ + case 2: + /* `stat' failed */ + if (saved_errno == ENOENT) + fprintf (stderr, + "%s: can't find socket; have you started the server?\n\ To start the server in Emacs, type \"M-x server-start\".\n", - argv[0]); - else - fprintf (stderr, "%s: can't stat %s: %s\n", - argv[0], server.sun_path, strerror (saved_errno)); - fail (argc, argv); - break; - } + progname); + else + fprintf (stderr, "%s: can't stat %s: %s\n", + progname, server.sun_path, strerror (saved_errno)); + return INVALID_SOCKET; + } } if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2) < 0) { - fprintf (stderr, "%s: ", argv[0]); + fprintf (stderr, "%s: ", progname); perror ("connect"); - fail (argc, argv); + return INVALID_SOCKET; } - /* We use the stream OUT to send our command to the server. */ - if ((out = fdopen (s, "r+")) == NULL) + return s; +} +#endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */ + +HSOCKET +set_socket () +{ + if (server_file) + return set_tcp_socket (); + else +#ifndef NO_SOCKETS_IN_FILE_SYSTEM + return set_local_socket (); +#else { - fprintf (stderr, "%s: ", argv[0]); - perror ("fdopen"); - fail (argc, argv); + server_file = "server"; + return set_tcp_socket (); + } +#endif +} + +int +main (argc, argv) + int argc; + char **argv; +{ + HSOCKET s; + int i, rl, needlf = 0; + char *cwd; + char string[BUFSIZ+1]; + + progname = argv[0]; + + /* Process options. */ + decode_options (argc, argv); + + if ((argc - optind < 1) && !eval) + { + fprintf (stderr, "%s: file name or argument required\n", progname); + fprintf (stderr, "Try `%s --help' for more information\n", progname); + exit (EXIT_FAILURE); } - /* We use the stream IN to read the response. - We used to use just one stream for both output and input - on the socket, but reversing direction works nonportably: - on some systems, the output appears as the first input; - on other systems it does not. */ - if ((in = fdopen (s, "r+")) == NULL) - { - fprintf (stderr, "%s: ", argv[0]); - perror ("fdopen"); - fail (argc, argv); - } + if ((s = set_socket ()) == INVALID_SOCKET) + fail (argc, argv); #ifdef HAVE_GETCWD cwd = getcwd (string, sizeof string); @@ -462,27 +698,26 @@ if (cwd == 0) { /* getwd puts message in STRING if it fails. */ - #ifdef HAVE_GETCWD - fprintf (stderr, "%s: %s (%s)\n", argv[0], + fprintf (stderr, "%s: %s (%s)\n", progname, "Cannot get current working directory", strerror (errno)); #else - fprintf (stderr, "%s: %s (%s)\n", argv[0], string, strerror (errno)); + fprintf (stderr, "%s: %s (%s)\n", progname, string, strerror (errno)); #endif fail (argc, argv); } if (nowait) - fprintf (out, "-nowait "); + SEND_STRING ("-nowait "); if (eval) - fprintf (out, "-eval "); + SEND_STRING ("-eval "); if (display) { - fprintf (out, "-display "); - quote_file_name (display, out); - fprintf (out, " "); + SEND_STRING ("-display "); + SEND_QUOTED (display); + SEND_STRING (" "); } if ((argc - optind > 0)) @@ -497,61 +732,71 @@ while (isdigit ((unsigned char) *p) || *p == ':') p++; if (*p != 0) { - quote_file_name (cwd, out); - fprintf (out, "/"); + SEND_QUOTED (cwd); + SEND_STRING ("/"); } } +#ifndef WINDOWSNT else if (*argv[i] != '/') +#else + else if ((*argv[i] != '/') + /* Absolute paths can also start with backslash + or drive letters. */ + && (*argv[i] != '\\') + && (!islower (tolower (*argv[i])) + || (argv[i][1] != ':'))) +#endif { - quote_file_name (cwd, out); - fprintf (out, "/"); + SEND_QUOTED (cwd); + SEND_STRING ("/"); } - quote_file_name (argv[i], out); - fprintf (out, " "); + SEND_QUOTED (argv[i]); + SEND_STRING (" "); } } else { - while ((str = fgets (string, BUFSIZ, stdin))) + while (fgets (string, BUFSIZ, stdin)) { - quote_file_name (str, out); + SEND_QUOTED (string); } - fprintf (out, " "); + SEND_STRING (" "); } - fprintf (out, "\n"); - fflush (out); + SEND_STRING ("\n"); /* Maybe wait for an answer. */ - if (nowait) - return EXIT_SUCCESS; - - if (!eval) + if (!nowait) { - printf ("Waiting for Emacs..."); - needlf = 2; - } - fflush (stdout); + if (!eval) + { + printf ("Waiting for Emacs..."); + needlf = 2; + } + fflush (stdout); - /* Now, wait for an answer and print any messages. */ - while ((str = fgets (string, BUFSIZ, in))) - { - if (needlf == 2) - printf ("\n"); - printf ("%s", str); - needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n'; + /* Now, wait for an answer and print any messages. */ + while ((rl = recv (s, string, BUFSIZ, 0)) > 0) + { + string[rl] = '\0'; + if (needlf == 2) + printf ("\n"); + printf ("%s", string); + needlf = string[0] == '\0' ? needlf : string[strlen (string) - 1] != '\n'; + } + + if (needlf) + printf ("\n"); + fflush (stdout); } - if (needlf) - printf ("\n"); - fflush (stdout); - + CLOSE_SOCKET (s); return EXIT_SUCCESS; } #endif /* HAVE_SOCKETS */ - + #ifndef HAVE_STRERROR char * strerror (errnum)