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