git.chise.org Git - chise/xemacs-chise.git.1/blob - lib-src/gnuserv.h

   1 /* -*-C-*-
   2
   3  Header file for the GNU Emacs server and client C code.
   4
   5  This file is part of GNU Emacs.
   6
   7  Copying is permitted under those conditions described by the GNU
   8  General Public License.
   9
  10  Copyright (C) 1989 Free Software Foundation, Inc.
  11
  12  Author: Andy Norman (ange@hplb.hpl.hp.com), based on
  13          'etc/server.c' and 'etc/emacsclient.c' from the 18.52 GNU
  14          Emacs distribution.
  15
  16  Please mail bugs and suggestions to the author at the above address.
  17 */
  18
  19 /* HISTORY
  20  * 11-Nov-1990          bristor@simba
  21  *    Added EOT stuff.
  22  */
  23
  24 /*
  25  * This file incorporates new features added by Bob Weiner <weiner@mot.com>,
  26  * Darrell Kindred <dkindred@cmu.edu> and Arup Mukherjee <arup@cmu.edu>.
  27  * Please see the note at the end of the README file for details.
  28  *
  29  * (If gnuserv came bundled with your emacs, the README file is probably
  30  * ../etc/gnuserv.README relative to the directory containing this file)
  31  */
  32
  33 #define GNUSERV_VERSION "3.12"
  34
  35 #define USE_TMPDIR
  36
  37 #define PATCHLEVEL 2
  38
  39 #define NO_SHORTNAMES
  40 /* gnuserv should not be compiled using SOCKS */
  41 #define DO_NOT_SOCKSIFY
  42 #define DONT_ENCAPSULATE
  43 #include <config.h>
  44 #undef signal
  45
  46 /* Define the communication method between server and clients:
  47  *   You can have either or both kinds of sockets, but you can't mix
  48  *   sockets with sysv ipc
  49  */
  50
  51
  52 #define INTERNET_DOMAIN_SOCKETS
  53 #ifdef HAVE_SYS_UN_H
  54 #define UNIX_DOMAIN_SOCKETS
  55 /* #define SYSV_IPC  */
  56 #endif
  57
  58 /*
  59  * Define additional authentication protocols to be used. These methods will
  60  * be tried before falling back to the default gnuserv protocol (based on
  61  * the GNU_SECURE environment variable). Currently, only MIT-MAGIC-COOKIE-1
  62  * is also supported.
  63  *
  64  * Comment out the next line(s) if you don't want to enable the
  65  * appropriate authentication protocol.
  66  */
  67
  68 #if defined (HAVE_XAUTH)
  69 #define AUTH_MAGIC_COOKIE
  70 #endif /* HAVE_XAUTH */
  71
  72 /*
  73  * stuff related to supporting MIT-MAGIC-COOKIE-1
  74  */
  75
  76 #define MCOOKIE_SCREEN "999"     /* screen # to use as the gnuserv cookie */
  77 #define MCOOKIE_NAME   "MAGIC-1" /* authentication protocol name */
  78 #define MCOOKIE_X_NAME "MIT-MAGIC-COOKIE-1"  /* as needed by X */
  79
  80
  81 #define DEFAUTH_NAME "GNU-SECURE"  /* name of default auth protocol */
  82 #define AUTH_TIMEOUT  15           /* # seconds to wait for auth data */
  83 #define AUTH_NAMESZ   15           /* max allows auth protocol name size */
  84
  85
  86 /*
  87  * Pick a default communication scheme, if none was specified.
  88  */
  89
  90 #if !defined(SYSV_IPC) && !defined(UNIX_DOMAIN_SOCKETS) && !defined(INTERNET_DOMAIN_SOCKETS)
  91
  92 #ifdef HAVE_SYSVIPC
  93 #define SYSV_IPC                /* SYSV systems use SYSV IPC by default */
  94 #endif /* HAVE_SYSVIPC */
  95
  96 #ifdef BSD
  97 #define UNIX_DOMAIN_SOCKETS     /* BSD systems use Unix Domain sockets by default */
  98 #endif /* BSD */
  99
 100 #endif /* No communication method pre-defined */
 101
 102 #include <sys/types.h>
 103 #include <sys/param.h>
 104 #include <sys/stat.h>
 105 #include <stdio.h>
 106 #include <stdlib.h>
 107 #include <string.h>
 108 #include <signal.h>
 109 #include <errno.h>
 110
 111 #ifdef HAVE_UNISTD_H
 112 #include <unistd.h>
 113 #endif
 114
 115 #ifdef HAVE_SYS_TIME_H
 116 #include <sys/time.h>
 117 #endif
 118
 119 /*
 120  * If you are using SYSV_IPC, you might want to make the buffer size bigger
 121  * since it limits the size of requests and responses. Don't make it bigger
 122  * than your system's max message size though (usually a couple of k) or else
 123  * msgsend will start failing. For sockets, using the system BUFSIZ is usually
 124  * what you want.
 125  */
 126
 127 # define GSERV_BUFSZ BUFSIZ
 128
 129
 130 #ifdef SYSV_IPC
 131 #include <sys/ipc.h>
 132 #include <sys/msg.h>
 133
 134 #define send_string(s,str) \
 135   if (strlen(msgp->mtext) + strlen(str) < GSERV_BUFSZ) \
 136      strcat(msgp->mtext,str); \
 137   else \
 138   { \
 139     fprintf(stderr,"%s: not enough message buffer space\n",progname); \
 140      exit(1); \
 141   } \
 142
 143 #endif /* SYSV_IPC */
 144
 145 #if defined(INTERNET_DOMAIN_SOCKETS) || defined(UNIX_DOMAIN_SOCKETS)
 146 #include <sys/socket.h>
 147 #endif /* INTERNET_DOMAIN_SOCKETS || UNIX_DOMAIN_SOCKETS */
 148
 149 #ifdef INTERNET_DOMAIN_SOCKETS
 150 #include <netdb.h>
 151 #include <netinet/in.h>
 152 #include <arpa/inet.h>
 153 #define TABLE_SIZE 101          /* The number of entries in the hash table */
 154 #define HASH(host) host         /* Rather simplistic hash function */
 155 #define DEFAULT_PORT 21490      /* default port number to use is
 156                                  * DEFAULT_PORT + uid */
 157 #endif /* INTERNET_DOMAIN_SOCKETS */
 158
 159 #ifdef UNIX_DOMAIN_SOCKETS
 160 #include <sys/un.h>
 161 #define HIDE_UNIX_SOCKET        /* put the unix socket in a protected dir */
 162 #endif /* UNIX_DOMAIN_SOCKETS */
 163
 164 /* On some platforms, we need to do the equivalent of "stty litout" to get
 165  * characters like ^D to pass through to emacs.  This problem has only
 166  * been observed under emacs18; fsf19 and lemacs are probably okay without it.
 167  */
 168 #ifndef DONT_USE_LITOUT
 169 #if !defined(HAVE_TERMIO) && !defined(HAVE_TERMIOS) && !defined(VMS)
 170 #if !defined(BSD4_1)
 171 #define USE_LITOUT
 172 #endif
 173 #endif
 174 #endif
 175
 176
 177 #define HOSTNAMSZ 255           /* max size of a hostname */
 178 #define REPLYSIZ 300            /* max size of reply from server to client */
 179 #undef FALSE
 180 #define FALSE 0
 181 #undef TRUE
 182 #define TRUE 1
 183
 184 extern char *optarg;
 185 extern int optind;
 186 extern char *progname;
 187 extern char *tmpdir;
 188
 189 /* The casts shut Sun's compiler up and are safe in the context these
 190    are actually used. */
 191 #define max2(x,y) (((int) (x) > (int) (y)) ? (x) : (y))
 192 #define min2(x,y) (((int) (x) < (int) (y)) ? (x) : (y))
 193
 194 #ifndef _NFILE            /* rough guess at maximum number of open files */
 195 #define _NFILE 20
 196 #endif
 197
 198 #define EOT_STR "\004"
 199 #define EOT_CHR '\004'
 200
 201 /* connection types */
 202 #define CONN_UNIX     0
 203 #define CONN_INTERNET 1
 204 #define CONN_IPC      2
 205
 206 /* function declarations */
 207 int make_connection (char *hostarg, int portarg, int *s);
 208 #ifdef SYSV_IPC
 209 void disconnect_from_ipc_server();
 210 #endif
 211 #if defined(INTERNET_DOMAIN_SOCKETS) || defined(UNIX_DOMAIN_SOCKETS)
 212 void send_string (int s, const char *msg);
 213 void disconnect_from_server (int s, int echo);
 214 int read_line (int s, char *dest);
 215 #endif
 216 #ifdef INTERNET_DOMAIN_SOCKETS
 217 int internet_addr (char *host);
 218 #endif