Move into nested docroot

This commit is contained in:
Rob Davies 2017-02-13 15:31:17 +00:00
parent 83a0d3a149
commit c8b70abde9
13405 changed files with 0 additions and 0 deletions

View file

@ -0,0 +1,6 @@
name: CKEditor test
type: module
description: Support module for the CKEditor module tests.
core: 8.x
package: Testing
version: VERSION

View file

@ -0,0 +1,15 @@
<?php
/**
* @file
* Helper module for the CKEditor tests.
*/
use Drupal\editor\Entity\Editor;
/**
* Implements hook_ckeditor_css_alter().
*/
function ckeditor_test_ckeditor_css_alter(array &$css, Editor $editor) {
$css[] = drupal_get_path('module', 'ckeditor_test') . '/ckeditor_test.css';
}

View file

@ -0,0 +1,16 @@
ckeditor.plugin.llama_contextual_and_button:
type: mapping
label: 'Contextual Llama With Button'
mapping:
ultra_llama_mode:
type: boolean
label: 'Ultra llama mode'
filter_settings.test_attribute_filter:
type: filter
label: 'Test Attribute Filter'
mapping:
tags:
type: sequence
sequence:
type: string

View file

@ -0,0 +1,159 @@
<?php
namespace Drupal\Tests\ckeditor\Kernel;
use Drupal\editor\Entity\Editor;
use Drupal\KernelTests\KernelTestBase;
use Drupal\filter\Entity\FilterFormat;
/**
* Tests different ways of enabling CKEditor plugins.
*
* @group ckeditor
*/
class CKEditorPluginManagerTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array('system', 'user', 'filter', 'editor', 'ckeditor');
/**
* The manager for "CKEditor plugin" plugins.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $manager;
protected function setUp() {
parent::setUp();
// Install the Filter module.
// Create text format, associate CKEditor.
$filtered_html_format = FilterFormat::create(array(
'format' => 'filtered_html',
'name' => 'Filtered HTML',
'weight' => 0,
'filters' => array(),
));
$filtered_html_format->save();
$editor = Editor::create([
'format' => 'filtered_html',
'editor' => 'ckeditor',
]);
$editor->save();
}
/**
* Tests the enabling of plugins.
*/
function testEnabledPlugins() {
$this->manager = $this->container->get('plugin.manager.ckeditor.plugin');
$editor = Editor::load('filtered_html');
// Case 1: no CKEditor plugins.
$definitions = array_keys($this->manager->getDefinitions());
sort($definitions);
$this->assertIdentical(array('drupalimage', 'drupalimagecaption', 'drupallink', 'internal', 'language', 'stylescombo'), $definitions, 'No CKEditor plugins found besides the built-in ones.');
$enabled_plugins = array(
'drupalimage' => drupal_get_path('module', 'ckeditor') . '/js/plugins/drupalimage/plugin.js',
'drupallink' => drupal_get_path('module', 'ckeditor') . '/js/plugins/drupallink/plugin.js',
);
$this->assertIdentical($enabled_plugins, $this->manager->getEnabledPluginFiles($editor), 'Only built-in plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $enabled_plugins, $this->manager->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');
// Enable the CKEditor Test module, which has the Llama plugin (plus four
// variations of it, to cover all possible ways a plugin can be enabled) and
// clear the editor manager's cache so it is picked up.
$this->enableModules(array('ckeditor_test'));
$this->manager = $this->container->get('plugin.manager.ckeditor.plugin');
$this->manager->clearCachedDefinitions();
// Case 2: CKEditor plugins are available.
$plugin_ids = array_keys($this->manager->getDefinitions());
sort($plugin_ids);
$this->assertIdentical(array('drupalimage', 'drupalimagecaption', 'drupallink', 'internal', 'language', 'llama', 'llama_button', 'llama_contextual', 'llama_contextual_and_button', 'llama_css', 'stylescombo'), $plugin_ids, 'Additional CKEditor plugins found.');
$this->assertIdentical($enabled_plugins, $this->manager->getEnabledPluginFiles($editor), 'Only the internal plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $enabled_plugins, $this->manager->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');
// Case 3: enable each of the newly available plugins, if possible:
// a. Llama: cannot be enabled, since it does not implement
// CKEditorPluginContextualInterface nor CKEditorPluginButtonsInterface.
// b. LlamaContextual: enabled by adding the 'Strike' button, which is
// part of another plugin!
// c. LlamaButton: automatically enabled by adding its 'Llama' button.
// d. LlamaContextualAndButton: enabled by either b or c.
// e. LlamaCSS: automatically enabled by add its 'LlamaCSS' button.
// Below, we will first enable the "Llama" button, which will cause the
// LlamaButton and LlamaContextualAndButton plugins to be enabled. Then we
// will remove the "Llama" button and add the "Strike" button, which will
// cause the LlamaContextual and LlamaContextualAndButton plugins to be
// enabled. Then we will add the "Strike" button back again, which would
// cause LlamaButton, LlamaContextual and LlamaContextualAndButton to be
// enabled. Finally, we will add the "LlamaCSS" button which would cause
// all four plugins to be enabled.
$settings = $editor->getSettings();
$original_toolbar = $settings['toolbar'];
$settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
$editor->setSettings($settings);
$editor->save();
$file = array();
$file['b'] = drupal_get_path('module', 'ckeditor_test') . '/js/llama_button.js';
$file['c'] = drupal_get_path('module', 'ckeditor_test') . '/js/llama_contextual.js';
$file['cb'] = drupal_get_path('module', 'ckeditor_test') . '/js/llama_contextual_and_button.js';
$file['css'] = drupal_get_path('module', 'ckeditor_test') . '/js/llama_css.js';
$expected = $enabled_plugins + array('llama_button' => $file['b'], 'llama_contextual_and_button' => $file['cb']);
$this->assertIdentical($expected, $this->manager->getEnabledPluginFiles($editor), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $expected, $this->manager->getEnabledPluginFiles($editor, TRUE), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
$settings['toolbar'] = $original_toolbar;
$settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
$editor->setSettings($settings);
$editor->save();
$expected = $enabled_plugins + array('llama_contextual' => $file['c'], 'llama_contextual_and_button' => $file['cb']);
$this->assertIdentical($expected, $this->manager->getEnabledPluginFiles($editor), 'The LLamaContextual and LlamaContextualAndButton plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $expected, $this->manager->getEnabledPluginFiles($editor, TRUE), 'The LlamaContextual and LlamaContextualAndButton plugins are enabled.');
$settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
$editor->setSettings($settings);
$editor->save();
$expected = $enabled_plugins + array('llama_button' => $file['b'], 'llama_contextual' => $file['c'], 'llama_contextual_and_button' => $file['cb']);
$this->assertIdentical($expected, $this->manager->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $expected, $this->manager->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
$settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
$editor->setSettings($settings);
$editor->save();
$expected = $enabled_plugins + array('llama_button' => $file['b'], 'llama_contextual' => $file['c'], 'llama_contextual_and_button' => $file['cb'], 'llama_css' => $file['css']);
$this->assertIdentical($expected, $this->manager->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual, LlamaContextualAndButton and LlamaCSS plugins are enabled.');
$this->assertIdentical(array('internal' => NULL) + $expected, $this->manager->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual, LlamaContextualAndButton and LlamaCSS plugins are enabled.');
}
/**
* Tests the iframe instance CSS files of plugins.
*/
function testCssFiles() {
$this->manager = $this->container->get('plugin.manager.ckeditor.plugin');
$editor = Editor::load('filtered_html');
// Case 1: no CKEditor iframe instance CSS file.
$this->assertIdentical(array(), $this->manager->getCssFiles($editor), 'No iframe instance CSS file found.');
// Enable the CKEditor Test module, which has the LlamaCss plugin and
// clear the editor manager's cache so it is picked up.
$this->enableModules(array('ckeditor_test'));
$this->manager = $this->container->get('plugin.manager.ckeditor.plugin');
$settings = $editor->getSettings();
// LlamaCss: automatically enabled by adding its 'LlamaCSS' button.
$settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
$editor->setSettings($settings);
$editor->save();
// Case 2: CKEditor iframe instance CSS file.
$expected = array(
'llama_css' => array(drupal_get_path('module', 'ckeditor_test') . '/css/llama.css')
);
$this->assertIdentical($expected, $this->manager->getCssFiles($editor), 'Iframe instance CSS file found.');
}
}

View file

@ -0,0 +1,495 @@
<?php
namespace Drupal\Tests\ckeditor\Kernel;
use Drupal\KernelTests\KernelTestBase;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\editor\Entity\Editor;
use Drupal\filter\Entity\FilterFormat;
/**
* Tests for the 'CKEditor' text editor plugin.
*
* @group ckeditor
*/
class CKEditorTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array('system', 'user', 'filter', 'editor', 'ckeditor', 'filter_test');
/**
* An instance of the "CKEditor" text editor plugin.
*
* @var \Drupal\ckeditor\Plugin\Editor\CKEditor;
*/
protected $ckeditor;
/**
* The Editor Plugin Manager.
*
* @var \Drupal\editor\Plugin\EditorManager;
*/
protected $manager;
protected function setUp() {
parent::setUp();
// Install the Filter module.
// Create text format, associate CKEditor.
$filtered_html_format = FilterFormat::create(array(
'format' => 'filtered_html',
'name' => 'Filtered HTML',
'weight' => 0,
'filters' => array(
'filter_html' => array(
'status' => 1,
'settings' => array(
'allowed_html' => '<h2 id> <h3> <h4> <h5> <h6> <p> <br> <strong> <a href hreflang>',
)
),
),
));
$filtered_html_format->save();
$editor = Editor::create([
'format' => 'filtered_html',
'editor' => 'ckeditor',
]);
$editor->save();
// Create "CKEditor" text editor plugin instance.
$this->ckeditor = $this->container->get('plugin.manager.editor')->createInstance('ckeditor');
}
/**
* Tests CKEditor::getJSSettings().
*/
function testGetJSSettings() {
$editor = Editor::load('filtered_html');
// Default toolbar.
$expected_config = $this->getDefaultInternalConfig() + array(
'drupalImage_dialogTitleAdd' => 'Insert Image',
'drupalImage_dialogTitleEdit' => 'Edit Image',
'drupalLink_dialogTitleAdd' => 'Add Link',
'drupalLink_dialogTitleEdit' => 'Edit Link',
'allowedContent' => $this->getDefaultAllowedContentConfig(),
'disallowedContent' => $this->getDefaultDisallowedContentConfig(),
'toolbar' => $this->getDefaultToolbarConfig(),
'contentsCss' => $this->getDefaultContentsCssConfig(),
'extraPlugins' => 'drupalimage,drupallink',
'language' => 'en',
'stylesSet' => FALSE,
'drupalExternalPlugins' => array(
'drupalimage' => file_url_transform_relative(file_create_url('core/modules/ckeditor/js/plugins/drupalimage/plugin.js')),
'drupallink' => file_url_transform_relative(file_create_url('core/modules/ckeditor/js/plugins/drupallink/plugin.js')),
),
);
$expected_config = $this->castSafeStrings($expected_config);
ksort($expected_config);
ksort($expected_config['allowedContent']);
$this->assertIdentical($expected_config, $this->castSafeStrings($this->ckeditor->getJSSettings($editor)), 'Generated JS settings are correct for default configuration.');
// Customize the configuration: add button, have two contextually enabled
// buttons, and configure a CKEditor plugin setting.
$this->enableModules(array('ckeditor_test'));
$this->container->get('plugin.manager.editor')->clearCachedDefinitions();
$this->ckeditor = $this->container->get('plugin.manager.editor')->createInstance('ckeditor');
$this->container->get('plugin.manager.ckeditor.plugin')->clearCachedDefinitions();
$settings = $editor->getSettings();
$settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
$settings['toolbar']['rows'][0][0]['items'][] = 'Format';
$editor->setSettings($settings);
$editor->save();
$expected_config['toolbar'][0]['items'][] = 'Strike';
$expected_config['toolbar'][0]['items'][] = 'Format';
$expected_config['format_tags'] = 'p;h2;h3;h4;h5;h6';
$expected_config['extraPlugins'] .= ',llama_contextual,llama_contextual_and_button';
$expected_config['drupalExternalPlugins']['llama_contextual'] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual.js'));
$expected_config['drupalExternalPlugins']['llama_contextual_and_button'] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js'));
$expected_config['contentsCss'][] = file_url_transform_relative(file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css'));
ksort($expected_config);
$this->assertIdentical($expected_config, $this->castSafeStrings($this->ckeditor->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');
// Change the allowed HTML tags; the "allowedContent" and "format_tags"
// settings for CKEditor should automatically be updated as well.
$format = $editor->getFilterFormat();
$format->filters('filter_html')->settings['allowed_html'] .= '<pre class> <h1> <blockquote class="*"> <address class="foo bar-* *">';
$format->save();
$expected_config['allowedContent']['pre'] = array('attributes' => 'class', 'styles' => FALSE, 'classes' => TRUE);
$expected_config['allowedContent']['h1'] = array('attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE);
$expected_config['allowedContent']['blockquote'] = array('attributes' => 'class', 'styles' => FALSE, 'classes' => TRUE);
$expected_config['allowedContent']['address'] = array('attributes' => 'class', 'styles' => FALSE, 'classes' => 'foo,bar-*');
$expected_config['format_tags'] = 'p;h1;h2;h3;h4;h5;h6;pre';
ksort($expected_config['allowedContent']);
$this->assertIdentical($expected_config, $this->castSafeStrings($this->ckeditor->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');
// Disable the filter_html filter: allow *all *tags.
$format->setFilterConfig('filter_html', array('status' => 0));
$format->save();
$expected_config['allowedContent'] = TRUE;
$expected_config['disallowedContent'] = FALSE;
$expected_config['format_tags'] = 'p;h1;h2;h3;h4;h5;h6;pre';
$this->assertIdentical($expected_config, $this->castSafeStrings($this->ckeditor->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');
// Enable the filter_test_restrict_tags_and_attributes filter.
$format->setFilterConfig('filter_test_restrict_tags_and_attributes', array(
'status' => 1,
'settings' => array(
'restrictions' => array(
'allowed' => array(
'p' => TRUE,
'a' => array(
'href' => TRUE,
'rel' => array('nofollow' => TRUE),
'class' => array('external' => TRUE),
'target' => array('_blank' => FALSE),
),
'span' => array(
'class' => array('dodo' => FALSE),
'property' => array('dc:*' => TRUE),
'rel' => array('foaf:*' => FALSE),
'style' => array('underline' => FALSE, 'color' => FALSE, 'font-size' => TRUE),
),
'*' => array(
'style' => FALSE,
'on*' => FALSE,
'class' => array('is-a-hipster-llama' => TRUE, 'and-more' => TRUE),
'data-*' => TRUE,
),
'del' => FALSE,
),
),
),
));
$format->save();
$expected_config['allowedContent'] = array(
'p' => array(
'attributes' => TRUE,
'styles' => FALSE,
'classes' => 'is-a-hipster-llama,and-more',
),
'a' => array(
'attributes' => 'href,rel,class,target',
'styles' => FALSE,
'classes' => 'external',
),
'span' => array(
'attributes' => 'class,property,rel,style',
'styles' => 'font-size',
'classes' => FALSE,
),
'*' => array(
'attributes' => 'class,data-*',
'styles' => FALSE,
'classes' => 'is-a-hipster-llama,and-more',
),
'del' => array(
'attributes' => FALSE,
'styles' => FALSE,
'classes' => FALSE,
),
);
$expected_config['disallowedContent'] = array(
'span' => array(
'styles' => 'underline,color',
'classes' => 'dodo',
),
'*' => array(
'attributes' => 'on*',
),
);
$expected_config['format_tags'] = 'p';
ksort($expected_config);
ksort($expected_config['allowedContent']);
ksort($expected_config['disallowedContent']);
$this->assertIdentical($expected_config, $this->castSafeStrings($this->ckeditor->getJSSettings($editor)), 'Generated JS settings are correct for customized configuration.');
}
/**
* Tests CKEditor::buildToolbarJSSetting().
*/
function testBuildToolbarJSSetting() {
$editor = Editor::load('filtered_html');
// Default toolbar.
$expected = $this->getDefaultToolbarConfig();
$this->assertIdentical($expected, $this->castSafeStrings($this->ckeditor->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for default toolbar.');
// Customize the configuration.
$settings = $editor->getSettings();
$settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
$editor->setSettings($settings);
$editor->save();
$expected[0]['items'][] = 'Strike';
$this->assertIdentical($expected, $this->castSafeStrings($this->ckeditor->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for customized toolbar.');
// Enable the editor_test module, customize further.
$this->enableModules(array('ckeditor_test'));
$this->container->get('plugin.manager.ckeditor.plugin')->clearCachedDefinitions();
// Override the label of a toolbar component.
$settings['toolbar']['rows'][0][0]['name'] = 'JunkScience';
$settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
$editor->setSettings($settings);
$editor->save();
$expected[0]['name'] = 'JunkScience';
$expected[0]['items'][] = 'Llama';
$this->assertIdentical($expected, $this->castSafeStrings($this->ckeditor->buildToolbarJSSetting($editor)), '"toolbar" configuration part of JS settings built correctly for customized toolbar with contrib module-provided CKEditor plugin.');
}
/**
* Tests CKEditor::buildContentsCssJSSetting().
*/
function testBuildContentsCssJSSetting() {
$editor = Editor::load('filtered_html');
// Default toolbar.
$expected = $this->getDefaultContentsCssConfig();
$this->assertIdentical($expected, $this->ckeditor->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly for default toolbar.');
// Enable the editor_test module, which implements hook_ckeditor_css_alter().
$this->enableModules(array('ckeditor_test'));
$expected[] = file_url_transform_relative(file_create_url(drupal_get_path('module', 'ckeditor_test') . '/ckeditor_test.css'));
$this->assertIdentical($expected, $this->ckeditor->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a hook_ckeditor_css_alter() implementation exists.');
// Enable LlamaCss plugin, which adds an additional CKEditor stylesheet.
$this->container->get('plugin.manager.editor')->clearCachedDefinitions();
$this->ckeditor = $this->container->get('plugin.manager.editor')->createInstance('ckeditor');
$this->container->get('plugin.manager.ckeditor.plugin')->clearCachedDefinitions();
$settings = $editor->getSettings();
// LlamaCss: automatically enabled by adding its 'LlamaCSS' button.
$settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
$editor->setSettings($settings);
$editor->save();
$expected[] = file_url_transform_relative(file_create_url(drupal_get_path('module', 'ckeditor_test') . '/css/llama.css'));
$this->assertIdentical($expected, $this->ckeditor->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a CKEditorPluginInterface implementation exists.');
// Enable the Bartik theme, which specifies a CKEditor stylesheet.
\Drupal::service('theme_handler')->install(['bartik']);
\Drupal::service('theme_handler')->setDefault('bartik');
$expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/base/elements.css'));
$expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/captions.css'));
$expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/table.css'));
$expected[] = file_url_transform_relative(file_create_url('core/themes/bartik/css/components/text-formatted.css'));
$this->assertIdentical($expected, $this->ckeditor->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a theme providing a CKEditor stylesheet exists.');
}
/**
* Tests Internal::getConfig().
*/
function testInternalGetConfig() {
$editor = Editor::load('filtered_html');
$internal_plugin = $this->container->get('plugin.manager.ckeditor.plugin')->createInstance('internal');
// Default toolbar.
$expected = $this->getDefaultInternalConfig();
$expected['disallowedContent'] = $this->getDefaultDisallowedContentConfig();
$expected['allowedContent'] = $this->getDefaultAllowedContentConfig();
$this->assertEqual($expected, $internal_plugin->getConfig($editor), '"Internal" plugin configuration built correctly for default toolbar.');
// Format dropdown/button enabled: new setting should be present.
$settings = $editor->getSettings();
$settings['toolbar']['rows'][0][0]['items'][] = 'Format';
$editor->setSettings($settings);
$expected['format_tags'] = 'p;h2;h3;h4;h5;h6';
$this->assertEqual($expected, $internal_plugin->getConfig($editor), '"Internal" plugin configuration built correctly for customized toolbar.');
}
/**
* Tests StylesCombo::getConfig().
*/
function testStylesComboGetConfig() {
$editor = Editor::load('filtered_html');
$stylescombo_plugin = $this->container->get('plugin.manager.ckeditor.plugin')->createInstance('stylescombo');
// Styles dropdown/button enabled: new setting should be present.
$settings = $editor->getSettings();
$settings['toolbar']['rows'][0][0]['items'][] = 'Styles';
$settings['plugins']['stylescombo']['styles'] = '';
$editor->setSettings($settings);
$editor->save();
$expected['stylesSet'] = array();
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Configure the optional "styles" setting in odd ways that shouldn't affect
// the end result.
$settings['plugins']['stylescombo']['styles'] = " \n";
$editor->setSettings($settings);
$editor->save();
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor));
$settings['plugins']['stylescombo']['styles'] = "\r\n \n \r \n ";
$editor->setSettings($settings);
$editor->save();
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Now configure it properly, the end result should change.
$settings['plugins']['stylescombo']['styles'] = "h1.title|Title\np.mAgical.Callout|Callout";
$editor->setSettings($settings);
$editor->save();
$expected['stylesSet'] = array(
array('name' => 'Title', 'element' => 'h1', 'attributes' => array('class' => 'title')),
array('name' => 'Callout', 'element' => 'p', 'attributes' => array('class' => 'mAgical Callout')),
);
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Same configuration, but now interspersed with nonsense. Should yield the
// same result.
$settings['plugins']['stylescombo']['styles'] = " h1 .title | Title \r \n\r \np.mAgical .Callout|Callout\r";
$editor->setSettings($settings);
$editor->save();
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Slightly different configuration: class names are optional.
$settings['plugins']['stylescombo']['styles'] = " h1 | Title ";
$editor->setSettings($settings);
$editor->save();
$expected['stylesSet'] = array(array('name' => 'Title', 'element' => 'h1'));
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Invalid syntax should cause stylesSet to be set to FALSE.
$settings['plugins']['stylescombo']['styles'] = "h1";
$editor->setSettings($settings);
$editor->save();
$expected['stylesSet'] = FALSE;
$this->assertIdentical($expected, $stylescombo_plugin->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
}
/**
* Tests language list availability in CKEditor.
*/
function testLanguages() {
// Get CKEditor supported language codes and spot-check.
$this->enableModules(array('language'));
$this->installConfig(array('language'));
$langcodes = $this->ckeditor->getLangcodes();
// Language codes transformed with browser mappings.
$this->assertTrue($langcodes['pt-pt'] == 'pt', '"pt" properly resolved');
$this->assertTrue($langcodes['zh-hans'] == 'zh-cn', '"zh-hans" properly resolved');
// Language code both in Drupal and CKEditor.
$this->assertTrue($langcodes['gl'] == 'gl', '"gl" properly resolved');
// Language codes only in CKEditor.
$this->assertTrue($langcodes['en-au'] == 'en-au', '"en-au" properly resolved');
$this->assertTrue($langcodes['sr-latn'] == 'sr-latn', '"sr-latn" properly resolved');
// No locale module, so even though languages are enabled, CKEditor should
// still be in English.
$this->assertCKEditorLanguage('en');
}
/**
* Tests that CKEditor plugins participate in JS translation.
*/
function testJSTranslation() {
$this->enableModules(array('language', 'locale'));
$this->installSchema('locale', 'locales_source');
$this->installSchema('locale', 'locales_location');
$this->installSchema('locale', 'locales_target');
$editor = Editor::load('filtered_html');
$this->ckeditor->getJSSettings($editor);
$localeStorage = $this->container->get('locale.storage');
$string = $localeStorage->findString(array('source' => 'Edit Link', 'context' => ''));
$this->assertTrue(!empty($string), 'String from JavaScript file saved.');
// With locale module, CKEditor should not adhere to the language selected.
$this->assertCKEditorLanguage();
}
/**
* Assert that CKEditor picks the expected language when French is default.
*
* @param string $langcode
* Language code to assert for. Defaults to French. That is the default
* language set in this assertion.
*/
protected function assertCKEditorLanguage($langcode = 'fr') {
// Set French as the site default language.
ConfigurableLanguage::createFromLangcode('fr')->save();
$this->config('system.site')->set('default_langcode', 'fr')->save();
// Reset the language manager so new negotiations attempts will fall back on
// French. Reinject the language manager CKEditor to use the current one.
$this->container->get('language_manager')->reset();
$this->ckeditor = $this->container->get('plugin.manager.editor')->createInstance('ckeditor');
// Test that we now get the expected language.
$editor = Editor::load('filtered_html');
$settings = $this->ckeditor->getJSSettings($editor);
$this->assertEqual($settings['language'], $langcode);
}
protected function getDefaultInternalConfig() {
return array(
'customConfig' => '',
'pasteFromWordPromptCleanup' => TRUE,
'resize_dir' => 'vertical',
'justifyClasses' => array('text-align-left', 'text-align-center', 'text-align-right', 'text-align-justify'),
'entities' => FALSE,
'disableNativeSpellChecker' => FALSE,
);
}
protected function getDefaultAllowedContentConfig() {
return [
'h2' => ['attributes' => 'id', 'styles' => FALSE, 'classes' => FALSE],
'h3' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'h4' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'h5' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'h6' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'p' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'br' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'strong' => ['attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE],
'a' => ['attributes' => 'href,hreflang', 'styles' => FALSE, 'classes' => FALSE],
'*' => ['attributes' => 'lang,dir', 'styles' => FALSE, 'classes' => FALSE],
];
}
protected function getDefaultDisallowedContentConfig() {
return array(
'*' => array('attributes' => 'on*'),
);
}
protected function getDefaultToolbarConfig() {
return array(
array(
'name' => 'Formatting',
'items' => array('Bold', 'Italic',),
),
array(
'name' => 'Links',
'items' => array('DrupalLink', 'DrupalUnlink',),
),
array(
'name' => 'Lists',
'items' => array('BulletedList', 'NumberedList',),
),
array(
'name' => 'Media',
'items' => array('Blockquote', 'DrupalImage',),
),
array(
'name' => 'Tools',
'items' => array('Source',),
),
'/',
);
}
protected function getDefaultContentsCssConfig() {
return array(
file_url_transform_relative(file_create_url('core/modules/ckeditor/css/ckeditor-iframe.css')),
file_url_transform_relative(file_create_url('core/modules/system/css/components/align.module.css')),
);
}
}

View file

@ -0,0 +1,64 @@
<?php
namespace Drupal\ckeditor_test\Plugin\CKEditorPlugin;
use Drupal\ckeditor\CKEditorPluginInterface;
use Drupal\Component\Plugin\PluginBase;
use Drupal\editor\Entity\Editor;
/**
* Defines the "Llama" plugin, with a CKEditor "llama" feature.
*
* This feature does not correspond to a toolbar button. Because this plugin
* does not implement the CKEditorPluginContextualInterface nor the
* CKEditorPluginButtonsInterface interface, there is no way of actually loading
* this plugin.
*
* @see \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextual
* @see \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaButton
* @see \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaContextualAndButton
* @see \Drupal\ckeditor_test\Plugin\CKEditorPlugin\LlamaCss
*
* @CKEditorPlugin(
* id = "llama",
* label = @Translation("Llama")
* )
*/
class Llama extends PluginBase implements CKEditorPluginInterface {
/**
* {@inheritdoc}
*/
function getDependencies(Editor $editor) {
return array();
}
/**
* {@inheritdoc}
*/
function getLibraries(Editor $editor) {
return array();
}
/**
* {@inheritdoc}
*/
function isInternal() {
return FALSE;
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama.js';
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
return array();
}
}

View file

@ -0,0 +1,35 @@
<?php
namespace Drupal\ckeditor_test\Plugin\CKEditorPlugin;
use Drupal\ckeditor\CKEditorPluginButtonsInterface;
/**
* Defines a "LlamaButton" plugin, with a toolbar builder-enabled "llama" feature.
*
* @CKEditorPlugin(
* id = "llama_button",
* label = @Translation("Llama Button")
* )
*/
class LlamaButton extends Llama implements CKEditorPluginButtonsInterface {
/**
* {@inheritdoc}
*/
function getButtons() {
return array(
'Llama' => array(
'label' => t('Insert Llama'),
),
);
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama_button.js';
}
}

View file

@ -0,0 +1,41 @@
<?php
namespace Drupal\ckeditor_test\Plugin\CKEditorPlugin;
use Drupal\ckeditor\CKEditorPluginContextualInterface;
use Drupal\editor\Entity\Editor;
/**
* Defines a "Llama" plugin, with a contextually enabled "llama" feature.
*
* @CKEditorPlugin(
* id = "llama_contextual",
* label = @Translation("Contextual Llama")
* )
*/
class LlamaContextual extends Llama implements CKEditorPluginContextualInterface {
/**
* {@inheritdoc}
*/
function isEnabled(Editor $editor) {
// Automatically enable this plugin if the Underline button is enabled.
$settings = $editor->getSettings();
foreach ($settings['toolbar']['rows'] as $row) {
foreach ($row as $group) {
if (in_array('Strike', $group['items'])) {
return TRUE;
}
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama_contextual.js';
}
}

View file

@ -0,0 +1,76 @@
<?php
namespace Drupal\ckeditor_test\Plugin\CKEditorPlugin;
use Drupal\ckeditor\CKEditorPluginButtonsInterface;
use Drupal\ckeditor\CKEditorPluginContextualInterface;
use Drupal\ckeditor\CKEditorPluginConfigurableInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\editor\Entity\Editor;
/**
* Defines a "LlamaContextualAndbutton" plugin, with a contextually OR toolbar
* builder-enabled "llama" feature.
*
* @CKEditorPlugin(
* id = "llama_contextual_and_button",
* label = @Translation("Contextual Llama With Button")
* )
*/
class LlamaContextualAndButton extends Llama implements CKEditorPluginContextualInterface, CKEditorPluginButtonsInterface, CKEditorPluginConfigurableInterface {
/**
* {@inheritdoc}
*/
function isEnabled(Editor $editor) {
// Automatically enable this plugin if the Strike button is enabled.
$settings = $editor->getSettings();
foreach ($settings['toolbar']['rows'] as $row) {
foreach ($row as $group) {
if (in_array('Strike', $group['items'])) {
return TRUE;
}
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
function getButtons() {
return array(
'Llama' => array(
'label' => t('Insert Llama'),
),
);
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama_contextual_and_button.js';
}
/**
* {@inheritdoc}
*/
function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
// Defaults.
$config = array('ultra_llama_mode' => FALSE);
$settings = $editor->getSettings();
if (isset($settings['plugins']['llama_contextual_and_button'])) {
$config = $settings['plugins']['llama_contextual_and_button'];
}
$form['ultra_llama_mode'] = array(
'#title' => t('Ultra llama mode'),
'#type' => 'checkbox',
'#default_value' => $config['ultra_llama_mode'],
);
return $form;
}
}

View file

@ -0,0 +1,46 @@
<?php
namespace Drupal\ckeditor_test\Plugin\CKEditorPlugin;
use Drupal\ckeditor\CKEditorPluginButtonsInterface;
use Drupal\ckeditor\CKEditorPluginCssInterface;
use Drupal\editor\Entity\Editor;
/**
* Defines a "LlamaCss" plugin, with an associated "llama" CSS.
*
* @CKEditorPlugin(
* id = "llama_css",
* label = @Translation("Llama CSS")
* )
*/
class LlamaCss extends Llama implements CKEditorPluginButtonsInterface, CKEditorPluginCssInterface {
/**
* {@inheritdoc}
*/
function getButtons() {
return array(
'LlamaCSS' => array(
'label' => t('Insert Llama CSS'),
),
);
}
/**
* {@inheritdoc}
*/
function getCssFiles(Editor $editor) {
return array(
drupal_get_path('module', 'ckeditor_test') . '/css/llama.css'
);
}
/**
* {@inheritdoc}
*/
function getFile() {
return drupal_get_path('module', 'ckeditor_test') . '/js/llama_css.js';
}
}

View file

@ -0,0 +1,38 @@
<?php
namespace Drupal\ckeditor_test\Plugin\Filter;
use Drupal\Component\Utility\Html;
use Drupal\filter\FilterProcessResult;
use Drupal\filter\Plugin\FilterBase;
/**
* A filter that adds a test attribute to any configured HTML tags.
*
* @Filter(
* id = "test_attribute_filter",
* title = @Translation("Test Attribute Filter"),
* type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
* settings = {
* "tags" = {},
* },
* weight = -10
* )
*/
class TestAttributeFilter extends FilterBase {
/**
* {@inheritdoc}
*/
public function process($text, $langcode) {
$document = Html::load($text);
foreach ($this->settings['tags'] as $tag) {
$tag_elements = $document->getElementsByTagName($tag);
foreach ($tag_elements as $tag_element) {
$tag_element->setAttribute('test_attribute', 'test attribute value');
}
}
return new FilterProcessResult(Html::serialize($document));
}
}

View file

@ -0,0 +1,121 @@
<?php
namespace Drupal\Tests\ckeditor\FunctionalJavascript;
use Drupal\Core\Entity\Entity\EntityFormDisplay;
use Drupal\editor\Entity\Editor;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\filter\Entity\FilterFormat;
use Drupal\FunctionalJavascriptTests\JavascriptTestBase;
use Drupal\node\Entity\NodeType;
/**
* Tests the integration of CKEditor.
*
* @group ckeditor
*/
class CKEditorIntegrationTest extends JavascriptTestBase {
/**
* The account.
*
* @var \Drupal\user\UserInterface
*/
protected $account;
/**
* {@inheritdoc}
*/
public static $modules = ['node', 'ckeditor', 'filter'];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// Create a text format and associate CKEditor.
$filtered_html_format = FilterFormat::create([
'format' => 'filtered_html',
'name' => 'Filtered HTML',
'weight' => 0,
]);
$filtered_html_format->save();
Editor::create([
'format' => 'filtered_html',
'editor' => 'ckeditor',
])->save();
// Create a node type for testing.
NodeType::create(['type' => 'page', 'name' => 'page'])->save();
$field_storage = FieldStorageConfig::loadByName('node', 'body');
// Create a body field instance for the 'page' node type.
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'page',
'label' => 'Body',
'settings' => ['display_summary' => TRUE],
'required' => TRUE,
])->save();
// Assign widget settings for the 'default' form mode.
EntityFormDisplay::create([
'targetEntityType' => 'node',
'bundle' => 'page',
'mode' => 'default',
'status' => TRUE,
])->setComponent('body', ['type' => 'text_textarea_with_summary'])
->save();
$this->account = $this->drupalCreateUser([
'administer nodes',
'create page content',
'use text format filtered_html',
]);
$this->drupalLogin($this->account);
}
/**
* Tests if the fragment link to a textarea works with CKEditor enabled.
*/
public function testFragmentLink() {
$session = $this->getSession();
$web_assert = $this->assertSession();
$ckeditor_id = '#cke_edit-body-0-value';
$this->drupalGet('node/add/page');
$session->getPage();
// Add a bottom margin to the title field to be sure the body field is not
// visible. PhantomJS runs with a resolution of 1024x768px.
$session->executeScript("document.getElementById('edit-title-0-value').style.marginBottom = '800px';");
// Check that the CKEditor-enabled body field is currently not visible in
// the viewport.
$web_assert->assertNotVisibleInViewport('css', $ckeditor_id, 'topLeft', 'CKEditor-enabled body field is visible.');
$before_url = $session->getCurrentUrl();
// Trigger a hash change with as target the hidden textarea.
$session->executeScript("location.hash = '#edit-body-0-value';");
// Check that the CKEditor-enabled body field is visible in the viewport.
$web_assert->assertVisibleInViewport('css', $ckeditor_id, 'topLeft', 'CKEditor-enabled body field is not visible.');
// Use JavaScript to go back in the history instead of
// \Behat\Mink\Session::back() because that function doesn't work after a
// hash change.
$session->executeScript("history.back();");
$after_url = $session->getCurrentUrl();
// Check that going back in the history worked.
self::assertEquals($before_url, $after_url, 'History back works.');
}
}

View file

@ -0,0 +1,140 @@
<?php
namespace Drupal\Tests\ckeditor\Kernel\Plugin\CKEditorPlugin;
use Drupal\editor\Entity\Editor;
use Drupal\filter\Entity\FilterFormat;
use Drupal\KernelTests\KernelTestBase;
/**
* @coversDefaultClass \Drupal\ckeditor\Plugin\CKEditorPlugin\Internal
*
* @group ckeditor
*/
class InternalTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = [
'ckeditor',
'ckeditor_test',
'filter',
'editor',
];
/**
* A testing text format.
*
* @var \Drupal\filter\Entity\FilterFormat
*/
protected $format;
/**
* A testing text editor.
*
* @var \Drupal\editor\Entity\Editor
*/
protected $editor;
/**
* The CKEditor plugin manager.
*
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $ckeditorPluginManager;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->installEntitySchema('editor');
$this->installEntitySchema('filter_format');
$this->format = FilterFormat::create([
'format' => 'test_format',
'name' => $this->randomMachineName(),
]);
$this->format->save();
$this->editor = Editor::create([
'editor' => 'ckeditor',
'format' => 'test_format',
'settings' => [
'toolbar' => [
'rows' => [
[
[
'name' => 'Enabled Buttons',
'items' => [
'Format',
],
],
],
],
],
],
]);
$this->editor->save();
$this->ckeditorPluginManager = $this->container->get('plugin.manager.ckeditor.plugin');
}
/**
* Test the format tags settings.
*
* @dataProvider formatTagsSettingsTestCases
*/
public function testFormatTagsSettings($filter_plugins, $expected_format_tags) {
foreach ($filter_plugins as $filter_plugin_id => $filter_plugin_settings) {
$this->format->setFilterConfig($filter_plugin_id, $filter_plugin_settings);
}
$this->format->save();
$internal_plugin = $this->ckeditorPluginManager->createInstance('internal', []);
$plugin_config = $internal_plugin->getConfig($this->editor);
$this->assertEquals($expected_format_tags, explode(';', $plugin_config['format_tags']));
}
/**
* A data provider for testFormatTagsSettings.
*/
public function formatTagsSettingsTestCases() {
$all_tags = ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'pre'];
return [
'No filter plugins enabled (all tags allowed)' => [
[],
$all_tags,
],
'HTML filter plugin enabled (some tags filtered out)' => [
[
'filter_html' => [
'status' => 1,
'settings' => [
'allowed_html' => '<h1> <h2>',
'filter_html_help' => 1,
'filter_html_nofollow' => 0,
],
],
],
['p', 'h1', 'h2'],
],
'Test attribute filter enabled (all tags allowed)' => [
[
'test_attribute_filter' => [
'status' => 1,
'settings' => [
'tags' => ['h1', 'h2'],
],
],
],
$all_tags,
],
];
}
}

View file

@ -0,0 +1,97 @@
<?php
namespace Drupal\Tests\ckeditor\Unit;
use Drupal\ckeditor\CKEditorPluginManager;
use Drupal\editor\Entity\Editor;
use Drupal\Tests\UnitTestCase;
/**
* @coversDefaultClass \Drupal\ckeditor\CKEditorPluginManager
*
* @group ckeditor
*/
class CKEditorPluginManagerTest extends UnitTestCase {
/**
* Provides a list of configs to test.
*/
public function providerGetEnabledButtons() {
return [
'empty' => [
[],
[]
],
'1 row, 1 group' => [
[
// Row 1.
[
// Group 1.
['name' => 'Formatting', 'items' => ['Bold', 'Italic']],
]
],
['Bold', 'Italic']
],
'1 row, >1 groups' => [
[
// Row 1.
[
// Group 1.
['name' => 'Formatting', 'items' => ['Bold', 'Italic']],
// Group 2.
['name' => 'Linking', 'items' => ['Link']],
],
],
['Bold', 'Italic', 'Link']
],
'2 rows, 1 group each' => [
[
// Row 1.
[
// Group 1.
['name' => 'Formatting', 'items' => ['Bold', 'Italic']],
],
// Row 2.
[
// Group 1.
['name' => 'Tools', 'items' => ['Source']],
],
],
['Bold', 'Italic', 'Source'],
],
'2 rows, >1 groups each' => [
[
// Row 1.
[
// Group 1.
['name' => 'Formatting', 'items' => ['Bold', 'Italic']],
// Group 2.
['name' => 'Linking', 'items' => ['Link']],
],
// Row 2.
[
// Group 1.
['name' => 'Tools', 'items' => ['Source']],
// Group 2.
['name' => 'Advanced', 'items' => ['Llama']],
],
],
['Bold', 'Italic', 'Link', 'Source', 'Llama']
],
];
}
/**
* @covers ::getEnabledButtons
* @dataProvider providerGetEnabledButtons
*/
public function testGetEnabledButtons(array $toolbar_rows, array $expected_buttons) {
$editor = $this->prophesize(Editor::class);
$editor->getSettings()
->willReturn(['toolbar' => ['rows' => $toolbar_rows]]);
$enabled_buttons = CKEditorPluginManager::getEnabledButtons($editor->reveal());
$this->assertEquals($expected_buttons, $enabled_buttons);
}
}

View file

@ -0,0 +1,65 @@
<?php
namespace Drupal\Tests\ckeditor\Unit\Plugin\CKEditorPlugin;
use Drupal\ckeditor\Plugin\CKEditorPlugin\Language;
use Drupal\Core\Language\LanguageManager;
use Drupal\Tests\UnitTestCase;
/**
* @coversDefaultClass \Drupal\ckeditor\Plugin\CKEditorPlugin\Language
*
* @group ckeditor
*/
class LanguageTest extends UnitTestCase {
/**
* The plugin under test.
*
* @var \Drupal\ckeditor\Plugin\CKEditorPlugin\Language
*/
protected $plugin;
/**
* {@inheritdoc}
*/
public function setUp() {
$this->plugin = new Language([], $this->randomMachineName(), []);
}
/**
* Provides a list of configs to test.
*/
public function providerGetConfig() {
return [
['un', count(LanguageManager::getUnitedNationsLanguageList())],
['all', count(LanguageManager::getStandardLanguageList())],
];
}
/**
* @covers ::getConfig
*
* @dataProvider providerGetConfig
*/
public function testGetConfig($language_list, $expected_number) {
$editor = $this->getMockBuilder('Drupal\editor\Entity\Editor')
->disableOriginalConstructor()
->getMock();
$editor->expects($this->once())
->method('getSettings')
->willReturn(['plugins' => ['language' => ['language_list' => $language_list]]]);
$config = $this->plugin->getConfig($editor);
$this->assertInternalType('array', $config);
$this->assertTrue(in_array('ar:Arabic:rtl', $config['language_list']));
$this->assertTrue(in_array('zh-hans:Chinese, Simplified', $config['language_list']));
$this->assertTrue(in_array('en:English', $config['language_list']));
$this->assertTrue(in_array('fr:French', $config['language_list']));
$this->assertTrue(in_array('ru:Russian', $config['language_list']));
$this->assertTrue(in_array('ar:Arabic:rtl', $config['language_list']));
$this->assertEquals($expected_number, count($config['language_list']));
}
}