B4A Library Automated FTP Library

New Automated FTP Library


UPDATED 3-24-2014 - Version 1.06 changes the display scale and should look better on the larger display of a tablet. A sample project is now included which shows how to use this library. The sample code requires B4A 3.2+. You can open and view the code with older versions but it will not run because of the newer layout files.

UPDATED 1-24-2014 - Version 1.05 adds a new function for checking for files or folders. It also contains a few other small fixes.
The new command works for Files or Folders. If the last parameter is set to TRUE, it will look for folders, if the last parameter is set to FALSE it will look for files. Because the code runs in the background and is modeless you must have a callback sub in the calling module. Code samples below:

'Call the command like this:
FTP.FileOrFolderExist("plane.jpg" , "test/files", False)

'Callback sub in calling module:
Sub FTP_FileExist(Found As Boolean)
    If Found Then Log("True") Else Log("False")
End Sub

UPDATED 4-2-2013 - Version 1.02 Corrects an issue where PassiveMode was not working and also corrects an issue where UploadFileSet would not work from File.DirInternal.

Automates the process of sending and receiving files using FTP with Wildcards & File Masks. Version 1.02 is attached. Please post/report back any issues you find, etc.

This library has progress bars for Each File and overall progress. It handles wildcards and multi file types at the same time. Issue one command and transfer multiple files and multiple types! Change the colors, text size and words of all objects on the Progress Dialog to fit the look of your app. Also works in Stealth Mode!

REQUIRES: B4A 2.5 +
Copy the FTP_Auto.jar & FTP_Auto.xml files to the Extra Libraries folder.

FTP_Auto

• Close
  Completes the current Que with any files left to process and then
  closes the connection.
• CloseNow
  Closes the connection and all other files in the Que are
  ignored and the process is terminated.
• DeleteFile (DeletePathAndFile As String)
  Deletes a single file from the server.
  Example:
  
  DeleteFile("public/pictures/airplane1.jpg")
• DeleteFileSet (VerifyBeforeDelete As Boolean)
  Delete the lastest FileSet in memory from the server.
  If you used a Mask to download a set of files, this function
  will delelete all files in that last set.
  NOTICE: use with care.
• DownLoadFile (LocalPath As String, ServerPath As String, FileName As String, Delete_FromServer As Boolean)
  Downloads a selected file from the FTP server and optionally deletes the file after successful download
  Example:
  
  DownLoadFile("/mnt/sdcard/pictures/", "public/downloads/", "airplane.jpg", False)
• DownloadFileSet (LocalPath As String, Files_Path_And_Mask() As String, Delete_FromServer As Boolean)
  Retrieves a list of files from the server matching the Mask(s) passed to Files_Path_And_Mask() array.
  You should include the full server path in the Mask. It will then download these files to
  the Folder passed in LocalPath. Files_Path_And_Mask() can contain one entry or however many is needed.
  Example:
  
  DownloadFileSet(File.DirInternal, Array As String("SM*.txt", "public/pictures/pla*.jpg"), False)
• IsInitialized As Boolean
  Tests whether the object has been initialized.
• Initialize (Activity As Activity, CalledFrom As Object, FTP_Site As String, UserName As String, PassWord As String, PortNumber As Int, ShowMessages As Boolean, UsePassiveMode As Boolean) As String
  Initializes the object for use. If True is passed for ShowMessages, additional
  messages will be displayed throughout the process. Use the keywords "Activity"
  and "Me" For the first two parameters.
  Example:
  
  Initialize(Activity, Me, "ftp.yourdomain.com", "userName", "PassWord", "Port", True, False)
• LastDownloadStats ( As ) As String
  Shows a popup window with the detials of the latest Download(s).
• LastProcessSuccessful As Boolean
  Returns True if the last Upload or Download process was successful, otherwise returns False.
• LastUploadStats ( As ) As String
  Show a popup window with details of the latest Upload(s).
• MakeDir (DirectoryName As String)
  Makes a directory on the FTP server. Does nothing if the directory already exist.
  If you want to make a directory in the root of the server and then a directory under
  it, you must issue the command twice.
  Example:
  
  MakeDir("test")
  MakeDir("test/datafolder")
• RemoveDir (DirectoryName As String)
  Removes selected directory from the FTP server
