Network.FTP.Client

Main Entrypoints

withFTP :: String -> Int -> (Handle -> FTPResponse -> IO a) -> IO a

Takes a host name and port. A handle for interacting with the server will be returned in a callback.

     withFTP "ftp.server.com" 21 $ h welcome -> do
         print welcome
         login h "username" "password"
         print =<< nlst h []

withFTPS :: String -> Int -> (Handle -> FTPResponse -> IO a) -> IO a

Takes a host name and port. A handle for interacting with the server will be returned in a callback. The commands will be protected with TLS. Make sure to use TLS data commands like nlstS or retrS if you want those to use TLS as well

     withFTPS "ftps.server.com" 21 $ h welcome -> do
         print welcome
         login h "username" "password"
         print =<< nlstS h []

Control Commands

login :: Handle -> String -> String -> IO FTPResponse

pasv :: Handle -> IO (String, Int)

rename :: Handle -> String -> String -> IO FTPResponse

dele :: Handle -> String -> IO FTPResponse

cwd :: Handle -> String -> IO FTPResponse

size :: Handle -> String -> IO Int

mkd :: Handle -> String -> IO String

rmd :: Handle -> String -> IO FTPResponse

pwd :: Handle -> IO String

quit :: Handle -> IO FTPResponse

Data Commands

nlst :: Handle -> [String] -> IO ByteString

retr :: Handle -> String -> IO ByteString

list :: Handle -> [String] -> IO ByteString

stor :: Handle -> String -> ByteString -> RTypeCode -> IO ()

Secure Data Commands

nlstS :: Handle -> [String] -> IO ByteString

retrS :: Handle -> String -> IO ByteString

listS :: Handle -> [String] -> IO ByteString

storS :: Handle -> String -> ByteString -> RTypeCode -> IO ()

Types

data FTPCommand

Commands according to the FTP specification

Constructors

User String

Pass String

Acct String

RType RTypeCode

Retr String

Nlst [String]

Port HostAddress PortNumber

Stor String

List [String]

Rnfr String

Rnto String

Dele String

Size String

Mkd String

Rmd String

Pbsz Int

Prot ProtType

Cwd String

Cdup

Ccc

Auth

Pwd

Abor

Pasv

Quit

Instances

Show FTPCommand

Methods

showsPrec :: Int -> FTPCommand -> ShowS

show :: FTPCommand -> String

showList :: [FTPCommand] -> ShowS

data FTPResponse

Response from an FTP command. ex "200 Welcome!"

Constructors

FTPResponse

Fields

• frStatus :: ResponseStatus

  Interpretation of the first digit of an FTP response code

• frCode :: Int

  The three digit response code

• frMessage :: ByteString

  Text of the response

Instances

Show FTPResponse

Methods

showsPrec :: Int -> FTPResponse -> ShowS

show :: FTPResponse -> String

showList :: [FTPResponse] -> ShowS

data ResponseStatus

First digit of an FTP response

Constructors

Wait

1

Success

2

Continue

3

FailureRetry

4

Failure

5

Instances

Show ResponseStatus

Methods

showsPrec :: Int -> ResponseStatus -> ShowS

show :: ResponseStatus -> String

showList :: [ResponseStatus] -> ShowS

data RTypeCode

Constructors

TA

TI

data PortActivity

Constructors

Active

Passive

data Handle

Can send and recieve a ByteString.

Constructors

Handle

Fields

• send :: ByteString -> IO ()
• sendLine :: ByteString -> IO ()
• recv :: Int -> IO ByteString
• recvLine :: IO ByteString

Handle Implementations

sIOHandleImpl :: Handle -> Handle

tlsHandleImpl :: Connection -> Handle

Lower Level Functions

sendCommand :: Handle -> FTPCommand -> IO FTPResponse

Send a command to the server and get a response back. Some commands use a data Handle, and their data is not returned here.

sendCommands :: Handle -> [FTPCommand] -> IO [FTPResponse]

Equvalent to

mapM . sendCommand

getLineResp :: Handle -> IO ByteString

Get a line from the server

getMultiLineResp :: Handle -> IO FTPResponse

Get a full response from the server Used in sendCommand

sendCommandLine :: Handle -> ByteString -> IO ()

createSendDataCommand :: Handle -> PortActivity -> [FTPCommand] -> IO Handle

Send setup commands to the server and create a data Handle

createTLSSendDataCommand :: Handle -> PortActivity -> [FTPCommand] -> IO Connection

Send setup commands to the server and create a data TLS connection