silverstripe-framework/tests/model/HTMLTextTest.php

<?php
/**
 * @package framework
 * @subpackage tests
 */
class HTMLTextTest extends SapphireTest {

	private $previousLocaleSetting = null;

	public function setUp()
	{
		parent::setUp();
		// clear the previous locale setting
		$this->previousLocaleSetting = null;
	}

	public function tearDown()
	{
		parent::tearDown();
		// If a test sets the locale, reset it on teardown
		if ($this->previousLocaleSetting) {
			setlocale(LC_CTYPE, $this->previousLocaleSetting);
		}
	}

	/**
	 * Test {@link HTMLText->LimitCharacters()}
	 */
	public function testLimitCharacters() {
		$cases = array(
			'The little brown fox jumped over the lazy cow.' => 'The little brown fox...',
			'<p>This is some text in a paragraph.</p>' => 'This is some text in...',
			'This text contains &amp; in it' => 'This text contains &amp;...'
		);

		foreach($cases as $originalValue => $expectedValue) {
			$textObj = new HTMLText('Test');
			$textObj->setValue($originalValue);
			$this->assertEquals($expectedValue, $textObj->LimitCharacters());
		}
	}

	public function testSummaryBasics() {
		$cases = array(
			'<h1>Should not take header</h1><p>Should take paragraph</p>' => 'Should take paragraph',
			'<p>Should strip <b>tags, but leave</b> text</p>' => 'Should strip tags, but leave text',
			'<p>Unclosed tags <br>should not phase it</p>' => 'Unclosed tags should not phase it',
			'<p>Second paragraph</p><p>should not cause errors or appear in output</p>' => 'Second paragraph',
			'<img src="hello" /><p>Second paragraph</p><p>should not cause errors or appear in output</p>'
				=> 'Second paragraph',
			'  <img src="hello" /><p>Second paragraph</p><p>should not cause errors or appear in output</p>'
				=> 'Second paragraph',
			'<p><img src="remove me">example <img src="include me">text words hello<img src="hello"></p>'
				=> 'example text words hello',
		);

		foreach($cases as $originalValue => $expectedValue) {
			$textObj = new HTMLText('Test');
			$textObj->setValue($originalValue);
			$this->assertEquals($expectedValue, $textObj->Summary());
		}
	}

	public function testSummaryLimits() {
		$cases = array(
			'<p>A long paragraph should be cut off if limit is set</p>' => 'A long paragraph should be...',
			'<p>No matter <i>how many <b>tags</b></i> are in it</p>' => 'No matter how many tags...',
			'<p>A sentence is. nicer than hard limits</p>' => 'A sentence is.',
			'<p>But not. If it\'s too short</p>' => 'But not. If it\'s too...'
		);

		foreach($cases as $originalValue => $expectedValue) {
			$textObj = new HTMLText('Test');
			$textObj->setValue($originalValue);
			$this->assertEquals($expectedValue, $textObj->Summary(5, 3, '...'));
		}
	}

	public function testSummaryEndings() {
		$cases = array(
			'...', ' -> more', ''
		);

		$orig = '<p>Cut it off, cut it off</p>';
		$match = 'Cut it off, cut';

		foreach($cases as $add) {
			$textObj = new HTMLText();
			$textObj->setValue($orig);
			$this->assertEquals($match.$add, $textObj->Summary(4, 0, $add));
		}
	}

	public function testSummaryFlexTooBigShouldNotCauseError() {
		$orig = '<p>Cut it off, cut it off</p>';
		$match = 'Cut it off, cut';

		$textObj = new HTMLText();
		$textObj->setValue($orig);
		$this->assertEquals($match, $textObj->Summary(4, 10, ''));
	}

	public function testSummaryInvalidHTML() {
		$cases = array(
			'It\'s got a <p<> tag, but<p junk true>This doesn\'t <a id="boo">make</b class="wa"> < ><any< sense</p>'
				=> 'This doesn\'t make any',
			'This doesn\'t <a style="much horray= true>even</b> < ><have< a <i>p tag' => 'This doesn\'t even have'
		);

		foreach($cases as $orig => $match) {
			$textObj = new HTMLText();
			$textObj->setValue($orig);
			$this->assertEquals($match, $textObj->Summary(4, 0, ''));
		}
	}

