(lookup_image): Build mask before applying an algorithm.
[bpt/emacs.git] / lib-src / emacsclient.c
index bd2edf6..c4e01b6 100644 (file)
@@ -1,11 +1,11 @@
 /* Client process that communicates with GNU Emacs acting as server.
 /* Client process that communicates with GNU Emacs acting as server.
-   Copyright (C) 1986, 1987 Free Software Foundation, Inc.
+   Copyright (C) 1986, 1987, 1994, 1999, 2000 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 1, or (at your option)
+the Free Software Foundation; either version 2, or (at your option)
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
@@ -15,21 +15,188 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
 
 #define NO_SHORTNAMES
 
 
 #define NO_SHORTNAMES
-#include "../src/config.h"
-#undef read
-#undef write
-#undef open
-#ifdef close
-#undef close
+#include <../src/config.h>
+#undef signal
+
+#include <stdio.h>
+#include <getopt.h>
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
 #endif
 
 #endif
 
+#ifdef VMS
+# include "vms-pwd.h"
+#else
+# include <pwd.h>
+#endif /* not VMS */
 
 
-#if !defined(HAVE_SOCKETS) && !defined(HAVE_SYSVIPC)
-#include <stdio.h>
+char *getenv (), *getwd ();
+char *getcwd ();
+
+/* This is defined with -D from the compilation command,
+   which extracts it from ../lisp/version.el.  */
+
+#ifndef VERSION
+#define VERSION "unspecified"
+#endif
+\f
+/* Name used to invoke this program.  */
+char *progname;
+
+/* Nonzero means don't wait for a response from Emacs.  --no-wait.  */
+int nowait = 0;
+
+void print_help_and_exit ();
+
+struct option longopts[] =
+{
+  { "no-wait", no_argument,       NULL, 'n' },
+  { "help",    no_argument,       NULL, 'H' },
+  { "version", no_argument,       NULL, 'V' },
+  { "alternate-editor",required_argument, NULL, 'a' },
+  { 0 }
+};
+
+
+const char * alternate_editor = NULL;
+
+/* Decode the options from argv and argc.
+   The global variable `optind' will say how many arguments we used up.  */
+
+void
+decode_options (argc, argv)
+     int argc;
+     char **argv;
+{
+  while (1)
+    {
+      int opt = getopt_long (argc, argv,
+                            "VHna:", longopts, 0);
+
+      if (opt == EOF)
+       break;
+
+      alternate_editor = getenv ("ALTERNATE_EDITOR");
+      
+      switch (opt)
+       {
+       case 0:
+         /* If getopt returns 0, then it has already processed a
+            long-named option.  We should do nothing.  */
+         break;
+         
+       case 'a':
+         alternate_editor = optarg;
+         break;
+         
+       case 'n':
+         nowait = 1;
+         break;
+
+       case 'V':
+         fprintf (stderr, "emacsclient %s\n", VERSION);
+         exit (1);
+         break;
+
+       case 'H':
+       default:
+         print_help_and_exit ();
+       }
+    }
+}
+
+void
+print_help_and_exit ()
+{
+  fprintf (stderr,
+          "Usage: %s [-a ALTERNATE-EDITOR] [-n] [--no-wait] [+LINENUMBER] FILENAME\n",
+          progname);
+  fprintf (stderr,
+          "Or %s --version\n",
+          progname);
+  fprintf (stderr,
+          "Report bugs to bug-gnu-emacs@gnu.org.\n");
+  exit (1);
+}
+
+/* Return a copy of NAME, inserting a &
+   before each &, each space, and any initial -.
+   Change spaces to underscores, too, so that the
+   return value never contains a space.  */
+
+char *
+quote_file_name (name)
+     char *name;
+{
+  char *copy = (char *) malloc (strlen (name) * 2 + 1);
+  char *p, *q;
+
+  p = name;
+  q = copy;
+  while (*p)
+    {
+      if (*p == ' ')
+       {
+         *q++ = '&';
+         *q++ = '_';
+         p++;
+       }
+      else
+       {
+         if (*p == '&' || (*p == '-' && p == name))
+           *q++ = '&';
+         *q++ = *p++;
+       }
+    }
+  *q++ = 0;
+
+  
+  return copy;
+}
+
+/* Like malloc but get fatal error if memory is exhausted.  */
+
+long *
+xmalloc (size)
+     unsigned int size;
+{
+  long *result = (long *) malloc (size);
+  if (result == NULL)
+  {
+    perror ("malloc");
+    exit (1);
+  }
+  return result;
+}
+\f
+/*
+  Try to run a different command, or --if no alternate editor is
+  defined-- exit with an errorcode.
+*/
+fail (argc, argv)
+     int argc;
+     char **argv;
+{
+  if (alternate_editor)
+    {
+      int i = optind -1 ;
+      execvp (alternate_editor, argv + i);
+    }
+  else
+    {
+      exit (1);
+    }
+}
+
+
+       
+\f
+#if !defined (HAVE_SOCKETS) && !defined (HAVE_SYSVIPC)
 
 main (argc, argv)
      int argc;
 
 main (argc, argv)
      int argc;
