class FastlySettingsForm in Fastly 8.3

Class FastlySettingsForm Defines a form to configure module settings.

@package Drupal\fastly\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\fastly\Form\FastlySettingsForm

Expanded class hierarchy of FastlySettingsForm

1 string reference to 'FastlySettingsForm'

fastly.routing.yml in ./fastly.routing.yml: fastly.routing.yml

File

src/Form/FastlySettingsForm.php, line 23

Namespace

Drupal\fastly\Form

View source

class FastlySettingsForm extends ConfigFormBase {

  /**
   * The Fastly API.
   *
   * @var \Drupal\fastly\Api
   */
  protected $api;

  /**
   * The Fastly VclHandler.
   *
   * @var \Drupal\fastly\VclHandler
   */
  protected $vclHandler;

  /**
   * Tracks validity of credentials associated with Fastly Api.
   *
   * @var \Drupal\fastly\State
   */
  protected $state;

  /**
   * The Fastly webhook service.
   *
   * @var \Drupal\fastly\Services\Webhook
   */
  protected $webhook;

  /**
   * Host of current request.
   *
   * @var string
   */
  protected $baseUrl;

  /**
   * Constructs a FastlySettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\fastly\Api $api
   *   Fastly API for Drupal.
   * @param \Drupal\fastly\State $state
   *   Fastly state service for Drupal.
   * @param \Drupal\fastly\VclHandler $vclHandler
   *   Vcl handler.
   * @param \Drupal\fastly\Services\Webhook $webhook
   *   The Fastly webhook service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack object.
   */
  public function __construct(ConfigFactoryInterface $config_factory, Api $api, State $state, VclHandler $vclHandler, Webhook $webhook, RequestStack $requestStack) {
    parent::__construct($config_factory);
    $this->api = $api;
    $this->state = $state;
    $this->vclHandler = $vclHandler;
    $this->webhook = $webhook;
    $this->baseUrl = $requestStack
      ->getCurrentRequest()
      ->getHost();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('fastly.api'), $container
      ->get('fastly.state'), $container
      ->get('fastly.vclhandler'), $container
      ->get('fastly.services.webhook'), $container
      ->get('request_stack'));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'fastly.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('fastly.settings');
    if ($config
      ->get('image_optimization') == 1) {
      if (!$this->api
        ->ioEnabled($config
        ->get('service_id'))) {
        $this
          ->messenger()
          ->addError($this
          ->t('You have Fastly image optimization enabled in configuration but you don\'t have it available on service!'));
      }
    }

