diff --git a/core/modules/comment/comment.post_update.php b/core/modules/comment/comment.post_update.php index 64587ae154..51cb23f49d 100644 --- a/core/modules/comment/comment.post_update.php +++ b/core/modules/comment/comment.post_update.php @@ -7,6 +7,8 @@ use Drupal\Core\Config\FileStorage; use Drupal\Core\Config\InstallStorage; +use Drupal\Core\Field\BaseFieldDefinition; +use Drupal\Core\StringTranslation\TranslatableMarkup; /** * Enable the comment admin view. @@ -46,3 +48,98 @@ function comment_post_update_add_ip_address_setting() { $settings->set('log_ip_addresses', TRUE) ->save(TRUE); } + +/** + * Update comments to be revisionable. + */ +function comment_post_update_make_comment_revisionable(&$sandbox) { + $definition_update_manager = \Drupal::entityDefinitionUpdateManager(); + /** @var \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $last_installed_schema_repository */ + $last_installed_schema_repository = \Drupal::service('entity.last_installed_schema.repository'); + + $entity_type = $definition_update_manager->getEntityType('comment'); + $field_storage_definitions = $last_installed_schema_repository->getLastInstalledFieldStorageDefinitions('comment'); + + // Update the entity type definition. + $entity_keys = $entity_type->getKeys(); + $entity_keys['revision'] = 'revision_id'; + $entity_keys['revision_translation_affected'] = 'revision_translation_affected'; + $entity_type->set('entity_keys', $entity_keys); + $entity_type->set('revision_table', 'comment_revision'); + $entity_type->set('revision_data_table', 'comment_field_revision'); + $revision_metadata_keys = [ + 'revision_default' => 'revision_default', + 'revision_user' => 'revision_user', + 'revision_created' => 'revision_created', + 'revision_log_message' => 'revision_log_message', + ]; + $entity_type->set('revision_metadata_keys', $revision_metadata_keys); + + // Update the field storage definitions and add the new ones required by a + // revisionable entity type. + $field_storage_definitions['langcode']->setRevisionable(TRUE); + $field_storage_definitions['subject']->setRevisionable(TRUE); + $field_storage_definitions['name']->setRevisionable(TRUE); + $field_storage_definitions['mail']->setRevisionable(TRUE); + $field_storage_definitions['homepage']->setRevisionable(TRUE); + $field_storage_definitions['hostname']->setRevisionable(TRUE); + $field_storage_definitions['created']->setRevisionable(TRUE); + $field_storage_definitions['changed']->setRevisionable(TRUE); + + $field_storage_definitions['revision_id'] = BaseFieldDefinition::create('integer') + ->setName('revision_id') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Revision ID')) + ->setReadOnly(TRUE) + ->setSetting('unsigned', TRUE); + + $field_storage_definitions['revision_default'] = BaseFieldDefinition::create('boolean') + ->setName('revision_default') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Default revision')) + ->setDescription(new TranslatableMarkup('A flag indicating whether this was a default revision when it was saved.')) + ->setStorageRequired(TRUE) + ->setInternal(TRUE) + ->setTranslatable(FALSE) + ->setRevisionable(TRUE); + + $field_storage_definitions['revision_translation_affected'] = BaseFieldDefinition::create('boolean') + ->setName('revision_translation_affected') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Revision translation affected')) + ->setDescription(new TranslatableMarkup('Indicates if the last edit of a translation belongs to current revision.')) + ->setReadOnly(TRUE) + ->setRevisionable(TRUE) + ->setTranslatable(TRUE); + + $field_storage_definitions['revision_created'] = BaseFieldDefinition::create('created') + ->setName('revision_created') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Revision create time')) + ->setDescription(new TranslatableMarkup('The time that the current revision was created.')) + ->setRevisionable(TRUE); + $field_storage_definitions['revision_user'] = BaseFieldDefinition::create('entity_reference') + ->setName('revision_user') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Revision user')) + ->setDescription(new TranslatableMarkup('The user ID of the author of the current revision.')) + ->setSetting('target_type', 'user') + ->setRevisionable(TRUE); + $field_storage_definitions['revision_log_message'] = BaseFieldDefinition::create('string_long') + ->setName('revision_log_message') + ->setTargetEntityTypeId('comment') + ->setTargetBundle(NULL) + ->setLabel(new TranslatableMarkup('Revision log message')) + ->setDescription(new TranslatableMarkup('Briefly describe the changes you have made.')) + ->setRevisionable(TRUE) + ->setDefaultValue(''); + + $definition_update_manager->updateFieldableEntityType($entity_type, $field_storage_definitions, $sandbox); + + return t('Comments have been converted to be revisionable.'); +} diff --git a/core/modules/comment/src/Entity/Comment.php b/core/modules/comment/src/Entity/Comment.php index 222cdae65a..33a6d44233 100644 --- a/core/modules/comment/src/Entity/Comment.php +++ b/core/modules/comment/src/Entity/Comment.php @@ -4,8 +4,8 @@ use Drupal\Component\Utility\Number; use Drupal\Core\Cache\Cache; -use Drupal\Core\Entity\ContentEntityBase; use Drupal\comment\CommentInterface; +use Drupal\Core\Entity\EditorialContentEntityBase; use Drupal\Core\Entity\EntityChangedTrait; use Drupal\Core\Entity\EntityPublishedTrait; use Drupal\Core\Entity\EntityStorageInterface; @@ -43,10 +43,13 @@ * }, * base_table = "comment", * data_table = "comment_field_data", + * revision_table = "comment_revision", + * revision_data_table = "comment_field_revision", * uri_callback = "comment_uri", * translatable = TRUE, * entity_keys = { * "id" = "cid", + * "revision" = "revision_id", * "bundle" = "comment_type", * "label" = "subject", * "langcode" = "langcode", @@ -54,6 +57,11 @@ * "published" = "status", * "owner" = "uid", * }, + * revision_metadata_keys = { + * "revision_user" = "revision_user", + * "revision_created" = "revision_created", + * "revision_log_message" = "revision_log_message", + * }, * links = { * "canonical" = "/comment/{comment}", * "delete-form" = "/comment/{comment}/delete", @@ -68,7 +76,7 @@ * } * ) */ -class Comment extends ContentEntityBase implements CommentInterface { +class Comment extends EditorialContentEntityBase implements CommentInterface { use EntityChangedTrait; use EntityOwnerTrait; @@ -222,7 +230,6 @@ public function permalink() { public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */ $fields = parent::baseFieldDefinitions($entity_type); - $fields += static::publishedBaseFieldDefinitions($entity_type); $fields += static::ownerBaseFieldDefinitions($entity_type); $fields['cid']->setLabel(t('Comment ID')) @@ -251,6 +258,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { $fields['subject'] = BaseFieldDefinition::create('string') ->setLabel(t('Subject')) ->setTranslatable(TRUE) + ->setRevisionable(TRUE) ->setSetting('max_length', 64) ->setDisplayOptions('form', [ 'type' => 'string_textfield', @@ -266,18 +274,21 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setLabel(t('Name')) ->setDescription(t("The comment author's name.")) ->setTranslatable(TRUE) + ->setRevisionable(TRUE) ->setSetting('max_length', 60) ->setDefaultValue(''); $fields['mail'] = BaseFieldDefinition::create('email') ->setLabel(t('Email')) ->setDescription(t("The comment author's email address.")) - ->setTranslatable(TRUE); + ->setTranslatable(TRUE) + ->setRevisionable(TRUE); $fields['homepage'] = BaseFieldDefinition::create('uri') ->setLabel(t('Homepage')) ->setDescription(t("The comment author's home page address.")) ->setTranslatable(TRUE) + ->setRevisionable(TRUE) // URIs are not length limited by RFC 2616, but we can only store 255 // characters in our comment DB schema. ->setSetting('max_length', 255); @@ -286,18 +297,21 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setLabel(t('Hostname')) ->setDescription(t("The comment author's hostname.")) ->setTranslatable(TRUE) + ->setRevisionable(TRUE) ->setSetting('max_length', 128) ->setDefaultValueCallback(static::class . '::getDefaultHostname'); $fields['created'] = BaseFieldDefinition::create('created') ->setLabel(t('Created')) ->setDescription(t('The time that the comment was created.')) - ->setTranslatable(TRUE); + ->setTranslatable(TRUE) + ->setRevisionable(TRUE); $fields['changed'] = BaseFieldDefinition::create('changed') ->setLabel(t('Changed')) ->setDescription(t('The time that the comment was last edited.')) - ->setTranslatable(TRUE); + ->setTranslatable(TRUE) + ->setRevisionable(TRUE); $fields['thread'] = BaseFieldDefinition::create('string') ->setLabel(t('Thread place')) @@ -318,6 +332,11 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setSetting('is_ascii', TRUE) ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH); + // Hide the revision log message field by default. + $fields['revision_log_message']->setDisplayOptions('form', [ + 'type' => 'hidden', + ]); + return $fields; }