You are here

Home » API reference » S3 File System 4.0.x » ActionsForm.php

class ActionsForm in S3 File System 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Form/ActionsForm.php \Drupal\s3fs\Form\ActionsForm

Defines an actions form.

Hierarchy

Expanded class hierarchy of ActionsForm

1 string reference to 'ActionsForm'
s3fs.routing.yml in ./s3fs.routing.yml
s3fs.routing.yml

File

src/Form/ActionsForm.php, line 15

Namespace

Drupal\s3fs\Form
View source 
class ActionsForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 's3fs_admin_actions_form';
  }

  /**
   * {@inheritdoc}
   */
  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"),
      /*
       * @todo Now we can't attach css inline with #attached, when core
       * implements, we implement too
       * @see https://www.drupal.org/node/2391025
       * '#attached' => [
       *   'css' => [
       *     // Push the button closer to its own description, and push
       *     // the disable checkbox away from the description.
       *     '#edit-refresh {margin-bottom: 0; margin-top: 1em;}
       *       div.refresh {margin-bottom: 1em;}' => ['type' => 'inline']
       *   ],
       * ],
       */
      '#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;
  }

  /**
   * Validate current configuration.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the 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, []));
    }
  }

  /**
   * Success message if configuration is correct.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateConfigSubmitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->messenger()
      ->addStatus('Your configuration works properly');
  }

  /**
   * Refreshes in form validation.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function refreshCacheValidateForm(array &$form, FormStateInterface $form_state) {
    $this
      ->validateConfigValidateForm($form, $form_state);
    $config = \Drupal::config('s3fs.settings')
      ->get();

    // Use this values for submit step.
    $form_state
      ->set('s3fs', [
      'config' => $config,
    ]);
  }

  /**
   * Validates in form submission.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  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);
  }

  /**
   * Validates the form.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  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);

    // Use this values for submit step.
    $form_state
      ->set('s3fs', [
      'config' => $config,
      'scheme' => $destination_scheme,
    ]);
  }

  /**
   * Submits the form.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  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);
  }

  /**
   * Refreshes in form validation.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  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,
      ]));
    }
  }

  /**
   * Validates in form submission.
   *
   * @param array $form
   *   Array that contains the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function credentialsCacheSubmitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->messenger()
      ->addStatus('Credential cache directory deleted.');
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // We use different submits instead default submit.
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ActionsForm::copyLocalSubmitForm public function Submits the form.
ActionsForm::copyLocalValidateForm public function Validates the form.
ActionsForm::credentialsCacheSubmitForm public function Validates in form submission.
ActionsForm::credentialsCacheValidateForm public function Refreshes in form validation.
ActionsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ActionsForm::refreshCacheSubmitForm public function Validates in form submission.
ActionsForm::refreshCacheValidateForm public function Refreshes in form validation.
ActionsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ActionsForm::validateConfigSubmitForm public function Success message if configuration is correct.
ActionsForm::validateConfigValidateForm public function Validate current configuration.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.