PageLayoutController.php 50.2 KB
Newer Older
1
<?php
2
declare(strict_types = 1);
3
4
namespace TYPO3\CMS\Backend\Controller;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

140
141
142
143
144
    /**
     * @var string
     */
    protected $searchContent;

145
146
147
148
149
    /**
     * @var SiteLanguage[]
     */
    protected $availableLanguages;

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

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

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

165
166
167
168
169
170
171
172
173
174
    /**
     * 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;
175
        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
176
        $this->pageRenderer = $this->moduleTemplate->getPageRenderer();
177
        $this->iconFactory = $this->moduleTemplate->getIconFactory();
178
        $this->uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
179
        $this->buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
180
        $this->backendLayouts = GeneralUtility::makeInstance(BackendLayoutView::class);
181
182
        $this->getLanguageService()->includeLLFile('EXT:backend/Resources/Private/Language/locallang_layout.xlf');
        // Setting module configuration / page select clause
183
        $this->id = (int)($request->getParsedBody()['id'] ?? $request->getQueryParams()['id'] ?? 0);
184

185
186
187
188
189
190
191
192
193
        // 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.'] ?? [];
194

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

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

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

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

224
225
        // 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.
226
        if ($this->id) {
227
228
229
230
231
232
233
234
            // 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))
                ->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));
            $statement = $queryBuilder->select('uid', $GLOBALS['TCA']['pages']['ctrl']['languageField'])
                ->from('pages')
235
                ->where(
236
                    $queryBuilder->expr()->eq(
237
                        $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'],
238
                        $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
239
                    )
240
241
242
                )->execute();
            while ($pageTranslation = $statement->fetch()) {
                $languageId = $pageTranslation[$GLOBALS['TCA']['pages']['ctrl']['languageField']];
243
244
                if (isset($this->availableLanguages[$languageId])) {
                    $this->MOD_MENU['language'][$languageId] = $this->availableLanguages[$languageId]->getTitle();
245
                }
246
            }
247
            // Override the label
248
249
            if (isset($this->availableLanguages[0])) {
                $this->MOD_MENU['language'][0] = $this->availableLanguages[0]->getTitle();
250
251
            }
        }
252
        // Initialize the available actions
253
        $actions = $this->initActions();
254
        // Clean up settings
255
        $this->MOD_SETTINGS = BackendUtility::getModuleData($this->MOD_MENU, $request->getParsedBody()['SET'] ?? $request->getQueryParams()['SET'] ?? [], $this->moduleName);
256
        // For all elements to be shown in draft workspaces & to also show hidden elements by default if user hasn't disabled the option
257
258
259
        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
260
        ) {
261
262
            $this->MOD_SETTINGS['tt_content_showHidden'] = 1;
        }
263
264
        // Make action menu from available actions
        $this->makeActionMenu($actions);
265
266
267
    }

    /**
268
     * Initializes the available actions this module provides
269
     *
270
     * @return array the available actions
271
     */
272
    protected function initActions(): array
273
    {
274
        $actions = [
275
            1 => $this->getLanguageService()->getLL('m_function_1')
276
        ];
277
278
279
        // 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');
280
        }
281
        $this->makeLanguageMenu();
282
283
284
285
286
287
288
        // 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]);
            }
        }
289
290
291
292
293
294
295
296
297
298

        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
     */
299
    protected function makeActionMenu(array $actions): void
300
    {
301
302
303
304
        $actionMenu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
        $actionMenu->setIdentifier('actionMenu');
        $actionMenu->setLabel('');

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

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

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

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

342
343
344
345
346
347
348
349
350
        // 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>';
351
                $view->assignMultiple([
352
353
354
                    'title' => $title,
                    'message' => $message,
                    'state' => InfoboxViewHelper::STATE_INFO
355
                ]);
356
357
                $content .= $view->render();
            }
358
359
360
361
        } elseif ($this->pageinfo['doktype'] === PageRepository::DOKTYPE_SHORTCUT) {
            $shortcutMode = (int)$this->pageinfo['shortcut_mode'];
            $pageRepository = GeneralUtility::makeInstance(PageRepository::class);
            $targetPage = [];
362
363
            $message = '';
            $state = InfoboxViewHelper::STATE_ERROR;
364

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

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

459
460
461
462
463
464
    /**
     * Get all pages with links where the content of a page $pageId is also shown on
     *
     * @param int $pageId
     * @return string
     */
465
    protected function getPageLinksWhereContentIsAlsoShownOn($pageId): string
466
467
468
469
470
471
472
473
474
475
476
477
478
    {
        $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) {
479
                $linkToPid = GeneralUtility::linkThisScript(['id' => $row['uid']]);
480
481
482
483
484
485
486
487
                $title = BackendUtility::getRecordTitle('pages', $row);
                $link = '<a href="' . htmlspecialchars($linkToPid) . '">' . htmlspecialchars($title) . ' (PID ' . (int)$row['uid'] . ')</a>';
                $links[] = $link;
            }
        }
        return implode(', ', $links);
    }

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

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

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