@@ -38,44 +205,64 @@ main (argc, argv)
   fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n",
           argv[0]);
   fprintf (stderr, "on systems with Berkeley sockets or System V IPC.\n");
   fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n",
           argv[0]);
   fprintf (stderr, "on systems with Berkeley sockets or System V IPC.\n");
-  exit (1);
+
+  fail (argc, argv);
 }
 
 #else /* HAVE_SOCKETS or HAVE_SYSVIPC */
 
 }
 
 #else /* HAVE_SOCKETS or HAVE_SYSVIPC */
 
-#if ! defined (HAVE_SYSVIPC)
+#if defined (HAVE_SOCKETS) && ! defined (NO_SOCKETS_IN_FILE_SYSTEM)
 /* BSD code is very different from SYSV IPC code */
 
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <sys/un.h>
 #include <sys/stat.h>
 /* BSD code is very different from SYSV IPC code */
 
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <sys/un.h>
 #include <sys/stat.h>
-#include <stdio.h>
 #include <errno.h>
 
 #include <errno.h>
 
-extern int sys_nerr;
-extern char *sys_errlist[];
+extern char *strerror ();
 extern int errno;
 
 extern int errno;
 
+/* Three possibilities:
+   2 - can't be `stat'ed               (sets errno)
+   1 - isn't owned by us
+   0 - success: none of the above */
+
+static int
+socket_status (socket_name)
+     char *socket_name;
+{
+  struct stat statbfr;
+
+  if (stat (socket_name, &statbfr) == -1)
+    return 2;
+
+  if (statbfr.st_uid != geteuid ())
+    return 1;
+
+  return 0;
+}
+
+int
 main (argc, argv)
      int argc;
      char **argv;
 {
 main (argc, argv)
      int argc;
      char **argv;
 {
-  char system_name[32];
+  char *system_name;
+  int system_name_length;
   int s, i;
   int s, i;
-  FILE *out;
+  FILE *out, *in;
   struct sockaddr_un server;
   char *homedir, *cwd, *str;
   char string[BUFSIZ];
 
   struct sockaddr_un server;
   char *homedir, *cwd, *str;
   char string[BUFSIZ];
 
-  char *getenv (), *getwd ();
-  int geteuid ();
+  progname = argv[0];
 
 
-  if (argc < 2)
-    {
-      fprintf (stderr, "Usage: %s [+linenumber] filename\n", argv[0]);
-      exit (1);
-    }
+  /* Process options.  */
+  decode_options (argc, argv);
+
+  if (argc - optind < 1)
+    print_help_and_exit ();
 
   /* 
    * Open up an AF_UNIX socket in this person's home directory
 
   /* 
    * Open up an AF_UNIX socket in this person's home directory
@@ -85,87 +272,180 @@ main (argc, argv)
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("socket");
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("socket");
-      exit (1);
+      fail (argc, argv);
     }
     }
+  
   server.sun_family = AF_UNIX;
   server.sun_family = AF_UNIX;
+
+  {
+    system_name_length = 32;
+
+    while (1)
+      {
+       system_name = (char *) xmalloc (system_name_length + 1);
+
+       /* system_name must be null-terminated string.  */
+       system_name[system_name_length] = '\0';
+
+       if (gethostname (system_name, system_name_length) == 0)
+         break;
+
+       free (system_name);
+       system_name_length *= 2;
+      }
+  }
+
 #ifndef SERVER_HOME_DIR
   {
     struct stat statbfr;
 #ifndef SERVER_HOME_DIR
   {
     struct stat statbfr;
+    int sock_status = 0;
 
 
-    gethostname (system_name, sizeof (system_name));
     sprintf (server.sun_path, "/tmp/esrv%d-%s", geteuid (), system_name);
 
     sprintf (server.sun_path, "/tmp/esrv%d-%s", geteuid (), system_name);
 
-    if (stat (server.sun_path, &statbfr) == -1)
-      {
-       perror ("stat");
-       exit (1);
-      }
-    if (statbfr.st_uid != geteuid())
+    /* See if the socket exists, and if it's owned by us. */
+    sock_status = socket_status (server.sun_path);
+    if (sock_status)
       {
       {
-       fprintf (stderr, "Illegal socket owner\n");
-       exit (1);
+       /* Failing that, see if LOGNAME or USER exist and differ from
+          our euid.  If so, look for a socket based on the UID
+          associated with the name.  This is reminiscent of the logic
+          that init_editfns uses to set the global Vuser_full_name.  */
+       char *user_name = (char *) getenv ("LOGNAME");
+       if (!user_name)
+         user_name = (char *) getenv ("USER");
+       
+       if (user_name)
+         {
+           struct passwd *pw = getpwnam (user_name);
+           if (pw && (pw->pw_uid != geteuid ()))
+             {
+               /* We're running under su, apparently. */
+               sprintf (server.sun_path, "/tmp/esrv%d-%s",
+                        pw->pw_uid, system_name);
+               sock_status = socket_status (server.sun_path);
+             }
+         }
       }
       }
+     switch (sock_status)
+       {
+       case 1:
+        /* There's a socket, but it isn't owned by us.  This is OK if
+           we are root. */
+        if (0 != geteuid ())
+          {
+            fprintf (stderr, "%s: Invalid socket owner\n", argv[0]);
+            fail (argc, argv);
+          }
+        break;
+        
+       case 2:
+        /* `stat' failed */
+        if (errno == ENOENT)
+          fprintf (stderr,
+                   "%s: can't find socket; have you started the server?\n",
+                   argv[0]);
+        else
+          fprintf (stderr, "%s: can't stat %s: %s\n",
+                   argv[0], server.sun_path, strerror (errno));
+        fail (argc, argv);
+        break;
+       }
   }
 #else
   if ((homedir = getenv ("HOME")) == NULL)
     {
       fprintf (stderr, "%s: No home directory\n", argv[0]);
   }
 #else
   if ((homedir = getenv ("HOME")) == NULL)
     {
       fprintf (stderr, "%s: No home directory\n", argv[0]);
-      exit (1);
+      fail (argc, argv);
     }
   strcpy (server.sun_path, homedir);
     }
   strcpy (server.sun_path, homedir);
