SystemConfig::getValue() - Code Metrics - Inspection of "Merge pull request #31989 from owncloud/oracle_cac..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 48eed4...615ba7 )

unknown

created 2018-07-05 10:03 UTC

SystemConfig::getValue() A

↳ Parent: SystemConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	2
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * @author Joas Schilling <[email protected]>
 * @author Jonathan Kawohl <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @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 OC;

use OCP\IConfig;

/**
 * Class which provides access to the system config values stored in config.php
 * Internal class for bootstrap only.
 * fixes cyclic DI: AllConfig needs AppConfig needs Database needs AllConfig
 */
class SystemConfig {

	/** @var array */
	protected $sensitiveValues = [
		'dbpassword' => true,
		'dbuser' => true,
		'mail_smtpname' => true,
		'mail_smtppassword' => true,
		'mail_from_address' => true,
		'mail_domain' => true,
		'mail_smtphost' => true,
		'passwordsalt' => true,
		'secret' => true,
		'updater.secret' => true,
		'ldap_agent_password' => true,
		'proxyuserpwd' => true,
		'marketplace.key' => true,
		'log.condition' => [
			[
			'shared_secret' => true,
			]
		],
		'log.conditions' => [
			[
			'shared_secret' => true,
			]
		],
		'license-key' => true,
		'redis' => [
			'password' => true,
		],
		'objectstore' => [
			'arguments' => [
				'password' => true,
				'options' => [
					'credentials' =>[
						'key' => true,
						'secret' => true,
					],
				],
			],
		],
	];
	/** @var Config */
	private $config;

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

	/**
	 * Lists all available config keys
	 * @return array an array of key names
	 */
	public function getKeys() {
		return $this->config->getKeys();
	}

	/**
	 * Sets a new system wide value
	 *
	 * @param string $key the key of the value, under which will be saved
	 * @param mixed $value the value that should be stored
	 */
	public function setValue($key, $value) {
		$this->config->setValue($key, $value);
	}

	/**
	 * Sets and deletes values and writes the config.php
	 *
	 * @param array $configs Associative array with `key => value` pairs
	 *                       If value is null, the config key will be deleted
	 */
	public function setValues(array $configs) {
		$this->config->setValues($configs);
	}

	/**
	 * Looks up a system wide defined value
	 *
	 * @param string $key the key of the value, under which it was saved
	 * @param mixed $default the default value to be returned if the value isn't set
	 * @return mixed the value or $default
	 */
	public function getValue($key, $default = '') {
		return $this->config->getValue($key, $default);
	}

	/**
	 * Looks up a system wide defined value and filters out sensitive data
	 *
	 * @param string $key the key of the value, under which it was saved
	 * @param mixed $default the default value to be returned if the value isn't set
	 * @return mixed the value or $default
	 */
	public function getFilteredValue($key, $default = '') {
		$value = $this->getValue($key, $default);

		if (isset($this->sensitiveValues[$key])) {
			$value = $this->removeSensitiveValue($this->sensitiveValues[$key], $value);
		}

		return $value;
	}

	/**
	 * Delete a system wide defined value
	 *
	 * @param string $key the key of the value, under which it was saved
	 */
	public function deleteValue($key) {
		$this->config->deleteKey($key);
	}

	/**
	 * @param bool|array $keysToRemove
	 * @param mixed $value
	 * @return mixed
	 */
	protected function removeSensitiveValue($keysToRemove, $value) {
		if ($keysToRemove === true) {
			return IConfig::SENSITIVE_VALUE;
		}

		if (\is_array($value)) {
			foreach ($keysToRemove as $keyToRemove => $valueToRemove) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
				if ($keyToRemove === 0) {
					/*
					 * The 0 key in keysToRemove indicates a possibly repeating
					 * array of actual entries 0,1,2,3...
					 * Remove any sensitive values from all actual entries.
					 */
					foreach ($value as $valueKey => $valueData) {
						if (\is_int($valueKey) && ($valueKey >= 0)) {
							$value[$valueKey] = $this->removeSensitiveValue($valueToRemove, $value[$valueKey]);
						}
					}
				} else {
					if (isset($value[$keyToRemove])) {
						$value[$keyToRemove] = $this->removeSensitiveValue($valueToRemove, $value[$keyToRemove]);
					}
				}
			}
		}

		return $value;
	}

	public function isReadOnly() {
		return $this->config->isReadOnly();
	}
}