548
            // Find backend layout / columns
549
550
551
            $backendLayout = $this->backendLayouts->getBackendLayoutForPage($this->id);
            if (!empty($backendLayout->getColumnPositionNumbers())) {
                $this->colPosList = implode(',', $backendLayout->getColumnPositionNumbers());
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
            }
            // 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);

571
572
            $content .= $this->getHeaderFlashMessagesForCurrentPid();

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

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

    /**
606
     * Rendering content
607
608
609
     *
     * @return string
     */
610
    protected function renderContent(): string
611
    {
612
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ContextMenu');
613
614

        if (GeneralUtility::makeInstance(Features::class)->isFeatureEnabled('fluidBasedPageModule')) {
615
            $backendLayout = $this->backendLayouts->getBackendLayoutForPage((int)$this->id);
616

617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
            $configuration = $backendLayout->getDrawingConfiguration();
            $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(array_combine(array_keys($this->MOD_MENU['language']), array_keys($this->MOD_MENU['language'])));
            $configuration->setLanguageColumnsPointer((int)$this->current_sys_language);
            if ($this->MOD_SETTINGS['function'] == 2) {
                $configuration->setLanguageMode($this->MOD_SETTINGS['function'] == 2);
            }

            $pageLayoutDrawer = $backendLayout->getBackendLayoutRenderer();
            $configuration->setShowNewContentWizard(empty($this->modTSconfig['properties']['disableNewContentElementWizard']));

            $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);
            $numberOfHiddenElements = $this->getNumberOfHiddenElements($configuration->getLanguageColumns());
            $tableOutput = $pageLayoutDrawer->drawContent();
        } else {
            $dbList = GeneralUtility::makeInstance(PageLayoutView::class);
            $dbList->doEdit = $this->isContentEditable($this->current_sys_language);
            $dbList->option_newWizard = empty($this->modTSconfig['properties']['disableNewContentElementWizard']);
            $dbList->defLangBinding = !empty($this->modTSconfig['properties']['defLangBinding']);
            $tcaItems = $this->backendLayouts->getColPosListItemsParsed($this->id);
            $numberOfHiddenElements = $this->getNumberOfHiddenElements(is_array($dbList->tt_contentConfig['languageCols']) ? $dbList->tt_contentConfig['languageCols'] : []);
656
657
658
659
660
            // Setting up the tt_content columns to show:
            if (is_array($GLOBALS['TCA']['tt_content']['columns']['colPos']['config']['items'])) {
                $colList = [];
                foreach ($tcaItems as $temp) {
                    $colList[] = $temp[1];
661
                }
662
            } else {
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
                // ... should be impossible that colPos has no array. But this is the fallback should it make any sense:
                $colList = ['1', '0', '2', '3'];
            }
            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);
            $dbList->tt_contentConfig['activeCols'] = $this->activeColPosList;
            $dbList->tt_contentConfig['showHidden'] = $this->MOD_SETTINGS['tt_content_showHidden'];
            $dbList->tt_contentConfig['sys_language_uid'] = (int)$this->current_sys_language;
            // If the function menu is set to "Language":
            if ($this->MOD_SETTINGS['function'] == 2) {
                $dbList->tt_contentConfig['languageMode'] = 1;
                $dbList->tt_contentConfig['languageCols'] = $this->MOD_MENU['language'];
                $dbList->tt_contentConfig['languageColsPointer'] = $this->current_sys_language;
            }
680
681
682
683
684
685
686
687
688
            $tableOutput = $dbList->getTable_tt_content($this->id);
            $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');
689
        $h_func_b = '';
690
        if ($this->getBackendUser()->check('tables_select', 'tt_content')) {
691
            // Toggle hidden ContentElements
692

693
694
695
696
697
698
699
700
            if ($numberOfHiddenElements > 0) {
                $h_func_b = '
                    <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>';
701
702
            }
        }
703
704
        $tableOutput .= $h_func_b;

705
706
707
        // Init the content
        $content = '';
        // Additional header content
708
709
710
        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawHeaderHook'] ?? [] as $hook) {
            $params = [];
            $content .= GeneralUtility::callUserFunction($hook, $params, $this);
711
        }
712
        $content .= $tableOutput;
713
        // Making search form:
714
715
716
        if (!$this->modTSconfig['properties']['disableSearchBox']) {
            $this->searchContent = $this->getSearchBox();
            if ($this->searchContent) {
717
                $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ToggleSearchToolbox');
718
719
720
721
722
723
724
                $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);
            }
725
726
        }
        // Additional footer content
727
728
729
        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawFooterHook'] ?? [] as $hook) {
            $params = [];
            $content .= GeneralUtility::callUserFunction($hook, $params, $this);
730
731
732
733
734
735
736
737
738
739
        }
        return $content;
    }

    /***************************
     *
     * Sub-content functions, rendering specific parts of the module content.
     *
     ***************************/
    /**
740
     * This creates the buttons for the modules
741
     * @param ServerRequestInterface $request
742
     */
743
    protected function makeButtons(ServerRequestInterface $request): void
744
    {
745
746
747
748
749
        // 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);
750
751
        $lang = $this->getLanguageService();
        // View page
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
        $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)
        ) {
772
773
774
775
776
777
778
779
780
            $languageParameter = $this->current_sys_language ? ('&L=' . $this->current_sys_language) : '';
            $onClick = BackendUtility::viewOnClick(
                $this->pageinfo['uid'],
                '',
                BackendUtility::BEgetRootLine($this->pageinfo['uid']),
                '',
                '',
                $languageParameter
            );
781
            $viewButton = $this->buttonBar->makeLinkButton()
782
                ->setOnClick($onClick)
783
                ->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.showPage'))
784
                ->setIcon($this->iconFactory->getIcon('actions-view-page', Icon::SIZE_SMALL))
785
786
787
                ->setHref('#');

            $this->buttonBar->addButton($viewButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
788
789
        }
        // Shortcut
790
791
792
793
        $shortcutButton = $this->buttonBar->makeShortcutButton()
            ->setModuleName($this->moduleName)
            ->setGetVariables([
                'id',
794
                'route',
795
796
797
798
799
                'edit_record',
            ])
            ->setSetVariables(array_keys($this->MOD_MENU));
        $this->buttonBar->addButton($shortcutButton);

800
        // Cache
801
        if (empty($this->modTSconfig['properties']['disableAdvanced'])) {
802
            $clearCacheButton = $this->buttonBar->makeLinkButton()
803
804
805
                ->setHref('#')
                ->setDataAttributes(['id' => $this->pageinfo['uid']])
                ->setClasses('t3js-clear-page-cache')
806
                ->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.clear_cache'))
807
                ->setIcon($this->iconFactory->getIcon('actions-system-cache-clear', Icon::SIZE_SMALL));
808
            $this->buttonBar->addButton($clearCacheButton, ButtonBar::BUTTON_POSITION_RIGHT, 1);
809
        }
810
        if (empty($this->modTSconfig['properties']['disableIconToolbar'])) {
811
            // Edit page properties and page language overlay icons
812
            if ($this->isPageEditable(0)) {
813
814
                /** @var \TYPO3\CMS\Core\Http\NormalizedParams */
                $normalizedParams = $request->getAttribute('normalizedParams');
815
                // Edit localized pages only when one specific language is selected
816
                if ($this->MOD_SETTINGS['function'] == 1 && $this->current_sys_language > 0) {
817
818
                    $localizationParentField = $GLOBALS['TCA']['pages']['ctrl']['transOrigPointerField'];
                    $languageField = $GLOBALS['TCA']['pages']['ctrl']['languageField'];
819
                    $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
820
                        ->getQueryBuilderForTable('pages');
821
822
823
824
825
826
                    $queryBuilder->getRestrictions()
                        ->removeAll()
                        ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
                        ->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));
                    $overlayRecord = $queryBuilder
                        ->select('uid')
827
                        ->from('pages')
828
                        ->where(
829
                            $queryBuilder->expr()->eq(
830
                                $localizationParentField,
831
832
833
                                $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
                            ),
                            $queryBuilder->expr()->eq(
834
                                $languageField,
835
836
                                $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)
                            )
837
838
839
840
                        )
                        ->setMaxResults(1)
                        ->execute()
                        ->fetch();
841
842
843
                    // Edit button
                    $urlParameters = [
                        'edit' => [
844
                            'pages' => [
845
846
847
                                $overlayRecord['uid'] => 'edit'
                            ]
                        ],
848
                        'returnUrl' => $normalizedParams->getRequestUri(),
849
                    ];
850

851
                    $url = (string)$this->uriBuilder->buildUriFromRoute('record_edit', $urlParameters);
852
                    $editLanguageButton = $this->buttonBar->makeLinkButton()
853
                        ->setHref($url)
854
                        ->setTitle($lang->getLL('editPageLanguageOverlayProperties'))
855
856
                        ->setIcon($this->iconFactory->getIcon('mimetypes-x-content-page-language-overlay', Icon::SIZE_SMALL));
                    $this->buttonBar->addButton($editLanguageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
857
                }
858
859
860
861
862
863
                $urlParameters = [
                    'edit' => [
                        'pages' => [
                            $this->id => 'edit'
                        ]
                    ],
864
                    'returnUrl' => $normalizedParams->getRequestUri(),
865
                ];
866
                $url = (string)$this->uriBuilder->buildUriFromRoute('record_edit', $urlParameters);
867
                $editPageButton = $this->buttonBar->makeLinkButton()
868
                    ->setHref($url)
869
                    ->setTitle($lang->getLL('editPageProperties'))
870
871
                    ->setIcon($this->iconFactory->getIcon('actions-page-open', Icon::SIZE_SMALL));
                $this->buttonBar->addButton($editPageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
872
873
874
875
876
877
878
879
880
881
882
883
884
            }
        }
    }

    /*******************************
     *
     * Other functions
     *
     ******************************/
    /**
     * Returns the number of hidden elements (including those hidden by start/end times)
     * on the current page (for the current sys_language)
     *
885
     * @param array $languageColumns
886
887
     * @return int
     */
