class NoReferrerSettingsForm in No Referrer 8

Implements a noreferrer Config 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\noreferrer\Form\NoReferrerSettingsForm

Expanded class hierarchy of NoReferrerSettingsForm

1 string reference to 'NoReferrerSettingsForm'

noreferrer.routing.yml in ./noreferrer.routing.yml: noreferrer.routing.yml

File

src/Form/NoReferrerSettingsForm.php, line 16

Namespace

Drupal\noreferrer\Form

View source

class NoReferrerSettingsForm extends ConfigFormBase {

  /**
   * The file system.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The file URL generator.
   *
   * @var \Drupal\Core\File\FileUrlGeneratorInterface|null
   */
  protected $fileUrlGenerator;

  /**
   * The private key service.
   *
   * @var \Drupal\Core\PrivateKey
   */
  protected $privateKey;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, PrivateKey $private_key, FileSystemInterface $file_system, $file_url_generator = NULL) {
    parent::__construct($config_factory);
    $this->privateKey = $private_key;
    $this->fileSystem = $file_system;
    $this->fileUrlGenerator = $file_url_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('private_key'), $container
      ->get('file_system'), $container
      ->has('file_url_generator') ? $container
      ->get('file_url_generator') : NULL);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['noopener'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add <code>rel="noopener"</code> if link has a target'),
      '#default_value' => $this
        ->config('noreferrer.settings')
        ->get('noopener'),
      '#description' => $this
        ->t('If checked, the <code>rel="noopener"</code> link type will be added to links that have a target attribute.'),
    ];
    $form['noreferrer'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add <code>rel="noreferrer"</code> to non-whitelisted links'),
      '#default_value' => $this
        ->config('noreferrer.settings')
        ->get('noreferrer'),
      '#description' => $this
        ->t('If checked, the <code>rel="noreferrer"</code> link type will be added to non-whitelisted external links.'),
    ];
    $form['whitelisted_domains'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Whitelisted domains'),
      '#default_value' => $this
        ->config('noreferrer.settings')
        ->get('whitelisted_domains'),
      '#description' => $this
        ->t('Enter a space-separated list of domains to which referrer URLs will be sent (e.g. <em>example.com example.org</em>). Links to all other domains will have a <code>rel="noreferrer"</code> link type added.'),
      '#maxlength' => NULL,
    ];
    $form['publish'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Publish list of whitelisted domains'),
      '#default_value' => $this
        ->config('noreferrer.settings')
        ->get('publish'),
      '#description' => $this
        ->t('If checked, the list of whitelisted domains will be published at <a href="@url">@url</a> when saving this form.', [
        '@url' => $this->fileUrlGenerator ? $this->fileUrlGenerator
          ->generateAbsoluteString($this
          ->publishUri()) : file_create_url($this
          ->publishUri()),
      ]),
    ];
    $form['subscribe_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Subscribe to external list of whitelisted domains'),
      '#default_value' => $this
        ->config('noreferrer.settings')
        ->get('subscribe_url'),
      '#description' => $this
        ->t('If configured, the list of whitelisted domains will be retrieved from the given URL during each cron run.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('noreferrer.settings')
      ->set('noopener', $form_state
      ->getValue('noopener'))
      ->set('noreferrer', $form_state
      ->getValue('noreferrer'))
      ->set('publish', $form_state
      ->getValue('publish'))
      ->set('subscribe_url', $form_state
      ->getValue('subscribe_url'))
      ->set('whitelisted_domains', $form_state
      ->getValue('whitelisted_domains'))
      ->save();
    if ($form_state
      ->getValue('publish')) {
      $this
        ->publish();
    }
    if ($url = $form_state
      ->getValue('subscribe_url')) {
      noreferrer_subscribe($url);
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Publishes domain whitelist.
   */
  public function publish() {
    if ($whitelist = $this
      ->config('noreferrer.settings')
      ->get('whitelisted_domains')) {
      $whitelist = json_encode(explode(' ', $whitelist));
      $this->fileSystem
        ->saveData($whitelist, $this
        ->publishUri(), FileSystemInterface::EXISTS_REPLACE);
    }
  }

  /**
   * Returns domain whitelist URI.
   */
  public function publishUri() {

    // For security through obscurity purposes, the whitelist URL is secret.
    return 'public://noreferrer-whitelist-' . Crypt::hmacBase64('noreferrer-whitelist', $this->privateKey
      ->get()) . '.json';
  }

}

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
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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
NoReferrerSettingsForm::$fileSystem	protected	property	The file system.
NoReferrerSettingsForm::$fileUrlGenerator	protected	property	The file URL generator.
NoReferrerSettingsForm::$privateKey	protected	property	The private key service.
NoReferrerSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
NoReferrerSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
NoReferrerSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NoReferrerSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
NoReferrerSettingsForm::publish	public	function	Publishes domain whitelist.
NoReferrerSettingsForm::publishUri	public	function	Returns domain whitelist URI.
NoReferrerSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
NoReferrerSettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 NoReferrerSettingsForm in No Referrer 8

Hierarchy

File

Namespace

Members

API Navigation