Ftp.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef SFML_FTP_HPP
#define SFML_FTP_HPP

// Headers
#include <SFML/System/NonCopyable.hpp>
#include <SFML/Network/SocketTCP.hpp>
#include <string>
#include <vector>


namespace sf
{
class IPAddress;

class SFML_API Ftp : NonCopyable
{
public :

    enum TransferMode
    {
        Binary, 
        Ascii,  
        Ebcdic  
    };

    class SFML_API Response
    {
    public :

        enum Status
        {
            // 1xx: the requested action is being initiated,
            // expect another reply before proceeding with a new command
            RestartMarkerReply          = 110, 
            ServiceReadySoon            = 120, 
            DataConnectionAlreadyOpened = 125, 
            OpeningDataConnection       = 150, 

            // 2xx: the requested action has been successfully completed
            Ok                    = 200, 
            PointlessCommand      = 202, 
            SystemStatus          = 211, 
            DirectoryStatus       = 212, 
            FileStatus            = 213, 
            HelpMessage           = 214, 
            SystemType            = 215, 
            ServiceReady          = 220, 
            ClosingConnection     = 221, 
            DataConnectionOpened  = 225, 
            ClosingDataConnection = 226, 
            EnteringPassiveMode   = 227, 
            LoggedIn              = 230, 
            FileActionOk          = 250, 
            DirectoryOk           = 257, 

            // 3xx: the command has been accepted, but the requested action
            // is dormant, pending receipt of further information
            NeedPassword       = 331, 
            NeedAccountToLogIn = 332, 
            NeedInformation    = 350, 

            // 4xx: the command was not accepted and the requested action did not take place,
            // but the error condition is temporary and the action may be requested again
            ServiceUnavailable        = 421, 
            DataConnectionUnavailable = 425, 
            TransferAborted           = 426, 
            FileActionAborted         = 450, 
            LocalError                = 451, 
            InsufficientStorageSpace  = 452, 

            // 5xx: the command was not accepted and
            // the requested action did not take place
            CommandUnknown          = 500, 
            ParametersUnknown       = 501, 
            CommandNotImplemented   = 502, 
            BadCommandSequence      = 503, 
            ParameterNotImplemented = 504, 
            NotLoggedIn             = 530, 
            NeedAccountToStore      = 532, 
            FileUnavailable         = 550, 
            PageTypeUnknown         = 551, 
            NotEnoughMemory         = 552, 
            FilenameNotAllowed      = 553, 

            // 10xx: SFML custom codes
            InvalidResponse  = 1000, 
            ConnectionFailed = 1001, 
            ConnectionClosed = 1002, 
            InvalidFile      = 1003  
        };

        Response(Status Code = InvalidResponse, const std::string& Message = "");

        bool IsOk() const;

        Status GetStatus() const;

        const std::string& GetMessage() const;

    private :

        // Member data
        Status      myStatus;  
        std::string myMessage; 
    };

    class SFML_API DirectoryResponse : public Response
    {
    public :

        DirectoryResponse(Response Resp);

        const std::string& GetDirectory() const;

    private :

        // Member data
        std::string myDirectory; 
    };


    class SFML_API ListingResponse : public Response
    {
    public :

        ListingResponse(Response Resp, const std::vector<char>& Data);

        std::size_t GetCount() const;

        const std::string& GetFilename(std::size_t Index) const;

    private :

        // Member data
        std::vector<std::string> myFilenames; 
    };


    ~Ftp();

    Response Connect(const IPAddress& Server, unsigned short Port = 21, float Timeout = 0.f);

    Response Login();

    Response Login(const std::string& UserName, const std::string& Password);

    Response Disconnect();

    Response KeepAlive();

    DirectoryResponse GetWorkingDirectory();

    ListingResponse GetDirectoryListing(const std::string& Directory = "");

    Response ChangeDirectory(const std::string& Directory);

    Response ParentDirectory();

    Response MakeDirectory(const std::string& Name);

    Response DeleteDirectory(const std::string& Name);

    Response RenameFile(const std::string& File, const std::string& NewName);

    Response DeleteFile(const std::string& Name);

    Response Download(const std::string& DistantFile, const std::string& DestPath, TransferMode Mode = Binary);

    Response Upload(const std::string& LocalFile, const std::string& DestPath, TransferMode Mode = Binary);

private :

    Response SendCommand(const std::string& Command, const std::string& Parameter = "");

    Response GetResponse();

    class DataChannel;

    friend class DataChannel;

    // Member data
    SocketTCP myCommandSocket; 
};

} // namespace sf


#endif // SFML_FTP_HPP