Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\Component\Utility;
Chris@0: 
Chris@0: use Drupal\Component\Render\MarkupInterface;
Chris@0: use Drupal\Component\Render\MarkupTrait;
Chris@0: use Drupal\Component\Utility\Html;
Chris@0: use Drupal\Component\Utility\Random;
Chris@0: use PHPUnit\Framework\TestCase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests \Drupal\Component\Utility\Html.
Chris@0:  *
Chris@0:  * @group Common
Chris@0:  *
Chris@0:  * @coversDefaultClass \Drupal\Component\Utility\Html
Chris@0:  */
Chris@0: class HtmlTest extends TestCase {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     $property = new \ReflectionProperty('Drupal\Component\Utility\Html', 'seenIdsInit');
Chris@0:     $property->setAccessible(TRUE);
Chris@0:     $property->setValue(NULL);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the Html::cleanCssIdentifier() method.
Chris@0:    *
Chris@0:    * @param string $expected
Chris@0:    *   The expected result.
Chris@0:    * @param string $source
Chris@0:    *   The string being transformed to an ID.
Chris@0:    * @param array|null $filter
Chris@0:    *   (optional) An array of string replacements to use on the identifier. If
Chris@0:    *   NULL, no filter will be passed and a default will be used.
Chris@0:    *
Chris@0:    * @dataProvider providerTestCleanCssIdentifier
Chris@0:    *
Chris@0:    * @covers ::cleanCssIdentifier
Chris@0:    */
Chris@0:   public function testCleanCssIdentifier($expected, $source, $filter = NULL) {
Chris@0:     if ($filter !== NULL) {
Chris@0:       $this->assertSame($expected, Html::cleanCssIdentifier($source, $filter));
Chris@0:     }
Chris@0:     else {
Chris@0:       $this->assertSame($expected, Html::cleanCssIdentifier($source));
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testCleanCssIdentifier().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestCleanCssIdentifier() {
Chris@0:     $id1 = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ-0123456789';
Chris@0:     $id2 = '¡¢£¤¥';
Chris@0:     $id3 = 'css__identifier__with__double__underscores';
Chris@0:     return [
Chris@0:       // Verify that no valid ASCII characters are stripped from the identifier.
Chris@0:       [$id1, $id1, []],
Chris@0:       // Verify that valid UTF-8 characters are not stripped from the identifier.
Chris@0:       [$id2, $id2, []],
Chris@12:       // Verify that double underscores are not stripped from the identifier.
Chris@0:       [$id3, $id3],
Chris@12:       // Verify that invalid characters (including non-breaking space) are
Chris@12:       // stripped from the identifier.
Chris@0:       ['invalididentifier', 'invalid !"#$%&\'()*+,./:;<=>?@[\\]^`{|}~ identifier', []],
Chris@0:       // Verify that an identifier starting with a digit is replaced.
Chris@0:       ['_cssidentifier', '1cssidentifier', []],
Chris@0:       // Verify that an identifier starting with a hyphen followed by a digit is
Chris@0:       // replaced.
Chris@0:       ['__cssidentifier', '-1cssidentifier', []],
Chris@0:       // Verify that an identifier starting with two hyphens is replaced.
Chris@0:       ['__cssidentifier', '--cssidentifier', []],
Chris@0:       // Verify that passing double underscores as a filter is processed.
Chris@0:       ['_cssidentifier', '__cssidentifier', ['__' => '_']],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests that Html::getClass() cleans the class name properly.
Chris@0:    *
Chris@0:    * @coversDefaultClass ::getClass
Chris@0:    */
Chris@0:   public function testHtmlClass() {
Chris@0:     // Verify Drupal coding standards are enforced.
Chris@0:     $this->assertSame('class-name--ü', Html::getClass('CLASS NAME_[Ü]'), 'Enforce Drupal coding standards.');
Chris@0: 
Chris@0:     // Test Html::getClass() handles Drupal\Component\Render\MarkupInterface
Chris@0:     // input.
Chris@0:     $markup = HtmlTestMarkup::create('CLASS_FROM_OBJECT');
Chris@0:     $this->assertSame('class-from-object', Html::getClass($markup), 'Markup object is converted to CSS class.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the Html::getUniqueId() method.
Chris@0:    *
Chris@0:    * @param string $expected
Chris@0:    *   The expected result.
Chris@0:    * @param string $source
Chris@0:    *   The string being transformed to an ID.
Chris@0:    * @param bool $reset
Chris@0:    *   (optional) If TRUE, reset the list of seen IDs. Defaults to FALSE.
Chris@0:    *
Chris@0:    * @dataProvider providerTestHtmlGetUniqueId
Chris@0:    *
Chris@0:    * @covers ::getUniqueId
Chris@0:    */
Chris@0:   public function testHtmlGetUniqueId($expected, $source, $reset = FALSE) {
Chris@0:     if ($reset) {
Chris@0:       Html::resetSeenIds();
Chris@0:     }
Chris@0:     $this->assertSame($expected, Html::getUniqueId($source));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testHtmlGetId().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestHtmlGetUniqueId() {
Chris@0:     $id = 'abcdefghijklmnopqrstuvwxyz-0123456789';
Chris@0:     return [
Chris@0:       // Verify that letters, digits, and hyphens are not stripped from the ID.
Chris@0:       [$id, $id],
Chris@0:       // Verify that invalid characters are stripped from the ID.
Chris@0:       ['invalididentifier', 'invalid,./:@\\^`{Üidentifier'],
Chris@0:       // Verify Drupal coding standards are enforced.
Chris@0:       ['id-name-1', 'ID NAME_[1]'],
Chris@0:       // Verify that a repeated ID is made unique.
Chris@0:       ['test-unique-id', 'test-unique-id', TRUE],
Chris@0:       ['test-unique-id--2', 'test-unique-id'],
Chris@0:       ['test-unique-id--3', 'test-unique-id'],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the Html::getUniqueId() method.
Chris@0:    *
Chris@0:    * @param string $expected
Chris@0:    *   The expected result.
Chris@0:    * @param string $source
Chris@0:    *   The string being transformed to an ID.
Chris@0:    *
Chris@0:    * @dataProvider providerTestHtmlGetUniqueIdWithAjaxIds
Chris@0:    *
Chris@0:    * @covers ::getUniqueId
Chris@0:    */
Chris@0:   public function testHtmlGetUniqueIdWithAjaxIds($expected, $source) {
Chris@0:     Html::setIsAjax(TRUE);
Chris@0:     $id = Html::getUniqueId($source);
Chris@0: 
Chris@0:     // Note, we truncate two hyphens at the end.
Chris@0:     // @see \Drupal\Component\Utility\Html::getId()
Chris@0:     if (strpos($source, '--') !== FALSE) {
Chris@0:       $random_suffix = substr($id, strlen($source) + 1);
Chris@0:     }
Chris@0:     else {
Chris@0:       $random_suffix = substr($id, strlen($source) + 2);
Chris@0:     }
Chris@0:     $expected = $expected . $random_suffix;
Chris@0:     $this->assertSame($expected, $id);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testHtmlGetId().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestHtmlGetUniqueIdWithAjaxIds() {
Chris@0:     return [
Chris@0:       ['test-unique-id1--', 'test-unique-id1'],
Chris@0:       // Note, we truncate two hyphens at the end.
Chris@0:       // @see \Drupal\Component\Utility\Html::getId()
Chris@0:       ['test-unique-id1---', 'test-unique-id1--'],
Chris@0:       ['test-unique-id2--', 'test-unique-id2'],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the Html::getUniqueId() method.
Chris@0:    *
Chris@0:    * @param string $expected
Chris@0:    *   The expected result.
Chris@0:    * @param string $source
Chris@0:    *   The string being transformed to an ID.
Chris@0:    *
Chris@0:    * @dataProvider providerTestHtmlGetId
Chris@0:    *
Chris@0:    * @covers ::getId
Chris@0:    */
Chris@0:   public function testHtmlGetId($expected, $source) {
Chris@0:     Html::setIsAjax(FALSE);
Chris@0:     $this->assertSame($expected, Html::getId($source));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testHtmlGetId().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestHtmlGetId() {
Chris@0:     $id = 'abcdefghijklmnopqrstuvwxyz-0123456789';
Chris@0:     return [
Chris@0:       // Verify that letters, digits, and hyphens are not stripped from the ID.
Chris@0:       [$id, $id],
Chris@0:       // Verify that invalid characters are stripped from the ID.
Chris@0:       ['invalididentifier', 'invalid,./:@\\^`{Üidentifier'],
Chris@0:       // Verify Drupal coding standards are enforced.
Chris@0:       ['id-name-1', 'ID NAME_[1]'],
Chris@0:       // Verify that a repeated ID is made unique.
Chris@0:       ['test-unique-id', 'test-unique-id'],
Chris@0:       ['test-unique-id', 'test-unique-id'],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests Html::decodeEntities().
Chris@0:    *
Chris@0:    * @dataProvider providerDecodeEntities
Chris@0:    * @covers ::decodeEntities
Chris@0:    */
Chris@0:   public function testDecodeEntities($text, $expected) {
Chris@0:     $this->assertEquals($expected, Html::decodeEntities($text));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for testDecodeEntities().
Chris@0:    *
Chris@0:    * @see testDecodeEntities()
Chris@0:    */
Chris@0:   public function providerDecodeEntities() {
Chris@0:     return [
Chris@0:       ['Drupal', 'Drupal'],
Chris@0:       ['<script>', '<script>'],
Chris@0:       ['&lt;script&gt;', '<script>'],
Chris@0:       ['&#60;script&#62;', '<script>'],
Chris@0:       ['&amp;lt;script&amp;gt;', '&lt;script&gt;'],
Chris@0:       ['"', '"'],
Chris@0:       ['&#34;', '"'],
Chris@0:       ['&amp;#34;', '&#34;'],
Chris@0:       ['&quot;', '"'],
Chris@0:       ['&amp;quot;', '&quot;'],
Chris@0:       ["'", "'"],
Chris@0:       ['&#39;', "'"],
Chris@0:       ['&amp;#39;', '&#39;'],
Chris@0:       ['©', '©'],
Chris@0:       ['&copy;', '©'],
Chris@0:       ['&#169;', '©'],
Chris@0:       ['→', '→'],
Chris@0:       ['&#8594;', '→'],
Chris@0:       ['➼', '➼'],
Chris@0:       ['&#10172;', '➼'],
Chris@0:       ['&euro;', '€'],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests Html::escape().
Chris@0:    *
Chris@0:    * @dataProvider providerEscape
Chris@0:    * @covers ::escape
Chris@0:    */
Chris@0:   public function testEscape($expected, $text) {
Chris@0:     $this->assertEquals($expected, Html::escape($text));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for testEscape().
Chris@0:    *
Chris@0:    * @see testEscape()
Chris@0:    */
Chris@0:   public function providerEscape() {
Chris@0:     return [
Chris@0:       ['Drupal', 'Drupal'],
Chris@0:       ['&lt;script&gt;', '<script>'],
Chris@0:       ['&amp;lt;script&amp;gt;', '&lt;script&gt;'],
Chris@0:       ['&amp;#34;', '&#34;'],
Chris@0:       ['&quot;', '"'],
Chris@0:       ['&amp;quot;', '&quot;'],
Chris@0:       ['&#039;', "'"],
Chris@0:       ['&amp;#039;', '&#039;'],
Chris@0:       ['©', '©'],
Chris@0:       ['→', '→'],
Chris@0:       ['➼', '➼'],
Chris@0:       ['€', '€'],
Chris@0:       ['Drup�al', "Drup\x80al"],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests relationship between escaping and decoding HTML entities.
Chris@0:    *
Chris@0:    * @covers ::decodeEntities
Chris@0:    * @covers ::escape
Chris@0:    */
Chris@0:   public function testDecodeEntitiesAndEscape() {
Chris@0:     $string = "<em>répét&eacute;</em>";
Chris@0:     $escaped = Html::escape($string);
Chris@0:     $this->assertSame('&lt;em&gt;répét&amp;eacute;&lt;/em&gt;', $escaped);
Chris@0:     $decoded = Html::decodeEntities($escaped);
Chris@0:     $this->assertSame('<em>répét&eacute;</em>', $decoded);
Chris@0:     $decoded = Html::decodeEntities($decoded);
Chris@0:     $this->assertSame('<em>répété</em>', $decoded);
Chris@0:     $escaped = Html::escape($decoded);
Chris@0:     $this->assertSame('&lt;em&gt;répété&lt;/em&gt;', $escaped);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests Html::serialize().
Chris@0:    *
Chris@0:    * Resolves an issue by where an empty DOMDocument object sent to serialization would
Chris@0:    * cause errors in getElementsByTagName() in the serialization function.
Chris@0:    *
Chris@0:    * @covers ::serialize
Chris@0:    */
Chris@0:   public function testSerialize() {
Chris@0:     $document = new \DOMDocument();
Chris@0:     $result = Html::serialize($document);
Chris@0:     $this->assertSame('', $result);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * @covers ::transformRootRelativeUrlsToAbsolute
Chris@0:    * @dataProvider providerTestTransformRootRelativeUrlsToAbsolute
Chris@0:    */
Chris@0:   public function testTransformRootRelativeUrlsToAbsolute($html, $scheme_and_host, $expected_html) {
Chris@0:     $this->assertSame($expected_html ?: $html, Html::transformRootRelativeUrlsToAbsolute($html, $scheme_and_host));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * @covers ::transformRootRelativeUrlsToAbsolute
Chris@0:    * @dataProvider providerTestTransformRootRelativeUrlsToAbsoluteAssertion
Chris@0:    */
Chris@0:   public function testTransformRootRelativeUrlsToAbsoluteAssertion($scheme_and_host) {
Chris@14:     if (method_exists($this, 'expectException')) {
Chris@14:       $this->expectException(\AssertionError::class);
Chris@14:     }
Chris@14:     else {
Chris@14:       $this->setExpectedException(\AssertionError::class);
Chris@14:     }
Chris@0:     Html::transformRootRelativeUrlsToAbsolute('', $scheme_and_host);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testTransformRootRelativeUrlsToAbsolute().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestTransformRootRelativeUrlsToAbsolute() {
Chris@0:     $data = [];
Chris@0: 
Chris@0:     // Random generator.
Chris@0:     $random = new Random();
Chris@0: 
Chris@0:     // One random tag name.
Chris@0:     $tag_name = strtolower($random->name(8, TRUE));
Chris@0: 
Chris@0:     // A site installed either in the root of a domain or a subdirectory.
Chris@0:     $base_paths = ['/', '/subdir/' . $random->name(8, TRUE) . '/'];
Chris@0: 
Chris@0:     foreach ($base_paths as $base_path) {
Chris@0:       // The only attribute that has more than just a URL as its value, is
Chris@0:       // 'srcset', so special-case it.
Chris@0:       $data += [
Chris@0:         "$tag_name, srcset, $base_path: root-relative" => ["<$tag_name srcset=\"http://example.com{$base_path}already-absolute 200w, {$base_path}root-relative 300w\">root-relative test</$tag_name>", 'http://example.com', "<$tag_name srcset=\"http://example.com{$base_path}already-absolute 200w, http://example.com{$base_path}root-relative 300w\">root-relative test</$tag_name>"],
Chris@0:         "$tag_name, srcset, $base_path: protocol-relative" => ["<$tag_name srcset=\"http://example.com{$base_path}already-absolute 200w, //example.com{$base_path}protocol-relative 300w\">protocol-relative test</$tag_name>", 'http://example.com', FALSE],
Chris@0:         "$tag_name, srcset, $base_path: absolute" => ["<$tag_name srcset=\"http://example.com{$base_path}already-absolute 200w, http://example.com{$base_path}absolute 300w\">absolute test</$tag_name>", 'http://example.com', FALSE],
Chris@0:       ];
Chris@0: 
Chris@0:       foreach (['href', 'poster', 'src', 'cite', 'data', 'action', 'formaction', 'about'] as $attribute) {
Chris@0:         $data += [
Chris@0:           "$tag_name, $attribute, $base_path: root-relative" => ["<$tag_name $attribute=\"{$base_path}root-relative\">root-relative test</$tag_name>", 'http://example.com', "<$tag_name $attribute=\"http://example.com{$base_path}root-relative\">root-relative test</$tag_name>"],
Chris@0:           "$tag_name, $attribute, $base_path: protocol-relative" => ["<$tag_name $attribute=\"//example.com{$base_path}protocol-relative\">protocol-relative test</$tag_name>", 'http://example.com', FALSE],
Chris@0:           "$tag_name, $attribute, $base_path: absolute" => ["<$tag_name $attribute=\"http://example.com{$base_path}absolute\">absolute test</$tag_name>", 'http://example.com', FALSE],
Chris@0:         ];
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     return $data;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Provides test data for testTransformRootRelativeUrlsToAbsoluteAssertion().
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   Test data.
Chris@0:    */
Chris@0:   public function providerTestTransformRootRelativeUrlsToAbsoluteAssertion() {
Chris@0:     return [
Chris@0:       'only relative path' => ['llama'],
Chris@0:       'only root-relative path' => ['/llama'],
Chris@0:       'host and path' => ['example.com/llama'],
Chris@0:       'scheme, host and path' => ['http://example.com/llama'],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Marks an object's __toString() method as returning markup.
Chris@0:  */
Chris@0: class HtmlTestMarkup implements MarkupInterface {
Chris@0:   use MarkupTrait;
Chris@0: 
Chris@0: }