Comment.php

<?php

namespace Drupal\comment\Entity;

use Drupal\Component\Utility\Number;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\comment\CommentInterface;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityPublishedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\user\Entity\User;
use Drupal\user\EntityOwnerTrait;

/**
 * Defines the comment entity class.
 *
 * @ContentEntityType(
 *   id = "comment",
 *   label = @Translation("Comment"),
 *   label_singular = @Translation("comment"),
 *   label_plural = @Translation("comments"),
 *   label_count = @PluralTranslation(
 *     singular = "@count comment",
 *     plural = "@count comments",
 *   ),
 *   bundle_label = @Translation("Comment type"),
 *   handlers = {
 *     "storage" = "Drupal\comment\CommentStorage",
 *     "storage_schema" = "Drupal\comment\CommentStorageSchema",
 *     "access" = "Drupal\comment\CommentAccessControlHandler",
 *     "list_builder" = "Drupal\Core\Entity\EntityListBuilder",
 *     "view_builder" = "Drupal\comment\CommentViewBuilder",
 *     "views_data" = "Drupal\comment\CommentViewsData",
 *     "form" = {
 *       "default" = "Drupal\comment\CommentForm",
 *       "delete" = "Drupal\comment\Form\DeleteForm"
 *     },
 *     "translation" = "Drupal\comment\CommentTranslationHandler"
 *   },
 *   base_table = "comment",
 *   data_table = "comment_field_data",
 *   uri_callback = "comment_uri",
 *   translatable = TRUE,
 *   entity_keys = {
 *     "id" = "cid",
 *     "bundle" = "comment_type",
 *     "label" = "subject",
 *     "langcode" = "langcode",
 *     "uuid" = "uuid",
 *     "published" = "status",
 *     "owner" = "uid",
 *   },
 *   links = {
 *     "canonical" = "/comment/{comment}",
 *     "delete-form" = "/comment/{comment}/delete",
 *     "delete-multiple-form" = "/admin/content/comment/delete",
 *     "edit-form" = "/comment/{comment}/edit",
 *     "create" = "/comment",
 *   },
 *   bundle_entity_type = "comment_type",
 *   field_ui_base_route  = "entity.comment_type.edit_form",
 *   constraints = {
 *     "CommentName" = {}
 *   }
 * )
 */
class Comment extends ContentEntityBase implements CommentInterface {
    use EntityChangedTrait;
    use EntityOwnerTrait;
    use EntityPublishedTrait;
    
    /**
     * The thread for which a lock was acquired.
     *
     * @var string
     */
    protected $threadLock = '';
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        parent::preSave($storage);
        if ($this->isNew()) {
            // Add the comment to database. This next section builds the thread field.
            // @see \Drupal\comment\CommentViewBuilder::buildComponents()
            $thread = $this->getThread();
            if (empty($thread)) {
                if ($this->threadLock) {
                    // Thread lock was not released after being set previously.
                    // This suggests there's a bug in code using this class.
                    throw new \LogicException('preSave() is called again without calling postSave() or releaseThreadLock()');
                }
                if (!$this->hasParentComment()) {
                    // This is a comment with no parent comment (depth 0): we start
                    // by retrieving the maximum thread level.
                    $max = $storage->getMaxThread($this);
                    // Strip the "/" from the end of the thread.
                    $max = rtrim((string) $max, '/');
                    // We need to get the value at the correct depth.
                    $parts = explode('.', $max);
                    $n = Number::alphadecimalToInt($parts[0]);
                    $prefix = '';
                }
                else {
                    // This is a comment with a parent comment, so increase the part of
                    // the thread value at the proper depth.
                    // Get the parent comment:
                    $parent = $this->getParentComment();
                    // Strip the "/" from the end of the parent thread.
                    $parent->setThread((string) rtrim((string) $parent->getThread(), '/'));
                    $prefix = $parent->getThread() . '.';
                    // Get the max value in *this* thread.
                    $max = $storage->getMaxThreadPerThread($this);
                    if ($max == '') {
                        // First child of this parent. As the other two cases do an
                        // increment of the thread number before creating the thread
                        // string set this to -1 so it requires an increment too.
                        $n = -1;
                    }
                    else {
                        // Strip the "/" at the end of the thread.
                        $max = rtrim($max, '/');
                        // Get the value at the correct depth.
                        $parts = explode('.', $max);
                        $parent_depth = count(explode('.', $parent->getThread()));
                        $n = Number::alphadecimalToInt($parts[$parent_depth]);
                    }
                }
                // Finally, build the thread field for this new comment. To avoid
                // race conditions, get a lock on the thread. If another process already
                // has the lock, just move to the next integer.
                do {
                    $thread = $prefix . Number::intToAlphadecimal(++$n) . '/';
                    $lock_name = "comment:{$this->getCommentedEntityId()}:{$thread}";
                } while (!\Drupal::lock()->acquire($lock_name));
                $this->threadLock = $lock_name;
            }
            $this->setThread($thread);
        }
        // The entity fields for name and mail have no meaning if the user is not
        // Anonymous. Set them to NULL to make it clearer that they are not used.
        // For anonymous users see \Drupal\comment\CommentForm::form() for mail,
        // and \Drupal\comment\CommentForm::buildEntity() for name setting.
        if (!$this->getOwner()
            ->isAnonymous()) {
            $this->set('name', NULL);
            $this->set('mail', NULL);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        parent::postSave($storage, $update);
        // Always invalidate the cache tag for the commented entity.
        if ($commented_entity = $this->getCommentedEntity()) {
            Cache::invalidateTags($commented_entity->getCacheTagsToInvalidate());
        }
        $this->releaseThreadLock();
        // Update the {comment_entity_statistics} table prior to executing the hook.
        \Drupal::service('comment.statistics')->update($this);
    }
    
