VerifyUserData::queryLookupServer() - Code Metrics - Inspection of "Merge pull request #5095 from patschi/patch-1" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( de953b...53c8e9 )

by Björn

created 2017-05-26 10:11 UTC

VerifyUserData::queryLookupServer() B

↳ Parent: VerifyUserData

Complexity

Conditions	5
Paths	6

Size

Total Lines	23
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	12
nc	6
nop	1
dl	0
loc	23
rs	8.5906
c	0
b	0
f	0

<?php
/**
 * @copyright Copyright (c) 2017 Bjoern Schiessle <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OC\Settings\BackgroundJobs;


use OC\Accounts\AccountManager;
use OC\BackgroundJob\Job;
use OC\BackgroundJob\JobList;
use OCP\AppFramework\Http;
use OCP\BackgroundJob\IJobList;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\ILogger;
use OCP\IUserManager;

class VerifyUserData extends Job {

	/** @var  bool */
	private $retainJob = true;

	/** @var int max number of attempts to send the request */
	private $maxTry = 24;

	/** @var int how much time should be between two tries (1 hour) */
	private $interval = 3600;

	/** @var AccountManager */
	private $accountManager;

	/** @var IUserManager */
	private $userManager;

	/** @var IClientService */
	private $httpClientService;

	/** @var ILogger */
	private $logger;

	/** @var string */
	private $lookupServerUrl;

	/**
	 * VerifyUserData constructor.
	 *
	 * @param AccountManager $accountManager
	 * @param IUserManager $userManager
	 * @param IClientService $clientService
	 * @param ILogger $logger
	 * @param IConfig $config
	 */
	public function __construct(AccountManager $accountManager,
								IUserManager $userManager,
								IClientService $clientService,
								ILogger $logger,
								IConfig $config
	) {
		$this->accountManager = $accountManager;
		$this->userManager = $userManager;
		$this->httpClientService = $clientService;
		$this->logger = $logger;

		$lookupServerUrl = $config->getSystemValue('lookup_server', 'https://lookup.nextcloud.com');
		$this->lookupServerUrl = rtrim($lookupServerUrl, '/');
	}

	/**
	 * run the job, then remove it from the jobList
	 *
	 * @param JobList $jobList
	 * @param ILogger $logger
	 */
	public function execute($jobList, ILogger $logger = null) {


		if ($this->shouldRun($this->argument)) {
			parent::execute($jobList, $logger);
			$jobList->remove($this, $this->argument);
			if ($this->retainJob) {
				$this->reAddJob($jobList, $this->argument);
			} else {
				$this->resetVerificationState();
			}
		}

	}

	protected function run($argument) {

		$try = (int)$argument['try'] + 1;

		switch($argument['type']) {
			case AccountManager::PROPERTY_WEBSITE:
				$result = $this->verifyWebsite($argument);
				break;
			case AccountManager::PROPERTY_TWITTER:
			case AccountManager::PROPERTY_EMAIL:
				$result = $this->verifyViaLookupServer($argument, $argument['type']);
				break;
			default:
				// no valid type given, no need to retry
				$this->logger->error($argument['type'] . ' is no valid type for user account data.');
				$result = true;
		}

		if ($result === true || $try > $this->maxTry) {
			$this->retainJob = false;
		}
	}

	/**
	 * verify web page
	 *
	 * @param array $argument
	 * @return bool true if we could check the verification code, otherwise false
	 */
	protected function verifyWebsite(array $argument) {

		$result = false;

		$url = rtrim($argument['data'], '/') . '/.well-known/' . 'CloudIdVerificationCode.txt';

		$client = $this->httpClientService->newClient();
		try {
			$response = $client->get($url);
		} catch (\Exception $e) {
			return false;
		}

		if ($response->getStatusCode() === Http::STATUS_OK) {
			$result = true;
			$publishedCode = $response->getBody();
			// remove new lines and spaces
			$publishedCodeSanitized = trim(preg_replace('/\s\s+/', ' ', $publishedCode));
			$user = $this->userManager->get($argument['uid']);
			// we don't check a valid user -> give up
			if ($user === null) {
				$this->logger->error($argument['uid'] . ' doesn\'t exist, can\'t verify user data.');
				return $result;
			}
			$userData = $this->accountManager->getUser($user);

			if ($publishedCodeSanitized === $argument['verificationCode']) {
				$userData[AccountManager::PROPERTY_WEBSITE]['verified'] = AccountManager::VERIFIED;
			} else {
				$userData[AccountManager::PROPERTY_WEBSITE]['verified'] = AccountManager::NOT_VERIFIED;
			}

			$this->accountManager->updateUser($user, $userData);
		}

		return $result;
	}

	/**
	 * verify email address
	 *
	 * @param array $argument
	 * @param string $dataType
	 * @return bool true if we could check the verification code, otherwise false
	 */
	protected function verifyViaLookupServer(array $argument, $dataType) {

		$user = $this->userManager->get($argument['uid']);

		// we don't check a valid user -> give up
		if ($user === null) {
			$this->logger->error($argument['uid'] . ' doesn\'t exist, can\'t verify user data.');
			return true;
		}

		$localUserData = $this->accountManager->getUser($user);
		$cloudId = $user->getCloudId();

		// ask lookup-server for user data
		$lookupServerData = $this->queryLookupServer($cloudId);

		// for some reasons we couldn't read any data from the lookup server, try again later
		if (empty($lookupServerData)) {
			return false;
		}

		// lookup server has verification data for wrong user data (e.g. email address), try again later
		if ($lookupServerData[$dataType]['value'] !== $argument['data']) {
			return false;
		}

		// lookup server hasn't verified the email address so far, try again later
		if ($lookupServerData[$dataType]['verified'] === AccountManager::NOT_VERIFIED) {
			return false;
		}

		$localUserData[$dataType]['verified'] = AccountManager::VERIFIED;
		$this->accountManager->updateUser($user, $localUserData);

		return true;
	}

	/**
	 * @param string $cloudId
	 * @return array
	 */
	protected function queryLookupServer($cloudId) {
		try {
			$client = $this->httpClientService->newClient();
			$response = $client->get(
				$this->lookupServerUrl . '/users?search=' . urlencode($cloudId) . '&exactCloudId=1',
				[
					'timeout' => 10,
					'connect_timeout' => 3,
				]
			);

			$body = json_decode($response->getBody(), true);

			if (is_array($body) && isset($body['federationId']) && $body['federationId'] === $cloudId) {
				return $body;
			}

		} catch (\Exception $e) {
			// do nothing, we will just re-try later
		}

		return [];
	}

	/**
	 * re-add background job with new arguments
	 *
	 * @param IJobList $jobList
	 * @param array $argument
	 */
	protected function reAddJob(IJobList $jobList, array $argument) {

		$jobList->add('OC\Settings\BackgroundJobs\VerifyUserData',
			[
				'verificationCode' => $argument['verificationCode'],
				'data' => $argument['data'],
				'type' => $argument['type'],
				'uid' => $argument['uid'],
				'try' => (int)$argument['try'] + 1,
				'lastRun' => time()
			]
		);
	}

	/**
	 * test if it is time for the next run
	 *
	 * @param array $argument
	 * @return bool
	 */
	protected function shouldRun(array $argument) {
		$lastRun = (int)$argument['lastRun'];
		return ((time() - $lastRun) > $this->interval);
	}


	/**
	 * reset verification state after max tries are reached
	 */
	protected function resetVerificationState() {
		$user = $this->userManager->get($this->argument['uid']);
		if ($user !== null) {
			$accountData = $this->accountManager->getUser($user);
			$accountData[$this->argument['type']]['verified'] = AccountManager::NOT_VERIFIED;
			$this->accountManager->updateUser($user, $accountData);
		}
	}

}


