1 /* $NetBSD: ftp_var.h,v 1.63 2002/08/27 13:11:02 christos Exp $ */ 2 3 /*- 4 * Copyright (c) 1996-2001 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 typedef void (*sigfunc)(int); 127 128 #include "extern.h" 129 130 131 /* 132 * Format of command table. 133 */ 134 struct cmd { 135 char *c_name; /* name of command */ 136 char *c_help; /* help string */ 137 char c_bell; /* give bell when command completes */ 138 char c_conn; /* must be connected to use command */ 139 char c_proxy; /* proxy server may execute */ 140 #ifndef NO_EDITCOMPLETE 141 char *c_complete; /* context sensitive completion list */ 142 #endif /* !NO_EDITCOMPLETE */ 143 void (*c_handler)(int, char **); /* function to call */ 144 }; 145 146 /* 147 * Format of macro table 148 */ 149 struct macel { 150 char mac_name[9]; /* macro name */ 151 char *mac_start; /* start of macro in macbuf */ 152 char *mac_end; /* end of macro in macbuf */ 153 }; 154 155 /* 156 * Format of option table 157 */ 158 struct option { 159 char *name; 160 char *value; 161 }; 162 163 /* 164 * Indices to features[]; an array containing status of remote server 165 * features; -1 not known (FEAT failed), 0 absent, 1 present. 166 */ 167 enum { 168 FEAT_FEAT = 0, /* FEAT, OPTS */ 169 FEAT_MDTM, /* MDTM */ 170 FEAT_MLST, /* MLSD, MLST */ 171 FEAT_REST_STREAM, /* RESTart STREAM */ 172 FEAT_SIZE, /* SIZE */ 173 FEAT_TVFS, /* TVFS (not used) */ 174 FEAT_max 175 }; 176 177 178 /* 179 * Global defines 180 */ 181 #define FTPBUFLEN MAXPATHLEN + 200 182 #define MAX_IN_PORT_T 0xffffU 183 184 #define HASHBYTES 1024 /* default mark for `hash' command */ 185 #define DEFAULTINCR 1024 /* default increment for `rate' command */ 186 #define STALLTIME 5 /* # of seconds of no xfer before "stalling" */ 187 188 #define FTP_PORT 21 /* default if ! getservbyname("ftp/tcp") */ 189 #define HTTP_PORT 80 /* default if ! getservbyname("http/tcp") */ 190 #ifndef GATE_PORT 191 #define GATE_PORT 21 /* default if ! getservbyname("ftpgate/tcp") */ 192 #endif 193 #ifndef GATE_SERVER 194 #define GATE_SERVER "" /* default server */ 195 #endif 196 197 #define DEFAULTPAGER "more" /* default pager if $PAGER isn't set */ 198 #define DEFAULTPROMPT "ftp> " /* default prompt if `set prompt' is empty */ 199 #define DEFAULTRPROMPT "" /* default rprompt if `set rprompt' is empty */ 200 201 #define TMPFILE "ftpXXXXXXXXXX" 202 203 204 #ifndef GLOBAL 205 #define GLOBAL extern 206 #endif 207 208 /* 209 * Options and other state info. 210 */ 211 GLOBAL int trace; /* trace packets exchanged */ 212 GLOBAL int hash; /* print # for each buffer transferred */ 213 GLOBAL int mark; /* number of bytes between hashes */ 214 GLOBAL int sendport; /* use PORT/LPRT cmd for each data connection */ 215 GLOBAL int verbose; /* print messages coming back from server */ 216 GLOBAL int connected; /* 1 = connected to server, -1 = logged in */ 217 GLOBAL int fromatty; /* input is from a terminal */ 218 GLOBAL int interactive; /* interactively prompt on m* cmds */ 219 GLOBAL int confirmrest; /* confirm rest of current m* cmd */ 220 GLOBAL int debug; /* debugging level */ 221 GLOBAL int bell; /* ring bell on cmd completion */ 222 GLOBAL int doglob; /* glob local file names */ 223 GLOBAL int autologin; /* establish user account on connection */ 224 GLOBAL int proxy; /* proxy server connection active */ 225 GLOBAL int proxflag; /* proxy connection exists */ 226 GLOBAL int gatemode; /* use gate-ftp */ 227 GLOBAL char *gateserver; /* server to use for gate-ftp */ 228 GLOBAL int sunique; /* store files on server with unique name */ 229 GLOBAL int runique; /* store local files with unique name */ 230 GLOBAL int mcase; /* map upper to lower case for mget names */ 231 GLOBAL int ntflag; /* use ntin ntout tables for name translation */ 232 GLOBAL int mapflag; /* use mapin mapout templates on file names */ 233 GLOBAL int preserve; /* preserve modification time on files */ 234 GLOBAL int progress; /* display transfer progress bar */ 235 GLOBAL int code; /* return/reply code for ftp command */ 236 GLOBAL int crflag; /* if 1, strip car. rets. on ascii gets */ 237 GLOBAL int passivemode; /* passive mode enabled */ 238 GLOBAL int activefallback; /* fall back to active mode if passive fails */ 239 GLOBAL char *altarg; /* argv[1] with no shell-like preprocessing */ 240 GLOBAL char ntin[17]; /* input translation table */ 241 GLOBAL char ntout[17]; /* output translation table */ 242 GLOBAL char mapin[MAXPATHLEN]; /* input map template */ 243 GLOBAL char mapout[MAXPATHLEN]; /* output map template */ 244 GLOBAL char typename[32]; /* name of file transfer type */ 245 GLOBAL int type; /* requested file transfer type */ 246 GLOBAL int curtype; /* current file transfer type */ 247 GLOBAL char structname[32]; /* name of file transfer structure */ 248 GLOBAL int stru; /* file transfer structure */ 249 GLOBAL char formname[32]; /* name of file transfer format */ 250 GLOBAL int form; /* file transfer format */ 251 GLOBAL char modename[32]; /* name of file transfer mode */ 252 GLOBAL int mode; /* file transfer mode */ 253 GLOBAL char bytename[32]; /* local byte size in ascii */ 254 GLOBAL int bytesize; /* local byte size in binary */ 255 GLOBAL int anonftp; /* automatic anonymous login */ 256 GLOBAL int dirchange; /* remote directory changed by cd command */ 257 GLOBAL int flushcache; /* set HTTP cache flush headers with request */ 258 GLOBAL int quit_time; /* maximum time to wait if stalled */ 259 GLOBAL int rate_get; /* maximum get xfer rate */ 260 GLOBAL int rate_get_incr; /* increment for get xfer rate */ 261 GLOBAL int rate_put; /* maximum put xfer rate */ 262 GLOBAL int rate_put_incr; /* increment for put xfer rate */ 263 GLOBAL int retry_connect; /* seconds between retrying connection */ 264 GLOBAL int ttywidth; /* width of tty */ 265 GLOBAL char *tmpdir; /* temporary directory */ 266 GLOBAL FILE *ttyout; /* stdout, or stderr if retrieving to stdout */ 267 GLOBAL int epsv4; /* use EPSV/EPRT on IPv4 connections */ 268 GLOBAL int epsv4bad; /* EPSV doesn't work on the current server */ 269 GLOBAL int editing; /* command line editing enabled */ 270 GLOBAL int features[FEAT_max]; /* remote FEATures supported */ 271 272 #ifndef NO_EDITCOMPLETE 273 GLOBAL EditLine *el; /* editline(3) status structure */ 274 GLOBAL History *hist; /* editline(3) history structure */ 275 GLOBAL char *cursor_pos; /* cursor position we're looking for */ 276 GLOBAL size_t cursor_argc; /* location of cursor in margv */ 277 GLOBAL size_t cursor_argo; /* offset of cursor in margv[cursor_argc] */ 278 #endif /* !NO_EDITCOMPLETE */ 279 280 GLOBAL off_t bytes; /* current # of bytes read */ 281 GLOBAL off_t filesize; /* size of file being transferred */ 282 GLOBAL char *direction; /* direction transfer is occurring */ 283 GLOBAL off_t restart_point; /* offset to restart transfer */ 284 285 GLOBAL char *hostname; /* name of host connected to */ 286 GLOBAL int unix_server; /* server is unix, can use binary for ascii */ 287 GLOBAL int unix_proxy; /* proxy is unix, can use binary for ascii */ 288 GLOBAL char remotepwd[MAXPATHLEN]; /* remote dir */ 289 GLOBAL char *username; /* name of user logged in as. (dynamic) */ 290 291 GLOBAL sa_family_t family; /* address family to use for connections */ 292 GLOBAL char *ftpport; /* port number to use for FTP connections */ 293 GLOBAL char *httpport; /* port number to use for HTTP connections */ 294 GLOBAL char *gateport; /* port number to use for gateftp connections */ 295 296 GLOBAL char *outfile; /* filename to output URLs to */ 297 GLOBAL int restartautofetch; /* restart auto-fetch */ 298 299 GLOBAL sigjmp_buf toplevel; /* non-local goto stuff for cmd scanner */ 300 301 GLOBAL char line[FTPBUFLEN]; /* input line buffer */ 302 GLOBAL char *stringbase; /* current scan point in line buffer */ 303 GLOBAL char argbuf[FTPBUFLEN]; /* argument storage buffer */ 304 GLOBAL char *argbase; /* current storage point in arg buffer */ 305 GLOBAL StringList *marg_sl; /* stringlist containing margv */ 306 GLOBAL int margc; /* count of arguments on input line */ 307 #define margv (marg_sl->sl_str) /* args parsed from input line */ 308 GLOBAL int cpend; /* flag: if != 0, then pending server reply */ 309 GLOBAL int mflag; /* flag: if != 0, then active multi command */ 310 311 GLOBAL int options; /* used during socket creation */ 312 313 GLOBAL int sndbuf_size; /* socket send buffer size */ 314 GLOBAL int rcvbuf_size; /* socket receive buffer size */ 315 316 GLOBAL int macnum; /* number of defined macros */ 317 GLOBAL struct macel macros[16]; 318 GLOBAL char macbuf[4096]; 319 320 GLOBAL char *localhome; /* local home directory */ 321 GLOBAL char *localname; /* local user name */ 322 GLOBAL char netrc[MAXPATHLEN]; /* path to .netrc file */ 323 GLOBAL char reply_string[BUFSIZ]; /* first line of previous reply */ 324 GLOBAL void (*reply_callback)(const char *); 325 /* 326 * function to call for each line in 327 * the server's reply except for the 328 * first (`xxx-') and last (`xxx ') 329 */ 330 331 332 GLOBAL FILE *cin; 333 GLOBAL FILE *cout; 334 GLOBAL int data; 335 336 extern struct cmd cmdtab[]; 337 extern struct option optiontab[]; 338 339 340 #define EMPTYSTRING(x) ((x) == NULL || (*(x) == '\0')) 341 #define FREEPTR(x) if ((x) != NULL) { free(x); (x) = NULL; } 342 343 #ifdef BSD4_4 344 # define HAVE_SOCKADDR_SA_LEN 1 345 #endif 346 347 #ifdef NO_LONG_LONG 348 # define LLF "%ld" 349 # define LLFP(x) "%" x "ld" 350 # define LLT long 351 # define ULLF "%lu" 352 # define ULLFP(x) "%" x "lu" 353 # define ULLT unsigned long 354 # define STRTOLL(x,y,z) strtol(x,y,z) 355 #else 356 # define LLF "%lld" 357 # define LLFP(x) "%" x "lld" 358 # define LLT long long 359 # define ULLF "%llu" 360 # define ULLFP(x) "%" x "llu" 361 # define ULLT unsigned long long 362 # define STRTOLL(x,y,z) strtoll(x,y,z) 363 #endif 364