PageLayoutController.php 48.6 KB
Newer Older
1
<?php
2

3
declare(strict_types=1);
4

5
/*
6
 * This file is part of the TYPO3 CMS project.
7
 *
8
9
10
 * 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.
11
 *
12
13
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
14
 *
15
16
 * The TYPO3 project - inspiring people to share!
 */
17

18
19
namespace TYPO3\CMS\Backend\Controller;

20
21
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
22
use TYPO3\CMS\Backend\Module\ModuleLoader;
23
use TYPO3\CMS\Backend\Routing\UriBuilder;
24
25
use TYPO3\CMS\Backend\Template\Components\ButtonBar;
use TYPO3\CMS\Backend\Template\ModuleTemplate;
Nicole Cordes's avatar
Nicole Cordes committed
26
use TYPO3\CMS\Backend\Utility\BackendUtility;
27
28
use TYPO3\CMS\Backend\View\BackendLayoutView;
use TYPO3\CMS\Backend\View\PageLayoutView;
29
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
30
use TYPO3\CMS\Core\Configuration\Features;
31
32
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
33
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
34
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
35
use TYPO3\CMS\Core\Http\HtmlResponse;
36
37
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
38
use TYPO3\CMS\Core\Localization\LanguageService;
39
use TYPO3\CMS\Core\Page\PageRenderer;
40
use TYPO3\CMS\Core\Site\Entity\SiteInterface;
41
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
42
use TYPO3\CMS\Core\Type\Bitmask\Permission;
Nicole Cordes's avatar
Nicole Cordes committed
43
use TYPO3\CMS\Core\Utility\GeneralUtility;
44
use TYPO3\CMS\Core\Versioning\VersionState;
45
use TYPO3\CMS\Fluid\View\StandaloneView;
46
use TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper;
Nicole Cordes's avatar
Nicole Cordes committed
47

48
49
50
/**
 * Script Class for Web > Layout module
 */
51
52
53
54
55
56
class PageLayoutController
{
    /**
     * Page Id for which to make the listing
     *
     * @var int
57
     * @internal
58
59
60
61
62
63
64
65
     */
    public $id;

    /**
     * Module TSconfig
     *
     * @var array
     */
66
    protected $modTSconfig = [];
67
68
69
70
71
72

    /**
     * Module shared TSconfig
     *
     * @var array
     */
73
    protected $modSharedTSconfig = [];
74
75
76
77
78

    /**
     * Current ids page record
     *
     * @var array
79
     * @internal
80
81
82
83
84
85
86
87
     */
    public $pageinfo;

    /**
     * List of column-integers to edit. Is set from TSconfig, default is "1,0,2,3"
     *
     * @var string
     */
88
    protected $colPosList;
89
90
91
92
93
94

    /**
     * Currently selected language for editing content elements
     *
     * @var int
     */
95
    protected $current_sys_language;
96
97
98
99
100
101

    /**
     * Menu configuration
     *
     * @var array
     */
102
    protected $MOD_MENU = [];
103
104
105
106
107

    /**
     * Module settings (session variable)
     *
     * @var array
108
     * @internal
109
     */
110
    public $MOD_SETTINGS = [];
111
112
113
114
115
116
117

    /**
     * List of column-integers accessible to the current BE user.
     * Is set from TSconfig, default is $colPosList
     *
     * @var string
     */
118
    protected $activeColPosList;
119
120
121
122
123
124
125
126
127
128
129
130
131

    /**
     * @var IconFactory
     */
    protected $iconFactory;

    /**
     * The name of the module
     *
     * @var string
     */
    protected $moduleName = 'web_layout';

132
133
134
135
136
137
138
139
140
141
    /**
     * @var ModuleTemplate
     */
    protected $moduleTemplate;

    /**
     * @var ButtonBar
     */
    protected $buttonBar;

142
143
144
145
146
    /**
     * @var string
     */
    protected $searchContent;

147
148
149
150
151
    /**
     * @var SiteLanguage[]
     */
    protected $availableLanguages;

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    /**
     * @var PageRenderer
     */
    protected $pageRenderer;

    /**
     * @var UriBuilder
     */
    protected $uriBuilder;

