ExecuteCoreUpgradeScriptsCommand::isUpgradeAllowed() - Code Metrics - Inspection of "Bump symfony/process from 2.8.11 to 4.0.4" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#460)

unknown

created 2018-01-30 00:12 UTC

isUpgradeAllowed() A

↳ Parent: ExecuteCoreUpgradeScriptsCommand

Complexity

Conditions	4
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.2
cc	4
eloc	6
nc	3
nop	3
crap	4

<?php

/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\Command;

use Owncloud\Updater\Utils\Checkpoint;
use Owncloud\Updater\Utils\FilesystemHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\Exception\ProcessFailedException;
use Owncloud\Updater\Utils\OccRunner;
use Owncloud\Updater\Utils\ZipExtractor;

/**
 * Class ExecuteCoreUpgradeScriptsCommand
 *
 * @package Owncloud\Updater\Command
 */
class ExecuteCoreUpgradeScriptsCommand extends Command {

	/**
	 * @var OccRunner $occRunner
	 */
	protected $occRunner;

	/**
	 * ExecuteCoreUpgradeScriptsCommand constructor.
	 *
	 * @param null|string $occRunner
	 */
	public function __construct($occRunner){
		parent::__construct();
		$this->occRunner = $occRunner;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
	}

	protected function configure(){
		$this
				->setName('upgrade:executeCoreUpgradeScripts')
				->setDescription('execute core upgrade scripts [danger, might take long]');
	}

	/**
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 * @throws \Exception
	 */
	protected function execute(InputInterface $input, OutputInterface $output){
		$locator = $this->container['utils.locator'];
		/** @var FilesystemHelper $fsHelper */
		$fsHelper = $this->container['utils.filesystemhelper'];
		$registry = $this->container['utils.registry'];
		$fetcher = $this->container['utils.fetcher'];
		/** @var Checkpoint $checkpoint */
		$checkpoint = $this->container['utils.checkpoint'];

		$installedVersion = implode('.', $locator->getInstalledVersion());
		$registry->set('installedVersion', $installedVersion);

		/** @var  \Owncloud\Updater\Utils\Feed $feed */
		$feed = $registry->get('feed');

		if ($feed){
			$path = $fetcher->getBaseDownloadPath($feed);
			$fullExtractionPath = $locator->getExtractionBaseDir() . '/' . $feed->getVersion();

			if (file_exists($fullExtractionPath)){
				$fsHelper->removeIfExists($fullExtractionPath);
			}
			try{
				$fsHelper->mkdir($fullExtractionPath, true);
			} catch (\Exception $e){
					$output->writeln('Unable create directory ' . $fullExtractionPath);
					throw $e;
			}

			$output->writeln('Extracting source into ' . $fullExtractionPath);
			$extractor = new ZipExtractor($path, $fullExtractionPath, $output);

			try{
				$extractor->extract();
			} catch (\Exception $e){
				$output->writeln('Extraction has been failed');
				$fsHelper->removeIfExists($locator->getExtractionBaseDir());
				throw $e;
			}

			$tmpDir = $locator->getExtractionBaseDir() . '/' . $installedVersion;
			$fsHelper->removeIfExists($tmpDir);
			$fsHelper->mkdir($tmpDir);
			$oldSourcesDir = $locator->getOwncloudRootPath();
			$newSourcesDir = $fullExtractionPath . '/owncloud';

			$packageVersion = $this->loadVersion($newSourcesDir);
			$allowedPreviousVersions = $this->loadAllowedPreviousVersions($newSourcesDir);

			if (!$this->isUpgradeAllowed($installedVersion, $packageVersion, $allowedPreviousVersions)){
				$message = sprintf(
					'Update from %s to %s is not possible. Updates between multiple major versions and downgrades are unsupported.',
					$installedVersion,
					$packageVersion
				);
				$this->getApplication()->getLogger()->error($message);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				$output->writeln('<error>'. $message .'</error>');
				return 1;
			}

			foreach ($locator->getRootDirContent() as $dir){
				$this->getApplication()->getLogger()->debug('Replacing ' . $dir);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
				$fsHelper->tripleMove($oldSourcesDir, $newSourcesDir, $tmpDir, $dir);
			}
			
			$fsHelper->copyr($tmpDir . '/config/config.php', $oldSourcesDir . '/config/config.php');

			//Remove old apps
			$appDirectories = $fsHelper->scandirFiltered($oldSourcesDir . '/apps');
			foreach ($appDirectories as $appDirectory){
				$fsHelper->rmdirr($oldSourcesDir . '/apps/' . $appDirectory);
			}

			//Put new shipped apps
			$newAppsDir = $fullExtractionPath . '/owncloud/apps';
			$newAppsList = $fsHelper->scandirFiltered($newAppsDir);
			foreach ($newAppsList as $appId){
				$output->writeln('Copying the application ' . $appId);
				$fsHelper->copyr($newAppsDir . '/' . $appId, $locator->getOwnCloudRootPath() . '/apps/' . $appId, false);
			}
			
			try {
				$plain = $this->occRunner->run('upgrade');
				$output->writeln($plain);
			} catch (ProcessFailedException $e){
				$lastCheckpointId = $checkpoint->getLastCheckpointId();
				if ($lastCheckpointId){
					$lastCheckpointPath = $checkpoint->getCheckpointPath($lastCheckpointId);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
					$fsHelper->copyr($lastCheckpointPath . '/apps', $oldSourcesDir . '/apps', false);
				}
				if ($e->getProcess()->getExitCode() != 3){
					throw ($e);
				}
			}
		}
	}

