ComposerApiService::getConfig() - Code Metrics - Inspection of "using composer/composer instead composer.phar" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — experimental/3.1 (#2619)

unknown

created 2017-11-09 10:01 UTC

ComposerApiService::getConfig() A

↳ Parent: ComposerApiService

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	0
dl	10
loc	10
rs	9.4285
c	0
b	0
f	0

<?php
/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
namespace Eccube\Service\Composer;

use Composer\Console\Application;
use Eccube\Annotation\Inject;
use Eccube\Annotation\Service;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\BufferedOutput;

/**
 * Class ComposerApiService
 * @package Eccube\Service\Composer
 * @Service
 */
class ComposerApiService implements ComposerServiceInterface
{
    /**
     * @Inject("config")
     * @var array
     */
    protected $appConfig;

    /**
     * @var Application $consoleApplication
     */
    private $consoleApplication;

    private $workingDir;

    /**
     * Run get info command
     *
     * @param string $pluginName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
     * @return array
     */
    public function execInfo($pluginName)

    {
        $output = $this->runCommand(array(
            'command' => 'info',
            'package' => $pluginName,
        ));
        $parser = new ParseOutputCommand($output, ParseOutputCommand::INFO_TYPE);

        return $parser->parse();
    }

    /**
     * Run execute command
     *
     * @param string $packageName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
     * @return array
     */
    public function execRequire($packageName)
    {
        $output = $this->runCommand(array(
            'command' => 'require',
            'packages' => array($packageName),
            '--no-interaction' => true,
            '--profile' => true,
            '--prefer-dist' => true,
            '--ignore-platform-reqs' => true,
        ));

        $parser = new ParseOutputCommand($output, ParseOutputCommand::REQUIRE_TYPE);

        return $parser->parse();
    }

    /**
     * Run remove command
     *
     * @param string $packageName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
     * @return bool
     */
    public function execRemove($packageName)
    {
        $this->runCommand(array(
            'command' => 'remove',
            'packages' => array($packageName),
            '--ignore-platform-reqs' => true,
            '--no-interaction' => true,
            '--profile' => true,
        ));

        return true;
    }

    /**
     * Get require
     *
     * @param string $packageName
     * @param string $callback
     * @param null   $typeFilter
     */
    public function foreachRequires($packageName, $callback, $typeFilter = null)
    {
        $info = $this->execInfo($packageName);
        if (isset($info['requires'])) {
            foreach ($info['requires'] as $name => $version) {
                $package = $this->execInfo($name);
                if (is_null($typeFilter) || @$package['type'] === $typeFilter) {
                    $callback($package);
                }
            }
        }
    }

    /**
     * Run get config information
     *
     * @param string $key
     * @param null   $value
     * @return array|mixed
     */
    public function execConfig($key, $value = null)
    {
        $commands = array(
            'command' => 'config',
            'setting-key' => $key,
            'setting-value' => $value,
        );
        if ($value) {
            $commands['setting-value'] = $value;
        }
        $output = $this->runCommand($commands);
        $parser = new ParseOutputCommand($output, ParseOutputCommand::CONFIG_TYPE);

        return $parser->parse();
    }

    /**
     * Get config list
     *
     * @return array
     */
    public function getConfig()

    {
        $output = $this->runCommand(array(
            'command' => 'config',
            '--list' => true,
        ));
        $parser = new ParseOutputCommand($output, ParseOutputCommand::LIST_TYPE);

        return $parser->parse();
    }

    /**
     * Set work dir
     *
     * @param string $workingDir
     */
    public function setWorkingDir($workingDir)
    {
        $this->workingDir = $workingDir;
    }

    /**
     * Run composer command
     *
     * @param array $commands
     * @return string
     */
    public function runCommand($commands)
    {
        $this->init();
        $commands['--working-dir'] = $this->workingDir;
        $commands['--no-ansi'] = 1;
        $input = new ArrayInput($commands);
        $output = new BufferedOutput();

        $exitCode = $this->consoleApplication->run($input, $output);

        $log = $output->fetch();
        if ($exitCode) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            log_error($log);
            throw new \RuntimeException($log);
        }
        log_info($log, $commands);

        return $log;
    }

    /**
     * Init composer console application
     */
    private function init()
    {
        set_time_limit(0);
        @ini_set('memory_limit', '1536M');
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        // Config for some environment
        putenv('COMPOSER_HOME='.$this->appConfig['plugin_realdir'].'/.composer');
        $consoleApplication = new Application();
        $consoleApplication->resetComposer();
        $consoleApplication->setAutoExit(false);
        $this->consoleApplication = $consoleApplication;
        $this->workingDir = $this->workingDir ? $this->workingDir : $this->appConfig['root_dir'];
    }
}


