Webs\Mirror\Command\Create

Complexity

Total Complexity

48

Size/Duplication

Total Lines	448
Duplicated Lines	0 %

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
B	downloadProviders()	0	26	3
A	poolPackages()	0	14	1
A	fallback()	0	21	2
A	getProvidersGenerator()	0	14	3
A	getClosureComplete()	0	4	1
B	isEqual()	0	27	4
A	__construct()	0	5	1
A	getPackagesGenerator()	0	14	4
B	showErrors()	0	34	5
B	disableDueErrors()	0	39	6
A	generateHtml()	0	7	1
B	downloadPackages()	0	27	3
A	canSkip()	0	7	3
A	setClean()	0	5	1
B	execute()	0	30	5
A	loadProviderPackages()	0	7	1
A	switch()	0	11	2
A	loadPackagesJson()	0	11	1
A	getExitCode()	0	5	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Packagist Mirror.
 *
 * For the full license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

namespace Webs\Mirror\Command;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Webs\Mirror\ShortName;
use Webs\Mirror\Provider;
use stdClass;
use Generator;
use Closure;

/**
 * Create a mirror.
 *
 * @author Webysther Nunes <webysther@gmail.com>
 */
class Create extends Base
{
    use ShortName;

    /**
     * @var stdClass
     */
    protected $providers;

    /**
     * @var array
     */
    protected $providerIncludes;

    /**
     * @var string
     */
    protected $currentProvider;

    /**
     * @var Clean
     */
    protected $clean;

    /**
     * {@inheritdoc}
     */
    public function __construct($name = '')
    {
        parent::__construct('create');
        $this->setDescription(
            'Create/update packagist mirror'
        );
    }

    /**
     * {@inheritdoc}
     */
    public function execute(InputInterface $input, OutputInterface $output):int
    {
        $this->progressBar->setConsole($input, $output);
        $this->package->setConsole($input, $output);
        $this->package->setHttp($this->http);
        $this->provider->setConsole($input, $output);
        $this->provider->setHttp($this->http);

        // Download providers, with repository, is incremental
        if ($this->downloadProviders()->stop()) {
            return $this->getExitCode();
        }

        // Download packages
        if ($this->downloadPackages()->stop()) {
            return $this->getExitCode();
        }

        // Switch .packagist.json to packagist.json
        if ($this->switch()->stop()) {
            return $this->getExitCode();
        }

        $this->setExitCode($this->clean->execute($input, $output));

        if ($this->initialized) {
            $this->filesystem->remove(self::INIT);

The method remove() does not exist on Webs\Mirror\Filesystem.

        }

        return $this->getExitCode();
    }

    /**
     * @param Clean $clean
     */
    public function setClean(Clean $clean):Create
    {
        $this->clean = $clean;

        return $this;
    }

    /**
     * @return int
     */
    protected function getExitCode():int
    {
        $this->generateHtml();

        return $this->exitCode;
    }

    /**
     * Load main packages.json.
     *
     * @return Create
     */
    protected function loadPackagesJson():Create
    {
        $this->output->writeln(
            'Loading providers from <info>'.$this->http->getBaseUri().'</>'
        );

        $this->providers = $this->provider->addFullPath(
            $this->package->loadMainJson()
        );

        return $this;
    }

    /**
     * Check if packages.json was changed.
     *
     * @return bool
     */
    protected function isEqual():bool
    {
        // if 'p/...' folder not found
        if (!$this->filesystem->has(self::TO)) {
            $this->filesystem->touch(self::INIT);
        }

        $this->initialized = $this->filesystem->has(self::INIT);

        $newPackages = json_encode($this->providers, JSON_PRETTY_PRINT);

        // No provider changed? Just relax...
        if ($this->canSkip(self::MAIN)) {
            $old = $this->filesystem->getHashFile(self::MAIN);
            $new = $this->filesystem->getHash($newPackages);

            if ($old == $new) {
                $this->output->writeln(self::MAIN.' <info>updated</>');
                $this->setExitCode(0);

                return true;
            }
        }

        $this->filesystem->write(self::DOT, $newPackages);

        return false;
    }

