From b6f4e50475b54f3e5630577d8ffc4a55ed56db8d Mon Sep 17 00:00:00 2001
From: Lauri Eskola <lauri.eskola@acquia.com>
Date: Thu, 14 Jul 2022 22:09:53 +0300
Subject: [PATCH] Issue #3245967 by bnjmnm, Wim Leers, nod_, lauriii,
tim.plunkett, andregp, Antoniya, AaronMcHale, rkoller, cedewey,
worldlinemine, shaal: Messages upon switching to CKEditor 5 are overwhelming
---
core/modules/ckeditor5/ckeditor5.module | 16 +-
core/modules/ckeditor5/ckeditor5.services.yml | 6 +
.../ckeditor5/src/Plugin/Editor/CKEditor5.php | 21 +-
.../ckeditor5/src/SmartDefaultSettings.php | 233 ++++++++++++++++--
.../CKEditor5AllowedTagsTest.php | 3 +-
.../src/Kernel/SmartDefaultSettingsTest.php | 222 ++++++++++++++---
6 files changed, 435 insertions(+), 66 deletions(-)
diff --git a/core/modules/ckeditor5/ckeditor5.module b/core/modules/ckeditor5/ckeditor5.module
index e93fb5dd5105..1eb0293a8535 100644
--- a/core/modules/ckeditor5/ckeditor5.module
+++ b/core/modules/ckeditor5/ckeditor5.module
@@ -36,8 +36,6 @@ function ckeditor5_help($route_name, RouteMatchInterface $route_match) {
$output .= '<dl>';
$output .= '<dt>' . t('Enabling CKEditor 5 for individual text formats') . '</dt>';
$output .= '<dd>' . t('CKEditor 5 has to be enabled and configured separately for individual text formats from the <a href=":formats">Text formats and editors page</a> because the filter settings for each text format can be different. For more information, see the <a href=":text_editor">Text Editor help page</a> and <a href=":filter">Filter help page</a>.', [':formats' => Url::fromRoute('filter.admin_overview')->toString(), ':text_editor' => Url::fromRoute('help.page', ['name' => 'editor'])->toString(), ':filter' => Url::fromRoute('help.page', ['name' => 'filter'])->toString()]) . '</dd>';
- $output .= '<dt>' . t('Migration for existing text formats switching to CKEditor 5') . '</dt>';
- $output .= '<dd>' . t('Text formats switching to CKEditor 5 from CKEditor 4 (or no text editor) should be able to do so with minimal effort and zero data loss. Existing configuration will be automatically migrated to CKEditor 5 compatible configuration. In instances where functionality can not be migrated, detailed messages are provided explaining what is necessary for feature parity.') . '</dd>';
$output .= '<dt>' . t('Configuring the toolbar') . '</dt>';
$output .= '<dd>' . t('When CKEditor 5 is chosen from the <em>Text editor</em> drop-down menu, its toolbar configuration is displayed. You can add and remove buttons from the <em>Active toolbar</em> by dragging and dropping them. Separators and rows can be added to organize the buttons.') . '</dd>';
$output .= '<dt>' . t('Filtering HTML content') . '</dt>';
@@ -61,6 +59,20 @@ function ckeditor5_help($route_name, RouteMatchInterface $route_match) {
$output .= '</ul>';
$output .= '</dd>';
$output .= '</dl>';
+ $output .= '<h3 id="migration-settings">' . t('Migrating an Existing Text Format to CKEditor 5') . '</h3>';
+ $output .= '<p>' . t('When switching an existing text format to use CKEditor 5, an automatic process is initiated that helps text formats switching to CKEditor 5 from CKEditor 4 (or no text editor) to do so with minimal effort and zero data loss.') . '</p>';
+ $output .= '<p>' . t("This process is designed for there to be no data loss risk in switching to CKEditor 5. However some of your editor's functionality may not be 100% equivalent to what was available previously. In most cases, these changes are minimal. After the process completes, status and/or warning messages will summarize any changes that occurred, and more detailed information will be available in the site's logs.") . '</p>';
+ $output .= '<p>' . t('CKEditor 5 will attempt to enable plugins that provide equivalent toolbar items to those used prior to switching to CKEditor 5. All core CKEditor 4 plugins and many popular contrib plugins already have CKEditor 5 equivalents. In some cases, functionality that required contrib modules is now built into CKEditor 5. In instances where a plugin does not have an equivalent, no data loss will occur but elements previously provided via the plugin may need to be added manually as HTML via source editing.') . '</p>';
+ $output .= '<h4>' . t('Additional migration considerations for text formats with restricted HTML') . '</h4>';
+ $output .= '<dl>';
+ $output .= '<dt>' . t('The “Allowed HTML tags" field in the “Limit allowed HTML tags and correct Faulty HTML" filter is now read-only') . '</dt>';
+ $output .= '<dd>' . t('This field accurately represents the tags/attributes allowed by a text format, but the allowed tags are based on which plugins are enabled and how they are configured. For example, enabling the Underline plugin adds the <u> tag to “Allowed HTML tags".') . '</dd>';
+ $output .= '<dt id="required-tags">' . t('The <p> and <br > tags will be automatically added to your text format.') . '</dt>';
+ $output .= '<dd>' . t('CKEditor 5 requires the <p> and <br > tags to achieve basic functionality. They will be automatically added to “Allowed HTML tags" on formats that previously did not allow them.') . '</dd>';
+ $output .= '<dt id="source-editing">' . t('Tags/attributes that are not explicitly supported by any plugin are supported by Source Editing') . '</dt>';
+ $output .= '<dd>' . t('When a necessary tag/attribute is not directly supported by an available plugin, the "Source Editing" plugin is enabled. This plugin is typically used for by passing the CKEditor 5 UI and editing contents as HTML source. In the settings for Source Editing, tags/attributes that aren\'t available via other plugins are added to Source Editing\'s "Manually editable HTML tags" setting so they are supported by the text format.') . '</dd>';
+ $output .= '</dl>';
+
return $output;
}
}
diff --git a/core/modules/ckeditor5/ckeditor5.services.yml b/core/modules/ckeditor5/ckeditor5.services.yml
index fad12eec39e9..b235935a8fe9 100644
--- a/core/modules/ckeditor5/ckeditor5.services.yml
+++ b/core/modules/ckeditor5/ckeditor5.services.yml
@@ -12,6 +12,9 @@ services:
arguments:
- '@plugin.manager.ckeditor5.plugin'
- '@plugin.manager.ckeditor4to5upgrade.plugin'
+ - '@logger.channel.ckeditor5'
+ - '@module_handler'
+ - '@current_user'
ckeditor5.stylesheets.message:
class: Drupal\ckeditor5\CKEditor5StylesheetsMessage
arguments:
@@ -22,3 +25,6 @@ services:
arguments: ['@cache_tags.invalidator']
tags:
- { name: event_subscriber }
+ logger.channel.ckeditor5:
+ parent: logger.channel_base
+ arguments: [ 'ckeditor5' ]
diff --git a/core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php b/core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
index 2103ca7e3c43..3bc43daf7eeb 100644
--- a/core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
+++ b/core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
@@ -26,6 +26,7 @@
use Drupal\editor\Entity\Editor;
use Drupal\editor\Plugin\EditorBase;
use Drupal\filter\FilterFormatInterface;
+use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationListInterface;
@@ -107,6 +108,13 @@ class CKEditor5 extends EditorBase implements ContainerFactoryPluginInterface {
*/
private $stylesheetsMessage;
+ /**
+ * A logger instance.
+ *
+ * @var \Psr\Log\LoggerInterface
+ */
+ protected $logger;
+
/**
* Constructs a CKEditor5 editor plugin.
*
@@ -128,8 +136,10 @@ class CKEditor5 extends EditorBase implements ContainerFactoryPluginInterface {
* The cache.
* @param \Drupal\ckeditor5\CKEditor5StylesheetsMessage $stylesheets_message
* The ckeditor_stylesheets message utility.
+ * @param \Psr\Log\LoggerInterface $logger
+ * A logger instance.
*/
- public function __construct(array $configuration, $plugin_id, $plugin_definition, CKEditor5PluginManagerInterface $ckeditor5_plugin_manager, LanguageManagerInterface $language_manager, ModuleHandlerInterface $module_handler, SmartDefaultSettings $smart_default_settings, CacheBackendInterface $cache, CKEditor5StylesheetsMessage $stylesheets_message) {
+ public function __construct(array $configuration, $plugin_id, $plugin_definition, CKEditor5PluginManagerInterface $ckeditor5_plugin_manager, LanguageManagerInterface $language_manager, ModuleHandlerInterface $module_handler, SmartDefaultSettings $smart_default_settings, CacheBackendInterface $cache, CKEditor5StylesheetsMessage $stylesheets_message, LoggerInterface $logger) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->ckeditor5PluginManager = $ckeditor5_plugin_manager;
$this->languageManager = $language_manager;
@@ -137,6 +147,7 @@ public function __construct(array $configuration, $plugin_id, $plugin_definition
$this->smartDefaultSettings = $smart_default_settings;
$this->cache = $cache;
$this->stylesheetsMessage = $stylesheets_message;
+ $this->logger = $logger;
}
/**
@@ -152,7 +163,8 @@ public static function create(ContainerInterface $container, array $configuratio
$container->get('module_handler'),
$container->get('ckeditor5.smart_default_settings'),
$container->get('cache.default'),
- $container->get('ckeditor5.stylesheets.message')
+ $container->get('ckeditor5.stylesheets.message'),
+ $container->get('logger.channel.ckeditor5')
);
}
@@ -264,6 +276,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta
assert($editor->getSettings() === $this->getDefaultSettings());
if (!$format->isNew()) {
[$editor, $messages] = $this->smartDefaultSettings->computeSmartDefaultSettings($editor, $format);
+ $form_state->set('used_smart_default_settings', TRUE);
foreach ($messages as $type => $messages_per_type) {
foreach ($messages_per_type as $message) {
$this->messenger()->addMessage($message, $type);
@@ -880,6 +893,10 @@ public function submitConfigurationForm(array &$form, FormStateInterface $form_s
$form_state->setValues($editor->getSettings());
parent::submitConfigurationForm($form, $form_state);
+ if ($form_state->get('used_smart_default_settings')) {
+ $format_name = $editor->getFilterFormat()->get('name');
+ $this->logger->info($this->t('The migration of %text_format to CKEditor 5 has been saved.', ['%text_format' => $format_name]));
+ }
}
/**
diff --git a/core/modules/ckeditor5/src/SmartDefaultSettings.php b/core/modules/ckeditor5/src/SmartDefaultSettings.php
index 8ced076e0e7f..fe55ab1ad7ca 100644
--- a/core/modules/ckeditor5/src/SmartDefaultSettings.php
+++ b/core/modules/ckeditor5/src/SmartDefaultSettings.php
@@ -10,11 +10,16 @@
use Drupal\ckeditor5\Plugin\CKEditor5PluginManagerInterface;
use Drupal\Component\Assertion\Inspector;
use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Component\Render\FormattableMarkup;
+use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Messenger\MessengerInterface;
+use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\Core\Url;
use Drupal\editor\EditorInterface;
use Drupal\editor\Entity\Editor;
use Drupal\filter\FilterFormatInterface;
+use Psr\Log\LoggerInterface;
/**
* Generates CKEditor 5 settings for existing text editors/formats.
@@ -40,6 +45,27 @@ final class SmartDefaultSettings {
*/
protected $upgradePluginManager;
+ /**
+ * The module handler.
+ *
+ * @var \Drupal\Core\Extension\ModuleHandlerInterface
+ */
+ protected $moduleHandler;
+
+ /**
+ * The current user.
+ *
+ * @var \Drupal\Core\Session\AccountInterface
+ */
+ protected $currentUser;
+
+ /**
+ * A logger instance.
+ *
+ * @var \Psr\Log\LoggerInterface
+ */
+ protected $logger;
+
/**
* Constructs a SmartDefaultSettings object.
*
@@ -47,10 +73,19 @@ final class SmartDefaultSettings {
* The CKEditor 5 plugin manager.
* @param \Drupal\Component\Plugin\PluginManagerInterface $upgrade_plugin_manager
* The CKEditor 4 to 5 upgrade plugin manager.
+ * @param \Psr\Log\LoggerInterface $logger
+ * A logger instance.
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * The module handler.
+ * @param \Drupal\Core\Session\AccountInterface $current_user
+ * The current user.
*/
- public function __construct(CKEditor5PluginManagerInterface $plugin_manager, PluginManagerInterface $upgrade_plugin_manager) {
+ public function __construct(CKEditor5PluginManagerInterface $plugin_manager, PluginManagerInterface $upgrade_plugin_manager, LoggerInterface $logger, ModuleHandlerInterface $module_handler, AccountInterface $current_user) {
$this->pluginManager = $plugin_manager;
$this->upgradePluginManager = $upgrade_plugin_manager;
+ $this->logger = $logger;
+ $this->moduleHandler = $module_handler;
+ $this->currentUser = $current_user;
}
/**
@@ -109,9 +144,11 @@ public function computeSmartDefaultSettings(?EditorInterface $text_editor, Filte
]);
$editor->setEditor('ckeditor5');
+ $source_editing_additions = HTMLRestrictions::emptySet();
// Compute the appropriate settings based on the CKEditor 4 configuration
// if it exists.
$old_editor = $editor->id() ? Editor::load($editor->id()) : NULL;
+ $old_editor_restrictions = $old_editor ? HTMLRestrictions::fromTextFormat($old_editor->getFilterFormat()) : HTMLRestrictions::emptySet();
if ($old_editor && $old_editor->getEditor() === 'ckeditor') {
[$upgraded_settings, $messages] = $this->createSettingsFromCKEditor4($old_editor->getSettings(), HTMLRestrictions::fromTextFormat($old_editor->getFilterFormat()));
$editor->setSettings($upgraded_settings);
@@ -122,51 +159,64 @@ public function computeSmartDefaultSettings(?EditorInterface $text_editor, Filte
// NOTE: Helper updates $editor->settings by reference and returns info for the message.
$result = $this->addToolbarItemsToMatchHtmlElementsInFormat($text_format, $editor);
if ($result !== NULL) {
- [$enabling_message_content, $enabled_for_attributes_message_content, $missing] = $result;
+ [$enabling_message_content, $enabled_for_attributes_message_content, $missing, $plugins_enabled] = $result;
// Distinguish between unsupported elements covering only tags or not.
$missing_attributes = new HTMLRestrictions(array_filter($missing->getAllowedElements()));
$unsupported = $missing->diff($missing_attributes);
if ($enabling_message_content) {
- $messages[MessengerInterface::TYPE_STATUS][] = $this->t('The following plugins were enabled to support tags that are allowed by this text format: %enabling_message_content.',
- ['%enabling_message_content' => $enabling_message_content],
- );
+ $this->logger->info(new FormattableMarkup('The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the %text_format text format: %enabling_message_content. The text format must be saved to make these changes active.',
+ [
+ '%text_format' => $editor->getFilterFormat()->get('name'),
+ '%enabling_message_content' => $enabling_message_content,
+ ],
+ ));
}
// Warn user about unsupported tags.
if (!$unsupported->allowsNothing()) {
$this->addTagsToSourceEditing($editor, $unsupported);
- $messages[MessengerInterface::TYPE_STATUS][] = $this->t("The following tags were permitted by this format's filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: @unsupported_string.", [
+ $source_editing_additions = $source_editing_additions->merge($unsupported);
+ $this->logger->info(new FormattableMarkup("The following tags were permitted by the %text_format text format's filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: @unsupported_string. The text format must be saved to make these changes active.", [
+ '%text_format' => $editor->getFilterFormat()->get('name'),
'@unsupported_string' => $unsupported->toFilterHtmlAllowedTagsString(),
- ]);
+ ]));
}
if ($enabled_for_attributes_message_content) {
- $messages[MessengerInterface::TYPE_STATUS][] = $this->t('The following plugins were enabled to support specific attributes that are allowed by this text format: %enabled_for_attributes_message_content.',
- ['%enabled_for_attributes_message_content' => $enabled_for_attributes_message_content],
- );
+ $this->logger->info(new FormattableMarkup('The CKEditor 5 migration process enabled the following plugins to support specific attributes that are allowed by the %text_format text format: %enabled_for_attributes_message_content.',
+ [
+ '%text_format' => $editor->getFilterFormat()->get('name'),
+ '%enabled_for_attributes_message_content' => $enabled_for_attributes_message_content,
+ ],
+ ));
}
// Warn user about supported tags but missing attributes.
if (!$missing_attributes->allowsNothing()) {
$this->addTagsToSourceEditing($editor, $missing_attributes);
- $messages[MessengerInterface::TYPE_STATUS][] = $this->t("This format's HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: @missing_attributes.", [
+ $source_editing_additions = $source_editing_additions->merge($missing_attributes);
+ $this->logger->info(new FormattableMarkup("As part of migrating to CKEditor 5, it was found that the %text_format text format's HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: @missing_attributes. The text format must be saved to make these changes active.", [
+ '%text_format' => $editor->getFilterFormat()->get('name'),
'@missing_attributes' => $missing_attributes->toFilterHtmlAllowedTagsString(),
- ]);
+ ]));
}
}
- if ($editor->getFilterFormat()->filters('filter_html')->status) {
- $filter_html_restrictions = HTMLRestrictions::fromTextFormat($editor->getFilterFormat());
+ $has_html_restrictions = $editor->getFilterFormat()->filters('filter_html')->status;
+ $missing_fundamental_tags = HTMLRestrictions::emptySet();
+ if ($has_html_restrictions) {
$fundamental = new HTMLRestrictions($this->pluginManager->getProvidedElements([
'ckeditor5_essentials',
'ckeditor5_paragraph',
]));
- $missing_tags = $fundamental->diff($filter_html_restrictions);
- if (!$missing_tags->allowsNothing()) {
+ $filter_html_restrictions = HTMLRestrictions::fromTextFormat($editor->getFilterFormat());
+ $missing_fundamental_tags = $fundamental->diff($filter_html_restrictions);
+ if (!$missing_fundamental_tags->allowsNothing()) {
$editor->getFilterFormat()->setFilterConfig('filter_html', $filter_html_restrictions->merge($fundamental)->getAllowedElements());
- $messages[MessengerInterface::TYPE_STATUS][] = $this->t("The following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : @missing_tags.", [
- '@missing_tags' => $missing_tags->toFilterHtmlAllowedTagsString(),
- ]);
+ $this->logger->warning(new FormattableMarkup("As part of migrating the %text_format text format to CKEditor 5, the following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : @missing_tags. The text format must be saved to make these changes active.", [
+ '%text_format' => $editor->getFilterFormat()->get('name'),
+ '@missing_tags' => $missing_fundamental_tags->toFilterHtmlAllowedTagsString(),
+ ]));
}
}
@@ -194,6 +244,140 @@ public function computeSmartDefaultSettings(?EditorInterface $text_editor, Filte
$editor->setSettings($settings);
}
+ if ($has_html_restrictions) {
+ // Determine what tags/attributes are allowed in this text format that were
+ // not allowed previous to the switch.
+ $allowed_by_new_plugin_config = new HTMLRestrictions($this->pluginManager->getProvidedElements(array_keys($this->pluginManager->getEnabledDefinitions($editor)), $editor));
+ $surplus_tags_attributes = $allowed_by_new_plugin_config->diff($old_editor_restrictions)->diff($missing_fundamental_tags);
+ $attributes_to_tag = [];
+ $added_tags = [];
+ if (!$surplus_tags_attributes->allowsNothing()) {
+ $surplus_elements = $surplus_tags_attributes->getAllowedElements();
+ $added_tags = array_diff_key($surplus_elements, $old_editor_restrictions->getAllowedElements());
+ foreach ($surplus_elements as $tag => $attributes) {
+ $the_attributes = is_array($attributes) ? $attributes : [];
+ foreach ($the_attributes as $attribute_name => $enabled) {
+ if ($enabled) {
+ $attributes_to_tag[$attribute_name][] = $tag;
+ }
+ }
+ }
+ }
+
+ $help_enabled = $this->moduleHandler->moduleExists('help');
+
+ if (!empty($plugins_enabled) || !$source_editing_additions->allowsNothing()) {
+ $beginning = $help_enabled ?
+ $this->t('To maintain the capabilities of this text format, <a target="_blank" href=":ck_migration_url">the CKEditor 5 migration</a> did the following:', [
+ ':ck_migration_url' => Url::fromRoute('help.page', ['name' => 'ckeditor5'], ['fragment' => 'migration-settings'])->toString(),
+ ]) :
+ $this->t('To maintain the capabilities of this text format, the CKEditor 5 migration did the following:');
+
+ $plugin_info = !empty($plugins_enabled) ?
+ $this->t('Enabled these plugins: (%plugins).', [
+ '%plugins' => implode(', ', $plugins_enabled),
+ ]) : '';
+
+ $source_editing_info = '';
+ if (!$source_editing_additions->allowsNothing()) {
+ $source_editing_info = $help_enabled ?
+ $this->t('Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href=":source_edit_url">Manually editable HTML tags</a> setting: @tag_list',
+ [
+ '@tag_list' => $source_editing_additions->toFilterHtmlAllowedTagsString(),
+ ':source_edit_url' => Url::fromRoute('help.page', ['name' => 'ckeditor5'], ['fragment' => 'source-editing'])->toString(),
+ ]) :
+ $this->t("Added these tags/attributes to the Source Editing Plugin's Manually editable HTML tags setting: @tag_list", ['@tag_list' => $source_editing_additions->toFilterHtmlAllowedTagsString()]);
+ }
+
+ $can_access_dblog = ($this->currentUser->hasPermission('access site reports') && $this->moduleHandler->moduleExists('dblog'));
+ $end = $can_access_dblog ?
+ $this->t('Additional details are available <a target="_blank" href=":dblog_url">in your logs</a>.',
+ [
+ ':dblog_url' => Url::fromRoute('dblog.overview')
+ ->setOption('query', ['type[]' => 'ckeditor5'])
+ ->toString(),
+ ]
+ ) :
+ $this->t('Additional details are available in your logs.');
+
+ $messages[MessengerInterface::TYPE_STATUS][] = new FormattableMarkup('@beginning @plugin_info @source_editing_info. @end', [
+ '@beginning' => $beginning,
+ '@plugin_info' => $plugin_info,
+ '@source_editing_info' => $source_editing_info,
+ '@end' => $end,
+ ]);
+ }
+
+ // Generate warning for:
+ // - The addition of <p>/<br> due to them being fundamental tags.
+ // - The addition of other tags/attributes previously unsupported by the
+ // format.
+ if (!$missing_fundamental_tags->allowsNothing() || !empty($attributes_to_tag) || !empty($added_tags)) {
+ $beginning = $this->t('Updating to CKEditor 5 added support for some previously unsupported tags/attributes.');
+ $fundamental_tags = '';
+ if ($help_enabled && !$missing_fundamental_tags->allowsNothing()) {
+ $fundamental_tags = $this->formatPlural(count($missing_fundamental_tags->toCKEditor5ElementsArray()),
+ 'The @tag tag was added because it is <a target="_blank" href=":fundamental_tag_link">required by CKEditor 5</a>.',
+ 'The @tag tags were added because they are <a target="_blank" href=":fundamental_tag_link">required by CKEditor 5</a>.',
+ [
+ '@tag' => implode(', ', $missing_fundamental_tags->toCKEditor5ElementsArray()),
+ ':fundamental_tag_link' => URL::fromRoute('help.page', ['name' => 'ckeditor5'], ['fragment' => 'required-tags'])->toString(),
+ ]);
+ }
+ elseif (!$missing_fundamental_tags->allowsNothing()) {
+ $fundamental_tags = $this->formatPlural(count($missing_fundamental_tags->toCKEditor5ElementsArray()),
+ 'The @tag tag was added because it is required by CKEditor 5.',
+ 'The @tag tags were added because they are required by CKEditor 5.',
+ [
+ '@tag' => implode(', ', $missing_fundamental_tags->toCKEditor5ElementsArray()),
+ ]);
+ }
+
+ $added_elements_begin = !empty($attributes_to_tag) || !empty($added_tags) ? $this->t('A plugin introduced support for the following:') : '';
+ $added_elements_tags = !empty($added_tags) ? $this->formatPlural(
+ count($added_tags),
+ 'The tag %tags;',
+ 'The tags %tags;',
+ [
+ '%tags' => implode(', ', array_map(function ($tag_name) {
+ return "<$tag_name>";
+ }, array_keys($added_tags))),
+ ]) : '';
+ $added_elements_attributes = !empty($attributes_to_tag) ? $this->formatPlural(
+ count($attributes_to_tag),
+ 'This attribute: %attributes;',
+ 'These attributes: %attributes;',
+ [
+ '%attributes' => rtrim(array_reduce(array_keys($attributes_to_tag), function ($carry, $item) use ($attributes_to_tag) {
+ $for_tags = implode(', ', array_map(function ($item) {
+ return "<$item>";
+ }, $attributes_to_tag[$item]));
+ return "$carry $item ({$this->t('for', [], ['context' => 'Ckeditor 5 tag list'])} $for_tags),";
+ }, ''), " ,"),
+ ]
+ ) : '';
+ $end = $can_access_dblog ?
+ $this->t('Additional details are available <a target="_blank" href=":dblog_url">in your logs</a>.',
+ [
+ ':dblog_url' => Url::fromRoute('dblog.overview')
+ ->setOption('query', ['type[]' => 'ckeditor5'])
+ ->toString(),
+ ]
+ ) :
+ $this->t('Additional details are available in your logs.');
+
+ $messages[MessengerInterface::TYPE_WARNING][] = new FormattableMarkup('@beginning @added_elements_begin @fundamental_tags @added_elements_tags @added_elements_attributes @end',
+ [
+ '@beginning' => $beginning,
+ '@added_elements_begin' => $added_elements_begin,
+ '@fundamental_tags' => $fundamental_tags,
+ '@added_elements_tags' => $added_elements_tags,
+ '@added_elements_attributes' => $added_elements_attributes,
+ '@end' => $end,
+ ]);
+ }
+ }
+
return [$editor, $messages];
}
@@ -249,6 +433,9 @@ private function createSettingsFromCKEditor4(array $ckeditor4_settings, HTMLRest
$equivalent = $this->upgradePluginManager->mapCKEditor4ToolbarButtonToCKEditor5ToolbarItem($cke4_button, $text_format_html_restrictions);
}
catch (\OutOfBoundsException $e) {
+ $this->logger->warning(new FormattableMarkup('The CKEditor 4 button %button does not have a known upgrade path. If it allowed editing markup, then you can do so now through the Source Editing functionality.', [
+ '%button' => $cke4_button,
+ ]));
$messages[MessengerInterface::TYPE_WARNING][] = $this->t('The CKEditor 4 button %button does not have a known upgrade path. If it allowed editing markup, then you can do so now through the Source Editing functionality.', [
'%button' => $cke4_button,
]);
@@ -287,6 +474,9 @@ private function createSettingsFromCKEditor4(array $ckeditor4_settings, HTMLRest
$settings['plugins'] += $cke5_plugin_settings;
}
catch (\OutOfBoundsException $e) {
+ $this->logger->warning(new FormattableMarkup('The %cke4_plugin_id plugin settings do not have a known upgrade path.', [
+ '%cke4_plugin_id' => $cke4_plugin_id,
+ ]));
$messages[MessengerInterface::TYPE_WARNING][] = $this->t('The %cke4_plugin_id plugin settings do not have a known upgrade path.', [
'%cke4_plugin_id' => $cke4_plugin_id,
]);
@@ -640,7 +830,7 @@ private function addToolbarItemsToMatchHtmlElementsInFormat(FilterFormatInterfac
// Combine the selection.
$selected_plugins = array_merge_recursive($selected_plugins_plain_tags, $selected_plugins_attributes);
- // If additional plugins need to be enable to support attribute config,
+ // If additional plugins need to be enabled to support attribute config,
// loop through the list to enable the plugins and build a UI message that
// will convey this plugin-enabling to the user.
if (!empty($selected_plugins)) {
@@ -652,13 +842,13 @@ private function addToolbarItemsToMatchHtmlElementsInFormat(FilterFormatInterfac
foreach ($selected_plugins as $plugin_id => $reason_why_enabled) {
$plugin_definition = $this->pluginManager->getDefinition($plugin_id);
$label = $plugin_definition->label();
+ $plugins_enabled[] = $label;
if ($plugin_definition->hasToolbarItems()) {
[$net_new] = self::computeNetNewElementsForPlugin($provided, $still_needed, $plugin_definition);
$editor_settings_to_update['toolbar']['items'] = array_merge($editor_settings_to_update['toolbar']['items'], array_keys($plugin_definition->getToolbarItems()));
foreach ($reason_why_enabled as $attribute_name => $attribute_config) {
// Plugin was selected for tag.
if (in_array($attribute_name, ['-attributes-none-', '-attributes-any-'], TRUE)) {
- $label = $plugin_definition->label();
$tags = array_reduce(array_keys($net_new->getAllowedElements()), function ($carry, $item) {
return $carry . "<$item>";
});
@@ -690,6 +880,7 @@ private function addToolbarItemsToMatchHtmlElementsInFormat(FilterFormatInterfac
substr($enabled_for_tags_message_content, 0, -1),
substr($enabled_for_attributes_message_content, 0, -2),
$still_needed,
+ $plugins_enabled,
];
}
else {
diff --git a/core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php b/core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php
index 9d83ae6d0fd4..5e7ef0c19c78 100644
--- a/core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php
+++ b/core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php
@@ -162,8 +162,7 @@ public function testSwitchToVersion5() {
$page->selectFieldOption('editor[editor]', 'ckeditor5');
$assert_session->assertWaitOnAjaxRequest();
-
- $assert_session->pageTextContains('The following tag(s) were added to Limit allowed HTML tags and correct faulty HTML, because they are needed to provide fundamental CKEditor 5 functionality : <br> <p>');
+ $assert_session->pageTextContains('The <br>, <p> tags were added because they are required by CKEditor 5');
$this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $this->defaultElementsAfterUpdatingToCkeditor5);
$page->pressButton('Save configuration');
diff --git a/core/modules/ckeditor5/tests/src/Kernel/SmartDefaultSettingsTest.php b/core/modules/ckeditor5/tests/src/Kernel/SmartDefaultSettingsTest.php
index f7aeaf253d7c..c0a9cece8d2b 100644
--- a/core/modules/ckeditor5/tests/src/Kernel/SmartDefaultSettingsTest.php
+++ b/core/modules/ckeditor5/tests/src/Kernel/SmartDefaultSettingsTest.php
@@ -44,6 +44,13 @@ class SmartDefaultSettingsTest extends KernelTestBase {
*/
protected $smartDefaultSettings;
+ /**
+ * The database connection used.
+ *
+ * @var \Drupal\Core\Database\Connection
+ */
+ protected $database;
+
/**
* {@inheritdoc}
*/
@@ -60,6 +67,8 @@ class SmartDefaultSettingsTest extends KernelTestBase {
'views',
// @todo Remove in https://www.drupal.org/project/drupal/issues/3263384
'ckeditor5_plugin_conditions_test',
+ 'dblog',
+ 'help',
];
/**
@@ -70,6 +79,9 @@ protected function setUp(): void {
$this->manager = $this->container->get('plugin.manager.ckeditor5.plugin');
$this->typedConfig = $this->container->get('config.typed');
$this->smartDefaultSettings = $this->container->get('ckeditor5.smart_default_settings');
+ $this->database = $this->container->get('database');
+
+ $this->installSchema('dblog', ['watchdog']);
FilterFormat::create(
Yaml::parseFile('core/profiles/standard/config/install/filter.format.full_html.yml')
@@ -340,6 +352,8 @@ protected function setUp(): void {
* @param array $expected_fundamental_compatibility_violations
* All expected fundamental compatibility violations for the given text
* format.
+ * @param string[] $expected_db_logs
+ * The expected database logs associated with the computed settings.
* @param string[] $expected_messages
* The expected messages associated with the computed settings.
* @param array|null $expected_post_filter_drop_fundamental_compatibility_violations
@@ -351,7 +365,7 @@ protected function setUp(): void {
*
* @dataProvider provider
*/
- public function test(string $format_id, array $filters_to_drop, array $expected_ckeditor5_settings, string $expected_superset, array $expected_fundamental_compatibility_violations, array $expected_messages, ?array $expected_post_filter_drop_fundamental_compatibility_violations = NULL, ?array $expected_post_update_text_editor_violations = NULL): void {
+ public function test(string $format_id, array $filters_to_drop, array $expected_ckeditor5_settings, string $expected_superset, array $expected_fundamental_compatibility_violations, array $expected_db_logs, array $expected_messages, ?array $expected_post_filter_drop_fundamental_compatibility_violations = NULL, ?array $expected_post_update_text_editor_violations = NULL): void {
$text_format = FilterFormat::load($format_id);
$text_editor = Editor::load($format_id);
@@ -449,6 +463,24 @@ public function test(string $format_id, array $filters_to_drop, array $expected_
$this->assertSame($expected_post_update_text_editor_violations, $updated_validation_errors);
}
+ $db_logged = $this
+ ->database
+ ->select('watchdog', 'w')
+ ->fields('w', ['message', 'variables', 'severity'])
+ ->condition('type', 'ckeditor5')
+ ->orderBy('wid')
+ ->execute()
+ ->fetchAll();
+
+ $type_to_status = [
+ 6 => 'status',
+ 4 => 'warning',
+ ];
+ $db_logs = [];
+ foreach ($db_logged as $log) {
+ $db_logs[$type_to_status[$log->severity]][] = $log->message;
+ }
+
// Transforms TranslatableMarkup objects to string.
foreach ($messages as $type => $messages_per_type) {
foreach ($messages_per_type as $key => $message) {
@@ -456,6 +488,7 @@ public function test(string $format_id, array $filters_to_drop, array $expected_
}
}
+ $this->assertSame($expected_db_logs, $db_logs);
$this->assertSame($expected_messages, $messages);
}
@@ -532,20 +565,26 @@ public function provider() {
],
'expected_superset' => '',
'expected_fundamental_compatibility_violations' => [],
- 'expected_messages' => [
+ 'expected_db_logs' => [
'status' => [
- 'The following plugins were enabled to support tags that are allowed by this text format: <em class="placeholder">Code (for tags: <code>)</em>.',
- 'The following tags were permitted by this format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
],
],
+ 'expected_messages' => [],
];
yield "basic_html can be switched to CKEditor 5 without problems (3 upgrade messages)" => NestedArray::mergeDeep(
$basic_html_test_case,
[
+ 'expected_db_logs' => [
+ 'status' => [
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
],
],
]
@@ -566,9 +605,14 @@ public function provider() {
],
],
],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-caption>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-caption>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-caption>. Additional details are available in your logs.',
],
],
]);
@@ -588,9 +632,14 @@ public function provider() {
],
],
],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-align>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-align>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-align>. Additional details are available in your logs.',
],
],
]);
@@ -620,11 +669,18 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h5 id>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (without H4 and H6)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (without H4 and H6)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (without H4 and H6)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h5 id>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h5 id>. Additional details are available in your logs.',
+ ],
+ ],
];
yield "basic_html_with_h1 can be switched to CKEditor 5 without problems, heading configuration computed automatically" => [
@@ -652,11 +708,18 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (with <h1>)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (with <h1>)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (with <h1>)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ ],
];
yield "basic_html_without_headings can be switched to CKEditor 5 without problems, heading configuration computed automatically" => [
@@ -682,11 +745,18 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (without H*)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (without H*)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (without H*)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type>. Additional details are available in your logs.',
+ ],
+ ],
];
yield "basic_html_with_pre can be switched to CKEditor 5 without problems, heading configuration computed automatically" => [
@@ -703,11 +773,19 @@ public function provider() {
],
'expected_superset' => '<code class="language-*">',
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (with <pre>)</em> text format: <em class="placeholder">Code (for tags: <code>) Code Block (for tags: <pre>)</em>. The text format must be saved to make these changes active.',
+ str_replace('Basic HTML', 'Basic HTML (with <pre>)', $basic_html_test_case['expected_db_logs']['status'][1]),
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (with <pre>)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'The following plugins were enabled to support tags that are allowed by this text format: <em class="placeholder">Code (for tags: <code>) Code Block (for tags: <pre>)</em>.',
- $basic_html_test_case['expected_messages']['status'][1],
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code, Code Block</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ 'warning' => [
+ 'Updating to CKEditor 5 added support for some previously unsupported tags/attributes. A plugin introduced support for the following: This attribute: <em class="placeholder"> class (for <code>)</em>; Additional details are available in your logs.',
],
],
];
@@ -746,12 +824,22 @@ public function provider() {
'<h6 class="text-align-center text-align-justify">',
]),
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- 'The following plugins were enabled to support specific attributes that are allowed by this text format: <em class="placeholder">Alignment ( for tag: <p> to support: class with value(s): text-align-center, text-align-justify)</em>.',
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (with alignable paragraph support)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (with alignable paragraph support)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'The CKEditor 5 migration process enabled the following plugins to support specific attributes that are allowed by the <em class="placeholder">Basic HTML (with alignable paragraph support)</em> text format: <em class="placeholder">Alignment ( for tag: <p> to support: class with value(s): text-align-center, text-align-justify)</em>.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (with alignable paragraph support)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code, Alignment</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ 'warning' => [
+ 'Updating to CKEditor 5 added support for some previously unsupported tags/attributes. A plugin introduced support for the following: This attribute: <em class="placeholder"> class (for <h2>, <h3>, <h4>, <h5>, <h6>)</em>; Additional details are available in your logs.',
+ ],
+ ],
];
yield "basic_html with media_embed added (3 upgrade messages)" => [
@@ -769,11 +857,18 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- "This format's HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.",
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (with Media Embed support)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (with Media Embed support)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (with Media Embed support)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ ],
];
yield "basic_html with media_embed added with data-view-mode allowed but no view modes configured (3 upgrade messages, 1 violation)" => [
@@ -791,9 +886,16 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">(with Media Embed support, view mode enabled but no view modes configured)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">(with Media Embed support, view mode enabled but no view modes configured)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">(with Media Embed support, view mode enabled but no view modes configured)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
'status' => [
- "This format's HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.",
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
],
]),
'expected_post_filter_drop_fundamental_compatibility_violations' => [],
@@ -817,9 +919,16 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">(with Media Embed support, view mode enabled and two view modes configured )</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">(with Media Embed support, view mode enabled and two view modes configured )</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">(with Media Embed support, view mode enabled and two view modes configured )</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
'status' => [
- "This format's HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin's <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.",
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
],
]),
'expected_post_filter_drop_fundamental_compatibility_violations' => [],
@@ -842,11 +951,18 @@ public function provider() {
],
'expected_superset' => $basic_html_test_case['expected_superset'],
'expected_fundamental_compatibility_violations' => $basic_html_test_case['expected_fundamental_compatibility_violations'],
- 'expected_messages' => array_merge_recursive($basic_html_test_case['expected_messages'], [
+ 'expected_db_logs' => [
'status' => [
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-*>.',
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Basic HTML (with any data-* attribute on images)</em> text format: <em class="placeholder">Code (for tags: <code>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Basic HTML (with any data-* attribute on images)</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd> <span>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Basic HTML (with any data-* attribute on images)</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-*>. The text format must be saved to make these changes active.',
],
- ]),
+ ],
+ 'expected_messages' => [
+ 'status' => [
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Code</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <span> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id> <img data-*>. Additional details are available in your logs.',
+ ],
+ ],
];
yield "restricted_html can be switched to CKEditor 5 after dropping the two markup-creating filters (3 upgrade messages)" => [
@@ -912,12 +1028,22 @@ public function provider() {
'expected_fundamental_compatibility_violations' => [
'' => 'CKEditor 5 needs at least the <p> and <br> tags to be allowed to be able to function. They are not allowed by the "<em class="placeholder">Limit allowed HTML tags and correct faulty HTML</em>" (<em class="placeholder">filter_html</em>) filter.',
],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Restricted HTML</em> text format: <em class="placeholder">Link (for tags: <a>) Block quote (for tags: <blockquote>) Code (for tags: <code>) List (for tags: <ul><ol><li>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Restricted HTML</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Restricted HTML</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ 'warning' => [
+ 'As part of migrating the <em class="placeholder">Restricted HTML</em> text format to CKEditor 5, the following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : <br> <p>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'The following plugins were enabled to support tags that are allowed by this text format: <em class="placeholder">Link (for tags: <a>) Block quote (for tags: <blockquote>) Code (for tags: <code>) List (for tags: <ul><ol><li>)</em>.',
- 'The following tags were permitted by this format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd>.',
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>.',
- 'The following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : <br> <p>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Link, Block quote, Code, List</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <a hreflang> <blockquote cite> <ul type> <ol type> <h2 id> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ 'warning' => [
+ 'Updating to CKEditor 5 added support for some previously unsupported tags/attributes. A plugin introduced support for the following: The <br>, <p> tags were added because they are <a target="_blank" href="/admin/help/ckeditor5#required-tags">required by CKEditor 5</a>. The tags <em class="placeholder"><h2>, <h3>, <h4>, <h5>, <h6>, <*>, <cite>, <dl>, <dt>, <dd>, <a>, <blockquote>, <ul>, <ol>, <strong>, <em>, <code>, <li></em>; These attributes: <em class="placeholder"> id (for <h2>, <h3>, <h4>, <h5>, <h6>), dir (for <*>), lang (for <*>), hreflang (for <a>), href (for <a>), cite (for <blockquote>), type (for <ul>, <ol>), start (for <ol>)</em>; Additional details are available in your logs.',
],
],
'expected_post_filter_drop_fundamental_compatibility_violations' => [],
@@ -976,6 +1102,7 @@ public function provider() {
],
'expected_superset' => '',
'expected_fundamental_compatibility_violations' => [],
+ 'expected_db_logs' => [],
'expected_messages' => [],
];
@@ -1036,12 +1163,22 @@ public function provider() {
'expected_fundamental_compatibility_violations' => [
'' => 'CKEditor 5 needs at least the <p> and <br> tags to be allowed to be able to function. They are not allowed by the "<em class="placeholder">Limit allowed HTML tags and correct faulty HTML</em>" (<em class="placeholder">filter_html</em>) filter.',
],
+ 'expected_db_logs' => [
+ 'status' => [
+ 'The CKEditor 5 migration enabled the following plugins to support tags that are allowed by the <em class="placeholder">Only the "filter_html" filter and its default settings</em> text format: <em class="placeholder">Link (for tags: <a>) Block quote (for tags: <blockquote>) Code (for tags: <code>) List (for tags: <ul><ol><li>)</em>. The text format must be saved to make these changes active.',
+ 'The following tags were permitted by the <em class="placeholder">Only the "filter_html" filter and its default settings</em> text format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd>. The text format must be saved to make these changes active.',
+ 'As part of migrating to CKEditor 5, it was found that the <em class="placeholder">Only the "filter_html" filter and its default settings</em> text format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type="1 A I"> <h2 id="jump-*"> <h3 id> <h4 id> <h5 id> <h6 id>. The text format must be saved to make these changes active.',
+ ],
+ 'warning' => [
+ 'As part of migrating the <em class="placeholder">Only the "filter_html" filter and its default settings</em> text format to CKEditor 5, the following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : <br> <p>. The text format must be saved to make these changes active.',
+ ],
+ ],
'expected_messages' => [
'status' => [
- 'The following plugins were enabled to support tags that are allowed by this text format: <em class="placeholder">Link (for tags: <a>) Block quote (for tags: <blockquote>) Code (for tags: <code>) List (for tags: <ul><ol><li>)</em>.',
- 'The following tags were permitted by this format\'s filter configuration, but no plugin was available that supports them. To ensure the tags remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <cite> <dl> <dt> <dd>.',
- 'This format\'s HTML filters includes plugins that support the following tags, but not some of their attributes. To ensure these attributes remain supported by this text format, the following were added to the Source Editing plugin\'s <em>Manually editable HTML tags</em>: <a hreflang> <blockquote cite> <ul type> <ol type="1 A I"> <h2 id="jump-*"> <h3 id> <h4 id> <h5 id> <h6 id>.',
- 'The following tag(s) were added to <em>Limit allowed HTML tags and correct faulty HTML</em>, because they are needed to provide fundamental CKEditor 5 functionality : <br> <p>.',
+ 'To maintain the capabilities of this text format, <a target="_blank" href="/admin/help/ckeditor5#migration-settings">the CKEditor 5 migration</a> did the following: Enabled these plugins: (<em class="placeholder">Link, Block quote, Code, List</em>). Added these tags/attributes to the Source Editing Plugin\'s <a target="_blank" href="/admin/help/ckeditor5#source-editing">Manually editable HTML tags</a> setting: <cite> <dl> <dt> <dd> <a hreflang> <blockquote cite> <ul type> <ol type="1 A I"> <h2 id="jump-*"> <h3 id> <h4 id> <h5 id> <h6 id>. Additional details are available in your logs.',
+ ],
+ 'warning' => [
+ 'Updating to CKEditor 5 added support for some previously unsupported tags/attributes. A plugin introduced support for the following: The <br>, <p> tags were added because they are <a target="_blank" href="/admin/help/ckeditor5#required-tags">required by CKEditor 5</a>. The tags <em class="placeholder"><h2>, <h3>, <h4>, <h5>, <h6>, <*>, <cite>, <dl>, <dt>, <dd>, <a>, <blockquote>, <ul>, <ol>, <strong>, <em>, <code>, <li></em>; These attributes: <em class="placeholder"> id (for <h2>, <h3>, <h4>, <h5>, <h6>), dir (for <*>), lang (for <*>), hreflang (for <a>), href (for <a>), cite (for <blockquote>), type (for <ul>, <ol>), start (for <ol>)</em>; Additional details are available in your logs.',
],
],
];
@@ -1063,6 +1200,12 @@ public function provider() {
],
'expected_superset' => '',
'expected_fundamental_compatibility_violations' => [],
+ 'expected_db_logs' => [
+ 'warning' => [
+ 'The CKEditor 4 button <em class="placeholder">Llama</em> does not have a known upgrade path. If it allowed editing markup, then you can do so now through the Source Editing functionality.',
+ 'The <em class="placeholder">llama_contextual_and_button</em> plugin settings do not have a known upgrade path.',
+ ],
+ ],
'expected_messages' => [
'warning' => [
'The CKEditor 4 button <em class="placeholder">Llama</em> does not have a known upgrade path. If it allowed editing markup, then you can do so now through the Source Editing functionality.',
@@ -1084,6 +1227,7 @@ public function provider() {
],
'expected_superset' => '',
'expected_fundamental_compatibility_violations' => [],
+ 'expected_db_logs' => [],
'expected_messages' => [],
];
}
--
GitLab