    /**
     * @var BackendLayoutView
     */
    protected $backendLayouts;

167
168
169
170
171
172
173
174
175
176
    /**
     * Injects the request object for the current request or subrequest
     * As this controller goes only through the main() method, it is rather simple for now
     *
     * @param ServerRequestInterface $request the current request
     * @return ResponseInterface the response with the content
     */
    public function mainAction(ServerRequestInterface $request): ResponseInterface
    {
        $GLOBALS['SOBE'] = $this;
177
        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
178
        $this->pageRenderer = $this->moduleTemplate->getPageRenderer();
179
        $this->iconFactory = $this->moduleTemplate->getIconFactory();
180
        $this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
181
        $this->buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
182
        $this->backendLayouts = GeneralUtility::makeInstance(BackendLayoutView::class);
183
184
        $this->getLanguageService()->includeLLFile('EXT:backend/Resources/Private/Language/locallang_layout.xlf');
        // Setting module configuration / page select clause
185
        $this->id = (int)($request->getParsedBody()['id'] ?? $request->getQueryParams()['id'] ?? 0);
186

187
188
189
190
191
192
193
194
195
        // Load page info array
        $this->pageinfo = BackendUtility::readPageAccess($this->id, $this->getBackendUser()->getPagePermsClause(Permission::PAGE_SHOW));
        /** @var SiteInterface $currentSite */
        $currentSite = $request->getAttribute('site');
        $this->availableLanguages = $currentSite->getAvailableLanguages($this->getBackendUser(), false, $this->id);
        // initialize page/be_user TSconfig settings
        $pageTsConfig = BackendUtility::getPagesTSconfig($this->id);
        $this->modSharedTSconfig['properties'] = $pageTsConfig['mod.']['SHARED.'] ?? [];
        $this->modTSconfig['properties'] = $pageTsConfig['mod.']['web_layout.'] ?? [];
196

197
        // Initialize menu
198
        $this->menuConfig($request);
199
        // Setting sys language from session var
200
        $this->current_sys_language = (int)$this->MOD_SETTINGS['language'];
201
202
203
204
205

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Recordlist/ClearCache');

        $this->main($request);
        return new HtmlResponse($this->moduleTemplate->renderContent());
206
207
208
209
    }

    /**
     * Initialize menu array
210
     * @param ServerRequestInterface $request
211
     */
212
    protected function menuConfig(ServerRequestInterface $request): void
213
214
    {
        // MENU-ITEMS:
215
        $this->MOD_MENU = [
216
            'tt_content_showHidden' => '',
217
            'function' => [
218
219
                1 => $this->getLanguageService()->getLL('m_function_1'),
                2 => $this->getLanguageService()->getLL('m_function_2')
220
221
            ],
            'language' => [
222
                0 => $this->getLanguageService()->getLL('m_default')
223
224
            ]
        ];
225

226
227
        // First, select all localized page records on the current page.
        // Each represents a possibility for a language on the page. Add these to language selector.
228
        if ($this->id) {
229
230
231
232
233
            // Compile language data for pid != 0 only. The language drop-down is not shown on pid 0
            // since pid 0 can't be localized.
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('pages');
            $queryBuilder->getRestrictions()->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
234
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, (int)$this->getBackendUser()->workspace));
235
236
            $statement = $queryBuilder->select('uid', $GLOBALS['TCA']['pages']['ctrl']['languageField'])
                ->from('pages')
237
                ->where(
238
                    $queryBuilder->expr()->eq(
239
                        $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'],
240
                        $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
241
                    )
242
243
244
                )->execute();
            while ($pageTranslation = $statement->fetch()) {
                $languageId = $pageTranslation[$GLOBALS['TCA']['pages']['ctrl']['languageField']];
245
246
                if (isset($this->availableLanguages[$languageId])) {
                    $this->MOD_MENU['language'][$languageId] = $this->availableLanguages[$languageId]->getTitle();
247
                }
248
            }
249
            // Override the label
250
251
            if (isset($this->availableLanguages[0])) {
                $this->MOD_MENU['language'][0] = $this->availableLanguages[0]->getTitle();
252
253
            }
        }
254
        // Initialize the available actions
255
        $actions = $this->initActions();
256
        // Clean up settings
257
        $this->MOD_SETTINGS = BackendUtility::getModuleData($this->MOD_MENU, $request->getParsedBody()['SET'] ?? $request->getQueryParams()['SET'] ?? [], $this->moduleName);
258
        // For all elements to be shown in draft workspaces & to also show hidden elements by default if user hasn't disabled the option
259
260
261
        if ($this->getBackendUser()->workspace != 0
            || !isset($this->MOD_SETTINGS['tt_content_showHidden'])
            || $this->MOD_SETTINGS['tt_content_showHidden'] !== '0'
Pawel Cieslik's avatar
Pawel Cieslik committed
262
        ) {
263
264
            $this->MOD_SETTINGS['tt_content_showHidden'] = 1;
        }
265
266
        // Make action menu from available actions
        $this->makeActionMenu($actions);
267
268
269
    }

    /**
270
     * Initializes the available actions this module provides
271
     *
272
     * @return array the available actions
273
     */
274
    protected function initActions(): array
275
    {
276
        $actions = [
277
            1 => $this->getLanguageService()->getLL('m_function_1')
278
        ];
279
280
281
        // Find if there are ANY languages at all (and if not, do not show the language option from function menu).
        if (count($this->availableLanguages) > 1) {
            $actions[2] = $this->getLanguageService()->getLL('m_function_2');
282
        }
283
        $this->makeLanguageMenu();
284
285
286
287
288
289
290
        // Page / user TSconfig blinding of menu-items
        $blindActions = $this->modTSconfig['properties']['menu.']['functions.'] ?? [];
        foreach ($blindActions as $key => $value) {
            if (!$value && array_key_exists($key, $actions)) {
                unset($actions[$key]);
            }
        }
291
292
293
294
295
296
297
298
299
300

        return $actions;
    }

    /**
     * This creates the dropdown menu with the different actions this module is able to provide.
     * For now they are Columns, Quick Edit and Languages.
     *
     * @param array $actions array with the available actions
     */
