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

C# FTP Client Library

, 23 May 2007 CPOL
Rate this:
Please Sign up or sign in to vote.
Easy to use FTP client library with features in mind.

Introduction

This code is an FTP class library for adding FTP access to your projects. It is heavily based on a project (see background for original code), and is now contained in the source files. I was not sure how to update the original article or add to it so I am publishing this as a new article since there was an extensive re-work of the original code in an attempt to make it more developer-friendly.

Background

This article, and code, are based upon the ftplib posted by J.P. Trosclair. A link to the article is here. I have left original copyright and credit notices in with the updated version of the code.

Using the code

I used nDoc to create a CHM file (in the doc directory of the code) to help with implementation. Its fairly simple, and you will mainly need basic FTP connection information (IP, username, etc.) to use the library.

An example is included in the documentation, and appears as so (to upload a file):

OpenFTP.FTP f = new OpenFTP.FTP();
f.Connect("127.0.0.1", "username_here", "password_here");
f.ChangeDirectory("somedirectory");
f.Files.Upload(Path.GetFileName(sFileName), Path.GetFileName(sFileName));

while (!f.Files.UploadComplete)
{
    Console.WriteLine("Uploading: TotalBytes: " + 
        f.Files.TotalBytes.ToString() + ", : PercentComplete: " + 
        f.Files.PercentComplete.ToString());
}
Console.WriteLine("Upload Complete: TotalBytes: " + 
    f.Files.TotalBytes.ToString() + ", : PercentComplete: " + 
    f.Files.PercentComplete.ToString());

f.Disconnect();
f = null;

Points of Interest

I liked the original article but decided that even though I could read and implement the code I wanted its implementation to be more simplistic so months later I won't have to re-read any code to figure how to include the methods in a new project. I have tried to remove the rough edges.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

jmers
Web Developer
Anonymous Proxy Anonymous Proxy
I am a Senior-level .NET developer using C# for about 5+ years now.
 
Codeproject has been a tremendous resource for me over the years.

Comments and Discussions

 
QuestionThank you PinmemberJason asdf29-Apr-14 12:52 
QuestionHow to check if the connection is established? PinmemberAnLa06109527-Jun-11 5:08 
GeneralAlex FTPS Client PinmemberB.Ritter5-Mar-11 1:09 
Generalexpect a demo Pinmemberpclion13-Feb-11 23:55 
GeneralNot work in download .. PinmemberAlexB4712-Feb-11 8:33 
GeneralBug solutions Pinmemberrobnet17-Aug-10 1:28 
GeneralRe: Bug solutions PinmemberB.Ritter1-Nov-10 7:37 
QuestionI cannot get the listing of the files plus other bugs PinmemberEvandrojr2-Mar-10 11:22 
GeneralActive Mode Pinmemberliglio27-Jan-10 15:33 
GeneralRe: Active Mode Pinmemberjmers27-Jan-10 18:13 
GeneralRe: Active Mode Pinmemberliglio28-Jan-10 4:13 
Ok, I put the internal class FTPPlumbing to public, and is downloading the files. The problem now is that all files are empty. I taked a look at the Download method and I can not see the code of receiving bytes from the socket.
 
