MiscService - Code Metrics - Inspection of "caching display name" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#516)

by Maxence

created 2020-11-11 16:39 UTC

MiscService B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	367
Duplicated Lines	3.81 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

Metric	Value
wmc	48
lcom	3
cbo	3
dl	14
loc	367
rs	8.5599
c	0
b	0
f	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	log()	0	8	1
A	get()	0	7	2
A	mustContains()	0	11	4
A	fail()	0	8	1
A	success()	0	6	1
A	getRealUserId()	0	15	3
B	getContactDisplayName()	0	28	8
A	getDisplay()	0	8	1
A	getDisplayMember()	0	11	3
A	getDisplayContact()	0	11	3
A	getContactData()	0	22	4
A	getDisplayContactFromArray()	0	17	6
A	getDisplayName()	0	12	3
A	generateClientBodyData()	0	7	1
A	asyncAndLeaveClientOutOfThis()	0	14	2
A	token()	14	14	3
A	getInfosFromContact()	0	10	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like MiscService often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use MiscService, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2017
 * @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 OCA\Circles\Service;

use daita\MySmallPhpTools\Traits\TArrayTools;
use Exception;
use OC;
use OC\User\NoUserException;
use OCA\Circles\AppInfo\Application;
use OCA\Circles\Exceptions\MissingKeyInArrayException;
use OCA\Circles\Model\Member;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\Contacts\ContactsMenu\IContactsStore;
use OCP\ILogger;
use OCP\IUserManager;

class MiscService {


	use TArrayTools;


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

	/** @var IContactsStore */
	private $contactsStore;

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

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

	public function __construct(
		ILogger $logger, IContactsStore $contactsStore, $appName, IUserManager $userManager
	) {
		$this->logger = $logger;
		$this->contactsStore = $contactsStore;
		$this->appName = $appName;
		$this->userManager = $userManager;
	}

	public function log($message, $level = 4) {
		$data = array(
			'app'   => $this->appName,
			'level' => $level
		);

		$this->logger->log($level, $message, $data);
	}


	/**
	 * @param $arr
	 * @param $k
	 *
	 * @param string $default
	 *
	 * @return array|string
	 */
	public static function get($arr, $k, $default = '') {
		if (!key_exists($k, $arr)) {
			return $default;
		}

		return $arr[$k];
	}


	public static function mustContains($data, $arr) {
		if (!is_array($arr)) {
			$arr = [$arr];
		}

		foreach ($arr as $k) {
			if (!key_exists($k, $data)) {
				throw new MissingKeyInArrayException('missing_key_in_array');
			}
		}
	}


	/**
	 * @param $data
	 *
	 * @return DataResponse
	 */
	public function fail($data) {
		$this->log(json_encode($data));

		return new DataResponse(
			array_merge($data, array('status' => 0)),
			Http::STATUS_NON_AUTHORATIVE_INFORMATION
		);
	}


	/**
	 * @param $data
	 *
	 * @return DataResponse
	 */
	public function success($data) {
		return new DataResponse(
			array_merge($data, array('status' => 1)),
			Http::STATUS_CREATED
		);
	}


	/**
	 * return the real userId, with its real case
	 *
	 * @param $userId
	 *
	 * @return string
	 * @throws NoUserException
	 */
	public function getRealUserId($userId) {
		if ($this->userManager->userExists($userId)) {
			return $this->userManager->get($userId)
									 ->getUID();
		}

		$result = $this->userManager->search($userId);
		if (sizeof($result) !== 1) {
			throw new NoUserException();
		}

		$user = array_shift($result);

		return $user->getUID();
	}



	/**
	 * @param string $ident
	 *
	 * @return string
	 */
	public function getContactDisplayName(string $ident): string {
		if (!class_exists(\OCA\DAV\CardDAV\ContactsManager::class) || !strpos($ident, ':')) {
			return '';
		}

		list($userId, $contactId) = explode(':', $ident);
		$entries = [];
		try {
			/** @var \OCA\DAV\CardDAV\ContactsManager $cManager */
			$cManager = OC::$server->query(\OCA\DAV\CardDAV\ContactsManager::class);
			$urlGenerator = OC::$server->getURLGenerator();

			$cm = OC::$server->getContactsManager();
			$cManager->setupContactsProvider($cm, $userId, $urlGenerator);
			$contact = $cm->search($contactId, ['UID']);

			$entries = array_shift($contact);
		} catch (Exception $e) {

		}

		if (key_exists('FN', $entries) && $entries['FN'] !== '') {
			return $entries['FN'];
		}

		if (key_exists('EMAIL', $entries) && $entries['EMAIL'] !== '') {
			return $entries['EMAIL'];
		}
	}


