Perl

Get a Remote File's Owner

Demonstrates the Chilkat SFtp.GetFileOwner method, which returns a remote file's owner. The arguments are the remote path (or handle), whether symbolic links are followed, and whether the first argument is a handle.

Background: Ownership determines who may read, write, or change a file under Unix permission rules, so reading the owner is useful for auditing or for deciding whether an operation will be allowed. Note that a server may report the owner as a numeric UID rather than a name if it cannot resolve the account, and that ownership is a Unix concept — servers on other platforms may return an empty or synthetic value.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the SFtp.GetFileOwner method, which returns a remote file's owner.  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.

my $sftp = Chilkat2::SFtp->new;

# Connect, authenticate, and initialize the SFTP subsystem.
my $port = 22;
my $success = $sftp->Connect('sftp.example.com', $port);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    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.
my $password = 'mySshPassword';

$success = $sftp->AuthenticatePw('mySshLogin', $password);
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

$success = $sftp->InitializeSftp();
if (!$success) {
    print $sftp->LastErrorText, "\n";
    exit;
}

# 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.
my $bFollowLinks = 1;
my $bIsHandle = 0;

my $owner = $sftp->GetFileOwner('subdir/report.pdf', $bFollowLinks, $bIsHandle);
if (!$sftp->LastMethodSuccess) {
    print $sftp->LastErrorText, "\n";
    exit;
}

print 'Owner: ', $owner, "\n";

$sftp->Disconnect();