WorkspacePublisher.php

<?php

namespace Drupal\workspaces;

use Drupal\Core\Access\AccessResultReasonInterface;
use Drupal\Core\Database\Connection;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Default implementation of the workspace publisher.
 *
 * @internal
 */
class WorkspacePublisher implements WorkspacePublisherInterface {
    use StringTranslationTrait;
    
    /**
     * The source workspace entity.
     *
     * @var \Drupal\workspaces\WorkspaceInterface
     */
    protected $sourceWorkspace;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The database connection.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $database;
    
    /**
     * The workspace manager.
     *
     * @var \Drupal\workspaces\WorkspaceManagerInterface
     */
    protected $workspaceManager;
    
    /**
     * The workspace association service.
     *
     * @var \Drupal\workspaces\WorkspaceAssociationInterface
     */
    protected $workspaceAssociation;
    
    /**
     * Constructs a new WorkspacePublisher.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Database\Connection $database
     *   Database connection.
     * @param \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager
     *   The workspace manager.
     * @param \Drupal\workspaces\WorkspaceAssociationInterface $workspace_association
     *   The workspace association service.
     * @param \Drupal\workspaces\WorkspaceInterface $source
     *   The source workspace entity.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, Connection $database, WorkspaceManagerInterface $workspace_manager, WorkspaceAssociationInterface $workspace_association, WorkspaceInterface $source) {
        $this->entityTypeManager = $entity_type_manager;
        $this->database = $database;
        $this->workspaceManager = $workspace_manager;
        $this->workspaceAssociation = $workspace_association;
        $this->sourceWorkspace = $source;
    }
    
    /**
     * {@inheritdoc}
     */
    public function publish() {
        $publish_access = $this->sourceWorkspace
            ->access('publish', NULL, TRUE);
        if (!$publish_access->isAllowed()) {
            $message = $publish_access instanceof AccessResultReasonInterface ? $publish_access->getReason() : '';
            throw new WorkspaceAccessException($message);
        }
        if ($this->checkConflictsOnTarget()) {
            throw new WorkspaceConflictException();
        }
        try {
            $transaction = $this->database
                ->startTransaction();
            // @todo Handle the publishing of a workspace with a batch operation in
            //   https://www.drupal.org/node/2958752.
            $this->workspaceManager
                ->executeOutsideWorkspace(function () {
                foreach ($this->getDifferringRevisionIdsOnSource() as $entity_type_id => $revision_difference) {
                    $entity_revisions = $this->entityTypeManager
                        ->getStorage($entity_type_id)
                        ->loadMultipleRevisions(array_keys($revision_difference));
                    $default_revisions = $this->entityTypeManager
                        ->getStorage($entity_type_id)
                        ->loadMultiple(array_values($revision_difference));
                    
                    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
                    foreach ($entity_revisions as $entity) {
                        // When pushing workspace-specific revisions to the default
                        // workspace (Live), we simply need to mark them as default
                        // revisions.
                        $entity->setSyncing(TRUE);
                        $entity->isDefaultRevision(TRUE);
                        // The default revision is not workspace-specific anymore.
                        $field_name = $entity->getEntityType()
                            ->getRevisionMetadataKey('workspace');
                        $entity->{$field_name}->target_id = NULL;
                        $entity->original = $default_revisions[$entity->id()];
                        $entity->save();
                    }
                }
            });
        } catch (\Exception $e) {
            if (isset($transaction)) {
                $transaction->rollBack();
            }
            watchdog_exception('workspaces', $e);
            throw $e;
        }
        // Notify the workspace association that a workspace has been published.
        $this->workspaceAssociation
            ->postPublish($this->sourceWorkspace);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSourceLabel() {
        return $this->sourceWorkspace
            ->label();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTargetLabel() {
        return $this->t('Live');
    }
    
    /**
     * {@inheritdoc}
     */
    public function checkConflictsOnTarget() {
        // Nothing to do for now, we can not get to a conflicting state because an
        // entity which is being edited in a workspace can not be edited in any
        // other workspace.
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDifferringRevisionIdsOnTarget() {
        $target_revision_difference = [];
        $tracked_entities = $this->workspaceAssociation
            ->getTrackedEntities($this->sourceWorkspace
            ->id());
        foreach ($tracked_entities as $entity_type_id => $tracked_revisions) {
            $entity_type = $this->entityTypeManager
                ->getDefinition($entity_type_id);
            // Get the latest revision IDs for all the entities that are tracked by
            // the source workspace.
            $query = $this->entityTypeManager
                ->getStorage($entity_type_id)
                ->getQuery()
                ->accessCheck(FALSE)
                ->condition($entity_type->getKey('id'), $tracked_revisions, 'IN')
                ->latestRevision();
            $result = $query->execute();
            // Now we compare the revision IDs which are tracked by the source
            // workspace to the latest revision IDs of those entities and the
            // difference between these two arrays gives us all the entities which
            // have been modified on the target.
            if ($revision_difference = array_diff_key($result, $tracked_revisions)) {
                $target_revision_difference[$entity_type_id] = $revision_difference;
            }
        }
        return $target_revision_difference;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDifferringRevisionIdsOnSource() {
        // Get the Workspace association revisions which haven't been pushed yet.
        return $this->workspaceAssociation
            ->getTrackedEntities($this->sourceWorkspace
            ->id());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getNumberOfChangesOnTarget() {
        $total_changes = $this->getDifferringRevisionIdsOnTarget();
        return count($total_changes, COUNT_RECURSIVE) - count($total_changes);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getNumberOfChangesOnSource() {
        $total_changes = $this->getDifferringRevisionIdsOnSource();
        return count($total_changes, COUNT_RECURSIVE) - count($total_changes);
    }

}