888
    protected function getNumberOfHiddenElements(array $languageColumns): int
889
    {
890
        $andWhere = [];
891
892
893
894
895
896
897
898
899
900
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tt_content');
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
            ->add(GeneralUtility::makeInstance(BackendWorkspaceRestriction::class));

        $queryBuilder
            ->count('uid')
            ->from('tt_content')
            ->where(
901
902
903
                $queryBuilder->expr()->eq(
                    'pid',
                    $queryBuilder->createNamedParameter($this->id, \PDO::PARAM_INT)
904
905
906
                )
            );

907
        if (!empty($languageColumns)) {
908
909
910
911
912
913
914
915
916
917
918
            // 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(
919
920
921
922
                $queryBuilder->expr()->eq(
                    'sys_language_uid',
                    $queryBuilder->createNamedParameter($this->current_sys_language, \PDO::PARAM_INT)
                )
923
            );
924
        }
925
926

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['disabled'])) {
927
928
929
930
            $andWhere[] = $queryBuilder->expr()->neq(
                'hidden',
                $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
            );
931
932
933
934
        }

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['starttime'])) {
            $andWhere[] = $queryBuilder->expr()->andX(
935
936
937
938
939
940
941
942
                $queryBuilder->expr()->neq(
                    'starttime',
                    $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->gt(
                    'starttime',
                    $queryBuilder->createNamedParameter($GLOBALS['SIM_ACCESS_TIME'], \PDO::PARAM_INT)
                )
943
944
945
946
947
            );
        }

        if (!empty($GLOBALS['TCA']['tt_content']['ctrl']['enablecolumns']['endtime'])) {
            $andWhere[] = $queryBuilder->expr()->andX(
948
949
950
951
952
953
954
955
                $queryBuilder->expr()->neq(
                    'endtime',
                    $queryBuilder->createNamedParameter(0, \PDO::PARAM_INT)
                ),
                $queryBuilder->expr()->lte(
                    'endtime',
                    $queryBuilder->createNamedParameter($GLOBALS['SIM_ACCESS_TIME'], \PDO::PARAM_INT)
                )
956
957
958
959
960
961
962
963
964
965
966
967
968
969
            );
        }

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

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

        return (int)$count;
970
971
972
    }

    /**
973
     * Check if page can be edited by current user
974
     *
975
     * @param int $languageId
976
977
     * @return bool
     */
978
    protected function isPageEditable(int $languageId): bool
979
    {
980
981
982
        if ($this->getBackendUser()->isAdmin()) {
            return true;
        }
983

984
985
986
        return !$this->pageinfo['editlock']
            && $this->getBackendUser()->doesUserHaveAccess($this->pageinfo, Permission::PAGE_EDIT)
            && $this->getBackendUser()->checkLanguageAccess($languageId);
987
988
989
990
991
    }

    /**
     * Check if content can be edited by current user
     *
992
     * @param int $languageId
993
994
     * @return bool
     */
995
    protected function isContentEditable(int $languageId): bool
996
    {
997
998
999
        if ($this->getBackendUser()->isAdmin()) {
            return true;
        }
1000

1001
1002
1003
        return !$this->pageinfo['editlock']
            && $this->getBackendUser()->doesUserHaveAccess($this->pageinfo, Permission::CONTENT_EDIT)
            && $this->getBackendUser()->checkLanguageAccess($languageId);
1004
1005
    }

1006
1007
1008
    /**
     * Returns LanguageService
     *
1009
     * @return LanguageService
1010
     */
1011
    protected function getLanguageService(): LanguageService