CKEditor5PluginDefinition.php

<?php

declare (strict_types=1);
namespace Drupal\ckeditor5\Plugin;

use Drupal\ckeditor5\HTMLRestrictions;
use Drupal\Component\Assertion\Inspector;
use Drupal\Component\Plugin\Definition\DerivablePluginDefinitionInterface;
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;

/**
 * Provides an implementation of a CKEditor 5 plugin definition.
 */
final class CKEditor5PluginDefinition extends PluginDefinition implements PluginDefinitionInterface, DerivablePluginDefinitionInterface {
    use SchemaCheckTrait;
    
    /**
     * The CKEditor 5 aspects of the plugin definition.
     *
     * @var array
     */
    private $ckeditor5;
    
    /**
     * The Drupal aspects of the plugin definition.
     *
     * @var array
     */
    private $drupal;
    
    /**
     * CKEditor5PluginDefinition constructor.
     *
     * @param array $definition
     *   An array of values from the annotation/YAML.
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(array $definition) {
        foreach ($definition as $property => $value) {
            if (property_exists($this, $property)) {
                $this->{$property} = $value;
            }
            else {
                throw new \InvalidArgumentException(sprintf('Property %s with value %s does not exist on %s.', $property, $value, __CLASS__));
            }
        }
    }
    
    /**
     * Gets an array representation of this CKEditor 5 plugin definition.
     *
     * @return array
     */
    public function toArray() : array {
        return [
            'id' => $this->id(),
            'provider' => $this->provider,
            'ckeditor5' => $this->ckeditor5,
            'drupal' => $this->drupal,
        ];
    }
    
