CleanUpLocalProcessedFilesCommand.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Lowlevel\Command;
 
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Style\SymfonyStyle;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Lowlevel\Service\CleanUpLocalProcessedFilesService;
 
#[AsCommand('cleanup:localprocessedfiles', 'Delete processed files and their database records.')]
class ‪CleanUpLocalProcessedFilesCommand extends Command
{
    public function ‪__construct(
        private readonly ‪CleanUpLocalProcessedFilesService $cleanProcessedFilesService
    ) {
        parent::__construct();
    }
 
    protected function ‪configure(): void
    {
        $this
            ->setDescription(
                'Deletes local processed files from local storage that are no longer referenced and ' .
                'deletes references to processed files that do no longer exist. Also allows to reset ALL files.'
            )
            ->setHelp('If you want to get more detailed information, use the --verbose option.')
            ->addOption(
                'dry-run',
                null,
                InputOption::VALUE_NONE,
                'If set, the records and files which would be deleted are displayed.'
            )
            ->addOption(
                'all',
                '',
                InputOption::VALUE_NONE,
                'If set, ALL processed-file (driver=Local) records will be removed, also those without identifier ("stubs" for unprocessed files) and existing files.'
            )
            ->addOption(
                'force',
                'f',
                InputOption::VALUE_NONE,
                'Force cleanup. When set the confirmation question will be skipped. When using --no-interaction, --force will be set automatically.'
            );
    }
 
    protected function ‪execute(InputInterface $input, OutputInterface ‪$output): int
    {
        $files = $this->cleanProcessedFilesService->getFilesToClean(0, $input->getOption('all'));
        $records = $this->cleanProcessedFilesService->getRecordsToClean($input->getOption('all'));
 
        if (‪$output->isVerbose()) {
            foreach ($records as ‪$record) {
                ‪$output->writeln('[RECORD] Would delete ' . ‪$record['identifier'] . ' UID:' . ‪$record['uid']);
            }
 
            foreach ($files as $file) {
                $path = ‪PathUtility::stripPathSitePrefix($file->getRealPath());
                ‪$output->writeln('[FILE] Would delete ' . $path);
            }
        }
 
        if ($files === [] && $records === []) {
            ‪$output->writeln('<fg=green>✓</> No processed files or processed records found. Nothing to be done');
 
            return Command::SUCCESS;
        }
 
        ‪$output->writeln('Found <options=bold,underscore>' . count($files) . ' files</> and <options=bold,underscore>' . count($records) . ' processed records</>');
 
        if ($input->getOption('dry-run')) {
            return Command::SUCCESS;
        }
 
        // Do not ask for confirmation when running the command in EXT:scheduler
        if (!$input->isInteractive()) {
            $input->setOption('force', true);
        }
 
        if (!$input->getOption('force')) {
            $questionHelper = $this->getHelper('question');
            $fileDeleteQuestion = new ConfirmationQuestion(
                'Are you sure you want to delete these processed files and records [default: no] ? ',
                false
            );
            $answerDeleteFiles = $questionHelper->ask($input, ‪$output, $fileDeleteQuestion);
        }
 
        if (($answerDeleteFiles ?? false) || $input->getOption('force')) {
            [$success, $error] = $this->‪deleteFile($input, ‪$output, $files);
            // Reload the list auf records to get the files deleted using deleteFile() as well
            $recordsIncludingDeleted = $this->cleanProcessedFilesService->getRecordsToClean($input->getOption('all'));
            $deletedRecordsCount = $this->cleanProcessedFilesService->deleteRecord(array_column($recordsIncludingDeleted, 'uid'));
 
            $failedRecordCount = count($records) - $deletedRecordsCount;
            $failedRecords = '';
            if ($failedRecordCount > 0) {
                $failedRecords = 'Failed to delete <fg=red>' . $failedRecordCount . '</> records.';
            }
 
            $failedFiles = '';
            if (count($error) > 0) {
                $failedFiles = 'Failed to delete <fg=red>' . count($error) . '</> files.';
            }
 
            ‪$output->writeln('');
 
            if (count($records) > 0) {
                ‪$output->writeln('Deleted <fg=green>' . $deletedRecordsCount . '</> processed records. ' . $failedRecords);
            }
 
            if (count($files) > 0) {
                ‪$output->writeln('Deleted <fg=green>' . count($success) . '</> processed files. ' . $failedFiles);
            }
        }
 
        return Command::SUCCESS;
    }
 
    protected function ‪deleteFile(InputInterface $input, OutputInterface ‪$output, array $files): array
    {
        $isVerbose = ‪$output->isVerbose();
        if (!$isVerbose) {
            $io = new SymfonyStyle($input, ‪$output);
            $progressBar = $io->createProgressBar(count($files));
        }
        $error = [];
        $success = [];
 
        foreach ($files as $file) {
            $path = ‪PathUtility::stripPathSitePrefix($file->getRealPath());
            if (unlink($file->getRealPath()) === false) {
                $error[] = $file;
                $isVerbose ? ‪$output->writeln('[FILE] Failed to delete ' . $path) : $progressBar->advance();
            } else {
                $success[] = $file;
                $isVerbose ? ‪$output->writeln('[FILE] Successfully deleted ' . $path) : $progressBar->advance();
            }
        }
 
        return [$success, $error];
    }
}