ProviderParser::generateGroupParameter() - Code Metrics - Inspection of "fix activity 'parsed' issue (android)" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a203f6...ccc5ed )

by Maxence

created 2017-11-02 11:27 UTC

ProviderParser::generateGroupParameter() A

↳ Parent: ProviderParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	8
rs	9.4285
cc	1
eloc	6
nc	1
nop	1

<?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\Activity;

use OCA\Circles\Api\v1\Circles;
use OCA\Circles\Model\Circle;
use OCA\Circles\Model\FederatedLink;
use OCA\Circles\Model\Member;
use OCA\Circles\Service\FederatedLinkService;
use OCA\Circles\Service\MiscService;
use OCP\Activity\IEvent;
use OCP\Activity\IManager;
use OCP\IL10N;
use OCP\IURLGenerator;

class ProviderParser {


	/** @var MiscService */
	protected $miscService;

	/** @var IL10N */
	protected $l10n;

	/** @var IURLGenerator */
	protected $url;

	/** @var IManager */
	protected $activityManager;

	public function __construct(
		IURLGenerator $url, IManager $activityManager, IL10N $l10n, MiscService $miscService
	) {
		$this->url = $url;
		$this->activityManager = $activityManager;
		$this->l10n = $l10n;
		$this->miscService = $miscService;
	}


	/**
	 * general function to generate Circle event.
	 *
	 * @param IEvent $event
	 * @param Circle $circle
	 * @param FederatedLink|null $remote
	 * @param string $ownEvent
	 * @param string $othersEvent
	 */
	protected function parseCircleEvent(
		IEvent &$event, Circle $circle, $remote, $ownEvent, $othersEvent
	) {
		$data = [
			'author' => $this->generateViewerParameter($circle),
			'circle' => $this->generateCircleParameter($circle),
			'remote' => ($remote === null) ? [] : $this->generateRemoteCircleParameter($remote)
		];

		if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
			$this->setSubject($event, $ownEvent, $data);

			return;
		}

