--- /dev/null
+<?php
+
+namespace TYPO3\CMS\Scheduler\Task;
+
+/*
+ * 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\Localization\LanguageService;
+use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
+
+/**
+ * Additional BE fields for ip address anonymization task.
+ */
+class IpAnonymizationAdditionalFieldProvider implements AdditionalFieldProviderInterface
+{
+ /**
+ * @var array Default number of days by table
+ */
+ protected $defaultNumberOfDays = [];
+
+ /**
+ * Add additional fields
+ *
+ * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+ * @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return array Array containing all the information pertaining to the additional fields
+ */
+ public function getAdditionalFields(array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $additionalFields = [];
+ $additionalFields['task_ipAnonymization_table'] = $this->getTableAdditionalField($taskInfo, $task, $parentObject);
+ $additionalFields['task_ipAnonymization_numberOfDays'] = $this->getNumberOfDaysAdditionalField($taskInfo, $task, $parentObject);
+ $additionalFields['task_ipAnonymization_mask'] = $this->getMaskAdditionalField($taskInfo, $task, $parentObject);
+ return $additionalFields;
+ }
+
+ /**
+ * Add a select field of available tables.
+ *
+ * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+ * @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return array Array containing all the information pertaining to the additional fields
+ */
+ protected function getTableAdditionalField(array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $tableConfiguration = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\IpAnonymizationTask::class]['options']['tables'];
+ $options = [];
+ // Add an empty option on top if an existing task is configured
+ // with a table that can not be found in configuration anymore
+ if ($parentObject->CMD === 'edit' && !array_key_exists($task->table, $tableConfiguration)) {
+ $options[] = '<option value="" selected="selected"></option>';
+ }
+ foreach ($tableConfiguration as $tableName => $configuration) {
+ if ($parentObject->CMD === 'add' && empty($options)) {
+ // Select first table by default if adding a new task
+ $options[] = '<option value="' . $tableName . '" selected="selected">' . $tableName . '</option>';
+ } elseif ($task->table === $tableName) {
+ // Select currently selected table
+ $options[] = '<option value="' . $tableName . '" selected="selected">' . $tableName . '</option>';
+ } else {
+ $options[] = '<option value="' . $tableName . '">' . $tableName . '</option>';
+ }
+ }
+ $fieldName = 'tx_scheduler[scheduler_ipAnonymization_table]';
+ $fieldId = 'task_ipAnonymization_table';
+ $fieldHtml = [];
+ // Add table drop down html
+ $fieldHtml[] = '<select class="form-control" name="' . $fieldName . '" id="' . $fieldId . '">' . implode(LF, $options) . '</select>';
+ // Add js array for default 'number of days' values
+ $fieldHtml[] = '<script type="text/javascript">/*<![CDATA[*/<!--';
+ $fieldHtml[] = 'var defaultNumberOfDays = ' . json_encode($this->defaultNumberOfDays) . ';';
+ $fieldHtml[] = '// -->/*]]>*/</script>';
+ $fieldConfiguration = [
+ 'code' => implode(LF, $fieldHtml),
+ 'label' => 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.table',
+ 'cshKey' => '_MOD_system_txschedulerM1',
+ 'cshLabel' => $fieldId
+ ];
+ return $fieldConfiguration;
+ }
+
+ /**
+ * Add an input field to get the number of days.
+ *
+ * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+ * @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return array Array containing all the information pertaining to the additional fields
+ */
+ protected function getNumberOfDaysAdditionalField(array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $fieldId = 'scheduler_ipAnonymization_numberOfDays';
+ // Initialize selected fields
+ $disabled = '';
+ if (empty($taskInfo[$fieldId])) {
+ if ($parentObject->CMD === 'add') {
+ // In case of new task, set to 180 days
+ $taskInfo[$fieldId] = 180;
+ } elseif ($parentObject->CMD === 'edit') {
+ // In case of editing the task, set to currently selected value
+ $taskInfo[$fieldId] = $task->numberOfDays;
+ if ($task->numberOfDays === 0 && !isset($this->defaultNumberOfDays[$task->table])) {
+ $disabled = ' disabled="disabled"';
+ }
+ }
+ }
+ $fieldName = 'tx_scheduler[' . $fieldId . ']';
+ $fieldHtml = '<input class="form-control" type="text" ' . 'name="' . $fieldName . '" ' . 'id="' . $fieldId . '" ' . $disabled . 'value="' . (int)$taskInfo['scheduler_ipAnonymization_numberOfDays'] . '" ' . 'size="4">';
+ $fieldConfiguration = [
+ 'code' => $fieldHtml,
+ 'label' => 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.numberOfDays',
+ 'cshKey' => '_MOD_system_txschedulerM1',
+ 'cshLabel' => $fieldId
+ ];
+ return $fieldConfiguration;
+ }
+
+ /**
+ * Add an input field to get the mask.
+ *
+ * @param array $taskInfo Reference to the array containing the info used in the add/edit form
+ * @param AbstractTask|null $task When editing, reference to the current task. NULL when adding.
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return array Array containing all the information pertaining to the additional fields
+ */
+ protected function getMaskAdditionalField(array &$taskInfo, $task, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $fieldId = 'scheduler_ipAnonymization_mask';
+ // Initialize selected fields
+ if (empty($taskInfo[$fieldId])) {
+ if ($parentObject->CMD === 'add') {
+ // In case of new task, set to 180 days
+ $taskInfo[$fieldId] = 2;
+ } elseif ($parentObject->CMD === 'edit') {
+ // In case of editing the task, set to currently selected value
+ $taskInfo[$fieldId] = $task->mask;
+ }
+ }
+ $fieldName = 'tx_scheduler[' . $fieldId . ']';
+
+ $fieldHtml = '';
+ foreach ([1, 2] as $mask) {
+ $selected = (int)$taskInfo[$fieldId] === $mask ? ' selected' : '';
+ $fieldHtml .= '<option value="' . $mask . '"' . $selected . '>'
+ . htmlspecialchars($this->getLanguageService()->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.mask.' . $mask))
+ . '</option>';
+ }
+
+ $fieldHtml = '<select class="form-control" name="' . $fieldName . '" ' . 'id="' . $fieldId . '">' . $fieldHtml . '</select>';
+
+ $fieldConfiguration = [
+ 'code' => $fieldHtml,
+ 'label' => 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.mask',
+ 'cshKey' => '_MOD_system_txschedulerM1',
+ 'cshLabel' => $fieldId
+ ];
+ return $fieldConfiguration;
+ }
+
+ /**
+ * Validate additional fields
+ *
+ * @param array $submittedData Reference to the array containing the data submitted by the user
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return bool True if validation was ok (or selected class is not relevant), false otherwise
+ */
+ public function validateAdditionalFields(array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $validData = $this->validateTableAdditionalField($submittedData, $parentObject);
+ $validData &= $this->validateNumberOfDaysAdditionalField($submittedData, $parentObject);
+ return $validData;
+ }
+
+ /**
+ * Checks given table for existence in configuration array
+ *
+ * @param array $submittedData Reference to the array containing the data submitted by the user
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return bool True if table exists in configuration, false otherwise
+ */
+ public function validateTableAdditionalField(array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $validData = false;
+ $tableConfiguration = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\IpAnonymizationTask::class]['options']['tables'];
+ if (!isset($submittedData['scheduler_ipAnonymization_table'])) {
+ $validData = true;
+ } elseif (array_key_exists($submittedData['scheduler_ipAnonymization_table'], $tableConfiguration)) {
+ $validData = true;
+ }
+ return $validData;
+ }
+
+ /**
+ * Checks if given number of days is a positive integer
+ *
+ * @param array $submittedData Reference to the array containing the data submitted by the user
+ * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject Reference to the calling object (Scheduler's BE module)
+ * @return bool True if validation was ok (or selected class is not relevant), false otherwise
+ */
+ public function validateNumberOfDaysAdditionalField(array &$submittedData, \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $parentObject)
+ {
+ $validData = false;
+ if (!isset($submittedData['scheduler_ipAnonymization_numberOfDays'])) {
+ $validData = true;
+ } elseif ((int)$submittedData['scheduler_ipAnonymization_numberOfDays'] >= 0) {
+ $validData = true;
+ } else {
+ // Issue error message
+ $parentObject->addMessage($this->getLanguageService()->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:msg.invalidNumberOfDays'), \TYPO3\CMS\Core\Messaging\FlashMessage::ERROR);
+ }
+ return $validData;
+ }
+
+ /**
+ * Save additional field in task
+ *
+ * @param array $submittedData Contains data submitted by the user
+ * @param \TYPO3\CMS\Scheduler\Task\AbstractTask $task Reference to the current task object
+ */
+ public function saveAdditionalFields(array $submittedData, \TYPO3\CMS\Scheduler\Task\AbstractTask $task)
+ {
+ $task->table = $submittedData['scheduler_ipAnonymization_table'];
+ $task->mask = $submittedData['scheduler_ipAnonymization_mask'];
+ $task->numberOfDays = (int)$submittedData['scheduler_ipAnonymization_numberOfDays'];
+ }
+
+ /**
+ * Returns an instance of LanguageService
+ *
+ * @return LanguageService
+ */
+ protected function getLanguageService(): LanguageService
+ {
+ return $GLOBALS['LANG'];
+ }
+}
--- /dev/null
+<?php
+
+namespace TYPO3\CMS\Scheduler\Task;
+
+/*
+ * 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\Database\ConnectionPool;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\IpAnonymizationUtility;
+
+/**
+ * Anonymize IP addresses in records
+ *
+ * This task anonymizes IP addresses in tables older than the given number of days.
+ *
+ * Available tables must be registered in
+ * $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\IpAnonymizationTask::class]['options']['tables']
+ * See ext_localconf.php of scheduler extension for an example
+ */
+class IpAnonymizationTask extends AbstractTask
+{
+
+ /**
+ * @var int Number of days
+ */
+ public $numberOfDays = 180;
+
+ /**
+ * @var int mask level
+ */
+ public $mask = 2;
+
+ /**
+ * @var string Table to clean up
+ */
+ public $table = '';
+
+ /**
+ * Execute garbage collection, called by scheduler.
+ *
+ * @throws \RuntimeException If configured table was not cleaned up
+ * @return bool TRUE if task run was successful
+ */
+ public function execute()
+ {
+ $tableConfigurations = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][self::class]['options']['tables'];
+ $tableHandled = false;
+ foreach ($tableConfigurations as $tableName => $configuration) {
+ if ($tableName === $this->table) {
+ $this->handleTable($tableName, $configuration);
+ $tableHandled = true;
+ }
+ }
+
+ if (!$tableHandled) {
+ throw new \RuntimeException(self::class . ' misconfiguration: ' . $this->table . ' does not exist in configuration', 1524502548);
+ }
+ return true;
+ }
+
+ /**
+ * Execute clean up of a specific table
+ *
+ * @throws \RuntimeException If table configuration is broken
+ * @param string $table The table to handle
+ * @param array $configuration Clean up configuration
+ * @return bool TRUE if cleanup was successful
+ */
+ protected function handleTable($table, array $configuration)
+ {
+ $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($table);
+ $queryBuilder = $connection->createQueryBuilder();
+ $queryBuilder->getRestrictions()->removeAll();
+
+ if (empty($configuration['dateField'])) {
+ throw new \RuntimeException(self::class . ' misconfiguration: "dateField" must be defined for table ' . $table, 1524502549);
+ }
+ if (empty($configuration['ipField'])) {
+ throw new \RuntimeException(self::class . ' misconfiguration: "ipField" must be defined for table ' . $table, 1524502666);
+ }
+ $deleteTimestamp = strtotime('-' . $this->numberOfDays . 'days');
+ if ($deleteTimestamp === false) {
+ throw new \RuntimeException(self::class . ' misconfiguration: number of days could not be calculcated for table ' . $table, 1524526354);
+ }
+ try {
+ $result = $queryBuilder
+ ->select('uid', $configuration['ipField'])
+ ->where(
+ $queryBuilder->expr()->lt(
+ $configuration['dateField'],
+ $queryBuilder->createNamedParameter($deleteTimestamp, \PDO::PARAM_INT)
+ ),
+ $queryBuilder->expr()->neq(
+ $configuration['ipField'],
+ $queryBuilder->createNamedParameter('', \PDO::PARAM_STR)
+ ),
+ $queryBuilder->expr()->isNotNull($configuration['ipField']),
+ $queryBuilder->expr()->notLike(
+ $configuration['ipField'],
+ $queryBuilder->createNamedParameter('%.0.0', \PDO::PARAM_STR)
+ ),
+ $queryBuilder->expr()->notLike(
+ $configuration['ipField'],
+ $queryBuilder->createNamedParameter('%::', \PDO::PARAM_STR)
+ )
+ )
+ ->from($table)
+ ->execute();
+
+ while ($row = $result->fetch()) {
+ $ip = (string)$row[$configuration['ipField']];
+
+ $connection->update(
+ $table,
+ [
+ $configuration['ipField'] => IpAnonymizationUtility::anonymizeIp($ip, $this->mask)
+ ],
+ [
+ 'uid' => $row['uid']
+ ]
+ );
+ }
+ } catch (\Exception $e) {
+ throw new \RuntimeException(self::class . ' failed for table ' . $this->table . ' with error: ' . $e->getMessage(), 1524502550);
+ }
+ return true;
+ }
+
+ /**
+ * This method returns the selected table as additional information
+ *
+ * @return string Information to display
+ */
+ public function getAdditionalInformation()
+ {
+ return sprintf($GLOBALS['LANG']->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.additionalInformationTable'), $this->table, $this->numberOfDays);
+ }
+}
projects / Packages / TYPO3.CMS.git / commitdiff