301
    protected function makeActionMenu(array $actions): void
302
    {
303
304
305
306
        $actionMenu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
        $actionMenu->setIdentifier('actionMenu');
        $actionMenu->setLabel('');

307
        $defaultKey = null;
308
        $foundDefaultKey = false;
309
        foreach ($actions as $key => $action) {
310
311
312
            $menuItem = $actionMenu
                ->makeMenuItem()
                ->setTitle($action)
313
                ->setHref((string)$this->uriBuilder->buildUriFromRoute($this->moduleName) . '&id=' . $this->id . '&SET[function]=' . $key);
314

315
            if (!$foundDefaultKey) {
316
                $defaultKey = $key;
317
                $foundDefaultKey = true;
318
            }
319
320
            if ((int)$this->MOD_SETTINGS['function'] === $key) {
                $menuItem->setActive(true);
321
                $defaultKey = null;
322
323
            }
            $actionMenu->addMenuItem($menuItem);
324
        }
325
326
327
        if (isset($defaultKey)) {
            $this->MOD_SETTINGS['function'] = $defaultKey;
        }
328
        $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($actionMenu);
329
330
331
332
333
334
335
    }

    /**
     * Generate the flashmessages for current pid
     *
     * @return string HTML content with flashmessages
     */
336
    protected function getHeaderFlashMessagesForCurrentPid(): string
337
338
339
    {
        $content = '';
        $lang = $this->getLanguageService();
340

341
342
343
        $view = GeneralUtility::makeInstance(StandaloneView::class);
        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/InfoBox.html'));

344
345
346
347
348
349
350
351
352
        // If page is a folder
        if ($this->pageinfo['doktype'] == PageRepository::DOKTYPE_SYSFOLDER) {
            $moduleLoader = GeneralUtility::makeInstance(ModuleLoader::class);
            $moduleLoader->load($GLOBALS['TBE_MODULES']);
            $modules = $moduleLoader->modules;
            if (is_array($modules['web']['sub']['list'])) {
                $title = $lang->getLL('goToListModule');
                $message = '<p>' . $lang->getLL('goToListModuleMessage') . '</p>';
                $message .= '<a class="btn btn-info" href="javascript:top.goToModule(\'web_list\',1);">' . $lang->getLL('goToListModule') . '</a>';
353
                $view->assignMultiple([
354
355
356
                    'title' => $title,
                    'message' => $message,
                    'state' => InfoboxViewHelper::STATE_INFO
357
                ]);
358
359
                $content .= $view->render();
            }
360
361
362
363
        } elseif ($this->pageinfo['doktype'] === PageRepository::DOKTYPE_SHORTCUT) {
            $shortcutMode = (int)$this->pageinfo['shortcut_mode'];
            $pageRepository = GeneralUtility::makeInstance(PageRepository::class);
            $targetPage = [];
364
365
            $message = '';
            $state = InfoboxViewHelper::STATE_ERROR;
366

367
            if ($shortcutMode || $this->pageinfo['shortcut']) {
368
369
                switch ($shortcutMode) {
                    case PageRepository::SHORTCUT_MODE_NONE:
370
371
                        $targetPage = $this->getTargetPageIfVisible($pageRepository->getPage($this->pageinfo['shortcut']));
                        $message .= $targetPage === [] ? $lang->getLL('pageIsMisconfiguredOrNotAccessibleInternalLinkMessage') : '';
372
373
                        break;
                    case PageRepository::SHORTCUT_MODE_FIRST_SUBPAGE:
374
375
376
                        $menuOfPages = $pageRepository->getMenu($this->pageinfo['uid'], '*', 'sorting', 'AND hidden = 0');
                        $targetPage = reset($menuOfPages) ?: [];
                        $message .= $targetPage === [] ? $lang->getLL('pageIsMisconfiguredFirstSubpageMessage') : '';
377
378
                        break;
                    case PageRepository::SHORTCUT_MODE_PARENT_PAGE:
379
380
381
382
383
384
385
386
387
388
389
                        $targetPage = $this->getTargetPageIfVisible($pageRepository->getPage($this->pageinfo['pid']));
                        $message .= $targetPage === [] ? $lang->getLL('pageIsMisconfiguredParentPageMessage') : '';
                        break;
                    case PageRepository::SHORTCUT_MODE_RANDOM_SUBPAGE:
                        $possibleTargetPages = $pageRepository->getMenu($this->pageinfo['uid'], '*', 'sorting', 'AND hidden = 0');
                        if ($possibleTargetPages === []) {
                            $message .= $lang->getLL('pageIsMisconfiguredOrNotAccessibleRandomInternalLinkMessage');
                            break;
                        }
                        $message = $lang->getLL('pageIsRandomInternalLinkMessage');
                        $state = InfoboxViewHelper::STATE_INFO;
390
391
                        break;
                }
392
393
                $message = htmlspecialchars($message);
                if ($targetPage !== [] && $shortcutMode !== PageRepository::SHORTCUT_MODE_RANDOM_SUBPAGE) {
394
                    $linkToPid = GeneralUtility::linkThisScript(['id' => $targetPage['uid']]);
395
                    $path = BackendUtility::getRecordPath($targetPage['uid'], $this->getBackendUser()->getPagePermsClause(Permission::PAGE_SHOW), 1000);
396
                    $linkedPath = '<a href="' . htmlspecialchars($linkToPid) . '">' . htmlspecialchars($path) . '</a>';
397
398
399
                    $message .= sprintf(htmlspecialchars($lang->getLL('pageIsInternalLinkMessage')), $linkedPath);
                    $message .= ' (' . htmlspecialchars($lang->sL(BackendUtility::getLabelFromItemlist('pages', 'shortcut_mode', $shortcutMode))) . ')';
                    $state = InfoboxViewHelper::STATE_INFO;
400
401
                }
            } else {
402
403
                $message = htmlspecialchars($lang->getLL('pageIsMisconfiguredInternalLinkMessage'));
                $state = InfoboxViewHelper::STATE_ERROR;
404
            }
405
406
407
408
409
410
411

            $view->assignMultiple([
                'title' => $this->pageinfo['title'],
                'message' => $message,
                'state' => $state
            ]);
            $content .= $view->render();
412
413
414
415
416
417
418
419
420
421
422
        } elseif ($this->pageinfo['doktype'] === PageRepository::DOKTYPE_LINK) {
            if (empty($this->pageinfo['url'])) {
                $view->assignMultiple([
                    'title' => $this->pageinfo['title'],
                    'message' => $lang->getLL('pageIsMisconfiguredExternalLinkMessage'),
                    'state' => InfoboxViewHelper::STATE_ERROR
                ]);
                $content .= $view->render();
            } else {
                $externalUrl = htmlspecialchars(GeneralUtility::makeInstance(PageRepository::class)->getExtURL($this->pageinfo));
                if ($externalUrl !== false) {
423
                    $externalUrlHtml = '<a href="' . $externalUrl . '" target="_blank" rel="noreferrer">' . $externalUrl . '</a>';
424
425
426
427
428
429
430
431
                    $view->assignMultiple([
                        'title' => $this->pageinfo['title'],
                        'message' => sprintf($lang->getLL('pageIsExternalLinkMessage'), $externalUrlHtml),
                        'state' => InfoboxViewHelper::STATE_INFO
                    ]);
                    $content .= $view->render();
                }
            }
432
433
434
435
        }
        // If content from different pid is displayed
        if ($this->pageinfo['content_from_pid']) {
            $contentPage = BackendUtility::getRecord('pages', (int)$this->pageinfo['content_from_pid']);
436
            $linkToPid = GeneralUtility::linkThisScript(['id' => $this->pageinfo['content_from_pid']]);
437
            $title = BackendUtility::getRecordTitle('pages', $contentPage);
438
            $link = '<a href="' . htmlspecialchars($linkToPid) . '">' . htmlspecialchars($title) . ' (PID ' . (int)$this->pageinfo['content_from_pid'] . ')</a>';
439
            $message = sprintf($lang->getLL('content_from_pid_title'), $link);
440
            $view->assignMultiple([
441
442
443
                'title' => $title,
                'message' => $message,
                'state' => InfoboxViewHelper::STATE_INFO
444
            ]);
445
            $content .= $view->render();
446
447
448
449
450
451
452
453
454
455
456
        } else {
            $links = $this->getPageLinksWhereContentIsAlsoShownOn($this->pageinfo['uid']);
            if (!empty($links)) {
                $message = sprintf($lang->getLL('content_on_pid_title'), $links);
                $view->assignMultiple([
                    'title' => '',
                    'message' => $message,
                    'state' => InfoboxViewHelper::STATE_INFO
                ]);
                $content .= $view->render();
            }
457
458
459
460
        }
        return $content;
    }