		$this->setSubject($event, $othersEvent, $data);
	}


	/**
	 * @param IEvent $event
	 * @param string $line
	 * @param array $data
	 */
	private function setSubject(IEvent $event, $line, $data) {
		$this->setParsedSubject($event, $line, $data);
		$this->setRichSubject($event, $line, $data);
	}


	/**
	 * @param IEvent $event
	 * @param string $line
	 * @param array $data
	 */
	private function setRichSubject(IEvent $event, $line, $data) {
		$ak = array_keys($data);
		foreach ($ak as $k) {
			$subAk = array_keys($data[$k]);
			foreach ($subAk as $sK) {
				if (substr($sK, 0, 1) === '_') {
					unset($data[$k][$sK]);
				}
			}
		}

		$event->setRichSubject($line, $data);
	}


	/**
	 * @param IEvent $event
	 * @param string $line
	 * @param array $data
	 */
	private function setParsedSubject(IEvent $event, $line, $data) {
		$ak = array_keys($data);
		$replace = [];
		foreach ($ak as $k) {
			if (!key_exists('_parsed', $data[$k])) {
				continue;
			}

			$replace['{' . $k . '}'] = $data[$k]['_parsed'];
		}

		$line = strtr($line, $replace);

		$event->setParsedSubject($line);
	}


	/**
	 * general function to generate Member event.
	 *
	 * @param Circle $circle
	 * @param $member
	 * @param IEvent $event
	 * @param $ownEvent
	 * @param $othersEvent
	 */
	protected function parseMemberEvent(
		IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
	) {
		$data = [
			'circle' => $this->generateCircleParameter($circle),
			'member' => $this->generateUserParameter($member)
		];

		if ($member->getUserId() === $this->activityManager->getCurrentUserId()
		) {
			$event->setSubject($ownEvent, $data);

			return;
		}

		$this->setSubject($event, $othersEvent, $data);
	}


	/**
	 * general function to generate Link event.
	 *
	 * @param Circle $circle
	 * @param FederatedLink $remote
	 * @param IEvent $event
	 * @param string $line
	 */
	protected function parseLinkEvent(IEvent &$event, Circle $circle, FederatedLink $remote, $line
	) {
		$data = [
			'circle' => $this->generateCircleParameter($circle),
			'remote' => $this->generateRemoteCircleParameter($remote)
		];

		$this->setSubject($event, $line, $data);
	}


	/**
	 * general function to generate Circle+Member event.
	 *
	 * @param Circle $circle
	 * @param Member $member
	 * @param IEvent $event
	 * @param string $ownEvent
	 * @param string $othersEvent
	 */
	protected function parseCircleMemberEvent(
		IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
	) {
		$data = [
			'author'   => $this->generateViewerParameter($circle),
			'circle'   => $this->generateCircleParameter($circle),
			'member'   => $this->generateUserParameter($member),
			'external' => $this->generateExternalMemberParameter($member),
			'group'    => $this->generateGroupParameter($member),
		];

		if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
			$this->setSubject($event, $ownEvent, $data);

			return;
		}

		$this->setSubject($event, $othersEvent, $data);
	}


	/**
	 * general function to generate Circle+Member advanced event.
	 *
	 * @param Circle $circle
	 * @param Member $member
	 * @param IEvent $event
	 * @param $ownEvent
	 * @param $targetEvent
	 * @param $othersEvent
	 */
	protected function parseCircleMemberAdvancedEvent(
		IEvent &$event, Circle $circle, Member $member, $ownEvent, $targetEvent, $othersEvent
	) {
		$data = [
			'author' => $this->generateViewerParameter($circle),
			'circle' => $this->generateCircleParameter($circle),
			'member' => $this->generateUserParameter($member)
		];

		if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
			$this->setSubject($event, $ownEvent, $data);

			return;
		}

		if ($member->getUserId() === $this->activityManager->getCurrentUserId()) {
			$this->setSubject($event, $targetEvent, $data);

			return;
		}

		$this->setSubject($event, $othersEvent, $data);
	}


	/**
	 * @param Circle $circle
	 * @param string $userId
	 *
	 * @return bool
	 */
	protected function isViewerTheAuthor(Circle $circle, $userId) {
		if ($circle->getViewer() === null) {
			return false;
		}

		if ($circle->getViewer()

				   ->getUserId() === $userId) {
			return true;
		}

		return false;
	}


	/**
	 * @param Circle $circle
	 *
	 * @return string|array <string,string|integer>
	 */
	protected function generateViewerParameter(Circle $circle) {
		if ($circle->getViewer() === null) {
			return [];
		}

		return $this->generateUserParameter($circle->getViewer());
	}


	/**
	 * @param Member $member
	 *
	 * @return array|string <string,string|integer>
	 */
	protected function generateExternalMemberParameter(Member $member) {
		return [
			'type'    => 'member_' . $member->getType(),
			'id'      => $member->getUserId(),
			'name'    => $member->getDisplayName() . ' (' . $member->getTypeString() . ')',
			'_parsed' => $member->getDisplayName()
		];
	}


	/**
	 * @param Circle $circle
	 *
	 * @return array<string,string|integer>
	 */
	protected function generateCircleParameter(Circle $circle) {
		return [
			'type'    => 'circle',
			'id'      => $circle->getId(),
			'name'    => $circle->getName(),
			'_parsed' => $circle->getName(),
			'link'    => Circles::generateLink($circle->getUniqueId())
		];
	}


	/**
	 * @param FederatedLink $link
	 *
	 * @return array<string,string|integer>

	 */
	protected function generateRemoteCircleParameter(FederatedLink $link) {
		return [
			'type'    => 'circle',
			'id'      => $link->getUniqueId(),
			'name'    => $link->getToken() . '@' . $link->getAddress(),
			'_parsed' => $link->getToken() . '@' . $link->getAddress()
		];
	}


	/**
	 * @param Member $member
	 *
	 * @return array <string,string|integer>

	 */
	protected function generateUserParameter(Member $member) {
		return [
			'type'    => 'user',
			'id'      => $member->getUserId(),
			'name'    => $this->miscService->getDisplayName($member->getUserId(), true),
			'_parsed' => $this->miscService->getDisplayName($member->getUserId(), true)
		];
	}


	/**
	 * @param Member $group
	 *
	 * @return array <string,string|integer>

	 */
	protected function generateGroupParameter($group) {
		return [
			'type'    => 'group',
			'id'      => $group->getUserId(),
			'name'    => $group->getUserId(),
			'_parsed' => $group->getUserId()
		];
	}

}

