Author image šŸ—²Michael R. Davisāš
and 1 contributors

NAME

Net::SFTP::Foreign::Tempdir::Extract - Secure FTP client integrating Path::Class, Tempdir, and Archive Extraction

SYNOPSIS

  use Net::SFTP::Foreign::Tempdir::Extract;
  my $sftp = Net::SFTP::Foreign::Tempdir::Extract->new(
                                                       host   => $host,
                                                       user   => $user,
                                                       match  => qr/\.zip\Z/,
                                                       backup => './backup', #default is not to backup
                                                       delete => 1,          #default is not to delete
                                                      );
  my $file = $sftp->next;

DESCRIPTION

Secure FTP client which downloads files locally to a temp directory for operations and automatically cleans up all temp files after variables are out of scope.

This package assume SSH keys are correctly installed on local account and remote server.

USAGE

File Downloader

This is a simple file downloader implementation

  use Net::SFTP::Foreign::Tempdir::Extract;
  my $sftp = Net::SFTP::Foreign::Tempdir::Extract->new(host=>$remote_host, user=>$remote_user);
  my $file = $sftp->download($remote_folder, $remote_filename);

File Watcher

This is a simple file watcher implementation

  use Net::SFTP::Foreign::Tempdir::Extract;
  my $sftp = Net::SFTP::Foreign::Tempdir::Extract->new(
                                                       host=>'remote_server',
                                                       user=>'remote_account',
                                                       match=>qr/\.zip\Z/,
                                                       folder=>'/remote_folder'
                                                      );
  my $file = $sftp->next or exit;        #nothing to process so exit
  print "$file";                       #process file here

Subclass

This is a typical subclass implementation for a particular infrastructure

  {
    package My::SFTP;
    use base qw{Net::SFTP::Foreign::Tempdir::Extract};
    sub host   {'remote_server.domain.tld'};
    sub folder {'/remote_folder'};
    sub match  {qr/\.zip\Z/};
    sub backup {time};
    1;
  }

  my $sftp = My::SFTP->new;
  while (my $file = $sftp->next) {
    printf "File %s is a %s\n", "$file", ref($file);
  }

Which outputs something like this.

  File /tmp/hwY9jVeYo3/file1.zip is a Net::SFTP::Foreign::Tempdir::Extract::File
  File /tmp/ytWaYdPXuD/file2.zip is a Net::SFTP::Foreign::Tempdir::Extract::File
  File /tmp/JrsrkleBOy/file3.zip is a Net::SFTP::Foreign::Tempdir::Extract::File

CONSTRUCTOR

new

METHODS

download

Downloads the named file in the folder.

  my $file = $sftp->download('remote_file.zip');                   #isa Net::SFTP::Foreign::Tempdir::Extract::File
  my $file = $sftp->download('/remote_folder', 'remote_file.zip'); #  which isa Path::Class::File object with an extract method

next

Downloads the next file in list and saves it locally to a temporary folder. Returns a Path::Class::File object or undef if there are no more files.

  my $file = $sftp->next or exit;  #get file or exit

  while (my $file = $sftp->next) {
    print "$file";
  }

list

Returns list of filenames remaining to be processed that match the folder and regular expression

Note: List is shifted for each call to next method

upload

Uploads file to the folder and returns the count of uploaded files.

  $sftp->folder("/remote_folder"); #or set on construction
  $sftp->upload('local_file.zip');
  $sftp->upload('local_file1.zip', 'local_file2.zip');

The upload method is a simple wrapper around Net::SFTP::Foreign->mput that is parallel to download.

PROPERTIES

host

SFTP server host name.

  $sftp->host("");           #default

user

SFTP user name (defaults to current user)

  $sftp->user(undef);        #default

port

SFTP port number (defaults to undef not passed through)

  $sftp->port(undef);        #default

options

SSH options passed to the more property of Net::SFTP::Foreign as an array reference.

  $sftp->options(['-q']);    #default
  $sftp->options([]);        #no options
  $sftp->options(['-v']);    #verbose

folder

Folder on remote SFTP server.

  $sftp->folder("/home/user/download");

Note: Some SFTP servers put clients in a change rooted environment.

match

Regular Expression to match file names for the next iterator

  $sftp->match(qr/\Aremote_file\.zip\Z/);   #exact file
  $sftp->match(qr/\.zip\Z/);                #any zip file
  $sftp->match(undef);                      #reset to default - all files

backup

Sets or returns the backup folder property.

  $sftp->backup("");         #don't backup
  $sftp->backup("./folder"); #backup to folder

Note: If configured, backup overrides delete option.

delete

Sets or returns the delete boolean property.

  $sftp->delete(0);          #don't delete
  $sftp->delete(1);          #delete after downloaded

Note: Ineffective when backup option is configured.

OBJECT ACCESSORS

sftp

Returns a cached connected Net::SFTP::Foreign object

BUGS

Send email to author and log on RT.

SUPPORT

DavisNetworks.com supports all Perl applications including this package.

Testing

This packages relies on the SSH keys to be operational for the local account. To test your SSH keys from the command line type `sftp user@server`. If this command prompts the user for a password, then your SSH keys are not installed correctly. You cannot reliably test with `ssh user@server` as the remote administrator may have disabled the terminal service over SSH.

AUTHOR

  Michael R. Davis
  CPAN ID: MRDVT
  Satellite Tracking of People, LLC
  mdavis@stopllc.com
  http://www.stopllc.com/

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

Building Blocks

Path::Class::File, Net::SFTP::Foreign, File::Tempdir