461
462
463
464
465
466
    /**
     * Get all pages with links where the content of a page $pageId is also shown on
     *
     * @param int $pageId
     * @return string
     */
467
    protected function getPageLinksWhereContentIsAlsoShownOn($pageId): string
468
469
470
471
472
473
474
475
476
477
478
479
480
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('pages');
        $queryBuilder->getRestrictions()->removeAll();
        $queryBuilder->getRestrictions()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
        $queryBuilder
            ->select('*')
            ->from('pages')
            ->where($queryBuilder->expr()->eq('content_from_pid', $queryBuilder->createNamedParameter($pageId, \PDO::PARAM_INT)));

        $links = [];
        $rows = $queryBuilder->execute()->fetchAll();
        if (!empty($rows)) {
            foreach ($rows as $row) {
481
                $linkToPid = GeneralUtility::linkThisScript(['id' => $row['uid']]);
482
483
484
485
486
487
488
489
                $title = BackendUtility::getRecordTitle('pages', $row);
                $link = '<a href="' . htmlspecialchars($linkToPid) . '">' . htmlspecialchars($title) . ' (PID ' . (int)$row['uid'] . ')</a>';
                $links[] = $link;
            }
        }
        return implode(', ', $links);
    }

490
491
492
    /**
     * @return string $title
     */
493
    protected function getLocalizedPageTitle(): string