	public function isUpgradeAllowed($installedVersion, $packageVersion, $canBeUpgradedFrom){
		if (version_compare($installedVersion, $packageVersion, '<=')){
			foreach ($canBeUpgradedFrom as $allowedPreviousVersion){
				if (version_compare($allowedPreviousVersion, $installedVersion, '<=')){
					return true;
				}
			}
		}
		return false;
	}

	/**
	 * @param string $pathToPackage
	 * @return string
	 */
	protected function loadVersion($pathToPackage){
		require  $pathToPackage . '/version.php';
		/** @var $OC_Version array */
		return implode('.', $OC_Version);

	}

	/**
	 * @param string $pathToPackage
	 * @return string[]
	 */
	protected function loadAllowedPreviousVersions($pathToPackage) {
		$canBeUpgradedFrom = $this->loadCanBeUpgradedFrom($pathToPackage);
		
		$firstItem = reset($canBeUpgradedFrom);
		if (!is_array($firstItem)){
			$canBeUpgradedFrom = [$canBeUpgradedFrom];
		}
		
		$allowedVersions = [];
		foreach ($canBeUpgradedFrom as $version){
			$allowedVersions[] = implode('.', $version);
		}

		return $allowedVersions;
	}
	
	/**
	 * @param string $pathToPackage
	 * @return array
	 */
	protected function loadCanBeUpgradedFrom($pathToPackage){
		require $pathToPackage . '/version.php';
		/** @var array $OC_VersionCanBeUpgradedFrom */
		return $OC_VersionCanBeUpgradedFrom;

	}
}


Pull Request — master (#460)

isUpgradeAllowed() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* @author Victor Dubiniuk <[email protected]>
5		*
6		* @copyright Copyright (c) 2015, ownCloud, Inc.
7		* @license AGPL-3.0
8		*
9		* This code is free software: you can redistribute it and/or modify
10		* it under the terms of the GNU Affero General Public License, version 3,
11		* as published by the Free Software Foundation.
12		*
13		* This program is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU Affero General Public License for more details.
17		*
18		* You should have received a copy of the GNU Affero General Public License, version 3,
19		* along with this program. If not, see <http://www.gnu.org/licenses/>
20		*
21		*/
22
23		namespace Owncloud\Updater\Command;
24
25		use Owncloud\Updater\Utils\Checkpoint;
26		use Owncloud\Updater\Utils\FilesystemHelper;
27		use Symfony\Component\Console\Input\InputInterface;
28		use Symfony\Component\Console\Output\OutputInterface;
29		use Symfony\Component\Process\Exception\ProcessFailedException;
30		use Owncloud\Updater\Utils\OccRunner;
31		use Owncloud\Updater\Utils\ZipExtractor;
32
33		/**
34		* Class ExecuteCoreUpgradeScriptsCommand
35		*
36		* @package Owncloud\Updater\Command
37		*/
38		class ExecuteCoreUpgradeScriptsCommand extends Command {
39
40		/**
41		* @var OccRunner $occRunner
42		*/
43		protected $occRunner;
44
45		/**
46		* ExecuteCoreUpgradeScriptsCommand constructor.
47		*
48		* @param null\|string $occRunner
49		*/
50		public function __construct($occRunner){
51		parent::__construct();
52		$this->occRunner = $occRunner;
		0 ignored issues – show Documentation Bug introduced 2016-08-18 18:18 UTC by Report Bug Copy Issue Report It seems like `$occRunner` can also be of type `string`. However, the property `$occRunner` is declared as type `object<Owncloud\Updater\Utils\OccRunner>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
53		}
54
55		protected function configure(){
56		$this
57		->setName('upgrade:executeCoreUpgradeScripts')
58		->setDescription('execute core upgrade scripts [danger, might take long]');
59		}
60
61		/**
62		* @param InputInterface $input
63		* @param OutputInterface $output
64		* @throws \Exception
65		*/
66		protected function execute(InputInterface $input, OutputInterface $output){
67		$locator = $this->container['utils.locator'];
68		/** @var FilesystemHelper $fsHelper */
69		$fsHelper = $this->container['utils.filesystemhelper'];
70		$registry = $this->container['utils.registry'];
71		$fetcher = $this->container['utils.fetcher'];
72		/** @var Checkpoint $checkpoint */
73		$checkpoint = $this->container['utils.checkpoint'];
74
75		$installedVersion = implode('.', $locator->getInstalledVersion());
76		$registry->set('installedVersion', $installedVersion);
77
78		/** @var \Owncloud\Updater\Utils\Feed $feed */
79		$feed = $registry->get('feed');
80
81		if ($feed){
82		$path = $fetcher->getBaseDownloadPath($feed);
83		$fullExtractionPath = $locator->getExtractionBaseDir() . '/' . $feed->getVersion();
84
85		if (file_exists($fullExtractionPath)){
86		$fsHelper->removeIfExists($fullExtractionPath);
87		}
88		try{
89		$fsHelper->mkdir($fullExtractionPath, true);
90		} catch (\Exception $e){
91		$output->writeln('Unable create directory ' . $fullExtractionPath);
92		throw $e;
93		}
94
95		$output->writeln('Extracting source into ' . $fullExtractionPath);
96		$extractor = new ZipExtractor($path, $fullExtractionPath, $output);
97
98		try{
99		$extractor->extract();
100		} catch (\Exception $e){
101		$output->writeln('Extraction has been failed');
102		$fsHelper->removeIfExists($locator->getExtractionBaseDir());
103		throw $e;
104		}
105
106		$tmpDir = $locator->getExtractionBaseDir() . '/' . $installedVersion;
107		$fsHelper->removeIfExists($tmpDir);
108		$fsHelper->mkdir($tmpDir);
109		$oldSourcesDir = $locator->getOwncloudRootPath();
110		$newSourcesDir = $fullExtractionPath . '/owncloud';
111
112		$packageVersion = $this->loadVersion($newSourcesDir);
113		$allowedPreviousVersions = $this->loadAllowedPreviousVersions($newSourcesDir);
114
115		if (!$this->isUpgradeAllowed($installedVersion, $packageVersion, $allowedPreviousVersions)){
116		$message = sprintf(
117		'Update from %s to %s is not possible. Updates between multiple major versions and downgrades are unsupported.',
118		$installedVersion,
119		$packageVersion
120		);
121		$this->getApplication()->getLogger()->error($message);
		0 ignored issues – show Bug introduced 2016-12-06 15:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getLogger()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Owncloud\Updater\Console\Application`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
122		$output->writeln('<error>'. $message .'</error>');
123		return 1;
124		}
125
126		foreach ($locator->getRootDirContent() as $dir){
127		$this->getApplication()->getLogger()->debug('Replacing ' . $dir);
		0 ignored issues – show Bug introduced 2016-01-08 18:46 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getLogger()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Owncloud\Updater\Console\Application`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
128		$fsHelper->tripleMove($oldSourcesDir, $newSourcesDir, $tmpDir, $dir);
129		}
130
131		$fsHelper->copyr($tmpDir . '/config/config.php', $oldSourcesDir . '/config/config.php');
132
133		//Remove old apps
134		$appDirectories = $fsHelper->scandirFiltered($oldSourcesDir . '/apps');
135		foreach ($appDirectories as $appDirectory){
136		$fsHelper->rmdirr($oldSourcesDir . '/apps/' . $appDirectory);
137		}
138
139		//Put new shipped apps
140		$newAppsDir = $fullExtractionPath . '/owncloud/apps';
141		$newAppsList = $fsHelper->scandirFiltered($newAppsDir);
142		foreach ($newAppsList as $appId){
143		$output->writeln('Copying the application ' . $appId);
144		$fsHelper->copyr($newAppsDir . '/' . $appId, $locator->getOwnCloudRootPath() . '/apps/' . $appId, false);
145		}
146
147		try {
148		$plain = $this->occRunner->run('upgrade');
149		$output->writeln($plain);
150		} catch (ProcessFailedException $e){
151		$lastCheckpointId = $checkpoint->getLastCheckpointId();
152		if ($lastCheckpointId){
153		$lastCheckpointPath = $checkpoint->getCheckpointPath($lastCheckpointId);
		0 ignored issues – show Bug introduced 2016-05-03 17:15 UTC by Report Bug Copy Issue Report It seems like `$lastCheckpointId` defined by `$checkpoint->getLastCheckpointId()` on line `151` can also be of type `boolean`; however, `Owncloud\Updater\Utils\C...nt::getCheckpointPath()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
154		$fsHelper->copyr($lastCheckpointPath . '/apps', $oldSourcesDir . '/apps', false);
155		}
156		if ($e->getProcess()->getExitCode() != 3){
157		throw ($e);
158		}
159		}
160		}
161		}
162
163	8	public function isUpgradeAllowed($installedVersion, $packageVersion, $canBeUpgradedFrom){
164	8	if (version_compare($installedVersion, $packageVersion, '<=')){
165	5	foreach ($canBeUpgradedFrom as $allowedPreviousVersion){
166	5	if (version_compare($allowedPreviousVersion, $installedVersion, '<=')){
167	5	return true;
168		}
169		}
170		}
171	3	return false;
172		}
173
174		/**
175		* @param string $pathToPackage
176		* @return string
177		*/
178		protected function loadVersion($pathToPackage){
179		require $pathToPackage . '/version.php';
180		/** @var $OC_Version array */
181		return implode('.', $OC_Version);
		0 ignored issues – show Bug introduced 2016-12-06 15:27 UTC by Report Bug Copy Issue Report The variable `$OC_Version` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
182		}
183
184		/**
185		* @param string $pathToPackage
186		* @return string[]
187		*/
188	2	protected function loadAllowedPreviousVersions($pathToPackage) {
189	2	$canBeUpgradedFrom = $this->loadCanBeUpgradedFrom($pathToPackage);
190
191	2	$firstItem = reset($canBeUpgradedFrom);
192	2	if (!is_array($firstItem)){
193	1	$canBeUpgradedFrom = [$canBeUpgradedFrom];
194		}
195
196	2	$allowedVersions = [];
197	2	foreach ($canBeUpgradedFrom as $version){
198	2	$allowedVersions[] = implode('.', $version);
199		}
200
201	2	return $allowedVersions;
202		}
203
204		/**
205		* @param string $pathToPackage
206		* @return array
207		*/
208		protected function loadCanBeUpgradedFrom($pathToPackage){
209		require $pathToPackage . '/version.php';
210		/** @var array $OC_VersionCanBeUpgradedFrom */
211		return $OC_VersionCanBeUpgradedFrom;
		0 ignored issues – show Bug introduced 2017-05-26 18:02 UTC by Report Bug Copy Issue Report The variable `$OC_VersionCanBeUpgradedFrom` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
212		}
213		}
214

owncloud / updater

Pull Request — master (#460)

isUpgradeAllowed() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like