sjero.net Git - wget/blob - src/ftp.h

   1 /* Declarations for FTP support.
   2    Copyright (C) 1996-2006 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Wget.
   5
   6 GNU Wget is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 GNU Wget is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Wget; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 In addition, as a special exception, the Free Software Foundation
  21 gives permission to link the code of its release of Wget with the
  22 OpenSSL project's "OpenSSL" library (or with modified versions of it
  23 that use the same license as the "OpenSSL" library), and distribute
  24 the linked executables.  You must obey the GNU General Public License
  25 in all respects for all of the code used other than "OpenSSL".  If you
  26 modify this file, you may extend this exception to your version of the
  27 file, but you are not obligated to do so.  If you do not wish to do
  28 so, delete this exception statement from your version.  */
  29
  30 #ifndef FTP_H
  31 #define FTP_H
  32
  33 #include "host.h"
  34
  35 /* System types. */
  36 enum stype
  37 {
  38   ST_UNIX,
  39   ST_VMS,
  40   ST_WINNT,
  41   ST_MACOS,
  42   ST_OS400,
  43   ST_OTHER
  44 };
  45
  46 extern char ftp_last_respline[];
  47
  48 uerr_t ftp_response (int, char **);
  49 uerr_t ftp_login (int, const char *, const char *);
  50 uerr_t ftp_port (int, int *);
  51 uerr_t ftp_pasv (int, ip_address *, int *);
  52 #ifdef ENABLE_IPV6
  53 uerr_t ftp_lprt (int, int *);
  54 uerr_t ftp_lpsv (int, ip_address *, int *);
  55 uerr_t ftp_eprt (int, int *);
  56 uerr_t ftp_epsv (int, ip_address *, int *);
  57 #endif
  58 uerr_t ftp_type (int, int);
  59 uerr_t ftp_cwd (int, const char *);
  60 uerr_t ftp_retr (int, const char *);
  61 uerr_t ftp_rest (int, wgint);
  62 uerr_t ftp_list (int, const char *);
  63 uerr_t ftp_syst (int, enum stype *);
  64 uerr_t ftp_pwd (int, char **);
  65 uerr_t ftp_size (int, const char *, wgint *);
  66
  67 #ifdef ENABLE_OPIE
  68 const char *skey_response (int, const char *, const char *);
  69 #endif
  70
  71 struct url;
  72
  73 /* File types.  */
  74 enum ftype
  75 {
  76   FT_PLAINFILE,
  77   FT_DIRECTORY,
  78   FT_SYMLINK,
  79   FT_UNKNOWN
  80 };
  81
  82
  83 /* Globbing (used by ftp_retrieve_glob).  */
  84 enum
  85 {
  86   GLOB_GLOBALL, GLOB_GETALL, GLOB_GETONE
  87 };
  88
  89 /* Information about one filename in a linked list.  */
  90 struct fileinfo
  91 {
  92   enum ftype type;              /* file type */
  93   char *name;                   /* file name */
  94   wgint size;                   /* file size */
  95   long tstamp;                  /* time-stamp */
  96   int perms;                    /* file permissions */
  97   char *linkto;                 /* link to which file points */
  98   struct fileinfo *prev;        /* previous... */
  99   struct fileinfo *next;        /* ...and next structure. */
 100 };
 101
 102 /* Commands for FTP functions.  */
 103 enum wget_ftp_command
 104 {
 105   DO_LOGIN      = 0x0001,       /* Connect and login to the server.  */
 106   DO_CWD        = 0x0002,       /* Change current directory.  */
 107   DO_RETR       = 0x0004,       /* Retrieve the file.  */
 108   DO_LIST       = 0x0008,       /* Retrieve the directory list.  */
 109   LEAVE_PENDING = 0x0010        /* Do not close the socket.  */
 110 };
 111
 112 enum wget_ftp_fstatus
 113 {
 114   NOTHING       = 0x0000,       /* Nothing done yet.  */
 115   ON_YOUR_OWN   = 0x0001,       /* The ftp_loop_internal sets the
 116                                    defaults.  */
 117   DONE_CWD      = 0x0002        /* The current working directory is
 118                                    correct.  */
 119 };
 120
 121 struct fileinfo *ftp_parse_ls (const char *, const enum stype);
 122 uerr_t ftp_loop (struct url *, int *, struct url *, bool, bool);
 123
 124 uerr_t ftp_index (const char *, struct url *, struct fileinfo *);
 125
 126 char ftp_process_type (const char *);
 127
 128
 129 #endif /* FTP_H */