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 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. */
158 static int window_app
= -1;
159 char szTitle
[MAX_PATH
];
162 /* Checking for STDOUT does not work; it's a valid handle also in
163 nonconsole apps. Testing for the console title seems to work. */
164 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
171 message (int is_error
, char *message
, ...)
176 va_start (args
, message
);
177 vsprintf (msg
, message
, args
);
181 if (w32_window_app ())
184 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
186 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
191 FILE *f
= is_error
? stderr
: stdout
;
198 /* Decode the options from argv and argc.
199 The global variable `optind' will say how many arguments we used up. */
202 decode_options (argc
, argv
)
206 alternate_editor
= getenv ("ALTERNATE_EDITOR");
210 int opt
= getopt_long (argc
, argv
,
211 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
224 /* If getopt returns 0, then it has already processed a
225 long-named option. We should do nothing. */
229 alternate_editor
= optarg
;
232 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
234 socket_name
= optarg
;
239 server_file
= optarg
;
255 message (FALSE
, "emacsclient %s\n", VERSION
);
260 print_help_and_exit ();
264 message (TRUE
, "Try `%s --help' for more information\n", progname
);
272 print_help_and_exit ()
275 "Usage: %s [OPTIONS] FILE...\n\
276 Tell the Emacs server to visit the specified files.\n\
277 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
279 The following OPTIONS are accepted:\n\
281 -V, --version Just print version info and return\n\
282 -H, --help Print this usage information message\n\
283 -e, --eval Evaluate FILE arguments as Lisp expressions\n\
284 -n, --no-wait Don't wait for the server to return\n\
285 -d, --display=DISPLAY Visit the file in the given display\n"
286 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
287 "-s, --socket-name=FILENAME\n\
288 Set filename of the UNIX socket for communication\n"
290 "-f, --server-file=FILENAME\n\
291 Set filename of the TCP authentication file\n\
292 -a, --alternate-editor=EDITOR\n\
293 Editor to fallback to if server is not running\n\
295 Report bugs to bug-gnu-emacs@gnu.org.\n", progname
);
303 execvp wrapper for Windows. Quotes arguments with embedded spaces.
305 This is necessary due to the broken implementation of exec* routines in
306 the Microsoft libraries: they concatenate the arguments together without
307 quoting special characters, and pass the result to CreateProcess, with
308 predictably bad results. By contrast, Posix execvp passes the arguments
309 directly into the argv array of the child process.
312 w32_execvp (path
, argv
)
318 /* Required to allow a .BAT script as alternate editor. */
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. */
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
;
496 FIXME: There's a corner case not dealt with, "x:y", where:
498 1) x is a valid drive designation (usually a letter in the A-Z range)
499 and y is a path, relative to the current directory on drive x. This
500 is absolute, *after* fixing the y part to include the current
503 2) x is a relative file name, and y is an NTFS stream name. This is a
504 correct relative path, but it is very unusual.
506 The trouble is that first case items are also valid examples of the
507 second case, i.e., "c:test" can be understood as drive:path or as
510 The "right" fix would involve checking whether
511 - the current drive/partition is NTFS,
512 - x is a valid (and accesible) drive designator,
513 - x:y already exists as a file:stream in the current directory,
514 - y already exists on the current directory of drive x,
515 - the auspices are favorable,
516 and then taking an "informed decision" based on the above.
518 Whatever the result, Emacs currently does a very bad job of dealing
519 with NTFS file:streams: it cannot visit them, and the only way to
520 create one is by setting `buffer-file-name' to point to it (either
521 manually or with emacsclient). So perhaps resorting to 1) and ignoring
522 2) for now is the right thing to do.
524 Anyway, something to decide After the Release.
532 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
534 __cdecl
close_winsock ()
539 /* Initialize the WinSock2 library. */
541 initialize_sockets ()
545 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
547 message (TRUE
, "%s: error initializing WinSock2", progname
);
551 atexit (close_winsock
);
553 #endif /* WINDOWSNT */
556 * Read the information needed to set up a TCP comm channel with
557 * the Emacs server: host, port, pid and authentication string.
560 get_server_config (server
, authentication
)
561 struct sockaddr_in
*server
;
562 char *authentication
;
569 if (file_name_absolute_p (server_file
))
570 config
= fopen (server_file
, "rb");
573 char *home
= getenv ("HOME");
577 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
578 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
579 config
= fopen (path
, "rb");
582 if (!config
&& (home
= getenv ("APPDATA")))
584 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
585 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
586 config
= fopen (path
, "rb");
594 if (fgets (dotted
, sizeof dotted
, config
)
595 && (port
= strchr (dotted
, ':'))
596 && (pid
= strchr (port
, ' ')))
603 message (TRUE
, "%s: invalid configuration info", progname
);
607 server
->sin_family
= AF_INET
;
608 server
->sin_addr
.s_addr
= inet_addr (dotted
);
609 server
->sin_port
= htons (atoi (port
));
611 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
613 message (TRUE
, "%s: cannot read authentication info", progname
);
619 emacs_pid
= atoi (pid
);
628 struct sockaddr_in server
;
629 struct linger l_arg
= {1, 1};
630 char auth_string
[AUTH_KEY_LENGTH
+ 1];
632 if (! get_server_config (&server
, auth_string
))
633 return INVALID_SOCKET
;
635 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
636 message (FALSE
, "%s: connected to remote socket at %s\n",
637 progname
, inet_ntoa (server
.sin_addr
));
640 * Open up an AF_INET socket
642 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
644 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
645 return INVALID_SOCKET
;
651 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
653 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
654 return INVALID_SOCKET
;
657 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
660 * Send the authentication
662 auth_string
[AUTH_KEY_LENGTH
] = '\0';
664 SEND_STRING ("-auth ");
665 SEND_STRING (auth_string
);
671 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
673 /* Three possibilities:
674 2 - can't be `stat'ed (sets errno)
675 1 - isn't owned by us
676 0 - success: none of the above */
679 socket_status (socket_name
)
684 if (stat (socket_name
, &statbfr
) == -1)
687 if (statbfr
.st_uid
!= geteuid ())
697 struct sockaddr_un server
;
700 * Open up an AF_UNIX socket in this person's home directory
703 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
705 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
706 return INVALID_SOCKET
;
709 server
.sun_family
= AF_UNIX
;
713 int default_sock
= !socket_name
;
715 char *server_name
= "server";
717 if (socket_name
&& !index (socket_name
, '/') && !index (socket_name
, '\\'))
718 { /* socket_name is a file name component. */
719 server_name
= socket_name
;
721 default_sock
= 1; /* Try both UIDs. */
726 socket_name
= alloca (100 + strlen (server_name
));
727 sprintf (socket_name
, "/tmp/emacs%d/%s",
728 (int) geteuid (), server_name
);
731 if (strlen (socket_name
) < sizeof (server
.sun_path
))
732 strcpy (server
.sun_path
, socket_name
);
735 message (TRUE
, "%s: socket-name %s too long",
736 progname
, socket_name
);
740 /* See if the socket exists, and if it's owned by us. */
741 sock_status
= socket_status (server
.sun_path
);
743 if (sock_status
&& default_sock
)
745 /* Failing that, see if LOGNAME or USER exist and differ from
746 our euid. If so, look for a socket based on the UID
747 associated with the name. This is reminiscent of the logic
748 that init_editfns uses to set the global Vuser_full_name. */
750 char *user_name
= (char *) getenv ("LOGNAME");
753 user_name
= (char *) getenv ("USER");
757 struct passwd
*pw
= getpwnam (user_name
);
759 if (pw
&& (pw
->pw_uid
!= geteuid ()))
761 /* We're running under su, apparently. */
762 socket_name
= alloca (100 + strlen (server_name
));
763 sprintf (socket_name
, "/tmp/emacs%d/%s",
764 (int) pw
->pw_uid
, server_name
);
766 if (strlen (socket_name
) < sizeof (server
.sun_path
))
767 strcpy (server
.sun_path
, socket_name
);
770 message (TRUE
, "%s: socket-name %s too long",
771 progname
, socket_name
);
775 sock_status
= socket_status (server
.sun_path
);
786 /* There's a socket, but it isn't owned by us. This is OK if
790 message (TRUE
, "%s: Invalid socket owner\n", progname
);
791 return INVALID_SOCKET
;
797 if (saved_errno
== ENOENT
)
799 "%s: can't find socket; have you started the server?\n\
800 To start the server in Emacs, type \"M-x server-start\".\n",
803 message (TRUE
, "%s: can't stat %s: %s\n",
804 progname
, server
.sun_path
, strerror (saved_errno
));
805 return INVALID_SOCKET
;
809 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
812 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
813 return INVALID_SOCKET
;
818 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
827 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
828 /* Explicit --socket-name argument. */
831 s
= set_local_socket ();
832 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
835 message (TRUE
, "%s: error accessing socket \"%s\"",
836 progname
, socket_name
);
841 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
843 server_file
= getenv ("EMACS_SERVER_FILE");
847 s
= set_tcp_socket ();
848 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
851 message (TRUE
, "%s: error accessing server file \"%s\"",
852 progname
, server_file
);
856 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
857 /* Implicit local socket. */
858 s
= set_local_socket ();
859 if (s
!= INVALID_SOCKET
)
863 /* Implicit server file. */
864 server_file
= "server";
865 s
= set_tcp_socket ();
866 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
869 /* No implicit or explicit socket, and no alternate editor. */
870 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
871 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
874 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
875 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
881 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
882 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
885 w32_find_emacs_process (hWnd
, lParam
)
892 /* Reject any window not of class "Emacs". */
893 if (! get_wc (hWnd
, class, sizeof (class))
894 || strcmp (class, "Emacs"))
897 /* We only need the process id, not the thread id. */
898 (void) GetWindowThreadProcessId (hWnd
, &pid
);
900 /* Not the one we're looking for. */
901 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
903 /* OK, let's raise it. */
906 /* Stop enumeration. */
911 * Search for a window of class "Emacs" and owned by a process with
912 * process id = emacs_pid. If found, allow it to grab the focus.
919 /* It shouldn't happen when dealing with TCP sockets. */
920 if (!emacs_pid
) return;
922 if (!(hUser32
= LoadLibrary ("user32.dll"))) return;
924 /* Modern Windows restrict which processes can set the foreground window.
925 emacsclient can allow Emacs to grab the focus by calling the function
926 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
927 NT) lack this function, so we have to check its availability. */
928 if ((set_fg
= GetProcAddress (hUser32
, "AllowSetForegroundWindow"))
929 && (get_wc
= GetProcAddress (hUser32
, "RealGetWindowClassA")))
930 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
932 FreeLibrary (hUser32
);
942 int i
, rl
, needlf
= 0;
944 char string
[BUFSIZ
+1];
948 /* Process options. */
949 decode_options (argc
, argv
);
951 if ((argc
- optind
< 1) && !eval
)
953 message (TRUE
, "%s: file name or argument required\nTry `%s --help' for more information\n",
958 if ((s
= set_socket ()) == INVALID_SOCKET
)
962 cwd
= getcwd (string
, sizeof string
);
964 cwd
= getwd (string
);
968 /* getwd puts message in STRING if it fails. */
969 message (TRUE
, "%s: %s (%s)\n", progname
,
971 "Cannot get current working directory",
984 SEND_STRING ("-nowait ");
987 SEND_STRING ("-eval ");
991 SEND_STRING ("-display ");
992 SEND_QUOTED (display
);
996 if ((argc
- optind
> 0))
998 for (i
= optind
; i
< argc
; i
++)
1001 ; /* Don't prepend any cwd or anything like that. */
1002 else if (*argv
[i
] == '+')
1004 char *p
= argv
[i
] + 1;
1005 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1012 else if (! file_name_absolute_p (argv
[i
]))
1018 SEND_QUOTED (argv
[i
]);
1024 while (fgets (string
, BUFSIZ
, stdin
))
1026 SEND_QUOTED (string
);
1033 /* Maybe wait for an answer. */
1038 printf ("Waiting for Emacs...");
1043 /* Now, wait for an answer and print any messages. */
1044 while ((rl
= recv (s
, string
, BUFSIZ
, 0)) > 0)
1049 printf ("%s", string
);
1050 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1059 return EXIT_SUCCESS
;
1062 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1064 #ifndef HAVE_STRERROR
1069 extern char *sys_errlist
[];
1070 extern int sys_nerr
;
1072 if (errnum
>= 0 && errnum
< sys_nerr
)
1073 return sys_errlist
[errnum
];
1074 return (char *) "Unknown error";
1077 #endif /* ! HAVE_STRERROR */
1079 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1080 (do not change this comment) */
1082 /* emacsclient.c ends here */