RemoveThumbsCommand::execute() - Code Metrics - sonata-project/SonataMediaBundle - Measure and Improve Code Quality continuously with Scrutinizer

RemoveThumbsCommand::execute() B
last analyzed 2020-08-28 02:17 UTC

↳ Parent: RemoveThumbsCommand

Complexity

Conditions	8
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	72
rs	7.3664
c	0
b	0
f	0
cc	8
nc	4
nop	2

How to fix Long Method

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\MediaBundle\Command;

use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Provider\MediaProviderInterface;
use Symfony\Component\Console\Helper\QuestionHelper;
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\Question\ChoiceQuestion;

/**
 * This command can be used to re-generate the thumbnails for all uploaded medias.
 *
 * Useful if you have existing media content and added new formats.
 *
 * @final since sonata-project/media-bundle 3.21.0
 */
class RemoveThumbsCommand extends BaseCommand

{
    /**
     * @var bool
     */
    protected $quiet = false;

    /**
     * @var InputInterface
     */
    protected $input;

    /**
     * @var OutputInterface
     */
    protected $output;

    public function configure(): void
    {
        $this->setName('sonata:media:remove-thumbnails')
            ->setDescription('Remove uploaded image thumbs')
            ->setDefinition(
                [
                new InputArgument('providerName', InputArgument::OPTIONAL, 'The provider'),
                new InputArgument('context', InputArgument::OPTIONAL, 'The context'),
                new InputArgument('format', InputArgument::OPTIONAL, 'The format (pass `all` to delete all thumbs)'),
                new InputOption('batchSize', null, InputOption::VALUE_REQUIRED, 'Media batch size (100 by default)', 100),
                new InputOption('batchesLimit', null, InputOption::VALUE_REQUIRED, 'Media batches limit (0 by default)', 0),
                new InputOption('startOffset', null, InputOption::VALUE_REQUIRED, 'Medias start offset (0 by default)', 0),
            ]
            );
    }

    public function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->input = $input;
        $this->output = $output;

        $this->quiet = $this->input->getOption('quiet');
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        $provider = $this->getProvider();
        $context = $this->getContext();
        $format = $this->getFormat($provider, $context);

        $batchCounter = 0;
        $batchSize = (int) ($this->input->getOption('batchSize'));
        $batchesLimit = (int) ($this->input->getOption('batchesLimit'));
        $startOffset = (int) ($this->input->getOption('startOffset'));
        $totalMediasCount = 0;
        do {
            ++$batchCounter;

            try {
                $batchOffset = $startOffset + ($batchCounter - 1) * $batchSize;
                $medias = $this->getMediaManager()->findBy(
                    [
                        'providerName' => $provider->getName(),
                        'context' => $context,
                    ],
                    [
                        'id' => 'ASC',
                    ],
                    $batchSize,
                    $batchOffset
                );
            } catch (\Exception $e) {
                $this->log('Error: '.$e->getMessage());

                break;
            }

            $batchMediasCount = \count($medias);
            if (0 === $batchMediasCount) {
                break;
            }

            $totalMediasCount += $batchMediasCount;
            $this->log(
                sprintf(
                    'Loaded %s medias (batch #%d, offset %d) for removing thumbs (provider: %s, format: %s)',
                    $batchMediasCount,
                    $batchCounter,
                    $batchOffset,
                    $provider->getName(),
                    $format
                )
            );

            foreach ($medias as $media) {
                if (!$this->processMedia($media, $provider, $context, $format)) {
                    continue;
                }
                //clean filesystem registry for saving memory
                $provider->getFilesystem()->clearFileRegister();
            }

            if ($batchesLimit > 0 && $batchCounter === $batchesLimit) {
                break;
            }
        } while (true);

        $this->log("Done (total medias processed: {$totalMediasCount}).");

