Passed
Pull Request — master (#52)
by Roeland
02:32
created

CredentialStoreHelper::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 2
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 2
rs 10
c 0
b 0
f 0
1
<?php
2
declare(strict_types=1);
3
/**
4
 * @copyright Copyright (c) 2018, Roeland Jago Douma <[email protected]>
5
 *
6
 * @author Roeland Jago Douma <[email protected]>
7
 *
8
 * @license GNU AGPL version 3 or any later version
9
 *
10
 * This program is free software: you can redistribute it and/or modify
11
 * it under the terms of the GNU Affero General Public License as
12
 * published by the Free Software Foundation, either version 3 of the
13
 * License, or (at your option) any later version.
14
 *
15
 * This program is distributed in the hope that it will be useful,
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 * GNU Affero General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU Affero General Public License
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
 *
23
 */
24
25
namespace OCA\Sentry\Helper;
26
27
use OCP\Authentication\Exceptions\CredentialsUnavailableException;
28
use OCP\Authentication\LoginCredentials\ICredentials;
29
use OCP\Authentication\LoginCredentials\IStore;
30
31
32
/*
33
 * This helper class is added to break the circle when fetching the login credentials.
34
 * If this fails a debug message will be logged which will be added as a breadcrumb
35
 * which will try to fetch the credentials etc.
36
 *
37
 * This breaks that cycle.
38
 */
39
class CredentialStoreHelper {
40
	/** @var IStore */
41
	private $store;
42
43
	/** @var bool */
44
	private $fetching = false;
45
46
	public function __construct(IStore $store) {
47
		$this->store = $store;
48
	}
49
50
	/**
51
	 * @return ICredentials
52
	 * @throws CredentialsUnavailableException
53
	 */
54
	public function getLoginCredentials(): ICredentials {
55
		if ($this->fetching) {
56
			// Throw the exception here if we are already fetching the credentials.
57
			throw new CredentialsUnavailableException('Credentials are already being fetched');
58
		}
59
60
		$this->fetching = true;
61
		$credentials = $this->store->getLoginCredentials();
62
		$this->fetching = false;
63
64
		return $credentials;
65
	}
66
}
67