xref: /netbsd-src/usr.bin/tip/tip.h (revision d48f14661dda8638fee055ba15d35bdfb29b9fa8)
1 /*	$NetBSD: tip.h,v 1.27 2006/04/03 16:13:34 tls Exp $	*/
2 
3 /*
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *      @(#)tip.h	8.1 (Berkeley) 6/6/93
33  */
34 
35 /*
36  * tip - terminal interface program
37  */
38 
39 #include <sys/param.h>
40 #include <sys/ioctl.h>
41 #include <sys/time.h>
42 #include <sys/wait.h>
43 #include <machine/endian.h>
44 
45 #include <ctype.h>
46 #include <err.h>
47 #include <fcntl.h>
48 #include <errno.h>
49 #include <libgen.h>
50 #include <dirent.h>
51 #include <pwd.h>
52 #include <setjmp.h>
53 #include <signal.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <termios.h>
58 #include <time.h>
59 #include <unistd.h>
60 
61 /*
62  * Remote host attributes
63  */
64 char	*DV;			/* UNIX device(s) to open */
65 char	*EL;			/* chars marking an EOL */
66 char	*CM;			/* initial connection message */
67 char	*IE;			/* EOT to expect on input */
68 char	*OE;			/* EOT to send to complete FT */
69 char	*CU;			/* call unit if making a phone call */
70 char	*AT;			/* acu type */
71 char	*PN;			/* phone number(s) */
72 char	*DI;			/* disconnect string */
73 char	*PA;			/* parity to be generated */
74 
75 char	*PH;			/* phone number file */
76 char	*RM;			/* remote file name */
77 char	*HO;			/* host name */
78 
79 long	BR;			/* line speed for conversation */
80 long	FS;			/* frame size for transfers */
81 
82 long	DU;			/* this host is dialed up */
83 long	HW;			/* this device is hardwired, see hunt.c */
84 char	*ES;			/* escape character */
85 char	*EX;			/* exceptions */
86 char	*FO;			/* force (literal next) char*/
87 char	*RC;			/* raise character */
88 char	*RE;			/* script record file */
89 char	*PR;			/* remote prompt */
90 long	DL;			/* line delay for file transfers to remote */
91 long	CL;			/* char delay for file transfers to remote */
92 long	ET;			/* echocheck timeout */
93 long	HD;			/* this host is half duplex - do local echo */
94 char	DC;			/* this host is directly connected. */
95 
96 /*
97  * String value table
98  */
99 typedef
100 	struct {
101 		const char *v_name;	/* whose name is it */
102 		uint8_t v_type;		/* for interpreting set's */
103 		uint8_t v_access;	/* protection of touchy ones */
104 		const char *v_abrev;	/* possible abreviation */
105 		void *v_value;		/* casted to a union later */
106 				/*
107 				 * XXX:	this assumes that the storage space
108 				 *	of a pointer >= that of a long
109 				 */
110 	}
111 	value_t;
112 
113 #define STRING	01		/* string valued */
114 #define BOOL	02		/* true-false value */
115 #define NUMBER	04		/* numeric value */
116 #define CHAR	010		/* character value */
117 
118 #define WRITE	01		/* write access to variable */
119 #define	READ	02		/* read access */
120 
121 #define CHANGED	01		/* low bit is used to show modification */
122 #define PUBLIC	1		/* public access rights */
123 #define PRIVATE	03		/* private to definer */
124 #define ROOT	05		/* root defined */
125 
126 #define	TRUE	1
127 #define FALSE	0
128 
129 #define ENVIRON	020		/* initialize out of the environment */
130 #define IREMOTE	040		/* initialize out of remote structure */
131 #define INIT	0100		/* static data space used for initialization */
132 #define TMASK	017
133 
134 /*
135  * Definition of ACU line description
136  */
137 typedef
138 	struct {
139 		const char *acu_name;
140 		int	(*acu_dialer)(char *, char *);
141 		void	(*acu_disconnect)(void);
142 		void	(*acu_abort)(void);
143 	}
144 	acu_t;
145 
146 #define	equal(a, b)	(strcmp(a,b)==0)/* A nice function to string compare */
147 
148 /*
149  * variable manipulation stuff --
150  *   if we defined the value entry in value_t, then we couldn't
151  *   initialize it in vars.c, so we cast it as needed to keep lint
152  *   happy.
153  */
154 
155 #define value(v)	vtable[v].v_value
156 
157 #define	number(v)	((int)(intptr_t)(v))
158 #define	boolean(v)	((short)(intptr_t)(v))
159 #define	character(v)	((char)(intptr_t)(v))
160 #define	address(v)	((long *)(intptr_t)(v))
161 
162 #define	setnumber(v,n)		do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
163 #define	setboolean(v,n)		do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
164 #define	setcharacter(v,n)	do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
165 #define	setaddress(v,n)		do { (v) = (char *)(intptr_t)(n); } while (/*CONSTCOND*/0)
166 
167 /*
168  * Escape command table definitions --
169  *   lookup in this table is performed when ``escapec'' is recognized
170  *   at the begining of a line (as defined by the eolmarks variable).
171 */
172 
173 typedef
174 	struct {
175 		char	e_char;			/* char to match on */
176 		char	e_flags;		/* experimental, privileged */
177 		const char *e_help;		/* help string */
178 		void 	(*e_func)(char);	/* command */
179 	}
180 	esctable_t;
181 
182 #define NORM	00		/* normal protection, execute anyone */
183 #define EXP	01		/* experimental, mark it with a `*' on help */
184 #define PRIV	02		/* privileged, root execute only */
185 
186 extern int	vflag;		/* verbose during reading of .tiprc file */
187 extern value_t	vtable[];	/* variable table */
188 
189 /*
190  * Definition of indices into variable table so
191  *  value(DEFINE) turns into a static address.
192  *
193  * XXX: keep in sync with vtable[] in vars.c
194  */
195 
196 #define BEAUTIFY	0
197 #define BAUDRATE	1
198 #define DIALTIMEOUT	2
199 #define EOFREAD		3
200 #define EOFWRITE	4
201 #define EOL		5
202 #define ESCAPE		6
203 #define EXCEPTIONS	7
204 #define FORCE		8
205 #define FRAMESIZE	9
206 #define HOST		10
207 #define PHONES		11
208 #define PROMPT		12
209 #define RAISE		13
210 #define RAISECHAR	14
211 #define RECORD		15
212 #define REMOTE		16
213 #define SCRIPT		17
214 #define TABEXPAND	18
215 #define VERBOSE		19
216 #define SHELL		20
217 #define HOME		21
218 #define ECHOCHECK	22
219 #define DISCONNECT	23
220 #define TAND		24
221 #define LDELAY		25
222 #define CDELAY		26
223 #define ETIMEOUT	27
224 #define RAWFTP		28
225 #define HALFDUPLEX	29
226 #define	LECHO		30
227 #define	PARITY		31
228 #define	HARDWAREFLOW	32
229 
230 struct termios	term;		/* current mode of terminal */
231 struct termios	defterm;	/* initial mode of terminal */
232 struct termios	defchars;	/* current mode with initial chars */
233 
234 FILE	*fscript;		/* FILE for scripting */
235 
236 int	attndes[2];		/* coprocess wakeup channel */
237 int	fildes[2];		/* file transfer synchronization channel */
238 int	repdes[2];		/* read process synchronization channel */
239 int	FD;			/* open file descriptor to remote host */
240 int	AC;			/* open file descriptor to dialer (v831 only) */
241 int	vflag;			/* print .tiprc initialization sequence */
242 int	sfd;			/* for ~< operation */
243 int	pid;			/* pid of tipout */
244 uid_t	uid, euid;		/* real and effective user id's */
245 gid_t	gid, egid;		/* real and effective group id's */
246 int	stop;			/* stop transfer session flag */
247 int	quit;			/* same; but on other end */
248 int	intflag;		/* recognized interrupt */
249 int	stoprompt;		/* for interrupting a prompt session */
250 int	timedout;		/* ~> transfer timedout */
251 int	cumode;			/* simulating the "cu" program */
252 int	bits8;			/* terminal is is 8-bit mode */
253 #define STRIP_PAR	(bits8 ? 0377 : 0177)
254 
255 char	fname[80];		/* file name buffer for ~< */
256 char	copyname[80];		/* file name buffer for ~> */
257 char	ccc;			/* synchronization character */
258 char	ch;			/* for tipout */
259 
260 int	odisc;				/* initial tty line discipline */
261 extern	int disc;			/* current tty discpline */
262 
263 extern acu_t		acutable[];
264 extern esctable_t	etable[];
265 extern unsigned char	evenpartab[];
266 
267 void	alrmtimeout(int);
268 int	any(char, const char *);
269 void	chdirectory(char);
270 void	cleanup(int);
271 const char   *connect(void);
272 void	consh(char);
273 char   *ctrl(char);
274 void	cumain(int, char **);
275 void	cu_put(char);
276 void	cu_take(char);
277 void	disconnect(const char *);
278 char   *expand(char *);
279 void	finish(char);
280 void	genbrk(char);
281 void	getfl(char);
282 char   *getremote(char *);
283 void	hardwareflow(const char *);
284 void	help(char);
285 int	hunt(char *);
286 char   *interp(const char *);
287 void	pipefile(char);
288 void	pipeout(char);
289 int	prompt(const char *, char *, size_t);
290 void	xpwrite(int, char *, size_t);
291 void	raw(void);
292 void	sendchar(char);
293 void	sendfile(char);
294 void	setparity(const char *);
295 void	setscript(void);
296 void	shell(char);
297 void	suspend(char);
298 void	tandem(const char *);
299 void	tipabort(const char *);
300 void	tipout(void);
301 int	ttysetup(speed_t);
302 void	unraw(void);
303 void	variable(char);
304 void	vinit(void);
305 char   *vinterp(char *, char);
306 void	vlex(char *);
307 int	vstring(const char *, char *);
308 
309 void	biz22_abort(void);
310 void	biz22_disconnect(void);
311 int	biz22f_dialer(char *, char *);
312 int	biz22w_dialer(char *, char *);
313 void	biz31_abort(void);
314 void	biz31_disconnect(void);
315 int	biz31f_dialer(char *, char *);
316 int	biz31w_dialer(char *, char *);
317 void	cour_abort(void);
318 int	cour_dialer(char *, char *);
319 void	cour_disconnect(void);
320 int	df02_dialer(char *, char *);
321 int	df03_dialer(char *, char *);
322 void	df_abort(void);
323 void	df_disconnect(void);
324 void	dn_abort(void);
325 int	dn_dialer(char *, char *);
326 void	dn_disconnect(void);
327 void	hay_abort(void);
328 int	hay_dialer(char *, char *);
329 void	hay_disconnect(void);
330 void	t3000_abort(void);
331 int	t3000_dialer(char *, char *);
332 void	t3000_disconnect(void);
333 void	v3451_abort(void);
334 int	v3451_dialer(char *, char *);
335 void	v3451_disconnect(void);
336 void	v831_abort(void);
337 int	v831_dialer(char *, char *);
338 void	v831_disconnect(void);
339 void	ven_abort(void);
340 int	ven_dialer(char *, char *);
341 void	ven_disconnect(void);
342