Application::assertFileExists() - Code Metrics - Inspection of "Merge pull request #354 from owncloud/fix-297" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c0208a...6ad896 )

by Thomas

created 2016-08-19 11:16 UTC

Application::assertFileExists() A

↳ Parent: Application

Complexity

Conditions	3
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
ccs	0
cts	5
cp	0
rs	9.4285
cc	3
eloc	3
nc	2
nop	2
crap	12

<?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\Console;

use Owncloud\Updater\Utils\DocLink;
use Owncloud\Updater\Utils\Locator;
use Owncloud\Updater\Utils\OccRunner;
use Pimple\Container;
use Symfony\Component\Console\Logger\ConsoleLogger;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\StreamOutput;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Command\Command;
use \Symfony\Component\Process\Exception\ProcessFailedException;

/**
 * Class Application
 *
 * @package Owncloud\Updater\Console
 */
class Application extends \Symfony\Component\Console\Application {

	/** @var Container */
	public static $container;

	/** @var Container */
	protected $diContainer;

	/** @var ConsoleLogger */
	protected $fallbackLogger;

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

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

	/** @var array */
	protected $allowFailure = [
		'upgrade:executeCoreUpgradeScripts',
		'upgrade:checkpoint',
		'upgrade:maintenanceMode',
		'help',
		'list'
	];

	/**
	 * Pass Pimple container into application
	 * @param Container $container
	 */
	public function setContainer(Container $container){
		$this->diContainer = $container;
		self::$container = $container;
	}

	/**
	 * Get Pimple container
	 * @return Container
	 */
	public function getContainer(){
		return $this->diContainer;
	}

	/**
	 * @param string $endpoint
	 */
	public function setEndpoint($endpoint){
		$this->endpoint = $endpoint;
	}

	/**
	 * @return string
	 */
	public function getEndpoint(){
		return $this->endpoint;
	}

	/**
	 * @param $token
	 */
	public function setAuthToken($token){
		$this->authToken = $token;
	}

	/**
	 * @return string
	 */
	public function getAuthToken(){
		return $this->authToken;
	}

	/**
	 * Get logger instance
	 * @return \Psr\Log\LoggerInterface
	 */
	public function getLogger(){
		if (isset($this->diContainer['logger'])) {
			return $this->diContainer['logger'];
		}

		// Logger is not available yet, fallback to stdout
		if (is_null($this->fallbackLogger)){
			$output = new ConsoleOutput();
			$this->fallbackLogger = new ConsoleLogger($output);
		}

		return $this->fallbackLogger;
	}

	/**
	 * Log exception with trace
	 * @param \Exception $e
	 */
	public function logException($e){
		$buffer = new BufferedOutput(OutputInterface::VERBOSITY_VERBOSE);
		$this->renderException($e, $buffer);
		$this->getLogger()->error($buffer->fetch());
	}

	/**
	 * Runs the current application.
	 *
	 * @param InputInterface $input An Input instance
	 * @param OutputInterface $output An Output instance
	 * @return int 0 if everything went fine, or an error code
	 * @throws \Exception
	 */
	public function doRun(InputInterface $input, OutputInterface $output){
		try{
			$this->assertOwnCloudFound();
			$configReader = $this->diContainer['utils.configReader'];
			$commandName = $this->getCommandName($input);
			try{
				$configReader->init();
				if (!isset($this->diContainer['utils.docLink'])) {
					$this->diContainer['utils.docLink'] = function ($c) {
						$locator = $c['utils.locator'];
						$installedVersion = implode('.', $locator->getInstalledVersion());
						return new DocLink($installedVersion);
					};
				}
			} catch (ProcessFailedException $e){
				if (!in_array($commandName, $this->allowFailure)){
					$this->logException($e);
					$output->writeln("<error>Initialization failed with message:</error>");
					$output->writeln($e->getProcess()->getOutput());
					$output->writeln('<info>Use upgrade:checkpoint --list to view a list of checkpoints</info>');
					$output->writeln('<info>upgrade:checkpoint --restore [checkpointid] to revert to the last checkpoint</info>');
					$output->writeln('Please attach your update.log to the issues you reporting.');
					return 1;
				}
			}
			// TODO: check if the current command needs a valid OC instance
			if (!isset($this->diContainer['logger'])) {
				$locator = $this->diContainer['utils.locator'];
				$this->initLogger($locator->getDataDir());
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
			}
			
			return parent::doRun($input, $output);
		} catch (\Exception $e){
			$this->logException($e);
			throw $e;
		}
	}

