xref: /third_party/curl/lib/ftplistparser.h (revision 13498266) 
1#ifndef HEADER_CURL_FTPLISTPARSER_H
2#define HEADER_CURL_FTPLISTPARSER_H
3/***************************************************************************
4 *                                  _   _ ____  _
5 *  Project                     ___| | | |  _ \| |
6 *                             / __| | | | |_) | |
7 *                            | (__| |_| |  _ <| |___
8 *                             \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 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
28#ifndef CURL_DISABLE_FTP
29
30/* WRITEFUNCTION callback for parsing LIST responses */
31size_t Curl_ftp_parselist(char *buffer, size_t size, size_t nmemb,
32                          void *connptr);
33
34struct ftp_parselist_data; /* defined inside ftplibparser.c */
35
36CURLcode Curl_ftp_parselist_geterror(struct ftp_parselist_data *pl_data);
37
38struct ftp_parselist_data *Curl_ftp_parselist_data_alloc(void);
39
40void Curl_ftp_parselist_data_free(struct ftp_parselist_data **pl_data);
41
42/* list of wildcard process states */
43typedef enum {
44  CURLWC_CLEAR = 0,
45  CURLWC_INIT = 1,
46  CURLWC_MATCHING, /* library is trying to get list of addresses for
47                      downloading */
48  CURLWC_DOWNLOADING,
49  CURLWC_CLEAN, /* deallocate resources and reset settings */
50  CURLWC_SKIP,  /* skip over concrete file */
51  CURLWC_ERROR, /* error cases */
52  CURLWC_DONE   /* if is wildcard->state == CURLWC_DONE wildcard loop
53                   will end */
54} wildcard_states;
55
56typedef void (*wildcard_dtor)(void *ptr);
57
58/* struct keeping information about wildcard download process */
59struct WildcardData {
60  char *path; /* path to the directory, where we trying wildcard-match */
61  char *pattern; /* wildcard pattern */
62  struct Curl_llist filelist; /* llist with struct Curl_fileinfo */
63  struct ftp_wc *ftpwc; /* pointer to FTP wildcard data */
64  wildcard_dtor dtor;
65  unsigned char state; /* wildcard_states */
66};
67
68CURLcode Curl_wildcard_init(struct WildcardData *wc);
69void Curl_wildcard_dtor(struct WildcardData **wcp);
70
71struct Curl_easy;
72
73#else
74/* FTP is disabled */
75#define Curl_wildcard_dtor(x)
76#endif /* CURL_DISABLE_FTP */
77#endif /* HEADER_CURL_FTPLISTPARSER_H */
78