        return 0;
    }

    public function getProvider(): MediaProviderInterface
    {
        $providerName = $this->input->getArgument('providerName');

        if (null === $providerName) {
            $providerName = $this->getQuestionHelper()->ask(
                $this->input,
                $this->output,
                new ChoiceQuestion('Please select the provider', array_keys($this->getMediaPool()->getProviders()))
            );
        }

        return $this->getMediaPool()->getProvider($providerName);
    }

    public function getContext(): string
    {
        $context = $this->input->getArgument('context');

        if (null === $context) {
            $context = $this->getQuestionHelper()->ask(
                $this->input,
                $this->output,
                new ChoiceQuestion('Please select the context', array_keys($this->getMediaPool()->getContexts()))
            );
        }

        return $context;
    }

    /**
     * @param string $context
     */
    public function getFormat(MediaProviderInterface $provider, $context): string
    {
        $format = $this->input->getArgument('format');

        if (null === $format) {
            $formats = array_keys($provider->getFormats());
            $formats[] = '<ALL THUMBNAILS>';

            $format = $this->getQuestionHelper()->ask(
                $this->input,
                $this->output,
                new ChoiceQuestion('Please select the format', $formats)
            );

            if ('<ALL THUMBNAILS>' === $format) {
                $format = $context.'_all';
            }
        } else {
            $format = $context.'_'.$format;
        }

        return $format;
    }

    /**
     * @param string $context
     * @param string $format
     */
    protected function processMedia(MediaInterface $media, MediaProviderInterface $provider, $context, $format): bool
    {
        $this->log('Deleting thumbs for '.$media->getName().' - '.$media->getId());

        try {
            if ($format === $context.'_all') {
                $format = null;
            }

            $provider->removeThumbnails($media, $format);
        } catch (\Exception $e) {
            $this->log(sprintf(
                '<error>Unable to remove thumbnails, media: %s - %s </error>',
                $media->getId(),
                $e->getMessage()
            ));

            return false;
        }

        return true;
    }

    /**
     * Write a message to the output.
     *
     * @param string $message
     */
    protected function log($message): void
    {
        if (false === $this->quiet) {
            $this->output->writeln($message);
        }
    }

    private function getQuestionHelper(): QuestionHelper
    {
        return $this->getHelper('question');
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\MediaBundle\Command;
15
16			use Sonata\MediaBundle\Model\MediaInterface;
17			use Sonata\MediaBundle\Provider\MediaProviderInterface;
18			use Symfony\Component\Console\Helper\QuestionHelper;
19			use Symfony\Component\Console\Input\InputArgument;
20			use Symfony\Component\Console\Input\InputInterface;
21			use Symfony\Component\Console\Input\InputOption;
22			use Symfony\Component\Console\Output\OutputInterface;
23			use Symfony\Component\Console\Question\ChoiceQuestion;
24
25			/**
26			* This command can be used to re-generate the thumbnails for all uploaded medias.
27			*
28			* Useful if you have existing media content and added new formats.
29			*
30			* @final since sonata-project/media-bundle 3.21.0
31			*/
32			class RemoveThumbsCommand extends BaseCommand
			0 ignored issues – show Deprecated Code introduced 2020-08-05 02:05 UTC by Report Bug Copy Issue Report The class `Sonata\MediaBundle\Command\BaseCommand` has been deprecated with message: since sonata-project/media-bundle 3.26, to be removed in 4.0. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
33			{
34			/**
35			* @var bool
36			*/
37			protected $quiet = false;
38
39			/**
40			* @var InputInterface
41			*/
42			protected $input;
43
44			/**
45			* @var OutputInterface
46			*/
47			protected $output;
48
49			public function configure(): void
50			{
51			$this->setName('sonata:media:remove-thumbnails')
52			->setDescription('Remove uploaded image thumbs')
53			->setDefinition(
54			[
55			new InputArgument('providerName', InputArgument::OPTIONAL, 'The provider'),
56			new InputArgument('context', InputArgument::OPTIONAL, 'The context'),
57			new InputArgument('format', InputArgument::OPTIONAL, 'The format (pass `all` to delete all thumbs)'),
58			new InputOption('batchSize', null, InputOption::VALUE_REQUIRED, 'Media batch size (100 by default)', 100),
59			new InputOption('batchesLimit', null, InputOption::VALUE_REQUIRED, 'Media batches limit (0 by default)', 0),
60			new InputOption('startOffset', null, InputOption::VALUE_REQUIRED, 'Medias start offset (0 by default)', 0),
61			]
62			);
63			}
64
65			public function execute(InputInterface $input, OutputInterface $output): int
66			{
67			$this->input = $input;
68			$this->output = $output;
69
70			$this->quiet = $this->input->getOption('quiet');
			0 ignored issues – show Documentation Bug introduced 2018-10-04 00:33 UTC by Report Bug Copy Issue Report It seems like `$this->input->getOption('quiet')` can also be of type `string` or `array<integer,string>`. However, the property `$quiet` is declared as type `boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
71
72			$provider = $this->getProvider();
73			$context = $this->getContext();
74			$format = $this->getFormat($provider, $context);
75
76			$batchCounter = 0;
77			$batchSize = (int) ($this->input->getOption('batchSize'));
78			$batchesLimit = (int) ($this->input->getOption('batchesLimit'));
79			$startOffset = (int) ($this->input->getOption('startOffset'));
80			$totalMediasCount = 0;
81			do {
82			++$batchCounter;
83
84			try {
85			$batchOffset = $startOffset + ($batchCounter - 1) * $batchSize;
86			$medias = $this->getMediaManager()->findBy(
87			[
88			'providerName' => $provider->getName(),
89			'context' => $context,
90			],
91			[
92			'id' => 'ASC',
93			],
94			$batchSize,
95			$batchOffset
96			);
97			} catch (\Exception $e) {
98			$this->log('Error: '.$e->getMessage());
99
100			break;
101			}
102
103			$batchMediasCount = \count($medias);
104			if (0 === $batchMediasCount) {
105			break;
106			}
107
108			$totalMediasCount += $batchMediasCount;
109			$this->log(
110			sprintf(
111			'Loaded %s medias (batch #%d, offset %d) for removing thumbs (provider: %s, format: %s)',
112			$batchMediasCount,
113			$batchCounter,
114			$batchOffset,
115			$provider->getName(),
116			$format
117			)
118			);
119
120			foreach ($medias as $media) {
121			if (!$this->processMedia($media, $provider, $context, $format)) {
122			continue;
123			}
124			//clean filesystem registry for saving memory
125			$provider->getFilesystem()->clearFileRegister();
126			}
127
128			if ($batchesLimit > 0 && $batchCounter === $batchesLimit) {
129			break;
130			}
131			} while (true);
132
133			$this->log("Done (total medias processed: {$totalMediasCount}).");
134
135			return 0;
136			}
137
138			public function getProvider(): MediaProviderInterface
139			{
140			$providerName = $this->input->getArgument('providerName');
141
142			if (null === $providerName) {
143			$providerName = $this->getQuestionHelper()->ask(
144			$this->input,
145			$this->output,
146			new ChoiceQuestion('Please select the provider', array_keys($this->getMediaPool()->getProviders()))
147			);
148			}
149
150			return $this->getMediaPool()->getProvider($providerName);
151			}
152
153			public function getContext(): string
154			{
155			$context = $this->input->getArgument('context');
156
157			if (null === $context) {
158			$context = $this->getQuestionHelper()->ask(
159			$this->input,
160			$this->output,
161			new ChoiceQuestion('Please select the context', array_keys($this->getMediaPool()->getContexts()))
162			);
163			}
164
165			return $context;
166			}
167
168			/**
169			* @param string $context
170			*/
171			public function getFormat(MediaProviderInterface $provider, $context): string
172			{
173			$format = $this->input->getArgument('format');
174
175			if (null === $format) {
176			$formats = array_keys($provider->getFormats());
177			$formats[] = '<ALL THUMBNAILS>';
178
179			$format = $this->getQuestionHelper()->ask(
180			$this->input,
181			$this->output,
182			new ChoiceQuestion('Please select the format', $formats)
183			);
184
185			if ('<ALL THUMBNAILS>' === $format) {
186			$format = $context.'_all';
187			}
188			} else {
189			$format = $context.'_'.$format;
190			}
191
192			return $format;
193			}
194
195			/**
196			* @param string $context
197			* @param string $format
198			*/
199			protected function processMedia(MediaInterface $media, MediaProviderInterface $provider, $context, $format): bool
200			{
201			$this->log('Deleting thumbs for '.$media->getName().' - '.$media->getId());
202
203			try {
204			if ($format === $context.'_all') {
205			$format = null;
206			}
207
208			$provider->removeThumbnails($media, $format);
209			} catch (\Exception $e) {
210			$this->log(sprintf(
211			'<error>Unable to remove thumbnails, media: %s - %s </error>',
212			$media->getId(),
213			$e->getMessage()
214			));
215
216			return false;
217			}
218
219			return true;
220			}
221
222			/**
223			* Write a message to the output.
224			*
225			* @param string $message
226			*/
227			protected function log($message): void
228			{
229			if (false === $this->quiet) {
230			$this->output->writeln($message);
231			}
232			}
233
234			private function getQuestionHelper(): QuestionHelper
235			{
236			return $this->getHelper('question');
237			}
238			}
239

sonata-project / SonataMediaBundle

RemoveThumbsCommand::execute() B last analyzed 2020-08-28 02:17 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

RemoveThumbsCommand::execute() B
last analyzed 2020-08-28 02:17 UTC