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

   1 /* Declarations for FTP support.
   2    Copyright (C) 1995, 1996, 1997, 2000 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
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifndef FTP_H
  21 #define FTP_H
  22
  23 /* Need it for struct rbuf.  */
  24 #include "rbuf.h"
  25
  26 #include "host.h"
  27
  28 /* System types. */
  29 enum stype
  30 {
  31   ST_UNIX,
  32   ST_VMS,
  33   ST_WINNT,
  34   ST_MACOS,
  35   ST_OTHER
  36 };
  37
  38 uerr_t ftp_response PARAMS ((struct rbuf *, char **));
  39 uerr_t ftp_login PARAMS ((struct rbuf *, const char *, const char *));
  40 uerr_t ftp_port PARAMS ((struct rbuf *));
  41 uerr_t ftp_pasv PARAMS ((struct rbuf *, ip_address *, unsigned short *));
  42 #ifdef INET6
  43 uerr_t ftp_epsv PARAMS ((struct rbuf *, ip_address *, unsigned short *,
  44                          char *));
  45 #endif
  46 uerr_t ftp_type PARAMS ((struct rbuf *, int));
  47 uerr_t ftp_cwd PARAMS ((struct rbuf *, const char *));
  48 uerr_t ftp_retr PARAMS ((struct rbuf *, const char *));
  49 uerr_t ftp_rest PARAMS ((struct rbuf *, long));
  50 uerr_t ftp_list PARAMS ((struct rbuf *, const char *));
  51 uerr_t ftp_syst PARAMS ((struct rbuf *, enum stype *));
  52 uerr_t ftp_pwd PARAMS ((struct rbuf *, char **));
  53 uerr_t ftp_size PARAMS ((struct rbuf *, const char *, long int *));
  54
  55 struct url;
  56
  57 /* File types.  */
  58 enum ftype
  59 {
  60   FT_PLAINFILE,
  61   FT_DIRECTORY,
  62   FT_SYMLINK,
  63   FT_UNKNOWN
  64 };
  65
  66
  67 /* Globbing (used by ftp_retrieve_glob).  */
  68 enum
  69 {
  70   GLOBALL, GETALL, GETONE
  71 };
  72
  73 /* Information about one filename in a linked list.  */
  74 struct fileinfo
  75 {
  76   enum ftype type;              /* file type */
  77   char *name;                   /* file name */
  78   long size;                    /* file size */
  79   long tstamp;                  /* time-stamp */
  80   int perms;                    /* file permissions */
  81   char *linkto;                 /* link to which file points */
  82   struct fileinfo *prev;        /* previous... */
  83   struct fileinfo *next;        /* ...and next structure. */
  84 };
  85
  86 /* Commands for FTP functions.  */
  87 enum wget_ftp_command
  88 {
  89   DO_LOGIN      = 0x0001,       /* Connect and login to the server.  */
  90   DO_CWD        = 0x0002,       /* Change current directory.  */
  91   DO_RETR       = 0x0004,       /* Retrieve the file.  */
  92   DO_LIST       = 0x0008,       /* Retrieve the directory list.  */
  93   LEAVE_PENDING = 0x0010,       /* Do not close the socket.  */
  94   NO_TRUNCATE   = 0x0020        /* Don't truncate the file if REST
  95                                    malfunctions. */
  96 };
  97
  98 enum wget_ftp_fstatus
  99 {
 100   NOTHING       = 0x0000,       /* Nothing done yet.  */
 101   ON_YOUR_OWN   = 0x0001,       /* The ftp_loop_internal sets the
 102                                    defaults.  */
 103   DONE_CWD      = 0x0002        /* The current working directory is
 104                                    correct.  */
 105 };
 106
 107 struct fileinfo *ftp_parse_ls PARAMS ((const char *, const enum stype));
 108 uerr_t ftp_loop PARAMS ((struct url *, int *));
 109
 110 uerr_t ftp_index PARAMS ((const char *, struct url *, struct fileinfo *));
 111
 112 char ftp_process_type PARAMS ((const char *));
 113
 114
 115 #endif /* FTP_H */