	/**
	 * @param string $ident
	 * @param int $type
	 *
	 * @return string
	 * @deprecated
	 *
	 */
	public static function getDisplay($ident, $type) {
		$display = $ident;

		self::getDisplayMember($display, $ident, $type);
		self::getDisplayContact($display, $ident, $type);

		return $display;
	}


	/**
	 * @param string $display
	 * @param string $ident
	 * @param int $type
	 */
	private static function getDisplayMember(&$display, $ident, $type) {
		if ($type !== Member::TYPE_USER) {
			return;
		}

		$user = OC::$server->getUserManager()
						   ->get($ident);
		if ($user !== null) {
			$display = $user->getDisplayName();
		}
	}


	/**
	 * @param string $display
	 * @param string $ident
	 * @param int $type
	 */
	private static function getDisplayContact(&$display, $ident, $type) {
		if ($type !== Member::TYPE_CONTACT) {
			return;
		}

		$contact = self::getContactData($ident);

		if ($contact === null) {
			return;
		}
		self::getDisplayContactFromArray($display, $contact);

	}


	/**
	 * @param $ident
	 *
	 * @return mixed|string
	 * @deprecated
	 *
	 */
	public static function getContactData($ident) {
		if (!class_exists(\OCA\DAV\CardDAV\ContactsManager::class) || !strpos($ident, ':')) {
			return [];
		}

		list($userId, $contactId) = explode(':', $ident);

		try {
			/** @var \OCA\DAV\CardDAV\ContactsManager $cManager */
			$cManager = OC::$server->query(\OCA\DAV\CardDAV\ContactsManager::class);
			$urlGenerator = OC::$server->getURLGenerator();

			$cm = OC::$server->getContactsManager();
			$cManager->setupContactsProvider($cm, $userId, $urlGenerator);
			$contact = $cm->search($contactId, ['UID']);

			return array_shift($contact);
		} catch (Exception $e) {

		}

		return [];
	}


	/**
	 * @param string $display
	 * @param array $contact
	 *
	 * @deprecated
	 */
	private static function getDisplayContactFromArray(string &$display, array $contact) {
		if (!is_array($contact)) {
			return;
		}

		if (key_exists('FN', $contact) && $contact['FN'] !== '') {
			$display = $contact['FN'];

			return;
		}

		if (key_exists('EMAIL', $contact) && $contact['EMAIL'] !== '') {
			$display = $contact['EMAIL'];

			return;
		}
	}


	/**
	 * return Display Name if user exists and display name exists.
	 * returns Exception if user does not exist.
	 *
	 * However, with noException set to true, will return userId even if user does not exist
	 *
	 * @param $userId
	 * @param bool $noException
	 *
	 * @return string
	 * @throws NoUserException
	 */
	public function getDisplayName($userId, $noException = false) {
		$user = $this->userManager->get($userId);
		if ($user === null) {
			if ($noException) {
				return $userId;
			} else {
				throw new NoUserException();
			}
		}

		return $user->getDisplayName();
	}


	/**
	 * @param array $options
	 *
	 * @return array

	 */
	public static function generateClientBodyData($options = []) {
		return [
			'body'            => ['data' => $options],
			'timeout'         => Application::CLIENT_TIMEOUT,
			'connect_timeout' => Application::CLIENT_TIMEOUT
		];
	}


	/**
	 * Hacky way to async the rest of the process without keeping client on hold.
	 *
	 * @param string $result
	 */
	public function asyncAndLeaveClientOutOfThis($result = '') {
		if (ob_get_contents() !== false) {
			ob_end_clean();
		}

		header('Connection: close');
		ignore_user_abort();
		ob_start();
		echo(json_encode($result));
		$size = ob_get_length();
		header('Content-Length: ' . $size);
		ob_end_flush();
		flush();
	}


