Get a Remote File's POSIX Permissions

See more SFTP Examples

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.

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.SFtp;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  port: Integer;
  password: string;
  bFollowLinks: Boolean;
  bIsHandle: Boolean;
  mode: Integer;

begin
  success := False;

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

  sftp := TSFtp.Create;

  //  Connect, authenticate, and initialize the SFTP subsystem.
  port := 22;
  success := sftp.Connect('sftp.example.com',port);
  if (success = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  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.
  password := 'mySshPassword';

  success := sftp.AuthenticatePw('mySshLogin',password);
  if (success = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  success := sftp.InitializeSftp();
  if (success = False) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

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

  mode := sftp.GetFilePermissions('subdir/script.sh',bFollowLinks,bIsHandle);
  if (mode < 0) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  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.
  WriteLn('POSIX mode (decimal): ' + mode);

  sftp.Disconnect();


  sftp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.