    /**
     * Switch current packagist.json to space and .packagist to packagist.json.
     *
     * @return bool True if work, false otherside
     */
    protected function switch():Create
    {
        // If .packages.json dont exists
        if (!$this->filesystem->has(self::DOT)) {
            return $this;

The expression return $this returns the type Webs\Mirror\Command\Create which is incompatible with the documented return type boolean.

        }

        // Move to new location
        $this->filesystem->move(self::DOT, self::MAIN);

        return $this;

The expression return $this returns the type Webs\Mirror\Command\Create which is incompatible with the documented return type boolean.

    }

    /**
     * Download packages.json & provider-xxx$xxx.json.
     *
     * @return bool True if work, false otherside
     */
    protected function downloadProviders():Create
    {
        if ($this->loadPackagesJson()->isEqual()) {
            return $this;

The expression return $this returns the type Webs\Mirror\Command\Create which is incompatible with the documented return type boolean.

        }

        $this->providerIncludes = $this->provider->normalize($this->providers);
        $generator = $this->getProvidersGenerator();

        $this->progressBar->start(count($this->providerIncludes));

        $success = function ($body, $path) {
            $this->filesystem->write($path, $body);
        };

        $this->http->pool($generator, $success, $this->getClosureComplete());
        $this->progressBar->end();
        $this->showErrors();

        if ($generator->getReturn()) {

The method getReturn() does not exist on Generator.

            $this->output->writeln('All providers are <info>updated</>');

            return $this->setExitCode(0);

The expression return $this->setExitCode(0) returns the type Webs\Mirror\Command\Create which is incompatible with the documented return type boolean.

        }

        return $this;

The expression return $this returns the type Webs\Mirror\Command\Create which is incompatible with the documented return type boolean.

    }

    /**
     * @return Closure
     */
    protected function getClosureComplete():Closure
    {
        return function () {
            $this->progressBar->progress();
        };
    }

    /**
     * Download packages.json & provider-xxx$xxx.json.
     *
     * @return Generator Providers downloaded
     */
    protected function getProvidersGenerator():Generator
    {
        $providerIncludes = array_keys($this->providerIncludes);
        $updated = true;
        foreach ($providerIncludes as $uri) {
            if ($this->canSkip($uri)) {
                continue;
            }

            $updated = false;
            yield $uri => $this->http->getRequest($uri);
        }

        return $updated;

The expression return $updated returns the type boolean which is incompatible with the type-hinted return Generator.

    }

    /**
     * @param string $path
     *
     * @return bool
     */
    protected function canSkip(string $path):bool
    {
        if ($this->filesystem->has($path) && !$this->initialized) {
            return true;
        }

        return false;
    }

    /**
     * Show errors.
     *
     * @return Create
     */
    protected function showErrors():Create
    {
        if (!$this->isVerbose()) {
            return $this;
        }

        $errors = $this->http->getPoolErrors();
        if (count($errors) === 0) {
            return $this;
        }

        foreach ($errors as $path => $reason) {
            $shortname = $this->shortname($path);
            $error = $reason->getCode();
            $host = $reason->getRequest()->getUri()->getHost();

            $this->output->write(
                "<comment>$shortname</> failed from ".
                "<info>$host</> with HTTP error"
            );

            if (!$error) {
                $this->output->writeln(
                    ':'.PHP_EOL.'<error>'.$reason->getMessage().'</>'
                );
                continue;
            }

            $this->output->writeln(" <error>$error</>");
        }

        $this->output->write(PHP_EOL);

        return $this;
    }

