Application::getLogger() - Code Metrics - Inspection of "Check if configReader exist first" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#246)

by Victor

created 2016-02-16 17:01 UTC

Application::getLogger() A

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?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\Locator;
use Pimple\Container;
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 extends \Symfony\Component\Console\Application {

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

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

	/** @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;
	}

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

	/**
	 * 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());
	}

	public function doRun(InputInterface $input, OutputInterface $output){
		if (!($this->diContainer['logger.output'] instanceof StreamOutput)){
			$output->writeln('[Warning] Failed to init logger. Logging is disabled.');
			$output->writeln(CURRENT_DIR . ' is not writable');
		}
		try{
			$configReader = $this->diContainer['utils.configReader'];
			$commandName = $this->getCommandName($input);

			try{
				$configReader->init();
			} 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
			$this->assertOwnCloudFound();
			
			return parent::doRun($input, $output);
		} catch (\Exception $e){
			$this->logException($e);
			throw $e;
		}
	}

	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;
	}

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

		// 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());
		}

		// has to be installed
		$file = $locator->getPathToConfigFile();
		if (!file_exists($file) || !is_file($file)){

			throw new \RuntimeException('ownCloud in ' . dirname(dirname($file)) . ' is not installed.');
		}

		// version.php should exist
		$file = $locator->getPathToVersionFile();
		if (!file_exists($file) || !is_file($file)){

			throw new \RuntimeException('ownCloud is not found in ' . dirname($file));
		}

		// 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.');
		}

		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());
		}
	}

}


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\Locator;
26		use Pimple\Container;
27		use Symfony\Component\Console\Output\StreamOutput;
28		use Symfony\Component\Console\Input\InputInterface;
29		use Symfony\Component\Console\Output\BufferedOutput;
30		use Symfony\Component\Console\Output\OutputInterface;
31		use Symfony\Component\Console\Command\Command;
32		use \Symfony\Component\Process\Exception\ProcessFailedException;
33
34		class Application extends \Symfony\Component\Console\Application {
35
36		/** @var Container */
37		public static $container;
38
39		/** @var Container */
40		protected $diContainer;
41
42		/** @var array */
43		protected $allowFailure = [
44		'upgrade:executeCoreUpgradeScripts',
45		'upgrade:checkpoint',
46		'upgrade:maintenanceMode',
47		'help',
48		'list'
49		];
50
51		/**
52		* Pass Pimple container into application
53		* @param Container $container
54		*/
55		public function setContainer(Container $container){
56		$this->diContainer = $container;
57		self::$container = $container;
58		}
59
60		/**
61		* Get Pimple container
62		* @return Container
63		*/
64		public function getContainer(){
65		return $this->diContainer;
66		}
67
68		/**
69		* Get logger instance
70		* @return \Psr\Log\LoggerInterface
71		*/
72		public function getLogger(){
73		return $this->diContainer['logger'];
74		}
75
76		/**
77		* Log exception with trace
78		* @param \Exception $e
79		*/
80		public function logException($e){
81		$buffer = new BufferedOutput(OutputInterface::VERBOSITY_VERBOSE);
82		$this->renderException($e, $buffer);
83		$this->getLogger()->error($buffer->fetch());
84		}
85
86		public function doRun(InputInterface $input, OutputInterface $output){
87		if (!($this->diContainer['logger.output'] instanceof StreamOutput)){
88		$output->writeln('[Warning] Failed to init logger. Logging is disabled.');
89		$output->writeln(CURRENT_DIR . ' is not writable');
90		}
91		try{
92		$configReader = $this->diContainer['utils.configReader'];
93		$commandName = $this->getCommandName($input);
94
95		try{
96		$configReader->init();
97		} catch (ProcessFailedException $e){
98		if (!in_array($commandName, $this->allowFailure)){
99		$this->logException($e);
100		$output->writeln("<error>Initialization failed with message:</error>");
101		$output->writeln($e->getProcess()->getOutput());
102		$output->writeln('<info>Use upgrade:checkpoint --list to view a list of checkpoints</info>');
103		$output->writeln('<info>upgrade:checkpoint --restore [checkpointid] to revert to the last checkpoint</info>');
104		$output->writeln('Please attach your update.log to the issues you reporting.');
105		return 1;
106		}
107		}
108		// TODO: check if the current command needs a valid OC instance
109		$this->assertOwnCloudFound();
110
111		return parent::doRun($input, $output);
112		} catch (\Exception $e){
113		$this->logException($e);
114		throw $e;
115		}
116		}
117
118		protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output){
119		if ($command instanceof \Owncloud\Updater\Command\Command){
120		$command->setContainer($this->getContainer());
121		$commandName = $this->getCommandName($input);
122		$this->getLogger()->info('Execution of ' . $commandName . ' command started');
123		if (!empty($command->getMessage())){
124		$message = sprintf('<info>%s</info>', $command->getMessage());
125		$output->writeln($message);
126		}
127		$exitCode = parent::doRunCommand($command, $input, $output);
128		$this->getLogger()->info(
129		'Execution of ' . $commandName . ' command stopped. Exit code is ' . $exitCode
130		);
131		} else {
132		$exitCode = parent::doRunCommand($command, $input, $output);
133		}
134		return $exitCode;
135		}
136
137		/**
138		* Check for owncloud instance
139		* @throws \RuntimeException
140		*/
141		protected function assertOwnCloudFound(){
142		$container = $this->getContainer();
143		/** @var Locator $locator */
144		$locator = $container['utils.locator'];
145		$fsHelper = $container['utils.filesystemhelper'];
146
147		// assert minimum version
148		$installedVersion = implode('.', $locator->getInstalledVersion());
149		if (version_compare($installedVersion, '9.0.0', '<')){
150		throw new \RuntimeException("Minimum ownCloud version 9.0.0 is required for the updater - $installedVersion was found in " . $locator->getOwncloudRootPath());
151		}
152
153		// has to be installed
154		$file = $locator->getPathToConfigFile();
155	View Code Duplication	if (!file_exists($file) \|\| !is_file($file)){
		0 ignored issues – show Duplication introduced 2016-02-15 21:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
156		throw new \RuntimeException('ownCloud in ' . dirname(dirname($file)) . ' is not installed.');
157		}
158
159		// version.php should exist
160		$file = $locator->getPathToVersionFile();
161	View Code Duplication	if (!file_exists($file) \|\| !is_file($file)){
		0 ignored issues – show Duplication introduced 2016-02-15 21:02 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
162		throw new \RuntimeException('ownCloud is not found in ' . dirname($file));
163		}
164
165		// datadir should exist
166		$dataDir = $locator->getDataDir();
167		if (!$fsHelper->fileExists($dataDir)){
168		throw new \RuntimeException('Datadirectory ' . $dataDir . ' does not exist.');
169		}
170
171		// datadir should be writable
172		if (!$fsHelper->isWritable($dataDir)){
173		throw new \RuntimeException('Datadirectory ' . $dataDir . ' is not writable.');
174		}
175
176		if (!$fsHelper->fileExists($locator->getUpdaterBaseDir())){
177		$fsHelper->mkdir($locator->getUpdaterBaseDir());
178		}
179
180		if (!$fsHelper->fileExists($locator->getDownloadBaseDir())){
181		$fsHelper->mkdir($locator->getDownloadBaseDir());
182		}
183		if (!$fsHelper->fileExists($locator->getCheckpointDir())){
184		$fsHelper->mkdir($locator->getCheckpointDir());
185		}
186		}
187
188		}
189

owncloud / updater

Pull Request — master (#246)

Application::getLogger() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like