-  strcat (server.sun_path, "/.emacs_server");
+  strcat (server.sun_path, "/.emacs-server-");
+  strcat (server.sun_path, system_name);
 #endif
 
 #endif
 
-  if (connect (s, &server, strlen (server.sun_path) + 2) < 0)
+  if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
+      < 0)
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("connect");
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("connect");
-      exit (1);
+      fail (argc, argv);
     }
     }
+
+  /* We use the stream OUT to send our command to the server.  */
   if ((out = fdopen (s, "r+")) == NULL)
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("fdopen");
   if ((out = fdopen (s, "r+")) == NULL)
     {
       fprintf (stderr, "%s: ", argv[0]);
       perror ("fdopen");
-      exit (1);
+      fail (argc, argv);
     }
 
     }
 
+  /* We use the stream IN to read the response.
+     We used to use just one stream for both output and input
+     on the socket, but reversing direction works nonportably:
+     on some systems, the output appears as the first input;
+     on other systems it does not.  */
+  if ((in = fdopen (s, "r+")) == NULL)
+    {
+      fprintf (stderr, "%s: ", argv[0]);
+      perror ("fdopen");
+      fail (argc, argv);
+    }
+
+#ifdef BSD_SYSTEM
   cwd = getwd (string);
   cwd = getwd (string);