494
495
    {
        if ($this->current_sys_language > 0) {
496
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
497
                ->getQueryBuilderForTable('pages');
498
499
500
            $queryBuilder->getRestrictions()
                ->removeAll()
                ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
501
                ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, (int)$this->getBackendUser()->workspace));
502
            $localizedPage = $queryBuilder
503
                ->select('*')
504
                ->from('pages')
505
                ->where(
506
                    $queryBuilder->expr()->eq(
507
                        $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'],
508
509
                        $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
                    ),
510
                    $queryBuilder->expr()->eq(
511
                        $GLOBALS['TCA']['pages']['ctrl']['languageField'],
512
513
                        $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)
                    )
514
515
516
517
                )
                ->setMaxResults(1)
                ->execute()
                ->fetch();
518
519
            BackendUtility::workspaceOL('pages', $localizedPage);
            return $localizedPage['title'];
520
        }
521
        return $this->pageinfo['title'];
522
523
524
525
526
    }

    /**
     * Main function.
     * Creates some general objects and calls other functions for the main rendering of module content.
527
528
     *
     * @param ServerRequestInterface $request
529
     */
530
    protected function main(ServerRequestInterface $request): void
531
    {
532
        $content = '';
533
534
        // Access check...
        // The page will show only if there is a valid page and if this page may be viewed by the user
535
        if ($this->id && is_array($this->pageinfo)) {
536
537
            $this->moduleTemplate->getDocHeaderComponent()->setMetaInformation($this->pageinfo);

538
539
540
            $this->moduleTemplate->addJavaScriptCode('mainJsFunctions', '
                if (top.fsMod) {
                    top.fsMod.recentIds["web"] = ' . (int)$this->id . ';
541
                    top.fsMod.navFrameHighlightedID["web"] = top.fsMod.currentBank + "_" + ' . (int)$this->id . ';
542
543
                }
                function deleteRecord(table,id,url) {   //
544
                    window.location.href = ' . GeneralUtility::quoteJSvalue((string)$this->uriBuilder->buildUriFromRoute('tce_db') . '&cmd[')
545
                                            . ' + table + "][" + id + "][delete]=1&redirect=" + encodeURIComponent(url);
546
547
548
549
                    return false;
                }
            ');

550
            // Find backend layout / columns
551
552
553
            $backendLayout = $this->backendLayouts->getBackendLayoutForPage($this->id);
            if (!empty($backendLayout->getColumnPositionNumbers())) {
                $this->colPosList = implode(',', $backendLayout->getColumnPositionNumbers());
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
            }
            // Removing duplicates, if any
            $this->colPosList = array_unique(GeneralUtility::intExplode(',', $this->colPosList));
            // Accessible columns
            if (isset($this->modSharedTSconfig['properties']['colPos_list']) && trim($this->modSharedTSconfig['properties']['colPos_list']) !== '') {
                $this->activeColPosList = array_unique(GeneralUtility::intExplode(',', trim($this->modSharedTSconfig['properties']['colPos_list'])));
                // Match with the list which is present in the colPosList for the current page
                if (!empty($this->colPosList) && !empty($this->activeColPosList)) {
                    $this->activeColPosList = array_unique(array_intersect(
                        $this->activeColPosList,
                        $this->colPosList
                    ));
                }
            } else {
                $this->activeColPosList = $this->colPosList;
            }
            $this->activeColPosList = implode(',', $this->activeColPosList);
            $this->colPosList = implode(',', $this->colPosList);

573
574
            $content .= $this->getHeaderFlashMessagesForCurrentPid();

575
            // Render the primary module content:
576
            $content .= '<form action="' . htmlspecialchars((string)$this->uriBuilder->buildUriFromRoute($this->moduleName, ['id' => $this->id])) . '" id="PageLayoutController" method="post">';
577
578
579
580
            // Page title
            $content .= '<h1 class="' . ($this->isPageEditable($this->current_sys_language) ? 't3js-title-inlineedit' : '') . '">' . htmlspecialchars($this->getLocalizedPageTitle()) . '</h1>';
            // All other listings
            $content .= $this->renderContent();
581
582
            $content .= '</form>';
            $content .= $this->searchContent;
583
            // Setting up the buttons for the docheader
584
585
            $this->makeButtons($request);

586
587
588
589
590
591
592
            // Create LanguageMenu
            $this->makeLanguageMenu();
        } else {
            $this->moduleTemplate->addJavaScriptCode(
                'mainJsFunctions',
                'if (top.fsMod) top.fsMod.recentIds["web"] = ' . (int)$this->id . ';'
            );
593
            $content .= '<h1>' . htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename']) . '</h1>';
594
595
            $view = GeneralUtility::makeInstance(StandaloneView::class);
            $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/InfoBox.html'));
596
            $view->assignMultiple([
597
598
                'title' => $this->getLanguageService()->getLL('clickAPage_header'),
                'message' => $this->getLanguageService()->getLL('clickAPage_content'),
599
                'state' => InfoboxViewHelper::STATE_INFO
600
            ]);
601
            $content .= $view->render();
602
        }
603
604
        // Set content
        $this->moduleTemplate->setContent($content);
605
606
607
    }

    /**
608
     * Rendering content
609
610
611
     *
     * @return string
     */
612
    protected function renderContent(): string
613
    {
614
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ContextMenu');
615
616
617
618
619
620
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Tooltip');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Localization');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/LayoutModule/DragDrop');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Modal');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/LayoutModule/Paste');
        $this->pageRenderer->addInlineLanguageLabelFile('EXT:backend/Resources/Private/Language/locallang_layout.xlf');
621

622
623
624
        $backendLayout = $this->backendLayouts->getBackendLayoutForPage((int)$this->id);

        $configuration = $backendLayout->getDrawingConfiguration();
625
626
627
628
629
630
631
632
633
634
635
        $configuration->setPageId($this->id);
        $configuration->setDefaultLanguageBinding(!empty($this->modTSconfig['properties']['defLangBinding']));
        $configuration->setActiveColumns(GeneralUtility::trimExplode(',', $this->activeColPosList));
        $configuration->setShowHidden((bool)$this->MOD_SETTINGS['tt_content_showHidden']);
        $configuration->setLanguageColumns($this->MOD_MENU['language']);
        $configuration->setLanguageColumnsPointer((int)$this->current_sys_language);
        if ($this->MOD_SETTINGS['function'] == 2) {
            $configuration->setLanguageMode(true);
        }
        $configuration->setShowNewContentWizard(empty($this->modTSconfig['properties']['disableNewContentElementWizard']));
        $numberOfHiddenElements = $this->getNumberOfHiddenElements($configuration->getLanguageColumns());
636

637
        if (GeneralUtility::makeInstance(Features::class)->isFeatureEnabled('fluidBasedPageModule')) {
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
            $pageLayoutDrawer = $backendLayout->getBackendLayoutRenderer();

            $pageActionsCallback = null;
            if ($configuration->isPageEditable()) {
                $languageOverlayId = 0;
                $pageLocalizationRecord = BackendUtility::getRecordLocalization('pages', $this->id, (int)$this->current_sys_language);
                if (is_array($pageLocalizationRecord)) {
                    $pageLocalizationRecord = reset($pageLocalizationRecord);
                }
                if (!empty($pageLocalizationRecord['uid'])) {
                    $languageOverlayId = $pageLocalizationRecord['uid'];
                }
                $pageActionsCallback = 'function(PageActions) {
                    PageActions.setPageId(' . (int)$this->id . ');
                    PageActions.setLanguageOverlayId(' . $languageOverlayId . ');
                }';
            }
            $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/PageActions', $pageActionsCallback);
            $tableOutput = $pageLayoutDrawer->drawContent();
        } else {
658
659
660
            $dbList = PageLayoutView::createFromDrawingConfiguration($configuration);
            // Setting up the tt_content columns to show
            $colList = array_keys($backendLayout->getUsedColumns());
661
662
663
664
665
            if ($this->colPosList !== '') {
                $colList = array_intersect(GeneralUtility::intExplode(',', $this->colPosList), $colList);
            }
            // The order of the rows: Default is left(1), Normal(0), right(2), margin(3)
            $dbList->tt_contentConfig['cols'] = implode(',', $colList);
666
667
668
            $tableOutput = $dbList->getTable_tt_content($this->id);
        }

