View source
<?php
declare (strict_types=1);
namespace Drupal\ckeditor5\Plugin;
use Drupal\ckeditor5\HTMLRestrictions;
use Drupal\Component\Assertion\Inspector;
use Drupal\Component\Plugin\Definition\PluginDefinition;
use Drupal\Component\Plugin\Definition\PluginDefinitionInterface;
use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;
use Drupal\Core\Config\Schema\SchemaCheckTrait;
use Drupal\Core\Config\TypedConfigManagerInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
final class CKEditor5PluginDefinition extends PluginDefinition implements PluginDefinitionInterface {
use SchemaCheckTrait;
private $ckeditor5;
private $drupal;
public function __construct(array $definition) {
$this->id = $id = $definition['id'];
$expected_prefix = sprintf("%s_", $definition['provider']);
if (strpos($id, $expected_prefix) !== 0) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must have a plugin ID that starts with "%s".', $id, $expected_prefix));
}
$this->provider = $definition['provider'];
static::validateCKEditor5Aspects($id, $definition);
$this->ckeditor5 = $definition['ckeditor5'];
$this
->validateDrupalAspects($id, $definition);
$this->drupal = $definition['drupal'];
}
public function toArray() : array {
return [
'id' => $this
->id(),
'provider' => $this->provider,
'ckeditor5' => $this->ckeditor5,
'drupal' => $this->drupal,
];
}
private static function validateCKEditor5Aspects(string $id, array $definition) : void {
if (!isset($definition['ckeditor5'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "ckeditor5" key.', $id));
}
if (!isset($definition['ckeditor5']['plugins'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "ckeditor5.plugins" key.', $id));
}
if (isset($definition['ckeditor5']['config']['link'])) {
if (isset($definition['ckeditor5']['config']['link']['decorators']) && is_array($definition['ckeditor5']['config']['link']['decorators'])) {
foreach ($definition['ckeditor5']['config']['link']['decorators'] as $decorator) {
if ($decorator['mode'] === 'automatic') {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition specifies an automatic decorator, this is not supported. Use the Drupal filter system instead.', $id));
}
}
}
if (isset($definition['ckeditor5']['config']['link']['addTargetToExternalLinks']) && $definition['ckeditor5']['config']['link']['addTargetToExternalLinks']) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition specifies an automatic decorator, this is not supported. Use the Drupal filter system instead.', $id));
}
}
}
private function validateDrupalAspects(string $id, array $definition) : void {
if (!isset($definition['drupal'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "drupal" key.', $id));
}
if (!isset($definition['drupal']['label'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "drupal.label" key.', $id));
}
elseif (!is_string($definition['drupal']['label']) && !$definition['drupal']['label'] instanceof TranslatableMarkup) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.label" value that is not a string nor a TranslatableMarkup instance.', $id));
}
if (!isset($definition['drupal']['elements'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition must contain a "drupal.elements" key.', $id));
}
elseif ($definition['id'] === 'ckeditor5_sourceEditing') {
assert($definition['drupal']['elements'] === []);
}
elseif ($definition['drupal']['elements'] !== FALSE && !(is_array($definition['drupal']['elements']) && !empty($definition['drupal']['elements']) && Inspector::assertAllStrings($definition['drupal']['elements']))) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.elements" value that is neither a list of HTML tags/attributes nor false.', $id));
}
elseif (is_array($definition['drupal']['elements'])) {
foreach ($definition['drupal']['elements'] as $index => $element) {
$parsed = HTMLRestrictions::fromString($element);
if ($parsed
->allowsNothing()) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a value at "drupal.elements.%d" that is not an HTML tag with optional attributes: "%s". Expected structure: "<tag allowedAttribute="allowedValue1 allowedValue2">".', $id, $index, $element));
}
if (count($parsed
->getAllowedElements()) > 1) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a value at "drupal.elements.%d": multiple tags listed, should be one: "%s".', $id, $index, $element));
}
}
}
if (isset($definition['drupal']['class']) && !class_exists($definition['drupal']['class'])) {
throw new InvalidPluginDefinitionException($id, sprintf('The CKEditor 5 "%s" provides a plugin class: "%s", but it does not exist.', $id, $definition['drupal']['class']));
}
elseif (isset($definition['drupal']['class']) && !in_array(CKEditor5PluginInterface::class, class_implements($definition['drupal']['class']))) {
throw new InvalidPluginDefinitionException($id, sprintf('CKEditor 5 plugins must implement \\Drupal\\ckeditor5\\Plugin\\CKEditor5PluginInterface. "%s" does not.', $id));
}
elseif (in_array(CKEditor5PluginConfigurableInterface::class, class_implements($definition['drupal']['class'], TRUE))) {
$default_configuration = (new \ReflectionClass($definition['drupal']['class']))
->newInstanceWithoutConstructor()
->defaultConfiguration();
if (!empty($default_configuration)) {
$configuration_name = sprintf("ckeditor5.plugin.%s", $definition['id']);
if (!$this
->getTypedConfig()
->hasConfigSchema($configuration_name)) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition is configurable, has non-empty default configuration but has no config schema. Config schema is required for validation.', $id));
}
$error_message = $this
->validateConfiguration($default_configuration);
if ($error_message) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition is configurable, but its default configuration does not match its config schema. %s', $id, $error_message));
}
}
}
if ($definition['drupal']['conditions'] !== FALSE) {
$supported_condition_types = [
'toolbarItem' => function ($value) : ?string {
return is_string($value) ? NULL : 'A string corresponding to a CKEditor 5 toolbar item must be specified.';
},
'imageUploadStatus' => function ($value) : ?string {
return is_bool($value) ? NULL : 'A boolean indicating whether image uploads must be enabled (true) or not (false) must be specified.';
},
'filter' => function ($value) : ?string {
return is_string($value) ? NULL : 'A string corresponding to a filter plugin ID must be specified.';
},
'requiresConfiguration' => function ($required_configuration, array $definition) : ?string {
if (!is_array($required_configuration)) {
return 'An array structure matching the required configuration for this plugin must be specified.';
}
if (!in_array(CKEditor5PluginConfigurableInterface::class, class_implements($definition['drupal']['class'], TRUE))) {
return 'This condition type is only available for CKEditor 5 plugins implementing CKEditor5PluginConfigurableInterface.';
}
$error_message = $this
->validateConfiguration($required_configuration);
return is_string($error_message) ? sprintf('The required configuration does not match its config schema. %s', $error_message) : NULL;
},
'plugins' => function ($value) : ?string {
return is_array($value) && Inspector::assertAllStrings($value) ? NULL : 'A list of strings, each corresponding to a CKEditor 5 plugin ID must be specified.';
},
];
$unsupported_condition_types = array_keys(array_diff_key($definition['drupal']['conditions'], $supported_condition_types));
if (!empty($unsupported_condition_types)) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.conditions" value that contains some unsupported condition types: "%s". Only the following conditions types are supported: "%s".', $id, implode(', ', $unsupported_condition_types), implode('", "', array_keys($supported_condition_types))));
}
foreach ($definition['drupal']['conditions'] as $condition_type => $value) {
$assessment = $supported_condition_types[$condition_type]($value, $definition);
if (is_string($assessment)) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "%s" is set to an invalid value. %s', $id, $condition_type, $assessment));
}
}
}
if ($definition['drupal']['admin_library'] !== FALSE) {
[
$extension,
$library,
] = explode('/', $definition['drupal']['admin_library'], 2);
if (\Drupal::service('library.discovery')
->getLibraryByName($extension, $library) === FALSE) {
throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.admin_library" key whose asset library "%s" does not exist.', $id, $definition['drupal']['admin_library']));
}
}
}
private function getTypedConfig() : TypedConfigManagerInterface {
return \Drupal::service('config.typed');
}
private function validateConfiguration(array $configuration) : ?string {
if (!isset($this->schema)) {
$configuration_name = sprintf("ckeditor5.plugin.%s", $this->id);
$this->configName = 'STRIP';
$this->schema = $this
->getTypedConfig()
->createFromNameAndData($configuration_name, $configuration);
}
$schema_errors = [];
foreach ($configuration as $key => $value) {
try {
$schema_error = $this
->checkValue($key, $value);
} catch (\InvalidArgumentException $e) {
$schema_error = [
$key => $e
->getMessage(),
];
}
$schema_errors = array_merge($schema_errors, $schema_error);
}
$formatted_schema_errors = [];
foreach ($schema_errors as $key => $value) {
$formatted_schema_errors[] = sprintf("[%s] %s", str_replace('STRIP:', '', $key), trim($value, '.'));
}
if (!empty($formatted_schema_errors)) {
return sprintf('The following errors were found: %s.', implode(', ', $formatted_schema_errors));
}
return NULL;
}
public function getClass() {
return $this->drupal['class'];
}
public function setClass($class) {
$this->drupal['class'] = $class;
return $this;
}
public function isConfigurable() : bool {
return is_subclass_of($this
->getClass(), CKEditor5PluginConfigurableInterface::class);
}
public function label() : TranslatableMarkup {
$label = $this->drupal['label'];
if (!$label instanceof TranslatableMarkup) {
$label = new TranslatableMarkup($label);
}
return $label;
}
public function getConditions() : array {
if (!$this
->hasConditions()) {
throw new \LogicException('::getConditions() should only be called if ::hasConditions() returns TRUE.');
}
return $this->drupal['conditions'];
}
public function hasConditions() : bool {
return $this->drupal['conditions'] !== FALSE;
}
public function getToolbarItems() : array {
return $this->drupal['toolbar_items'];
}
public function hasToolbarItems() : bool {
return $this
->getToolbarItems() !== [];
}
public function getLibrary() : string {
if (!$this
->hasLibrary()) {
throw new \LogicException('::getLibrary() should only be called if ::hasLibrary() returns TRUE.');
}
return $this->drupal['library'];
}
public function hasLibrary() : bool {
return $this->drupal['library'] !== FALSE;
}
public function getAdminLibrary() : string {
if (!$this
->hasAdminLibrary()) {
throw new \LogicException('::getAdminLibrary() should only be called if ::hasAdminLibrary() returns TRUE.');
}
return $this->drupal['admin_library'];
}
public function hasAdminLibrary() : bool {
return $this->drupal['admin_library'] !== FALSE;
}
public function getElements() : array {
if (!$this
->hasElements()) {
throw new \LogicException('::getElements() should only be called if ::hasElements() returns TRUE.');
}
return $this->drupal['elements'];
}
public function getCreatableElements() : array {
if (!$this
->hasElements()) {
throw new \LogicException('::getCreatableElements() should only be called if ::hasElements() returns TRUE.');
}
return array_filter($this
->getElements(), [
__CLASS__,
'isCreatableElement',
]);
}
public static function isCreatableElement(string $element) : bool {
return !HTMLRestrictions::fromString($element)
->getPlainTagsSubset()
->allowsNothing();
}
public function hasElements() : bool {
return $this->drupal['elements'] !== FALSE;
}
public function getCKEditor5Plugins() : array {
return $this->ckeditor5['plugins'];
}
public function hasCKEditor5Plugins() : bool {
return $this
->getCKEditor5Plugins() !== [];
}
public function getCKEditor5Config() : array {
return $this->ckeditor5['config'];
}
public function hasCKEditor5Config() : bool {
return $this
->getCKEditor5Config() !== [];
}
}