FilterKernelTest.php
Same filename and directory in other branches
Namespace
Drupal\Tests\filter\KernelFile
-
core/
modules/ filter/ tests/ src/ Kernel/ FilterKernelTest.php
View source
<?php
declare (strict_types=1);
namespace Drupal\Tests\filter\Kernel;
use Drupal\Component\Utility\Html;
use Drupal\Core\Language\Language;
use Drupal\Core\Render\RenderContext;
use Drupal\editor\EditorXssFilter\Standard;
use Drupal\filter\Entity\FilterFormat;
use Drupal\filter\FilterPluginCollection;
use Drupal\filter\Plugin\FilterInterface;
use Drupal\KernelTests\KernelTestBase;
/**
* Tests Filter module filters individually.
*
* @group filter
*/
class FilterKernelTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'system',
'filter',
];
/**
* @var \Drupal\filter\Plugin\FilterInterface[]
*/
protected $filters;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->installConfig([
'system',
]);
$manager = $this->container
->get('plugin.manager.filter');
$bag = new FilterPluginCollection($manager, []);
$this->filters = $bag->getAll();
}
/**
* Tests the align filter.
*/
public function testAlignFilter() : void {
$filter = $this->filters['filter_align'];
$test = function ($input) use ($filter) {
return $filter->process($input, 'und');
};
// No data-align attribute.
$input = '<img src="llama.jpg" />';
$expected = $input;
$this->assertSame($expected, $test($input)->getProcessedText());
// Data-align attribute: all 3 allowed values.
$input = '<img src="llama.jpg" data-align="left" />';
$expected = '<img src="llama.jpg" class="align-left">';
$this->assertSame($expected, $test($input)->getProcessedText());
$input = '<img src="llama.jpg" data-align="center" />';
$expected = '<img src="llama.jpg" class="align-center">';
$this->assertSame($expected, $test($input)->getProcessedText());
$input = '<img src="llama.jpg" data-align="right" />';
$expected = '<img src="llama.jpg" class="align-right">';
$this->assertSame($expected, $test($input)->getProcessedText());
// Data-align attribute: a disallowed value.
$input = '<img src="llama.jpg" data-align="left foobar" />';
$expected = '<img src="llama.jpg">';
$this->assertSame($expected, $test($input)->getProcessedText());
// Empty data-align attribute.
$input = '<img src="llama.jpg" data-align="" />';
$expected = '<img src="llama.jpg">';
$this->assertSame($expected, $test($input)->getProcessedText());
// Ensure the filter also works with uncommon yet valid attribute quoting.
$input = '<img src=llama.jpg data-align=right />';
$expected = '<img src="llama.jpg" class="align-right">';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
// Security test: attempt to inject an additional class.
$input = '<img src="llama.jpg" data-align="center another-class-here" />';
$expected = '<img src="llama.jpg">';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
// Security test: attempt an XSS.
$input = '<img src="llama.jpg" data-align="center \'onclick=\'alert(foo);" />';
$expected = '<img src="llama.jpg">';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
}
/**
* Tests the caption filter.
*/
public function testCaptionFilter() : void {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$filter = $this->filters['filter_caption'];
$test = function ($input) use ($filter, $renderer) {
return $renderer->executeInRenderContext(new RenderContext(), function () use ($input, $filter) {
return $filter->process($input, 'und');
});
};
$attached_library = [
'library' => [
'filter/caption',
],
];
// No data-caption attribute.
$input = '<img src="llama.jpg" />';
$expected = $input;
$this->assertSame($expected, $test($input)->getProcessedText());
// Data-caption attribute.
$input = '<img src="llama.jpg" data-caption="Loquacious llama!" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Empty data-caption attribute.
$input = '<img src="llama.jpg" data-caption="" />';
$expected = '<img src="llama.jpg">';
$this->assertSame($expected, $test($input)->getProcessedText());
// HTML entities in the caption.
$input = '<img src="llama.jpg" data-caption="“Loquacious llama!”" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>“Loquacious llama!”</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// HTML encoded as HTML entities in data-caption attribute.
$input = '<img src="llama.jpg" data-caption="<em>Loquacious llama!</em>" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption><em>Loquacious llama!</em></figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// HTML (not encoded as HTML entities) in data-caption attribute, which is
// not allowed by the HTML spec, but may happen when people manually write
// HTML, so we explicitly support it.
$input = '<img src="llama.jpg" data-caption="<em>Loquacious llama!</em>" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption><em>Loquacious llama!</em></figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Security test: attempt an XSS.
$input = '<img src="llama.jpg" data-caption="<script>alert(\'Loquacious llama!\')</script>" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>alert(\'Loquacious llama!\')</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Ensure the filter also works with uncommon yet valid attribute quoting.
$input = '<img src=llama.jpg data-caption=\'Loquacious llama!\' />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Finally, ensure that this also works on any other tag.
$input = '<video src="llama.jpg" data-caption="Loquacious llama!" />';
$expected = '<figure role="group">
<video src="llama.jpg"></video>
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
$input = '<foobar data-caption="Loquacious llama!">baz</foobar>';
$expected = '<figure role="group">
<foobar>baz</foobar>
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Ensure the caption filter works for linked images.
$input = '<a href="http://example.com/llamas/are/awesome/but/kittens/are/cool/too"><img src="llama.jpg" data-caption="Loquacious llama!" /></a>';
$expected = '<figure role="group">
<a href="http://example.com/llamas/are/awesome/but/kittens/are/cool/too"><img src="llama.jpg"></a>
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// So far we've tested that the caption filter works correctly. But we also
// want to make sure that it works well in tandem with the "Limit allowed
// HTML tags" filter, which it is typically used with.
$html_filter = $this->filters['filter_html'];
$html_filter->setConfiguration([
'settings' => [
'allowed_html' => '<img src data-align data-caption>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
]);
$test_with_html_filter = function ($input) use ($filter, $html_filter, $renderer) {
return $renderer->executeInRenderContext(new RenderContext(), function () use ($input, $filter, $html_filter) {
// 1. Apply HTML filter's processing step.
$output = $html_filter->process($input, 'und');
// 2. Apply caption filter's processing step.
$output = $filter->process($output, 'und');
return $output->getProcessedText();
});
};
// Editor XSS filter.
$test_editor_xss_filter = function ($input) {
$dummy_filter_format = FilterFormat::create();
return Standard::filterXss($input, $dummy_filter_format);
};
// All the tricky cases encountered at https://www.drupal.org/node/2105841.
// A plain URL preceded by text.
$input = '<img data-caption="See https://www.drupal.org" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>See https://www.drupal.org</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// An anchor.
$input = '<img data-caption="This is a <a href="https://www.drupal.org">quick</a> test…" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>This is a <a href="https://www.drupal.org">quick</a> test…</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// A plain URL surrounded by parentheses.
$input = '<img data-caption="(https://www.drupal.org)" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>(https://www.drupal.org)</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// A source being credited.
$input = '<img data-caption="Source: Wikipedia" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Source: Wikipedia</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// A source being credited, without a space after the colon.
$input = '<img data-caption="Source:Wikipedia" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Source:Wikipedia</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// A pretty crazy edge case where we have two colons.
$input = '<img data-caption="Interesting (Scope resolution operator ::)" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Interesting (Scope resolution operator ::)</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$this->assertSame($input, $test_editor_xss_filter($input));
// An evil anchor (to ensure XSS filtering is applied to the caption also).
$input = '<img data-caption="This is an <a href="javascript:alert();">evil</a> test…" src="llama.jpg">';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>This is an <a href="alert();">evil</a> test…</figcaption>
</figure>
';
$this->assertSame($expected, $test_with_html_filter($input));
$expected_xss_filtered = '<img data-caption="This is an <a href="alert();">evil</a> test…" src="llama.jpg">';
$this->assertSame($expected_xss_filtered, $test_editor_xss_filter($input));
}
/**
* Tests the combination of the align and caption filters.
*/
public function testAlignAndCaptionFilters() : void {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$align_filter = $this->filters['filter_align'];
$caption_filter = $this->filters['filter_caption'];
$test = function ($input) use ($align_filter, $caption_filter, $renderer) {
return $renderer->executeInRenderContext(new RenderContext(), function () use ($input, $align_filter, $caption_filter) {
return $caption_filter->process($align_filter->process($input, 'und'), 'und');
});
};
$attached_library = [
'library' => [
'filter/caption',
],
];
// Both data-caption and data-align attributes: all 3 allowed values for the
// data-align attribute.
$input = '<img src="llama.jpg" data-caption="Loquacious llama!" data-align="left" />';
$expected = '<figure role="group" class="align-left">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
$input = '<img src="llama.jpg" data-caption="Loquacious llama!" data-align="center" />';
$expected = '<figure role="group" class="align-center">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
$input = '<img src="llama.jpg" data-caption="Loquacious llama!" data-align="right" />';
$expected = '<figure role="group" class="align-right">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Both data-caption and data-align attributes, but a disallowed data-align
// attribute value.
$input = '<img src="llama.jpg" data-caption="Loquacious llama!" data-align="left foobar" />';
$expected = '<figure role="group">
<img src="llama.jpg">
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
// Ensure both filters together work for linked images.
$input = '<a href="http://example.com/llamas/are/awesome/but/kittens/are/cool/too"><img src="llama.jpg" data-caption="Loquacious llama!" data-align="center" /></a>';
$expected = '<figure role="group" class="align-center">
<a href="http://example.com/llamas/are/awesome/but/kittens/are/cool/too"><img src="llama.jpg"></a>
<figcaption>Loquacious llama!</figcaption>
</figure>
';
$output = $test($input);
$this->assertSame($expected, $output->getProcessedText());
$this->assertSame($attached_library, $output->getAttachments());
}
/**
* Tests the line break filter.
*/
public function testLineBreakFilter() : void {
// Get FilterAutoP object.
$filter = $this->filters['filter_autop'];
// Since the line break filter naturally needs plenty of newlines in test
// strings and expectations, we're using "\n" instead of regular newlines
// here.
// cSpell:disable
$tests = [
// Single line breaks should be changed to <br /> tags, while paragraphs
// separated with double line breaks should be enclosed with <p></p> tags.
"aaa\nbbb\n\nccc" => [
"<p>aaa<br />\nbbb</p>\n<p>ccc</p>" => TRUE,
],
// Skip contents of certain block tags entirely.
"<script>aaa\nbbb\n\nccc</script>\n <style>aaa\nbbb\n\nccc</style>\n <pre>aaa\nbbb\n\nccc</pre>\n <object>aaa\nbbb\n\nccc</object>\n <iframe>aaa\nbbb\n\nccc</iframe>\n <svg>aaa\nbbb\n\nccc</svg>" => [
"<script>aaa\nbbb\n\nccc</script>" => TRUE,
"<style>aaa\nbbb\n\nccc</style>" => TRUE,
"<pre>aaa\nbbb\n\nccc</pre>" => TRUE,
"<object>aaa\nbbb\n\nccc</object>" => TRUE,
"<iframe>aaa\nbbb\n\nccc</iframe>" => TRUE,
"<svg>aaa\nbbb\n\nccc</svg>" => TRUE,
],
// Skip comments entirely.
"One. <!-- comment --> Two.\n<!--\nThree.\n-->\n" => [
'<!-- comment -->' => TRUE,
"<!--\nThree.\n-->" => TRUE,
],
// Do not add paragraph tags around Twig theme debugging.
"<p>Text here\n<!-- THEME DEBUG -->\n<!-- THEME HOOK: 'html' -->\n<!-- FILE NAME SUGGESTIONS:\n* html--node.html.twig\nx html.html.twig\n-->\n<!-- BEGIN OUTPUT from 'core/themes/olivero/templates/layout/html.html.twig' -->\n<span>Test</span></p>" => [
"<p>Text here" => TRUE,
"<p>Text here</p>" => FALSE,
"<span>Test</span></p>" => TRUE,
"<p><span>Test</span></p>" => FALSE,
],
// Do not add paragraph tags around custom template Twig theme debugging.
"<p>Text here\n<!-- THEME DEBUG -->\n<!-- THEME HOOK: 'html' -->\n<!-- FILE NAME SUGGESTIONS:\n* html--node.html.twig\nx html.html.twig\n-->\n<!-- 💡 BEGIN CUSTOM TEMPLATE OUTPUT from 'custom/themes/custom-theme/templates/layout/html.html.twig' -->\n<span>Test</span></p>" => [
"<p>Text here" => TRUE,
"<p>Text here</p>" => FALSE,
"<span>Test</span></p>" => TRUE,
"<p><span>Test</span></p>" => FALSE,
],
// Resulting HTML should produce matching paragraph tags.
'<p><div> </div></p>' => [
"<p>\n<div> </div>\n</p>" => TRUE,
],
'<div><p> </p></div>' => [
"<div>\n</div>" => TRUE,
],
'<blockquote><pre>aaa</pre></blockquote>' => [
"<blockquote><pre>aaa</pre></blockquote>" => TRUE,
],
"<pre>aaa\nbbb\nccc</pre>\nddd\neee" => [
"<pre>aaa\nbbb\nccc</pre>" => TRUE,
"<p>ddd<br />\neee</p>" => TRUE,
],
// Comments remain unchanged and subsequent lines/paragraphs are
// transformed normally.
"aaa<!--comment-->\n\nbbb\n\nccc\n\nddd<!--comment\nwith linebreak-->\n\neee\n\nfff" => [
"<p>aaa</p>\n<!--comment--><p>\nbbb</p>\n<p>ccc</p>\n<p>ddd</p>" => TRUE,
"<!--comment\nwith linebreak--><p>\neee</p>\n<p>fff</p>" => TRUE,
],
// Check that a comment in a PRE will result that the text after
// the comment, but still in PRE, is not transformed.
"<pre>aaa\nbbb<!-- comment -->\n\nccc</pre>\nddd" => [
"<pre>aaa\nbbb<!-- comment -->\n\nccc</pre>" => TRUE,
],
// Bug 810824, paragraphs were appearing around iframe tags.
"<iframe>aaa</iframe>\n\n" => [
"<p><iframe>aaa</iframe></p>" => FALSE,
],
// Bug 3097338, paragraphs were appearing around drupalmedia tags.
'<drupal-media data-caption=" " data-entity-type="media" data-entity-uuid="dbb16f97-cd11-4357-acde-cd09e19e312b"></drupal-media>' => [
'<p><drupal-media data-caption=" " data-entity-type="media" data-entity-uuid="dbb16f97-cd11-4357-acde-cd09e19e312b"></drupal-media></p>' => FALSE,
],
];
// cSpell:enable
$this->assertFilteredString($filter, $tests);
// Very long string hitting PCRE limits.
$limit = max((int) ini_get('pcre.backtrack_limit'), (int) ini_get('pcre.recursion_limit'));
$source = $this->randomMachineName($limit);
$result = _filter_autop($source);
$this->assertEquals($result, '<p>' . $source . "</p>\n", 'Line break filter can process very long strings.');
}
/**
* Tests that the line break filter does not apply to twig debug.
*/
public function testLineBreakFilterTwigDebug() : void {
// Enable twig theme debug to ensure that any
// changes to theme debugging format force checking
// that the auto paragraph filter continues to be applied
// correctly.
$twig = \Drupal::service('twig');
$twig->enableDebug();
// Manually render a template in its simplest form.
$variables = [
'theme_hook_original' => 'container',
'directory' => '',
'children' => 'Test two',
];
include_once $this->root . '/core/themes/engines/twig/twig.engine';
$render = (string) twig_render_template('container.html.twig', $variables);
$render = trim($render);
// Render text before applying the auto paragraph filter.
$this->assertSame("<!-- THEME DEBUG -->\n<!-- THEME HOOK: 'container' -->\n<!-- 💡 BEGIN CUSTOM TEMPLATE OUTPUT from 'container.html.twig' -->\n<div>Test two</div>\n\n<!-- END CUSTOM TEMPLATE OUTPUT from 'container.html.twig' -->", $render);
$result = _filter_autop($render);
// After auto-p is applied, the theme debug should no longer have
// line breaks but the true line breaks should still.
$this->assertSame("<!-- THEME DEBUG --><!-- THEME HOOK: 'container' --><!-- 💡 BEGIN CUSTOM TEMPLATE OUTPUT from 'container.html.twig' --><div>Test two</div>\n\n<!-- END CUSTOM TEMPLATE OUTPUT from 'container.html.twig' -->", $result);
}
/**
* Tests filter settings, defaults, access restrictions and similar.
*
* @todo This is for functions like filter_filter and check_markup, whose
* functionality is not completely focused on filtering. Some ideas:
* restricting formats according to user permissions, proper cache
* handling, defaults -- allowed tags/attributes/protocols.
*
* @todo It is possible to add script, iframe etc. to allowed tags, but this
* makes HTML filter completely ineffective.
*
* @todo Class, id, name and xmlns should be added to the list of forbidden
* attributes, or, better yet, use an allowed attribute list.
*/
public function testHtmlFilter() : void {
// Get FilterHtml object.
$filter = $this->filters['filter_html'];
$filter->setConfiguration([
'settings' => [
'allowed_html' => '<a> <p> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd> <br>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
]);
// HTML filter is not able to secure some tags, these should never be
// allowed.
$f = (string) $filter->process('<script />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove script tags.');
$f = (string) $filter->process('<iframe />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove iframe tags.');
$f = (string) $filter->process('<object />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove object tags.');
$f = (string) $filter->process('<style />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove style tags.');
// Some tags make CSRF attacks easier, let the user take the risk herself.
$f = (string) $filter->process('<img />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove img tags by default.');
$f = (string) $filter->process('<input />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('', $f, 'HTML filter should remove input tags by default.');
// Filtering content of some attributes is infeasible, these shouldn't be
// allowed too.
$f = (string) $filter->process('<p style="display: none;" />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNoNormalized($f, 'style', 'HTML filter should remove style attributes.');
$this->assertSame('<p></p>', $f);
$f = (string) $filter->process('<p onerror="alert(0);"></p>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNoNormalized($f, 'onerror', 'HTML filter should remove on* attributes.');
$this->assertSame('<p></p>', $f);
$f = (string) $filter->process('<code onerror> </code>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNoNormalized($f, 'onerror', 'HTML filter should remove empty on* attributes.');
$this->assertSame('<code> </code>', $f);
$f = (string) $filter->process('<br>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<br>', 'HTML filter should allow line breaks.');
$f = (string) $filter->process('<br />', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<br>', 'HTML filter should allow self-closing line breaks.');
// All attributes of allowed tags are stripped by default.
$f = (string) $filter->process('<a kitten="cute" llama="awesome">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<a>link</a>', 'HTML filter should remove attributes that are not explicitly allowed.');
// Now allow the "llama" attribute on <a>.
$filter->setConfiguration([
'settings' => [
'allowed_html' => '<a href llama> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd> <br>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
]);
$f = (string) $filter->process('<a kitten="cute" llama="awesome">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<a llama="awesome">link</a>', 'HTML filter keeps explicitly allowed attributes, and removes attributes that are not explicitly allowed.');
// Restrict the allowed "llama" attribute on <a> to only allow the value
// "majestical", or "epic".
$filter->setConfiguration([
'settings' => [
'allowed_html' => '<a href llama="majestical epic"> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd> <br>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
]);
$f = (string) $filter->process('<a kitten="cute" llama="awesome">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('<a>link</a>', $f, 'HTML filter removes allowed attributes that do not have an explicitly allowed value.');
$f = (string) $filter->process('<a kitten="cute" llama="majestical">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('<a llama="majestical">link</a>', $f, 'HTML filter keeps explicitly allowed attributes with an attribute value that is also explicitly allowed.');
$f = (string) $filter->process('<a kitten="cute" llama="awesome">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<a>link</a>', 'HTML filter removes allowed attributes that have a not explicitly allowed value.');
$f = (string) $filter->process('<a href="/beautiful-animals" kitten="cute" llama="epic majestical">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertSame('<a href="/beautiful-animals" llama="epic majestical">link</a>', $f, 'HTML filter keeps explicitly allowed attributes with an attribute value that is also explicitly allowed.');
// Allow iframes and check that the subsequent tags are parsed correctly.
$filter->setConfiguration([
'settings' => [
'allowed_html' => '<iframe> <a href llama>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
]);
$f = (string) $filter->process('<a kitten="cute" llama="awesome">link</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, '<a llama="awesome">link</a>');
}
/**
* Tests the spam deterrent.
*/
public function testNoFollowFilter() : void {
// Get FilterHtml object.
$filter = $this->filters['filter_html'];
$filter->setConfiguration([
'settings' => [
'allowed_html' => '<a href>',
'filter_html_help' => 1,
'filter_html_nofollow' => 1,
],
]);
// Test if the rel="nofollow" attribute is added, even if we try to prevent
// it.
$f = (string) $filter->process('<a href="http://www.example.com/">text</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, 'rel="nofollow"', 'Spam deterrent -- no evasion.');
$f = (string) $filter->process('<A href="http://www.example.com/">text</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, 'rel="nofollow"', 'Spam deterrent evasion -- capital A.');
$f = (string) $filter->process("<a/href=\"http://www.example.com/\">text</a>", Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, 'rel="nofollow"', 'Spam deterrent evasion -- non whitespace character after tag name.');
$f = (string) $filter->process("<\x00a\x00 href=\"http://www.example.com/\">text</a>", Language::LANGCODE_NOT_SPECIFIED);
$this->assertNormalized($f, 'rel="nofollow"', 'Spam deterrent evasion -- some nulls.');
$f = (string) $filter->process('<a href="http://www.example.com/" rel="follow">text</a>', Language::LANGCODE_NOT_SPECIFIED);
$this->assertNoNormalized($f, 'rel="follow"', 'Spam deterrent evasion -- with rel set - rel="follow" removed.');
$this->assertNormalized($f, 'rel="nofollow"', 'Spam deterrent evasion -- with rel set - rel="nofollow" added.');
}
/**
* Tests the HTML escaping filter.
*/
public function testHtmlEscapeFilter() : void {
// Get FilterHtmlEscape object.
$filter = $this->filters['filter_html_escape'];
$tests = [
" One. <!-- \"comment\" --> Two'.\n<p>Three.</p>\n " => [
"One. <!-- "comment" --> Two'.\n<p>Three.</p>" => TRUE,
' One.' => FALSE,
"</p>\n " => FALSE,
],
];
$this->assertFilteredString($filter, $tests);
}
/**
* Tests the URL filter.
*/
public function testUrlFilter() : void {
// Get FilterUrl object.
$filter = $this->filters['filter_url'];
$filter->setConfiguration([
'settings' => [
'filter_url_length' => 496,
],
]);
// @todo Possible categories:
// - absolute, mail, partial
// - characters/encoding, surrounding markup, security
// Create an email that is too long.
$long_email = str_repeat('a', 254) . '@example.com';
$too_long_email = str_repeat('b', 255) . '@example.com';
$email_with_plus_sign = 'one+two@example.com';
// Filter selection/pattern matching.
$tests = [
// HTTP URLs.
'http://example.com or www.example.com' => [
'<a href="http://example.com">http://example.com</a>' => TRUE,
'<a href="http://www.example.com">www.example.com</a>' => TRUE,
],
// MAILTO URLs.
'person@example.com or mailto:person2@example.com or ' . $email_with_plus_sign . ' or ' . $long_email . ' but not ' . $too_long_email => [
'<a href="mailto:person@example.com">person@example.com</a>' => TRUE,
'<a href="mailto:person2@example.com">mailto:person2@example.com</a>' => TRUE,
'<a href="mailto:' . $long_email . '">' . $long_email . '</a>' => TRUE,
'<a href="mailto:' . $too_long_email . '">' . $too_long_email . '</a>' => FALSE,
'<a href="mailto:' . $email_with_plus_sign . '">' . $email_with_plus_sign . '</a>' => TRUE,
],
// URI parts and special characters.
'http://trailingslash.com/ or www.trailingslash.com/
http://host.com/some/path?query=foo&bar[baz]=beer#fragment or www.host.com/some/path?query=foo&bar[baz]=beer#fragment
http://twitter.com/#!/example/status/22376963142324226
http://example.com/@user/
ftp://user:pass@ftp.example.com/~home/dir1
sftp://user@nonstandardport:222/dir
ssh://192.168.0.100/srv/git/drupal.git' => [
'<a href="http://trailingslash.com/">http://trailingslash.com/</a>' => TRUE,
'<a href="http://www.trailingslash.com/">www.trailingslash.com/</a>' => TRUE,
'<a href="http://host.com/some/path?query=foo&bar[baz]=beer#fragment">http://host.com/some/path?query=foo&bar[baz]=beer#fragment</a>' => TRUE,
'<a href="http://www.host.com/some/path?query=foo&bar[baz]=beer#fragment">www.host.com/some/path?query=foo&bar[baz]=beer#fragment</a>' => TRUE,
'<a href="http://twitter.com/#!/example/status/22376963142324226">http://twitter.com/#!/example/status/22376963142324226</a>' => TRUE,
'<a href="http://example.com/@user/">http://example.com/@user/</a>' => TRUE,
'<a href="ftp://user:pass@ftp.example.com/~home/dir1">ftp://user:pass@ftp.example.com/~home/dir1</a>' => TRUE,
'<a href="sftp://user@nonstandardport:222/dir">sftp://user@nonstandardport:222/dir</a>' => TRUE,
'<a href="ssh://192.168.0.100/srv/git/drupal.git">ssh://192.168.0.100/srv/git/drupal.git</a>' => TRUE,
],
// International Unicode characters.
'http://пример.испытание/
http://مثال.إختبار/
http://例子.測試/
http://12345.中国/
http://例え.テスト/
http://dréißig-bücher.de/
http://méxico-mañana.es/' => [
'<a href="http://пример.испытание/">http://пример.испытание/</a>' => TRUE,
'<a href="http://مثال.إختبار/">http://مثال.إختبار/</a>' => TRUE,
'<a href="http://例子.測試/">http://例子.測試/</a>' => TRUE,
'<a href="http://12345.中国/">http://12345.中国/</a>' => TRUE,
'<a href="http://例え.テスト/">http://例え.テスト/</a>' => TRUE,
'<a href="http://dréißig-bücher.de/">http://dréißig-bücher.de/</a>' => TRUE,
'<a href="http://méxico-mañana.es/">http://méxico-mañana.es/</a>' => TRUE,
],
// Encoding.
'http://ampersand.com/?a=1&b=2
http://encoded.com/?a=1&b=2' => [
'<a href="http://ampersand.com/?a=1&b=2">http://ampersand.com/?a=1&b=2</a>' => TRUE,
'<a href="http://encoded.com/?a=1&b=2">http://encoded.com/?a=1&b=2</a>' => TRUE,
],
// Domain name length.
'www.ex.ex or www.example.example or www.toolongdomainexampledomainexampledomainexampledomainexampledomain or
me@me.tv' => [
'<a href="http://www.ex.ex">www.ex.ex</a>' => TRUE,
'<a href="http://www.example.example">www.example.example</a>' => TRUE,
'http://www.toolong' => FALSE,
'<a href="mailto:me@me.tv">me@me.tv</a>' => TRUE,
],
// Absolute URL protocols.
// The list to test is found in the beginning of _filter_url() at
// $protocols = \Drupal::getContainer()->getParameter('filter_protocols').
'https://example.com,
ftp://ftp.example.com,
news://example.net,
telnet://example,
irc://example.host,
ssh://odd.geek,
sftp://secure.host?,
webcal://calendar,
rtsp://127.0.0.1,
not foo://disallowed.com.
' => [
'href="https://example.com"' => TRUE,
'href="ftp://ftp.example.com"' => TRUE,
'href="news://example.net"' => TRUE,
'href="telnet://example"' => TRUE,
'href="irc://example.host"' => TRUE,
'href="ssh://odd.geek"' => TRUE,
'href="sftp://secure.host"' => TRUE,
'href="webcal://calendar"' => TRUE,
'href="rtsp://127.0.0.1"' => TRUE,
'href="foo://disallowed.com"' => FALSE,
'not foo://disallowed.com.' => TRUE,
],
];
$this->assertFilteredString($filter, $tests);
// Surrounding text/punctuation.
$tests = [
'Partial URL with trailing period www.partial.com.
Email with trailing comma person@example.com,
Absolute URL with trailing question http://www.absolute.com?
Query string with trailing exclamation www.query.com/index.php?a=!
Partial URL with 3 trailing www.partial.periods...
Email with 3 trailing exclamations@example.com!!!
Absolute URL and query string with 2 different punctuation characters (http://www.example.com/q=abc).
Partial URL with brackets in the URL as well as surrounded brackets (www.foo.com/more_(than)_one_(parens)).
Absolute URL with square brackets in the URL as well as surrounded brackets [https://www.drupal.org/?class[]=1]
Absolute URL with quotes "https://www.example.org/sample"' => [
'period <a href="http://www.partial.com">www.partial.com</a>.' => TRUE,
'comma <a href="mailto:person@example.com">person@example.com</a>,' => TRUE,
'question <a href="http://www.absolute.com">http://www.absolute.com</a>?' => TRUE,
'exclamation <a href="http://www.query.com/index.php?a=">www.query.com/index.php?a=</a>!' => TRUE,
'trailing <a href="http://www.partial.periods">www.partial.periods</a>...' => TRUE,
'trailing <a href="mailto:exclamations@example.com">exclamations@example.com</a>!!!' => TRUE,
'characters (<a href="http://www.example.com/q=abc">http://www.example.com/q=abc</a>).' => TRUE,
'brackets (<a href="http://www.foo.com/more_(than)_one_(parens)">www.foo.com/more_(than)_one_(parens)</a>).' => TRUE,
'brackets [<a href="https://www.drupal.org/?class[]=1">https://www.drupal.org/?class[]=1</a>]' => TRUE,
'quotes "<a href="https://www.example.org/sample">https://www.example.org/sample</a>"' => TRUE,
],
'(www.parenthesis.com/dir?a=1&b=2#a)' => [
'(<a href="http://www.parenthesis.com/dir?a=1&b=2#a">www.parenthesis.com/dir?a=1&b=2#a</a>)' => TRUE,
],
];
$this->assertFilteredString($filter, $tests);
// Surrounding markup.
$tests = [
'<p xmlns="www.namespace.com" />
<p xmlns="http://namespace.com">
An <a href="http://example.com" title="Read more at www.example.info...">anchor</a>.
</p>' => [
'<p xmlns="www.namespace.com" />' => TRUE,
'<p xmlns="http://namespace.com">' => TRUE,
'href="http://www.namespace.com"' => FALSE,
'href="http://namespace.com"' => FALSE,
'An <a href="http://example.com" title="Read more at www.example.info...">anchor</a>.' => TRUE,
],
'Not <a href="foo">www.relative.com</a> or <a href="http://absolute.com">www.absolute.com</a>
but <strong>http://www.strong.net</strong> or <em>www.emphasis.info</em>' => [
'<a href="foo">www.relative.com</a>' => TRUE,
'href="http://www.relative.com"' => FALSE,
'<a href="http://absolute.com">www.absolute.com</a>' => TRUE,
'<strong><a href="http://www.strong.net">http://www.strong.net</a></strong>' => TRUE,
'<em><a href="http://www.emphasis.info">www.emphasis.info</a></em>' => TRUE,
],
'Test <code>using www.example.com the code tag</code>.
' => [
'href' => FALSE,
'http' => FALSE,
],
'Intro.
<blockquote>
Quoted text linking to www.example.com, written by person@example.com, originating from http://origin.example.com. <code>@see www.usage.example.com or <em>www.example.info</em> bla bla</code>.
</blockquote>
Outro.
' => [
'href="http://www.example.com"' => TRUE,
'href="mailto:person@example.com"' => TRUE,
'href="http://origin.example.com"' => TRUE,
'http://www.usage.example.com' => FALSE,
'http://www.example.info' => FALSE,
'Intro.' => TRUE,
'Outro.' => TRUE,
],
'Unknown tag <x>containing x and www.example.com</x>? And a tag <pooh>beginning with p and containing www.example.pooh with p?</pooh>
' => [
'href="http://www.example.com"' => TRUE,
'href="http://www.example.pooh"' => TRUE,
],
'<p>Test <br/>: This is a www.example17.com example <strong>with</strong> various http://www.example18.com tags. *<br/>
It is important www.example19.com to *<br/>test different URLs and http://www.example20.com in the same paragraph. *<br>
HTML www.example21.com soup by person@example22.com can literally http://www.example23.com contain *img*<img> anything. Just a www.example24.com with http://www.example25.com thrown in. www.example26.com from person@example27.com with extra http://www.example28.com.
' => [
'href="http://www.example17.com"' => TRUE,
'href="http://www.example18.com"' => TRUE,
'href="http://www.example19.com"' => TRUE,
'href="http://www.example20.com"' => TRUE,
'href="http://www.example21.com"' => TRUE,
'href="mailto:person@example22.com"' => TRUE,
'href="http://www.example23.com"' => TRUE,
'href="http://www.example24.com"' => TRUE,
'href="http://www.example25.com"' => TRUE,
'href="http://www.example26.com"' => TRUE,
'href="mailto:person@example27.com"' => TRUE,
'href="http://www.example28.com"' => TRUE,
],
'<script>
<!--
// @see www.example.com
var exampleurl = "http://example.net";
-->
<!--//--><![CDATA[//><!--
// @see www.example.com
var exampleurl = "http://example.net";
//--><!]]>
</script>' => [
'href="http://www.example.com"' => FALSE,
'href="http://example.net"' => FALSE,
],
'<style>body {
background: url(http://example.com/pixel.gif);
}</style>' => [
'href' => FALSE,
],
'<!-- Skip any URLs like www.example.com in comments -->' => [
'href' => FALSE,
],
'<!-- Skip any URLs like
www.example.com with a newline in comments -->' => [
'href' => FALSE,
],
'<!-- Skip any URLs like www.comment.com in comments. <p>Also ignore http://commented.out/markup.</p> -->' => [
'href' => FALSE,
],
'<dl>
<dt>www.example.com</dt>
<dd>http://example.com</dd>
<dd>person@example.com</dd>
<dt>Check www.example.net</dt>
<dd>Some text around http://www.example.info by person@example.info?</dd>
</dl>' => [
'href="http://www.example.com"' => TRUE,
'href="http://example.com"' => TRUE,
'href="mailto:person@example.com"' => TRUE,
'href="http://www.example.net"' => TRUE,
'href="http://www.example.info"' => TRUE,
'href="mailto:person@example.info"' => TRUE,
],
'<div>www.div.com</div>
<ul>
<li>http://listitem.com</li>
<li class="odd">www.class.listitem.com</li>
</ul>' => [
'<div><a href="http://www.div.com">www.div.com</a></div>' => TRUE,
'<li><a href="http://listitem.com">http://listitem.com</a></li>' => TRUE,
'<li class="odd"><a href="http://www.class.listitem.com">www.class.listitem.com</a></li>' => TRUE,
],
];
$this->assertFilteredString($filter, $tests);
// URL trimming.
$filter->setConfiguration([
'settings' => [
'filter_url_length' => 20,
],
]);
$tests = [
'www.trimmed.com/d/ff.ext?a=1&b=2#a1' => [
'<a href="http://www.trimmed.com/d/ff.ext?a=1&b=2#a1">www.trimmed.com/d/f…</a>' => TRUE,
],
];
$this->assertFilteredString($filter, $tests);
}
/**
* Asserts multiple filter output expectations for multiple input strings.
*
* @param \Drupal\filter\Plugin\FilterInterface $filter
* An input filter object.
* @param array $tests
* An associative array, whereas each key is an arbitrary input string and
* each value is again an associative array whose keys are filter output
* strings and whose values are Booleans indicating whether the output is
* expected or not. For example:
* @code
* $tests = [
* 'Input string' => [
* '<p>Input string</p>' => TRUE,
* 'Input string<br' => FALSE,
* ],
* ];
* @endcode
*
* @internal
*/
public function assertFilteredString(FilterInterface $filter, array $tests) : void {
foreach ($tests as $source => $tasks) {
$result = $filter->process($source, $filter)
->getProcessedText();
foreach ($tasks as $value => $is_expected) {
if ($is_expected) {
$this->assertStringContainsString($value, $result, sprintf('%s: %s found. Filtered result: %s.', var_export($source, TRUE), var_export($value, TRUE), var_export($result, TRUE)));
}
else {
$this->assertStringNotContainsString($value, $result, sprintf('%s: %s not found. Filtered result: %s.', var_export($source, TRUE), var_export($value, TRUE), var_export($result, TRUE)));
}
}
}
}
/**
* Tests URL filter on longer content.
*
* Filters based on regular expressions should also be tested with a more
* complex content than just isolated test lines.
* The most common errors are:
* - accidental '*' (greedy) match instead of '*?' (minimal) match.
* - only matching first occurrence instead of all.
* - newlines not matching '.*'.
*
* This test covers:
* - Document with multiple newlines and paragraphs (two newlines).
* - Mix of several HTML tags, invalid non-HTML tags, tags to ignore and HTML
* comments.
* - Empty HTML tags (BR, IMG).
* - Mix of absolute and partial URLs, and email addresses in one content.
* - Input that exceeds PCRE backtracking limit.
*/
public function testUrlFilterContent() : void {
// Get FilterUrl object.
$filter = $this->filters['filter_url'];
$filter->setConfiguration([
'settings' => [
'filter_url_length' => 496,
],
]);
$path = __DIR__ . '/../..';
$input = file_get_contents($path . '/filter.url-input.txt');
$expected = file_get_contents($path . '/filter.url-output.txt');
$result = _filter_url($input, $filter);
$this->assertSame($expected, $result, 'Complex HTML document was correctly processed.');
$pcre_backtrack_limit = ini_get('pcre.backtrack_limit');
// Setting this limit to the smallest possible value should cause PCRE
// errors and break the various preg_* functions used by _filter_url().
ini_set('pcre.backtrack_limit', 1);
// If PCRE errors occur, _filter_url() should return the exact same text.
// Case of a small and simple HTML document.
$input = $expected = '<p>www.test.com</p>';
$result = _filter_url($input, $filter);
$this->assertSame($expected, $result, 'Simple HTML document was left intact when PCRE errors occurred.');
// Case of a complex HTML document.
$input = $expected = file_get_contents($path . '/filter.url-input.txt');
$result = _filter_url($input, $filter);
$this->assertSame($expected, $result, 'Complex HTML document was left intact when PCRE errors occurred.');
// Setting limit back to default.
ini_set('pcre.backtrack_limit', $pcre_backtrack_limit);
}
/**
* Tests the HTML corrector filter.
*
* @todo This test could really use some validity checking function.
*/
public function testHtmlCorrectorFilter() : void {
// Tag closing.
$f = Html::normalize('<p>text');
$this->assertEquals('<p>text</p>', $f, 'HTML corrector -- tag closing at the end of input.');
$f = Html::normalize('<p>text <img alt="ao');
$this->assertEquals('<p>text <img alt="ao"></p>', $f, 'HTML corrector -- tag closing at the end of input + broken attribute.');
$f = Html::normalize('<p>text<p><p>text');
$this->assertEquals('<p>text</p><p></p><p>text</p>', $f, 'HTML corrector -- tag closing.');
$f = Html::normalize("<ul><li>e1<li>e2");
$this->assertEquals("<ul><li>e1</li><li>e2</li></ul>", $f, 'HTML corrector -- unclosed list tags.');
$f = Html::normalize('<div id="d">content');
$this->assertEquals('<div id="d">content</div>', $f, 'HTML corrector -- unclosed tag with attribute.');
$f = Html::normalize('<hr><br>');
$this->assertEquals('<hr><br>', $f, 'HTML corrector -- void element.');
$f = Html::normalize('<P>test</P>');
$this->assertEquals('<p>test</p>', $f, 'HTML corrector -- Convert upper cased tags to proper lowercased ones.');
$f = Html::normalize('<P>test</p>');
$this->assertEquals('<p>test</p>', $f, 'HTML corrector -- Convert upper cased tags to proper lowercased ones.');
$f = Html::normalize('test<hr />');
$this->assertEquals('test<hr>', $f, 'HTML corrector -- convert self-closing element to HTML5 void element.');
$f = Html::normalize('test<hr/>');
$this->assertEquals('test<hr>', $f, 'HTML corrector -- convert self-closing element to HTML5 void element.');
$f = Html::normalize('test<hr />');
$this->assertEquals('test<hr>', $f, 'HTML corrector -- convert self-closing element with multiple spaces to HTML5 void element.');
$f = Html::normalize('<span class="test" />');
$this->assertEquals('<span class="test"></span>', $f, 'HTML corrector -- Convert XHTML that is properly formed but that would not be compatible with typical HTML user agents.');
$f = Html::normalize('test1<br class="test">test2');
$this->assertEquals('test1<br class="test">test2', $f, 'HTML corrector -- Keep self-closing tags.');
$f = Html::normalize('line1<hr>line2');
$this->assertEquals('line1<hr>line2', $f, 'HTML corrector -- Keep self-closing tags.');
$f = Html::normalize('line1<HR>line2');
$this->assertEquals('line1<hr>line2', $f, 'HTML corrector -- Keep self-closing tags.');
$f = Html::normalize('<img src="http://example.com/test.jpg">test</img>');
$this->assertEquals('<img src="http://example.com/test.jpg">test', $f, 'HTML corrector -- Fix self-closing single tags.');
$f = Html::normalize('<br></br>');
$this->assertEquals('<br><br>', $f, "HTML corrector -- Transform empty tags to a self-closed tag if the tag's content model is EMPTY.");
$f = Html::normalize('<div></div>');
$this->assertEquals('<div></div>', $f, "HTML corrector -- Do not transform empty tags to a single closed tag if the tag's content model is not EMPTY.");
$f = Html::normalize('<p>line1<br/><hr/>line2</p>');
$this->assertEquals('<p>line1<br></p><hr>line2', $f, 'HTML corrector -- Move non-inline elements outside of inline containers.');
$f = Html::normalize('<p>line1<div>line2</div></p>');
$this->assertEquals('<p>line1</p><div>line2</div>', $f, 'HTML corrector -- Move non-inline elements outside of inline containers.');
$f = Html::normalize('<p>test<p>test</p>\\n');
$this->assertEquals('<p>test</p><p>test</p>\\n', $f, 'HTML corrector -- Auto-close improperly nested tags.');
$f = Html::normalize('<p>Line1<br><STRONG>bold stuff</b>');
$this->assertEquals('<p>Line1<br><strong>bold stuff</strong></p>', $f, 'HTML corrector -- Properly close unclosed tags, and remove useless closing tags.');
$f = Html::normalize('test <!-- this is a comment -->');
$this->assertEquals('test <!-- this is a comment -->', $f, 'HTML corrector -- Do not touch HTML comments.');
$f = Html::normalize('test <!--this is a comment-->');
$this->assertEquals('test <!--this is a comment-->', $f, 'HTML corrector -- Do not touch HTML comments.');
$f = Html::normalize('test <!-- comment <p>another
<strong>multiple</strong> line
comment</p> -->');
$this->assertEquals('test <!-- comment <p>another
<strong>multiple</strong> line
comment</p> -->', $f, 'HTML corrector -- Do not touch HTML comments.');
$f = Html::normalize('test <!-- comment <p>another comment</p> -->');
$this->assertEquals('test <!-- comment <p>another comment</p> -->', $f, 'HTML corrector -- Do not touch HTML comments.');
$f = Html::normalize('test <!--break-->');
$this->assertEquals('test <!--break-->', $f, 'HTML corrector -- Do not touch HTML comments.');
$f = Html::normalize('<p>test\\n</p>\\n');
$this->assertEquals('<p>test\\n</p>\\n', $f, 'HTML corrector -- New-lines are accepted and kept as-is.');
// cSpell:disable
$f = Html::normalize('<p>دروبال');
$this->assertEquals('<p>دروبال</p>', $f, 'HTML corrector -- Encoding is correctly kept.');
// cSpell:enable
$html = '<script>alert("test")</script>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- script element');
$html = '<p><script>alert("test")</script></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- nested script element');
$html = '<p><style> /* Styling */ body {color:red}</style></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- style element.');
$html = '<p><style>
/*<![CDATA[*/
/* Styling */
body {color:red}
/*]]>*/
</style></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- Existing cdata section /*<![CDATA[*/ properly escaped');
$html = '<p><style>
/*<![CDATA[*/
/* Styling */
body {color:red}
/*]]>*/
</style></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- Existing cdata section <!--/*--><![CDATA[/* ><!--*/ properly escaped');
$html = '<p><script>
//<![CDATA[
alert("test");
//]]>
</script></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- Existing cdata section <!--//--><![CDATA[// ><!-- properly escaped');
$html = '<p><script>
// <![CDATA[
alert("test");
//]]>
</script></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- Existing cdata section // <![CDATA[ properly escaped');
$html = '<p><script>
// <![CDATA[![CDATA[![CDATA[
alert("test");
//]]]]]]>
</script></p>';
$this->assertEquals($html, Html::normalize($html), 'HTML corrector -- Existing cdata section // <![CDATA[![CDATA[![CDATA[ properly escaped');
// Test calling Html::normalize() twice.
$html = '<p><script>
// <![CDATA[![CDATA[![CDATA[
alert("test");
//]]]]]]>
</script></p>';
$this->assertEquals($html, Html::normalize(Html::normalize($html)), 'HTML corrector -- Existing cdata section // <![CDATA[![CDATA[![CDATA[ properly escaped');
}
/**
* Asserts that a text transformed to lowercase with HTML entities decoded does contains a given string.
*
* Otherwise fails the test with a given message, similar to all the
* PHPUnit assert* functions.
*
* Note that this does not remove nulls, new lines and other characters that
* could be used to obscure a tag or an attribute name.
*
* @param string $haystack
* Text to look in.
* @param string $needle
* Lowercase, plain text to look for.
* @param string $message
* (optional) Message to display if failed. Defaults to an empty string.
*
* @internal
*/
public function assertNormalized(string $haystack, string $needle, string $message = '') : void {
$this->assertStringContainsString($needle, strtolower(Html::decodeEntities($haystack)), $message);
}
/**
* Asserts that text transformed to lowercase with HTML entities decoded does not contain a given string.
*
* Otherwise fails the test with a given message, similar to all the
* PHPUnit assert* functions.
*
* Note that this does not remove nulls, new lines, and other character that
* could be used to obscure a tag or an attribute name.
*
* @param string $haystack
* Text to look in.
* @param string $needle
* Lowercase, plain text to look for.
* @param string $message
* (optional) Message to display if failed. Defaults to an empty string.
*
* @internal
*/
public function assertNoNormalized(string $haystack, string $needle, string $message = '') : void {
$this->assertStringNotContainsString($needle, strtolower(Html::decodeEntities($haystack)), $message);
}
}Classes
| Title | Deprecated | Summary |
|---|---|---|
| FilterKernelTest | Tests Filter module filters individually. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.