SelfUpdateCommand::execute() - Code Metrics - Inspection of "#497 Add Basic Self Update Functionality" - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#615)

unknown

created 2017-09-03 15:16 UTC

SelfUpdateCommand::execute() B

↳ Parent: SelfUpdateCommand

Complexity

Conditions	8
Paths	32

Size

Total Lines	57
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	57
rs	7.2648
cc	8
eloc	33
nc	32
nop	2

How to fix Long Method

<?php

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

namespace Robo;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Filesystem\Filesystem as sfFilesystem;

/**
 * Update the robo.phar from the latest github release
 *
 * @author Alexander Menk <[email protected]>
 */
class SelfUpdateCommand extends Command
{
    private $command;


    protected $gitHubRepository;

    protected $currentVersion;

    public function __construct($name = null, $currentVersion = null, $gitHubRepository = null)
    {
        parent::__construct($name);
        $this->currentVersion = $currentVersion;
        $this->gitHubRepository = $gitHubRepository;
    }


    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('self-update')
            ->setAliases(array( 'selfupdate' ))
            ->setDescription('Updates the robo.phar to the latest version.')
            ->setHelp(
                <<<EOT
The <info>self-update</info> command checks github for newer
versions of robo and if found, installs the latest.
EOT
            );
    }

    protected function getLatestReleaseFromGithub()
    {
        $opts = [
            'http' => [
                'method' => 'GET',
                'header' => [
                    'User-Agent: ' . Robo::APPLICATION_NAME  . ' (' . $this->gitHubRepository . ')' . ' Self-Update (PHP)'
                ]
            ]
        ];

        $context = stream_context_create($opts);

        $releases = file_get_contents('https://api.github.com/repos/' . $this->gitHubRepository . '/releases', false, $context);
        $releases = json_decode($releases);

        if (! isset($releases[0])) {
            throw new \Exception('API error - no release found at GitHub repository ' . $this->gitHubRepository);
        }

        $version = $releases[0]->tag_name;
        $url     = $releases[0]->assets[0]->browser_download_url;

        return [ $version, $url ];
    }

    public function isEnabled()
    {
        return !empty(\Phar::running());
    }


    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {

        $localFilename = realpath($_SERVER['argv'][0]) ?: $_SERVER['argv'][0];
        $programName   = basename($localFilename);
        $tempFilename  = dirname($localFilename) . '/' . basename($localFilename, '.phar') . '-temp.phar';

        // check for permissions in local filesystem before start connection process
        if (! is_writable($tempDirectory = dirname($tempFilename))) {
            throw new \Exception(
                $programName . ' update failed: the "' . $tempDirectory .
                '" directory used to download the temp file could not be written'
            );
        }

        if (! is_writable($localFilename)) {
            throw new \Exception(
                $programName . ' update failed: the "' . $localFilename . '" file could not be written (execute with sudo)'
            );
        }

        list( $latest, $downloadUrl ) = $this->getLatestReleaseFromGithub();


        if ($this->currentVersion == $latest) {
            $output->writeln('No update available');
            return;
        }

        $fs = new sfFilesystem();

        $output->writeln('Downloading ' . Robo::APPLICATION_NAME . ' (' . $this->gitHubRepository . ') ' . $latest);

        $fs->copy($downloadUrl, $tempFilename);

        $output->writeln('Download finished');

        try {
            \error_reporting(E_ALL); // supress notices

            @chmod($tempFilename, 0777 & ~umask());
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            // test the phar validity
            $phar = new \Phar($tempFilename);
            // free the variable to unlock the file
            unset($phar);
            @rename($tempFilename, $localFilename);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            $output->writeln('<info>Successfully updated ' . $programName . '</info>');
            $this->_exit();
        } catch (\Exception $e) {
            @unlink($tempFilename);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            if (! $e instanceof \UnexpectedValueException && ! $e instanceof \PharException) {
                throw $e;
            }
            $output->writeln('<error>The download is corrupted (' . $e->getMessage() . ').</error>');
            $output->writeln('<error>Please re-run the self-update command to try again.</error>');
        }
    }

    /**
     * Stop execution
     *
     * This is a workaround to prevent warning of dispatcher after replacing
     * the phar file.
     *
     * @return void
     */
    protected function _exit()
    {
        exit;

    }
}


