lib-src/emacsclient.c

   1 /* Client process that communicates with GNU Emacs acting as server.
   2    Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2003
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22
  23 #define NO_SHORTNAMES
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include <config.h>
  27 #endif
  28
  29 #undef signal
  30
  31 #include <ctype.h>
  32 #include <stdio.h>
  33 #include <getopt.h>
  34 #ifdef HAVE_UNISTD_H
  35 #include <unistd.h>
  36 #endif
  37
  38 #ifdef VMS
  39 # include "vms-pwd.h"
  40 #else
  41 # include <pwd.h>
  42 #endif /* not VMS */
  43
  44 char *getenv (), *getwd ();
  45 char *getcwd ();
  46
  47 /* This is defined with -D from the compilation command,
  48    which extracts it from ../lisp/version.el.  */
  49
  50 #ifndef VERSION
  51 #define VERSION "unspecified"
  52 #endif
  53 \f
  54 /* Name used to invoke this program.  */
  55 char *progname;
  56
  57 /* Nonzero means don't wait for a response from Emacs.  --no-wait.  */
  58 int nowait = 0;
  59
  60 /* Nonzero means args are expressions to be evaluated.  --eval.  */
  61 int eval = 0;
  62
  63 /* The display on which Emacs should work.  --display.  */
  64 char *display = NULL;
  65
  66 /* If non-NULL, the name of an editor to fallback to if the server
  67    is not running.  --alternate-editor.   */
  68 const char * alternate_editor = NULL;
  69
  70 void print_help_and_exit ();
  71
  72 struct option longopts[] =
  73 {
  74   { "no-wait",  no_argument,       NULL, 'n' },
  75   { "eval",     no_argument,       NULL, 'e' },
  76   { "help",     no_argument,       NULL, 'H' },
  77   { "version",  no_argument,       NULL, 'V' },
  78   { "alternate-editor", required_argument, NULL, 'a' },
  79   { "display",  required_argument, NULL, 'd' },
  80   { 0, 0, 0, 0 }
  81 };
  82
  83 /* Decode the options from argv and argc.
  84    The global variable `optind' will say how many arguments we used up.  */
  85
  86 void
  87 decode_options (argc, argv)
  88      int argc;
  89      char **argv;
  90 {
  91   while (1)
  92     {
  93       int opt = getopt_long (argc, argv,
  94                              "VHnea:d:", longopts, 0);
  95
  96       if (opt == EOF)
  97         break;
  98
  99       alternate_editor = getenv ("ALTERNATE_EDITOR");
 100
 101       switch (opt)
 102         {
 103         case 0:
 104           /* If getopt returns 0, then it has already processed a
 105              long-named option.  We should do nothing.  */
 106           break;
 107
 108         case 'a':
 109           alternate_editor = optarg;
 110           break;
 111
 112         case 'd':
 113           display = optarg;
 114           break;
 115
 116         case 'n':
 117           nowait = 1;
 118           break;
 119
 120         case 'e':
 121           eval = 1;
 122           break;
 123
 124         case 'V':
 125           printf ("emacsclient %s\n", VERSION);
 126           exit (0);
 127           break;
 128
 129         case 'H':
 130           print_help_and_exit ();
 131           break;
 132
 133         default:
 134           fprintf (stderr, "Try `%s --help' for more information\n", progname);
 135           exit (1);
 136           break;
 137         }
 138     }
 139 }
 140
 141 void
 142 print_help_and_exit ()
 143 {
 144   printf (
 145           "Usage: %s [OPTIONS] FILE...\n\
 146 Tell the Emacs server to visit the specified files.\n\
 147 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
 148 \n\
 149 The following OPTIONS are accepted:\n\
 150 -V, --version           Just print a version info and return\n\
 151 -H, --help              Print this usage information message\n\
 152 -n, --no-wait           Don't wait for the server to return\n\
 153 -e, --eval              Evaluate the FILE arguments as ELisp expressions\n\
 154 -d, --display=DISPLAY   Visit the file in the given display\n\
 155 -a, --alternate-editor=EDITOR\n\
 156                         Editor to fallback to if the server is not running\n\
 157 \n\
 158 Report bugs to bug-gnu-emacs@gnu.org.\n", progname);
 159   exit (0);
 160 }
 161
 162 /* Return a copy of NAME, inserting a &
 163    before each &, each space, each newline, and any initial -.
 164    Change spaces to underscores, too, so that the
 165    return value never contains a space.  */
 166
 167 char *
 168 quote_file_name (name)
 169      char *name;
 170 {
 171   char *copy = (char *) malloc (strlen (name) * 2 + 1);
 172   char *p, *q;
 173
 174   p = name;
 175   q = copy;
 176   while (*p)
 177     {
 178       if (*p == ' ')
 179         {
 180           *q++ = '&';
 181           *q++ = '_';
 182           p++;
 183         }
 184       else if (*p == '\n')
 185         {
 186           *q++ = '&';
 187           *q++ = 'n';
 188           p++;
 189         }
 190       else
 191         {
 192           if (*p == '&' || (*p == '-' && p == name))
 193             *q++ = '&';
 194           *q++ = *p++;
 195         }
 196     }
 197   *q++ = 0;
 198
 199   return copy;
 200 }
 201
 202 /* Like malloc but get fatal error if memory is exhausted.  */
 203
 204 long *
 205 xmalloc (size)
 206      unsigned int size;
 207 {
 208   long *result = (long *) malloc (size);
 209   if (result == NULL)
 210   {
 211     perror ("malloc");
 212     exit (1);
 213   }
 214   return result;
 215 }
 216 \f
 217 /*
 218   Try to run a different command, or --if no alternate editor is
 219   defined-- exit with an errorcode.
 220 */
 221 void
 222 fail (argc, argv)
 223      int argc;
 224      char **argv;
 225 {
 226   if (alternate_editor)
 227     {
 228       int i = optind - 1;
 229       execvp (alternate_editor, argv + i);
 230       return;
 231     }
 232   else
 233     {
 234       exit (1);
 235     }
 236 }
 237
 238
 239 \f
 240 #if !defined (HAVE_SOCKETS) || defined (NO_SOCKETS_IN_FILE_SYSTEM)
 241
 242 int
 243 main (argc, argv)
 244      int argc;
 245      char **argv;
 246 {
 247   fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n",
 248            argv[0]);
 249   fprintf (stderr, "on systems with Berkeley sockets.\n");
 250
 251   fail (argc, argv);
 252 }
 253
 254 #else /* HAVE_SOCKETS */
 255
 256 #include <sys/types.h>
 257 #include <sys/socket.h>
 258 #include <sys/un.h>
 259 #include <sys/stat.h>
 260 #include <errno.h>
 261
 262 extern char *strerror ();
 263 extern int errno;
 264
 265 /* Three possibilities:
 266    2 - can't be `stat'ed                (sets errno)
 267    1 - isn't owned by us
 268    0 - success: none of the above */
 269
 270 static int
 271 socket_status (socket_name)
 272      char *socket_name;
 273 {
 274   struct stat statbfr;
 275
 276   if (stat (socket_name, &statbfr) == -1)
 277     return 2;
 278
 279   if (statbfr.st_uid != geteuid ())
 280     return 1;
 281
 282   return 0;
 283 }
 284
 285 int
 286 main (argc, argv)
 287      int argc;
 288      char **argv;
 289 {
 290   char *system_name;
 291   int system_name_length;
 292   int s, i, needlf = 0;
 293   FILE *out, *in;
 294   struct sockaddr_un server;
 295   char *cwd, *str;
 296   char string[BUFSIZ];
 297
 298   progname = argv[0];
 299
 300   /* Process options.  */
 301   decode_options (argc, argv);
 302
 303   if (argc - optind < 1)
 304     {
 305       fprintf (stderr, "%s: file name or argument required\n", progname);
 306       fprintf (stderr, "Try `%s --help' for more information\n", progname);
 307       exit (1);
 308     }
 309
 310   /*
 311    * Open up an AF_UNIX socket in this person's home directory
 312    */
 313
 314   if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
 315     {
 316       fprintf (stderr, "%s: ", argv[0]);
 317       perror ("socket");
 318       fail (argc, argv);
 319     }
 320
 321   server.sun_family = AF_UNIX;
 322
 323   {
 324     char *dot;
 325     system_name_length = 32;
 326
 327     while (1)
 328       {
 329         system_name = (char *) xmalloc (system_name_length + 1);
 330
 331         /* system_name must be null-terminated string.  */
 332         system_name[system_name_length] = '\0';
 333
 334         if (gethostname (system_name, system_name_length) == 0)
 335           break;
 336
 337         free (system_name);
 338         system_name_length *= 2;
 339       }
 340
 341     /* We always use the non-dotted host name, for simplicity.  */
 342     dot = index (system_name, '.');
 343     if (dot)
 344       *dot = '\0';
 345   }
 346
 347   {
 348     int sock_status = 0;
 349
 350     sprintf (server.sun_path, "/tmp/emacs%d-%s/server", (int) geteuid (), system_name);
 351
 352     /* See if the socket exists, and if it's owned by us. */
 353     sock_status = socket_status (server.sun_path);
 354     if (sock_status)
 355       {
 356         /* Failing that, see if LOGNAME or USER exist and differ from
 357            our euid.  If so, look for a socket based on the UID
 358            associated with the name.  This is reminiscent of the logic
 359            that init_editfns uses to set the global Vuser_full_name.  */
 360
 361         char *user_name = (char *) getenv ("LOGNAME");
 362         if (!user_name)
 363           user_name = (char *) getenv ("USER");
 364
 365         if (user_name)
 366           {
 367             struct passwd *pw = getpwnam (user_name);
 368             if (pw && (pw->pw_uid != geteuid ()))
 369               {
 370                 /* We're running under su, apparently. */
 371                 sprintf (server.sun_path, "/tmp/esrv%d-%s",
 372                          (int) pw->pw_uid, system_name);
 373                 sock_status = socket_status (server.sun_path);
 374               }
 375           }
 376       }
 377
 378      switch (sock_status)
 379        {
 380        case 1:
 381          /* There's a socket, but it isn't owned by us.  This is OK if
 382             we are root. */
 383          if (0 != geteuid ())
 384            {
 385              fprintf (stderr, "%s: Invalid socket owner\n", argv[0]);
 386              fail (argc, argv);
 387            }
 388          break;
 389
 390        case 2:
 391          /* `stat' failed */
 392          if (errno == ENOENT)
 393            fprintf (stderr,
 394                     "%s: can't find socket; have you started the server?\n\
 395 To start the server in Emacs, type \"M-x server-start\".\n",
 396                     argv[0]);
 397          else
 398            fprintf (stderr, "%s: can't stat %s: %s\n",
 399                     argv[0], server.sun_path, strerror (errno));
 400          fail (argc, argv);
 401          break;
 402        }
 403   }
 404
 405   if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
 406       < 0)
 407     {
 408       fprintf (stderr, "%s: ", argv[0]);
 409       perror ("connect");
 410       fail (argc, argv);
 411     }
 412
 413   /* We use the stream OUT to send our command to the server.  */
 414   if ((out = fdopen (s, "r+")) == NULL)
 415     {
 416       fprintf (stderr, "%s: ", argv[0]);
 417       perror ("fdopen");
 418       fail (argc, argv);
 419     }
 420
 421   /* We use the stream IN to read the response.
 422      We used to use just one stream for both output and input
 423      on the socket, but reversing direction works nonportably:
 424      on some systems, the output appears as the first input;
 425      on other systems it does not.  */
 426   if ((in = fdopen (s, "r+")) == NULL)
 427     {
 428       fprintf (stderr, "%s: ", argv[0]);
 429       perror ("fdopen");
 430       fail (argc, argv);
 431     }
 432
 433 #ifdef HAVE_GETCWD
 434   cwd = getcwd (string, sizeof string);
 435 #else
 436   cwd = getwd (string);
 437 #endif
 438   if (cwd == 0)
 439     {
 440       /* getwd puts message in STRING if it fails.  */
 441
 442 #ifdef HAVE_GETCWD
 443       fprintf (stderr, "%s: %s (%s)\n", argv[0],
 444                "Cannot get current working directory", strerror (errno));
 445 #else
 446       fprintf (stderr, "%s: %s (%s)\n", argv[0], string, strerror (errno));
 447 #endif
 448       fail (argc, argv);
 449     }
 450
 451   if (nowait)
 452     fprintf (out, "-nowait ");
 453
 454   if (eval)
 455     fprintf (out, "-eval ");
 456
 457   if (display)
 458     fprintf (out, "-display %s ", quote_file_name (display));
 459
 460   for (i = optind; i < argc; i++)
 461     {
 462       if (eval)
 463         ; /* Don't prepend any cwd or anything like that.  */
 464       else if (*argv[i] == '+')
 465         {
 466           char *p = argv[i] + 1;
 467           while (isdigit ((unsigned char) *p) || *p == ':') p++;
 468           if (*p != 0)
 469             fprintf (out, "%s/", quote_file_name (cwd));
 470         }
 471       else if (*argv[i] != '/')
 472         fprintf (out, "%s/", quote_file_name (cwd));
 473
 474       fprintf (out, "%s ", quote_file_name (argv[i]));
 475     }
 476   fprintf (out, "\n");
 477   fflush (out);
 478
 479   /* Maybe wait for an answer.   */
 480   if (nowait)
 481     return 0;
 482
 483   if (!eval)
 484     {
 485       printf ("Waiting for Emacs...");
 486       needlf = 2;
 487     }
 488   fflush (stdout);
 489
 490   /* Now, wait for an answer and print any messages.  */
 491   while ((str = fgets (string, BUFSIZ, in)))
 492     {
 493       if (needlf == 2)
 494         printf ("\n");
 495       printf ("%s", str);
 496       needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
 497     }
 498
 499   if (needlf)
 500     printf ("\n");
 501   fflush (stdout);
 502
 503   return 0;
 504 }
 505
 506 #endif /* HAVE_SOCKETS */
 507 \f
 508 #ifndef HAVE_STRERROR
 509 char *
 510 strerror (errnum)
 511      int errnum;
 512 {
 513   extern char *sys_errlist[];
 514   extern int sys_nerr;
 515
 516   if (errnum >= 0 && errnum < sys_nerr)
 517     return sys_errlist[errnum];
 518   return (char *) "Unknown error";
 519 }
 520
 521 #endif /* ! HAVE_STRERROR */
 522
 523 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
 524    (do not change this comment) */