1			<?php
2			/**
3			* @author Joas Schilling <[email protected]>
4			* @author Jonathan Kawohl <[email protected]>
5			* @author Lukas Reschke <[email protected]>
6			* @author Morris Jobke <[email protected]>
7			* @author Roeland Jago Douma <[email protected]>
8			*
9			* @copyright Copyright (c) 2018, ownCloud GmbH
10			* @license AGPL-3.0
11			*
12			* This code is free software: you can redistribute it and/or modify
13			* it under the terms of the GNU Affero General Public License, version 3,
14			* as published by the Free Software Foundation.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU Affero General Public License for more details.
20			*
21			* You should have received a copy of the GNU Affero General Public License, version 3,
22			* along with this program. If not, see <http://www.gnu.org/licenses/>
23			*
24			*/
25
26			namespace OC;
27
28			use OCP\IConfig;
29
30			/**
31			* Class which provides access to the system config values stored in config.php
32			* Internal class for bootstrap only.
33			* fixes cyclic DI: AllConfig needs AppConfig needs Database needs AllConfig
34			*/
35			class SystemConfig {
36
37			/** @var array */
38			protected $sensitiveValues = [
39			'dbpassword' => true,
40			'dbuser' => true,
41			'mail_smtpname' => true,
42			'mail_smtppassword' => true,
43			'mail_from_address' => true,
44			'mail_domain' => true,
45			'mail_smtphost' => true,
46			'passwordsalt' => true,
47			'secret' => true,
48			'updater.secret' => true,
49			'ldap_agent_password' => true,
50			'proxyuserpwd' => true,
51			'marketplace.key' => true,
52			'log.condition' => [
53			[
54			'shared_secret' => true,
55			]
56			],
57			'log.conditions' => [
58			[
59			'shared_secret' => true,
60			]
61			],
62			'license-key' => true,
63			'redis' => [
64			'password' => true,
65			],
66			'objectstore' => [
67			'arguments' => [
68			'password' => true,
69			'options' => [
70			'credentials' =>[
71			'key' => true,
72			'secret' => true,
73			],
74			],
75			],
76			],
77			];
78			/** @var Config */
79			private $config;
80
81			public function __construct(Config $config) {
82			$this->config = $config;
83			}
84
85			/**
86			* Lists all available config keys
87			* @return array an array of key names
88			*/
89			public function getKeys() {
90			return $this->config->getKeys();
91			}
92
93			/**
94			* Sets a new system wide value
95			*
96			* @param string $key the key of the value, under which will be saved
97			* @param mixed $value the value that should be stored
98			*/
99			public function setValue($key, $value) {
100			$this->config->setValue($key, $value);
101			}
102
103			/**
104			* Sets and deletes values and writes the config.php
105			*
106			* @param array $configs Associative array with `key => value` pairs
107			* If value is null, the config key will be deleted
108			*/
109			public function setValues(array $configs) {
110			$this->config->setValues($configs);
111			}
112
113			/**
114			* Looks up a system wide defined value
115			*
116			* @param string $key the key of the value, under which it was saved
117			* @param mixed $default the default value to be returned if the value isn't set
118			* @return mixed the value or $default
119			*/
120			public function getValue($key, $default = '') {
121			return $this->config->getValue($key, $default);
122			}
123
124			/**
125			* Looks up a system wide defined value and filters out sensitive data
126			*
127			* @param string $key the key of the value, under which it was saved
128			* @param mixed $default the default value to be returned if the value isn't set
129			* @return mixed the value or $default
130			*/
131			public function getFilteredValue($key, $default = '') {
132			$value = $this->getValue($key, $default);
133
134			if (isset($this->sensitiveValues[$key])) {
135			$value = $this->removeSensitiveValue($this->sensitiveValues[$key], $value);
136			}
137
138			return $value;
139			}
140
141			/**
142			* Delete a system wide defined value
143			*
144			* @param string $key the key of the value, under which it was saved
145			*/
146			public function deleteValue($key) {
147			$this->config->deleteKey($key);
148			}
149
150			/**
151			* @param bool\|array $keysToRemove
152			* @param mixed $value
153			* @return mixed
154			*/
155			protected function removeSensitiveValue($keysToRemove, $value) {
156			if ($keysToRemove === true) {
157			return IConfig::SENSITIVE_VALUE;
158			}
159
160			if (\is_array($value)) {
161			foreach ($keysToRemove as $keyToRemove => $valueToRemove) {
			0 ignored issues – show Bug introduced 2015-11-21 07:38 UTC by Report Bug Copy Issue Report The expression `$keysToRemove` of type `boolean\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
162			if ($keyToRemove === 0) {
163			/*
164			* The 0 key in keysToRemove indicates a possibly repeating
165			* array of actual entries 0,1,2,3...
166			* Remove any sensitive values from all actual entries.
167			*/
168			foreach ($value as $valueKey => $valueData) {
169			if (\is_int($valueKey) && ($valueKey >= 0)) {
170			$value[$valueKey] = $this->removeSensitiveValue($valueToRemove, $value[$valueKey]);
171			}
172			}
173			} else {
174			if (isset($value[$keyToRemove])) {
175			$value[$keyToRemove] = $this->removeSensitiveValue($valueToRemove, $value[$keyToRemove]);
176			}
177			}
178			}
179			}
180
181			return $value;
182			}
183
184			public function isReadOnly() {
185			return $this->config->isReadOnly();
186			}
187			}
188

owncloud / core

Push — master ( 48eed4...615ba7 )

SystemConfig::getValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like