Spatie\HttpStatusCheck\ScanCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	configure()	0	62	1
B	execute()	0	59	7

<?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);

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?

        return 0;
    }
}