1<?php 2declare(strict_types = 1); 3namespace TYPO3\CMS\Core\Database\Query\Restriction; 4 5/* 6 * This file is part of the TYPO3 CMS project. 7 * 8 * It is free software; you can redistribute it and/or modify it under 9 * the terms of the GNU General Public License, either version 2 10 * of the License, or any later version. 11 * 12 * For the full copyright and license information, please read the 13 * LICENSE.txt file that was distributed with this source code. 14 * 15 * The TYPO3 project - inspiring people to share! 16 */ 17 18use TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression; 19use TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder; 20 21/** 22 * Restriction to make queries workspace-aware. This restriction is new compared to the "older" 23 * FrontendWorkspaceRestriction and BackendWorkspaceRestriction in a way that it ALWAYS fetches the live version, 24 * plus in current workspace the workspace records). 25 * It does not care about the state, as this should be done by overlays. 26 * 27 * As workspaces cannot be fully overlaid within ONE query, this query does the following: 28 * - In live context, only fetch published records 29 * - In a workspace, fetch all LIVE records and all workspace records which do not have "-1" (= all new placeholders get fetched as well) 30 * 31 * This means, that all records which are fetched need to run through either 32 * - BackendUtility::getRecordWSOL() (when having one or a few records) 33 * - PageRepository->versionOL() 34 * - PlainDataResolver (when having lots of records) 35 */ 36class WorkspaceRestriction implements QueryRestrictionInterface 37{ 38 /** 39 * @var int 40 */ 41 protected $workspaceId; 42 43 /** 44 * @param int $workspaceId 45 */ 46 public function __construct(int $workspaceId = 0) 47 { 48 $this->workspaceId = (int)$workspaceId; 49 } 50 51 /** 52 * Main method to build expressions for given tables 53 * 54 * @param array $queriedTables Array of tables, where array key is table alias and value is a table name 55 * @param ExpressionBuilder $expressionBuilder Expression builder instance to add restrictions with 56 * @return CompositeExpression The result of query builder expression(s) 57 */ 58 public function buildExpression(array $queriedTables, ExpressionBuilder $expressionBuilder): CompositeExpression 59 { 60 $constraints = []; 61 foreach ($queriedTables as $tableAlias => $tableName) { 62 if (empty($GLOBALS['TCA'][$tableName]['ctrl']['versioningWS'] ?? false)) { 63 continue; 64 } 65 if ($this->workspaceId === 0) { 66 // Only include ws_id=0 67 $workspaceIdExpression = $expressionBuilder->eq($tableAlias . '.t3ver_wsid', 0); 68 } else { 69 // Include live records PLUS records from the given workspace 70 $workspaceIdExpression = $expressionBuilder->in( 71 $tableAlias . '.t3ver_wsid', 72 [0, $this->workspaceId] 73 ); 74 } 75 // Always filter out "pid=-1" records 76 $constraints[] = $expressionBuilder->andX( 77 $workspaceIdExpression, 78 $expressionBuilder->neq( 79 $tableAlias . '.pid', 80 -1 81 ) 82 ); 83 } 84 return $expressionBuilder->andX(...$constraints); 85 } 86} 87