    /**
     * Disable mirror when due lots of errors.
     */
    protected function disableDueErrors()
    {
        $errors = $this->http->getPoolErrors();
        if (count($errors) === 0) {
            return $this;
        }

        $counter = [];

        foreach ($errors as $reason) {
            $uri = $reason->getRequest()->getUri();
            $host = $uri->getScheme().'://'.$uri->getHost();

            if (!isset($counter[$host])) {
                $counter[$host] = 0;
            }

            ++$counter[$host];
        }

        $mirrors = $this->http->getMirror()->toArray();

The method toArray() does not exist on Webs\Mirror\Mirror.

        foreach ($mirrors as $mirror) {
            $total = $counter[$mirror];
            if ($total < 1000) {
                continue;
            }

            $this->output->write(PHP_EOL);
            $this->output->writeln(
                '<error>Due to '.
                $total.' errors mirror '.
                $mirror.' will be disabled</>'
            );
            $this->output->write(PHP_EOL);
            $this->http->getMirror()->remove($mirror);
        }

        return $this;
    }

    /**
     * @param string $uri
     *
     * @return Create
     */
    protected function loadProviderPackages(string $uri):Create
    {
        $providers = json_decode($this->filesystem->read($uri))->providers;
        $this->providerPackages = $this->package->normalize($providers);

The property providerPackages does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->currentProvider = $uri;

        return $this;
    }

    /**
     * Download packages listed on provider-*.json on public/p dir.
     *
     * @return Create
     */
    protected function downloadPackages():Create
    {
        $totalProviders = count($this->providerIncludes);
        $currentProvider = 0;

        $providerIncludes = array_keys($this->providerIncludes);
        foreach ($providerIncludes as $uri) {
            $shortname = $this->shortname($uri);

            $this->output->writeln(
                '['.++$currentProvider.'/'.$totalProviders.']'.
                ' Loading packages from <info>'.$shortname.'</> provider'
            );

            $this->http->useMirrors();
            $generator = $this->loadProviderPackages($uri)->getPackagesGenerator();
            if (empty(iterator_to_array($generator))) {
                continue;
            }

            $this->progressBar->start(count($this->providerPackages));
            $this->poolPackages($generator);
            $this->progressBar->end();
            $this->showErrors()->disableDueErrors()->fallback();
        }

        return $this;
    }

    /**
     * Download only a package.
     *
     * @return Generator Providers downloaded
     */
    protected function getPackagesGenerator():Generator
    {
        $providerPackages = array_keys($this->providerPackages);
        foreach ($providerPackages as $uri) {
            if ($this->filesystem->has($uri)) {
                $this->progressBar->progress();
                continue;
            }

            if ($this->initialized) {
                $uri = $this->http->getMirror()->getNext().'/'.$uri;
            }

            yield $uri => $this->http->getRequest($uri);
        }
    }

    /**
     * @param Generator $generator
     * @param bool|bool $useMirrors
     *
     * @return Create
     */
    protected function poolPackages(Generator $generator):Create
    {
        $this->http->pool(
            $generator,
            // Success
            function ($body, $path) {
                $this->filesystem->write($path, $body);
                $this->package->setDownloaded($path);
            },
            // If complete, even failed and success
            $this->getCompleteClosure()

The method getCompleteClosure() does not exist on Webs\Mirror\Command\Create. Did you maybe mean getClosureComplete()?

        );

        return $this;
    }

    protected function fallback():Create
    {
        $total = count($this->http->getPoolErrors());

        if (!$total) {
            return $this;
        }

        $shortname = $this->shortname($this->currentProvider);

        $this->output->writeln(
            'Fallback packages from <info>'.$shortname.
            '</> provider to main mirror <info>'.$this->http->getBaseUri().'</>'
        );

        $this->providerPackages = $this->http->getPoolErrors();

The property providerPackages does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $generator = $this->getPackagesGenerator();
        $this->progressBar->start($total);
        $this->poolPackages($generator);
        $this->progressBar->end();
        $this->showErrors();

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Webs\Mirror\Command\Create. Consider adding a return statement or allowing null as return value.

    }

    /**
     * Generate HTML of index.html.
     */
    protected function generateHtml():Create
    {
        ob_start();
        include getcwd().'/resources/index.html.php';
        $this->filesystem->write('index.html', ob_get_clean());

        return $this;
    }
}