Lua

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 Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- 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.

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.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.password = "myPassword"

local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:change_remote_dir("public_html")
if not success then
    print(ftp.last_error_text)
    return
end

-- GetDirCount retrieves the directory listing on the first call and returns the number of
-- entries.  A negative return indicates failure.
local n = ftp:get_dir_count()
if n < 0 then
    print(ftp.last_error_text)
    return
end

for i = 0, n - 1 do
    local name = ftp:get_filename(i)
    if ftp:get_is_directory(i) then
        print("[DIR]  " .. name)
    else
        print("       " .. name)
    end
end

success = ftp:disconnect()
if not success then
    print(ftp.last_error_text)
    return
end