View source
<?php
namespace Drupal\s3fs\Form;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Symfony\Component\HttpFoundation\Request;
class SettingsForm extends ConfigFormBase {
public function getFormId() {
return 's3fs_admin_settings_form';
}
protected function getEditableConfigNames() {
return [
's3fs.settings',
];
}
public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL) {
$config = $this
->config('s3fs.settings');
$region_map = [
'' => 'Default',
'us-east-1' => 'US East - Northern Virginia (us-east-1)',
'us-east-2' => 'US East - Ohio (us-east-2)',
'us-west-1' => 'US West - Northern California (us-west-1)',
'us-west-2' => 'US West - Oregon (us-west-2)',
'us-gov-west-1' => 'USA GovCloud Standard (us-gov-west-1)',
'eu-west-1' => 'EU - Ireland (eu-west-1)',
'eu-west-2' => 'EU - London (eu-west-2)',
'eu-central-1' => 'EU - Frankfurt (eu-central-1)',
'ap-south-1' => 'Asia Pacific - Mumbai',
'ap-southeast-1' => 'Asia Pacific - Singapore (ap-southeast-1)',
'ap-southeast-2' => 'Asia Pacific - Sydney (ap-southeast-2)',
'ap-northeast-1' => 'Asia Pacific - Tokyo (ap-northeast-1)',
'ap-northeast-2' => 'Asia Pacific - Seoul (ap-northeast-2)',
'sa-east-1' => 'South America - Sao Paulo (sa-east-1)',
'cn-north-1' => 'China - Beijing (cn-north-1)',
];
$form['credentials'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Amazon Web Services Credentials'),
'#description' => $this
->t("To configure your Amazon Web Services credentials, enter the values in the appropriate fields below.\n You may instead set \$config['s3fs.settings']['access_key'] and \$config['s3fs.settings']['secret_key'] in your site's settings.php file.\n Values set in settings.php will override the values in these fields."),
'#collapsible' => TRUE,
'#collapsed' => $config
->get('use_instance_profile'),
];
$form['credentials']['access_key'] = [
'#type' => 'textfield',
'#title' => $this
->t('Amazon Web Services Access Key'),
'#default_value' => $config
->get('access_key'),
];
$form['credentials']['secret_key'] = [
'#type' => 'textfield',
'#title' => $this
->t('Amazon Web Services Secret Key'),
'#default_value' => $config
->get('secret_key'),
];
$form['credentials']['use_instance_profile'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use EC2 Instance Profile Credentials'),
'#default_value' => $config
->get('use_instance_profile'),
'#description' => $this
->t('If your Drupal site is running on an Amazon EC2 server, you may use the Instance Profile Credentials from that server
rather than setting your AWS credentials directly.'),
];
$form['credentials']['default_cache_config'] = [
'#type' => 'textfield',
'#title' => $this
->t('Default Cache Location'),
'#default_value' => $config
->get('default_cache_config'),
'#description' => $this
->t('The default cache location for your EC2 Instance Profile Credentials.'),
'#states' => [
'visible' => [
':input[id=edit-use-instance-profile]' => [
'checked' => TRUE,
],
],
],
];
$form['bucket'] = [
'#type' => 'textfield',
'#title' => $this
->t('S3 Bucket Name'),
'#default_value' => $config
->get('bucket'),
'#required' => TRUE,
];
$form['region'] = [
'#type' => 'select',
'#options' => $region_map,
'#title' => $this
->t('S3 Region'),
'#default_value' => $config
->get('region'),
'#description' => $this
->t('The region in which your bucket resides. Be careful to specify this accurately,
as you are likely to see strange or broken behavior if the region is set wrong.<br>
Use of the USA GovCloud region requires @SPECIAL_PERMISSION.<br>
Use of the China - Beijing region requires a @CHINESE_AWS_ACCT.', [
'@CHINESE_AWS_ACCT' => Link::fromTextAndUrl($this
->t('亚马逊 AWS account'), Url::fromUri('http://www.amazonaws.cn'))
->toString(),
'@SPECIAL_PERMISSION' => Link::fromTextAndUrl($this
->t('special permission'), Url::fromUri('http://aws.amazon.com/govcloud-us/'))
->toString(),
]),
];
$form['advanced'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Advanced Configuration Options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
];
$advanced =& $form['advanced'];
$advanced['use_cname'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable CNAME'),
'#default_value' => $config
->get('use_cname'),
'#description' => $this
->t('Serve files from a custom domain by using an appropriately named bucket, e.g. "mybucket.mydomain.com".'),
];
$advanced['cname_settings_fieldset'] = [
'#type' => 'fieldset',
'#title' => $this
->t('CNAME Settings'),
'#states' => [
'visible' => [
':input[id=edit-use-cname]' => [
'checked' => TRUE,
],
],
],
];
$advanced['use_customhost'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use a Custom Host'),
'#default_value' => $config
->get('use_customhost'),
'#description' => $this
->t('Connect to an S3-compatible storage service other than Amazon.'),
];
$advanced['customhost_settings_fieldset'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Custom Host Settings'),
'#states' => [
'visible' => [
':input[id=edit-use-customhost]' => [
'checked' => TRUE,
],
],
],
];
$advanced['customhost_settings_fieldset']['hostname'] = [
'#type' => 'textfield',
'#title' => $this
->t('Hostname'),
'#default_value' => $config
->get('hostname'),
'#description' => $this
->t('Custom service hostname, e.g. "objects.dreamhost.com".'),
'#states' => [
'visible' => [
':input[id=edit-s3fs-use-customhost]' => [
'checked' => TRUE,
],
],
],
];
$advanced['cname_settings_fieldset']['domain'] = [
'#type' => 'textfield',
'#title' => $this
->t('CDN Domain Name'),
'#default_value' => $config
->get('domain'),
'#description' => $this
->t('If serving files from CloudFront, the bucket name can differ from the domain name.'),
];
$advanced['cache_control_header'] = [
'#type' => 'textfield',
'#title' => $this
->t('S3 Object Cache-Control Header'),
'#default_value' => $config
->get('cache_control_header'),
'#description' => $this
->t('The cache control header to set on all S3 objects for CDNs and browsers, e.g.
"public, max-age=300".'),
];
$advanced['encryption'] = [
'#type' => 'select',
'#options' => [
'' => 'None',
'AES256' => 'AES256',
'aws:kms' => 'aws:kms',
],
'#title' => $this
->t('Server-Side Encryption'),
'#default_value' => $config
->get('encryption'),
'#description' => $this
->t('If your bucket requires @ENCRYPTION, you can specify the encryption algorithm here', [
'@ENCRYPTION' => Link::fromTextAndUrl($this
->t('server-side encryption'), Url::fromUri('http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html'))
->toString(),
]),
];
$advanced['use_https'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Always serve files from S3 via HTTPS'),
'#default_value' => $config
->get('use_https'),
'#description' => $this
->t('Forces S3 File System to always generate HTTPS URLs for files in your bucket,
e.g. "https://mybucket.s3.amazonaws.com/smiley.jpg".<br>
Without this setting enabled, URLs for your files will use the same scheme as the page they are served from.'),
];
$advanced['ignore_cache'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Ignore the file metadata cache'),
'#default_value' => $config
->get('ignore_cache'),
'#description' => $this
->t("If you need to debug a problem with S3, you may want to temporarily ignore the file metadata cache.\n This will make all file system reads hit S3 instead of the cache.<br>\n <b>This causes s3fs to work extremely slowly, and should never be enabled on a production site.</b>"),
];
$advanced['use_s3_for_public'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use S3 for public:// files'),
'#default_value' => Settings::get('s3fs.use_s3_for_public'),
'#disabled' => TRUE,
'#description' => $this
->t('Enable this option to store all files which would be uploaded to or created in the web server\'s local file system
within your S3 bucket instead. To replace public:// stream wrapper with s3fs stream, include the following in settings.php:<br>
<em>$settings[\'s3fs.use_s3_for_public\'] = TRUE;</em><br><br>
<b>PLEASE NOTE:</b> If you intend to use Drupal\'s performance options which aggregate your CSS or Javascript
files, or will be using any other system that writes CSS or Javascript files into your site\'s public:// file system,
you must perform some additional configuration on your webserver to make those files work correctly when stored in S3.
Please see the section titled "Aggregated CSS and JS in S3" in the README for details.'),
];
$advanced['no_rewrite_cssjs'] = [
'#type' => 'checkbox',
'#title' => $this
->t("Don't rewrite CSS/JS file paths"),
'#default_value' => $config
->get('no_rewrite_cssjs'),
'#description' => $this
->t('If this box is checked, s3fs will NOT rewrite the CSS/JS file paths to "/s3fs-(css|js)/...". Instead, they will
be placed on the page with their regular CDN name. Only enable this option if you <b>know</b> you need it!'),
'#states' => [
'visible' => [
':input[id=edit-use-s3-for-public]' => [
'checked' => TRUE,
],
],
],
];
$advanced['use_s3_for_private'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use S3 for private:// files'),
'#default_value' => Settings::get('s3fs.use_s3_for_private'),
'#disabled' => TRUE,
'#description' => $this
->t('Enable this option to store all files which would be uploaded to or created in the private://
file system (files available only to authneticated users) within your S3 bucket instead. To replace private:// stream wrapper with s3fs stream, include the following in settings.php:<br>
<em>$settings[\'s3fs.use_s3_for_private\'] = TRUE;</em>'),
];
$advanced['root_folder'] = [
'#type' => 'textfield',
'#title' => $this
->t('Root Folder'),
'#default_value' => $config
->get('root_folder'),
'#description' => $this
->t('S3 File System uses the specified folder as the root of the file system within your bucket (if blank, the bucket
root is used). This is helpful when your bucket is used by multiple sites, or has additional data in it which
s3fs should not interfere with.<br>
The metadata refresh function will not retrieve metadata for any files which are outside the Root Folder.<br>
This setting is case sensitive. Do not include leading or trailing slashes.<br>
Changing this setting <b>will not</b> move any files. If you\'ve already uploaded files to S3 through S3 File
System, you will need to manually move them into this folder.'),
];
$advanced['additional_folders'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Additional Folder Settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => $this
->t('Like the root folder, changing these settings <b>will not</b> move any files. If you\'ve already uploaded files
to S3 through S3 File System, you will need to manually move them into the corresponding folders.'),
];
$additional_folders =& $advanced['additional_folders'];
$additional_folders['public_folder'] = [
'#type' => 'textfield',
'#title' => $this
->t('Public Folder'),
'#default_value' => $config
->get('public_folder'),
'#description' => $this
->t('The name of the folder in your bucket (or within the root folder) where public:// files will be stored.'),
];
$additional_folders['private_folder'] = [
'#type' => 'textfield',
'#title' => $this
->t('Private Folder'),
'#default_value' => $config
->get('private_folder'),
'#description' => $this
->t('The name of the folder in your bucket (or within the root folder) where private:// files will be stored.'),
];
$advanced['file_specific'] = [
'#type' => 'fieldset',
'#title' => $this
->t('File-specific Settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
];
$file_specific =& $advanced['file_specific'];
$file_specific['presigned_urls'] = [
'#type' => 'textarea',
'#title' => $this
->t('Presigned URLs'),
'#default_value' => $config
->get('presigned_urls'),
'#rows' => 5,
'#description' => $this
->t('A list of timeouts and paths that should be delivered through a presigned url.<br>
Enter one value per line, in the format timeout|path. e.g. "60|private_files/*". Paths use regex patterns
as per @link. If no timeout is provided, it defaults to 60 seconds.<br>
<b>This feature does not work when "Enable CNAME" is used.</b>', [
'@link' => Link::fromTextAndUrl($this
->t('preg_match'), Url::fromUri('http://php.net/preg_match'))
->toString(),
]),
];
$file_specific['saveas'] = [
'#type' => 'textarea',
'#title' => $this
->t('Force Save As'),
'#default_value' => $config
->get('saveas'),
'#rows' => 5,
'#description' => $this
->t('A list of paths for which users will be forced to save the file, rather than displaying it in the browser.<br>
Enter one value per line. e.g. "video/*". Paths use regex patterns as per @link.<br>
<b>This feature does not work when "Enable CNAME" is used.</b>', [
'@link' => Link::fromTextAndUrl($this
->t('preg_match'), Url::fromUri('http://php.net/preg_match'))
->toString(),
]),
];
$file_specific['torrents'] = [
'#type' => 'textarea',
'#title' => $this
->t('Torrents'),
'#default_value' => $config
->get('torrents'),
'#rows' => 5,
'#description' => $this
->t('A list of paths that should be delivered via BitTorrent.<br>
Enter one value per line, e.g. "big_files/*". Paths use regex patterns as per @link.<br>
<b>Private files and paths which are already set as Presigned URLs or Forced Save As cannot be delivered as torrents.</b>', [
'@link' => Link::fromTextAndUrl($this
->t('preg_match'), Url::fromUri('http://php.net/preg_match'))
->toString(),
]),
];
return parent::buildForm($form, $form_state);
}
public function submitForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
$this
->config('s3fs.settings')
->set('access_key', $values['access_key'])
->set('secret_key', $values['secret_key'])
->set('use_instance_profile', $values['use_instance_profile'])
->set('default_cache_config', $values['default_cache_config'])
->set('bucket', $values['bucket'])
->set('region', $values['region'])
->set('use_cname', $values['use_cname'])
->set('use_customhost', $values['use_customhost'])
->set('hostname', $values['hostname'])
->set('domain', $values['domain'])
->set('cache_control_header', $values['cache_control_header'])
->set('encryption', $values['encryption'])
->set('use_https', $values['use_https'])
->set('ignore_cache', $values['ignore_cache'])
->set('no_rewrite_cssjs', $values['no_rewrite_cssjs'])
->set('root_folder', trim($values['root_folder'], '\\/'))
->set('public_folder', trim($values['public_folder'], '\\/'))
->set('private_folder', trim($values['private_folder'], '\\/'))
->set('presigned_urls', $values['presigned_urls'])
->set('saveas', $values['saveas'])
->set('torrents', $values['torrents'])
->save();
parent::submitForm($form, $form_state);
}
}