1			<?php
2
3			/*
4			* This file is part of the Symfony package.
5			*
6			* (c) Fabien Potencier <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Robo;
13
14			use Symfony\Component\Console\Command\Command;
15			use Symfony\Component\Console\Input\InputInterface;
16			use Symfony\Component\Console\Output\OutputInterface;
17			use Symfony\Component\Filesystem\Filesystem as sfFilesystem;
18
19			/**
20			* Update the robo.phar from the latest github release
21			*
22			* @author Alexander Menk <[email protected]>
23			*/
24			class SelfUpdateCommand extends Command
25			{
26			private $command;
			0 ignored issues – show Unused Code introduced 2017-08-30 05:59 UTC by Report Bug Copy Issue Report The property `$command` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
27
28			protected $gitHubRepository;
29
30			protected $currentVersion;
31
32			public function __construct($name = null, $currentVersion = null, $gitHubRepository = null)
33			{
34			parent::__construct($name);
35			$this->currentVersion = $currentVersion;
36			$this->gitHubRepository = $gitHubRepository;
37			}
38
39
40			/**
41			* {@inheritdoc}
42			*/
43			protected function configure()
44			{
45			$this
46			->setName('self-update')
47			->setAliases(array( 'selfupdate' ))
48			->setDescription('Updates the robo.phar to the latest version.')
49			->setHelp(
50			<<<EOT
51			The <info>self-update</info> command checks github for newer
52			versions of robo and if found, installs the latest.
53			EOT
54			);
55			}
56
57			protected function getLatestReleaseFromGithub()
58			{
59			$opts = [
60			'http' => [
61			'method' => 'GET',
62			'header' => [
63			'User-Agent: ' . Robo::APPLICATION_NAME . ' (' . $this->gitHubRepository . ')' . ' Self-Update (PHP)'
64			]
65			]
66			];
67
68			$context = stream_context_create($opts);
69
70			$releases = file_get_contents('https://api.github.com/repos/' . $this->gitHubRepository . '/releases', false, $context);
71			$releases = json_decode($releases);
72
73			if (! isset($releases[0])) {
74			throw new \Exception('API error - no release found at GitHub repository ' . $this->gitHubRepository);
75			}
76
77			$version = $releases[0]->tag_name;
78			$url = $releases[0]->assets[0]->browser_download_url;
79
80			return [ $version, $url ];
81			}
82
83			public function isEnabled()
84			{
85			return !empty(\Phar::running());
86			}
87
88
89			/**
90			* {@inheritdoc}
91			*/
92			protected function execute(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Coding Style introduced 2017-08-29 20:03 UTC by Report Bug Copy Issue Report `execute` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
93			{
94
95			$localFilename = realpath($_SERVER['argv'][0]) ?: $_SERVER['argv'][0];
96			$programName = basename($localFilename);
97			$tempFilename = dirname($localFilename) . '/' . basename($localFilename, '.phar') . '-temp.phar';
98
99			// check for permissions in local filesystem before start connection process
100			if (! is_writable($tempDirectory = dirname($tempFilename))) {
101			throw new \Exception(
102			$programName . ' update failed: the "' . $tempDirectory .
103			'" directory used to download the temp file could not be written'
104			);
105			}
106
107			if (! is_writable($localFilename)) {
108			throw new \Exception(
109			$programName . ' update failed: the "' . $localFilename . '" file could not be written (execute with sudo)'
110			);
111			}
112
113			list( $latest, $downloadUrl ) = $this->getLatestReleaseFromGithub();
114
115
116			if ($this->currentVersion == $latest) {
117			$output->writeln('No update available');
118			return;
119			}
120
121			$fs = new sfFilesystem();
122
123			$output->writeln('Downloading ' . Robo::APPLICATION_NAME . ' (' . $this->gitHubRepository . ') ' . $latest);
124
125			$fs->copy($downloadUrl, $tempFilename);
126
127			$output->writeln('Download finished');
128
129			try {
130			\error_reporting(E_ALL); // supress notices
131
132			@chmod($tempFilename, 0777 & ~umask());
			0 ignored issues – show Security Best Practice introduced 2017-08-29 20:03 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
133			// test the phar validity
134			$phar = new \Phar($tempFilename);
135			// free the variable to unlock the file
136			unset($phar);
137			@rename($tempFilename, $localFilename);
			0 ignored issues – show Security Best Practice introduced 2017-08-29 20:03 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
138			$output->writeln('<info>Successfully updated ' . $programName . '</info>');
139			$this->_exit();
140			} catch (\Exception $e) {
141			@unlink($tempFilename);
			0 ignored issues – show Security Best Practice introduced 2017-08-29 20:03 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
142			if (! $e instanceof \UnexpectedValueException && ! $e instanceof \PharException) {
143			throw $e;
144			}
145			$output->writeln('<error>The download is corrupted (' . $e->getMessage() . ').</error>');
146			$output->writeln('<error>Please re-run the self-update command to try again.</error>');
147			}
148			}
149
150			/**
151			* Stop execution
152			*
153			* This is a workaround to prevent warning of dispatcher after replacing
154			* the phar file.
155			*
156			* @return void
157			*/
158			protected function _exit()
159			{
160			exit;
			0 ignored issues – show Coding Style Compatibility introduced 2017-08-29 20:17 UTC by Report Bug Copy Issue Report The method `_exit()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
161			}
162			}
163

consolidation / robo

Pull Request — master (#615)

SelfUpdateCommand::execute() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like