ScanCommand::execute() - Code Metrics - spatie/http-status-check - Measure and Improve Code Quality continuously with Scrutinizer

ScanCommand::execute() B
last analyzed 2020-10-12 09:01 UTC

↳ Parent: ScanCommand

Complexity

Conditions	7
Paths	26

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	59
rs	7.9612
c	0
b	0
f	0
cc	7
nc	26
nop	2

How to fix Long Method

<?php

namespace Spatie\HttpStatusCheck;

use GuzzleHttp\RequestOptions;
use Spatie\Crawler\CrawlAllUrls;
use Spatie\Crawler\Crawler;
use Spatie\Crawler\CrawlInternalUrls;
use Symfony\Component\Console\Command\Command;
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\ConfirmationQuestion;

class ScanCommand extends Command
{
    protected function configure()
    {
        $this->setName('scan')
            ->setDescription('Check the http status code of all links on a website.')
            ->addArgument(
                'url',
                InputArgument::REQUIRED,
                'The url to check'
            )
            ->addOption(
                'concurrency',
                'c',
                InputOption::VALUE_REQUIRED,
                'The amount of concurrent connections to use',
                10
            )
            ->addOption(
                'output',
                'o',
                InputOption::VALUE_REQUIRED,
                'Log all non-2xx and non-3xx responses in this file'
            )
            ->addOption(
                'dont-crawl-external-links',
                'x',
                InputOption::VALUE_NONE,
                'Dont crawl external links'
            )
            ->addOption(
                'timeout',
                't',
                InputOption::VALUE_OPTIONAL,
                'The maximum number of seconds the request can take',
                10
            )
            ->addOption(
                'user-agent',
                'u',
                InputOption::VALUE_OPTIONAL,
                'The User Agent to pass for the request',
                ''
            )
            ->addOption(
                'skip-verification',
                's',
                InputOption::VALUE_NONE,
                'Skips checking the SSL certificate'
            )
            ->addOption(
                'options',
                'opt',
                InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL,
                'Additional options to the request',
                []
            )
            ->addOption(
                'ignore-robots',
                null,
                InputOption::VALUE_NONE,
                'Ignore robots checks'
            );
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     *
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $baseUrl = $input->getArgument('url');
        $crawlProfile = $input->getOption('dont-crawl-external-links') ? new CrawlInternalUrls($baseUrl) : new CrawlAllUrls();

        $output->writeln("Start scanning {$baseUrl}");
        $output->writeln('');

        $crawlLogger = new CrawlLogger($output);

        if ($input->getOption('output')) {
            $outputFile = $input->getOption('output');

            if (file_exists($outputFile)) {
                $helper = $this->getHelper('question');
                $question = new ConfirmationQuestion(
                    "The output file `{$outputFile}` already exists. Overwrite it? (y/n)",
                    false
                );

                if (! $helper->ask($input, $output, $question)) {
                    $output->writeln('Aborting...');

                    return 0;
                }

                unlink($outputFile);
            }

            $crawlLogger->setOutputFile($input->getOption('output'));
        }

        $clientOptions = [
            RequestOptions::TIMEOUT => $input->getOption('timeout'),
            RequestOptions::VERIFY => ! $input->getOption('skip-verification'),
            RequestOptions::ALLOW_REDIRECTS => [
                'track_redirects' => true,
            ],
        ];

        $clientOptions = array_merge($clientOptions, $input->getOption('options'));

        if ($input->getOption('user-agent')) {
            $clientOptions[RequestOptions::HEADERS]['user-agent'] = $input->getOption('user-agent');
        }

        $crawler = Crawler::create($clientOptions)
            ->setConcurrency($input->getOption('concurrency'))
            ->setCrawlObserver($crawlLogger)
            ->setCrawlProfile($crawlProfile);

        if ($input->getOption('ignore-robots')) {
            $crawler->ignoreRobots();
        }

        $crawler->startCrawling($baseUrl);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return 0;
    }
}


1			<?php
2
3			namespace Spatie\HttpStatusCheck;
4
5			use GuzzleHttp\RequestOptions;
6			use Spatie\Crawler\CrawlAllUrls;
7			use Spatie\Crawler\Crawler;
8			use Spatie\Crawler\CrawlInternalUrls;
9			use Symfony\Component\Console\Command\Command;
10			use Symfony\Component\Console\Input\InputArgument;
11			use Symfony\Component\Console\Input\InputInterface;
12			use Symfony\Component\Console\Input\InputOption;
13			use Symfony\Component\Console\Output\OutputInterface;
14			use Symfony\Component\Console\Question\ConfirmationQuestion;
15
16			class ScanCommand extends Command
17			{
18			protected function configure()
19			{
20			$this->setName('scan')
21			->setDescription('Check the http status code of all links on a website.')
22			->addArgument(
23			'url',
24			InputArgument::REQUIRED,
25			'The url to check'
26			)
27			->addOption(
28			'concurrency',
29			'c',
30			InputOption::VALUE_REQUIRED,
31			'The amount of concurrent connections to use',
32			10
33			)
34			->addOption(
35			'output',
36			'o',
37			InputOption::VALUE_REQUIRED,
38			'Log all non-2xx and non-3xx responses in this file'
39			)
40			->addOption(
41			'dont-crawl-external-links',
42			'x',
43			InputOption::VALUE_NONE,
44			'Dont crawl external links'
45			)
46			->addOption(
47			'timeout',
48			't',
49			InputOption::VALUE_OPTIONAL,
50			'The maximum number of seconds the request can take',
51			10
52			)
53			->addOption(
54			'user-agent',
55			'u',
56			InputOption::VALUE_OPTIONAL,
57			'The User Agent to pass for the request',
58			''
59			)
60			->addOption(
61			'skip-verification',
62			's',
63			InputOption::VALUE_NONE,
64			'Skips checking the SSL certificate'
65			)
66			->addOption(
67			'options',
68			'opt',
69			InputOption::VALUE_IS_ARRAY \| InputOption::VALUE_OPTIONAL,
70			'Additional options to the request',
71			[]
72			)
73			->addOption(
74			'ignore-robots',
75			null,
76			InputOption::VALUE_NONE,
77			'Ignore robots checks'
78			);
79			}
80
81			/**
82			* @param \Symfony\Component\Console\Input\InputInterface $input
83			* @param \Symfony\Component\Console\Output\OutputInterface $output
84			*
85			* @return int
86			*/
87			protected function execute(InputInterface $input, OutputInterface $output)
88			{
89			$baseUrl = $input->getArgument('url');
90			$crawlProfile = $input->getOption('dont-crawl-external-links') ? new CrawlInternalUrls($baseUrl) : new CrawlAllUrls();
91
92			$output->writeln("Start scanning {$baseUrl}");
93			$output->writeln('');
94
95			$crawlLogger = new CrawlLogger($output);
96
97			if ($input->getOption('output')) {
98			$outputFile = $input->getOption('output');
99
100			if (file_exists($outputFile)) {
101			$helper = $this->getHelper('question');
102			$question = new ConfirmationQuestion(
103			"The output file `{$outputFile}` already exists. Overwrite it? (y/n)",
104			false
105			);
106
107			if (! $helper->ask($input, $output, $question)) {
108			$output->writeln('Aborting...');
109
110			return 0;
111			}
112
113			unlink($outputFile);
114			}
115
116			$crawlLogger->setOutputFile($input->getOption('output'));
117			}
118
119			$clientOptions = [
120			RequestOptions::TIMEOUT => $input->getOption('timeout'),
121			RequestOptions::VERIFY => ! $input->getOption('skip-verification'),
122			RequestOptions::ALLOW_REDIRECTS => [
123			'track_redirects' => true,
124			],
125			];
126
127			$clientOptions = array_merge($clientOptions, $input->getOption('options'));
128
129			if ($input->getOption('user-agent')) {
130			$clientOptions[RequestOptions::HEADERS]['user-agent'] = $input->getOption('user-agent');
131			}
132
133			$crawler = Crawler::create($clientOptions)
134			->setConcurrency($input->getOption('concurrency'))
135			->setCrawlObserver($crawlLogger)
136			->setCrawlProfile($crawlProfile);
137
138			if ($input->getOption('ignore-robots')) {
139			$crawler->ignoreRobots();
140			}
141
142			$crawler->startCrawling($baseUrl);
			0 ignored issues – show Bug introduced 2019-11-19 17:11 UTC by Report Bug Copy Issue Report It seems like `$baseUrl` defined by `$input->getArgument('url')` on line `89` can also be of type `array<integer,string>` or `null`; however, `Spatie\Crawler\Crawler::startCrawling()` does only seem to accept `object<Psr\Http\Message\UriInterface>\|string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
143
144			return 0;
145			}
146			}
147

spatie / http-status-check

GitHub Access Token became invalid

ScanCommand::execute() B last analyzed 2020-10-12 09:01 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ScanCommand::execute() B
last analyzed 2020-10-12 09:01 UTC