cClientFTP.h

Go to the documentation of this file.

//
//
#ifndef _INC_cClientFTP_H
#define _INC_cClientFTP_H
#ifndef NO_PRAGMA_ONCE
#pragma once
#endif
 
#include "cClientFTPData.h"
#ifdef USE_PING_TEST
#include "GrayLib/include/Net/cNetAddrTracker.h"
#endif
#include "GrayLib/include/Net/cNetAddrName.h"
#ifdef USE_SSL
#include "GrayLib/include/SSL/CSSLChannel.h"
#endif
 
namespace GrayFTP
{
        class cFTPAccount;
        typedef cRefPtr<cFTPAccount> cFTPAccountPtr;
        enum FTP_PRIV_TYPE_;
 
        enum FTP_TTYPE_TYPE
        {
                FTP_TTYPE_ASCII_NONPRINT,       // TYPE A
                FTP_TTYPE_BINARY_IMAGE,         // TYPE I
 
                // Not really supported yet.
                FTP_TTYPE_ASCII_TELNET,
                FTP_TTYPE_ASCII_CSA,
                FTP_TTYPE_EBCDIC_NONPRINT,
                FTP_TTYPE_EBCDIC_TELNET,
                FTP_TTYPE_EBCDIC_ASA,
        };
 
        enum FTP_TMODE_TYPE
        {
                FTP_TMODE_STREAM,
                FTP_TMODE_BLOCK,
                FTP_TMODE_COMPRESSED
        };
 
        enum FTP_TSTRUCT_TYPE
        {
                FTP_TSTRUCT_FILE,
                FTP_TSTRUCT_RECORD,
                FTP_TSTRUCT_PAGE
        };
 
        enum CF_TYPE_
        {
                CF_AUTHENTICATE = 0x01, 
                CF_PARM_NEED = 0x02,    
                CF_PARM_OPTIONAL = 0x04,        
                CF_PARM_HIDE = 0x08,    
                CF_FEAT = 0x10,                 
                CF_MAJOR = 0x20,                
        };
 
        typedef void (cClientFTP::* FTP_CMD_FUNC)(const char* pszParam);        // a method in cClientFTP
 
        struct CFTPCmd
        {
                const char* m_pszCmd;           
                StrLen_t m_iCmdLen;
                const char* m_pszSyntax;        
                DWORD m_dwFlags;                        
                FTP_CMD_FUNC m_Function;        
        };
 
        class cClientFTP : public cClientFTPBase
        {
 
                typedef cClientFTPBase SUPER_t;
 
        private:
                static const CFTPCmd k_CmdArray[];
                static const CFTPCmd k_SiteCmdArray[];
 
        public:
                cNetAddrName m_AddrPeer;        
#ifdef USE_PING_TEST
                cNetAddrTrackPtr m_pAddrTrack;  
#endif
#ifdef USE_SSL
                cSSLServerStreamPtr m_pAuthSSL; 
#endif
                                                                        // Current command.
                char m_szCmdBuffer[_MAX_PATH];  
                const CFTPCmd* m_pCmd;                  
 
                                                                                // User logged in.
                cStringA m_sUserName;           
                cFTPAccountPtr m_pAccount;      
                bool m_bAccountLogin;           
 
                                                                        // Data connection params.
                bool m_bUTF8;
                STREAM_POS_t m_nDataRestoreOffset;      
                cNetAddress m_DAddr;                    
                cNetServerPortPtr m_pDPasv;             
                cFTPDataParamsPtr m_pDataParams;                        
                cArrayRef<cClientFTPData> m_aConnectData;       
 
                                                                                                        // Session Environment
                FTP_TTYPE_TYPE m_TransferType;          // Cmd_Type
                FTP_TMODE_TYPE m_TransferMode;
                FTP_TSTRUCT_TYPE m_TransferStruct;
 
                // Current path.
                cStringA m_sCWD;                        
                cStringA m_sActiveUserPath;     
                FILECHAR_t m_tActiveFilePath[_MAX_PATH];        
 
        protected:
                static const CFTPCmd* FindCmd(const CFTPCmd* pCmds, const char* pszCmd);
 
                void Cmd_Pasv_Start(const char* pszParam, bool bExt);
 
        public:
                cClientFTP(cFTPFactory* pFactory, IUnkObject* pServerConnection, cStreamInput* pStreamInp, cStreamOutput* pStreamOut);
                virtual ~cClientFTP();
 
