silverstripe-framework/tests/forms/HTMLEditorFieldTest.php

267 lines
8.7 KiB
PHP
Raw Normal View History

<?php
use SilverStripe\Assets\File;
use SilverStripe\Assets\Filesystem;
use SilverStripe\Control\Controller;
use SilverStripe\Control\SS_HTTPRequest;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Extension;
use SilverStripe\Dev\CSSContentParser;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\Dev\TestOnly;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\HTMLEditor\HTMLEditorField;
use SilverStripe\Forms\HTMLEditor\HTMLEditorField_Toolbar;
use SilverStripe\Forms\HTMLEditor\HTMLEditorField_Image;
use SilverStripe\Forms\HTMLReadonlyField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBHTMLText;
/**
* @package framework
* @subpackage tests
*/
class HTMLEditorFieldTest extends FunctionalTest {
2014-08-15 08:53:05 +02:00
protected static $fixture_file = 'HTMLEditorFieldTest.yml';
2014-08-15 08:53:05 +02:00
protected static $use_draft_site = true;
2014-08-15 08:53:05 +02:00
protected $requiredExtensions = array(
'SilverStripe\\Forms\\HTMLEditor\\HTMLEditorField_Toolbar' => array(
'HTMLEditorFieldTest_DummyMediaFormFieldExtension'
)
);
2014-08-15 08:53:05 +02:00
protected $extraDataObjects = array('HTMLEditorFieldTest_Object');
2014-08-15 08:53:05 +02:00
public function setUp() {
parent::setUp();
// Set backend root to /HTMLEditorFieldTest
AssetStoreTest_SpyStore::activate('HTMLEditorFieldTest');
// Set the File Name Filter replacements so files have the expected names
Config::inst()->update('SilverStripe\\Assets\\FileNameFilter', 'default_replacements', array(
'/\s/' => '-', // remove whitespace
'/_/' => '-', // underscores to dashes
'/[^A-Za-z0-9+.\-]+/' => '', // remove non-ASCII chars, only allow alphanumeric plus dash and dot
'/[\-]{2,}/' => '-', // remove duplicate dashes
'/^[\.\-_]+/' => '', // Remove all leading dots, dashes or underscores
));
// Create a test files for each of the fixture references
$files = File::get()->exclude('ClassName', 'SilverStripe\\Assets\\Folder');
foreach($files as $file) {
$fromPath = BASE_PATH . '/framework/tests/forms/images/' . $file->Name;
$destPath = AssetStoreTest_SpyStore::getLocalPath($file); // Only correct for test asset store
Filesystem::makeFolder(dirname($destPath));
copy($fromPath, $destPath);
}
}
public function tearDown() {
AssetStoreTest_SpyStore::reset();
parent::tearDown();
}
public function testBasicSaving() {
$obj = new HTMLEditorFieldTest_Object();
$editor = new HTMLEditorField('Content');
2014-08-15 08:53:05 +02:00
$editor->setValue('<p class="foo">Simple Content</p>');
$editor->saveInto($obj);
$this->assertEquals('<p class="foo">Simple Content</p>', $obj->Content, 'Attributes are preserved.');
2014-08-15 08:53:05 +02:00
$editor->setValue('<p>Unclosed Tag');
$editor->saveInto($obj);
$this->assertEquals('<p>Unclosed Tag</p>', $obj->Content, 'Unclosed tags are closed.');
}
2014-08-15 08:53:05 +02:00
public function testNullSaving() {
$obj = new HTMLEditorFieldTest_Object();
$editor = new HTMLEditorField('Content');
2014-08-15 08:53:05 +02:00
$editor->setValue(null);
$editor->saveInto($obj);
$this->assertEquals('', $obj->Content, "Doesn't choke on empty/null values.");
}
2014-08-15 08:53:05 +02:00
public function testResizedImageInsertion() {
$obj = new HTMLEditorFieldTest_Object();
$editor = new HTMLEditorField('Content');
2014-08-15 08:53:05 +02:00
$fileID = $this->idFromFixture('SilverStripe\\Assets\\Image', 'example_image');
$editor->setValue(sprintf(
2016-03-08 12:20:51 +01:00
'[image src="assets/HTMLEditorFieldTest_example.jpg" width="10" height="20" id="%d"]',
$fileID
));
$editor->saveInto($obj);
2014-08-15 08:53:05 +02:00
2016-03-08 12:20:51 +01:00
$parser = new CSSContentParser($obj->dbObject('Content')->forTemplate());
$xml = $parser->getByXpath('//img');
2016-03-08 12:20:51 +01:00
$this->assertEquals(
'HTMLEditorFieldTest example',
(string)$xml[0]['alt'],
'Alt tags are added by default based on filename'
);
$this->assertEquals('', (string)$xml[0]['title'], 'Title tags are added by default.');
$this->assertEquals(10, (int)$xml[0]['width'], 'Width tag of resized image is set.');
$this->assertEquals(20, (int)$xml[0]['height'], 'Height tag of resized image is set.');
2014-08-15 08:53:05 +02:00
$neededFilename
= '/assets/HTMLEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example__ResizedImageWyIxMCIsIjIwIl0.jpg';
$this->assertEquals($neededFilename, (string)$xml[0]['src'], 'Correct URL of resized image is set.');
$this->assertTrue(file_exists(BASE_PATH.DIRECTORY_SEPARATOR.$neededFilename), 'File for resized image exists');
$this->assertEquals(false, $obj->HasBrokenFile, 'Referenced image file exists.');
2014-08-15 08:53:05 +02:00
}
public function testMultiLineSaving() {
$obj = $this->objFromFixture('HTMLEditorFieldTest_Object', 'home');
$editor = new HTMLEditorField('Content');
$editor->setValue('<p>First Paragraph</p><p>Second Paragraph</p>');
$editor->saveInto($obj);
$this->assertEquals('<p>First Paragraph</p><p>Second Paragraph</p>', $obj->Content);
}
2014-08-15 08:53:05 +02:00
public function testSavingLinksWithoutHref() {
$obj = $this->objFromFixture('HTMLEditorFieldTest_Object', 'home');
$editor = new HTMLEditorField('Content');
2014-08-15 08:53:05 +02:00
$editor->setValue('<p><a name="example-anchor"></a></p>');
$editor->saveInto($obj);
2014-08-15 08:53:05 +02:00
$this->assertEquals (
'<p><a name="example-anchor"></a></p>', $obj->Content, 'Saving a link without a href attribute works'
);
}
2015-11-18 17:26:26 +01:00
public function testGetAnchors() {
if (!class_exists('Page')) {
$this->markTestSkipped();
}
$linkedPage = new Page();
$linkedPage->Title = 'Dummy';
$linkedPage->write();
$html = <<<EOS
<div name="foo"></div>
<div name='bar'></div>
2015-11-18 17:26:26 +01:00
<div id="baz"></div>
[sitetree_link id="{$linkedPage->ID}"]
<div id='bam'></div>
2015-11-18 17:26:26 +01:00
<div id = "baz"></div>
<div id = ""></div>
<div id="some'id"></div>
<div id=bar></div>
EOS
;
2015-11-18 17:26:26 +01:00
$expected = array(
'foo',
'bar',
'baz',
'bam',
2016-01-19 05:08:40 +01:00
"some&#039;id",
2015-11-18 17:26:26 +01:00
);
$page = new Page();
$page->Title = 'Test';
$page->Content = $html;
$page->write();
$this->useDraftSite(true);
2016-01-19 05:08:40 +01:00
$request = new SS_HTTPRequest('GET', '/', array(
2015-11-18 17:26:26 +01:00
'PageID' => $page->ID,
2016-01-19 05:08:40 +01:00
));
2015-11-18 17:26:26 +01:00
$toolBar = new HTMLEditorField_Toolbar(new Controller(), 'test');
2016-01-19 05:08:40 +01:00
$toolBar->setRequest($request);
2015-11-18 17:26:26 +01:00
2016-01-19 05:08:40 +01:00
$results = json_decode($toolBar->getanchors(), true);
$this->assertEquals($expected, $results);
2015-11-18 17:26:26 +01:00
}
public function testHTMLEditorFieldFileLocal() {
$file = new HTMLEditorField_Image('http://domain.com/folder/my_image.jpg?foo=bar');
$this->assertEquals('http://domain.com/folder/my_image.jpg?foo=bar', $file->URL);
$this->assertEquals('my_image.jpg', $file->Name);
$this->assertEquals('jpg', $file->Extension);
// TODO Can't easily test remote file dimensions
}
public function testHTMLEditorFieldFileRemote() {
$fileFixture = new File(array('Name' => 'my_local_image.jpg', 'Filename' => 'folder/my_local_image.jpg'));
$file = new HTMLEditorField_Image('http://localdomain.com/folder/my_local_image.jpg', $fileFixture);
$this->assertEquals('http://localdomain.com/folder/my_local_image.jpg', $file->URL);
$this->assertEquals('my_local_image.jpg', $file->Name);
$this->assertEquals('jpg', $file->Extension);
}
public function testReadonlyField() {
$editor = new HTMLEditorField('Content');
$fileID = $this->idFromFixture('SilverStripe\\Assets\\Image', 'example_image');
$editor->setValue(sprintf(
'[image src="assets/HTMLEditorFieldTest_example.jpg" width="10" height="20" id="%d"]',
$fileID
));
/** @var HTMLReadonlyField $readonly */
$readonly = $editor->performReadonlyTransformation();
/** @var DBHTMLText $readonlyContent */
$readonlyContent = $readonly->Field();
$this->assertEquals( <<<EOS
<span class="readonly typography" id="Content">
<img src="/assets/HTMLEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example__ResizedImageWyIxMCIsIjIwIl0.jpg" alt="HTMLEditorFieldTest example" width="10" height="20">
</span>
EOS
,
$readonlyContent->getValue()
);
// Test with include input tag
$readonly = $editor->performReadonlyTransformation()
->setIncludeHiddenField(true);
/** @var DBHTMLText $readonlyContent */
$readonlyContent = $readonly->Field();
$this->assertEquals( <<<EOS
<span class="readonly typography" id="Content">
<img src="/assets/HTMLEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example__ResizedImageWyIxMCIsIjIwIl0.jpg" alt="HTMLEditorFieldTest example" width="10" height="20">
</span>
<input type="hidden" name="Content" value="[image src=&quot;/assets/HTMLEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example.jpg&quot; width=&quot;10&quot; height=&quot;20&quot; id=&quot;{$fileID}&quot;]" />
EOS
,
$readonlyContent->getValue()
);
}
}
/**
* @package framework
* @subpackage tests
*/
class HTMLEditorFieldTest_DummyMediaFormFieldExtension extends Extension implements TestOnly {
public static $fields = null;
public static $update_called = false;
/**
* @param Form $form
*/
public function updateImageForm($form) {
self::$update_called = true;
self::$fields = $form->Fields();
}
}
class HTMLEditorFieldTest_Object extends DataObject implements TestOnly {
private static $db = array(
'Title' => 'Varchar',
'Content' => 'HTMLText',
'HasBrokenFile' => 'Boolean'
);
}