669
        if ($this->getBackendUser()->check('tables_select', 'tt_content') && $numberOfHiddenElements > 0) {
670
            // Toggle hidden ContentElements
671
672
673
674
675
676
677
            $tableOutput .= '
                <div class="checkbox">
                    <label for="checkTt_content_showHidden">
                        <input type="checkbox" id="checkTt_content_showHidden" class="checkbox" name="SET[tt_content_showHidden]" value="1" ' . ($this->MOD_SETTINGS['tt_content_showHidden'] ? 'checked="checked"' : '') . ' />
                        ' . htmlspecialchars($this->getLanguageService()->getLL('hiddenCE')) . ' (<span class="t3js-hidden-counter">' . $numberOfHiddenElements . '</span>)
                    </label>
                </div>';
678
        }
679

680
681
682
        // Init the content
        $content = '';
        // Additional header content
683
684
685
        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawHeaderHook'] ?? [] as $hook) {
            $params = [];
            $content .= GeneralUtility::callUserFunction($hook, $params, $this);
686
        }
687
        $content .= $tableOutput;
688
        // Making search form:
689
690
691
        if (!$this->modTSconfig['properties']['disableSearchBox']) {
            $this->searchContent = $this->getSearchBox();
            if ($this->searchContent) {
692
                $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ToggleSearchToolbox');
693
694
695
696
697
698
699
                $toggleSearchFormButton = $this->buttonBar->makeLinkButton()
                    ->setClasses('t3js-toggle-search-toolbox')
                    ->setTitle($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.title.searchIcon'))
                    ->setIcon($this->iconFactory->getIcon('actions-search', Icon::SIZE_SMALL))
                    ->setHref('#');
                $this->buttonBar->addButton($toggleSearchFormButton, ButtonBar::BUTTON_POSITION_LEFT, 4);
            }
700
701
        }
        // Additional footer content
702
703
704
        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawFooterHook'] ?? [] as $hook) {
            $params = [];
            $content .= GeneralUtility::callUserFunction($hook, $params, $this);
705
706
707
708
709
710
711
712
713
714
        }
        return $content;
    }

    /***************************
     *
     * Sub-content functions, rendering specific parts of the module content.
     *
     ***************************/
    /**
715
     * This creates the buttons for the modules
716
     * @param ServerRequestInterface $request
717
     */
