Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / ftp / ftp_var.h
1 /* $FreeBSD: src/usr.bin/ftp/ftp_var.h,v 1.11.2.2 2002/08/27 09:55:08 yar Exp $ */
2 /*      $NetBSD: ftp_var.h,v 1.20.2.1 1997/11/18 01:01:37 mellon Exp $  */
3
4 /*
5  * Copyright (c) 1985, 1989, 1993, 1994
6  *      The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)ftp_var.h   8.4 (Berkeley) 10/9/94
37  */
38
39 /*
40  * FTP global variables.
41  */
42
43 #include <sys/param.h>
44 #include <sys/socket.h>
45 #include <setjmp.h>
46 #include <stringlist.h>
47 #include <netinet/in.h>
48 #include <netdb.h>
49
50 #ifndef SMALL
51 #include <histedit.h>
52 #endif /* !SMALL */
53
54 #include "extern.h"
55
56 #define HASHBYTES       1024
57 #define FTPBUFLEN       MAXPATHLEN + 200
58
59 #define STALLTIME       5       /* # of seconds of no xfer before "stalling" */
60
61 #define FTP_PORT        21      /* default if ! getservbyname("ftp/tcp") */
62 #define HTTP_PORT       80      /* default if ! getservbyname("http/tcp") */
63 #ifndef GATE_PORT
64 #define GATE_PORT       21      /* default if ! getservbyname("ftpgate/tcp") */
65 #endif
66 #ifndef GATE_SERVER
67 #define GATE_SERVER     ""      /* default server */
68 #endif
69
70 #define PAGER           "more"  /* default pager if $PAGER isn't set */
71
72 /*
73  * Options and other state info.
74  */
75 int     trace;                  /* trace packets exchanged */
76 int     hash;                   /* print # for each buffer transferred */
77 int     mark;                   /* number of bytes between hashes */
78 int     sendport;               /* use PORT cmd for each data connection */
79 int     epsv4;                  /* use EPSV/EPRT cmds on IPv4 ftp */
80 int     verbose;                /* print messages coming back from server */
81 int     connected;              /* 1 = connected to server, -1 = logged in */
82 int     fromatty;               /* input is from a terminal */
83 int     interactive;            /* interactively prompt on m* cmds */
84 int     confirmrest;            /* confirm rest of current m* cmd */
85 int     debug;                  /* debugging level */
86 int     bell;                   /* ring bell on cmd completion */
87 int     doglob;                 /* glob local file names */
88 int     autologin;              /* establish user account on connection */
89 int     proxy;                  /* proxy server connection active */
90 int     proxflag;               /* proxy connection exists */
91 int     gatemode;               /* use gate-ftp */
92 char   *gateserver;             /* server to use for gate-ftp */
93 int     sunique;                /* store files on server with unique name */
94 int     runique;                /* store local files with unique name */
95 int     mcase;                  /* map upper to lower case for mget names */
96 int     ntflag;                 /* use ntin ntout tables for name translation */
97 int     mapflag;                /* use mapin mapout templates on file names */
98 int     preserve;               /* preserve modification time on files */
99 int     progress;               /* display transfer progress bar */
100 int     code;                   /* return/reply code for ftp command */
101 int     crflag;                 /* if 1, strip car. rets. on ascii gets */
102 char    pasv[BUFSIZ];           /* passive port for proxy data connection */
103 int     passivemode;            /* passive mode enabled */
104 int     restricted_data_ports;  /* enable quarantine FTP area */
105 char   *altarg;                 /* argv[1] with no shell-like preprocessing  */
106 char    ntin[17];               /* input translation table */
107 char    ntout[17];              /* output translation table */
108 char    mapin[MAXPATHLEN];      /* input map template */
109 char    mapout[MAXPATHLEN];     /* output map template */
110 char    typename[32];           /* name of file transfer type */
111 int     type;                   /* requested file transfer type */
112 int     curtype;                /* current file transfer type */
113 char    structname[32];         /* name of file transfer structure */
114 int     stru;                   /* file transfer structure */
115 char    formname[32];           /* name of file transfer format */
116 int     form;                   /* file transfer format */
117 char    modename[32];           /* name of file transfer mode */
118 int     mode;                   /* file transfer mode */
119 char    bytename[32];           /* local byte size in ascii */
120 int     bytesize;               /* local byte size in binary */
121 int     anonftp;                /* automatic anonymous login */
122 int     dirchange;              /* remote directory changed by cd command */
123 int     ttywidth;               /* width of tty */
124 char   *tmpdir;                 /* temporary directory */
125 int     try_epsv;               /* try EPSV for this session */
126
127 #ifndef SMALL
128 int       editing;              /* command line editing enabled */
129 EditLine *el;                   /* editline(3) status structure */
130 History  *hist;                 /* editline(3) history structure */
131 char     *cursor_pos;           /* cursor position we're looking for */
132 size_t    cursor_argc;          /* location of cursor in margv */
133 size_t    cursor_argo;          /* offset of cursor in margv[cursor_argc] */
134 #endif /* !SMALL */
135
136 off_t   bytes;                  /* current # of bytes read */
137 off_t   filesize;               /* size of file being transferred */
138 char   *direction;              /* direction transfer is occurring */
139 off_t   restart_point;          /* offset to restart transfer */
140
141 char   *hostname;               /* name of host connected to */
142 int     unix_server;            /* server is unix, can use binary for ascii */
143 int     unix_proxy;             /* proxy is unix, can use binary for ascii */
144
145 char *ftpport;                  /* port number to use for ftp connections */
146 char *httpport;                 /* port number to use for http connections */
147 char *gateport;                 /* port number to use for gateftp connections */
148
149 int     dobind;                 /* bind to specific address */
150 struct addrinfo * bindres0;     /* addrinfo for address to bind to */
151
152 jmp_buf toplevel;               /* non-local goto stuff for cmd scanner */
153
154 char    line[FTPBUFLEN];        /* input line buffer */
155 char    *stringbase;            /* current scan point in line buffer */
156 char    argbuf[FTPBUFLEN];      /* argument storage buffer */
157 char    *argbase;               /* current storage point in arg buffer */
158 StringList *marg_sl;            /* stringlist containing margv */
159 int     margc;                  /* count of arguments on input line */
160 #define margv (marg_sl->sl_str) /* args parsed from input line */
161 int     cpend;                  /* flag: if != 0, then pending server reply */
162 int     mflag;                  /* flag: if != 0, then active multi command */
163
164 int     options;                /* used during socket creation */
165
166 /*
167  * Format of command table.
168  */
169 struct cmd {
170         char    *c_name;        /* name of command */
171         char    *c_help;        /* help string */
172         char     c_bell;        /* give bell when command completes */
173         char     c_conn;        /* must be connected to use command */
174         char     c_proxy;       /* proxy server may execute */
175 #ifndef SMALL
176         char    *c_complete;    /* context sensitive completion list */
177 #endif /* !SMALL */
178         void    (*c_handler) __P((int, char **)); /* function to call */
179 };
180
181 struct macel {
182         char mac_name[9];       /* macro name */
183         char *mac_start;        /* start of macro in macbuf */
184         char *mac_end;          /* end of macro in macbuf */
185 };
186
187 int macnum;                     /* number of defined macros */
188 struct macel macros[16];
189 char macbuf[4096];