first commit

This commit is contained in:
salam committed 2026-10-19 08:18:39 +02:00
commit 1218dd1517
12716 files changed
+989233

No files matched your search

@@ -0,0 +1,338 @@
<?php
namespace TYPO3\CMS\Extbase\Scheduler;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use TYPO3\CMS\Extbase\Utility\TypeHandlingUtility;
use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\AbstractTask;
/**
* Field provider for Extbase CommandController Scheduler task
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.
*/
class FieldProvider implements AdditionalFieldProviderInterface
{
/**
* @var \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager
*/
protected $commandManager;
/**
* @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
*/
protected $objectManager;
/**
* @var \TYPO3\CMS\Extbase\Reflection\ReflectionService
*/
protected $reflectionService;
/**
* @var \TYPO3\CMS\Extbase\Scheduler\Task
*/
protected $task;
/**
* Constructor
*
* @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager
* @param \TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService
*/
public function __construct(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager = null, \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager = null, \TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService = null)
{
$this->objectManager = $objectManager ?? \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
$this->commandManager = $commandManager ?? $this->objectManager->get(\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager::class);
$this->reflectionService = $reflectionService ?? $this->objectManager->get(\TYPO3\CMS\Extbase\Reflection\ReflectionService::class);
}
/**
* Render additional information fields within the scheduler backend.
*
* @param array &$taskInfo Array information of task to return
* @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
* @param SchedulerModuleController $schedulerModule Reference to the calling object (BE module of the Scheduler)
* @return array Additional fields
* @see \TYPO3\CMS\Scheduler\AdditionalFieldProvider#getAdditionalFields($taskInfo, $task, $schedulerModule)
*/
public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
{
$this->task = $task;
if ($this->task !== null) {
$this->task->setScheduler();
}
$fields = [];
$fields['action'] = $this->getCommandControllerActionField();
if ($this->task !== null && $this->task->getCommandIdentifier()) {
$command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
$fields['description'] = $this->getCommandControllerActionDescriptionField();
$argumentFields = $this->getCommandControllerActionArgumentFields($command->getArgumentDefinitions());
$fields = array_merge($fields, $argumentFields);
$this->task->save();
}
return $fields;
}
/**
* Validates additional selected fields
*
* @param array &$submittedData
* @param SchedulerModuleController $schedulerModule
* @return bool
*/
public function validateAdditionalFields(array &$submittedData, SchedulerModuleController $schedulerModule)
{
return true;
}
/**
* Saves additional field values
*
* @param array $submittedData
* @param AbstractTask $task
* @return bool
*/
public function saveAdditionalFields(array $submittedData, AbstractTask $task)
{
$task->setCommandIdentifier($submittedData['task_extbase']['action']);
$task->setArguments((array)$submittedData['task_extbase']['arguments']);
return true;
}
/**
* Get description of selected command
*
* @return array
*/
protected function getCommandControllerActionDescriptionField()
{
$command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
return [
'code' => '',
'label' => '<strong>' . $command->getDescription() . '</strong>'
];
}
/**
* Gets a select field containing all possible CommandController actions
*
* @return array
*/
protected function getCommandControllerActionField()
{
$commands = $this->commandManager->getAvailableCommands();
$options = [];
foreach ($commands as $command) {
if ($command->isInternal() === true || $command->isCliOnly() === true) {
continue;
}
$className = $command->getControllerClassName();
$classNameParts = explode('\\', $className);
// Skip vendor and product name for core classes
if (strpos($className, 'TYPO3\\CMS\\') === 0) {
$classPartsToSkip = 2;
} else {
$classPartsToSkip = 1;
}
$classNameParts = array_slice($classNameParts, $classPartsToSkip);
$extensionName = $classNameParts[0];
$controllerName = $classNameParts[2];
$identifier = $command->getCommandIdentifier();
$options[$identifier] = $extensionName . ' ' . str_replace('CommandController', '', $controllerName) . ': ' . $command->getControllerCommandName();
}
$name = 'action';
$currentlySelectedCommand = $this->task !== null ? $this->task->getCommandIdentifier() : null;
return [
'code' => $this->renderSelectField($name, $options, $currentlySelectedCommand),
'label' => $this->getActionLabel()
];
}
/**
* Gets a set of fields covering arguments which must be sent to $currentControllerAction.
* Also registers the default values of those fields with the Task, allowing
* them to be read upon execution.
*
* @param array $argumentDefinitions
* @return array
*/
protected function getCommandControllerActionArgumentFields(array $argumentDefinitions)
{
$fields = [];
$argumentValues = $this->task->getArguments();
foreach ($argumentDefinitions as $argument) {
$name = $argument->getName();
$defaultValue = $this->getDefaultArgumentValue($argument);
$this->task->addDefaultValue($name, $defaultValue);
$value = $argumentValues[$name] ?? $defaultValue;
$fields[$name] = [
'code' => $this->renderField($argument, $value),
'label' => $this->getArgumentLabel($argument)
];
}
return $fields;
}
/**
* Gets a label for $key based on either provided extension or currently
* selected CommandController extension,´
*
* @param string $localLanguageKey
* @param string $extensionName
* @return string
*/
protected function getLanguageLabel($localLanguageKey, $extensionName = null)
{
if (!$extensionName) {
list($extensionName, $commandControllerName, $commandName) = explode(':', $this->task->getCommandIdentifier());
}
$label = \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate($localLanguageKey, $extensionName);
return $label;
}
/**
* Gets the data type required for the argument value
*
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument
* @return string the argument type
*/
protected function getArgumentType(\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
{
$command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
$controllerClassName = $command->getControllerClassName();
$methodName = $command->getControllerCommandName() . 'Command';
$tags = $this->reflectionService
->getClassSchema($controllerClassName)
->getMethod($methodName)['tags']['param'] ?? [];
foreach ($tags as $tag) {
list($argumentType, $argumentVariableName) = explode(' ', $tag);
if (substr($argumentVariableName, 1) === $argument->getName()) {
return $argumentType;
}
}
return '';
}
/**
* Get a human-readable label for a command argument
*
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument
* @return string
*/
protected function getArgumentLabel(\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
{
$argumentName = $argument->getName();
list($extensionName, $commandControllerName, $commandName) = explode(':', $this->task->getCommandIdentifier());
$path = ['command', $commandControllerName, $commandName, 'arguments', $argumentName];
$labelNameIndex = implode('.', $path);
$label = $this->getLanguageLabel($labelNameIndex);
if (!$label) {
$label = 'Argument: ' . $argumentName;
}
$descriptionIndex = $labelNameIndex . '.description';
$description = $this->getLanguageLabel($descriptionIndex);
if ((string)$description === '') {
$description = $argument->getDescription();
}
if ((string)$description !== '') {
$label .= '. <em>' . htmlspecialchars($description) . '</em>';
}
return $label;
}
/**
* Gets the default value of argument
*
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument
* @return mixed
*/
protected function getDefaultArgumentValue(\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument)
{
$type = $this->getArgumentType($argument);
$argumentName = $argument->getName();
$command = $this->commandManager->getCommandByIdentifier($this->task->getCommandIdentifier());
$argumentReflection = $this->reflectionService
->getClassSchema($command->getControllerClassName())
->getMethod($command->getControllerCommandName() . 'Command')['params'] ?? [];
$defaultValue = $argumentReflection[$argumentName]['defaultValue'];
if (TypeHandlingUtility::normalizeType($type) === 'boolean') {
$defaultValue = (bool)$defaultValue ? 1 : 0;
}
return $defaultValue;
}
/**
* Get a human-readable label for the action field
*
* @return string
*/
protected function getActionLabel()
{
$index = 'task.action';
$label = $this->getLanguageLabel($index, 'extbase');
if (!$label) {
$label = 'CommandController Command. <em>Save and reopen to define command arguments</em>';
}
return $label;
}
/**
* Render a select field with name $name and options $options
*
* @param string $name
* @param array $options
* @param string $selectedOptionValue
* @return string
*/
protected function renderSelectField($name, array $options, $selectedOptionValue)
{
$html = [
'<select class="form-control" name="tx_scheduler[task_extbase][' . htmlspecialchars($name) . ']">'
];
foreach ($options as $optionValue => $optionLabel) {
$selected = $optionValue === $selectedOptionValue ? ' selected="selected"' : '';
$html[] = '<option title="test" value="' . htmlspecialchars($optionValue) . '"' . $selected . '>' . htmlspecialchars($optionLabel) . '</option>';
}
$html[] = '</select>';
return implode(LF, $html);
}
/**
* Renders a field for defining an argument's value
*
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument
* @param mixed $currentValue
* @return string
*/
protected function renderField(\TYPO3\CMS\Extbase\Mvc\Cli\CommandArgumentDefinition $argument, $currentValue)
{
$type = $this->getArgumentType($argument);
$name = $argument->getName();
$fieldName = 'tx_scheduler[task_extbase][arguments][' . htmlspecialchars($name) . ']';
if (TypeHandlingUtility::normalizeType($type) === 'boolean') {
// checkbox field for boolean values.
$html = '<input type="hidden" name="' . $fieldName . '" value="0">';
$html .= '<div class="checkbox"><label><input type="checkbox" name="' . $fieldName . '" value="1" ' . ((bool)$currentValue ? ' checked="checked"' : '') . '></label></div>';
} else {
// regular string, also the default field type
$html = '<input class="form-control" type="text" name="' . $fieldName . '" value="' . htmlspecialchars($currentValue) . '"> ';
}
return $html;
}
}
@@ -0,0 +1,203 @@
<?php
namespace TYPO3\CMS\Extbase\Scheduler;
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
use TYPO3\CMS\Core\Log\LogManager;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Cli\CommandManager;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Scheduler\Task\AbstractTask;
/**
* Scheduler task to execute CommandController commands
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.
*/
class Task extends AbstractTask
{
/**
* @var string
*/
protected $commandIdentifier;
/**
* @var array
*/
protected $arguments = [];
/**
* @var array
*/
protected $defaults = [];
/**
* @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
*/
protected $objectManager;
/**
* @var CommandManager
*/
protected $commandManager;
/**
* @var TaskExecutor
*/
protected $taskExecutor;
/**
* Instantiates the Object Manager
*/
public function __construct()
{
parent::__construct();
$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
$this->commandManager = $this->objectManager->get(CommandManager::class);
$this->taskExecutor = $this->objectManager->get(TaskExecutor::class);
}
/**
* Sleep
*
* @return array Properties to serialize
*/
public function __sleep()
{
$properties = get_object_vars($this);
unset(
$properties['commandManager'],
$properties['objectManager'],
$properties['taskExecutor'],
$properties['logger']
);
return array_keys($properties);
}
/**
* Wakeup
*/
public function __wakeup()
{
$this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
$this->commandManager = $this->objectManager->get(CommandManager::class);
$this->taskExecutor = $this->objectManager->get(TaskExecutor::class);
}
/**
* Function execute from the Scheduler
*
* @return bool TRUE on successful execution
* @throws \Exception If an error occurs
*/
public function execute()
{
try {
$this->taskExecutor->execute($this);
} catch (\Exception $e) {
$this->logException($e);
// Make sure the Scheduler gets exception details
throw $e;
}
return true;
}
/**
* @param string $commandIdentifier
*/
public function setCommandIdentifier($commandIdentifier)
{
$this->commandIdentifier = $commandIdentifier;
}
/**
* @return string
*/
public function getCommandIdentifier()
{
return $this->commandIdentifier;
}
/**
* @param array $arguments
*/
public function setArguments($arguments)
{
$this->arguments = $arguments;
}
/**
* @return array
*/
public function getArguments()
{
return $this->arguments;
}
/**
* @param array $defaults
*/
public function setDefaults(array $defaults)
{
$this->defaults = $defaults;
}
/**
* @return array
*/
public function getDefaults()
{
return $this->defaults;
}
/**
* @param string $argumentName
* @param mixed $argumentValue
*/
public function addDefaultValue($argumentName, $argumentValue)
{
if (is_bool($argumentValue)) {
$argumentValue = (int)$argumentValue;
}
$this->defaults[$argumentName] = $argumentValue;
}
/**
* Return a text representation of the selected command and arguments
*
* @return string Information to display
*/
public function getAdditionalInformation()
{
$label = $this->commandIdentifier;
if (!empty($this->arguments)) {
$arguments = [];
foreach ($this->arguments as $argumentName => $argumentValue) {
if (!isset($this->defaults[$argumentName]) || $argumentValue != $this->defaults[$argumentName]) {
$arguments[] = $argumentName . '=' . $argumentValue;
}
}
$label .= ' ' . implode(', ', $arguments);
}
return $label;
}
/**
* @param \Exception $e
*/
protected function logException(\Exception $e)
{
$this->logger->error('A Task (' . $this->commandIdentifier . ') Exception was captured: ' . $e->getMessage() . ' (' . $e->getCode() . ')', ['exception' => $e]);
}
}
@@ -0,0 +1,145 @@
<?php
namespace TYPO3\CMS\Extbase\Scheduler;
/*
* 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!
*/
/**
* Task Executor
*
* Takes a \TYPO3\CMS\Extbase\Scheduler\Task and executes the CommandController command
* defined therein.
* @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.
*/
class TaskExecutor implements \TYPO3\CMS\Core\SingletonInterface
{
/**
* @var \TYPO3\CMS\Extbase\Mvc\Cli\Request
*/
protected $request;
/**
* @var \TYPO3\CMS\Extbase\Mvc\Cli\Response
*/
protected $response;
/**
* @var \TYPO3\CMS\Extbase\Mvc\Dispatcher
*/
protected $dispatcher;
/**
* @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
*/
protected $objectManager;
/**
* @var \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager
*/
protected $commandManager;
/**
* @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
*/
protected $configurationManager;
/**
* @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
*/
public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
{
$this->objectManager = $objectManager;
}
/**
* @param \TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager
*/
public function injectCommandManager(\TYPO3\CMS\Extbase\Mvc\Cli\CommandManager $commandManager)
{
$this->commandManager = $commandManager;
}
/**
* @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager
*/
public function injectConfigurationManager(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
{
$this->configurationManager = $configurationManager;
}
/**
* Initialize Dispatcher
*/
public function initializeObject()
{
$this->dispatcher = $this->objectManager->get(\TYPO3\CMS\Extbase\Mvc\Dispatcher::class);
}
/**
* Initializes configuration manager, object container and reflection service
*
* @param array $configuration
*/
protected function initialize(array $configuration)
{
// initialize unconsumed Request and Response
$this->request = $this->objectManager->get(\TYPO3\CMS\Extbase\Mvc\Cli\Request::class);
$this->response = $this->objectManager->get(\TYPO3\CMS\Extbase\Mvc\Cli\Response::class);
// initialize configuration
$this->configurationManager->setContentObject(\TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::class));
$this->configurationManager->setConfiguration($configuration);
// configure object container
$frameworkConfiguration = $this->configurationManager->getConfiguration(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
if (isset($frameworkConfiguration['objects'])) {
$objectContainer = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\Container\Container::class);
foreach ($frameworkConfiguration['objects'] as $classNameWithDot => $classConfiguration) {
if (isset($classConfiguration['className'])) {
$originalClassName = rtrim($classNameWithDot, '.');
$objectContainer->registerImplementation($originalClassName, $classConfiguration['className']);
}
}
}
}
/**
* Execute Task
*
* If errors occur during Task execution they are thrown as Exceptions which
* must be caught manually if you manually execute Tasks through your code.
*
* @param \TYPO3\CMS\Extbase\Scheduler\Task $task the task to execute
*/
public function execute(\TYPO3\CMS\Extbase\Scheduler\Task $task)
{
$commandIdentifier = $task->getCommandIdentifier();
list($extensionKey, $controllerName, $commandName) = explode(':', $commandIdentifier);
$extensionName = \TYPO3\CMS\Core\Utility\GeneralUtility::underscoredToUpperCamelCase($extensionKey);
$this->initialize(['extensionName' => $extensionName]);
// execute command
$command = $this->commandManager->getCommandByIdentifier($commandIdentifier);
$this->request->setControllerObjectName($command->getControllerClassName());
$this->request->setControllerCommandName($command->getControllerCommandName());
$this->request->setArguments($task->getArguments());
$this->dispatcher->dispatch($this->request, $this->response);
$this->shutdown();
}
/**
* Resets framework singletons
*/
protected function shutdown()
{
$persistenceManager = $this->objectManager->get(\TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager::class);
$persistenceManager->persistAll();
}
}