    // Validate API credentials set directly in settings files.
    $purge_credentials_are_valid = $this->api
      ->validatePurgeCredentials();
    if (getenv('FASTLY_API_TOKEN')) {
      $api_key = getenv('FASTLY_API_TOKEN');
    }
    else {
      $api_key = count($form_state
        ->getValues()) ? $form_state
        ->getValue('api_key') : $config
        ->get('api_key');
    }
    $form['account_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Account settings'),
      '#open' => TRUE,
    ];
    $form['account_settings']['site_id'] = [
      '#type' => 'machine_name',
      '#title' => $this
        ->t('Site ID'),
      '#default_value' => $config
        ->get('site_id'),
      '#required' => FALSE,
      '#description' => $this
        ->t("Site identifier which is being prepended to cache tags. Use this if you have multiple sites in the same service in Fastly. Note: You can use the environment variable <code>FASTLY_SITE_ID</code> to set this also. If nothing is set in either config or environment variable then one will be randomly generated for you."),
    ];
    $purge_credentials_status_message = $purge_credentials_are_valid ? $this
      ->t("An <em>API key</em> and <em>Service Id</em> pair are set that can perform purge operations. These credentials may not be adequate to performs all operations on this form. Can be overridden by <code>FASTLY_API_TOKEN</code> environment variable.") : $this
      ->t("You can find your personal API tokens on your Fastly Account Settings page. See <a href=':using_api_tokens'>using API tokens</a> for more information. If you don't have an account yet, please visit <a href=':signup'>https://www.fastly.com/signup</a> on Fastly. Can be overridden by <code>FASTLY_API_TOKEN</code> environment variable.", [
      ':using_api_tokens' => 'https://docs.fastly.com/guides/account-management-and-security/using-api-tokens',
      ':signup' => 'https://www.fastly.com/signup',
    ]);
    $form['service_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Service settings'),
      '#open' => TRUE,
    ];
    $form['account_settings']['api_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('API key'),
      '#default_value' => $api_key,
      '#required' => !$purge_credentials_are_valid,
      '#description' => $purge_credentials_status_message,
      // Update the listed services whenever the API key is modified.
      '#ajax' => [
        'callback' => '::updateServices',
        'wrapper' => 'edit-service-wrapper',
        'event' => 'change',
      ],
    ];
    $service_options = $this
      ->getServiceOptions();
    $form['service_settings']['service_id'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Service'),
      '#options' => $service_options,
      '#empty_option' => $this
        ->t('- Select -'),
      '#default_value' => getenv('FASTLY_API_SERVICE') ?: $config
        ->get('service_id'),
      '#required' => !$purge_credentials_are_valid,
      '#description' => $this
        ->t('A Service represents the configuration for your website to be served through Fastly. You can override this with FASTLY_API_SERVICE environment variable'),
      // Hide while no API key is set.
      '#states' => [
        'invisible' => [
          'input[name="api_key"]' => [
            'empty' => TRUE,
          ],
        ],
      ],
      '#prefix' => '<div id="edit-service-wrapper">',
      '#suffix' => '</div>',
    ];
    $form['vcl'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('VCL update options'),
      '#open' => TRUE,
      '#description' => $this
        ->t('Upload Fastly VCL snippets that improve cacheability of the site. Note: VCL assumes Drupal is the only app running. Please test in staging before applying in production.'),
    ];
    $form['vcl']['vcl_snippets'] = [
      '#type' => 'button',
      '#title' => 'Upload latest Fastly VCL snippets',
      '#value' => $this
        ->t('Upload latest Fastly VCL'),
      '#ajax' => [
        'callback' => [
          $this,
          'uploadVcls',
        ],
        'event' => 'click-custom',
      ],
      '#attached' => [
        'library' => [
          'fastly/fastly',
        ],
      ],
      '#suffix' => '<span class="email-valid-message"></span>',
    ];
    $form['vcl']['activate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Activate version on VCL upload'),
      '#default_value' => 1,
      '#attributes' => [
        'checked' => 'checked',
      ],
    ];
    $form['vcl']['error_maintenance'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Error/Maintenance Page'),
      '#default_value' => $config
        ->get('error_maintenance'),
      '#required' => FALSE,
      '#description' => $this
        ->t('Custom error / maintenance HTML page content. "Pretty" page presented to the end user on HTTP 500+ errors. Max size 128kB'),
      '#prefix' => '<div id="edit-maintenance-wrapper">',
      '#suffix' => '</div>',
    ];
    $form['vcl']['upload_error_maintenance'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Upload error maintenance page'),
      '#required' => FALSE,
      '#description' => $this
        ->t('Upload error maintenance page'),
      '#ajax' => [
        'callback' => [
          $this,
          'uploadMaintenance',
        ],
        'event' => 'click-custom-upload-error-maintenance',
      ],
      '#attached' => [
        'library' => [
          'fastly/fastly',
        ],
      ],
      '#suffix' => '<span class="error-maintenance-message"></span>',
    ];
    $form['purge_actions'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Purge actions'),
      '#description' => $this
        ->t('Purge / invalidate all site content: affects this site only. <br><b>WARNING: PURGE WHOLE SERVICE ACTION WILL DESTROY THE ENTIRE CACHE FOR ALL SITES IN THE CURRENT FASTLY SERVICE.</b>'),
      '#open' => TRUE,
    ];
    $form['purge_actions']['purge_all_keys'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Purge / invalidate all site content'),
      '#required' => FALSE,
      '#description' => $this
        ->t('Purge all'),
      '#ajax' => [
        'callback' => [
          $this,
          'purgeAllByKeys',
        ],
        'event' => 'click-custom-purge-all-keys',
      ],
      '#attached' => [
        'library' => [
          'fastly/fastly',
        ],
      ],
      '#suffix' => '<span class="purge-all-message-keys"></span>',
    ];
    $form['purge_actions']['purge_all'] = [
      '#type' => 'button',
      '#value' => $this
        ->t('Purge whole service'),
      '#required' => FALSE,
      '#description' => $this
        ->t('Purge whole service'),
      '#ajax' => [
        'callback' => [
          $this,
          'purgeAll',
        ],
        'event' => 'click-custom-purge-all',
      ],
      '#attached' => [
        'library' => [
          'fastly/fastly',
        ],
      ],
      '#suffix' => '<span class="purge-all-message"></span>',
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * Handles changing the API key.
   */
  public function updateServices($form, FormStateInterface $form_state) {
    return $form['service_settings']['service_id'];
  }

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

    // Get and use the API token value from this form for validation.
    $apiKey = $form_state
      ->getValue('api_key');
    if (empty($apiKey) && !$this->api
      ->validatePurgeCredentials()) {
      $form_state
        ->setErrorByName('api_key', $this
        ->t('Please enter an API token.'));
    }
    if (!empty($apiKey)) {
      $this->api
        ->setApiKey($apiKey);
    }

    // Verify API token has adequate scope to use this form.
    if (!$this->api
      ->validatePurgeToken()) {
      $form_state
        ->setErrorByName('api_key', $this
        ->t('Invalid API token. Make sure the token you are trying has at least <em>global:read</em>, <em>purge_all</em>, and <em>purge_all</em> scopes.'));
    }
  }

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

    // Set purge credentials state to TRUE if we have made it this far.
    $this->state
      ->setPurgeCredentialsState(TRUE);
    $this
      ->config('fastly.settings')
      ->set('api_key', $form_state
      ->getValue('api_key'))
      ->set('service_id', $form_state
      ->getValue('service_id'))
      ->set('error_maintenance', $form_state
      ->getValue('error_maintenance'))
      ->set('site_id', $form_state
      ->getValue('site_id'))
      ->save();
    $this->webhook
      ->sendWebHook($this
      ->t("Fastly module configuration changed on %base_url", [
      '%base_url' => $this->baseUrl,
    ]), "config_save");
    parent::submitForm($form, $form_state);
  }

  /**
   * Retrieves options for the Fastly service.
   *
   * @return array
   *   Array of service ids mapped to service names.
   */
  protected function getServiceOptions() {
    if (empty($this->api
      ->getApiKey())) {
      return [];
    }
    $services = $this->api
      ->getServices();
    if (empty($services)) {
      return [];
    }
    $service_options = [];
    foreach ($services as $service) {
      $service_options[$service->id] = $service->name;
    }
    ksort($service_options);
    return $service_options;
  }

  /**
   * Upload Vcls.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   AjaxResponse.
   */
  public function uploadVcls(array $form, FormStateInterface $form_state) {
    $activate = $form_state
      ->getValue("activate");
    $response = new AjaxResponse();
    $message = $this->vclHandler
      ->execute($activate);
    $response
      ->addCommand(new HtmlCommand('.email-valid-message', $message));
    return $response;
  }

  /**
   * Purge all.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   AjaxResponse.
   */
  public function purgeAll(array $form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $purge = $this->api
      ->purgeAll(FALSE);
    if (!$purge) {
      $message = $this
        ->t("Something went wrong while purging / invalidating content. Please, check logs for more info.");
    }
    else {
      $message = $this
        ->t("Entire service purged successfully.");
    }
    $response
      ->addCommand(new HtmlCommand('.purge-all-message', $message));
    return $response;
  }

  /**
   * Uploads maintenance page and saves configuration.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   AjaxResponse.
   */
  public function uploadMaintenance(array $form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    if ($this
      ->config("error_maintenance") != $form_state
      ->getValue('error_maintenance')) {
      $upload = $this->vclHandler
        ->uploadMaintenancePage($form_state
        ->getValue('error_maintenance'));
    }
    if (!$upload) {
      $message = $this
        ->t("Maintenance page upload failed.");
    }
    else {
      $message = $this
        ->t("Maintenance page uploaded successfuly.");
      $this->webhook
        ->sendWebHook($this
        ->t("Fastly Error / Maintenance page updated on %base_url", [
        '%base_url' => $this->baseUrl,
      ]), "config_save");
      $this
        ->submitForm($form, $form_state);
    }
    $response
      ->addCommand(new HtmlCommand('.error-maintenance-message', $message));
    return $response;
  }

  /**
   * Purge all.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   AjaxResponse.
   */
  public function purgeAllByKeys(array $form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $purge = $this->api
      ->purgeAll();
    if (!$purge) {
      $message = $this
        ->t("Something went wrong while purging / invalidating content. Please, check logs for more info.");
    }
    else {
      $message = $this
        ->t("All site content is purged / invalidated successfully.");
    }
    $response
      ->addCommand(new HtmlCommand('.purge-all-message-keys', $message));
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FastlySettingsForm::$api	protected	property	The Fastly API.
FastlySettingsForm::$baseUrl	protected	property	Host of current request.
FastlySettingsForm::$state	protected	property	Tracks validity of credentials associated with Fastly Api.
FastlySettingsForm::$vclHandler	protected	property	The Fastly VclHandler.
FastlySettingsForm::$webhook	protected	property	The Fastly webhook service.
FastlySettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
FastlySettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
FastlySettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FastlySettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FastlySettingsForm::getServiceOptions	protected	function	Retrieves options for the Fastly service.
FastlySettingsForm::purgeAll	public	function	Purge all.
FastlySettingsForm::purgeAllByKeys	public	function	Purge all.
FastlySettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
FastlySettingsForm::updateServices	public	function	Handles changing the API key.
FastlySettingsForm::uploadMaintenance	public	function	Uploads maintenance page and saves configuration.
FastlySettingsForm::uploadVcls	public	function	Upload Vcls.
FastlySettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
FastlySettingsForm::__construct	public	function	Constructs a FastlySettingsForm object. Overrides ConfigFormBase::__construct
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
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. Overrides UrlGeneratorTrait::redirect
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.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class FastlySettingsForm in Fastly 8.3

Hierarchy

File

Namespace

Members

API Navigation