• SetColors (HeadingColor As Int, TotalProgressColor As Int, FileTextColor As Int, PanelBackgroundColor As Int, FrameColor As Int)
  Used to set colors of each Item in the status dialog.
  NOTE: Passing 0 for any argument with leave that item unchanged
• SetCompletedDownloadDialog (ShowCompletedDialog As Boolean, DialogText As String)
  If ShowCompletedDialog=True, it will show a dialog after the download process is completed.
• SetCompletedUploadDialog (ShowCompletedDialog As Boolean, DialogText As String)
  If ShowCompletedDialog=True, it will show a dialog after the upload process is completed.
• SetProcessCompleteOn (ProcessCompleteOn As Boolean)
  Use this function to determine by code when the Upload or Download is finished.
  The calling Activity must contain a sub named FTP_ProcessComplete. If your calling
  Activity includes this sub and you set this function to True, then the sub will
  be called as soon as the process has completed. EXAMPLE:
  
  'Add this sub to calling Activity
  Sub FTP_ProcessComplete
  'Your code here...
  End Sub
• SetStealthOn (UseStealth As Boolean)
  If set to True, no progress box will be displayed during the file
  transfer. If False the progress dialog will show during the file
  transfers. The default is False.
• SetStickyOn (MakeSticky As Boolean)
  If set to True, the progress box will stay on the screen until
  the user taps the Done button, otherwise the progress box will close
  as soon as the transfer is complete. The default is False.
• SetText (HeaderDownLoadText As String, HeaderUploadText As String, TotalProgressText As String, FileProgressText As String, ButtonCancelText As String, ButtonDoneText As String)
  Used to set the Text of the Item's status display.
  NOTE: May be used for different language, etc.
• SetTextSize (HeaderTextSize As Int, TotalProgressTextSize As Int, FileProgressTextSize As Int, CancelAndDoneTextSize As Int)
  Used to set the Text size of the Item's Text in the status dialog.
  NOTE: Passing 0 for any argument with leave that item unchanged
• UpLoadFile (LocalPath As String, ServerPath As String, FileToSend As String)
  Uploads a single file passed in FileToSend
  
  Example: UpLoadFile("/mnt/sdcard/pictures", "uploads/pictures", "vacation.jpg")
• UploadFileSet (ServerPath As String, Files_Path_And_Mask() As String, DeleteFileFromLocalDevice As Boolean)
  Retrieves a list of files from the local device. The Files_Path_And_Mask() array should contain the full
  path to the local devices files. It will then upload these files to the server.
  Files_Path_And_Mask() array can contain one entry or however many is needed.
  Example:
  
  UploadFileSet("uploads/pictures/", Array As String("/mnt/pictures/VA*.jpg", "/mnt/sdcard/backups/contact*.dat"), False)
• WiFi_IsConnected As Boolean
  Check if Wifi is connected
  Returns True if connected otherwise returns False

Permissions:
◦android.permission.ACCESS_WIFI_STATE
◦android.permission.INTERNET

 

[margret]

OK, the button is not cut off but the text in the Cancel button is. You need to use this command to set the text size.

'Used to set the Text size of the Item's Text in the status dialog.
'NOTE: Passing 0 for any argument will leave that item unchanged
SetTextSize(HeaderTextSize As Int, TotalProgressTextSize As Int, FileProgressTextSize As Int, CancelAndDoneTextSize As Int)

This should correct this issue, please let me know how it works.

 

[dealsmonkey]

OK, the button is not cut off but the text in the Cancel button is. You need to use this command to set the text size.



This should correct this issue, please let me know how it works.

It has and thank you again

 

[luke2012]

First of all my compliments for the library!

There is a way to check if a FTP folder already exist ?

 

[margret]

First of all my compliments for the library!

There is a way to check if a FTP folder already exist ?

Not at the current time. I will look and see if this can be done.

 

[luke2012]

Not at the current time. I will look and see if this can be done.

Thank you margret!

 

[luke2012]

Not at the current time. I will look and see if this can be done.

I found I C# function that make this check :

public bool directoryExists2(string directory, string mainDirectory)
        {
            try
            {
                var list = this.GetFileList(mainDirectory);
                if (list.Contains(directory))
                    return true;
                else
                    return false;
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                return false;
            }
        }

Do you think that could be ported and integrated in the library ?

 

[Erel]

I'm not familiar with this library. However it should be similar to FTP from the Net library. You can call List on the parent folder and then see which files and folders are available in the parent folder.

 

