ESPFtpServer.h

/*
*  FTP SERVER FOR ESP8266/ESP32
 * based on FTP Server for Arduino Due and Ethernet shield (W5100) or WIZ820io (W5200)
 * based on Jean-Michel Gallego's work
 * modified to work with esp8266 SPIFFS by David Paiva (david@nailbuster.com)
 * 2017: modified by @robo8080 (ported to ESP32 and SD)
 * 2019: modified by @fa1ke5 (use SD card in SD_MMC mode (No SD lib, SD_MMC lib), and added fully fuctional passive mode ftp server)
 * 2020: modified by @jmwislez (support generic FS, and re-introduced ESP8266)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


/*******************************************************************************
 **                                                                            **
 **                       DEFINITIONS FOR FTP SERVER                           **
 **                                                                            **
 *******************************************************************************/

// Uncomment to print debugging info to console
//#define FTP_DEBUG

#ifndef FTP_SERVERESP_H
#define FTP_SERVERESP_H

#include <FS.h>
#include <WiFiClient.h>

#define FTP_SERVER_VERSION "jmwislez/ESP32FtpServer 0.1.0"

#define FTP_CTRL_PORT      21           // Command port on wich server is listening  
#define FTP_DATA_PORT_PASV 50009        // Data port in passive mode

#define FTP_TIME_OUT       5            // Disconnect client after 5 minutes of inactivity
#define FTP_CMD_SIZE       255 + 8      // max size of a command
#define FTP_CWD_SIZE       255 + 8      // max size of a directory name
#define FTP_FIL_SIZE       255          // max size of a file name

#define FTP_BUF_SIZE       4096         // 700 KByte/s download in AP mode, direct connection.

class FtpServer {
  public:
    void    begin (String uname, String pword);
    void    handleFTP (fs::FS &fs);

  private:
    bool    haveParameter ();
    bool    makeExistsPath (fs::FS &fs, char * path, char * param = NULL);
    void    iniVariables ();
    void    clientConnected ();
    void    disconnectClient ();
    boolean userIdentity ();
    boolean userPassword ();
    boolean processCommand (fs::FS &fs);
    boolean dataConnect ();
    boolean doRetrieve ();
    boolean doStore ();
    void    closeTransfer ();
    void    abortTransfer ();
    boolean makePath (char * fullname);
    boolean makePath (char * fullName, char * param);
    uint8_t getDateTime (uint16_t * pyear, uint8_t * pmonth, uint8_t * pday,
                         uint8_t * phour, uint8_t * pminute, uint8_t * second);
    char *  makeDateTimeStr (char * tstr, uint16_t date, uint16_t time);
    int8_t  readChar ();
    String  fillSpaces (uint8_t len, String input_str);

    IPAddress  dataIp;                  // IP address of client for data
    WiFiClient client;
    WiFiClient data;

    File file;
  
    boolean  dataPassiveConn;
    uint16_t dataPort;
    char     buf[FTP_BUF_SIZE];         // data buffer for transfers
    char     cmdLine[FTP_CMD_SIZE];     // where to store incoming char from client
    char     cwdName[FTP_CWD_SIZE];     // name of current directory
    char     command[5];                // command sent by client
    boolean  rnfrCmd;                   // previous command was RNFR
    char *   parameters;                // point to begin of parameters sent by client
    uint16_t iCL;                       // pointer to cmdLine next incoming char
    int8_t   cmdStatus,                 // status of ftp command connexion
             transferStatus;            // status of ftp data transfer
    uint32_t millisTimeOut,             // disconnect after 5 min of inactivity
             millisDelay,
             millisEndConnection,       // 
             millisBeginTrans,          // store time of beginning of a transaction
             bytesTransferred;          //
    String   _FTP_USER;
    String   _FTP_PASS;
};

#endif // FTP_SERVERESP_H