License	Public Domain
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.FTP.Client

Contents

Main Entrypoints
Control Commands
Data Commands
Types
Exceptions
Handle Implementations
Lower Level Functions

Description

Synopsis

withFTP :: (MonadIO m, MonadMask m) => String -> Int -> (Handle -> FTPResponse -> m a) -> m a
withFTPS :: (MonadMask m, MonadIO m) => String -> Int -> (Handle -> FTPResponse -> m a) -> m a
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
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
data FTPCommand
- = 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
data FTPResponse = FTPResponse {
- frStatus :: ResponseStatus
- frCode :: Int
- frMessage :: FTPMessage
}
data FTPMessage
- = SingleLine ByteString
- | MultiLine [ByteString]
data ResponseStatus
- = Wait
- | Success
- | Continue
- | FailureRetry
- | Failure
data MlsxResponse = MlsxResponse {
- mrFilename :: String
- mrFacts :: Map String String
}
data RTypeCode
- = TA
- | TI
data PortActivity
- = Active
- | Passive
data ProtType
- = P
- | C
data Security
- = Clear
- | TLS
data Handle = Handle {
- send :: ByteString -> IO ()
- sendLine :: ByteString -> IO ()
- recv :: Int -> IO ByteString
- recvLine :: IO ByteString
- security :: Security
}
data FTPException
- = FailureRetryException FTPResponse
- | FailureException FTPResponse
- | UnsuccessfulException FTPResponse
- | BogusResponseFormatException FTPResponse
- | BadProtocolResponseException ByteString
sIOHandleImpl :: Handle -> Handle
tlsHandleImpl :: Connection -> Handle
sendCommand :: MonadIO m => Handle -> FTPCommand -> m FTPResponse
sendCommandS :: MonadIO m => Handle -> FTPCommand -> m FTPResponse
recvAll :: (MonadIO m, MonadCatch m) => Handle -> m ByteString
sendAll :: MonadIO m => Handle -> [FTPCommand] -> m [FTPResponse]
sendAllS :: MonadIO m => Handle -> [FTPCommand] -> m [FTPResponse]
getLineResp :: Handle -> IO ByteString
getResponse :: MonadIO m => Handle -> m FTPResponse
getResponseS :: MonadIO m => Handle -> m FTPResponse
sendCommandLine :: MonadIO m => Handle -> ByteString -> m ()
createSendDataCommand :: (MonadIO m, MonadMask m) => Handle -> PortActivity -> FTPCommand -> m Handle
createTLSSendDataCommand :: (MonadIO m, MonadMask m) => Handle -> PortActivity -> FTPCommand -> m Connection
parseMlsxLine :: ByteString -> MlsxResponse

Main Entrypoints

withFTP :: (MonadIO m, MonadMask m) => String -> Int -> (Handle -> FTPResponse -> m a) -> m a Source #

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 Source #

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 Source #

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

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

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

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

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

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

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

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

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

Data Commands

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

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

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

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

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

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

Types

data FTPCommand Source #

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

Instances details

Show FTPCommand Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> FTPCommand -> ShowS # show :: FTPCommand -> String # showList :: [FTPCommand] -> ShowS #

data FTPResponse Source #

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

Instances details

Show FTPResponse Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> FTPResponse -> ShowS # show :: FTPResponse -> String # showList :: [FTPResponse] -> ShowS #
Eq FTPResponse Source #
Instance details Defined in Network.FTP.Client Methods (==) :: FTPResponse -> FTPResponse -> Bool # (/=) :: FTPResponse -> FTPResponse -> Bool #

data FTPMessage Source #

Constructors

SingleLine ByteString
MultiLine [ByteString]

Instances

Instances details

Show FTPMessage Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> FTPMessage -> ShowS # show :: FTPMessage -> String # showList :: [FTPMessage] -> ShowS #
Eq FTPMessage Source #
Instance details Defined in Network.FTP.Client Methods (==) :: FTPMessage -> FTPMessage -> Bool # (/=) :: FTPMessage -> FTPMessage -> Bool #

data ResponseStatus Source #

First digit of an FTP response

Constructors

Wait	1
Success	2
Continue	3
FailureRetry	4
Failure	5

Instances

Instances details

Show ResponseStatus Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> ResponseStatus -> ShowS # show :: ResponseStatus -> String # showList :: [ResponseStatus] -> ShowS #
Eq ResponseStatus Source #
Instance details Defined in Network.FTP.Client Methods (==) :: ResponseStatus -> ResponseStatus -> Bool # (/=) :: ResponseStatus -> ResponseStatus -> Bool #

data MlsxResponse Source #

Constructors

MlsxResponse
Fields mrFilename :: String mrFacts :: Map String String

Instances

Instances details

Show MlsxResponse Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> MlsxResponse -> ShowS # show :: MlsxResponse -> String # showList :: [MlsxResponse] -> ShowS #

data RTypeCode Source #

Constructors

TA
TI

data PortActivity Source #

Constructors

Active
Passive

data ProtType Source #

Constructors

P
C

data Security Source #

Constructors

Clear
TLS

data Handle Source #

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 Source #

Constructors

FailureRetryException FTPResponse
FailureException FTPResponse
UnsuccessfulException FTPResponse
BogusResponseFormatException FTPResponse
BadProtocolResponseException ByteString

Instances

Instances details

Exception FTPException Source #
Instance details Defined in Network.FTP.Client Methods toException :: FTPException -> SomeException # fromException :: SomeException -> Maybe FTPException # displayException :: FTPException -> String #
Show FTPException Source #
Instance details Defined in Network.FTP.Client Methods showsPrec :: Int -> FTPException -> ShowS # show :: FTPException -> String # showList :: [FTPException] -> ShowS #