1		<?php
2		/*
3		* This file is part of EC-CUBE
4		*
5		* Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
6		*
7		* http://www.lockon.co.jp/
8		*
9		* This program is free software; you can redistribute it and/or
10		* modify it under the terms of the GNU General Public License
11		* as published by the Free Software Foundation; either version 2
12		* of the License, or (at your option) any later version.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU General Public License for more details.
18		*
19		* You should have received a copy of the GNU General Public License
20		* along with this program; if not, write to the Free Software
21		* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22		*/
23		namespace Eccube\Service\Composer;
24
25		use Composer\Console\Application;
26		use Eccube\Annotation\Inject;
27		use Eccube\Annotation\Service;
28		use Symfony\Component\Console\Input\ArrayInput;
29		use Symfony\Component\Console\Output\BufferedOutput;
30
31		/**
32		* Class ComposerApiService
33		* @package Eccube\Service\Composer
34		* @Service
35		*/
36		class ComposerApiService implements ComposerServiceInterface
37		{
38		/**
39		* @Inject("config")
40		* @var array
41		*/
42		protected $appConfig;
43
44		/**
45		* @var Application $consoleApplication
46		*/
47		private $consoleApplication;
48
49		private $workingDir;
50
51		/**
52		* Run get info command
53		*
54		* @param string $pluginName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
55		* @return array
56		*/
57	View Code Duplication	public function execInfo($pluginName)
		0 ignored issues – show Duplication introduced 2017-11-09 10:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
58		{
59		$output = $this->runCommand(array(
60		'command' => 'info',
61		'package' => $pluginName,
62		));
63		$parser = new ParseOutputCommand($output, ParseOutputCommand::INFO_TYPE);
64
65		return $parser->parse();
66		}
67
68		/**
69		* Run execute command
70		*
71		* @param string $packageName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
72		* @return array
73		*/
74		public function execRequire($packageName)
75		{
76		$output = $this->runCommand(array(
77		'command' => 'require',
78		'packages' => array($packageName),
79		'--no-interaction' => true,
80		'--profile' => true,
81		'--prefer-dist' => true,
82		'--ignore-platform-reqs' => true,
83		));
84
85		$parser = new ParseOutputCommand($output, ParseOutputCommand::REQUIRE_TYPE);
86
87		return $parser->parse();
88		}
89
90		/**
91		* Run remove command
92		*
93		* @param string $packageName format foo/bar or foo/bar:1.0.0 or "foo/bar 1.0.0"
94		* @return bool
95		*/
96		public function execRemove($packageName)
97		{
98		$this->runCommand(array(
99		'command' => 'remove',
100		'packages' => array($packageName),
101		'--ignore-platform-reqs' => true,
102		'--no-interaction' => true,
103		'--profile' => true,
104		));
105
106		return true;
107		}
108
109		/**
110		* Get require
111		*
112		* @param string $packageName
113		* @param string $callback
114		* @param null $typeFilter
115		*/
116		public function foreachRequires($packageName, $callback, $typeFilter = null)
117		{
118		$info = $this->execInfo($packageName);
119		if (isset($info['requires'])) {
120		foreach ($info['requires'] as $name => $version) {
121		$package = $this->execInfo($name);
122		if (is_null($typeFilter) \|\| @$package['type'] === $typeFilter) {
123		$callback($package);
124		}
125		}
126		}
127		}
128
129		/**
130		* Run get config information
131		*
132		* @param string $key
133		* @param null $value
134		* @return array\|mixed
135		*/
136		public function execConfig($key, $value = null)
137		{
138		$commands = array(
139		'command' => 'config',
140		'setting-key' => $key,
141		'setting-value' => $value,
142		);
143		if ($value) {
144		$commands['setting-value'] = $value;
145		}
146		$output = $this->runCommand($commands);
147		$parser = new ParseOutputCommand($output, ParseOutputCommand::CONFIG_TYPE);
148
149		return $parser->parse();
150		}
151
152		/**
153		* Get config list
154		*
155		* @return array
156		*/
157	View Code Duplication	public function getConfig()
		0 ignored issues – show Duplication introduced 2017-11-09 10:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
158		{
159		$output = $this->runCommand(array(
160		'command' => 'config',
161		'--list' => true,
162		));
163		$parser = new ParseOutputCommand($output, ParseOutputCommand::LIST_TYPE);
164
165		return $parser->parse();
166		}
167
168		/**
169		* Set work dir
170		*
171		* @param string $workingDir
172		*/
173		public function setWorkingDir($workingDir)
174		{
175		$this->workingDir = $workingDir;
176		}
177
178		/**
179		* Run composer command
180		*
181		* @param array $commands
182		* @return string
183		*/
184		public function runCommand($commands)
185		{
186		$this->init();
187		$commands['--working-dir'] = $this->workingDir;
188		$commands['--no-ansi'] = 1;
189		$input = new ArrayInput($commands);
190		$output = new BufferedOutput();
191
192		$exitCode = $this->consoleApplication->run($input, $output);
193
194		$log = $output->fetch();
195		if ($exitCode) {
		0 ignored issues – show Bug Best Practice introduced 2017-11-09 10:42 UTC by Report Bug Copy Issue Report The expression `$exitCode` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
196		log_error($log);
197		throw new \RuntimeException($log);
198		}
199		log_info($log, $commands);
200
201		return $log;
202		}
203
204		/**
205		* Init composer console application
206		*/
207		private function init()
208		{
209		set_time_limit(0);
210		@ini_set('memory_limit', '1536M');
		0 ignored issues – show Security Best Practice introduced 2017-10-20 14:07 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...
211		// Config for some environment
212		putenv('COMPOSER_HOME='.$this->appConfig['plugin_realdir'].'/.composer');
213		$consoleApplication = new Application();
214		$consoleApplication->resetComposer();
215		$consoleApplication->setAutoExit(false);
216		$this->consoleApplication = $consoleApplication;
217		$this->workingDir = $this->workingDir ? $this->workingDir : $this->appConfig['root_dir'];
218		}
219		}
220

EC-CUBE / ec-cube

Pull Request — experimental/3.1 (#2619)

ComposerApiService::getConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like