ftp.h 6.4 KB

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