    /**
     * Validates the CKEditor 5 aspects of the CKEditor 5 plugin definition.
     *
     * @param string $id
     *   The plugin ID, for use in exception messages.
     * @param array $definition
     *   The plugin definition to validate.
     *
     * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
     *
     * @internal
     * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::processDefinition()
     */
    public 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));
        }
        // Automatic link decorators make sense in CKEditor 5, where the generated
        // HTML must be assumed to be served as-is. But it does not make sense in
        // in Drupal, where we prefer not storing (hardcoding) such decisions in the
        // database. Drupal instead filters it on output, using the filter system.
        if (isset($definition['ckeditor5']['config']['link'])) {
            // @see https://ckeditor.com/docs/ckeditor5/latest/api/module_link_link-LinkDecoratorAutomaticDefinition.html
            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));
                    }
                }
            }
            // CKEditor 5 offers one preconfigured automatic link decorator under a
            // special config flag.
            // @see https://ckeditor.com/docs/ckeditor5/latest/api/module_link_link-LinkConfig.html#member-addTargetToExternalLinks
            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));
            }
        }
    }
    
    /**
     * Validates the Drupal aspects of the CKEditor 5 plugin definition.
     *
     * @param string $id
     *   The plugin ID, for use in exception messages.
     * @param array $definition
     *   The plugin definition to validate.
     *
     * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
     *
     * @internal
     * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::processDefinition()
     */
    public 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));
        }
        // Without a label, the CKEditor 5 UI, validation constraints et cetera
        // cannot be as informative in guiding the end user.
        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));
        }
        // Without accurate and complete metadata about what HTML elements a
        // CKEditor 5 plugin supports, Drupal cannot ensure a complete and accurate
        // upgrade path.
        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) {
            // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::isPluginDisabled()
            // @see \Drupal\ckeditor5\Plugin\Validation\Constraint\ToolbarItemConditionsMetConstraintValidator::validate()
            $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']));
            }
        }
    }
    
    /**
     * Returns the typed configuration service.
     *
     * @return \Drupal\Core\Config\TypedConfigManagerInterface
     *   The typed configuration service.
     */
    private function getTypedConfig() : TypedConfigManagerInterface {
        return \Drupal::service('config.typed');
    }
    
    /**
     * Validates the given configuration array.
     *
     * @param array $configuration
     *   The configuration to validate.
     *
     * @return string|null
     *   NULL if there are no validation errors, a string containing the schema
     *   violation error messages otherwise.
     */
    private function validateConfiguration(array $configuration) : ?string {
        if (!isset($this->schema)) {
            $configuration_name = sprintf("ckeditor5.plugin.%s", $this->id);
            // TRICKY: SchemaCheckTrait::checkConfigSchema() dynamically adds a
            // 'langcode' key-value pair that is irrelevant here. Also,
            // ::checkValue() may (counter to its docs) trigger an exception.
            $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;
    }
    
    /**
     * {@inheritdoc}
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$class
     */
    public function getClass() {
        return $this->drupal['class'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function setClass($class) {
        $this->drupal['class'] = $class;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$deriver
     */
    public function getDeriver() {
        // TRICKY: this is the only key that is allowed to not be set, because it is
        // possible that this plugin definition is a partial/incomplete one, and the
        // default from the annotation is only applied automatically for class
        // annotation CKEditor 5 plugin definitions (because they create an instance
        // of the DrupalAspectsOfCKEditor5Plugin annotation level), not for CKEditor
        // 5 plugin definitions in YAML.
        // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::processDefinition()
        // @see \Drupal\ckeditor5\Annotation\CKEditor5Plugin::__construct()
        return $this->drupal['deriver'] ?? NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setDeriver($deriver) {
        $this->drupal['deriver'] = $deriver;
        return $this;
    }
    
    /**
     * Whether this plugin is configurable by the user.
     *
     * @return bool
     *   TRUE if it is configurable, FALSE otherwise.
     *
     * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableInterface
     */
    public function isConfigurable() : bool {
        return is_subclass_of($this->getClass(), CKEditor5PluginConfigurableInterface::class);
    }
    
    /**
     * Gets the human-readable name of the CKEditor plugin.
     *
     * @return \Drupal\Core\StringTranslation\TranslatableMarkup
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$label
     */
    public function label() : TranslatableMarkup {
        $label = $this->drupal['label'];
        if (!$label instanceof TranslatableMarkup) {
            $label = new TranslatableMarkup($label);
        }
        return $label;
    }
    
    /**
     * Gets the list of conditions to enable this plugin.
     *
     * @return array
     *   An array of conditions.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$conditions
     *
     * @throws \LogicException
     *   When called on a plugin definition that has no conditions.
     */
    public function getConditions() : array {
        if (!$this->hasConditions()) {
            throw new \LogicException('::getConditions() should only be called if ::hasConditions() returns TRUE.');
        }
        return $this->drupal['conditions'];
    }
    
    /**
     * Whether this plugin has conditions.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$conditions
     */
    public function hasConditions() : bool {
        return $this->drupal['conditions'] !== FALSE;
    }
    
    /**
     * Gets the list of toolbar items this plugin provides.
     *
     * @return array[]
     *   An array of toolbar items.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$toolbar_items
     */
    public function getToolbarItems() : array {
        return $this->drupal['toolbar_items'];
    }
    
    /**
     * Whether this plugin has toolbar items.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$toolbar_items
     */
    public function hasToolbarItems() : bool {
        return $this->getToolbarItems() !== [];
    }
    
    /**
     * Gets the asset library this plugin needs to be loaded.
     *
     * @return string
     *   An asset library ID.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$library
     *
     * @throws \LogicException
     *   When called on a plugin definition that has no library.
     */
    public function getLibrary() : string {
        if (!$this->hasLibrary()) {
            throw new \LogicException('::getLibrary() should only be called if ::hasLibrary() returns TRUE.');
        }
        return $this->drupal['library'];
    }
    
    /**
     * Whether this plugin has an asset library to load.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$library
     */
    public function hasLibrary() : bool {
        return $this->drupal['library'] !== FALSE;
    }
    
    /**
     * Gets the asset library this plugin needs to be loaded on the admin UI.
     *
     * @return string
     *   An asset library ID.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$admin_library
     *
     * @throws \LogicException
     *   When called on a plugin definition that has no admin library.
     */
    public function getAdminLibrary() : string {
        if (!$this->hasAdminLibrary()) {
            throw new \LogicException('::getAdminLibrary() should only be called if ::hasAdminLibrary() returns TRUE.');
        }
        return $this->drupal['admin_library'];
    }
    
    /**
     * Whether this plugin has an asset library to load on the admin UI.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$admin_library
     */
    public function hasAdminLibrary() : bool {
        return $this->drupal['admin_library'] !== FALSE;
    }
    
    /**
     * Gets the list of elements and attributes this plugin allows to create/edit.
     *
     * @return string[]
     *   A list of elements and attributes.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$elements
     *
     * @throws \LogicException
     *   When called on a plugin definition that has no elements.
     */
    public function getElements() : array {
        if (!$this->hasElements()) {
            throw new \LogicException('::getElements() should only be called if ::hasElements() returns TRUE.');
        }
        return $this->drupal['elements'];
    }
    
    /**
     * Gets the elements this plugin allows to create.
     *
     * @return string[]
     *   A list of plain tags (without attributes) that this plugin can create.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$elements
     *
     * @throws \LogicException
     *   When called on a plugin definition that has no 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',
        ]);
    }
    
    /**
     * Checks if the element is a plain tag, meaning the plugin can create it.
     *
     * @param string $element
     *   A single element, for example `<foo>`, `<foo bar>` or `<foo bar="baz'>`.
     *
     * @return bool
     *   If it is a plain tag and hence a creatable element.
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$elements
     */
    public static function isCreatableElement(string $element) : bool {
        return !HTMLRestrictions::fromString($element)->getPlainTagsSubset()
            ->allowsNothing();
    }
    
    /**
     * Whether this plugin allows creating/editing elements and attributes.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\DrupalAspectsOfCKEditor5Plugin::$elements
     */
    public function hasElements() : bool {
        return $this->drupal['elements'] !== FALSE;
    }
    
    /**
     * Gets the list of CKEditor 5 plugin classes this plugin needs to load.
     *
     * @return string[]
     *   CKEditor 5 plugin classes.
     *
     * @see \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin::$plugins
     */
    public function getCKEditor5Plugins() : array {
        return $this->ckeditor5['plugins'];
    }
    
    /**
     * Whether this plugin loads CKEditor 5 plugin classes.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin::$plugins
     */
    public function hasCKEditor5Plugins() : bool {
        return $this->getCKEditor5Plugins() !== [];
    }
    
    /**
     * Gets keyed array of additional values for the CKEditor 5 configuration.
     *
     * @return array
     *   The CKEditor 5 constructor config.
     *
     * @see \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin::$config
     */
    public function getCKEditor5Config() : array {
        return $this->ckeditor5['config'];
    }
    
    /**
     * Whether this plugin has additional values for the CKEditor 5 configuration.
     *
     * @return bool
     *
     * @see \Drupal\ckeditor5\Annotation\CKEditor5AspectsOfCKEditor5Plugin::$config
     */
    public function hasCKEditor5Config() : bool {
        return $this->getCKEditor5Config() !== [];
    }

}