Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Contains \Drupal\Tests\Component\Utility\SafeMarkupTest.
Chris@0:  */
Chris@0: 
Chris@0: namespace Drupal\Tests\Component\Utility;
Chris@0: 
Chris@0: use Drupal\Component\Render\HtmlEscapedText;
Chris@0: use Drupal\Component\Utility\SafeMarkup;
Chris@0: use Drupal\Component\Render\MarkupInterface;
Chris@0: use Drupal\Component\Render\MarkupTrait;
Chris@0: use Drupal\Component\Utility\UrlHelper;
Chris@0: use PHPUnit\Framework\TestCase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests marking strings as safe.
Chris@0:  *
Chris@0:  * @group Utility
Chris@17:  * @group legacy
Chris@0:  * @coversDefaultClass \Drupal\Component\Utility\SafeMarkup
Chris@0:  */
Chris@0: class SafeMarkupTest extends TestCase {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   protected function tearDown() {
Chris@0:     parent::tearDown();
Chris@0: 
Chris@0:     UrlHelper::setAllowedProtocols(['http', 'https']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests SafeMarkup::isSafe() with different objects.
Chris@0:    *
Chris@0:    * @covers ::isSafe
Chris@17:    * @expectedDeprecation SafeMarkup::isSafe() is scheduled for removal in Drupal 9.0.0. Instead, you should just check if a variable is an instance of \Drupal\Component\Render\MarkupInterface. See https://www.drupal.org/node/2549395.
Chris@0:    */
Chris@0:   public function testIsSafe() {
Chris@14:     $safe_string = $this->getMockBuilder('\Drupal\Component\Render\MarkupInterface')->getMock();
Chris@0:     $this->assertTrue(SafeMarkup::isSafe($safe_string));
Chris@0:     $string_object = new SafeMarkupTestString('test');
Chris@0:     $this->assertFalse(SafeMarkup::isSafe($string_object));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests SafeMarkup::checkPlain().
Chris@0:    *
Chris@0:    * @dataProvider providerCheckPlain
Chris@0:    * @covers ::checkPlain
Chris@17:    * @expectedDeprecation SafeMarkup::checkPlain() is scheduled for removal in Drupal 9.0.0. Rely on Twig's auto-escaping feature, or use the @link theme_render #plain_text @endlink key when constructing a render array that contains plain text in order to use the renderer's auto-escaping feature. If neither of these are possible, \Drupal\Component\Utility\Html::escape() can be used in places where explicit escaping is needed. See https://www.drupal.org/node/2549395.
Chris@0:    *
Chris@0:    * @param string $text
Chris@0:    *   The text to provide to SafeMarkup::checkPlain().
Chris@0:    * @param string $expected
Chris@0:    *   The expected output from the function.
Chris@0:    * @param string $message
Chris@0:    *   The message to provide as output for the test.
Chris@0:    */
Chris@0:   public function testCheckPlain($text, $expected, $message) {
Chris@0:     $result = SafeMarkup::checkPlain($text);
Chris@0:     $this->assertTrue($result instanceof HtmlEscapedText);
Chris@0:     $this->assertEquals($expected, $result, $message);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests Drupal\Component\Render\HtmlEscapedText.
Chris@0:    *
Chris@0:    * Verifies that the result of SafeMarkup::checkPlain() is the same as using
Chris@0:    * HtmlEscapedText directly.
Chris@0:    *
Chris@0:    * @dataProvider providerCheckPlain
Chris@0:    *
Chris@0:    * @param string $text
Chris@0:    *   The text to provide to the HtmlEscapedText constructor.
Chris@0:    * @param string $expected
Chris@0:    *   The expected output from the function.
Chris@0:    * @param string $message
Chris@0:    *   The message to provide as output for the test.
Chris@0:    */
Chris@0:   public function testHtmlEscapedText($text, $expected, $message) {
Chris@0:     $result = new HtmlEscapedText($text);
Chris@0:     $this->assertEquals($expected, $result, $message);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for testCheckPlain() and testEscapeString().
Chris@0:    *
Chris@0:    * @see testCheckPlain()
Chris@0:    */
Chris@0:   public function providerCheckPlain() {
Chris@0:     // Checks that invalid multi-byte sequences are escaped.
Chris@0:     $tests[] = ["Foo\xC0barbaz", 'Foo�barbaz', 'Escapes invalid sequence "Foo\xC0barbaz"'];
Chris@0:     $tests[] = ["\xc2\"", '�&quot;', 'Escapes invalid sequence "\xc2\""'];
Chris@0:     $tests[] = ["Fooÿñ", "Fooÿñ", 'Does not escape valid sequence "Fooÿñ"'];
Chris@0: 
Chris@0:     // Checks that special characters are escaped.
Chris@0:     $tests[] = [SafeMarkupTestMarkup::create("<script>"), '&lt;script&gt;', 'Escapes &lt;script&gt; even inside an object that implements MarkupInterface.'];
Chris@0:     $tests[] = ["<script>", '&lt;script&gt;', 'Escapes &lt;script&gt;'];
Chris@0:     $tests[] = ['<>&"\'', '&lt;&gt;&amp;&quot;&#039;', 'Escapes reserved HTML characters.'];
Chris@0:     $tests[] = [SafeMarkupTestMarkup::create('<>&"\''), '&lt;&gt;&amp;&quot;&#039;', 'Escapes reserved HTML characters even inside an object that implements MarkupInterface.'];
Chris@0: 
Chris@0:     return $tests;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests string formatting with SafeMarkup::format().
Chris@0:    *
Chris@0:    * @dataProvider providerFormat
Chris@0:    * @covers ::format
Chris@17:    * @expectedDeprecation SafeMarkup::format() is scheduled for removal in Drupal 9.0.0. Use \Drupal\Component\Render\FormattableMarkup. See https://www.drupal.org/node/2549395.
Chris@0:    *
Chris@0:    * @param string $string
Chris@0:    *   The string to run through SafeMarkup::format().
Chris@0:    * @param string[] $args
Chris@0:    *   The arguments to pass into SafeMarkup::format().
Chris@0:    * @param string $expected
Chris@0:    *   The expected result from calling the function.
Chris@0:    * @param string $message
Chris@0:    *   The message to display as output to the test.
Chris@0:    * @param bool $expected_is_safe
Chris@0:    *   Whether the result is expected to be safe for HTML display.
Chris@0:    */
Chris@0:   public function testFormat($string, array $args, $expected, $message, $expected_is_safe) {
Chris@0:     UrlHelper::setAllowedProtocols(['http', 'https', 'mailto']);
Chris@0: 
Chris@0:     $result = SafeMarkup::format($string, $args);
Chris@0:     $this->assertEquals($expected, (string) $result, $message);
Chris@0:     $this->assertEquals($expected_is_safe, $result instanceof MarkupInterface, 'SafeMarkup::format correctly sets the result as safe or not safe.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for testFormat().
Chris@0:    *
Chris@0:    * @see testFormat()
Chris@0:    */
Chris@0:   public function providerFormat() {
Chris@0:     $tests[] = ['Simple text', [], 'Simple text', 'SafeMarkup::format leaves simple text alone.', TRUE];
Chris@0:     $tests[] = ['Escaped text: @value', ['@value' => '<script>'], 'Escaped text: &lt;script&gt;', 'SafeMarkup::format replaces and escapes string.', TRUE];
Chris@0:     $tests[] = ['Escaped text: @value', ['@value' => SafeMarkupTestMarkup::create('<span>Safe HTML</span>')], 'Escaped text: <span>Safe HTML</span>', 'SafeMarkup::format does not escape an already safe string.', TRUE];
Chris@0:     $tests[] = ['Placeholder text: %value', ['%value' => '<script>'], 'Placeholder text: <em class="placeholder">&lt;script&gt;</em>', 'SafeMarkup::format replaces, escapes and themes string.', TRUE];
Chris@0:     $tests[] = ['Placeholder text: %value', ['%value' => SafeMarkupTestMarkup::create('<span>Safe HTML</span>')], 'Placeholder text: <em class="placeholder"><span>Safe HTML</span></em>', 'SafeMarkup::format does not escape an already safe string themed as a placeholder.', TRUE];
Chris@0: 
Chris@0:     $tests['javascript-protocol-url'] = ['Simple text <a href=":url">giraffe</a>', [':url' => 'javascript://example.com?foo&bar'], 'Simple text <a href="//example.com?foo&amp;bar">giraffe</a>', 'Support for filtering bad protocols', TRUE];
Chris@0:     $tests['external-url'] = ['Simple text <a href=":url">giraffe</a>', [':url' => 'http://example.com?foo&bar'], 'Simple text <a href="http://example.com?foo&amp;bar">giraffe</a>', 'Support for filtering bad protocols', TRUE];
Chris@0:     $tests['relative-url'] = ['Simple text <a href=":url">giraffe</a>', [':url' => '/node/1?foo&bar'], 'Simple text <a href="/node/1?foo&amp;bar">giraffe</a>', 'Support for filtering bad protocols', TRUE];
Chris@0:     $tests['fragment-with-special-chars'] = ['Simple text <a href=":url">giraffe</a>', [':url' => 'http://example.com/#&lt;'], 'Simple text <a href="http://example.com/#&amp;lt;">giraffe</a>', 'Support for filtering bad protocols', TRUE];
Chris@0:     $tests['mailto-protocol'] = ['Hey giraffe <a href=":url">MUUUH</a>', [':url' => 'mailto:test@example.com'], 'Hey giraffe <a href="mailto:test@example.com">MUUUH</a>', '', TRUE];
Chris@0:     $tests['js-with-fromCharCode'] = ['Hey giraffe <a href=":url">MUUUH</a>', [':url' => "javascript:alert(String.fromCharCode(88,83,83))"], 'Hey giraffe <a href="alert(String.fromCharCode(88,83,83))">MUUUH</a>', '', TRUE];
Chris@0: 
Chris@0:     // Test some "URL" values that are not RFC 3986 compliant URLs. The result
Chris@0:     // of SafeMarkup::format() should still be valid HTML (other than the
Chris@0:     // value of the "href" attribute not being a valid URL), and not
Chris@0:     // vulnerable to XSS.
Chris@0:     $tests['non-url-with-colon'] = ['Hey giraffe <a href=":url">MUUUH</a>', [':url' => "llamas: they are not URLs"], 'Hey giraffe <a href=" they are not URLs">MUUUH</a>', '', TRUE];
Chris@0:     $tests['non-url-with-html'] = ['Hey giraffe <a href=":url">MUUUH</a>', [':url' => "<span>not a url</span>"], 'Hey giraffe <a href="&lt;span&gt;not a url&lt;/span&gt;">MUUUH</a>', '', TRUE];
Chris@0: 
Chris@0:     // Tests non-standard placeholders that will not replace.
Chris@0:     $tests['non-standard-placeholder'] = ['Hey hey', ['risky' => "<script>alert('foo');</script>"], 'Hey hey', '', TRUE];
Chris@0:     return $tests;
Chris@0:   }
Chris@0: 
Chris@0: }
Chris@0: 
Chris@0: class SafeMarkupTestString {
Chris@0: 
Chris@0:   protected $string;
Chris@0: 
Chris@0:   public function __construct($string) {
Chris@0:     $this->string = $string;
Chris@0:   }
Chris@0: 
Chris@0:   public function __toString() {
Chris@0:     return $this->string;
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 SafeMarkupTestMarkup implements MarkupInterface {
Chris@0:   use MarkupTrait;
Chris@0: 
Chris@0: }