Xbase++

Get a Remote File's POSIX Permissions

Demonstrates the Chilkat SFtp.GetFilePermissions method, which returns a remote item's complete POSIX mode value. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: The returned mode is the full POSIX value, meaning it packs the file-type bits together with the owner/group/other permission bits — so a regular file with 0755 permissions comes back as decimal 33261 (octal 0100755), not 493. The permission bits people usually care about are the low nine. To set permissions rather than read them, use SetPermissions.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword
LOCAL nBFollowLinks
LOCAL nBIsHandle
LOCAL nMode

nSuccess := 0

//  Demonstrates the SFtp.GetFilePermissions method, which returns a remote item's complete POSIX
//  mode value.  The 1st argument is the remote path (or handle), the 2nd selects whether symbolic
//  links are followed, and the 3rd indicates whether the 1st argument is a handle.

oSftp := CreateObject("Chilkat.SFtp")

//  Connect, authenticate, and initialize the SFTP subsystem.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oSftp:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  The 2nd argument (bFollowLinks) selects whether a symbolic link is followed to its target.
//  The 3rd argument (bIsHandle) is 0 here because the 1st argument is a path, not an
//  open handle.
nBFollowLinks := 1
nBIsHandle := 0

nMode := oSftp:GetFilePermissions("subdir/script.sh", nBFollowLinks, nBIsHandle)
IF (nMode < 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  The value is the complete POSIX mode, which combines the file-type bits with the
//  owner/group/other permission bits (the low 9 bits).  For example, a mode of 33261 (octal
//  0100755) is a regular file with 0755 permissions.
? "POSIX mode (decimal): " + Str(nMode)

oSftp:Disconnect()

oSftp:destroy()