1 /* $NetBSD: ftp_var.h,v 1.92 2026/02/08 08:31:58 lukem Exp $ */ 2 3 /*- 4 * Copyright (c) 1996-2026 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 105 #include <netinet/in.h> 106 #include <arpa/inet.h> 107 108 #include <poll.h> 109 110 #include <setjmp.h> 111 #include <stringlist.h> 112 113 #ifndef NO_EDITCOMPLETE 114 #include <histedit.h> 115 #endif /* !NO_EDITCOMPLETE */ 116 117 #include "extern.h" 118 #include "progressbar.h" 119 120 /* 121 * Format of command table. 122 */ 123 struct cmd { 124 const char *c_name; /* name of command */ 125 const char *c_help; /* help string */ 126 char c_bell; /* give bell when command completes */ 127 char c_conn; /* must be connected to use command */ 128 char c_proxy; /* proxy server may execute */ 129 #ifndef NO_EDITCOMPLETE 130 const char *c_complete; /* context sensitive completion list */ 131 #endif /* !NO_EDITCOMPLETE */ 132 void (*c_handler)(int, char **); /* function to call */ 133 }; 134 135 #define MAX_C_NAME 12 /* maximum length of cmd.c_name */ 136 137 /* 138 * Format of macro table 139 */ 140 struct macel { 141 char mac_name[9]; /* macro name */ 142 char *mac_start; /* start of macro in macbuf */ 143 char *mac_end; /* end of macro in macbuf */ 144 }; 145 146 /* 147 * Format of option table 148 */ 149 struct option { 150 const char *name; 151 char *value; 152 }; 153 154 /* 155 * Indices to features[]; an array containing status of remote server 156 * features; -1 not known (FEAT failed), 0 absent, 1 present. 157 */ 158 enum { 159 FEAT_FEAT = 0, /* FEAT, OPTS */ 160 FEAT_MDTM, /* MDTM */ 161 FEAT_MLST, /* MLSD, MLST */ 162 FEAT_REST_STREAM, /* RESTart STREAM */ 163 FEAT_SIZE, /* SIZE */ 164 FEAT_TVFS, /* TVFS (not used) */ 165 FEAT_max 166 }; 167 168 /* 169 * Global defines 170 */ 171 #define FTPBUFLEN (16 * 1024) 172 #define MAX_IN_PORT_T 0xffffU 173 #define XFERBUFMIN (1 * 1024) /* 1 KiB max read()/write() */ 174 #define XFERBUFMAX (128 * 1024) /* 128 KiB max read()/write() */ 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 #define HTTPS_PORT 443 /* default if ! getservbyname("https/tcp") */ 182 #ifndef GATE_PORT 183 #define GATE_PORT 21 /* default if ! getservbyname("ftpgate/tcp") */ 184 #endif 185 #ifndef GATE_SERVER 186 #define GATE_SERVER "" /* default server */ 187 #endif 188 189 #define DEFAULTPAGER "more" /* default pager if $PAGER isn't set */ 190 #define DEFAULTPROMPT "ftp> " /* default prompt if `set prompt' is empty */ 191 #define DEFAULTRPROMPT "" /* default rprompt if `set rprompt' is empty */ 192 193 #define TMPFILE "ftpXXXXXXXXXX" 194 195 196 #ifndef GLOBAL 197 #define GLOBAL extern 198 #endif 199 200 /* 201 * Options and other state info. 202 */ 203 GLOBAL int trace; /* trace packets exchanged */ 204 GLOBAL int hash; /* print # for each buffer transferred */ 205 GLOBAL int mark; /* number of bytes between hashes */ 206 GLOBAL int sendport; /* use PORT/LPRT cmd for each data connection */ 207 GLOBAL int connected; /* 1 = connected to server, -1 = logged in */ 208 GLOBAL int interactive; /* interactively prompt on m* cmds */ 209 GLOBAL int confirmrest; /* confirm rest of current m* cmd */ 210 GLOBAL int ftp_debug; /* debugging level */ 211 GLOBAL int bell; /* ring bell on cmd completion */ 212 GLOBAL int doglob; /* glob local file names */ 213 GLOBAL int autologin; /* establish user account on connection */ 214 GLOBAL int proxy; /* proxy server connection active */ 215 GLOBAL int proxflag; /* proxy connection exists */ 216 GLOBAL int gatemode; /* use gate-ftp */ 217 GLOBAL const char *gateserver; /* server to use for gate-ftp */ 218 GLOBAL int sunique; /* store files on server with unique name */ 219 GLOBAL int runique; /* store local files with unique name */ 220 GLOBAL int mcase; /* map upper to lower case for mget names */ 221 GLOBAL int ntflag; /* use ntin ntout tables for name translation */ 222 GLOBAL int mapflag; /* use mapin mapout templates on file names */ 223 GLOBAL int preserve; /* preserve modification time on files */ 224 GLOBAL int code; /* return/reply code for ftp command */ 225 GLOBAL int crflag; /* if 1, strip car. rets. on ascii gets */ 226 GLOBAL int passivemode; /* passive mode enabled */ 227 GLOBAL int activefallback; /* fall back to active mode if passive fails */ 228 GLOBAL char *altarg; /* argv[1] with no shell-like preprocessing */ 229 GLOBAL char ntin[17]; /* input translation table */ 230 GLOBAL char ntout[17]; /* output translation table */ 231 GLOBAL char mapin[MAXPATHLEN]; /* input map template */ 232 GLOBAL char mapout[MAXPATHLEN]; /* output map template */ 233 GLOBAL char typename[32]; /* name of file transfer type */ 234 GLOBAL int type; /* requested file transfer type */ 235 GLOBAL int curtype; /* current file transfer type */ 236 GLOBAL char structname[32]; /* name of file transfer structure */ 237 GLOBAL int stru; /* file transfer structure */ 238 GLOBAL char formname[32]; /* name of file transfer format */ 239 GLOBAL int form; /* file transfer format */ 240 GLOBAL char modename[32]; /* name of file transfer mode */ 241 GLOBAL int mode; /* file transfer mode */ 242 GLOBAL char bytename[32]; /* local byte size in ascii */ 243 GLOBAL int bytesize; /* local byte size in binary */ 244 GLOBAL int anonftp; /* automatic anonymous login */ 245 GLOBAL int dirchange; /* remote directory changed by cd command */ 246 GLOBAL int flushcache; /* set HTTP cache flush headers with request */ 247 GLOBAL int rate_get; /* maximum get xfer rate */ 248 GLOBAL int rate_get_incr; /* increment for get xfer rate */ 249 GLOBAL int rate_put; /* maximum put xfer rate */ 250 GLOBAL int rate_put_incr; /* increment for put xfer rate */ 251 GLOBAL int retry_connect; /* seconds between retrying connection */ 252 GLOBAL const char *tmpdir; /* temporary directory */ 253 GLOBAL int epsv4; /* use EPSV/EPRT on IPv4 connections */ 254 GLOBAL int epsv4bad; /* EPSV doesn't work on the current server */ 255 GLOBAL int epsv6; /* use EPSV/EPRT on IPv6 connections */ 256 GLOBAL int epsv6bad; /* EPSV doesn't work on the current server */ 257 GLOBAL int editing; /* command line editing enabled */ 258 GLOBAL StringList *custom_headers; /* stringlist with custom HTTP headers */ 259 GLOBAL int features[FEAT_max]; /* remote FEATures supported */ 260 261 #ifndef NO_EDITCOMPLETE 262 GLOBAL EditLine *el; /* editline(3) status structure */ 263 GLOBAL History *hist; /* editline(3) history structure */ 264 GLOBAL char *cursor_pos; /* cursor position we're looking for */ 265 GLOBAL size_t cursor_argc; /* location of cursor in margv */ 266 GLOBAL size_t cursor_argo; /* offset of cursor in margv[cursor_argc] */ 267 #endif /* !NO_EDITCOMPLETE */ 268 269 GLOBAL char *hostname; /* name of host connected to */ 270 GLOBAL int unix_server; /* server is unix, can use binary for ascii */ 271 GLOBAL int unix_proxy; /* proxy is unix, can use binary for ascii */ 272 GLOBAL char localcwd[MAXPATHLEN]; /* local dir */ 273 GLOBAL char remotecwd[MAXPATHLEN]; /* remote dir */ 274 GLOBAL int remcwdvalid; /* remotecwd has been updated */ 275 GLOBAL char *username; /* name of user logged in as. (dynamic) */ 276 277 GLOBAL sa_family_t family; /* address family to use for connections */ 278 GLOBAL const char *ftpport; /* port number to use for FTP connections */ 279 GLOBAL const char *httpport; /* port number to use for HTTP connections */ 280 #ifdef WITH_SSL 281 GLOBAL const char *httpsport; /* port number to use for HTTPS connections */ 282 #endif 283 GLOBAL const char *gateport; /* port number to use for gateftp connections */ 284 GLOBAL struct addrinfo *bindai; /* local address to bind as */ 285 286 GLOBAL char *outfile; /* filename to output URLs to */ 287 GLOBAL int restartautofetch; /* restart auto-fetch */ 288 289 GLOBAL char line[FTPBUFLEN]; /* input line buffer */ 290 GLOBAL char *stringbase; /* current scan point in line buffer */ 291 GLOBAL char argbuf[FTPBUFLEN]; /* argument storage buffer */ 292 GLOBAL char *argbase; /* current storage point in arg buffer */ 293 GLOBAL StringList *marg_sl; /* stringlist containing margv */ 294 GLOBAL int margc; /* count of arguments on input line */ 295 #define margv (marg_sl->sl_str) /* args parsed from input line */ 296 GLOBAL int cpend; /* flag: if != 0, then pending server reply */ 297 GLOBAL int mflag; /* flag: if != 0, then active multi command */ 298 299 GLOBAL int options; /* used during socket creation */ 300 301 GLOBAL int sndbuf_size; /* socket send buffer size; 0 = autoscale */ 302 GLOBAL int rcvbuf_size; /* socket receive buffer size; 0 = autoscale */ 303 304 GLOBAL int macnum; /* number of defined macros */ 305 GLOBAL struct macel macros[16]; 306 GLOBAL char macbuf[4096]; 307 308 GLOBAL char *localhome; /* local home directory */ 309 GLOBAL char *localname; /* local user name */ 310 GLOBAL char netrc[MAXPATHLEN]; /* path to .netrc file */ 311 GLOBAL char reply_string[BUFSIZ]; /* first line of previous reply */ 312 GLOBAL void (*reply_callback)(const char *); 313 /* 314 * function to call for each line in 315 * the server's reply except for the 316 * first (`xxx-') and last (`xxx ') 317 */ 318 319 GLOBAL volatile sig_atomic_t sigint_raised; 320 321 GLOBAL FILE *cin; 322 GLOBAL FILE *cout; 323 GLOBAL int data; 324 325 extern struct cmd cmdtab[]; 326 extern struct option optiontab[]; 327 328 extern size_t ftp_buflen; 329 330 #define EMPTYSTRING(x) ((x) == NULL || (*(x) == '\0')) 331 #define FREEPTR(x) if ((x) != NULL) { free(x); (x) = NULL; } 332 333 #ifdef BSD4_4 334 # define HAVE_STRUCT_SOCKADDR_IN_SIN_LEN 1 335 #endif 336 337 #ifdef NO_LONG_LONG 338 # define STRTOLL(x,y,z) strtol(x,y,z) 339 #else 340 # define STRTOLL(x,y,z) strtoll(x,y,z) 341 #endif 342 343 #ifdef NO_DEBUG 344 #define DPRINTF(...) (void)0 345 #define DWARN(...) (void)0 346 #else 347 #define DWFTP(a) do a; while (0) 348 #define DPRINTF(...) DWFTP(if (ftp_debug) (void)fprintf(ttyout, __VA_ARGS__)) 349 #define DWARN(...) DWFTP(if (ftp_debug) warn(__VA_ARGS__)) 350 #endif 351 352 #define STRorNULL(s) ((s) ? (s) : "<null>") 353 354 #ifdef NO_USAGE 355 void xusage(void); 356 #define UPRINTF(...) xusage() 357 #else 358 #define UPRINTF(...) (void)fprintf(ttyout, __VA_ARGS__) 359 #endif 360
Indexes created Sun Feb 22 16:20:20 UTC 2026