From 521ae2e553ad91a289ccf302d03573e10a74822e Mon Sep 17 00:00:00 2001
From: Christian Kuhn <lolli@schwarzbu.ch>
Date: Fri, 20 Oct 2017 13:05:12 +0200
Subject: [PATCH] [!!!][TASK] Scheduler: Drop "use atd" based execution
The feature to execute scheduler tasks via the "at daemon"
on unix found extremely little use in the wild and is
dropped from the core.
The implementation is rather clumsy, too, so we take
the opportunity to just drop this feature.
Change-Id: Ia3786953c41580ef6ea3b3c3ee21c1a82cab3dcd
Resolves: #82832
Releases: master
Reviewed-on: https://review.typo3.org/54455
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Stefan Neufeind <typo3.neufeind@speedpartner.de>
Tested-by: Stefan Neufeind <typo3.neufeind@speedpartner.de>
Reviewed-by: Andreas Fernandez <typo3@scripting-base.de>
Tested-by: Andreas Fernandez <typo3@scripting-base.de>
---
...-82832-UseAtDaemonDroppedFromScheduler.rst | 37 ++++++++++
.../Php/MethodCallMatcher.php | 7 ++
.../Controller/SchedulerModuleController.php | 4 --
typo3/sysext/scheduler/Classes/Scheduler.php | 72 -------------------
.../Private/Language/locallang_em.xlf | 3 -
typo3/sysext/scheduler/ext_conf_template.txt | 3 -
6 files changed, 44 insertions(+), 82 deletions(-)
create mode 100644 typo3/sysext/core/Documentation/Changelog/master/Breaking-82832-UseAtDaemonDroppedFromScheduler.rst
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-82832-UseAtDaemonDroppedFromScheduler.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-82832-UseAtDaemonDroppedFromScheduler.rst
new file mode 100644
index 000000000000..17ea65281ae5
--- /dev/null
+++ b/typo3/sysext/core/Documentation/Changelog/master/Breaking-82832-UseAtDaemonDroppedFromScheduler.rst
@@ -0,0 +1,37 @@
+.. include:: ../../Includes.txt
+
+=======================================================
+Breaking: #82832 - Use at daemon dropped from scheduler
+=======================================================
+
+See :issue:`82832`
+
+Description
+===========
+
+The functionality to execute tasks via the unix "at daemon" (atd)
+has been dropped.
+
+The following method has been dropped:
+* TYPO3\CMS\Scheduler\Scheduler->scheduleNextSchedulerRunUsingAtDaemon()
+
+
+Impact
+======
+
+If this feature has been used, existing tasks may not be executed anymore.
+
+
+Affected Installations
+======================
+
+The feature "useAtdaemon" had to be explicitly enabled in scheduler
+extension configuration. In general it was very sparsely used.
+
+
+Migration
+=========
+
+Switch to cron execution instead.
+
+.. index:: Backend, CLI, PHP-API, PartiallyScanned
\ No newline at end of file
diff --git a/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallMatcher.php b/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallMatcher.php
index ee98199074f2..2d9e17a2e3cb 100644
--- a/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallMatcher.php
+++ b/typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallMatcher.php
@@ -1359,4 +1359,11 @@ return [
'Deprecation-57594-OptimizeReflectionServiceCacheHandling.rst',
],
],
+ 'TYPO3\CMS\Scheduler\Scheduler->scheduleNextSchedulerRunUsingAtDaemon' => [
+ 'numberOfMandatoryArguments' => 0,
+ 'maximumNumberOfArguments' => 0,
+ 'restFiles' => [
+ 'Breaking-82832-UseAtDaemonDroppedFromScheduler.rst',
+ ],
+ ],
];
diff --git a/typo3/sysext/scheduler/Classes/Controller/SchedulerModuleController.php b/typo3/sysext/scheduler/Classes/Controller/SchedulerModuleController.php
index b8fdca28e5fe..1fc5649fe9bd 100644
--- a/typo3/sysext/scheduler/Classes/Controller/SchedulerModuleController.php
+++ b/typo3/sysext/scheduler/Classes/Controller/SchedulerModuleController.php
@@ -841,10 +841,6 @@ class SchedulerModuleController
*/
protected function executeTasks()
{
- // Make sure next automatic scheduler-run is scheduled
- if (GeneralUtility::_POST('go') !== null) {
- $this->scheduler->scheduleNextSchedulerRunUsingAtDaemon();
- }
// Continue if some elements have been chosen for execution
if (isset($this->submittedData['execute']) && !empty($this->submittedData['execute'])) {
// Get list of registered classes
diff --git a/typo3/sysext/scheduler/Classes/Scheduler.php b/typo3/sysext/scheduler/Classes/Scheduler.php
index b0684a38e958..5d42e145e862 100644
--- a/typo3/sysext/scheduler/Classes/Scheduler.php
+++ b/typo3/sysext/scheduler/Classes/Scheduler.php
@@ -18,9 +18,7 @@ use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Registry;
-use TYPO3\CMS\Core\Utility\CommandUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
-use TYPO3\CMS\Core\Utility\MathUtility;
/**
* TYPO3 Scheduler. This class handles scheduling and execution of tasks.
@@ -45,9 +43,6 @@ class Scheduler implements \TYPO3\CMS\Core\SingletonInterface
if (empty($this->extConf['maxLifetime'])) {
$this->extConf['maxLifetime'] = 1440;
}
- if (empty($this->extConf['useAtdaemon'])) {
- $this->extConf['useAtdaemon'] = 0;
- }
// Clean up the serialized execution arrays
$this->cleanExecutionArrays();
}
@@ -235,9 +230,6 @@ class Scheduler implements \TYPO3\CMS\Core\SingletonInterface
} else {
$result = false;
}
- if ($result) {
- $this->scheduleNextSchedulerRunUsingAtDaemon();
- }
return $result;
}
@@ -281,9 +273,6 @@ class Scheduler implements \TYPO3\CMS\Core\SingletonInterface
} else {
$result = false;
}
- if ($result) {
- $this->scheduleNextSchedulerRunUsingAtDaemon();
- }
return $result;
}
@@ -464,65 +453,4 @@ class Scheduler implements \TYPO3\CMS\Core\SingletonInterface
$GLOBALS['BE_USER']->writelog(4, 0, $status, 0, '[scheduler]: ' . $code . ' - ' . $message, []);
}
}
-
- /**
- * Schedule the next run of scheduler
- * For the moment only the "at"-daemon is used, and only if it is enabled
- *
- * @return bool Successfully scheduled next execution using "at"-daemon
- * @see tx_scheduler::fetchTask()
- */
- public function scheduleNextSchedulerRunUsingAtDaemon()
- {
- if ((int)$this->extConf['useAtdaemon'] !== 1) {
- return false;
- }
- /** @var $registry Registry */
- $registry = GeneralUtility::makeInstance(Registry::class);
- // Get at job id from registry and remove at job
- $atJobId = $registry->get('tx_scheduler', 'atJobId');
- if (MathUtility::canBeInterpretedAsInteger($atJobId)) {
- shell_exec('atrm ' . (int)$atJobId . ' 2>&1');
- }
- // Can not use fetchTask() here because if tasks have just executed
- // they are not in the list of next executions
- $tasks = $this->fetchTasksWithCondition('');
- $nextExecution = false;
- foreach ($tasks as $task) {
- try {
- /** @var $task Task\AbstractTask */
- $tempNextExecution = $task->getNextDueExecution();
- if ($nextExecution === false || $tempNextExecution < $nextExecution) {
- $nextExecution = $tempNextExecution;
- }
- } catch (\OutOfBoundsException $e) {
- // The event will not be executed again or has already ended - we don't have to consider it for
- // scheduling the next "at" run
- }
- }
- if ($nextExecution !== false) {
- if ($nextExecution > $GLOBALS['EXEC_TIME']) {
- $startTime = strftime('%H:%M %F', $nextExecution);
- } else {
- $startTime = 'now+1minute';
- }
- $cliDispatchPath = PATH_site . 'typo3/sysext/core/bin/typo3';
- list($cliDispatchPathEscaped, $startTimeEscaped) =
- CommandUtility::escapeShellArguments([$cliDispatchPath, $startTime]);
- $cmd = 'echo ' . $cliDispatchPathEscaped . ' scheduler:run | at ' . $startTimeEscaped . ' 2>&1';
- $output = shell_exec($cmd);
- $outputParts = '';
- foreach (explode(LF, $output) as $outputLine) {
- if (GeneralUtility::isFirstPartOfStr($outputLine, 'job')) {
- $outputParts = explode(' ', $outputLine, 3);
- break;
- }
- }
- if ($outputParts[0] === 'job' && MathUtility::canBeInterpretedAsInteger($outputParts[1])) {
- $atJobId = (int)$outputParts[1];
- $registry->set('tx_scheduler', 'atJobId', $atJobId);
- }
- }
- return true;
- }
}
diff --git a/typo3/sysext/scheduler/Resources/Private/Language/locallang_em.xlf b/typo3/sysext/scheduler/Resources/Private/Language/locallang_em.xlf
index fdf862ad3f5b..1149e579956b 100644
--- a/typo3/sysext/scheduler/Resources/Private/Language/locallang_em.xlf
+++ b/typo3/sysext/scheduler/Resources/Private/Language/locallang_em.xlf
@@ -12,9 +12,6 @@
<trans-unit id="scheduler.config.showSampleTasks">
<source>Enable sample tasks: When turned on, you can use the sample, test tasks provided by the scheduler. Before turning this off, make sure you don't have any of those sample tasks currently scheduled. You will also need to clear the configuration cache.</source>
</trans-unit>
- <trans-unit id="scheduler.config.useAtdaemon">
- <source>Use "at"-daemon: This allows automatic scheduling of the next execution of the scheduler. Your system must have the at daemon installed and configured for the user PHP runs with.</source>
- </trans-unit>
<trans-unit id="scheduler.config.listShowTaskDescriptionAsHover">
<source>Show description of tasks as hover: If disabled descriptions of tasks will be shown below the job-name in the scheduler-list.</source>
</trans-unit>
diff --git a/typo3/sysext/scheduler/ext_conf_template.txt b/typo3/sysext/scheduler/ext_conf_template.txt
index 1bfaf503a397..a2df31e48276 100644
--- a/typo3/sysext/scheduler/ext_conf_template.txt
+++ b/typo3/sysext/scheduler/ext_conf_template.txt
@@ -6,6 +6,3 @@ enableBELog = 1
# cat=basic//; type=boolean; label=LLL:EXT:scheduler/Resources/Private/Language/locallang_em.xlf:scheduler.config.showSampleTasks
showSampleTasks = 1
-
-# cat=basic//; type=boolean; label=LLL:EXT:scheduler/Resources/Private/Language/locallang_em.xlf:scheduler.config.useAtdaemon
-useAtdaemon = 0
--
GitLab