class FilterSpamspan in SpamSpan filter 8

Same name and namespace in other branches

8.2 src/Plugin/Filter/FilterSpamspan.php \Drupal\spamspan\Plugin\Filter\FilterSpamspan

Provides a filter to obfuscate email addresses.

Plugin annotation


@Filter(
  id = "filter_spamspan",
  title = @Translation("SpamSpan email address encoding filter"),
  description = @Translation("Attempt to hide email addresses from spam-bots."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
  settings = {
    "spamspan_at" = " [at] ",
    "spamspan_use_graphic" = 0,
    "spamspan_dot_enable" = 0,
    "spamspan_dot" = " [dot] ",
    "spamspan_use_form" = 0,
    "spamspan_form_pattern" = "<a href=""%url?goto=%email"">%displaytext</a>",
    "spamspan_form_default_url" = "contact",
    "spamspan_form_default_displaytext" = "contact form",
    "spamspan_parse_dom" = 0
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\filter\Plugin\FilterBase implements FilterInterface
    class \Drupal\spamspan\Plugin\Filter\FilterSpamspan implements SpamspanInterface uses SpamspanDomTrait, SpamspanSettingsFormTrait, SpamspanTrait

Expanded class hierarchy of FilterSpamspan

File

src/Plugin/Filter/FilterSpamspan.php, line 33

Namespace

Drupal\spamspan\Plugin\Filter

View source

class FilterSpamspan extends FilterBase implements SpamspanInterface {
  use SpamspanTrait;
  use SpamspanDomTrait;
  use SpamspanSettingsFormTrait;

  /**
   * Inline images.
   */
  const PATTERN_IMG_INLINE = '/data\\:(?:.+?)base64(?:.+?)(?=["|\'])/';
  const PATTERN_IMG_PLACEHOLDER = '__spamspan_img_placeholder__';

  /**
   * If text was altered by this filter, set variable below to TRUE.
   *
   * @var bool
   */
  protected $textAltered = FALSE;

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    return $this
      ->t('Each email address will be obfuscated in a human readable fashion or, if JavaScript is enabled, replaced with a spam resistent clickable link. Email addresses will get the default web form unless specified. If replacement text (a persons name) is required a webform is also required. Separate each part with the "|" pipe symbol. Replace spaces in names with "_".');
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $this->textAltered = FALSE;

    // HTML image tags need to be handled separately, as they may contain base64
    // encoded images slowing down the email regex function.
    // Therefore, remove all image contents and add them back later.
    // See https://drupal.org/node/1243042 for details.
    $images = [
      [],
    ];
    preg_match_all(self::PATTERN_IMG_INLINE, $text, $images);
    $text = preg_replace(self::PATTERN_IMG_INLINE, self::PATTERN_IMG_PLACEHOLDER, $text);
    if (!empty($this->settings['spamspan_parse_dom'])) {
      $text = $this
        ->processAsDom($text, $this->textAltered);
    }
    else {
      $text = $this
        ->processAsText($text, $this->textAltered);
    }

    // Revert back to the original image contents.
    foreach ($images[0] as $image) {
      $text = preg_replace('/' . self::PATTERN_IMG_PLACEHOLDER . '/', $image, $text, 1);
    }
    $result = new FilterProcessResult($text);
    if ($this->textAltered) {
      $result
        ->addAttachments([
        'library' => [
          'spamspan/obfuscate',
        ],
      ]);
      if ($this->settings['spamspan_use_graphic']) {
        $result
          ->addAttachments([
          'library' => [
            'spamspan/atsign',
          ],
        ]);
      }
    }
    return $result;
  }

  /**
   * Replaces email addresses using regex.
   *
   * @param string $text
   *   Input text.
   * @param bool $altered
   *   Set to true if any replacements happen.
   *
   * @return string
   *   Output text.
   */
  protected function processAsText($text, &$altered) {
    $text = $this
      ->replaceMailtoLinks($text, $altered);
    if (!empty($this->settings['spamspan_use_form'])) {
      $text = $this
        ->replaceEmailAddressesWithOptions($text, $altered);
    }
    $text = $this
      ->replaceBareEmailAddresses($text, $altered);
    return $text;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FilterBase::$provider	public	property	The name of the provider that owns this filter.
FilterBase::$settings	public	property	An associative array containing the configured settings of this filter.
FilterBase::$status	public	property	A Boolean indicating whether this filter is enabled.
FilterBase::$weight	public	property	The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
FilterBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription	public	function	Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions	public	function	Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions	4
FilterBase::getLabel	public	function	Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType	public	function	Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare	public	function	Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
FilterBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	4
FilterInterface::TYPE_HTML_RESTRICTOR		constant	HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE		constant	Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE		constant	Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE		constant	Reversible transformation filters.
FilterSpamspan::$textAltered	protected	property	If text was altered by this filter, set variable below to TRUE.
FilterSpamspan::PATTERN_IMG_INLINE		constant	Inline images.
FilterSpamspan::PATTERN_IMG_PLACEHOLDER		constant
FilterSpamspan::process	public	function	Performs the filter processing. Overrides FilterInterface::process
FilterSpamspan::processAsText	protected	function	Replaces email addresses using regex.
FilterSpamspan::tips	public	function	Generates a filter's tip. Overrides FilterBase::tips
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SpamspanDomTrait::loadHtmlDocument	protected	function	Load text as DOM Document.
SpamspanDomTrait::processAsDom	protected	function	Replaces email addresses using DOM and regex.
SpamspanDomTrait::replaceDomNode	protected	function	Replace DOM node with another one created from text.
SpamspanDomTrait::toStringHtmlDocument	protected	function	Convert DOM Document back to html.
SpamspanInterface::PATTERN_EMAIL_BARE		constant
SpamspanInterface::PATTERN_EMAIL_WITH_OPTIONS		constant	For cases when spamspan_use_form is checked.
SpamspanInterface::PATTERN_MAILTO		constant	Regex for mailto URLs.
SpamspanInterface::PATTERN_MAIN		constant	Set up a regex constant to split an email into name and domain parts.
SpamspanInterface::PATTERN_SPECIAL		constant	Special characters in the local part.
SpamspanSettingsFormTrait::getSetting	public	function	Returns the value of a setting, or its default value if absent.
SpamspanSettingsFormTrait::processSettingsForm	public	function	Attach our validation.
SpamspanSettingsFormTrait::settingsForm	public	function
SpamspanSettingsFormTrait::validateSettingsForm	public	function	Validate settings form.	1
SpamspanTrait::callbackBareEmailAddresses	public	function	Callback function for preg_replace_callback.
SpamspanTrait::callbackEmailAddressesWithOptions	public	function	Callback function for preg_replace_callback.
SpamspanTrait::callbackMailto	public	function	Callback function for preg_replace_callback.
SpamspanTrait::filterTagContents	protected	function	Clean up the contents of <a> tag.
SpamspanTrait::output	protected	function	A helper function for the callbacks.
SpamspanTrait::outputWhenUseForm	protected	function	A version of $this->output method.
SpamspanTrait::replaceBareEmailAddresses	public	function
SpamspanTrait::replaceEmailAddressesWithOptions	public	function
SpamspanTrait::replaceMailtoLinks	public	function
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.

You are here

class FilterSpamspan in SpamSpan filter 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation