Tcl

List a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.ReadDirListing method, which reads all remaining entries from an open directory handle into an SFtpDir object. The first argument is the handle returned by OpenDir and the second is the SFtpDir that receives the listing. The example iterates the entries with NumFilesAndDirs and FileAt, reading each SFtpFile's Filename, IsDirectory, Size64, and LastModifiedTimeStr.

Background: Listing a directory is a three-part operation: OpenDir gets a handle, ReadDirListing pulls every entry into an SFtpDir in one call, and the handle is then closed. Each entry is an SFtpFile carrying that item's name, type, size, timestamps, owner, and permission flags — a single stat covering what several separate GetFile* calls would return. The entries come back in the server's own order rather than sorted; use SFtpDir.Sort if you need a particular ordering. Note that a listing normally includes the . and .. entries, which most code skips.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the SFtp.ReadDirListing method, which reads all remaining entries from an open
#  directory handle into an SFtpDir object.  The 1st argument is the handle (from OpenDir) and
#  the 2nd is the SFtpDir that receives the listing.

set sftp [new_CkSFtp]

#  Connect, authenticate, and initialize the SFTP subsystem.
set port 22
set success [CkSFtp_Connect $sftp "sftp.example.com" $port]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  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.
set password "mySshPassword"

set success [CkSFtp_AuthenticatePw $sftp "mySshLogin" $password]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

set success [CkSFtp_InitializeSftp $sftp]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  Open the remote directory to be listed.  OpenDir returns a handle string.
set handle [CkSFtp_openDir $sftp "subdir"]
if {[CkSFtp_get_LastMethodSuccess $sftp] == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

#  Read all directory entries into an SFtpDir object.
set dirListing [new_CkSFtpDir]

set success [CkSFtp_ReadDirListing $sftp $handle $dirListing]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSFtpDir $dirListing
    exit
}

#  The listing has been read, so the directory handle can be closed now.
set success [CkSFtp_CloseHandle $sftp $handle]
if {$success == 0} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    delete_CkSFtpDir $dirListing
    exit
}

#  Iterate the entries.  Entries are in server order (Chilkat does not sort the listing).
set n [CkSFtpDir_get_NumFilesAndDirs $dirListing]
puts "Directory contains $n entries:"

set fileObj [new_CkSFtpFile]

for {set i 0} {$i <= [expr $n - 1]} {incr i} {
    #  FileAt fills the SFtpFile object with the entry at the given index.
    set success [CkSFtpDir_FileAt $dirListing $i $fileObj]
    if {$success == 0} then {
        puts [CkSFtpDir_lastErrorText $dirListing]
        delete_CkSFtp $sftp
        delete_CkSFtpDir $dirListing
        delete_CkSFtpFile $fileObj
        exit
    }

    if {CkSFtpFile_get_IsDirectory $fileObj} then {
        puts "{  [DIR]  }[CkSFtpFile_filename $fileObj]"
    }     else {
        #  Size64 is a 64-bit size; LastModifiedTimeStr is the modification time as text.
        puts "  [CkSFtpFile_filename $fileObj]  ([CkSFtpFile_get_Size64 $fileObj] bytes, modified [CkSFtpFile_lastModifiedTimeStr $fileObj])"
    }

}

CkSFtp_Disconnect $sftp

delete_CkSFtp $sftp
delete_CkSFtpDir $dirListing
delete_CkSFtpFile $fileObj