Click here to Skip to main content
Click here to Skip to main content

Console FTP in C#

, 7 Mar 2004
Rate this:
Please Sign up or sign in to vote.
A basic FTP client in C#.

Introduction

This is my first attempt at making a useful application using C# and sockets. The program is far from complete but I think it can do the basics for now (upload, download, resume, append). I want to add as many features as possible to this semi-console version so that way, it will be easy to use it in a windows form. I'm the worst when it comes to [GOOD] coding practices/methods so I'll take any advice on how I can make my code more efficient. I wouldn't mind hearing how other people have designed such programs.

Since the initial post, I have been working on and off on the FTP client. Unfortunately, my HD crashed and all my work so I restarted from what I had submitted last October. I'm very happy to see that a few individuals have sampled by code and posted messages. I'm trying to design the class to be modular, so it can easily be used/imported in/to a GUI or Console program, and simple.

If you find any bugs, please post them or tell me. I found a lot as I redid the project. The picture to the left is using CoreFtp in a console and the right is using ExtFtpIa in a form.

-- Update --

I have again rewritten the code, it is much cleaner and uses less lines of code. Unfortunately, I didn't implement a lot of the features I had in my previous two versions because they were unnecessary.

Details

Some of the cool things that it can do so far is queue upload/download commands, resume/append files and establish a data connection using PASV or PORT. I've also commented most of the functions in XML so you can create a comments webpage.

The library is capable of uploading, downloading, resuming and appending and can establish a data connection using PASV or PORT. Text sent by the client, and text received from the server can be captured by using a System.IO.TextWriter object such as Console.Out, or TextWriter.Null (if you don't want to capture the text).

Unfortunately, I don't have full access to a windows FTP server so I was unable to implement WindowsFileNode.Delete. It will throw a NotImplementedException when invoked.

I also included some other classes in the library to send emails (MIME and regular text e-mails), and to retrieve e-mails using a POP3 server.

The Important Classes and Methods

Create

The FtpConnection.Create method is overloaded. One will take a username and password, and the other will login anonymously.

[STAThread]
static void Main(string[] args)
{
    FtpConnection ftpConn = FtpConnection.Create("ftp.epson.com", 
      21, Console.Out, Console.Out);
}

ReceiveReply

ReceiveReply retrieves the reply sent by the server. The method blocks until the reply has been received. What is returned is an and ArpaReply object which has two important properties, a reply code and a reply message.

FileTransfer

FileTransfer is an abstract classes that synchronously or asynchronously, uploads or downloads a file to or from a FTP server. The four main classes that derive from FileTransfer are ActiveFileDownload, PassiveFileUpload, ActiveFileUpload, and PassiveFileUpload. When performing an asynchronous file transfer, an IDataTransferAsyncResult is returned which contains a method to asynchronosuly abort a file transfer, and a property, BytesTransferred, that gets the amount of bytes transferred so far.

SendCommand

SendCommand sends a commands to the FTP server. The command to send is selected using the , FtpCommand enumerator. You place the parameters in a string object.

SendCommand(FtpCommand cmd, string param)

DirectoryList

DirectoryList is an abstract class to retrieve a directory listing from a FTP server. The classes derived from it are ActiveDirectoryList and PassiveDirectoryList.

FileNode

FileNode contains an abstract method, FileNode.FromFtpList , that parses the directory listing received from a FTP server to an array of FileNode objects. I made a class for the UNIX and windows file listing. I'm having problems with parsing the listings from some servers (e.x.: doing a directory listing from ftp.epson.com/drivers will generate errors). I didn't create code for WindowsFileNode.Delete because I don't have a windows FTP server to test it on, so for now, it will throw a NotImplemented exception.

Test Code

[STAThread]
static void Main(string[] args)
{
    FtpConnection ftpConn = FtpConnection.Create("risc.ua.edu", 21, 
      Console.Out, Console.Out);
    
    //get directory listing
    DirectoryList dirList = new PassiveDirectoryList(ftpConn);
    byte[] data = dirList.GetList(null, Console.Out, Console.Out);
    
    //parse directory listing
    string list = System.Text.Encoding.ASCII.GetString(data);
    UnixFileNode[] fileNodes = (UnixFileNode[]) new UnixFileNode().FromFtpList(list, 
      ftpConn.CurrentWorkingDirectory);
    
    //show listing on console
    foreach(UnixFileNode fileNode in fileNodes)
    Console.WriteLine(fileNode);
    
    //disconnect
    ftpConn.Close();
}

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Hasani

United States United States
No Biography provided

Comments and Discussions

 
AnswerRe: How about support other languages? Pinmemberwoto21-Mar-04 5:35 
Generalrandom update PinmemberHasani28-May-03 14:30 
GeneralGreat but what about a simple example Pinmembernsimeonov28-May-03 3:31 
GeneralRe: Great but what about a simple example PinmemberHasani28-May-03 14:19 
what ide do you use? the xml comments should make it work well w/ vs.net. Is the description on this website not good enough?
 
[begin code sample]
 
//create handler
CoreFtp.FtpEventHandler handler = new CoreFtp.FtpEventHandler();
 
//redirect output to console
handler.OnOutputMessage += new CoreFtp.FtpEventHandler.OutputMessageHandler(Console.WriteLine);
handler.OnOutputServerReply += new CoreFtp.FtpEventHandler.OutputMessageHandler(Console.WriteLine);
handler.OnOutputClientCmd += new CoreFtp.FtpEventHandler.OutputMessageHandler(Console.WriteLine);
 
//set ip, port, username and password
string ftpip = "someserver";
int port = 21;
string username = "anonymous";
string pwd = string.Empty;
 
//create the ftp object which automatically connects to the server when instantiated
CoreFtp ftpconn = new CoreFtp(ftpip, 21, username, pwd, handler);
 
string dir = ftpconn.CurrentDirectory;
 
//get directory listing which is stored in an array of FileInfoNode object
FileInfoNode[] dirListing = ftpconn.GetList(dir);
foreach(FileInfoNode entry in dirListing)
     //there are other properties the FileInfoNode object has that
     //such as FileSize, creationdate, etc   and can be displayed on the console
     Console.WriteLine(entry.FullPath);
 
//to upload a file
string lclFile = @"C:\MyFavorite.mp3";
string rmtFile = "MyFavorite.mp3";
bool useAscii = false;
ftpconn.SendFile(lclFile, rmtFile, useAscii);
 
//to download a file
lclFile = @"C:\PS2Preview.mpg";
rmtFile = "/pub/PS2/clips/04122003/randomclipofps2.mpg";
ftpconn.GetFile(lclFile, rmtFile, useAscii);
 
[end code sample]
GeneralRe: Great but what about a simple example Pinmembernsimeonov30-May-03 5:27 
GeneralRe: Great but what about a simple example PinmemberHasani31-May-03 10:01 
GeneralRe: Great but what about a simple example Pinmembers2ksim25-Mar-04 12:30 
GeneralRe: Great but what about a simple example PinmemberHasani25-Mar-04 15:37 
GeneralRe: Great but what about a simple example Pinmembers2ksim26-Mar-04 4:13 
GeneralRe: Great but what about a simple example PinmemberHasani26-Mar-04 21:12 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web03 | 2.8.141223.1 | Last Updated 8 Mar 2004
Article Copyright 2002 by Hasani
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid