[BUGFIX] Prevent XSS in PageLayoutController
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Controller / PageLayoutController.php
1 <?php
2 namespace TYPO3\CMS\Backend\Controller;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use Psr\Http\Message\ResponseInterface;
18 use Psr\Http\Message\ServerRequestInterface;
19 use TYPO3\CMS\Backend\Form\Exception\AccessDeniedException;
20 use TYPO3\CMS\Backend\Form\FormDataCompiler;
21 use TYPO3\CMS\Backend\Form\FormDataGroup\TcaDatabaseRecord;
22 use TYPO3\CMS\Backend\Form\FormResultCompiler;
23 use TYPO3\CMS\Backend\Form\NodeFactory;
24 use TYPO3\CMS\Backend\Module\ModuleLoader;
25 use TYPO3\CMS\Backend\Template\Components\ButtonBar;
26 use TYPO3\CMS\Backend\Template\ModuleTemplate;
27 use TYPO3\CMS\Backend\Tree\View\ContentLayoutPagePositionMap;
28 use TYPO3\CMS\Backend\Utility\BackendUtility;
29 use TYPO3\CMS\Backend\View\BackendLayoutView;
30 use TYPO3\CMS\Backend\View\PageLayoutView;
31 use TYPO3\CMS\Core\DataHandling\DataHandler;
32 use TYPO3\CMS\Core\Imaging\Icon;
33 use TYPO3\CMS\Core\Imaging\IconFactory;
34 use TYPO3\CMS\Core\Messaging\FlashMessage;
35 use TYPO3\CMS\Core\Messaging\FlashMessageService;
36 use TYPO3\CMS\Core\Page\PageRenderer;
37 use TYPO3\CMS\Core\Type\Bitmask\Permission;
38 use TYPO3\CMS\Core\Utility\GeneralUtility;
39 use TYPO3\CMS\Core\Utility\HttpUtility;
40 use TYPO3\CMS\Core\Utility\MathUtility;
41 use TYPO3\CMS\Core\Versioning\VersionState;
42 use TYPO3\CMS\Fluid\View\StandaloneView;
43 use TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper;
44 use TYPO3\CMS\Frontend\Page\PageRepository;
45 use TYPO3\CMS\Recordlist\RecordList;
46
47 /**
48 * Script Class for Web > Layout module
49 */
50 class PageLayoutController
51 {
52 /**
53 * Page Id for which to make the listing
54 *
55 * @var int
56 */
57 public $id;
58
59 /**
60 * Pointer - for browsing list of records.
61 *
62 * @var int
63 */
64 public $pointer;
65
66 /**
67 * Thumbnails or not
68 *
69 * @var string
70 */
71 public $imagemode;
72
73 /**
74 * Search-fields
75 *
76 * @var string
77 */
78 public $search_field;
79
80 /**
81 * Search-levels
82 *
83 * @var int
84 */
85 public $search_levels;
86
87 /**
88 * Show-limit
89 *
90 * @var int
91 */
92 public $showLimit;
93
94 /**
95 * Return URL
96 *
97 * @var string
98 */
99 public $returnUrl;
100
101 /**
102 * Clear-cache flag - if set, clears page cache for current id.
103 *
104 * @var bool
105 */
106 public $clear_cache;
107
108 /**
109 * PopView id - for opening a window with the page
110 *
111 * @var bool
112 */
113 public $popView;
114
115 /**
116 * QuickEdit: Variable, that tells quick edit what to show/edit etc.
117 * Format is [tablename]:[uid] with some exceptional values for both parameters (with special meanings).
118 *
119 * @var string
120 */
121 public $edit_record;
122
123 /**
124 * QuickEdit: If set, this variable tells quick edit that the last edited record had
125 * this value as UID and we should look up the new, real uid value in sys_log.
126 *
127 * @var string
128 */
129 public $new_unique_uid;
130
131 /**
132 * Page select perms clause
133 *
134 * @var string
135 */
136 public $perms_clause;
137
138 /**
139 * Module TSconfig
140 *
141 * @var array
142 */
143 public $modTSconfig;
144
145 /**
146 * Module shared TSconfig
147 *
148 * @var array
149 */
150 public $modSharedTSconfig;
151
152 /**
153 * Current ids page record
154 *
155 * @var array
156 */
157 public $pageinfo;
158
159 /**
160
161 * "Pseudo" Description -table name
162 *
163 * @var string
164 */
165 public $descrTable;
166
167 /**
168 * List of column-integers to edit. Is set from TSconfig, default is "1,0,2,3"
169 *
170 * @var string
171 */
172 public $colPosList;
173
174 /**
175 * Flag: If content can be edited or not.
176 *
177 * @var bool
178 */
179 public $EDIT_CONTENT;
180
181 /**
182 * Users permissions integer for this page.
183 *
184 * @var int
185 */
186 public $CALC_PERMS;
187
188 /**
189 * Currently selected language for editing content elements
190 *
191 * @var int
192 */
193 public $current_sys_language;
194
195 /**
196 * Module configuration
197 *
198 * @var array
199 */
200 public $MCONF = [];
201
202 /**
203 * Menu configuration
204 *
205 * @var array
206 */
207 public $MOD_MENU = [];
208
209 /**
210 * Module settings (session variable)
211 *
212 * @var array
213 */
214 public $MOD_SETTINGS = [];
215
216 /**
217 * Array of tables to be listed by the Web > Page module in addition to the default tables
218 *
219 * @var array
220 */
221 public $externalTables = [];
222
223 /**
224 * Module output accumulation
225 *
226 * @var string
227 */
228 public $content;
229
230 /**
231 * List of column-integers accessible to the current BE user.
232 * Is set from TSconfig, default is $colPosList
233 *
234 * @var string
235 */
236 public $activeColPosList;
237
238 /**
239 * @var array
240 */
241 protected $eRParts = [];
242
243 /**
244 * @var string
245 */
246 protected $editSelect;
247
248 /**
249 * @var bool
250 */
251 protected $deleteButton;
252
253 /**
254 * @var bool
255 */
256 protected $undoButton;
257
258 /**
259 * @var array
260 */
261 protected $undoButtonR;
262
263 /**
264 * @var string
265 */
266 protected $R_URI;
267
268 /**
269 * @var string
270 */
271 protected $closeUrl;
272
273 /**
274 * Caches the available languages in a colPos
275 *
276 * @var array
277 */
278 protected $languagesInColumnCache = [];
279
280 /**
281 * Caches the amount of content elements as a matrix
282 *
283 * @var array
284 * @internal
285 */
286 public $contentElementCache = [];
287
288 /**
289 * @var IconFactory
290 */
291 protected $iconFactory;
292
293 /**
294 * The name of the module
295 *
296 * @var string
297 */
298 protected $moduleName = 'web_layout';
299
300 /**
301 * @var ModuleTemplate
302 */
303 protected $moduleTemplate;
304
305 /**
306 * @var ButtonBar
307 */
308 protected $buttonBar;
309
310 /**
311 * @var string
312 */
313 protected $searchContent;
314
315 /**
316 * Initializing the module
317 *
318 * @return void
319 */
320 public function init()
321 {
322 $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);
323 $this->iconFactory = $this->moduleTemplate->getIconFactory();
324 $this->buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
325 $this->getLanguageService()->includeLLFile('EXT:backend/Resources/Private/Language/locallang_layout.xlf');
326 // Setting module configuration / page select clause
327 $this->MCONF['name'] = $this->moduleName;
328 $this->perms_clause = $this->getBackendUser()->getPagePermsClause(1);
329 // Get session data
330 $sessionData = $this->getBackendUser()->getSessionData(RecordList::class);
331 $this->search_field = !empty($sessionData['search_field']) ? $sessionData['search_field'] : '';
332 // GPvars:
333 $this->id = (int)GeneralUtility::_GP('id');
334 $this->pointer = GeneralUtility::_GP('pointer');
335 $this->imagemode = GeneralUtility::_GP('imagemode');
336 $this->clear_cache = GeneralUtility::_GP('clear_cache');
337 $this->popView = GeneralUtility::_GP('popView');
338 $this->edit_record = GeneralUtility::_GP('edit_record');
339 $this->new_unique_uid = GeneralUtility::_GP('new_unique_uid');
340 $this->search_field = GeneralUtility::_GP('search_field');
341 $this->search_levels = GeneralUtility::_GP('search_levels');
342 $this->showLimit = GeneralUtility::_GP('showLimit');
343 $this->returnUrl = GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GP('returnUrl'));
344 $this->externalTables = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['cms']['db_layout']['addTables'];
345 $sessionData['search_field'] = $this->search_field;
346 // Store session data
347 $this->getBackendUser()->setAndSaveSessionData(RecordList::class, $sessionData);
348 // Load page info array:
349 $this->pageinfo = BackendUtility::readPageAccess($this->id, $this->perms_clause);
350 // Initialize menu
351 $this->menuConfig();
352 // Setting sys language from session var:
353 $this->current_sys_language = (int)$this->MOD_SETTINGS['language'];
354 // CSH / Descriptions:
355 $this->descrTable = '_MOD_' . $this->moduleName;
356 }
357
358 /**
359 * Initialize menu array
360 *
361 * @return void
362 */
363 public function menuConfig()
364 {
365 $lang = $this->getLanguageService();
366 // MENU-ITEMS:
367 $this->MOD_MENU = [
368 'tt_content_showHidden' => '',
369 'function' => [
370 1 => $lang->getLL('m_function_1'),
371 0 => $lang->getLL('m_function_0'),
372 2 => $lang->getLL('m_function_2')
373 ],
374 'language' => [
375 0 => $lang->getLL('m_default')
376 ]
377 ];
378 // initialize page/be_user TSconfig settings
379 $this->modSharedTSconfig = BackendUtility::getModTSconfig($this->id, 'mod.SHARED');
380 $this->modTSconfig = BackendUtility::getModTSconfig($this->id, 'mod.' . $this->moduleName);
381 // example settings:
382 // $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['cms']['db_layout']['addTables']['tx_myext'] =
383 // array ('default' => array(
384 // 'MENU' => 'LLL:EXT:tx_myext/locallang_db.xlf:menuDefault',
385 // 'fList' => 'title,description,image',
386 // 'icon' => TRUE));
387 if (is_array($this->externalTables)) {
388 foreach ($this->externalTables as $table => $tableSettings) {
389 // delete the default settings from above
390 if (is_array($this->MOD_MENU[$table])) {
391 unset($this->MOD_MENU[$table]);
392 }
393 if (is_array($tableSettings) && count($tableSettings) > 1) {
394 foreach ($tableSettings as $key => $settings) {
395 $this->MOD_MENU[$table][$key] = $lang->sL($settings['MENU']);
396 }
397 }
398 }
399 }
400 // First, select all pages_language_overlay records on the current page. Each represents a possibility for a language on the page. Add these to language selector.
401 $res = $this->exec_languageQuery($this->id);
402 while ($lRow = $this->getDatabaseConnection()->sql_fetch_assoc($res)) {
403 if ($this->getBackendUser()->checkLanguageAccess($lRow['uid'])) {
404 $this->MOD_MENU['language'][$lRow['uid']] = $lRow['hidden'] ? '(' . $lRow['title'] . ')' : $lRow['title'];
405 }
406 }
407 // Setting alternative default label:
408 if (($this->modSharedTSconfig['properties']['defaultLanguageLabel'] || $this->modTSconfig['properties']['defaultLanguageLabel']) && isset($this->MOD_MENU['language'][0])) {
409 $this->MOD_MENU['language'][0] = $this->modTSconfig['properties']['defaultLanguageLabel'] ? $this->modTSconfig['properties']['defaultLanguageLabel'] : $this->modSharedTSconfig['properties']['defaultLanguageLabel'];
410 }
411 // Clean up settings
412 $this->MOD_SETTINGS = BackendUtility::getModuleData($this->MOD_MENU, GeneralUtility::_GP('SET'), $this->moduleName);
413 // For all elements to be shown in draft workspaces & to also show hidden elements by default if user hasn't disabled the option
414 if ($this->getBackendUser()->workspace != 0 || $this->MOD_SETTINGS['tt_content_showHidden'] !== '0') {
415 $this->MOD_SETTINGS['tt_content_showHidden'] = 1;
416 }
417 $this->makeActionMenu();
418 }
419
420 /**
421 * This creates the dropdown menu with the different actions this module is able to provide.
422 * For now they are Columns, Quick Edit and Languages.
423 *
424 * @return void
425 */
426 protected function makeActionMenu()
427 {
428 $availableActionArray = [
429 0 => $this->getLanguageService()->getLL('m_function_0'),
430 1 => $this->getLanguageService()->getLL('m_function_1'),
431 2 => $this->getLanguageService()->getLL('m_function_2')
432 ];
433 // Find if there are ANY languages at all (and if not, remove the language option from function menu).
434 $count = $this->getDatabaseConnection()->exec_SELECTcountRows('uid', 'sys_language', $this->getBackendUser()->isAdmin() ? '' : 'hidden=0');
435 if (!$count) {
436 unset($availableActionArray['2']);
437 }
438 // page/be_user TSconfig settings and blinding of menu-items
439 if ($this->modTSconfig['properties']['QEisDefault']) {
440 ksort($availableActionArray);
441 }
442 $availableActionArray = BackendUtility::unsetMenuItems($this->modTSconfig['properties'], $availableActionArray, 'menu.function');
443 // Remove QuickEdit as option if page type is not...
444 if (!GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['FE']['content_doktypes'] . ',6', $this->pageinfo['doktype'])) {
445 unset($availableActionArray[0]);
446 }
447 $actionMenu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
448 $actionMenu->setIdentifier('actionMenu');
449 $actionMenu->setLabel('');
450
451 $defaultKey = null;
452 $foundDefaultKey = false;
453 foreach ($availableActionArray as $key => $action) {
454 $menuItem = $actionMenu
455 ->makeMenuItem()
456 ->setTitle($action)
457 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&SET[function]=' . $key);
458
459 if (!$foundDefaultKey) {
460 $defaultKey = $key;
461 $foundDefaultKey = true;
462 }
463 if ((int)$this->MOD_SETTINGS['function'] === $key) {
464 $menuItem->setActive(true);
465 $defaultKey = null;
466 }
467 $actionMenu->addMenuItem($menuItem);
468 }
469 if (isset($defaultKey)) {
470 $this->MOD_SETTINGS['function'] = $defaultKey;
471 }
472 $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($actionMenu);
473 }
474
475 /**
476 * Clears page cache for the current id, $this->id
477 *
478 * @return void
479 */
480 public function clearCache()
481 {
482 if ($this->clear_cache) {
483 $tce = GeneralUtility::makeInstance(DataHandler::class);
484 $tce->stripslashes_values = false;
485 $tce->start([], []);
486 $tce->clear_cacheCmd($this->id);
487 }
488 }
489
490 /**
491 * Generate the flashmessages for current pid
492 *
493 * @return string HTML content with flashmessages
494 */
495 protected function getHeaderFlashMessagesForCurrentPid()
496 {
497 $content = '';
498 $lang = $this->getLanguageService();
499
500 // If page is a folder
501 if ($this->pageinfo['doktype'] == PageRepository::DOKTYPE_SYSFOLDER) {
502 $moduleLoader = GeneralUtility::makeInstance(ModuleLoader::class);
503 $moduleLoader->load($GLOBALS['TBE_MODULES']);
504 $modules = $moduleLoader->modules;
505 if (is_array($modules['web']['sub']['list'])) {
506 $title = $lang->getLL('goToListModule');
507 $message = '<p>' . $lang->getLL('goToListModuleMessage') . '</p>';
508 $message .= '<a class="btn btn-info" href="javascript:top.goToModule(\'web_list\',1);">' . $lang->getLL('goToListModule') . '</a>';
509 $view = GeneralUtility::makeInstance(StandaloneView::class);
510 $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/InfoBox.html'));
511 $view->assignMultiple([
512 'title' => $title,
513 'message' => $message,
514 'state' => InfoboxViewHelper::STATE_INFO
515 ]);
516 $content .= $view->render();
517 }
518 }
519 // If content from different pid is displayed
520 if ($this->pageinfo['content_from_pid']) {
521 $contentPage = BackendUtility::getRecord('pages', (int)$this->pageinfo['content_from_pid']);
522 $linkToPid = $this->local_linkThisScript(['id' => $this->pageinfo['content_from_pid']]);
523 $title = BackendUtility::getRecordTitle('pages', $contentPage);
524 $link = '<a href="' . htmlspecialchars($linkToPid) . '">' . htmlspecialchars($title) . ' (PID ' . (int)$this->pageinfo['content_from_pid'] . ')</a>';
525 $message = sprintf($lang->getLL('content_from_pid_title'), $link);
526 $view = GeneralUtility::makeInstance(StandaloneView::class);
527 $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/InfoBox.html'));
528 $view->assignMultiple([
529 'title' => $title,
530 'message' => $message,
531 'state' => InfoboxViewHelper::STATE_INFO
532 ]);
533 $content .= $view->render();
534 }
535 return $content;
536 }
537
538 /**
539 *
540 * @return string $title
541 */
542 protected function getLocalizedPageTitle()
543 {
544 if ($this->current_sys_language > 0) {
545 $overlayRecord = $this->getDatabaseConnection()->exec_SELECTgetSingleRow(
546 'title',
547 'pages_language_overlay',
548 'pid = ' . (int)$this->id .
549 ' AND sys_language_uid = ' . (int)$this->current_sys_language .
550 BackendUtility::deleteClause('pages_language_overlay') .
551 BackendUtility::versioningPlaceholderClause('pages_language_overlay'),
552 '',
553 '',
554 ''
555 );
556 return $overlayRecord['title'];
557 } else {
558 return $this->pageinfo['title'];
559 }
560 }
561
562 /**
563 * Injects the request object for the current request or subrequest
564 * As this controller goes only through the main() method, it is rather simple for now
565 *
566 * @param ServerRequestInterface $request the current request
567 * @param ResponseInterface $response
568 * @return ResponseInterface the response with the content
569 */
570 public function mainAction(ServerRequestInterface $request, ResponseInterface $response)
571 {
572 $GLOBALS['SOBE'] = $this;
573 $this->init();
574 $this->clearCache();
575 $this->main();
576 $response->getBody()->write($this->moduleTemplate->renderContent());
577 return $response;
578 }
579
580 /**
581 * Main function.
582 * Creates some general objects and calls other functions for the main rendering of module content.
583 *
584 * @return void
585 */
586 public function main()
587 {
588 $lang = $this->getLanguageService();
589 // Access check...
590 // The page will show only if there is a valid page and if this page may be viewed by the user
591 $access = is_array($this->pageinfo) ? 1 : 0;
592 // Content
593 $content = '';
594 if ($this->id && $access) {
595 // Initialize permission settings:
596 $this->CALC_PERMS = $this->getBackendUser()->calcPerms($this->pageinfo);
597 $this->EDIT_CONTENT = $this->contentIsNotLockedForEditors();
598
599 $this->moduleTemplate->getDocHeaderComponent()->setMetaInformation($this->pageinfo);
600
601 // override the default jumpToUrl
602 $this->moduleTemplate->addJavaScriptCode('jumpToUrl', '
603 function jumpToUrl(URL,formEl) {
604 if (document.editform && TBE_EDITOR.isFormChanged) { // Check if the function exists... (works in all browsers?)
605 if (!TBE_EDITOR.isFormChanged()) {
606 window.location.href = URL;
607 } else if (formEl) {
608 if (formEl.type=="checkbox") formEl.checked = formEl.checked ? 0 : 1;
609 }
610 } else {
611 window.location.href = URL;
612 }
613 }
614 ');
615 $this->moduleTemplate->addJavaScriptCode('mainJsFunctions', '
616 if (top.fsMod) {
617 top.fsMod.recentIds["web"] = ' . (int)$this->id . ';
618 top.fsMod.navFrameHighlightedID["web"] = "pages' . (int)$this->id . '_"+top.fsMod.currentBank; ' . (int)$this->id . ';
619 }
620 ' . ($this->popView ? BackendUtility::viewOnClick($this->id, '', BackendUtility::BEgetRootLine($this->id)) : '') . '
621 function deleteRecord(table,id,url) { //
622 window.location.href = ' . GeneralUtility::quoteJSvalue(BackendUtility::getModuleUrl('tce_db') . '&cmd[')
623 . ' + table + "][" + id + "][delete]=1&redirect=" + encodeURIComponent(url) + "&vC=' . $this->getBackendUser()->veriCode() . '&prErr=1&uPT=1";
624 return false;
625 }
626 ');
627
628 // Find backend layout / columns
629 $backendLayout = GeneralUtility::callUserFunction(BackendLayoutView::class . '->getSelectedBackendLayout', $this->id, $this);
630 if (!empty($backendLayout['__colPosList'])) {
631 $this->colPosList = implode(',', $backendLayout['__colPosList']);
632 }
633 // Removing duplicates, if any
634 $this->colPosList = array_unique(GeneralUtility::intExplode(',', $this->colPosList));
635 // Accessible columns
636 if (isset($this->modSharedTSconfig['properties']['colPos_list']) && trim($this->modSharedTSconfig['properties']['colPos_list']) !== '') {
637 $this->activeColPosList = array_unique(GeneralUtility::intExplode(',', trim($this->modSharedTSconfig['properties']['colPos_list'])));
638 // Match with the list which is present in the colPosList for the current page
639 if (!empty($this->colPosList) && !empty($this->activeColPosList)) {
640 $this->activeColPosList = array_unique(array_intersect(
641 $this->activeColPosList,
642 $this->colPosList
643 ));
644 }
645 } else {
646 $this->activeColPosList = $this->colPosList;
647 }
648 $this->activeColPosList = implode(',', $this->activeColPosList);
649 $this->colPosList = implode(',', $this->colPosList);
650
651 $content .= $this->getHeaderFlashMessagesForCurrentPid();
652
653 // Render the primary module content:
654 if ($this->MOD_SETTINGS['function'] == 0) {
655 // QuickEdit
656 $content .= '<form action="' . htmlspecialchars(BackendUtility::getModuleUrl('tce_db', ['prErr' => 1, 'uPT' => 1])) . '" method="post" enctype="multipart/form-data" name="editform" id="PageLayoutController" onsubmit="return TBE_EDITOR.checkSubmit(1);">';
657 $content .= $this->renderQuickEdit();
658 } else {
659 $content .= '<form action="' . htmlspecialchars(BackendUtility::getModuleUrl($this->moduleName, ['id' => $this->id, 'imagemode' => $this->imagemode])) . '" id="PageLayoutController" method="post">';
660 // Page title
661 $content .= '<h1 class="t3js-title-inlineedit">' . htmlspecialchars($this->getLocalizedPageTitle()) . '</h1>';
662 // All other listings
663 $content .= $this->renderListContent();
664 }
665 $content .= '</form>';
666 $content .= $this->searchContent;
667 // Setting up the buttons for the docheader
668 $this->makeButtons($this->MOD_SETTINGS['function'] == 0 ? 'quickEdit' : '');
669 // Create LanguageMenu
670 $this->makeLanguageMenu();
671 } else {
672 $this->moduleTemplate->addJavaScriptCode(
673 'mainJsFunctions',
674 'if (top.fsMod) top.fsMod.recentIds["web"] = ' . (int)$this->id . ';'
675 );
676 $content .= '<h1>' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '</h1>';
677 $view = GeneralUtility::makeInstance(StandaloneView::class);
678 $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/InfoBox.html'));
679 $view->assignMultiple([
680 'title' => $lang->getLL('clickAPage_header'),
681 'message' => $lang->getLL('clickAPage_content'),
682 'state' => InfoboxViewHelper::STATE_INFO
683 ]);
684 $content .= $view->render();
685 }
686 // Set content
687 $this->moduleTemplate->setContent($content);
688 }
689
690 /**
691 * Rendering the quick-edit view.
692 *
693 * @return string
694 */
695 public function renderQuickEdit()
696 {
697 $databaseConnection = $this->getDatabaseConnection();
698 $beUser = $this->getBackendUser();
699 $lang = $this->getLanguageService();
700 // Set the edit_record value for internal use in this function:
701 $edit_record = $this->edit_record;
702 // If a command to edit all records in a column is issue, then select all those elements, and redirect to FormEngine
703 if (substr($edit_record, 0, 9) == '_EDIT_COL') {
704 $res = $databaseConnection->exec_SELECTquery('*', 'tt_content', 'pid=' . (int)$this->id . ' AND colPos=' . (int)substr($edit_record, 10) . ' AND sys_language_uid=' . (int)$this->current_sys_language . ($this->MOD_SETTINGS['tt_content_showHidden'] ? '' : BackendUtility::BEenableFields('tt_content')) . BackendUtility::deleteClause('tt_content') . BackendUtility::versioningPlaceholderClause('tt_content'), '', 'sorting');
705 $idListA = [];
706 while ($cRow = $databaseConnection->sql_fetch_assoc($res)) {
707 $idListA[] = $cRow['uid'];
708 }
709 $url = BackendUtility::getModuleUrl('record_edit', [
710 'edit[tt_content][' . implode(',', $idListA) . ']' => 'edit',
711 'returnUrl' => $this->local_linkThisScript(['edit_record' => ''])
712 ]);
713 HttpUtility::redirect($url);
714 }
715 // If the former record edited was the creation of a NEW record, this will look up the created records uid:
716 if ($this->new_unique_uid) {
717 $res = $databaseConnection->exec_SELECTquery('*', 'sys_log', 'userid=' . (int)$beUser->user['uid'] . ' AND NEWid=' . $databaseConnection->fullQuoteStr($this->new_unique_uid, 'sys_log'));
718 $sys_log_row = $databaseConnection->sql_fetch_assoc($res);
719 if (is_array($sys_log_row)) {
720 $edit_record = $sys_log_row['tablename'] . ':' . $sys_log_row['recuid'];
721 }
722 }
723 $edit_record = $this->makeQuickEditMenu($edit_record);
724 // Splitting the edit-record cmd value into table/uid:
725 $this->eRParts = explode(':', $edit_record);
726 $tableName = $this->eRParts[0];
727 // Delete-button flag?
728 $this->deleteButton = MathUtility::canBeInterpretedAsInteger($this->eRParts[1]) && $edit_record && ($tableName !== 'pages' && $this->EDIT_CONTENT || $tableName === 'pages' && $this->CALC_PERMS & Permission::PAGE_DELETE);
729 // If undo-button should be rendered (depends on available items in sys_history)
730 $this->undoButton = false;
731
732 // if there is no content on a page
733 // the parameter $this->eRParts[1] will be set to e.g. /new/1
734 // which is not an integer value and it will throw an exception here on certain dbms
735 // thus let's check that before as there cannot be a history for a new record
736 $this->undoButtonR = false;
737 if (MathUtility::canBeInterpretedAsInteger($this->eRParts[1])) {
738 $undoRes = $databaseConnection->exec_SELECTquery('tstamp', 'sys_history', 'tablename=' . $databaseConnection->fullQuoteStr($tableName, 'sys_history') . ' AND recuid=' . (int)$this->eRParts[1], '', 'tstamp DESC', '1');
739 $this->undoButtonR = $databaseConnection->sql_fetch_assoc($undoRes);
740 }
741 if ($this->undoButtonR) {
742 $this->undoButton = true;
743 }
744 // Setting up the Return URL for coming back to THIS script (if links take the user to another script)
745 $R_URL_parts = parse_url(GeneralUtility::getIndpEnv('REQUEST_URI'));
746 $R_URL_getvars = GeneralUtility::_GET();
747 unset($R_URL_getvars['popView']);
748 unset($R_URL_getvars['new_unique_uid']);
749 $R_URL_getvars['edit_record'] = $edit_record;
750 $this->R_URI = $R_URL_parts['path'] . '?' . GeneralUtility::implodeArrayForUrl('', $R_URL_getvars);
751
752 // Creating editing form:
753 if ($edit_record) {
754 // Splitting uid parts for special features, if new:
755 list($uidVal, $neighborRecordUid, $ex_colPos) = explode('/', $this->eRParts[1]);
756
757 if ($uidVal === 'new') {
758 $command = 'new';
759 // Page id of this new record
760 $theUid = $this->id;
761 if ($neighborRecordUid) {
762 $theUid = $neighborRecordUid;
763 }
764 } else {
765 $command = 'edit';
766 $theUid = $uidVal;
767 // Convert $uidVal to workspace version if any:
768 $draftRecord = BackendUtility::getWorkspaceVersionOfRecord($beUser->workspace, $tableName, $theUid, 'uid');
769 if ($draftRecord) {
770 $theUid = $draftRecord['uid'];
771 }
772 }
773
774 // @todo: Hack because DatabaseInitializeNewRow reads from _GP directly
775 $GLOBALS['_GET']['defVals'][$tableName] = [
776 'colPos' => (int)$ex_colPos,
777 'sys_language_uid' => (int)$this->current_sys_language
778 ];
779
780 /** @var TcaDatabaseRecord $formDataGroup */
781 $formDataGroup = GeneralUtility::makeInstance(TcaDatabaseRecord::class);
782 /** @var FormDataCompiler $formDataCompiler */
783 $formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
784 /** @var NodeFactory $nodeFactory */
785 $nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);
786
787 try {
788 $formDataCompilerInput = [
789 'tableName' => $tableName,
790 'vanillaUid' => (int)$theUid,
791 'command' => $command,
792 ];
793 $formData = $formDataCompiler->compile($formDataCompilerInput);
794
795 if ($command !== 'new') {
796 BackendUtility::lockRecords($tableName, $formData['databaseRow']['uid'], $tableName === 'tt_content' ? $formData['databaseRow']['pid'] : 0);
797 }
798
799 $formData['renderType'] = 'outerWrapContainer';
800 $formResult = $nodeFactory->create($formData)->render();
801
802 $panel = $formResult['html'];
803 $formResult['html'] = '';
804
805 /** @var FormResultCompiler $formResultCompiler */
806 $formResultCompiler = GeneralUtility::makeInstance(FormResultCompiler::class);
807 $formResultCompiler->mergeResult($formResult);
808
809 $row = $formData['databaseRow'];
810 $new_unique_uid = '';
811 if ($command === 'new') {
812 $new_unique_uid = $row['uid'];
813 }
814
815 // Add hidden fields:
816 if ($uidVal == 'new') {
817 $panel .= '<input type="hidden" name="data[' . $tableName . '][' . $row['uid'] . '][pid]" value="' . $row['pid'] . '" />';
818 }
819 $redirect = ($uidVal == 'new' ? BackendUtility::getModuleUrl(
820 $this->moduleName,
821 ['id' => $this->id, 'new_unique_uid' => $new_unique_uid, 'returnUrl' => $this->returnUrl]
822 ) : $this->R_URI);
823 $panel .= '
824 <input type="hidden" name="_serialNumber" value="' . md5(microtime()) . '" />
825 <input type="hidden" name="edit_record" value="' . $edit_record . '" />
826 <input type="hidden" name="redirect" value="' . htmlspecialchars($redirect) . '" />
827 ';
828 // Add JavaScript as needed around the form:
829 $content = $formResultCompiler->JStop() . $panel . $formResultCompiler->printNeededJSFunctions();
830
831 // Display "is-locked" message:
832 if ($command === 'edit') {
833 $lockInfo = BackendUtility::isRecordLocked($tableName, $formData['databaseRow']['uid']);
834 if ($lockInfo) {
835 /** @var \TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage */
836 $flashMessage = GeneralUtility::makeInstance(FlashMessage::class, $lockInfo['msg'], '', FlashMessage::WARNING);
837 /** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
838 $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
839 /** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
840 $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
841 $defaultFlashMessageQueue->enqueue($flashMessage);
842 }
843 }
844 } catch (AccessDeniedException $e) {
845 // If no edit access, print error message:
846 $content = '<h2>' . $lang->getLL('noAccess', true) . '</h2>';
847 $content .= '<div>' . $lang->getLL('noAccess_msg') . '<br /><br />' . ($beUser->errorMsg ? 'Reason: ' . $beUser->errorMsg . '<br /><br />' : '') . '</div>';
848 }
849 } else {
850 // If no edit access, print error message:
851 $content = '<h2>' . $lang->getLL('noAccess') . '</h2>';
852 $content .= '<div>' . $lang->getLL('noAccess_msg') . '</div>';
853 }
854
855 // Element selection matrix:
856 if ($tableName === 'tt_content' && MathUtility::canBeInterpretedAsInteger($this->eRParts[1])) {
857 $content .= '<h2>' . $lang->getLL('CEonThisPage') . '</h2>';
858 // PositionMap
859 $posMap = GeneralUtility::makeInstance(ContentLayoutPagePositionMap::class);
860 $posMap->cur_sys_language = $this->current_sys_language;
861 $content .= $posMap->printContentElementColumns(
862 $this->id,
863 $this->eRParts[1],
864 $this->colPosList,
865 $this->MOD_SETTINGS['tt_content_showHidden'],
866 $this->R_URI
867 );
868 // Toggle hidden ContentElements
869 $numberOfHiddenElements = $this->getNumberOfHiddenElements();
870 if ($numberOfHiddenElements) {
871 $content .= '<div class="checkbox">';
872 $content .= '<label for="checkTt_content_showHidden">';
873 $content .= BackendUtility::getFuncCheck($this->id, 'SET[tt_content_showHidden]', $this->MOD_SETTINGS['tt_content_showHidden'], '', '', 'id="checkTt_content_showHidden"');
874 $content .= (!$numberOfHiddenElements ? ('<span class="text-muted">' . $lang->getLL('hiddenCE', true) . '</span>') : $lang->getLL('hiddenCE', true) . ' (' . $numberOfHiddenElements . ')');
875 $content .= '</label>';
876 $content .= '</div>';
877 }
878 // CSH
879 $content .= BackendUtility::cshItem($this->descrTable, 'quickEdit_selElement', null, '<span class="btn btn-default btn-sm">|</span>');
880 }
881
882 return $content;
883 }
884
885 /**
886 * Rendering all other listings than QuickEdit
887 *
888 * @return string
889 */
890 public function renderListContent()
891 {
892 $this->moduleTemplate->getPageRenderer()->loadJquery();
893 $this->moduleTemplate->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/ClickMenu');
894 /** @var $dbList \TYPO3\CMS\Backend\View\PageLayoutView */
895 $dbList = GeneralUtility::makeInstance(PageLayoutView::class);
896 $dbList->thumbs = $this->imagemode;
897 $dbList->no_noWrap = 1;
898 $dbList->descrTable = $this->descrTable;
899 $this->pointer = MathUtility::forceIntegerInRange($this->pointer, 0, 100000);
900 $dbList->script = BackendUtility::getModuleUrl($this->moduleName);
901 $dbList->showIcon = 0;
902 $dbList->setLMargin = 0;
903 $dbList->doEdit = $this->EDIT_CONTENT;
904 $dbList->ext_CALC_PERMS = $this->CALC_PERMS;
905 $dbList->agePrefixes = $this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears');
906 $dbList->id = $this->id;
907 $dbList->nextThree = MathUtility::forceIntegerInRange($this->modTSconfig['properties']['editFieldsAtATime'], 0, 10);
908 $dbList->option_newWizard = $this->modTSconfig['properties']['disableNewContentElementWizard'] ? 0 : 1;
909 $dbList->defLangBinding = $this->modTSconfig['properties']['defLangBinding'] ? 1 : 0;
910 if (!$dbList->nextThree) {
911 $dbList->nextThree = 1;
912 }
913 $dbList->externalTables = $this->externalTables;
914 // Create menu for selecting a table to jump to (this is, if more than just pages/tt_content elements are found on the page!)
915 // also fills $dbList->activeTables
916 $dbList->getTableMenu($this->id);
917 // Initialize other variables:
918 $tableOutput = [];
919 $tableJSOutput = [];
920 $CMcounter = 0;
921 // Traverse the list of table names which has records on this page (that array is populated
922 // by the $dblist object during the function getTableMenu()):
923 foreach ($dbList->activeTables as $table => $value) {
924 $h_func = '';
925 $h_func_b = '';
926 if (!isset($dbList->externalTables[$table])) {
927 // Toggle hidden ContentElements
928 $numberOfHiddenElements = $this->getNumberOfHiddenElements();
929 if ($numberOfHiddenElements > 0) {
930 $h_func_b = '
931 <div class="checkbox">
932 <label for="checkTt_content_showHidden">
933 <input type="checkbox" id="checkTt_content_showHidden" class="checkbox" name="SET[tt_content_showHidden]" value="1" ' . ($this->MOD_SETTINGS['tt_content_showHidden'] ? 'checked="checked"' : '') . ' />
934 ' . $this->getLanguageService()->getLL('hiddenCE', true) . ' (<span class="t3js-hidden-counter">' . $numberOfHiddenElements . '</span>)
935 </label>
936 </div>';
937 }
938
939 // Boolean: Display up/down arrows and edit icons for tt_content records
940 $dbList->tt_contentConfig['showCommands'] = 1;
941 // Boolean: Display info-marks or not
942 $dbList->tt_contentConfig['showInfo'] = 1;
943 // Setting up the tt_content columns to show:
944 if (is_array($GLOBALS['TCA']['tt_content']['columns']['colPos']['config']['items'])) {
945 $colList = [];
946 $tcaItems = GeneralUtility::callUserFunction(BackendLayoutView::class . '->getColPosListItemsParsed', $this->id, $this);
947 foreach ($tcaItems as $temp) {
948 $colList[] = $temp[1];
949 }
950 } else {
951 // ... should be impossible that colPos has no array. But this is the fallback should it make any sense:
952 $colList = ['1', '0', '2', '3'];
953 }
954 if ($this->colPosList !== '') {
955 $colList = array_intersect(GeneralUtility::intExplode(',', $this->colPosList), $colList);
956 }
957 // The order of the rows: Default is left(1), Normal(0), right(2), margin(3)
958 $dbList->tt_contentConfig['cols'] = implode(',', $colList);
959 $dbList->tt_contentConfig['activeCols'] = $this->activeColPosList;
960 $dbList->tt_contentConfig['showHidden'] = $this->MOD_SETTINGS['tt_content_showHidden'];
961 $dbList->tt_contentConfig['sys_language_uid'] = (int)$this->current_sys_language;
962 // If the function menu is set to "Language":
963 if ($this->MOD_SETTINGS['function'] == 2) {
964 $dbList->tt_contentConfig['languageMode'] = 1;
965 $dbList->tt_contentConfig['languageCols'] = $this->MOD_MENU['language'];
966 $dbList->tt_contentConfig['languageColsPointer'] = $this->current_sys_language;
967 }
968 } else {
969 if (isset($this->MOD_SETTINGS) && isset($this->MOD_MENU)) {
970 $h_func = BackendUtility::getFuncMenu($this->id, 'SET[' . $table . ']', $this->MOD_SETTINGS[$table], $this->MOD_MENU[$table], '', '');
971 }
972 }
973 // Start the dblist object:
974 $dbList->itemsLimitSingleTable = 1000;
975 $dbList->start($this->id, $table, $this->pointer, $this->search_field, $this->search_levels, $this->showLimit);
976 $dbList->counter = $CMcounter;
977 $dbList->ext_function = $this->MOD_SETTINGS['function'];
978 // Render versioning selector:
979 $dbList->HTMLcode .= $this->moduleTemplate->getVersionSelector($this->id);
980 // Generate the list of elements here:
981 $dbList->generateList();
982 // Adding the list content to the tableOutput variable:
983 $tableOutput[$table] = $h_func . $dbList->HTMLcode . $h_func_b;
984 // ... and any accumulated JavaScript goes the same way!
985 $tableJSOutput[$table] = $dbList->JScode;
986 // Increase global counter:
987 $CMcounter += $dbList->counter;
988 // Reset variables after operation:
989 $dbList->HTMLcode = '';
990 $dbList->JScode = '';
991 }
992 // END: traverse tables
993 // For Context Sensitive Menus:
994 // Init the content
995 $content = '';
996 // Additional header content
997 $headerContentHook = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawHeaderHook'];
998 if (is_array($headerContentHook)) {
999 foreach ($headerContentHook as $hook) {
1000 $params = [];
1001 $content .= GeneralUtility::callUserFunction($hook, $params, $this);
1002 }
1003 }
1004 // Add the content for each table we have rendered (traversing $tableOutput variable)
1005 foreach ($tableOutput as $table => $output) {
1006 $content .= $output;
1007 }
1008 // Making search form:
1009 if (!$this->modTSconfig['properties']['disableSearchBox'] && ($dbList->counter > 0 || $this->currentPageHasSubPages())) {
1010 $this->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/ToggleSearchToolbox');
1011 $toggleSearchFormButton = $this->buttonBar->makeLinkButton()
1012 ->setClasses('t3js-toggle-search-toolbox')
1013 ->setTitle($this->getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.title.searchIcon'))
1014 ->setIcon($this->iconFactory->getIcon('actions-search', Icon::SIZE_SMALL))
1015 ->setHref('#');
1016 $this->buttonBar->addButton($toggleSearchFormButton, ButtonBar::BUTTON_POSITION_LEFT, 4);
1017 $this->searchContent = $dbList->getSearchBox();
1018 }
1019 // Additional footer content
1020 $footerContentHook = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/db_layout.php']['drawFooterHook'];
1021 if (is_array($footerContentHook)) {
1022 foreach ($footerContentHook as $hook) {
1023 $params = [];
1024 $content .= GeneralUtility::callUserFunction($hook, $params, $this);
1025 }
1026 }
1027 return $content;
1028 }
1029
1030 /**
1031 * @return ModuleTemplate
1032 */
1033 public function getModuleTemplate()
1034 {
1035 return $this->moduleTemplate;
1036 }
1037
1038 /**
1039 * Print accumulated content of module
1040 *
1041 * @return void
1042 */
1043 public function printContent()
1044 {
1045 echo $this->moduleTemplate->renderContent();
1046 }
1047
1048 /***************************
1049 *
1050 * Sub-content functions, rendering specific parts of the module content.
1051 *
1052 ***************************/
1053 /**
1054 * This creates the buttons for die modules
1055 *
1056 * @param string $function Identifier for function of module
1057 * @return void
1058 */
1059 protected function makeButtons($function = '')
1060 {
1061 $lang = $this->getLanguageService();
1062 // View page
1063 if (!VersionState::cast($this->pageinfo['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)) {
1064 $viewButton = $this->buttonBar->makeLinkButton()
1065 ->setOnClick(BackendUtility::viewOnClick($this->pageinfo['uid'], '', BackendUtility::BEgetRootLine($this->pageinfo['uid'])))
1066 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.showPage'))
1067 ->setIcon($this->iconFactory->getIcon('actions-document-view', Icon::SIZE_SMALL))
1068 ->setHref('#');
1069
1070 $this->buttonBar->addButton($viewButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
1071 }
1072 // Shortcut
1073 $shortcutButton = $this->buttonBar->makeShortcutButton()
1074 ->setModuleName($this->moduleName)
1075 ->setGetVariables([
1076 'id',
1077 'M',
1078 'edit_record',
1079 'pointer',
1080 'new_unique_uid',
1081 'search_field',
1082 'search_levels',
1083 'showLimit'
1084 ])
1085 ->setSetVariables(array_keys($this->MOD_MENU));
1086 $this->buttonBar->addButton($shortcutButton);
1087
1088 // Cache
1089 if (!$this->modTSconfig['properties']['disableAdvanced']) {
1090 $clearCacheButton = $this->buttonBar->makeLinkButton()
1091 ->setHref(BackendUtility::getModuleUrl($this->moduleName, ['id' => $this->pageinfo['uid'], 'clear_cache' => '1']))
1092 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.clear_cache'))
1093 ->setIcon($this->iconFactory->getIcon('actions-system-cache-clear', Icon::SIZE_SMALL));
1094 $this->buttonBar->addButton($clearCacheButton, ButtonBar::BUTTON_POSITION_RIGHT, 1);
1095 }
1096 if (!$this->modTSconfig['properties']['disableIconToolbar']) {
1097 // Move record
1098 if (MathUtility::canBeInterpretedAsInteger($this->eRParts[1])) {
1099 $urlParameters = [
1100 'table' => $this->eRParts[0],
1101 'uid' => $this->eRParts[1],
1102 'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')
1103 ];
1104 $moveButton = $this->buttonBar->makeLinkButton()
1105 ->setHref(BackendUtility::getModuleUrl('move_element', $urlParameters))
1106 ->setTitle($lang->getLL('move_' . ($this->eRParts[0] == 'tt_content' ? 'record' : 'page')))
1107 ->setIcon($this->iconFactory->getIcon('actions-' . ($this->eRParts[0] == 'tt_content' ? 'document' : 'page') . '-move', Icon::SIZE_SMALL));
1108 $this->buttonBar->addButton($moveButton, ButtonBar::BUTTON_POSITION_LEFT, 2);
1109 }
1110
1111 // Edit page properties and page language overlay icons
1112 if ($this->pageIsNotLockedForEditors() && $this->getBackendUser()->checkLanguageAccess(0)) {
1113 // Edit localized page_language_overlay only when one specific language is selected
1114 if ($this->MOD_SETTINGS['function'] == 1 && $this->current_sys_language > 0) {
1115 $overlayRecord = $this->getDatabaseConnection()->exec_SELECTgetSingleRow(
1116 'uid',
1117 'pages_language_overlay',
1118 'pid = ' . (int)$this->id . ' ' .
1119 'AND sys_language_uid = ' . (int)$this->current_sys_language .
1120 BackendUtility::deleteClause('pages_language_overlay') .
1121 BackendUtility::versioningPlaceholderClause('pages_language_overlay'),
1122 '',
1123 '',
1124 ''
1125 );
1126 // Edit button
1127 $urlParameters = [
1128 'edit' => [
1129 'pages_language_overlay' => [
1130 $overlayRecord['uid'] => 'edit'
1131 ]
1132 ],
1133 'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')
1134 ];
1135 $url = BackendUtility::getModuleUrl('record_edit', $urlParameters);
1136 $editLanguageButton = $this->buttonBar->makeLinkButton()
1137 ->setHref($url)
1138 ->setTitle($lang->getLL('editPageLanguageOverlayProperties'))
1139 ->setIcon($this->iconFactory->getIcon('mimetypes-x-content-page-language-overlay', Icon::SIZE_SMALL));
1140 $this->buttonBar->addButton($editLanguageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
1141 }
1142 $urlParameters = [
1143 'edit' => [
1144 'pages' => [
1145 $this->id => 'edit'
1146 ]
1147 ],
1148 'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')
1149 ];
1150 $url = BackendUtility::getModuleUrl('record_edit', $urlParameters);
1151 $editPageButton = $this->buttonBar->makeLinkButton()
1152 ->setHref($url)
1153 ->setTitle($lang->getLL('editPageProperties'))
1154 ->setIcon($this->iconFactory->getIcon('actions-page-open', Icon::SIZE_SMALL));
1155 $this->buttonBar->addButton($editPageButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
1156 }
1157
1158 // Add CSH (Context Sensitive Help) icon to tool bar
1159 $contextSensitiveHelpButton = $this->buttonBar->makeHelpButton()
1160 ->setModuleName($this->descrTable)
1161 ->setFieldName(($function === 'quickEdit' ? 'quickEdit' : 'columns_' . $this->MOD_SETTINGS['function']));
1162 $this->buttonBar->addButton($contextSensitiveHelpButton);
1163
1164 // QuickEdit
1165 if ($function == 'quickEdit') {
1166 // Close Record
1167 $closeButton = $this->buttonBar->makeLinkButton()
1168 ->setHref('#')
1169 ->setOnClick('jumpToUrl(' . GeneralUtility::quoteJSvalue($this->closeUrl) . '); return false;')
1170 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.closeDoc'))
1171 ->setIcon($this->iconFactory->getIcon('actions-document-close', Icon::SIZE_SMALL));
1172 $this->buttonBar->addButton($closeButton, ButtonBar::BUTTON_POSITION_LEFT, 0);
1173
1174 // Save Record
1175 $saveButtonDropdown = $this->buttonBar->makeSplitButton();
1176 $saveButton = $this->buttonBar->makeInputButton()
1177 ->setName('_savedok')
1178 ->setValue('1')
1179 ->setForm('PageLayoutController')
1180 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.saveDoc'))
1181 ->setIcon($this->iconFactory->getIcon('actions-document-save', Icon::SIZE_SMALL));
1182 $saveButtonDropdown->addItem($saveButton);
1183 $saveAndCloseButton = $this->buttonBar->makeInputButton()
1184 ->setName('_saveandclosedok')
1185 ->setValue('1')
1186 ->setForm('PageLayoutController')
1187 ->setOnClick('document.editform.redirect.value=\'' . $this->closeUrl . '\';')
1188 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.saveCloseDoc'))
1189 ->setIcon($this->iconFactory->getIcon('actions-document-save-close', Icon::SIZE_SMALL));
1190 $saveButtonDropdown->addItem($saveAndCloseButton);
1191 $saveAndShowPageButton = $this->buttonBar->makeInputButton()
1192 ->setName('_savedokview')
1193 ->setValue('1')
1194 ->setForm('PageLayoutController')
1195 ->setOnClick('document.editform.redirect.value+=\'&popView=1\';')
1196 ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.saveDocShow'))
1197 ->setIcon($this->iconFactory->getIcon('actions-document-save-view', Icon::SIZE_SMALL));
1198 $saveButtonDropdown->addItem($saveAndShowPageButton);
1199 $this->buttonBar->addButton($saveButtonDropdown, ButtonBar::BUTTON_POSITION_LEFT, 1);
1200
1201 // Delete record
1202 if ($this->deleteButton) {
1203 $dataAttributes = [];
1204 $dataAttributes['table'] = $this->eRParts[0];
1205 $dataAttributes['uid'] = $this->eRParts[1];
1206 $dataAttributes['return-url'] = BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id;
1207 $deleteButton = $this->buttonBar->makeLinkButton()
1208 ->setHref('#')
1209 ->setClasses('t3js-editform-delete-record')
1210 ->setDataAttributes($dataAttributes)
1211 ->setTitle($lang->getLL('deleteItem'))
1212 ->setIcon($this->iconFactory->getIcon('actions-edit-delete', Icon::SIZE_SMALL));
1213 $this->buttonBar->addButton($deleteButton, ButtonBar::BUTTON_POSITION_LEFT, 4);
1214 }
1215
1216 // History
1217 if ($this->undoButton) {
1218 $undoButton = $this->buttonBar->makeLinkButton()
1219 ->setHref('#')
1220 ->setOnClick('window.location.href=' .
1221 GeneralUtility::quoteJSvalue(
1222 BackendUtility::getModuleUrl(
1223 'record_history',
1224 [
1225 'element' => $this->eRParts[0] . ':' . $this->eRParts[1],
1226 'revert' => 'ALL_FIELDS',
1227 'sumUp' => -1,
1228 'returnUrl' => $this->R_URI,
1229 ]
1230 )
1231 ) . '; return false;')
1232 ->setTitle(sprintf($lang->getLL('undoLastChange'), BackendUtility::calcAge($GLOBALS['EXEC_TIME'] - $this->undoButtonR['tstamp'], $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears'))))
1233 ->setIcon($this->iconFactory->getIcon('actions-edit-undo', Icon::SIZE_SMALL));
1234 $this->buttonBar->addButton($undoButton, ButtonBar::BUTTON_POSITION_LEFT, 5);
1235 $historyButton = $this->buttonBar->makeLinkButton()
1236 ->setHref('#')
1237 ->setOnClick('jumpToUrl(' .
1238 GeneralUtility::quoteJSvalue(
1239 BackendUtility::getModuleUrl(
1240 'record_history',
1241 [
1242 'element' => $this->eRParts[0] . ':' . $this->eRParts[1],
1243 'returnUrl' => $this->R_URI,
1244 ]
1245 ) . '#latest'
1246 ) . ');return false;')
1247 ->setTitle($lang->getLL('recordHistory'))
1248 ->setIcon($this->iconFactory->getIcon('actions-document-history-open', Icon::SIZE_SMALL));
1249 $this->buttonBar->addButton($historyButton, ButtonBar::BUTTON_POSITION_LEFT, 3);
1250 }
1251 }
1252 }
1253 }
1254
1255 /*******************************
1256 *
1257 * Other functions
1258 *
1259 ******************************/
1260 /**
1261 * Returns the number of hidden elements (including those hidden by start/end times)
1262 * on the current page (for the current sys_language)
1263 *
1264 * @return int
1265 */
1266 public function getNumberOfHiddenElements()
1267 {
1268 return $this->getDatabaseConnection()->exec_SELECTcountRows(
1269 'uid',
1270 'tt_content',
1271 'pid=' . (int)$this->id . ' AND sys_language_uid=' . (int)$this->current_sys_language . BackendUtility::BEenableFields('tt_content', 1) . BackendUtility::deleteClause('tt_content') . BackendUtility::versioningPlaceholderClause('tt_content')
1272 );
1273 }
1274
1275 /**
1276 * Returns URL to the current script.
1277 * In particular the "popView" and "new_unique_uid" Get vars are unset.
1278 *
1279 * @param array $params Parameters array, merged with global GET vars.
1280 * @return string URL
1281 */
1282 public function local_linkThisScript($params)
1283 {
1284 $params['popView'] = '';
1285 $params['new_unique_uid'] = '';
1286 return GeneralUtility::linkThisScript($params);
1287 }
1288
1289 /**
1290 * Returns a SQL query for selecting sys_language records.
1291 *
1292 * @param int $id Page id: If zero, the query will select all sys_language records from root level which are NOT hidden. If set to another value, the query will select all sys_language records that has a pages_language_overlay record on that page (and is not hidden, unless you are admin user)
1293 * @return string Return query string.
1294 */
1295 public function exec_languageQuery($id)
1296 {
1297 if ($id) {
1298 $exQ = BackendUtility::deleteClause('pages_language_overlay') .
1299 ($this->getBackendUser()->isAdmin() ? '' : ' AND sys_language.hidden=0');
1300 return $this->getDatabaseConnection()->exec_SELECTquery(
1301 'sys_language.*',
1302 'pages_language_overlay,sys_language',
1303 'pages_language_overlay.sys_language_uid=sys_language.uid AND pages_language_overlay.pid=' . (int)$id . $exQ .
1304 BackendUtility::versioningPlaceholderClause('pages_language_overlay'),
1305 'pages_language_overlay.sys_language_uid,sys_language.uid,sys_language.pid,sys_language.tstamp,sys_language.hidden,sys_language.title,sys_language.language_isocode,sys_language.static_lang_isocode,sys_language.flag',
1306 'sys_language.title'
1307 );
1308 } else {
1309 return $this->getDatabaseConnection()->exec_SELECTquery(
1310 'sys_language.*',
1311 'sys_language',
1312 'sys_language.hidden=0',
1313 '',
1314 'sys_language.title'
1315 );
1316 }
1317 }
1318
1319 /**
1320 * Check if a column of a page for a language is empty. Translation records are ignored here!
1321 *
1322 * @param int $colPos
1323 * @param int $languageId
1324 * @return bool
1325 */
1326 public function isColumnEmpty($colPos, $languageId)
1327 {
1328 foreach ($this->contentElementCache[$languageId][$colPos] as $uid => $row) {
1329 if ((int)$row['l18n_parent'] === 0) {
1330 return false;
1331 }
1332 }
1333 return true;
1334 }
1335
1336 /**
1337 * Get elements for a column and a language
1338 *
1339 * @param int $pageId
1340 * @param int $colPos
1341 * @param int $languageId
1342 * @return array
1343 */
1344 public function getElementsFromColumnAndLanguage($pageId, $colPos, $languageId)
1345 {
1346 if (!isset($this->contentElementCache[$languageId][$colPos])) {
1347 $languageId = (int)$languageId;
1348 $whereClause = 'tt_content.pid=' . (int)$pageId . ' AND tt_content.colPos=' . (int)$colPos . ' AND tt_content.sys_language_uid=' . $languageId . BackendUtility::deleteClause('tt_content');
1349 if ($languageId > 0) {
1350 $whereClause .= ' AND tt_content.l18n_parent=0 AND sys_language.uid=' . $languageId . ($this->getBackendUser()->isAdmin() ? '' : ' AND sys_language.hidden=0');
1351 }
1352
1353 $databaseConnection = $this->getDatabaseConnection();
1354 $res = $databaseConnection->exec_SELECTquery(
1355 'tt_content.uid',
1356 'tt_content,sys_language',
1357 $whereClause
1358 );
1359 while ($row = $databaseConnection->sql_fetch_assoc($res)) {
1360 $this->contentElementCache[$languageId][$colPos][$row['uid']] = $row;
1361 }
1362 $databaseConnection->sql_free_result($res);
1363 }
1364 if (is_array($this->contentElementCache[$languageId][$colPos])) {
1365 return array_keys($this->contentElementCache[$languageId][$colPos]);
1366 }
1367 return [];
1368 }
1369
1370 /**
1371 * Check if page can be edited by current user
1372 *
1373 * @return bool
1374 */
1375 public function pageIsNotLockedForEditors()
1376 {
1377 return $this->getBackendUser()->isAdmin() || ($this->CALC_PERMS & Permission::PAGE_EDIT) === Permission::PAGE_EDIT && !$this->pageinfo['editlock'];
1378 }
1379
1380 /**
1381 * Check if content can be edited by current user
1382 *
1383 * @return bool
1384 */
1385 public function contentIsNotLockedForEditors()
1386 {
1387 return $this->getBackendUser()->isAdmin() || ($this->CALC_PERMS & Permission::CONTENT_EDIT) === Permission::CONTENT_EDIT && !$this->pageinfo['editlock'];
1388 }
1389
1390 /**
1391 * Returns LanguageService
1392 *
1393 * @return \TYPO3\CMS\Lang\LanguageService
1394 */
1395 protected function getLanguageService()
1396 {
1397 return $GLOBALS['LANG'];
1398 }
1399
1400 /**
1401 * Returns the current BE user.
1402 *
1403 * @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
1404 */
1405 protected function getBackendUser()
1406 {
1407 return $GLOBALS['BE_USER'];
1408 }
1409
1410 /**
1411 * Returns the database connection
1412 *
1413 * @return \TYPO3\CMS\Core\Database\DatabaseConnection
1414 */
1415 protected function getDatabaseConnection()
1416 {
1417 return $GLOBALS['TYPO3_DB'];
1418 }
1419
1420 /**
1421 * Returns current PageRenderer
1422 *
1423 * @return PageRenderer
1424 */
1425 protected function getPageRenderer()
1426 {
1427 return GeneralUtility::makeInstance(PageRenderer::class);
1428 }
1429
1430 /**
1431 * @param $edit_record array
1432 *
1433 * @return array
1434 */
1435 protected function makeQuickEditMenu($edit_record)
1436 {
1437 $lang = $this->getLanguageService();
1438 $databaseConnection = $this->getDatabaseConnection();
1439 $beUser = $this->getBackendUser();
1440
1441 $quickEditMenu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
1442 $quickEditMenu->setIdentifier('quickEditMenu');
1443 $quickEditMenu->setLabel('');
1444
1445 // Setting close url/return url for exiting this script:
1446 // Goes to 'Columns' view if close is pressed (default)
1447 $this->closeUrl = $this->local_linkThisScript(['SET' => ['function' => 1]]);
1448 if ($this->returnUrl) {
1449 $this->closeUrl = $this->returnUrl;
1450 }
1451 $retUrlStr = $this->returnUrl ? '&returnUrl=' . rawurlencode($this->returnUrl) : '';
1452
1453 // Creating the selector box, allowing the user to select which element to edit:
1454 $isSelected = 0;
1455 $languageOverlayRecord = '';
1456 if ($this->current_sys_language) {
1457 list($languageOverlayRecord) = BackendUtility::getRecordsByField(
1458 'pages_language_overlay',
1459 'pid',
1460 $this->id,
1461 'AND sys_language_uid=' . (int)$this->current_sys_language
1462 );
1463 }
1464 if (is_array($languageOverlayRecord)) {
1465 $inValue = 'pages_language_overlay:' . $languageOverlayRecord['uid'];
1466 $isSelected += (int)$edit_record == $inValue;
1467 $menuItem = $quickEditMenu->makeMenuItem()
1468 ->setTitle('[ ' . $lang->getLL('editLanguageHeader', true) . ' ]')
1469 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=' . $inValue . $retUrlStr)
1470 ->setActive($edit_record == $inValue);
1471 $quickEditMenu->addMenuItem($menuItem);
1472 } else {
1473 $inValue = 'pages:' . $this->id;
1474 $isSelected += (int)$edit_record == $inValue;
1475 $menuItem = $quickEditMenu->makeMenuItem()
1476 ->setTitle('[ ' . $lang->getLL('editPageProperties', true) . ' ]')
1477 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=' . $inValue . $retUrlStr)
1478 ->setActive($edit_record == $inValue);
1479 $quickEditMenu->addMenuItem($menuItem);
1480 }
1481 // Selecting all content elements from this language and allowed colPos:
1482 $whereClause = 'pid=' . (int)$this->id . ' AND sys_language_uid=' . (int)$this->current_sys_language . ' AND colPos IN (' . $this->colPosList . ')' . ($this->MOD_SETTINGS['tt_content_showHidden'] ? '' : BackendUtility::BEenableFields('tt_content')) . BackendUtility::deleteClause('tt_content') . BackendUtility::versioningPlaceholderClause('tt_content');
1483 if (!$this->getBackendUser()->user['admin']) {
1484 $whereClause .= ' AND editlock = 0';
1485 }
1486 $res = $databaseConnection->exec_SELECTquery('*', 'tt_content', $whereClause, '', 'colPos,sorting');
1487 $colPos = null;
1488 $first = 1;
1489 // Page is the pid if no record to put this after.
1490 $prev = $this->id;
1491 while ($cRow = $databaseConnection->sql_fetch_assoc($res)) {
1492 BackendUtility::workspaceOL('tt_content', $cRow);
1493 if (is_array($cRow)) {
1494 if ($first) {
1495 if (!$edit_record) {
1496 $edit_record = 'tt_content:' . $cRow['uid'];
1497 }
1498 $first = 0;
1499 }
1500 if (!isset($colPos) || $cRow['colPos'] !== $colPos) {
1501 $colPos = $cRow['colPos'];
1502 $menuItem = $quickEditMenu->makeMenuItem()
1503 ->setTitle(' ')
1504 ->setHref('#');
1505 $quickEditMenu->addMenuItem($menuItem);
1506 $menuItem = $quickEditMenu->makeMenuItem()
1507 ->setTitle('__' . $lang->sL(BackendUtility::getLabelFromItemlist('tt_content', 'colPos', $colPos)) . ':__')
1508 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=_EDIT_COL:' . $colPos . $retUrlStr);
1509 $quickEditMenu->addMenuItem($menuItem);
1510 }
1511 $inValue = 'tt_content:' . $cRow['uid'];
1512 $isSelected += (int)$edit_record == $inValue;
1513 $menuItem = $quickEditMenu->makeMenuItem()
1514 ->setTitle(GeneralUtility::fixed_lgd_cs(($cRow['header'] ? $cRow['header'] : '[' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title') . '] ' . strip_tags($cRow['bodytext'])), $beUser->uc['titleLen']))
1515 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=' . $inValue . $retUrlStr)
1516 ->setActive($edit_record == $inValue);
1517 $quickEditMenu->addMenuItem($menuItem);
1518 $prev = -$cRow['uid'];
1519 }
1520 }
1521 // If edit_record is not set (meaning, no content elements was found for this language) we simply set it to create a new element:
1522 if (!$edit_record) {
1523 $edit_record = 'tt_content:new/' . $prev . '/' . $colPos;
1524 $inValue = 'tt_content:new/' . $prev . '/' . $colPos;
1525 $isSelected += (int)$edit_record == $inValue;
1526 $menuItem = $quickEditMenu->makeMenuItem()
1527 ->setTitle('[ ' . $lang->getLL('newLabel', 1) . ' ]')
1528 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=' . $inValue . $retUrlStr)
1529 ->setActive($edit_record == $inValue);
1530 $quickEditMenu->addMenuItem($menuItem);
1531 }
1532 // If none is yet selected...
1533 if (!$isSelected) {
1534 $menuItem = $quickEditMenu->makeMenuItem()
1535 ->setTitle('__________')
1536 ->setHref('#');
1537 $quickEditMenu->addMenuItem($menuItem);
1538 $menuItem = $quickEditMenu->makeMenuItem()
1539 ->setTitle('[ ' . $lang->getLL('newLabel', true) . ' ]')
1540 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&edit_record=' . $edit_record . $retUrlStr)
1541 ->setActive($edit_record == $inValue);
1542 $quickEditMenu->addMenuItem($menuItem);
1543 }
1544 $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($quickEditMenu);
1545 return $edit_record;
1546 }
1547
1548 /**
1549 * Make the LanguageMenu
1550 *
1551 * @return void
1552 */
1553 protected function makeLanguageMenu()
1554 {
1555 if (count($this->MOD_MENU['language']) > 1) {
1556 $lang = $this->getLanguageService();
1557 $languageMenu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
1558 $languageMenu->setIdentifier('languageMenu');
1559 $languageMenu->setLabel($lang->sL('LLL:EXT:lang/locallang_general.xlf:LGL.language', true));
1560 foreach ($this->MOD_MENU['language'] as $key => $language) {
1561 $menuItem = $languageMenu
1562 ->makeMenuItem()
1563 ->setTitle($language)
1564 ->setHref(BackendUtility::getModuleUrl($this->moduleName) . '&id=' . $this->id . '&SET[language]=' . $key);
1565 if ((int)$this->current_sys_language === $key) {
1566 $menuItem->setActive(true);
1567 }
1568 $languageMenu->addMenuItem($menuItem);
1569 }
1570 $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($languageMenu);
1571 }
1572 }
1573
1574 /**
1575 * Checks whether the current page has sub pages
1576 *
1577 * @return bool
1578 */
1579 protected function currentPageHasSubPages()
1580 {
1581 $count = $this->getDatabaseConnection()->exec_SELECTcountRows(
1582 'uid',
1583 'pages',
1584 'pid = ' . (int)$this->id
1585 . BackendUtility::deleteClause('pages')
1586 . BackendUtility::versioningPlaceholderClause('pages')
1587 . BackendUtility::getWorkspaceWhereClause('pages')
1588 );
1589
1590 return $count > 0;
1591 }
1592 }