[margret]

I am currently working on adding this feature to the library.

 

[margret]

@ luke2012

Please try this new version attached and see if it is working for you. I wrote the code but did not do a lot of testing. Please let me know if you find any issues. The new command works for Files or Folders. If the last parameter is set to TRUE, it will look for folders, if the last parameter is set to FALSE it will look for files. Because the code runs in the background and is modeless you must have a callback sub in the calling module. Code samples below:

'Call the command like this:
FTP.FileOrFolderExist("plane.jpg" , "test/files", False)

'Callback sub in calling module:
Sub FTP_FileExist(Found As Boolean)
     If Found Then Log("True") Else Log("False")
End Sub

If no issues are found I will update the first post with this version.

 

[Planet]

hello,
I tried the version 1.05 sendCMD the command:
the return of the command is

dim ret as string

ret=ftp.sendCMD(...,...) ?

thanks

 

[margret]

As it is now, this function does not return a value. If you can show me what you are wanting to do, I will look at adding the functions needed.

 

[Planet]

Hello,
I am attaching a NET documentation.
sorry for my english!
----------------------------------------------------------
SendCommand (Command As String, Parameters As String)
Sends an FTP command. The CommandCompleted event will be raised with the server reply.
Should only be used with commands that return the reply in the command channel (not the data channel).
It is possible that Success will be false and LastException will not be initialized.
Common commands:
MKD - Creates a new folder.
RMD - Deletes an empty folder.
Example:
FTP.SendCommand("MKD", "/somefolder/newfolder")

CommandCompleted (Command As String, Success As Boolean, ReplyCode As Int, ReplyString As String)

 

[margret]

Post #129 is now updated with a newer update of FTP_Auto library. It now includes a way to retrieve the values from the SendCMD function. See sub below:

'If you need a return value, you must include this sub below in
'the calling module.
'
Sub FTP_CmdCompleted(Vars() As String)
     Log(Vars(0)) 'Command
     Log(Vars(1)) 'Success
     Log(Vars(2)) 'ReplyCode
     Log(Vars(3)) 'ReplyString
End Sub

 

[Planet]

Hello Margret
thanks for the quick reply and your work.

 

[ernschd]

Hello Margret,

i use the last version 1.05 of your library for synchronizing files to a FTP-Server.
My problem is when there a no files to download, the upload part never starts.
With files on the FTP everything works fine.

Here's my code:

Sub Activity_Create(FirstTime As Boolean)
   FTP.Initialize(Activity, Me, "my-ftp-server", "user", "pass", 21, True, False)   
   downloadFtpFiles
End Sub

Sub downloadFtpFiles
   ftpDown = True   
   If FTP.WiFi_IsConnected Then
     FTP.SetProcessCompleteOn(True)         
     FTP.SetCompletedDownloadDialog(True,"Download erfolgreich")
     FTP.DownloadFileSet(File.DirRootExternal, Array As String("*.new", "*.new"), False)   
  Else
    Msgbox("Message......","Error")
  End If
End Sub

Sub uploadFtpFiles
   ftpDown = False   
   If FTP.WiFi_IsConnected Then
     FTP.SetStealthOn(True)
     FTP.UploadFileSet("/", Array As String(File.DirRootExternal & "/*.db", "*"), False)   
     End If
End Sub

Sub FTP_ProcessComplete
   Log("ftpDown is " & ftpDown)
   If ftpDown = True Then uploadFtpFiles
End Sub

Thank you.

 

[s2info]

Hello Margret,

Thank You for this lib. The functions deletefile and downloadfile (version 1.05) shows a message box when deletes a file. You could add a parameter (true or false) to show or not show this message box?

Thank You

 

[margret]

I tought I had added an option to show or not show dialogs. I will look into this. I will also look into the other request posted above.

 

[margret]

Hello Margret,

Thank You for this lib. The functions deletefile and downloadfile (version 1.05) shows a message box when deletes a file. You could add a parameter (true or false) to show or not show this message box?

Thank You

In the FTP.Initialize command, the next to last parameter is a Boolean for showing or not showing dialog messages. If it is set to False, it will not show the messages using DeleteFile or DownLoadFile.

 

[merlin2049er]

sweet, I'd love to include this with my app.

 

[merlin2049er]

How many people can concurrently connect to the same ftp server?