	/**
	 * Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80
	 *
	 * @param int $length
	 *
	 * @return string
	 */
	public function token(int $length = 0): string {

		$chars = 'qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM1234567890';

		$str = '';
		$max = strlen($chars) - 1;
		for ($i = 0; $i <= $length; $i++) {
			try {
				$str .= $chars[random_int(0, $max)];
			} catch (Exception $e) {

			}
		}

		return $str;
	}


	/**
	 * @param Member $member
	 *
	 * @return array

	 */
	public function getInfosFromContact(Member $member) {
		$contact = MiscService::getContactData($member->getUserId());


		return [
			'memberId' => $member->getMemberId(),
			'emails'   => $this->getArray('EMAIL', $contact),
			'cloudIds' => $this->getArray('CLOUD', $contact)
		];

	}

}



1		<?php
2		/**
3		* Circles - Bring cloud-users closer together.
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Maxence Lange <[email protected]>
9		* @copyright 2017
10		* @license GNU AGPL version 3 or any later version
11		*
12		* This program is free software: you can redistribute it and/or modify
13		* it under the terms of the GNU Affero General Public License as
14		* published by the Free Software Foundation, either version 3 of the
15		* License, or (at your option) any later version.
16		*
17		* This program is distributed in the hope that it will be useful,
18		* but WITHOUT ANY WARRANTY; without even the implied warranty of
19		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20		* GNU Affero General Public License for more details.
21		*
22		* You should have received a copy of the GNU Affero General Public License
23		* along with this program. If not, see <http://www.gnu.org/licenses/>.
24		*
25		*/
26
27		namespace OCA\Circles\Service;
28
29		use daita\MySmallPhpTools\Traits\TArrayTools;
30		use Exception;
31		use OC;
32		use OC\User\NoUserException;
33		use OCA\Circles\AppInfo\Application;
34		use OCA\Circles\Exceptions\MissingKeyInArrayException;
35		use OCA\Circles\Model\Member;
36		use OCP\AppFramework\Http;
37		use OCP\AppFramework\Http\DataResponse;
38		use OCP\Contacts\ContactsMenu\IContactsStore;
39		use OCP\ILogger;
40		use OCP\IUserManager;
41
42		class MiscService {
43
44
45		use TArrayTools;
46
47
48		/** @var ILogger */
49		private $logger;
50
51		/** @var IContactsStore */
52		private $contactsStore;
53
54		/** @var string */
55		private $appName;
56
57		/** @var IUserManager */
58		private $userManager;
59
60		public function __construct(
61		ILogger $logger, IContactsStore $contactsStore, $appName, IUserManager $userManager
62		) {
63		$this->logger = $logger;
64		$this->contactsStore = $contactsStore;
65		$this->appName = $appName;
66		$this->userManager = $userManager;
67		}
68
69		public function log($message, $level = 4) {
70		$data = array(
71		'app' => $this->appName,
72		'level' => $level
73		);
74
75		$this->logger->log($level, $message, $data);
76		}
77
78
79		/**
80		* @param $arr
81		* @param $k
82		*
83		* @param string $default
84		*
85		* @return array\|string
86		*/
87		public static function get($arr, $k, $default = '') {
88		if (!key_exists($k, $arr)) {
89		return $default;
90		}
91
92		return $arr[$k];
93		}
94
95
96		public static function mustContains($data, $arr) {
97		if (!is_array($arr)) {
98		$arr = [$arr];
99		}
100
101		foreach ($arr as $k) {
102		if (!key_exists($k, $data)) {
103		throw new MissingKeyInArrayException('missing_key_in_array');
104		}
105		}
106		}
107
108
109		/**
110		* @param $data
111		*
112		* @return DataResponse
113		*/
114		public function fail($data) {
115		$this->log(json_encode($data));
116
117		return new DataResponse(
118		array_merge($data, array('status' => 0)),
119		Http::STATUS_NON_AUTHORATIVE_INFORMATION
120		);
121		}
122
123
124		/**
125		* @param $data
126		*
127		* @return DataResponse
128		*/
129		public function success($data) {
130		return new DataResponse(
131		array_merge($data, array('status' => 1)),
132		Http::STATUS_CREATED
133		);
134		}
135
136
137		/**
138		* return the real userId, with its real case
139		*
140		* @param $userId
141		*
142		* @return string
143		* @throws NoUserException
144		*/
145		public function getRealUserId($userId) {
146		if ($this->userManager->userExists($userId)) {
147		return $this->userManager->get($userId)
148		->getUID();
149		}
150
151		$result = $this->userManager->search($userId);
152		if (sizeof($result) !== 1) {
153		throw new NoUserException();
154		}
155
156		$user = array_shift($result);
157
158		return $user->getUID();
159		}
160
161
162
163		/**
164		* @param string $ident
165		*
166		* @return string
167		*/
168		public function getContactDisplayName(string $ident): string {
169		if (!class_exists(\OCA\DAV\CardDAV\ContactsManager::class) \|\| !strpos($ident, ':')) {
170		return '';
171		}
172
173		list($userId, $contactId) = explode(':', $ident);
174		$entries = [];
175		try {
176		/** @var \OCA\DAV\CardDAV\ContactsManager $cManager */
177		$cManager = OC::$server->query(\OCA\DAV\CardDAV\ContactsManager::class);
178		$urlGenerator = OC::$server->getURLGenerator();
179
180		$cm = OC::$server->getContactsManager();
181		$cManager->setupContactsProvider($cm, $userId, $urlGenerator);
182		$contact = $cm->search($contactId, ['UID']);
183
184		$entries = array_shift($contact);
185		} catch (Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2020-11-11 16:42 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
186		}
187
188		if (key_exists('FN', $entries) && $entries['FN'] !== '') {
189		return $entries['FN'];
190		}
191
192		if (key_exists('EMAIL', $entries) && $entries['EMAIL'] !== '') {
193		return $entries['EMAIL'];
194		}
195		}
196
197
198		/**
199		* @param string $ident
200		* @param int $type
201		*
202		* @return string
203		* @deprecated
204		*
205		*/
206		public static function getDisplay($ident, $type) {
207		$display = $ident;
208
209		self::getDisplayMember($display, $ident, $type);
210		self::getDisplayContact($display, $ident, $type);
211
212		return $display;
213		}
214
215
216		/**
217		* @param string $display
218		* @param string $ident
219		* @param int $type
220		*/
221		private static function getDisplayMember(&$display, $ident, $type) {
222		if ($type !== Member::TYPE_USER) {
223		return;
224		}
225
226		$user = OC::$server->getUserManager()
227		->get($ident);
228		if ($user !== null) {
229		$display = $user->getDisplayName();
230		}
231		}
232
233
234		/**
235		* @param string $display
236		* @param string $ident
237		* @param int $type
238		*/
239		private static function getDisplayContact(&$display, $ident, $type) {
240		if ($type !== Member::TYPE_CONTACT) {
241		return;
242		}
243
244		$contact = self::getContactData($ident);
		0 ignored issues – show Deprecated Code introduced 2020-11-11 16:42 UTC by Report Bug Copy Issue Report The method `OCA\Circles\Service\MiscService::getContactData()` has been deprecated. This method has been deprecated. Loading history...
245		if ($contact === null) {
246		return;
247		}
248		self::getDisplayContactFromArray($display, $contact);
		0 ignored issues – show Deprecated Code introduced 2020-11-11 16:42 UTC by Report Bug Copy Issue Report The method `OCA\Circles\Service\Misc...splayContactFromArray()` has been deprecated. This method has been deprecated. Loading history...
249		}
250
251
252		/**
253		* @param $ident
254		*
255		* @return mixed\|string
256		* @deprecated
257		*
258		*/
259		public static function getContactData($ident) {
260		if (!class_exists(\OCA\DAV\CardDAV\ContactsManager::class) \|\| !strpos($ident, ':')) {
261		return [];
262		}
263
264		list($userId, $contactId) = explode(':', $ident);
265
266		try {
267		/** @var \OCA\DAV\CardDAV\ContactsManager $cManager */
268		$cManager = OC::$server->query(\OCA\DAV\CardDAV\ContactsManager::class);
269		$urlGenerator = OC::$server->getURLGenerator();
270
271		$cm = OC::$server->getContactsManager();
272		$cManager->setupContactsProvider($cm, $userId, $urlGenerator);
273		$contact = $cm->search($contactId, ['UID']);
274
275		return array_shift($contact);
276		} catch (Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-08-25 10:04 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
277		}
278
279		return [];
280		}
281
282
283		/**
284		* @param string $display
285		* @param array $contact
286		*
287		* @deprecated
288		*/
289		private static function getDisplayContactFromArray(string &$display, array $contact) {
290		if (!is_array($contact)) {
291		return;
292		}
293
294		if (key_exists('FN', $contact) && $contact['FN'] !== '') {
295		$display = $contact['FN'];
296
297		return;
298		}
299
300		if (key_exists('EMAIL', $contact) && $contact['EMAIL'] !== '') {
301		$display = $contact['EMAIL'];
302
303		return;
304		}
305		}
306
307
308		/**
309		* return Display Name if user exists and display name exists.
310		* returns Exception if user does not exist.
311		*
312		* However, with noException set to true, will return userId even if user does not exist
313		*
314		* @param $userId
315		* @param bool $noException
316		*
317		* @return string
318		* @throws NoUserException
319		*/
320		public function getDisplayName($userId, $noException = false) {
321		$user = $this->userManager->get($userId);
322		if ($user === null) {
323		if ($noException) {
324		return $userId;
325		} else {
326		throw new NoUserException();
327		}
328		}
329
330		return $user->getDisplayName();
331		}
332
333
334		/**
335		* @param array $options
336		*
337		* @return array
		0 ignored issues – show Documentation introduced 2017-09-02 15:56 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,array<string,array>>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
338		*/
339		public static function generateClientBodyData($options = []) {
340		return [
341		'body' => ['data' => $options],
342		'timeout' => Application::CLIENT_TIMEOUT,
343		'connect_timeout' => Application::CLIENT_TIMEOUT
344		];
345		}
346
347
348		/**
349		* Hacky way to async the rest of the process without keeping client on hold.
350		*
351		* @param string $result
352		*/
353		public function asyncAndLeaveClientOutOfThis($result = '') {
354		if (ob_get_contents() !== false) {
355		ob_end_clean();
356		}
357
358		header('Connection: close');
359		ignore_user_abort();
360		ob_start();
361		echo(json_encode($result));
362		$size = ob_get_length();
363		header('Content-Length: ' . $size);
364		ob_end_flush();
365		flush();
366		}
367
368
369		/**
370		* Generate uuid: 2b5a7a87-8db1-445f-a17b-405790f91c80
371		*
372		* @param int $length
373		*
374		* @return string
375		*/
376	View Code Duplication	public function token(int $length = 0): string {
		0 ignored issues – show Duplication introduced 2020-01-29 12:32 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...
377		$chars = 'qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM1234567890';
378
379		$str = '';
380		$max = strlen($chars) - 1;
381		for ($i = 0; $i <= $length; $i++) {
382		try {
383		$str .= $chars[random_int(0, $max)];
384		} catch (Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2020-01-07 10:49 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
385		}
386		}
387
388		return $str;
389		}
390
391
392		/**
393		* @param Member $member
394		*
395		* @return array
		0 ignored issues – show Documentation introduced 2020-08-17 14:56 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string\|array>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
396		*/
397		public function getInfosFromContact(Member $member) {
398		$contact = MiscService::getContactData($member->getUserId());
		0 ignored issues – show Deprecated Code introduced 2020-11-11 16:42 UTC by Report Bug Copy Issue Report The method `OCA\Circles\Service\MiscService::getContactData()` has been deprecated. This method has been deprecated. Loading history...
399
400		return [
401		'memberId' => $member->getMemberId(),
402		'emails' => $this->getArray('EMAIL', $contact),
403		'cloudIds' => $this->getArray('CLOUD', $contact)
404		];
405
406		}
407
408		}
409
410

nextcloud / circles