Click here to Skip to main content

Article

C# FTP Client Library

jmers

Rate me:

4.65/5 (24 votes)

23 May 2007CPOL1 min read

264K

4.3K

124

83

Easy to use FTP client library with features in mind.

Download source - 107.3 KB

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

C#

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)

Written By

jmers

Web Developer

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

How can I use download file ?

Wat Thanaphong18-Jun-18 22:37

18-Jun-18 22:37

Work fine on upload but I can't download a file from server. It said file not found everytime. Confused | :confused:

Confused | :confused:

Jason asdf29-Apr-14 11:52

29-Apr-14 11:52

This compiled easily for compact framework and works very well. Thank you.

How to check if the connection is established?

AnLa06109527-Jun-11 4:08

27-Jun-11 4:08

In the project this one was inspired by, you had a 'IsConnected' property in the FTP client class. To check if you where connected.
How do I check my connection in this one.

Alex FTPS Client

B.Ritter5-Mar-11 0:09

5-Mar-11 0:09

After using this library for a while, I finally switched to "Alex FTPS Client".
In my opinion "Alex FTPS Client" is easier to use and more stable!
http://ftps.codeplex.com/

pclion13-Feb-11 22:55

13-Feb-11 22:55

i don't know how the many methods and properties to be used.

            FTP ftp = new FTP();<br />
            if (textBox3.Text.Trim().Length == 0)<br />
                ftp.Connect(textBox1.Text, textBox2.Text, textBox4.Text);<br />
            else<br />
                ftp.Connect(textBox1.Text, int.Parse(textBox3.Text), textBox2.Text, textBox4.Text);<br />
<br />
            List<string> list = new List<string>();<br />
            foreach (FTP.Directory dir in ftp.Directories)<br />
            {<br />
                list.Add(dir.DirectoryName);<br />
            }<br />
            foreach (FTP.File f in ftp.Files)<br />
            {<br />
                list.Add(f.FileName);<br />
            }

but it retrieved nothing.

pclion

Not work in download ..

AlexB4712-Feb-11 7:33

12-Feb-11 7:33

I try this..

OpenFTP.FTP f = new OpenFTP.FTP();
f.Connect("xxx.xxx.xxx.xxx", "ID", "PW");
f.ChangeDirectory("root");
f.ChangeDirectory("public");

//f.Files.Upload("pippo.txt", "C:\\Tmp\\pippo2.txt");
f.Files.Download("pippo.txt", "C:\\Tmp\\pippo3.txt");

and not work. Why?

P.s.
Upload work correctly.

Regards.
Alex

Alex

robnet17-Aug-10 0:28

17-Aug-10 0:28

I think i know why several users have bugs with this project. Honestly, i like this lib, but it was designed only for Win FTP Servers. When i tried to ChangeDirectory("test") or something it just threw an exception without any visible reason. So I checked the source code, stepped through it and two main mistakes are in these two methods:
public void Add(string sUnparsedFile)
and
public void Add(string sUnparsedDirectory)

Here the methods try to parse the filesize and the file and directory date (without any exception handling). The problem is that the string does not match the method which extracts the data. Win != Linux.

I can give you my workaround solution for these two methods, but i will try to solve the problems in a better way and post it here.

public void Add(string sUnparsedDirectory)
{
    string sDirectoryName = sUnparsedDirectory.Substring(39).Trim().Replace("\r", "");
    DateTime dtDirectoryDate;
    try
    {
        dtDirectoryDate = Convert.ToDateTime(sUnparsedDirectory.Substring(0, 8) + " " +    sUnparsedDirectory.Substring(10, 7));
    }
    catch (FormatException)
    {
        dtDirectoryDate = new DateTime();
    }
    Add(sDirectoryName, dtDirectoryDate);

}

public void Add(string sUnparsedFile)
{
    string sFileName = sUnparsedFile.Substring(39).Trim().Replace("\r","");
    long lFileSize;
    DateTime dtFileDate;
    try
    {
        lFileSize = long.Parse(sUnparsedFile.Substring(17, 21).Trim());
        dtFileDate = Convert.ToDateTime(sUnparsedFile.Substring(0, 8) + " " + sUnparsedFile.Substring(10, 7));
    }
    catch (FormatException)
    {
        lFileSize = 0;
        dtFileDate = new DateTime();
    }
				
    Add(sFileName, lFileSize, dtFileDate);
}

greez

Re: Bug solutions

B.Ritter1-Nov-10 6:37

1-Nov-10 6:37

My solution to this problem:

private static Match GetMatchingRegex(string line)
{
    Regex rx;
    Match m;
    for (int i = 0; i <= _ParseFormats.Length - 1; i++)
    {
        rx = new Regex(_ParseFormats[i]);
        m = rx.Match(line);
        if (m.Success)
        {
            return m;
        }
    }
    return null;
}

#region "Regular expressions for parsing LIST results"
        
/// <summary>
/// List of REGEX formats for different FTP server listing formats
/// </summary>
/// <remarks>
/// The first three are various UNIX/LINUX formats, fourth is for MS FTP
/// in detailed mode and the last for MS FTP in 'DOS' mode.
/// </remarks>
private static string[] _ParseFormats = new string[] { 
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})\\s+\\d+\\s+\\w+\\s+\\w+\\s+(?<size>\\d+)\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{4})\\s+(?<name>.+)", 
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})\\s+\\d+\\s+\\d+\\s+(?<size>\\d+)\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{4})\\s+(?<name>.+)", 
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})\\s+\\d+\\s+\\d+\\s+(?<size>\\d+)\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{1,2}:\\d{2})\\s+(?<name>.+)", 
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})\\s+\\d+\\s+\\w+\\s+\\w+\\s+(?<size>\\d+)\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{1,2}:\\d{2})\\s+(?<name>.+)", 
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})(\\s+)(?<size>(\\d+))(\\s+)(?<ctbit>(\\w+\\s\\w+))(\\s+)(?<size2>(\\d+))\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{2}:\\d{2})\\s+(?<name>.+)", 
    "(?<timestamp>\\d{2}\\-\\d{2}\\-\\d{2}\\s+\\d{2}:\\d{2}[Aa|Pp][mM])\\s+(?<dir>\\<\\w+\\>){0,1}(?<size>\\d+){0,1}\\s+(?<name>.+)",
    "(?<dir>[\\-d])(?<permission>([\\-r][\\-w][\\-xs]){3})\\s+\\d+\\s+\\(\\w+\\)\\s+\\(\\w+\\)\\s+(?<size>\\d+)\\s+(?<timestamp>\\w+\\s+\\d+\\s+\\d{1,2}:\\d{2})\\s+(?<name>.+)"};

#endregion

public void Add(string sUnparsedDirectory)
{
    sUnparsedDirectory = sUnparsedDirectory.Replace("\r", string.Empty);

    string sDirectoryName = string.Empty;
    DateTime dtDirectoryDate;

    //parse line
    Match m = GetMatchingRegex(sUnparsedDirectory);
    if (m == null)
    {
        //failed
        throw (new ApplicationException("Unable to parse line: " + sUnparsedDirectory));
    }
    else
    {
        sDirectoryName = m.Groups["name"].Value;

        if (DateTime.TryParse(m.Groups["timestamp"].Value, out dtDirectoryDate) == false)
        {
            dtDirectoryDate = DateTime.MinValue;
        }
    }

    Add(sDirectoryName, dtDirectoryDate);
}

public void Add(string sUnparsedFile)
{
    sUnparsedFile = sUnparsedFile.Replace("\r", string.Empty);

    string sFileName = string.Empty;
    DateTime dtFileDate;
    long lFileSize = 0;

    //parse line
    Match m = GetMatchingRegex(sUnparsedFile);
    if (m == null)
    {
        //failed
        throw (new ApplicationException("Unable to parse line: " + sUnparsedFile));
    }
    else
    {
        sFileName = m.Groups["name"].Value;
        string sFileSize = m.Groups["size"].Value;
        long.TryParse(sFileSize, out lFileSize);

        if (DateTime.TryParse(m.Groups["timestamp"].Value, out dtFileDate) == false)
        {
            dtFileDate = DateTime.MinValue;
        }
    }

	Add(sFileName, lFileSize, dtFileDate);
}

Works pretty good so far Smile | :)

Smile | :)

I cannot get the listing of the files plus other bugs

Evandrojr2-Mar-10 10:22

2-Mar-10 10:22

I have tried with 2 different servers.

It connects but then says that there are 0 files and when I try to download a file it says it could not be found.

namespace NeoUpdate.Core
{
    public class UpdateItSelf
    {
        public void CheckForUpdate()
        {
            OpenFTP.FTP f = new OpenFTP.FTP();

            f.Connect("xxxxxx", "xxxxx", "xxxxx");

            //Gets an exception wrong date time
            //            f.ChangeDirectory("/"); 

            // is ok
            string dir = f.Directories.GetWorkingDirectory();
            string fileNames;

            f.Files.RebuildFileList();

            //  f.Files.Count is always = ZERO
            for( int i=0; i <  f.Files.Count; ++i){
                fileNames = f.Files[i].FileName;
            }

            //gets an exception (file not found)
            f.Files.Download("n.txt");

liglio27-Jan-10 14:33

27-Jan-10 14:33

ftplib had support to Active Mode. How do I use Active Mode in your OpenFTP class ?

Re: Active Mode

jmers27-Jan-10 17:13

27-Jan-10 17:13

I'm really not sure, the ftplib was a basic class for accessing an FTP, I simply wrote a wrapper around it with methods and properties to make it easier to use. The underlying code didn't really change so if the functionality was there before it should still be there, or at least be accessible.

Jmers

Re: Active Mode

liglio28-Jan-10 3:13

28-Jan-10 3: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");
}
}

Re: Active Mode

Daniel Castenholz29-Jan-10 8:22

Daniel Castenholz

29-Jan-10 8:22

I just found myself needing Active mode. Might I suggest that you add the following into the FTP class:

public int Port
{
get { return FTPPlumbing.Port; }
}
// DJC - Expose the passive flag to apps
public bool PassiveMode
{
get { return FTPPlumbing.PassiveMode; }
set { FTPPlumbing.PassiveMode = value; }
}
public long TotalBytes
{
get { return lTotalBytes; }
set { lTotalBytes = value; }
}

SocketException Error Code 11004

Brisingr Aerowing10-Jan-10 10:54

Brisingr Aerowing

10-Jan-10 10:54

When I try to connect to an FTP Server (ftp://ftp.ibiblio.org/) using this library, I get the following error:

System.Net.Sockets.SocketException was unhandled
ErrorCode=11004
Message="The requested name is valid, but no data of the requested type was found"
NativeErrorCode=11004
Source="System"

I removed the rest of the Message.

Here is the code that threw the exception:

f.Connect("ftp://ftp.ibiblio.org", "Anon", "")

If you would like to see the entire error message, I will email it to you.

My email is ztgreve@gmail.com

This error does not make much sense to me.

Ztgreve

Re: SocketException Error Code 11004

jmers10-Jan-10 15:18

10-Jan-10 15:18

Did you try the address part without the "ftp://"? When I connect using it, I only use the domain name portion.

Jmers

Direkt200718-Nov-09 4:07

18-Nov-09 4:07

hello and thanks for the code !

Can anyone explain me how to upload folders ?

thanks

Gateone7512-Aug-09 2:32

12-Aug-09 2:32

Hello, can you post this useful dll for CF 3.5?

Thanks

Seishin#8-Apr-09 2:01

8-Apr-09 2:01

try<br />
{<br />
	main_sock.Connect(main_ipEndPoint);<br />
}<br />
catch (Exception ex)<br />
{<br />
	throw new Exception(ex.Message);<br />
}

life is study!!!

Phylum12322-Oct-09 5:25

22-Oct-09 5:25

I second that LOL. Smile | :)

Smile | :)

Exceoption when trying to upload [modified]

#realJSOP8-Jan-09 11:52

8-Jan-09 11:52

When I try to call Files.Upload(remoteFileName, localFileName), I get this:

startIndex cannot be larger than length of string. Parameter name: startIndex

What's up with that? I'm gonna try to finger it out, but I could use some rather immediate urgent help.

"Why don't you tie a kerosene-soaked rag around your ankles so the ants won't climb up and eat your candy ass..." - Dale Earnhardt, 1997
-----
"...the staggering layers of obscenity in your statement make it a work of art on so many levels." - Jason Jystad, 10/26/2001

modified on Friday, January 9, 2009 5:38 AM

How to connect to two FTP Servers

LearnNetnAll15-Dec-08 21:59

15-Dec-08 21:59

Hi,

I am using openFTP dll in windows service develope in vs 2008.
This service will get all files from local directory and upload it to two different FTP server.
I am opening first ftp server using

FTP() ObjFTP =null;

ObjFTP = new FTP();
ObjFTP.Connect(_sRemoteHost, _iPort, _sRemoteUser, _sRemotePassword);

and once upload done. I am closing this instance by using

try
{
if (ObjFTP != null)
{
ObjFTP.Disconnect();
}
}
catch (Exception ex)
{
ObjFTP = null;
}

But getting an error saying "Connection forcefully disconnected"
Then I am again opening the instance for second FTP server as my requirment to upload these file to second FTP server also.

ObjFTP = new FTP();
ObjFTP.Connect(_sRemoteHost, _iPort, _sRemoteUser, _sRemotePassword);

But I am not able to upload it to second FTP Server.

Is this possible to upload files to two different FTP servers in a process
Please help.............

A socket operation encountered a dead network

josephx2k715-Dec-08 12:41

15-Dec-08 12:41

Hi, I don't know why I'm getting this error after clicking the button..
This is my code below just to upload a file to my web server.

private void button1_Click(object sender, EventArgs e)
        {
            string sFileName = "c:\\hello.txt";
            OpenFTP.FTP f = new OpenFTP.FTP();
            f.Connect("", "", "");
            f.ChangeDirectory("");

            f.Files.Upload(Path.GetFileName(sFileName), Path.GetFileName(sFileName));
            StringBuilder sbTxtMessage = new StringBuilder();
            while (!f.Files.UploadComplete)
            {
                sbTxtMessage.Append("Uploading: TotalBytes: " + f.Files.TotalBytes.ToString() + ", :PercentComplete: " + f.Files.PercentComplete.ToString());
                txtMessage.Text = sbTxtMessage.ToString();
                //txtMessage.Text("Uploading: TotalBytes: " + f.Files.TotalBytes.ToString() + ", :PercentComplete: " + f.Files.PercentComplete.ToString());
            }
            sbTxtMessage.Append("Upload Complete: TotalBytes: " + f.Files.TotalBytes.ToString() + ", : PercentComplete: " + f.Files.PercentComplete.ToString());
            //txtMessage.Text("Upload Complete: TotalBytes: " + f.Files.TotalBytes.ToString() + ", : PercentComplete: " + f.Files.PercentComplete.ToString());

            f.Disconnect();
            f = null;
        }

Warning 1 'System.Net.Dns.GetHostByName(string)' is obsolete: 'GetHostByName is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202' E:\Practice\Csharp_mobile\FTPClient\FTPClient\ftp.cs 470 38 FTPClient

Warning 2 'System.Net.Dns.GetHostByName(string)' is obsolete: 'GetHostByName is obsoleted for this type, please use GetHostEntry instead. http://go.microsoft.com/fwlink/?linkid=14202' E:\Practice\Csharp_mobile\FTPClient\FTPClient\ftp.cs 599 40 FTPClient

Warning 3 Unreachable code detected E:\Practice\Csharp_mobile\FTPClient\FTPClient\ftp.cs 1186 10 FTPClient

Warning 4 Unreachable code detected E:\Practice\Csharp_mobile\FTPClient\FTPClient\ftp.cs 1256 10 FTPClient

I'm sure the ftp user information I input in the ftp.cs f.connect(...) is correct because I was able to make it work in FtpLib by J.P. Trosclair's version.

Any ideas why I received this error "A socket operation encountered a dead network" ?

I'm new to C# so please help. Thanks.

emilioarp12-Nov-08 7:30

12-Nov-08 7:30

I'm using it to download files. It is a good tool.
thanks

connection was forcibly closed by the remote host at System.Net.Sockets.

next100years11-Nov-08 0:55

11-Nov-08 0:55

the upload was success but return this error.
here the code:

string sFileName ="D:\\web_development\\file.xml";

OpenFTP.FTP f = new OpenFTP.FTP();
//f.Connect("xxx.xxx.xx.xx", "user", "password");

f.Files.Upload(Path.GetFileName(sFileName),sFileName);

A comfortable FTP class in .NET

Elmue27-Aug-08 12:22

27-Aug-08 12:22

Hello

If you search a comfortable and reusable FTP client,

-- which is running on .NET Framework 1.1 or higher,
-- which can automatically put together splitted files on the server,
-- which allows to download only a part of a file on the server,
-- which allows to resume any broken download,
-- which automatically starts a separate thread,
-- which can be aborted any time from your main thread,
-- which supports UTF8 encoded filenames,
-- which has a built-in download scheduler,
-- which has a built-in bandwidth control,
-- which has a built-in preview function for the download of movies,
-- which automatically reconnects the server after an error has occurred,
-- which displays download progress in percent and in bytes and the remaining time,
-- which writes a detailed logging for all operations it does,
-- which is based on Wininet.dll and has one workaround for each of the 4 known Wininet.dll bugs,
-- which is very well tested and bug-free,
-- which is written by a very experienced programmer and has a very clean and well documented sourcecode,

then have a look at this project:

ElmueSoft Partial FTP Downloader[^]

Elmü

General News Suggestion Question Bug Answer Joke Praise Rant Admin

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

Go to top