9.5/_cleaner_task_8php_source.html

<?php

namespace ‪TYPO3\CMS\Recycler\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\Core\Environment;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Scheduler\Task\AbstractTask;


class ‪CleanerTask extends ‪AbstractTask

{

    protected ‪$period = 0;


    protected ‪$tcaTables = [];


    public function ‪execute()

    {

        $success = true;

        $tables = $this->‪getTcaTables();

        foreach ($tables as $table) {

            if (!$this->‪cleanTable($table)) {

                $success = false;

            }

        }


        return $success;

    }


    protected function ‪cleanTable($tableName)

    {

        if (isset(‪$GLOBALS['TCA'][$tableName]['ctrl']['delete'])) {

            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($tableName);

            $queryBuilder->getRestrictions()->removeAll();


            $constraints = [

                $queryBuilder->expr()->eq(

                    ‪$GLOBALS['TCA'][$tableName]['ctrl']['delete'],

                    $queryBuilder->createNamedParameter(1, \PDO::PARAM_INT)

                )

                ,

            ];


            if (‪$GLOBALS['TCA'][$tableName]['ctrl']['tstamp']) {

                $dateBefore = $this->‪getPeriodAsTimestamp();

                $constraints[] = $queryBuilder->expr()->lt(

                    ‪$GLOBALS['TCA'][$tableName]['ctrl']['tstamp'],

                    $queryBuilder->createNamedParameter($dateBefore, \PDO::PARAM_INT)

                );

            }

            $this->‪checkFileResourceFieldsBeforeDeletion($tableName);

            try {

                $queryBuilder->delete($tableName)

                    ->where(...$constraints)

                    ->execute();

            } catch (\Doctrine\DBAL\DBALException $e) {

                return false;

            }

        }

        return true;

    }


    public function ‪getAdditionalInformation()

    {

        $message = '';


        $message .= sprintf(

            $this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskDescriptionTables'),

            implode(', ', $this->‪getTcaTables())

        );


        $message .= '; ';


        $message .= sprintf(

            $this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskDescriptionDays'),

            $this->‪getPeriod()

        );


        return $message;

    }


    public function ‪setPeriod(‪$period)

    {

        $this->period = (int)‪$period;

    }


    public function ‪getPeriod()

    {

        return ‪$this->period;

    }


    public function ‪getPeriodAsTimestamp()

    {

        return strtotime('-' . $this->‪getPeriod() . ' days');

    }


    public function ‪setTcaTables(‪$tcaTables = [])

    {

        $this->tcaTables = ‪$tcaTables;

    }


    public function ‪getTcaTables()

    {

        return ‪$this->tcaTables;

    }


    protected function ‪checkFileResourceFieldsBeforeDeletion($table)

    {

        $fieldList = $this->‪getFileResourceFields($table);

        if (!empty($fieldList)) {

            $this->‪deleteFilesForTable($table, $fieldList);

        }

    }


    protected function ‪deleteFilesForTable($table, array $fieldList)

    {

        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);

        $queryBuilder->getRestrictions()->removeAll();


        $constraints = [

            $queryBuilder->expr()->eq(

                ‪$GLOBALS['TCA'][$table]['ctrl']['delete'],

                $queryBuilder->createNamedParameter(1, \PDO::PARAM_INT)

            )

        ];


        if (‪$GLOBALS['TCA'][$table]['ctrl']['tstamp']) {

            $dateBefore = $this->‪getPeriodAsTimestamp();

            $constraints[] = $queryBuilder->expr()->lt(

                ‪$GLOBALS['TCA'][$table]['ctrl']['tstamp'],

                $queryBuilder->createNamedParameter($dateBefore, \PDO::PARAM_INT)

            );

        }


        $result = $queryBuilder

            ->select(...$fieldList)

            ->from($table)

            ->where(...$constraints)

            ->execute();


        while ($row = $result->fetch()) {

            foreach ($fieldList as $fieldName) {

                $uploadDir = ‪Environment::getPublicPath() . '/' . ‪$GLOBALS['TCA'][$table]['columns'][$fieldName]['config']['uploadfolder'] . '/';

                $fileList = GeneralUtility::trimExplode(',', $row[$fieldName]);

                foreach ($fileList as $fileName) {

                    @unlink($uploadDir . $fileName);

                }

            }

        }

    }


    protected function ‪getFileResourceFields($table)

    {

        $result = [];

        if (isset(‪$GLOBALS['TCA'][$table]['columns'])) {

            foreach (‪$GLOBALS['TCA'][$table]['columns'] as $fieldName => $fieldConfiguration) {

                if ($fieldConfiguration['config']['type'] === 'group'

                    && $fieldConfiguration['config']['internal_type'] === 'file'

                ) {

                    $result[] = $fieldName;

                }

            }

        }

        return $result;

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }

}