AlexSkrypnyk / drupal_file_downloader

Drupal module to download files from different providers

drupal_file_downloader

Drupal module to download files from remote locations

Why?

When using hook_update_N() to deliver updates, it is sometimes necessary to fetch files from remote location and store them. This helper module allows to have different download providers as a source of such files.

Supported providers

• FTP - COMPLETED
• Amazon S3 - COMPLETED

Example FTP

// Set FTP provider configuration.
variable_set('drupal_file_downloader_ftp_host', 'your_ftp_hostname');
variable_set('drupal_file_downloader_ftp_root_path', 'your_common_storage_dir');
variable_set('drupal_file_downloader_ftp_username', 'your_username');
variable_set('drupal_file_downloader_ftp_password', 'your_password');

// This will download all files from all subdirectories of directory 
// `remote_dir` on the FTP server.
// So, if the path for a file was `/home/user/ftp_dir/dump/media_images/1.jpg`,
// `dump` is a `root_path`, `media_images` is a directory to pass to download()
// method and `1.jpg` is a filename.
// The return will have all downloaded files as array keyed by 'fid' for
// managed files or by real file paths for non-managed files.
$downloaded_files = Drupal\drupal_file_downloader\Downloader::download('FTP', 'remote_dir');

// Perform some operations with files.

// Cleanup downloaded files.
Drupal\drupal_file_downloader\Downloader::cleanup(downloaded_files);

Example S3

// This will download all files from all subdirectories of remote Amazon S3
// bucket directory 'remote_dir' into local directory 'public://remote_dir'
// as non-managed files and will print file download result.
// The return will have all downloaded files as array keyed by 'fid' for
// managed files or by real file paths for non-managed files.
$downloaded_files = Drupal\drupal_file_downloader\Downloader::download('S3', 'remote_dir', ['provider_config' => ['bucket' => 'mybucket.example.com']]);

// Perform some operations with files.

// Cleanup downloaded files.
Drupal\drupal_file_downloader\Downloader::cleanup(downloaded_files);

Installation

Depending on your provider, you may need to install additional modules.

FTP Provider

1. Install xautoload module.
2. Install 3rd party library php-ftp-client library into your libraries directory, so that FileClient.php file would be located at sites/all/libraries/php-ftp-client/src/FtpClient/FtpClient.php.
3. Set default FTP configuration:

$conf['drupal_file_downloader_ftp_host'] = 'your_ftp_hostname';
$conf['drupal_file_downloader_ftp_username'] = 'your_username';
$conf['drupal_file_downloader_ftp_password'] = 'your_password';
$conf['drupal_file_downloader_ftp_root_path'] = 'your_common_storage_dir';

S3 Provider

1. Install xautoload module.

2. Install s3fs drupal module.

3. Install AWS SDK PHP library - follow instructions on s3fs module's page.

4. Set AWS access and secret key variables (add to your settings.php):

   • $conf['awssdk2_access_key'] = 'your_access_key_here';
   • $conf['awssdk2_secret_key'] = 'your_secret_key_here';

5. Set AWS region variable (add to your settings.php):

   • $conf['s3fs_region'] = 'your_region';