Update to zlib-1.2.5.
[dragonfly.git] / contrib / tnftp / ftp_var.h
1 /*      $NetBSD: ftp_var.h,v 1.79 2008/05/10 00:05:31 skd Exp $ */
2
3 /*-
4  * Copyright (c) 1996-2007 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  *
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>
104 #include <sys/socket.h>
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  */
124 struct cmd {
125         char            *c_name;        /* name of command */
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
136 /*
137  * Format of macro table
138  */
139 struct macel {
140         char     mac_name[9];   /* macro name */
141         char    *mac_start;     /* start of macro in macbuf */
142         char    *mac_end;       /* end of macro in macbuf */
143 };
144
145 /*
146  * Format of option table
147  */
148 struct option {
149         char    *name;
150         char    *value;
151 };
152
153 /*
154  * Indices to features[]; an array containing status of remote server
155  * features; -1 not known (FEAT failed), 0 absent, 1 present.
156  */
157 enum {
158         FEAT_FEAT = 0,          /* FEAT, OPTS */
159         FEAT_MDTM,              /* MDTM */
160         FEAT_MLST,              /* MLSD, MLST */
161         FEAT_REST_STREAM,       /* RESTart STREAM */
162         FEAT_SIZE,              /* SIZE */
163         FEAT_TVFS,              /* TVFS (not used) */
164         FEAT_max
165 };
166
167
168 /*
169  * Global defines
170  */
171 #define FTPBUFLEN       MAXPATHLEN + 200
172 #define MAX_IN_PORT_T   0xffffU
173
174 #define HASHBYTES       1024    /* default mark for `hash' command */
175 #define DEFAULTINCR     1024    /* default increment for `rate' command */
176
177 #define FTP_PORT        21      /* default if ! getservbyname("ftp/tcp") */
178 #define HTTP_PORT       80      /* default if ! getservbyname("http/tcp") */
179 #ifndef GATE_PORT
180 #define GATE_PORT       21      /* default if ! getservbyname("ftpgate/tcp") */
181 #endif
182 #ifndef GATE_SERVER
183 #define GATE_SERVER     ""      /* default server */
184 #endif
185
186 #define DEFAULTPAGER    "more"  /* default pager if $PAGER isn't set */
187 #define DEFAULTPROMPT   "ftp> " /* default prompt  if `set prompt' is empty */
188 #define DEFAULTRPROMPT  ""      /* default rprompt if `set rprompt' is empty */
189
190 #define TMPFILE         "ftpXXXXXXXXXX"
191
192
193 #ifndef GLOBAL
194 #define GLOBAL  extern
195 #endif
196
197 /*
198  * Options and other state info.
199  */
200 GLOBAL  int     trace;          /* trace packets exchanged */
201 GLOBAL  int     hash;           /* print # for each buffer transferred */
202 GLOBAL  int     mark;           /* number of bytes between hashes */
203 GLOBAL  int     sendport;       /* use PORT/LPRT cmd for each data connection */
204 GLOBAL  int     connected;      /* 1 = connected to server, -1 = logged in */
205 GLOBAL  int     interactive;    /* interactively prompt on m* cmds */
206 GLOBAL  int     confirmrest;    /* confirm rest of current m* cmd */
207 GLOBAL  int     ftp_debug;      /* debugging level */
208 GLOBAL  int     bell;           /* ring bell on cmd completion */
209 GLOBAL  int     doglob;         /* glob local file names */
210 GLOBAL  int     autologin;      /* establish user account on connection */
211 GLOBAL  int     proxy;          /* proxy server connection active */
212 GLOBAL  int     proxflag;       /* proxy connection exists */
213 GLOBAL  int     gatemode;       /* use gate-ftp */
214 GLOBAL  char   *gateserver;     /* server to use for gate-ftp */
215 GLOBAL  int     sunique;        /* store files on server with unique name */
216 GLOBAL  int     runique;        /* store local files with unique name */
217 GLOBAL  int     mcase;          /* map upper to lower case for mget names */
218 GLOBAL  int     ntflag;         /* use ntin ntout tables for name translation */
219 GLOBAL  int     mapflag;        /* use mapin mapout templates on file names */
220 GLOBAL  int     preserve;       /* preserve modification time on files */
221 GLOBAL  int     code;           /* return/reply code for ftp command */
222 GLOBAL  int     crflag;         /* if 1, strip car. rets. on ascii gets */
223 GLOBAL  int     passivemode;    /* passive mode enabled */
224 GLOBAL  int     activefallback; /* fall back to active mode if passive fails */
225 GLOBAL  char   *altarg;         /* argv[1] with no shell-like preprocessing  */
226 GLOBAL  char    ntin[17];       /* input translation table */
227 GLOBAL  char    ntout[17];      /* output translation table */
228 GLOBAL  char    mapin[MAXPATHLEN]; /* input map template */
229 GLOBAL  char    mapout[MAXPATHLEN]; /* output map template */
230 GLOBAL  char    typename[32];   /* name of file transfer type */
231 GLOBAL  int     type;           /* requested file transfer type */
232 GLOBAL  int     curtype;        /* current file transfer type */
233 GLOBAL  char    structname[32]; /* name of file transfer structure */
234 GLOBAL  int     stru;           /* file transfer structure */
235 GLOBAL  char    formname[32];   /* name of file transfer format */
236 GLOBAL  int     form;           /* file transfer format */
237 GLOBAL  char    modename[32];   /* name of file transfer mode */
238 GLOBAL  int     mode;           /* file transfer mode */
239 GLOBAL  char    bytename[32];   /* local byte size in ascii */
240 GLOBAL  int     bytesize;       /* local byte size in binary */
241 GLOBAL  int     anonftp;        /* automatic anonymous login */
242 GLOBAL  int     dirchange;      /* remote directory changed by cd command */
243 GLOBAL  int     flushcache;     /* set HTTP cache flush headers with request */
244 GLOBAL  int     rate_get;       /* maximum get xfer rate */
245 GLOBAL  int     rate_get_incr;  /* increment for get xfer rate */
246 GLOBAL  int     rate_put;       /* maximum put xfer rate */
247 GLOBAL  int     rate_put_incr;  /* increment for put xfer rate */
248 GLOBAL  int     retry_connect;  /* seconds between retrying connection */
249 GLOBAL  char   *tmpdir;         /* temporary directory */
250 GLOBAL  int     epsv4;          /* use EPSV/EPRT on IPv4 connections */
251 GLOBAL  int     epsv4bad;       /* EPSV doesn't work on the current server */
252 GLOBAL  int     epsv6;          /* use EPSV/EPRT on IPv6 connections */
253 GLOBAL  int     epsv6bad;       /* EPSV doesn't work on the current server */
254 GLOBAL  int     editing;        /* command line editing enabled */
255 GLOBAL  int     features[FEAT_max];     /* remote FEATures supported */
256
257 #ifndef NO_EDITCOMPLETE
258 GLOBAL  EditLine *el;           /* editline(3) status structure */
259 GLOBAL  History  *hist;         /* editline(3) history structure */
260 GLOBAL  char     *cursor_pos;   /* cursor position we're looking for */
261 GLOBAL  size_t    cursor_argc;  /* location of cursor in margv */
262 GLOBAL  size_t    cursor_argo;  /* offset of cursor in margv[cursor_argc] */
263 #endif /* !NO_EDITCOMPLETE */
264
265 GLOBAL  char   *direction;      /* direction transfer is occurring */
266
267 GLOBAL  char   *hostname;       /* name of host connected to */
268 GLOBAL  int     unix_server;    /* server is unix, can use binary for ascii */
269 GLOBAL  int     unix_proxy;     /* proxy is unix, can use binary for ascii */
270 GLOBAL  char    localcwd[MAXPATHLEN];   /* local dir */
271 GLOBAL  char    remotecwd[MAXPATHLEN];  /* remote dir */
272 GLOBAL  char   *username;       /* name of user logged in as. (dynamic) */
273
274 GLOBAL  sa_family_t family;     /* address family to use for connections */
275 GLOBAL  char    *ftpport;       /* port number to use for FTP connections */
276 GLOBAL  char    *httpport;      /* port number to use for HTTP connections */
277 GLOBAL  char    *gateport;      /* port number to use for gateftp connections */
278 GLOBAL  struct addrinfo *bindai; /* local address to bind as */
279
280 GLOBAL  char   *outfile;        /* filename to output URLs to */
281 GLOBAL  int     restartautofetch; /* restart auto-fetch */
282
283 GLOBAL  char    line[FTPBUFLEN]; /* input line buffer */
284 GLOBAL  char    *stringbase;    /* current scan point in line buffer */
285 GLOBAL  char    argbuf[FTPBUFLEN]; /* argument storage buffer */
286 GLOBAL  char    *argbase;       /* current storage point in arg buffer */
287 GLOBAL  StringList *marg_sl;    /* stringlist containing margv */
288 GLOBAL  int     margc;          /* count of arguments on input line */
289 #define margv (marg_sl->sl_str) /* args parsed from input line */
290 GLOBAL  int     cpend;          /* flag: if != 0, then pending server reply */
291 GLOBAL  int     mflag;          /* flag: if != 0, then active multi command */
292
293 GLOBAL  int     options;        /* used during socket creation */
294
295 GLOBAL  int     sndbuf_size;    /* socket send buffer size */
296 GLOBAL  int     rcvbuf_size;    /* socket receive buffer size */
297
298 GLOBAL  int     macnum;         /* number of defined macros */
299 GLOBAL  struct macel macros[16];
300 GLOBAL  char    macbuf[4096];
301
302 GLOBAL  char    *localhome;             /* local home directory */
303 GLOBAL  char    *localname;             /* local user name */
304 GLOBAL  char     netrc[MAXPATHLEN];     /* path to .netrc file */
305 GLOBAL  char     reply_string[BUFSIZ];  /* first line of previous reply */
306 GLOBAL  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
313 GLOBAL  volatile sig_atomic_t   sigint_raised;
314
315 GLOBAL  FILE    *cin;
316 GLOBAL  FILE    *cout;
317 GLOBAL  int      data;
318
319 extern  struct cmd      cmdtab[];
320 extern  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
327 # define HAVE_STRUCT_SOCKADDR_IN_SIN_LEN        1
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__)
341 #define DWARN(...)      if (ftp_debug) warn(__VA_ARGS__)
342 #endif
343
344 #define STRorNULL(s)    ((s) ? (s) : "<null>")
345
346 #ifdef NO_USAGE
347 void xusage(void);
348 #define UPRINTF(...)    xusage()
349 #else
350 #define UPRINTF(...)    (void)fprintf(ttyout, __VA_ARGS__)
351 #endif