1/*	$NetBSD: ftp_var.h,v 1.10 2009/05/20 12:53:47 lukem Exp $	*/
2/*	from	NetBSD: ftp_var.h,v 1.81 2009/04/12 10:18:52 lukem Exp	*/
3
4/*-
5 * Copyright (c) 1996-2009 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Luke Mewburn.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33/*
34 * Copyright (c) 1985, 1989, 1993, 1994
35 *	The Regents of the University of California.  All rights reserved.
36 *
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
39 * are met:
40 * 1. Redistributions of source code must retain the above copyright
41 *    notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 *    notice, this list of conditions and the following disclaimer in the
44 *    documentation and/or other materials provided with the distribution.
45 * 3. Neither the name of the University nor the names of its contributors
46 *    may be used to endorse or promote products derived from this software
47 *    without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 *	@(#)ftp_var.h	8.4 (Berkeley) 10/9/94
62 */
63
64/*
65 * Copyright (C) 1997 and 1998 WIDE Project.
66 * All rights reserved.
67 *
68 * Redistribution and use in source and binary forms, with or without
69 * modification, are permitted provided that the following conditions
70 * are met:
71 * 1. Redistributions of source code must retain the above copyright
72 *    notice, this list of conditions and the following disclaimer.
73 * 2. Redistributions in binary form must reproduce the above copyright
74 *    notice, this list of conditions and the following disclaimer in the
75 *    documentation and/or other materials provided with the distribution.
76 * 3. Neither the name of the project nor the names of its contributors
77 *    may be used to endorse or promote products derived from this software
78 *    without specific prior written permission.
79 *
80 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
81 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
82 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
83 * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
84 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
85 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
86 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
87 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
88 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
89 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
90 * SUCH DAMAGE.
91 */
92
93/*
94 * FTP global variables.
95 */
96
97#ifdef SMALL
98#undef	NO_EDITCOMPLETE
99#define	NO_EDITCOMPLETE
100#undef	NO_PROGRESS
101#define	NO_PROGRESS
102#endif
103
104#if 0	/* tnftp */
105
106#include <sys/param.h>
107
108#include <netinet/in.h>
109#include <arpa/inet.h>
110
111#include <poll.h>
112
113#include <setjmp.h>
114#include <stringlist.h>
115
116#endif	/* tnftp */
117
118#ifndef NO_EDITCOMPLETE
119#include <histedit.h>
120#endif /* !NO_EDITCOMPLETE */
121
122#include "extern.h"
123#include "progressbar.h"
124
125/*
126 * Format of command table.
127 */
128struct cmd {
129	const char	*c_name;	/* name of command */
130	const char	*c_help;	/* help string */
131	char		c_bell;		/* give bell when command completes */
132	char		c_conn;		/* must be connected to use command */
133	char		c_proxy;	/* proxy server may execute */
134#ifndef NO_EDITCOMPLETE
135	const char	*c_complete;	/* context sensitive completion list */
136#endif /* !NO_EDITCOMPLETE */
137	void		(*c_handler)(int, char **); /* function to call */
138};
139
140#define MAX_C_NAME	12		/* maximum length of cmd.c_name */
141
142/*
143 * Format of macro table
144 */
145struct macel {
146	char	 mac_name[9];	/* macro name */
147	char	*mac_start;	/* start of macro in macbuf */
148	char	*mac_end;	/* end of macro in macbuf */
149};
150
151/*
152 * Format of option table
153 */
154struct option {
155	const char	*name;
156	char		*value;
157};
158
159/*
160 * Indices to features[]; an array containing status of remote server
161 * features; -1 not known (FEAT failed), 0 absent, 1 present.
162 */
163enum {
164	FEAT_FEAT = 0,		/* FEAT, OPTS */
165	FEAT_MDTM,		/* MDTM */
166	FEAT_MLST,		/* MLSD, MLST */
167	FEAT_REST_STREAM,	/* RESTart STREAM */
168	FEAT_SIZE,		/* SIZE */
169	FEAT_TVFS,		/* TVFS (not used) */
170	FEAT_max
171};
172
173
174/*
175 * Global defines
176 */
177#define	FTPBUFLEN	MAXPATHLEN + 200
178#define	MAX_IN_PORT_T	0xffffU
179
180#define	HASHBYTES	1024	/* default mark for `hash' command */
181#define	DEFAULTINCR	1024	/* default increment for `rate' command */
182
183#define	FTP_PORT	21	/* default if ! getservbyname("ftp/tcp") */
184#define	HTTP_PORT	80	/* default if ! getservbyname("http/tcp") */
185#ifndef	GATE_PORT
186#define	GATE_PORT	21	/* default if ! getservbyname("ftpgate/tcp") */
187#endif
188#ifndef	GATE_SERVER
189#define	GATE_SERVER	""	/* default server */
190#endif
191
192#define	DEFAULTPAGER	"more"	/* default pager if $PAGER isn't set */
193#define	DEFAULTPROMPT	"ftp> "	/* default prompt  if `set prompt' is empty */
194#define	DEFAULTRPROMPT	""	/* default rprompt if `set rprompt' is empty */
195
196#define	TMPFILE		"ftpXXXXXXXXXX"
197
198
199#ifndef	GLOBAL
200#define	GLOBAL	extern
201#endif
202
203/*
204 * Options and other state info.
205 */
206GLOBAL	int	trace;		/* trace packets exchanged */
207GLOBAL	int	hash;		/* print # for each buffer transferred */
208GLOBAL	int	mark;		/* number of bytes between hashes */
209GLOBAL	int	sendport;	/* use PORT/LPRT cmd for each data connection */
210GLOBAL	int	connected;	/* 1 = connected to server, -1 = logged in */
211GLOBAL	int	interactive;	/* interactively prompt on m* cmds */
212GLOBAL	int	confirmrest;	/* confirm rest of current m* cmd */
213GLOBAL	int	ftp_debug;	/* debugging level */
214GLOBAL	int	bell;		/* ring bell on cmd completion */
215GLOBAL	int	doglob;		/* glob local file names */
216GLOBAL	int	autologin;	/* establish user account on connection */
217GLOBAL	int	proxy;		/* proxy server connection active */
218GLOBAL	int	proxflag;	/* proxy connection exists */
219GLOBAL	int	gatemode;	/* use gate-ftp */
220GLOBAL	const char *gateserver;	/* server to use for gate-ftp */
221GLOBAL	int	sunique;	/* store files on server with unique name */
222GLOBAL	int	runique;	/* store local files with unique name */
223GLOBAL	int	mcase;		/* map upper to lower case for mget names */
224GLOBAL	int	ntflag;		/* use ntin ntout tables for name translation */
225GLOBAL	int	mapflag;	/* use mapin mapout templates on file names */
226GLOBAL	int	preserve;	/* preserve modification time on files */
227GLOBAL	int	code;		/* return/reply code for ftp command */
228GLOBAL	int	crflag;		/* if 1, strip car. rets. on ascii gets */
229GLOBAL	int	passivemode;	/* passive mode enabled */
230GLOBAL	int	activefallback;	/* fall back to active mode if passive fails */
231GLOBAL	char   *altarg;		/* argv[1] with no shell-like preprocessing  */
232GLOBAL	char	ntin[17];	/* input translation table */
233GLOBAL	char	ntout[17];	/* output translation table */
234GLOBAL	char	mapin[MAXPATHLEN]; /* input map template */
235GLOBAL	char	mapout[MAXPATHLEN]; /* output map template */
236GLOBAL	char	typename[32];	/* name of file transfer type */
237GLOBAL	int	type;		/* requested file transfer type */
238GLOBAL	int	curtype;	/* current file transfer type */
239GLOBAL	char	structname[32];	/* name of file transfer structure */
240GLOBAL	int	stru;		/* file transfer structure */
241GLOBAL	char	formname[32];	/* name of file transfer format */
242GLOBAL	int	form;		/* file transfer format */
243GLOBAL	char	modename[32];	/* name of file transfer mode */
244GLOBAL	int	mode;		/* file transfer mode */
245GLOBAL	char	bytename[32];	/* local byte size in ascii */
246GLOBAL	int	bytesize;	/* local byte size in binary */
247GLOBAL	int	anonftp;	/* automatic anonymous login */
248GLOBAL	int	dirchange;	/* remote directory changed by cd command */
249GLOBAL	int	flushcache;	/* set HTTP cache flush headers with request */
250GLOBAL	int	rate_get;	/* maximum get xfer rate */
251GLOBAL	int	rate_get_incr;	/* increment for get xfer rate */
252GLOBAL	int	rate_put;	/* maximum put xfer rate */
253GLOBAL	int	rate_put_incr;	/* increment for put xfer rate */
254GLOBAL	int	retry_connect;	/* seconds between retrying connection */
255GLOBAL	const char *tmpdir;	/* temporary directory */
256GLOBAL	int	epsv4;		/* use EPSV/EPRT on IPv4 connections */
257GLOBAL	int	epsv4bad;	/* EPSV doesn't work on the current server */
258GLOBAL	int	epsv6;		/* use EPSV/EPRT on IPv6 connections */
259GLOBAL	int	epsv6bad;	/* EPSV doesn't work on the current server */
260GLOBAL	int	editing;	/* command line editing enabled */
261GLOBAL	int	features[FEAT_max];	/* remote FEATures supported */
262
263#ifndef NO_EDITCOMPLETE
264GLOBAL	EditLine *el;		/* editline(3) status structure */
265GLOBAL	History  *hist;		/* editline(3) history structure */
266GLOBAL	char	 *cursor_pos;	/* cursor position we're looking for */
267GLOBAL	size_t	  cursor_argc;	/* location of cursor in margv */
268GLOBAL	size_t	  cursor_argo;	/* offset of cursor in margv[cursor_argc] */
269#endif /* !NO_EDITCOMPLETE */
270
271GLOBAL	char   *hostname;	/* name of host connected to */
272GLOBAL	int	unix_server;	/* server is unix, can use binary for ascii */
273GLOBAL	int	unix_proxy;	/* proxy is unix, can use binary for ascii */
274GLOBAL	char	localcwd[MAXPATHLEN];	/* local dir */
275GLOBAL	char	remotecwd[MAXPATHLEN];	/* remote dir */
276GLOBAL	char   *username;	/* name of user logged in as. (dynamic) */
277
278GLOBAL	sa_family_t family;	/* address family to use for connections */
279GLOBAL	const char *ftpport;	/* port number to use for FTP connections */
280GLOBAL	const char *httpport;	/* port number to use for HTTP connections */
281GLOBAL	const char *gateport;	/* port number to use for gateftp connections */
282GLOBAL	struct addrinfo *bindai; /* local address to bind as */
283
284GLOBAL	char   *outfile;	/* filename to output URLs to */
285GLOBAL	int	restartautofetch; /* restart auto-fetch */
286
287GLOBAL	char	line[FTPBUFLEN]; /* input line buffer */
288GLOBAL	char	*stringbase;	/* current scan point in line buffer */
289GLOBAL	char	argbuf[FTPBUFLEN]; /* argument storage buffer */
290GLOBAL	char	*argbase;	/* current storage point in arg buffer */
291GLOBAL	StringList *marg_sl;	/* stringlist containing margv */
292GLOBAL	int	margc;		/* count of arguments on input line */
293#define	margv (marg_sl->sl_str)	/* args parsed from input line */
294GLOBAL	int     cpend;		/* flag: if != 0, then pending server reply */
295GLOBAL	int	mflag;		/* flag: if != 0, then active multi command */
296
297GLOBAL	int	options;	/* used during socket creation */
298
299GLOBAL	int	sndbuf_size;	/* socket send buffer size */
300GLOBAL	int	rcvbuf_size;	/* socket receive buffer size */
301
302GLOBAL	int	macnum;		/* number of defined macros */
303GLOBAL	struct macel macros[16];
304GLOBAL	char	macbuf[4096];
305
306GLOBAL	char	*localhome;		/* local home directory */
307GLOBAL	char	*localname;		/* local user name */
308GLOBAL	char	 netrc[MAXPATHLEN];	/* path to .netrc file */
309GLOBAL	char	 reply_string[BUFSIZ];	/* first line of previous reply */
310GLOBAL	void	(*reply_callback)(const char *);
311					/*
312					 * function to call for each line in
313					 * the server's reply except for the
314					 * first (`xxx-') and last (`xxx ')
315					 */
316
317GLOBAL	volatile sig_atomic_t	sigint_raised;
318
319GLOBAL	FILE	*cin;
320GLOBAL	FILE	*cout;
321GLOBAL	int	 data;
322
323extern	struct cmd	cmdtab[];
324extern	struct option	optiontab[];
325
326
327#define	EMPTYSTRING(x)	((x) == NULL || (*(x) == '\0'))
328#define	FREEPTR(x)	if ((x) != NULL) { free(x); (x) = NULL; }
329
330#ifdef BSD4_4
331# define HAVE_STRUCT_SOCKADDR_IN_SIN_LEN	1
332#endif
333
334#ifdef NO_LONG_LONG
335# define STRTOLL(x,y,z)	strtol(x,y,z)
336#else
337# define STRTOLL(x,y,z)	strtoll(x,y,z)
338#endif
339
340#ifdef NO_DEBUG
341#define DPRINTF(...)
342#define DWARN(...)
343#else
344#define DPRINTF(...)	if (ftp_debug) (void)fprintf(ttyout, __VA_ARGS__)
345#define DWARN(...)	if (ftp_debug) warn(__VA_ARGS__)
346#endif
347
348#define STRorNULL(s)	((s) ? (s) : "<null>")
349
350#ifdef NO_USAGE
351void xusage(void);
352#define UPRINTF(...)	xusage()
353#else
354#define UPRINTF(...)	(void)fprintf(ttyout, __VA_ARGS__)
355#endif
356