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