	public function testFirstSentence() {
		$many = str_repeat('many ', 100);
		$cases = array(
			'<h1>should ignore</h1><p>First sentence. Second sentence.</p>' => 'First sentence.',
			'<h1>should ignore</h1><p>First Mr. sentence. Second sentence.</p>' => 'First Mr. sentence.',
			"<h1>should ignore</h1><p>Sentence with {$many}words. Second sentence.</p>"
				=> "Sentence with {$many}words.",
			'<p>This classic picture book features a repetitive format that lends itself to audience interaction.'.
			'&nbsp; Illustrator Eric Carle submitted new, bolder artwork for the 25th anniversary edition.</p>'
				=> 'This classic picture book features a repetitive format that lends itself to audience interaction.'
		);

		foreach($cases as $orig => $match) {
			$textObj = new HTMLText();
			$textObj->setValue($orig);
			$this->assertEquals($match, $textObj->FirstSentence());
		}
	}

	public function testRAW() {
		$data = DBField::create_field('HTMLText', 'This &amp; This');
		$this->assertEquals($data->RAW(), 'This &amp; This');

		$data = DBField::create_field('HTMLText', 'This & This');
		$this->assertEquals($data->RAW(), 'This & This');
	}

	public function testXML() {
		$data = DBField::create_field('HTMLText', 'This & This');
		$this->assertEquals($data->XML(), 'This &amp; This');
	}

	public function testHTML() {
		$data = DBField::create_field('HTMLText', 'This & This');
		$this->assertEquals($data->HTML(), 'This &amp; This');
	}

	public function testJS() {
		$data = DBField::create_field('HTMLText', '"this is a test"');
		$this->assertEquals($data->JS(), '\"this is a test\"');
	}

	public function testATT() {
		$data = DBField::create_field('HTMLText', '"this is a test"');
		$this->assertEquals($data->ATT(), '&quot;this is a test&quot;');
	}

	function testExists() {
		$h = new HTMLText;
		$h->setValue("");
		$this->assertFalse($h->exists());
		$h->setValue("<p></p>");
		$this->assertFalse($h->exists());
		$h->setValue("<p> </p>");
		$this->assertFalse($h->exists());
		$h->setValue("<h2/>");
		$this->assertFalse($h->exists());
		$h->setValue("<h2></h2>");
		$this->assertFalse($h->exists());

		$h->setValue("something");
		$this->assertTrue($h->exists());
		$h->setValue("<img src=\"dummy.png\">");
		$this->assertTrue($h->exists());
		$h->setValue("<img src=\"dummy.png\"><img src=\"dummy.png\">");
		$this->assertTrue($h->exists());
		$h->setValue("<p><img src=\"dummy.png\"></p>");
		$this->assertTrue($h->exists());

		$h->setValue("<iframe src=\"http://www.google.com\"></iframe>");
		$this->assertTrue($h->exists());
		$h->setValue("<embed src=\"test.swf\">");
		$this->assertTrue($h->exists());
		$h->setValue("<object width=\"400\" height=\"400\" data=\"test.swf\"></object>");
		$this->assertTrue($h->exists());


		$h->setValue("<p>test</p>");
		$this->assertTrue($h->exists());
	}

	function testWhitelist() {
		$textObj = new HTMLText('Test', 'meta,link');
		$this->assertEquals(
			'<meta content="Keep"><link href="Also Keep">',
			$textObj->whitelistContent('<meta content="Keep"><p>Remove</p><link href="Also Keep" />Remove Text'),
			'Removes any elements not in whitelist excluding text elements'
		);

		$textObj = new HTMLText('Test', 'meta,link,text()');
		$this->assertEquals(
			'<meta content="Keep"><link href="Also Keep">Keep Text',
			$textObj->whitelistContent('<meta content="Keep"><p>Remove</p><link href="Also Keep" />Keep Text'),
			'Removes any elements not in whitelist including text elements'
		);
	}

	public function testShortCodeParsedInRAW() {
		$parser = ShortcodeParser::get('HTMLTextTest');
		$parser->register('shortcode', function($arguments, $content, $parser, $tagName, $extra) {
			return 'replaced';
		});
		ShortcodeParser::set_active('HTMLTextTest');
		/** @var HTMLText $field */
		$field = DBField::create_field('HTMLText', '<p>[shortcode]</p>');
		$this->assertEquals('<p>replaced</p>', $field->RAW());
		$this->assertEquals('<p>replaced</p>', (string)$field);

		$field->setOptions(array(
			'shortcodes' => false,
		));

		$this->assertEquals('<p>[shortcode]</p>', $field->RAW());
		$this->assertEquals('<p>[shortcode]</p>', (string)$field);


		ShortcodeParser::set_active('default');
	}