public void Download(string sRemoteFilename, string sLocalFilename, bool bResume)
{
if (FTPPlumbing.IsConnected)
{
FTPPlumbing.SetBinaryMode(true);
SelectedFileSize = this[sRemoteFilename].FileSize;
TotalBytes = 0;
PercentComplete = 0;
 
#region Setup File
 
if (bResume && System.IO.File.Exists(sLocalFilename))
{
#region Setup File to Resume
 
try
{
FTPPlumbing.file = new FileStream(sLocalFilename, FileMode.Open);
}
catch (Exception e)
{
FTPPlumbing.file = null;
throw e;
}
 
FTPPlumbing.SendCommand("REST " + FTPPlumbing.file.Length);
 
if (FTPPlumbing.ResponseCode != FTPPlumbing.FTPResponseCode.FileActionPended)
{
throw new Exception(FTPPlumbing.ResponseString);
}
 
FTPPlumbing.file.Seek(FTPPlumbing.file.Length, SeekOrigin.Begin);
TotalBytes = FTPPlumbing.file.Length;
 
#endregion Setup File to Resume
}
else
{
#region Setup File for Initial Download
 
try
{
FTPPlumbing.file = new FileStream(sLocalFilename, FileMode.Create);
}
catch (Exception e)
{
FTPPlumbing.file = null;
throw e;
}
 
#endregion Setup File for Initial Download
}
 
#endregion Setup File
 
#region Connect Socket
 
FTPPlumbing.OpenDataSocket();
FTPPlumbing.SendCommand("RETR " + sRemoteFilename);
 
switch (FTPPlumbing.ResponseCode)
{
case FTPPlumbing.FTPResponseCode.DataConnectionAlreadyOpen:
case FTPPlumbing.FTPResponseCode.FileStatusOK:
break;
 
default:
FTPPlumbing.file.Close();
FTPPlumbing.file = null;
throw new Exception(FTPPlumbing.ResponseString);
}
 
FTPPlumbing.ConnectDataSocket();
 
#endregion Connect Socket
}
else
{
throw new Exception("FTP Not Connected - Download Cannot Begin");
}
}
GeneralRe: Active Mode PinmemberDaniel Castenholz29-Jan-10 9:22 
QuestionSocketException Error Code 11004 PinmemberZac Greve10-Jan-10 11:54 
AnswerRe: SocketException Error Code 11004 Pinmemberjmers10-Jan-10 16:18 
Questionupload folder PinmemberDirekt200718-Nov-09 5:07 
GeneralCF 3.5 PinmemberGateone7512-Aug-09 3:32 
RantLOL PinmemberSeishin#8-Apr-09 3:01 
GeneralRe: LOL PinmemberPhylum12322-Oct-09 6:25 
GeneralExceoption when trying to upload [modified] PinmvpJohn Simmons / outlaw programmer8-Jan-09 12:52 
QuestionHow to connect to two FTP Servers PinmemberLearnNetnAll15-Dec-08 22:59 
GeneralA socket operation encountered a dead network Pinmemberjosephx2k715-Dec-08 13:41 
Generalgood library Pinmemberemilioarp12-Nov-08 8:30 
Generalconnection was forcibly closed by the remote host at System.Net.Sockets. Pinmembernext100years11-Nov-08 1:55 
GeneralA comfortable FTP class in .NET PinmemberElmue27-Aug-08 13:22 
GeneralChangeDirectory Chrash PinmemberMember 42541521-May-08 12:52 
GeneralRe: ChangeDirectory Chrash Pinmemberjmers3-May-08 10:36 
GeneralRe: ChangeDirectory Chrash Pinmemberstreit31-May-08 14:13 
GeneralRe: ChangeDirectory Chrash Pinmemberemilioarp2-Oct-08 9:47 
GeneralRe: ChangeDirectory Chrash PinmemberB.Ritter3-Nov-08 10:50 
GeneralRe: ChangeDirectory Chrash [modified] PinmemberB.Ritter8-Nov-08 3:42 
GeneralRe: ChangeDirectory Chrash Pinmemberemilioarp10-Nov-08 9:18 
GeneralRe: ChangeDirectory Chrash PinmemberB.Ritter10-Nov-08 23:12 
GeneralRe: ChangeDirectory Chrash Pinmemberemilioarp12-Nov-08 5:24 
GeneralRe: ChangeDirectory Chrash Pinmemberjose.mira27-Apr-09 8:38 
GeneralRe: ChangeDirectory Chrash Pinmemberjose.mira4-May-09 8:01 
Generalerror connecting the ftpserver Pinmembernanio31-Jan-08 21:56 
GeneralRe: error connecting the ftpserver Pinmemberjmers30-Apr-08 6:57 
GeneralSubdirectories when uploading Pinmemberdannywooly21-Nov-07 1:50 
GeneralRe: Subdirectories when uploading Pinmemberjmers21-Nov-07 5:24 
GeneralFiles download Pinmemberblablablaidan24-Oct-07 23:05 
GeneralRe: Files download Pinmemberjmers25-Oct-07 2:13 
GeneralRe: Files download Pinmemberblablablaidan25-Oct-07 4:09 
GeneralRe: Files download Pinmemberjmers25-Oct-07 4:43 
GeneralRe: Files download Pinmemberblablablaidan25-Oct-07 5:15 
GeneralRe: Files download Pinmemberjmers30-Apr-08 7:02 
GeneralRe: Files download PinmemberG_Pow18-Sep-08 12:39 
GeneralRe: Files download Pinmemberemilioarp12-Nov-08 8:23 
GeneralRe: Files download PinmemberMember 45941477-Apr-09 16:40 
GeneralList Directories Pinmemberblablablaidan17-Oct-07 2:58 
GeneralRe: List Directories Pinmemberjmers24-Oct-07 6:38 

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
Web02 | 2.8.141220.1 | Last Updated 23 May 2007
Article Copyright 2007 by jmers
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid