Click here to Skip to main content
11,413,961 members (72,593 online)
Click here to Skip to main content

FTP component written with fully managed code

, 7 May 2002
Rate this:
Please Sign up or sign in to vote.
A .NET FTP component

Recently, I needed to write a program which could automatically download files from an FTP server. Unfortunately the .NET Framework lacks good support for FTP services. Although a few companies have already written libraries which can be used directly, the price is really too high for poor men like me. As a result, I decided to write my own FTP library and here it is.

Disclaimer

This FTP component is an incomplete implementation of my design nor has it been fully tested. Please keep in mind it may contain bugs or even design flaws.

Connect to FTP server

FtpSession session = new FtpSession();
session.Server = "localhost";
session.Port   = 21; //not required if using the default ftp port 21
session.Connect("anonymous", "someone@somewhere.com");

Enum subdirectories and files

/*
* It is possible an incorrect list will be returned.
* In this case, you need to add your own regular expression to 
* interpret the list result (try to find it within ftpdirectory.cs)
*/
FtpDirectory root = session.RootDirectory;
foreach(FtpDirectory d in root.SubDirectories)
    //do something

    foreach(FtpFile f in root.Files)
        //do something

        /*
         * Only CurrentDirectory's item can be legally used.
         * Do not save down FtpDirectory and FtpFile for later use
         * unless you are sure they belongs to CurrentDirectory.
         * Here is some sample may cause problems
         */
        FtpDirectory d1 = session.CurrentDirectory.FindSubdirectory("somesubdir");
        FtpDirectory d2 = session.CurrentDirectory.FindSubdirectory("othersubdir");
        session.CurrentDirectory = d2;
        
        /*
         * Following 2 line will cause problem since CurrentDirectory 
         * is not d1's parent anymore
         */
        foreach(FtpDirectory d in d1) 
            //dosomthing

Change current directory

session.CurrentDirectory = somesubdirectory

Upload file

//Blocking call
session.CurrentDirectory.PutFile("somelocalfile");
    
