* configure.in (ATTRIBUTE_FORMAT, ATTRIBUTE_FORMAT_PRINTF): New macros.
[bpt/emacs.git] / lib-src / emacsclient.c
CommitLineData
efb859b4 1/* Client process that communicates with GNU Emacs acting as server.
73b0cd50 2 Copyright (C) 1986-1987, 1994, 1999-2011 Free Software Foundation, Inc.
46cec291
RS
3
4This file is part of GNU Emacs.
5
294981c7 6GNU Emacs is free software: you can redistribute it and/or modify
46cec291 7it under the terms of the GNU General Public License as published by
294981c7
GM
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
46cec291
RS
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
294981c7 17along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
46cec291
RS
18
19
2f8fe2f4 20#include <config.h>
e69233c2 21
aa0b6932 22#ifdef WINDOWSNT
aa0b6932 23
bc28de71
JB
24/* config.h defines these, which disables sockets altogether! */
25# undef _WINSOCKAPI_
26# undef _WINSOCK_H
27
411b80a5
JB
28# include <malloc.h>
29# include <stdlib.h>
42073bfb 30# include <windows.h>
dbf60b07 31# include <commctrl.h>
0613f5d5
DN
32# include <io.h>
33# include <winsock2.h>
411b80a5 34
411b80a5
JB
35# define NO_SOCKETS_IN_FILE_SYSTEM
36
aa0b6932
JB
37# define HSOCKET SOCKET
38# define CLOSE_SOCKET closesocket
aa0b6932 39# define INITIALIZE() (initialize_sockets ())
411b80a5 40
728a982d
DN
41char *w32_getenv (char *);
42#define egetenv(VAR) w32_getenv(VAR)
43
411b80a5
JB
44#else /* !WINDOWSNT */
45
67c1df01 46# include "syswait.h"
ed4a3730 47
1e7823d0
JB
48# ifdef HAVE_INET_SOCKETS
49# include <netinet/in.h>
0613f5d5
DN
50# ifdef HAVE_SOCKETS
51# include <sys/types.h>
52# include <sys/socket.h>
53# include <sys/un.h>
54# endif /* HAVE_SOCKETS */
1e7823d0 55# endif
18d2ad29 56# include <arpa/inet.h>
448d4085 57
e35fc962 58# define INVALID_SOCKET -1
aa0b6932
JB
59# define HSOCKET int
60# define CLOSE_SOCKET close
aa0b6932 61# define INITIALIZE()
411b80a5 62
5445ab06
DN
63# ifndef WCONTINUED
64# define WCONTINUED 8
65# endif
66
728a982d
DN
67#define egetenv(VAR) getenv(VAR)
68
411b80a5 69#endif /* !WINDOWSNT */
aa0b6932 70
4e23f2ba 71#undef signal
46cec291 72
42073bfb 73#include <stdarg.h>
e69233c2 74#include <ctype.h>
8f9aaa0a 75#include <stdio.h>
613f7bda 76#include <getopt.h>
4004364e 77#include <unistd.h>
8f9aaa0a 78
0613f5d5 79#include <pwd.h>
dc4a4a14 80#include <sys/stat.h>
9628b887 81#include <signal.h>
4d553a13 82#include <errno.h>
9628b887 83
0613f5d5 84
9628b887 85\f
873fbd0b 86char *getenv (const char *), *getwd (char *);
35a7804d
JB
87#ifdef HAVE_GETCWD
88char *(getcwd) (char *, size_t);
89#endif
8f9aaa0a 90
8f9aaa0a
RS
91#ifndef VERSION
92#define VERSION "unspecified"
93#endif
94\f
aa0b6932
JB
95
96#ifndef EXIT_SUCCESS
97#define EXIT_SUCCESS 0
98#endif
99
100#ifndef EXIT_FAILURE
101#define EXIT_FAILURE 1
102#endif
103
104#ifndef FALSE
105#define FALSE 0
106#endif
107
108#ifndef TRUE
109#define TRUE 1
110#endif
111
bc558f3e
JB
112/* Additional space when allocating buffers for filenames, etc. */
113#define EXTRA_SPACE 100
114
4be3dfc5
PE
115/* Use this to suppress gcc's `...may be used before initialized' warnings. */
116#ifdef lint
117# define IF_LINT(Code) Code
118#else
119# define IF_LINT(Code) /* empty */
120#endif
121
aa0b6932 122\f
8f9aaa0a 123/* Name used to invoke this program. */
728a982d 124const char *progname;
8f9aaa0a 125
0a125897
KL
126/* The second argument to main. */
127char **main_argv;
128
749ae770 129/* Nonzero means don't wait for a response from Emacs. --no-wait. */
8f9aaa0a
RS
130int nowait = 0;
131
0b973fc5
DW
132/* Nonzero means don't print messages for successful operations. --quiet. */
133int quiet = 0;
134
30be2360
SM
135/* Nonzero means args are expressions to be evaluated. --eval. */
136int eval = 0;
137
31fa6595
SM
138/* Nonzero means don't open a new frame. Inverse of --create-frame. */
139int current_frame = 1;
92071250 140
30be2360 141/* The display on which Emacs should work. --display. */
988e88ab 142const char *display = NULL;
30be2360 143
0191e222
CY
144/* The parent window ID, if we are opening a frame via XEmbed. */
145char *parent_id = NULL;
146
9628b887 147/* Nonzero means open a new Emacs frame on the current terminal. */
77134727 148int tty = 0;
9628b887 149
30be2360
SM
150/* If non-NULL, the name of an editor to fallback to if the server
151 is not running. --alternate-editor. */
b03d27bd 152const char *alternate_editor = NULL;
30be2360 153
3db926be 154/* If non-NULL, the filename of the UNIX socket. */
254107e4
RS
155char *socket_name = NULL;
156
aa0b6932 157/* If non-NULL, the filename of the authentication file. */
988e88ab 158const char *server_file = NULL;
aa0b6932 159
c66648e0
JB
160/* PID of the Emacs server process. */
161int emacs_pid = 0;
162
b23b5a5b
PE
163static void print_help_and_exit (void) NO_RETURN;
164static void fail (void) NO_RETURN;
68441b90 165
7f3bff3e 166
8f9aaa0a
RS
167struct option longopts[] =
168{
749ae770 169 { "no-wait", no_argument, NULL, 'n' },
0b973fc5 170 { "quiet", no_argument, NULL, 'q' },
30be2360 171 { "eval", no_argument, NULL, 'e' },
8f9aaa0a
RS
172 { "help", no_argument, NULL, 'H' },
173 { "version", no_argument, NULL, 'V' },
b28c910d 174 { "tty", no_argument, NULL, 't' },
dc1cd5f7 175 { "nw", no_argument, NULL, 't' },
31fa6595 176 { "create-frame", no_argument, NULL, 'c' },
3cf8c6aa 177 { "alternate-editor", required_argument, NULL, 'a' },
b03d27bd 178#ifndef NO_SOCKETS_IN_FILE_SYSTEM
254107e4 179 { "socket-name", required_argument, NULL, 's' },
b03d27bd 180#endif
aa0b6932 181 { "server-file", required_argument, NULL, 'f' },
0ebec7d3 182#ifndef WINDOWSNT
30be2360 183 { "display", required_argument, NULL, 'd' },
0ebec7d3 184#endif
0191e222 185 { "parent-id", required_argument, NULL, 'p' },
30be2360 186 { 0, 0, 0, 0 }
8f9aaa0a
RS
187};
188
974b73e8
KL
189\f
190/* Like malloc but get fatal error if memory is exhausted. */
191
b23b5a5b 192static long *
873fbd0b 193xmalloc (unsigned int size)
974b73e8
KL
194{
195 long *result = (long *) malloc (size);
196 if (result == NULL)
197 {
198 perror ("malloc");
199 exit (EXIT_FAILURE);
200 }
201 return result;
202}
203
974b73e8
KL
204/* From sysdep.c */
205#if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
206
cb06b8dc
SM
207/* From lisp.h */
208#ifndef DIRECTORY_SEP
209#define DIRECTORY_SEP '/'
210#endif
211#ifndef IS_DIRECTORY_SEP
212#define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
213#endif
214#ifndef IS_DEVICE_SEP
215#ifndef DEVICE_SEP
216#define IS_DEVICE_SEP(_c_) 0
217#else
218#define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
219#endif
220#endif
221#ifndef IS_ANY_SEP
222#define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
223#endif
224
225
974b73e8 226/* Return the current working directory. Returns NULL on errors.
5ab73228 227 Any other returned value must be freed with free. This is used
974b73e8
KL
228 only when get_current_dir_name is not defined on the system. */
229char*
7c3320d8 230get_current_dir_name (void)
974b73e8
KL
231{
232 char *buf;
b9170155 233 const char *pwd;
974b73e8
KL
234 struct stat dotstat, pwdstat;
235 /* If PWD is accurate, use it instead of calling getwd. PWD is
236 sometimes a nicer name, and using it may avoid a fatal error if a
237 parent directory is searchable but not readable. */
7ce8671d 238 if ((pwd = egetenv ("PWD")) != 0
974b73e8
KL
239 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
240 && stat (pwd, &pwdstat) == 0
241 && stat (".", &dotstat) == 0
242 && dotstat.st_ino == pwdstat.st_ino
243 && dotstat.st_dev == pwdstat.st_dev
244#ifdef MAXPATHLEN
245 && strlen (pwd) < MAXPATHLEN
246#endif
247 )
248 {
249 buf = (char *) xmalloc (strlen (pwd) + 1);
250 if (!buf)
251 return NULL;
252 strcpy (buf, pwd);
253 }
254#ifdef HAVE_GETCWD
255 else
256 {
257 size_t buf_size = 1024;
258 buf = (char *) xmalloc (buf_size);
259 if (!buf)
260 return NULL;
261 for (;;)
262 {
263 if (getcwd (buf, buf_size) == buf)
264 break;
265 if (errno != ERANGE)
266 {
267 int tmp_errno = errno;
268 free (buf);
269 errno = tmp_errno;
270 return NULL;
271 }
272 buf_size *= 2;
273 buf = (char *) realloc (buf, buf_size);
274 if (!buf)
275 return NULL;
276 }
277 }
278#else
279 else
280 {
281 /* We need MAXPATHLEN here. */
282 buf = (char *) xmalloc (MAXPATHLEN + 1);
283 if (!buf)
284 return NULL;
285 if (getwd (buf) == NULL)
286 {
287 int tmp_errno = errno;
288 free (buf);
289 errno = tmp_errno;
290 return NULL;
291 }
292 }
293#endif
294 return buf;
295}
296#endif
297
42073bfb 298#ifdef WINDOWSNT
7ce8671d 299
a54af40e
EZ
300/* Like strdup but get a fatal error if memory is exhausted. */
301
302char *
303xstrdup (const char *s)
304{
305 char *result = strdup (s);
306 if (result == NULL)
307 {
308 perror ("strdup");
309 exit (EXIT_FAILURE);
310 }
311 return result;
312}
313
7ce8671d
JB
314#define REG_ROOT "SOFTWARE\\GNU\\Emacs"
315
316/* Retrieve an environment variable from the Emacs subkeys of the registry.
317 Return NULL if the variable was not found, or it was empty.
318 This code is based on w32_get_resource (w32.c). */
319char *
7c3320d8 320w32_get_resource (HKEY predefined, char *key, LPDWORD type)
7ce8671d
JB
321{
322 HKEY hrootkey = NULL;
323 char *result = NULL;
324 DWORD cbData;
325
326 if (RegOpenKeyEx (predefined, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
327 {
328 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS)
329 {
330 result = (char *) xmalloc (cbData);
331
bc558f3e
JB
332 if ((RegQueryValueEx (hrootkey, key, NULL, type, result, &cbData) != ERROR_SUCCESS)
333 || (*result == 0))
7ce8671d
JB
334 {
335 free (result);
336 result = NULL;
337 }
338 }
339
340 RegCloseKey (hrootkey);
341 }
342
343 return result;
344}
345
346/*
347 getenv wrapper for Windows
348
a54af40e
EZ
349 Value is allocated on the heap, and can be free'd.
350
351 This is needed to duplicate Emacs's behavior, which is to look for
352 environment variables in the registry if they don't appear in the
353 environment. */
7ce8671d 354char *
7c3320d8 355w32_getenv (char *envvar)
7ce8671d
JB
356{
357 char *value;
358 DWORD dwType;
359
360 if (value = getenv (envvar))
a54af40e
EZ
361 /* Found in the environment. strdup it, because values returned
362 by getenv cannot be free'd. */
363 return xstrdup (value);
7ce8671d
JB
364
365 if (! (value = w32_get_resource (HKEY_CURRENT_USER, envvar, &dwType)) &&
366 ! (value = w32_get_resource (HKEY_LOCAL_MACHINE, envvar, &dwType)))
d41784ee
EZ
367 {
368 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
369 if (strcmp (envvar, "TERM") == 0)
a54af40e 370 return xstrdup ("w32console");
d41784ee
EZ
371 /* Found neither in the environment nor in the registry. */
372 return NULL;
373 }
7ce8671d
JB
374
375 if (dwType == REG_SZ)
376 /* Registry; no need to expand. */
377 return value;
378
379 if (dwType == REG_EXPAND_SZ)
380 {
381 DWORD size;
382
383 if (size = ExpandEnvironmentStrings (value, NULL, 0))
384 {
385 char *buffer = (char *) xmalloc (size);
386 if (ExpandEnvironmentStrings (value, buffer, size))
387 {
388 /* Found and expanded. */
389 free (value);
390 return buffer;
391 }
392
393 /* Error expanding. */
394 free (buffer);
395 }
396 }
397
398 /* Not the right type, or not correctly expanded. */
399 free (value);
400 return NULL;
401}
402
ff90fbde 403void
7c3320d8 404w32_set_user_model_id (void)
ff90fbde
JR
405{
406 HMODULE shell;
0a3472c7 407 HRESULT (WINAPI * set_user_model) (wchar_t * id);
ff90fbde
JR
408
409 /* On Windows 7 and later, we need to set the user model ID
410 to associate emacsclient launched files with Emacs frames
411 in the UI. */
361358ea 412 shell = LoadLibrary ("shell32.dll");
ff90fbde
JR
413 if (shell)
414 {
415 set_user_model
416 = (void *) GetProcAddress (shell,
417 "SetCurrentProcessExplicitAppUserModelID");
418 /* If the function is defined, then we are running on Windows 7
419 or newer, and the UI uses this to group related windows
420 together. Since emacs, runemacs, emacsclient are related, we
421 want them grouped even though the executables are different,
422 so we need to set a consistent ID between them. */
423 if (set_user_model)
424 set_user_model (L"GNU.Emacs");
425
426 FreeLibrary (shell);
427 }
428}
429
42073bfb 430int
7c3320d8 431w32_window_app (void)
42073bfb
JB
432{
433 static int window_app = -1;
434 char szTitle[MAX_PATH];
435
436 if (window_app < 0)
dbf60b07
JR
437 {
438 /* Checking for STDOUT does not work; it's a valid handle also in
439 nonconsole apps. Testing for the console title seems to work. */
440 window_app = (GetConsoleTitleA (szTitle, MAX_PATH) == 0);
441 if (window_app)
361358ea 442 InitCommonControls ();
dbf60b07 443 }
42073bfb
JB
444
445 return window_app;
446}
105faa84
DN
447
448/*
cb06b8dc 449 execvp wrapper for Windows. Quotes arguments with embedded spaces.
105faa84
DN
450
451 This is necessary due to the broken implementation of exec* routines in
452 the Microsoft libraries: they concatenate the arguments together without
453 quoting special characters, and pass the result to CreateProcess, with
7c3320d8 454 predictably bad results. By contrast, POSIX execvp passes the arguments
105faa84
DN
455 directly into the argv array of the child process.
456*/
457int
7c3320d8 458w32_execvp (const char *path, char **argv)
105faa84
DN
459{
460 int i;
461
462 /* Required to allow a .BAT script as alternate editor. */
463 argv[0] = (char *) alternate_editor;
464
465 for (i = 0; argv[i]; i++)
466 if (strchr (argv[i], ' '))
467 {
468 char *quoted = alloca (strlen (argv[i]) + 3);
469 sprintf (quoted, "\"%s\"", argv[i]);
470 argv[i] = quoted;
471 }
472
473 return execvp (path, argv);
474}
475
476#undef execvp
477#define execvp w32_execvp
478
d41784ee
EZ
479/* Emulation of ttyname for Windows. */
480char *
481ttyname (int fd)
482{
483 return "CONOUT$";
484}
485
105faa84 486#endif /* WINDOWSNT */
42073bfb 487
f387c1ee
JB
488/* Display a normal or error message.
489 On Windows, use a message box if compiled as a Windows app. */
b23b5a5b 490static void
b0bbc07d 491message (int is_error, const char *format, ...)
42073bfb 492{
361358ea 493 char msg[2048];
42073bfb
JB
494 va_list args;
495
b0bbc07d
PE
496 va_start (args, format);
497 vsprintf (msg, format, args);
42073bfb
JB
498 va_end (args);
499
500#ifdef WINDOWSNT
501 if (w32_window_app ())
502 {
503 if (is_error)
504 MessageBox (NULL, msg, "Emacsclient ERROR", MB_ICONERROR);
505 else
506 MessageBox (NULL, msg, "Emacsclient", MB_ICONINFORMATION);
507 }
508 else
509#endif
9219db75
JB
510 {
511 FILE *f = is_error ? stderr : stdout;
512
513 fputs (msg, f);
514 fflush (f);
515 }
42073bfb
JB
516}
517
8f9aaa0a 518/* Decode the options from argv and argc.
5212210c 519 The global variable `optind' will say how many arguments we used up. */
8f9aaa0a 520
b23b5a5b 521static void
873fbd0b 522decode_options (int argc, char **argv)
8f9aaa0a 523{
7ce8671d 524 alternate_editor = egetenv ("ALTERNATE_EDITOR");
0ea5797a 525
8f9aaa0a
RS
526 while (1)
527 {
dc1cd5f7 528 int opt = getopt_long_only (argc, argv,
b03d27bd 529#ifndef NO_SOCKETS_IN_FILE_SYSTEM
0b973fc5 530 "VHneqa:s:f:d:tc",
b03d27bd 531#else
0b973fc5 532 "VHneqa:f:d:tc",
b03d27bd 533#endif
974b73e8 534 longopts, 0);
8f9aaa0a
RS
535
536 if (opt == EOF)
537 break;
538
539 switch (opt)
540 {
541 case 0:
542 /* If getopt returns 0, then it has already processed a
543 long-named option. We should do nothing. */
544 break;
e69233c2 545
97e3214d
GM
546 case 'a':
547 alternate_editor = optarg;
548 break;
e69233c2 549
b03d27bd 550#ifndef NO_SOCKETS_IN_FILE_SYSTEM
254107e4
RS
551 case 's':
552 socket_name = optarg;
553 break;
b03d27bd 554#endif
254107e4 555
aa0b6932
JB
556 case 'f':
557 server_file = optarg;
558 break;
254107e4 559
0ea5797a
SM
560 /* We used to disallow this argument in w32, but it seems better
561 to allow it, for the occasional case where the user is
562 connecting with a w32 client to a server compiled with X11
563 support. */
30be2360
SM
564 case 'd':
565 display = optarg;
566 break;
567
8f9aaa0a
RS
568 case 'n':
569 nowait = 1;
570 break;
571
30be2360
SM
572 case 'e':
573 eval = 1;
574 break;
575
0b973fc5
DW
576 case 'q':
577 quiet = 1;
578 break;
579
8f9aaa0a 580 case 'V':
42073bfb 581 message (FALSE, "emacsclient %s\n", VERSION);
65396510 582 exit (EXIT_SUCCESS);
8f9aaa0a 583 break;
46cec291 584
819b8f00 585 case 't':
77134727 586 tty = 1;
c1b8e896 587 current_frame = 0;
77134727
KL
588 break;
589
e5299d8d 590 case 'c':
31fa6595 591 current_frame = 0;
9628b887 592 break;
0b0d3e0b 593
0191e222
CY
594 case 'p':
595 parent_id = optarg;
596 current_frame = 0;
597 break;
598
8f9aaa0a 599 case 'H':
8f9aaa0a 600 print_help_and_exit ();
20c396e8
JB
601 break;
602
603 default:
42073bfb 604 message (TRUE, "Try `%s --help' for more information\n", progname);
65396510 605 exit (EXIT_FAILURE);
20c396e8 606 break;
8f9aaa0a
RS
607 }
608 }
9628b887 609
273b9028
CY
610 /* If the -c option is used (without -t) and no --display argument
611 is provided, try $DISPLAY.
612 Without the -c option, we used to set `display' to $DISPLAY by
613 default, but this changed the default behavior and is sometimes
614 inconvenient. So we force users to use "--display $DISPLAY" if
615 they want Emacs to connect to their current display. */
09317bf4 616 if (!current_frame && !tty && !display)
e7534fc4
AR
617 {
618 display = egetenv ("DISPLAY");
619#ifdef NS_IMPL_COCOA
620 /* Under Cocoa, we don't really use displays the same way as in X,
621 so provide a dummy. */
622 if (!display || strlen (display) == 0)
623 display = "ns";
624#endif
625 }
9997dc15 626
273b9028 627 /* A null-string display is invalid. */
0ea5797a
SM
628 if (display && strlen (display) == 0)
629 display = NULL;
630
273b9028
CY
631 /* If no display is available, new frames are tty frames. */
632 if (!current_frame && !display)
92071250 633 tty = 1;
c0f342ab 634
b8ccaf6f 635 /* --no-wait implies --current-frame on ttys when there are file
273b9028 636 arguments or expressions given. */
b8ccaf6f 637 if (nowait && tty && argc - optind > 0)
92071250 638 current_frame = 1;
802bdb3c
DN
639
640#ifdef WINDOWSNT
69157c99 641 if (alternate_editor && alternate_editor[0] == '\0')
802bdb3c
DN
642 {
643 message (TRUE, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
644an empty string");
645 exit (EXIT_FAILURE);
646 }
647#endif /* WINDOWSNT */
8f9aaa0a
RS
648}
649
974b73e8 650\f
b23b5a5b 651static void
873fbd0b 652print_help_and_exit (void)
8f9aaa0a 653{
c0f342ab
JB
654 /* Spaces and tabs are significant in this message; they're chosen so the
655 message aligns properly both in a tty and in a Windows message box.
656 Please try to preserve them; otherwise the output is very hard to read
657 when using emacsclientw. */
42073bfb 658 message (FALSE,
974b73e8 659 "Usage: %s [OPTIONS] FILE...\n\
30be2360
SM
660Tell the Emacs server to visit the specified files.\n\
661Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
20c396e8 662\n\
30be2360 663The following OPTIONS are accepted:\n\
c0f342ab
JB
664-V, --version Just print version info and return\n\
665-H, --help Print this usage information message\n\
dc1cd5f7 666-nw, -t, --tty Open a new Emacs frame on the current terminal\n\
c4b858e3 667-c, --create-frame Create a new frame instead of trying to\n\
9dfda22f 668 use the current Emacs frame\n\
c0f342ab 669-e, --eval Evaluate the FILE arguments as ELisp expressions\n\
d07529f3 670-n, --no-wait Don't wait for the server to return\n\
0b973fc5 671-q, --quiet Don't display messages on success\n\
24d5010d 672-d DISPLAY, --display=DISPLAY\n\
0191e222
CY
673 Visit the file in the given display\n\
674--parent-id=ID Open in parent window ID, via XEmbed\n"
aa0b6932 675#ifndef NO_SOCKETS_IN_FILE_SYSTEM
24d5010d 676"-s SOCKET, --socket-name=SOCKET\n\
9dfda22f 677 Set filename of the UNIX socket for communication\n"
aa0b6932 678#endif
24d5010d 679"-f SERVER, --server-file=SERVER\n\
9dfda22f 680 Set filename of the TCP authentication file\n\
24d5010d 681-a EDITOR, --alternate-editor=EDITOR\n\
9dfda22f 682 Editor to fallback to if the server is not running\n"
6133a1a9 683#ifndef WINDOWSNT
c3f995a2
JB
684" If EDITOR is the empty string, start Emacs in daemon\n\
685 mode and try connecting again\n"
6133a1a9 686#endif /* not WINDOWSNT */
c3f995a2 687"\n\
5f54cae6 688Report bugs with M-x report-emacs-bug.\n", progname);
65396510 689 exit (EXIT_SUCCESS);
8f9aaa0a 690}
5212210c 691
aa0b6932
JB
692/*
693 Try to run a different command, or --if no alternate editor is
694 defined-- exit with an errorcode.
cb06b8dc 695 Uses argv, but gets it from the global variable main_argv.
aa0b6932 696*/
b23b5a5b 697static void
974b73e8 698fail (void)
9002956f 699{
aa0b6932 700 if (alternate_editor)
9002956f 701 {
aa0b6932 702 int i = optind - 1;
4472aef4 703
974b73e8 704 execvp (alternate_editor, main_argv + i);
42073bfb 705 message (TRUE, "%s: error executing alternate editor \"%s\"\n",
974b73e8 706 progname, alternate_editor);
9002956f 707 }
aa0b6932 708 exit (EXIT_FAILURE);
9002956f
KL
709}
710
aa0b6932 711\f
1e7823d0 712#if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
9002956f 713
aa0b6932 714int
0613f5d5 715main (int argc, char **argv)
9002956f 716{
974b73e8
KL
717 main_argv = argv;
718 progname = argv[0];
719 message (TRUE, "%s: Sorry, the Emacs server is supported only\n"
c0f342ab 720 "on systems with Berkeley sockets.\n",
aa0b6932 721 argv[0]);
974b73e8 722 fail ();
9002956f
KL
723}
724
1e7823d0 725#else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
2828d5f9 726
aa0b6932
JB
727#define AUTH_KEY_LENGTH 64
728#define SEND_BUFFER_SIZE 4096
729
873fbd0b 730extern char *strerror (int);
aa0b6932
JB
731
732/* Buffer to accumulate data to send in TCP connections. */
733char send_buffer[SEND_BUFFER_SIZE + 1];
734int sblen = 0; /* Fill pointer for the send buffer. */
4b7b77f6
JR
735/* Socket used to communicate with the Emacs server process. */
736HSOCKET emacs_socket = 0;
aa0b6932 737
d22b00e5
JR
738/* On Windows, the socket library was historically separate from the standard
739 C library, so errors are handled differently. */
b23b5a5b 740static void
988e88ab 741sock_err_message (const char *function_name)
d22b00e5
JR
742{
743#ifdef WINDOWSNT
744 char* msg = NULL;
745
746 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
747 | FORMAT_MESSAGE_ALLOCATE_BUFFER
748 | FORMAT_MESSAGE_ARGUMENT_ARRAY,
749 NULL, WSAGetLastError (), 0, (LPTSTR)&msg, 0, NULL);
750
751 message (TRUE, "%s: %s: %s\n", progname, function_name, msg);
752
753 LocalFree (msg);
754#else
755 message (TRUE, "%s: %s: %s\n", progname, function_name, strerror (errno));
756#endif
757}
758
759
aa0b6932
JB
760/* Let's send the data to Emacs when either
761 - the data ends in "\n", or
762 - the buffer is full (but this shouldn't happen)
763 Otherwise, we just accumulate it. */
b23b5a5b 764static void
988e88ab 765send_to_emacs (HSOCKET s, const char *data)
aa0b6932
JB
766{
767 while (data)
2828d5f9 768 {
728a982d 769 size_t dlen = strlen (data);
aa0b6932
JB
770 if (dlen + sblen >= SEND_BUFFER_SIZE)
771 {
772 int part = SEND_BUFFER_SIZE - sblen;
773 strncpy (&send_buffer[sblen], data, part);
774 data += part;
775 sblen = SEND_BUFFER_SIZE;
776 }
777 else if (dlen)
778 {
779 strcpy (&send_buffer[sblen], data);
780 data = NULL;
781 sblen += dlen;
782 }
783 else
784 break;
785
786 if (sblen == SEND_BUFFER_SIZE
787 || (sblen > 0 && send_buffer[sblen-1] == '\n'))
788 {
789 int sent = send (s, send_buffer, sblen, 0);
790 if (sent != sblen)
791 strcpy (send_buffer, &send_buffer[sent]);
792 sblen -= sent;
793 }
2828d5f9 794 }
2828d5f9 795}
2828d5f9
KL
796
797\f
0b0d3e0b 798/* In STR, insert a & before each &, each space, each newline, and
a4cf2096 799 any initial -. Change spaces to underscores, too, so that the
0b0d3e0b
KL
800 return value never contains a space.
801
3a35a84c 802 Does not change the string. Outputs the result to S. */
b23b5a5b 803static void
988e88ab 804quote_argument (HSOCKET s, const char *str)
5212210c 805{
9002956f 806 char *copy = (char *) xmalloc (strlen (str) * 2 + 1);
988e88ab
J
807 const char *p;
808 char *q;
5212210c 809
0b0d3e0b 810 p = str;
5212210c
RS
811 q = copy;
812 while (*p)
813 {
814 if (*p == ' ')
815 {
f1db6a73 816 *q++ = '&';
5212210c
RS
817 *q++ = '_';
818 p++;
819 }
3cf8c6aa
SM
820 else if (*p == '\n')
821 {
822 *q++ = '&';
823 *q++ = 'n';
824 p++;
825 }
5212210c
RS
826 else
827 {
0b0d3e0b 828 if (*p == '&' || (*p == '-' && p == str))
f1db6a73 829 *q++ = '&';
5212210c
RS
830 *q++ = *p++;
831 }
832 }
f1db6a73 833 *q++ = 0;
5212210c 834
486ba65f 835 send_to_emacs (s, copy);
87209357
EZ
836
837 free (copy);
5212210c 838}
0c76956f 839
0b0d3e0b
KL
840
841/* The inverse of quote_argument. Removes quoting in string STR by
842 modifying the string in place. Returns STR. */
843
b23b5a5b 844static char *
873fbd0b 845unquote_argument (char *str)
0b0d3e0b
KL
846{
847 char *p, *q;
848
849 if (! str)
850 return str;
851
852 p = str;
853 q = str;
854 while (*p)
855 {
856 if (*p == '&')
857 {
858 p++;
859 if (*p == '&')
860 *p = '&';
861 else if (*p == '_')
862 *p = ' ';
863 else if (*p == 'n')
864 *p = '\n';
865 else if (*p == '-')
866 *p = '-';
867 }
868 *q++ = *p++;
869 }
870 *q = 0;
871 return str;
872}
873
8f9aaa0a 874\f
b23b5a5b 875static int
03fc768b 876file_name_absolute_p (const char *filename)
b03d27bd
JB
877{
878 /* Sanity check, it shouldn't happen. */
879 if (! filename) return FALSE;
880
881 /* /xxx is always an absolute path. */
882 if (filename[0] == '/') return TRUE;
883
884 /* Empty filenames (which shouldn't happen) are relative. */
885 if (filename[0] == '\0') return FALSE;
886
887#ifdef WINDOWSNT
71b8f735 888 /* X:\xxx is always absolute. */
03fc768b 889 if (isalpha ((unsigned char) filename[0])
cb0297bb 890 && filename[1] == ':' && (filename[2] == '\\' || filename[2] == '/'))
b03d27bd
JB
891 return TRUE;
892
893 /* Both \xxx and \\xxx\yyy are absolute. */
894 if (filename[0] == '\\') return TRUE;
895#endif
896
897 return FALSE;
898}
899
aa0b6932 900#ifdef WINDOWSNT
f0384499 901/* Wrapper to make WSACleanup a cdecl, as required by atexit. */
7c3320d8
JB
902void __cdecl
903close_winsock (void)
aa0b6932
JB
904{
905 WSACleanup ();
906}
0c76956f 907
b03d27bd
JB
908/* Initialize the WinSock2 library. */
909void
7c3320d8 910initialize_sockets (void)
0c76956f 911{
aa0b6932
JB
912 WSADATA wsaData;
913
aa0b6932
JB
914 if (WSAStartup (MAKEWORD (2, 0), &wsaData))
915 {
78da39c6 916 message (TRUE, "%s: error initializing WinSock2\n", progname);
aa0b6932
JB
917 exit (EXIT_FAILURE);
918 }
919
920 atexit (close_winsock);
0c76956f 921}
e35fc962 922#endif /* WINDOWSNT */
974b73e8 923
8f9aaa0a 924\f
97e3214d 925/*
aa0b6932 926 * Read the information needed to set up a TCP comm channel with
968ef9b4 927 * the Emacs server: host, port, and authentication string.
0e0dced5 928 */
b23b5a5b 929static int
873fbd0b 930get_server_config (struct sockaddr_in *server, char *authentication)
97e3214d 931{
aa0b6932
JB
932 char dotted[32];
933 char *port;
b03d27bd 934 FILE *config = NULL;
aa0b6932 935
b03d27bd
JB
936 if (file_name_absolute_p (server_file))
937 config = fopen (server_file, "rb");
938 else
97e3214d 939 {
b9170155 940 const char *home = egetenv ("HOME");
88b46d84 941
aa0b6932
JB
942 if (home)
943 {
bc558f3e
JB
944 char *path = alloca (strlen (home) + strlen (server_file)
945 + EXTRA_SPACE);
aa0b6932
JB
946 sprintf (path, "%s/.emacs.d/server/%s", home, server_file);
947 config = fopen (path, "rb");
948 }
88b46d84 949#ifdef WINDOWSNT
7ce8671d 950 if (!config && (home = egetenv ("APPDATA")))
88b46d84 951 {
bc558f3e
JB
952 char *path = alloca (strlen (home) + strlen (server_file)
953 + EXTRA_SPACE);
88b46d84
JB
954 sprintf (path, "%s/.emacs.d/server/%s", home, server_file);
955 config = fopen (path, "rb");
956 }
957#endif
aa0b6932
JB
958 }
959
960 if (! config)
961 return FALSE;
962
963 if (fgets (dotted, sizeof dotted, config)
968ef9b4
JB
964 && (port = strchr (dotted, ':')))
965 *port++ = '\0';
97e3214d
GM
966 else
967 {
78da39c6 968 message (TRUE, "%s: invalid configuration info\n", progname);
65396510 969 exit (EXIT_FAILURE);
97e3214d 970 }
97e3214d 971
aa0b6932
JB
972 server->sin_family = AF_INET;
973 server->sin_addr.s_addr = inet_addr (dotted);
974 server->sin_port = htons (atoi (port));
97e3214d 975
aa0b6932
JB
976 if (! fread (authentication, AUTH_KEY_LENGTH, 1, config))
977 {
78da39c6 978 message (TRUE, "%s: cannot read authentication info\n", progname);
aa0b6932
JB
979 exit (EXIT_FAILURE);
980 }
46cec291 981
aa0b6932 982 fclose (config);
97e3214d 983
aa0b6932 984 return TRUE;
97e3214d
GM
985}
986
b23b5a5b 987static HSOCKET
873fbd0b 988set_tcp_socket (void)
aa0b6932
JB
989{
990 HSOCKET s;
991 struct sockaddr_in server;
aa0b6932
JB
992 struct linger l_arg = {1, 1};
993 char auth_string[AUTH_KEY_LENGTH + 1];
9628b887 994
aa0b6932
JB
995 if (! get_server_config (&server, auth_string))
996 return INVALID_SOCKET;
997
0b973fc5 998 if (server.sin_addr.s_addr != inet_addr ("127.0.0.1") && !quiet)
9219db75 999 message (FALSE, "%s: connected to remote socket at %s\n",
b03d27bd
JB
1000 progname, inet_ntoa (server.sin_addr));
1001
aa0b6932
JB
1002 /*
1003 * Open up an AF_INET socket
1004 */
1005 if ((s = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0)
1006 {
d22b00e5 1007 sock_err_message ("socket");
aa0b6932
JB
1008 return INVALID_SOCKET;
1009 }
1010
1011 /*
1012 * Set up the socket
1013 */
1014 if (connect (s, (struct sockaddr *) &server, sizeof server) < 0)
1015 {
d22b00e5 1016 sock_err_message ("connect");
aa0b6932
JB
1017 return INVALID_SOCKET;
1018 }
1019
aa0b6932
JB
1020 setsockopt (s, SOL_SOCKET, SO_LINGER, (char *) &l_arg, sizeof l_arg);
1021
1022 /*
1023 * Send the authentication
1024 */
1025 auth_string[AUTH_KEY_LENGTH] = '\0';
1026
486ba65f
JR
1027 send_to_emacs (s, "-auth ");
1028 send_to_emacs (s, auth_string);
5ab73228 1029 send_to_emacs (s, " ");
aa0b6932
JB
1030
1031 return s;
1032}
1033
b2ff54a0
JR
1034
1035/* Returns 1 if PREFIX is a prefix of STRING. */
1036static int
988e88ab 1037strprefix (const char *prefix, const char *string)
b2ff54a0 1038{
cb06b8dc 1039 return !strncmp (prefix, string, strlen (prefix));
b2ff54a0
JR
1040}
1041
a336ee5b
CY
1042/* Get tty name and type. If successful, return the type in TTY_TYPE
1043 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1044 is zero, or return 0 if NOABORT is non-zero. */
1045
b23b5a5b 1046static int
b9170155 1047find_tty (const char **tty_type, const char **tty_name, int noabort)
a336ee5b 1048{
b9170155
PE
1049 const char *type = egetenv ("TERM");
1050 const char *name = ttyname (fileno (stdout));
a336ee5b
CY
1051
1052 if (!name)
1053 {
1054 if (noabort)
1055 return 0;
1056 else
1057 {
1058 message (TRUE, "%s: could not get terminal name\n", progname);
1059 fail ();
1060 }
1061 }
1062
1063 if (!type)
1064 {
1065 if (noabort)
1066 return 0;
1067 else
1068 {
1069 message (TRUE, "%s: please set the TERM variable to your terminal type\n",
1070 progname);
1071 fail ();
1072 }
1073 }
1074
1075 if (strcmp (type, "eterm") == 0)
1076 {
1077 if (noabort)
1078 return 0;
1079 else
1080 {
1081 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1082 message (TRUE, "%s: opening a frame in an Emacs term buffer"
1083 " is not supported\n", progname);
1084 fail ();
1085 }
1086 }
1087
1088 *tty_name = name;
1089 *tty_type = type;
1090 return 1;
1091}
1092
b2ff54a0 1093
aa0b6932 1094#if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
46cec291 1095
9f637eea
GM
1096/* Three possibilities:
1097 2 - can't be `stat'ed (sets errno)
1098 1 - isn't owned by us
1099 0 - success: none of the above */
1100
1101static int
b0bbc07d 1102socket_status (char *name)
9f637eea
GM
1103{
1104 struct stat statbfr;
1105
b0bbc07d 1106 if (stat (name, &statbfr) == -1)
9f637eea
GM
1107 return 2;
1108
1109 if (statbfr.st_uid != geteuid ())
1110 return 1;
0b0d3e0b 1111
9f637eea
GM
1112 return 0;
1113}
1114
974b73e8 1115\f
da8e1115
KL
1116/* A signal handler that passes the signal to the Emacs process.
1117 Useful for SIGWINCH. */
1118
9af30bdf 1119static void
428a555e 1120pass_signal_to_emacs (int signalnum)
9628b887
KL
1121{
1122 int old_errno = errno;
1123
9f729af5 1124 if (emacs_pid)
428a555e 1125 kill (emacs_pid, signalnum);
9f729af5 1126
428a555e 1127 signal (signalnum, pass_signal_to_emacs);
9f729af5
KL
1128 errno = old_errno;
1129}
1130
0b0d3e0b
KL
1131/* Signal handler for SIGCONT; notify the Emacs process that it can
1132 now resume our tty frame. */
1133
9af30bdf 1134static void
0b0d3e0b
KL
1135handle_sigcont (int signalnum)
1136{
1137 int old_errno = errno;
1138
1139 if (tcgetpgrp (1) == getpgrp ())
1140 {
1141 /* We are in the foreground. */
486ba65f 1142 send_to_emacs (emacs_socket, "-resume \n");
0b0d3e0b
KL
1143 }
1144 else
1145 {
1146 /* We are in the background; cancel the continue. */
1147 kill (getpid (), SIGSTOP);
1148 }
c6c53c3e
KL
1149
1150 signal (signalnum, handle_sigcont);
0b0d3e0b
KL
1151 errno = old_errno;
1152}
1153
1154/* Signal handler for SIGTSTP; notify the Emacs process that we are
1155 going to sleep. Normally the suspend is initiated by Emacs via
1156 server-handle-suspend-tty, but if the server gets out of sync with
1157 reality, we may get a SIGTSTP on C-z. Handling this signal and
1158 notifying Emacs about it should get things under control again. */
1159
9af30bdf 1160static void
0b0d3e0b
KL
1161handle_sigtstp (int signalnum)
1162{
1163 int old_errno = errno;
1164 sigset_t set;
c0f342ab 1165
90843190 1166 if (emacs_socket)
486ba65f 1167 send_to_emacs (emacs_socket, "-suspend \n");
0b0d3e0b 1168
5ab73228 1169 /* Unblock this signal and call the default handler by temporarily
0b0d3e0b
KL
1170 changing the handler and resignalling. */
1171 sigprocmask (SIG_BLOCK, NULL, &set);
1172 sigdelset (&set, signalnum);
1173 signal (signalnum, SIG_DFL);
1174 kill (getpid (), signalnum);
1175 sigprocmask (SIG_SETMASK, &set, NULL); /* Let's the above signal through. */
1176 signal (signalnum, handle_sigtstp);
1177
1178 errno = old_errno;
1179}
273b9028
CY
1180
1181
da8e1115 1182/* Set up signal handlers before opening a frame on the current tty. */
0b0d3e0b 1183
b23b5a5b 1184static void
4d553a13 1185init_signals (void)
9628b887
KL
1186{
1187 /* Set up signal handlers. */
428a555e 1188 signal (SIGWINCH, pass_signal_to_emacs);
4ca927b4
KL
1189
1190 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1191 deciding which terminal the signal came from. C-g is now a
1192 normal input event on secondary terminals. */
1193#if 0
428a555e
KL
1194 signal (SIGINT, pass_signal_to_emacs);
1195 signal (SIGQUIT, pass_signal_to_emacs);
4ca927b4 1196#endif
0b0d3e0b
KL
1197
1198 signal (SIGCONT, handle_sigcont);
1199 signal (SIGTSTP, handle_sigtstp);
1200 signal (SIGTTOU, handle_sigtstp);
9628b887
KL
1201}
1202
46cec291 1203
b23b5a5b 1204static HSOCKET
873fbd0b 1205set_local_socket (void)
46cec291 1206{
aa0b6932 1207 HSOCKET s;
46cec291 1208 struct sockaddr_un server;
46cec291 1209
e69233c2 1210 /*
46cec291
RS
1211 * Open up an AF_UNIX socket in this person's home directory
1212 */
1213
1214 if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1215 {
42073bfb 1216 message (TRUE, "%s: socket: %s\n", progname, strerror (errno));
aa0b6932 1217 return INVALID_SOCKET;
46cec291 1218 }
e69233c2 1219
46cec291 1220 server.sun_family = AF_UNIX;
c5fee545 1221
c5fee545 1222 {
9f637eea 1223 int sock_status = 0;
5c9659d3 1224 int default_sock = !socket_name;
b80bf66e 1225 int saved_errno = 0;
988e88ab 1226 const char *server_name = "server";
4be3dfc5 1227 const char *tmpdir IF_LINT ( = NULL);
0b0d3e0b 1228
8966b757
AS
1229 if (socket_name && !strchr (socket_name, '/')
1230 && !strchr (socket_name, '\\'))
1231 {
1232 /* socket_name is a file name component. */
d3a6748c
KL
1233 server_name = socket_name;
1234 socket_name = NULL;
1235 default_sock = 1; /* Try both UIDs. */
0734b0d0 1236 }
efb859b4 1237
5c9659d3 1238 if (default_sock)
254107e4 1239 {
f77b11a0
JB
1240 tmpdir = egetenv ("TMPDIR");
1241 if (!tmpdir)
b336bfcd
GM
1242 {
1243#ifdef DARWIN_OS
e6068ab3
YM
1244#ifndef _CS_DARWIN_USER_TEMP_DIR
1245#define _CS_DARWIN_USER_TEMP_DIR 65537
1246#endif
b336bfcd
GM
1247 size_t n = confstr (_CS_DARWIN_USER_TEMP_DIR, NULL, (size_t) 0);
1248 if (n > 0)
1249 {
1250 tmpdir = alloca (n);
1251 confstr (_CS_DARWIN_USER_TEMP_DIR, tmpdir, n);
1252 }
1253 else
1254#endif
1255 tmpdir = "/tmp";
1256 }
bc558f3e
JB
1257 socket_name = alloca (strlen (tmpdir) + strlen (server_name)
1258 + EXTRA_SPACE);
f77b11a0
JB
1259 sprintf (socket_name, "%s/emacs%d/%s",
1260 tmpdir, (int) geteuid (), server_name);
254107e4
RS
1261 }
1262
1263 if (strlen (socket_name) < sizeof (server.sun_path))
1264 strcpy (server.sun_path, socket_name);
1265 else
819b8f00 1266 {
78da39c6 1267 message (TRUE, "%s: socket-name %s too long\n",
974b73e8 1268 progname, socket_name);
819b8f00
KL
1269 fail ();
1270 }
efb859b4 1271
9f637eea
GM
1272 /* See if the socket exists, and if it's owned by us. */
1273 sock_status = socket_status (server.sun_path);
152b6e83 1274 saved_errno = errno;
5c9659d3 1275 if (sock_status && default_sock)
efb859b4 1276 {
9f637eea
GM
1277 /* Failing that, see if LOGNAME or USER exist and differ from
1278 our euid. If so, look for a socket based on the UID
1279 associated with the name. This is reminiscent of the logic
1280 that init_editfns uses to set the global Vuser_full_name. */
e69233c2 1281
b9170155 1282 const char *user_name = egetenv ("LOGNAME");
293f9f2a 1283
9f637eea 1284 if (!user_name)
b9170155 1285 user_name = egetenv ("USER");
e69233c2 1286
9f637eea
GM
1287 if (user_name)
1288 {
1289 struct passwd *pw = getpwnam (user_name);
293f9f2a 1290
9f637eea
GM
1291 if (pw && (pw->pw_uid != geteuid ()))
1292 {
1293 /* We're running under su, apparently. */
bc558f3e
JB
1294 socket_name = alloca (strlen (tmpdir) + strlen (server_name)
1295 + EXTRA_SPACE);
f77b11a0
JB
1296 sprintf (socket_name, "%s/emacs%d/%s",
1297 tmpdir, (int) pw->pw_uid, server_name);
5c9659d3
SM
1298
1299 if (strlen (socket_name) < sizeof (server.sun_path))
1300 strcpy (server.sun_path, socket_name);
1301 else
1302 {
78da39c6 1303 message (TRUE, "%s: socket-name %s too long\n",
aa0b6932 1304 progname, socket_name);
65396510 1305 exit (EXIT_FAILURE);
5c9659d3
SM
1306 }
1307
9f637eea 1308 sock_status = socket_status (server.sun_path);
b80bf66e 1309 saved_errno = errno;
9f637eea 1310 }
293f9f2a
RS
1311 else
1312 errno = saved_errno;
9f637eea 1313 }
efb859b4 1314 }
e69233c2 1315
aa0b6932
JB
1316 switch (sock_status)
1317 {
1318 case 1:
974b73e8
KL
1319 /* There's a socket, but it isn't owned by us. This is OK if
1320 we are root. */
1321 if (0 != geteuid ())
1322 {
1323 message (TRUE, "%s: Invalid socket owner\n", progname);
aa0b6932 1324 return INVALID_SOCKET;
974b73e8
KL
1325 }
1326 break;
aa0b6932
JB
1327
1328 case 2:
974b73e8
KL
1329 /* `stat' failed */
1330 if (saved_errno == ENOENT)
1331 message (TRUE,
1332 "%s: can't find socket; have you started the server?\n\
45adde32 1333To start the server in Emacs, type \"M-x server-start\".\n",
aa0b6932 1334 progname);
974b73e8
KL
1335 else
1336 message (TRUE, "%s: can't stat %s: %s\n",
aa0b6932 1337 progname, server.sun_path, strerror (saved_errno));
974b73e8 1338 return INVALID_SOCKET;
aa0b6932 1339 }
efb859b4 1340 }
46cec291 1341
4e23f2ba
JB
1342 if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
1343 < 0)
46cec291 1344 {
42073bfb 1345 message (TRUE, "%s: connect: %s\n", progname, strerror (errno));
aa0b6932 1346 return INVALID_SOCKET;
46cec291 1347 }
23a7488d 1348
aa0b6932
JB
1349 return s;
1350}
1351#endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1352
b23b5a5b 1353static HSOCKET
636b507b 1354set_socket (int no_exit_if_error)
aa0b6932 1355{
b03d27bd 1356 HSOCKET s;
c0f342ab 1357
b03d27bd 1358 INITIALIZE ();
c0f342ab 1359
aa0b6932 1360#ifndef NO_SOCKETS_IN_FILE_SYSTEM
b03d27bd
JB
1361 /* Explicit --socket-name argument. */
1362 if (socket_name)
46cec291 1363 {
b03d27bd 1364 s = set_local_socket ();
636b507b 1365 if ((s != INVALID_SOCKET) || no_exit_if_error)
974b73e8 1366 return s;
355a326e 1367 message (TRUE, "%s: error accessing socket \"%s\"\n",
974b73e8 1368 progname, socket_name);
b03d27bd 1369 exit (EXIT_FAILURE);
46cec291 1370 }
b03d27bd
JB
1371#endif
1372
1373 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1374 if (!server_file)
7ce8671d 1375 server_file = egetenv ("EMACS_SERVER_FILE");
46cec291 1376
b03d27bd 1377 if (server_file)
23a7488d 1378 {
b03d27bd 1379 s = set_tcp_socket ();
636b507b 1380 if ((s != INVALID_SOCKET) || no_exit_if_error)
974b73e8 1381 return s;
c0f342ab 1382
78da39c6 1383 message (TRUE, "%s: error accessing server file \"%s\"\n",
974b73e8 1384 progname, server_file);
b03d27bd 1385 exit (EXIT_FAILURE);
23a7488d 1386 }
c0f342ab 1387
b03d27bd
JB
1388#ifndef NO_SOCKETS_IN_FILE_SYSTEM
1389 /* Implicit local socket. */
1390 s = set_local_socket ();
1391 if (s != INVALID_SOCKET)
1392 return s;
1393#endif
23a7488d 1394
b03d27bd
JB
1395 /* Implicit server file. */
1396 server_file = "server";
1397 s = set_tcp_socket ();
636b507b 1398 if ((s != INVALID_SOCKET) || no_exit_if_error)
b03d27bd
JB
1399 return s;
1400
1401 /* No implicit or explicit socket, and no alternate editor. */
42073bfb 1402 message (TRUE, "%s: No socket or alternate editor. Please use:\n\n"
b03d27bd
JB
1403#ifndef NO_SOCKETS_IN_FILE_SYSTEM
1404"\t--socket-name\n"
ee6a193c 1405#endif
b03d27bd
JB
1406"\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1407\t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1408 progname);
1409 exit (EXIT_FAILURE);
aa0b6932 1410}
46cec291 1411
0e0dced5
JB
1412#ifdef WINDOWSNT
1413FARPROC set_fg; /* Pointer to AllowSetForegroundWindow. */
1414FARPROC get_wc; /* Pointer to RealGetWindowClassA. */
1415
1416BOOL CALLBACK
7c3320d8 1417w32_find_emacs_process (HWND hWnd, LPARAM lParam)
0e0dced5
JB
1418{
1419 DWORD pid;
1420 char class[6];
1421
1422 /* Reject any window not of class "Emacs". */
1423 if (! get_wc (hWnd, class, sizeof (class))
1424 || strcmp (class, "Emacs"))
1425 return TRUE;
1426
1427 /* We only need the process id, not the thread id. */
1428 (void) GetWindowThreadProcessId (hWnd, &pid);
1429
1430 /* Not the one we're looking for. */
1431 if (pid != (DWORD) emacs_pid) return TRUE;
1432
1433 /* OK, let's raise it. */
1434 set_fg (emacs_pid);
1435
1436 /* Stop enumeration. */
1437 return FALSE;
1438}
1439
1440/*
1441 * Search for a window of class "Emacs" and owned by a process with
1442 * process id = emacs_pid. If found, allow it to grab the focus.
1443 */
1444void
7c3320d8 1445w32_give_focus (void)
0e0dced5 1446{
ff90fbde 1447 HANDLE user32;
0e0dced5 1448
71b8f735 1449 /* It shouldn't happen when dealing with TCP sockets. */
0e0dced5
JB
1450 if (!emacs_pid) return;
1451
ff90fbde
JR
1452 user32 = GetModuleHandle ("user32.dll");
1453
1454 if (!user32)
1455 return;
0e0dced5
JB
1456
1457 /* Modern Windows restrict which processes can set the foreground window.
1458 emacsclient can allow Emacs to grab the focus by calling the function
1459 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1460 NT) lack this function, so we have to check its availability. */
ff90fbde
JR
1461 if ((set_fg = GetProcAddress (user32, "AllowSetForegroundWindow"))
1462 && (get_wc = GetProcAddress (user32, "RealGetWindowClassA")))
0e0dced5 1463 EnumWindows (w32_find_emacs_process, (LPARAM) 0);
0e0dced5
JB
1464}
1465#endif
1466
636b507b
DN
1467/* Start the emacs daemon and try to connect to it. */
1468
b23b5a5b 1469static void
636b507b
DN
1470start_daemon_and_retry_set_socket (void)
1471{
802bdb3c 1472#ifndef WINDOWSNT
636b507b
DN
1473 pid_t dpid;
1474 int status;
636b507b
DN
1475
1476 dpid = fork ();
1477
1478 if (dpid > 0)
1479 {
fd95644b
DN
1480 pid_t w;
1481 w = waitpid (dpid, &status, WUNTRACED | WCONTINUED);
636b507b 1482
361358ea 1483 if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS (status))
fd95644b
DN
1484 {
1485 message (TRUE, "Error: Could not start the Emacs daemon\n");
1486 exit (EXIT_FAILURE);
1487 }
1488
1489 /* Try connecting, the daemon should have started by now. */
1490 message (TRUE, "Emacs daemon should have started, trying to connect again\n");
636b507b 1491 if ((emacs_socket = set_socket (1)) == INVALID_SOCKET)
fd95644b
DN
1492 {
1493 message (TRUE, "Error: Cannot connect even after starting the Emacs daemon\n");
1494 exit (EXIT_FAILURE);
1495 }
636b507b
DN
1496 }
1497 else if (dpid < 0)
1498 {
fd95644b 1499 fprintf (stderr, "Error: Cannot fork!\n");
6ab88e02 1500 exit (EXIT_FAILURE);
636b507b
DN
1501 }
1502 else
1503 {
988e88ab 1504 char emacs[] = "emacs";
b0bbc07d
PE
1505 char daemon_option[] = "--daemon";
1506 char *d_argv[] = {emacs, daemon_option, 0 };
636b507b
DN
1507 if (socket_name != NULL)
1508 {
1509 /* Pass --daemon=socket_name as argument. */
988e88ab 1510 const char *deq = "--daemon=";
636b507b
DN
1511 char *daemon_arg = alloca (strlen (deq)
1512 + strlen (socket_name) + 1);
1513 strcpy (daemon_arg, deq);
1514 strcat (daemon_arg, socket_name);
1515 d_argv[1] = daemon_arg;
1516 }
1517 execvp ("emacs", d_argv);
1518 message (TRUE, "%s: error starting emacs daemon\n", progname);
1519 }
802bdb3c 1520#endif /* WINDOWSNT */
636b507b
DN
1521}
1522
aa0b6932 1523int
873fbd0b 1524main (int argc, char **argv)
aa0b6932 1525{
b0bbc07d 1526 int rl, needlf = 0;
974b73e8 1527 char *cwd, *str;
aa0b6932 1528 char string[BUFSIZ+1];
4be3dfc5
PE
1529 int null_socket_name IF_LINT ( = 0);
1530 int null_server_file IF_LINT ( = 0);
1531 int start_daemon_if_needed;
3ecb8d93 1532 int exit_status = EXIT_SUCCESS;
aa0b6932 1533
974b73e8 1534 main_argv = argv;
aa0b6932
JB
1535 progname = argv[0];
1536
ff90fbde
JR
1537#ifdef WINDOWSNT
1538 /* On Windows 7 and later, we need to explicitly associate emacsclient
1539 with emacs so the UI behaves sensibly. */
1540 w32_set_user_model_id ();
1541#endif
1542
aa0b6932
JB
1543 /* Process options. */
1544 decode_options (argc, argv);
1545
273b9028 1546 if ((argc - optind < 1) && !eval && current_frame)
23a7488d 1547 {
974b73e8
KL
1548 message (TRUE, "%s: file name or argument required\n"
1549 "Try `%s --help' for more information\n",
1550 progname, progname);
aa0b6932 1551 exit (EXIT_FAILURE);
23a7488d
RS
1552 }
1553
636b507b
DN
1554 /* If alternate_editor is the empty string, start the emacs daemon
1555 in case of failure to connect. */
1556 start_daemon_if_needed = (alternate_editor
1557 && (alternate_editor[0] == '\0'));
1558 if (start_daemon_if_needed)
1559 {
1560 /* set_socket changes the values for socket_name and
1561 server_file, we need to reset them, if they were NULL before
1562 for the second call to set_socket. */
1563 null_socket_name = (socket_name == NULL);
1564 null_server_file = (server_file == NULL);
1565 }
aa0b6932 1566
7e6bb4c9
PE
1567 emacs_socket = set_socket (alternate_editor || start_daemon_if_needed);
1568 if (emacs_socket == INVALID_SOCKET)
1569 {
1570 if (! start_daemon_if_needed)
1571 fail ();
1572
1573 /* Reset socket_name and server_file if they were NULL
1574 before the set_socket call. */
1575 if (null_socket_name)
1576 socket_name = NULL;
1577 if (null_server_file)
1578 server_file = NULL;
1579
1580 start_daemon_and_retry_set_socket ();
1581 }
974b73e8
KL
1582
1583 cwd = get_current_dir_name ();
46cec291
RS
1584 if (cwd == 0)
1585 {
1586 /* getwd puts message in STRING if it fails. */
974b73e8
KL
1587 message (TRUE, "%s: %s\n", progname,
1588 "Cannot get current working directory");
819b8f00 1589 fail ();
46cec291
RS
1590 }
1591
c66648e0 1592#ifdef WINDOWSNT
0e0dced5 1593 w32_give_focus ();
c66648e0
JB
1594#endif
1595
273b9028 1596 /* Send over our environment and current directory. */
59e085e0
KL
1597 if (!current_frame)
1598 {
1599 extern char **environ;
1600 int i;
1601 for (i = 0; environ[i]; i++)
1602 {
486ba65f
JR
1603 send_to_emacs (emacs_socket, "-env ");
1604 quote_argument (emacs_socket, environ[i]);
1605 send_to_emacs (emacs_socket, " ");
59e085e0 1606 }
2828d5f9 1607 }
ba528748
SM
1608 send_to_emacs (emacs_socket, "-dir ");
1609 quote_argument (emacs_socket, cwd);
1610 send_to_emacs (emacs_socket, "/");
1611 send_to_emacs (emacs_socket, " ");
2828d5f9 1612
6afdd335 1613 retry:
5212210c 1614 if (nowait)
486ba65f 1615 send_to_emacs (emacs_socket, "-nowait ");
292d74a3 1616
92071250 1617 if (current_frame)
486ba65f 1618 send_to_emacs (emacs_socket, "-current-frame ");
c0f342ab 1619
30be2360 1620 if (display)
87209357 1621 {
486ba65f
JR
1622 send_to_emacs (emacs_socket, "-display ");
1623 quote_argument (emacs_socket, display);
1624 send_to_emacs (emacs_socket, " ");
87209357 1625 }
30be2360 1626
0191e222
CY
1627 if (parent_id)
1628 {
1629 send_to_emacs (emacs_socket, "-parent-id ");
1630 quote_argument (emacs_socket, parent_id);
1631 send_to_emacs (emacs_socket, " ");
1632 }
1633
8536c0f5
CY
1634 /* If using the current frame, send tty information to Emacs anyway.
1635 In daemon mode, Emacs may need to occupy this tty if no other
1636 frame is available. */
322ca650 1637 if (tty || (current_frame && !eval))
9628b887 1638 {
b9170155 1639 const char *tty_type, *tty_name;
0b0d3e0b 1640
273b9028
CY
1641 if (find_tty (&tty_type, &tty_name, !tty))
1642 {
b2ff54a0 1643#if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
273b9028 1644 init_signals ();
b2ff54a0 1645#endif
273b9028
CY
1646 send_to_emacs (emacs_socket, "-tty ");
1647 quote_argument (emacs_socket, tty_name);
1648 send_to_emacs (emacs_socket, " ");
1649 quote_argument (emacs_socket, tty_type);
1650 send_to_emacs (emacs_socket, " ");
1651 }
9628b887 1652 }
77134727 1653
273b9028 1654 if (!current_frame && !tty)
486ba65f 1655 send_to_emacs (emacs_socket, "-window-system ");
0b0d3e0b 1656
87209357 1657 if ((argc - optind > 0))
5212210c 1658 {
b0bbc07d 1659 int i;
87209357 1660 for (i = optind; i < argc; i++)
46cec291 1661 {
0b0d3e0b 1662
87209357 1663 if (eval)
0b0d3e0b 1664 {
974b73e8 1665 /* Don't prepend cwd or anything like that. */
486ba65f
JR
1666 send_to_emacs (emacs_socket, "-eval ");
1667 quote_argument (emacs_socket, argv[i]);
1668 send_to_emacs (emacs_socket, " ");
0b0d3e0b
KL
1669 continue;
1670 }
1671
1672 if (*argv[i] == '+')
1673 {
87209357
EZ
1674 char *p = argv[i] + 1;
1675 while (isdigit ((unsigned char) *p) || *p == ':') p++;
0b0d3e0b
KL
1676 if (*p == 0)
1677 {
486ba65f
JR
1678 send_to_emacs (emacs_socket, "-position ");
1679 quote_argument (emacs_socket, argv[i]);
1680 send_to_emacs (emacs_socket, " ");
0b0d3e0b
KL
1681 continue;
1682 }
0b0d3e0b 1683 }
6cde1b21
JB
1684#ifdef WINDOWSNT
1685 else if (! file_name_absolute_p (argv[i])
1686 && (isalpha (argv[i][0]) && argv[i][1] == ':'))
1687 /* Windows can have a different default directory for each
1688 drive, so the cwd passed via "-dir" is not sufficient
1689 to account for that.
1690 If the user uses <drive>:<relpath>, we hence need to be
1691 careful to expand <relpath> with the default directory
1692 corresponding to <drive>. */
1693 {
1694 char *filename = (char *) xmalloc (MAX_PATH);
1695 DWORD size;
1696
1697 size = GetFullPathName (argv[i], MAX_PATH, filename, NULL);
1698 if (size > 0 && size < MAX_PATH)
1699 argv[i] = filename;
1700 else
1701 free (filename);
1702 }
1703#endif
0b0d3e0b 1704
486ba65f 1705 send_to_emacs (emacs_socket, "-file ");
486ba65f
JR
1706 quote_argument (emacs_socket, argv[i]);
1707 send_to_emacs (emacs_socket, " ");
0b0d3e0b 1708 }
46cec291 1709 }
273b9028 1710 else if (eval)
87209357 1711 {
273b9028
CY
1712 /* Read expressions interactively. */
1713 while ((str = fgets (string, BUFSIZ, stdin)))
1714 {
1715 send_to_emacs (emacs_socket, "-eval ");
1716 quote_argument (emacs_socket, str);
1717 }
1718 send_to_emacs (emacs_socket, " ");
87209357 1719 }
0b0d3e0b 1720
486ba65f 1721 send_to_emacs (emacs_socket, "\n");
46cec291 1722
fc2040c0 1723 /* Wait for an answer. */
0b973fc5 1724 if (!eval && !tty && !nowait && !quiet)
30be2360
SM
1725 {
1726 printf ("Waiting for Emacs...");
1727 needlf = 2;
1728 }
46cec291 1729 fflush (stdout);
0b0d3e0b 1730 fsync (1);
46cec291 1731
3cf8c6aa 1732 /* Now, wait for an answer and print any messages. */
b166dcd8 1733 while (exit_status == EXIT_SUCCESS)
3cf8c6aa 1734 {
974b73e8 1735 char *p;
b166dcd8
KC
1736 do
1737 {
1738 errno = 0;
1739 rl = recv (emacs_socket, string, BUFSIZ, 0);
1740 }
1741 /* If we receive a signal (e.g. SIGWINCH, which we pass
1742 through to Emacs), on some OSes we get EINTR and must retry. */
1743 while (rl < 0 && errno == EINTR);
1744
1745 if (rl <= 0)
1746 break;
b23b5a5b 1747
974b73e8
KL
1748 string[rl] = '\0';
1749
1750 p = string + strlen (string) - 1;
1751 while (p > string && *p == '\n')
0b0d3e0b
KL
1752 *p-- = 0;
1753
31fa6595 1754 if (strprefix ("-emacs-pid ", string))
4d553a13 1755 {
6afdd335 1756 /* -emacs-pid PID: The process id of the Emacs process. */
77134727
KL
1757 emacs_pid = strtol (string + strlen ("-emacs-pid"), NULL, 10);
1758 }
974b73e8 1759 else if (strprefix ("-window-system-unsupported ", string))
6afdd335
KL
1760 {
1761 /* -window-system-unsupported: Emacs was compiled without X
1762 support. Try again on the terminal. */
6afdd335
KL
1763 nowait = 0;
1764 tty = 1;
1765 goto retry;
1766 }
974b73e8 1767 else if (strprefix ("-print ", string))
77134727 1768 {
6afdd335 1769 /* -print STRING: Print STRING on the terminal. */
974b73e8 1770 str = unquote_argument (string + strlen ("-print "));
0b0d3e0b 1771 if (needlf)
77134727 1772 printf ("\n");
0b0d3e0b
KL
1773 printf ("%s", str);
1774 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
77134727 1775 }
974b73e8 1776 else if (strprefix ("-error ", string))
77134727 1777 {
6afdd335 1778 /* -error DESCRIPTION: Signal an error on the terminal. */
974b73e8 1779 str = unquote_argument (string + strlen ("-error "));
0b0d3e0b
KL
1780 if (needlf)
1781 printf ("\n");
974b73e8 1782 fprintf (stderr, "*ERROR*: %s", str);
0b0d3e0b 1783 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
3ecb8d93 1784 exit_status = EXIT_FAILURE;
0b0d3e0b 1785 }
c801ad51 1786#ifdef SIGSTOP
382707ec 1787 else if (strprefix ("-suspend ", string))
0b0d3e0b 1788 {
6afdd335 1789 /* -suspend: Suspend this terminal, i.e., stop the process. */
0b0d3e0b 1790 if (needlf)
77134727 1791 printf ("\n");
0b0d3e0b
KL
1792 needlf = 0;
1793 kill (0, SIGSTOP);
4d553a13 1794 }
b2ff54a0 1795#endif
4d553a13
KL
1796 else
1797 {
6afdd335 1798 /* Unknown command. */
0b0d3e0b 1799 if (needlf)
4d553a13 1800 printf ("\n");
974b73e8 1801 printf ("*ERROR*: Unknown message: %s", string);
3ecb8d93
WS
1802 needlf = string[0]
1803 == '\0' ? needlf : string[strlen (string) - 1] != '\n';
4d553a13 1804 }
3cf8c6aa
SM
1805 }
1806
1807 if (needlf)
1808 printf ("\n");
1809 fflush (stdout);
0b0d3e0b 1810 fsync (1);
23a7488d 1811
3ecb8d93
WS
1812 if (rl < 0)
1813 exit_status = EXIT_FAILURE;
1814
4b7b77f6 1815 CLOSE_SOCKET (emacs_socket);
3ecb8d93 1816 return exit_status;
46cec291
RS
1817}
1818
1e7823d0 1819#endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
aa0b6932 1820
27711600
RM
1821\f
1822#ifndef HAVE_STRERROR
1823char *
1824strerror (errnum)
1825 int errnum;
1826{
1827 extern char *sys_errlist[];
1828 extern int sys_nerr;
1829
1830 if (errnum >= 0 && errnum < sys_nerr)
1831 return sys_errlist[errnum];
1832 return (char *) "Unknown error";
1833}
1834
1835#endif /* ! HAVE_STRERROR */
ab5796a9 1836
65396510
TTN
1837
1838/* emacsclient.c ends here */