	/**
	 * @param Command $command
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 * @return int
	 * @throws \Exception
	 */
	protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output){
		if ($command instanceof \Owncloud\Updater\Command\Command){
			$command->setContainer($this->getContainer());
			$commandName = $this->getCommandName($input);
			$this->getLogger()->info('Execution of ' . $commandName . ' command started');
			if (!empty($command->getMessage())){
				$message = sprintf('<info>%s</info>', $command->getMessage());
				$output->writeln($message);
			}
			$exitCode = parent::doRunCommand($command, $input, $output);
			$this->getLogger()->info(
					'Execution of ' . $commandName . ' command stopped. Exit code is ' . $exitCode
			);
		} else {
			$exitCode = parent::doRunCommand($command, $input, $output);
		}
		return $exitCode;
	}

	/**
	 * @param string $baseDir
	 */
	protected function initLogger($baseDir){
		$container = $this->getContainer();
		$container['logger.output'] = function($c) use ($baseDir) {

			$stream = @fopen($baseDir . '/update.log', 'a+');
			if ($stream === false){
				$stream = @fopen('php://stderr', 'a');
			}
			return new StreamOutput($stream, StreamOutput::VERBOSITY_DEBUG, false);
		};
		$container['logger'] = function($c){
			return new ConsoleLogger($c['logger.output']);
		};
	}

	/**
	 * Check for ownCloud instance
	 * @throws \RuntimeException
	 */
	public function assertOwnCloudFound(){
		$container = $this->getContainer();
		/** @var Locator $locator */
		$locator = $container['utils.locator'];
		$fsHelper = $container['utils.filesystemhelper'];
		/** @var OccRunner $occRunner */
		$occRunner = $container['utils.occrunner'];

		// has to be installed
		$file = $locator->getPathToConfigFile();
		$this->assertFileExists($file, 'ownCloud in ' . dirname(dirname($file)) . ' is not installed.');

		// version.php should exist
		$file = $locator->getPathToVersionFile();
		$this->assertFileExists($file, 'ownCloud is not found in ' . dirname($file));

		$status = $occRunner->runJson('status');
		if (!isset($status['installed'])  || $status['installed'] != 'true'){
			throw new \RuntimeException('ownCloud in ' . dirname($file) . ' is not installed.');
		}

		// datadir should exist
		$dataDir = $locator->getDataDir();
		if (!$fsHelper->fileExists($dataDir)){
			throw new \RuntimeException('Datadirectory ' . $dataDir . ' does not exist.');
		}

		// datadir should be writable
		if (!$fsHelper->isWritable($dataDir)){
			throw new \RuntimeException('Datadirectory ' . $dataDir . ' is not writable.');
		}

		// assert minimum version
		$installedVersion = implode('.', $locator->getInstalledVersion());
		if (version_compare($installedVersion, '9.0.0', '<')){
			throw new \RuntimeException("Minimum ownCloud version 9.0.0 is required for the updater - $installedVersion was found in " . $locator->getOwnCloudRootPath());
		}

		if (!$fsHelper->fileExists($locator->getUpdaterBaseDir())){
			$fsHelper->mkdir($locator->getUpdaterBaseDir());
		}

		if (!$fsHelper->fileExists($locator->getDownloadBaseDir())){
			$fsHelper->mkdir($locator->getDownloadBaseDir());
		}
		if (!$fsHelper->fileExists($locator->getCheckpointDir())){
			$fsHelper->mkdir($locator->getCheckpointDir());
		}
	}

	/**
	 * @param string $path
	 * @param string $message
	 */
	protected function assertFileExists($path, $message){
		if (!file_exists($path) || !is_file($path)){
			throw new \RuntimeException($message);
		}
	}
}


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\Console;
24
25			use Owncloud\Updater\Utils\DocLink;
26			use Owncloud\Updater\Utils\Locator;
27			use Owncloud\Updater\Utils\OccRunner;
28			use Pimple\Container;
29			use Symfony\Component\Console\Logger\ConsoleLogger;
30			use Symfony\Component\Console\Output\ConsoleOutput;
31			use Symfony\Component\Console\Output\StreamOutput;
32			use Symfony\Component\Console\Input\InputInterface;
33			use Symfony\Component\Console\Output\BufferedOutput;
34			use Symfony\Component\Console\Output\OutputInterface;
35			use Symfony\Component\Console\Command\Command;
36			use \Symfony\Component\Process\Exception\ProcessFailedException;
37
38			/**
39			* Class Application
40			*
41			* @package Owncloud\Updater\Console
42			*/
43			class Application extends \Symfony\Component\Console\Application {
44
45			/** @var Container */
46			public static $container;
47
48			/** @var Container */
49			protected $diContainer;
50
51			/** @var ConsoleLogger */
52			protected $fallbackLogger;
53
54			/** @var string */
55			protected $endpoint;
56
57			/** @var string */
58			protected $authToken;
59
60			/** @var array */
61			protected $allowFailure = [
62			'upgrade:executeCoreUpgradeScripts',
63			'upgrade:checkpoint',
64			'upgrade:maintenanceMode',
65			'help',
66			'list'
67			];
68
69			/**
70			* Pass Pimple container into application
71			* @param Container $container
72			*/
73			public function setContainer(Container $container){
74			$this->diContainer = $container;
75			self::$container = $container;
76			}
77
78			/**
79			* Get Pimple container
80			* @return Container
81			*/
82			public function getContainer(){
83			return $this->diContainer;
84			}
85
86			/**
87			* @param string $endpoint
88			*/
89			public function setEndpoint($endpoint){
90			$this->endpoint = $endpoint;
91			}
92
93			/**
94			* @return string
95			*/
96			public function getEndpoint(){
97			return $this->endpoint;
98			}
99
100			/**
101			* @param $token
102			*/
103			public function setAuthToken($token){
104			$this->authToken = $token;
105			}
106
107			/**
108			* @return string
109			*/
110			public function getAuthToken(){
111			return $this->authToken;
112			}
113
114			/**
115			* Get logger instance
116			* @return \Psr\Log\LoggerInterface
117			*/
118			public function getLogger(){
119			if (isset($this->diContainer['logger'])) {
120			return $this->diContainer['logger'];
121			}
122
123			// Logger is not available yet, fallback to stdout
124			if (is_null($this->fallbackLogger)){
125			$output = new ConsoleOutput();
126			$this->fallbackLogger = new ConsoleLogger($output);
127			}
128
129			return $this->fallbackLogger;
130			}
131
132			/**
133			* Log exception with trace
134			* @param \Exception $e
135			*/
136			public function logException($e){
137			$buffer = new BufferedOutput(OutputInterface::VERBOSITY_VERBOSE);
138			$this->renderException($e, $buffer);
139			$this->getLogger()->error($buffer->fetch());
140			}
141
142			/**
143			* Runs the current application.
144			*
145			* @param InputInterface $input An Input instance
146			* @param OutputInterface $output An Output instance
147			* @return int 0 if everything went fine, or an error code
148			* @throws \Exception
149			*/
150			public function doRun(InputInterface $input, OutputInterface $output){
151			try{
152			$this->assertOwnCloudFound();
153			$configReader = $this->diContainer['utils.configReader'];
154			$commandName = $this->getCommandName($input);
155			try{
156			$configReader->init();
157			if (!isset($this->diContainer['utils.docLink'])) {
158			$this->diContainer['utils.docLink'] = function ($c) {
159			$locator = $c['utils.locator'];
160			$installedVersion = implode('.', $locator->getInstalledVersion());
161			return new DocLink($installedVersion);
162			};
163			}
164			} catch (ProcessFailedException $e){
165			if (!in_array($commandName, $this->allowFailure)){
166			$this->logException($e);
167			$output->writeln("<error>Initialization failed with message:</error>");
168			$output->writeln($e->getProcess()->getOutput());
169			$output->writeln('<info>Use upgrade:checkpoint --list to view a list of checkpoints</info>');
170			$output->writeln('<info>upgrade:checkpoint --restore [checkpointid] to revert to the last checkpoint</info>');
171			$output->writeln('Please attach your update.log to the issues you reporting.');
172			return 1;
173			}
174			}
175			// TODO: check if the current command needs a valid OC instance
176			if (!isset($this->diContainer['logger'])) {
177			$locator = $this->diContainer['utils.locator'];
178			$this->initLogger($locator->getDataDir());
			0 ignored issues – show Unused Code introduced 2016-05-26 20:53 UTC by Report Bug Copy Issue Report The call to the method `Owncloud\Updater\Console\Application::initLogger()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
179			}
180
181			return parent::doRun($input, $output);
182			} catch (\Exception $e){
183			$this->logException($e);
184			throw $e;
185			}
186			}
187
188			/**
189			* @param Command $command
190			* @param InputInterface $input
191			* @param OutputInterface $output
192			* @return int
193			* @throws \Exception
194			*/
195			protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output){
196			if ($command instanceof \Owncloud\Updater\Command\Command){
197			$command->setContainer($this->getContainer());
198			$commandName = $this->getCommandName($input);
199			$this->getLogger()->info('Execution of ' . $commandName . ' command started');
200			if (!empty($command->getMessage())){
201			$message = sprintf('<info>%s</info>', $command->getMessage());
202			$output->writeln($message);
203			}
204			$exitCode = parent::doRunCommand($command, $input, $output);
205			$this->getLogger()->info(
206			'Execution of ' . $commandName . ' command stopped. Exit code is ' . $exitCode
207			);
208			} else {
209			$exitCode = parent::doRunCommand($command, $input, $output);
210			}
211			return $exitCode;
212			}
213
214			/**
215			* @param string $baseDir
216			*/
217			protected function initLogger($baseDir){
218			$container = $this->getContainer();
219			$container['logger.output'] = function($c) use ($baseDir) {
			0 ignored issues – show Unused Code introduced 2016-04-14 17:59 UTC by Report Bug Copy Issue Report The parameter `$c` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
220			$stream = @fopen($baseDir . '/update.log', 'a+');
221			if ($stream === false){
222			$stream = @fopen('php://stderr', 'a');
223			}
224			return new StreamOutput($stream, StreamOutput::VERBOSITY_DEBUG, false);
225			};
226			$container['logger'] = function($c){
227			return new ConsoleLogger($c['logger.output']);
228			};
229			}
230
231			/**
232			* Check for ownCloud instance
233			* @throws \RuntimeException
234			*/
235			public function assertOwnCloudFound(){
236			$container = $this->getContainer();
237			/** @var Locator $locator */
238			$locator = $container['utils.locator'];
239			$fsHelper = $container['utils.filesystemhelper'];
240			/** @var OccRunner $occRunner */
241			$occRunner = $container['utils.occrunner'];
242
243			// has to be installed
244			$file = $locator->getPathToConfigFile();
245			$this->assertFileExists($file, 'ownCloud in ' . dirname(dirname($file)) . ' is not installed.');
246
247			// version.php should exist
248			$file = $locator->getPathToVersionFile();
249			$this->assertFileExists($file, 'ownCloud is not found in ' . dirname($file));
250
251			$status = $occRunner->runJson('status');
252			if (!isset($status['installed']) \|\| $status['installed'] != 'true'){
253			throw new \RuntimeException('ownCloud in ' . dirname($file) . ' is not installed.');
254			}
255
256			// datadir should exist
257			$dataDir = $locator->getDataDir();
258			if (!$fsHelper->fileExists($dataDir)){
259			throw new \RuntimeException('Datadirectory ' . $dataDir . ' does not exist.');
260			}
261
262			// datadir should be writable
263			if (!$fsHelper->isWritable($dataDir)){
264			throw new \RuntimeException('Datadirectory ' . $dataDir . ' is not writable.');
265			}
266
267			// assert minimum version
268			$installedVersion = implode('.', $locator->getInstalledVersion());
269			if (version_compare($installedVersion, '9.0.0', '<')){
270			throw new \RuntimeException("Minimum ownCloud version 9.0.0 is required for the updater - $installedVersion was found in " . $locator->getOwnCloudRootPath());
271			}
272
273			if (!$fsHelper->fileExists($locator->getUpdaterBaseDir())){
274			$fsHelper->mkdir($locator->getUpdaterBaseDir());
275			}
276
277			if (!$fsHelper->fileExists($locator->getDownloadBaseDir())){
278			$fsHelper->mkdir($locator->getDownloadBaseDir());
279			}
280			if (!$fsHelper->fileExists($locator->getCheckpointDir())){
281			$fsHelper->mkdir($locator->getCheckpointDir());
282			}
283			}
284
285			/**
286			* @param string $path
287			* @param string $message
288			*/
289			protected function assertFileExists($path, $message){
290			if (!file_exists($path) \|\| !is_file($path)){
291			throw new \RuntimeException($message);
292			}
293			}
294			}
295

owncloud / updater

Push — master ( c0208a...6ad896 )

Application::assertFileExists() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like