1		<?php
2		/**
3		* @copyright Copyright (c) 2017 Bjoern Schiessle <[email protected]>
4		*
5		* @license GNU AGPL version 3 or any later version
6		*
7		* This program is free software: you can redistribute it and/or modify
8		* it under the terms of the GNU Affero General Public License as
9		* published by the Free Software Foundation, either version 3 of the
10		* License, or (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU Affero General Public License for more details.
16		*
17		* You should have received a copy of the GNU Affero General Public License
18		* along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*
20		*/
21
22
23		namespace OC\Settings\BackgroundJobs;
24
25
26		use OC\Accounts\AccountManager;
27		use OC\BackgroundJob\Job;
28		use OC\BackgroundJob\JobList;
29		use OCP\AppFramework\Http;
30		use OCP\BackgroundJob\IJobList;
31		use OCP\Http\Client\IClientService;
32		use OCP\IConfig;
33		use OCP\ILogger;
34		use OCP\IUserManager;
35
36		class VerifyUserData extends Job {
37
38		/** @var bool */
39		private $retainJob = true;
40
41		/** @var int max number of attempts to send the request */
42		private $maxTry = 24;
43
44		/** @var int how much time should be between two tries (1 hour) */
45		private $interval = 3600;
46
47		/** @var AccountManager */
48		private $accountManager;
49
50		/** @var IUserManager */
51		private $userManager;
52
53		/** @var IClientService */
54		private $httpClientService;
55
56		/** @var ILogger */
57		private $logger;
58
59		/** @var string */
60		private $lookupServerUrl;
61
62		/**
63		* VerifyUserData constructor.
64		*
65		* @param AccountManager $accountManager
66		* @param IUserManager $userManager
67		* @param IClientService $clientService
68		* @param ILogger $logger
69		* @param IConfig $config
70		*/
71		public function __construct(AccountManager $accountManager,
72		IUserManager $userManager,
73		IClientService $clientService,
74		ILogger $logger,
75		IConfig $config
76		) {
77		$this->accountManager = $accountManager;
78		$this->userManager = $userManager;
79		$this->httpClientService = $clientService;
80		$this->logger = $logger;
81
82		$lookupServerUrl = $config->getSystemValue('lookup_server', 'https://lookup.nextcloud.com');
83		$this->lookupServerUrl = rtrim($lookupServerUrl, '/');
84		}
85
86		/**
87		* run the job, then remove it from the jobList
88		*
89		* @param JobList $jobList
90		* @param ILogger $logger
91		*/
92	View Code Duplication	public function execute($jobList, ILogger $logger = null) {
		0 ignored issues – show Duplication introduced 2017-04-21 14:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
93
94		if ($this->shouldRun($this->argument)) {
95		parent::execute($jobList, $logger);
96		$jobList->remove($this, $this->argument);
97		if ($this->retainJob) {
98		$this->reAddJob($jobList, $this->argument);
99		} else {
100		$this->resetVerificationState();
101		}
102		}
103
104		}
105
106		protected function run($argument) {
107
108		$try = (int)$argument['try'] + 1;
109
110		switch($argument['type']) {
111		case AccountManager::PROPERTY_WEBSITE:
112		$result = $this->verifyWebsite($argument);
113		break;
114		case AccountManager::PROPERTY_TWITTER:
115		case AccountManager::PROPERTY_EMAIL:
116		$result = $this->verifyViaLookupServer($argument, $argument['type']);
117		break;
118		default:
119		// no valid type given, no need to retry
120		$this->logger->error($argument['type'] . ' is no valid type for user account data.');
121		$result = true;
122		}
123
124		if ($result === true \|\| $try > $this->maxTry) {
125		$this->retainJob = false;
126		}
127		}
128
129		/**
130		* verify web page
131		*
132		* @param array $argument
133		* @return bool true if we could check the verification code, otherwise false
134		*/
135		protected function verifyWebsite(array $argument) {
136
137		$result = false;
138
139		$url = rtrim($argument['data'], '/') . '/.well-known/' . 'CloudIdVerificationCode.txt';
140
141		$client = $this->httpClientService->newClient();
142		try {
143		$response = $client->get($url);
144		} catch (\Exception $e) {
145		return false;
146		}
147
148		if ($response->getStatusCode() === Http::STATUS_OK) {
149		$result = true;
150		$publishedCode = $response->getBody();
151		// remove new lines and spaces
152		$publishedCodeSanitized = trim(preg_replace('/\s\s+/', ' ', $publishedCode));
153		$user = $this->userManager->get($argument['uid']);
154		// we don't check a valid user -> give up
155		if ($user === null) {
156		$this->logger->error($argument['uid'] . ' doesn\'t exist, can\'t verify user data.');
157		return $result;
158		}
159		$userData = $this->accountManager->getUser($user);
160
161		if ($publishedCodeSanitized === $argument['verificationCode']) {
162		$userData[AccountManager::PROPERTY_WEBSITE]['verified'] = AccountManager::VERIFIED;
163		} else {
164		$userData[AccountManager::PROPERTY_WEBSITE]['verified'] = AccountManager::NOT_VERIFIED;
165		}
166
167		$this->accountManager->updateUser($user, $userData);
168		}
169
170		return $result;
171		}
172
173		/**
174		* verify email address
175		*
176		* @param array $argument
177		* @param string $dataType
178		* @return bool true if we could check the verification code, otherwise false
179		*/
180		protected function verifyViaLookupServer(array $argument, $dataType) {
181
182		$user = $this->userManager->get($argument['uid']);
183
184		// we don't check a valid user -> give up
185		if ($user === null) {
186		$this->logger->error($argument['uid'] . ' doesn\'t exist, can\'t verify user data.');
187		return true;
188		}
189
190		$localUserData = $this->accountManager->getUser($user);
191		$cloudId = $user->getCloudId();
192
193		// ask lookup-server for user data
194		$lookupServerData = $this->queryLookupServer($cloudId);
195
196		// for some reasons we couldn't read any data from the lookup server, try again later
197		if (empty($lookupServerData)) {
198		return false;
199		}
200
201		// lookup server has verification data for wrong user data (e.g. email address), try again later
202		if ($lookupServerData[$dataType]['value'] !== $argument['data']) {
203		return false;
204		}
205
206		// lookup server hasn't verified the email address so far, try again later
207		if ($lookupServerData[$dataType]['verified'] === AccountManager::NOT_VERIFIED) {
208		return false;
209		}
210
211		$localUserData[$dataType]['verified'] = AccountManager::VERIFIED;
212		$this->accountManager->updateUser($user, $localUserData);
213
214		return true;
215		}
216
217		/**
218		* @param string $cloudId
219		* @return array
220		*/
221		protected function queryLookupServer($cloudId) {
222		try {
223		$client = $this->httpClientService->newClient();
224		$response = $client->get(
225		$this->lookupServerUrl . '/users?search=' . urlencode($cloudId) . '&exactCloudId=1',
226		[
227		'timeout' => 10,
228		'connect_timeout' => 3,
229		]
230		);
231
232		$body = json_decode($response->getBody(), true);
233
234		if (is_array($body) && isset($body['federationId']) && $body['federationId'] === $cloudId) {
235		return $body;
236		}
237
238		} catch (\Exception $e) {
239		// do nothing, we will just re-try later
240		}
241
242		return [];
243		}
244
245		/**
246		* re-add background job with new arguments
247		*
248		* @param IJobList $jobList
249		* @param array $argument
250		*/
251	View Code Duplication	protected function reAddJob(IJobList $jobList, array $argument) {
		0 ignored issues – show Duplication introduced 2017-04-21 16:30 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
252		$jobList->add('OC\Settings\BackgroundJobs\VerifyUserData',
253		[
254		'verificationCode' => $argument['verificationCode'],
255		'data' => $argument['data'],
256		'type' => $argument['type'],
257		'uid' => $argument['uid'],
258		'try' => (int)$argument['try'] + 1,
259		'lastRun' => time()
260		]
261		);
262		}
263
264		/**
265		* test if it is time for the next run
266		*
267		* @param array $argument
268		* @return bool
269		*/
270		protected function shouldRun(array $argument) {
271		$lastRun = (int)$argument['lastRun'];
272		return ((time() - $lastRun) > $this->interval);
273		}
274
275
276		/**
277		* reset verification state after max tries are reached
278		*/
279		protected function resetVerificationState() {
280		$user = $this->userManager->get($this->argument['uid']);
281		if ($user !== null) {
282		$accountData = $this->accountManager->getUser($user);
283		$accountData[$this->argument['type']]['verified'] = AccountManager::NOT_VERIFIED;
284		$this->accountManager->updateUser($user, $accountData);
285		}
286		}
287
288		}
289

nextcloud / server

Push — master ( de953b...53c8e9 )

VerifyUserData::queryLookupServer() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like