public function video_s3::admin_settings in Video 6.5

Same name and namespace in other branches

1. 6.4 plugins/video_s3/filesystem/video_s3.inc \video_s3::admin_settings()

Overrides video_plugin::admin_settings

File

plugins/video_s3/filesystem/video_s3.inc, line 58

Class file used to store videos in Amazon S3.

Class

video_s3

Code

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 &quot;fresh&quot; 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;
}