1			<?php
2
3			/**
4			* Circles - Bring cloud-users closer together.
5			*
6			* This file is licensed under the Affero General Public License version 3 or
7			* later. See the COPYING file.
8			*
9			* @author Maxence Lange <[email protected]>
10			* @copyright 2017
11			* @license GNU AGPL version 3 or any later version
12			*
13			* This program is free software: you can redistribute it and/or modify
14			* it under the terms of the GNU Affero General Public License as
15			* published by the Free Software Foundation, either version 3 of the
16			* License, or (at your option) any later version.
17			*
18			* This program is distributed in the hope that it will be useful,
19			* but WITHOUT ANY WARRANTY; without even the implied warranty of
20			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21			* GNU Affero General Public License for more details.
22			*
23			* You should have received a copy of the GNU Affero General Public License
24			* along with this program. If not, see <http://www.gnu.org/licenses/>.
25			*
26			*/
27
28			namespace OCA\Circles\Activity;
29
30			use OCA\Circles\Api\v1\Circles;
31			use OCA\Circles\Model\Circle;
32			use OCA\Circles\Model\FederatedLink;
33			use OCA\Circles\Model\Member;
34			use OCA\Circles\Service\FederatedLinkService;
35			use OCA\Circles\Service\MiscService;
36			use OCP\Activity\IEvent;
37			use OCP\Activity\IManager;
38			use OCP\IL10N;
39			use OCP\IURLGenerator;
40
41			class ProviderParser {
42
43
44			/** @var MiscService */
45			protected $miscService;
46
47			/** @var IL10N */
48			protected $l10n;
49
50			/** @var IURLGenerator */
51			protected $url;
52
53			/** @var IManager */
54			protected $activityManager;
55
56			public function __construct(
57			IURLGenerator $url, IManager $activityManager, IL10N $l10n, MiscService $miscService
58			) {
59			$this->url = $url;
60			$this->activityManager = $activityManager;
61			$this->l10n = $l10n;
62			$this->miscService = $miscService;
63			}
64
65
66			/**
67			* general function to generate Circle event.
68			*
69			* @param IEvent $event
70			* @param Circle $circle
71			* @param FederatedLink\|null $remote
72			* @param string $ownEvent
73			* @param string $othersEvent
74			*/
75			protected function parseCircleEvent(
76			IEvent &$event, Circle $circle, $remote, $ownEvent, $othersEvent
77			) {
78			$data = [
79			'author' => $this->generateViewerParameter($circle),
80			'circle' => $this->generateCircleParameter($circle),
81			'remote' => ($remote === null) ? [] : $this->generateRemoteCircleParameter($remote)
82			];
83
84			if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
85			$this->setSubject($event, $ownEvent, $data);
86
87			return;
88			}
89
90			$this->setSubject($event, $othersEvent, $data);
91			}
92
93
94			/**
95			* @param IEvent $event
96			* @param string $line
97			* @param array $data
98			*/
99			private function setSubject(IEvent $event, $line, $data) {
100			$this->setParsedSubject($event, $line, $data);
101			$this->setRichSubject($event, $line, $data);
102			}
103
104
105			/**
106			* @param IEvent $event
107			* @param string $line
108			* @param array $data
109			*/
110			private function setRichSubject(IEvent $event, $line, $data) {
111			$ak = array_keys($data);
112			foreach ($ak as $k) {
113			$subAk = array_keys($data[$k]);
114			foreach ($subAk as $sK) {
115			if (substr($sK, 0, 1) === '_') {
116			unset($data[$k][$sK]);
117			}
118			}
119			}
120
121			$event->setRichSubject($line, $data);
122			}
123
124
125			/**
126			* @param IEvent $event
127			* @param string $line
128			* @param array $data
129			*/
130			private function setParsedSubject(IEvent $event, $line, $data) {
131			$ak = array_keys($data);
132			$replace = [];
133			foreach ($ak as $k) {
134			if (!key_exists('_parsed', $data[$k])) {
135			continue;
136			}
137
138			$replace['{' . $k . '}'] = $data[$k]['_parsed'];
139			}
140
141			$line = strtr($line, $replace);
142
143			$event->setParsedSubject($line);
144			}
145
146
147			/**
148			* general function to generate Member event.
149			*
150			* @param Circle $circle
151			* @param $member
152			* @param IEvent $event
153			* @param $ownEvent
154			* @param $othersEvent
155			*/
156			protected function parseMemberEvent(
157			IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
158			) {
159			$data = [
160			'circle' => $this->generateCircleParameter($circle),
161			'member' => $this->generateUserParameter($member)
162			];
163
164			if ($member->getUserId() === $this->activityManager->getCurrentUserId()
165			) {
166			$event->setSubject($ownEvent, $data);
167
168			return;
169			}
170
171			$this->setSubject($event, $othersEvent, $data);
172			}
173
174
175			/**
176			* general function to generate Link event.
177			*
178			* @param Circle $circle
179			* @param FederatedLink $remote
180			* @param IEvent $event
181			* @param string $line
182			*/
183			protected function parseLinkEvent(IEvent &$event, Circle $circle, FederatedLink $remote, $line
184			) {
185			$data = [
186			'circle' => $this->generateCircleParameter($circle),
187			'remote' => $this->generateRemoteCircleParameter($remote)
188			];
189
190			$this->setSubject($event, $line, $data);
191			}
192
193
194			/**
195			* general function to generate Circle+Member event.
196			*
197			* @param Circle $circle
198			* @param Member $member
199			* @param IEvent $event
200			* @param string $ownEvent
201			* @param string $othersEvent
202			*/
203			protected function parseCircleMemberEvent(
204			IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
205			) {
206			$data = [
207			'author' => $this->generateViewerParameter($circle),
208			'circle' => $this->generateCircleParameter($circle),
209			'member' => $this->generateUserParameter($member),
210			'external' => $this->generateExternalMemberParameter($member),
211			'group' => $this->generateGroupParameter($member),
212			];
213
214			if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
215			$this->setSubject($event, $ownEvent, $data);
216
217			return;
218			}
219
220			$this->setSubject($event, $othersEvent, $data);
221			}
222
223
224			/**
225			* general function to generate Circle+Member advanced event.
226			*
227			* @param Circle $circle
228			* @param Member $member
229			* @param IEvent $event
230			* @param $ownEvent
231			* @param $targetEvent
232			* @param $othersEvent
233			*/
234			protected function parseCircleMemberAdvancedEvent(
235			IEvent &$event, Circle $circle, Member $member, $ownEvent, $targetEvent, $othersEvent
236			) {
237			$data = [
238			'author' => $this->generateViewerParameter($circle),
239			'circle' => $this->generateCircleParameter($circle),
240			'member' => $this->generateUserParameter($member)
241			];
242
243			if ($this->isViewerTheAuthor($circle, $this->activityManager->getCurrentUserId())) {
244			$this->setSubject($event, $ownEvent, $data);
245
246			return;
247			}
248
249			if ($member->getUserId() === $this->activityManager->getCurrentUserId()) {
250			$this->setSubject($event, $targetEvent, $data);
251
252			return;
253			}
254
255			$this->setSubject($event, $othersEvent, $data);
256			}
257
258
259			/**
260			* @param Circle $circle
261			* @param string $userId
262			*
263			* @return bool
264			*/
265			protected function isViewerTheAuthor(Circle $circle, $userId) {
266			if ($circle->getViewer() === null) {
267			return false;
268			}
269
270			if ($circle->getViewer()
			0 ignored issues – show Unused Code introduced 2017-07-28 02:28 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return $circle->getViewe...etUserId() === $userId;`. Loading history...
271			->getUserId() === $userId) {
272			return true;
273			}
274
275			return false;
276			}
277
278
279			/**
280			* @param Circle $circle
281			*
282			* @return string\|array <string,string\|integer>
283			*/
284			protected function generateViewerParameter(Circle $circle) {
285			if ($circle->getViewer() === null) {
286			return [];
287			}
288
289			return $this->generateUserParameter($circle->getViewer());
290			}
291
292
293			/**
294			* @param Member $member
295			*
296			* @return array\|string <string,string\|integer>
297			*/
298			protected function generateExternalMemberParameter(Member $member) {
299			return [
300			'type' => 'member_' . $member->getType(),
301			'id' => $member->getUserId(),
302			'name' => $member->getDisplayName() . ' (' . $member->getTypeString() . ')',
303			'_parsed' => $member->getDisplayName()
304			];
305			}
306
307
308			/**
309			* @param Circle $circle
310			*
311			* @return array<string,string\|integer>
312			*/
313			protected function generateCircleParameter(Circle $circle) {
314			return [
315			'type' => 'circle',
316			'id' => $circle->getId(),
317			'name' => $circle->getName(),
318			'_parsed' => $circle->getName(),
319			'link' => Circles::generateLink($circle->getUniqueId())
320			];
321			}
322
323
324			/**
325			* @param FederatedLink $link
326			*
327			* @return array<string,string\|integer>
			0 ignored issues – show Documentation introduced 2017-07-02 12:35 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string>`. 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...
328			*/
329			protected function generateRemoteCircleParameter(FederatedLink $link) {
330			return [
331			'type' => 'circle',
332			'id' => $link->getUniqueId(),
333			'name' => $link->getToken() . '@' . $link->getAddress(),
334			'_parsed' => $link->getToken() . '@' . $link->getAddress()
335			];
336			}
337
338
339			/**
340			* @param Member $member
341			*
342			* @return array <string,string\|integer>
			0 ignored issues – show Documentation introduced 2017-08-12 08:26 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string>`. 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...
343			*/
344			protected function generateUserParameter(Member $member) {
345			return [
346			'type' => 'user',
347			'id' => $member->getUserId(),
348			'name' => $this->miscService->getDisplayName($member->getUserId(), true),
349			'_parsed' => $this->miscService->getDisplayName($member->getUserId(), true)
350			];
351			}
352
353
354			/**
355			* @param Member $group
356			*
357			* @return array <string,string\|integer>
			0 ignored issues – show Documentation introduced 2017-08-12 08:26 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,string>`. 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...
358			*/
359			protected function generateGroupParameter($group) {
360			return [
361			'type' => 'group',
362			'id' => $group->getUserId(),
363			'name' => $group->getUserId(),
364			'_parsed' => $group->getUserId()
365			];
366			}
367
368			}

nextcloud / circles

Push — master ( a203f6...ccc5ed )

ProviderParser::generateGroupParameter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like