TreeControllerTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
 
namespace ‪TYPO3\CMS\Backend\Tests\Functional\Controller\Page;
 
/*
 * 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\Backend\Controller\Page\TreeController;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\UserAspect;
use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;
use ‪TYPO3\CMS\Core\Core\Bootstrap;
use ‪TYPO3\CMS\Core\Tests\Functional\SiteHandling\SiteBasedTestTrait;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerWriter;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪TreeControllerTest extends FunctionalTestCase
{
    use ‪SiteBasedTestTrait;
 
    protected ‪$coreExtensionsToLoad = ['workspaces'];
 
    private ‪$subject;
 
    private ‪$backendUser;
 
    private ‪$regularBackendUser;
 
    private ‪$context;
 
    protected ‪$backendUserFixture = 'EXT:core/Tests/Functional/Fixtures/be_users.xml';
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        //admin user for importing dataset
        $this->backendUser = $this->setUpBackendUserFromFixture(1);
        $this->‪setUpDatabase();
 
        //regular editor, non admin
        $this->backendUser = $this->setUpBackendUser(9);
        $this->context = GeneralUtility::makeInstance(Context::class);
        $this->context->setAspect('backend.user', GeneralUtility::makeInstance(UserAspect::class, $this->backendUser));
 
        $this->subject = $this->getAccessibleMock(TreeController::class, ['dummy']);
    }
 
    protected function ‪tearDown(): void
    {
        unset($this->subject, $this->backendUser, $this->context);
        parent::tearDown();
    }
 
    protected function ‪setUpDatabase()
    {
        ‪Bootstrap::initializeLanguageObject();
        $scenarioFile = __DIR__ . '/Fixtures/PagesWithBEPermissions.yaml';
        $factory = DataHandlerFactory::fromYamlFile($scenarioFile);
        $writer = DataHandlerWriter::withBackendUser($this->backendUser);
        $writer->invokeFactory($factory);
        static::failIfArrayIsNotEmpty(
            $writer->getErrors()
        );
    }
 
    public function ‪getAllEntryPointPageTrees()
    {
        $actual = $this->subject->_call('getAllEntryPointPageTrees');
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1000,
                'title' => 'ACME Inc',
                '_children' => [
                    [
                        'uid' => 1100,
                        'title' => 'EN: Welcome',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1200,
                        'title' => 'EN: Features',
                        '_children' => [
                            [
                                'uid' => 1210,
                                'title' => 'EN: Frontend Editing',
                                '_children' => [
                                ],
                            ],
                            [
                                'uid' => 1230,
                                'title' => 'EN: Managing content',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1400,
                        'title' => 'EN: ACME in your Region',
                        '_children' => [
                            [
                                'uid' => 1410,
                                'title' => 'EN: Groups',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1500,
                        'title' => 'Internal',
                        '_children' => [
                            [
                                'uid' => 1520,
                                'title' => 'Forecasts',
                                '_children' => [],
                            ],
                            [
                                'uid' => 1530,
                                'title' => 'Reports',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1700,
                        'title' => 'Announcements & News',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 404,
                        'title' => 'Page not found',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1930,
                        'title' => 'Our Blog',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1990,
                        'title' => 'Storage',
                        '_children' => [
                        ],
                    ],
                ],
            ],
            [
                'uid' => 8110,
                'title' => 'Europe',
                '_children' => [
                    [
                        'uid' => 811000,
                        'title' => 'France',
                        '_children' => [],
                    ],
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getAllEntryPointPageTreesWithSearch()
    {
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 0, 'Groups');
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1000,
                'title' => 'ACME Inc',
                '_children' => [
                    [
                        'uid' => 1400,
                        'title' => 'EN: ACME in your Region',
                        '_children' => [
                            [
                                'uid' => 1410,
                                'title' => 'EN: Groups',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            [
                'uid' => 8110,
                'title' => 'Europe',
                '_children' => [
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getSubtreeForAccessiblePage()
    {
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 1200);
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1200,
                'title' => 'EN: Features',
                '_children' => [
                    [
                        'uid' => 1210,
                        'title' => 'EN: Frontend Editing',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1230,
                        'title' => 'EN: Managing content',
                        '_children' => [
                        ],
                    ],
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getSubtreeForNonAccessiblePage()
    {
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 1510);
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getSubtreeForPageOutsideMountPoint()
    {
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 7000);
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getAllEntryPointPageTreesInWorkspace()
    {
        $this->‪setWorkspace(1);
        $actual = $this->subject->_call('getAllEntryPointPageTrees');
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1000,
                'title' => 'ACME Inc',
                '_children' => [
                    [
                        'uid' => 1950,
                        'title' => 'EN: Goodbye',
                        '_children' => [
                            [
                                'uid' => 10015,
                                'title' => 'EN: Really Goodbye',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1100,
                        'title' => 'EN: Welcome',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1200,
                        'title' => 'EN: Features modified',
                        '_children' => [
                            [
                                'uid' => 1240,
                                'title' => 'EN: Managing data',
                                '_children' => [],
                            ],
                            [
                                'uid' => 1230,
                                'title' => 'EN: Managing content',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1500,
                        'title' => 'Internal',
                        '_children' => [
                            [
                                'uid' => 1520,
                                'title' => 'Forecasts',
                                '_children' => [],
                            ],
                            [
                                'uid' => 1530,
                                'title' => 'Reports',
                                '_children' => [
                                ],
                            ],
                        ],
                    ],
                    [
                        'uid' => 1700,
                        'title' => 'Announcements & News',
                        '_children' => [
                            [
                                // page moved in workspace 1
                                // from pid 8110 to pid 1700 (visible now)
                                'uid' => 811000,
                                'title' => 'France',
                                '_children' => [],
                            ],
                            [
                                // page with sub-pages moved in workspace 1
                                // from pid 1510 (missing permissions) to pid 1700 (visible now)
                                'uid' => 1511,
                                'title' => 'Products',
                                '_children' => [],
                            ],
                        ],
                    ],
                    [
                        'uid' => 404,
                        'title' => 'Page not found',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1930,
                        'title' => 'Our Blog',
                        '_children' => [
                        ],
                    ],
                    [
                        'uid' => 1990,
                        'title' => 'Storage',
                        '_children' => [
                        ],
                    ],
                ],
            ],
            [
                'uid' => 8110,
                'title' => 'Europe',
                '_children' => [
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getAllEntryPointPageTreesInWorkspaceWithSearchDataProvider(): array
    {
        return [
            'search for "ACME in your Region" (live value, but deleted in workspace)' => [
                'ACME in your Region',
                [],
            ],
            'search for non-existing value' => [
                sha1(random_bytes(10)),
                [],
            ],
            'search for "groups" (live value, but changed in workspace)' => [
                'Groups',
                [],
            ],
            'search for "teams" (workspace value)' => [
                'Teams',
                [
                    [
                        'uid' => 1400,
                        'title' => 'EN: ACME in your Region',
                        '_children' => [
                            [
                                'uid' => 1410,
                                'title' => 'EN: Teams modified',
                                '_children' => [],
                            ],
                        ],
                    ],
                ],
            ],
            // page with sub-pages moved in workspace 1
            // from pid 1510 (missing permissions) to pid 1700 (visible now)
            'search for "products" (moved from pid 1510 to pid 1700 in workspace)' => [
                'Product',
                [
                    [
                        'uid' => 1700,
                        'title' => 'Announcements & News',
                        '_children' => [
                            [
                                'uid' => 1511,
                                'title' => 'Products',
                                '_children' => [
                                    [
                                        'uid' => 151110,
                                        'title' => 'Product 1',
                                        '_children' => [],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ];
    }
 
    public function ‪getAllEntryPointPageTreesInWorkspaceWithSearch(string $search, array $expectedChildren)
    {
        $this->‪setWorkspace(1);
        // the record was changed from live "Groups" to "Teams modified" in a workspace
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 0, $search);
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1000,
                'title' => 'ACME Inc',
                '_children' => $expectedChildren,
            ],
            [
                'uid' => 8110,
                'title' => 'Europe',
                '_children' => [
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    public function ‪getSubtreeForAccessiblePageInWorkspace()
    {
        $this->‪setWorkspace(1);
        $actual = $this->subject->_call('getAllEntryPointPageTrees', 1200);
        $keepProperties = array_flip(['uid', 'title', '_children']);
        $actual = $this->‪sortTreeArray($actual);
        $actual = $this->‪normalizeTreeArray($actual, $keepProperties);
 
        $expected = [
            [
                'uid' => 1200,
                'title' => 'EN: Features modified',
                '_children' => [
                    [
                        'uid' => 1240,
                        'title' => 'EN: Managing data',
                        '_children' => [
                            [
                                'uid' => 124010,
                                'title' => 'EN: Managing complex data',
                                '_children' => []
                            ]
                        ],
                    ],
                    [
                        'uid' => 1230,
                        'title' => 'EN: Managing content',
                        '_children' => [
                        ],
                    ],
                ],
            ],
        ];
        self::assertEquals($expected, $actual);
    }
 
    private function ‪setWorkspace(int $workspaceId)
    {
        $this->backendUser->workspace = $workspaceId;
        $this->context->setAspect('workspace', new ‪WorkspaceAspect($workspaceId));
    }
 
    private function ‪sortTreeArray(array $tree): array
    {
        ksort($tree);
        return array_map(
            function (array $item) {
                foreach ($item as $propertyName => $propertyValue) {
                    if (!is_array($propertyValue)) {
                        continue;
                    }
                    $item[$propertyName] = $this->‪sortTreeArray($propertyValue);
                }
                return $item;
            },
            $tree
        );
    }
 
    private function ‪normalizeTreeArray(array $tree, array $keepProperties): array
    {
        return array_map(
            function (array $item) use ($keepProperties) {
                // only keep these property names
                $item = array_intersect_key($item, $keepProperties);
                foreach ($item as $propertyName => $propertyValue) {
                    if (!is_array($propertyValue)) {
                        continue;
                    }
                    // process recursively for nested array items (e.g. `_children`)
                    $item[$propertyName] = $this->‪normalizeTreeArray($propertyValue, $keepProperties);
                }
                return $item;
            },
            // normalize numeric indexes (remove sorting markers)
            array_values($tree)
        );
    }
}