Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Move workspace preview user to custom class
Instead of faking an existing backend user, the workspace preview functionality (= from a link) should use an anonymous read-only use which has only access to the workspace and the page, in order to remove the hacks to allow read-access for existing backend users. This way, the hook code is getting cleaner and easier to read, and also easier to debug. Resolves: #84039 Releases: master Change-Id: Ia69d66ce25af48b86104ff724f2a3e877aa3a813 Reviewed-on: https://review.typo3.org/55888 Tested-by: TYPO3com <no-reply@typo3.com> Reviewed-by: Benni Mack <benni@typo3.org> Tested-by: Benni Mack <benni@typo3.org>
- Loading branch information
Showing
3 changed files
with
119 additions
and
118 deletions.
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
typo3/sysext/workspaces/Classes/Authentication/PreviewUserAuthentication.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
| declare(strict_types = 1); | ||
| namespace TYPO3\CMS\Workspaces\Authentication; | ||
|
|
||
| /* | ||
| * This file is part of the TYPO3 CMS project. | ||
| * | ||
| * It is free software; you can redistribute it and/or modify it under | ||
| * the terms of the GNU General Public License, either version 2 | ||
| * of the License, or any later version. | ||
| * | ||
| * For the full copyright and license information, please read the | ||
| * LICENSE.txt file that was distributed with this source code. | ||
| * | ||
| * The TYPO3 project - inspiring people to share! | ||
| */ | ||
|
|
||
| use TYPO3\CMS\Core\Authentication\BackendUserAuthentication; | ||
| use TYPO3\CMS\Core\Database\ConnectionPool; | ||
| use TYPO3\CMS\Core\Database\Query\Restriction\RootLevelRestriction; | ||
| use TYPO3\CMS\Core\Type\Bitmask\Permission; | ||
| use TYPO3\CMS\Core\Utility\GeneralUtility; | ||
|
|
||
| /** | ||
| * A backend-user like preview user with read-only permissions for a certain workspace | ||
| * is used for previewing a workspace in the frontend without having a full backend user | ||
| * available. | ||
| * | ||
| * Has | ||
| * - no user[uid] | ||
| * - cookie fetched from ADMCMD_prev cookie name | ||
| * - read-only everywhere | ||
| * - locked to a certain workspace > 0 | ||
| * - locked to the current page ID as webmount | ||
| * | ||
| * This class explicitly does not derive from FrontendBackendUserAuthentication. | ||
| * As this user is only meant for using against GET/cookie of "ADMCMD_prev" = clicked on a preview link | ||
| * This user cannot use any admin panel / frontend editing capabilities. | ||
| */ | ||
| class PreviewUserAuthentication extends BackendUserAuthentication | ||
| { | ||
| public function __construct() | ||
| { | ||
| parent::__construct(); | ||
| $this->name = 'ADMCMD_prev'; | ||
| } | ||
|
|
||
| /** | ||
| * Checking if a workspace is allowed for backend user | ||
| * This method is intentionally called with setTemporaryWorkspace() to check if the workspace exists. | ||
| * | ||
| * @param mixed $wsRec If integer, workspace record is looked up, if array it is seen as a Workspace record with at least uid, title, members and adminusers columns. Can be faked for workspaces uid 0 | ||
| * @param string $fields List of fields to select. Default fields are: uid,title,adminusers,members,reviewers,publish_access,stagechg_notification | ||
| * @return array|bool Output will also show how access was granted. For preview users, if the record exists, it's a go. | ||
| */ | ||
| public function checkWorkspace($wsRec, $fields = 'uid,title,adminusers,members,reviewers,publish_access,stagechg_notification') | ||
| { | ||
| // If not array, look up workspace record: | ||
| if (!is_array($wsRec)) { | ||
| switch ((int)$wsRec) { | ||
| case '0': | ||
| $wsRec = ['uid' => (int)$wsRec]; | ||
| break; | ||
| default: | ||
| $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_workspace'); | ||
| $queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(RootLevelRestriction::class)); | ||
| $wsRec = $queryBuilder->select(...GeneralUtility::trimExplode(',', $fields)) | ||
| ->from('sys_workspace') | ||
| ->where($queryBuilder->expr()->eq( | ||
| 'uid', | ||
| $queryBuilder->createNamedParameter($wsRec, \PDO::PARAM_INT) | ||
| )) | ||
| ->orderBy('title') | ||
| ->setMaxResults(1) | ||
| ->execute() | ||
| ->fetch(\PDO::FETCH_ASSOC); | ||
| } | ||
| } | ||
| // If the workspace exists in the database, the preview user is automatically a member to that workspace | ||
| if (is_array($wsRec)) { | ||
| return array_merge($wsRec, ['_ACCESS' => 'member']); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * A preview user has read-only permissions, always. | ||
| * | ||
| * @param int $perms | ||
| * @return string | ||
| */ | ||
| public function getPagePermsClause($perms) | ||
| { | ||
| if ($perms === Permission::PAGE_SHOW) { | ||
| return '1=1'; | ||
| } | ||
| return '0=1'; | ||
| } | ||
|
|
||
| /** | ||
| * Has read permissions on the whole workspace, but nothing else | ||
| * | ||
| * @param array $row | ||
| * @return int | ||
| */ | ||
| public function calcPerms($row) | ||
| { | ||
| return Permission::PAGE_SHOW; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters