Completed
Pull Request — master (#615)
by
unknown
02:51
created

SelfUpdateCommand   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 137
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 3

Importance

Changes 4
Bugs 0 Features 1
Metric Value
wmc 14
c 4
b 0
f 1
lcom 2
cbo 3
dl 0
loc 137
rs 10

6 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A configure() 0 13 1
B getLatestReleaseFromGithub() 0 25 2
A isEnabled() 0 3 1
B execute() 0 57 8
A _exit() 0 4 1
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 by
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
        parent::__construct( $name );
34
        $this->currentVersion = $currentVersion;
35
        $this->gitHubRepository = $gitHubRepository;
36
    }
37
38
39
    /**
40
     * {@inheritdoc}
41
     */
42
    protected function configure()
43
    {
44
        $this
45
            ->setName('self-update')
46
            ->setAliases(array( 'selfupdate' ))
47
            ->setDescription('Updates the robo.phar to the latest version.')
48
            ->setHelp(
49
                <<<EOT
50
The <info>self-update</info> command checks github for newer
51
versions of robo and if found, installs the latest.
52
EOT
53
            );
54
    }
55
56
    protected function getLatestReleaseFromGithub()
57
    {
58
        $opts = [
59
            'http' => [
60
                'method' => 'GET',
61
                'header' => [
62
                    'User-Agent: ' . Robo::APPLICATION_NAME . ' Self-Update (PHP)'
63
                ]
64
            ]
65
        ];
66
67
        $context = stream_context_create($opts);
68
69
        $releases = file_get_contents('https://api.github.com/repos/' . $this->gitHubRepository . '/releases', false, $context);
70
        $releases = json_decode($releases);
71
72
        if (! isset($releases[0])) {
73
            throw new \Exception('API error - no release found at GitHub repository ' . $this->gitHubRepository);
74
        }
75
76
        $version = $releases[0]->tag_name;
77
        $url     = $releases[0]->assets[0]->browser_download_url;
78
79
        return [ $version, $url ];
80
    }
81
82
    public function isEnabled() {
83
        return !empty(\Phar::running());
84
    }
85
86
87
    /**
88
     * {@inheritdoc}
89
     */
90
    protected function execute(InputInterface $input, OutputInterface $output)
0 ignored issues
show
Coding Style introduced by
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...
91
    {
92
93
        $localFilename = realpath($_SERVER['argv'][0]) ?: $_SERVER['argv'][0];
94
        $programName   = basename($localFilename);
95
        $tempFilename  = dirname($localFilename) . '/' . basename($localFilename, '.phar') . '-temp.phar';
96
97
        // check for permissions in local filesystem before start connection process
98
        if (! is_writable($tempDirectory = dirname($tempFilename))) {
99
            throw new \Exception(
100
                $programName . ' update failed: the "' . $tempDirectory .
101
                '" directory used to download the temp file could not be written'
102
            );
103
        }
104
105
        if (! is_writable($localFilename)) {
106
            throw new \Exception(
107
                $programName . ' update failed: the "' . $localFilename . '" file could not be written (execute with sudo)'
108
            );
109
        }
110
111
        list( $latest, $downloadUrl ) = $this->getLatestReleaseFromGithub();
112
113
114
        if ($this->currentVersion == $latest) {
115
            $output->writeln('No update available');
116
            return;
117
        }
118
119
        $fs = new sfFilesystem();
120
121
        $output->writeln('Downloading ' . Robo::APPLICATION_NAME . ' ' . $latest);
122
123
        $fs->copy($downloadUrl, $tempFilename);
124
125
        $output->writeln('Download finished');
126
127
        try {
128
            \error_reporting(E_ALL); // supress notices
129
130
            @chmod($tempFilename, 0777 & ~umask());
0 ignored issues
show
Security Best Practice introduced by
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...
131
            // test the phar validity
132
            $phar = new \Phar($tempFilename);
133
            // free the variable to unlock the file
134
            unset($phar);
135
            @rename($tempFilename, $localFilename);
0 ignored issues
show
Security Best Practice introduced by
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...
136
            $output->writeln('<info>Successfully updated ' . $programName . '</info>');
137
            $this->_exit();
138
        } catch (\Exception $e) {
139
            @unlink($tempFilename);
0 ignored issues
show
Security Best Practice introduced by
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...
140
            if (! $e instanceof \UnexpectedValueException && ! $e instanceof \PharException) {
141
                throw $e;
142
            }
143
            $output->writeln('<error>The download is corrupted (' . $e->getMessage() . ').</error>');
144
            $output->writeln('<error>Please re-run the self-update command to try again.</error>');
145
        }
146
    }
147
148
    /**
149
     * Stop execution
150
     *
151
     * This is a workaround to prevent warning of dispatcher after replacing
152
     * the phar file.
153
     *
154
     * @return void
155
     */
156
    protected function _exit()
157
    {
158
        exit;
0 ignored issues
show
Coding Style Compatibility introduced by
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...
159
    }
160
}
161