Network.FTP.Client

Main Entrypoints

withFTP :: (MonadIO m, MonadMask m) => String -> Int -> (Handle -> FTPResponse -> m a) -> m 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 :: (MonadMask m, MonadIO m) => String -> Int -> (Handle -> FTPResponse -> m a) -> m 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.

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

Control Commands

login :: MonadIO m => Handle -> String -> String -> m FTPResponse

pasv :: MonadIO m => Handle -> m (String, Int)

rename :: MonadIO m => Handle -> String -> String -> m FTPResponse

dele :: MonadIO m => Handle -> String -> m FTPResponse

cwd :: MonadIO m => Handle -> String -> m FTPResponse

size :: MonadIO m => Handle -> String -> m Int

mkd :: MonadIO m => Handle -> String -> m String

rmd :: MonadIO m => Handle -> String -> m FTPResponse

pwd :: MonadIO m => Handle -> m String

quit :: MonadIO m => Handle -> m FTPResponse

Data Commands

nlst :: (MonadIO m, MonadMask m) => Handle -> [String] -> m ByteString

retr :: (MonadIO m, MonadMask m) => Handle -> String -> m ByteString

list :: (MonadIO m, MonadMask m) => Handle -> [String] -> m ByteString

stor :: (MonadIO m, MonadMask m) => Handle -> String -> ByteString -> RTypeCode -> m ()

mlsd :: (MonadIO m, MonadMask m) => Handle -> String -> m [MlsxResponse]

mlst :: (MonadIO m, MonadMask m) => Handle -> String -> m MlsxResponse

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

Mlsd String

Mlst String

Cwd String

Cdup

Ccc

Auth

Pwd

Abor

Pasv

Quit

Instances

Show FTPCommand

Defined in Network.FTP.Client

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 :: FTPMessage

  Text of the response

Instances

Eq FTPResponse

Defined in Network.FTP.Client

Methods

(==) :: FTPResponse -> FTPResponse -> Bool

(/=) :: FTPResponse -> FTPResponse -> Bool

Show FTPResponse

Defined in Network.FTP.Client

Methods

showsPrec :: Int -> FTPResponse -> ShowS

show :: FTPResponse -> String

showList :: [FTPResponse] -> ShowS

data FTPMessage

Constructors

SingleLine ByteString

MultiLine [ByteString]

Instances

Eq FTPMessage

Defined in Network.FTP.Client

Methods

(==) :: FTPMessage -> FTPMessage -> Bool

(/=) :: FTPMessage -> FTPMessage -> Bool

Show FTPMessage

Defined in Network.FTP.Client

Methods

showsPrec :: Int -> FTPMessage -> ShowS

show :: FTPMessage -> String

showList :: [FTPMessage] -> ShowS

data ResponseStatus

First digit of an FTP response

Constructors

Wait

1

Success

2

Continue

3

FailureRetry

4

Failure

5

Instances

Eq ResponseStatus

Defined in Network.FTP.Client

Methods

(==) :: ResponseStatus -> ResponseStatus -> Bool

(/=) :: ResponseStatus -> ResponseStatus -> Bool

Show ResponseStatus

Defined in Network.FTP.Client

Methods

showsPrec :: Int -> ResponseStatus -> ShowS

show :: ResponseStatus -> String

showList :: [ResponseStatus] -> ShowS

data MlsxResponse

Constructors

MlsxResponse

Fields

• mrFilename :: String
• mrFacts :: Map String String

Instances

Show MlsxResponse

Defined in Network.FTP.Client

Methods

showsPrec :: Int -> MlsxResponse -> ShowS

show :: MlsxResponse -> String

showList :: [MlsxResponse] -> ShowS

data RTypeCode

Constructors

TA

TI

data PortActivity

Constructors

Active

Passive

data ProtType

Constructors

P

C

data Security

Constructors

Clear

TLS

data Handle

Can send and recieve a ByteString.

Constructors

Handle

Fields

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

Exceptions

data FTPException

Constructors

FailureRetryException FTPResponse

FailureException FTPResponse

UnsuccessfulException FTPResponse

BogusResponseFormatException FTPResponse

BadProtocolResponseException ByteString

Instances

Show FTPException

Defined in Network.FTP.Client

Methods

showsPrec :: Int -> FTPException -> ShowS

show :: FTPException -> String

showList :: [FTPException] -> ShowS

Exception FTPException

Defined in Network.FTP.Client

Methods

toException :: FTPException -> SomeException

fromException :: SomeException -> Maybe FTPException

displayException :: FTPException -> String

Handle Implementations

sIOHandleImpl :: Handle -> Handle

tlsHandleImpl :: Connection -> Handle

Lower Level Functions

sendCommand :: MonadIO m => Handle -> FTPCommand -> m 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 :: MonadIO m => Handle -> FTPCommand -> m FTPResponse

recvAll :: (MonadIO m, MonadCatch m) => Handle -> m ByteString

Recieve all data and return it as a ByteString

sendAll :: MonadIO m => Handle -> [FTPCommand] -> m [FTPResponse]

Equvalent to

mapM . sendCommand

sendAllS :: MonadIO m => Handle -> [FTPCommand] -> m [FTPResponse]

Equvalent to

mapM . sendCommandS

getLineResp :: Handle -> IO ByteString

Get a line from the server

getResponse :: MonadIO m => Handle -> m FTPResponse

Get a full response from the server Used in sendCommand

getResponseS :: MonadIO m => Handle -> m FTPResponse

sendCommandLine :: MonadIO m => Handle -> ByteString -> m ()

createSendDataCommand :: (MonadIO m, MonadMask m) => Handle -> PortActivity -> FTPCommand -> m Handle

Send setup commands to the server and create a data Handle

createTLSSendDataCommand :: (MonadIO m, MonadMask m) => Handle -> PortActivity -> FTPCommand -> m Connection

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

parseMlsxLine :: ByteString -> MlsxResponse