+#else
+  cwd = getcwd (string, sizeof string);
+#endif
   if (cwd == 0)
     {
       /* getwd puts message in STRING if it fails.  */
   if (cwd == 0)
     {
       /* getwd puts message in STRING if it fails.  */
-      fprintf (stderr, "%s: %s (%s)\n", argv[0], string,
-              (errno < sys_nerr) ? sys_errlist[errno] : "unknown error");
-      exit (1);
+      fprintf (stderr, "%s: %s (%s)\n", argv[0],
+#ifdef BSD_SYSTEM
+              string,
+#else
+              "Cannot get current working directory",
+#endif
+              strerror (errno));
+      fail (argc, argv);
     }
 
     }
 
-  for (i = 1; i < argc; i++)
+  if (nowait)
+    fprintf (out, "-nowait ");
+
+  for (i = optind; i < argc; i++)
     {
       if (*argv[i] == '+')
        {
          char *p = argv[i] + 1;
          while (*p >= '0' && *p <= '9') p++;
          if (*p != 0)
     {
       if (*argv[i] == '+')
        {
          char *p = argv[i] + 1;
          while (*p >= '0' && *p <= '9') p++;
          if (*p != 0)
-           fprintf (out, "%s/", cwd);
+           fprintf (out, "%s/", quote_file_name (cwd));
        }
       else if (*argv[i] != '/')
        }
       else if (*argv[i] != '/')
-       fprintf (out, "%s/", cwd);
-      fprintf (out, "%s ", argv[i]);
+       fprintf (out, "%s/", quote_file_name (cwd));
+
+      fprintf (out, "%s ", quote_file_name (argv[i]));
     }
   fprintf (out, "\n");
   fflush (out);
 
     }
   fprintf (out, "\n");
   fflush (out);
 
+  /* Maybe wait for an answer.   */
+  if (nowait)
+    return 0;
+
   printf ("Waiting for Emacs...");
   fflush (stdout);
 
   printf ("Waiting for Emacs...");
   fflush (stdout);
 
-  rewind (out); /* re-read the output */
-  str = fgets (string, BUFSIZ, out); 
-
-  /* Now, wait for an answer and print any messages.  */
+  /* Now, wait for an answer and print any messages.  On some systems,
+     the first line we read will actually be the output we just sent.
+     We can't predict whether that will happen, so if it does, we
+     detect it by recognizing `Client: ' at the beginning.  */
   
   
-  while (str = fgets (string, BUFSIZ, out))
+  while (str = fgets (string, BUFSIZ, in))
     printf ("%s", str);
     printf ("%s", str);
-  
-  exit (0);
+
+  return 0;
 }
 
 #else /* This is the SYSV IPC section */
 }
 
 #else /* This is the SYSV IPC section */
@@ -173,7 +453,13 @@ main (argc, argv)
 #include <sys/types.h>
 #include <sys/ipc.h>
 #include <sys/msg.h>
 #include <sys/types.h>
 #include <sys/ipc.h>
 #include <sys/msg.h>
+#include <sys/utsname.h>
 #include <stdio.h>
 #include <stdio.h>
