9.5/_ip_anonymization_task_8php_source.html

<?php

declare(strict_types = 1);

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;


class ‪IpAnonymizationTask extends ‪AbstractTask

{


    public ‪$numberOfDays = 180;


    public ‪$mask = 2;


    public ‪$table = '';


    public function ‪execute()

    {

        $configuration = ‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][self::class]['options']['tables'][‪$this->table] ?? [];

        if (empty($configuration)) {

            throw new \RuntimeException(self::class . ' misconfiguration: ' . $this->table . ' does not exist in configuration', 1524502548);

        }

        $this->‪handleTable($this->table, $configuration);

        return true;

    }


    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 calculated for table ' . ‪$table, 1524526354);

        }

        if ($this->mask === 2) {

            $notLikeMaskPattern = '%.0.0';

        } else {

            $notLikeMaskPattern = '%.0';

        }

        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($notLikeMaskPattern, \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, (int)$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;

    }


    public function ‪getAdditionalInformation()

    {

        return sprintf(‪$GLOBALS['LANG']->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.ipAnonymization.additionalInformationTable'), $this->table, $this->numberOfDays);

    }

}