718
    protected function makeButtons(ServerRequestInterface $request): void
719
    {
720
721
722
723
724
        // Add CSH (Context Sensitive Help) icon to tool bar
        $contextSensitiveHelpButton = $this->buttonBar->makeHelpButton()
            ->setModuleName('_MOD_' . $this->moduleName)
            ->setFieldName('columns_' . $this->MOD_SETTINGS['function']);
        $this->buttonBar->addButton($contextSensitiveHelpButton);
725
726
        $lang = $this->getLanguageService();
        // View page
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
        $pageTsConfig = BackendUtility::getPagesTSconfig($this->id);
        // Exclude sysfolders, spacers and recycler by default
        $excludeDokTypes = [
            PageRepository::DOKTYPE_RECYCLER,
            PageRepository::DOKTYPE_SYSFOLDER,
            PageRepository::DOKTYPE_SPACER
        ];
        // Custom override of values
        if (isset($pageTsConfig['TCEMAIN.']['preview.']['disableButtonForDokType'])) {
            $excludeDokTypes = GeneralUtility::intExplode(
                ',',
                $pageTsConfig['TCEMAIN.']['preview.']['disableButtonForDokType'],
                true
            );
        }

        if (
            !in_array((int)$this->pageinfo['doktype'], $excludeDokTypes, true)
            && !VersionState::cast($this->pageinfo['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
        ) {
747
748
749
750
751
752
753
754
755
            $languageParameter = $this->current_sys_language ? ('&L=' . $this->current_sys_language) : '';
            $onClick = BackendUtility::viewOnClick(
                $this->pageinfo['uid'],
                '',
                BackendUtility::BEgetRootLine($this->pageinfo['uid']),
                '',
                '',
                $languageParameter
            );
756
            $viewButton = $this->buttonBar->makeLinkButton()
757
                ->setOnClick($onClick)
758
                ->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.showPage'))
759
                ->setIcon($this->iconFactory->getIcon('actions-view-page', Icon::SIZE_SMALL))
760
761
762
                ->setHref('#');

            $this->buttonBar->addButton($viewButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
763
764
        }
        // Shortcut
765
766
767
768
        $shortcutButton = $this->buttonBar->makeShortcutButton()
            ->setModuleName($this->moduleName)
            ->setGetVariables([
                'id',
769
                'route',
770
771
772
773
774
                'edit_record',
            ])
            ->setSetVariables(array_keys($this->MOD_MENU));
        $this->buttonBar->addButton($shortcutButton);

775
        // Cache
776
        if (empty($this->modTSconfig['properties']['disableAdvanced'])) {
777
            $clearCacheButton = $this->buttonBar->makeLinkButton()
778
779
780
                ->setHref('#')
                ->setDataAttributes(['id' => $this->pageinfo['uid']])
                ->setClasses('t3js-clear-page-cache')
781
                ->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.clear_cache'))
782
                ->setIcon($this->iconFactory->getIcon('actions-system-cache-clear', Icon::SIZE_SMALL));
783
            $this->buttonBar->addButton($clearCacheButton, ButtonBar::BUTTON_POSITION_RIGHT, 1);
784
        }
785
        if (empty($this->modTSconfig['properties']['disableIconToolbar'])) {
786
            // Edit page properties and page language overlay icons
787
            if ($this->isPageEditable(0)) {
788
789
                /** @var \TYPO3\CMS\Core\Http\NormalizedParams */
                $normalizedParams = $request->getAttribute('normalizedParams');
790
                // Edit localized pages only when one specific language is selected
791
                if ($this->MOD_SETTINGS['function'] == 1 && $this->current_sys_language > 0) {
792
793
                    $localizationParentField = $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'];
                    $languageField = $GLOBALS['TCA']['pages']['ctrl']['languageField'];
794
                    $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
795
                        ->getQueryBuilderForTable('pages');
796
797
798
                    $queryBuilder->getRestrictions()
                        ->removeAll()
                        ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
799
                        ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, (int)$this->getBackendUser()->workspace));
800
801
                    $overlayRecord = $queryBuilder
                        ->select('uid')
802
                        ->from('pages')
803
                        ->where(
804
                            $queryBuilder->expr()->eq(
805
                                $localizationParentField,
806
807
808
                                $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
                            ),
                            $queryBuilder->expr()->eq(
809
                                $languageField,
810
811
                                $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)
                            )
812
813
814
815
                        )
                        ->setMaxResults(1)
                        ->execute()
                        ->fetch();
816
                    BackendUtility::workspaceOL('pages', $overlayRecord, (int)$this->getBackendUser()->workspace);
817
818
819
                    // Edit button
                    $urlParameters = [
                        'edit' => [
820
                            'pages' => [
821
822
823
                                $overlayRecord['uid'] => 'edit'
                            ]
                        ],
824
                        'returnUrl' => $normalizedParams->getRequestUri(),
825
                    ];
826

827
                    $url = (string)$this->uriBuilder->buildUriFromRoute('record_edit', $urlParameters);
828
                    $editLanguageButton = $this->buttonBar->makeLinkButton()
829
                        ->setHref($url)
830
                        ->setTitle($lang->getLL('editPageLanguageOverlayProperties'))
831
832
                        ->setIcon($this->iconFactory->getIcon('mimetypes-x-content-page-language-overlay', Icon::SIZE_SMALL));
                    $this->buttonBar->addButton($editLanguageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
833
                }
834
835
836
837
838
839
                $urlParameters = [
                    'edit' => [
                        'pages' => [
                            $this->id => 'edit'
                        ]
                    ],
840
                    'returnUrl' => $normalizedParams->getRequestUri(),
841
                ];
842
                $url = (string)$this->uriBuilder->buildUriFromRoute('record_edit', $urlParameters);
843
                $editPageButton = $this->buttonBar->makeLinkButton()
844
                    ->setHref($url)
845
                    ->setTitle($lang->getLL('editPageProperties'))
846
847
                    ->setIcon($this->iconFactory->getIcon('actions-page-open', Icon::SIZE_SMALL));
                $this->buttonBar->addButton($editPageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
848
849
850
851
852
853
854
855
856
857
858
859
860
            }
        }
    }

    /*******************************
     *
     * Other functions
     *
     ******************************/
    /**
     * Returns the number of hidden elements (including those hidden by start/end times)
     * on the current page (for the current sys_language)
     *
861
     * @param array $languageColumns
862
863
     * @return int
     */
864
    protected function getNumberOfHiddenElements(array $languageColumns): int
865
    {
866
        $andWhere = [];
867
868
869
870
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tt_content');
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
871
            ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, (int)$this->getBackendUser()->workspace));
872
873
874
875
876

        $queryBuilder
            ->count('uid')
            ->from('tt_content')
            ->where(
877
878
879
                $queryBuilder->expr()->eq(
                    'pid',
                    $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
880
881
882
                )
            );

883
        if (!empty($languageColumns)) {
884
885
886
887
888
889
890
891
892
893
894
            // Multi-language view is active
            if ($this->current_sys_language > 0) {
                $queryBuilder->andWhere(
                    $queryBuilder->expr()->in(
                        'sys_language_uid',
                        [0, $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)]
                    )
                );
            }
        } else {
            $queryBuilder->andWhere(
895
896
897
898
                $queryBuilder->expr()->eq(
                    'sys_language_uid',
                    $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)
                )
899
            );
