1 | #ifndef HEADER_CURL_FTP_H |
2 | #define |
3 | /*************************************************************************** |
4 | * _ _ ____ _ |
5 | * Project ___| | | | _ \| | |
6 | * / __| | | | |_) | | |
7 | * | (__| |_| | _ <| |___ |
8 | * \___|\___/|_| \_\_____| |
9 | * |
10 | * Copyright (C) 1998 - 2022, Daniel Stenberg, <[email protected]>, et al. |
11 | * |
12 | * This software is licensed as described in the file COPYING, which |
13 | * you should have received as part of this distribution. The terms |
14 | * are also available at https://curl.se/docs/copyright.html. |
15 | * |
16 | * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
17 | * copies of the Software, and permit persons to whom the Software is |
18 | * furnished to do so, under the terms of the COPYING file. |
19 | * |
20 | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
21 | * KIND, either express or implied. |
22 | * |
23 | * SPDX-License-Identifier: curl |
24 | * |
25 | ***************************************************************************/ |
26 | |
27 | #include "curl_setup.h" |
28 | |
29 | #include "pingpong.h" |
30 | |
31 | #ifndef CURL_DISABLE_FTP |
32 | extern const struct Curl_handler Curl_handler_ftp; |
33 | |
34 | #ifdef USE_SSL |
35 | extern const struct Curl_handler Curl_handler_ftps; |
36 | #endif |
37 | |
38 | CURLcode Curl_GetFTPResponse(struct Curl_easy *data, ssize_t *nread, |
39 | int *ftpcode); |
40 | #endif /* CURL_DISABLE_FTP */ |
41 | |
42 | /**************************************************************************** |
43 | * FTP unique setup |
44 | ***************************************************************************/ |
45 | typedef enum { |
46 | FTP_STOP, /* do nothing state, stops the state machine */ |
47 | FTP_WAIT220, /* waiting for the initial 220 response immediately after |
48 | a connect */ |
49 | FTP_AUTH, |
50 | FTP_USER, |
51 | FTP_PASS, |
52 | FTP_ACCT, |
53 | FTP_PBSZ, |
54 | FTP_PROT, |
55 | FTP_CCC, |
56 | FTP_PWD, |
57 | FTP_SYST, |
58 | FTP_NAMEFMT, |
59 | FTP_QUOTE, /* waiting for a response to a command sent in a quote list */ |
60 | FTP_RETR_PREQUOTE, |
61 | FTP_STOR_PREQUOTE, |
62 | FTP_POSTQUOTE, |
63 | FTP_CWD, /* change dir */ |
64 | FTP_MKD, /* if the dir didn't exist */ |
65 | FTP_MDTM, /* to figure out the datestamp */ |
66 | FTP_TYPE, /* to set type when doing a head-like request */ |
67 | FTP_LIST_TYPE, /* set type when about to do a dir list */ |
68 | FTP_RETR_TYPE, /* set type when about to RETR a file */ |
69 | FTP_STOR_TYPE, /* set type when about to STOR a file */ |
70 | FTP_SIZE, /* get the remote file's size for head-like request */ |
71 | FTP_RETR_SIZE, /* get the remote file's size for RETR */ |
72 | FTP_STOR_SIZE, /* get the size for STOR */ |
73 | FTP_REST, /* when used to check if the server supports it in head-like */ |
74 | FTP_RETR_REST, /* when asking for "resume" in for RETR */ |
75 | FTP_PORT, /* generic state for PORT, LPRT and EPRT, check count1 */ |
76 | FTP_PRET, /* generic state for PRET RETR, PRET STOR and PRET LIST/NLST */ |
77 | FTP_PASV, /* generic state for PASV and EPSV, check count1 */ |
78 | FTP_LIST, /* generic state for LIST, NLST or a custom list command */ |
79 | FTP_RETR, |
80 | FTP_STOR, /* generic state for STOR and APPE */ |
81 | FTP_QUIT, |
82 | FTP_LAST /* never used */ |
83 | } ftpstate; |
84 | |
85 | struct ftp_parselist_data; /* defined later in ftplistparser.c */ |
86 | |
87 | struct ftp_wc { |
88 | struct ftp_parselist_data *parser; |
89 | |
90 | struct { |
91 | curl_write_callback write_function; |
92 | FILE *file_descriptor; |
93 | } backup; |
94 | }; |
95 | |
96 | typedef enum { |
97 | FTPFILE_MULTICWD = 1, /* as defined by RFC1738 */ |
98 | FTPFILE_NOCWD = 2, /* use SIZE / RETR / STOR on the full path */ |
99 | FTPFILE_SINGLECWD = 3 /* make one CWD, then SIZE / RETR / STOR on the |
100 | file */ |
101 | } curl_ftpfile; |
102 | |
103 | /* This FTP struct is used in the Curl_easy. All FTP data that is |
104 | connection-oriented must be in FTP_conn to properly deal with the fact that |
105 | perhaps the Curl_easy is changed between the times the connection is |
106 | used. */ |
107 | struct FTP { |
108 | char *path; /* points to the urlpieces struct field */ |
109 | char *pathalloc; /* if non-NULL a pointer to an allocated path */ |
110 | |
111 | /* transfer a file/body or not, done as a typedefed enum just to make |
112 | debuggers display the full symbol and not just the numerical value */ |
113 | curl_pp_transfer transfer; |
114 | curl_off_t downloadsize; |
115 | }; |
116 | |
117 | |
118 | /* ftp_conn is used for struct connection-oriented data in the connectdata |
119 | struct */ |
120 | struct ftp_conn { |
121 | struct pingpong pp; |
122 | char *entrypath; /* the PWD reply when we logged on */ |
123 | char *file; /* url-decoded file name (or path) */ |
124 | char **dirs; /* realloc()ed array for path components */ |
125 | int dirdepth; /* number of entries used in the 'dirs' array */ |
126 | bool dont_check; /* Set to TRUE to prevent the final (post-transfer) |
127 | file size and 226/250 status check. It should still |
128 | read the line, just ignore the result. */ |
129 | bool ctl_valid; /* Tells Curl_ftp_quit() whether or not to do anything. If |
130 | the connection has timed out or been closed, this |
131 | should be FALSE when it gets to Curl_ftp_quit() */ |
132 | bool cwddone; /* if it has been determined that the proper CWD combo |
133 | already has been done */ |
134 | int cwdcount; /* number of CWD commands issued */ |
135 | bool cwdfail; /* set TRUE if a CWD command fails, as then we must prevent |
136 | caching the current directory */ |
137 | bool wait_data_conn; /* this is set TRUE if data connection is waited */ |
138 | /* newhost is the (allocated) IP addr or host name to connect the data |
139 | connection to */ |
140 | unsigned short newport; |
141 | char *newhost; |
142 | char *prevpath; /* url-decoded conn->path from the previous transfer */ |
143 | char transfertype; /* set by ftp_transfertype for use by Curl_client_write()a |
144 | and others (A/I or zero) */ |
145 | int count1; /* general purpose counter for the state machine */ |
146 | int count2; /* general purpose counter for the state machine */ |
147 | int count3; /* general purpose counter for the state machine */ |
148 | ftpstate state; /* always use ftp.c:state() to change state! */ |
149 | ftpstate state_saved; /* transfer type saved to be reloaded after |
150 | data connection is established */ |
151 | curl_off_t retr_size_saved; /* Size of retrieved file saved */ |
152 | char *server_os; /* The target server operating system. */ |
153 | curl_off_t known_filesize; /* file size is different from -1, if wildcard |
154 | LIST parsing was done and wc_statemach set |
155 | it */ |
156 | BIT(ftp_trying_alternative); |
157 | }; |
158 | |
159 | #define DEFAULT_ACCEPT_TIMEOUT 60000 /* milliseconds == one minute */ |
160 | |
161 | #endif /* HEADER_CURL_FTP_H */ |
162 | |