SFTP Download Files Matching a Pattern

Demonstrates how to download the files in a remote SFTP directory matching a file pattern. The example opens a directory, iterates over the files, and downloads each file matching a file pattern, such as "*.xml".

Downloads for Windows/Linux and Install Instructions

require 'rubygems'
require 'chilkat'

#  Important: It is helpful to send the contents of the
#  sftp.LastErrorText property when requesting support.

sftp = Chilkat::CkSFtp.new()

#  Any string automatically begins a fully-functional 30-day trial.
success = sftp.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Set some timeouts, in milliseconds:
sftp.put_ConnectTimeoutMs(5000)
sftp.put_IdleTimeoutMs(10000)

#  Connect to the SSH server.
#  The standard SSH port = 22
#  The hostname may be a hostname or IP address.

hostname = "www.my-sftp-server.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Authenticate with the SSH server.  Chilkat SFTP supports
#  both password-based authenication as well as public-key
#  authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

#  Open a directory on the server...
#  Paths starting with a slash are "absolute", and are relative
#  to the root of the file system. Names starting with any other
#  character are relative to the user's default directory (home directory).
#  A path component of ".." refers to the parent directory,
#  and "." refers to the current directory.

dirPath = "abc123"
handle = sftp.openDir(dirPath)
if (handle == nil )
    print sftp.lastErrorText() + "\n"
    exit
end

#  Download the directory listing:

# dirListing is a CkSFtpDir
dirListing = sftp.ReadDir(handle)
if (dirListing == nil )
    print sftp.lastErrorText() + "\n"
    exit
end

#  Iterate over the files.

n = dirListing.get_NumFilesAndDirs()
if (n == 0)
    print "No entries found in this directory." + "\n";
else
    for i in 0 .. n - 1

        # fileObj is a CkSFtpFile
        fileObj = dirListing.GetFileObject(i)

        print fileObj.filename() + "\n";

        #  Does this filename match the desired pattern?
        #  Write code here to determine if it's a match or not.

        #  Assuming it's a match, you would download the file
        #  like this:

        remoteFilePath = dirPath + "/"
        remoteFilePath = remoteFilePath + fileObj.filename()
        localFilePath = fileObj.filename()
        success = sftp.DownloadFileByName(remoteFilePath,localFilePath)
        if (success != true)
            print sftp.lastErrorText() + "\n"
            exit
        end

    end
end

#  Close the directory
success = sftp.CloseHandle(handle)
if (success != true)
    print sftp.lastErrorText() + "\n"
    exit
end

print "Success." + "\n"