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 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 2, or (at your option)
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. */
31 /* config.h defines these, which disables sockets altogether! */
39 # define NO_SOCKETS_IN_FILE_SYSTEM
41 # define HSOCKET SOCKET
42 # define CLOSE_SOCKET closesocket
43 # define INITIALIZE() (initialize_sockets ())
45 #else /* !WINDOWSNT */
47 # include <sys/types.h>
49 # ifdef HAVE_INET_SOCKETS
50 # include <netinet/in.h>
53 # define INVALID_SOCKET -1
55 # define CLOSE_SOCKET close
58 #endif /* !WINDOWSNT */
75 #else /* not WINDOWSNT */
77 #endif /* not WINDOWSNT */
80 char *getenv (), *getwd ();
84 #define VERSION "unspecified"
87 #define SEND_STRING(data) (send_to_emacs (s, (data)))
88 #define SEND_QUOTED(data) (quote_file_name (s, (data)))
91 #define EXIT_SUCCESS 0
95 #define EXIT_FAILURE 1
110 /* Name used to invoke this program. */
113 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
116 /* Nonzero means args are expressions to be evaluated. --eval. */
119 /* The display on which Emacs should work. --display. */
120 char *display
= NULL
;
122 /* If non-NULL, the name of an editor to fallback to if the server
123 is not running. --alternate-editor. */
124 const char *alternate_editor
= NULL
;
126 /* If non-NULL, the filename of the UNIX socket. */
127 char *socket_name
= NULL
;
129 /* If non-NULL, the filename of the authentication file. */
130 char *server_file
= NULL
;
132 /* PID of the Emacs server process. */
135 void print_help_and_exit () NO_RETURN
;
137 struct option longopts
[] =
139 { "no-wait", no_argument
, NULL
, 'n' },
140 { "eval", no_argument
, NULL
, 'e' },
141 { "help", no_argument
, NULL
, 'H' },
142 { "version", no_argument
, NULL
, 'V' },
143 { "alternate-editor", required_argument
, NULL
, 'a' },
144 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
145 { "socket-name", required_argument
, NULL
, 's' },
147 { "server-file", required_argument
, NULL
, 'f' },
148 { "display", required_argument
, NULL
, 'd' },
152 /* Message functions. */
155 /* I first tried to check for STDOUT. The check did not work,
156 I get a valid handle also in nonconsole apps.
157 Instead I test for console title, which seems to work. */
161 static int window_app
= -1;
162 char szTitle
[MAX_PATH
];
165 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
172 message (int is_error
, char *message
, ...)
177 va_start (args
, message
);
178 vsprintf (msg
, message
, args
);
182 if (w32_window_app ())
185 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
187 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
192 FILE *f
= is_error
? stderr
: stdout
;
199 /* Decode the options from argv and argc.
200 The global variable `optind' will say how many arguments we used up. */
203 decode_options (argc
, argv
)
207 alternate_editor
= getenv ("ALTERNATE_EDITOR");
211 int opt
= getopt_long (argc
, argv
,
212 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
225 /* If getopt returns 0, then it has already processed a
226 long-named option. We should do nothing. */
230 alternate_editor
= optarg
;
233 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
235 socket_name
= optarg
;
240 server_file
= optarg
;
256 message (FALSE
, "emacsclient %s\n", VERSION
);
261 print_help_and_exit ();
265 message (TRUE
, "Try `%s --help' for more information\n", progname
);
273 print_help_and_exit ()
276 "Usage: %s [OPTIONS] FILE...\n\
277 Tell the Emacs server to visit the specified files.\n\
278 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
280 The following OPTIONS are accepted:\n\
282 -V, --version Just print version info and return\n\
283 -H, --help Print this usage information message\n\
284 -e, --eval Evaluate FILE arguments as Lisp expressions\n\
285 -n, --no-wait Don't wait for the server to return\n\
286 -d, --display=DISPLAY Visit the file in the given display\n"
287 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
288 "-s, --socket-name=FILENAME\n\
289 Set filename of the UNIX socket for communication\n"
291 "-f, --server-file=FILENAME\n\
292 Set filename of the TCP authentication file\n\
293 -a, --alternate-editor=EDITOR\n\
294 Editor to fallback to if server is not running\n\
296 Report bugs to bug-gnu-emacs@gnu.org.\n", progname
);
304 execvp() wrapper for Windows. Quotes arguments with embedded spaces.
306 This is necessary due to the broken implementation of exec* routines in
307 the Microsoft libraries: they concatenate the arguments together without
308 quoting special characters, and pass the result to CreateProcess, with
309 predictably bad results. By contrast, Posix execvp passes the arguments
310 directly into the argv[] array of the child process.
313 w32_execvp (path
, argv
)
319 argv
[0] = (char *) alternate_editor
;
321 for (i
= 0; argv
[i
]; i
++)
322 if (strchr (argv
[i
], ' '))
324 char *quoted
= alloca (strlen (argv
[i
]) + 3);
325 sprintf (quoted
, "\"%s\"", argv
[i
]);
329 return execvp (path
, argv
);
333 #define execvp w32_execvp
335 #endif /* WINDOWSNT */
338 Try to run a different command, or --if no alternate editor is
339 defined-- exit with an errorcode.
346 if (alternate_editor
)
350 execvp (alternate_editor
, argv
+ i
);
351 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
352 progname
, alternate_editor
);
358 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
365 message (TRUE
, "%s: Sorry, the Emacs server is supported only\non systems with Berkely sockets.\n",
371 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
374 # include <winsock2.h>
376 # include <sys/types.h>
377 # include <sys/socket.h>
379 # include <sys/stat.h>
383 #define AUTH_KEY_LENGTH 64
384 #define SEND_BUFFER_SIZE 4096
386 extern char *strerror ();
389 /* Buffer to accumulate data to send in TCP connections. */
390 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
391 int sblen
= 0; /* Fill pointer for the send buffer. */
393 /* Let's send the data to Emacs when either
394 - the data ends in "\n", or
395 - the buffer is full (but this shouldn't happen)
396 Otherwise, we just accumulate it. */
398 send_to_emacs (s
, data
)
404 int dlen
= strlen (data
);
405 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
407 int part
= SEND_BUFFER_SIZE
- sblen
;
408 strncpy (&send_buffer
[sblen
], data
, part
);
410 sblen
= SEND_BUFFER_SIZE
;
414 strcpy (&send_buffer
[sblen
], data
);
421 if (sblen
== SEND_BUFFER_SIZE
422 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
424 int sent
= send (s
, send_buffer
, sblen
, 0);
426 strcpy (send_buffer
, &send_buffer
[sent
]);
432 /* In NAME, insert a & before each &, each space, each newline, and
433 any initial -. Change spaces to underscores, too, so that the
434 return value never contains a space. */
436 quote_file_name (s
, name
)
440 char *copy
= (char *) malloc (strlen (name
) * 2 + 1);
461 if (*p
== '&' || (*p
== '-' && p
== name
))
474 file_name_absolute_p (filename
)
475 const unsigned char *filename
;
477 /* Sanity check, it shouldn't happen. */
478 if (! filename
) return FALSE
;
480 /* /xxx is always an absolute path. */
481 if (filename
[0] == '/') return TRUE
;
483 /* Empty filenames (which shouldn't happen) are relative. */
484 if (filename
[0] == '\0') return FALSE
;
487 /* X:\xxx is always absolute; X:xxx is an error and will fail. */
488 if (isalpha (filename
[0])
489 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
492 /* Both \xxx and \\xxx\yyy are absolute. */
493 if (filename
[0] == '\\') return TRUE
;
500 /* Wrapper to make WSACleanup a cdecl, as required by atexit(). */
502 __cdecl
close_winsock ()
507 /* Initialize the WinSock2 library. */
509 initialize_sockets ()
513 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
515 message (TRUE
, "%s: error initializing WinSock2", progname
);
519 atexit (close_winsock
);
521 #endif /* WINDOWSNT */
524 * Read the information needed to set up a TCP comm channel with
525 * the Emacs server: host, port, pid and authentication string.
528 get_server_config (server
, authentication
)
529 struct sockaddr_in
*server
;
530 char *authentication
;
537 if (file_name_absolute_p (server_file
))
538 config
= fopen (server_file
, "rb");
541 char *home
= getenv ("HOME");
545 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
546 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
547 config
= fopen (path
, "rb");
550 if (!config
&& (home
= getenv ("APPDATA")))
552 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
553 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
554 config
= fopen (path
, "rb");
562 if (fgets (dotted
, sizeof dotted
, config
)
563 && (port
= strchr (dotted
, ':'))
564 && (pid
= strchr (port
, ' ')))
571 message (TRUE
, "%s: invalid configuration info", progname
);
575 server
->sin_family
= AF_INET
;
576 server
->sin_addr
.s_addr
= inet_addr (dotted
);
577 server
->sin_port
= htons (atoi (port
));
579 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
581 message (TRUE
, "%s: cannot read authentication info", progname
);
587 emacs_pid
= atoi (pid
);
596 struct sockaddr_in server
;
597 struct linger l_arg
= {1, 1};
598 char auth_string
[AUTH_KEY_LENGTH
+ 1];
600 if (! get_server_config (&server
, auth_string
))
601 return INVALID_SOCKET
;
603 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
604 message (FALSE
, "%s: connected to remote socket at %s\n",
605 progname
, inet_ntoa (server
.sin_addr
));
608 * Open up an AF_INET socket
610 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
612 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
613 return INVALID_SOCKET
;
619 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
621 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
622 return INVALID_SOCKET
;
625 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
628 * Send the authentication
630 auth_string
[AUTH_KEY_LENGTH
] = '\0';
632 SEND_STRING ("-auth ");
633 SEND_STRING (auth_string
);
639 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
641 /* Three possibilities:
642 2 - can't be `stat'ed (sets errno)
643 1 - isn't owned by us
644 0 - success: none of the above */
647 socket_status (socket_name
)
652 if (stat (socket_name
, &statbfr
) == -1)
655 if (statbfr
.st_uid
!= geteuid ())
665 struct sockaddr_un server
;
668 * Open up an AF_UNIX socket in this person's home directory
671 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
673 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
674 return INVALID_SOCKET
;
677 server
.sun_family
= AF_UNIX
;
681 int default_sock
= !socket_name
;
683 char *server_name
= "server";
685 if (socket_name
&& !index (socket_name
, '/') && !index (socket_name
, '\\'))
686 { /* socket_name is a file name component. */
687 server_name
= socket_name
;
689 default_sock
= 1; /* Try both UIDs. */
694 socket_name
= alloca (100 + strlen (server_name
));
695 sprintf (socket_name
, "/tmp/emacs%d/%s",
696 (int) geteuid (), server_name
);
699 if (strlen (socket_name
) < sizeof (server
.sun_path
))
700 strcpy (server
.sun_path
, socket_name
);
703 message (TRUE
, "%s: socket-name %s too long",
704 progname
, socket_name
);
708 /* See if the socket exists, and if it's owned by us. */
709 sock_status
= socket_status (server
.sun_path
);
711 if (sock_status
&& default_sock
)
713 /* Failing that, see if LOGNAME or USER exist and differ from
714 our euid. If so, look for a socket based on the UID
715 associated with the name. This is reminiscent of the logic
716 that init_editfns uses to set the global Vuser_full_name. */
718 char *user_name
= (char *) getenv ("LOGNAME");
721 user_name
= (char *) getenv ("USER");
725 struct passwd
*pw
= getpwnam (user_name
);
727 if (pw
&& (pw
->pw_uid
!= geteuid ()))
729 /* We're running under su, apparently. */
730 socket_name
= alloca (100 + strlen (server_name
));
731 sprintf (socket_name
, "/tmp/emacs%d/%s",
732 (int) pw
->pw_uid
, server_name
);
734 if (strlen (socket_name
) < sizeof (server
.sun_path
))
735 strcpy (server
.sun_path
, socket_name
);
738 message (TRUE
, "%s: socket-name %s too long",
739 progname
, socket_name
);
743 sock_status
= socket_status (server
.sun_path
);
754 /* There's a socket, but it isn't owned by us. This is OK if
758 message (TRUE
, "%s: Invalid socket owner\n", progname
);
759 return INVALID_SOCKET
;
765 if (saved_errno
== ENOENT
)
767 "%s: can't find socket; have you started the server?\n\
768 To start the server in Emacs, type \"M-x server-start\".\n",
771 message (TRUE
, "%s: can't stat %s: %s\n",
772 progname
, server
.sun_path
, strerror (saved_errno
));
773 return INVALID_SOCKET
;
777 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
780 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
781 return INVALID_SOCKET
;
786 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
795 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
796 /* Explicit --socket-name argument. */
799 s
= set_local_socket ();
800 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
803 message (TRUE
, "%s: error accessing socket \"%s\"",
804 progname
, socket_name
);
809 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
811 server_file
= getenv ("EMACS_SERVER_FILE");
815 s
= set_tcp_socket ();
816 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
819 message (TRUE
, "%s: error accessing server file \"%s\"",
820 progname
, server_file
);
824 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
825 /* Implicit local socket. */
826 s
= set_local_socket ();
827 if (s
!= INVALID_SOCKET
)
831 /* Implicit server file. */
832 server_file
= "server";
833 s
= set_tcp_socket ();
834 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
837 /* No implicit or explicit socket, and no alternate editor. */
838 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
839 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
842 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
843 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
854 int i
, rl
, needlf
= 0;
856 char string
[BUFSIZ
+1];
860 /* Process options. */
861 decode_options (argc
, argv
);
863 if ((argc
- optind
< 1) && !eval
)
865 message (TRUE
, "%s: file name or argument required\nTry `%s --help' for more information\n",
870 if ((s
= set_socket ()) == INVALID_SOCKET
)
874 cwd
= getcwd (string
, sizeof string
);
876 cwd
= getwd (string
);
880 /* getwd puts message in STRING if it fails. */
881 message (TRUE
, "%s: %s (%s)\n", progname
,
883 "Cannot get current working directory",
893 Modern Windows restrict which processes can set the foreground window.
894 emacsclient can allow Emacs to grab the focus by calling the function
895 AllowSetForegroundWindow(). Unfortunately, older Windows (W95, W98
896 and NT) lack this function, so we have to check its availability.
902 if (hUser32
= LoadLibrary ("user32.dll"))
905 if (set_fg
= GetProcAddress (hUser32
, "AllowSetForegroundWindow"))
907 FreeLibrary (hUser32
);
913 SEND_STRING ("-nowait ");
916 SEND_STRING ("-eval ");
920 SEND_STRING ("-display ");
921 SEND_QUOTED (display
);
925 if ((argc
- optind
> 0))
927 for (i
= optind
; i
< argc
; i
++)
930 ; /* Don't prepend any cwd or anything like that. */
931 else if (*argv
[i
] == '+')
933 char *p
= argv
[i
] + 1;
934 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
941 else if (! file_name_absolute_p (argv
[i
]))
947 SEND_QUOTED (argv
[i
]);
953 while (fgets (string
, BUFSIZ
, stdin
))
955 SEND_QUOTED (string
);
962 /* Maybe wait for an answer. */
967 printf ("Waiting for Emacs...");
972 /* Now, wait for an answer and print any messages. */
973 while ((rl
= recv (s
, string
, BUFSIZ
, 0)) > 0)
978 printf ("%s", string
);
979 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
991 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
993 #ifndef HAVE_STRERROR
998 extern char *sys_errlist
[];
1001 if (errnum
>= 0 && errnum
< sys_nerr
)
1002 return sys_errlist
[errnum
];
1003 return (char *) "Unknown error";
1006 #endif /* ! HAVE_STRERROR */
1008 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1009 (do not change this comment) */
1011 /* emacsclient.c ends here */