Your IP : 216.73.217.30
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Backend\Controller;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Clipboard\Clipboard;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\DataHandling\DataHandler;
use TYPO3\CMS\Core\Http\HtmlResponse;
use TYPO3\CMS\Core\Http\JsonResponse;
use TYPO3\CMS\Core\Http\RedirectResponse;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
/**
* Script Class, creating object of \TYPO3\CMS\Core\DataHandling\DataHandler and
* sending the posted data to the object.
*
* Used by many smaller forms/links in TYPO3, including the QuickEdit module.
* Is not used by FormEngine though (main form rendering script) - that uses the same class (DataHandler) but makes its own initialization (to save the redirect request).
* For all other cases than FormEngine it is recommended to use this script for submitting your editing forms - but the best solution in any case would probably be to link your application to FormEngine, that will give you easy form-rendering as well.
*/
class SimpleDataHandlerController
{
/**
* Array. Accepts options to be set in TCE object. Currently it supports "reverseOrder" (bool).
*
* @var array
*/
protected $flags;
/**
* Data array on the form [tablename][uid][fieldname] = value
*
* @var array
*/
protected $data;
/**
* Command array on the form [tablename][uid][command] = value.
* This array may get additional data set internally based on clipboard commands send in CB var!
*
* @var array
*/
protected $cmd;
/**
* Array passed to ->setMirror.
*
* @var array
*/
protected $mirror;
/**
* Cache command sent to ->clear_cacheCmd
*
* @var string
*/
protected $cacheCmd;
/**
* Redirect URL. Script will redirect to this location after performing operations (unless errors has occurred)
*
* @var string
*/
protected $redirect;
/**
* Clipboard command array. May trigger changes in "cmd"
*
* @var array
*/
protected $CB;
/**
* TYPO3 Core Engine
*
* @var \TYPO3\CMS\Core\DataHandling\DataHandler
*/
protected $tce;
/**
* Injects the request object for the current request or subrequest
* As this controller goes only through the processRequest() method, it just redirects to the given URL afterwards.
*
* @param ServerRequestInterface $request the current request
* @return ResponseInterface the response with the content
*/
public function mainAction(ServerRequestInterface $request): ResponseInterface
{
$this->init($request);
$this->initializeClipboard($request);
$this->processRequest();
// Write errors to flash message queue
$this->tce->printLogErrorMessages();
if ($this->redirect) {
return new RedirectResponse(GeneralUtility::locationHeaderUrl($this->redirect), 303);
}
return new HtmlResponse('');
}
/**
* Processes all AJAX calls and returns a JSON formatted string
*/
public function processAjaxRequest(ServerRequestInterface $request): ResponseInterface
{
$this->init($request);
// do the regular / main logic
$this->initializeClipboard($request);
$this->processRequest();
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
$content = [
'redirect' => $this->redirect,
'messages' => [],
'hasErrors' => false,
];
// Prints errors (= write them to the message queue)
$this->tce->printLogErrorMessages();
$messages = $flashMessageService->getMessageQueueByIdentifier()->getAllMessagesAndFlush();
if (!empty($messages)) {
foreach ($messages as $message) {
$content['messages'][] = [
'title' => $message->getTitle(),
'message' => $message->getMessage(),
'severity' => $message->getSeverity(),
];
if ($message->getSeverity() === ContextualFeedbackSeverity::ERROR) {
$content['hasErrors'] = true;
}
}
}
return new JsonResponse($content);
}
/**
* Initialization of the class
*/
protected function init(ServerRequestInterface $request): void
{
$beUser = $this->getBackendUser();
$parsedBody = $request->getParsedBody();
$queryParams = $request->getQueryParams();
// GPvars:
$this->flags = (array)($parsedBody['flags'] ?? $queryParams['flags'] ?? []);
$this->data = (array)($parsedBody['data'] ?? $queryParams['data'] ?? []);
$this->cmd = (array)($parsedBody['cmd'] ?? $queryParams['cmd'] ?? []);
$this->mirror = (array)($parsedBody['mirror'] ?? $queryParams['mirror'] ?? []);
$this->cacheCmd = (string)($parsedBody['cacheCmd'] ?? $queryParams['cacheCmd'] ?? '');
$this->CB = (array)($parsedBody['CB'] ?? $queryParams['CB'] ?? []);
$this->redirect = GeneralUtility::sanitizeLocalUrl((string)($parsedBody['redirect'] ?? $queryParams['redirect'] ?? ''));
// Creating DataHandler object
$this->tce = GeneralUtility::makeInstance(DataHandler::class);
// Configuring based on user prefs.
if ($beUser->uc['copyLevels'] ?? false) {
// Set to number of page-levels to copy.
$this->tce->copyTree = MathUtility::forceIntegerInRange($beUser->uc['copyLevels'], 0, 100);
}
if ($beUser->uc['neverHideAtCopy'] ?? false) {
$this->tce->neverHideAtCopy = true;
}
// Reverse order.
if ($this->flags['reverseOrder'] ?? false) {
$this->tce->reverseOrder = true;
}
}
/**
* Clipboard pasting and deleting.
*/
protected function initializeClipboard(ServerRequestInterface $request): void
{
if ($this->CB !== []) {
$clipObj = GeneralUtility::makeInstance(Clipboard::class);
$clipObj->initializeClipboard($request);
if ($this->CB['paste'] ?? false) {
$clipObj->setCurrentPad((string)($this->CB['pad'] ?? ''));
$this->setPasteCmd($clipObj);
}
if ($this->CB['delete'] ?? false) {
$clipObj->setCurrentPad((string)($this->CB['pad'] ?? ''));
$this->setDeleteCmd($clipObj);
}
}
}
/**
* Executing the posted actions ...
*/
protected function processRequest(): void
{
// LOAD DataHandler with data and cmd arrays:
$this->tce->start($this->data, $this->cmd);
if ($this->mirror !== []) {
$this->tce->setMirror($this->mirror);
}
// Execute actions:
$this->tce->process_datamap();
$this->tce->process_cmdmap();
// Clearing cache:
if (!empty($this->cacheCmd)) {
$this->tce->clear_cacheCmd($this->cacheCmd);
}
// Update page tree?
if (isset($this->data['pages']) || isset($this->cmd['pages'])) {
BackendUtility::setUpdateSignal('updatePageTree');
}
}
/**
* Applies the proper paste configuration to $this->cmd
*
* The reference ($this->CB['paste']) has following format: [tablename]:[paste-uid].
* Tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid.
* No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though.
* so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record
* 'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30
* ':30' means 'paste ALL database elements on the clipboard into page with id 30
* ':-30' not valid.
*/
protected function setPasteCmd(Clipboard $clipboard): void
{
[$pasteTable, $pasteUid] = explode('|', (string)$this->CB['paste']);
$pasteUid = (int)$pasteUid;
// pUid must be set and if pTable is not set (that means paste ALL elements)
// the uid MUST be positive/zero (pointing to page id)
if (!$pasteTable && $pasteUid < 0) {
return;
}
$elements = $clipboard->elFromTable($pasteTable);
// So the order is preserved.
$elements = array_reverse($elements);
$mode = $clipboard->currentMode() === 'copy' ? 'copy' : 'move';
// Traverse elements and make CMD array
foreach ($elements as $key => $value) {
[$table, $uid] = explode('|', $key);
if (!is_array($this->cmd[$table] ?? null)) {
$this->cmd[$table] = [];
}
if (is_array($this->CB['update'] ?? false)) {
$this->cmd[$table][$uid][$mode] = [
'action' => 'paste',
'target' => $pasteUid,
'update' => $this->CB['update'],
];
} else {
$this->cmd[$table][$uid][$mode] = $pasteUid;
}
if ($mode === 'move') {
$clipboard->removeElement($key);
}
}
$clipboard->endClipboard();
}
/**
* Applies the proper delete configuration to $this->cmd
*/
protected function setDeleteCmd(Clipboard $clipboard): void
{
foreach ($clipboard->elFromTable() as $key => $value) {
[$table, $uid] = explode('|', $key);
if (!is_array($this->cmd[$table])) {
$this->cmd[$table] = [];
}
$this->cmd[$table][$uid]['delete'] = 1;
$clipboard->removeElement($key);
}
$clipboard->endClipboard();
}
protected function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
}