//Async call using callback
session.CurrentDirectory.BeginPutFile("somelocalfile", +
    new FtpAsyncDelegate(yourcallback);
    
//Async call using event
session.EndPutFile += new FtpFileEventHandler(yourhandler);
session.CurrectDirectory.BeginPutFile("somelocalfile");
        
    //Manually upload the file
    FileInfo fi = new FileInfo(localfilefullpath);
    Stream r = File.OpenRead(fi.FullName);

    // actually will return a FtpOutputDataStream object
    Stream w = session.CurrentDirectory.CreateDataStream(fi.Name); 
    int readed;
    byte[] buff = new byte[4096];
    while((readed=r.Read(buff, 0, 4096) != 0)
	    w.Write(buff, 0, readed);
    /*
    * Must call FtpDataStream.Close().
    * This is because it will try to read the file transfer 
    * result from FTP server.
    */
    w.Close();
    s.Close();

Download file

//Blocking call
session.CurrentDirectory.GetFile("someremotefile");
    
//Async call using callback
session.CurrentDirectory.BeginGetFile("someremotefile", + 
    new FtpAsyncDelegate(yourcallback);
    
//Async call using event
session.EngGetFile += new FtpFileEventHandler(yourhandler);
session.CurrectDirectory.BeginGetFile("someremotefile");

//Manually download a file
Stream r = File.OpenWrite(localfilepath);

    FtpFile remoteFile = session.CurrentDirectory.FindFile(remotefilename);
    Stream w = remoteFile.GetOutputDataStream();
    int readed;
    byte[] buff = new byte[4096];
    while((readed=r.Read(buff, 0, 4096) != 0)
        w.Write(buff, 0, readed);
    /*
    * Must call FtpDataStream.Close().
    * This is because it will try to read the file transfer 
    * result from FTP server.
    */
    w.Close();
    s.Close();

Create a new file in ftp server

//method 1
session.CurrentDirectory.CreateFile(newfilename);
        
//method 2
Stream s = session.CurrentDirectory.CreateFileStream(newfilename);
// do something with s
s.Close();

Delete a file from ftp server

//method 1
session.CurrentDirectory.RemoveFile(remotefilename);
        
//method 2
IFtpItem item = session.CurrentDirectory.FindItem(remotefilename)
if(item != null)
    session.CurrentDirectory.RemoveItem(item);

Delete a subdirectory

//method 1
session.CurrentDirectory.RemoveSubdir(subdirectoryname);

//method 2
IFtpItem item = session.CurrentDirectory.FindItem(sub directoryname)
if(item != null)
    session.CurrentDirectory.RemoveItem(item);

Refresh the content of ftp directory

/*
* If you have saved down some some directory item(subdir or ftpfile).
* They will become invalid after you refresh the directory
*/
FtpFile f = session.CurrentDirectory.FindFile(somefile);
         
// you can not leagally use f anymore after the following line
session.CurrentDirectory.Refresh();

Rename a file or directory

IFtpItem item = session.FindItem(directoryorfile);
if(item != null)
    session.RenameSubitem(item, newname);

Known Limitations

  • No support for active mode
  • No support for proxy server

Updates

  • Removed FileCollection and DirectoryCollection
  • Added support for VB's for each statement
  • VB client can directly access FtpDirectory.Files and FtpDirectory.SubDirectories with for each statement now.

Please send me a email if you find any bugs. Please include at least a description of the bug you have found. It will be nice if a testing program or even a solution is included.

Have fun.

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

Alex Kwok
Web Developer
Hong Kong Hong Kong
No Biography provided

Comments and Discussions

 
QuestionBug Report: the method FtpDirectory.FindFile is always case-sensitive! Pin
Dr.Benj, 8-Apr-12 21:11
memberDr.Benj8-Apr-12 21:11 
QuestionBug Report: the FtpFile.Rename method is empty Pin
Dr.Benj, 8-Apr-12 21:08
memberDr.Benj8-Apr-12 21:08 
BugI had Fixed Some Bug of this Ftp Lib Pin
williechen, 16-Dec-11 0:59
memberwilliechen16-Dec-11 0:59 
QuestionNot all directories are listet - UnixListLineExpression needs any change Pin
Nasenbaaer, 16-Nov-11 1:13
memberNasenbaaer16-Nov-11 1:13 
AnswerSolution found Pin
Nasenbaaer, 16-Nov-11 22:56
memberNasenbaaer16-Nov-11 22:56 
GeneralDirectory timestamp regex... Pin
therearefartoomanybens, 13-Dec-09 15:50
membertherearefartoomanybens13-Dec-09 15:50 
GeneralError :Could not find file link.text Pin
massu, 23-Feb-09 3:25
membermassu23-Feb-09 3:25 
Generalfile transfer Pin
guptasahil1988, 17-Feb-09 23:19
memberguptasahil198817-Feb-09 23:19 
QuestionCannot List FTP Directories Pin
Gulfraz Khan, 15-Dec-08 23:23
memberGulfraz Khan15-Dec-08 23:23 
GeneralDirectory Tree download.. Pin
Member 4391311, 28-Sep-08 20:08
memberMember 439131128-Sep-08 20:08 
GeneralA comfortable FTP class in .NET Pin
Elmue, 27-Aug-08 13:16
memberElmue27-Aug-08 13:16 
QuestionHow can i connect to xxx.xxx.xxx.xxx\someFolder? Pin
ipop007zZZ, 7-Jul-08 0:10
memberipop007zZZ7-Jul-08 0:10 
AnswerRe: How can i connect to xxx.xxx.xxx.xxx\someFolder? Pin
therearefartoomanybens, 13-Dec-09 10:44
membertherearefartoomanybens13-Dec-09 10:44 
QuestionHow create directory Pin
alien250, 11-Sep-07 3:23
memberalien25011-Sep-07 3:23 
AnswerRe: How create directory Pin
alien250, 11-Sep-07 4:17
memberalien25011-Sep-07 4:17 
GeneralRe: How create directory Pin
Member 2812704, 21-Jun-11 3:11
memberMember 281270421-Jun-11 3:11 
GeneralParent Directory Pin
Lava04, 13-Jun-07 1:24
memberLava0413-Jun-07 1:24 
QuestionHow to move a file from one directory to another directory in ftp Pin
chandu.sanka, 28-Nov-06 3:17
memberchandu.sanka28-Nov-06 3:17 
Questionhow to trace the target location directory Pin
chandu.sanka, 28-Nov-06 3:13
memberchandu.sanka28-Nov-06 3:13 
Questionkcommon.dll Pin
_anagram_, 1-Nov-06 3:32
member_anagram_1-Nov-06 3:32 
AnswerRe: kcommon.dll Pin
_anagram_, 1-Nov-06 7:12
member_anagram_1-Nov-06 7:12 
OK I have found an answer in another post :

======================================
Re: Error trying to build
[Click for User Profile] Alex Kwok 0:18 2 Jun '02

Oh sorry, it's my mistake.
Change 1.0.*.* to 1.0.* will solve the error.

[Reply | Email | View Thread | Get Link] Rate this message: 1 2 3 4 5 (out of 5)
Report as Spam or Abuse
======================================

Good job !

Bye
QuestionRe: kcommon.dll Pin
alexander_z2, 12-Jul-11 15:38
memberalexander_z212-Jul-11 15:38 
QuestionHow to download from ftp server using VS2003 Pin
Raju Sharma, 17-Oct-06 21:21
memberRaju Sharma17-Oct-06 21:21 
Generalftp upload Pin
preets308, 16-Jul-06 21:15
memberpreets30816-Jul-06 21:15 
GeneralCoping file to different directory in remote server Pin
jasocl, 3-Jul-06 23:11
memberjasocl3-Jul-06 23:11 

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.150427.2 | Last Updated 8 May 2002
Article Copyright 2002 by Alex Kwok
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid