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 void print_help_and_exit () NO_RETURN
;
134 struct option longopts
[] =
136 { "no-wait", no_argument
, NULL
, 'n' },
137 { "eval", no_argument
, NULL
, 'e' },
138 { "help", no_argument
, NULL
, 'H' },
139 { "version", no_argument
, NULL
, 'V' },
140 { "alternate-editor", required_argument
, NULL
, 'a' },
141 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
142 { "socket-name", required_argument
, NULL
, 's' },
144 { "server-file", required_argument
, NULL
, 'f' },
145 { "display", required_argument
, NULL
, 'd' },
149 /* Message functions. */
152 /* I first tried to check for STDOUT. The check did not work,
153 I get a valid handle also in nonconsole apps.
154 Instead I test for console title, which seems to work. */
158 static int window_app
= -1;
159 char szTitle
[MAX_PATH
];
162 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
169 message (int is_error
, char *message
, ...)
175 va_start (args
, message
);
179 sprintf (buf
, "%s: ", progname
);
180 msg
= strchr (buf
, '\0');
183 vsprintf (msg
, message
, args
);
187 if (w32_window_app ())
190 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
192 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
196 fprintf (is_error
? stderr
: stdout
, msg
);
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
);
302 Try to run a different command, or --if no alternate editor is
303 defined-- exit with an errorcode.
310 if (alternate_editor
)
314 argv
[i
] = (char *)alternate_editor
;
316 execvp (alternate_editor
, argv
+ i
);
317 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
318 progname
, alternate_editor
);
324 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
331 message (TRUE
, "%s: Sorry, the Emacs server is supported only\non systems with Berkely sockets.\n",
337 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
340 # include <winsock2.h>
342 # include <sys/types.h>
343 # include <sys/socket.h>
345 # include <sys/stat.h>
349 #define AUTH_KEY_LENGTH 64
350 #define SEND_BUFFER_SIZE 4096
352 extern char *strerror ();
355 /* Buffer to accumulate data to send in TCP connections. */
356 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
357 int sblen
= 0; /* Fill pointer for the send buffer. */
359 /* Let's send the data to Emacs when either
360 - the data ends in "\n", or
361 - the buffer is full (but this shouldn't happen)
362 Otherwise, we just accumulate it. */
364 send_to_emacs (s
, data
)
370 int dlen
= strlen (data
);
371 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
373 int part
= SEND_BUFFER_SIZE
- sblen
;
374 strncpy (&send_buffer
[sblen
], data
, part
);
376 sblen
= SEND_BUFFER_SIZE
;
380 strcpy (&send_buffer
[sblen
], data
);
387 if (sblen
== SEND_BUFFER_SIZE
388 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
390 int sent
= send (s
, send_buffer
, sblen
, 0);
392 strcpy (send_buffer
, &send_buffer
[sent
]);
398 /* In NAME, insert a & before each &, each space, each newline, and
399 any initial -. Change spaces to underscores, too, so that the
400 return value never contains a space. */
402 quote_file_name (s
, name
)
406 char *copy
= (char *) malloc (strlen (name
) * 2 + 1);
427 if (*p
== '&' || (*p
== '-' && p
== name
))
440 file_name_absolute_p (filename
)
441 const unsigned char *filename
;
443 /* Sanity check, it shouldn't happen. */
444 if (! filename
) return FALSE
;
446 /* /xxx is always an absolute path. */
447 if (filename
[0] == '/') return TRUE
;
449 /* Empty filenames (which shouldn't happen) are relative. */
450 if (filename
[0] == '\0') return FALSE
;
453 /* X:\xxx is always absolute; X:xxx is an error and will fail. */
454 if (isalpha (filename
[0])
455 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
458 /* Both \xxx and \\xxx\yyy are absolute. */
459 if (filename
[0] == '\\') return TRUE
;
466 /* Wrapper to make WSACleanup a cdecl, as required by atexit(). */
468 __cdecl
close_winsock ()
473 /* Initialize the WinSock2 library. */
475 initialize_sockets ()
479 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
481 message (TRUE
, "%s: error initializing WinSock2", progname
);
485 atexit (close_winsock
);
487 #endif /* WINDOWSNT */
490 * Read the information needed to set up a TCP comm channel with
491 * the Emacs server: host, port, pid and authentication string.
494 get_server_config (server
, authentication
)
495 struct sockaddr_in
*server
;
496 char *authentication
;
503 if (file_name_absolute_p (server_file
))
504 config
= fopen (server_file
, "rb");
507 char *home
= getenv ("HOME");
511 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
512 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
513 config
= fopen (path
, "rb");
516 if (!config
&& (home
= getenv ("APPDATA")))
518 char *path
= alloca (32 + strlen (home
) + strlen (server_file
));
519 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
520 config
= fopen (path
, "rb");
528 if (fgets (dotted
, sizeof dotted
, config
)
529 && (port
= strchr (dotted
, ':'))
530 && (pid
= strchr (port
, ' ')))
537 message (TRUE
, "%s: invalid configuration info", progname
);
541 server
->sin_family
= AF_INET
;
542 server
->sin_addr
.s_addr
= inet_addr (dotted
);
543 server
->sin_port
= htons (atoi (port
));
545 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
547 message (TRUE
, "%s: cannot read authentication info", progname
);
555 Modern Windows restrict which processes can set the foreground window.
556 So, for emacsclient to be able to force Emacs into the foreground, we
557 have to call AllowSetForegroundWindow(). Unfortunately, older Windows
558 (W95, W98 and NT) don't have this function, so we have to check first.
560 We're doing this here because it has to be done before sending info
561 to Emacs, and otherwise we'll need a global variable just to pass around
562 the pid, which is also inelegant.
567 if (hUser32
= LoadLibrary ("user32.dll"))
570 if (set_fg
= GetProcAddress (hUser32
, "AllowSetForegroundWindow"))
572 FreeLibrary (hUser32
);
584 struct sockaddr_in server
;
585 struct linger l_arg
= {1, 1};
586 char auth_string
[AUTH_KEY_LENGTH
+ 1];
588 if (! get_server_config (&server
, auth_string
))
589 return INVALID_SOCKET
;
591 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
592 message (TRUE
, "%s: connected to remote socket at %s\n",
593 progname
, inet_ntoa (server
.sin_addr
));
596 * Open up an AF_INET socket
598 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
600 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
601 return INVALID_SOCKET
;
607 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
609 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
610 return INVALID_SOCKET
;
613 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
616 * Send the authentication
618 auth_string
[AUTH_KEY_LENGTH
] = '\0';
620 SEND_STRING ("-auth ");
621 SEND_STRING (auth_string
);
627 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
629 /* Three possibilities:
630 2 - can't be `stat'ed (sets errno)
631 1 - isn't owned by us
632 0 - success: none of the above */
635 socket_status (socket_name
)
640 if (stat (socket_name
, &statbfr
) == -1)
643 if (statbfr
.st_uid
!= geteuid ())
653 struct sockaddr_un server
;
656 * Open up an AF_UNIX socket in this person's home directory
659 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
661 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
662 return INVALID_SOCKET
;
665 server
.sun_family
= AF_UNIX
;
669 int default_sock
= !socket_name
;
671 char *server_name
= "server";
673 if (socket_name
&& !index (socket_name
, '/') && !index (socket_name
, '\\'))
674 { /* socket_name is a file name component. */
675 server_name
= socket_name
;
677 default_sock
= 1; /* Try both UIDs. */
682 socket_name
= alloca (100 + strlen (server_name
));
683 sprintf (socket_name
, "/tmp/emacs%d/%s",
684 (int) geteuid (), server_name
);
687 if (strlen (socket_name
) < sizeof (server
.sun_path
))
688 strcpy (server
.sun_path
, socket_name
);
691 message (TRUE
, "%s: socket-name %s too long",
692 progname
, socket_name
);
696 /* See if the socket exists, and if it's owned by us. */
697 sock_status
= socket_status (server
.sun_path
);
699 if (sock_status
&& default_sock
)
701 /* Failing that, see if LOGNAME or USER exist and differ from
702 our euid. If so, look for a socket based on the UID
703 associated with the name. This is reminiscent of the logic
704 that init_editfns uses to set the global Vuser_full_name. */
706 char *user_name
= (char *) getenv ("LOGNAME");
709 user_name
= (char *) getenv ("USER");
713 struct passwd
*pw
= getpwnam (user_name
);
715 if (pw
&& (pw
->pw_uid
!= geteuid ()))
717 /* We're running under su, apparently. */
718 socket_name
= alloca (100 + strlen (server_name
));
719 sprintf (socket_name
, "/tmp/emacs%d/%s",
720 (int) pw
->pw_uid
, server_name
);
722 if (strlen (socket_name
) < sizeof (server
.sun_path
))
723 strcpy (server
.sun_path
, socket_name
);
726 message (TRUE
, "%s: socket-name %s too long",
727 progname
, socket_name
);
731 sock_status
= socket_status (server
.sun_path
);
742 /* There's a socket, but it isn't owned by us. This is OK if
746 message (TRUE
, "%s: Invalid socket owner\n", progname
);
747 return INVALID_SOCKET
;
753 if (saved_errno
== ENOENT
)
755 "%s: can't find socket; have you started the server?\n\
756 To start the server in Emacs, type \"M-x server-start\".\n",
759 message (TRUE
, "%s: can't stat %s: %s\n",
760 progname
, server
.sun_path
, strerror (saved_errno
));
761 return INVALID_SOCKET
;
765 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
768 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
769 return INVALID_SOCKET
;
774 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
783 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
784 /* Explicit --socket-name argument. */
787 s
= set_local_socket ();
788 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
791 message (TRUE
, "%s: error accessing socket \"%s\"",
792 progname
, socket_name
);
797 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
799 server_file
= getenv ("EMACS_SERVER_FILE");
803 s
= set_tcp_socket ();
804 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
807 message (TRUE
, "%s: error accessing server file \"%s\"",
808 progname
, server_file
);
812 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
813 /* Implicit local socket. */
814 s
= set_local_socket ();
815 if (s
!= INVALID_SOCKET
)
819 /* Implicit server file. */
820 server_file
= "server";
821 s
= set_tcp_socket ();
822 if ((s
!= INVALID_SOCKET
) || alternate_editor
)
825 /* No implicit or explicit socket, and no alternate editor. */
826 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
827 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
830 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
831 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
842 int i
, rl
, needlf
= 0;
844 char string
[BUFSIZ
+1];
848 /* Process options. */
849 decode_options (argc
, argv
);
851 if ((argc
- optind
< 1) && !eval
)
853 message (TRUE
, "%s: file name or argument required\nTry `%s --help' for more information\n",
858 if ((s
= set_socket ()) == INVALID_SOCKET
)
862 cwd
= getcwd (string
, sizeof string
);
864 cwd
= getwd (string
);
868 /* getwd puts message in STRING if it fails. */
870 message (TRUE
, "%s: %s (%s)\n", progname
,
871 "Cannot get current working directory", strerror (errno
));
873 message (TRUE
, "%s: %s (%s)\n", progname
, string
, strerror (errno
));
879 SEND_STRING ("-nowait ");
882 SEND_STRING ("-eval ");
886 SEND_STRING ("-display ");
887 SEND_QUOTED (display
);
891 if ((argc
- optind
> 0))
893 for (i
= optind
; i
< argc
; i
++)
896 ; /* Don't prepend any cwd or anything like that. */
897 else if (*argv
[i
] == '+')
899 char *p
= argv
[i
] + 1;
900 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
907 else if (! file_name_absolute_p (argv
[i
]))
913 SEND_QUOTED (argv
[i
]);
919 while (fgets (string
, BUFSIZ
, stdin
))
921 SEND_QUOTED (string
);
928 /* Maybe wait for an answer. */
933 printf ("Waiting for Emacs...");
938 /* Now, wait for an answer and print any messages. */
939 while ((rl
= recv (s
, string
, BUFSIZ
, 0)) > 0)
944 printf ("%s", string
);
945 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
957 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
959 #ifndef HAVE_STRERROR
964 extern char *sys_errlist
[];
967 if (errnum
>= 0 && errnum
< sys_nerr
)
968 return sys_errlist
[errnum
];
969 return (char *) "Unknown error";
972 #endif /* ! HAVE_STRERROR */
974 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
975 (do not change this comment) */
977 /* emacsclient.c ends here */