View source
<?php
namespace Drupal\s3fs\Form;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Site\Settings;
use Drupal\Core\StreamWrapper\StreamWrapperInterface;
class ActionsForm extends FormBase {
public function getFormId() {
return 's3fs_admin_actions_form';
}
public function buildForm(array $form, FormStateInterface $form_state) {
$form['#attached']['library'][] = 's3fs/s3fs.actionform';
$form['validate_configuration'] = [
'#type' => 'fieldset',
'#description' => $this
->t("To validate current S3fs configuration include configuration inside settings.php file."),
'#title' => $this
->t('Validate configuration'),
];
$form['validate_configuration']['validate'] = [
'#type' => 'submit',
'#value' => $this
->t('Validate'),
'#validate' => [
[
$this,
'validateConfigValidateForm',
],
],
'#submit' => [
[
$this,
'validateConfigSubmitForm',
],
],
];
$form['refresh_cache'] = [
'#type' => 'fieldset',
'#description' => $this
->t("The file metadata cache keeps track of every file that S3 File System writes to (and deletes from) the S3 bucket,\n so that queries for data about those files (checks for existence, filetype, etc.) don't have to hit S3.\n This speeds up many operations, most noticeably anything related to images and their derivatives."),
'#title' => $this
->t('File Metadata Cache'),
];
$refresh_description = $this
->t("This button queries S3 for the metadata of <i><b>all</b></i> the files in your site's bucket (unless you use the\n Root Folder option), and saves it to the database. This may take a while for buckets with many thousands of files. <br>\n It should only be necessary to use this button if you've just installed S3 File System and you need to cache all the\n pre-existing files in your bucket, or if you need to restore your metadata cache from scratch for some other reason.");
$form['refresh_cache']['refresh'] = [
'#type' => 'submit',
'#suffix' => '<div class="refresh">' . $refresh_description . '</div>',
'#value' => $this
->t("Refresh file metadata cache"),
'#validate' => [
[
$this,
'refreshCacheValidateForm',
],
],
'#submit' => [
[
$this,
'refreshCacheSubmitForm',
],
],
];
$form['copy_local'] = [
'#type' => 'fieldset',
'#description' => $this
->t("<b>Important: This feature is for sites that have configured or going to have configured to take\n over for the public and/or private file systems. Example: You should have\n \$settings['s3fs.use_s3_for_public'] = TRUE; or \$settings['s3fs.use_s3_for_private'] = TRUE; after\n or before use this actions.</b> You may wish to copy any files which were previously uploaded to\n your site into your S3 bucket. <br> If you have a lot of files, or very large files, you'll want to\n use <i>drush s3fs-copy-local</i> instead of this form, as the limitations imposed by browsers may\n break very long copy operations."),
'#title' => $this
->t('Copy Local Files to S3'),
];
$form['copy_local']['upload_condition'] = [
'#type' => 'select',
'#title' => $this
->t('Upload Condition'),
'#description' => $this
->t("When to upload files"),
'#options' => [
'always' => $this
->t('Always'),
'newer' => $this
->t('Modified time is newer'),
'size' => $this
->t('File size differs'),
'newer_size' => $this
->t('Modified time or file size'),
],
'#default_value' => 'always',
'#required' => TRUE,
];
$form['copy_local']['submitbuttons'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'copysubmitbuttons',
],
],
];
$form['copy_local']['submitbuttons']['public'] = [
'#type' => 'submit',
'#prefix' => '<br>',
'#name' => 'public',
'#value' => $this
->t('Copy local public files to S3'),
'#validate' => [
[
$this,
'copyLocalValidateForm',
],
],
'#submit' => [
[
$this,
'copyLocalSubmitForm',
],
],
];
if (Settings::get('file_private_path')) {
$form['copy_local']['submitbuttons']['private'] = [
'#type' => 'submit',
'#prefix' => '<br>',
'#name' => 'private',
'#value' => $this
->t('Copy local private files to S3'),
'#validate' => [
[
$this,
'copyLocalValidateForm',
],
],
'#submit' => [
[
$this,
'copyLocalSubmitForm',
],
],
];
}
$config = \Drupal::config('s3fs.settings')
->get();
$doctrineInstalled = class_exists('\\Doctrine\\Common\\Cache\\FilesystemCache');
if (!empty($config['use_credentials_cache']) && !empty($config['credentials_cache_dir']) && $doctrineInstalled) {
$form['credentials_cache'] = [
'#type' => 'fieldset',
'#description' => $this
->t("The credential cache persists a copy of obtained credentials to\n avoid repeated lookups to AWS servers."),
'#title' => $this
->t('Credentials Cache'),
];
$credentialRefreshDescription = $this
->t("This button purges the directory that stores copies of obtained\n credentials that have been cached locally. It should not be necessary\n to purge credentials unless an invalid set of credentials has been\n stored in the cache.");
$form['credentials_cache']['refresh'] = [
'#type' => 'submit',
'#suffix' => '<div class="refresh">' . $credentialRefreshDescription . '</div>',
'#value' => $this
->t("Delete credentials cache directory"),
'#validate' => [
[
$this,
'credentialsCacheValidateForm',
],
],
'#submit' => [
[
$this,
'credentialsCacheSubmitForm',
],
],
];
}
return $form;
}
public function validateConfigValidateForm(array &$form, FormStateInterface $form_state) {
$config = \Drupal::config('s3fs.settings')
->get();
if ($errors = \Drupal::service('s3fs')
->validate($config)) {
$errorText = $this
->t("Unable to validate your s3fs configuration settings. Please configure S3 File System from the admin/config/media/s3fs page or settings.php and try again.");
foreach ($errors as $error) {
$errorText .= "<br>\n" . $error;
}
$form_state
->setError($form, new FormattableMarkup($errorText, []));
}
}
public function validateConfigSubmitForm(array &$form, FormStateInterface $form_state) {
$this
->messenger()
->addStatus('Your configuration works properly');
}
public function refreshCacheValidateForm(array &$form, FormStateInterface $form_state) {
$this
->validateConfigValidateForm($form, $form_state);
$config = \Drupal::config('s3fs.settings')
->get();
$form_state
->set('s3fs', [
'config' => $config,
]);
}
public function refreshCacheSubmitForm(array &$form, FormStateInterface $form_state) {
$s3fs_storage = $form_state
->get('s3fs');
$config = $s3fs_storage['config'];
\Drupal::service('s3fs.refresh_cache_batch')
->execute($config);
}
public function copyLocalValidateForm(array &$form, FormStateInterface $form_state) {
$this
->validateConfigValidateForm($form, $form_state);
$normal_wrappers = \Drupal::service('stream_wrapper_manager')
->getNames(StreamWrapperInterface::NORMAL);
$triggering_element = $form_state
->getTriggeringElement();
$destination_scheme = $triggering_element['#name'];
if (!empty($normal_wrappers[$destination_scheme])) {
if ($destination_scheme == 'private' && !Settings::get('file_private_path')) {
$form_state
->setError($form, $this
->t("Private system is not properly configurated, check \$settings['file_private_path'] in your settings.php."));
}
}
else {
$form_state
->setError($form, $this
->t('Scheme @scheme is not supported.', [
'@scheme' => $destination_scheme,
]));
}
$config = \Drupal::config('s3fs.settings')
->get();
$submittedCondition = $form_state
->getValue('upload_condition');
$uploadConditions = [];
switch ($submittedCondition) {
case 'always':
$uploadConditions['always'] = TRUE;
break;
case 'newer_size':
$uploadConditions['newer'] = TRUE;
$uploadConditions['size'] = TRUE;
break;
case 'newer':
$uploadConditions['newer'] = TRUE;
break;
case 'size':
$uploadConditions['size'] = TRUE;
break;
}
$form_state
->set('upload_conditions', $uploadConditions);
$form_state
->set('s3fs', [
'config' => $config,
'scheme' => $destination_scheme,
]);
}
public function copyLocalSubmitForm(array &$form, FormStateInterface $form_state) {
$s3fs_storage = $form_state
->get('s3fs');
$config = $s3fs_storage['config'];
$scheme = $s3fs_storage['scheme'];
$uploadOptions = [
'upload_conditions' => $form_state
->get('upload_conditions'),
];
\Drupal::service('s3fs.file_migration_batch')
->execute($config, $scheme, $uploadOptions);
}
public function credentialsCacheValidateForm(array &$form, FormStateInterface $form_state) {
$config = \Drupal::config('s3fs.settings')
->get();
if (empty($config['credentials_cache_dir']) || !class_exists('\\Doctrine\\Common\\Cache\\FilesystemCache')) {
$form_state
->setError($form, $this
->t("Credentials cache not properly setup. Unable to delete."));
}
try {
@\Drupal::service('file_system')
->deleteRecursive($config['credentials_cache_dir'] . '/s3fscache');
} catch (FileException $e) {
$form_state
->setError($form, $this
->t("Unable to delete credential cache directory. @message", [
'@message' => $e,
]));
}
}
public function credentialsCacheSubmitForm(array &$form, FormStateInterface $form_state) {
$this
->messenger()
->addStatus('Credential cache directory deleted.');
}
public function submitForm(array &$form, FormStateInterface $form_state) {
}
}
