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