+#include <errno.h>
+extern int errno;
+
+char *getwd (), *getcwd (), *getenv ();
+struct utsname system_name;
 
 main (argc, argv)
      int argc;
 
 main (argc, argv)
      int argc;
@@ -181,23 +467,28 @@ main (argc, argv)
 {
   int s;
   key_t key;
 {
   int s;
   key_t key;
-  struct msgbuf * msgp =
-      (struct msgbuf *) malloc (sizeof *msgp + BUFSIZ);
+  /* Size of text allocated in MSGP.  */
+  int size_allocated = BUFSIZ;
+  /* Amount of text used in MSGP.  */
+  int used;
+  struct msgbuf *msgp
+    = (struct msgbuf *) malloc (sizeof (struct msgbuf) + size_allocated);
   struct msqid_ds * msg_st;
   char *homedir, buf[BUFSIZ];
   char gwdirb[BUFSIZ];
   char *cwd;
   char *temp;
   struct msqid_ds * msg_st;
   char *homedir, buf[BUFSIZ];
   char gwdirb[BUFSIZ];
   char *cwd;
   char *temp;
-  char *getwd (), *getcwd (), *getenv ();
 
 
-  if (argc < 2)
-    {
-      fprintf (stderr, "Usage: %s [+linenumber] filename\n", argv[0]);
-      exit (1);
-    }
+  progname = argv[0];
+
+  /* Process options.  */
+  decode_options (argc, argv);
+
+  if (argc - optind < 1)
+    print_help_and_exit ();
 
   /*
 
   /*
-   * Create a message queue using ~/.emacs_server as the path for ftok
+   * Create a message queue using ~/.emacs-server as the path for ftok
    */
   if ((homedir = getenv ("HOME")) == NULL)
     {
    */
   if ((homedir = getenv ("HOME")) == NULL)
     {
@@ -205,10 +496,17 @@ main (argc, argv)
       exit (1);
     }
   strcpy (buf, homedir);
       exit (1);
     }
   strcpy (buf, homedir);
-  strcat (buf, "/.emacs_server");
+#ifndef HAVE_LONG_FILE_NAMES
+  /* If file names are short, we can't fit the host name.  */
+  strcat (buf, "/.emacs-server");
+#else
+  strcat (buf, "/.emacs-server-");
+  uname (&system_name);
+  strcat (buf, system_name.nodename);
+#endif
   creat (buf, 0600);
   key = ftok (buf, 1); /* unlikely to be anyone else using it */
   creat (buf, 0600);
   key = ftok (buf, 1); /* unlikely to be anyone else using it */
-  s = msgget (key, 0600);
+  s = msgget (key, 0600 | IPC_CREAT);
   if (s == -1)
     {
       fprintf (stderr, "%s: ", argv[0]);
   if (s == -1)
     {
       fprintf (stderr, "%s: ", argv[0]);
@@ -217,7 +515,7 @@ main (argc, argv)
     }
 
   /* Determine working dir, so we can prefix it to all the arguments.  */
     }
 
   /* Determine working dir, so we can prefix it to all the arguments.  */
-#ifdef BSD
+#ifdef BSD_SYSTEM
   temp = getwd (gwdirb);
 #else
   temp = getcwd (gwdirb, sizeof gwdirb);
   temp = getwd (gwdirb);
 #else
   temp = getcwd (gwdirb, sizeof gwdirb);
@@ -234,49 +532,110 @@ main (argc, argv)
     }
   else
     {
     }
   else
     {
-      fprintf (stderr, cwd);
-      exit (1);
+#ifdef BSD_SYSTEM
+      fprintf (stderr, "%s: %s\n", argv[0], cwd);
+#else
+      fprintf (stderr, "%s: Cannot get current working directory: %s\n",
+              argv[0], strerror (errno));
+#endif
+      fail (argc, argv);
     }
 
   msgp->mtext[0] = 0;
     }
 
   msgp->mtext[0] = 0;
