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 program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  17
  18 #ifndef FTP_H
  19 #define FTP_H
  20
  21 /* Need it for struct rbuf.  */
  22 #include "rbuf.h"
  23
  24 /* System types. */
  25 enum stype
  26 {
  27   ST_UNIX,
  28   ST_VMS,
  29   ST_WINNT,
  30   ST_OTHER
  31 };
  32
  33 uerr_t ftp_response PARAMS ((struct rbuf *, char **));
  34 uerr_t ftp_login PARAMS ((struct rbuf *, const char *, const char *));
  35 uerr_t ftp_port PARAMS ((struct rbuf *));
  36 uerr_t ftp_pasv PARAMS ((struct rbuf *, unsigned char *));
  37 uerr_t ftp_type PARAMS ((struct rbuf *, int));
  38 uerr_t ftp_cwd PARAMS ((struct rbuf *, const char *));
  39 uerr_t ftp_retr PARAMS ((struct rbuf *, const char *));
  40 uerr_t ftp_rest PARAMS ((struct rbuf *, long));
  41 uerr_t ftp_list PARAMS ((struct rbuf *, const char *));
  42 uerr_t ftp_syst PARAMS ((struct rbuf *, enum stype *));
  43 uerr_t ftp_pwd PARAMS ((struct rbuf *, char **));
  44
  45 struct urlinfo;
  46
  47 /* File types.  */
  48 enum ftype
  49 {
  50   FT_PLAINFILE,
  51   FT_DIRECTORY,
  52   FT_SYMLINK,
  53   FT_UNKNOWN
  54 };
  55
  56
  57 /* Globbing (used by ftp_retrieve_glob).  */
  58 enum
  59 {
  60   GLOBALL, GETALL, GETONE
  61 };
  62
  63 /* Information about one filename in a linked list.  */
  64 struct fileinfo
  65 {
  66   enum ftype type;              /* file type */
  67   char *name;                   /* file name */
  68   long size;                    /* file size */
  69   long tstamp;                  /* time-stamp */
  70   int perms;                    /* file permissions */
  71   char *linkto;                 /* link to which file points */
  72   struct fileinfo *prev;        /* previous... */
  73   struct fileinfo *next;        /* ...and next structure. */
  74 };
  75
  76 /* Commands for FTP functions.  */
  77 enum command
  78 {
  79   DO_LOGIN      = 0x0001,       /* Connect and login to the server.  */
  80   DO_CWD        = 0x0002,       /* Change current directory.  */
  81   DO_RETR       = 0x0004,       /* Retrieve the file.  */
  82   DO_LIST       = 0x0008,       /* Retrieve the directory list.  */
  83   LEAVE_PENDING = 0x0010        /* Do not close the socket.  */
  84 };
  85
  86 enum fstatus
  87 {
  88   NOTHING       = 0x0000,       /* Nothing done yet.  */
  89   ON_YOUR_OWN   = 0x0001,       /* The ftp_loop_internal sets the
  90                                    defaults.  */
  91   DONE_CWD      = 0x0002        /* The current working directory is
  92                                    correct.  */
  93 };
  94
  95 typedef struct
  96 {
  97   int st;                       /* connection status */
  98   int cmd;                      /* command code */
  99   struct rbuf rbuf;             /* control connection buffer */
 100   long dltime;                  /* time of the download */
 101 } ccon;
 102
 103 struct fileinfo *ftp_parse_ls PARAMS ((const char *, enum stype));
 104 uerr_t ftp_loop PARAMS ((struct urlinfo *, int *));
 105
 106 uerr_t ftp_index (const char *, struct urlinfo *, struct fileinfo *);
 107
 108 #endif /* FTP_H */