Ruby

Check if an FTP Listing Entry is a Directory

Demonstrates the Chilkat Ftp2.GetIsDirectory method, which returns whether a cached directory-listing entry is a directory. The only argument is a zero-based index. An invalid index returns false.

Background: Distinguishing directories from files is the first thing most listing code needs — to render a folder tree, to decide whether to recurse, or to apply different handling. This reads the type from the cached listing, so it is a local lookup rather than a server query. Reliability depends on the server's listing format conveying the type, which the common Unix and MLSD formats do.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ftp2.GetIsDirectory method, which returns whether a cached directory-listing
#  entry is a directory.  The only argument is a zero-based index into the current listing.

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
ftp.put_Password("myPassword")

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

success = ftp.ChangeRemoteDir("public_html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  GetDirCount retrieves the directory listing on the first call and returns the number of
#  entries.  A negative return indicates failure.
n = ftp.GetDirCount()
if (n < 0)
    print ftp.lastErrorText() + "\n";
    exit
end

for i in 0 .. n - 1
    name = ftp.getFilename(i)
    if (ftp.GetIsDirectory(i))
        print "[DIR]  " + name + "\n";
    else
        print "       " + name + "\n";
    end

end

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end