App\Command\CleanAttachmentsCommand

Complexity

Total Complexity

11

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	execute()	0	50	5
A	configure()	0	6	1
A	removeEmptySubFolders()	0	8	4

<?php

namespace App\Command;

use App\Services\AttachmentHelper;
use App\Services\AttachmentReverseSearch;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Mime\FileinfoMimeTypeGuesser;
use Symfony\Component\Mime\MimeTypes;
use Symfony\Component\Mime\MimeTypesInterface;

class CleanAttachmentsCommand extends Command
{
    protected static $defaultName = 'app:clean-attachments';

    protected $attachment_helper;
    protected $reverseSearch;
    protected $mimeTypeGuesser;

    public function __construct(AttachmentHelper $attachmentHelper, AttachmentReverseSearch $reverseSearch)
    {
        $this->attachment_helper = $attachmentHelper;
        $this->reverseSearch = $reverseSearch;
        $this->mimeTypeGuesser = new MimeTypes();
        parent::__construct();
    }

    protected function configure()
    {
        $this
            ->setDescription('Lists (and deletes if wanted) attachments files that are not used anymore (abandoned files).')
            ->setHelp('This command allows to find all files in the media folder which are not associated with an attachment anymore.'.
                ' These files are not needed and can eventually deleted.');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $io = new SymfonyStyle($input, $output);

        $mediaPath = $this->attachment_helper->getMediaPath();
        $io->note("The media path is " . $mediaPath);

        $finder = new Finder();
        //We look for files in the media folder only
        $finder->files()->in($mediaPath);
        $fs = new Filesystem();

        $file_list = array();

        $table = new Table($output);
        $table->setHeaders(['Filename', 'MIME Type', 'Last modified date']);
        $dateformatter = \IntlDateFormatter::create(null, \IntlDateFormatter::SHORT, \IntlDateFormatter::SHORT);

        foreach ($finder as $file)
        {
            //If not attachment object uses this file, print it
            if (count($this->reverseSearch->findAttachmentsByFile($file)) == 0) {
                $file_list[] = $file;
                $table->addRow([
                    $fs->makePathRelative($file->getPathname(), $mediaPath),
                    $this->mimeTypeGuesser->guessMimeType($file->getPathname()),
                    $dateformatter->format($file->getMTime())
                ]);
            }
        }

        if (count($file_list) > 0) {
            $table->render();

            $continue = $io->confirm(sprintf("Found %d abandoned files. Do you want to delete them? This can not be undone!", count($file_list)), false);

            if (!$continue) {
                //We are finished here, when no files should be deleted
                return;
            }

            //Delete the files
            $fs->remove($file_list);
            //Delete empty folders:
            $this->removeEmptySubFolders($mediaPath);

            $io->success("All abandoned files were removed.");

        } else {
            $io->success("No abandoned files found.");
        }


    }

    /**
     * This function removes all empty folders inside $path. Taken from https://stackoverflow.com/a/1833681
     * @param string $path The path in which the empty folders should be deleted
     * @return bool
     */
    protected function removeEmptySubFolders($path)
    {
        $empty=true;
        foreach (glob($path . DIRECTORY_SEPARATOR . "*") as $file)
        {
            $empty &= is_dir($file) && $this->removeEmptySubFolders($file);
        }
        return $empty && rmdir($path);
    }
}