Add arch tagline
[emacs.git] / lib-src / emacsclient.c
blob9de812d1c73cc1f9a61886331d7e3a40dfe112c9
1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #define NO_SHORTNAMES
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
29 #ifdef WINDOWSNT
31 /* config.h defines these, which disables sockets altogether! */
32 # undef _WINSOCKAPI_
33 # undef _WINSOCK_H
35 # include <malloc.h>
36 # include <stdlib.h>
37 # include <windows.h>
38 # include <commctrl.h>
40 # define NO_SOCKETS_IN_FILE_SYSTEM
42 # define HSOCKET SOCKET
43 # define CLOSE_SOCKET closesocket
44 # define INITIALIZE() (initialize_sockets ())
46 #else /* !WINDOWSNT */
48 # include <sys/types.h>
50 # ifdef HAVE_INET_SOCKETS
51 # include <netinet/in.h>
52 # endif
54 # define INVALID_SOCKET -1
55 # define HSOCKET int
56 # define CLOSE_SOCKET close
57 # define INITIALIZE()
59 #endif /* !WINDOWSNT */
61 #undef signal
63 #include <stdarg.h>
64 #include <ctype.h>
65 #include <stdio.h>
66 #include "getopt.h"
67 #ifdef HAVE_UNISTD_H
68 #include <unistd.h>
69 #endif
71 #ifdef VMS
72 # include "vms-pwd.h"
73 #else /* not VMS */
74 #ifdef WINDOWSNT
75 # include <io.h>
76 #else /* not WINDOWSNT */
77 # include <pwd.h>
78 #endif /* not WINDOWSNT */
79 #endif /* not VMS */
80 #include <sys/stat.h>
82 #include <signal.h>
83 #include <errno.h>
86 char *getenv (), *getwd ();
87 char *(getcwd) ();
89 #ifdef WINDOWSNT
90 char *w32_getenv ();
91 #define egetenv(VAR) w32_getenv(VAR)
92 #else
93 #define egetenv(VAR) getenv(VAR)
94 #endif
96 #ifndef VERSION
97 #define VERSION "unspecified"
98 #endif
101 #ifndef EXIT_SUCCESS
102 #define EXIT_SUCCESS 0
103 #endif
105 #ifndef EXIT_FAILURE
106 #define EXIT_FAILURE 1
107 #endif
109 #ifndef FALSE
110 #define FALSE 0
111 #endif
113 #ifndef TRUE
114 #define TRUE 1
115 #endif
117 #ifndef NO_RETURN
118 #define NO_RETURN
119 #endif
121 /* Name used to invoke this program. */
122 char *progname;
124 /* The second argument to main. */
125 char **main_argv;
127 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
128 int nowait = 0;
130 /* Nonzero means args are expressions to be evaluated. --eval. */
131 int eval = 0;
133 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
134 int current_frame = 1;
136 /* Nonzero means open a new graphical frame. */
137 int window_system = 0;
139 /* The display on which Emacs should work. --display. */
140 char *display = NULL;
142 /* Nonzero means open a new Emacs frame on the current terminal. */
143 int tty = 0;
145 /* If non-NULL, the name of an editor to fallback to if the server
146 is not running. --alternate-editor. */
147 const char *alternate_editor = NULL;
149 /* If non-NULL, the filename of the UNIX socket. */
150 char *socket_name = NULL;
152 /* If non-NULL, the filename of the authentication file. */
153 char *server_file = NULL;
155 /* PID of the Emacs server process. */
156 int emacs_pid = 0;
158 void print_help_and_exit () NO_RETURN;
160 struct option longopts[] =
162 { "no-wait", no_argument, NULL, 'n' },
163 { "eval", no_argument, NULL, 'e' },
164 { "help", no_argument, NULL, 'H' },
165 { "version", no_argument, NULL, 'V' },
166 { "tty", no_argument, NULL, 't' },
167 { "create-frame", no_argument, NULL, 'c' },
168 { "alternate-editor", required_argument, NULL, 'a' },
169 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
170 { "socket-name", required_argument, NULL, 's' },
171 #endif
172 { "server-file", required_argument, NULL, 'f' },
173 { "display", required_argument, NULL, 'd' },
174 { 0, 0, 0, 0 }
178 /* Like malloc but get fatal error if memory is exhausted. */
180 long *
181 xmalloc (size)
182 unsigned int size;
184 long *result = (long *) malloc (size);
185 if (result == NULL)
187 perror ("malloc");
188 exit (EXIT_FAILURE);
190 return result;
193 /* Like strdup but get a fatal error if memory is exhausted. */
195 char *
196 xstrdup (const char *s)
198 char *result = strdup (s);
199 if (result == NULL)
201 perror ("strdup");
202 exit (EXIT_FAILURE);
204 return result;
207 /* From sysdep.c */
208 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
210 /* From lisp.h */
211 #ifndef DIRECTORY_SEP
212 #define DIRECTORY_SEP '/'
213 #endif
214 #ifndef IS_DIRECTORY_SEP
215 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
216 #endif
217 #ifndef IS_DEVICE_SEP
218 #ifndef DEVICE_SEP
219 #define IS_DEVICE_SEP(_c_) 0
220 #else
221 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
222 #endif
223 #endif
224 #ifndef IS_ANY_SEP
225 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
226 #endif
229 /* Return the current working directory. Returns NULL on errors.
230 Any other returned value must be freed with free. This is used
231 only when get_current_dir_name is not defined on the system. */
232 char*
233 get_current_dir_name ()
235 char *buf;
236 char *pwd;
237 struct stat dotstat, pwdstat;
238 /* If PWD is accurate, use it instead of calling getwd. PWD is
239 sometimes a nicer name, and using it may avoid a fatal error if a
240 parent directory is searchable but not readable. */
241 if ((pwd = egetenv ("PWD")) != 0
242 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
243 && stat (pwd, &pwdstat) == 0
244 && stat (".", &dotstat) == 0
245 && dotstat.st_ino == pwdstat.st_ino
246 && dotstat.st_dev == pwdstat.st_dev
247 #ifdef MAXPATHLEN
248 && strlen (pwd) < MAXPATHLEN
249 #endif
252 buf = (char *) xmalloc (strlen (pwd) + 1);
253 if (!buf)
254 return NULL;
255 strcpy (buf, pwd);
257 #ifdef HAVE_GETCWD
258 else
260 size_t buf_size = 1024;
261 buf = (char *) xmalloc (buf_size);
262 if (!buf)
263 return NULL;
264 for (;;)
266 if (getcwd (buf, buf_size) == buf)
267 break;
268 if (errno != ERANGE)
270 int tmp_errno = errno;
271 free (buf);
272 errno = tmp_errno;
273 return NULL;
275 buf_size *= 2;
276 buf = (char *) realloc (buf, buf_size);
277 if (!buf)
278 return NULL;
281 #else
282 else
284 /* We need MAXPATHLEN here. */
285 buf = (char *) xmalloc (MAXPATHLEN + 1);
286 if (!buf)
287 return NULL;
288 if (getwd (buf) == NULL)
290 int tmp_errno = errno;
291 free (buf);
292 errno = tmp_errno;
293 return NULL;
296 #endif
297 return buf;
299 #endif
301 #ifdef WINDOWSNT
303 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
305 /* Retrieve an environment variable from the Emacs subkeys of the registry.
306 Return NULL if the variable was not found, or it was empty.
307 This code is based on w32_get_resource (w32.c). */
308 char *
309 w32_get_resource (predefined, key, type)
310 HKEY predefined;
311 char *key;
312 LPDWORD type;
314 HKEY hrootkey = NULL;
315 char *result = NULL;
316 DWORD cbData;
318 if (RegOpenKeyEx (predefined, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
320 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS)
322 result = (char *) xmalloc (cbData);
324 if ((RegQueryValueEx (hrootkey, key, NULL, type, result, &cbData) != ERROR_SUCCESS) ||
325 (*result == 0))
327 free (result);
328 result = NULL;
332 RegCloseKey (hrootkey);
335 return result;
339 getenv wrapper for Windows
341 This is needed to duplicate Emacs's behavior, which is to look for enviroment
342 variables in the registry if they don't appear in the environment.
344 char *
345 w32_getenv (envvar)
346 char *envvar;
348 char *value;
349 DWORD dwType;
351 if (value = getenv (envvar))
352 /* Found in the environment. */
353 return value;
355 if (! (value = w32_get_resource (HKEY_CURRENT_USER, envvar, &dwType)) &&
356 ! (value = w32_get_resource (HKEY_LOCAL_MACHINE, envvar, &dwType)))
357 /* Not found in the registry. */
358 return NULL;
360 if (dwType == REG_SZ)
361 /* Registry; no need to expand. */
362 return value;
364 if (dwType == REG_EXPAND_SZ)
366 DWORD size;
368 if (size = ExpandEnvironmentStrings (value, NULL, 0))
370 char *buffer = (char *) xmalloc (size);
371 if (ExpandEnvironmentStrings (value, buffer, size))
373 /* Found and expanded. */
374 free (value);
375 return buffer;
378 /* Error expanding. */
379 free (buffer);
383 /* Not the right type, or not correctly expanded. */
384 free (value);
385 return NULL;
389 w32_window_app ()
391 static int window_app = -1;
392 char szTitle[MAX_PATH];
394 if (window_app < 0)
396 /* Checking for STDOUT does not work; it's a valid handle also in
397 nonconsole apps. Testing for the console title seems to work. */
398 window_app = (GetConsoleTitleA (szTitle, MAX_PATH) == 0);
399 if (window_app)
400 InitCommonControls();
403 return window_app;
407 execvp wrapper for Windows. Quotes arguments with embedded spaces.
409 This is necessary due to the broken implementation of exec* routines in
410 the Microsoft libraries: they concatenate the arguments together without
411 quoting special characters, and pass the result to CreateProcess, with
412 predictably bad results. By contrast, Posix execvp passes the arguments
413 directly into the argv array of the child process.
416 w32_execvp (path, argv)
417 char *path;
418 char **argv;
420 int i;
422 /* Required to allow a .BAT script as alternate editor. */
423 argv[0] = (char *) alternate_editor;
425 for (i = 0; argv[i]; i++)
426 if (strchr (argv[i], ' '))
428 char *quoted = alloca (strlen (argv[i]) + 3);
429 sprintf (quoted, "\"%s\"", argv[i]);
430 argv[i] = quoted;
433 return execvp (path, argv);
436 #undef execvp
437 #define execvp w32_execvp
439 #endif /* WINDOWSNT */
441 /* Display a normal or error message.
442 On Windows, use a message box if compiled as a Windows app. */
443 void
444 message (int is_error, char *message, ...)
446 char msg [2048];
447 va_list args;
449 va_start (args, message);
450 vsprintf (msg, message, args);
451 va_end (args);
453 #ifdef WINDOWSNT
454 if (w32_window_app ())
456 if (is_error)
457 MessageBox (NULL, msg, "Emacsclient ERROR", MB_ICONERROR);
458 else
459 MessageBox (NULL, msg, "Emacsclient", MB_ICONINFORMATION);
461 else
462 #endif
464 FILE *f = is_error ? stderr : stdout;
466 fputs (msg, f);
467 fflush (f);
471 /* Decode the options from argv and argc.
472 The global variable `optind' will say how many arguments we used up. */
474 void
475 decode_options (argc, argv)
476 int argc;
477 char **argv;
479 alternate_editor = egetenv ("ALTERNATE_EDITOR");
480 display = egetenv ("DISPLAY");
481 if (display && strlen (display) == 0)
482 display = NULL;
484 while (1)
486 int opt = getopt_long (argc, argv,
487 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
488 "VHnea:s:f:d:tc",
489 #else
490 "VHnea:f:d:tc",
491 #endif
492 longopts, 0);
494 if (opt == EOF)
495 break;
497 switch (opt)
499 case 0:
500 /* If getopt returns 0, then it has already processed a
501 long-named option. We should do nothing. */
502 break;
504 case 'a':
505 alternate_editor = optarg;
506 break;
508 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
509 case 's':
510 socket_name = optarg;
511 break;
512 #endif
514 case 'f':
515 server_file = optarg;
516 break;
518 case 'd':
519 display = optarg;
520 break;
522 case 'n':
523 nowait = 1;
524 break;
526 case 'e':
527 eval = 1;
528 break;
530 case 'V':
531 message (FALSE, "emacsclient %s\n", VERSION);
532 exit (EXIT_SUCCESS);
533 break;
535 case 't':
536 tty = 1;
537 current_frame = 0;
538 break;
540 case 'c':
541 current_frame = 0;
542 break;
544 case 'H':
545 print_help_and_exit ();
546 break;
548 default:
549 message (TRUE, "Try `%s --help' for more information\n", progname);
550 exit (EXIT_FAILURE);
551 break;
555 if (!tty && display)
556 window_system = 1;
557 #if !defined (WINDOWSNT) && !defined (HAVE_CARBON)
558 else
559 tty = 1;
560 #endif
562 /* --no-wait implies --current-frame on ttys when there are file
563 arguments or expressions given. */
564 if (nowait && tty && argc - optind > 0)
565 current_frame = 1;
567 if (current_frame)
569 tty = 0;
570 window_system = 0;
573 if (tty)
574 window_system = 0;
578 void
579 print_help_and_exit ()
581 /* Spaces and tabs are significant in this message; they're chosen so the
582 message aligns properly both in a tty and in a Windows message box.
583 Please try to preserve them; otherwise the output is very hard to read
584 when using emacsclientw. */
585 message (FALSE,
586 "Usage: %s [OPTIONS] FILE...\n\
587 Tell the Emacs server to visit the specified files.\n\
588 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
590 The following OPTIONS are accepted:\n\
591 -V, --version Just print version info and return\n\
592 -H, --help Print this usage information message\n\
593 -t, --tty Open a new Emacs frame on the current terminal\n\
594 -c, --create-frame Create a new frame instead of trying to\n\
595 use the current Emacs frame\n\
596 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
597 -n, --no-wait Don't wait for the server to return\n\
598 -d, --display=DISPLAY Visit the file in the given display\n"
599 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
600 "-s, --socket-name=FILENAME\n\
601 Set filename of the UNIX socket for communication\n"
602 #endif
603 "-f, --server-file=FILENAME\n\
604 Set filename of the TCP authentication file\n\
605 -a, --alternate-editor=EDITOR\n\
606 Editor to fallback to if the server is not running\n\
608 Report bugs to bug-gnu-emacs@gnu.org.\n", progname);
609 exit (EXIT_SUCCESS);
613 Try to run a different command, or --if no alternate editor is
614 defined-- exit with an errorcode.
615 Uses argv, but gets it from the global variable main_argv.
617 void
618 fail (void)
620 if (alternate_editor)
622 int i = optind - 1;
624 execvp (alternate_editor, main_argv + i);
625 message (TRUE, "%s: error executing alternate editor \"%s\"\n",
626 progname, alternate_editor);
628 exit (EXIT_FAILURE);
632 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
635 main (argc, argv)
636 int argc;
637 char **argv;
639 main_argv = argv;
640 progname = argv[0];
641 message (TRUE, "%s: Sorry, the Emacs server is supported only\n"
642 "on systems with Berkeley sockets.\n",
643 argv[0]);
644 fail ();
647 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
649 #ifdef WINDOWSNT
650 # include <winsock2.h>
651 #else
652 # include <sys/types.h>
653 # include <sys/socket.h>
654 # include <sys/un.h>
655 #endif
657 #define AUTH_KEY_LENGTH 64
658 #define SEND_BUFFER_SIZE 4096
660 extern char *strerror ();
661 extern int errno;
663 /* Buffer to accumulate data to send in TCP connections. */
664 char send_buffer[SEND_BUFFER_SIZE + 1];
665 int sblen = 0; /* Fill pointer for the send buffer. */
666 /* Socket used to communicate with the Emacs server process. */
667 HSOCKET emacs_socket = 0;
669 /* On Windows, the socket library was historically separate from the standard
670 C library, so errors are handled differently. */
671 void
672 sock_err_message (function_name)
673 char *function_name;
675 #ifdef WINDOWSNT
676 char* msg = NULL;
678 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
679 | FORMAT_MESSAGE_ALLOCATE_BUFFER
680 | FORMAT_MESSAGE_ARGUMENT_ARRAY,
681 NULL, WSAGetLastError (), 0, (LPTSTR)&msg, 0, NULL);
683 message (TRUE, "%s: %s: %s\n", progname, function_name, msg);
685 LocalFree (msg);
686 #else
687 message (TRUE, "%s: %s: %s\n", progname, function_name, strerror (errno));
688 #endif
692 /* Let's send the data to Emacs when either
693 - the data ends in "\n", or
694 - the buffer is full (but this shouldn't happen)
695 Otherwise, we just accumulate it. */
696 void
697 send_to_emacs (s, data)
698 HSOCKET s;
699 char *data;
701 while (data)
703 int dlen = strlen (data);
704 if (dlen + sblen >= SEND_BUFFER_SIZE)
706 int part = SEND_BUFFER_SIZE - sblen;
707 strncpy (&send_buffer[sblen], data, part);
708 data += part;
709 sblen = SEND_BUFFER_SIZE;
711 else if (dlen)
713 strcpy (&send_buffer[sblen], data);
714 data = NULL;
715 sblen += dlen;
717 else
718 break;
720 if (sblen == SEND_BUFFER_SIZE
721 || (sblen > 0 && send_buffer[sblen-1] == '\n'))
723 int sent = send (s, send_buffer, sblen, 0);
724 if (sent != sblen)
725 strcpy (send_buffer, &send_buffer[sent]);
726 sblen -= sent;
732 /* In STR, insert a & before each &, each space, each newline, and
733 any initial -. Change spaces to underscores, too, so that the
734 return value never contains a space.
736 Does not change the string. Outputs the result to STREAM. */
737 void
738 quote_argument (s, str)
739 HSOCKET s;
740 char *str;
742 char *copy = (char *) xmalloc (strlen (str) * 2 + 1);
743 char *p, *q;
745 p = str;
746 q = copy;
747 while (*p)
749 if (*p == ' ')
751 *q++ = '&';
752 *q++ = '_';
753 p++;
755 else if (*p == '\n')
757 *q++ = '&';
758 *q++ = 'n';
759 p++;
761 else
763 if (*p == '&' || (*p == '-' && p == str))
764 *q++ = '&';
765 *q++ = *p++;
768 *q++ = 0;
770 send_to_emacs (s, copy);
772 free (copy);
776 /* The inverse of quote_argument. Removes quoting in string STR by
777 modifying the string in place. Returns STR. */
779 char *
780 unquote_argument (str)
781 char *str;
783 char *p, *q;
785 if (! str)
786 return str;
788 p = str;
789 q = str;
790 while (*p)
792 if (*p == '&')
794 p++;
795 if (*p == '&')
796 *p = '&';
797 else if (*p == '_')
798 *p = ' ';
799 else if (*p == 'n')
800 *p = '\n';
801 else if (*p == '-')
802 *p = '-';
804 *q++ = *p++;
806 *q = 0;
807 return str;
812 file_name_absolute_p (filename)
813 const unsigned char *filename;
815 /* Sanity check, it shouldn't happen. */
816 if (! filename) return FALSE;
818 /* /xxx is always an absolute path. */
819 if (filename[0] == '/') return TRUE;
821 /* Empty filenames (which shouldn't happen) are relative. */
822 if (filename[0] == '\0') return FALSE;
824 #ifdef WINDOWSNT
825 /* X:\xxx is always absolute. */
826 if (isalpha (filename[0])
827 && filename[1] == ':' && (filename[2] == '\\' || filename[2] == '/'))
828 return TRUE;
830 /* Both \xxx and \\xxx\yyy are absolute. */
831 if (filename[0] == '\\') return TRUE;
834 FIXME: There's a corner case not dealt with, "x:y", where:
836 1) x is a valid drive designation (usually a letter in the A-Z range)
837 and y is a path, relative to the current directory on drive x. This
838 is absolute, *after* fixing the y part to include the current
839 directory in x.
841 2) x is a relative file name, and y is an NTFS stream name. This is a
842 correct relative path, but it is very unusual.
844 The trouble is that first case items are also valid examples of the
845 second case, i.e., "c:test" can be understood as drive:path or as
846 file:stream.
848 The "right" fix would involve checking whether
849 - the current drive/partition is NTFS,
850 - x is a valid (and accesible) drive designator,
851 - x:y already exists as a file:stream in the current directory,
852 - y already exists on the current directory of drive x,
853 - the auspices are favorable,
854 and then taking an "informed decision" based on the above.
856 Whatever the result, Emacs currently does a very bad job of dealing
857 with NTFS file:streams: it cannot visit them, and the only way to
858 create one is by setting `buffer-file-name' to point to it (either
859 manually or with emacsclient). So perhaps resorting to 1) and ignoring
860 2) for now is the right thing to do.
862 Anyway, something to decide After the Release.
864 #endif
866 return FALSE;
869 #ifdef WINDOWSNT
870 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
871 void
872 __cdecl close_winsock ()
874 WSACleanup ();
877 /* Initialize the WinSock2 library. */
878 void
879 initialize_sockets ()
881 WSADATA wsaData;
883 if (WSAStartup (MAKEWORD (2, 0), &wsaData))
885 message (TRUE, "%s: error initializing WinSock2", progname);
886 exit (EXIT_FAILURE);
889 atexit (close_winsock);
891 #endif /* WINDOWSNT */
895 * Read the information needed to set up a TCP comm channel with
896 * the Emacs server: host, port, pid and authentication string.
899 get_server_config (server, authentication)
900 struct sockaddr_in *server;
901 char *authentication;
903 char dotted[32];
904 char *port;
905 char *pid;
906 FILE *config = NULL;
908 if (file_name_absolute_p (server_file))
909 config = fopen (server_file, "rb");
910 else
912 char *home = egetenv ("HOME");
914 if (home)
916 char *path = alloca (32 + strlen (home) + strlen (server_file));
917 sprintf (path, "%s/.emacs.d/server/%s", home, server_file);
918 config = fopen (path, "rb");
920 #ifdef WINDOWSNT
921 if (!config && (home = egetenv ("APPDATA")))
923 char *path = alloca (32 + strlen (home) + strlen (server_file));
924 sprintf (path, "%s/.emacs.d/server/%s", home, server_file);
925 config = fopen (path, "rb");
927 #endif
930 if (! config)
931 return FALSE;
933 if (fgets (dotted, sizeof dotted, config)
934 && (port = strchr (dotted, ':'))
935 && (pid = strchr (port, ' ')))
937 *port++ = '\0';
938 *pid++ = '\0';
940 else
942 message (TRUE, "%s: invalid configuration info", progname);
943 exit (EXIT_FAILURE);
946 server->sin_family = AF_INET;
947 server->sin_addr.s_addr = inet_addr (dotted);
948 server->sin_port = htons (atoi (port));
950 if (! fread (authentication, AUTH_KEY_LENGTH, 1, config))
952 message (TRUE, "%s: cannot read authentication info", progname);
953 exit (EXIT_FAILURE);
956 fclose (config);
958 emacs_pid = atoi (pid);
960 return TRUE;
963 HSOCKET
964 set_tcp_socket ()
966 HSOCKET s;
967 struct sockaddr_in server;
968 struct linger l_arg = {1, 1};
969 char auth_string[AUTH_KEY_LENGTH + 1];
971 if (! get_server_config (&server, auth_string))
972 return INVALID_SOCKET;
974 if (server.sin_addr.s_addr != inet_addr ("127.0.0.1"))
975 message (FALSE, "%s: connected to remote socket at %s\n",
976 progname, inet_ntoa (server.sin_addr));
979 * Open up an AF_INET socket
981 if ((s = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0)
983 sock_err_message ("socket");
984 return INVALID_SOCKET;
988 * Set up the socket
990 if (connect (s, (struct sockaddr *) &server, sizeof server) < 0)
992 sock_err_message ("connect");
993 return INVALID_SOCKET;
996 setsockopt (s, SOL_SOCKET, SO_LINGER, (char *) &l_arg, sizeof l_arg);
999 * Send the authentication
1001 auth_string[AUTH_KEY_LENGTH] = '\0';
1003 send_to_emacs (s, "-auth ");
1004 send_to_emacs (s, auth_string);
1005 send_to_emacs (s, "\n");
1007 return s;
1011 /* Returns 1 if PREFIX is a prefix of STRING. */
1012 static int
1013 strprefix (char *prefix, char *string)
1015 return !strncmp (prefix, string, strlen (prefix));
1019 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1021 /* Three possibilities:
1022 2 - can't be `stat'ed (sets errno)
1023 1 - isn't owned by us
1024 0 - success: none of the above */
1026 static int
1027 socket_status (socket_name)
1028 char *socket_name;
1030 struct stat statbfr;
1032 if (stat (socket_name, &statbfr) == -1)
1033 return 2;
1035 if (statbfr.st_uid != geteuid ())
1036 return 1;
1038 return 0;
1042 /* A signal handler that passes the signal to the Emacs process.
1043 Useful for SIGWINCH. */
1045 SIGTYPE
1046 pass_signal_to_emacs (int signalnum)
1048 int old_errno = errno;
1050 if (emacs_pid)
1051 kill (emacs_pid, signalnum);
1053 signal (signalnum, pass_signal_to_emacs);
1054 errno = old_errno;
1057 /* Signal handler for SIGCONT; notify the Emacs process that it can
1058 now resume our tty frame. */
1060 SIGTYPE
1061 handle_sigcont (int signalnum)
1063 int old_errno = errno;
1065 if (tcgetpgrp (1) == getpgrp ())
1067 /* We are in the foreground. */
1068 send_to_emacs (emacs_socket, "-resume \n");
1070 else
1072 /* We are in the background; cancel the continue. */
1073 kill (getpid (), SIGSTOP);
1076 signal (signalnum, handle_sigcont);
1077 errno = old_errno;
1080 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1081 going to sleep. Normally the suspend is initiated by Emacs via
1082 server-handle-suspend-tty, but if the server gets out of sync with
1083 reality, we may get a SIGTSTP on C-z. Handling this signal and
1084 notifying Emacs about it should get things under control again. */
1086 SIGTYPE
1087 handle_sigtstp (int signalnum)
1089 int old_errno = errno;
1090 sigset_t set;
1092 if (emacs_socket)
1093 send_to_emacs (emacs_socket, "-suspend \n");
1095 /* Unblock this signal and call the default handler by temprarily
1096 changing the handler and resignalling. */
1097 sigprocmask (SIG_BLOCK, NULL, &set);
1098 sigdelset (&set, signalnum);
1099 signal (signalnum, SIG_DFL);
1100 kill (getpid (), signalnum);
1101 sigprocmask (SIG_SETMASK, &set, NULL); /* Let's the above signal through. */
1102 signal (signalnum, handle_sigtstp);
1104 errno = old_errno;
1106 /* Set up signal handlers before opening a frame on the current tty. */
1108 void
1109 init_signals (void)
1111 /* Set up signal handlers. */
1112 signal (SIGWINCH, pass_signal_to_emacs);
1114 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1115 deciding which terminal the signal came from. C-g is now a
1116 normal input event on secondary terminals. */
1117 #if 0
1118 signal (SIGINT, pass_signal_to_emacs);
1119 signal (SIGQUIT, pass_signal_to_emacs);
1120 #endif
1122 signal (SIGCONT, handle_sigcont);
1123 signal (SIGTSTP, handle_sigtstp);
1124 signal (SIGTTOU, handle_sigtstp);
1128 HSOCKET
1129 set_local_socket ()
1131 HSOCKET s;
1132 struct sockaddr_un server;
1135 * Open up an AF_UNIX socket in this person's home directory
1138 if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1140 message (TRUE, "%s: socket: %s\n", progname, strerror (errno));
1141 return INVALID_SOCKET;
1144 server.sun_family = AF_UNIX;
1147 int sock_status = 0;
1148 int default_sock = !socket_name;
1149 int saved_errno = 0;
1150 char *server_name = "server";
1152 if (socket_name && !index (socket_name, '/') && !index (socket_name, '\\'))
1153 { /* socket_name is a file name component. */
1154 server_name = socket_name;
1155 socket_name = NULL;
1156 default_sock = 1; /* Try both UIDs. */
1159 if (default_sock)
1161 socket_name = alloca (100 + strlen (server_name));
1162 sprintf (socket_name, "/tmp/emacs%d/%s",
1163 (int) geteuid (), server_name);
1166 if (strlen (socket_name) < sizeof (server.sun_path))
1167 strcpy (server.sun_path, socket_name);
1168 else
1170 message (TRUE, "%s: socket-name %s too long",
1171 progname, socket_name);
1172 fail ();
1175 /* See if the socket exists, and if it's owned by us. */
1176 sock_status = socket_status (server.sun_path);
1177 saved_errno = errno;
1178 if (sock_status && default_sock)
1180 /* Failing that, see if LOGNAME or USER exist and differ from
1181 our euid. If so, look for a socket based on the UID
1182 associated with the name. This is reminiscent of the logic
1183 that init_editfns uses to set the global Vuser_full_name. */
1185 char *user_name = (char *) egetenv ("LOGNAME");
1187 if (!user_name)
1188 user_name = (char *) egetenv ("USER");
1190 if (user_name)
1192 struct passwd *pw = getpwnam (user_name);
1194 if (pw && (pw->pw_uid != geteuid ()))
1196 /* We're running under su, apparently. */
1197 socket_name = alloca (100 + strlen (server_name));
1198 sprintf (socket_name, "/tmp/emacs%d/%s",
1199 (int) pw->pw_uid, server_name);
1201 if (strlen (socket_name) < sizeof (server.sun_path))
1202 strcpy (server.sun_path, socket_name);
1203 else
1205 message (TRUE, "%s: socket-name %s too long",
1206 progname, socket_name);
1207 exit (EXIT_FAILURE);
1210 sock_status = socket_status (server.sun_path);
1211 saved_errno = errno;
1213 else
1214 errno = saved_errno;
1218 switch (sock_status)
1220 case 1:
1221 /* There's a socket, but it isn't owned by us. This is OK if
1222 we are root. */
1223 if (0 != geteuid ())
1225 message (TRUE, "%s: Invalid socket owner\n", progname);
1226 return INVALID_SOCKET;
1228 break;
1230 case 2:
1231 /* `stat' failed */
1232 if (saved_errno == ENOENT)
1233 message (TRUE,
1234 "%s: can't find socket; have you started the server?\n\
1235 To start the server in Emacs, type \"M-x server-start\".\n",
1236 progname);
1237 else
1238 message (TRUE, "%s: can't stat %s: %s\n",
1239 progname, server.sun_path, strerror (saved_errno));
1240 return INVALID_SOCKET;
1244 if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
1245 < 0)
1247 message (TRUE, "%s: connect: %s\n", progname, strerror (errno));
1248 return INVALID_SOCKET;
1251 return s;
1253 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1255 HSOCKET
1256 set_socket ()
1258 HSOCKET s;
1260 INITIALIZE ();
1262 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1263 /* Explicit --socket-name argument. */
1264 if (socket_name)
1266 s = set_local_socket ();
1267 if ((s != INVALID_SOCKET) || alternate_editor)
1268 return s;
1269 message (TRUE, "%s: error accessing socket \"%s\"",
1270 progname, socket_name);
1271 exit (EXIT_FAILURE);
1273 #endif
1275 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1276 if (!server_file)
1277 server_file = egetenv ("EMACS_SERVER_FILE");
1279 if (server_file)
1281 s = set_tcp_socket ();
1282 if ((s != INVALID_SOCKET) || alternate_editor)
1283 return s;
1285 message (TRUE, "%s: error accessing server file \"%s\"",
1286 progname, server_file);
1287 exit (EXIT_FAILURE);
1290 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1291 /* Implicit local socket. */
1292 s = set_local_socket ();
1293 if (s != INVALID_SOCKET)
1294 return s;
1295 #endif
1297 /* Implicit server file. */
1298 server_file = "server";
1299 s = set_tcp_socket ();
1300 if ((s != INVALID_SOCKET) || alternate_editor)
1301 return s;
1303 /* No implicit or explicit socket, and no alternate editor. */
1304 message (TRUE, "%s: No socket or alternate editor. Please use:\n\n"
1305 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1306 "\t--socket-name\n"
1307 #endif
1308 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1309 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1310 progname);
1311 exit (EXIT_FAILURE);
1314 #ifdef WINDOWSNT
1315 FARPROC set_fg; /* Pointer to AllowSetForegroundWindow. */
1316 FARPROC get_wc; /* Pointer to RealGetWindowClassA. */
1318 BOOL CALLBACK
1319 w32_find_emacs_process (hWnd, lParam)
1320 HWND hWnd;
1321 LPARAM lParam;
1323 DWORD pid;
1324 char class[6];
1326 /* Reject any window not of class "Emacs". */
1327 if (! get_wc (hWnd, class, sizeof (class))
1328 || strcmp (class, "Emacs"))
1329 return TRUE;
1331 /* We only need the process id, not the thread id. */
1332 (void) GetWindowThreadProcessId (hWnd, &pid);
1334 /* Not the one we're looking for. */
1335 if (pid != (DWORD) emacs_pid) return TRUE;
1337 /* OK, let's raise it. */
1338 set_fg (emacs_pid);
1340 /* Stop enumeration. */
1341 return FALSE;
1345 * Search for a window of class "Emacs" and owned by a process with
1346 * process id = emacs_pid. If found, allow it to grab the focus.
1348 void
1349 w32_give_focus ()
1351 HMODULE hUser32;
1353 /* It shouldn't happen when dealing with TCP sockets. */
1354 if (!emacs_pid) return;
1356 if (!(hUser32 = LoadLibrary ("user32.dll"))) return;
1358 /* Modern Windows restrict which processes can set the foreground window.
1359 emacsclient can allow Emacs to grab the focus by calling the function
1360 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1361 NT) lack this function, so we have to check its availability. */
1362 if ((set_fg = GetProcAddress (hUser32, "AllowSetForegroundWindow"))
1363 && (get_wc = GetProcAddress (hUser32, "RealGetWindowClassA")))
1364 EnumWindows (w32_find_emacs_process, (LPARAM) 0);
1366 FreeLibrary (hUser32);
1368 #endif
1371 main (argc, argv)
1372 int argc;
1373 char **argv;
1375 int i, rl, needlf = 0;
1376 char *cwd, *str;
1377 char string[BUFSIZ+1];
1379 main_argv = argv;
1380 progname = argv[0];
1382 /* Process options. */
1383 decode_options (argc, argv);
1385 if ((argc - optind < 1) && !eval && !tty && !window_system)
1387 message (TRUE, "%s: file name or argument required\n"
1388 "Try `%s --help' for more information\n",
1389 progname, progname);
1390 exit (EXIT_FAILURE);
1393 if ((emacs_socket = set_socket ()) == INVALID_SOCKET)
1394 fail ();
1397 cwd = get_current_dir_name ();
1398 if (cwd == 0)
1400 /* getwd puts message in STRING if it fails. */
1401 message (TRUE, "%s: %s\n", progname,
1402 "Cannot get current working directory");
1403 fail ();
1406 #ifdef WINDOWSNT
1407 w32_give_focus ();
1408 #endif
1410 /* Send over our environment. */
1411 if (!current_frame)
1413 extern char **environ;
1414 int i;
1415 for (i = 0; environ[i]; i++)
1417 char *name = xstrdup (environ[i]);
1418 char *value = strchr (name, '=');
1419 send_to_emacs (emacs_socket, "-env ");
1420 quote_argument (emacs_socket, environ[i]);
1421 send_to_emacs (emacs_socket, " ");
1425 /* Send over our current directory. */
1426 if (!current_frame)
1428 send_to_emacs (emacs_socket, "-dir ");
1429 quote_argument (emacs_socket, cwd);
1430 send_to_emacs (emacs_socket, "/");
1431 send_to_emacs (emacs_socket, " ");
1434 retry:
1435 if (nowait)
1436 send_to_emacs (emacs_socket, "-nowait ");
1438 if (current_frame)
1439 send_to_emacs (emacs_socket, "-current-frame ");
1441 if (display)
1443 send_to_emacs (emacs_socket, "-display ");
1444 quote_argument (emacs_socket, display);
1445 send_to_emacs (emacs_socket, " ");
1448 if (tty)
1450 char *type = egetenv ("TERM");
1451 char *tty_name = NULL;
1452 #ifndef WINDOWSNT
1453 tty_name = ttyname (fileno (stdin));
1454 #endif
1456 if (! tty_name)
1458 message (TRUE, "%s: could not get terminal name\n", progname);
1459 fail ();
1462 if (! type)
1464 message (TRUE, "%s: please set the TERM variable to your terminal type\n",
1465 progname);
1466 fail ();
1469 if (! strcmp (type, "eterm"))
1471 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1472 message (TRUE, "%s: opening a frame in an Emacs term buffer"
1473 " is not supported\n", progname);
1474 fail ();
1476 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1477 init_signals ();
1478 #endif
1480 send_to_emacs (emacs_socket, "-tty ");
1481 quote_argument (emacs_socket, tty_name);
1482 send_to_emacs (emacs_socket, " ");
1483 quote_argument (emacs_socket, type);
1484 send_to_emacs (emacs_socket, " ");
1487 if (window_system)
1488 send_to_emacs (emacs_socket, "-window-system ");
1490 if ((argc - optind > 0))
1492 for (i = optind; i < argc; i++)
1494 int relative = 0;
1496 if (eval)
1498 /* Don't prepend cwd or anything like that. */
1499 send_to_emacs (emacs_socket, "-eval ");
1500 quote_argument (emacs_socket, argv[i]);
1501 send_to_emacs (emacs_socket, " ");
1502 continue;
1505 if (*argv[i] == '+')
1507 char *p = argv[i] + 1;
1508 while (isdigit ((unsigned char) *p) || *p == ':') p++;
1509 if (*p == 0)
1511 send_to_emacs (emacs_socket, "-position ");
1512 quote_argument (emacs_socket, argv[i]);
1513 send_to_emacs (emacs_socket, " ");
1514 continue;
1516 else
1517 relative = 1;
1519 else if (! file_name_absolute_p (argv[i]))
1520 relative = 1;
1522 send_to_emacs (emacs_socket, "-file ");
1523 if (relative)
1525 quote_argument (emacs_socket, cwd);
1526 send_to_emacs (emacs_socket, "/");
1528 quote_argument (emacs_socket, argv[i]);
1529 send_to_emacs (emacs_socket, " ");
1532 else
1534 if (!tty && !window_system)
1536 while ((str = fgets (string, BUFSIZ, stdin)))
1538 if (eval)
1539 send_to_emacs (emacs_socket, "-eval ");
1540 else
1541 send_to_emacs (emacs_socket, "-file ");
1542 quote_argument (emacs_socket, str);
1544 send_to_emacs (emacs_socket, " ");
1548 send_to_emacs (emacs_socket, "\n");
1550 /* Wait for an answer. */
1551 if (!eval && !tty && !nowait)
1553 printf ("Waiting for Emacs...");
1554 needlf = 2;
1556 fflush (stdout);
1557 fsync (1);
1559 /* Now, wait for an answer and print any messages. */
1560 while ((rl = recv (emacs_socket, string, BUFSIZ, 0)) > 0)
1562 char *p;
1563 string[rl] = '\0';
1565 p = string + strlen (string) - 1;
1566 while (p > string && *p == '\n')
1567 *p-- = 0;
1569 if (strprefix ("-emacs-pid ", string))
1571 /* -emacs-pid PID: The process id of the Emacs process. */
1572 emacs_pid = strtol (string + strlen ("-emacs-pid"), NULL, 10);
1574 else if (strprefix ("-window-system-unsupported ", string))
1576 /* -window-system-unsupported: Emacs was compiled without X
1577 support. Try again on the terminal. */
1578 window_system = 0;
1579 nowait = 0;
1580 tty = 1;
1581 goto retry;
1583 else if (strprefix ("-print ", string))
1585 /* -print STRING: Print STRING on the terminal. */
1586 str = unquote_argument (string + strlen ("-print "));
1587 if (needlf)
1588 printf ("\n");
1589 printf ("%s", str);
1590 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
1592 else if (strprefix ("-error ", string))
1594 /* -error DESCRIPTION: Signal an error on the terminal. */
1595 str = unquote_argument (string + strlen ("-error "));
1596 if (needlf)
1597 printf ("\n");
1598 fprintf (stderr, "*ERROR*: %s", str);
1599 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
1601 #ifdef SIGSTOP
1602 else if (strprefix ("-suspend ", string))
1604 /* -suspend: Suspend this terminal, i.e., stop the process. */
1605 if (needlf)
1606 printf ("\n");
1607 needlf = 0;
1608 kill (0, SIGSTOP);
1610 #endif
1611 else
1613 /* Unknown command. */
1614 if (needlf)
1615 printf ("\n");
1616 printf ("*ERROR*: Unknown message: %s", string);
1617 needlf = string[0] == '\0' ? needlf : string[strlen (string) - 1] != '\n';
1621 if (needlf)
1622 printf ("\n");
1623 fflush (stdout);
1624 fsync (1);
1626 CLOSE_SOCKET (emacs_socket);
1627 return EXIT_SUCCESS;
1630 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1633 #ifndef HAVE_STRERROR
1634 char *
1635 strerror (errnum)
1636 int errnum;
1638 extern char *sys_errlist[];
1639 extern int sys_nerr;
1641 if (errnum >= 0 && errnum < sys_nerr)
1642 return sys_errlist[errnum];
1643 return (char *) "Unknown error";
1646 #endif /* ! HAVE_STRERROR */
1648 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1649 (do not change this comment) */
1651 /* emacsclient.c ends here */