video_s3.inc in Video 6.5
Same filename and directory in other branches
Class file used to store videos in Amazon S3.
File
plugins/video_s3/filesystem/video_s3.incView source
<?php
/**
* @file
* Class file used to store videos in Amazon S3.
*/
// Register this file as a CTools plugin
$plugin = array();
class video_s3 implements video_filesystem {
protected $params = array();
protected $name = 'Amazon S3';
protected $value = 'video_s3';
/**
* @var video_amazon_s3
*/
protected $s3;
public function __construct() {
module_load_include('lib.inc', 'video_s3');
if (_video_s3_is_active_fs()) {
$this->s3 = new video_amazon_s3();
$this->s3
->connect();
}
}
public function load_file(stdClass $video) {
$s3 = $this->s3;
if ($s3 != NULL && ($s3file = $s3
->get($video->fid))) {
foreach ($video->files as $key => &$file) {
$filepath = $file->filepath;
// For old video's (pre-4.5), the filename property is actually a path
// and no locally converted files were saved to S3.
if (strpos('/', $file->filename) !== FALSE) {
$filepath = $file->filename;
}
$file->url = $s3
->getVideoUrl($filepath, $s3file->bucket);
}
}
}
public function get_name() {
return $this->name;
}
public function get_help() {
return t('Amazon Simple Storage Service (!s3) to store your video files. This frees up bandwidth from your site, providing a faster experience for your users. Simply enable this and enter your authentication details and your done!', array(
'!s3' => l(t('Amazon S3'), 'http://aws.amazon.com/s3/'),
));
}
public function get_value() {
return $this->value;
}
public function admin_settings(&$form_state) {
$form = array();
$form['amazon_s3_ssl'] = array(
'#type' => 'checkbox',
'#title' => t('Use HTTPS file links'),
'#default_value' => variable_get('amazon_s3_ssl', FALSE),
'#description' => t('If you would like to use SSL when transfering your files enable this option.'),
);
$form['amazon_s3_delete_local'] = array(
'#type' => 'checkbox',
'#title' => t('Delete local file after uploading to S3'),
'#default_value' => variable_get('amazon_s3_delete_local', FALSE),
'#description' => t('Replaces the original file on the local file system with an empty file to reduce disk space usage. The file is not removed as Drupal and FileField expect a file to be present.'),
);
$form['amazon_s3_private'] = array(
'#type' => 'checkbox',
'#title' => t('Enable private file storage'),
'#default_value' => variable_get('amazon_s3_private', FALSE),
'#description' => t('If you would like to use private file storage for your files enable this option. Videos are displayed using temporary URLs that expire after an amount of time that is configurable below.'),
);
$form['amazon_s3_lifetime'] = array(
'#type' => 'textfield',
'#title' => t('Private URL lifetime'),
'#default_value' => variable_get('amazon_s3_lifetime', 1800),
'#size' => 5,
'#description' => t('The number of seconds a URL to a private file is valid.'),
);
$form['amazon_s3_access_key'] = array(
'#type' => 'textfield',
'#title' => t('Access key ID'),
'#default_value' => variable_get('amazon_s3_access_key', ''),
'#size' => 50,
'#element_validate' => array(
'_video_s3_fsadmin_validate',
),
);
$form['amazon_s3_secret_access_key'] = array(
'#type' => 'password',
'#title' => t('Secret access key'),
'#default_value' => variable_get('amazon_s3_secret_access_key', ''),
'#description' => t('Once saved, you do not need to re-enter your secret key. If you need to update your key, then fill this out to update it.'),
'#size' => 50,
'#element_validate' => array(
'_video_s3_fsadmin_validate_secret',
'_video_s3_fsadmin_validate',
),
);
// @todo Maybe move this to the admin settings page instead of global?
$form['amazon_s3_bucket'] = array(
'#type' => 'textfield',
'#title' => t('Bucket'),
'#description' => t('Enter the bucket you wish to store your videos in. If the bucket doesn\'t exist the system will attempt to create it.'),
'#default_value' => variable_get('amazon_s3_bucket', ''),
'#size' => 50,
'#element_validate' => array(
'_video_s3_fsadmin_validate',
),
);
// cloud front
$form['amazon_s3_cf_domain'] = array(
'#type' => 'textfield',
'#title' => t('CloudFront domain name'),
'#description' => t('If you are using Amazon CloudFront with this bucket, enter the CloudFront domain name. This will probably be something like <em>X.cloudfront.net</em> where <em>X</em> is a series of random-looking numbers and letters. Do not include <em>http://</em> at the beginning.'),
'#default_value' => variable_get('amazon_s3_cf_domain', ''),
'#size' => 50,
);
// Cloud Front and private files do not work together
if (variable_get('amazon_s3_private', FALSE)) {
$form['amazon_s3_cf_domain']['#description'] = t('Amazon CloudFront and S3 private file storage cannot be used together. Disable private files to enable this setting.');
$form['amazon_s3_cf_domain']['#disabled'] = TRUE;
}
$form['headers_fset'] = array(
'#type' => 'fieldset',
'#title' => t('Headers'),
);
$form['headers_fset']['amazon_s3_expires_offset'] = array(
'#type' => 'select',
'#title' => t('Expires header'),
'#options' => array(
'none' => t('(none)'),
'0' => t('File is always expired (Unix epoch, 1 Jan 1970, 00:00:00 UTC)'),
),
'#default_value' => variable_get('amazon_s3_expires_offset', 604800),
'#description' => t('Amazon S3 can be told to send an Expires header (<a href="http://developer.yahoo.com/performance/rules.html#expires">learn more</a>) with served files. This will induce most browsers to cache the file longer, reducing the frequency that it is re-downloaded from the server. This can save on bandwidth charges and provide a faster experience for visitors. However, files which will be frequently updated with the same filename should use a low Expires offset, or else visitors won\'t see "fresh" data. Also, Expires headers will be updated for currently-uploaded files on cron runs, so the interval set here should be greater than or equal to your server\'s cron run interval for best results.'),
);
$form['headers_fset']['amazon_s3_cache_control_max_age'] = array(
'#type' => 'select',
'#title' => t('max-age parameter of Cache-Control header'),
'#options' => array(
'none' => t('(none)'),
),
'#default_value' => variable_get('amazon_s3_cache_control_max_age', 'none'),
'#description' => t('When using Amazon CloudFront, the max-age parameter of the Cache-Control header (<a href="http://condor.depaul.edu/~dmumaugh/readings/handouts/SE435/HTTP/node24.html">learn more</a>) tells CloudFront\'s edge servers how frequently they should check the Amazon S3 bucket to see if the files they have cached have been changed or deleted. If you need to ensure that files on edge servers are updated quickly after a video is changed or deleted, set this to a low value; if videos are rarely changed or deleted, or visitors seeing stale data is not a problem, set this to a high value for speed and/or to save on the cost of transferring files from your S3 server to the edge servers. If no value is selected, Amazon\'s default of one day will be used.'),
);
foreach (array(
300,
// 5 min
600,
// 10 min
1800,
// 30 min
3600,
// 1 hr
14400,
// 4 hr
28800,
// 8 hr
43200,
// 12 hr
86400,
// 1 day
172800,
// 2 day
604800,
// 1 wk
1209600,
// 2 wk
2419200,
// 4 wk
4838400,
// 8 wk
14515200,
// 24 wk
31536000,
// 1 yr (365 day)
63072000,
// 2 yr
157680000,
// 5 yr
315360000,
) as $time) {
$interval = format_interval($time, 1);
$form['headers_fset']['amazon_s3_expires_offset']['#options'][$time] = $interval;
if ($time >= 3600) {
// The minimum Cache-Control; max-age value Amazon will accept is one hour.
$form['headers_fset']['amazon_s3_cache_control_max_age']['#options'][$time] = $interval;
}
}
if (variable_get('amazon_s3_access_key', FALSE) && _video_s3_is_active_fs()) {
$buckets = $this->s3->s3
->get_bucket_list();
// Setup our header.
$header = array(
t('Bucket name'),
t('Information'),
);
$rows = array();
foreach ($buckets as $bucket) {
$info = '';
if (!$this
->isValidBucketName($bucket)) {
$info = t('Unsupported bucket name');
}
elseif ($bucket == variable_get('amazon_s3_bucket', '')) {
$info = '<strong>' . t('Active bucket') . '</strong>';
}
$rows[] = array(
$bucket,
$info,
);
}
$form['amazon_info'] = array(
'#type' => 'fieldset',
'#title' => t('Amazon S3 information'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
$form['amazon_info']['buckets'] = array(
'#type' => 'markup',
'#value' => theme('table', $header, $rows),
);
}
return $form;
}
public function admin_settings_validate($form, &$form_state) {
// Check for CURL
if (!extension_loaded('curl') && !@dl(PHP_SHLIB_SUFFIX == 'so' ? 'curl.so' : 'php_curl.dll')) {
form_set_error('amazon_s3', t('The CURL extension is not loaded.'));
return;
}
$bucket = $form_state['values']['amazon_s3_bucket'];
// S3 buckets must contain only lower case alphanumeric characters, dots and dashes.
if (!$this
->isValidBucketName($bucket)) {
form_set_error('amazon_s3_bucket', t('S3 bucket names must contain only lower case alphanumeric characters, dots and dashes.'));
}
$ssl = isset($form_state['values']['amazon_s3_ssl']) && $form_state['values']['amazon_s3_ssl'];
$access_key = $form_state['values']['amazon_s3_access_key'];
$secret_key = $form_state['values']['amazon_s3_secret_access_key'];
if (empty($access_key) || empty($secret_key)) {
// There is no point in continuing if there is no access info
return;
}
// Lets verify our credentials and verify our bucket exists, if not attempt to create it.
$s3 = new video_amazon_s3();
$s3
->connect($access_key, $secret_key, $ssl);
$buckets = $s3->s3
->get_bucket_list();
if (!in_array($bucket, $buckets)) {
// Create a bucket with public read access
// @todo: region selection
$response = $s3->s3
->create_bucket($bucket, AmazonS3::REGION_US_E1, AmazonS3::ACL_PUBLIC);
if ($response
->isOK()) {
drupal_set_message(t('Successfully created the bucket %bucket.', array(
'%bucket' => $bucket,
)));
}
else {
form_set_error('amazon_s3_bucket', t('Could not verify or create the bucket %bucket.', array(
'%bucket' => $bucket,
)));
$bucket = NULL;
}
}
// Always check the access rights, in case the bucket was created
// outside of Drupal or before the Zencoder module was active.
if ($bucket != NULL && module_exists('video_zencoder')) {
if ($s3
->setZencoderAccessPolicy($bucket)) {
drupal_set_message(t('Successfully granted write access for bucket %bucket to Zencoder.', array(
'%bucket' => $bucket,
)));
}
}
}
public function onpreconvert(stdClass $video) {
if ($this->s3
->verify($video->fid)) {
// The file is already inserted
return FALSE;
}
db_query('INSERT INTO {video_s3} (fid, status) VALUES (%d, %d)', $video->fid, VIDEO_S3_ACTIVE);
// Push the original file, but leave it on the local disk for the local transcoder
if ($this->s3
->pushFile($video, TRUE) != NULL) {
db_query('UPDATE {video_s3} SET bucket="%s", filename="%s", filepath="%s", filemime="%s", filesize="%s", status=%d, completed=%d WHERE fid=%d', $video->bucket, $video->filename, $video->filepath, $video->filemime, $video->filesize, VIDEO_S3_COMPLETE, time(), $video->fid);
return TRUE;
}
db_query('UPDATE {video_s3} SET status = %d WHERE fid=%d', VIDEO_S3_FAILED, $video->fid);
return FALSE;
}
public function onpostconvert(stdClass $video) {
$success = TRUE;
// Push converted files, if any
if (!empty($video->data)) {
foreach ($video->data as $file) {
if (isset($file->filepath) && !$this->s3
->pushFile($file)) {
$success = FALSE;
break;
}
}
}
// Replace the local original file after the local command has been able to access it
if (variable_get('amazon_s3_delete_local', FALSE)) {
$s3url = 'http://' . $video->bucket . '.s3.amazonaws.com/' . drupal_urlencode($video->filepath);
$this->s3
->replaceLocalFile($video->filepath, $s3url);
}
return $success;
}
public function delete_video(stdClass $video) {
// Find the bucket
if (!($s3info = $this->s3
->verify($video->fid))) {
return;
}
// Remove the original file
$this->s3->s3
->delete_object($s3info->bucket, $video->filepath);
// Remove converted files
if (!empty($video->data)) {
foreach ($video->data as $subvideo) {
$filepath = NULL;
if (isset($subvideo->url)) {
// This video is converted by Zencoder
$parts = parse_url($subvideo->url);
$filepath = ltrim($parts['path'], '/');
}
else {
// This video is locally converted
$filepath = $subvideo->filepath;
}
// Delete the remote copy
$this->s3->s3
->delete_object($s3info->bucket, $filepath);
// Delete the local copy
file_delete($filepath);
}
}
// Remove thumbnails on S3
$thumb_folder = video_thumb_path($video, FALSE) . '/';
$thumbfilenames = $this->s3->s3
->get_object_list($s3info->bucket, array(
'prefix' => $thumb_folder,
));
if (!empty($thumbfilenames)) {
$objects = array();
foreach ($thumbfilenames as $thumb) {
$objects[] = array(
'key' => $thumb,
);
}
$this->s3->s3
->delete_objects($s3info->bucket, array(
'objects' => $objects,
));
}
// Remove thumbnails locally
if (is_dir($thumb_folder)) {
rmdirr($thumb_folder);
// Delete any entries in the files table that may refer to the above path.
db_query('DELETE FROM {files} WHERE filepath LIKE "%b%%"', strtr(db_escape_string($thumb_folder), array(
'%' => '\\%',
'_' => '\\_',
)));
}
db_query('DELETE FROM {video_s3} WHERE fid = %d', $video->fid);
}
private function isValidBucketName($name) {
return preg_match('/^[a-z0-9.-]+$/', $name);
}
}
/**
* Replace the empty form value with the variable value.
*
* Used for the access secret.
*
* @param $element
* Element to validate
* @param $form_state
* Form state
*/
function _video_s3_fsadmin_validate_secret($element, &$form_state) {
$key = end($element['#parents']);
$val = $form_state['values'][$key];
$existing = variable_get($key, NULL);
if ($val === '' && $existing !== NULL) {
$form_state['values'][$key] = $existing;
}
}
/**
* Handle required fields that are only required when S3 is the file system.
*
* @param $element
* Element to validate
* @param $form_state
* Form state
*/
function _video_s3_fsadmin_validate($element, $form_state) {
if ($form_state['values']['vid_filesystem'] != 'video_s3') {
return;
}
$key = end($element['#parents']);
$val = $form_state['values'][$key];
if (empty($val)) {
form_error($element, t('!name field is required.', array(
'!name' => $element['#title'],
)));
}
}Functions
Name |
Description |
|---|---|
| _video_s3_fsadmin_validate | Handle required fields that are only required when S3 is the file system. |
| _video_s3_fsadmin_validate_secret | Replace the empty form value with the variable value. |