diff --git a/README.txt b/README.txt index 491d5f8..0b4ef38 100644 --- a/README.txt +++ b/README.txt @@ -11,10 +11,10 @@ This module adds the rel="noreferrer" link type to all external links generated by code. It also provides a filter which, if enabled for a text format, adds the rel="noreferrer" link type to all external links in user-generated content. -Whitelisted domains can be defined, to which referrer URLs will be sent. If -desired, you may also publish your list of whitelisted domains as a JSON file, +Allowed domains can be defined, to which referrer URLs will be sent. If +desired, you may also publish your list of allowed domains as a JSON file, to which other sites can subscribe. Alternately, you may subscribe to another -site's list of whitelisted domains. +site's list of allowed domains. This module also adds the rel="noopener" link type to all links with a target. You can toggle both link types on and off if, for example, you need only the diff --git a/config/install/noreferrer.settings.yml b/config/install/noreferrer.settings.yml index 00728a6..6cd664e 100644 --- a/config/install/noreferrer.settings.yml +++ b/config/install/noreferrer.settings.yml @@ -2,4 +2,4 @@ noopener: true noreferrer: true publish: false subscribe_url: '' -whitelisted_domains: '' +allowed_domains: '' diff --git a/config/schema/noreferrer.schema.yml b/config/schema/noreferrer.schema.yml index 1125f19..edbe85d 100644 --- a/config/schema/noreferrer.schema.yml +++ b/config/schema/noreferrer.schema.yml @@ -9,13 +9,13 @@ noreferrer.settings: label: 'Add rel="noopener" link type if link has a target' noreferrer: type: boolean - label: 'Add rel="noreferrer" link type to non-whitelisted links' + label: 'Add rel="noreferrer" link type to non-allowed links' publish: type: boolean - label: 'Publish list of whitelisted domains' + label: 'Publish list of allowed domains' subscribe_url: type: string - label: 'Subscribe to external list of whitelisted domains' - whitelisted_domains: + label: 'Subscribe to external list of allowed domains' + allowed_domains: type: string - label: 'Whitelisted domains' + label: 'Allowed domains' diff --git a/noreferrer.module b/noreferrer.module index bf5fb73..7c11dcf 100644 --- a/noreferrer.module +++ b/noreferrer.module @@ -25,7 +25,7 @@ function noreferrer_link_alter(&$variables) { ]; } } - if (!$config->get('noreferrer') || !$variables['url']->isExternal() || noreferrer_is_whitelisted($variables['url']->toString())) { + if (!$config->get('noreferrer') || !$variables['url']->isExternal() || noreferrer_is_allowed($variables['url']->toString())) { return; } if (!isset($variables['options']['attributes']['rel']) || is_array($variables['options']['attributes']['rel'])) { @@ -40,11 +40,11 @@ function noreferrer_link_alter(&$variables) { } /** - * Helper function to determine if a host is in the domain whitelist. + * Helper function to determine if a host is in the domain allow list. */ -function noreferrer_is_whitelisted($url) { - if ($whitelist = \Drupal::config('noreferrer.settings')->get('whitelisted_domains')) { - $domains = explode(' ', $whitelist); +function noreferrer_is_allowed($url) { + if ($allowed_domains = \Drupal::config('noreferrer.settings')->get('allowed_domains')) { + $domains = explode(' ', $allowed_domains); $host = parse_url($url, PHP_URL_HOST); foreach ($domains as $domain) { if (!strcasecmp($domain, $host) || strripos($host, '.' . $domain) === strlen($host) - strlen($domain) - 1) { @@ -65,27 +65,27 @@ function noreferrer_cron() { } /** - * Retrieves whitelist from external URL. + * Retrieves allow list from external URL. */ function noreferrer_subscribe($url) { try { $response = \Drupal::httpClient()->get($url); } catch (Exception $e) { - \Drupal::logger('noreferrer')->error('Error received at %url while retrieving domain whitelist: %message.', [ + \Drupal::logger('noreferrer')->error('Error received at %url while retrieving domain allow list: %message.', [ '%url' => $url, '%message' => $e->getMessage(), ]); return; } - $whitelist = json_decode((string) $response->getBody()); - if (is_array($whitelist)) { + $allowed_domains = json_decode((string) $response->getBody()); + if (is_array($allowed_domains)) { \Drupal::configFactory()->getEditable('noreferrer.settings') - ->set('whitelisted_domains', implode(' ', $whitelist)) + ->set('allowed_domains', implode(' ', $allowed_domains)) ->save(); } else { - \Drupal::logger('noreferrer')->error('Unable to extract valid data from %url while retrieving domain whitelist.', ['%url' => $url]); + \Drupal::logger('noreferrer')->error('Unable to extract valid data from %url while retrieving domain allow list.', ['%url' => $url]); } } diff --git a/src/Form/NoReferrerSettingsForm.php b/src/Form/NoReferrerSettingsForm.php index 1bf9a1d..f468e1e 100644 --- a/src/Form/NoReferrerSettingsForm.php +++ b/src/Form/NoReferrerSettingsForm.php @@ -84,30 +84,30 @@ class NoReferrerSettingsForm extends ConfigFormBase { ]; $form['noreferrer'] = [ '#type' => 'checkbox', - '#title' => $this->t('Add rel="noreferrer" to non-whitelisted links'), + '#title' => $this->t('Add rel="noreferrer" to non-allowed links'), '#default_value' => $this->config('noreferrer.settings')->get('noreferrer'), - '#description' => $this->t('If checked, the rel="noreferrer" link type will be added to non-whitelisted external links.'), + '#description' => $this->t('If checked, the rel="noreferrer" link type will be added to non-allowed external links.'), ]; - $form['whitelisted_domains'] = [ + $form['allowed_domains'] = [ '#type' => 'textfield', - '#title' => $this->t('Whitelisted domains'), - '#default_value' => $this->config('noreferrer.settings')->get('whitelisted_domains'), + '#title' => $this->t('Allowed domains'), + '#default_value' => $this->config('noreferrer.settings')->get('allowed_domains'), '#description' => $this->t('Enter a space-separated list of domains to which referrer URLs will be sent (e.g. example.com example.org). Links to all other domains will have a rel="noreferrer" link type added.'), '#maxlength' => NULL, ]; $form['publish'] = [ '#type' => 'checkbox', - '#title' => $this->t('Publish list of whitelisted domains'), + '#title' => $this->t('Publish list of allowed domains'), '#default_value' => $this->config('noreferrer.settings')->get('publish'), - '#description' => $this->t('If checked, the list of whitelisted domains will be published at @url when saving this form.', [ + '#description' => $this->t('If checked, the list of allowed domains will be published at @url 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'), + '#title' => $this->t('Subscribe to external list of allowed 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.'), + '#description' => $this->t('If configured, the list of allowed domains will be retrieved from the given URL during each cron run.'), ]; return parent::buildForm($form, $form_state); } @@ -121,7 +121,7 @@ class NoReferrerSettingsForm extends ConfigFormBase { ->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')) + ->set('allowed_domains', $form_state->getValue('allowed_domains')) ->save(); if ($form_state->getValue('publish')) { $this->publish(); @@ -133,21 +133,21 @@ class NoReferrerSettingsForm extends ConfigFormBase { } /** - * Publishes domain whitelist. + * Publishes domain allow list. */ 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); + if ($allowed_domains = $this->config('noreferrer.settings')->get('allowed_domains')) { + $allowed_domains = json_encode(explode(' ', $allowed_domains)); + $this->fileSystem->saveData($allowed_domains, $this->publishUri(), FileSystemInterface::EXISTS_REPLACE); } } /** - * Returns domain whitelist URI. + * Returns domain allow list 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'; + // For security through obscurity purposes, the allow list URL is secret. + return 'public://noreferrer-allowlist-' . Crypt::hmacBase64('noreferrer-allowlist', $this->privateKey->get()) . '.json'; } } diff --git a/src/Plugin/Filter/NoReferrerFilter.php b/src/Plugin/Filter/NoReferrerFilter.php index f8afa2d..bb30e05 100644 --- a/src/Plugin/Filter/NoReferrerFilter.php +++ b/src/Plugin/Filter/NoReferrerFilter.php @@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; * @Filter( * id = "noreferrer", * title = @Translation("Add rel="noopener" and/or rel="noreferrer" to links"), - * description = @Translation("Adds rel="noopener" to links with a target and/or rel="noreferrer" to non-whitelisted links."), + * description = @Translation("Adds rel="noopener" to links with a target and/or rel="noreferrer" to non-allowed links."), * type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE, * weight = 10 * ) @@ -86,7 +86,7 @@ class NoReferrerFilter extends FilterBase implements ContainerFactoryPluginInter if ($noopener && $link->getAttribute('target') !== '') { $types[] = 'noopener'; } - if ($noreferrer && ($href = $link->getAttribute('href')) && UrlHelper::isExternal($href) && !noreferrer_is_whitelisted($href)) { + if ($noreferrer && ($href = $link->getAttribute('href')) && UrlHelper::isExternal($href) && !noreferrer_is_allowed($href)) { $types[] = 'noreferrer'; } if ($types) { diff --git a/tests/src/Functional/NoReferrerTest.php b/tests/src/Functional/NoReferrerTest.php index 2b8e0fd..71efaba 100644 --- a/tests/src/Functional/NoReferrerTest.php +++ b/tests/src/Functional/NoReferrerTest.php @@ -37,7 +37,7 @@ class NoReferrerTest extends BrowserTestBase { 'access administration pages', ]); $this->drupalLogin($admin_user); - $edit = ['whitelisted_domains' => 'drupal.org example.org', 'publish' => 1]; + $edit = ['allowed_domains' => 'drupal.org example.org', 'publish' => 1]; $this->drupalGet('admin/config/content/noreferrer'); $this->submitForm($edit, $this->t('Save configuration')); $this->assertSame('test', (string) Link::fromTextAndUrl('test', Url::fromUri('https://example.com/'))->toString());