    /**
     * Release the lock acquired for the thread in preSave().
     */
    protected function releaseThreadLock() {
        if ($this->threadLock) {
            \Drupal::lock()->release($this->threadLock);
            $this->threadLock = '';
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
        parent::postDelete($storage, $entities);
        $child_cids = $storage->getChildCids($entities);
        $comment_storage = \Drupal::entityTypeManager()->getStorage('comment');
        $comments = $comment_storage->loadMultiple($child_cids);
        $comment_storage->delete($comments);
        foreach ($entities as $entity) {
            \Drupal::service('comment.statistics')->update($entity);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function referencedEntities() {
        $referenced_entities = parent::referencedEntities();
        if ($this->getCommentedEntityId()) {
            $referenced_entities[] = $this->getCommentedEntity();
        }
        return $referenced_entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function permalink() {
        $uri = $this->toUrl();
        $uri->setOption('fragment', 'comment-' . $this->id());
        return $uri;
    }
    
    /**
     * {@inheritdoc}
     */
    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'))
            ->setDescription(t('The comment ID.'));
        $fields['uuid']->setDescription(t('The comment UUID.'));
        $fields['comment_type']->setLabel(t('Comment Type'))
            ->setDescription(t('The comment type.'));
        $fields['langcode']->setDescription(t('The comment language code.'));
        // Set the default value callback for the status field.
        $fields['status']->setDefaultValueCallback('Drupal\\comment\\Entity\\Comment::getDefaultStatus');
        $fields['pid'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Parent ID'))
            ->setDescription(t('The parent comment ID if this is a reply to a comment.'))
            ->setSetting('target_type', 'comment');
        $fields['entity_id'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Entity ID'))
            ->setDescription(t('The ID of the entity of which this comment is a reply.'))
            ->setRequired(TRUE);
        $fields['subject'] = BaseFieldDefinition::create('string')->setLabel(t('Subject'))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 64)
            ->setDisplayOptions('form', [
            'type' => 'string_textfield',
            // Default comment body field has weight 20.
'weight' => 10,
        ])
            ->setDisplayConfigurable('form', TRUE);
        $fields['uid']->setDescription(t('The user ID of the comment author.'));
        $fields['name'] = BaseFieldDefinition::create('string')->setLabel(t('Name'))
            ->setDescription(t("The comment author's name."))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 60)
            ->setDefaultValue('');
        $fields['mail'] = BaseFieldDefinition::create('email')->setLabel(t('Email'))
            ->setDescription(t("The comment author's email address."))
            ->setTranslatable(TRUE);
        $fields['homepage'] = BaseFieldDefinition::create('uri')->setLabel(t('Homepage'))
            ->setDescription(t("The comment author's home page address."))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 255);
        $fields['hostname'] = BaseFieldDefinition::create('string')->setLabel(t('Hostname'))
            ->setDescription(t("The comment author's hostname."))
            ->setTranslatable(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);
        $fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(t('Changed'))
            ->setDescription(t('The time that the comment was last edited.'))
            ->setTranslatable(TRUE);
        $fields['thread'] = BaseFieldDefinition::create('string')->setLabel(t('Thread place'))
            ->setDescription(t("The alphadecimal representation of the comment's place in a thread, consisting of a base 36 string prefixed by an integer indicating its length."))
            ->setSetting('max_length', 255);
        $fields['entity_type'] = BaseFieldDefinition::create('string')->setLabel(t('Entity type'))
            ->setRequired(TRUE)
            ->setDescription(t('The entity type to which this comment is attached.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);
        $fields['field_name'] = BaseFieldDefinition::create('string')->setLabel(t('Comment field name'))
            ->setRequired(TRUE)
            ->setDescription(t('The field name through which this comment was added.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH);
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
        if ($comment_type = CommentType::load($bundle)) {
            $fields['entity_id'] = clone $base_field_definitions['entity_id'];
            $fields['entity_id']->setSetting('target_type', $comment_type->getTargetEntityTypeId());
            return $fields;
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasParentComment() {
        return (bool) $this->get('pid')->target_id;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getParentComment() {
        return $this->get('pid')->entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntity() {
        return $this->get('entity_id')->entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntityId() {
        return $this->get('entity_id')->target_id;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntityTypeId() {
        return $this->get('entity_type')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setFieldName($field_name) {
        $this->set('field_name', $field_name);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFieldName() {
        return $this->get('field_name')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSubject() {
        return $this->get('subject')->value ?? '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSubject($subject) {
        $this->set('subject', $subject);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAuthorName() {
        // If their is a valid user id and the user entity exists return the label.
        if ($this->get('uid')->target_id && $this->get('uid')->entity) {
            return $this->get('uid')->entity
                ->label();
        }
        return $this->get('name')->value ?: \Drupal::config('user.settings')->get('anonymous');
    }
    
    /**
     * {@inheritdoc}
     */
    public function setAuthorName($name) {
        $this->set('name', $name);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAuthorEmail() {
        $mail = $this->get('mail')->value;
        if ($this->get('uid')->target_id != 0) {
            $mail = $this->get('uid')->entity
                ->getEmail();
        }
        return $mail;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHomepage() {
        return $this->get('homepage')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setHomepage($homepage) {
        $this->set('homepage', $homepage);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHostname() {
        return $this->get('hostname')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setHostname($hostname) {
        $this->set('hostname', $hostname);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCreatedTime() {
        if (isset($this->get('created')->value)) {
            return $this->get('created')->value;
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setCreatedTime($created) {
        $this->set('created', $created);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThread() {
        $thread = $this->get('thread');
        if (!empty($thread->value)) {
            return $thread->value;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function setThread($thread) {
        $this->set('thread', $thread);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preCreate(EntityStorageInterface $storage, array &$values) {
        if (empty($values['comment_type']) && !empty($values['field_name']) && !empty($values['entity_type'])) {
            $fields = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions($values['entity_type']);
            $values['comment_type'] = $fields[$values['field_name']]->getSetting('comment_type');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOwner() {
        $user = $this->get('uid')->entity;
        if (!$user || $user->isAnonymous()) {
            $user = User::getAnonymousUser();
            $user->name = $this->getAuthorName();
            $user->homepage = $this->getHomepage();
        }
        return $user;
    }
    
    /**
     * Get the comment type ID for this comment.
     *
     * @return string
     *   The ID of the comment type.
     */
    public function getTypeId() {
        return $this->bundle();
    }
    
    /**
     * Default value callback for 'status' base field definition.
     *
     * @see ::baseFieldDefinitions()
     *
     * @return bool
     *   TRUE if the comment should be published, FALSE otherwise.
     */
    public static function getDefaultStatus() {
        return \Drupal::currentUser()->hasPermission('skip comment approval') ? CommentInterface::PUBLISHED : CommentInterface::NOT_PUBLISHED;
    }
    
    /**
     * Returns the default value for entity hostname base field.
     *
     * @return string
     *   The client host name.
     */
    public static function getDefaultHostname() {
        if (\Drupal::config('comment.settings')->get('log_ip_addresses')) {
            return \Drupal::request()->getClientIP();
        }
        return '';
    }

}