	public function testShortCodeParsedInTemplateHelpers() {
		$parser = ShortcodeParser::get('HTMLTextTest');
		$parser->register('shortcode', function($arguments, $content, $parser, $tagName, $extra) {
			return 'Replaced short code with this. <a href="home">home</a>';
		});
		ShortcodeParser::set_active('HTMLTextTest');
		/** @var HTMLText $field */
		$field = DBField::create_field('HTMLText', '<p>[shortcode]</p>');

		$this->assertEquals(
			'&lt;p&gt;Replaced short code with this. &lt;a href=&quot;home&quot;&gt;home&lt;/a&gt;&lt;/p&gt;',
			$field->HTMLATT()
		);
		$this->assertEquals(
			'%3Cp%3EReplaced+short+code+with+this.+%3Ca+href%3D%22home%22%3Ehome%3C%2Fa%3E%3C%2Fp%3E',
			$field->URLATT()
		);
		$this->assertEquals(
			'%3Cp%3EReplaced%20short%20code%20with%20this.%20%3Ca%20href%3D%22home%22%3Ehome%3C%2Fa%3E%3C%2Fp%3E',
			$field->RAWURLATT()
		);
		$this->assertEquals(
			'&lt;p&gt;Replaced short code with this. &lt;a href=&quot;home&quot;&gt;home&lt;/a&gt;&lt;/p&gt;',
			$field->ATT()
		);
		$this->assertEquals(
			'<p>Replaced short code with this. <a href="home">home</a></p>',
			$field->RAW()
		);
		$this->assertEquals(
			'\x3cp\x3eReplaced short code with this. \x3ca href=\"home\"\x3ehome\x3c/a\x3e\x3c/p\x3e',
			$field->JS()
		);
		$this->assertEquals(
			'&lt;p&gt;Replaced short code with this. &lt;a href=&quot;home&quot;&gt;home&lt;/a&gt;&lt;/p&gt;',
			$field->HTML()
		);
		$this->assertEquals(
			'&lt;p&gt;Replaced short code with this. &lt;a href=&quot;home&quot;&gt;home&lt;/a&gt;&lt;/p&gt;',
			$field->XML()
		);
		$this->assertEquals(
			'Repl...',
			$field->LimitCharacters(4, '...')
		);
		$this->assertEquals(
			'Replaced...',
			$field->LimitCharactersToClosestWord(10, '...')
		);
		$this->assertEquals(
			'Replaced...',
			$field->LimitWordCount(1, '...')
		);
		$this->assertEquals(
			'<p>replaced short code with this. <a href="home">home</a></p>',
			$field->LowerCase()
		);
		$this->assertEquals(
			'<P>REPLACED SHORT CODE WITH THIS. <A HREF="HOME">HOME</A></P>',
			$field->UpperCase()
		);
		$this->assertEquals(
			'Replaced short code with this. home',
			$field->NoHTML()
		);
		Config::nest();
		Config::inst()->update('Director', 'alternate_base_url', 'http://example.com/');
		$this->assertEquals(
			'<p>Replaced short code with this. <a href="http://example.com/home">home</a></p>',
			$field->AbsoluteLinks()
		);
		Config::unnest();
		$this->assertEquals(
			'Replaced short code with this.',
			$field->LimitSentences(1)
		);
		$this->assertEquals(
			'Replaced short code with this.',
			$field->FirstSentence()
		);
		$this->assertEquals(
			'Replaced short...',
			$field->Summary(2)
		);
		$this->assertEquals(
			'Replaced short code with...',
			$field->BigSummary(4)
		);
		$this->assertEquals(
			'Replaced short code with this. home[home]',
			$field->FirstParagraph()
		);
		$this->assertEquals(
			'Replaced <span class="highlight">short</span> <span class="highlight">code</span> with this. home',
			$field->ContextSummary(500, 'short code')
		);

		ShortcodeParser::set_active('default');
	}

	public function testValidUtf8()
	{
		// Install a UTF-8 locale
		$this->previousLocaleSetting = setlocale(LC_CTYPE, 0);
		$locales = array('en_US.UTF-8', 'en_NZ.UTF-8', 'de_DE.UTF-8');
		$localeInstalled = false;
		foreach ($locales as $locale) {
			if ($localeInstalled = setlocale(LC_CTYPE, $locale)) {
				break;
			}
		}

		// If the system doesn't have any of the UTF-8 locales, exit early
		if ($localeInstalled === false) {
			$this->markTestIncomplete('Unable to run this test because of missing locale!');
			return;
		}

		$problematicText = html_entity_decode('<p>This is a&nbsp;Test with non-breaking&nbsp;space!</p>', ENT_COMPAT, 'UTF-8');

		$textObj = new HTMLText('Test');
		$textObj->setValue($problematicText);

		$this->assertTrue(mb_check_encoding($textObj->FirstSentence(), 'UTF-8'));
		$this->assertTrue(mb_check_encoding($textObj->Summary(), 'UTF-8'));
	}
}