From 5f1e296ca123788d14beb2162c50431ddee2551d Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Mon, 17 Jun 2024 09:25:16 +0200 Subject: [PATCH 01/43] FEATURE: Extract workspace metadata and user-assignment to Neos Introduces `WorkspacePublishingService` as replacement for the current Neos `Workspace` "active record" model. Introduces `WorkspaceService` as central authority to manage Neos workspaces. Related: #4726 --- .../SharedModel/Workspace/WorkspaceName.php | 25 +- .../Classes/ContentRepositoryRegistry.php | 8 + .../Command/WorkspaceCommandController.php | 88 +++-- .../{Workspace => Model}/DiscardingResult.php | 2 +- .../{Workspace => Model}/PublishingResult.php | 4 +- Neos.Neos/Classes/Domain/Model/User.php | 10 + Neos.Neos/Classes/Domain/Model/UserId.php | 36 ++ .../Classes/Domain/Model/UserInterface.php | 6 + .../Domain/Model/WorkspaceClassification.php | 17 + .../Domain/Model/WorkspaceDescription.php | 44 +++ .../Domain/Model/WorkspaceMetadata.php | 23 ++ .../Domain/Model/WorkspacePermissions.php | 29 ++ .../Classes/Domain/Model/WorkspaceTitle.php | 39 ++ .../Classes/Domain/Service/UserService.php | 133 +------ .../WorkspacePublishingService.php} | 361 ++++++++---------- .../Domain/Service/WorkspaceService.php | 349 +++++++++++++++++ .../Domain/Workspace/DiscardAllChanges.php | 45 --- .../Domain/Workspace/PublishAllChanges.php | 45 --- .../Domain/Workspace/WorkspaceProvider.php | 77 ---- .../Service/EditorContentStreamZookeeper.php | 63 +-- .../Classes/UserIdProvider/UserIdProvider.php | 6 +- .../Backend/ChangeStatsViewHelper.php | 65 ---- .../Mysql/Version20240425223900.php | 50 +++ .../Postgresql/Version20240425223901.php | 44 +++ .../Controller/WorkspaceController.php | 254 +++++------- .../WorkspaceControllerInternals.php | 38 -- .../WorkspaceControllerInternalsFactory.php | 32 -- .../Classes/ViewModel/PendingChanges.php | 46 +++ .../Classes/ViewModel/WorkspaceListItem.php | 34 ++ .../Classes/ViewModel/WorkspaceListItems.php | 52 +++ .../Private/Templates/Workspace/Index.html | 242 ++++++------ .../Private/Templates/Workspace/New.html | 31 +- .../Private/Translations/en/Main.xlf | 3 + 33 files changed, 1265 insertions(+), 1036 deletions(-) rename Neos.Neos/Classes/Domain/{Workspace => Model}/DiscardingResult.php (94%) rename Neos.Neos/Classes/Domain/{Workspace => Model}/PublishingResult.php (79%) create mode 100644 Neos.Neos/Classes/Domain/Model/UserId.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceDescription.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceTitle.php rename Neos.Neos/Classes/Domain/{Workspace/Workspace.php => Service/WorkspacePublishingService.php} (51%) create mode 100644 Neos.Neos/Classes/Domain/Service/WorkspaceService.php delete mode 100644 Neos.Neos/Classes/Domain/Workspace/DiscardAllChanges.php delete mode 100644 Neos.Neos/Classes/Domain/Workspace/PublishAllChanges.php delete mode 100644 Neos.Neos/Classes/Domain/Workspace/WorkspaceProvider.php delete mode 100644 Neos.Neos/Classes/ViewHelpers/Backend/ChangeStatsViewHelper.php create mode 100644 Neos.Neos/Migrations/Mysql/Version20240425223900.php create mode 100644 Neos.Neos/Migrations/Postgresql/Version20240425223901.php delete mode 100644 Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternals.php delete mode 100644 Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternalsFactory.php create mode 100644 Neos.Workspace.Ui/Classes/ViewModel/PendingChanges.php create mode 100644 Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItem.php create mode 100644 Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php index 37ac2fc8c24..5725d3fdb89 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php @@ -23,6 +23,8 @@ */ final class WorkspaceName implements \JsonSerializable { + private const PATTERN = '/^[a-z0-9\-]{1,30}$/'; + public const WORKSPACE_NAME_LIVE = 'live'; /** @@ -33,7 +35,7 @@ final class WorkspaceName implements \JsonSerializable private function __construct( public readonly string $value ) { - if (preg_match('/^[\p{L}\p{P}\d \.]{1,200}$/u', $value) !== 1) { + if (!self::hasValidFormat($value)) { throw new \InvalidArgumentException('Invalid workspace name given.', 1505826610318); } } @@ -48,6 +50,11 @@ public static function fromString(string $value): self return self::instance($value); } + public static function tryFromString(string $value): ?self + { + return self::hasValidFormat($value) ? self::instance($value) : null; + } + public static function forLive(): self { return self::instance(self::WORKSPACE_NAME_LIVE); @@ -61,19 +68,16 @@ public static function forLive(): self */ public static function transliterateFromString(string $name): self { - try { - // Check if name already match name pattern to prevent unnecessary transliteration + if (self::hasValidFormat($name)) { return self::fromString($name); - } catch (\InvalidArgumentException $e) { - // Okay, let's transliterate } - $originalName = $name; + $originalName = strtolower($name); // Transliterate (transform 北京 to 'Bei Jing') $name = Transliterator::transliterate($name); - // Urlization (replace spaces with dash, special special characters) + // Urlization (replace spaces with dash, special characters) $name = Transliterator::urlize($name); // Ensure only allowed characters are left @@ -84,7 +88,7 @@ public static function transliterateFromString(string $name): self $name = 'workspace-' . strtolower(md5($originalName)); } - return new self($name); + return self::fromString($name); } public function isLive(): bool @@ -101,4 +105,9 @@ public function equals(self $other): bool { return $this === $other; } + + private static function hasValidFormat(string $value): bool + { + return preg_match(self::PATTERN, $value) === 1; + } } diff --git a/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php b/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php index 1fd7cc04910..4912e4e29e5 100644 --- a/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php +++ b/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php @@ -81,6 +81,14 @@ public function get(ContentRepositoryId $contentRepositoryId): ContentRepository return $this->getFactory($contentRepositoryId)->getOrBuild(); } + /** + * @return array + */ + public function getContentRepositoryIds(): array + { + return array_map(ContentRepositoryId::fromString(...), array_keys($this->settings['contentRepositories'])); + } + /** * @internal for test cases only */ diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 664bbc87914..4c030b1b790 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -36,8 +36,10 @@ use Neos\Flow\Cli\CommandController; use Neos\Flow\Cli\Exception\StopCommandException; use Neos\Flow\Persistence\PersistenceManagerInterface; +use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Service\UserService; -use Neos\Neos\Domain\Workspace\WorkspaceProvider; +use Neos\Neos\Domain\Service\WorkspaceService; +use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\PendingChangesProjection\ChangeFinder; /** @@ -56,7 +58,10 @@ class WorkspaceCommandController extends CommandController protected ContentRepositoryRegistry $contentRepositoryRegistry; #[Flow\Inject] - protected WorkspaceProvider $workspaceProvider; + protected WorkspacePublishingService $workspacePublishingService; + + #[Flow\Inject] + protected WorkspaceService $workspaceService; /** * Publish changes of a workspace @@ -68,16 +73,14 @@ class WorkspaceCommandController extends CommandController */ public function publishCommand(string $workspace, string $contentRepository = 'default'): void { - // @todo: bypass access control - $workspace = $this->workspaceProvider->provideForWorkspaceName( + $this->workspacePublishingService->publishWorkspace( ContentRepositoryId::fromString($contentRepository), WorkspaceName::fromString($workspace) ); - $workspace->publishAllChanges(); $this->outputLine( 'Published all nodes in workspace %s to its base workspace', - [$workspace->name->value] + [$workspace] ); } @@ -92,19 +95,17 @@ public function publishCommand(string $workspace, string $contentRepository = 'd */ public function discardCommand(string $workspace, string $contentRepository = 'default'): void { - // @todo: bypass access control - $workspace = $this->workspaceProvider->provideForWorkspaceName( - ContentRepositoryId::fromString($contentRepository), - WorkspaceName::fromString($workspace) - ); - try { - $workspace->discardAllChanges(); + // @todo: bypass access control + $this->workspacePublishingService->discardAllWorkspaceChanges( + ContentRepositoryId::fromString($contentRepository), + WorkspaceName::fromString($workspace) + ); } catch (WorkspaceDoesNotExist $exception) { - $this->outputLine('Workspace "%s" does not exist', [$workspace->name->value]); + $this->outputLine('Workspace "%s" does not exist', [$workspace]); $this->quit(1); } - $this->outputLine('Discarded all nodes in workspace %s', [$workspace->name->value]); + $this->outputLine('Discarded all nodes in workspace %s', [$workspace]); } /** @@ -121,11 +122,11 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de { try { // @todo: bypass access control - $workspace = $this->workspaceProvider->provideForWorkspaceName( + $this->workspacePublishingService->rebaseWorkspace( ContentRepositoryId::fromString($contentRepository), - WorkspaceName::fromString($workspace) + WorkspaceName::fromString($workspace), + $force ? RebaseErrorHandlingStrategy::STRATEGY_FORCE : RebaseErrorHandlingStrategy::STRATEGY_FAIL, ); - $workspace->rebase($force ? RebaseErrorHandlingStrategy::STRATEGY_FORCE : RebaseErrorHandlingStrategy::STRATEGY_FAIL); } catch (WorkspaceDoesNotExist $exception) { $this->outputLine('Workspace "%s" does not exist', [$workspace]); $this->quit(1); @@ -134,7 +135,7 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de $this->quit(1); } - $this->outputLine('Rebased workspace %s', [$workspace->name->value]); + $this->outputLine('Rebased workspace %s', [$workspace]); } /** @@ -178,13 +179,23 @@ public function createCommand( string $contentRepository = 'default' ): void { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + + $this->workspaceService->createWorkspace( + $contentRepositoryId, + \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title), + \Neos\Neos\Domain\Model\WorkspaceDescription::fromString($description ?? ''), + WorkspaceName::fromString($baseWorkspace), + \Neos\Neos\Domain\Model\UserId::fromString($owner), + WorkspaceClassification::PERSONAL, + ); + $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); if ($owner === '') { $workspaceOwnerUserId = null; } else { $workspaceOwnerUserId = UserId::fromString($owner); - $workspaceOwner = $this->userService->findByUserIdentifier($workspaceOwnerUserId); + $workspaceOwner = $this->userService->findUserById($workspaceOwnerUserId); if ($workspaceOwner === null) { $this->outputLine('The user "%s" specified as owner does not exist', [$owner]); $this->quit(3); @@ -243,13 +254,14 @@ public function deleteCommand(string $workspace, bool $force = false, string $co $this->quit(2); } - $workspace = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName); - if (!$workspace instanceof Workspace) { + $crWorkspace = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName); + if ($crWorkspace === null) { $this->outputLine('Workspace "%s" does not exist', [$workspaceName->value]); $this->quit(1); } + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName); - if ($workspace->isPersonalWorkspace()) { + if ($workspaceMetadata->classification === WorkspaceClassification::PERSONAL) { $this->outputLine( 'Did not delete workspace "%s" because it is a personal workspace.' . ' Personal workspaces cannot be deleted manually.', @@ -264,28 +276,28 @@ public function deleteCommand(string $workspace, bool $force = false, string $co 'Workspace "%s" cannot be deleted because the following workspaces are based on it:', [$workspaceName->value] ); + $this->outputLine(); $tableRows = []; $headerRow = ['Name', 'Title', 'Description']; foreach ($dependentWorkspaces as $dependentWorkspace) { + $dependentWorkspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $dependentWorkspace->workspaceName); $tableRows[] = [ $dependentWorkspace->workspaceName->value, - $dependentWorkspace->workspaceTitle->value, - $dependentWorkspace->workspaceDescription->value + $dependentWorkspaceMetadata->title->value, + $dependentWorkspaceMetadata->description->value ]; } $this->output->outputTable($tableRows, $headerRow); $this->quit(3); } + try { - $nodesCount = $contentRepositoryInstance->projectionState(ChangeFinder::class) - ->countByContentStreamId( - $workspace->currentContentStreamId - ); + $nodesCount = $this->workspacePublishingService->countPendingWorkspaceChanges($contentRepositoryId, $workspaceName); } catch (\Exception $exception) { - $this->outputLine('Could not fetch unpublished nodes for workspace %s, nothing was deleted. %s', [$workspace->workspaceName->value, $exception->getMessage()]); + $this->outputLine('Could not fetch unpublished nodes for workspace %s, nothing was deleted. %s', [$workspaceName->value, $exception->getMessage()]); $this->quit(4); } @@ -299,11 +311,7 @@ public function deleteCommand(string $workspace, bool $force = false, string $co $this->quit(5); } // @todo bypass access control? - $workspace = $this->workspaceProvider->provideForWorkspaceName( - $contentRepositoryId, - $workspaceName - ); - $workspace->discardAllChanges(); + $this->workspacePublishingService->discardAllWorkspaceChanges($contentRepositoryId, $workspaceName); } $contentRepositoryInstance->handle( @@ -359,16 +367,18 @@ public function listCommand(string $contentRepository = 'default'): void } $tableRows = []; - $headerRow = ['Name', 'Base Workspace', 'Title', 'Owner', 'Description', 'Status', 'Content Stream']; + $headerRow = ['Name', 'Classification', 'Base Workspace', 'Title', 'Description', 'Status', 'Content Stream']; foreach ($workspaces as $workspace) { + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName); + /* @var Workspace $workspace */ $tableRows[] = [ $workspace->workspaceName->value, + $workspaceMetadata->classification->name, $workspace->baseWorkspaceName?->value ?: '', - $workspace->workspaceTitle->value, - $workspace->workspaceOwner ?: '', - $workspace->workspaceDescription->value, + $workspaceMetadata->title->value, + $workspaceMetadata->description->value, $workspace->status->value, $workspace->currentContentStreamId->value, ]; diff --git a/Neos.Neos/Classes/Domain/Workspace/DiscardingResult.php b/Neos.Neos/Classes/Domain/Model/DiscardingResult.php similarity index 94% rename from Neos.Neos/Classes/Domain/Workspace/DiscardingResult.php rename to Neos.Neos/Classes/Domain/Model/DiscardingResult.php index b6d448206d9..af1fb4d09c1 100644 --- a/Neos.Neos/Classes/Domain/Workspace/DiscardingResult.php +++ b/Neos.Neos/Classes/Domain/Model/DiscardingResult.php @@ -12,7 +12,7 @@ declare(strict_types=1); -namespace Neos\Neos\Domain\Workspace; +namespace Neos\Neos\Domain\Model; use Neos\Flow\Annotations as Flow; diff --git a/Neos.Neos/Classes/Domain/Workspace/PublishingResult.php b/Neos.Neos/Classes/Domain/Model/PublishingResult.php similarity index 79% rename from Neos.Neos/Classes/Domain/Workspace/PublishingResult.php rename to Neos.Neos/Classes/Domain/Model/PublishingResult.php index 8e7215216da..256f5757c1a 100644 --- a/Neos.Neos/Classes/Domain/Workspace/PublishingResult.php +++ b/Neos.Neos/Classes/Domain/Model/PublishingResult.php @@ -12,8 +12,9 @@ declare(strict_types=1); -namespace Neos\Neos\Domain\Workspace; +namespace Neos\Neos\Domain\Model; +use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\Flow\Annotations as Flow; /** @@ -26,6 +27,7 @@ { public function __construct( public int $numberOfPublishedChanges, + public WorkspaceName $targetWorkspaceName, ) { } } diff --git a/Neos.Neos/Classes/Domain/Model/User.php b/Neos.Neos/Classes/Domain/Model/User.php index c7954eb5b90..331636a9f5f 100644 --- a/Neos.Neos/Classes/Domain/Model/User.php +++ b/Neos.Neos/Classes/Domain/Model/User.php @@ -36,6 +36,11 @@ class User extends Person implements UserInterface */ protected $preferences; + /** + * @var string + */ + protected $Persistence_Object_Identifier; + /** * Constructs this User object */ @@ -45,6 +50,11 @@ public function __construct() $this->preferences = new UserPreferences(); } + public function getId(): UserId + { + return UserId::fromString($this->Persistence_Object_Identifier); + } + /** * Returns a label which can be used as a human-friendly identifier for this user. * diff --git a/Neos.Neos/Classes/Domain/Model/UserId.php b/Neos.Neos/Classes/Domain/Model/UserId.php new file mode 100644 index 00000000000..2011ebb9a56 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/UserId.php @@ -0,0 +1,36 @@ +value; + } + + public function equals(self $other): bool + { + return $this->value === $other->value; + } +} diff --git a/Neos.Neos/Classes/Domain/Model/UserInterface.php b/Neos.Neos/Classes/Domain/Model/UserInterface.php index bc451ca8936..b6cc5b33692 100644 --- a/Neos.Neos/Classes/Domain/Model/UserInterface.php +++ b/Neos.Neos/Classes/Domain/Model/UserInterface.php @@ -21,6 +21,12 @@ */ interface UserInterface { + + /** + * Returns the globally unique identifier for this user + */ + public function getId(): UserId; + /** * Returns a label which can be used as a human-friendly identifier for this user, for example his or her first * and last name. diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php new file mode 100644 index 00000000000..47f162a0ff3 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php @@ -0,0 +1,17 @@ +value) !== 1) { + throw new \InvalidArgumentException('Invalid workspace description given.', 1505831660363); + } + } + + public static function fromString(string $value): self + { + return new self($value); + } + + public static function empty(): self + { + return new self(''); + } + + public function jsonSerialize(): string + { + return $this->value; + } + + public function equals(self $other): bool + { + return $this->value === $other->value; + } +} diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php new file mode 100644 index 00000000000..de693c701e0 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -0,0 +1,23 @@ +value) !== 1) { + throw new \InvalidArgumentException('Invalid workspace title given.', 1505827170288); + } + } + + public static function fromString(string $value): self + { + return new self($value); + } + + public function jsonSerialize(): string + { + return $this->value; + } + + public function equals(self $other): bool + { + return $this->value === $other->value; + } +} diff --git a/Neos.Neos/Classes/Domain/Service/UserService.php b/Neos.Neos/Classes/Domain/Service/UserService.php index bab470d18b0..c842a5b22ca 100644 --- a/Neos.Neos/Classes/Domain/Service/UserService.php +++ b/Neos.Neos/Classes/Domain/Service/UserService.php @@ -15,7 +15,6 @@ namespace Neos\Neos\Domain\Service; use Neos\ContentRepository\Core\Projection\Workspace\Workspace; -use Neos\ContentRepository\Core\SharedModel\User\UserId; use Neos\Flow\Annotations as Flow; use Neos\Flow\Persistence\Exception\IllegalObjectTypeException; use Neos\Flow\Persistence\PersistenceManagerInterface; @@ -40,6 +39,7 @@ use Neos\Flow\Utility\Now; use Neos\Neos\Domain\Exception; use Neos\Neos\Domain\Model\User; +use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Repository\UserRepository; use Neos\Party\Domain\Model\AbstractParty; use Neos\Party\Domain\Model\PersonName; @@ -247,39 +247,20 @@ public function getCurrentUser(): ?User return null; } - $tokens = $this->securityContext->getAuthenticationTokens(); - $user = array_reduce($tokens, function ($foundUser, TokenInterface $token) { - if ($foundUser !== null) { - return $foundUser; - } - - /** @var ?Account $account */ + foreach ($this->securityContext->getAuthenticationTokens() as $token) { $account = $token->getAccount(); if ($account === null) { - return $foundUser; + continue; } - $user = $this->getNeosUserForAccount($account); - if ($user === null) { - return $foundUser; + if ($user !== null) { + return $user; } - - return $user; - }, null); - - return $user; - } - - public function getCurrentUserIdentifier(): ?UserId - { - $currentUser = $this->getCurrentUser(); - - return $currentUser - ? UserId::fromString($this->persistenceManager->getIdentifierByObject($currentUser)) - : null; + } + return null; } - public function findByUserIdentifier(UserId $userId): ?User + public function findUserById(UserId $userId): ?User { /** @var ?User $user */ $user = $this->partyRepository->findByIdentifier($userId->value); @@ -677,104 +658,6 @@ public function deactivateUser(User $user): void $this->emitUserDeactivated($user); } - /** - * Checks if the current user may publish to the given workspace according to one the roles of the user's accounts - * - * In future versions, this logic may be implemented in Neos in a more generic way (for example, by means of an - * ACL object), but for now, this method exists in order to at least centralize and encapsulate the required logic. - */ - public function currentUserCanPublishToWorkspace(Workspace $workspace): bool - { - if ($workspace->isPublicWorkspace()) { - return $this->securityContext->hasRole('Neos.Neos:LivePublisher'); - } - - $currentUser = $this->getCurrentUser(); - $ownerIdentifier = $currentUser - ? $this->persistenceManager->getIdentifierByObject($currentUser) - : null; - - if ($workspace->workspaceOwner === null || $workspace->workspaceOwner === $ownerIdentifier) { - return true; - } - - return false; - } - - /** - * Checks if the current user may read the given workspace according to one the roles of the user's accounts - * - * In future versions, this logic may be implemented in Neos in a more generic way (for example, by means of an - * ACL object), but for now, this method exists in order to at least centralize and encapsulate the required logic. - */ - public function currentUserCanReadWorkspace(Workspace $workspace): bool - { - if ($workspace->isPublicWorkspace()) { - return true; - } - - $currentUser = $this->getCurrentUser(); - - return $currentUser && $workspace->workspaceOwner - === $this->persistenceManager->getIdentifierByObject($currentUser); - } - - /** - * Checks if the current user may manage the given workspace according to one the roles of the user's accounts - * - * In future versions, this logic may be implemented in Neos in a more generic way (for example, by means of an - * ACL object), but for now, this method exists in order to at least centralize and encapsulate the required logic. - */ - public function currentUserCanManageWorkspace(Workspace $workspace): bool - { - if ($workspace->isPersonalWorkspace()) { - return false; - } - - if ($workspace->isInternalWorkspace()) { - return $this->privilegeManager->isPrivilegeTargetGranted( - 'Neos.Neos:Backend.Module.Management.Workspaces.ManageInternalWorkspaces' - ); - } - - - $currentUser = $this->getCurrentUser(); - if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner === $this->persistenceManager->getIdentifierByObject($currentUser)) { - return $this->privilegeManager->isPrivilegeTargetGranted( - 'Neos.Neos:Backend.Module.Management.Workspaces.ManageOwnWorkspaces' - ); - } - - if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner !== $this->persistenceManager->getIdentifierByObject($currentUser)) { - return $this->privilegeManager->isPrivilegeTargetGranted( - 'Neos.Neos:Backend.Module.Management.Workspaces.ManageAllPrivateWorkspaces' - ); - } - - return false; - } - - - /** - * Checks if the current user may transfer ownership of the given workspace - * - * In future versions, this logic may be implemented in Neos in a more generic way (for example, by means of an - * ACL object), but for now, this method exists in order to at least centralize and encapsulate the required logic. - */ - public function currentUserCanTransferOwnershipOfWorkspace(Workspace $workspace): bool - { - if ($workspace->isPersonalWorkspace()) { - return false; - } - - // The privilege to manage shared workspaces is needed, because regular editors should not change ownerships - // of their internal workspaces, even if it was technically possible, because they wouldn't be able to change - // ownership back to themselves. - return $this->privilegeManager->isPrivilegeTargetGranted( - 'Neos.Neos:Backend.Module.Management.Workspaces.ManageInternalWorkspaces' - ); - } - /** * @return bool * @throws NoSuchRoleException diff --git a/Neos.Neos/Classes/Domain/Workspace/Workspace.php b/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php similarity index 51% rename from Neos.Neos/Classes/Domain/Workspace/Workspace.php rename to Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php index 9d3bd125be8..78a71898036 100644 --- a/Neos.Neos/Classes/Domain/Workspace/Workspace.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php @@ -12,7 +12,7 @@ declare(strict_types=1); -namespace Neos\Neos\Domain\Workspace; +namespace Neos\Neos\Domain\Service; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\ChangeBaseWorkspace; @@ -22,334 +22,285 @@ use Neos\ContentRepository\Core\Feature\WorkspacePublication\Command\PublishWorkspace; use Neos\ContentRepository\Core\Feature\WorkspacePublication\Dto\NodeIdsToPublishOrDiscard; use Neos\ContentRepository\Core\Feature\WorkspacePublication\Dto\NodeIdToPublishOrDiscard; +use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Command\RebaseWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Dto\RebaseErrorHandlingStrategy; use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Exception\WorkspaceRebaseFailed; use Neos\ContentRepository\Core\NodeType\NodeTypeName; use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindClosestNodeFilter; use Neos\ContentRepository\Core\Projection\ContentGraph\NodeAggregate; use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints; -use Neos\ContentRepository\Core\Projection\Workspace\WorkspaceStatus; +use Neos\ContentRepository\Core\Projection\Workspace\Workspace as ContentRepositoryWorkspace; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Exception\NodeAggregateCurrentlyDoesNotExist; use Neos\ContentRepository\Core\SharedModel\Exception\WorkspaceDoesNotExist; use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; +use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; -use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Command\RebaseWorkspace; -use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; -use Neos\Neos\Domain\Service\NodeTypeNameFactory; +use Neos\Neos\Domain\Model\DiscardingResult; +use Neos\Neos\Domain\Model\PublishingResult; use Neos\Neos\PendingChangesProjection\Change; use Neos\Neos\PendingChangesProjection\ChangeFinder; /** - * Neos' workspace model - * - * Provides a high-level API to evaluate, publish or discard changes in a given workspace. - * Uses the low-level content repository workspace read model for information retrieval, - * {@see \Neos\ContentRepository\Core\Projection\Workspace\Workspace} - * - * This model is mutable and will for example update itself after publishing, or changing the base workspace. - * Mutations in the content repository that are not triggered by this model (by using the low level API) will not be reflected. + * Central authority for publishing/discarding workspace changes from Neos * * @api */ -#[Flow\Proxy(false)] -final class Workspace +#[Flow\Scope('singleton')] +final class WorkspacePublishingService { - public readonly ContentRepositoryId $contentRepositoryId; - - /** @internal please use the {@see WorkspaceProvider} instead */ public function __construct( - public readonly WorkspaceName $name, - private ContentStreamId $currentContentStreamId, - private WorkspaceStatus $currentStatus, - private ?WorkspaceName $currentBaseWorkspaceName, - private readonly ContentRepository $contentRepository, + private readonly ContentRepositoryRegistry $contentRepositoryRegistry, ) { - $this->contentRepositoryId = $contentRepository->id; - } - - public function getCurrentStatus(): WorkspaceStatus - { - return $this->currentStatus; - } - - public function getCurrentBaseWorkspaceName(): ?WorkspaceName - { - return $this->currentBaseWorkspaceName; - } - - /** @internal experimental api, until actually used by the Neos.Ui */ - public function countAllChanges(): int - { - $changeFinder = $this->contentRepository->projectionState(ChangeFinder::class); - $changes = $changeFinder->findByContentStreamId($this->currentContentStreamId); - - return count($changes); } /** @internal experimental api, until actually used by the Neos.Ui */ - public function countChangesInSite(NodeAggregateId $siteId): int + public function countPendingWorkspaceChanges(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): int { - $ancestorNodeTypeName = NodeTypeNameFactory::forSite(); - $this->requireNodeToBeOfType( - $siteId, - $ancestorNodeTypeName - ); - - $changes = $this->resolveNodeIdsToPublishOrDiscard( - $siteId, - $ancestorNodeTypeName - ); - - return count($changes); + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + return count($this->pendingWorkspaceChanges($contentRepository, $workspaceName)); } - /** @internal experimental api, until actually used by the Neos.Ui */ - public function countChangesInDocument(NodeAggregateId $documentId): int - { - $ancestorNodeTypeName = NodeTypeNameFactory::forDocument(); - $this->requireNodeToBeOfType( - $documentId, - $ancestorNodeTypeName - ); - $changes = $this->resolveNodeIdsToPublishOrDiscard( - $documentId, - $ancestorNodeTypeName - ); - - return count($changes); - } - - /** @internal should not be necessary in user land code */ - public function getCurrentContentStreamId(): ContentStreamId + /** + * @throws WorkspaceDoesNotExist | WorkspaceRebaseFailed + */ + public function rebaseWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, RebaseErrorHandlingStrategy $rebaseErrorHandlingStrategy = RebaseErrorHandlingStrategy::STRATEGY_FAIL): void { - return $this->currentContentStreamId; + $rebaseCommand = RebaseWorkspace::create($workspaceName)->withErrorHandlingStrategy($rebaseErrorHandlingStrategy); + $this->contentRepositoryRegistry->get($contentRepositoryId)->handle($rebaseCommand); } - public function publishAllChanges(): PublishingResult + public function publishWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): PublishingResult { - $changeFinder = $this->contentRepository->projectionState(ChangeFinder::class); - $changes = $changeFinder->findByContentStreamId($this->currentContentStreamId); - - $this->publish(); - - return new PublishingResult( - count($changes) - ); + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + if ($crWorkspace->baseWorkspaceName === null) { + throw new \InvalidArgumentException(sprintf('Failed to publish workspace "%s" because it has no base workspace', $workspaceName->value), 1717517124); + } + $numberOfPendingChanges = $this->pendingWorkspaceChanges($contentRepository, $workspaceName); + $this->contentRepositoryRegistry->get($contentRepositoryId)->handle(PublishWorkspace::create($workspaceName)); + return new PublishingResult(count($numberOfPendingChanges), $crWorkspace->baseWorkspaceName); } - public function publishChangesInSite(NodeAggregateId $siteId): PublishingResult + public function publishChangesInSite(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $siteId): PublishingResult { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + if ($crWorkspace->baseWorkspaceName === null) { + throw new \InvalidArgumentException(sprintf('Failed to publish workspace "%s" because it has no base workspace', $workspaceName->value), 1717517240); + } $ancestorNodeTypeName = NodeTypeNameFactory::forSite(); $this->requireNodeToBeOfType( + $contentRepository, + $workspaceName, $siteId, $ancestorNodeTypeName ); $nodeIdsToPublish = $this->resolveNodeIdsToPublishOrDiscard( + $contentRepository, + $workspaceName, $siteId, $ancestorNodeTypeName ); - $this->publishNodes($nodeIdsToPublish); + $this->publishNodes($contentRepository, $workspaceName, $nodeIdsToPublish); return new PublishingResult( - count($nodeIdsToPublish) + count($nodeIdsToPublish), + $crWorkspace->baseWorkspaceName, ); } - public function publishChangesInDocument(NodeAggregateId $documentId): PublishingResult + public function publishChangesInDocument(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $documentId): PublishingResult { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + if ($crWorkspace->baseWorkspaceName === null) { + throw new \InvalidArgumentException(sprintf('Failed to publish workspace "%s" because it has no base workspace', $workspaceName->value), 1717517467); + } $ancestorNodeTypeName = NodeTypeNameFactory::forDocument(); $this->requireNodeToBeOfType( + $contentRepository, + $workspaceName, $documentId, $ancestorNodeTypeName ); $nodeIdsToPublish = $this->resolveNodeIdsToPublishOrDiscard( + $contentRepository, + $workspaceName, $documentId, $ancestorNodeTypeName ); - $this->publishNodes($nodeIdsToPublish); + $this->publishNodes($contentRepository, $workspaceName, $nodeIdsToPublish); return new PublishingResult( - count($nodeIdsToPublish) + count($nodeIdsToPublish), + $crWorkspace->baseWorkspaceName, ); } - public function discardAllChanges(): DiscardingResult + public function discardAllWorkspaceChanges(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): DiscardingResult { - $changeFinder = $this->contentRepository->projectionState(ChangeFinder::class); - $changes = $changeFinder->findByContentStreamId($this->currentContentStreamId); + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + + $changesToBeDiscarded = $this->pendingWorkspaceChanges($contentRepository, $workspaceName); - $this->discard(); + $contentRepository->handle(DiscardWorkspace::create($workspaceName)); return new DiscardingResult( - count($changes) + count($changesToBeDiscarded) ); } - public function discardChangesInSite(NodeAggregateId $siteId): DiscardingResult + public function discardChangesInSite(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $siteId): DiscardingResult { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); $ancestorNodeTypeName = NodeTypeNameFactory::forSite(); $this->requireNodeToBeOfType( + $contentRepository, + $workspaceName, $siteId, $ancestorNodeTypeName ); $nodeIdsToDiscard = $this->resolveNodeIdsToPublishOrDiscard( + $contentRepository, + $workspaceName, $siteId, NodeTypeNameFactory::forSite() ); - $this->discardNodes($nodeIdsToDiscard); + $this->discardNodes($contentRepository, $workspaceName, $nodeIdsToDiscard); return new DiscardingResult( count($nodeIdsToDiscard) ); } - public function discardChangesInDocument(NodeAggregateId $documentId): DiscardingResult + public function discardChangesInDocument(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $documentId): DiscardingResult { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); $ancestorNodeTypeName = NodeTypeNameFactory::forDocument(); $this->requireNodeToBeOfType( + $contentRepository, + $workspaceName, $documentId, $ancestorNodeTypeName ); $nodeIdsToDiscard = $this->resolveNodeIdsToPublishOrDiscard( + $contentRepository, + $workspaceName, $documentId, $ancestorNodeTypeName ); - $this->discardNodes($nodeIdsToDiscard); + $this->discardNodes($contentRepository, $workspaceName, $nodeIdsToDiscard); return new DiscardingResult( count($nodeIdsToDiscard) ); } - /** - * @throws WorkspaceRebaseFailed - */ - public function rebase(RebaseErrorHandlingStrategy $rebaseErrorHandlingStrategy = RebaseErrorHandlingStrategy::STRATEGY_FAIL): void + public function changeBaseWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceName $newBaseWorkspaceName): void { - $rebaseCommand = RebaseWorkspace::create( - $this->name - )->withErrorHandlingStrategy($rebaseErrorHandlingStrategy); - - $this->contentRepository->handle($rebaseCommand); - - $this->updateCurrentState(); - } - - public function changeBaseWorkspace(WorkspaceName $baseWorkspaceName): void - { - $this->contentRepository->handle( + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + $contentRepository->handle( ChangeBaseWorkspace::create( - $this->name, - $baseWorkspaceName + $workspaceName, + $newBaseWorkspaceName, ) ); - - $this->updateCurrentState(); } - private function requireNodeToBeOfType( - NodeAggregateId $nodeAggregateId, - NodeTypeName $nodeTypeName, + private function discardNodes( + ContentRepository $contentRepository, + WorkspaceName $workspaceName, + NodeIdsToPublishOrDiscard $nodeIdsToDiscard ): void { - $nodeAggregate = $this->contentRepository->getContentGraph($this->name)->findNodeAggregateById( - $nodeAggregateId, + /** + * TODO: only rebase if necessary! + * Also, isn't this already included in @see WorkspaceCommandHandler::handleDiscardIndividualNodesFromWorkspace ? + */ + $contentRepository->handle( + RebaseWorkspace::create($workspaceName) ); - if (!$nodeAggregate instanceof NodeAggregate) { - throw new NodeAggregateCurrentlyDoesNotExist( - 'Node aggregate ' . $nodeAggregateId->value . ' does currently not exist', - 1710967964 - ); - } - if ( - !$this->contentRepository->getNodeTypeManager() - ->getNodeType($nodeAggregate->nodeTypeName) - ?->isOfType($nodeTypeName) - ) { - throw new \DomainException( - 'Node aggregate ' . $nodeAggregateId->value . ' is not of expected type ' . $nodeTypeName->value, - 1710968108 - ); - } - } - - private function publish(): void - { - $this->contentRepository->handle( - PublishWorkspace::create( - $this->name, + $contentRepository->handle( + DiscardIndividualNodesFromWorkspace::create( + $workspaceName, + $nodeIdsToDiscard ) ); - - $this->updateCurrentState(); } private function publishNodes( + ContentRepository $contentRepository, + WorkspaceName $workspaceName, NodeIdsToPublishOrDiscard $nodeIdsToPublish ): void { /** * TODO: only rebase if necessary! * Also, isn't this already included in @see WorkspaceCommandHandler::handlePublishIndividualNodesFromWorkspace ? */ - $this->contentRepository->handle( - RebaseWorkspace::create( - $this->name - ) + $contentRepository->handle( + RebaseWorkspace::create($workspaceName) ); - $this->contentRepository->handle( + $contentRepository->handle( PublishIndividualNodesFromWorkspace::create( - $this->name, + $workspaceName, $nodeIdsToPublish ) ); - - $this->updateCurrentState(); } - private function discard(): void - { - $this->contentRepository->handle( - DiscardWorkspace::create( - $this->name, - ) - ); - - $this->updateCurrentState(); + private function requireContentRepositoryWorkspace( + ContentRepository $contentRepository, + WorkspaceName $workspaceName + ): ContentRepositoryWorkspace { + $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceName); + if (!$workspace instanceof ContentRepositoryWorkspace) { + throw WorkspaceDoesNotExist::butWasSupposedTo($workspaceName); + } + return $workspace; } - private function discardNodes( - NodeIdsToPublishOrDiscard $nodeIdsToDiscard + private function requireNodeToBeOfType( + ContentRepository $contentRepository, + WorkspaceName $workspaceName, + NodeAggregateId $nodeAggregateId, + NodeTypeName $nodeTypeName, ): void { - /** - * TODO: only rebase if necessary! - * Also, isn't this already included in @see WorkspaceCommandHandler::handleDiscardIndividualNodesFromWorkspace ? - */ - $this->contentRepository->handle( - RebaseWorkspace::create( - $this->name - ) - ); - - $this->contentRepository->handle( - DiscardIndividualNodesFromWorkspace::create( - $this->name, - $nodeIdsToDiscard - ) + $nodeAggregate = $contentRepository->getContentGraph($workspaceName)->findNodeAggregateById( + $nodeAggregateId, ); + if (!$nodeAggregate instanceof NodeAggregate) { + throw new NodeAggregateCurrentlyDoesNotExist( + 'Node aggregate ' . $nodeAggregateId->value . ' does currently not exist', + 1710967964 + ); + } - $this->updateCurrentState(); + if ( + !$contentRepository->getNodeTypeManager() + ->getNodeType($nodeAggregate->nodeTypeName) + ?->isOfType($nodeTypeName) + ) { + throw new \RuntimeException( + sprintf('Node aggregate %s is not of expected type %s', $nodeAggregateId->value, $nodeTypeName->value), + 1710968108 + ); + } } /** @@ -357,16 +308,17 @@ private function discardNodes( * @param NodeTypeName $ancestorNodeTypeName The type of the ancestor node of all affected nodes */ private function resolveNodeIdsToPublishOrDiscard( + ContentRepository $contentRepository, + WorkspaceName $workspaceName, NodeAggregateId $ancestorId, NodeTypeName $ancestorNodeTypeName ): NodeIdsToPublishOrDiscard { - /** @var ChangeFinder $changeFinder */ - $changeFinder = $this->contentRepository->projectionState(ChangeFinder::class); - $changes = $changeFinder->findByContentStreamId($this->currentContentStreamId); $nodeIdsToPublishOrDiscard = []; - foreach ($changes as $change) { + foreach ($this->pendingWorkspaceChanges($contentRepository, $workspaceName) as $change) { if ( !$this->isChangePublishableWithinAncestorScope( + $contentRepository, + $workspaceName, $change, $ancestorNodeTypeName, $ancestorId @@ -384,7 +336,20 @@ private function resolveNodeIdsToPublishOrDiscard( return NodeIdsToPublishOrDiscard::create(...$nodeIdsToPublishOrDiscard); } + /** + * @return array + */ + private function pendingWorkspaceChanges(ContentRepository $contentRepository, WorkspaceName $workspaceName): array + { + $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + /** @var ChangeFinder $changeFinder */ + $changeFinder = $contentRepository->projectionState(ChangeFinder::class); + return $changeFinder->findByContentStreamId($crWorkspace->currentContentStreamId); + } + private function isChangePublishableWithinAncestorScope( + ContentRepository $contentRepository, + WorkspaceName $workspaceName, Change $change, NodeTypeName $ancestorNodeTypeName, NodeAggregateId $ancestorId @@ -397,7 +362,7 @@ private function isChangePublishableWithinAncestorScope( } } - $subgraph = $this->contentRepository->getContentGraph($this->name)->getSubgraph( + $subgraph = $contentRepository->getContentGraph($workspaceName)->getSubgraph( $change->originDimensionSpacePoint->toDimensionSpacePoint(), VisibilityConstraints::withoutRestrictions() ); @@ -414,7 +379,7 @@ private function isChangePublishableWithinAncestorScope( } /** - * Before the introduction of the WorkspacePublisher, the UI only ever + * Before the introduction of the {@see WorkspacePublishingService}, the UI only ever * referenced the closest document node as a removal attachment point. * * Removed document nodes therefore were referencing themselves. @@ -428,7 +393,7 @@ private function isChangePublishableWithinAncestorScope( * located, because we have no reference to their respective site. * * Every document node that matches that description will be published - * or discarded by WorkspacePublisher::publishSite, regardless of what + * or discarded by {@see WorkspacePublishingService::publishChangesInSite()}, regardless of what * the current site is. * * @deprecated remove once we are sure this check is no longer needed due to @@ -440,18 +405,4 @@ private function isChangeWithSelfReferencingRemovalAttachmentPoint(Change $chang { return $change->removalAttachmentPoint?->equals($change->nodeAggregateId) ?? false; } - - private function updateCurrentState(): void - { - /** The workspace projection should have been marked stale via @see WithMarkStaleInterface in the meantime */ - $contentRepositoryWorkspace = $this->contentRepository->getWorkspaceFinder() - ->findOneByName($this->name); - if (!$contentRepositoryWorkspace) { - throw new WorkspaceDoesNotExist('Cannot update state of non-existent workspace ' . $this->name->value, 1711704397); - } - - $this->currentContentStreamId = $contentRepositoryWorkspace->currentContentStreamId; - $this->currentStatus = $contentRepositoryWorkspace->status; - $this->currentBaseWorkspaceName = $contentRepositoryWorkspace->baseWorkspaceName; - } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php new file mode 100644 index 00000000000..010f0a3a888 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -0,0 +1,349 @@ +requireWorkspace($contentRepositoryId, $workspaceName); + + $table = self::TABLE_NAME_WORKSPACE_METADATA; + $query = <<dbal->fetchAssociative($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + ]); + if ($metadataRow === false) { + return new WorkspaceMetadata( + $workspaceName, + WorkspaceTitle::fromString(ucfirst($workspaceName->value)), + WorkspaceDescription::fromString(''), + $workspaceName->isLive() ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, + ); + } + return new WorkspaceMetadata( + $workspaceName, + WorkspaceTitle::fromString($metadataRow['title']), + WorkspaceDescription::fromString($metadataRow['description']), + WorkspaceClassification::from($metadataRow['classification']) + ); + } + + public function getPersonalWorkspaceForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): Workspace + { + $workspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $userId); + if ($workspaceName === null) { + throw new \RuntimeException(sprintf('No workspace is assigned to the user with id "%s")', $userId->value), 1718293801); + } + return $this->requireWorkspace($contentRepositoryId, $workspaceName); + } + + + + public function createRootWorkspace( + ContentRepositoryId $contentRepositoryId, + WorkspaceTitle $title, + WorkspaceDescription $description, + ): WorkspaceName + { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); + $contentRepository->handle( + CreateRootWorkspace::create( + $workspaceName, + \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle::fromString($title->value), + \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription::fromString($description->value), + ContentStreamId::create() + ) + ); + + // TODO catch exceptions + + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject' => 'group:EVERYBODY', + 'role' => 'OWNER', + ]); + + // TODO catch exceptions + + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'title' => $title->value, + 'description' => $description->value, + 'classification' => WorkspaceClassification::ROOT, + ]); + + return $workspaceName; + } + + public function createWorkspace( + ContentRepositoryId $contentRepositoryId, + WorkspaceTitle $title, + WorkspaceDescription $description, + WorkspaceName $baseWorkspaceName, + UserId|null $ownerId, + WorkspaceClassification $classification, + ): WorkspaceName { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); + $contentRepository->handle( + CreateWorkspace::create( + $workspaceName, + $baseWorkspaceName, + \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle::fromString($title->value), + \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription::fromString($description->value), + ContentStreamId::create() + ) + ); + + // TODO catch exceptions + + if ($ownerId !== null) { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject' => 'user:' . $ownerId->value, + 'role' => 'OWNER', + ]); + } + + // TODO catch exceptions + + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'title' => $title->value, + 'description' => $description->value, + 'classification' => $classification->name, + ]); + + return $workspaceName; + } + + public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $contentRepositoryId, User $user): void + { + $existingWorkspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId()); + if ($existingWorkspaceName !== null) { + $this->requireWorkspace($contentRepositoryId, $existingWorkspaceName); + return; + } + $this->createWorkspace( + $contentRepositoryId, + WorkspaceTitle::fromString($user->getLabel()), + WorkspaceDescription::empty(), + WorkspaceName::forLive(), + $user->getId(), + WorkspaceClassification::PERSONAL, + ); + } + + public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions + { + $workspaceMetadata = $this->getWorkspaceMetadata($contentRepositoryId, $workspaceName); + + $userRoles = $this->userService->getAllRoles($user); + $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); + + $userWorkspaceRoles = $this->getUserWorkspaceRoles($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); + + return match ($workspaceMetadata->classification) { + WorkspaceClassification::UNKNOWN => WorkspacePermissions::create( + read: $userIsAdmin, + publish: false, + manage: $userIsAdmin, + ), + WorkspaceClassification::ROOT => WorkspacePermissions::create( + read: true, + publish: $this->privilegeManager->isPrivilegeTargetGrantedForRoles($userRoles, 'Neos.Workspace.Ui:Backend.PublishAllToLiveWorkspace'), + manage: $userIsAdmin, + ), + WorkspaceClassification::PERSONAL => WorkspacePermissions::create( + read: $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId())?->equals($workspaceName) ?: false, + publish: in_array('MANAGER', $userWorkspaceRoles, true), + manage: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), + ), + WorkspaceClassification::SHARED => WorkspacePermissions::create( + read: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), + publish: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), + manage: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), + ), + }; + +// $this->privilegeManager->isPrivilegeTargetGrantedForRoles($user->getAllRoles) +// +// // can manage +// +// if ($workspace->isInternalWorkspace()) { +// return $this->privilegeManager->isPrivilegeTargetGranted( +// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageInternalWorkspaces' +// ); +// } +// +// +// $currentUser = $this->getCurrentUser(); +// if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner === $this->persistenceManager->getIdentifierByObject($currentUser)) { +// return $this->privilegeManager->isPrivilegeTargetGranted( +// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageOwnWorkspaces' +// ); +// } +// +// if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner !== $this->persistenceManager->getIdentifierByObject($currentUser)) { +// return $this->privilegeManager->isPrivilegeTargetGranted( +// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageAllPrivateWorkspaces' +// ); +// } +// +// +// // can publish +// +// if ($workspace->isPublicWorkspace()) { +// return $this->securityContext->hasRole('Neos.Neos:LivePublisher'); +// } +// +// $currentUser = $this->getCurrentUser(); +// $ownerIdentifier = $currentUser +// ? $this->persistenceManager->getIdentifierByObject($currentUser) +// : null; +// +// if ($workspace->workspaceOwner === null || $workspace->workspaceOwner === $ownerIdentifier) { +// return true; +// } +// +// +// return WorkspacePermissions::create( +// read: false, +// publish: false, +// manage: false, +// ); + } + + private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): ?WorkspaceName + { + $table = self::TABLE_NAME_WORKSPACE_ROLE; + $query = <<dbal->fetchOne($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'subject' => 'user:' . $userId->value, + 'ownerRole' => 'OWNER' + ]); + return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); + } + + private function getUserWorkspaceRoles(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): array + { + $table = self::TABLE_NAME_WORKSPACE_ROLE; + $query = <<dbal->fetchFirstColumn($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + 'subjects' => ['user:' . $userId->value, ...array_map(fn (string $role) => 'group:' . $role, $userRoles)], + ], [ + 'subjects' => Connection::PARAM_STR_ARRAY, + ]); + } + + private static function getUniqueWorkspaceName(ContentRepository $contentRepository, string $candidate): WorkspaceName + { + $workspaceNameCandidate = WorkspaceName::transliterateFromString($candidate); + $workspaceName = $workspaceNameCandidate; + while ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) instanceof Workspace) { + $workspaceName = WorkspaceName::fromString( + $workspaceNameCandidate->value . '-' . Algorithms::generateRandomString(5) + ); + } + return $workspaceName; + } + + + private function requireWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): Workspace + { + $workspace = $this->contentRepositoryRegistry + ->get($contentRepositoryId) + ->getWorkspaceFinder() + ->findOneByName($workspaceName); + if ($workspace === null) { + throw new \InvalidArgumentException(sprintf('Failed to find workspace with name "%s"', $workspaceName->value), 1718379722); + } + return $workspace; + } + +} diff --git a/Neos.Neos/Classes/Domain/Workspace/DiscardAllChanges.php b/Neos.Neos/Classes/Domain/Workspace/DiscardAllChanges.php deleted file mode 100644 index 89a4cbb80b5..00000000000 --- a/Neos.Neos/Classes/Domain/Workspace/DiscardAllChanges.php +++ /dev/null @@ -1,45 +0,0 @@ - $values - */ - public static function fromArray(array $values): self - { - return new self( - ContentRepositoryId::fromString($values['contentRepositoryId']), - WorkspaceName::fromString($values['workspaceName']), - ); - } -} diff --git a/Neos.Neos/Classes/Domain/Workspace/PublishAllChanges.php b/Neos.Neos/Classes/Domain/Workspace/PublishAllChanges.php deleted file mode 100644 index 586350f0d8d..00000000000 --- a/Neos.Neos/Classes/Domain/Workspace/PublishAllChanges.php +++ /dev/null @@ -1,45 +0,0 @@ - $values - */ - public static function fromArray(array $values): self - { - return new self( - ContentRepositoryId::fromString($values['contentRepositoryId']), - WorkspaceName::fromString($values['workspaceName']), - ); - } -} diff --git a/Neos.Neos/Classes/Domain/Workspace/WorkspaceProvider.php b/Neos.Neos/Classes/Domain/Workspace/WorkspaceProvider.php deleted file mode 100644 index 257a1233410..00000000000 --- a/Neos.Neos/Classes/Domain/Workspace/WorkspaceProvider.php +++ /dev/null @@ -1,77 +0,0 @@ - - */ - private array $instances; - - public function __construct( - private readonly ContentRepositoryRegistry $contentRepositoryRegistry - ) { - } - - public function provideForWorkspaceName( - ContentRepositoryId $contentRepositoryId, - WorkspaceName $workspaceName, - ): Workspace { - $index = $contentRepositoryId->value . '-' . $workspaceName->value; - if (isset($this->instances[$index])) { - return $this->instances[$index]; - } - - $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - $contentRepositoryWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); - - return $this->instances[$index] = new Workspace( - $workspaceName, - $contentRepositoryWorkspace->currentContentStreamId, - $contentRepositoryWorkspace->status, - $contentRepositoryWorkspace->baseWorkspaceName, - $contentRepository - ); - } - - private function requireContentRepositoryWorkspace( - ContentRepository $contentRepository, - WorkspaceName $workspaceName - ): ContentRepositoryWorkspace { - $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceName); - if (!$workspace instanceof ContentRepositoryWorkspace) { - throw WorkspaceDoesNotExist::butWasSupposedTo($workspaceName); - } - - // @todo: access control goes here - - return $workspace; - } -} diff --git a/Neos.Neos/Classes/Service/EditorContentStreamZookeeper.php b/Neos.Neos/Classes/Service/EditorContentStreamZookeeper.php index f4e18d0a96d..4ea58ba6d74 100644 --- a/Neos.Neos/Classes/Service/EditorContentStreamZookeeper.php +++ b/Neos.Neos/Classes/Service/EditorContentStreamZookeeper.php @@ -14,22 +14,12 @@ namespace Neos\Neos\Service; -use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; -use Neos\ContentRepository\Core\SharedModel\User\UserId; -use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle; -use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; use Neos\Flow\Core\Bootstrap; use Neos\Flow\Http\HttpRequestHandlerInterface; -use Neos\Flow\Persistence\PersistenceManagerInterface; use Neos\Flow\Security\Authentication; use Neos\Flow\Security\Policy\PolicyService; -use Neos\Flow\Security\Policy\Role; -use Neos\Neos\Domain\Model\User; -use Neos\Neos\Domain\Service\WorkspaceNameBuilder; +use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionFailedException; use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult; use Neos\Party\Domain\Service\PartyService; @@ -46,15 +36,15 @@ final class EditorContentStreamZookeeper { /** * @Flow\Inject - * @var PersistenceManagerInterface + * @var PartyService */ - protected $persistenceManager; + protected $partyService; /** * @Flow\Inject - * @var PartyService + * @var \Neos\Neos\Domain\Service\UserService */ - protected $partyService; + protected $userService; /** * @Flow\Inject @@ -70,9 +60,9 @@ final class EditorContentStreamZookeeper /** * @Flow\Inject - * @var ContentRepositoryRegistry + * @var WorkspaceService */ - protected $contentRepositoryRegistry; + protected $workspaceService; /** * This method is called whenever a login happens (AuthenticationProviderManager::class, 'authenticatedToken'), @@ -97,45 +87,14 @@ public function relayEditorAuthentication(Authentication\TokenInterface $token): } catch (SiteDetectionFailedException) { return; } - $contentRepository = $this->contentRepositoryRegistry->get($siteDetectionResult->contentRepositoryId); - $isEditor = false; - foreach ($token->getAccount()->getRoles() as $role) { - /** @var Role $role */ - if (isset($role->getAllParentRoles()['Neos.Neos:AbstractEditor'])) { - $isEditor = true; - break; - } - } - if (!$isEditor) { + $authenticatedUser = $this->userService->getCurrentUser(); + if ($authenticatedUser === null) { return; } - $user = $this->partyService->getAssignedPartyOfAccount($token->getAccount()); - if (!$user instanceof User) { - return; - } - $workspaceName = WorkspaceNameBuilder::fromAccountIdentifier( - $token->getAccount()->getAccountIdentifier() - ); - $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceName); - if ($workspace !== null) { - return; - } - - $baseWorkspace = $contentRepository->getWorkspaceFinder()->findOneByName(WorkspaceName::forLive()); - if (!$baseWorkspace) { + if (!array_key_exists('Neos.Neos:AbstractEditor', $this->userService->getAllRoles($authenticatedUser))) { return; } - $editorsNewContentStreamId = ContentStreamId::create(); - $contentRepository->handle( - CreateWorkspace::create( - $workspaceName, - $baseWorkspace->workspaceName, - new WorkspaceTitle((string) $user->getName()), - new WorkspaceDescription(''), - $editorsNewContentStreamId, - UserId::fromString($this->persistenceManager->getIdentifierByObject($user)) - ) - ); + $this->workspaceService->createPersonalWorkspaceForUserIfMissing($siteDetectionResult->contentRepositoryId, $authenticatedUser); } } diff --git a/Neos.Neos/Classes/UserIdProvider/UserIdProvider.php b/Neos.Neos/Classes/UserIdProvider/UserIdProvider.php index 6b1da68e7a9..b81c97e8c5a 100644 --- a/Neos.Neos/Classes/UserIdProvider/UserIdProvider.php +++ b/Neos.Neos/Classes/UserIdProvider/UserIdProvider.php @@ -20,10 +20,10 @@ public function __construct( public function getUserId(): UserId { - $userId = $this->userService->getCurrentUserIdentifier(); - if ($userId === null) { + $user = $this->userService->getCurrentUser(); + if ($user === null) { return UserId::forSystemUser(); } - return UserId::fromString($userId->value); + return UserId::fromString($user->getId()->value); } } diff --git a/Neos.Neos/Classes/ViewHelpers/Backend/ChangeStatsViewHelper.php b/Neos.Neos/Classes/ViewHelpers/Backend/ChangeStatsViewHelper.php deleted file mode 100644 index 6d4493e4773..00000000000 --- a/Neos.Neos/Classes/ViewHelpers/Backend/ChangeStatsViewHelper.php +++ /dev/null @@ -1,65 +0,0 @@ -registerArgument('changeCounts', 'array', 'Expected keys: new, changed, removed', true); - } - - /** - * Expects an array of change count data and adds calculated ratios to the rendered child view - * - * @return string - */ - public function render(): string - { - $changeCounts = $this->arguments['changeCounts']; - - $this->templateVariableContainer->add('newCountRatio', $changeCounts['new'] / $changeCounts['total'] * 100); - $this->templateVariableContainer->add( - 'changedCountRatio', - $changeCounts['changed'] / $changeCounts['total'] * 100 - ); - $this->templateVariableContainer->add( - 'removedCountRatio', - $changeCounts['removed'] / $changeCounts['total'] * 100 - ); - $content = $this->renderChildren(); - $this->templateVariableContainer->remove('newCountRatio'); - $this->templateVariableContainer->remove('changedCountRatio'); - $this->templateVariableContainer->remove('removedCountRatio'); - - return $content; - } -} diff --git a/Neos.Neos/Migrations/Mysql/Version20240425223900.php b/Neos.Neos/Migrations/Mysql/Version20240425223900.php new file mode 100644 index 00000000000..3083611b5c6 --- /dev/null +++ b/Neos.Neos/Migrations/Mysql/Version20240425223900.php @@ -0,0 +1,50 @@ +abortIf( + !$this->connection->getDatabasePlatform() instanceof \Doctrine\DBAL\Platforms\MariaDb1027Platform, + "Migration can only be executed safely on '\Doctrine\DBAL\Platforms\MariaDb1027Platform'." + ); + + $tableWorkspaceMetadata = $schema->createTable('neos_neos_workspace_metadata'); + $tableWorkspaceMetadata->addColumn('content_repository_id', 'string', ['length' => 16]); + $tableWorkspaceMetadata->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('title', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('description', 'text'); + $tableWorkspaceMetadata->addColumn('classification', 'string', ['length' => 255]); + $tableWorkspaceMetadata->setPrimaryKey(['content_repository_id', 'workspace_name']); + + $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); + $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); + $tableWorkspaceRole->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('subject', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('role', 'string', ['length' => 255]); + $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject']); + } + + public function down(Schema $schema): void + { + $this->abortIf( + !$this->connection->getDatabasePlatform() instanceof \Doctrine\DBAL\Platforms\MariaDb1027Platform, + "Migration can only be executed safely on '\Doctrine\DBAL\Platforms\MariaDb1027Platform'." + ); + + $schema->dropTable('neos_neos_workspace_role'); + $schema->dropTable('neos_neos_workspace_metadata'); + } +} diff --git a/Neos.Neos/Migrations/Postgresql/Version20240425223901.php b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php new file mode 100644 index 00000000000..dbfc24240ed --- /dev/null +++ b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php @@ -0,0 +1,44 @@ +abortIf($this->connection->getDatabasePlatform()?->getName() !== 'postgresql'); + + $tableWorkspaceMetadata = $schema->createTable('neos_neos_workspace_metadata'); + $tableWorkspaceMetadata->addColumn('content_repository_id', 'string', ['length' => 16]); + $tableWorkspaceMetadata->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('title', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('description', 'text'); + $tableWorkspaceMetadata->addColumn('classification', 'string', ['length' => 255]); + $tableWorkspaceMetadata->setPrimaryKey(['content_repository_id', 'workspace_name']); + + $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); + $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); + $tableWorkspaceRole->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('subject', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('role', 'string', ['length' => 255]); + $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject']); + } + + public function down(Schema $schema): void + { + $this->abortIf($this->connection->getDatabasePlatform()?->getName() !== 'postgresql'); + + $schema->dropTable('neos_neos_workspace_role'); + $schema->dropTable('neos_neos_workspace_metadata'); + } +} diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 515fc39f2b7..d4287abc1e3 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -30,12 +30,11 @@ use Neos\ContentRepository\Core\Projection\ContentGraph\Nodes; use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints; use Neos\ContentRepository\Core\Projection\Workspace\Workspace; +use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Node\NodeName; use Neos\ContentRepository\Core\SharedModel\User\UserId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Diff\Diff; use Neos\Diff\Renderer\Html\HtmlArrayRenderer; @@ -49,24 +48,30 @@ use Neos\Flow\Property\PropertyMapper; use Neos\Flow\Security\Account; use Neos\Flow\Security\Context; +use Neos\Flow\Utility\Algorithms; use Neos\Media\Domain\Model\AssetInterface; use Neos\Media\Domain\Model\ImageInterface; use Neos\Neos\Controller\Module\AbstractModuleController; use Neos\Neos\Controller\Module\ModuleTranslationTrait; use Neos\Neos\Domain\Model\SiteNodeName; use Neos\Neos\Domain\Model\User; +use Neos\Neos\Domain\Model\WorkspaceClassification; +use Neos\Neos\Domain\Model\WorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; use Neos\Neos\Domain\Service\UserService; +use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\Domain\Service\WorkspaceNameBuilder; -use Neos\Neos\Domain\Workspace\DiscardAllChanges; -use Neos\Neos\Domain\Workspace\PublishAllChanges; -use Neos\Neos\Domain\Workspace\WorkspaceProvider; +use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\FrontendRouting\NodeAddress; use Neos\Neos\FrontendRouting\NodeAddressFactory; use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult; use Neos\Neos\PendingChangesProjection\ChangeFinder; use Neos\Neos\Utility\NodeTypeWithFallbackProvider; +use Neos\Workspace\Ui\ViewModel\PendingChanges; +use Neos\Workspace\Ui\ViewModel\WorkspaceListItem; +use Neos\Workspace\Ui\ViewModel\WorkspaceListItems; /** * The Neos Workspace module controller @@ -90,153 +95,113 @@ class WorkspaceController extends AbstractModuleController protected Context $securityContext; #[Flow\Inject] - protected UserService $domainUserService; + protected UserService $userService; #[Flow\Inject] protected PackageManager $packageManager; #[Flow\Inject] - protected WorkspaceProvider $workspaceProvider; + protected WorkspacePublishingService $workspacePublishingService; + + #[Flow\Inject] + protected WorkspaceService $workspaceService; /** * Display a list of unpublished content */ public function indexAction(): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; - $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $currentUser = $this->userService->getCurrentUser(); + if ($currentUser === null) { + throw new \RuntimeException('No user authenticated', 1718308216); + } - /** @var ?Account $currentAccount */ - $currentAccount = $this->securityContext->getAccount(); - if ($currentAccount === null) { - throw new \RuntimeException('No account is authenticated', 1710068839); + $contentRepositoryIds = $this->contentRepositoryRegistry->getContentRepositoryIds(); + $numberOfContentRepositories = count($contentRepositoryIds); + if ($numberOfContentRepositories === 0) { + throw new \RuntimeException('No content repository configured', 1718296290); } - $userWorkspace = $contentRepository->getWorkspaceFinder()->findOneByName( - WorkspaceNameBuilder::fromAccountIdentifier($currentAccount->getAccountIdentifier()) - ); - if (is_null($userWorkspace)) { - throw new \RuntimeException('Current user has no workspace', 1645485990); + if ($this->request->hasArgument('contentRepositoryId')) { + $contentRepositoryId = ContentRepositoryId::fromString($this->request->getArgument('contentRepositoryId')); + } else { + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; } + $this->view->assign('contentRepositoryIds', $contentRepositoryIds); + $this->view->assign('contentRepositoryId', $contentRepositoryId->value); + $this->view->assign('displayContentRepositorySelector', $numberOfContentRepositories > 1); - $workspacesAndCounts = [ - $userWorkspace->workspaceName->value => [ - 'workspace' => $userWorkspace, - 'changesCounts' => $this->computeChangesCount($userWorkspace, $contentRepository), - 'canPublish' => false, - 'canManage' => false, - 'canDelete' => false, - 'workspaceOwnerHumanReadable' => $userWorkspace->workspaceOwner ? $this->domainUserService->findByUserIdentifier(UserId::fromString($userWorkspace->workspaceOwner))?->getLabel() : null - ] - ]; + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $items = []; foreach ($contentRepository->getWorkspaceFinder()->findAll() as $workspace) { - /** @var \Neos\ContentRepository\Core\Projection\Workspace\Workspace $workspace */ - // FIXME: This check should be implemented through a specialized Workspace Privilege or something similar - if (!$workspace->isPersonalWorkspace() && ($workspace->isInternalWorkspace() || $this->domainUserService->currentUserCanManageWorkspace($workspace))) { - $workspaceName = $workspace->workspaceName->value; - $workspacesAndCounts[$workspaceName]['workspace'] = $workspace; - $workspacesAndCounts[$workspaceName]['changesCounts'] = - $this->computeChangesCount($workspace, $contentRepository); - $workspacesAndCounts[$workspaceName]['canPublish'] - = $this->domainUserService->currentUserCanPublishToWorkspace($workspace); - $workspacesAndCounts[$workspaceName]['canManage'] - = $this->domainUserService->currentUserCanManageWorkspace($workspace); - $workspacesAndCounts[$workspaceName]['dependentWorkspacesCount'] = count( - $contentRepository->getWorkspaceFinder()->findByBaseWorkspace($workspace->workspaceName) - ); - $workspacesAndCounts[$workspaceName]['workspaceOwnerHumanReadable'] = $workspace->workspaceOwner ? $this->domainUserService->findByUserIdentifier(UserId::fromString($workspace->workspaceOwner))?->getLabel() : null; + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName); + $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepositoryId, $workspace->workspaceName, $currentUser); + if (!$permissions->read) { + continue; } + $items[] = new WorkspaceListItem( + name: $workspace->workspaceName->value, + classification: $workspaceMetadata->classification->name, + title: $workspaceMetadata->title->value, + description: $workspaceMetadata->description->value, + baseWorkspaceName: $workspace->baseWorkspaceName?->value, + pendingChanges: $this->computePendingChanges($workspace, $contentRepository), + hasDependantWorkspaces: count($contentRepository->getWorkspaceFinder()->findByBaseWorkspace($workspace->workspaceName)) > 0, + permissions: $permissions, + ); } - - $this->view->assign('userWorkspace', $userWorkspace); - $this->view->assign('workspacesAndChangeCounts', $workspacesAndCounts); + $this->view->assign('workspaces', WorkspaceListItems::fromArray($items)); } - public function showAction(WorkspaceName $workspace): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - $workspaceControllerInternals = $this->contentRepositoryRegistry->buildService( - $contentRepositoryId, - new WorkspaceControllerInternalsFactory() - ); $workspaceObj = $contentRepository->getWorkspaceFinder()->findOneByName($workspace); if (is_null($workspaceObj)) { /** @todo add flash message */ $this->redirect('index'); } + $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepositoryId, $workspaceObj->workspaceName); $this->view->assignMultiple([ 'selectedWorkspace' => $workspaceObj, 'selectedWorkspaceLabel' => $workspaceObj->workspaceTitle, 'baseWorkspaceName' => $workspaceObj->baseWorkspaceName, 'baseWorkspaceLabel' => $workspaceObj->baseWorkspaceName, // TODO fallback to title - // TODO $this->domainUserService->currentUserCanPublishToWorkspace($workspace->getBaseWorkspace()), - 'canPublishToBaseWorkspace' => true, + 'canPublishToBaseWorkspace' => $permissions->publish, 'siteChanges' => $this->computeSiteChanges($workspaceObj, $contentRepository), - 'contentDimensions' => $workspaceControllerInternals->getContentDimensionsOrderedByPriority() + 'contentDimensions' => $contentRepository->getContentDimensionSource()->getContentDimensionsOrderedByPriority() ]); } - public function newAction(): void + public function newAction(ContentRepositoryId $contentRepositoryId): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $this->view->assign('baseWorkspaceOptions', $this->prepareBaseWorkspaceOptions($contentRepository)); + $this->view->assign('contentRepositoryId', $contentRepositoryId->value); } - /** - * Create a workspace - * - * @Flow\Validate(argumentName="title", type="\Neos\Flow\Validation\Validator\NotEmptyValidator") - * @param WorkspaceTitle $title Human friendly title of the workspace, for example "Christmas Campaign" - * @param WorkspaceName $baseWorkspace Workspace the new workspace should be based on - * @param string $visibility Visibility of the new workspace, must be either "internal" or "shared" - * @param WorkspaceDescription $description A description explaining the purpose of the new workspace - * @return void - * @throws \Neos\Flow\Mvc\Exception\StopActionException - */ public function createAction( + ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceName $baseWorkspace, - string $visibility, WorkspaceDescription $description, ): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; - $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - - $workspaceName = WorkspaceName::fromString( - WorkspaceName::transliterateFromString($title->value)->value . '-' - . substr(base_convert(microtime(false), 10, 36), -5, 5) - ); - while ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) instanceof Workspace) { - $workspaceName = WorkspaceName::fromString( - WorkspaceName::transliterateFromString($title->value)->value . '-' - . substr(base_convert(microtime(false), 10, 36), -5, 5) - ); - } - - $currentUserIdentifier = $this->domainUserService->getCurrentUserIdentifier(); - if (is_null($currentUserIdentifier)) { - throw new \InvalidArgumentException('Cannot create workspace without a current user', 1652155039); + $currentUser = $this->userService->getCurrentUser(); + if ($currentUser === null) { + throw new \RuntimeException('No user authenticated', 1718303756); } try { - $contentRepository->handle( - CreateWorkspace::create( - $workspaceName, - $baseWorkspace, - $title, - $description, - ContentStreamId::create(), - $visibility === 'private' ? $currentUserIdentifier : null - ) + $this->workspaceService->createWorkspace( + $contentRepositoryId, + $title, + $description, + $baseWorkspace, + $currentUser->getId(), + WorkspaceClassification::SHARED, ); } catch (WorkspaceAlreadyExists $exception) { $this->addFlashMessage( @@ -246,7 +211,7 @@ public function createAction( ); $this->redirect('new'); } - + $this->addFlashMessage($this->getModuleLabel('workspaces.workspaceHasBeenCreated', [$title->value])); $this->redirect('index'); } @@ -265,12 +230,12 @@ public function editAction(WorkspaceName $workspaceName): void $this->redirect('index'); } $this->view->assign('workspace', $workspace); - $this->view->assign('baseWorkspaceOptions', $this->prepareBaseWorkspaceOptions($contentRepository, $workspace)); + $this->view->assign('baseWorkspaceOptions', $this->prepareBaseWorkspaceOptions($contentRepository, $workspaceName)); // TODO: $this->view->assign('disableBaseWorkspaceSelector', // $this->publishingService->getUnpublishedNodesCount($workspace) > 0); $this->view->assign( 'showOwnerSelector', - $this->domainUserService->currentUserCanTransferOwnershipOfWorkspace($workspace) + true// TODO fix $this->userService->currentUserCanTransferOwnershipOfWorkspace($workspace) ); $this->view->assign('ownerOptions', $this->prepareOwnerOptions()); } @@ -291,8 +256,7 @@ public function updateAction( WorkspaceDescription $description, ?string $workspaceOwner ): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); if ($title->value === '') { @@ -350,8 +314,7 @@ public function updateAction( */ public function deleteAction(WorkspaceName $workspaceName): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceName); @@ -646,26 +609,16 @@ public function publishOrDiscardNodesAction(array $nodes, string $action, string */ public function publishWorkspaceAction(WorkspaceName $workspace): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; - /** @todo send from UI */ - $command = new PublishAllChanges( + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; + $publishingResult = $this->workspacePublishingService->publishWorkspace( $contentRepositoryId, - $workspace + $workspace, ); - - $workspace = $this->workspaceProvider->provideForWorkspaceName( - $command->contentRepositoryId, - $command->workspaceName - ); - $workspace->publishAllChanges(); - /** @var WorkspaceName $baseWorkspaceName Otherwise the command handler would have thrown an exception */ - $baseWorkspaceName = $workspace->getCurrentBaseWorkspaceName(); $this->addFlashMessage($this->translator->translateById( 'workspaces.allChangesInWorkspaceHaveBeenPublished', [ - htmlspecialchars($workspace->name->value), - htmlspecialchars($baseWorkspaceName->value) + htmlspecialchars($workspace->value), + htmlspecialchars($publishingResult->targetWorkspaceName->value) ], null, null, @@ -682,22 +635,14 @@ public function publishWorkspaceAction(WorkspaceName $workspace): void */ public function discardWorkspaceAction(WorkspaceName $workspace): void { - $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest()) - ->contentRepositoryId; - /** @todo send from UI */ - $command = new DiscardAllChanges( + $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; + $this->workspacePublishingService->discardAllWorkspaceChanges( $contentRepositoryId, - $workspace + $workspace, ); - $workspace = $this->workspaceProvider->provideForWorkspaceName( - $command->contentRepositoryId, - $command->workspaceName - ); - $workspace->discardAllChanges(); - $this->addFlashMessage($this->translator->translateById( 'workspaces.allChangesInWorkspaceHaveBeenDiscarded', - [htmlspecialchars($workspace->name->value)], + [htmlspecialchars($workspace->value)], null, null, 'Main', @@ -712,9 +657,9 @@ public function discardWorkspaceAction(WorkspaceName $workspace): void * @return array * @throws \JsonException */ - protected function computeChangesCount(Workspace $selectedWorkspace, ContentRepository $contentRepository): array + protected function computePendingChanges(Workspace $selectedWorkspace, ContentRepository $contentRepository): PendingChanges { - $changesCount = ['new' => 0, 'changed' => 0, 'removed' => 0, 'total' => 0]; + $changesCount = ['new' => 0, 'changed' => 0, 'removed' => 0]; foreach ($this->computeSiteChanges($selectedWorkspace, $contentRepository) as $siteChanges) { foreach ($siteChanges['documents'] as $documentChanges) { foreach ($documentChanges['changes'] as $change) { @@ -725,12 +670,10 @@ protected function computeChangesCount(Workspace $selectedWorkspace, ContentRepo } else { $changesCount['changed']++; } - $changesCount['total']++; } } } - - return $changesCount; + return new PendingChanges(new: $changesCount['new'], changed: $changesCount['changed'], removed: $changesCount['removed']); } /** @@ -1060,31 +1003,36 @@ protected function postProcessDiffArray(array &$diffArray): void /** * Creates an array of workspace names and their respective titles which are possible base workspaces for other * workspaces. - * If $excludedWorkspace is set, this workspace and all its child workspaces will be excluded from the list of returned workspaces + * If $excludedWorkspace is set, this workspace and all its base workspaces will be excluded from the list of returned workspaces * * @param ContentRepository $contentRepository - * @param Workspace|null $excludedWorkspace + * @param WorkspaceName|null $excludedWorkspace * @return array */ protected function prepareBaseWorkspaceOptions( ContentRepository $contentRepository, - Workspace $excludedWorkspace = null, + WorkspaceName $excludedWorkspace = null, ): array { $baseWorkspaceOptions = []; $workspaces = $contentRepository->getWorkspaceFinder()->findAll(); foreach ($workspaces as $workspace) { - - /** @var Workspace $workspace */ - if ( - !$workspace->isPersonalWorkspace() - && $workspace !== $excludedWorkspace - && ($workspace->isPublicWorkspace() - || $workspace->isInternalWorkspace() - || $this->domainUserService->currentUserCanManageWorkspace($workspace)) - && (!$excludedWorkspace || $workspaces->getBaseWorkspaces($workspace->workspaceName)->get($excludedWorkspace->workspaceName) === null) - ) { - $baseWorkspaceOptions[$workspace->workspaceName->value] = $workspace->workspaceTitle->value; + if ($excludedWorkspace !== null) { + if ($workspace->workspaceName->equals($excludedWorkspace)) { + continue; + } + if ($workspaces->getBaseWorkspaces($workspace->workspaceName)->get($excludedWorkspace) !== null) { + continue; + } + } + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepository->id, $workspace->workspaceName); + if (!in_array($workspaceMetadata->classification, [WorkspaceClassification::SHARED, WorkspaceClassification::ROOT], true)) { + continue; + } + $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepository->id, $workspace->workspaceName); + if (!$permissions->manage) { + continue; } + $baseWorkspaceOptions[$workspace->workspaceName->value] = $workspace->workspaceTitle->value; } return $baseWorkspaceOptions; @@ -1098,7 +1046,7 @@ protected function prepareBaseWorkspaceOptions( protected function prepareOwnerOptions(): array { $ownerOptions = ['' => '-']; - foreach ($this->domainUserService->getUsers() as $user) { + foreach ($this->userService->getUsers() as $user) { /** @var User $user */ $ownerOptions[$this->persistenceManager->getIdentifierByObject($user)] = $user->getLabel(); } diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternals.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternals.php deleted file mode 100644 index 0a28cfe7413..00000000000 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternals.php +++ /dev/null @@ -1,38 +0,0 @@ - - */ - public function getContentDimensionsOrderedByPriority(): array - { - return $this->contentDimensionSource->getContentDimensionsOrderedByPriority(); - } -} diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternalsFactory.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternalsFactory.php deleted file mode 100644 index 0ad2b7f3d38..00000000000 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceControllerInternalsFactory.php +++ /dev/null @@ -1,32 +0,0 @@ - - */ -class WorkspaceControllerInternalsFactory implements ContentRepositoryServiceFactoryInterface -{ - public function build( - ContentRepositoryServiceFactoryDependencies $serviceFactoryDependencies - ): WorkspaceControllerInternals { - return new WorkspaceControllerInternals( - $serviceFactoryDependencies->contentDimensionSource, - ); - } -} diff --git a/Neos.Workspace.Ui/Classes/ViewModel/PendingChanges.php b/Neos.Workspace.Ui/Classes/ViewModel/PendingChanges.php new file mode 100644 index 00000000000..ad999538841 --- /dev/null +++ b/Neos.Workspace.Ui/Classes/ViewModel/PendingChanges.php @@ -0,0 +1,46 @@ +total = $this->new + $this->changed + $this->removed; + } + + public function getNewCountRatio(): float + { + return $this->new / $this->total * 100; + } + + public function getChangedCountRatio(): float + { + return $this->changed / $this->total * 100; + } + + public function getRemovedCountRatio(): float + { + return $this->removed / $this->total * 100; + } +} diff --git a/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItem.php b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItem.php new file mode 100644 index 00000000000..b7c54aa3d6e --- /dev/null +++ b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItem.php @@ -0,0 +1,34 @@ + + */ +#[Flow\Proxy(false)] +final readonly class WorkspaceListItems implements \IteratorAggregate, \Countable +{ + private function __construct( + private array $items, + ) { + } + + /** + * @param array $items + */ + public static function fromArray(array $items): self + { + foreach ($items as $item) { + if (!$item instanceof WorkspaceListItem) { + throw new \InvalidArgumentException(sprintf('Expected instance of %s, got: %s', WorkspaceListItem::class, get_debug_type($item)), 1718295710); + } + } + return new self($items); + } + + public function getIterator(): \Traversable + { + return yield from $this->items; + } + + public function count(): int + { + return count($this->items); + } +} diff --git a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html index d65d207cbd7..f125042ecfa 100644 --- a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html +++ b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html @@ -3,6 +3,17 @@
+ + +
+ +
+ +
+
+ + + @@ -14,146 +25,137 @@ - - - - + + + + + - - + - - - - - +
+ + + + + + + + + + +
 
- - - - - - + +
+ + + + + + + + + + + + + + + + + + {workspace.title -> f:format.crop(maxCharacters: 25, append: '…')} + + + {workspace.baseWorkspaceName -> f:format.crop(maxCharacters: 25, append: '…')} + + + - + + + + + + TODO + + + TODO + + + + + +
+ - - - - - - - - + - + - +
+ + + + + {neos:backend.translate(id: 'workspaces.review', source: 'Main', package: 'Neos.Workspace.Ui')} + - 		{workspace.workspaceTitle.value -> f:format.crop(maxCharacters: 25, append: '…')} - - - {workspace.baseWorkspaceName.value -> f:format.crop(maxCharacters: 25, append: '…')} - - - - - + + +
+ + + + -
- + + - {workspaceAndCounts.workspaceOwnerHumanReadable} + - {workspaceAndCounts.workspaceOwnerHumanReadable} - - - - - -
- - - - - - - - - - -
- - - - - {neos:backend.translate(id: 'workspaces.review', source: 'Main', package: 'Neos.Workspace.Ui')} - - - - 		-
- - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- -
{neos:backend.translate(id: 'workspaces.dialog.confirmWorkspaceDeletion', source: 'Main', package: 'Neos.Workspace.Ui', arguments: {0: workspace.workspaceTitle.value})}
-
-
-

{neos:backend.translate(id: 'workspaces.dialog.thisWillDeleteTheWorkspace', source: 'Main', package: 'Neos.Workspace.Ui')}

-
+ + + + + + + + + + + + +
+
+
+
+ +
{neos:backend.translate(id: 'workspaces.dialog.confirmWorkspaceDeletion', source: 'Main', package: 'Neos.Workspace.Ui', arguments: {0: workspace.workspaceTitle.value})}
+
+
+

{neos:backend.translate(id: 'workspaces.dialog.thisWillDeleteTheWorkspace', source: 'Main', package: 'Neos.Workspace.Ui')}

-
- {neos:backend.translate(id: 'cancel', source: 'Main', package: 'Neos.Workspace.Ui')} - - - -
+
+
+ {neos:backend.translate(id: 'cancel', source: 'Main', package: 'Neos.Workspace.Ui')} + + +
-
- - - - - - - -
-
- {neos:backend.translate(id: 'workspaces.createNewWorkspace', source: 'Main', package: 'Neos.Workspace.Ui')} + {neos:backend.translate(id: 'workspaces.createNewWorkspace', source: 'Main', package: 'Neos.Workspace.Ui')}
diff --git a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/New.html b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/New.html index 6c4e619e1b4..65ad3753f05 100644 --- a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/New.html +++ b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/New.html @@ -6,12 +6,12 @@

{neos:backend.translate(id: 'workspaces.createNewWorkspace', source: 'Main', - +
- +
@@ -27,36 +27,13 @@

{neos:backend.translate(id: 'workspaces.createNewWorkspace', source: 'Main',
- +
- - - -
- -
- -
-
- -
-
- - - - -

- {neos:backend.translate(id: 'cancel', package: 'Neos.Workspace.Ui')} + {neos:backend.translate(id: 'cancel', package: 'Neos.Workspace.Ui')}
diff --git a/Neos.Workspace.Ui/Resources/Private/Translations/en/Main.xlf b/Neos.Workspace.Ui/Resources/Private/Translations/en/Main.xlf index 8786d9093b1..da39fa6b61e 100644 --- a/Neos.Workspace.Ui/Resources/Private/Translations/en/Main.xlf +++ b/Neos.Workspace.Ui/Resources/Private/Translations/en/Main.xlf @@ -159,6 +159,9 @@ A workspace with this title already exists. + + The workspace "{0}" has been created. + The workspace "{0}" has been updated. From 8975a5fbd2c5915842bff0647d9c228aecb54937 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Mon, 8 Jul 2024 10:17:43 +0200 Subject: [PATCH 02/43] wip --- .../ContentRepositoryIds.php | 60 +++++++ .../SharedModel/Workspace/WorkspaceName.php | 23 ++- .../Workspace/WorkspaceNameTest.php | 154 ++++++++++++++++++ .../Classes/ContentRepositoryRegistry.php | 8 +- .../Command/WorkspaceCommandController.php | 12 +- .../Classes/Domain/Model/UserInterface.php | 1 - .../Domain/Model/WorkspaceMetadata.php | 15 ++ .../Domain/Model/WorkspacePermissions.php | 6 +- .../Classes/Domain/Model/WorkspaceRole.php | 23 +++ .../Domain/Model/WorkspaceSubjectType.php | 14 ++ .../Classes/Domain/Service/UserService.php | 1 + .../Domain/Service/WorkspaceService.php | 147 +++++++---------- .../Mysql/Version20240425223900.php | 5 +- .../Postgresql/Version20240425223901.php | 5 +- .../Controller/WorkspaceController.php | 67 ++++---- .../Classes/ViewModel/WorkspaceListItems.php | 3 + 16 files changed, 391 insertions(+), 153 deletions(-) create mode 100644 Neos.ContentRepository.Core/Classes/SharedModel/ContentRepository/ContentRepositoryIds.php create mode 100644 Neos.ContentRepository.Core/Tests/Unit/SharedModel/Workspace/WorkspaceNameTest.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRole.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/ContentRepository/ContentRepositoryIds.php b/Neos.ContentRepository.Core/Classes/SharedModel/ContentRepository/ContentRepositoryIds.php new file mode 100644 index 00000000000..031638864b7 --- /dev/null +++ b/Neos.ContentRepository.Core/Classes/SharedModel/ContentRepository/ContentRepositoryIds.php @@ -0,0 +1,60 @@ + + * @api + */ +final readonly class ContentRepositoryIds implements \IteratorAggregate, \Countable +{ + /** + * @var array + */ + private array $ids; + + private function __construct(ContentRepositoryId ...$ids) + { + $this->ids = $ids; + } + + /** + * @param array $ids + */ + public static function fromArray(array $ids): self + { + $processedIds = []; + foreach ($ids as $id) { + if (is_string($id)) { + $id = ContentRepositoryId::fromString($id); + } + if (!$id instanceof ContentRepositoryId) { + throw new \InvalidArgumentException(sprintf('Expected string or instance of %s, got: %s', ContentRepositoryId::class, get_debug_type($id)), 1720424666); + } + $processedIds[] = $id; + } + return new self(...$processedIds); + } + + public function getIterator(): \Traversable + { + return yield from $this->ids; + } + + public function count(): int + { + return count($this->ids); + } +} diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php index 5725d3fdb89..512c52aa368 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceName.php @@ -23,7 +23,9 @@ */ final class WorkspaceName implements \JsonSerializable { - private const PATTERN = '/^[a-z0-9\-]{1,30}$/'; + public const MAX_LENGTH = 30; + + private const PATTERN = '/^[a-z][a-z0-9\-]{0,' . (self::MAX_LENGTH - 1) . '}$/'; public const WORKSPACE_NAME_LIVE = 'live'; @@ -36,7 +38,7 @@ private function __construct( public readonly string $value ) { if (!self::hasValidFormat($value)) { - throw new \InvalidArgumentException('Invalid workspace name given.', 1505826610318); + throw new \InvalidArgumentException('Invalid workspace name given.', 1505826610); } } @@ -77,15 +79,18 @@ public static function transliterateFromString(string $name): self // Transliterate (transform 北京 to 'Bei Jing') $name = Transliterator::transliterate($name); - // Urlization (replace spaces with dash, special characters) - $name = Transliterator::urlize($name); - // Ensure only allowed characters are left - $name = preg_replace('/[^a-z0-9\-]/', '', $name); + $name = (string)preg_replace('/[^a-z0-9\-]/', '', $name); + + // Ensure max length... + if (strlen($name) > self::MAX_LENGTH) { + $name = substr($name, 0, self::MAX_LENGTH); + } - // Make sure we don't have an empty string left. - if (empty($name)) { - $name = 'workspace-' . strtolower(md5($originalName)); + // If the name is still invalid at this point, we fall back to md5 + if (!self::hasValidFormat($name)) { + $prefix = 'workspace-'; + $name = $prefix . substr(md5($originalName), 0, self::MAX_LENGTH - strlen($prefix)); } return self::fromString($name); diff --git a/Neos.ContentRepository.Core/Tests/Unit/SharedModel/Workspace/WorkspaceNameTest.php b/Neos.ContentRepository.Core/Tests/Unit/SharedModel/Workspace/WorkspaceNameTest.php new file mode 100644 index 00000000000..6d01e897715 --- /dev/null +++ b/Neos.ContentRepository.Core/Tests/Unit/SharedModel/Workspace/WorkspaceNameTest.php @@ -0,0 +1,154 @@ +value, $value); + } + + /** + * @test + * @dataProvider validWorkspaceNames + */ + public function tryFromStringReturnsInstanceForValidValues(string $value): void + { + self::assertSame(WorkspaceName::tryFromString($value)->value, $value); + } + + private static function invalidWorkspaceNames(): iterable + { + yield 'empty string' => ['']; + yield 'only digits' => ['123']; + yield 'leading dash' => ['-invalid']; + yield 'upper case characters' => ['thisIsNotAllowed']; + yield 'whitespace' => ['this neither']; + yield 'exceeding max length' => ['this-is-just-a-little-too-long-']; + } + + /** + * @test + * @dataProvider invalidWorkspaceNames + */ + public function fromStringFailsForInvalidValues(string $value): void + { + $this->expectException(\InvalidArgumentException::class); + WorkspaceName::fromString($value); + } + + /** + * @test + * @dataProvider invalidWorkspaceNames + */ + public function tryFromStringReturnsNullForInvalidValues(string $value): void + { + self::assertNull(WorkspaceName::tryFromString($value)); + } + + /** + * @test + */ + public function forLiveReturnsAConstantInstance(): void + { + self::assertSame(WorkspaceName::fromString(WorkspaceName::WORKSPACE_NAME_LIVE), WorkspaceName::forLive()); + } + + private static function transliterateFromStringDataProvider(): iterable + { + yield 'valid name is not changed' => ['value' => 'already-valid', 'expectedResult' => 'already-valid']; + yield 'name is lower-cased' => ['value' => 'mixedCase', 'expectedResult' => 'mixedcase']; + yield 'chinese characters' => ['value' => '北京', 'expectedResult' => 'bei-jing']; + yield 'german umlauts' => ['value' => 'ümläute', 'expectedResult' => 'umlaute']; + yield 'white space' => ['value' => ' Contains spaces ', 'expectedResult' => 'contains-spaces']; + yield 'exceeding max length' => ['value' => 'This name is just a little too long', 'expectedResult' => 'this-name-is-just-a-little-too']; + yield 'only special characters' => ['value' => '-', 'expectedResult' => 'workspace-336d5ebc5436534e61d1']; + } + + /** + * @test + * @dataProvider transliterateFromStringDataProvider + */ + public function transliterateFromStringTests(string $value, string $expectedResult): void + { + self::assertSame($expectedResult, WorkspaceName::transliterateFromString($value)->value); + } + + /** + * @test + */ + public function isLiveReturnsFalseByDefault(): void + { + self::assertFalse(WorkspaceName::fromString('not-live')->isLive()); + } + + /** + * @test + */ + public function isLiveReturnsTrueForLiveWorkspace(): void + { + self::assertTrue(WorkspaceName::forLive()->isLive()); + } + + /** + * @test + */ + public function jsonSerializeReturnsPlainValue(): void + { + self::assertJsonStringEqualsJsonString(json_encode(WorkspaceName::forLive()), '"live"'); + } + + /** + * @test + */ + public function equalsReturnsFalseIfTwoInstancesDontMatch(): void + { + self::assertFalse(WorkspaceName::fromString('some-workspace')->equals(WorkspaceName::fromString('some-other-workspace'))); + } + + /** + * @test + */ + public function equalsReturnsTrueIfTwoInstancesMatch(): void + { + self::assertTrue(WorkspaceName::fromString('some-workspace')->equals(WorkspaceName::fromString('some-workspace'))); + } +} diff --git a/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php b/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php index 4912e4e29e5..517ea017ff9 100644 --- a/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php +++ b/Neos.ContentRepositoryRegistry/Classes/ContentRepositoryRegistry.php @@ -17,6 +17,7 @@ use Neos\ContentRepository\Core\Projection\ProjectionCatchUpTriggerInterface; use Neos\ContentRepository\Core\Projection\ProjectionFactoryInterface; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; +use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryIds; use Neos\ContentRepository\Core\SharedModel\User\UserIdProviderInterface; use Neos\ContentRepositoryRegistry\Exception\ContentRepositoryNotFoundException; use Neos\ContentRepositoryRegistry\Exception\InvalidConfigurationException; @@ -81,12 +82,9 @@ public function get(ContentRepositoryId $contentRepositoryId): ContentRepository return $this->getFactory($contentRepositoryId)->getOrBuild(); } - /** - * @return array - */ - public function getContentRepositoryIds(): array + public function getContentRepositoryIds(): ContentRepositoryIds { - return array_map(ContentRepositoryId::fromString(...), array_keys($this->settings['contentRepositories'])); + return ContentRepositoryIds::fromArray(array_keys($this->settings['contentRepositories'] ?? [])); } /** diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 4c030b1b790..ba7abc670f5 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -22,11 +22,9 @@ use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Dto\RebaseErrorHandlingStrategy; use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Exception\WorkspaceRebaseFailed; use Neos\ContentRepository\Core\Projection\Workspace\Workspace; -use Neos\ContentRepository\Core\Projection\Workspace\WorkspaceStatus; use Neos\ContentRepository\Core\Service\WorkspaceMaintenanceServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Exception\WorkspaceDoesNotExist; -use Neos\ContentRepository\Core\SharedModel\User\UserId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; @@ -36,11 +34,11 @@ use Neos\Flow\Cli\CommandController; use Neos\Flow\Cli\Exception\StopCommandException; use Neos\Flow\Persistence\PersistenceManagerInterface; +use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Service\UserService; -use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\Domain\Service\WorkspacePublishingService; -use Neos\Neos\PendingChangesProjection\ChangeFinder; +use Neos\Neos\Domain\Service\WorkspaceService; /** * The Workspace Command Controller @@ -182,7 +180,7 @@ public function createCommand( $this->workspaceService->createWorkspace( $contentRepositoryId, - \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title), + \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title ?? $workspace), \Neos\Neos\Domain\Model\WorkspaceDescription::fromString($description ?? ''), WorkspaceName::fromString($baseWorkspace), \Neos\Neos\Domain\Model\UserId::fromString($owner), @@ -209,7 +207,7 @@ public function createCommand( WorkspaceTitle::fromString($title ?: $workspace), WorkspaceDescription::fromString($description ?: $workspace), ContentStreamId::create(), - $workspaceOwnerUserId + $workspaceOwnerUserId !== null ? \Neos\ContentRepository\Core\SharedModel\User\UserId::fromString($workspaceOwnerUserId->value) : null, )); } catch (WorkspaceAlreadyExists $workspaceAlreadyExists) { $this->outputLine('Workspace "%s" already exists', [$workspace]); @@ -219,7 +217,7 @@ public function createCommand( $this->quit(2); } - if ($workspaceOwnerUserId instanceof UserId) { + if ($workspaceOwnerUserId !== null) { $this->outputLine( 'Created a new workspace "%s", based on workspace "%s", owned by "%s".', [$workspace, $baseWorkspace, $owner] diff --git a/Neos.Neos/Classes/Domain/Model/UserInterface.php b/Neos.Neos/Classes/Domain/Model/UserInterface.php index b6cc5b33692..7998656c49f 100644 --- a/Neos.Neos/Classes/Domain/Model/UserInterface.php +++ b/Neos.Neos/Classes/Domain/Model/UserInterface.php @@ -21,7 +21,6 @@ */ interface UserInterface { - /** * Returns the globally unique identifier for this user */ diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index de693c701e0..d445b80a9f2 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -20,4 +20,19 @@ public function __construct( public WorkspaceClassification $classification, ) { } + + /** + * Note: To be used with named arguments! + */ + public function with( + WorkspaceTitle $title = null, + WorkspaceDescription $description = null, + ): self { + return new self( + $this->workspaceName, + $title ?? $this->title, + $description ?? $this->description, + $this->classification + ); + } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php index 39de79eb0a1..96ea78c4c4e 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php @@ -14,16 +14,16 @@ { private function __construct( public bool $read, - public bool $publish, + public bool $write, public bool $manage, ) { } public static function create( bool $read, - bool $publish, + bool $write, bool $manage, ): self { - return new self($read, $publish, $manage); + return new self($read, $write, $manage); } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php new file mode 100644 index 00000000000..5f256133db4 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -0,0 +1,23 @@ +value >= $role->value; + } +} diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php b/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php new file mode 100644 index 00000000000..ba05191d4d9 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php @@ -0,0 +1,14 @@ +securityContext->getAuthenticationTokens() as $token) { + /** @var Account|null $account */ $account = $token->getAccount(); if ($account === null) { continue; diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 3ff1200ec9d..742a44b818e 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -15,6 +15,8 @@ namespace Neos\Neos\Domain\Service; use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Exception; +use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; @@ -24,16 +26,15 @@ use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; -use Neos\Flow\Security\Account; -use Neos\Flow\Security\Authorization\PrivilegeManagerInterface; use Neos\Flow\Utility\Algorithms; use Neos\Neos\Domain\Model\User; use Neos\Neos\Domain\Model\UserId; -use Neos\Neos\Domain\Model\UserInterface; use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceDescription; use Neos\Neos\Domain\Model\WorkspaceMetadata; use Neos\Neos\Domain\Model\WorkspacePermissions; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; /** @@ -47,7 +48,6 @@ final class WorkspaceService public function __construct( private readonly ContentRepositoryRegistry $contentRepositoryRegistry, - private readonly PrivilegeManagerInterface $privilegeManager, private readonly UserService $userService, private readonly Connection $dbal, ) { @@ -87,6 +87,27 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W ); } + public function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle, WorkspaceDescription $newWorkspaceDescription): void + { + $this->requireWorkspace($contentRepositoryId, $workspaceName); + try { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'title' => $newWorkspaceTitle->value, + 'description' => $newWorkspaceDescription->value, + ]); + } catch (UniqueConstraintViolationException $e) { + $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'title' => $newWorkspaceTitle->value, + 'description' => $newWorkspaceDescription->value, + ], [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + ]); + } + } + public function getPersonalWorkspaceForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): Workspace { $workspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $userId); @@ -100,8 +121,7 @@ public function createRootWorkspace( ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, - ): WorkspaceName - { + ): WorkspaceName { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); $contentRepository->handle( @@ -115,12 +135,13 @@ public function createRootWorkspace( // TODO catch exceptions - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject' => 'group:EVERYBODY', - 'role' => 'OWNER', - ]); +// $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ +// 'content_repository_id' => $contentRepositoryId->value, +// 'workspace_name' => $workspaceName->value, +// 'subject_type' => WorkspaceSubjectType::GROUP->name, +// 'subject' => 'Neos.Flow:Everybody', +// 'role' => WorkspaceRole::COLLABORATOR, +// ]); // TODO catch exceptions @@ -161,8 +182,9 @@ public function createWorkspace( $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject' => 'user:' . $ownerId->value, - 'role' => 'OWNER', + 'subject_type' => WorkspaceSubjectType::USER->name, + 'subject' => $ownerId->value, + 'role' => WorkspaceRole::OWNER->name, ]); } @@ -198,82 +220,16 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions { - $workspaceMetadata = $this->getWorkspaceMetadata($contentRepositoryId, $workspaceName); - $userRoles = $this->userService->getAllRoles($user); $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); - $userWorkspaceRoles = $this->getUserWorkspaceRoles($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); - - return match ($workspaceMetadata->classification) { - WorkspaceClassification::UNKNOWN => WorkspacePermissions::create( - read: $userIsAdmin, - publish: false, - manage: $userIsAdmin, - ), - WorkspaceClassification::ROOT => WorkspacePermissions::create( - read: true, - publish: $this->privilegeManager->isPrivilegeTargetGrantedForRoles($userRoles, 'Neos.Workspace.Ui:Backend.PublishAllToLiveWorkspace'), - manage: $userIsAdmin, - ), - WorkspaceClassification::PERSONAL => WorkspacePermissions::create( - read: $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId())?->equals($workspaceName) ?: false, - publish: in_array('MANAGER', $userWorkspaceRoles, true), - manage: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), - ), - WorkspaceClassification::SHARED => WorkspacePermissions::create( - read: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), - publish: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), - manage: $userIsAdmin || in_array('MANAGER', $userWorkspaceRoles, true), - ), - }; + $userWorkspaceRole = $this->getWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); -// $this->privilegeManager->isPrivilegeTargetGrantedForRoles($user->getAllRoles) -// -// // can manage -// -// if ($workspace->isInternalWorkspace()) { -// return $this->privilegeManager->isPrivilegeTargetGranted( -// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageInternalWorkspaces' -// ); -// } -// -// -// $currentUser = $this->getCurrentUser(); -// if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner === $this->persistenceManager->getIdentifierByObject($currentUser)) { -// return $this->privilegeManager->isPrivilegeTargetGranted( -// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageOwnWorkspaces' -// ); -// } -// -// if ($workspace->isPrivateWorkspace() && $currentUser !== null && $workspace->workspaceOwner !== $this->persistenceManager->getIdentifierByObject($currentUser)) { -// return $this->privilegeManager->isPrivilegeTargetGranted( -// 'Neos.Neos:Backend.Module.Management.Workspaces.ManageAllPrivateWorkspaces' -// ); -// } -// -// -// // can publish -// -// if ($workspace->isPublicWorkspace()) { -// return $this->securityContext->hasRole('Neos.Neos:LivePublisher'); -// } -// -// $currentUser = $this->getCurrentUser(); -// $ownerIdentifier = $currentUser -// ? $this->persistenceManager->getIdentifierByObject($currentUser) -// : null; -// -// if ($workspace->workspaceOwner === null || $workspace->workspaceOwner === $ownerIdentifier) { -// return true; -// } -// -// -// return WorkspacePermissions::create( -// read: false, -// publish: false, -// manage: false, -// ); + return WorkspacePermissions::create( + read: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + write: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + manage: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), + ); } private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): ?WorkspaceName @@ -297,7 +253,10 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } - private function getUserWorkspaceRoles(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): array + /** + * @param array $userRoles + */ + private function getWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): WorkspaceRole { $table = self::TABLE_NAME_WORKSPACE_ROLE; $query = <<dbal->fetchFirstColumn($query, [ + $role = $this->dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, 'workspaceName' => $workspaceName->value, 'subjects' => ['user:' . $userId->value, ...array_map(fn (string $role) => 'group:' . $role, $userRoles)], ], [ 'subjects' => Connection::PARAM_STR_ARRAY, ]); + if ($role === false) { + return WorkspaceRole::NONE; + } + return WorkspaceRole::from($role); } private static function getUniqueWorkspaceName(ContentRepository $contentRepository, string $candidate): WorkspaceName @@ -343,5 +313,4 @@ private function requireWorkspace(ContentRepositoryId $contentRepositoryId, Work } return $workspace; } - } diff --git a/Neos.Neos/Migrations/Mysql/Version20240425223900.php b/Neos.Neos/Migrations/Mysql/Version20240425223900.php index 3083611b5c6..3438212364a 100644 --- a/Neos.Neos/Migrations/Mysql/Version20240425223900.php +++ b/Neos.Neos/Migrations/Mysql/Version20240425223900.php @@ -32,9 +32,10 @@ public function up(Schema $schema): void $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); $tableWorkspaceRole->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('subject_type', 'string', ['length' => 20]); $tableWorkspaceRole->addColumn('subject', 'string', ['length' => 255]); - $tableWorkspaceRole->addColumn('role', 'string', ['length' => 255]); - $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject']); + $tableWorkspaceRole->addColumn('role', 'string', ['length' => 20]); + $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject_type', 'subject']); } public function down(Schema $schema): void diff --git a/Neos.Neos/Migrations/Postgresql/Version20240425223901.php b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php index dbfc24240ed..5218bf5bcd9 100644 --- a/Neos.Neos/Migrations/Postgresql/Version20240425223901.php +++ b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php @@ -29,9 +29,10 @@ public function up(Schema $schema): void $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); $tableWorkspaceRole->addColumn('workspace_name', 'string', ['length' => 255]); + $tableWorkspaceRole->addColumn('subject_type', 'string', ['length' => 20]); $tableWorkspaceRole->addColumn('subject', 'string', ['length' => 255]); - $tableWorkspaceRole->addColumn('role', 'string', ['length' => 255]); - $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject']); + $tableWorkspaceRole->addColumn('role', 'string', ['length' => 20]); + $tableWorkspaceRole->setPrimaryKey(['content_repository_id', 'workspace_name', 'subject_type', 'subject']); } public function down(Schema $schema): void diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index ea5b6d5e1fc..289521560bf 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -16,7 +16,6 @@ use Doctrine\DBAL\DBALException; use Neos\ContentRepository\Core\ContentRepository; -use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\ChangeWorkspaceOwner; use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\DeleteWorkspace; @@ -33,7 +32,6 @@ use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Node\NodeAddress; use Neos\ContentRepository\Core\SharedModel\Node\NodeName; -use Neos\ContentRepository\Core\SharedModel\User\UserId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; @@ -49,7 +47,6 @@ use Neos\Flow\Property\PropertyMapper; use Neos\Flow\Security\Account; use Neos\Flow\Security\Context; -use Neos\Flow\Utility\Algorithms; use Neos\Media\Domain\Model\AssetInterface; use Neos\Media\Domain\Model\ImageInterface; use Neos\Neos\Controller\Module\AbstractModuleController; @@ -62,10 +59,9 @@ use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; use Neos\Neos\Domain\Service\UserService; -use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\Domain\Service\WorkspaceNameBuilder; use Neos\Neos\Domain\Service\WorkspacePublishingService; -use Neos\Neos\FrontendRouting\NodeAddress; +use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\Domain\Workspace\DiscardAllChanges; use Neos\Neos\Domain\Workspace\PublishAllChanges; use Neos\Neos\Domain\Workspace\WorkspaceProvider; @@ -126,12 +122,14 @@ public function indexAction(): void } $contentRepositoryIds = $this->contentRepositoryRegistry->getContentRepositoryIds(); - $numberOfContentRepositories = count($contentRepositoryIds); + $numberOfContentRepositories = $contentRepositoryIds->count(); if ($numberOfContentRepositories === 0) { throw new \RuntimeException('No content repository configured', 1718296290); } if ($this->request->hasArgument('contentRepositoryId')) { - $contentRepositoryId = ContentRepositoryId::fromString($this->request->getArgument('contentRepositoryId')); + $contentRepositoryIdArgument = $this->request->getArgument('contentRepositoryId'); + assert(is_string($contentRepositoryIdArgument)); + $contentRepositoryId = ContentRepositoryId::fromString($contentRepositoryIdArgument); } else { $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; } @@ -164,6 +162,10 @@ classification: $workspaceMetadata->classification->name, public function showAction(WorkspaceName $workspace): void { + $currentUser = $this->userService->getCurrentUser(); + if ($currentUser === null) { + throw new \RuntimeException('No user authenticated', 1720371024); + } $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); @@ -172,13 +174,21 @@ public function showAction(WorkspaceName $workspace): void /** @todo add flash message */ $this->redirect('index'); } - $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepositoryId, $workspaceObj->workspaceName); + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace); + $baseWorkspaceMetadata = null; + $baseWorkspacePermissions = null; + if ($workspaceObj->baseWorkspaceName !== null) { + $baseWorkspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceObj->baseWorkspaceName); + assert($baseWorkspace !== null); + $baseWorkspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $baseWorkspace->workspaceName); + $baseWorkspacePermissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepositoryId, $baseWorkspace->workspaceName, $currentUser); + } $this->view->assignMultiple([ 'selectedWorkspace' => $workspaceObj, - 'selectedWorkspaceLabel' => $workspaceObj->workspaceTitle, + 'selectedWorkspaceLabel' => $workspaceMetadata->title->value, 'baseWorkspaceName' => $workspaceObj->baseWorkspaceName, - 'baseWorkspaceLabel' => $workspaceObj->baseWorkspaceName, // TODO fallback to title - 'canPublishToBaseWorkspace' => $permissions->publish, + 'baseWorkspaceLabel' => $baseWorkspaceMetadata?->title->value, + 'canPublishToBaseWorkspace' => $baseWorkspacePermissions?->write ?? false, 'siteChanges' => $this->computeSiteChanges($workspaceObj, $contentRepository), 'contentDimensions' => $contentRepository->getContentDimensionSource()->getContentDimensionsOrderedByPriority() ]); @@ -281,26 +291,12 @@ public function updateAction( ); $this->redirect('index'); } - - if (!$workspace->workspaceTitle->equals($title) || !$workspace->workspaceDescription->equals($description)) { - $contentRepository->handle( - RenameWorkspace::create( - $workspaceName, - $title, - $description - ) - ); - } - - if ($workspace->workspaceOwner !== $workspaceOwner) { - $contentRepository->handle( - ChangeWorkspaceOwner::create( - $workspaceName, - $workspaceOwner ?: null, - ) - ); - } - + $this->workspaceService->updateWorkspaceMetadata( + $contentRepositoryId, + $workspaceName, + $title, + $description, + ); $this->addFlashMessage($this->translator->translateById( 'workspaces.workspaceHasBeenUpdated', [$title->value], @@ -672,9 +668,6 @@ public function discardWorkspaceAction(WorkspaceName $workspace): void /** * Computes the number of added, changed and removed nodes for the given workspace - * - * @return array - * @throws \JsonException */ protected function computePendingChanges(Workspace $selectedWorkspace, ContentRepository $contentRepository): PendingChanges { @@ -1032,6 +1025,7 @@ protected function prepareBaseWorkspaceOptions( ContentRepository $contentRepository, WorkspaceName $excludedWorkspace = null, ): array { + $user = $this->userService->getCurrentUser(); $baseWorkspaceOptions = []; $workspaces = $contentRepository->getWorkspaceFinder()->findAll(); foreach ($workspaces as $workspace) { @@ -1047,7 +1041,10 @@ protected function prepareBaseWorkspaceOptions( if (!in_array($workspaceMetadata->classification, [WorkspaceClassification::SHARED, WorkspaceClassification::ROOT], true)) { continue; } - $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepository->id, $workspace->workspaceName); + if ($user === null) { + continue; + } + $permissions = $this->workspaceService->getWorkspacePermissionsForUser($contentRepository->id, $workspace->workspaceName, $user); if (!$permissions->manage) { continue; } diff --git a/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php index bfdcda600c7..7c875cf7d2a 100644 --- a/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php +++ b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php @@ -22,6 +22,9 @@ #[Flow\Proxy(false)] final readonly class WorkspaceListItems implements \IteratorAggregate, \Countable { + /** + * @param array $items + */ private function __construct( private array $items, ) { From 54df32a8a8d0b402de527e6aac37e05d6c4beeb7 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 9 Aug 2024 14:01:01 +0200 Subject: [PATCH 03/43] Mini tweaks --- Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php | 3 --- Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 196fe3b3e0b..7b0fd9fe7c1 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -62,9 +62,6 @@ use Neos\Neos\Domain\Service\WorkspaceNameBuilder; use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\Domain\Service\WorkspaceService; -use Neos\Neos\Domain\Workspace\DiscardAllChanges; -use Neos\Neos\Domain\Workspace\PublishAllChanges; -use Neos\Neos\Domain\Workspace\WorkspaceProvider; use Neos\Neos\FrontendRouting\NodeAddress as LegacyNodeAddress; use Neos\Neos\FrontendRouting\NodeAddressFactory; use Neos\Neos\FrontendRouting\NodeUriBuilderFactory; diff --git a/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php index 7c875cf7d2a..39408c94bf9 100644 --- a/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php +++ b/Neos.Workspace.Ui/Classes/ViewModel/WorkspaceListItems.php @@ -45,7 +45,7 @@ public static function fromArray(array $items): self public function getIterator(): \Traversable { - return yield from $this->items; + yield from $this->items; } public function count(): int From dccfb50837425d97bf918740fff4f3c330311735 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 16 Aug 2024 11:07:53 +0200 Subject: [PATCH 04/43] wip --- .../Projection/Workspace/Workspace.php | 64 +++++++++++++++---- .../Command/WorkspaceCommandController.php | 34 +++++++++- .../Domain/Service/WorkspaceService.php | 2 +- .../Controller/WorkspaceController.php | 22 +++---- 4 files changed, 97 insertions(+), 25 deletions(-) diff --git a/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php b/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php index e2a294126d5..ff85e8c5da8 100644 --- a/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php +++ b/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php @@ -24,31 +24,72 @@ * * @api */ -class Workspace +final readonly class Workspace { /** * This prefix determines if a given workspace (name) is a user workspace. */ public const PERSONAL_WORKSPACE_PREFIX = 'user-'; + /** + * @var WorkspaceName Workspace identifier, unique within one Content Repository instance + */ + public WorkspaceName $workspaceName; + + /** + * @var WorkspaceName|null Workspace identifier of the base workspace (i.e. the target when publishing changes) – if null this instance is considered a root (aka public) workspace + */ + public ?WorkspaceName $baseWorkspaceName; + + /** + * @deprecated with 9.0.0-beta12 metadata should be assigned to workspaces outside the Content Repository core + */ + public WorkspaceTitle $workspaceTitle; + + /** + * @deprecated with 9.0.0-beta12metadata should be assigned to workspaces outside the Content Repository core + */ + public WorkspaceDescription $workspaceDescription; + + /** + * The Content Stream this workspace currently points to – usually it is set to a new, empty content stream after publishing/rebasing the workspace + */ + public ContentStreamId $currentContentStreamId; + + /** + * The current status of this workspace + */ + public WorkspaceStatus $status; + + /** + * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core + */ + public string|null $workspaceOwner; + /** * @internal */ public function __construct( - public readonly WorkspaceName $workspaceName, - public readonly ?WorkspaceName $baseWorkspaceName, - public readonly WorkspaceTitle $workspaceTitle, - public readonly WorkspaceDescription $workspaceDescription, - public readonly ContentStreamId $currentContentStreamId, - public readonly WorkspaceStatus $status, - public readonly ?string $workspaceOwner + WorkspaceName $workspaceName, + ?WorkspaceName $baseWorkspaceName, + WorkspaceTitle $workspaceTitle, + WorkspaceDescription $workspaceDescription, + ContentStreamId $currentContentStreamId, + WorkspaceStatus $status, + ?string $workspaceOwner ) { + $this->workspaceName = $workspaceName; + $this->baseWorkspaceName = $baseWorkspaceName; + $this->workspaceTitle = $workspaceTitle; + $this->workspaceDescription = $workspaceDescription; + $this->currentContentStreamId = $currentContentStreamId; + $this->status = $status; + $this->workspaceOwner = $workspaceOwner; } - /** * Checks if this workspace is a user's personal workspace - * @api + * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isPersonalWorkspace(): bool { @@ -59,7 +100,7 @@ public function isPersonalWorkspace(): bool * Checks if this workspace is shared only across users with access to internal workspaces, for example "reviewers" * * @return bool - * @api + * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isPrivateWorkspace(): bool { @@ -70,6 +111,7 @@ public function isPrivateWorkspace(): bool * Checks if this workspace is shared across all editors * * @return boolean + * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isInternalWorkspace(): bool { diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index ba7abc670f5..a48f668b137 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -373,8 +373,8 @@ public function listCommand(string $contentRepository = 'default'): void /* @var Workspace $workspace */ $tableRows[] = [ $workspace->workspaceName->value, - $workspaceMetadata->classification->name, - $workspace->baseWorkspaceName?->value ?: '', + $workspaceMetadata->classification->value, + $workspace->baseWorkspaceName?->value ?: '-', $workspaceMetadata->title->value, $workspaceMetadata->description->value, $workspace->status->value, @@ -383,4 +383,34 @@ public function listCommand(string $contentRepository = 'default'): void } $this->output->outputTable($tableRows, $headerRow); } + + /** + * Display details for the specified workspace + * + * @param string $workspace Name of the workspace to show + * @param string $contentRepository The name of the content repository. (Default: 'default') + * @throws StopCommandException + */ + public function showCommand(string $workspace, string $contentRepository = 'default'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); + + $workspaceName = WorkspaceName::fromString($workspace); + $workspacesInstance = $contentRepositoryInstance->getWorkspaceFinder()->findOneByName($workspaceName); + + if ($workspacesInstance === null) { + $this->outputLine('Workspace "%s" not found.', [$workspaceName->value]); + $this->quit(); + } + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName); + + $this->outputFormatted('Name: %s', [$workspacesInstance->workspaceName->value]); + $this->outputFormatted('Classification: %s', [$workspaceMetadata->classification->value]); + $this->outputFormatted('Base Workspace: %s', [$workspacesInstance->baseWorkspaceName?->value ?: '-']); + $this->outputFormatted('Title: %s', [$workspaceMetadata->title->value]); + $this->outputFormatted('Description: %s', [$workspaceMetadata->description->value]); + $this->outputFormatted('Status: %s', [$workspacesInstance->status->value]); + $this->outputFormatted('Content Stream: %s', [$workspacesInstance->currentContentStreamId->value]); + } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 742a44b818e..362d9d224be 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -279,7 +279,7 @@ private function getWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId $role = $this->dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, 'workspaceName' => $workspaceName->value, - 'subjects' => ['user:' . $userId->value, ...array_map(fn (string $role) => 'group:' . $role, $userRoles)], + 'subjects' => ['user:' . $userId->value, ...array_map(static fn (string $role) => 'group:' . $role, $userRoles)], ], [ 'subjects' => Connection::PARAM_STR_ARRAY, ]); diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 7b0fd9fe7c1..ad69ab8f39f 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -263,7 +263,7 @@ public function editAction(WorkspaceName $workspaceName): void * @param WorkspaceName $workspaceName * @param WorkspaceTitle $title Human friendly title of the workspace, for example "Christmas Campaign" * @param WorkspaceDescription $description A description explaining the purpose of the new workspace - * @param string $workspaceOwner Id of the owner of the workspace + * @param string|null $workspaceOwner Id of the owner of the workspace * @return void */ public function updateAction( @@ -329,22 +329,23 @@ public function deleteAction(WorkspaceName $workspaceName): void $this->redirect('index'); } - if ($workspace->isPersonalWorkspace()) { + $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName); + + if ($workspaceMetadata->classification === WorkspaceClassification::PERSONAL) { $this->redirect('index'); } - $dependentWorkspaces = $contentRepository->getWorkspaceFinder() - ->findByBaseWorkspace($workspace->workspaceName); + $dependentWorkspaces = $contentRepository->getWorkspaceFinder()->findByBaseWorkspace($workspace->workspaceName); if (count($dependentWorkspaces) > 0) { $dependentWorkspaceTitles = []; - /** @var Workspace $dependentWorkspace */ foreach ($dependentWorkspaces as $dependentWorkspace) { - $dependentWorkspaceTitles[] = $dependentWorkspace->workspaceTitle->value; + $dependentWorkspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $dependentWorkspace->workspaceName); + $dependentWorkspaceTitles[] = $dependentWorkspaceMetadata->title->value; } $message = $this->translator->translateById( 'workspaces.workspaceCannotBeDeletedBecauseOfDependencies', - [$workspace->workspaceTitle->value, implode(', ', $dependentWorkspaceTitles)], + [$workspaceMetadata->title->value, implode(', ', $dependentWorkspaceTitles)], null, null, 'Main', @@ -364,7 +365,7 @@ public function deleteAction(WorkspaceName $workspaceName): void } catch (\Exception $exception) { $message = $this->translator->translateById( 'workspaces.notDeletedErrorWhileFetchingUnpublishedNodes', - [$workspace->workspaceTitle->value], + [$workspaceMetadata->title->value], null, null, 'Main', @@ -376,7 +377,7 @@ public function deleteAction(WorkspaceName $workspaceName): void if ($nodesCount > 0) { $message = $this->translator->translateById( 'workspaces.workspaceCannotBeDeletedBecauseOfUnpublishedNodes', - [$workspace->workspaceTitle->value, $nodesCount], + [$workspaceMetadata->title->value, $nodesCount], $nodesCount, null, 'Main', @@ -394,7 +395,7 @@ public function deleteAction(WorkspaceName $workspaceName): void $this->addFlashMessage($this->translator->translateById( 'workspaces.workspaceHasBeenRemoved', - [$workspace->workspaceTitle->value], + [$workspaceMetadata->title->value], null, null, 'Main', @@ -459,7 +460,6 @@ public function rebaseAndRedirectAction(string $targetNode, Workspace $targetWor $targetNodeAddressInPersonalWorkspace->workspaceName ); $mainRequest = $this->controllerContext->getRequest()->getMainRequest(); - /** @var ActionRequest $mainRequest */ $this->uriBuilder->setRequest($mainRequest); $this->redirect( From 0af1fa293cdbad05a9fcdedfca430dbf47fe7b32 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Mon, 9 Sep 2024 10:04:43 +0200 Subject: [PATCH 05/43] WIP: Fix WorkspaceService as discussed with basti & christian --- Neos.Neos/Classes/Domain/Service/WorkspaceService.php | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 362d9d224be..53a2eb44912 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -15,7 +15,6 @@ namespace Neos\Neos\Domain\Service; use Doctrine\DBAL\Connection; -use Doctrine\DBAL\Exception; use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; @@ -243,12 +242,14 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep WHERE content_repository_id = :contentRepositoryId AND subject = :subject + AND subject_type = :subjectType AND role = :ownerRole SQL; $workspaceName = $this->dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, - 'subject' => 'user:' . $userId->value, - 'ownerRole' => 'OWNER' + 'subject' => $userId->value, + 'subjectType' => WorkspaceSubjectType::USER->name, + 'ownerRole' => WorkspaceRole::OWNER->name, ]); return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } @@ -295,7 +296,7 @@ private static function getUniqueWorkspaceName(ContentRepository $contentReposit $workspaceName = $workspaceNameCandidate; while ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) instanceof Workspace) { $workspaceName = WorkspaceName::fromString( - $workspaceNameCandidate->value . '-' . Algorithms::generateRandomString(5) + $workspaceNameCandidate->value . '-' . strtolower(Algorithms::generateRandomString(5)) ); } return $workspaceName; From e70592466cf8967011dbe092a20945134d78988c Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 10 Sep 2024 13:00:39 +0200 Subject: [PATCH 06/43] Fix WorkspaceService::createRootWorkspace() --- Neos.Neos/Classes/Domain/Service/WorkspaceService.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 53a2eb44912..588aa65a49e 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -149,7 +149,7 @@ public function createRootWorkspace( 'workspace_name' => $workspaceName->value, 'title' => $title->value, 'description' => $description->value, - 'classification' => WorkspaceClassification::ROOT, + 'classification' => WorkspaceClassification::ROOT->name, ]); return $workspaceName; From 11aa9b30c5596152b991564631122b8bc836cf23 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 10 Sep 2024 13:01:11 +0200 Subject: [PATCH 07/43] Use `WorkspaceService` in workspace::createroot CLI command --- .../Command/WorkspaceCommandController.php | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index a48f668b137..416a9f33aa9 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -14,7 +14,6 @@ namespace Neos\Neos\Command; -use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\BaseWorkspaceDoesNotExist; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; @@ -36,6 +35,8 @@ use Neos\Flow\Persistence\PersistenceManagerInterface; use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceClassification; +use Neos\Neos\Domain\Model\WorkspaceDescription as NeosWorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceTitle as NeosWorkspaceTitle; use Neos\Neos\Domain\Service\UserService; use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\Domain\Service\WorkspaceService; @@ -141,18 +142,17 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de * * @param string $name Name of the new root * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @param string|null $description Optional description of the workspace */ - public function createRootCommand(string $name, string $contentRepository = 'default'): void + public function createRootCommand(string $name, string $contentRepository = 'default', string $description = null): void { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); - - $contentRepositoryInstance->handle(CreateRootWorkspace::create( - WorkspaceName::fromString($name), - WorkspaceTitle::fromString($name), - WorkspaceDescription::fromString($name), - ContentStreamId::create() - )); + $workspaceName = $this->workspaceService->createRootWorkspace( + $contentRepositoryId, + NeosWorkspaceTitle::fromString($name), + NeosWorkspaceDescription::fromString($description ?? $name) + ); + $this->outputLine('Created root workspace "%s" in content repository "%s"', [$workspaceName->value, $contentRepositoryId->value]); } /** @@ -180,8 +180,8 @@ public function createCommand( $this->workspaceService->createWorkspace( $contentRepositoryId, - \Neos\Neos\Domain\Model\WorkspaceTitle::fromString($title ?? $workspace), - \Neos\Neos\Domain\Model\WorkspaceDescription::fromString($description ?? ''), + NeosWorkspaceTitle::fromString($title ?? $workspace), + NeosWorkspaceDescription::fromString($description ?? ''), WorkspaceName::fromString($baseWorkspace), \Neos\Neos\Domain\Model\UserId::fromString($owner), WorkspaceClassification::PERSONAL, From bdfb9549bc8be0ff6a215af7d1176621f855288b Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 10 Sep 2024 17:10:05 +0200 Subject: [PATCH 08/43] Stabilize unique workspace name creation and add initial behat tests --- .../Bootstrap/Features/WorkspaceCreation.php | 2 +- .../Bootstrap/Helpers/FakeUserIdProvider.php | 2 +- .../Command/WorkspaceCommandController.php | 7 +- .../Domain/Service/WorkspaceService.php | 102 +++++++++++------- .../Features/Bootstrap/FeatureContext.php | 3 +- .../Bootstrap/WorkspaceServiceTrait.php | 101 +++++++++++++++++ .../WorkspaceService.feature | 90 ++++++++++++++++ .../Controller/WorkspaceController.php | 3 +- 8 files changed, 264 insertions(+), 46 deletions(-) create mode 100644 Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php create mode 100644 Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature diff --git a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Features/WorkspaceCreation.php b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Features/WorkspaceCreation.php index fec6f30e5a5..bdfcd1dc5e4 100644 --- a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Features/WorkspaceCreation.php +++ b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Features/WorkspaceCreation.php @@ -68,7 +68,7 @@ public function theCommandCreateRootWorkspaceIsExecutedWithPayload(TableNode $pa $command = CreateRootWorkspace::create( WorkspaceName::fromString($commandArguments['workspaceName']), new WorkspaceTitle($commandArguments['workspaceTitle'] ?? ucfirst($commandArguments['workspaceName'])), - new WorkspaceDescription($commandArguments['workspaceDescription'] ?? 'The workspace "' . $commandArguments['workspaceName'] . '"'), + new WorkspaceDescription($commandArguments['workspaceDescription'] ?? ('The workspace "' . $commandArguments['workspaceName'] . '"')), ContentStreamId::fromString($commandArguments['newContentStreamId']) ); diff --git a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Helpers/FakeUserIdProvider.php b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Helpers/FakeUserIdProvider.php index f52f569ceb2..88614645a23 100644 --- a/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Helpers/FakeUserIdProvider.php +++ b/Neos.ContentRepository.TestSuite/Classes/Behavior/Features/Bootstrap/Helpers/FakeUserIdProvider.php @@ -9,7 +9,7 @@ final class FakeUserIdProvider implements UserIdProviderInterface { - private static ?UserId $userId = null; + public static ?UserId $userId = null; public static function setUserId(UserId $userId): void { diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 416a9f33aa9..32c5c44ef61 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -158,7 +158,7 @@ public function createRootCommand(string $name, string $contentRepository = 'def /** * Create a new workspace * - * This command creates a new workspace. + * This command creates a new personal workspace. * * @param string $workspace Name of the workspace, for example "christmas-campaign" * @param string $baseWorkspace Name of the base workspace. If none is specified, "live" is assumed. @@ -178,13 +178,12 @@ public function createCommand( ): void { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - $this->workspaceService->createWorkspace( + $this->workspaceService->createPersonalWorkspace( $contentRepositoryId, NeosWorkspaceTitle::fromString($title ?? $workspace), NeosWorkspaceDescription::fromString($description ?? ''), WorkspaceName::fromString($baseWorkspace), - \Neos\Neos\Domain\Model\UserId::fromString($owner), - WorkspaceClassification::PERSONAL, + UserId::fromString($owner), ); $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 588aa65a49e..53e3fb552e1 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -25,7 +25,6 @@ use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; -use Neos\Flow\Utility\Algorithms; use Neos\Neos\Domain\Model\User; use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceClassification; @@ -155,7 +154,57 @@ public function createRootWorkspace( return $workspaceName; } - public function createWorkspace( + public function createPersonalWorkspace( + ContentRepositoryId $contentRepositoryId, + WorkspaceTitle $title, + WorkspaceDescription $description, + WorkspaceName $baseWorkspaceName, + UserId $ownerId, + ): WorkspaceName { + return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::PERSONAL); + } + + public function createSharedWorkspace( + ContentRepositoryId $contentRepositoryId, + WorkspaceTitle $title, + WorkspaceDescription $description, + WorkspaceName $baseWorkspaceName, + UserId|null $ownerId = null, + ): WorkspaceName { + return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::SHARED); + } + + public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $contentRepositoryId, User $user): void + { + $existingWorkspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId()); + if ($existingWorkspaceName !== null) { + $this->requireWorkspace($contentRepositoryId, $existingWorkspaceName); + return; + } + $this->createPersonalWorkspace( + $contentRepositoryId, + WorkspaceTitle::fromString($user->getLabel()), + WorkspaceDescription::empty(), + WorkspaceName::forLive(), + $user->getId(), + ); + } + + public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions + { + $userRoles = $this->userService->getAllRoles($user); + $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); + + $userWorkspaceRole = $this->getWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); + + return WorkspacePermissions::create( + read: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + write: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + manage: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), + ); + } + + private function createWorkspace( ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, @@ -200,37 +249,6 @@ public function createWorkspace( return $workspaceName; } - public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $contentRepositoryId, User $user): void - { - $existingWorkspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId()); - if ($existingWorkspaceName !== null) { - $this->requireWorkspace($contentRepositoryId, $existingWorkspaceName); - return; - } - $this->createWorkspace( - $contentRepositoryId, - WorkspaceTitle::fromString($user->getLabel()), - WorkspaceDescription::empty(), - WorkspaceName::forLive(), - $user->getId(), - WorkspaceClassification::PERSONAL, - ); - } - - public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions - { - $userRoles = $this->userService->getAllRoles($user); - $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); - - $userWorkspaceRole = $this->getWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); - - return WorkspacePermissions::create( - read: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), - write: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), - manage: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), - ); - } - private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): ?WorkspaceName { $table = self::TABLE_NAME_WORKSPACE_ROLE; @@ -294,12 +312,22 @@ private static function getUniqueWorkspaceName(ContentRepository $contentReposit { $workspaceNameCandidate = WorkspaceName::transliterateFromString($candidate); $workspaceName = $workspaceNameCandidate; - while ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) instanceof Workspace) { + $attempt = 1; + do { + if ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) === null) { + return $workspaceName; + } + if ($attempt === 1) { + $suffix = ''; + } else { + $suffix = '-' . ($attempt - 1); + } $workspaceName = WorkspaceName::fromString( - $workspaceNameCandidate->value . '-' . strtolower(Algorithms::generateRandomString(5)) + substr($workspaceNameCandidate->value, 0, WorkspaceName::MAX_LENGTH - strlen($suffix)) . $suffix ); - } - return $workspaceName; + $attempt++; + } while ($attempt <= 10); + throw new \RuntimeException(sprintf('Failed to find unique workspace name for "%s" after %d attempts.', $candidate, $attempt - 1), 1725975479); } diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/FeatureContext.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/FeatureContext.php index ac1b37f4ba5..08699ce17ca 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/FeatureContext.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/FeatureContext.php @@ -44,6 +44,8 @@ class FeatureContext implements BehatContext use ContentCacheTrait; use AssetTrait; + use WorkspaceServiceTrait; + protected Environment $environment; protected ContentRepositoryRegistry $contentRepositoryRegistry; @@ -55,7 +57,6 @@ public function __construct() $this->environment = $this->getObject(Environment::class); $this->contentRepositoryRegistry = $this->getObject(ContentRepositoryRegistry::class); $this->persistenceManager = $this->getObject(PersistenceManagerInterface::class); - } /* diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php new file mode 100644 index 00000000000..1462d889cc4 --- /dev/null +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -0,0 +1,101 @@ + $className + * + * @return T + */ + abstract private function getObject(string $className): object; + + /** + * @When the root workspace :workspaceTitle is created + */ + public function theRootWorkspaceIsCreated(string $workspaceTitle): void + { + $this->getObject(WorkspaceService::class)->createRootWorkspace( + $this->currentContentRepository->id, + WorkspaceTitle::fromString($workspaceTitle), + WorkspaceDescription::fromString(''), + ); + } + + /** + * @When the personal workspace :workspaceTitle is created with the target workspace :targetWorkspace + */ + public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceTitle, string $targetWorkspace): void + { + $this->getObject(WorkspaceService::class)->createPersonalWorkspace( + $this->currentContentRepository->id, + WorkspaceTitle::fromString($workspaceTitle), + WorkspaceDescription::fromString(''), + WorkspaceName::fromString($targetWorkspace), + UserId::fromString(FakeUserIdProvider::$userId?->value ?? ''), + ); + } + + /** + * @When the shared workspace :workspaceTitle is created with the target workspace :targetWorkspace + */ + public function theSharedWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceTitle, string $targetWorkspace): void + { + $this->getObject(WorkspaceService::class)->createSharedWorkspace( + $this->currentContentRepository->id, + WorkspaceTitle::fromString($workspaceTitle), + WorkspaceDescription::fromString(''), + WorkspaceName::fromString($targetWorkspace), + null + ); + } + + /** + * @Then the following workspaces should exist: + */ + public function theFollowingWorkspacesShouldExist(TableNode $expectedWorkspacesTable): void + { + $expectedWorkspaces = $expectedWorkspacesTable->getHash(); + $actualWorkspaces = []; + $workspaceFinder = $this->currentContentRepository->getWorkspaceFinder(); + $workspaceService = $this->getObject(WorkspaceService::class); + foreach ($workspaceFinder->findAll() as $workspace) { + $workspaceMetadata = $workspaceService->getWorkspaceMetadata($this->currentContentRepository->id, $workspace->workspaceName); + $actualWorkspaces[] = [ + 'Name' => $workspace->workspaceName->value, + 'Base workspace' => $workspace->baseWorkspaceName?->value ?? '', + 'Title' => $workspaceMetadata->title->value, + 'Classification' => $workspaceMetadata->classification->value, + ]; + } + Assert::same($expectedWorkspaces, $actualWorkspaces); + } +} diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature new file mode 100644 index 00000000000..5c8eaac6faa --- /dev/null +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -0,0 +1,90 @@ +@flowEntities +Feature: Neos WorkspaceService related features + + Background: + Given using no content dimensions + And using the following node types: + """yaml + 'Neos.ContentRepository:Root': {} + """ + And using identifier "default", I define a content repository + And I am in content repository "default" + And I am user identified by "editor" + + Scenario: Create single root workspace + When the root workspace "Some root workspace" is created + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | some-root-workspace | | Some root workspace | ROOT | + + Scenario: Create root workspace with a title that exceeds the workspace name max length + When the root workspace "Some root workspace with a title that exceeds the max name length" is created + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | some-root-workspace-with-a-title-tha | | Some root workspace with a title that exceeds the max name length | ROOT | + + Scenario: Create multiple root workspaces with the same derived name + When the root workspace "Root" is created + And the root workspace "Root 5" is created + And the root workspace "root" is created + And the root workspace "-Root" is created + And the root workspace "Root" is created + And the root workspace "Root" is created + And the root workspace "Root" is created + And the root workspace "Root" is created + And the root workspace "Root" is created + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | root | | Root | ROOT | + | root-1 | | root | ROOT | + | root-2 | | -Root | ROOT | + | root-3 | | Root | ROOT | + | root-4 | | Root | ROOT | + | root-5 | | Root 5 | ROOT | + | root-6 | | Root | ROOT | + | root-7 | | Root | ROOT | + | root-8 | | Root | ROOT | + + Scenario: Create multiple root workspaces with the same derived name with a lenght that exceeds the allowed max length + And the root workspace "some-root-workspace-with-a-long-title" is created + And the root workspace "some-root-workspace-with-a-long-title" is created + And the root workspace "some-root-workspace-with-a-long-title" is created + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | some-root-workspace-with-a-long-ti-1 | | some-root-workspace-with-a-long-title | ROOT | + | some-root-workspace-with-a-long-ti-2 | | some-root-workspace-with-a-long-title | ROOT | + | some-root-workspace-with-a-long-titl | | some-root-workspace-with-a-long-title | ROOT | + + Scenario: Create a single personal workspace + When the root workspace "Some root workspace" is created + And the personal workspace "Some user workspace" is created with the target workspace "some-root-workspace" + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | some-root-workspace | | Some root workspace | ROOT | + | some-user-workspace | some-root-workspace | Some user workspace | PERSONAL | + + Scenario: Create a single shared workspace + When the root workspace "Some root workspace" is created + And the shared workspace "Some shared workspace" is created with the target workspace "some-root-workspace" + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | some-root-workspace | | Some root workspace | ROOT | + | some-shared-workspace | some-root-workspace | Some shared workspace | SHARED | + + Scenario: Creating several workspaces with the same derived names + When the root workspace "root 1" is created + And the root workspace "Root 2" is created + And the personal workspace "User 1" is created with the target workspace "root-1" + And the personal workspace "User 2" is created with the target workspace "root-2" + And the personal workspace "root 1" is created with the target workspace "root-2" + And the shared workspace "Root 1" is created with the target workspace "root-2" + And the shared workspace "Shared 2" is created with the target workspace "root-1" + Then the following workspaces should exist: + | Name | Base workspace | Title | Classification | + | root-1 | | root 1 | ROOT | + | root-1-1 | root-2 | root 1 | PERSONAL | + | root-1-2 | root-2 | Root 1 | SHARED | + | root-2 | | Root 2 | ROOT | + | shared-2 | root-1 | Shared 2 | SHARED | + | user-1 | root-1 | User 1 | PERSONAL | + | user-2 | root-2 | User 2 | PERSONAL | diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index ad69ab8f39f..e217817b4c3 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -211,13 +211,12 @@ public function createAction( } try { - $this->workspaceService->createWorkspace( + $this->workspaceService->createSharedWorkspace( $contentRepositoryId, $title, $description, $baseWorkspace, $currentUser->getId(), - WorkspaceClassification::SHARED, ); } catch (WorkspaceAlreadyExists $exception) { $this->addFlashMessage( From 0f20b89231532a166e6312f8e6370320b5eea704 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Thu, 19 Sep 2024 11:01:25 +0200 Subject: [PATCH 09/43] Provide CLI to synchronize workspace metadata and roles Usage: ``` ./flow workspace:syncall --content-repository foo ``` --- .../Command/WorkspaceCommandController.php | 29 ++++++++++ .../Domain/Service/WorkspaceService.php | 54 +++++++++++++------ .../Controller/WorkspaceController.php | 14 +++-- .../Private/Templates/Workspace/Index.html | 6 +-- 4 files changed, 76 insertions(+), 27 deletions(-) diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 32c5c44ef61..2cf14aaa8d3 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -412,4 +412,33 @@ public function showCommand(string $workspace, string $contentRepository = 'defa $this->outputFormatted('Status: %s', [$workspacesInstance->status->value]); $this->outputFormatted('Content Stream: %s', [$workspacesInstance->currentContentStreamId->value]); } + + + /** + * Synchronizes metadata and role assignments of all workspaces for the specified Content Repository + * + * @param string $contentRepository The name of the content repository. (Default: 'default') + * @throws StopCommandException + */ + public function syncAllCommand(string $contentRepository = 'default'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); + + $workspaces = $contentRepositoryInstance->getWorkspaceFinder()->findAll(); + + if (count($workspaces) === 0) { + $this->outputLine('No workspaces found.'); + $this->quit(); + } + foreach ($workspaces as $workspace) { + try { + $this->workspaceService->synchronizeWorkspaceMetadataAndRoles($contentRepositoryId, $workspace->workspaceName); + $this->outputLine('Synchronized workspace "%s"', [$workspace->workspaceName->value]); + } catch (\Exception $exception) { + $this->outputLine('Failed to synchronize workspace "%s": %s', [$workspace->workspaceName->value, $exception->getMessage()]); + } + } + $this->outputLine('Done.'); + } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 53e3fb552e1..6369fb3af39 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -70,12 +70,7 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W 'workspaceName' => $workspaceName->value, ]); if ($metadataRow === false) { - return new WorkspaceMetadata( - $workspaceName, - WorkspaceTitle::fromString(ucfirst($workspaceName->value)), - WorkspaceDescription::fromString(''), - $workspaceName->isLive() ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, - ); + throw new \RuntimeException(sprintf('Failed to load metadata for workspace "%s" (Content Repository "%s"). Maybe workspace metadata and roles have to be synchronized', $workspaceName->value, $contentRepositoryId->value), 1726736384); } return new WorkspaceMetadata( $workspaceName, @@ -85,24 +80,51 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W ); } - public function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle, WorkspaceDescription $newWorkspaceDescription): void + public function updateWorkspaceTitleAndDescription(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle, WorkspaceDescription $newWorkspaceDescription): void { $this->requireWorkspace($contentRepositoryId, $workspaceName); + $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'title' => $newWorkspaceTitle->value, + 'description' => $newWorkspaceDescription->value, + ], [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + ]); + } + + public function synchronizeWorkspaceMetadataAndRoles(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): void + { + $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); + if ($workspace->baseWorkspaceName === null) { + $classification = WorkspaceClassification::ROOT; + } elseif ($workspace->workspaceOwner !== null) { + $classification = WorkspaceClassification::PERSONAL; + } else { + $classification = WorkspaceClassification::SHARED; + } try { $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'title' => $newWorkspaceTitle->value, - 'description' => $newWorkspaceDescription->value, + 'title' => WorkspaceTitle::fromString($workspace->workspaceTitle->value)->value, + 'description' => WorkspaceDescription::fromString($workspace->workspaceDescription->value)->value, + 'classification' => $classification->value, ]); } catch (UniqueConstraintViolationException $e) { - $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, [ - 'title' => $newWorkspaceTitle->value, - 'description' => $newWorkspaceDescription->value, - ], [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - ]); + // Metadata already exists + } + if ($workspace->workspaceOwner !== null) { + try { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => WorkspaceSubjectType::USER->name, + 'subject' => $workspace->workspaceOwner, + 'role' => WorkspaceRole::OWNER->name, + ]); + } catch (UniqueConstraintViolationException $e) { + // Owner role assignment already exists + } } } diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index e217817b4c3..6b5244e8341 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -241,17 +241,17 @@ public function editAction(WorkspaceName $workspaceName): void $workspace = $contentRepository->getWorkspaceFinder()->findOneByName($workspaceName); if (is_null($workspace)) { - // @todo add flash message + $this->addFlashMessage('Failed to find workspace "%s"', 'Error', Message::SEVERITY_ERROR, [$workspaceName->value]); $this->redirect('index'); } $this->view->assign('workspace', $workspace); $this->view->assign('baseWorkspaceOptions', $this->prepareBaseWorkspaceOptions($contentRepository, $workspaceName)); // TODO: $this->view->assign('disableBaseWorkspaceSelector', // $this->publishingService->getUnpublishedNodesCount($workspace) > 0); - $this->view->assign( - 'showOwnerSelector', - true// TODO fix $this->userService->currentUserCanTransferOwnershipOfWorkspace($workspace) - ); + + // TODO fix $this->userService->currentUserCanTransferOwnershipOfWorkspace($workspace) + $this->view->assign('showOwnerSelector', false); + $this->view->assign('ownerOptions', $this->prepareOwnerOptions()); } @@ -262,14 +262,12 @@ public function editAction(WorkspaceName $workspaceName): void * @param WorkspaceName $workspaceName * @param WorkspaceTitle $title Human friendly title of the workspace, for example "Christmas Campaign" * @param WorkspaceDescription $description A description explaining the purpose of the new workspace - * @param string|null $workspaceOwner Id of the owner of the workspace * @return void */ public function updateAction( WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, - ?string $workspaceOwner ): void { $contentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); @@ -287,7 +285,7 @@ public function updateAction( ); $this->redirect('index'); } - $this->workspaceService->updateWorkspaceMetadata( + $this->workspaceService->updateWorkspaceTitleAndDescription( $contentRepositoryId, $workspaceName, $title, diff --git a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html index f125042ecfa..b76c5a2a837 100644 --- a/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html +++ b/Neos.Workspace.Ui/Resources/Private/Templates/Workspace/Index.html @@ -82,7 +82,7 @@ - + {neos:backend.translate(id: 'workspaces.review', source: 'Main', package: 'Neos.Workspace.Ui')} @@ -92,7 +92,7 @@
- + @@ -130,7 +130,7 @@
{neos:backend.translate(id: 'cancel', source: 'Main', package: 'Neos.Workspace.Ui')} - + From a46729647f4b4f6caf79950586f872120e9508f7 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Mon, 23 Sep 2024 11:49:52 +0200 Subject: [PATCH 10/43] Stabilize and document WorkspaceService --- .../Domain/Service/WorkspaceService.php | 283 ++++++++++-------- 1 file changed, 160 insertions(+), 123 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 6369fb3af39..7fbfc65113f 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -15,6 +15,7 @@ namespace Neos\Neos\Domain\Service; use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Exception as DbalException; use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; @@ -22,9 +23,12 @@ use Neos\ContentRepository\Core\Projection\Workspace\Workspace; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; +use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription as DeprecatedWorkspaceDescription; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; +use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle as DeprecatedWorkspaceTitle; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; +use Neos\Flow\Security\Exception\NoSuchRoleException; use Neos\Neos\Domain\Model\User; use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceClassification; @@ -35,6 +39,8 @@ use Neos\Neos\Domain\Model\WorkspaceSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; +use function sprintf; + /** * @api */ @@ -51,83 +57,65 @@ public function __construct( ) { } + /** + * Load metadata for the specified workspace + */ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceMetadata { $this->requireWorkspace($contentRepositoryId, $workspaceName); - - $table = self::TABLE_NAME_WORKSPACE_METADATA; - $query = <<dbal->fetchAssociative($query, [ - 'contentRepositoryId' => $contentRepositoryId->value, - 'workspaceName' => $workspaceName->value, - ]); - if ($metadataRow === false) { + $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); + if ($metadata === null) { throw new \RuntimeException(sprintf('Failed to load metadata for workspace "%s" (Content Repository "%s"). Maybe workspace metadata and roles have to be synchronized', $workspaceName->value, $contentRepositoryId->value), 1726736384); } - return new WorkspaceMetadata( - $workspaceName, - WorkspaceTitle::fromString($metadataRow['title']), - WorkspaceDescription::fromString($metadataRow['description']), - WorkspaceClassification::from($metadataRow['classification']) - ); + return $metadata; } + /** + * Change title and/or description metadata for the specified workspace + */ public function updateWorkspaceTitleAndDescription(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle, WorkspaceDescription $newWorkspaceDescription): void { $this->requireWorkspace($contentRepositoryId, $workspaceName); - $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, [ + $this->updateWorkspaceMetadata($contentRepositoryId, $workspaceName, [ 'title' => $newWorkspaceTitle->value, 'description' => $newWorkspaceDescription->value, - ], [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, ]); } + /** + * Add missing metadata and owner role assignments for the specified workspace + * + * Note: This is mainly needed in order to migrate existing installations or fix the state if it was corrupted + */ public function synchronizeWorkspaceMetadataAndRoles(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): void { $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); if ($workspace->baseWorkspaceName === null) { $classification = WorkspaceClassification::ROOT; - } elseif ($workspace->workspaceOwner !== null) { + } elseif ($workspace->workspaceOwner !== null && str_starts_with($workspaceName->value, 'user-')) { $classification = WorkspaceClassification::PERSONAL; } else { $classification = WorkspaceClassification::SHARED; } - try { - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'title' => WorkspaceTitle::fromString($workspace->workspaceTitle->value)->value, - 'description' => WorkspaceDescription::fromString($workspace->workspaceDescription->value)->value, - 'classification' => $classification->value, - ]); - } catch (UniqueConstraintViolationException $e) { - // Metadata already exists + + $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); + if ($metadata === null) { + $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, WorkspaceTitle::fromString($workspace->workspaceTitle->value), WorkspaceDescription::fromString($workspace->workspaceDescription->value), $classification); } + if ($workspace->workspaceOwner !== null) { - try { - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::USER->name, - 'subject' => $workspace->workspaceOwner, - 'role' => WorkspaceRole::OWNER->name, - ]); - } catch (UniqueConstraintViolationException $e) { - // Owner role assignment already exists + $existingUserRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, UserId::fromString($workspace->workspaceOwner), []); + if ($existingUserRole === WorkspaceRole::NONE) { + $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $workspace->workspaceOwner, WorkspaceRole::OWNER); } } } + /** + * Retrieve the currently active personal workspace for the specified $userId + * + * NOTE: Currently there can only ever be a single personal workspace per user. But this API already prepares support for multiple personal workspaces per user + */ public function getPersonalWorkspaceForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): Workspace { $workspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $userId); @@ -137,65 +125,44 @@ public function getPersonalWorkspaceForUser(ContentRepositoryId $contentReposito return $this->requireWorkspace($contentRepositoryId, $workspaceName); } - public function createRootWorkspace( - ContentRepositoryId $contentRepositoryId, - WorkspaceTitle $title, - WorkspaceDescription $description, - ): WorkspaceName { + /** + * Create a new root (aka base) workspace with the specified metadata + */ + public function createRootWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description): WorkspaceName + { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); $contentRepository->handle( CreateRootWorkspace::create( $workspaceName, - \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle::fromString($title->value), - \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription::fromString($description->value), + DeprecatedWorkspaceTitle::fromString($title->value), + DeprecatedWorkspaceDescription::fromString($description->value), ContentStreamId::create() ) ); - - // TODO catch exceptions - -// $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ -// 'content_repository_id' => $contentRepositoryId->value, -// 'workspace_name' => $workspaceName->value, -// 'subject_type' => WorkspaceSubjectType::GROUP->name, -// 'subject' => 'Neos.Flow:Everybody', -// 'role' => WorkspaceRole::COLLABORATOR, -// ]); - - // TODO catch exceptions - - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'title' => $title->value, - 'description' => $description->value, - 'classification' => WorkspaceClassification::ROOT->name, - ]); - + $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, WorkspaceClassification::ROOT); return $workspaceName; } - public function createPersonalWorkspace( - ContentRepositoryId $contentRepositoryId, - WorkspaceTitle $title, - WorkspaceDescription $description, - WorkspaceName $baseWorkspaceName, - UserId $ownerId, - ): WorkspaceName { + /** + * Create a new, personal, workspace for the specified user + */ + public function createPersonalWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId $ownerId): WorkspaceName + { return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::PERSONAL); } - public function createSharedWorkspace( - ContentRepositoryId $contentRepositoryId, - WorkspaceTitle $title, - WorkspaceDescription $description, - WorkspaceName $baseWorkspaceName, - UserId|null $ownerId = null, - ): WorkspaceName { + /** + * Create a new, potentially shared, workspace + */ + public function createSharedWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId|null $ownerId = null): WorkspaceName + { return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::SHARED); } + /** + * Create a new, personal, workspace for the specified user if none exists yet + */ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $contentRepositoryId, User $user): void { $existingWorkspaceName = $this->findPrimaryWorkspaceNameForUser($contentRepositoryId, $user->getId()); @@ -212,12 +179,19 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con ); } + /** + * + */ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions { - $userRoles = $this->userService->getAllRoles($user); + try { + $userRoles = $this->userService->getAllRoles($user); + } catch (NoSuchRoleException $e) { + throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); + } $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); - $userWorkspaceRole = $this->getWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); + $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); return WorkspacePermissions::create( read: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), @@ -226,61 +200,123 @@ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepos ); } - private function createWorkspace( - ContentRepositoryId $contentRepositoryId, - WorkspaceTitle $title, - WorkspaceDescription $description, - WorkspaceName $baseWorkspaceName, - UserId|null $ownerId, - WorkspaceClassification $classification, - ): WorkspaceName { + // ------------------ + + private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): ?WorkspaceMetadata + { + $table = self::TABLE_NAME_WORKSPACE_METADATA; + $query = <<dbal->fetchAssociative($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to load metadata for workspace "%s" (Content Repository "%s"): %s. Maybe workspace metadata and roles have to be synchronized', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1726736383, $e); + } + if (!is_array($metadataRow)) { + return null; + } + assert(is_string($metadataRow['title'])); + assert(is_string($metadataRow['description'])); + assert(is_string($metadataRow['classification'])); + return new WorkspaceMetadata( + $workspaceName, + WorkspaceTitle::fromString($metadataRow['title']), + WorkspaceDescription::fromString($metadataRow['description']), + WorkspaceClassification::from($metadataRow['classification']) + ); + } + + /** + * @param array $data + */ + private function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, array $data): void + { + try { + $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, $data, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to update metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1726821159, $e); + } + } + + private function createWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId|null $ownerId, WorkspaceClassification $classification): WorkspaceName + { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); $contentRepository->handle( CreateWorkspace::create( $workspaceName, $baseWorkspaceName, - \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle::fromString($title->value), - \Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription::fromString($description->value), + DeprecatedWorkspaceTitle::fromString($title->value), + DeprecatedWorkspaceDescription::fromString($description->value), ContentStreamId::create() ) ); - - // TODO catch exceptions - if ($ownerId !== null) { + $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $ownerId->value, WorkspaceRole::OWNER); + } + $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, $classification); + return $workspaceName; + } + + private function addWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceSubjectType $subjectType, string $subject, WorkspaceRole $role): void + { + try { $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::USER->name, - 'subject' => $ownerId->value, - 'role' => WorkspaceRole::OWNER->name, + 'subject_type' => $subjectType->name, + 'subject' => $subject, + 'role' => $role->name, ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to add role for subject "%s" in workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject, $contentRepositoryId->value, $e->getMessage()), 1727083752, $e); } + } - // TODO catch exceptions - - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'title' => $title->value, - 'description' => $description->value, - 'classification' => $classification->name, - ]); - - return $workspaceName; + private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceClassification $classification): void + { + try { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'title' => $title->value, + 'description' => $description->value, + 'classification' => $classification->name, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to add metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1727084068, $e); + } } private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): ?WorkspaceName { - $table = self::TABLE_NAME_WORKSPACE_ROLE; + $tableRole = self::TABLE_NAME_WORKSPACE_ROLE; + $tableMetadata = self::TABLE_NAME_WORKSPACE_METADATA; $query = << $userId->value, 'subjectType' => WorkspaceSubjectType::USER->name, 'ownerRole' => WorkspaceRole::OWNER->name, + 'classification' => WorkspaceClassification::PERSONAL->name, ]); return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } @@ -297,7 +334,7 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep /** * @param array $userRoles */ - private function getWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): WorkspaceRole + private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): WorkspaceRole { $table = self::TABLE_NAME_WORKSPACE_ROLE; $query = << Date: Wed, 25 Sep 2024 17:55:58 +0200 Subject: [PATCH 11/43] Fix workspace role handling --- .../Classes/Domain/Model/WorkspaceRole.php | 22 ++++++--- .../Domain/Service/WorkspaceService.php | 49 ++++++++++--------- 2 files changed, 43 insertions(+), 28 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index 5f256133db4..0e41a8c643e 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -9,15 +9,25 @@ * * @api */ -enum WorkspaceRole : int +enum WorkspaceRole : string { - case NONE = 0; - case COLLABORATOR = 1; - case MANAGER = 2; - case OWNER = 3; + case NONE = 'NONE'; + case COLLABORATOR = 'COLLABORATOR'; + case MANAGER = 'MANAGER'; + case OWNER = 'OWNER'; public function isAtLeast(self $role): bool { - return $this->value >= $role->value; + return $this->specifity() >= $role->specifity(); + } + + private function specifity(): int + { + return match ($this) { + self::NONE => 0, + self::COLLABORATOR => 1, + self::MANAGER => 2, + self::OWNER => 3, + }; } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 7fbfc65113f..dc72622188f 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -16,7 +16,6 @@ use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception as DbalException; -use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; @@ -39,8 +38,6 @@ use Neos\Neos\Domain\Model\WorkspaceSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; -use function sprintf; - /** * @api */ @@ -104,10 +101,7 @@ public function synchronizeWorkspaceMetadataAndRoles(ContentRepositoryId $conten } if ($workspace->workspaceOwner !== null) { - $existingUserRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, UserId::fromString($workspace->workspaceOwner), []); - if ($existingUserRole === WorkspaceRole::NONE) { - $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $workspace->workspaceOwner, WorkspaceRole::OWNER); - } + $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $workspace->workspaceOwner, WorkspaceRole::OWNER); } } @@ -184,19 +178,18 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con */ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions { - try { - $userRoles = $this->userService->getAllRoles($user); - } catch (NoSuchRoleException $e) { - throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); + if ($this->userService->currentUserIsAdministrator()) { + return WorkspacePermissions::create( + read: true, + write: true, + manage: true, + ); } - $userIsAdmin = array_key_exists('Neos.Neos:Administrator', $userRoles); - - $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), array_keys($userRoles)); - + $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user); return WorkspacePermissions::create( - read: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), - write: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), - manage: $userIsAdmin || $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), + read: $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + write: $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), + manage: $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), ); } @@ -334,8 +327,13 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep /** * @param array $userRoles */ - private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): WorkspaceRole + private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspaceRole { + try { + $userRoles = array_keys($this->userService->getAllRoles($user)); + } catch (NoSuchRoleException $e) { + throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); + } $table = self::TABLE_NAME_WORKSPACE_ROLE; $query = <<dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, 'workspaceName' => $workspaceName->value, - 'subjects' => ['user:' . $userId->value, ...array_map(static fn (string $role) => 'group:' . $role, $userRoles)], + 'userSubjectType' => WorkspaceSubjectType::USER->name, + 'userId' => $user->getId()->value, + 'groupSubjectType' => WorkspaceSubjectType::GROUP->name, + 'groupSubjects' => $userRoles, ], [ - 'subjects' => Connection::PARAM_STR_ARRAY, + 'groupSubjects' => Connection::PARAM_STR_ARRAY, ]); if ($role === false) { return WorkspaceRole::NONE; From 5d448c86ebb56e41eeeec6ff4bc822b3f0ead08f Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 25 Sep 2024 17:58:14 +0200 Subject: [PATCH 12/43] Improve "pending changes" projection and read model --- .../Service/WorkspacePublishingService.php | 46 ++++-- .../PendingChangesProjection/Change.php | 130 ++++++--------- .../PendingChangesProjection/ChangeFinder.php | 30 ++-- .../PendingChangesProjection/Changes.php | 149 ++++++++++++++++++ 4 files changed, 236 insertions(+), 119 deletions(-) create mode 100644 Neos.Neos/Classes/PendingChangesProjection/Changes.php diff --git a/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php b/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php index 78a71898036..fd7cb7e1453 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspacePublishingService.php @@ -41,6 +41,7 @@ use Neos\Neos\Domain\Model\PublishingResult; use Neos\Neos\PendingChangesProjection\Change; use Neos\Neos\PendingChangesProjection\ChangeFinder; +use Neos\Neos\PendingChangesProjection\Changes; /** * Central authority for publishing/discarding workspace changes from Neos @@ -55,13 +56,24 @@ public function __construct( ) { } - /** @internal experimental api, until actually used by the Neos.Ui */ - public function countPendingWorkspaceChanges(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): int + + /** + * @internal experimental api, until actually used by the Neos.Ui + */ + public function pendingWorkspaceChanges(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): Changes { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - return count($this->pendingWorkspaceChanges($contentRepository, $workspaceName)); + return $this->pendingWorkspaceChangesInternal($contentRepository, $workspaceName); } + /** + * @internal experimental api, until actually used by the Neos.Ui + */ + public function countPendingWorkspaceChanges(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): int + { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + return $this->countPendingWorkspaceChangesInternal($contentRepository, $workspaceName); + } /** * @throws WorkspaceDoesNotExist | WorkspaceRebaseFailed @@ -79,9 +91,9 @@ public function publishWorkspace(ContentRepositoryId $contentRepositoryId, Works if ($crWorkspace->baseWorkspaceName === null) { throw new \InvalidArgumentException(sprintf('Failed to publish workspace "%s" because it has no base workspace', $workspaceName->value), 1717517124); } - $numberOfPendingChanges = $this->pendingWorkspaceChanges($contentRepository, $workspaceName); + $numberOfPendingChanges = $this->countPendingWorkspaceChangesInternal($contentRepository, $workspaceName); $this->contentRepositoryRegistry->get($contentRepositoryId)->handle(PublishWorkspace::create($workspaceName)); - return new PublishingResult(count($numberOfPendingChanges), $crWorkspace->baseWorkspaceName); + return new PublishingResult($numberOfPendingChanges, $crWorkspace->baseWorkspaceName); } public function publishChangesInSite(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $siteId): PublishingResult @@ -149,13 +161,11 @@ public function discardAllWorkspaceChanges(ContentRepositoryId $contentRepositor $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); - $changesToBeDiscarded = $this->pendingWorkspaceChanges($contentRepository, $workspaceName); + $numberOfChangesToBeDiscarded = $this->countPendingWorkspaceChangesInternal($contentRepository, $workspaceName); $contentRepository->handle(DiscardWorkspace::create($workspaceName)); - return new DiscardingResult( - count($changesToBeDiscarded) - ); + return new DiscardingResult($numberOfChangesToBeDiscarded); } public function discardChangesInSite(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, NodeAggregateId $siteId): DiscardingResult @@ -314,7 +324,7 @@ private function resolveNodeIdsToPublishOrDiscard( NodeTypeName $ancestorNodeTypeName ): NodeIdsToPublishOrDiscard { $nodeIdsToPublishOrDiscard = []; - foreach ($this->pendingWorkspaceChanges($contentRepository, $workspaceName) as $change) { + foreach ($this->pendingWorkspaceChangesInternal($contentRepository, $workspaceName) as $change) { if ( !$this->isChangePublishableWithinAncestorScope( $contentRepository, @@ -336,17 +346,19 @@ private function resolveNodeIdsToPublishOrDiscard( return NodeIdsToPublishOrDiscard::create(...$nodeIdsToPublishOrDiscard); } - /** - * @return array - */ - private function pendingWorkspaceChanges(ContentRepository $contentRepository, WorkspaceName $workspaceName): array + private function pendingWorkspaceChangesInternal(ContentRepository $contentRepository, WorkspaceName $workspaceName): Changes { $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); - /** @var ChangeFinder $changeFinder */ - $changeFinder = $contentRepository->projectionState(ChangeFinder::class); - return $changeFinder->findByContentStreamId($crWorkspace->currentContentStreamId); + return $contentRepository->projectionState(ChangeFinder::class)->findByContentStreamId($crWorkspace->currentContentStreamId); } + private function countPendingWorkspaceChangesInternal(ContentRepository $contentRepository, WorkspaceName $workspaceName): int + { + $crWorkspace = $this->requireContentRepositoryWorkspace($contentRepository, $workspaceName); + return $contentRepository->projectionState(ChangeFinder::class)->countByContentStreamId($crWorkspace->currentContentStreamId); + } + + private function isChangePublishableWithinAncestorScope( ContentRepository $contentRepository, WorkspaceName $workspaceName, diff --git a/Neos.Neos/Classes/PendingChangesProjection/Change.php b/Neos.Neos/Classes/PendingChangesProjection/Change.php index 9473d7a9b93..acee1cda5e6 100644 --- a/Neos.Neos/Classes/PendingChangesProjection/Change.php +++ b/Neos.Neos/Classes/PendingChangesProjection/Change.php @@ -15,6 +15,7 @@ namespace Neos\Neos\PendingChangesProjection; use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Exception as DbalException; use Neos\ContentRepository\Core\DimensionSpace\OriginDimensionSpacePoint; use Neos\ContentRepository\Core\Feature\NodeRemoval\Command\RemoveNodeAggregate; use Neos\ContentRepository\Core\SharedModel\Node\NodeAggregateId; @@ -22,71 +23,26 @@ use Neos\Flow\Annotations as Flow; /** - * Change Read Model + * Read model for pending changes * - * !!! Still a bit unstable - might change in the future. + * @internal !!! Still a bit unstable - might change in the future. * @Flow\Proxy(false) */ -class Change +final class Change { /** - * @var ContentStreamId + * @param NodeAggregateId|null $removalAttachmentPoint {@see RemoveNodeAggregate::$removalAttachmentPoint} for docs */ - public $contentStreamId; - - /** - * @var NodeAggregateId - */ - public $nodeAggregateId; - - /** - * @var OriginDimensionSpacePoint - */ - public $originDimensionSpacePoint; - - /** - * @var bool - */ - public $created; - - /** - * @var bool - */ - public $changed; - - /** - * @var bool - */ - public $moved; - - /** - * @var bool - */ - public $deleted; - - /** - * {@see RemoveNodeAggregate::$removalAttachmentPoint} for docs - */ - public ?NodeAggregateId $removalAttachmentPoint; - public function __construct( - ContentStreamId $contentStreamId, - NodeAggregateId $nodeAggregateId, - OriginDimensionSpacePoint $originDimensionSpacePoint, - bool $created, - bool $changed, - bool $moved, - bool $deleted, - ?NodeAggregateId $removalAttachmentPoint = null + public ContentStreamId $contentStreamId, + public NodeAggregateId $nodeAggregateId, + public OriginDimensionSpacePoint $originDimensionSpacePoint, + public bool $created, + public bool $changed, + public bool $moved, + public bool $deleted, + public ?NodeAggregateId $removalAttachmentPoint = null ) { - $this->contentStreamId = $contentStreamId; - $this->nodeAggregateId = $nodeAggregateId; - $this->originDimensionSpacePoint = $originDimensionSpacePoint; - $this->created = $created; - $this->changed = $changed; - $this->moved = $moved; - $this->deleted = $deleted; - $this->removalAttachmentPoint = $removalAttachmentPoint; } @@ -95,37 +51,45 @@ public function __construct( */ public function addToDatabase(Connection $databaseConnection, string $tableName): void { - $databaseConnection->insert($tableName, [ - 'contentStreamId' => $this->contentStreamId->value, - 'nodeAggregateId' => $this->nodeAggregateId->value, - 'originDimensionSpacePoint' => $this->originDimensionSpacePoint->toJson(), - 'originDimensionSpacePointHash' => $this->originDimensionSpacePoint->hash, - 'created' => (int)$this->created, - 'changed' => (int)$this->changed, - 'moved' => (int)$this->moved, - 'deleted' => (int)$this->deleted, - 'removalAttachmentPoint' => $this->removalAttachmentPoint?->value - ]); - } - - public function updateToDatabase(Connection $databaseConnection, string $tableName): void - { - $databaseConnection->update( - $tableName, - [ + try { + $databaseConnection->insert($tableName, [ + 'contentStreamId' => $this->contentStreamId->value, + 'nodeAggregateId' => $this->nodeAggregateId->value, + 'originDimensionSpacePoint' => $this->originDimensionSpacePoint->toJson(), + 'originDimensionSpacePointHash' => $this->originDimensionSpacePoint->hash, 'created' => (int)$this->created, 'changed' => (int)$this->changed, 'moved' => (int)$this->moved, 'deleted' => (int)$this->deleted, 'removalAttachmentPoint' => $this->removalAttachmentPoint?->value - ], - [ - 'contentStreamId' => $this->contentStreamId->value, - 'nodeAggregateId' => $this->nodeAggregateId->value, - 'originDimensionSpacePoint' => $this->originDimensionSpacePoint->toJson(), - 'originDimensionSpacePointHash' => $this->originDimensionSpacePoint->hash, - ] - ); + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to insert Change to database: %s', $e->getMessage()), 1727272723, $e); + } + } + + public function updateToDatabase(Connection $databaseConnection, string $tableName): void + { + try { + $databaseConnection->update( + $tableName, + [ + 'created' => (int)$this->created, + 'changed' => (int)$this->changed, + 'moved' => (int)$this->moved, + 'deleted' => (int)$this->deleted, + 'removalAttachmentPoint' => $this->removalAttachmentPoint?->value + ], + [ + 'contentStreamId' => $this->contentStreamId->value, + 'nodeAggregateId' => $this->nodeAggregateId->value, + 'originDimensionSpacePoint' => $this->originDimensionSpacePoint->toJson(), + 'originDimensionSpacePointHash' => $this->originDimensionSpacePoint->hash, + ] + ); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to update Change in database: %s', $e->getMessage()), 1727272761, $e); + } } /** diff --git a/Neos.Neos/Classes/PendingChangesProjection/ChangeFinder.php b/Neos.Neos/Classes/PendingChangesProjection/ChangeFinder.php index 512eb585b29..f25e288f4e4 100644 --- a/Neos.Neos/Classes/PendingChangesProjection/ChangeFinder.php +++ b/Neos.Neos/Classes/PendingChangesProjection/ChangeFinder.php @@ -34,38 +34,30 @@ public function __construct( ) { } - /** - * @param ContentStreamId $contentStreamId - * @return array|Change[] - */ - public function findByContentStreamId(ContentStreamId $contentStreamId): array + public function findByContentStreamId(ContentStreamId $contentStreamId): Changes { $changeRows = $this->dbal->executeQuery( - ' - SELECT * FROM ' . $this->tableName . ' + <<tableName} WHERE contentStreamId = :contentStreamId - ', + SQL, [ 'contentStreamId' => $contentStreamId->value ] - )->fetchAll(); - $changes = []; - foreach ($changeRows as $changeRow) { - $changes[] = Change::fromDatabaseRow($changeRow); - } - return $changes; + )->fetchAllAssociative(); + return Changes::fromArray(array_map(Change::fromDatabaseRow(...), $changeRows)); } public function countByContentStreamId(ContentStreamId $contentStreamId): int { - return (int)$this->dbal->executeQuery( - ' - SELECT * FROM ' . $this->tableName . ' + return (int)$this->dbal->fetchOne( + <<tableName} WHERE contentStreamId = :contentStreamId - ', + SQL, [ 'contentStreamId' => $contentStreamId->value ] - )->rowCount(); + ); } } diff --git a/Neos.Neos/Classes/PendingChangesProjection/Changes.php b/Neos.Neos/Classes/PendingChangesProjection/Changes.php new file mode 100644 index 00000000000..0a7ab30e10d --- /dev/null +++ b/Neos.Neos/Classes/PendingChangesProjection/Changes.php @@ -0,0 +1,149 @@ + + */ +final readonly class Changes implements \IteratorAggregate, \Countable +{ + private const NODE_HAS_BEEN_CREATED = 0b0001; + private const NODE_HAS_BEEN_CHANGED = 0b0010; + private const NODE_HAS_BEEN_MOVED = 0b0100; + private const NODE_HAS_BEEN_DELETED = 0b1000; + + + /** + * @param list $changes + */ + private function __construct( + private array $changes + ) { + } + + public static function fromArray(array $changes): self + { + foreach ($changes as $change) { + if (!$change instanceof Change) { + throw new \InvalidArgumentException(sprintf('Changes can only consist of %s instances, given: %s', Change::class, get_debug_type($change)), 1727273148); + } + } + return new self($changes); + } + + /** + * @deprecated + * @return list + */ + public function toPublishableNodeInfo(ContentRepository $contentRepository, WorkspaceName $workspaceName): array + { + /** @var array{contextPath:string,documentContextPath:string,typeOfChange:int}[] $unpublishedNodes */ + $unpublishedNodes = []; + foreach ($this->changes as $change) { + if ($change->removalAttachmentPoint) { + $nodeAddress = new NodeAddress( + $change->contentStreamId, + $change->originDimensionSpacePoint->toDimensionSpacePoint(), + $change->nodeAggregateId, + $workspaceName + ); + + /** + * See {@see Remove::apply} -> Removal Attachment Point == closest document node. + */ + $documentNodeAddress = new NodeAddress( + $change->contentStreamId, + $change->originDimensionSpacePoint->toDimensionSpacePoint(), + $change->removalAttachmentPoint, + $workspaceName + ); + + $unpublishedNodes[] = [ + 'contextPath' => $nodeAddress->serializeForUri(), + 'documentContextPath' => $documentNodeAddress->serializeForUri(), + 'typeOfChange' => self::getTypeOfChange($change) + ]; + } else { + $subgraph = $contentRepository->getContentGraph($workspaceName)->getSubgraph( + $change->originDimensionSpacePoint->toDimensionSpacePoint(), + VisibilityConstraints::withoutRestrictions() + ); + $node = $subgraph->findNodeById($change->nodeAggregateId); + + if ($node instanceof Node) { + $documentNode = $subgraph->findClosestNode($node->aggregateId, FindClosestNodeFilter::create(nodeTypes: NodeTypeNameFactory::NAME_DOCUMENT)); + if ($documentNode instanceof Node) { + $nodeAddressFactory = NodeAddressFactory::create($contentRepository); + $unpublishedNodes[] = [ + 'contextPath' => $nodeAddressFactory->createFromNode($node)->serializeForUri(), + 'documentContextPath' => $nodeAddressFactory->createFromNode($documentNode) + ->serializeForUri(), + 'typeOfChange' => self::getTypeOfChange($change) + ]; + } + } + } + } + return array_values(array_filter($unpublishedNodes, function ($item) { + return (bool)$item; + })); + } + + private static function getTypeOfChange(Change $change): int + { + $result = 0; + if ($change->created) { + $result |= self::NODE_HAS_BEEN_CREATED; + } + if ($change->changed) { + $result |= self::NODE_HAS_BEEN_CHANGED; + } + if ($change->moved) { + $result |= self::NODE_HAS_BEEN_MOVED; + } + if ($change->deleted) { + $result |= self::NODE_HAS_BEEN_DELETED; + } + return $result; + } + + /** + * @return \Traversable + */ + public function getIterator(): \Traversable + { + yield from $this->changes; + } + + public function count(): int + { + return count($this->changes); + } +} From fd1a616604d1fc4c42729d46c13f2ab089d198c8 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 25 Sep 2024 18:00:36 +0200 Subject: [PATCH 13/43] Cosmetic tweaks to satisfy linter --- Neos.Neos/Classes/Domain/Service/WorkspaceService.php | 3 --- Neos.Neos/Classes/PendingChangesProjection/Changes.php | 3 +++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index dc72622188f..0767f57700c 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -324,9 +324,6 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } - /** - * @param array $userRoles - */ private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspaceRole { try { diff --git a/Neos.Neos/Classes/PendingChangesProjection/Changes.php b/Neos.Neos/Classes/PendingChangesProjection/Changes.php index 0a7ab30e10d..458c294cb7a 100644 --- a/Neos.Neos/Classes/PendingChangesProjection/Changes.php +++ b/Neos.Neos/Classes/PendingChangesProjection/Changes.php @@ -48,6 +48,9 @@ private function __construct( ) { } + /** + * @param list $changes + */ public static function fromArray(array $changes): self { foreach ($changes as $change) { From fe34b607e665d260c1dc52db1d831e6d8dd6602a Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 27 Sep 2024 10:31:47 +0200 Subject: [PATCH 14/43] Move owner assignment from role to metadata, fix migration --- .../MigrateEventsCommandController.php | 77 +++++++++++- .../Command/WorkspaceCommandController.php | 29 ----- .../Domain/Model/WorkspaceMetadata.php | 4 +- .../Domain/Model/WorkspacePermissions.php | 10 ++ .../Classes/Domain/Model/WorkspaceRole.php | 5 +- .../Domain/Model/WorkspaceSubjectType.php | 6 +- .../Domain/Service/WorkspaceService.php | 115 ++++++------------ .../Mysql/Version20240425223900.php | 2 + .../Postgresql/Version20240425223901.php | 2 + 9 files changed, 132 insertions(+), 118 deletions(-) diff --git a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php index 413290f86b7..d10486ba16d 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php +++ b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php @@ -1,22 +1,97 @@ contentRepositoryRegistry->get($contentRepositoryId); + + $workspaces = $contentRepositoryInstance->getWorkspaceFinder()->findAll(); + + if (count($workspaces) === 0) { + $this->outputLine('No workspaces found.'); + $this->quit(); + } + foreach ($workspaces as $workspace) { + try { + $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName); + } catch (\Exception $e) { + if ($workspace->baseWorkspaceName === null) { + $classification = WorkspaceClassification::ROOT; + } elseif ($workspace->isPersonalWorkspace()) { + $classification = WorkspaceClassification::PERSONAL; + } else { + $classification = WorkspaceClassification::SHARED; + } + $this->dbal->insert('neos_neos_workspace_metadata', [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspace->workspaceName->value, + 'title' => $workspace->workspaceTitle->value, + 'description' => $workspace->workspaceDescription->value, + 'classification' => $classification->value, + 'owner_user_id' => $workspace->isPersonalWorkspace() ? $workspace->workspaceOwner : null, + ]); + if ($workspace->workspaceName->isLive()) { + $this->dbal->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspace->workspaceName->value, + 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject' => 'Neos.Neos:LivePublisher', + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } elseif ($workspace->isInternalWorkspace()) { + $this->dbal->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspace->workspaceName->value, + 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject' => 'Neos.Neos:AbstractEditor', + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } elseif ($workspace->isPrivateWorkspace()) { + $this->dbal->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspace->workspaceName->value, + 'subject_type' => WorkspaceSubjectType::USER->value, + 'subject' => $workspace->workspaceOwner, + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } + $this->outputLine('Added metadata for workspace "%s"', [$workspace->workspaceName->value]); + } + } + $this->outputLine('Done.'); + } + /** * Migrates "propertyValues":{"tagName":{"value":null,"type":"string"}} to "propertiesToUnset":["tagName"] * diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 2cf14aaa8d3..32c5c44ef61 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -412,33 +412,4 @@ public function showCommand(string $workspace, string $contentRepository = 'defa $this->outputFormatted('Status: %s', [$workspacesInstance->status->value]); $this->outputFormatted('Content Stream: %s', [$workspacesInstance->currentContentStreamId->value]); } - - - /** - * Synchronizes metadata and role assignments of all workspaces for the specified Content Repository - * - * @param string $contentRepository The name of the content repository. (Default: 'default') - * @throws StopCommandException - */ - public function syncAllCommand(string $contentRepository = 'default'): void - { - $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); - - $workspaces = $contentRepositoryInstance->getWorkspaceFinder()->findAll(); - - if (count($workspaces) === 0) { - $this->outputLine('No workspaces found.'); - $this->quit(); - } - foreach ($workspaces as $workspace) { - try { - $this->workspaceService->synchronizeWorkspaceMetadataAndRoles($contentRepositoryId, $workspace->workspaceName); - $this->outputLine('Synchronized workspace "%s"', [$workspace->workspaceName->value]); - } catch (\Exception $exception) { - $this->outputLine('Failed to synchronize workspace "%s": %s', [$workspace->workspaceName->value, $exception->getMessage()]); - } - } - $this->outputLine('Done.'); - } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index d445b80a9f2..0f6e7932e59 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -18,6 +18,7 @@ public function __construct( public WorkspaceTitle $title, public WorkspaceDescription $description, public WorkspaceClassification $classification, + public UserId|null $ownerUserId, ) { } @@ -32,7 +33,8 @@ public function with( $this->workspaceName, $title ?? $this->title, $description ?? $this->description, - $this->classification + $this->classification, + $this->ownerUserId, ); } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php index 96ea78c4c4e..9b08db77ccf 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php @@ -26,4 +26,14 @@ public static function create( ): self { return new self($read, $write, $manage); } + + public static function all(): self + { + return new self(true, true, true); + } + + public static function none(): self + { + return new self(false, false, false); + } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index 0e41a8c643e..dcb444599fc 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -6,15 +6,14 @@ /** * Role, a user can have in one workspace + * Note: "Owner" is not a role, owners implicitly always have all permissions * * @api */ enum WorkspaceRole : string { - case NONE = 'NONE'; case COLLABORATOR = 'COLLABORATOR'; case MANAGER = 'MANAGER'; - case OWNER = 'OWNER'; public function isAtLeast(self $role): bool { @@ -24,10 +23,8 @@ public function isAtLeast(self $role): bool private function specifity(): int { return match ($this) { - self::NONE => 0, self::COLLABORATOR => 1, self::MANAGER => 2, - self::OWNER => 3, }; } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php b/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php index ba05191d4d9..09334960f63 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php @@ -7,8 +7,8 @@ /** * @api */ -enum WorkspaceSubjectType +enum WorkspaceSubjectType : string { - case USER; - case GROUP; + case USER = 'USER'; + case GROUP = 'GROUP'; } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 0767f57700c..097b006ee23 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -14,6 +14,7 @@ namespace Neos\Neos\Domain\Service; +use Doctrine\DBAL\ArrayParameterType; use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception as DbalException; use Neos\ContentRepository\Core\ContentRepository; @@ -79,32 +80,6 @@ public function updateWorkspaceTitleAndDescription(ContentRepositoryId $contentR ]); } - /** - * Add missing metadata and owner role assignments for the specified workspace - * - * Note: This is mainly needed in order to migrate existing installations or fix the state if it was corrupted - */ - public function synchronizeWorkspaceMetadataAndRoles(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): void - { - $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); - if ($workspace->baseWorkspaceName === null) { - $classification = WorkspaceClassification::ROOT; - } elseif ($workspace->workspaceOwner !== null && str_starts_with($workspaceName->value, 'user-')) { - $classification = WorkspaceClassification::PERSONAL; - } else { - $classification = WorkspaceClassification::SHARED; - } - - $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); - if ($metadata === null) { - $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, WorkspaceTitle::fromString($workspace->workspaceTitle->value), WorkspaceDescription::fromString($workspace->workspaceDescription->value), $classification); - } - - if ($workspace->workspaceOwner !== null) { - $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $workspace->workspaceOwner, WorkspaceRole::OWNER); - } - } - /** * Retrieve the currently active personal workspace for the specified $userId * @@ -134,7 +109,7 @@ public function createRootWorkspace(ContentRepositoryId $contentRepositoryId, Wo ContentStreamId::create() ) ); - $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, WorkspaceClassification::ROOT); + $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, WorkspaceClassification::ROOT, null); return $workspaceName; } @@ -174,22 +149,27 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con } /** - * + * Determines the permission the given user has for the specified workspace {@see WorkspacePermissions} */ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions { - if ($this->userService->currentUserIsAdministrator()) { - return WorkspacePermissions::create( - read: true, - write: true, - manage: true, - ); + $userIsAdministrator = $this->userService->currentUserIsAdministrator(); + $workspaceMetadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); + if ($workspaceMetadata === null) { + return WorkspacePermissions::create(false, false, $userIsAdministrator); } + if ($workspaceMetadata->ownerUserId !== null && $workspaceMetadata->ownerUserId->equals($user->getId())) { + return WorkspacePermissions::all(); + } + $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user); + if ($userWorkspaceRole === null) { + return WorkspacePermissions::create(false, false, $userIsAdministrator); + } return WorkspacePermissions::create( read: $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), write: $userWorkspaceRole->isAtLeast(WorkspaceRole::COLLABORATOR), - manage: $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), + manage: $userIsAdministrator || $userWorkspaceRole->isAtLeast(WorkspaceRole::MANAGER), ); } @@ -221,11 +201,13 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, assert(is_string($metadataRow['title'])); assert(is_string($metadataRow['description'])); assert(is_string($metadataRow['classification'])); + assert(is_null($metadataRow['owner_user_id']) || is_string($metadataRow['owner_user_id'])); return new WorkspaceMetadata( $workspaceName, WorkspaceTitle::fromString($metadataRow['title']), WorkspaceDescription::fromString($metadataRow['description']), - WorkspaceClassification::from($metadataRow['classification']) + WorkspaceClassification::from($metadataRow['classification']), + $metadataRow['owner_user_id'] !== null ? UserId::fromString($metadataRow['owner_user_id']) : null, ); } @@ -257,29 +239,11 @@ private function createWorkspace(ContentRepositoryId $contentRepositoryId, Works ContentStreamId::create() ) ); - if ($ownerId !== null) { - $this->addWorkspaceRole($contentRepositoryId, $workspaceName, WorkspaceSubjectType::USER, $ownerId->value, WorkspaceRole::OWNER); - } - $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, $classification); + $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, $classification, $ownerId); return $workspaceName; } - private function addWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceSubjectType $subjectType, string $subject, WorkspaceRole $role): void - { - try { - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => $subjectType->name, - 'subject' => $subject, - 'role' => $role->name, - ]); - } catch (DbalException $e) { - throw new \RuntimeException(sprintf('Failed to add role for subject "%s" in workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject, $contentRepositoryId->value, $e->getMessage()), 1727083752, $e); - } - } - - private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceClassification $classification): void + private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceClassification $classification, UserId|null $ownerUserId): void { try { $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ @@ -288,6 +252,7 @@ private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, 'title' => $title->value, 'description' => $description->value, 'classification' => $classification->name, + 'owner_user_id' => $ownerUserId?->value, ]); } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to add metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1727084068, $e); @@ -296,47 +261,38 @@ private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRepositoryId, UserId $userId): ?WorkspaceName { - $tableRole = self::TABLE_NAME_WORKSPACE_ROLE; $tableMetadata = self::TABLE_NAME_WORKSPACE_METADATA; $query = <<dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, - 'subject' => $userId->value, - 'subjectType' => WorkspaceSubjectType::USER->name, - 'ownerRole' => WorkspaceRole::OWNER->name, - 'classification' => WorkspaceClassification::PERSONAL->name, + 'personalWorkspaceClassification' => WorkspaceClassification::PERSONAL->name, + 'userId' => $userId->value, ]); return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } - private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspaceRole + private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): ?WorkspaceRole { try { $userRoles = array_keys($this->userService->getAllRoles($user)); } catch (NoSuchRoleException $e) { throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); } - $table = self::TABLE_NAME_WORKSPACE_ROLE; + $tableRole = self::TABLE_NAME_WORKSPACE_ROLE; $query = << WorkspaceSubjectType::GROUP->name, 'groupSubjects' => $userRoles, ], [ - 'groupSubjects' => Connection::PARAM_STR_ARRAY, + 'groupSubjects' => ArrayParameterType::STRING, ]); if ($role === false) { - return WorkspaceRole::NONE; + return null; } return WorkspaceRole::from($role); } diff --git a/Neos.Neos/Migrations/Mysql/Version20240425223900.php b/Neos.Neos/Migrations/Mysql/Version20240425223900.php index 3438212364a..69bd0305bcd 100644 --- a/Neos.Neos/Migrations/Mysql/Version20240425223900.php +++ b/Neos.Neos/Migrations/Mysql/Version20240425223900.php @@ -27,7 +27,9 @@ public function up(Schema $schema): void $tableWorkspaceMetadata->addColumn('title', 'string', ['length' => 255]); $tableWorkspaceMetadata->addColumn('description', 'text'); $tableWorkspaceMetadata->addColumn('classification', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('owner_user_id', 'string', ['length' => 255, 'notnull' => false]); $tableWorkspaceMetadata->setPrimaryKey(['content_repository_id', 'workspace_name']); + $tableWorkspaceMetadata->addIndex(['owner_user_id']); $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); diff --git a/Neos.Neos/Migrations/Postgresql/Version20240425223901.php b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php index 5218bf5bcd9..b370bd7b9d1 100644 --- a/Neos.Neos/Migrations/Postgresql/Version20240425223901.php +++ b/Neos.Neos/Migrations/Postgresql/Version20240425223901.php @@ -24,7 +24,9 @@ public function up(Schema $schema): void $tableWorkspaceMetadata->addColumn('title', 'string', ['length' => 255]); $tableWorkspaceMetadata->addColumn('description', 'text'); $tableWorkspaceMetadata->addColumn('classification', 'string', ['length' => 255]); + $tableWorkspaceMetadata->addColumn('owner_user_id', 'string', ['length' => 255, 'notnull' => false]); $tableWorkspaceMetadata->setPrimaryKey(['content_repository_id', 'workspace_name']); + $tableWorkspaceMetadata->addIndex(['owner_user_id']); $tableWorkspaceRole = $schema->createTable('neos_neos_workspace_role'); $tableWorkspaceRole->addColumn('content_repository_id', 'string', ['length' => 16]); From 96c427b41a3a4ab23d64d94032c574d56bee4610 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 27 Sep 2024 10:44:47 +0200 Subject: [PATCH 15/43] Remove UI specific publishable node info array from `Changes` VO --- .../PendingChangesProjection/Changes.php | 91 ------------------- 1 file changed, 91 deletions(-) diff --git a/Neos.Neos/Classes/PendingChangesProjection/Changes.php b/Neos.Neos/Classes/PendingChangesProjection/Changes.php index 458c294cb7a..956e9e37210 100644 --- a/Neos.Neos/Classes/PendingChangesProjection/Changes.php +++ b/Neos.Neos/Classes/PendingChangesProjection/Changes.php @@ -14,16 +14,7 @@ namespace Neos\Neos\PendingChangesProjection; -use Neos\ContentRepository\Core\ContentRepository; -use Neos\ContentRepository\Core\Projection\ContentGraph\Filter\FindClosestNodeFilter; -use Neos\ContentRepository\Core\Projection\ContentGraph\Node; -use Neos\ContentRepository\Core\Projection\ContentGraph\VisibilityConstraints; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; -use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; -use Neos\Neos\Domain\Service\NodeTypeNameFactory; -use Neos\Neos\FrontendRouting\NodeAddress; -use Neos\Neos\FrontendRouting\NodeAddressFactory; /** * Read model for a set of pending changes @@ -34,12 +25,6 @@ */ final readonly class Changes implements \IteratorAggregate, \Countable { - private const NODE_HAS_BEEN_CREATED = 0b0001; - private const NODE_HAS_BEEN_CHANGED = 0b0010; - private const NODE_HAS_BEEN_MOVED = 0b0100; - private const NODE_HAS_BEEN_DELETED = 0b1000; - - /** * @param list $changes */ @@ -61,82 +46,6 @@ public static function fromArray(array $changes): self return new self($changes); } - /** - * @deprecated - * @return list - */ - public function toPublishableNodeInfo(ContentRepository $contentRepository, WorkspaceName $workspaceName): array - { - /** @var array{contextPath:string,documentContextPath:string,typeOfChange:int}[] $unpublishedNodes */ - $unpublishedNodes = []; - foreach ($this->changes as $change) { - if ($change->removalAttachmentPoint) { - $nodeAddress = new NodeAddress( - $change->contentStreamId, - $change->originDimensionSpacePoint->toDimensionSpacePoint(), - $change->nodeAggregateId, - $workspaceName - ); - - /** - * See {@see Remove::apply} -> Removal Attachment Point == closest document node. - */ - $documentNodeAddress = new NodeAddress( - $change->contentStreamId, - $change->originDimensionSpacePoint->toDimensionSpacePoint(), - $change->removalAttachmentPoint, - $workspaceName - ); - - $unpublishedNodes[] = [ - 'contextPath' => $nodeAddress->serializeForUri(), - 'documentContextPath' => $documentNodeAddress->serializeForUri(), - 'typeOfChange' => self::getTypeOfChange($change) - ]; - } else { - $subgraph = $contentRepository->getContentGraph($workspaceName)->getSubgraph( - $change->originDimensionSpacePoint->toDimensionSpacePoint(), - VisibilityConstraints::withoutRestrictions() - ); - $node = $subgraph->findNodeById($change->nodeAggregateId); - - if ($node instanceof Node) { - $documentNode = $subgraph->findClosestNode($node->aggregateId, FindClosestNodeFilter::create(nodeTypes: NodeTypeNameFactory::NAME_DOCUMENT)); - if ($documentNode instanceof Node) { - $nodeAddressFactory = NodeAddressFactory::create($contentRepository); - $unpublishedNodes[] = [ - 'contextPath' => $nodeAddressFactory->createFromNode($node)->serializeForUri(), - 'documentContextPath' => $nodeAddressFactory->createFromNode($documentNode) - ->serializeForUri(), - 'typeOfChange' => self::getTypeOfChange($change) - ]; - } - } - } - } - return array_values(array_filter($unpublishedNodes, function ($item) { - return (bool)$item; - })); - } - - private static function getTypeOfChange(Change $change): int - { - $result = 0; - if ($change->created) { - $result |= self::NODE_HAS_BEEN_CREATED; - } - if ($change->changed) { - $result |= self::NODE_HAS_BEEN_CHANGED; - } - if ($change->moved) { - $result |= self::NODE_HAS_BEEN_MOVED; - } - if ($change->deleted) { - $result |= self::NODE_HAS_BEEN_DELETED; - } - return $result; - } - /** * @return \Traversable */ From c3f51e2e0c37706b2935fde28ffbaaec6be59b3b Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 27 Sep 2024 10:56:33 +0200 Subject: [PATCH 16/43] Make `WorkspaceNameBuilder` obsolete and remove it --- .../Classes/Controller/UsageController.php | 12 ++++- .../Domain/Service/WorkspaceNameBuilder.php | 35 -------------- Neos.Neos/Classes/Service/UserService.php | 29 ----------- Neos.Neos/Classes/Utility/User.php | 13 ++++- .../Tests/Unit/Service/UserServiceTest.php | 48 ------------------- .../Controller/WorkspaceController.php | 9 ++-- 6 files changed, 24 insertions(+), 122 deletions(-) delete mode 100644 Neos.Neos/Classes/Domain/Service/WorkspaceNameBuilder.php diff --git a/Neos.Media.Browser/Classes/Controller/UsageController.php b/Neos.Media.Browser/Classes/Controller/UsageController.php index b3f65a5b53c..17baf481e21 100644 --- a/Neos.Media.Browser/Classes/Controller/UsageController.php +++ b/Neos.Media.Browser/Classes/Controller/UsageController.php @@ -23,6 +23,7 @@ use Neos\Media\Domain\Service\AssetService; use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; +use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\FrontendRouting\SiteDetection\SiteDetectionResult; use Neos\Neos\Service\UserService; use Neos\Neos\Domain\Service\UserService as DomainUserService; @@ -60,6 +61,12 @@ class UsageController extends ActionController */ protected $contentRepositoryRegistry; + /** + * @Flow\Inject + * @var WorkspaceService + */ + protected $workspaceService; + /** * @Flow\Inject * @var DomainUserService @@ -76,8 +83,9 @@ public function relatedNodesAction(AssetInterface $asset) { $currentContentRepositoryId = SiteDetectionResult::fromRequest($this->request->getHttpRequest())->contentRepositoryId; $currentContentRepository = $this->contentRepositoryRegistry->get($currentContentRepositoryId); - $userWorkspaceName = WorkspaceName::fromString($this->userService->getPersonalWorkspaceName()); - $userWorkspace = $currentContentRepository->getWorkspaceFinder()->findOneByName($userWorkspaceName); + $userId = $this->userService->getBackendUser()?->getId(); + assert($userId !== null); + $userWorkspace = $this->workspaceService->getPersonalWorkspaceForUser($currentContentRepositoryId, $userId); $usageReferences = $this->assetService->getUsageReferences($asset); $relatedNodes = []; diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceNameBuilder.php b/Neos.Neos/Classes/Domain/Service/WorkspaceNameBuilder.php deleted file mode 100644 index fc08f99cb26..00000000000 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceNameBuilder.php +++ /dev/null @@ -1,35 +0,0 @@ -userDomainService->getCurrentUser(); } - /** - * Returns the name of the currently logged in user's personal workspace - * (even if that might not exist at that time). - * If no user is logged in this method returns null. - * - * @api - */ - public function getPersonalWorkspaceName(): ?string - { - $currentUser = $this->userDomainService->getCurrentUser(); - - if (!$currentUser instanceof User) { - return null; - } - /** @var ?Account $currentAccount */ - $currentAccount = $this->securityContext->getAccount(); - if ($currentAccount === null) { - return null; - } - - $username = $this->userDomainService->getUsername( - $currentUser, - $currentAccount->getAuthenticationProviderName() - ); - return ($username === null ? null : UserUtility::getPersonalWorkspaceNameForUsername($username)); - } - /** * Returns the stored preferences of a user * diff --git a/Neos.Neos/Classes/Utility/User.php b/Neos.Neos/Classes/Utility/User.php index 5275452f696..dcc502fcd14 100644 --- a/Neos.Neos/Classes/Utility/User.php +++ b/Neos.Neos/Classes/Utility/User.php @@ -4,7 +4,9 @@ namespace Neos\Neos\Utility; +use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\Neos\Domain\Service\WorkspaceNameBuilder; +use Neos\Neos\Domain\Service\WorkspaceService; /** * Utility functions for dealing with users in the Content Repository. @@ -16,13 +18,20 @@ class User /** * Constructs a personal workspace name for the user with the given username. * - * @deprecated with Neos 9.0 please use {@see WorkspaceNameBuilder::fromAccountIdentifier} instead. + * @deprecated with Neos 9.0 please use {@see WorkspaceService::createPersonalWorkspaceForUserIfMissing()} instead. * @param string $username * @return string */ public static function getPersonalWorkspaceNameForUsername($username): string { - return WorkspaceNameBuilder::fromAccountIdentifier($username)->value; + $name = preg_replace('/[^A-Za-z0-9\-]/', '-', 'user-' . $username); + if (is_null($name)) { + throw new \InvalidArgumentException( + 'Cannot convert account identifier ' . $username . ' to workspace name.', + 1645656253 + ); + } + return WorkspaceName::transliterateFromString($name)->value; } /** diff --git a/Neos.Neos/Tests/Unit/Service/UserServiceTest.php b/Neos.Neos/Tests/Unit/Service/UserServiceTest.php index faeaa5fe8a0..fbbbe57c25e 100644 --- a/Neos.Neos/Tests/Unit/Service/UserServiceTest.php +++ b/Neos.Neos/Tests/Unit/Service/UserServiceTest.php @@ -118,54 +118,6 @@ public function getBackendUserReturnsTheCurrentlyLoggedInUser() self::assertSame($mockUser, $this->userService->getBackendUser()); } - /** - * @test - */ - public function getPersonalWorkspaceReturnsNullIfNoUserIsLoggedIn() - { - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getCurrentUser')->will(self::returnValue(null)); - self::assertNull($this->userService->getPersonalWorkspace()); - } - - /** - * @test - */ - public function getPersonalWorkspaceReturnsTheUsersWorkspaceIfAUserIsLoggedIn() - { - $mockUser = $this->getMockBuilder(User::class)->disableOriginalConstructor()->getMock(); - $mockUserWorkspace = $this->getMockBuilder(Workspace::class)->disableOriginalConstructor()->getMock(); - $mockAccount = $this->getMockBuilder(Account::class)->disableOriginalConstructor()->getMock(); - - $this->mockSecurityContext->expects(self::atLeastOnce())->method('getAccount')->will(self::returnValue($mockAccount)); - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getCurrentUser')->will(self::returnValue($mockUser)); - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getUserName')->with($mockUser)->will(self::returnValue('TheUserName')); - $this->mockWorkspaceRepository->expects(self::atLeastOnce())->method('findOneByName')->with('user-TheUserName')->will(self::returnValue($mockUserWorkspace)); - self::assertSame($mockUserWorkspace, $this->userService->getPersonalWorkspace()); - } - - /** - * @test - */ - public function getPersonalWorkspaceNameReturnsNullIfNoUserIsLoggedIn() - { - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getCurrentUser')->will(self::returnValue(null)); - self::assertNull($this->userService->getPersonalWorkspaceName()); - } - - /** - * @test - */ - public function getPersonalWorkspaceNameReturnsTheUsersWorkspaceNameIfAUserIsLoggedIn() - { - $mockUser = $this->getMockBuilder(User::class)->disableOriginalConstructor()->getMock(); - $mockAccount = $this->getMockBuilder(Account::class)->disableOriginalConstructor()->getMock(); - - $this->mockSecurityContext->expects(self::atLeastOnce())->method('getAccount')->will(self::returnValue($mockAccount)); - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getCurrentUser')->will(self::returnValue($mockUser)); - $this->mockUserDomainService->expects(self::atLeastOnce())->method('getUserName')->with($mockUser)->will(self::returnValue('TheUserName')); - self::assertSame('user-TheUserName', $this->userService->getPersonalWorkspaceName()); - } - /** * @test */ diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index a059b140eb1..6e8805ee927 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -413,14 +413,11 @@ public function rebaseAndRedirectAction(string $targetNode, Workspace $targetWor // todo legacy uri node address notation used. Should be refactored to use json encoded NodeAddress $targetNodeAddress = NodeAddressFactory::create($contentRepository)->createCoreNodeAddressFromLegacyUriString($targetNode); - /** @var ?Account $currentAccount */ - $currentAccount = $this->securityContext->getAccount(); - if ($currentAccount === null) { + $user = $this->userService->getCurrentUser(); + if ($user === null) { throw new \RuntimeException('No account is authenticated', 1710068880); } - $personalWorkspaceName = WorkspaceNameBuilder::fromAccountIdentifier($currentAccount->getAccountIdentifier()); - /** @var Workspace $personalWorkspace */ - $personalWorkspace = $contentRepository->getWorkspaceFinder()->findOneByName($personalWorkspaceName); + $personalWorkspace = $this->workspaceService->getPersonalWorkspaceForUser($contentRepositoryId, $user->getId()); /** @todo do something else * if ($personalWorkspace !== $targetWorkspace) { From 732b81a95d425a446a752f9e64ba24418201cc74 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Fri, 27 Sep 2024 11:00:40 +0200 Subject: [PATCH 17/43] Remove workspace related left-overs from `UserService` --- .../Classes/Domain/Service/UserService.php | 25 ------------------- 1 file changed, 25 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/UserService.php b/Neos.Neos/Classes/Domain/Service/UserService.php index 953ca46ebdc..8ad74db35ec 100644 --- a/Neos.Neos/Classes/Domain/Service/UserService.php +++ b/Neos.Neos/Classes/Domain/Service/UserService.php @@ -371,8 +371,6 @@ public function deleteUser(User $user) $this->accountRepository->remove($account); } - $this->removeOwnerFromUsersWorkspaces($user); - $this->partyRepository->remove($user); $this->emitUserDeleted($user); } @@ -792,29 +790,6 @@ private function destroyActiveSessionsForUser(User $user, bool $keepCurrentSessi } } - /** - * Removes all personal workspaces of the given user's account if these workspaces exist. Also removes - * all possibly existing content of these workspaces. - * - * @param string $accountIdentifier Identifier of the user's account - * @return void - */ - protected function deletePersonalWorkspace($accountIdentifier) - { - // TODO - } - - /** - * Removes ownership of all workspaces currently owned by the given user - * - * @param User $user The user currently owning workspaces - * @return void - */ - protected function removeOwnerFromUsersWorkspaces(User $user) - { - // TODO - } - /** * @param string $username * @param string $authenticationProviderName From 8f87ddf10d5660d55e8bbfb91875594c7e1a5ae2 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Mon, 30 Sep 2024 15:58:58 +0200 Subject: [PATCH 18/43] Make `Utility\User` class obsolete and remove it --- Neos.Neos/Classes/Utility/User.php | 48 ------------------- .../Mysql/Version20151223125909.php | 3 +- .../Mysql/Version20160104121311.php | 3 +- .../Postgresql/Version20151223125946.php | 3 +- .../Postgresql/Version20160104121413.php | 3 +- .../Controller/WorkspaceController.php | 1 - 6 files changed, 4 insertions(+), 57 deletions(-) delete mode 100644 Neos.Neos/Classes/Utility/User.php diff --git a/Neos.Neos/Classes/Utility/User.php b/Neos.Neos/Classes/Utility/User.php deleted file mode 100644 index dcc502fcd14..00000000000 --- a/Neos.Neos/Classes/Utility/User.php +++ /dev/null @@ -1,48 +0,0 @@ -value; - } - - /** - * Will reduce the username to ascii alphabet and numbers. - * - * @deprecated with Neos 9.0 please implement your own slug genration. You might also want to look into transliteration with {@see \Behat\Transliterator\Transliterator}. - * @param string $username - * @return string - */ - public static function slugifyUsername($username): string - { - return preg_replace('/[^a-z0-9]/i', '', $username) ?: ''; - } -} diff --git a/Neos.Neos/Migrations/Mysql/Version20151223125909.php b/Neos.Neos/Migrations/Mysql/Version20151223125909.php index 3e7b2c61bfc..b7b9fddc70f 100644 --- a/Neos.Neos/Migrations/Mysql/Version20151223125909.php +++ b/Neos.Neos/Migrations/Mysql/Version20151223125909.php @@ -5,7 +5,6 @@ use Doctrine\DBAL\Platforms\AbstractMySQLPlatform; use Doctrine\DBAL\Schema\Schema; use Doctrine\Migrations\AbstractMigration; -use Neos\Neos\Utility\User as UserUtility; use PDO; /** @@ -34,7 +33,7 @@ public function up(Schema $schema): void $neosAccountQuery = $this->connection->executeQuery('SELECT t0.party_abstractparty, t1.accountidentifier FROM typo3_party_domain_model_abstractparty_accounts_join t0 JOIN typo3_flow_security_account t1 ON t0.flow_security_account = t1.persistence_object_identifier WHERE t1.authenticationprovidername = \'Typo3BackendProvider\''); while ($account = $neosAccountQuery->fetch(PDO::FETCH_ASSOC)) { - $normalizedUsername = UserUtility::slugifyUsername($account['accountidentifier']); + $normalizedUsername = preg_replace('/[^a-z0-9]/i', '', $account['accountidentifier']) ?: ''; foreach ($workspacesWithoutOwner as $workspaceWithoutOwner) { if ($workspaceWithoutOwner['name'] === 'user-' . $normalizedUsername) { diff --git a/Neos.Neos/Migrations/Mysql/Version20160104121311.php b/Neos.Neos/Migrations/Mysql/Version20160104121311.php index d18a45b32b6..6075ad206f2 100644 --- a/Neos.Neos/Migrations/Mysql/Version20160104121311.php +++ b/Neos.Neos/Migrations/Mysql/Version20160104121311.php @@ -5,7 +5,6 @@ use Doctrine\DBAL\Platforms\AbstractMySQLPlatform; use Doctrine\DBAL\Schema\Schema; use Doctrine\Migrations\AbstractMigration; -use Neos\Neos\Utility\User as UserUtility; use PDO; /** @@ -34,7 +33,7 @@ public function up(Schema $schema): void $neosAccountQuery = $this->connection->executeQuery('SELECT t0.party_abstractparty, t1.accountidentifier FROM typo3_party_domain_model_abstractparty_accounts_join t0 JOIN typo3_flow_security_account t1 ON t0.flow_security_account = t1.persistence_object_identifier WHERE t1.authenticationprovidername = \'Typo3BackendProvider\''); while ($account = $neosAccountQuery->fetch(PDO::FETCH_ASSOC)) { - $normalizedUsername = UserUtility::slugifyUsername($account['accountidentifier']); + $normalizedUsername = preg_replace('/[^a-z0-9]/i', '', $account['accountidentifier']) ?: ''; foreach ($workspacesWithoutOwner as $workspaceWithoutOwner) { if ($workspaceWithoutOwner['name'] === 'user-' . $normalizedUsername) { diff --git a/Neos.Neos/Migrations/Postgresql/Version20151223125946.php b/Neos.Neos/Migrations/Postgresql/Version20151223125946.php index 99321c107ec..4b0d4d0ccdc 100644 --- a/Neos.Neos/Migrations/Postgresql/Version20151223125946.php +++ b/Neos.Neos/Migrations/Postgresql/Version20151223125946.php @@ -5,7 +5,6 @@ use Doctrine\DBAL\Platforms\PostgreSQLPlatform; use Doctrine\DBAL\Schema\Schema; use Doctrine\Migrations\AbstractMigration; -use Neos\Neos\Utility\User as UserUtility; use PDO; /** @@ -34,7 +33,7 @@ public function up(Schema $schema): void $neosAccountQuery = $this->connection->executeQuery('SELECT t0.party_abstractparty, t1.accountidentifier FROM typo3_party_domain_model_abstractparty_accounts_join t0 JOIN typo3_flow_security_account t1 ON t0.flow_security_account = t1.persistence_object_identifier WHERE t1.authenticationprovidername = \'Typo3BackendProvider\''); while ($account = $neosAccountQuery->fetch(PDO::FETCH_ASSOC)) { - $normalizedUsername = UserUtility::slugifyUsername($account['accountidentifier']); + $normalizedUsername = preg_replace('/[^a-z0-9]/i', '', $account['accountidentifier']) ?: ''; foreach ($workspacesWithoutOwner as $workspaceWithoutOwner) { if ($workspaceWithoutOwner['name'] === 'user-' . $normalizedUsername) { diff --git a/Neos.Neos/Migrations/Postgresql/Version20160104121413.php b/Neos.Neos/Migrations/Postgresql/Version20160104121413.php index 16f6585f454..f531511bf00 100644 --- a/Neos.Neos/Migrations/Postgresql/Version20160104121413.php +++ b/Neos.Neos/Migrations/Postgresql/Version20160104121413.php @@ -5,7 +5,6 @@ use Doctrine\DBAL\Platforms\PostgreSQLPlatform; use Doctrine\DBAL\Schema\Schema; use Doctrine\Migrations\AbstractMigration; -use Neos\Neos\Utility\User as UserUtility; use PDO; /** @@ -34,7 +33,7 @@ public function up(Schema $schema): void $neosAccountQuery = $this->connection->executeQuery('SELECT t0.party_abstractparty, t1.accountidentifier FROM typo3_party_domain_model_abstractparty_accounts_join t0 JOIN typo3_flow_security_account t1 ON t0.flow_security_account = t1.persistence_object_identifier WHERE t1.authenticationprovidername = \'Typo3BackendProvider\''); while ($account = $neosAccountQuery->fetch(PDO::FETCH_ASSOC)) { - $normalizedUsername = UserUtility::slugifyUsername($account['accountidentifier']); + $normalizedUsername = preg_replace('/[^a-z0-9]/i', '', $account['accountidentifier']) ?: ''; foreach ($workspacesWithoutOwner as $workspaceWithoutOwner) { if ($workspaceWithoutOwner['name'] === 'user-' . $normalizedUsername) { diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 6e8805ee927..f07732d5d96 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -59,7 +59,6 @@ use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; use Neos\Neos\Domain\Service\UserService; -use Neos\Neos\Domain\Service\WorkspaceNameBuilder; use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\Domain\Service\WorkspaceService; use Neos\Neos\FrontendRouting\NodeAddress as LegacyNodeAddress; From cbe3ba501990b523aaae839046521a01ed6952dc Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Mon, 30 Sep 2024 15:59:27 +0200 Subject: [PATCH 19/43] Rework migration to work on the database table directly --- .../MigrateEventsCommandController.php | 45 ++++++++++++------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php index d10486ba16d..e7bfdc04bae 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php +++ b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php @@ -6,6 +6,7 @@ use Doctrine\DBAL\Connection; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; +use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\ContentRepositoryRegistry\Service\EventMigrationServiceFactory; use Neos\Flow\Cli\CommandController; @@ -42,51 +43,63 @@ public function workspacesCommand(string $contentRepository = 'default'): void $this->outputLine('No workspaces found.'); $this->quit(); } - foreach ($workspaces as $workspace) { + + $workspaceTableName = "cr_{$contentRepositoryId->value}_p_workspace"; + + $workspaceRows = $this->dbal->fetchAllAssociative(<<value, 'user-'); + $isPrivateWorkspace = $workspaceOwner !== null && !$isPersonalWorkspace; + $isInternalWorkspace = $baseWorkspaceName !== null && $workspaceOwner === null; try { - $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspace->workspaceName); + $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName); } catch (\Exception $e) { - if ($workspace->baseWorkspaceName === null) { + if ($baseWorkspaceName === null) { $classification = WorkspaceClassification::ROOT; - } elseif ($workspace->isPersonalWorkspace()) { + } elseif ($isPersonalWorkspace) { $classification = WorkspaceClassification::PERSONAL; } else { $classification = WorkspaceClassification::SHARED; } $this->dbal->insert('neos_neos_workspace_metadata', [ 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspace->workspaceName->value, - 'title' => $workspace->workspaceTitle->value, - 'description' => $workspace->workspaceDescription->value, + 'workspace_name' => $workspaceName->value, + 'title' => $workspaceRow['workspacetitle'] ?? '', + 'description' => $workspaceRow['workspacedescription'] ?? '', 'classification' => $classification->value, - 'owner_user_id' => $workspace->isPersonalWorkspace() ? $workspace->workspaceOwner : null, + 'owner_user_id' => $isPersonalWorkspace ? $workspaceOwner : null, ]); - if ($workspace->workspaceName->isLive()) { + if ($workspaceName->isLive()) { $this->dbal->insert('neos_neos_workspace_role', [ 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspace->workspaceName->value, + 'workspace_name' => $workspaceName->value, 'subject_type' => WorkspaceSubjectType::GROUP->value, 'subject' => 'Neos.Neos:LivePublisher', 'role' => WorkspaceRole::COLLABORATOR->value, ]); - } elseif ($workspace->isInternalWorkspace()) { + } elseif ($isInternalWorkspace) { $this->dbal->insert('neos_neos_workspace_role', [ 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspace->workspaceName->value, + 'workspace_name' => $workspaceName->value, 'subject_type' => WorkspaceSubjectType::GROUP->value, 'subject' => 'Neos.Neos:AbstractEditor', 'role' => WorkspaceRole::COLLABORATOR->value, ]); - } elseif ($workspace->isPrivateWorkspace()) { + } elseif ($isPrivateWorkspace) { $this->dbal->insert('neos_neos_workspace_role', [ 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspace->workspaceName->value, + 'workspace_name' => $workspaceName->value, 'subject_type' => WorkspaceSubjectType::USER->value, - 'subject' => $workspace->workspaceOwner, + 'subject' => $workspaceOwner, 'role' => WorkspaceRole::COLLABORATOR->value, ]); } - $this->outputLine('Added metadata for workspace "%s"', [$workspace->workspaceName->value]); + $this->outputLine('Added metadata for workspace "%s"', [$workspaceName->value]); } } $this->outputLine('Done.'); From 22d8d3a4f3eea1c315a06d6072ffdb72ecb8c309 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Mon, 30 Sep 2024 18:05:53 +0200 Subject: [PATCH 20/43] TASK: Make migration more stable by not relying on the projection but calculating the state via events --- .../MigrateEventsCommandController.php | 87 +-------- .../Classes/Service/EventMigrationService.php | 170 ++++++++++++++++++ .../Service/EventMigrationServiceFactory.php | 5 +- 3 files changed, 182 insertions(+), 80 deletions(-) diff --git a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php index e7bfdc04bae..c0401b67d1c 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php +++ b/Neos.ContentRepositoryRegistry/Classes/Command/MigrateEventsCommandController.php @@ -4,24 +4,16 @@ namespace Neos\ContentRepositoryRegistry\Command; -use Doctrine\DBAL\Connection; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\ContentRepositoryRegistry\Service\EventMigrationServiceFactory; use Neos\Flow\Cli\CommandController; -use Neos\Neos\Domain\Model\WorkspaceClassification; -use Neos\Neos\Domain\Model\WorkspaceRole; -use Neos\Neos\Domain\Model\WorkspaceSubjectType; -use Neos\Neos\Domain\Service\WorkspaceService; class MigrateEventsCommandController extends CommandController { public function __construct( private readonly ContentRepositoryRegistry $contentRepositoryRegistry, - private readonly EventMigrationServiceFactory $eventMigrationServiceFactory, - private readonly WorkspaceService $workspaceService, - private readonly Connection $dbal, + private readonly EventMigrationServiceFactory $eventMigrationServiceFactory ) { parent::__construct(); } @@ -29,80 +21,17 @@ public function __construct( /** * Migrates initial metadata & roles from the CR core workspaces to the corresponding Neos database tables * - * @see https://github.com/neos/neos-development-collection/pull/5146 + * Needed to extract these information to Neos.Neos: https://github.com/neos/neos-development-collection/issues/4726 * + * Included in September 2024 - before final Neos 9.0 release + * + * @param string $contentRepository Identifier of the Content Repository to migrate */ - public function workspacesCommand(string $contentRepository = 'default'): void + public function migrateWorkspaceMetadataToWorkspaceServiceCommand(string $contentRepository = 'default'): void { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); - - $workspaces = $contentRepositoryInstance->getWorkspaceFinder()->findAll(); - - if (count($workspaces) === 0) { - $this->outputLine('No workspaces found.'); - $this->quit(); - } - - $workspaceTableName = "cr_{$contentRepositoryId->value}_p_workspace"; - - $workspaceRows = $this->dbal->fetchAllAssociative(<<value, 'user-'); - $isPrivateWorkspace = $workspaceOwner !== null && !$isPersonalWorkspace; - $isInternalWorkspace = $baseWorkspaceName !== null && $workspaceOwner === null; - try { - $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName); - } catch (\Exception $e) { - if ($baseWorkspaceName === null) { - $classification = WorkspaceClassification::ROOT; - } elseif ($isPersonalWorkspace) { - $classification = WorkspaceClassification::PERSONAL; - } else { - $classification = WorkspaceClassification::SHARED; - } - $this->dbal->insert('neos_neos_workspace_metadata', [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'title' => $workspaceRow['workspacetitle'] ?? '', - 'description' => $workspaceRow['workspacedescription'] ?? '', - 'classification' => $classification->value, - 'owner_user_id' => $isPersonalWorkspace ? $workspaceOwner : null, - ]); - if ($workspaceName->isLive()) { - $this->dbal->insert('neos_neos_workspace_role', [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::GROUP->value, - 'subject' => 'Neos.Neos:LivePublisher', - 'role' => WorkspaceRole::COLLABORATOR->value, - ]); - } elseif ($isInternalWorkspace) { - $this->dbal->insert('neos_neos_workspace_role', [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::GROUP->value, - 'subject' => 'Neos.Neos:AbstractEditor', - 'role' => WorkspaceRole::COLLABORATOR->value, - ]); - } elseif ($isPrivateWorkspace) { - $this->dbal->insert('neos_neos_workspace_role', [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::USER->value, - 'subject' => $workspaceOwner, - 'role' => WorkspaceRole::COLLABORATOR->value, - ]); - } - $this->outputLine('Added metadata for workspace "%s"', [$workspaceName->value]); - } - } - $this->outputLine('Done.'); + $eventMigrationService = $this->contentRepositoryRegistry->buildService($contentRepositoryId, $this->eventMigrationServiceFactory); + $eventMigrationService->migrateWorkspaceMetadataToWorkspaceService($this->outputLine(...)); } /** diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php index 41ce8c22fe7..0f9de9eabee 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php @@ -28,6 +28,10 @@ use Neos\EventStore\Model\Event\SequenceNumber; use Neos\EventStore\Model\EventEnvelope; use Neos\EventStore\Model\EventStream\VirtualStreamName; +use Neos\Neos\Domain\Model\WorkspaceClassification; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceSubjectType; +use Neos\Neos\Domain\Service\WorkspaceService; /** * Content Repository service to perform migrations of events. @@ -46,6 +50,7 @@ public function __construct( private readonly ContentRepositoryId $contentRepositoryId, private readonly EventStoreInterface $eventStore, private readonly Connection $connection, + private readonly WorkspaceService $workspaceService, ) { } @@ -469,6 +474,171 @@ public function migratePayloadToValidWorkspaceNames(\Closure $outputFn): void $outputFn(sprintf('You need to replay your projection for workspaces. Please run: ./flow cr:projectionreplay --projection=workspace')); } + /** + * Migrates initial metadata & roles from the CR core workspaces to the corresponding Neos database tables + * + * Needed to extract these information to Neos.Neos: https://github.com/neos/neos-development-collection/issues/4726 + * + * Included in September 2024 - before final Neos 9.0 release + * + * @param \Closure $outputFn + * @return void + */ + public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): void + { + $numberOfHandledWorkspaceEvents = 0; + + $workspaces = []; + // building up the state. Mimic how the legacy WorkspaceProjection handles the events and builds up the state. + foreach ($this->eventStore->load(VirtualStreamName::all()) as $eventEnvelope) { + $eventType = $eventEnvelope->event->type->value; + + switch ($eventType) { + case 'RootWorkspaceWasCreated': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($eventData['workspaceTitle'])) { + // without the field its not a legacy workspace creation event + continue 2; + } + $workspaces[$eventData['workspaceName']] = [ + 'workspaceName' => $eventData['workspaceName'], + 'workspaceTitle' => $eventData['workspaceTitle'], + 'workspaceDescription' => $eventData['workspaceDescription'], + 'baseWorkspaceName' => null, + 'workspaceOwner' => null + ]; + break; + case 'WorkspaceWasCreated': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($eventData['workspaceTitle'])) { + // without the field its not a legacy workspace creation event + continue 2; + } + $workspaces[$eventData['workspaceName']] = [ + 'workspaceName' => $eventData['workspaceName'], + 'baseWorkspaceName' => $eventData['baseWorkspaceName'], + 'workspaceTitle' => $eventData['workspaceTitle'], + 'workspaceDescription' => $eventData['workspaceDescription'], + 'workspaceOwner' => $eventData['workspaceOwner'] ?? null + ]; + break; + case 'WorkspaceBaseWorkspaceWasChanged': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($workspaces[$eventData['workspaceName']])) { + continue 2; + } + $workspaces[$eventData['workspaceName']] = [ + 'baseWorkspaceName' => $eventData['baseWorkspaceName'], + ...$workspaces[$eventData['workspaceName']] + ]; + break; + case 'WorkspaceOwnerWasChanged': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($workspaces[$eventData['workspaceName']])) { + continue 2; + } + $workspaces[$eventData['workspaceName']] = [ + 'workspaceOwner' => $eventData['newWorkspaceOwner'], + ...$workspaces[$eventData['workspaceName']] + ]; + break; + case 'WorkspaceWasRenamed': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($workspaces[$eventData['workspaceName']])) { + continue 2; + } + $workspaces[$eventData['workspaceName']] = [ + 'workspaceTitle' => $eventData['workspaceTitle'], + 'workspaceDescription' => $eventData['workspaceDescription'], + ...$workspaces[$eventData['workspaceName']] + ]; + break; + case 'WorkspaceWasRemoved': + $eventData = self::decodeEventPayload($eventEnvelope); + if (!isset($workspaces[$eventData['workspaceName']])) { + continue 2; + } + unset($workspaces[$eventData['workspaceName']]); + break; + default: + continue 2; + } + $numberOfHandledWorkspaceEvents++; + } + if (count($workspaces) === 0) { + $outputFn('Migration was not necessary.'); + return; + } + + $outputFn(sprintf('Found %d legacy workspace events resulting in %d workspaces.', $numberOfHandledWorkspaceEvents, count($workspaces))); + + // adding metadata + $addedWorkspaceMetadata = 0; + foreach ($workspaces as $workspaceRow) { + $workspaceName = WorkspaceName::fromString($workspaceRow['workspaceName']); + $baseWorkspaceName = isset($workspaceRow['baseWorkspaceName']) ? WorkspaceName::fromString($workspaceRow['baseWorkspaceName']) : null; + $workspaceOwner = $workspaceRow['workspaceOwner'] ?? null; + $isPersonalWorkspace = str_starts_with($workspaceName->value, 'user-'); + $isPrivateWorkspace = $workspaceOwner !== null && !$isPersonalWorkspace; + $isInternalWorkspace = $baseWorkspaceName !== null && $workspaceOwner === null; + try { + $this->workspaceService->getWorkspaceMetadata($this->contentRepositoryId, $workspaceName); + $outputFn(sprintf('Metadata for "%s" exists already.', $workspaceName->value)); + continue; + } catch (\Exception $e) { + // metadata does not exist yet + } + if ($baseWorkspaceName === null) { + $classification = WorkspaceClassification::ROOT; + } elseif ($isPersonalWorkspace) { + $classification = WorkspaceClassification::PERSONAL; + } else { + $classification = WorkspaceClassification::SHARED; + } + $this->connection->insert('neos_neos_workspace_metadata', [ + 'content_repository_id' => $this->contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'title' => $workspaceRow['workspaceTitle'], + 'description' => $workspaceRow['workspaceDescription'], + 'classification' => $classification->value, + 'owner_user_id' => $isPersonalWorkspace ? $workspaceOwner : null, + ]); + if ($workspaceName->isLive()) { + $this->connection->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $this->contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject' => 'Neos.Neos:LivePublisher', + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } elseif ($isInternalWorkspace) { + $this->connection->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $this->contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject' => 'Neos.Neos:AbstractEditor', + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } elseif ($isPrivateWorkspace) { + $this->connection->insert('neos_neos_workspace_role', [ + 'content_repository_id' => $this->contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => WorkspaceSubjectType::USER->value, + 'subject' => $workspaceOwner, + 'role' => WorkspaceRole::COLLABORATOR->value, + ]); + } + $outputFn(sprintf('Added metadata for "%s".', $workspaceName->value)); + $addedWorkspaceMetadata++; + } + if ($addedWorkspaceMetadata === 0) { + $outputFn('Migration was not necessary.'); + return; + } + + $outputFn(sprintf('Added metadata for %d workspaces.', $addedWorkspaceMetadata)); + } + /** ------------------------ */ /** diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php index 6067de83d42..ca89e22c688 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php @@ -10,6 +10,7 @@ use Neos\ContentRepositoryRegistry\Command\MigrateEventsCommandController; use Neos\EventStore\DoctrineAdapter\DoctrineEventStore; use Neos\Flow\Annotations as Flow; +use Neos\Neos\Domain\Service\WorkspaceService; /** * Factory for the {@see EventMigrationService} @@ -22,6 +23,7 @@ final class EventMigrationServiceFactory implements ContentRepositoryServiceFact { public function __construct( private readonly Connection $connection, + private readonly WorkspaceService $workspaceService ) { } @@ -34,7 +36,8 @@ public function build(ContentRepositoryServiceFactoryDependencies $serviceFactor return new EventMigrationService( $serviceFactoryDependencies->contentRepositoryId, $serviceFactoryDependencies->eventStore, - $this->connection + $this->connection, + $this->workspaceService, ); } } From 1e1849dc25838b8278978f0b22a2ac869986b36b Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 1 Oct 2024 11:47:33 +0200 Subject: [PATCH 21/43] Optimize `migrateWorkspaceMetadataToWorkspaceService` migration by only loading relevant events --- .../Classes/Service/EventMigrationService.php | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php index 0f9de9eabee..f7c7c7c140c 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php @@ -25,8 +25,11 @@ use Neos\ContentRepositoryRegistry\Command\MigrateEventsCommandController; use Neos\ContentRepositoryRegistry\Factory\EventStore\DoctrineEventStoreFactory; use Neos\EventStore\EventStoreInterface; +use Neos\EventStore\Model\Event\EventType; +use Neos\EventStore\Model\Event\EventTypes; use Neos\EventStore\Model\Event\SequenceNumber; use Neos\EventStore\Model\EventEnvelope; +use Neos\EventStore\Model\EventStream\EventStreamFilter; use Neos\EventStore\Model\EventStream\VirtualStreamName; use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceRole; @@ -489,15 +492,16 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): $numberOfHandledWorkspaceEvents = 0; $workspaces = []; + $eventTypes = EventTypes::create(...array_map(EventType::fromString(...), ['RootWorkspaceWasCreated', 'WorkspaceWasCreated', 'WorkspaceBaseWorkspaceWasChanged', 'WorkspaceOwnerWasChanged', 'WorkspaceWasRenamed', 'WorkspaceWasRemoved'])); // building up the state. Mimic how the legacy WorkspaceProjection handles the events and builds up the state. - foreach ($this->eventStore->load(VirtualStreamName::all()) as $eventEnvelope) { + foreach ($this->eventStore->load(VirtualStreamName::all(), EventStreamFilter::create(eventTypes: $eventTypes)) as $eventEnvelope) { $eventType = $eventEnvelope->event->type->value; switch ($eventType) { case 'RootWorkspaceWasCreated': $eventData = self::decodeEventPayload($eventEnvelope); if (!isset($eventData['workspaceTitle'])) { - // without the field its not a legacy workspace creation event + // without the field it's not a legacy workspace creation event continue 2; } $workspaces[$eventData['workspaceName']] = [ @@ -511,7 +515,7 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): case 'WorkspaceWasCreated': $eventData = self::decodeEventPayload($eventEnvelope); if (!isset($eventData['workspaceTitle'])) { - // without the field its not a legacy workspace creation event + // without the field it's not a legacy workspace creation event continue 2; } $workspaces[$eventData['workspaceName']] = [ From b84ae908d0dea5e595fea735b7c3ba6e296538d4 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:12:37 +0200 Subject: [PATCH 22/43] TASK: Adjust deprecations --- .../Command/ChangeWorkspaceOwner.php | 2 +- .../Command/RenameWorkspace.php | 2 +- .../Classes/Projection/Workspace/Workspace.php | 14 ++++++++------ .../SharedModel/Workspace/WorkspaceDescription.php | 2 +- .../SharedModel/Workspace/WorkspaceTitle.php | 2 +- .../Classes/Service/EventMigrationService.php | 4 ++-- 6 files changed, 14 insertions(+), 12 deletions(-) diff --git a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php index e5b36e4eae2..57738fbff5d 100644 --- a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php +++ b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php @@ -11,7 +11,7 @@ * Change workspace owner of a workspace, identified by $workspaceName. * Setting $newWorkspaceOwner to null, removes the current workspace owner. * - * @api commands are the write-API of the ContentRepository + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ final readonly class ChangeWorkspaceOwner implements CommandInterface { diff --git a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php index 38c91a85f11..170e72eddac 100644 --- a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php +++ b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php @@ -12,7 +12,7 @@ /** * Change the title or description of a workspace * - * @api commands are the write-API of the ContentRepository + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ final readonly class RenameWorkspace implements CommandInterface { diff --git a/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php b/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php index ff85e8c5da8..ddb826aff52 100644 --- a/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php +++ b/Neos.ContentRepository.Core/Classes/Projection/Workspace/Workspace.php @@ -28,6 +28,7 @@ { /** * This prefix determines if a given workspace (name) is a user workspace. + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ public const PERSONAL_WORKSPACE_PREFIX = 'user-'; @@ -42,12 +43,12 @@ public ?WorkspaceName $baseWorkspaceName; /** - * @deprecated with 9.0.0-beta12 metadata should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ public WorkspaceTitle $workspaceTitle; /** - * @deprecated with 9.0.0-beta12metadata should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ public WorkspaceDescription $workspaceDescription; @@ -62,7 +63,7 @@ public WorkspaceStatus $status; /** - * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public string|null $workspaceOwner; @@ -89,7 +90,7 @@ public function __construct( /** * Checks if this workspace is a user's personal workspace - * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isPersonalWorkspace(): bool { @@ -100,7 +101,7 @@ public function isPersonalWorkspace(): bool * Checks if this workspace is shared only across users with access to internal workspaces, for example "reviewers" * * @return bool - * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isPrivateWorkspace(): bool { @@ -111,7 +112,7 @@ public function isPrivateWorkspace(): bool * Checks if this workspace is shared across all editors * * @return boolean - * @deprecated with 9.0.0-beta12 owners/collaborators should be assigned to workspaces outside the Content Repository core + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isInternalWorkspace(): bool { @@ -122,6 +123,7 @@ public function isInternalWorkspace(): bool * Checks if this workspace is public to everyone, even without authentication * * @return boolean + * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core */ public function isPublicWorkspace(): bool { diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php index 8192ab1646c..98ea1d0a3a1 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php @@ -17,7 +17,7 @@ /** * Description for a workspace * - * @api + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ final readonly class WorkspaceDescription implements \JsonSerializable { diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php index 4e18d3be20f..09fb6f716a7 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php @@ -17,7 +17,7 @@ /** * Human-Readable title of a workspace * - * @api + * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core */ final readonly class WorkspaceTitle implements \JsonSerializable { diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php index f7c7c7c140c..9da4be1a291 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php @@ -496,6 +496,7 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): // building up the state. Mimic how the legacy WorkspaceProjection handles the events and builds up the state. foreach ($this->eventStore->load(VirtualStreamName::all(), EventStreamFilter::create(eventTypes: $eventTypes)) as $eventEnvelope) { $eventType = $eventEnvelope->event->type->value; + $numberOfHandledWorkspaceEvents++; switch ($eventType) { case 'RootWorkspaceWasCreated': @@ -565,9 +566,8 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): unset($workspaces[$eventData['workspaceName']]); break; default: - continue 2; + throw new \Exception('Unhandled event type: ' . $eventType); } - $numberOfHandledWorkspaceEvents++; } if (count($workspaces) === 0) { $outputFn('Migration was not necessary.'); From 702d7492e9f305f8442048c2e52434676d201777 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:18:35 +0200 Subject: [PATCH 23/43] TASK: Deprecate `UserInterface` The interface is now obsolete with the ESCR and was previously only used as pragmatic solution to decouple the CR from Neos.Neos as written here: > Some additional background information: This PR also introduces a new "owner" field to the `Workspace` model in TYPO3CR. The owner of a workspace is a Neos user. But in order to avoid a dependency from TYPO3CR to Neos, I simply store a UUID and introduced a new `UserInterface` in TYPO3CR. [...] see https://github.com/neos/neos-development-collection/pull/165#issuecomment-157645872 --- Neos.Neos/Classes/Domain/Model/UserInterface.php | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/UserInterface.php b/Neos.Neos/Classes/Domain/Model/UserInterface.php index 7998656c49f..bc44bc7b951 100644 --- a/Neos.Neos/Classes/Domain/Model/UserInterface.php +++ b/Neos.Neos/Classes/Domain/Model/UserInterface.php @@ -15,17 +15,11 @@ namespace Neos\Neos\Domain\Model; /** - * Interface for a user of the content repository. Users can be owners of workspaces. - * - * @api + * @deprecated with 9.0.0-beta14 please use {@see \Neos\Neos\Domain\Model\User} instead. + * The interface was only needed for the old cr: https://github.com/neos/neos-development-collection/pull/165#issuecomment-157645872 */ interface UserInterface { - /** - * Returns the globally unique identifier for this user - */ - public function getId(): UserId; - /** * Returns a label which can be used as a human-friendly identifier for this user, for example his or her first * and last name. From 3410ca76469907836329306eba889a130516fa17 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:23:07 +0200 Subject: [PATCH 24/43] TASK: Add comment for `$Persistence_Object_Identifier` "hack" The property will be introduced via Flows persistence magic aspect. We declare it here already as workaround to not have to use `PersistenceManager::getIdentifierByObject()`}` to access this identifier. And to have IDE support. --- Neos.Neos/Classes/Domain/Model/User.php | 1 + 1 file changed, 1 insertion(+) diff --git a/Neos.Neos/Classes/Domain/Model/User.php b/Neos.Neos/Classes/Domain/Model/User.php index 331636a9f5f..3dddfa3b11b 100644 --- a/Neos.Neos/Classes/Domain/Model/User.php +++ b/Neos.Neos/Classes/Domain/Model/User.php @@ -37,6 +37,7 @@ class User extends Person implements UserInterface protected $preferences; /** + * This property will be introduced and initialised via Flows persistence magic aspect. * @var string */ protected $Persistence_Object_Identifier; From 686ff3d8a1a93c68813f2c40a9c01068b645497a Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:48:48 +0200 Subject: [PATCH 25/43] TASK: Improve exceptions --- Neos.Neos/Classes/Domain/Service/WorkspaceService.php | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 097b006ee23..f32e36864d2 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -193,7 +193,12 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, 'workspaceName' => $workspaceName->value, ]); } catch (DbalException $e) { - throw new \RuntimeException(sprintf('Failed to load metadata for workspace "%s" (Content Repository "%s"): %s. Maybe workspace metadata and roles have to be synchronized', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1726736383, $e); + throw new \RuntimeException(sprintf( + 'Failed to fetch metadata for workspace "%s" (Content Repository "%s), please ensure the database schema is up to date. %s', + $workspaceName->value, + $contentRepositoryId->value, + $e->getMessage() + ), 1727782164, $e); } if (!is_array($metadataRow)) { return null; @@ -346,7 +351,6 @@ private static function getUniqueWorkspaceName(ContentRepository $contentReposit throw new \RuntimeException(sprintf('Failed to find unique workspace name for "%s" after %d attempts.', $candidate, $attempt - 1), 1725975479); } - private function requireWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): Workspace { $workspace = $this->contentRepositoryRegistry @@ -354,7 +358,7 @@ private function requireWorkspace(ContentRepositoryId $contentRepositoryId, Work ->getWorkspaceFinder() ->findOneByName($workspaceName); if ($workspace === null) { - throw new \InvalidArgumentException(sprintf('Failed to find workspace with name "%s"', $workspaceName->value), 1718379722); + throw new \RuntimeException(sprintf('Failed to find workspace with name "%s" for content repository "%s"', $workspaceName->value, $contentRepositoryId->value), 1718379722); } return $workspace; } From 5c3e817361226b0cadbdfac23631c3b4ed33060b Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:50:06 +0200 Subject: [PATCH 26/43] TASK: Make migration independent of workspaceService Otherwise, we would be implicitly still relying on the workspace finder and up-to-date projections --- .../Classes/Service/EventMigrationService.php | 19 ++++++++++++------- .../Service/EventMigrationServiceFactory.php | 7 ++----- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php index 9da4be1a291..c4ba07641e8 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php @@ -34,7 +34,6 @@ use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceRole; use Neos\Neos\Domain\Model\WorkspaceSubjectType; -use Neos\Neos\Domain\Service\WorkspaceService; /** * Content Repository service to perform migrations of events. @@ -52,8 +51,7 @@ final class EventMigrationService implements ContentRepositoryServiceInterface public function __construct( private readonly ContentRepositoryId $contentRepositoryId, private readonly EventStoreInterface $eventStore, - private readonly Connection $connection, - private readonly WorkspaceService $workspaceService, + private readonly Connection $connection ) { } @@ -585,12 +583,19 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): $isPersonalWorkspace = str_starts_with($workspaceName->value, 'user-'); $isPrivateWorkspace = $workspaceOwner !== null && !$isPersonalWorkspace; $isInternalWorkspace = $baseWorkspaceName !== null && $workspaceOwner === null; - try { - $this->workspaceService->getWorkspaceMetadata($this->contentRepositoryId, $workspaceName); + + $query = <<connection->fetchOne($query, [ + 'contentRepositoryId' => $this->contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + ]); + if ($metadataExists !== 0) { $outputFn(sprintf('Metadata for "%s" exists already.', $workspaceName->value)); continue; - } catch (\Exception $e) { - // metadata does not exist yet } if ($baseWorkspaceName === null) { $classification = WorkspaceClassification::ROOT; diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php index ca89e22c688..f61935dccaa 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationServiceFactory.php @@ -10,7 +10,6 @@ use Neos\ContentRepositoryRegistry\Command\MigrateEventsCommandController; use Neos\EventStore\DoctrineAdapter\DoctrineEventStore; use Neos\Flow\Annotations as Flow; -use Neos\Neos\Domain\Service\WorkspaceService; /** * Factory for the {@see EventMigrationService} @@ -22,8 +21,7 @@ final class EventMigrationServiceFactory implements ContentRepositoryServiceFactoryInterface { public function __construct( - private readonly Connection $connection, - private readonly WorkspaceService $workspaceService + private readonly Connection $connection ) { } @@ -36,8 +34,7 @@ public function build(ContentRepositoryServiceFactoryDependencies $serviceFactor return new EventMigrationService( $serviceFactoryDependencies->contentRepositoryId, $serviceFactoryDependencies->eventStore, - $this->connection, - $this->workspaceService, + $this->connection ); } } From 721b413bc69ae27795b13fecff25dce7445425cc Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 13:51:01 +0200 Subject: [PATCH 27/43] TASK: Add missing `@internal` annotations --- .../WorkspaceModification/Command/ChangeWorkspaceOwner.php | 1 + .../Feature/WorkspaceModification/Command/RenameWorkspace.php | 1 + .../Classes/SharedModel/Workspace/WorkspaceDescription.php | 1 + .../Classes/SharedModel/Workspace/WorkspaceTitle.php | 1 + 4 files changed, 4 insertions(+) diff --git a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php index 57738fbff5d..740fed703b6 100644 --- a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php +++ b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/ChangeWorkspaceOwner.php @@ -12,6 +12,7 @@ * Setting $newWorkspaceOwner to null, removes the current workspace owner. * * @deprecated with 9.0.0-beta14 owners/collaborators should be assigned to workspaces outside the Content Repository core + * @internal */ final readonly class ChangeWorkspaceOwner implements CommandInterface { diff --git a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php index 170e72eddac..edd76b21fa3 100644 --- a/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php +++ b/Neos.ContentRepository.Core/Classes/Feature/WorkspaceModification/Command/RenameWorkspace.php @@ -13,6 +13,7 @@ * Change the title or description of a workspace * * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core + * @internal */ final readonly class RenameWorkspace implements CommandInterface { diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php index 98ea1d0a3a1..3181b351960 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceDescription.php @@ -18,6 +18,7 @@ * Description for a workspace * * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core + * @internal */ final readonly class WorkspaceDescription implements \JsonSerializable { diff --git a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php index 09fb6f716a7..e00ee41690e 100644 --- a/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php +++ b/Neos.ContentRepository.Core/Classes/SharedModel/Workspace/WorkspaceTitle.php @@ -18,6 +18,7 @@ * Human-Readable title of a workspace * * @deprecated with 9.0.0-beta14 metadata should be assigned to workspaces outside the Content Repository core + * @internal */ final readonly class WorkspaceTitle implements \JsonSerializable { From e64ff937a2aac0a8c83a9500ed37d8fda0cc44d0 Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Tue, 1 Oct 2024 14:23:25 +0200 Subject: [PATCH 28/43] TASK: Remove obsolete todos (There is no acl to bypass yet *g) --- Neos.Neos/Classes/Command/WorkspaceCommandController.php | 3 --- 1 file changed, 3 deletions(-) diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index 32c5c44ef61..cc9742a49c5 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -95,7 +95,6 @@ public function publishCommand(string $workspace, string $contentRepository = 'd public function discardCommand(string $workspace, string $contentRepository = 'default'): void { try { - // @todo: bypass access control $this->workspacePublishingService->discardAllWorkspaceChanges( ContentRepositoryId::fromString($contentRepository), WorkspaceName::fromString($workspace) @@ -120,7 +119,6 @@ public function discardCommand(string $workspace, string $contentRepository = 'd public function rebaseCommand(string $workspace, string $contentRepository = 'default', bool $force = false): void { try { - // @todo: bypass access control $this->workspacePublishingService->rebaseWorkspace( ContentRepositoryId::fromString($contentRepository), WorkspaceName::fromString($workspace), @@ -307,7 +305,6 @@ public function deleteCommand(string $workspace, bool $force = false, string $co ); $this->quit(5); } - // @todo bypass access control? $this->workspacePublishingService->discardAllWorkspaceChanges($contentRepositoryId, $workspaceName); } From 25e9957d9840eef590075845400fd25eb9e7f3d9 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 14:19:49 +0200 Subject: [PATCH 29/43] Rename `WorkspaceSubjectType` to `WorkspaceRoleSubjectType` --- .../Classes/Service/EventMigrationService.php | 8 ++++---- ...kspaceSubjectType.php => WorkspaceRoleSubjectType.php} | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) rename Neos.Neos/Classes/Domain/Model/{WorkspaceSubjectType.php => WorkspaceRoleSubjectType.php} (77%) diff --git a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php index c4ba07641e8..32dbba18330 100644 --- a/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php +++ b/Neos.ContentRepositoryRegistry/Classes/Service/EventMigrationService.php @@ -33,7 +33,7 @@ use Neos\EventStore\Model\EventStream\VirtualStreamName; use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceRole; -use Neos\Neos\Domain\Model\WorkspaceSubjectType; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; /** * Content Repository service to perform migrations of events. @@ -616,7 +616,7 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): $this->connection->insert('neos_neos_workspace_role', [ 'content_repository_id' => $this->contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject_type' => WorkspaceRoleSubjectType::GROUP->value, 'subject' => 'Neos.Neos:LivePublisher', 'role' => WorkspaceRole::COLLABORATOR->value, ]); @@ -624,7 +624,7 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): $this->connection->insert('neos_neos_workspace_role', [ 'content_repository_id' => $this->contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::GROUP->value, + 'subject_type' => WorkspaceRoleSubjectType::GROUP->value, 'subject' => 'Neos.Neos:AbstractEditor', 'role' => WorkspaceRole::COLLABORATOR->value, ]); @@ -632,7 +632,7 @@ public function migrateWorkspaceMetadataToWorkspaceService(\Closure $outputFn): $this->connection->insert('neos_neos_workspace_role', [ 'content_repository_id' => $this->contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject_type' => WorkspaceSubjectType::USER->value, + 'subject_type' => WorkspaceRoleSubjectType::USER->value, 'subject' => $workspaceOwner, 'role' => WorkspaceRole::COLLABORATOR->value, ]); diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php similarity index 77% rename from Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php rename to Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php index 09334960f63..78777a834bd 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceSubjectType.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php @@ -7,7 +7,7 @@ /** * @api */ -enum WorkspaceSubjectType : string +enum WorkspaceRoleSubjectType : string { case USER = 'USER'; case GROUP = 'GROUP'; From 2dde2cfc41100e3ad3c74ffc985c4f2a91d247c6 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 14:22:30 +0200 Subject: [PATCH 30/43] Make `WorkspaceService` more explicit --- .../Command/WorkspaceCommandController.php | 160 ++++++++---------- .../Domain/Model/WorkspaceRoleSubject.php | 39 +++++ .../Domain/Service/WorkspaceService.php | 111 +++++++----- .../Bootstrap/WorkspaceServiceTrait.php | 22 +-- .../Controller/WorkspaceController.php | 8 +- 5 files changed, 185 insertions(+), 155 deletions(-) create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index cc9742a49c5..f474189f0fc 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -14,8 +14,7 @@ namespace Neos\Neos\Command; -use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; -use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\BaseWorkspaceDoesNotExist; +use Doctrine\DBAL\Exception as DbalException; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\DeleteWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceRebase\Dto\RebaseErrorHandlingStrategy; @@ -24,19 +23,17 @@ use Neos\ContentRepository\Core\Service\WorkspaceMaintenanceServiceFactory; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Exception\WorkspaceDoesNotExist; -use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceDescription; use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceName; -use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle; use Neos\ContentRepositoryRegistry\ContentRepositoryRegistry; use Neos\Flow\Annotations as Flow; use Neos\Flow\Cli\CommandController; use Neos\Flow\Cli\Exception\StopCommandException; -use Neos\Flow\Persistence\PersistenceManagerInterface; -use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceClassification; -use Neos\Neos\Domain\Model\WorkspaceDescription as NeosWorkspaceDescription; -use Neos\Neos\Domain\Model\WorkspaceTitle as NeosWorkspaceTitle; +use Neos\Neos\Domain\Model\WorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleSubject; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; +use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Service\UserService; use Neos\Neos\Domain\Service\WorkspacePublishingService; use Neos\Neos\Domain\Service\WorkspaceService; @@ -50,9 +47,6 @@ class WorkspaceCommandController extends CommandController #[Flow\Inject] protected UserService $userService; - #[Flow\Inject] - protected PersistenceManagerInterface $persistenceManager; - #[Flow\Inject] protected ContentRepositoryRegistry $contentRepositoryRegistry; @@ -78,7 +72,7 @@ public function publishCommand(string $workspace, string $contentRepository = 'd ); $this->outputLine( - 'Published all nodes in workspace %s to its base workspace', + 'Published all nodes in workspace "%s" to its base workspace', [$workspace] ); } @@ -99,11 +93,11 @@ public function discardCommand(string $workspace, string $contentRepository = 'd ContentRepositoryId::fromString($contentRepository), WorkspaceName::fromString($workspace) ); - } catch (WorkspaceDoesNotExist $exception) { - $this->outputLine('Workspace "%s" does not exist', [$workspace]); + } catch (WorkspaceDoesNotExist) { + $this->outputLine('Workspace "%s" does not exist', [$workspace]); $this->quit(1); } - $this->outputLine('Discarded all nodes in workspace %s', [$workspace]); + $this->outputLine('Discarded all nodes in workspace "%s"', [$workspace]); } /** @@ -125,14 +119,14 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de $force ? RebaseErrorHandlingStrategy::STRATEGY_FORCE : RebaseErrorHandlingStrategy::STRATEGY_FAIL, ); } catch (WorkspaceDoesNotExist $exception) { - $this->outputLine('Workspace "%s" does not exist', [$workspace]); + $this->outputLine('Workspace "%s" does not exist', [$workspace]); $this->quit(1); } catch (WorkspaceRebaseFailed $exception) { - $this->outputLine('Rebasing of workspace %s is not possible due to conflicts. You can try the --force option.', [$workspace]); + $this->outputLine('Rebasing of workspace "%s" is not possible due to conflicts. You can try the --force option.', [$workspace]); $this->quit(1); } - $this->outputLine('Rebased workspace %s', [$workspace]); + $this->outputLine('Rebased workspace "%s"', [$workspace]); } /** @@ -140,91 +134,75 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de * * @param string $name Name of the new root * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @param string|null $title Optional title of the workspace * @param string|null $description Optional description of the workspace + * @throws WorkspaceAlreadyExists */ - public function createRootCommand(string $name, string $contentRepository = 'default', string $description = null): void + public function createRootCommand(string $name, string $contentRepository = 'default', string $title = null, string $description = null): void { + $workspaceName = WorkspaceName::fromString($name); $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - $workspaceName = $this->workspaceService->createRootWorkspace( + $this->workspaceService->createRootWorkspace( $contentRepositoryId, - NeosWorkspaceTitle::fromString($name), - NeosWorkspaceDescription::fromString($description ?? $name) + $workspaceName, + WorkspaceTitle::fromString($title ?? $name), + WorkspaceDescription::fromString($description ?? '') ); - $this->outputLine('Created root workspace "%s" in content repository "%s"', [$workspaceName->value, $contentRepositoryId->value]); + $this->outputLine('Created root workspace "%s" in content repository "%s"', [$workspaceName->value, $contentRepositoryId->value]); } /** - * Create a new workspace - * - * This command creates a new personal workspace. + * Create a new personal workspace for the specified user * * @param string $workspace Name of the workspace, for example "christmas-campaign" + * @param string $owner The username (aka account identifier) of a User to own the workspace * @param string $baseWorkspace Name of the base workspace. If none is specified, "live" is assumed. * @param string|null $title Human friendly title of the workspace, for example "Christmas Campaign" * @param string|null $description A description explaining the purpose of the new workspace - * @param string $owner The identifier of a User to own the workspace * @param string $contentRepository Identifier of the content repository. (Default: 'default') * @throws StopCommandException */ - public function createCommand( - string $workspace, - string $baseWorkspace = 'live', - string $title = null, - string $description = null, - string $owner = '', - string $contentRepository = 'default' - ): void { + public function createPersonalCommand(string $workspace, string $owner, string $baseWorkspace = 'live', string $title = null, string $description = null, string $contentRepository = 'default'): void { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); - + $workspaceOwner = $this->userService->getUser($owner); + if ($workspaceOwner === null) { + $this->outputLine('The user "%s" specified as owner does not exist', [$owner]); + $this->quit(1); + } + $workspaceName = WorkspaceName::fromString($workspace); $this->workspaceService->createPersonalWorkspace( $contentRepositoryId, - NeosWorkspaceTitle::fromString($title ?? $workspace), - NeosWorkspaceDescription::fromString($description ?? ''), + $workspaceName, + WorkspaceTitle::fromString($title ?? $workspaceName->value), + WorkspaceDescription::fromString($description ?? ''), WorkspaceName::fromString($baseWorkspace), - UserId::fromString($owner), + $workspaceOwner->getId(), ); + $this->outputLine('Created personal workspace "%s" for user "%s"', [$workspaceName->value, (string)$workspaceOwner->getName()]); + } - $contentRepositoryInstance = $this->contentRepositoryRegistry->get($contentRepositoryId); - - if ($owner === '') { - $workspaceOwnerUserId = null; - } else { - $workspaceOwnerUserId = UserId::fromString($owner); - $workspaceOwner = $this->userService->findUserById($workspaceOwnerUserId); - if ($workspaceOwner === null) { - $this->outputLine('The user "%s" specified as owner does not exist', [$owner]); - $this->quit(3); - } - } - - try { - $contentRepositoryInstance->handle(CreateWorkspace::create( - WorkspaceName::fromString($workspace), - WorkspaceName::fromString($baseWorkspace), - WorkspaceTitle::fromString($title ?: $workspace), - WorkspaceDescription::fromString($description ?: $workspace), - ContentStreamId::create(), - $workspaceOwnerUserId !== null ? \Neos\ContentRepository\Core\SharedModel\User\UserId::fromString($workspaceOwnerUserId->value) : null, - )); - } catch (WorkspaceAlreadyExists $workspaceAlreadyExists) { - $this->outputLine('Workspace "%s" already exists', [$workspace]); - $this->quit(1); - } catch (BaseWorkspaceDoesNotExist $baseWorkspaceDoesNotExist) { - $this->outputLine('The base workspace "%s" does not exist', [$baseWorkspace]); - $this->quit(2); - } - - if ($workspaceOwnerUserId !== null) { - $this->outputLine( - 'Created a new workspace "%s", based on workspace "%s", owned by "%s".', - [$workspace, $baseWorkspace, $owner] - ); - } else { - $this->outputLine( - 'Created a new workspace "%s", based on workspace "%s".', - [$workspace, $baseWorkspace] - ); - } + /** + * Create a new shared workspace + * + * @param string $workspace Name of the workspace, for example "christmas-campaign" + * @param string $baseWorkspace Name of the base workspace. If none is specified, "live" is assumed. + * @param string|null $title Human friendly title of the workspace, for example "Christmas Campaign" + * @param string|null $description A description explaining the purpose of the new workspace + * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @throws StopCommandException + */ + public function createSharedCommand(string $workspace, string $baseWorkspace = 'live', string $title = null, string $description = null, string $contentRepository = 'default'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $workspaceName = WorkspaceName::fromString($workspace); + $this->workspaceService->createSharedWorkspace( + $contentRepositoryId, + $workspaceName, + WorkspaceTitle::fromString($title ?? $workspaceName->value), + WorkspaceDescription::fromString($description ?? ''), + WorkspaceName::fromString($baseWorkspace), + ); + $this->outputLine('Created shared workspace "%s"', [$workspaceName->value]); } /** @@ -236,7 +214,7 @@ public function createCommand( * @param string $workspace Name of the workspace, for example "christmas-campaign" * @param boolean $force Delete the workspace and all of its contents * @param string $contentRepository The name of the content repository. (Default: 'default') - * @see neos.neos:workspace:discard + * @throws StopCommandException */ public function deleteCommand(string $workspace, bool $force = false, string $contentRepository = 'default'): void { @@ -257,20 +235,18 @@ public function deleteCommand(string $workspace, bool $force = false, string $co $workspaceMetadata = $this->workspaceService->getWorkspaceMetadata($contentRepositoryId, $workspaceName); if ($workspaceMetadata->classification === WorkspaceClassification::PERSONAL) { - $this->outputLine( - 'Did not delete workspace "%s" because it is a personal workspace.' - . ' Personal workspaces cannot be deleted manually.', - [$workspaceName->value] - ); + $this->outputLine('Did not delete workspace "%s" because it is a personal workspace. Personal workspaces cannot be deleted manually.', [$workspaceName->value]); $this->quit(2); } - $dependentWorkspaces = $contentRepositoryInstance->getWorkspaceFinder()->findByBaseWorkspace($workspaceName); + try { + $dependentWorkspaces = $contentRepositoryInstance->getWorkspaceFinder()->findByBaseWorkspace($workspaceName); + } catch (DbalException $e) { + $this->outputLine('Failed to determine dependant workspaces: %s', [$e->getMessage()]); + $this->quit(1); + } if (count($dependentWorkspaces) > 0) { - $this->outputLine( - 'Workspace "%s" cannot be deleted because the following workspaces are based on it:', - [$workspaceName->value] - ); + $this->outputLine('Workspace "%s" cannot be deleted because the following workspaces are based on it:', [$workspaceName->value]); $this->outputLine(); $tableRows = []; diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php new file mode 100644 index 00000000000..4fe05827d85 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php @@ -0,0 +1,39 @@ +value) !== 1) { + throw new \InvalidArgumentException(sprintf('"%s" is not a valid workspace role subject.', $value), 1728384932); + } + } + + public static function fromString(string $value): self + { + return new self($value); + } + + public function jsonSerialize(): string + { + return $this->value; + } + + public function equals(self $other): bool + { + return $this->value === $other->value; + } +} diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index f32e36864d2..edf84c028de 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -17,9 +17,9 @@ use Doctrine\DBAL\ArrayParameterType; use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception as DbalException; -use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; +use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; use Neos\ContentRepository\Core\Projection\Workspace\Workspace; use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId; use Neos\ContentRepository\Core\SharedModel\Workspace\ContentStreamId; @@ -36,7 +36,8 @@ use Neos\Neos\Domain\Model\WorkspaceMetadata; use Neos\Neos\Domain\Model\WorkspacePermissions; use Neos\Neos\Domain\Model\WorkspaceRole; -use Neos\Neos\Domain\Model\WorkspaceSubjectType; +use Neos\Neos\Domain\Model\WorkspaceRoleSubject; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; /** @@ -60,12 +61,15 @@ public function __construct( */ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceMetadata { - $this->requireWorkspace($contentRepositoryId, $workspaceName); + $crWorkspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); - if ($metadata === null) { - throw new \RuntimeException(sprintf('Failed to load metadata for workspace "%s" (Content Repository "%s"). Maybe workspace metadata and roles have to be synchronized', $workspaceName->value, $contentRepositoryId->value), 1726736384); - } - return $metadata; + return $metadata ?? new WorkspaceMetadata( + $workspaceName, + WorkspaceTitle::fromString($workspaceName->value), + WorkspaceDescription::fromString(''), + $crWorkspace->baseWorkspaceName !== null ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, + null, + ); } /** @@ -96,11 +100,12 @@ public function getPersonalWorkspaceForUser(ContentRepositoryId $contentReposito /** * Create a new root (aka base) workspace with the specified metadata + * + * @throws WorkspaceAlreadyExists */ - public function createRootWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description): WorkspaceName + public function createRootWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description): void { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); $contentRepository->handle( CreateRootWorkspace::create( $workspaceName, @@ -110,23 +115,22 @@ public function createRootWorkspace(ContentRepositoryId $contentRepositoryId, Wo ) ); $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, WorkspaceClassification::ROOT, null); - return $workspaceName; } /** * Create a new, personal, workspace for the specified user */ - public function createPersonalWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId $ownerId): WorkspaceName + public function createPersonalWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId $ownerId): void { - return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::PERSONAL); + $this->createWorkspace($contentRepositoryId, $workspaceName, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::PERSONAL); } /** * Create a new, potentially shared, workspace */ - public function createSharedWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId|null $ownerId = null): WorkspaceName + public function createSharedWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName): void { - return $this->createWorkspace($contentRepositoryId, $title, $description, $baseWorkspaceName, $ownerId, WorkspaceClassification::SHARED); + $this->createWorkspace($contentRepositoryId, $workspaceName, $title, $description, $baseWorkspaceName, null, WorkspaceClassification::SHARED); } /** @@ -139,8 +143,10 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con $this->requireWorkspace($contentRepositoryId, $existingWorkspaceName); return; } + $workspaceName = $this->getUniqueWorkspaceName($contentRepositoryId, $user->getLabel()); $this->createPersonalWorkspace( $contentRepositoryId, + $workspaceName, WorkspaceTitle::fromString($user->getLabel()), WorkspaceDescription::empty(), WorkspaceName::forLive(), @@ -173,6 +179,29 @@ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepos ); } + public function getUniqueWorkspaceName(ContentRepositoryId $contentRepositoryId, string $candidate): WorkspaceName + { + $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); + $workspaceNameCandidate = WorkspaceName::transliterateFromString($candidate); + $workspaceName = $workspaceNameCandidate; + $attempt = 1; + do { + if ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) === null) { + return $workspaceName; + } + if ($attempt === 1) { + $suffix = ''; + } else { + $suffix = '-' . ($attempt - 1); + } + $workspaceName = WorkspaceName::fromString( + substr($workspaceNameCandidate->value, 0, WorkspaceName::MAX_LENGTH - strlen($suffix)) . $suffix + ); + $attempt++; + } while ($attempt <= 10); + throw new \RuntimeException(sprintf('Failed to find unique workspace name for "%s" after %d attempts.', $candidate, $attempt - 1), 1725975479); + } + // ------------------ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): ?WorkspaceMetadata @@ -203,10 +232,6 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, if (!is_array($metadataRow)) { return null; } - assert(is_string($metadataRow['title'])); - assert(is_string($metadataRow['description'])); - assert(is_string($metadataRow['classification'])); - assert(is_null($metadataRow['owner_user_id']) || is_string($metadataRow['owner_user_id'])); return new WorkspaceMetadata( $workspaceName, WorkspaceTitle::fromString($metadataRow['title']), @@ -231,10 +256,9 @@ private function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryI } } - private function createWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId|null $ownerId, WorkspaceClassification $classification): WorkspaceName + private function createWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceName $baseWorkspaceName, UserId|null $ownerId, WorkspaceClassification $classification): void { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); - $workspaceName = self::getUniqueWorkspaceName($contentRepository, $title->value); $contentRepository->handle( CreateWorkspace::create( $workspaceName, @@ -245,7 +269,6 @@ private function createWorkspace(ContentRepositoryId $contentRepositoryId, Works ) ); $this->addWorkspaceMetadata($contentRepositoryId, $workspaceName, $title, $description, $classification, $ownerId); - return $workspaceName; } private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $title, WorkspaceDescription $description, WorkspaceClassification $classification, UserId|null $ownerUserId): void @@ -256,7 +279,7 @@ private function addWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, 'workspace_name' => $workspaceName->value, 'title' => $title->value, 'description' => $description->value, - 'classification' => $classification->name, + 'classification' => $classification->value, 'owner_user_id' => $ownerUserId?->value, ]); } catch (DbalException $e) { @@ -279,12 +302,27 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep SQL; $workspaceName = $this->dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, - 'personalWorkspaceClassification' => WorkspaceClassification::PERSONAL->name, + 'personalWorkspaceClassification' => WorkspaceClassification::PERSONAL->value, 'userId' => $userId->value, ]); return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } + public function addWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleSubjectType $subjectType, WorkspaceRoleSubject $subject, WorkspaceRole $role): void + { + try { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => $subjectType->value, + 'subject' => $subject->value, + 'role' => $role->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to add metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1727084068, $e); + } + } + private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): ?WorkspaceRole { try { @@ -307,6 +345,7 @@ private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryI (subject_type = :groupSubjectType AND subject IN (:groupSubjects)) ) ORDER BY + /* We only want to return the most specific role so we order them and return the first row */ CASE WHEN role='MANAGER' THEN 1 WHEN role='COLLABORATOR' THEN 2 @@ -316,9 +355,9 @@ private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryI $role = $this->dbal->fetchOne($query, [ 'contentRepositoryId' => $contentRepositoryId->value, 'workspaceName' => $workspaceName->value, - 'userSubjectType' => WorkspaceSubjectType::USER->name, + 'userSubjectType' => WorkspaceRoleSubjectType::USER->value, 'userId' => $user->getId()->value, - 'groupSubjectType' => WorkspaceSubjectType::GROUP->name, + 'groupSubjectType' => WorkspaceRoleSubjectType::GROUP->value, 'groupSubjects' => $userRoles, ], [ 'groupSubjects' => ArrayParameterType::STRING, @@ -329,28 +368,6 @@ private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryI return WorkspaceRole::from($role); } - private static function getUniqueWorkspaceName(ContentRepository $contentRepository, string $candidate): WorkspaceName - { - $workspaceNameCandidate = WorkspaceName::transliterateFromString($candidate); - $workspaceName = $workspaceNameCandidate; - $attempt = 1; - do { - if ($contentRepository->getWorkspaceFinder()->findOneByName($workspaceName) === null) { - return $workspaceName; - } - if ($attempt === 1) { - $suffix = ''; - } else { - $suffix = '-' . ($attempt - 1); - } - $workspaceName = WorkspaceName::fromString( - substr($workspaceNameCandidate->value, 0, WorkspaceName::MAX_LENGTH - strlen($suffix)) . $suffix - ); - $attempt++; - } while ($attempt <= 10); - throw new \RuntimeException(sprintf('Failed to find unique workspace name for "%s" after %d attempts.', $candidate, $attempt - 1), 1725975479); - } - private function requireWorkspace(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): Workspace { $workspace = $this->contentRepositoryRegistry diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index 1462d889cc4..9ad574f4a3b 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -39,25 +39,27 @@ trait WorkspaceServiceTrait abstract private function getObject(string $className): object; /** - * @When the root workspace :workspaceTitle is created + * @When the root workspace :workspaceName is created */ - public function theRootWorkspaceIsCreated(string $workspaceTitle): void + public function theRootWorkspaceIsCreated(string $workspaceName): void { $this->getObject(WorkspaceService::class)->createRootWorkspace( $this->currentContentRepository->id, - WorkspaceTitle::fromString($workspaceTitle), + WorkspaceName::fromString($workspaceName), + WorkspaceTitle::fromString($workspaceName), WorkspaceDescription::fromString(''), ); } /** - * @When the personal workspace :workspaceTitle is created with the target workspace :targetWorkspace + * @When the personal workspace :workspaceName is created with the target workspace :targetWorkspace */ - public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceTitle, string $targetWorkspace): void + public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceName, string $targetWorkspace): void { $this->getObject(WorkspaceService::class)->createPersonalWorkspace( $this->currentContentRepository->id, - WorkspaceTitle::fromString($workspaceTitle), + WorkspaceName::fromString($workspaceName), + WorkspaceTitle::fromString($workspaceName), WorkspaceDescription::fromString(''), WorkspaceName::fromString($targetWorkspace), UserId::fromString(FakeUserIdProvider::$userId?->value ?? ''), @@ -65,16 +67,16 @@ public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $work } /** - * @When the shared workspace :workspaceTitle is created with the target workspace :targetWorkspace + * @When the shared workspace :workspaceName is created with the target workspace :targetWorkspace */ - public function theSharedWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceTitle, string $targetWorkspace): void + public function theSharedWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceName, string $targetWorkspace): void { $this->getObject(WorkspaceService::class)->createSharedWorkspace( $this->currentContentRepository->id, - WorkspaceTitle::fromString($workspaceTitle), + WorkspaceName::fromString($workspaceName), + WorkspaceTitle::fromString($workspaceName), WorkspaceDescription::fromString(''), WorkspaceName::fromString($targetWorkspace), - null ); } diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index f07732d5d96..38e853f867e 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -17,9 +17,7 @@ use Doctrine\DBAL\Exception as DBALException; use Neos\ContentRepository\Core\ContentRepository; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; -use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\ChangeWorkspaceOwner; use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\DeleteWorkspace; -use Neos\ContentRepository\Core\Feature\WorkspaceModification\Command\RenameWorkspace; use Neos\ContentRepository\Core\Feature\WorkspacePublication\Command\DiscardIndividualNodesFromWorkspace; use Neos\ContentRepository\Core\Feature\WorkspacePublication\Command\PublishIndividualNodesFromWorkspace; use Neos\ContentRepository\Core\Feature\WorkspacePublication\Dto\NodeIdsToPublishOrDiscard; @@ -41,11 +39,9 @@ use Neos\Flow\Annotations as Flow; use Neos\Flow\I18n\Exception\IndexOutOfBoundsException; use Neos\Flow\I18n\Exception\InvalidFormatPlaceholderException; -use Neos\Flow\Mvc\ActionRequest; use Neos\Flow\Mvc\Exception\StopActionException; use Neos\Flow\Package\PackageManager; use Neos\Flow\Property\PropertyMapper; -use Neos\Flow\Security\Account; use Neos\Flow\Security\Context; use Neos\Media\Domain\Model\AssetInterface; use Neos\Media\Domain\Model\ImageInterface; @@ -208,14 +204,14 @@ public function createAction( if ($currentUser === null) { throw new \RuntimeException('No user authenticated', 1718303756); } - + $workspaceName = $this->workspaceService->getUniqueWorkspaceName($contentRepositoryId, $title->value); try { $this->workspaceService->createSharedWorkspace( $contentRepositoryId, + $workspaceName, $title, $description, $baseWorkspace, - $currentUser->getId(), ); } catch (WorkspaceAlreadyExists $exception) { $this->addFlashMessage( From 1e3e2f721f4a7c1e7d0e9a585f5a6ad421503c64 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 14:23:37 +0200 Subject: [PATCH 31/43] Workspace UI: Workspace role preset Automatically set the current user as `Manager` and role `Neos.Neos:AbstractEditor` as `Collaborator` for new shared workspaces --- .../Classes/Controller/WorkspaceController.php | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 38e853f867e..48501aa296a 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -51,6 +51,9 @@ use Neos\Neos\Domain\Model\User; use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleSubject; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; @@ -221,6 +224,20 @@ public function createAction( ); $this->redirect('new'); } + $this->workspaceService->addWorkspaceRole( + $contentRepositoryId, + $workspaceName, + WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($currentUser->getId()->value), + WorkspaceRole::MANAGER, + ); + $this->workspaceService->addWorkspaceRole( + $contentRepositoryId, + $workspaceName, + WorkspaceRoleSubjectType::GROUP, + WorkspaceRoleSubject::fromString('Neos.Neos:AbstractEditor'), + WorkspaceRole::COLLABORATOR, + ); $this->addFlashMessage($this->getModuleLabel('workspaces.workspaceHasBeenCreated', [$title->value])); $this->redirect('index'); } From 904c716bb4bb5e62f963a98e74f635956ba252ba Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 16:09:00 +0200 Subject: [PATCH 32/43] `WorkspacePermissions` doc comments --- .../Domain/Model/WorkspacePermissions.php | 35 ++++++++++++------- 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php index 9b08db77ccf..faf543259cf 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspacePermissions.php @@ -7,18 +7,22 @@ use Neos\Flow\Annotations as Flow; /** + * Calculated permissions a specific user has on a workspace + * + * - read: Permission to read data from the corresponding workspace (e.g. get hold of and traverse the content graph) + * - write: Permission to write to the corresponding workspace, including publishing a derived workspace to it + * - manage: Permission to change the metadata and roles of the corresponding workspace (e.g. change description/title or add/remove workspace roles) + * * @api */ #[Flow\Proxy(false)] final readonly class WorkspacePermissions { - private function __construct( - public bool $read, - public bool $write, - public bool $manage, - ) { - } - + /** + * @param bool $read Permission to read data from the corresponding workspace (e.g. get hold of and traverse the content graph) + * @param bool $write Permission to write to the corresponding workspace, including publishing a derived workspace to it + * @param bool $manage Permission to change the metadata and roles of the corresponding workspace (e.g. change description/title or add/remove workspace roles) + */ public static function create( bool $read, bool $write, @@ -27,13 +31,20 @@ public static function create( return new self($read, $write, $manage); } - public static function all(): self - { - return new self(true, true, true); + /** + * @param bool $read Permission to read data from the corresponding workspace (e.g. get hold of and traverse the content graph) + * @param bool $write Permission to write to the corresponding workspace, including publishing a derived workspace to it + * @param bool $manage Permission to change the metadata and roles of the corresponding workspace (e.g. change description/title or add/remove workspace roles) + */ + private function __construct( + public bool $read, + public bool $write, + public bool $manage, + ) { } - public static function none(): self + public static function all(): self { - return new self(false, false, false); + return new self(true, true, true); } } From 8bafb5a509e574c3c01ccdc0b211550d52e1bdd7 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 16:16:41 +0200 Subject: [PATCH 33/43] Add more doc comments --- .../Classes/Domain/Model/WorkspaceClassification.php | 10 ++++++---- Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php | 2 ++ Neos.Neos/Classes/Domain/Model/WorkspaceRole.php | 2 +- .../Classes/Domain/Model/WorkspaceRoleSubject.php | 2 +- .../Classes/Domain/Model/WorkspaceRoleSubjectType.php | 4 ++++ 5 files changed, 14 insertions(+), 6 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php index 47f162a0ff3..6d24240d5df 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php @@ -5,13 +5,15 @@ namespace Neos\Neos\Domain\Model; /** + * The classification of a workspace – A workspace is always of one of the covered cases + * * @api */ enum WorkspaceClassification : string { - case PERSONAL = 'PERSONAL'; - case SHARED = 'SHARED'; - case ROOT = 'ROOT'; + case PERSONAL = 'PERSONAL'; // The personal workspace of a Neos user + case SHARED = 'SHARED'; // A workspace that can potentially be shared by multiple Neos users + case ROOT = 'ROOT'; // A workspace without a target, e.g. the "live" workspace - case UNKNOWN = 'UNKNOWN'; + case UNKNOWN = 'UNKNOWN'; // This case represents a classification that could not be determined (i.e. no corresponding workspace metadata exists) } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index 0f6e7932e59..46b931d33a9 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -8,6 +8,8 @@ use Neos\Flow\Annotations as Flow; /** + * Neos-specific metadata of a workspace + * * @api */ #[Flow\Proxy(false)] diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index dcb444599fc..3a9ce920e08 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -5,7 +5,7 @@ namespace Neos\Neos\Domain\Model; /** - * Role, a user can have in one workspace + * Role, a user or user group can have in one workspace * Note: "Owner" is not a role, owners implicitly always have all permissions * * @api diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php index 4fe05827d85..fb80329b09d 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubject.php @@ -7,7 +7,7 @@ use Neos\Flow\Annotations as Flow; /** - * The identifier of a workspace role subject that identifiers a group of users or a single user + * The identifier of a workspace role subject that identifiers a group of users or a single user {@see WorkspaceRoleSubjectType} * * @api */ diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php index 78777a834bd..f4b3eb71e0a 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleSubjectType.php @@ -5,6 +5,10 @@ namespace Neos\Neos\Domain\Model; /** + * Type of workspace role subject + * + * A workspace role can be assigned to a single user or a group (defined by the Flow role identifier) + * * @api */ enum WorkspaceRoleSubjectType : string From f68300a61217d54a6eebfd1e05352c85b40b915d Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Tue, 8 Oct 2024 17:07:29 +0200 Subject: [PATCH 34/43] wip --- .../Command/WorkspaceCommandController.php | 139 +++++++++++++++++- .../Classes/Domain/Model/WorkspaceRole.php | 4 +- .../Domain/Service/WorkspaceService.php | 87 ++++++++--- .../Controller/WorkspaceController.php | 10 +- 4 files changed, 215 insertions(+), 25 deletions(-) diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index f474189f0fc..e9fb7b86003 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -130,7 +130,9 @@ public function rebaseCommand(string $workspace, string $contentRepository = 'de } /** - * Create a new root workspace for a content repository. + * Create a new root workspace for a content repository + * + * NOTE: By default, only administrators can access workspaces without role assignments. Use workspace:assignrole to add workspace permissions * * @param string $name Name of the new root * @param string $contentRepository Identifier of the content repository. (Default: 'default') @@ -162,7 +164,8 @@ public function createRootCommand(string $name, string $contentRepository = 'def * @param string $contentRepository Identifier of the content repository. (Default: 'default') * @throws StopCommandException */ - public function createPersonalCommand(string $workspace, string $owner, string $baseWorkspace = 'live', string $title = null, string $description = null, string $contentRepository = 'default'): void { + public function createPersonalCommand(string $workspace, string $owner, string $baseWorkspace = 'live', string $title = null, string $description = null, string $contentRepository = 'default'): void + { $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); $workspaceOwner = $this->userService->getUser($owner); if ($workspaceOwner === null) { @@ -184,6 +187,8 @@ public function createPersonalCommand(string $workspace, string $owner, string $ /** * Create a new shared workspace * + * NOTE: By default, only administrators can access workspaces without role assignments. Use workspace:assignrole to add workspace permissions + * * @param string $workspace Name of the workspace, for example "christmas-campaign" * @param string $baseWorkspace Name of the base workspace. If none is specified, "live" is assumed. * @param string|null $title Human friendly title of the workspace, for example "Christmas Campaign" @@ -205,6 +210,136 @@ public function createSharedCommand(string $workspace, string $baseWorkspace = ' $this->outputLine('Created shared workspace "%s"', [$workspaceName->value]); } + /** + * Set/change the title of a workspace + * + * @param string $workspace Name of the workspace, for example "some-workspace" + * @param string $newTitle Human friendly title of the workspace, for example "Some workspace" + * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @throws StopCommandException + */ + public function setTitleCommand(string $workspace, string $newTitle, string $contentRepository = 'default'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $workspaceName = WorkspaceName::fromString($workspace); + $this->workspaceService->setWorkspaceTitle( + $contentRepositoryId, + $workspaceName, + WorkspaceTitle::fromString($newTitle), + ); + $this->outputLine('Set title of workspace "%s" to "%s"', [$workspaceName->value, $newTitle]); + } + + /** + * Set/change the description of a workspace + * + * @param string $workspace Name of the workspace, for example "some-workspace" + * @param string $newDescription Human friendly description of the workspace + * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @throws StopCommandException + */ + public function setDescriptionCommand(string $workspace, string $newDescription, string $contentRepository = 'default'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $workspaceName = WorkspaceName::fromString($workspace); + $this->workspaceService->setWorkspaceDescription( + $contentRepositoryId, + $workspaceName, + WorkspaceDescription::fromString($newDescription), + ); + $this->outputLine('Set description of workspace "%s"', [$workspaceName->value]); + } + + /** + * Assign a workspace role to the given user/user group + * + * Without explicit workspace roles, only administrators can change the corresponding workspace. + * With this command, a user or group (represented by a Flow role identifier) can be granted one of the two roles: + * - collaborator: Can read from and write to the workspace + * - manager: Can read from and write to the workspace and manage it (i.e. change metadata & role assignments) + * + * Examples: + * + * To grant editors read and write access to a (shared) workspace: ./flow workspace:assignrole some-workspace "Neos.Neos:AbstractEditor" collaborator + * + * To grant a specific user read, write and manage access to a workspace: ./flow workspace:assignrole some-workspace admin manager --type user + * + * {@see WorkspaceRole} + * + * @param string $workspace Name of the workspace, for example "some-workspace" + * @param string $subject The user/group that should be assigned. By default, this is expected to be a Flow role identifier (e.g. 'Neos.Neos:AbstractEditor') – if $type is 'user', this is the username (aka account identifier) of a Neos user + * @param string $role Role to assign, either 'collaborator' or 'manager' – a collaborator can read and write from/to the workspace. A manager can _on top_ change the workspace metadata & roles itself + * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @param string $type Type of role, either 'group' (default) or 'user' – if 'group', $subject is expected to be a Flow role identifier, otherwise the username (aka account identifier) of a Neos user + * @throws StopCommandException + */ + public function assignRoleCommand(string $workspace, string $subject, string $role, string $contentRepository = 'default', string $type = 'group'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $workspaceName = WorkspaceName::fromString($workspace); + + $subjectType = match ($type) { + 'group' => WorkspaceRoleSubjectType::GROUP, + 'user' => WorkspaceRoleSubjectType::USER, + default => throw new \InvalidArgumentException(sprintf('type must be "group" or "user", given "%s"', $type), 1728398802), + }; + $workspaceRole = match ($role) { + 'collaborator' => WorkspaceRole::COLLABORATOR, + 'manager' => WorkspaceRole::MANAGER, + default => throw new \InvalidArgumentException(sprintf('role must be "collaborator" or "manager", given "%s"', $role), 1728398880), + }; + if ($subjectType === WorkspaceRoleSubjectType::USER) { + $neosUser = $this->userService->getUser($subject); + if ($neosUser === null) { + $this->outputLine('The user "%s" specified as subject does not exist', [$subject]); + $this->quit(1); + } + $roleSubject = WorkspaceRoleSubject::fromString($neosUser->getId()->value); + } else { + $roleSubject = WorkspaceRoleSubject::fromString($subject); + } + $this->workspaceService->assignWorkspaceRole( + $contentRepositoryId, + $workspaceName, + $subjectType, + $roleSubject, + $workspaceRole, + ); + $this->outputLine('Assigned role "%s" to subject "%s" for workspace "%s"', [$workspaceRole->value, $roleSubject->value, $workspaceName->value]); + } + + /** + * Unassign a workspace role from the given user/user group + * + * @see assignRoleCommand() + * + * @param string $workspace Name of the workspace, for example "some-workspace" + * @param string $subject The user/group that should be unassigned. By default, this is expected to be a Flow role identifier (e.g. 'Neos.Neos:AbstractEditor') – if $type is 'user', this is the username (aka account identifier) of a Neos user + * @param string $contentRepository Identifier of the content repository. (Default: 'default') + * @param string $type Type of role, either 'group' (default) or 'user' – if 'group', $subject is expected to be a Flow role identifier, otherwise the username (aka account identifier) of a Neos user + * @throws StopCommandException + */ + public function unassignRoleCommand(string $workspace, string $subject, string $contentRepository = 'default', string $type = 'group'): void + { + $contentRepositoryId = ContentRepositoryId::fromString($contentRepository); + $workspaceName = WorkspaceName::fromString($workspace); + + $subjectType = match ($type) { + 'group' => WorkspaceRoleSubjectType::GROUP, + 'user' => WorkspaceRoleSubjectType::USER, + default => throw new \InvalidArgumentException(sprintf('type must be "group" or "user", given "%s"', $type), 1728398802), + }; + $roleSubject = WorkspaceRoleSubject::fromString($subject); + $this->workspaceService->unassignWorkspaceRole( + $contentRepositoryId, + $workspaceName, + $subjectType, + $roleSubject, + ); + $this->outputLine('Removed role assignment from subject "%s" for workspace "%s"', [$roleSubject->value, $workspaceName->value]); + } + + /** * Deletes a workspace * diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index 3a9ce920e08..1361eaa9188 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -12,8 +12,8 @@ */ enum WorkspaceRole : string { - case COLLABORATOR = 'COLLABORATOR'; - case MANAGER = 'MANAGER'; + case COLLABORATOR = 'COLLABORATOR'; // Can read from and write to the workspace + case MANAGER = 'MANAGER'; // Can read from and write to the workspace and manage it (i.e. change metadata & role assignments) public function isAtLeast(self $role): bool { diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index edf84c028de..7ebc4d7f48c 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -41,6 +41,8 @@ use Neos\Neos\Domain\Model\WorkspaceTitle; /** + * Central authority to interact with Content Repository Workspaces within Neos + * * @api */ #[Flow\Scope('singleton')] @@ -58,6 +60,8 @@ public function __construct( /** * Load metadata for the specified workspace + * + * Note: If no metadata exists for the specified workspace, an instance with classification {@see WorkspaceClassification::UNKNOWN} is returned! */ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceMetadata { @@ -73,13 +77,23 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W } /** - * Change title and/or description metadata for the specified workspace + * Update/set title metadata for the specified workspace */ - public function updateWorkspaceTitleAndDescription(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle, WorkspaceDescription $newWorkspaceDescription): void + public function setWorkspaceTitle(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle): void { $this->requireWorkspace($contentRepositoryId, $workspaceName); $this->updateWorkspaceMetadata($contentRepositoryId, $workspaceName, [ 'title' => $newWorkspaceTitle->value, + ]); + } + + /** + * Update/set description metadata for the specified workspace + */ + public function setWorkspaceDescription(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceDescription $newWorkspaceDescription): void + { + $this->requireWorkspace($contentRepositoryId, $workspaceName); + $this->updateWorkspaceMetadata($contentRepositoryId, $workspaceName, [ 'description' => $newWorkspaceDescription->value, ]); } @@ -154,6 +168,48 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con ); } + /** + * Assign a workspace role to the given user/user group + * + * Without explicit workspace roles, only administrators can change the corresponding workspace. + * With this method, the subject (i.e. a Neos user or group represented by a Flow role identifier) can be granted a {@see WorkspaceRole} for the specified workspace + */ + public function assignWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleSubjectType $subjectType, WorkspaceRoleSubject $subject, WorkspaceRole $role): void + { + $this->requireWorkspace($contentRepositoryId, $workspaceName); + try { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => $subjectType->value, + 'subject' => $subject->value, + 'role' => $role->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject->value, $contentRepositoryId->value, $e->getMessage()), 1728396138, $e); + } + } + + /** + * Remove a workspace role assignment for the given subject + * + * @see self::assignWorkspaceRole() + */ + public function unassignWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleSubjectType $subjectType, WorkspaceRoleSubject $subject): void + { + $this->requireWorkspace($contentRepositoryId, $workspaceName); + try { + $this->dbal->delete(self::TABLE_NAME_WORKSPACE_ROLE, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'subject_type' => $subjectType->value, + 'subject' => $subject->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to unassign role for subject "%s" from workspace "%s" (Content Repository "%s"): %s', $subject->value, $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728396169, $e); + } + } + /** * Determines the permission the given user has for the specified workspace {@see WorkspacePermissions} */ @@ -247,10 +303,20 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, private function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, array $data): void { try { - $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, $data, [ + $affectedRows = $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, $data, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, ]); + if ($affectedRows === 0) { + $this->dbal->insert(self::TABLE_NAME_WORKSPACE_METADATA, [ + 'content_repository_id' => $contentRepositoryId->value, + 'workspace_name' => $workspaceName->value, + 'description' => '', + 'title' => '', + 'classification' => WorkspaceClassification::UNKNOWN->value, + ...$data, + ]); + } } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to update metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1726821159, $e); } @@ -308,21 +374,6 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } - public function addWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleSubjectType $subjectType, WorkspaceRoleSubject $subject, WorkspaceRole $role): void - { - try { - $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ - 'content_repository_id' => $contentRepositoryId->value, - 'workspace_name' => $workspaceName->value, - 'subject_type' => $subjectType->value, - 'subject' => $subject->value, - 'role' => $role->value, - ]); - } catch (DbalException $e) { - throw new \RuntimeException(sprintf('Failed to add metadata for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1727084068, $e); - } - } - private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): ?WorkspaceRole { try { diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 48501aa296a..5f4588cfb7f 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -224,14 +224,14 @@ public function createAction( ); $this->redirect('new'); } - $this->workspaceService->addWorkspaceRole( + $this->workspaceService->assignWorkspaceRole( $contentRepositoryId, $workspaceName, WorkspaceRoleSubjectType::USER, WorkspaceRoleSubject::fromString($currentUser->getId()->value), WorkspaceRole::MANAGER, ); - $this->workspaceService->addWorkspaceRole( + $this->workspaceService->assignWorkspaceRole( $contentRepositoryId, $workspaceName, WorkspaceRoleSubjectType::GROUP, @@ -297,10 +297,14 @@ public function updateAction( ); $this->redirect('index'); } - $this->workspaceService->updateWorkspaceTitleAndDescription( + $this->workspaceService->setWorkspaceTitle( $contentRepositoryId, $workspaceName, $title, + ); + $this->workspaceService->setWorkspaceDescription( + $contentRepositoryId, + $workspaceName, $description, ); $this->addFlashMessage($this->translator->translateById( From 7d6a819a97fd9958a7a9b852a7776106a6bf91ff Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 12:05:31 +0200 Subject: [PATCH 35/43] Fix and improve Behat tests for WorkspaceService ...and fix the discovered bugs along the way o.O --- .../Domain/Service/WorkspaceService.php | 11 +- .../Features/Bootstrap/ExceptionsTrait.php | 59 ++++++++ .../Bootstrap/WorkspaceServiceTrait.php | 114 +++++++++++---- .../WorkspaceService.feature | 137 +++++++++--------- 4 files changed, 215 insertions(+), 106 deletions(-) create mode 100644 Neos.Neos/Tests/Behavior/Features/Bootstrap/ExceptionsTrait.php diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 7ebc4d7f48c..d79001c2ca2 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -65,13 +65,13 @@ public function __construct( */ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceMetadata { - $crWorkspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); + $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); return $metadata ?? new WorkspaceMetadata( $workspaceName, WorkspaceTitle::fromString($workspaceName->value), WorkspaceDescription::fromString(''), - $crWorkspace->baseWorkspaceName !== null ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, + $workspace->baseWorkspaceName === null ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, null, ); } @@ -81,7 +81,6 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W */ public function setWorkspaceTitle(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceTitle $newWorkspaceTitle): void { - $this->requireWorkspace($contentRepositoryId, $workspaceName); $this->updateWorkspaceMetadata($contentRepositoryId, $workspaceName, [ 'title' => $newWorkspaceTitle->value, ]); @@ -92,7 +91,6 @@ public function setWorkspaceTitle(ContentRepositoryId $contentRepositoryId, Work */ public function setWorkspaceDescription(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceDescription $newWorkspaceDescription): void { - $this->requireWorkspace($contentRepositoryId, $workspaceName); $this->updateWorkspaceMetadata($contentRepositoryId, $workspaceName, [ 'description' => $newWorkspaceDescription->value, ]); @@ -302,6 +300,7 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, */ private function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, array $data): void { + $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); try { $affectedRows = $this->dbal->update(self::TABLE_NAME_WORKSPACE_METADATA, $data, [ 'content_repository_id' => $contentRepositoryId->value, @@ -312,8 +311,8 @@ private function updateWorkspaceMetadata(ContentRepositoryId $contentRepositoryI 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, 'description' => '', - 'title' => '', - 'classification' => WorkspaceClassification::UNKNOWN->value, + 'title' => $workspaceName->value, + 'classification' => $workspace->baseWorkspaceName === null ? WorkspaceClassification::ROOT->value : WorkspaceClassification::UNKNOWN->value, ...$data, ]); } diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/ExceptionsTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/ExceptionsTrait.php new file mode 100644 index 00000000000..fabfcd12608 --- /dev/null +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/ExceptionsTrait.php @@ -0,0 +1,59 @@ +lastCaughtException !== null) { + throw new \RuntimeException(sprintf('Can\'t execute new commands before catching previous exception: %s', $this->lastCaughtException->getMessage()), 1728464381, $this->lastCaughtException); + } + try { + return $callback(); + } catch (\Exception $exception) { + $this->lastCaughtException = $exception; + return null; + } + } + + /** + * @Then an exception :exceptionMessage should be thrown + */ + public function anExceptionShouldBeThrown(string $exceptionMessage): void + { + Assert::assertNotNull($this->lastCaughtException, 'Expected an exception but none was thrown'); + Assert::assertSame($exceptionMessage, $this->lastCaughtException->getMessage()); + $this->lastCaughtException = null; + } + + /** + * @BeforeScenario + * @AfterScenario + */ + public function afterScenarioExceptionsTrait(): void + { + if ($this->lastCaughtException !== null) { + throw new \RuntimeException(sprintf('Previous exception was not handled: %s', $this->lastCaughtException->getMessage()), 1728464379, $this->lastCaughtException); + } + } +} diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index 9ad574f4a3b..d8e044c5ff9 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -1,8 +1,9 @@ getObject(WorkspaceService::class)->createRootWorkspace( + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->createRootWorkspace( $this->currentContentRepository->id, WorkspaceName::fromString($workspaceName), - WorkspaceTitle::fromString($workspaceName), - WorkspaceDescription::fromString(''), - ); + WorkspaceTitle::fromString($title ?? $workspaceName), + WorkspaceDescription::fromString($description ?? ''), + )); } /** - * @When the personal workspace :workspaceName is created with the target workspace :targetWorkspace + * @When the personal workspace :workspaceName is created with the target workspace :targetWorkspace for user :ownerUserId */ - public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceName, string $targetWorkspace): void + public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceName, string $targetWorkspace, string $ownerUserId): void { - $this->getObject(WorkspaceService::class)->createPersonalWorkspace( + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->createPersonalWorkspace( $this->currentContentRepository->id, WorkspaceName::fromString($workspaceName), WorkspaceTitle::fromString($workspaceName), WorkspaceDescription::fromString(''), WorkspaceName::fromString($targetWorkspace), - UserId::fromString(FakeUserIdProvider::$userId?->value ?? ''), - ); + UserId::fromString($ownerUserId), + )); } /** @@ -71,33 +78,78 @@ public function thePersonalWorkspaceIsCreatedWithTheTargetWorkspace(string $work */ public function theSharedWorkspaceIsCreatedWithTheTargetWorkspace(string $workspaceName, string $targetWorkspace): void { - $this->getObject(WorkspaceService::class)->createSharedWorkspace( + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->createSharedWorkspace( $this->currentContentRepository->id, WorkspaceName::fromString($workspaceName), WorkspaceTitle::fromString($workspaceName), WorkspaceDescription::fromString(''), WorkspaceName::fromString($targetWorkspace), - ); + )); + } + + /** + * @When a root workspace :workspaceName exists without metadata + */ + public function aRootWorkspaceExistsWithoutMetadata(string $workspaceName): void + { + $this->currentContentRepository->handle(CreateRootWorkspace::create( + WorkspaceName::fromString($workspaceName), + DeprecatedWorkspaceTitle::fromString($workspaceName), + DeprecatedWorkspaceDescription::fromString(''), + ContentStreamId::create(), + )); + } + + /** + * @When a workspace :arg1 with base workspace :arg2 exists without metadata + */ + public function aWorkspaceWithBaseWorkspaceExistsWithoutMetadata(string $workspaceName, string $baseWorkspaceName): void + { + $this->currentContentRepository->handle(CreateWorkspace::create( + WorkspaceName::fromString($workspaceName), + WorkspaceName::fromString($baseWorkspaceName), + DeprecatedWorkspaceTitle::fromString($workspaceName), + DeprecatedWorkspaceDescription::fromString(''), + ContentStreamId::create(), + )); + } + + /** + * @When the title of workspace :workspaceName is set to :newTitle + */ + public function theTitleOfWorkspaceIsSetTo(string $workspaceName, string $newTitle): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->setWorkspaceTitle( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + WorkspaceTitle::fromString($newTitle), + )); + } + + /** + * @When the description of workspace :workspaceName is set to :newDescription + */ + public function theDescriptionOfWorkspaceIsSetTo(string $workspaceName, string $newDescription): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->setWorkspaceDescription( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + WorkspaceDescription::fromString($newDescription), + )); } /** - * @Then the following workspaces should exist: + * @Then the workspace :workspaceName should have the following metadata: */ - public function theFollowingWorkspacesShouldExist(TableNode $expectedWorkspacesTable): void + public function theWorkspaceShouldHaveTheFollowingMetadata($workspaceName, TableNode $expectedMetadata): void { - $expectedWorkspaces = $expectedWorkspacesTable->getHash(); - $actualWorkspaces = []; - $workspaceFinder = $this->currentContentRepository->getWorkspaceFinder(); - $workspaceService = $this->getObject(WorkspaceService::class); - foreach ($workspaceFinder->findAll() as $workspace) { - $workspaceMetadata = $workspaceService->getWorkspaceMetadata($this->currentContentRepository->id, $workspace->workspaceName); - $actualWorkspaces[] = [ - 'Name' => $workspace->workspaceName->value, - 'Base workspace' => $workspace->baseWorkspaceName?->value ?? '', - 'Title' => $workspaceMetadata->title->value, - 'Classification' => $workspaceMetadata->classification->value, - ]; - } - Assert::same($expectedWorkspaces, $actualWorkspaces); + $workspaceMetadata = $this->getObject(WorkspaceService::class)->getWorkspaceMetadata($this->currentContentRepository->id, WorkspaceName::fromString($workspaceName)); + Assert::assertSame($expectedMetadata->getHash()[0], [ + 'Workspace name' => $workspaceMetadata->workspaceName->value, + 'Title' => $workspaceMetadata->title->value, + 'Description' => $workspaceMetadata->description->value, + 'Classification' => $workspaceMetadata->classification->value, + 'Owner user id' => $workspaceMetadata->ownerUserId?->value ?? '', + ]); } } diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature index 5c8eaac6faa..bea118232bf 100644 --- a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -11,80 +11,79 @@ Feature: Neos WorkspaceService related features And I am in content repository "default" And I am user identified by "editor" - Scenario: Create single root workspace - When the root workspace "Some root workspace" is created - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | some-root-workspace | | Some root workspace | ROOT | + Scenario: Create single root workspace without specifying title and description + When the root workspace "some-root-workspace" is created + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | some-root-workspace | | ROOT | | - Scenario: Create root workspace with a title that exceeds the workspace name max length - When the root workspace "Some root workspace with a title that exceeds the max name length" is created - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | some-root-workspace-with-a-title-tha | | Some root workspace with a title that exceeds the max name length | ROOT | + Scenario: Create single root workspace with title and description + When the root workspace "some-root-workspace" with title "Some root workspace" and description "Some description" is created + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | Some root workspace | Some description | ROOT | | - Scenario: Create multiple root workspaces with the same derived name - When the root workspace "Root" is created - And the root workspace "Root 5" is created - And the root workspace "root" is created - And the root workspace "-Root" is created - And the root workspace "Root" is created - And the root workspace "Root" is created - And the root workspace "Root" is created - And the root workspace "Root" is created - And the root workspace "Root" is created - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | root | | Root | ROOT | - | root-1 | | root | ROOT | - | root-2 | | -Root | ROOT | - | root-3 | | Root | ROOT | - | root-4 | | Root | ROOT | - | root-5 | | Root 5 | ROOT | - | root-6 | | Root | ROOT | - | root-7 | | Root | ROOT | - | root-8 | | Root | ROOT | + Scenario: Create root workspace with a name that exceeds the workspace name max length + When the root workspace "some-name-that-exceeds-the-max-allowed-length" is created + Then an exception 'Invalid workspace name "some-name-that-exceeds-the-max-allowed-length" given. A workspace name has to consist of at most 36 lower case characters' should be thrown + + Scenario: Create root workspace with a name that is already used + Given the root workspace "some-root-workspace" is created + When the root workspace "some-root-workspace" is created + Then an exception "The workspace some-root-workspace already exists" should be thrown + + Scenario: Get metadata of non-existing root workspace + When a root workspace "some-root-workspace" exists without metadata + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | some-root-workspace | | ROOT | | + + Scenario: Change title of root workspace + When the root workspace "some-root-workspace" is created + And the title of workspace "some-root-workspace" is set to "Some new workspace title" + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | Some new workspace title | | ROOT | | + + Scenario: Set title of root workspace without metadata + When a root workspace "some-root-workspace" exists without metadata + And the title of workspace "some-root-workspace" is set to "Some new workspace title" + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | Some new workspace title | | ROOT | | + + Scenario: Change description of root workspace + When the root workspace "some-root-workspace" is created + And the description of workspace "some-root-workspace" is set to "Some new workspace description" + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | some-root-workspace | Some new workspace description | ROOT | | + + Scenario: Change description of root workspace without metadata + When a root workspace "some-root-workspace" exists without metadata + And the description of workspace "some-root-workspace" is set to "Some new workspace description" + Then the workspace "some-root-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-root-workspace | some-root-workspace | Some new workspace description | ROOT | | - Scenario: Create multiple root workspaces with the same derived name with a lenght that exceeds the allowed max length - And the root workspace "some-root-workspace-with-a-long-title" is created - And the root workspace "some-root-workspace-with-a-long-title" is created - And the root workspace "some-root-workspace-with-a-long-title" is created - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | some-root-workspace-with-a-long-ti-1 | | some-root-workspace-with-a-long-title | ROOT | - | some-root-workspace-with-a-long-ti-2 | | some-root-workspace-with-a-long-title | ROOT | - | some-root-workspace-with-a-long-titl | | some-root-workspace-with-a-long-title | ROOT | Scenario: Create a single personal workspace - When the root workspace "Some root workspace" is created - And the personal workspace "Some user workspace" is created with the target workspace "some-root-workspace" - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | some-root-workspace | | Some root workspace | ROOT | - | some-user-workspace | some-root-workspace | Some user workspace | PERSONAL | + When the root workspace "some-root-workspace" is created + And the personal workspace "some-user-workspace" is created with the target workspace "some-root-workspace" for user "some-user-id" + Then the workspace "some-user-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-user-workspace | some-user-workspace | | PERSONAL | some-user-id | Scenario: Create a single shared workspace - When the root workspace "Some root workspace" is created - And the shared workspace "Some shared workspace" is created with the target workspace "some-root-workspace" - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | some-root-workspace | | Some root workspace | ROOT | - | some-shared-workspace | some-root-workspace | Some shared workspace | SHARED | + When the root workspace "some-root-workspace" is created + And the shared workspace "some-shared-workspace" is created with the target workspace "some-root-workspace" + Then the workspace "some-shared-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-shared-workspace | some-shared-workspace | | SHARED | | - Scenario: Creating several workspaces with the same derived names - When the root workspace "root 1" is created - And the root workspace "Root 2" is created - And the personal workspace "User 1" is created with the target workspace "root-1" - And the personal workspace "User 2" is created with the target workspace "root-2" - And the personal workspace "root 1" is created with the target workspace "root-2" - And the shared workspace "Root 1" is created with the target workspace "root-2" - And the shared workspace "Shared 2" is created with the target workspace "root-1" - Then the following workspaces should exist: - | Name | Base workspace | Title | Classification | - | root-1 | | root 1 | ROOT | - | root-1-1 | root-2 | root 1 | PERSONAL | - | root-1-2 | root-2 | Root 1 | SHARED | - | root-2 | | Root 2 | ROOT | - | shared-2 | root-1 | Shared 2 | SHARED | - | user-1 | root-1 | User 1 | PERSONAL | - | user-2 | root-2 | User 2 | PERSONAL | + Scenario: Get metadata of non-existing sub workspace + Given the root workspace "some-root-workspace" is created + When a workspace "some-workspace" with base workspace "some-root-workspace" exists without metadata + Then the workspace "some-workspace" should have the following metadata: + | Workspace name | Title | Description | Classification | Owner user id | + | some-workspace | some-workspace | | UNKNOWN | | From 3b3d718ae3c6a45c899da2cf8f3deb1c8f0975fa Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 14:06:39 +0200 Subject: [PATCH 36/43] Remove `workspaceName` from `WorkspaceMetadata` --- .../Domain/Model/WorkspaceMetadata.php | 17 -------- .../Domain/Service/WorkspaceService.php | 2 - .../Bootstrap/WorkspaceServiceTrait.php | 1 - .../WorkspaceService.feature | 40 +++++++++---------- 4 files changed, 20 insertions(+), 40 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index 46b931d33a9..7421014d386 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -16,27 +16,10 @@ final readonly class WorkspaceMetadata { public function __construct( - public WorkspaceName $workspaceName, public WorkspaceTitle $title, public WorkspaceDescription $description, public WorkspaceClassification $classification, public UserId|null $ownerUserId, ) { } - - /** - * Note: To be used with named arguments! - */ - public function with( - WorkspaceTitle $title = null, - WorkspaceDescription $description = null, - ): self { - return new self( - $this->workspaceName, - $title ?? $this->title, - $description ?? $this->description, - $this->classification, - $this->ownerUserId, - ); - } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index d79001c2ca2..11276aac95a 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -68,7 +68,6 @@ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, W $workspace = $this->requireWorkspace($contentRepositoryId, $workspaceName); $metadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); return $metadata ?? new WorkspaceMetadata( - $workspaceName, WorkspaceTitle::fromString($workspaceName->value), WorkspaceDescription::fromString(''), $workspace->baseWorkspaceName === null ? WorkspaceClassification::ROOT : WorkspaceClassification::UNKNOWN, @@ -287,7 +286,6 @@ private function loadWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, return null; } return new WorkspaceMetadata( - $workspaceName, WorkspaceTitle::fromString($metadataRow['title']), WorkspaceDescription::fromString($metadataRow['description']), WorkspaceClassification::from($metadataRow['classification']), diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index d8e044c5ff9..71ab1a2a94a 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -145,7 +145,6 @@ public function theWorkspaceShouldHaveTheFollowingMetadata($workspaceName, Table { $workspaceMetadata = $this->getObject(WorkspaceService::class)->getWorkspaceMetadata($this->currentContentRepository->id, WorkspaceName::fromString($workspaceName)); Assert::assertSame($expectedMetadata->getHash()[0], [ - 'Workspace name' => $workspaceMetadata->workspaceName->value, 'Title' => $workspaceMetadata->title->value, 'Description' => $workspaceMetadata->description->value, 'Classification' => $workspaceMetadata->classification->value, diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature index bea118232bf..205b9c32968 100644 --- a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -14,14 +14,14 @@ Feature: Neos WorkspaceService related features Scenario: Create single root workspace without specifying title and description When the root workspace "some-root-workspace" is created Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | some-root-workspace | | ROOT | | + | Title | Description | Classification | Owner user id | + | some-root-workspace | | ROOT | | Scenario: Create single root workspace with title and description When the root workspace "some-root-workspace" with title "Some root workspace" and description "Some description" is created Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | Some root workspace | Some description | ROOT | | + | Title | Description | Classification | Owner user id | + | Some root workspace | Some description | ROOT | | Scenario: Create root workspace with a name that exceeds the workspace name max length When the root workspace "some-name-that-exceeds-the-max-allowed-length" is created @@ -35,55 +35,55 @@ Feature: Neos WorkspaceService related features Scenario: Get metadata of non-existing root workspace When a root workspace "some-root-workspace" exists without metadata Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | some-root-workspace | | ROOT | | + | Title | Description | Classification | Owner user id | + | some-root-workspace | | ROOT | | Scenario: Change title of root workspace When the root workspace "some-root-workspace" is created And the title of workspace "some-root-workspace" is set to "Some new workspace title" Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | Some new workspace title | | ROOT | | + | Title | Description | Classification | Owner user id | + | Some new workspace title | | ROOT | | Scenario: Set title of root workspace without metadata When a root workspace "some-root-workspace" exists without metadata And the title of workspace "some-root-workspace" is set to "Some new workspace title" Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | Some new workspace title | | ROOT | | + | Title | Description | Classification | Owner user id | + | Some new workspace title | | ROOT | | Scenario: Change description of root workspace When the root workspace "some-root-workspace" is created And the description of workspace "some-root-workspace" is set to "Some new workspace description" Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | some-root-workspace | Some new workspace description | ROOT | | + | Title | Description | Classification | Owner user id | + | some-root-workspace | Some new workspace description | ROOT | | Scenario: Change description of root workspace without metadata When a root workspace "some-root-workspace" exists without metadata And the description of workspace "some-root-workspace" is set to "Some new workspace description" Then the workspace "some-root-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-root-workspace | some-root-workspace | Some new workspace description | ROOT | | + | Title | Description | Classification | Owner user id | + | some-root-workspace | Some new workspace description | ROOT | | Scenario: Create a single personal workspace When the root workspace "some-root-workspace" is created And the personal workspace "some-user-workspace" is created with the target workspace "some-root-workspace" for user "some-user-id" Then the workspace "some-user-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-user-workspace | some-user-workspace | | PERSONAL | some-user-id | + | Title | Description | Classification | Owner user id | + | some-user-workspace | | PERSONAL | some-user-id | Scenario: Create a single shared workspace When the root workspace "some-root-workspace" is created And the shared workspace "some-shared-workspace" is created with the target workspace "some-root-workspace" Then the workspace "some-shared-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-shared-workspace | some-shared-workspace | | SHARED | | + | Title | Description | Classification | Owner user id | + | some-shared-workspace | | SHARED | | Scenario: Get metadata of non-existing sub workspace Given the root workspace "some-root-workspace" is created When a workspace "some-workspace" with base workspace "some-root-workspace" exists without metadata Then the workspace "some-workspace" should have the following metadata: - | Workspace name | Title | Description | Classification | Owner user id | - | some-workspace | some-workspace | | UNKNOWN | | + | Title | Description | Classification | Owner user id | + | some-workspace | | UNKNOWN | | From e284cf007f468c407ef6f35bc399163dc1356b70 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 14:07:33 +0200 Subject: [PATCH 37/43] Fix typo in private method --- Neos.Neos/Classes/Domain/Model/WorkspaceRole.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index 1361eaa9188..f91bb5acbc2 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -17,10 +17,10 @@ enum WorkspaceRole : string public function isAtLeast(self $role): bool { - return $this->specifity() >= $role->specifity(); + return $this->specificity() >= $role->specificity(); } - private function specifity(): int + private function specificity(): int { return match ($this) { self::COLLABORATOR => 1, From cc85cbf6bd15ed50d983ab119a0c5c516191c2cb Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Wed, 9 Oct 2024 14:19:33 +0200 Subject: [PATCH 38/43] TASK: Improve documentation --- .../Domain/Model/WorkspaceClassification.php | 26 ++++++++++++++++--- .../Domain/Model/WorkspaceMetadata.php | 16 ------------ .../Classes/Domain/Model/WorkspaceRole.php | 11 ++++++-- .../Domain/Service/WorkspaceService.php | 4 ++- 4 files changed, 34 insertions(+), 23 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php index 6d24240d5df..63ee82f0d38 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceClassification.php @@ -4,6 +4,8 @@ namespace Neos\Neos\Domain\Model; +use Neos\Neos\Domain\Service\WorkspaceService; + /** * The classification of a workspace – A workspace is always of one of the covered cases * @@ -11,9 +13,25 @@ */ enum WorkspaceClassification : string { - case PERSONAL = 'PERSONAL'; // The personal workspace of a Neos user - case SHARED = 'SHARED'; // A workspace that can potentially be shared by multiple Neos users - case ROOT = 'ROOT'; // A workspace without a target, e.g. the "live" workspace + /** + * The personal workspace of a Neos user + */ + case PERSONAL = 'PERSONAL'; + + /** + * A workspace that can potentially be shared by multiple Neos users + */ + case SHARED = 'SHARED'; + + /** + * A workspace without a target, e.g. the "live" workspace + */ + case ROOT = 'ROOT'; - case UNKNOWN = 'UNKNOWN'; // This case represents a classification that could not be determined (i.e. no corresponding workspace metadata exists) + /** + * A non-root content repository workspace without corresponding metadata + * + * In case workspaces were created through the content repository and not through Neos' {@see WorkspaceService} + */ + case UNKNOWN = 'UNKNOWN'; } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index 46b931d33a9..b2bebc8147c 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -23,20 +23,4 @@ public function __construct( public UserId|null $ownerUserId, ) { } - - /** - * Note: To be used with named arguments! - */ - public function with( - WorkspaceTitle $title = null, - WorkspaceDescription $description = null, - ): self { - return new self( - $this->workspaceName, - $title ?? $this->title, - $description ?? $this->description, - $this->classification, - $this->ownerUserId, - ); - } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php index 1361eaa9188..40842ecd4dd 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRole.php @@ -12,8 +12,15 @@ */ enum WorkspaceRole : string { - case COLLABORATOR = 'COLLABORATOR'; // Can read from and write to the workspace - case MANAGER = 'MANAGER'; // Can read from and write to the workspace and manage it (i.e. change metadata & role assignments) + /** + * Can read from and write to the workspace + */ + case COLLABORATOR = 'COLLABORATOR'; + + /** + * Can read from and write to the workspace and manage it (i.e. change metadata & role assignments) + */ + case MANAGER = 'MANAGER'; public function isAtLeast(self $role): bool { diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index d79001c2ca2..b9c8cb3ca33 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -61,7 +61,9 @@ public function __construct( /** * Load metadata for the specified workspace * - * Note: If no metadata exists for the specified workspace, an instance with classification {@see WorkspaceClassification::UNKNOWN} is returned! + * Note: If no metadata exists for the specified workspace, metadata with title based on the name and classification + * according to the content repository workspace is returned. Root workspaces are of classification ROOT whereas simple ones will yield UNKNOWN. + * {@see WorkspaceClassification::UNKNOWN} */ public function getWorkspaceMetadata(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceMetadata { From 5fc33d5cd3804c714757b38aedec2f9537818b82 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 14:35:12 +0200 Subject: [PATCH 39/43] Allow to determine Workspace role assignments --- .../Command/WorkspaceCommandController.php | 18 +++++++ .../Domain/Model/WorkspaceRoleAssignment.php | 23 ++++++++ .../Domain/Model/WorkspaceRoleAssignments.php | 48 +++++++++++++++++ .../Domain/Service/WorkspaceService.php | 49 ++++++++++++++++- .../Bootstrap/WorkspaceServiceTrait.php | 47 +++++++++++++++++ .../WorkspaceService.feature | 52 +++++++++++++++++++ 6 files changed, 236 insertions(+), 1 deletion(-) create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignments.php diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index e9fb7b86003..a066a36452d 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -31,6 +31,7 @@ use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceDescription; use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; use Neos\Neos\Domain\Model\WorkspaceRoleSubject; use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; @@ -519,5 +520,22 @@ public function showCommand(string $workspace, string $contentRepository = 'defa $this->outputFormatted('Description: %s', [$workspaceMetadata->description->value]); $this->outputFormatted('Status: %s', [$workspacesInstance->status->value]); $this->outputFormatted('Content Stream: %s', [$workspacesInstance->currentContentStreamId->value]); + + $workspaceRoleAssignments = $this->workspaceService->getWorkspaceRoleAssignments($contentRepositoryId, $workspaceName); + $this->outputLine(); + $this->outputLine('Role assignments:'); + if ($workspaceRoleAssignments->isEmpty()) { + $this->outputLine('There are no role assignments for workspace "%s". Use the workspace:assignrole command to assign roles', [$workspaceName->value]); + return; + } + $this->output->outputTable(array_map(static fn (WorkspaceRoleAssignment $assignment) => [ + $assignment->subjectType->value, + $assignment->subject->value, + $assignment->role->value, + ], iterator_to_array($workspaceRoleAssignments)), [ + 'Subject type', + 'Subject', + 'Role', + ]); } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php new file mode 100644 index 00000000000..ba6e6370138 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php @@ -0,0 +1,23 @@ + + * @api + */ +#[Flow\Proxy(false)] +final readonly class WorkspaceRoleAssignments implements \IteratorAggregate, \Countable +{ + private array $assignments; + + private function __construct(WorkspaceRoleAssignment ...$assignments) + { + $this->assignments = $assignments; + } + + /** + * @param array $assignments + */ + public static function fromArray(array $assignments): self + { + return new self(...$assignments); + } + + public function isEmpty(): bool + { + return $this->assignments === []; + } + + public function getIterator(): Traversable + { + yield from $this->assignments; + } + + public function count(): int + { + return count($this->assignments); + } +} diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index ecd51f928ff..1131422a81d 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -17,6 +17,7 @@ use Doctrine\DBAL\ArrayParameterType; use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception as DbalException; +use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; @@ -36,6 +37,8 @@ use Neos\Neos\Domain\Model\WorkspaceMetadata; use Neos\Neos\Domain\Model\WorkspacePermissions; use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignments; use Neos\Neos\Domain\Model\WorkspaceRoleSubject; use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; @@ -184,6 +187,8 @@ public function assignWorkspaceRole(ContentRepositoryId $contentRepositoryId, Wo 'subject' => $subject->value, 'role' => $role->value, ]); + } catch (UniqueConstraintViolationException $e) { + throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): There is already a role assigned for that user/group, please unassign that first', $workspaceName->value, $subject->value, $contentRepositoryId->value), 1728476154, $e); } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject->value, $contentRepositoryId->value, $e->getMessage()), 1728396138, $e); } @@ -198,7 +203,7 @@ public function unassignWorkspaceRole(ContentRepositoryId $contentRepositoryId, { $this->requireWorkspace($contentRepositoryId, $workspaceName); try { - $this->dbal->delete(self::TABLE_NAME_WORKSPACE_ROLE, [ + $affectedRows = $this->dbal->delete(self::TABLE_NAME_WORKSPACE_ROLE, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, 'subject_type' => $subjectType->value, @@ -207,6 +212,43 @@ public function unassignWorkspaceRole(ContentRepositoryId $contentRepositoryId, } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to unassign role for subject "%s" from workspace "%s" (Content Repository "%s"): %s', $subject->value, $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728396169, $e); } + if ($affectedRows === 0) { + throw new \RuntimeException(sprintf('Failed to unassign role for subject "%s" from workspace "%s" (Content Repository "%s"): No role assignment exists for this user/group', $subject->value, $workspaceName->value, $contentRepositoryId->value), 1728477071); + } + } + + /** + * Get all role assignments for the specified workspace + * + * NOTE: This should never be used to evaluate permissions, instead {@see self::getWorkspacePermissionsForUser()} should be used! + */ + public function getWorkspaceRoleAssignments(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceRoleAssignments + { + $table = self::TABLE_NAME_WORKSPACE_ROLE; + $query = <<dbal->fetchAllAssociative($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to fetch workspace role assignments for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728474440, $e); + } + return WorkspaceRoleAssignments::fromArray( + array_map(static fn (array $row) => new WorkspaceRoleAssignment( + WorkspaceRoleSubjectType::from($row['subject_type']), + WorkspaceRoleSubject::fromString($row['subject']), + WorkspaceRole::from($row['role']), + ), $rows) + ); } /** @@ -234,6 +276,11 @@ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepos ); } + /** + * Builds a workspace name that is unique within the specified content repository. + * If $candidate already refers to a workspace name that is not used yet, it will be used (with transliteration to enforce a valid format) + * Otherwise a counter "-n" suffix is appended and increased until a unique name is found, or the maximum number of attempts has been reached (in which case an exception is thrown) + */ public function getUniqueWorkspaceName(ContentRepositoryId $contentRepositoryId, string $candidate): WorkspaceName { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index 71ab1a2a94a..fa7c30b70c3 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -22,6 +22,10 @@ use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle as DeprecatedWorkspaceTitle; use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; +use Neos\Neos\Domain\Model\WorkspaceRoleSubject; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Service\WorkspaceService; use PHPUnit\Framework\Assert; @@ -151,4 +155,47 @@ public function theWorkspaceShouldHaveTheFollowingMetadata($workspaceName, Table 'Owner user id' => $workspaceMetadata->ownerUserId?->value ?? '', ]); } + + /** + * @When the role :role is assigned to workspace :workspaceName for group :groupName + * @When the role :role is assigned to workspace :workspaceName for user :username + */ + public function theRoleIsAssignedToWorkspaceForGroupOrUser(string $role, string $workspaceName, string $groupName = null, string $username = null): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->assignWorkspaceRole( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($groupName ?? $username), + WorkspaceRole::from($role) + )); + } + + /** + * @When the role for group :groupName is unassigned from workspace :workspaceName + * @When the role for user :username is unassigned from workspace :workspaceName + */ + public function theRoleIsUnassignedFromWorkspace(string $workspaceName, string $groupName = null, string $username = null): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->unassignWorkspaceRole( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($groupName ?? $username), + )); + } + + /** + * @Then the workspace :workspaceName should have the following role assignments: + */ + public function theWorkspaceShouldHaveTheFollowingRoleAssignments($workspaceName, TableNode $expectedAssignments): void + { + $workspaceAssignments = $this->getObject(WorkspaceService::class)->getWorkspaceRoleAssignments($this->currentContentRepository->id, WorkspaceName::fromString($workspaceName)); + $actualAssignments = array_map(static fn (WorkspaceRoleAssignment $assignment) => [ + 'Subject type' => $assignment->subjectType->value, + 'Subject' => $assignment->subject->value, + 'Role' => $assignment->role->value, + ], iterator_to_array($workspaceAssignments)); + Assert::assertSame($expectedAssignments->getHash(), $actualAssignments); + } } diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature index 205b9c32968..073288a47b1 100644 --- a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -87,3 +87,55 @@ Feature: Neos WorkspaceService related features Then the workspace "some-workspace" should have the following metadata: | Title | Description | Classification | Owner user id | | some-workspace | | UNKNOWN | | + + Scenario: Assign role to non-existing workspace + When the role COLLABORATOR is assigned to workspace "some-workspace" for group "Neos.Neos:AbstractEditor" + Then an exception 'Failed to find workspace with name "some-workspace" for content repository "default"' should be thrown + + Scenario: Assign group role to root workspace + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | GROUP | Neos.Neos:AbstractEditor | COLLABORATOR | + + Scenario: Assign a role to the same group twice + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + And the role MANAGER is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then an exception 'Failed to assign role for workspace "some-root-workspace" to subject "Neos.Neos:AbstractEditor" (Content Repository "default"): There is already a role assigned for that user/group, please unassign that first' should be thrown + + Scenario: Assign user role to root workspace + Given the root workspace "some-root-workspace" is created + When the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | USER | some-user-id | MANAGER | + + Scenario: Assign a role to the same user twice + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for user "some-user-id" + And the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + Then an exception 'Failed to assign role for workspace "some-root-workspace" to subject "some-user-id" (Content Repository "default"): There is already a role assigned for that user/group, please unassign that first' should be thrown + + Scenario: Unassign role from non-existing workspace + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-workspace" + Then an exception 'Failed to find workspace with name "some-workspace" for content repository "default"' should be thrown + + Scenario: Unassign role from workspace that has not been assigned before + Given the root workspace "some-root-workspace" is created + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-root-workspace" + Then an exception 'Failed to unassign role for subject "Neos.Neos:AbstractEditor" from workspace "some-root-workspace" (Content Repository "default"): No role assignment exists for this user/group' should be thrown + + Scenario: Assign two roles, then unassign one + Given the root workspace "some-root-workspace" is created + And the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + And the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | GROUP | Neos.Neos:AbstractEditor | COLLABORATOR | + | USER | some-user-id | MANAGER | + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-root-workspace" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | USER | some-user-id | MANAGER | From 31119ae4efc06f0a7b5fc8d9cc7206e34f0a61dd Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 14:35:12 +0200 Subject: [PATCH 40/43] Allow to determine Workspace role assignments --- .../Command/WorkspaceCommandController.php | 18 +++++++ .../Domain/Model/WorkspaceRoleAssignment.php | 23 ++++++++ .../Domain/Model/WorkspaceRoleAssignments.php | 51 ++++++++++++++++++ .../Domain/Service/WorkspaceService.php | 49 ++++++++++++++++- .../Bootstrap/WorkspaceServiceTrait.php | 47 +++++++++++++++++ .../WorkspaceService.feature | 52 +++++++++++++++++++ 6 files changed, 239 insertions(+), 1 deletion(-) create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php create mode 100644 Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignments.php diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index e9fb7b86003..a066a36452d 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -31,6 +31,7 @@ use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceDescription; use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; use Neos\Neos\Domain\Model\WorkspaceRoleSubject; use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; @@ -519,5 +520,22 @@ public function showCommand(string $workspace, string $contentRepository = 'defa $this->outputFormatted('Description: %s', [$workspaceMetadata->description->value]); $this->outputFormatted('Status: %s', [$workspacesInstance->status->value]); $this->outputFormatted('Content Stream: %s', [$workspacesInstance->currentContentStreamId->value]); + + $workspaceRoleAssignments = $this->workspaceService->getWorkspaceRoleAssignments($contentRepositoryId, $workspaceName); + $this->outputLine(); + $this->outputLine('Role assignments:'); + if ($workspaceRoleAssignments->isEmpty()) { + $this->outputLine('There are no role assignments for workspace "%s". Use the workspace:assignrole command to assign roles', [$workspaceName->value]); + return; + } + $this->output->outputTable(array_map(static fn (WorkspaceRoleAssignment $assignment) => [ + $assignment->subjectType->value, + $assignment->subject->value, + $assignment->role->value, + ], iterator_to_array($workspaceRoleAssignments)), [ + 'Subject type', + 'Subject', + 'Role', + ]); } } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php new file mode 100644 index 00000000000..ba6e6370138 --- /dev/null +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php @@ -0,0 +1,23 @@ + + * @api + */ +#[Flow\Proxy(false)] +final readonly class WorkspaceRoleAssignments implements \IteratorAggregate, \Countable +{ + /** + * @var array + */ + private array $assignments; + + private function __construct(WorkspaceRoleAssignment ...$assignments) + { + $this->assignments = $assignments; + } + + /** + * @param array $assignments + */ + public static function fromArray(array $assignments): self + { + return new self(...$assignments); + } + + public function isEmpty(): bool + { + return $this->assignments === []; + } + + public function getIterator(): Traversable + { + yield from $this->assignments; + } + + public function count(): int + { + return count($this->assignments); + } +} diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index ecd51f928ff..1131422a81d 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -17,6 +17,7 @@ use Doctrine\DBAL\ArrayParameterType; use Doctrine\DBAL\Connection; use Doctrine\DBAL\Exception as DbalException; +use Doctrine\DBAL\Exception\UniqueConstraintViolationException; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateRootWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Command\CreateWorkspace; use Neos\ContentRepository\Core\Feature\WorkspaceCreation\Exception\WorkspaceAlreadyExists; @@ -36,6 +37,8 @@ use Neos\Neos\Domain\Model\WorkspaceMetadata; use Neos\Neos\Domain\Model\WorkspacePermissions; use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignments; use Neos\Neos\Domain\Model\WorkspaceRoleSubject; use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; @@ -184,6 +187,8 @@ public function assignWorkspaceRole(ContentRepositoryId $contentRepositoryId, Wo 'subject' => $subject->value, 'role' => $role->value, ]); + } catch (UniqueConstraintViolationException $e) { + throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): There is already a role assigned for that user/group, please unassign that first', $workspaceName->value, $subject->value, $contentRepositoryId->value), 1728476154, $e); } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject->value, $contentRepositoryId->value, $e->getMessage()), 1728396138, $e); } @@ -198,7 +203,7 @@ public function unassignWorkspaceRole(ContentRepositoryId $contentRepositoryId, { $this->requireWorkspace($contentRepositoryId, $workspaceName); try { - $this->dbal->delete(self::TABLE_NAME_WORKSPACE_ROLE, [ + $affectedRows = $this->dbal->delete(self::TABLE_NAME_WORKSPACE_ROLE, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, 'subject_type' => $subjectType->value, @@ -207,6 +212,43 @@ public function unassignWorkspaceRole(ContentRepositoryId $contentRepositoryId, } catch (DbalException $e) { throw new \RuntimeException(sprintf('Failed to unassign role for subject "%s" from workspace "%s" (Content Repository "%s"): %s', $subject->value, $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728396169, $e); } + if ($affectedRows === 0) { + throw new \RuntimeException(sprintf('Failed to unassign role for subject "%s" from workspace "%s" (Content Repository "%s"): No role assignment exists for this user/group', $subject->value, $workspaceName->value, $contentRepositoryId->value), 1728477071); + } + } + + /** + * Get all role assignments for the specified workspace + * + * NOTE: This should never be used to evaluate permissions, instead {@see self::getWorkspacePermissionsForUser()} should be used! + */ + public function getWorkspaceRoleAssignments(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName): WorkspaceRoleAssignments + { + $table = self::TABLE_NAME_WORKSPACE_ROLE; + $query = <<dbal->fetchAllAssociative($query, [ + 'contentRepositoryId' => $contentRepositoryId->value, + 'workspaceName' => $workspaceName->value, + ]); + } catch (DbalException $e) { + throw new \RuntimeException(sprintf('Failed to fetch workspace role assignments for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728474440, $e); + } + return WorkspaceRoleAssignments::fromArray( + array_map(static fn (array $row) => new WorkspaceRoleAssignment( + WorkspaceRoleSubjectType::from($row['subject_type']), + WorkspaceRoleSubject::fromString($row['subject']), + WorkspaceRole::from($row['role']), + ), $rows) + ); } /** @@ -234,6 +276,11 @@ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepos ); } + /** + * Builds a workspace name that is unique within the specified content repository. + * If $candidate already refers to a workspace name that is not used yet, it will be used (with transliteration to enforce a valid format) + * Otherwise a counter "-n" suffix is appended and increased until a unique name is found, or the maximum number of attempts has been reached (in which case an exception is thrown) + */ public function getUniqueWorkspaceName(ContentRepositoryId $contentRepositoryId, string $candidate): WorkspaceName { $contentRepository = $this->contentRepositoryRegistry->get($contentRepositoryId); diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index 71ab1a2a94a..fa7c30b70c3 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -22,6 +22,10 @@ use Neos\ContentRepository\Core\SharedModel\Workspace\WorkspaceTitle as DeprecatedWorkspaceTitle; use Neos\Neos\Domain\Model\UserId; use Neos\Neos\Domain\Model\WorkspaceDescription; +use Neos\Neos\Domain\Model\WorkspaceRole; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; +use Neos\Neos\Domain\Model\WorkspaceRoleSubject; +use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Service\WorkspaceService; use PHPUnit\Framework\Assert; @@ -151,4 +155,47 @@ public function theWorkspaceShouldHaveTheFollowingMetadata($workspaceName, Table 'Owner user id' => $workspaceMetadata->ownerUserId?->value ?? '', ]); } + + /** + * @When the role :role is assigned to workspace :workspaceName for group :groupName + * @When the role :role is assigned to workspace :workspaceName for user :username + */ + public function theRoleIsAssignedToWorkspaceForGroupOrUser(string $role, string $workspaceName, string $groupName = null, string $username = null): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->assignWorkspaceRole( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($groupName ?? $username), + WorkspaceRole::from($role) + )); + } + + /** + * @When the role for group :groupName is unassigned from workspace :workspaceName + * @When the role for user :username is unassigned from workspace :workspaceName + */ + public function theRoleIsUnassignedFromWorkspace(string $workspaceName, string $groupName = null, string $username = null): void + { + $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->unassignWorkspaceRole( + $this->currentContentRepository->id, + WorkspaceName::fromString($workspaceName), + $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($groupName ?? $username), + )); + } + + /** + * @Then the workspace :workspaceName should have the following role assignments: + */ + public function theWorkspaceShouldHaveTheFollowingRoleAssignments($workspaceName, TableNode $expectedAssignments): void + { + $workspaceAssignments = $this->getObject(WorkspaceService::class)->getWorkspaceRoleAssignments($this->currentContentRepository->id, WorkspaceName::fromString($workspaceName)); + $actualAssignments = array_map(static fn (WorkspaceRoleAssignment $assignment) => [ + 'Subject type' => $assignment->subjectType->value, + 'Subject' => $assignment->subject->value, + 'Role' => $assignment->role->value, + ], iterator_to_array($workspaceAssignments)); + Assert::assertSame($expectedAssignments->getHash(), $actualAssignments); + } } diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature index 205b9c32968..073288a47b1 100644 --- a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -87,3 +87,55 @@ Feature: Neos WorkspaceService related features Then the workspace "some-workspace" should have the following metadata: | Title | Description | Classification | Owner user id | | some-workspace | | UNKNOWN | | + + Scenario: Assign role to non-existing workspace + When the role COLLABORATOR is assigned to workspace "some-workspace" for group "Neos.Neos:AbstractEditor" + Then an exception 'Failed to find workspace with name "some-workspace" for content repository "default"' should be thrown + + Scenario: Assign group role to root workspace + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | GROUP | Neos.Neos:AbstractEditor | COLLABORATOR | + + Scenario: Assign a role to the same group twice + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + And the role MANAGER is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then an exception 'Failed to assign role for workspace "some-root-workspace" to subject "Neos.Neos:AbstractEditor" (Content Repository "default"): There is already a role assigned for that user/group, please unassign that first' should be thrown + + Scenario: Assign user role to root workspace + Given the root workspace "some-root-workspace" is created + When the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | USER | some-user-id | MANAGER | + + Scenario: Assign a role to the same user twice + Given the root workspace "some-root-workspace" is created + When the role COLLABORATOR is assigned to workspace "some-root-workspace" for user "some-user-id" + And the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + Then an exception 'Failed to assign role for workspace "some-root-workspace" to subject "some-user-id" (Content Repository "default"): There is already a role assigned for that user/group, please unassign that first' should be thrown + + Scenario: Unassign role from non-existing workspace + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-workspace" + Then an exception 'Failed to find workspace with name "some-workspace" for content repository "default"' should be thrown + + Scenario: Unassign role from workspace that has not been assigned before + Given the root workspace "some-root-workspace" is created + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-root-workspace" + Then an exception 'Failed to unassign role for subject "Neos.Neos:AbstractEditor" from workspace "some-root-workspace" (Content Repository "default"): No role assignment exists for this user/group' should be thrown + + Scenario: Assign two roles, then unassign one + Given the root workspace "some-root-workspace" is created + And the role MANAGER is assigned to workspace "some-root-workspace" for user "some-user-id" + And the role COLLABORATOR is assigned to workspace "some-root-workspace" for group "Neos.Neos:AbstractEditor" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | GROUP | Neos.Neos:AbstractEditor | COLLABORATOR | + | USER | some-user-id | MANAGER | + When the role for group "Neos.Neos:AbstractEditor" is unassigned from workspace "some-root-workspace" + Then the workspace "some-root-workspace" should have the following role assignments: + | Subject type | Subject | Role | + | USER | some-user-id | MANAGER | From 51c720198bb6a7623bb191c1eda3b66c22f9f6d9 Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 15:03:13 +0200 Subject: [PATCH 41/43] stabilize WorkspaceMetadata constructor --- Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php index 7421014d386..582b96f04f2 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceMetadata.php @@ -21,5 +21,8 @@ public function __construct( public WorkspaceClassification $classification, public UserId|null $ownerUserId, ) { + if ($this->classification === WorkspaceClassification::PERSONAL && $this->ownerUserId === null) { + throw new \InvalidArgumentException('The owner-user-id must be set if the workspace is personal.', 1728476633); + } } } From aa1655d400cb8b6a0068d57205c692ee250c1d1e Mon Sep 17 00:00:00 2001 From: Bastian Waidelich Date: Wed, 9 Oct 2024 15:03:27 +0200 Subject: [PATCH 42/43] Fix `WorkspaceService::getWorkspacePermissionsForUser()` --- .../Domain/Service/WorkspaceService.php | 21 +++++++++++-------- .../WorkspaceService.feature | 1 - 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 1131422a81d..19cbd5faac1 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -256,7 +256,12 @@ public function getWorkspaceRoleAssignments(ContentRepositoryId $contentReposito */ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): WorkspacePermissions { - $userIsAdministrator = $this->userService->currentUserIsAdministrator(); + try { + $userRoles = array_keys($this->userService->getAllRoles($user)); + } catch (NoSuchRoleException $e) { + throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); + } + $userIsAdministrator = in_array('Neos.Neos:Administrator', $userRoles, true); $workspaceMetadata = $this->loadWorkspaceMetadata($contentRepositoryId, $workspaceName); if ($workspaceMetadata === null) { return WorkspacePermissions::create(false, false, $userIsAdministrator); @@ -265,7 +270,7 @@ public function getWorkspacePermissionsForUser(ContentRepositoryId $contentRepos return WorkspacePermissions::all(); } - $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user); + $userWorkspaceRole = $this->loadWorkspaceRoleOfUser($contentRepositoryId, $workspaceName, $user->getId(), $userRoles); if ($userWorkspaceRole === null) { return WorkspacePermissions::create(false, false, $userIsAdministrator); } @@ -420,13 +425,11 @@ private function findPrimaryWorkspaceNameForUser(ContentRepositoryId $contentRep return $workspaceName === false ? null : WorkspaceName::fromString($workspaceName); } - private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, User $user): ?WorkspaceRole + /** + * @param array $userRoles + */ + private function loadWorkspaceRoleOfUser(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, UserId $userId, array $userRoles): ?WorkspaceRole { - try { - $userRoles = array_keys($this->userService->getAllRoles($user)); - } catch (NoSuchRoleException $e) { - throw new \RuntimeException(sprintf('Failed to determine roles for user "%s", check your package dependencies: %s', $user->getId()->value, $e->getMessage()), 1727084881, $e); - } $tableRole = self::TABLE_NAME_WORKSPACE_ROLE; $query = << $contentRepositoryId->value, 'workspaceName' => $workspaceName->value, 'userSubjectType' => WorkspaceRoleSubjectType::USER->value, - 'userId' => $user->getId()->value, + 'userId' => $userId->value, 'groupSubjectType' => WorkspaceRoleSubjectType::GROUP->value, 'groupSubjects' => $userRoles, ], [ diff --git a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature index 073288a47b1..3aeea41fe92 100644 --- a/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature +++ b/Neos.Neos/Tests/Behavior/Features/ContentRepository/WorkspaceService.feature @@ -9,7 +9,6 @@ Feature: Neos WorkspaceService related features """ And using identifier "default", I define a content repository And I am in content repository "default" - And I am user identified by "editor" Scenario: Create single root workspace without specifying title and description When the root workspace "some-root-workspace" is created From 5540c83b188c02b2adda7fcfab09b00943d3551b Mon Sep 17 00:00:00 2001 From: mhsdesign <85400359+mhsdesign@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:23:33 +0200 Subject: [PATCH 43/43] TASK: Use `WorkspaceRoleAssignment` in `assignWorkspaceRole` signatur --- .../Command/WorkspaceCommandController.php | 8 ++++-- .../Domain/Model/WorkspaceRoleAssignment.php | 28 ++++++++++++++++++- .../Domain/Service/WorkspaceService.php | 15 +++++----- .../Bootstrap/WorkspaceServiceTrait.php | 8 ++++-- .../Controller/WorkspaceController.php | 17 +++++------ 5 files changed, 54 insertions(+), 22 deletions(-) diff --git a/Neos.Neos/Classes/Command/WorkspaceCommandController.php b/Neos.Neos/Classes/Command/WorkspaceCommandController.php index a066a36452d..b55b5833658 100644 --- a/Neos.Neos/Classes/Command/WorkspaceCommandController.php +++ b/Neos.Neos/Classes/Command/WorkspaceCommandController.php @@ -302,9 +302,11 @@ public function assignRoleCommand(string $workspace, string $subject, string $ro $this->workspaceService->assignWorkspaceRole( $contentRepositoryId, $workspaceName, - $subjectType, - $roleSubject, - $workspaceRole, + WorkspaceRoleAssignment::create( + $subjectType, + $roleSubject, + $workspaceRole + ) ); $this->outputLine('Assigned role "%s" to subject "%s" for workspace "%s"', [$workspaceRole->value, $roleSubject->value, $workspaceName->value]); } diff --git a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php index ba6e6370138..fd7d5a7896f 100644 --- a/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php +++ b/Neos.Neos/Classes/Domain/Model/WorkspaceRoleAssignment.php @@ -14,10 +14,36 @@ #[Flow\Proxy(false)] final readonly class WorkspaceRoleAssignment { - public function __construct( + private function __construct( public WorkspaceRoleSubjectType $subjectType, public WorkspaceRoleSubject $subject, public WorkspaceRole $role, ) { } + + public static function create( + WorkspaceRoleSubjectType $subjectType, + WorkspaceRoleSubject $subject, + WorkspaceRole $role, + ): self { + return new self($subjectType, $subject, $role); + } + + public static function createForUser(UserId $userId, WorkspaceRole $role): self + { + return new self( + WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($userId->value), + $role + ); + } + + public static function createForGroup(string $flowRoleIdentifier, WorkspaceRole $role): self + { + return new self( + WorkspaceRoleSubjectType::GROUP, + WorkspaceRoleSubject::fromString($flowRoleIdentifier), + $role + ); + } } diff --git a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php index 19cbd5faac1..5f854bc2689 100644 --- a/Neos.Neos/Classes/Domain/Service/WorkspaceService.php +++ b/Neos.Neos/Classes/Domain/Service/WorkspaceService.php @@ -151,6 +151,7 @@ public function createSharedWorkspace(ContentRepositoryId $contentRepositoryId, /** * Create a new, personal, workspace for the specified user if none exists yet + * @internal experimental api, until actually used by the Neos.Ui */ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $contentRepositoryId, User $user): void { @@ -176,21 +177,21 @@ public function createPersonalWorkspaceForUserIfMissing(ContentRepositoryId $con * Without explicit workspace roles, only administrators can change the corresponding workspace. * With this method, the subject (i.e. a Neos user or group represented by a Flow role identifier) can be granted a {@see WorkspaceRole} for the specified workspace */ - public function assignWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleSubjectType $subjectType, WorkspaceRoleSubject $subject, WorkspaceRole $role): void + public function assignWorkspaceRole(ContentRepositoryId $contentRepositoryId, WorkspaceName $workspaceName, WorkspaceRoleAssignment $assignment): void { $this->requireWorkspace($contentRepositoryId, $workspaceName); try { $this->dbal->insert(self::TABLE_NAME_WORKSPACE_ROLE, [ 'content_repository_id' => $contentRepositoryId->value, 'workspace_name' => $workspaceName->value, - 'subject_type' => $subjectType->value, - 'subject' => $subject->value, - 'role' => $role->value, + 'subject_type' => $assignment->subjectType->value, + 'subject' => $assignment->subject->value, + 'role' => $assignment->role->value, ]); } catch (UniqueConstraintViolationException $e) { - throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): There is already a role assigned for that user/group, please unassign that first', $workspaceName->value, $subject->value, $contentRepositoryId->value), 1728476154, $e); + throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): There is already a role assigned for that user/group, please unassign that first', $workspaceName->value, $assignment->subject->value, $contentRepositoryId->value), 1728476154, $e); } catch (DbalException $e) { - throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): %s', $workspaceName->value, $subject->value, $contentRepositoryId->value, $e->getMessage()), 1728396138, $e); + throw new \RuntimeException(sprintf('Failed to assign role for workspace "%s" to subject "%s" (Content Repository "%s"): %s', $workspaceName->value, $assignment->subject->value, $contentRepositoryId->value, $e->getMessage()), 1728396138, $e); } } @@ -243,7 +244,7 @@ public function getWorkspaceRoleAssignments(ContentRepositoryId $contentReposito throw new \RuntimeException(sprintf('Failed to fetch workspace role assignments for workspace "%s" (Content Repository "%s"): %s', $workspaceName->value, $contentRepositoryId->value, $e->getMessage()), 1728474440, $e); } return WorkspaceRoleAssignments::fromArray( - array_map(static fn (array $row) => new WorkspaceRoleAssignment( + array_map(static fn (array $row) => WorkspaceRoleAssignment::create( WorkspaceRoleSubjectType::from($row['subject_type']), WorkspaceRoleSubject::fromString($row['subject']), WorkspaceRole::from($row['role']), diff --git a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php index fa7c30b70c3..0570d6ee3b9 100644 --- a/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php +++ b/Neos.Neos/Tests/Behavior/Features/Bootstrap/WorkspaceServiceTrait.php @@ -165,9 +165,11 @@ public function theRoleIsAssignedToWorkspaceForGroupOrUser(string $role, string $this->tryCatchingExceptions(fn () => $this->getObject(WorkspaceService::class)->assignWorkspaceRole( $this->currentContentRepository->id, WorkspaceName::fromString($workspaceName), - $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, - WorkspaceRoleSubject::fromString($groupName ?? $username), - WorkspaceRole::from($role) + WorkspaceRoleAssignment::create( + $groupName !== null ? WorkspaceRoleSubjectType::GROUP : WorkspaceRoleSubjectType::USER, + WorkspaceRoleSubject::fromString($groupName ?? $username), + WorkspaceRole::from($role) + ) )); } diff --git a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php index 5f4588cfb7f..c5710e14cfb 100644 --- a/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php +++ b/Neos.Workspace.Ui/Classes/Controller/WorkspaceController.php @@ -52,8 +52,7 @@ use Neos\Neos\Domain\Model\WorkspaceClassification; use Neos\Neos\Domain\Model\WorkspaceDescription; use Neos\Neos\Domain\Model\WorkspaceRole; -use Neos\Neos\Domain\Model\WorkspaceRoleSubject; -use Neos\Neos\Domain\Model\WorkspaceRoleSubjectType; +use Neos\Neos\Domain\Model\WorkspaceRoleAssignment; use Neos\Neos\Domain\Model\WorkspaceTitle; use Neos\Neos\Domain\Repository\SiteRepository; use Neos\Neos\Domain\Service\NodeTypeNameFactory; @@ -227,16 +226,18 @@ public function createAction( $this->workspaceService->assignWorkspaceRole( $contentRepositoryId, $workspaceName, - WorkspaceRoleSubjectType::USER, - WorkspaceRoleSubject::fromString($currentUser->getId()->value), - WorkspaceRole::MANAGER, + WorkspaceRoleAssignment::createForUser( + $currentUser->getId(), + WorkspaceRole::MANAGER, + ) ); $this->workspaceService->assignWorkspaceRole( $contentRepositoryId, $workspaceName, - WorkspaceRoleSubjectType::GROUP, - WorkspaceRoleSubject::fromString('Neos.Neos:AbstractEditor'), - WorkspaceRole::COLLABORATOR, + WorkspaceRoleAssignment::createForGroup( + 'Neos.Neos:AbstractEditor', + WorkspaceRole::COLLABORATOR, + ) ); $this->addFlashMessage($this->getModuleLabel('workspaces.workspaceHasBeenCreated', [$title->value])); $this->redirect('index');