'', // Don't load CKEditor's config.js file. 'pasteFromWordPromptCleanup' => TRUE, 'removeDialogTabs' => 'image:Link;image:advanced;link:advanced', 'resize_dir' => 'vertical', 'keystrokes' => array( // 0x11000 is CKEDITOR.CTRL, see http://docs.ckeditor.com/#!/api/CKEDITOR-property-CTRL. array(0x110000 + 75, 'link'), array(0x110000 + 76, NULL), ), ); // Add the allowedContent setting, which ensures CKEditor only allows tags // and attributes that are allowed by the text format for this text editor. $config['allowedContent'] = $this->generateAllowedContentSetting($editor); // Add the format_tags setting, if its button is enabled. $toolbar_buttons = array_unique(NestedArray::mergeDeepArray($editor->settings['toolbar']['buttons'])); if (in_array('Format', $toolbar_buttons)) { $config['format_tags'] = $this->generateFormatTagsSetting($editor); } return $config; } /** * Implements \Drupal\ckeditor\Plugin\CKEditorPluginButtonsInterface::getButtons(). */ public function getButtons() { $button = function($name, $direction = 'ltr') { return ''; }; return array( // "basicstyles" plugin. 'Bold' => array( 'label' => t('Bold'), 'image_alternative' => $button('bold'), ), 'Italic' => array( 'label' => t('Italic'), 'image_alternative' => $button('italic'), ), 'Strike' => array( 'label' => t('Strike-through'), 'image_alternative' => $button('strike'), ), 'Superscript' => array( 'label' => t('Superscript'), 'image_alternative' => $button('super script'), ), 'Subscript' => array( 'label' => t('Subscript'), 'image_alternative' => $button('sub script'), ), // "removeformat" plugin. 'RemoveFormat' => array( 'label' => t('Remove format'), 'image_alternative' => $button('remove format'), ), // "list" plugin. 'BulletedList' => array( 'label' => t('Bullet list'), 'image_alternative' => $button('bulleted list'), 'image_alternative_rtl' => $button('bulleted list', 'rtl'), ), 'NumberedList' => array( 'label' => t('Numbered list'), 'image_alternative' => $button('numbered list'), 'image_alternative_rtl' => $button('numbered list', 'rtl'), ), // "indent" plugin. 'Outdent' => array( 'label' => t('Outdent'), 'image_alternative' => $button('outdent'), 'image_alternative_rtl' => $button('outdent', 'rtl'), ), 'Indent' => array( 'label' => t('Indent'), 'image_alternative' => $button('indent'), 'image_alternative_rtl' => $button('indent', 'rtl'), ), // "undo" plugin. 'Undo' => array( 'label' => t('Undo'), 'image_alternative' => $button('undo'), 'image_alternative_rtl' => $button('undo', 'rtl'), ), 'Redo' => array( 'label' => t('Redo'), 'image_alternative' => $button('redo'), 'image_alternative_rtl' => $button('redo', 'rtl'), ), // "link" plugin. 'Link' => array( 'label' => t('Link'), 'image_alternative' => $button('link'), ), 'Unlink' => array( 'label' => t('Unlink'), 'image_alternative' => $button('unlink'), ), 'Anchor' => array( 'label' => t('Anchor'), 'image_alternative' => $button('anchor'), 'image_alternative_rtl' => $button('anchor', 'rtl'), ), // "blockquote" plugin. 'Blockquote' => array( 'label' => t('Blockquote'), 'image_alternative' => $button('blockquote'), ), // "horizontalrule" plugin 'HorizontalRule' => array( 'label' => t('Horizontal rule'), 'image_alternative' => $button('horizontal rule'), ), // "clipboard" plugin. 'Cut' => array( 'label' => t('Cut'), 'image_alternative' => $button('cut'), 'image_alternative_rtl' => $button('cut', 'rtl'), ), 'Copy' => array( 'label' => t('Copy'), 'image_alternative' => $button('copy'), 'image_alternative_rtl' => $button('copy', 'rtl'), ), 'Paste' => array( 'label' => t('Paste'), 'image_alternative' => $button('paste'), 'image_alternative_rtl' => $button('paste', 'rtl'), ), // "pastetext" plugin. 'PasteText' => array( 'label' => t('Paste Text'), 'image_alternative' => $button('paste text'), 'image_alternative_rtl' => $button('paste text', 'rtl'), ), // "pastefromword" plugin. 'PasteFromWord' => array( 'label' => t('Paste from Word'), 'image_alternative' => $button('paste from word'), 'image_alternative_rtl' => $button('paste from word', 'rtl'), ), // "specialchar" plugin. 'SpecialChar' => array( 'label' => t('Character map'), 'image_alternative' => $button('special char'), ), 'Format' => array( 'label' => t('HTML block format'), 'image_alternative' => '', ), // "image" plugin. 'Image' => array( 'label' => t('Image'), 'image_alternative' => $button('image'), ), // "table" plugin. 'Table' => array( 'label' => t('Table'), 'image_alternative' => $button('table'), ), // "showblocks" plugin. 'ShowBlocks' => array( 'label' => t('Show blocks'), 'image_alternative' => $button('show blocks'), 'image_alternative_rtl' => $button('show blocks', 'rtl'), ), // "sourcearea" plugin. 'Source' => array( 'label' => t('Source code'), 'image_alternative' => $button('source'), ), // "maximize" plugin. 'Maximize' => array( 'label' => t('Maximize'), 'image_alternative' => $button('maximize'), ), // No plugin, separator "buttons" for toolbar builder UI use only. '|' => array( 'label' => t('Group separator'), 'image_alternative' => '', 'attributes' => array('class' => array('ckeditor-group-button-separator')), 'multiple' => TRUE, ), '-' => array( 'label' => t('Separator'), 'image_alternative' => '', 'attributes' => array('class' => array('ckeditor-button-separator')), 'multiple' => TRUE, ), ); } /** * Builds the "format_tags" configuration part of the CKEditor JS settings. * * @see getConfig() * * @param \Drupal\editor\Plugin\Core\Entity\Editor $editor * A configured text editor object. * * @return array * An array containing the "format_tags" configuration. */ protected function generateFormatTagsSetting(Editor $editor) { // The
tag is always allowed — HTML without
tags is nonsensical. $format_tags = array('p'); // Given the list of possible format tags, automatically determine whether // the current text format allows this tag, and thus whether it should show // up in the "Format" dropdown. $possible_format_tags = array('h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'pre'); foreach ($possible_format_tags as $tag) { $input = '<' . $tag . '>TEST' . $tag . '>'; $output = trim(check_markup($input, $editor->format)); if ($input == $output) { $format_tags[] = $tag; } } return implode(';', $format_tags); } /** * Builds the "allowedContent" configuration part of the CKEditor JS settings. * * This ensures that CKEditor obeys the HTML restrictions defined by Drupal's * filter system, by enabling CKEditor's Advanced Content Filter (ACF) * functionality: http://ckeditor.com/blog/CKEditor-4.1-RC-Released. * * @see getConfig() * * @param \Drupal\editor\Plugin\Core\Entity\Editor $editor * A configured text editor object. * * @return string|TRUE * The "allowedContent" configuration: a well-formatted string or TRUE. The * latter indicates that anything is allowed. */ protected function generateAllowedContentSetting(Editor $editor) { // When nothing is disallowed, set allowedContent to true. $filter_types = filter_get_filter_types_by_format($editor->format); if (!in_array(FILTER_TYPE_HTML_RESTRICTOR, $filter_types)) { return TRUE; } // Generate setting that accurately reflects allowed tags and attributes. else { $get_allowed_attribute_values = function($attribute_values) { $values = array_keys(array_filter($attribute_values, function($value) { return $value !== FALSE; })); if (count($values)) { return implode(',', $values); } else { return NULL; } }; $html_restrictions = filter_get_html_restrictions_by_format($editor->format); // When all HTML is allowed, also set allowedContent to true. if ($html_restrictions === FALSE) { return TRUE; } $setting = array(); foreach ($html_restrictions['allowed'] as $tag => $attributes) { // Tell CKEditor the tag is allowed, but no attributes. if ($attributes === FALSE) { $setting[$tag] = array( 'attributes' => FALSE, 'styles' => FALSE, 'classes' => FALSE, ); } // Tell CKEditor the tag is allowed, as well as any attribute on it. The // "style" and "class" attributes are handled separately by CKEditor: // they are disallowed even if you specify it in the list of allowed // attributes, unless you state specific values for them that are // allowed. Or, in this case: any value for them is allowed. elseif ($attributes === TRUE) { $setting[$tag] = array( 'attributes' => TRUE, 'styles' => TRUE, 'classes' => TRUE, ); // We've just marked that any value for the "style" and "class" // attributes is allowed. However, that may not be the case: the "*" // tag may still apply restrictions. // Since CKEditor's ACF follows the following principle: // Once validated, an element or its property cannot be // invalidated by another rule. // That means that the most permissive setting wins. Which means that // it will still be allowed by CKEditor to e.g. define any style, no // matter what the "*" tag's restrictions may be. If there's a setting // for either the "style" or "class" attribute, it cannot possibly be // more permissive than what was set above. Hence: inherit from the // "*" tag where possible. if (isset($html_restrictions['allowed']['*'])) { $wildcard = $html_restrictions['allowed']['*']; if (isset($wildcard['style'])) { if (!is_array($wildcard['style'])) { $setting[$tag]['styles'] = $wildcard['style']; } else { $allowed_styles = $get_allowed_attribute_values($wildcard['style']); if (isset($allowed_styles)) { $setting[$tag]['styles'] = $allowed_styles; } else { unset($setting[$tag]['styles']); } } } if (isset($wildcard['class'])) { if (!is_array($wildcard['class'])) { $setting[$tag]['classes'] = $wildcard['class']; } else { $allowed_classes = $get_allowed_attribute_values($wildcard['class']); if (isset($allowed_classes)) { $setting[$tag]['classes'] = $allowed_classes; } else { unset($setting[$tag]['classes']); } } } } } // Tell CKEditor the tag is allowed, along with some tags. elseif (is_array($attributes)) { // CKEditor does not yet support blacklisting, so ignore those. // @todo Update this once http://dev.ckeditor.com/ticket/10276 lands. $attributes = array_filter($attributes, function($value) { return $value !== FALSE; }); // Configure allowed attributes, allowed "style" attribute values and // allowed "class" attribute values. // CKEditor only allows specific values for the "class" and "style" // attributes; so ignore restrictions on other attributes, which // Drupal filters may provide. // NOTE: A Drupal contrib module can subclass this class, override the // getConfig() method, and override the JavaScript at // Drupal.editors.ckeditor to somehow make validation of values for // attributes other than "class" and "style" work. if (count($attributes)) { $setting[$tag]['attributes'] = implode(',', array_keys($attributes)); } if (isset($attributes['style']) && is_array($attributes['style'])) { $allowed_styles = $get_allowed_attribute_values($attributes['style']); if (isset($allowed_values)) { $setting[$tag]['styles'] = $allowed_styles; } } if (isset($attributes['class']) && is_array($attributes['class'])) { $allowed_classes = $get_allowed_attribute_values($attributes['class']); if (isset($allowed_classes)) { $setting[$tag]['classes'] = $allowed_classes; } } } } return $setting; } } }