900
        }
901
902

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['disabled'])) {
903
904
905
906
            $andWhere[] = $queryBuilder->expr()->neq(
                'hidden',
                $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
            );
907
908
909
910
        }

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['starttime'])) {
            $andWhere[] = $queryBuilder->expr()->andX(
911
912
913
914
915
916
917
918
                $queryBuilder->expr()->neq(
                    'starttime',
                    $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->gt(
                    'starttime',
                    $queryBuilder->createNamedParameter($GLOBALS['SIM_ACCESS_TIME'], \PDO::PARAM_INT)
                )
919
920
921
922
923
            );
        }

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['endtime'])) {
            $andWhere[] = $queryBuilder->expr()->andX(
924
925
926
927
928
929
930
931
                $queryBuilder->expr()->neq(
                    'endtime',
                    $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->lte(
                    'endtime',
                    $queryBuilder->createNamedParameter($GLOBALS['SIM_ACCESS_TIME'], \PDO::PARAM_INT)
                )
932
933
934
935
936
937
938
939
940
941
942
943
944
945
            );
        }

        if (!empty($andWhere)) {
            $queryBuilder->andWhere(
                $queryBuilder->expr()->orX(...$andWhere)
            );
        }

        $count = $queryBuilder
            ->execute()
            ->fetchColumn(0);

        return (int)$count;
946
947
948
    }

    /**
949
     * Check if page can be edited by current user
950
     *
951
     * @param int $languageId
952
953
     * @return bool
     */
954
    protected function isPageEditable(int $languageId): bool
955
    {
956
957
958
        if ($this->getBackendUser()->isAdmin()) {
            return true;
        }
959

960
961
962
        return !$this->pageinfo['editlock']
            && $this->getBackendUser()->doesUserHaveAccess($this->pageinfo, Permission::PAGE_EDIT)
            && $this->getBackendUser()->checkLanguageAccess($languageId);
963
964
965
966
967
    }

    /**
     * Check if content can be edited by current user
     *
968
     * @param int $languageId
969
970
     * @return bool
     */
971
    protected function isContentEditable(int $languageId): bool
972
    {
973
974
975
        if ($this->getBackendUser()->isAdmin()) {
            return true;
        }
976

977
978
979
        return !$this->pageinfo['editlock']
            && $this->getBackendUser()->doesUserHaveAccess($this->pageinfo, Permission::CONTENT_EDIT)
            && $this->getBackendUser()->checkLanguageAccess($languageId);
980
981
    }

982
983
984
    /**
     * Returns LanguageService
     *
985
     * @return LanguageService
TYPO3 Release Team's avatar