                cFTPFactory* get_FTPFactory() const;
                virtual HRESULT DisposeThis(void) override;
 
                void Data_ConnectComplete(cClientFTPData* pClient, bool bPasv);
                HRESULT Data_ConnectOpen();
                bool Data_IsPASV() const
                {
                        return !m_DAddr.isAddrValid();
                }
 
                static inline bool IsRoot(const char* pStr)
                {
                        for (; *pStr != '\0'; pStr++)
                        {
                                if (!cFilePath::IsCharDirSep(*pStr))
                                        return false;
                        }
                        return true;
                }
 
                HTTPRET_TYPE MakeFilePath(const char* pszName, FTP_PRIV_TYPE_ wPrivReq, cFileFindEntry* pfd = nullptr);
 
                const char* DoCommandCheck(const char* pszCmdBuffer);
                void DoControlCmd(const char* pszCmdBuffer);
 
                virtual HRESULT ProcessStreamPacket() override;
                bool OnException();
 
                StrLen_t _cdecl ReplyF(HTTPRET_TYPE eReplyCode, const char* pReplyString, ...);
 
                int Reply_OK(HTTPRET_TYPE eReplyCode = HTTPRET_OK_DATA);
                int Reply_BadPath(HTTPRET_TYPE eReplyCode = HTTPRET_ER_550);
                int Reply_SysError(HTTPRET_TYPE eReplyCode, const char* pszText, HRESULT hRes);
                int Reply_SysErrorLast(HTTPRET_TYPE eReplyCode, const char* pszText = nullptr);
                int Reply_ParameterNotImplemented(const char* pText);
 
                int Reply_DataTransferError(const char* pError, HRESULT hRes);
                int Reply_DataTransferAbort(HRESULT hRes);
                int Reply_DataTransferComplete(void);
 
                void Cmd_Allo(const char* pszParam);
#ifdef USE_SSL
                void Cmd_Auth(const char* pszParam);
#endif
                void Cmd_Appe(const char* pszParam);
                void Cmd_Pwd(const char* pszParam);
                void Cmd_Cwd(const char* pszParam);
                void Cmd_Cdup(const char* pszParam);
                void Cmd_Mkd(const char* pszParam);
                void Cmd_Opts(const char* pszParam);
                void Cmd_Rest(const char* pszParam);
                void Cmd_Rmd(const char* pszParam);
                void Cmd_Retr(const char* pszParam);
                void Cmd_Stor_Base(const char* pszParam, bool bAppend);
                void Cmd_Stor(const char* pszParam);
                void Cmd_Dele(const char* pszParam);
                void Cmd_Epsv(const char* pszParam);
                void Cmd_Help_Base(const CFTPCmd* pCmds, const char* pszType, const char* pszParam);
                void Cmd_Help(const char* pszParam);
                void Cmd_List_Base(const char* pszParam, bool bVerbose);
                void Cmd_Mdtm(const char* pszParam);
                void Cmd_List(const char* pszParam);
                void Cmd_Nlst(const char* pszParam);
                void Cmd_User(const char* pszParam);
                void Cmd_Pass(const char* pszParam);
                void Cmd_Pasv(const char* pszParam);
                void Cmd_Noop(const char* pszParam);
                void Cmd_Quit(const char* pszParam);
                void Cmd_Port(const char* pszParam);
                void Cmd_Syst(const char* pszParam);
                void Cmd_Abor(const char* pszParam);
                void Cmd_Mode(const char* pszParam);
                void Cmd_Struct(const char* pszParam);
                void Cmd_Stat(const char* pszParam);
                void Cmd_Size(const char* pszParam);
                void Cmd_Type(const char* pszParam);
                void Cmd_Feat(const char* pszParam);
                void Cmd_Rnfr(const char* pszParam);
                void Cmd_Rnto(const char* pszParam);
                void Cmd_UTF8(const char* pszParam);
 
                void Cmd_Site(const char* pszParam);
                void Cmd_Site_Help(const char* pszParam);
                // void Cmd_Site_ChMod( const char* pszParam );
#ifdef UNDER_CE
                void Cmd_Site_CeMon(const char* pszParam);
#endif
 
                // Event types. LOG_ATTR_MASK_t
                StrLen_t _cdecl LogEventF(LOG_ATTR_MASK_t dwAttrMask, const LOGCHAR_t* pszFormat, ...);
        };
 
        typedef cRefPtr<cClientFTP> cClientFTPPtr;
};
#endif // _INC_cClientFTP_H