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