Skip to content

Commit

Permalink
FEATURE: Implement EditPreviewModes for the new ui
Browse files Browse the repository at this point in the history 
Since nodes have no context in Neos 9 the edit preview mode cannot be decided by asking the node any more.

This change renovates the `UserInterfaceMode` and the `UserInterfaceModeService` to use php 8 value objects.
The UserInterfaceMode object is then added as globalValue `userInterfaceMode` to the `Neos\Neos\FusionView`.

The uses of the following fusion expressions have to be adjusted as follows:

- `node.context.live` - `userInterfaceMode.isLive`
- `node.context.currentRenderingMode.edit` - `userInterfaceMode.isEditMode`
- `node.context.currentRenderingMode.preview` - `userInterfaceMode.isPreviewMode`
- `node.context.currentRenderingMode.name` - `userInterfaceMode.name`

Resolves: #4086
  • Loading branch information
@mficzel
mficzel committed Sep 12, 2023
1 parent 8cb03d5 commit 5439b86
Show file tree
Hide file tree
Showing 12 changed files with 113 additions and 196 deletions.
15 changes: 14 additions & 1 deletion Neos.Neos/Classes/Controller/Frontend/NodeController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
use Neos\Flow\Session\SessionInterface;
use Neos\Flow\Utility\Now;
use Neos\Neos\Domain\Service\NodeSiteResolvingService;
use Neos\Neos\Domain\Service\UserInterfaceModeService;
use Neos\Neos\FrontendRouting\Exception\InvalidShortcutException;
use Neos\Neos\FrontendRouting\Exception\NodeNotFoundException;
use Neos\Neos\FrontendRouting\NodeAddress;
Expand Down Expand Up @@ -108,8 +109,12 @@ class NodeController extends ActionController
*/
protected $nodeSiteResolvingService;

#[Flow\Inject]
protected UserInterfaceModeService $userInterfaceModeService;

/**
* @param string $node Legacy name for backwards compatibility of route components
* @param string $uiModeName Name of the user interface mode to use
* @throws NodeNotFoundException
* @throws \Neos\Flow\Mvc\Exception\StopActionException
* @throws \Neos\Flow\Mvc\Exception\UnsupportedRequestTypeException
Expand All @@ -120,8 +125,12 @@ class NodeController extends ActionController
* with unsafe requests from widgets or plugins that are rendered on the node
* - For those the CSRF token is validated on the sub-request, so it is safe to be skipped here
*/
public function previewAction(string $node): void
public function previewAction(string $node, string $uiModeName = null): void
{
if (is_null($uiModeName)) {
$uiModeName = $this->userInterfaceModeService->findUserInterfaceModeNameByCurrentUser();
}

$visibilityConstraints = VisibilityConstraints::frontend();
if ($this->privilegeManager->isPrivilegeTargetGranted('Neos.Neos:Backend.GeneralAccess')) {
$visibilityConstraints = VisibilityConstraints::withoutRestrictions();
Expand Down Expand Up @@ -161,6 +170,8 @@ public function previewAction(string $node): void
$this->handleShortcutNode($nodeAddress, $contentRepository);
}

$this->view->setOption('userInterfaceModeName', $uiModeName);

$this->view->assignMultiple([
'value' => $nodeInstance,
'site' => $site,
Expand Down Expand Up @@ -234,6 +245,8 @@ public function showAction(string $node, bool $showInvisible = false): void
$this->handleShortcutNode($nodeAddress, $contentRepository);
}

$this->view->setOption('userInterfaceModeName', 'live');

$this->view->assignMultiple([
'value' => $nodeInstance,
'site' => $site,
Expand Down
185 changes: 45 additions & 140 deletions Neos.Neos/Classes/Domain/Model/UserInterfaceMode.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,139 +23,37 @@
class UserInterfaceMode
{
/**
* @var string
*/
protected $name;

/**
* @var boolean
*/
protected $preview;

/**
* @var boolean
*/
protected $edit;

/**
* @var string
*/
protected $fusionPath;

/**
* @var string
*/
protected $title;

/**
* @var array<string,mixed>
*/
protected $options;

/**
* @return string
*/
public function getName()
{
return $this->name;
}

/**
* @param string $name
* @return void
*/
public function setName($name)
{
$this->name = $name;
}

/**
* @return boolean
*/
public function isPreview()
{
return $this->preview;
}

/**
* @param boolean $preview
* @return void
*/
public function setPreview($preview)
{
$this->preview = $preview;
}

/**
* @return boolean
*/
public function isEdit()
{
return $this->edit;
}

/**
* @param boolean $edit
* @return void
*/
public function setEdit($edit)
{
$this->edit = $edit;
}

/**
* @return string
*/
public function getFusionPath()
{
return $this->fusionPath;
}

/**
* @param string $fusionPath
* @return void
*/
public function setFusionPath($fusionPath)
{
$this->fusionPath = $fusionPath;
}

/**
* @return string
*/
public function getTitle()
{
return $this->title;
}

/**
* @param string $title
* @return void
* @param array<string,mixed> $options
*/
public function setTitle($title)
{
$this->title = $title;
public function __construct(
public readonly string $name,
public readonly bool $isPreview,
public readonly bool $isEdit,
public readonly string $title,
public readonly string $fusionPath,
public readonly array $options
) {
if ($name == 'live' && ($isPreview || $isEdit)) {
throw new \InvalidArgumentException('UserInterfaceMode "Live" mode cannot be edit or preview mode');
}
if ($isPreview && $isEdit) {
throw new \InvalidArgumentException(sprintf('UserInterfaceMode "%s" cannot can either be edit or preview mode', $name));
}
}

/**
* @return array<string,mixed>
*/
public function getOptions()
public function getIsEditMode(): bool
{
return $this->options;
return $this->isEdit;
}

public function getOptionByPath(string $path): mixed
public function getIsPreviewMode(): bool
{
return ObjectAccess::getPropertyPath($this->options, $path);
return $this->isPreview;
}

/**
* @param array<string,mixed> $options
*/
public function setOptions(array $options): void
public function getIsLive(): bool
{
$this->options = $options;
return $this->name === 'live';
}

/**
Expand All @@ -164,24 +62,31 @@ public function setOptions(array $options): void
* @param string $modeName
* @param array<string,mixed> $configuration
*/
public static function createByConfiguration($modeName, array $configuration): self
public static function createByConfiguration(string $modeName, array $configuration): UserInterfaceMode
{
$mode = new self();
$mode->setName($modeName);
$mode->setPreview($configuration['isPreviewMode']);
$mode->setEdit($configuration['isEditingMode']);
$mode->setTitle($configuration['title']);

if (isset($configuration['fusionRenderingPath'])) {
$mode->setFusionPath($configuration['fusionRenderingPath']);
} else {
$mode->setFusionPath('');
}

if (isset($configuration['options']) && is_array($configuration['options'])) {
$mode->setOptions($configuration['options']);
}

$mode = new UserInterfaceMode(
$modeName,
$configuration['isPreviewMode'] ?? false,
$configuration['isEditingMode'] ?? false,
$configuration['title'] ?? $modeName,
$configuration['fusionRenderingPath'] ?? '',
$configuration['options'] ?? [],
);
return $mode;
}

/**
* Creates the live User interface mode
*/
public static function createLive(): UserInterfaceMode
{
return new UserInterfaceMode(
'live',
false,
false,
'Live',
'',
[]
);
}
}
51 changes: 15 additions & 36 deletions Neos.Neos/Classes/Domain/Service/UserInterfaceModeService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,68 +54,47 @@ class UserInterfaceModeService
/**
* Get the current rendering mode (editPreviewMode).
* Will return a live mode when not in backend.
*
* @return UserInterfaceMode
*/
public function findModeByCurrentUser()
public function findUserInterfaceModeNameByCurrentUser(): string
{
if (
$this->userService->getBackendUser() === null
|| !$this->privilegeManager->isPrivilegeTargetGranted('Neos.Neos:Backend.GeneralAccess')
) {
return $this->findModeByName('live');
return 'live';
}

$editPreviewMode = $this->userService->getUserPreference('contentEditing.editPreviewMode');
if ($editPreviewMode === null) {
$editPreviewMode = $this->defaultEditPreviewMode;
}

return $this->findModeByName($editPreviewMode);
return $editPreviewMode;
}

/**
* Returns the default rendering mode.
*
* @return UserInterfaceMode
*/
public function findDefaultMode()
public function findDefaultUserInterfaceMode(): string
{
$mode = $this->findModeByName($this->defaultEditPreviewMode);

return $mode;
return $this->defaultEditPreviewMode;
}

/**
* Finds an rendering mode by name.
*
* @param string $modeName
* @return UserInterfaceMode
* @throws Exception
*/
public function findModeByName($modeName)
public function findModeByName(string $modeName): UserInterfaceMode
{
if ($modeName === 'live') {
return UserInterfaceMode::createLive();
}
if (isset($this->editPreviewModes[$modeName])) {
if ($this->editPreviewModes[$modeName] instanceof UserInterfaceMode) {
$mode = $this->editPreviewModes[$modeName];
} elseif (is_array($this->editPreviewModes[$modeName])) {
$mode = UserInterfaceMode::createByConfiguration($modeName, $this->editPreviewModes[$modeName]);
$this->editPreviewModes[$modeName] = $mode;
} else {
throw new Exception(
'The requested interface render mode "' . $modeName . '" is not configured correctly.'
. ' Please make sure it is fully configured.',
1427716331
);
}
} else {
throw new Exception(
'The requested interface render mode "' . $modeName . '" is not configured.'
. ' Please make sure it exists as key in the Settings path "Neos.Neos.Interface.editPreviewModes".',
1427715962
);
return UserInterfaceMode::createByConfiguration($modeName, $this->editPreviewModes[$modeName]);
}

return $mode;
throw new Exception(
'The requested interface render mode "' . $modeName . '" is not configured.'
. ' Please make sure it exists as key in the Settings path "Neos.Neos.Interface.editPreviewModes".',
1427715962
);
}
}
14 changes: 13 additions & 1 deletion Neos.Neos/Classes/View/FusionView.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
use Neos\Neos\Domain\Repository\SiteRepository;
use Neos\Neos\Domain\Service\FusionService;
use Neos\Neos\Domain\Service\SiteNodeUtility;
use Neos\Neos\Domain\Service\UserInterfaceModeService;
use Neos\Neos\Exception;
use Psr\Http\Message\ResponseInterface;

Expand All @@ -49,6 +50,9 @@ class FusionView extends AbstractView
#[Flow\Inject]
protected SiteRepository $siteRepository;

#[Flow\Inject]
protected UserInterfaceModeService $userInterfaceModeService;

/**
* @Flow\Inject
* @var ContentRepositoryRegistry
Expand Down Expand Up @@ -96,6 +100,11 @@ public function render(): string|ResponseInterface
null,
'Flag to enable content caching inside Fusion (overriding the global setting).',
'boolean'
],
'userInterfaceModeName' => [
'live',
'Name of the user interface mode to use',
'string'
]
];

Expand Down Expand Up @@ -229,8 +238,11 @@ protected function getFusionRuntime(Node $currentSiteNode)
$site = $this->siteRepository->findSiteBySiteNode($currentSiteNode);
$fusionConfiguration = $this->fusionService->createFusionConfigurationFromSite($site);

$userInterfaceMode = $this->userInterfaceModeService->findModeByName($this->getOption('userInterfaceModeName'));

$fusionGlobals = FusionGlobals::fromArray([
'request' => $this->controllerContext->getRequest()
'request' => $this->controllerContext->getRequest(),
'userInterfaceMode' => $userInterfaceMode
]);
$this->fusionRuntime = $this->runtimeFactory->createFromConfiguration(
$fusionConfiguration,
Expand Down
2 changes: 1 addition & 1 deletion Neos.Neos/Resources/Private/Fusion/Override/GlobalCacheIdentifiers.fusion
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
prototype(Neos.Fusion:GlobalCacheIdentifiers) {
workspaceChain = ${Array.join(Array.keys(Neos.Caching.getWorkspaceChain(documentNode)), ',')}
[email protected] = ${!!documentNode}
editPreviewMode = ${editPreviewMode}
userInterfaceMode = ${userInterfaceMode.name}
}
Loading

0 comments on commit 5439b86

Please sign in to comment.