-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | FTP Client and Server Library -- -- ftphs provides a Haskell library to implement a FTP client and a FTP -- server. -- -- ftphs has a number of features: -- -- @package ftphs @version 1.0.7 -- | This module provides a parser that is used internally by -- Network.FTP.Client. You almost certainly do not want to use -- this module directly. Use Network.FTP.Client instead. -- -- Written by John Goerzen, jgoerzen@complete.org module Network.FTP.Client.Parser -- | Parse a FTP reply. Returns a (result code, text) pair. parseReply :: String -> FTPResult -- | Parse a FTP reply. Returns a (result code, text) pair. If the result -- code indicates an error, raise an exception instead of just passing it -- back. parseGoodReply :: String -> IO FTPResult -- | Converts a socket address to a string suitable for a PORT command. -- -- Example: -- -- 
--   toPortString (SockAddrInet (PortNum 0x1234) (0xaabbccdd)) ->
--                                "170,187,204,221,18,52"
--
toPortString :: SockAddr -> IO String -- | Converts a port string to a socket address. This is the inverse -- calculation of toPortString. fromPortString :: String -> IO SockAddr -- | Parse a FTP reply. Logs debug messages. debugParseGoodReply :: String -> IO FTPResult -- | Converts a response code to a socket address respToSockAddr :: FTPResult -> IO SockAddr type FTPResult = (Int, [String]) unexpectedresp :: Show a => [Char] -> a -> [Char] isxresp :: (Num a, Ord a) => a -> (a, t) -> Bool forcexresp :: (Num a, Ord a, Show t) => a -> (a, t) -> (a, t) forceioresp :: Int -> FTPResult -> IO () parseDirName :: FTPResult -> Maybe String -- | This module provides a parser that is used internally by -- Network.FTP.Server. You almost certainly do not want to use -- this module directly. Use Network.FTP.Server instead. -- -- Written by John Goerzen, jgoerzen@complete.org module Network.FTP.Server.Parser parseCommand :: Handle -> IO (Either ParseError (String, String)) -- | This module provides a server-side interface to the File Transfer -- Protocol as defined by: -- -- -- -- Written by John Goerzen, jgoerzen@complete.org -- -- This is a modular FTP server implementation in pure Haskell. It is -- highly adaptable to many different tasks, and can serve up not only -- real files and directories, but also virtually any data structure you -- could represent as a filesystem. It does this by using the -- System.IO.HVFS and System.IO.HVIO modules. -- -- In addition, basic networking and multitasking configuration is -- handled via Network.SocketServer and logging via -- System.Log.Logger. -- -- This module is believed to be secure, but it not believed to be robust -- enough for use on a public FTP server. In particular, it may be -- vulnerable to denial of service attacks due to no timeouts or -- restrictions on data size, and error catching is not yet completely -- pervasive. These will be fixed in time. Your patches would also be -- welcomed. -- -- Here is an example server that serves up the entire local filesystem -- in a read-only manner: -- -- 
--   import Network.FTP.Server
--   import Network.SocketServer
--   import System.Log.Logger
--   import System.IO.HVFS
--   import System.IO.HVFS.Combinators
--   
--   main = do
--          updateGlobalLogger "" (setLevel DEBUG)
--          updateGlobalLogger "Network.FTP.Server" (setLevel DEBUG)
--          let opts = (simpleTCPOptions 12345) {reuse = True}
--          serveTCPforever opts $
--               threadedHandler $
--               loggingHandler "" INFO $
--               handleHandler $
--               anonFtpHandler (HVFSReadOnly SystemFS)
--
-- -- Hint: if you wantto serve up only part of a filesystem, see -- System.IO.HVFS.Combinators.newHVFSChroot. module Network.FTP.Server -- | Main FTP handler; pass the result of applying this to one argument to -- handleHandler anonFtpHandler :: HVFSOpenable a => a -> Handle -> SockAddr -> SockAddr -> IO () instance [overlap ok] Eq AuthState instance [overlap ok] Show AuthState instance [overlap ok] Eq DataType instance [overlap ok] Show DataType instance [overlap ok] Ord Command instance [overlap ok] Eq Command -- | This module provides a client-side interface to the File Transfer -- Protocol as defined by RFC959 and RFC1123. -- -- Written by John Goerzen, jgoerzen@complete.org -- -- Welcome to the FTP module for Haskell. -- -- Here is a quick usage example to get you started. This is a log of a -- real session with ghci: -- -- (This would be similar in a do block. You could also save it to -- a file and run that with Hugs.) -- -- 
--   Prelude> :l Network.FTP.Client
--   ...
--
-- -- The above loads the module. -- -- Next, we enable the debugging. This will turn on all the FTP -- sent and FTP received messages you'll see. -- -- 
--   Prelude Network.FTP.Client> enableFTPDebugging
--
-- -- Now, connect to the server on ftp.kernel.org. -- -- 
--   *Network.FTP.Client> h <- easyConnectFTP "ftp.kernel.org"
--   FTP received: 220 Welcome to ftp.kernel.org.
--
-- -- And log in anonymously. -- -- 
--   *Network.FTP.Client> loginAnon h
--   FTP sent: USER anonymous
--   FTP received: 331 Please specify the password.
--   FTP sent: PASS anonymous@
--   ...
--   FTP received: 230 Login successful.
--
-- -- Change the directory... -- -- 
--   Prelude Network.FTP.Client> cwd h "/pub/linux/kernel/Historic"
--   FTP sent: CWD /pub/linux/kernel/Historic
--   FTP received: 250 Directory successfully changed.
--
-- -- Let's look at the directory. nlst returns a list of strings, -- each string corresponding to a filename. Here, putStrLn . -- unlines will simply print them out, one per line. -- -- 
--   Prelude Network.FTP.Client> nlst h Nothing >>= putStrLn . unlines
--   FTP sent: TYPE A
--   FTP received: 200 Switching to ASCII mode.
--   FTP sent: PASV
--   FTP received: 227 Entering Passive Mode (204,152,189,116,130,143)
--   FTP sent: NLST
--   FTP received: 150 Here comes the directory listing.
--   linux-0.01.tar.bz2
--   linux-0.01.tar.bz2.sign
--   linux-0.01.tar.gz
--   linux-0.01.tar.gz.sign
--   linux-0.01.tar.sign
--   old-versions
--   v0.99
--   FTP received: 226 Directory send OK.
--
-- -- Let's try downloading something and print it to the screen. Again, we -- use putStrLn. We use fst here because -- getbinary returns a tuple consisting of a string representing -- the data and a FTPResult code. -- -- 
--   Prelude Network.FTP.Client> getbinary h "linux-0.01.tar.gz.sign" >>= putStrLn . fst
--   FTP sent: TYPE I
--   FTP received: 200 Switching to Binary mode.
--   FTP sent: PASV
--   FTP received: 227 Entering Passive Mode (204,152,189,116,121,121)
--   FTP sent: RETR linux-0.01.tar.gz.sign
--   FTP received: 150 Opening BINARY mode data connection for linux-0.01.tar.gz.sign (248 bytes).
--   -----BEGIN PGP SIGNATURE-----
--   Version: GnuPG v1.0.0 (GNU/Linux)
--   Comment: See http://www.kernel.org/signature.html for info
--   
--   iD8DBQA54rf0yGugalF9Dw4RAqelAJ9lafFni4f/QyJ2IqDXzW2nz/ZIogCfRPtg
--   uYpWffOhkyByfhUt8Lcelec=
--   =KnLA
--   -----END PGP SIGNATURE-----
--   FTP received: 226 File send OK.
--
-- -- Here's an example showing you what the result code looks like. -- -- 
--   Prelude Network.FTP.Client> getbinary h "linux-0.01.tar.gz.sign" >>= print . snd
--   ...
--   (226,["File send OK."])
--
-- -- The first component of the FTPResult object is the numeric -- status code from the server. The second component is a list of message -- lines from the server. -- -- Now, let's get a more detailed directory listing: -- -- 
--   Prelude Network.FTP.Client> dir h Nothing >>= putStrLn . unlines
--   ...
--   -r--r--r--    1 536      536         63362 Oct 30  1993 linux-0.01.tar.bz2
--   -r--r--r--    1 536      536           248 Oct 30  1993 linux-0.01.tar.bz2.sign
--   -r--r--r--    1 536      536         73091 Oct 30  1993 linux-0.01.tar.gz
--   -r--r--r--    1 536      536           248 Oct 30  1993 linux-0.01.tar.gz.sign
--   -r--r--r--    1 536      536           248 Oct 30  1993 linux-0.01.tar.sign
--   drwxrwsr-x    5 536      536          4096 Mar 20  2003 old-versions
--   drwxrwsr-x    2 536      536          4096 Mar 20  2003 v0.99
--   FTP received: 226 Directory send OK.
--
-- -- And finally, log out: -- -- 
--   Prelude Network.FTP.Client> quit h
--   FTP sent: QUIT
--   FTP received: 221 Goodbye.
--
-- -- Here is one big important caution: -- -- /You MUST consume all data from commands that return file data before -- you issue any other FTP commands./ -- -- That's due to the lazy nature of Haskell. This means that, for -- instance, you can't just iterate over the items nlst returns, -- trying to getbinary each one of them -- the system is still -- transferring nlst data while you are trying that, and confusion -- will ensue. Either open two FTP connections or make sure you consume -- the nlst data first. -- -- Here is a partial list of commands effected: nlst, dir, -- getbinary, getlines, downloadbinary. -- -- The Data.List.Utils.seqList function could be quite helpful -- here. For instance: -- -- 
--   x <- nlst h Nothing
--   map (\fn -> ...download files from FTP... ) (seqList x)
--
-- -- If you omit the call to Data.List.Utils.seqList, commands to -- download files will be issued before the entire directory listing is -- read. FTP cannot handle this. -- -- The corrolary is: -- -- /Actions that yield lazy data for data uploading must not issue FTP -- commands themselves./ -- -- This will be fairly rare. Just be aware of this. -- -- This module logs messages under Network.FTP.Client for -- outgoing traffic and Network.FTP.Client.Parser for incoming -- traffic, all with the System.Log.DEBUG priority, so by -- default, no log messages are seen. The enableFTPDebugging -- function will adjust the priorities of these two handlers so debug -- messages are seen. Only control channel conversations are logged. Data -- channel conversations are never logged. -- -- All exceptions raised by this module have a string beginning with -- "FTP: ". Most errors will be IO userErrors. In a few -- extremely rare cases, errors may be raised by the Prelude error -- function, though these will also have a string beginning with -- "FTP: ". Exceptions raised by the underlying networking code -- will be passed on to you unmodified. -- -- Useful standards: -- -- module Network.FTP.Client -- | Connect to the remote FTP server and read but discard the welcome. -- Assumes default FTP port, 21, on remote. easyConnectFTP :: HostName -> IO FTPConnection -- | Connect to remote FTP server and read the welcome. connectFTP :: HostName -> PortNumber -> IO (FTPConnection, FTPResult) -- | Log in anonymously. loginAnon :: FTPConnection -> IO FTPResult -- | Log in to an FTP account. login :: FTPConnection -> String -> Maybe String -> Maybe String -> IO FTPResult -- | Log off the server and quit. quit :: FTPConnection -> IO FTPResult -- | Sets whether passive mode is used (returns new connection object -- reflecting this) setPassive :: FTPConnection -> Bool -> FTPConnection isPassive :: FTPConnection -> Bool -- | Enable logging of FTP messages through System.Log.Logger. -- This sets the log levels of Network.FTP.Client.Parser and -- Network.FTP.Client to DEBUG. By default, this means that full -- protocol dumps will be sent to stderr. -- -- The effect is global and persists until changed. enableFTPDebugging :: IO () -- | Retrieves a list of files in the given directory. -- -- FIXME: should this take a list of dirs? nlst :: FTPConnection -> Maybe String -> IO [String] -- | Retrieve the system-specific long form of a directory list. -- -- FIXME: should this take a list of dirs? dir :: FTPConnection -> Maybe String -> IO [String] -- | Retrieves the specified file in text mode. getlines :: FTPConnection -> String -> IO ([String], FTPResult) -- | Retrieves the specified file in binary mode. getbinary :: FTPConnection -> String -> IO (String, FTPResult) -- | Downloads a file from remote and saves to disk in binary mode. Note: -- filename is used for both local and remote. downloadbinary :: FTPConnection -> String -> IO FTPResult -- | Puts data in the specified file in text mode. The first string is the -- filename. putlines :: FTPConnection -> String -> [String] -> IO FTPResult -- | Puts data in the specified file in binary. The first string is the -- filename. putbinary :: FTPConnection -> String -> String -> IO FTPResult -- | Uploads a file from disk in binary mode. Note: filename is used for -- both local and remote. uploadbinary :: FTPConnection -> String -> IO FTPResult -- | Rename or move a file. rename :: FTPConnection -> String -> String -> IO FTPResult -- | Delete (unlink) a file. delete :: FTPConnection -> String -> IO FTPResult -- | Get the size of a file. -- -- This command is non-standard and may possibly fail. size :: (Num a, Read a) => FTPConnection -> String -> IO a -- | Change the working directory. cwd :: FTPConnection -> String -> IO FTPResult -- | Make new directory. Returns the absolute name of the new directory if -- possible. mkdir :: FTPConnection -> String -> IO (Maybe String, FTPResult) -- | Remove a directory. rmdir :: FTPConnection -> String -> IO FTPResult -- | Print the current working directory. The first component of the result -- is the parsed directory name, if the servers response was parsable. pwd :: FTPConnection -> IO (Maybe String, FTPResult) data FTPConnection -- | Returns the socket part from calling ntransfercmd. transfercmd :: FTPConnection -> String -> IO Handle -- | Establishes a connection to the remote. -- -- FIXME: need support for rest ntransfercmd :: FTPConnection -> String -> IO (Handle, Maybe Integer) -- | Retrieves lines of data from the remote. The string gives the command -- to issue. retrlines :: FTPConnection -> String -> IO ([String], FTPResult) -- | Stores the lines of data to the remote. The string gives the commands -- to issue. storlines :: FTPConnection -> String -> [String] -> IO FTPResult sendcmd :: FTPConnection -> [Char] -> IO FTPResult