-  argc--; argv++;
+  used = 0;
+
+  if (nowait)
+    {
+      strcat (msgp->mtext, "-nowait ");
+      used += 8;
+    }
+
+  argc -= optind;
+  argv += optind;
+
   while (argc)
     {
   while (argc)
     {
-      if (*argv[0] == '+')
+      int need_cwd = 0;
+      char *modified_arg = argv[0];
+
+      if (*modified_arg == '+')
        {
        {
-         char *p = argv[0] + 1;
+         char *p = modified_arg + 1;
          while (*p >= '0' && *p <= '9') p++;
          if (*p != 0)
          while (*p >= '0' && *p <= '9') p++;
          if (*p != 0)
-           strcat (msgp->mtext, cwd);
+           need_cwd = 1;
        }
        }
-      else if (*argv[0] != '/')
-       strcat (msgp->mtext, cwd);
+      else if (*modified_arg != '/')
+       need_cwd = 1;
 
 
-      strcat (msgp->mtext, argv[0]);
+      modified_arg = quote_file_name (modified_arg);
+
+      if (need_cwd)
+       /* Overestimate in case we have to quote something in CWD.  */
+       used += 2 * strlen (cwd);
+      used += strlen (modified_arg) + 1;
+      while (used + 2 > size_allocated)
+       {
+         size_allocated *= 2;
+         msgp = (struct msgbuf *) realloc (msgp,
+                                           (sizeof (struct msgbuf)
+                                            + size_allocated));
+       }
+
+      if (need_cwd)
+       strcat (msgp->mtext, quote_file_name (cwd));
+
+      strcat (msgp->mtext, modified_arg);
       strcat (msgp->mtext, " ");
       argv++; argc--;
     }
   strcat (msgp->mtext, "\n");
       strcat (msgp->mtext, " ");
       argv++; argc--;
     }
   strcat (msgp->mtext, "\n");
+#ifdef HPUX /* HPUX has a bug.  */
+  if (strlen (msgp->mtext) >= 512)
+    {
+      fprintf (stderr, "%s: args too long for msgsnd\n", progname);
+      fail (argc, argv);
+    }
+#endif
   msgp->mtype = 1;
   if (msgsnd (s, msgp, strlen (msgp->mtext)+1, 0) < 0)
     {
   msgp->mtype = 1;
   if (msgsnd (s, msgp, strlen (msgp->mtext)+1, 0) < 0)
     {
-      fprintf (stderr, "%s: ", argv[0]);
+      fprintf (stderr, "%s: ", progname);
       perror ("msgsnd");
       perror ("msgsnd");
-      exit (1);
+      fail (argc, argv);
     }
     }
-  /*
-   * Now, wait for an answer
-   */
+
+  /* Maybe wait for an answer.   */
+  if (nowait)
+    return 0;
+
   printf ("Waiting for Emacs...");
   fflush (stdout);
 
   msgrcv (s, msgp, BUFSIZ, getpid (), 0);      /* wait for anything back */
   strcpy (buf, msgp->mtext);
 
   printf ("Waiting for Emacs...");
   fflush (stdout);
 
   msgrcv (s, msgp, BUFSIZ, getpid (), 0);      /* wait for anything back */
   strcpy (buf, msgp->mtext);
 
-  printf ("\n%s\n", buf);
+  printf ("\n");
+  if (*buf)
+    printf ("%s\n", buf);
   exit (0);
 }
 
 #endif /* HAVE_SYSVIPC */
 
 #endif /* HAVE_SOCKETS or HAVE_SYSVIPC */
   exit (0);
 }
 
 #endif /* HAVE_SYSVIPC */
 
 #endif /* HAVE_SOCKETS or HAVE_SYSVIPC */
+\f
+#ifndef HAVE_STRERROR
+char *
+strerror (errnum)
+     int errnum;
+{
+  extern char *sys_errlist[];
+  extern int sys_nerr;
+
+  if (errnum >= 0 && errnum < sys_nerr)
+    return sys_errlist[errnum];
+  return (char *) "Unknown error";
+}
+
+#endif /* ! HAVE_STRERROR */