Provider::generateViewerParameter() - Code Metrics - Inspection of "Use UniqueID" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#105)

by Maxence
created 2017-07-28 02:26 UTC
Provider::generateViewerParameter() A

↳ Parent: Provider
Complexity

Conditions	2
Paths	2
Size

Total Lines	10
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	2
eloc	6
nc	2
nop	1
<?php


namespace OCA\Circles\Activity;


use Exception;
use InvalidArgumentException;
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\CirclesService;
use OCA\Circles\Service\MiscService;
use OCP\Activity\IEvent;
use OCP\Activity\IManager;
use OCP\Activity\IProvider;
use OCP\IL10N;
use OCP\IURLGenerator;
use OpenCloud\Common\Exceptions\InvalidArgumentError;


class Provider implements IProvider {

	/** @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;
	}


	/**
	 * @param string $lang
	 * @param IEvent $event
	 * @param IEvent|null $previousEvent
	 *
	 * @return IEvent
	 */
	public function parse($lang, IEvent $event, IEvent $previousEvent = null) {

		if ($event->getApp() !== 'circles') {
			throw new \InvalidArgumentException();
		}

		try {

			$params = $event->getSubjectParameters();
			$circle = Circle::fromJSON($this->l10n, $params['circle']);

			$this->setIcon($event, $circle);
			$this->parseAsMember($event, $circle, $params);
			$this->parseAsModerator($event, $circle, $params);
			$this->generateParsedSubject($event);

			return $event;
		} catch (\Exception $e) {
			throw new \InvalidArgumentException();
		}
	}


	private function setIcon(IEvent &$event, Circle $circle) {
		$event->setIcon(
			CirclesService::getCircleIcon(
				$circle->getType(),
				(method_exists($this->activityManager, 'getRequirePNG')
				 && $this->activityManager->getRequirePNG())
			)
		);
	}

	/**
	 * @param Circle $circle
	 * @param IEvent $event
	 * @param array $params
	 *
	 * @return IEvent
	 */
	private function parseAsMember(IEvent &$event, Circle $circle, $params) {
		if ($event->getType() !== 'circles_as_member') {
			return $event;
		}

		switch ($event->getSubject()) {
			case 'circle_create':
				return $this->parseCircleEvent(
					$event, $circle, null,
					$this->l10n->t('You created the circle {circle}'),
					$this->l10n->t('{author} created the circle {circle}')
				);

			case 'circle_delete':
				return $this->parseCircleEvent(
					$event, $circle, null,
					$this->l10n->t('You deleted {circle}'),
					$this->l10n->t('{author} deleted {circle}')
				);
		}

		if (key_exists('member', $params)) {
			$this->parseMemberAsMember($event, $circle);
		}

		return $event;
	}


	/**
	 * @param Circle $circle
	 * @param IEvent $event
	 *
	 * @return IEvent
	 */
	private function parseMemberAsMember(IEvent &$event, Circle $circle) {
		$params = $event->getSubjectParameters();
		$member = Member::fromJSON($this->l10n, $params['member']);

		switch ($event->getSubject()) {
			case 'member_join':

				return $this->parseCircleMemberEvent(
					$event, $circle, $member,
					$this->l10n->t('You joined {circle}'),
					$this->l10n->t('{member} joined {circle}')
				);

			case 'member_add':

				return $this->parseCircleMemberAdvancedEvent(
					$event, $circle, $member,
					$this->l10n->t('You added {member} as member to {circle}'),
					$this->l10n->t('You were added as member to {circle} by {author}'),
					$this->l10n->t('{member} was added as member to {circle} by {author}')
				);

			case 'member_left':

				return $this->parseCircleMemberEvent(
					$event, $circle, $member,
					$this->l10n->t('You left {circle}'),
					$this->l10n->t('{member} left {circle}')
				);

			case 'member_remove':

				return $this->parseCircleMemberAdvancedEvent(
					$event, $circle, $member,
					$this->l10n->t('You removed {member} from {circle}'),
					$this->l10n->t('You were removed from {circle} by {author}'),
					$this->l10n->t('{member} was removed from {circle} by {author}')
				);
		}

		return $event;
	}


	/**
	 * @param Circle $circle
	 * @param IEvent $event
	 * @param array $params
	 *
	 * @return IEvent
	 * @throws Exception
	 */
	private function parseAsModerator(IEvent &$event, Circle $circle, $params) {
		if ($event->getType() !== 'circles_as_moderator') {
			return $event;
		}

		try {
			if (key_exists('member', $params)) {
				return $this->parseMemberAsModerator($event, $circle);
			}

			if (key_exists('link', $params)) {
				return $this->parseLinkAsModerator($event, $circle);
			}

			throw new InvalidArgumentError();
		} catch (Exception $e) {
			throw $e;
		}
	}


	/**
	 * @param Circle $circle
	 * @param IEvent $event
	 *
	 * @return IEvent
	 */
	private function parseMemberAsModerator(IEvent &$event, Circle $circle) {

		$params = $event->getSubjectParameters();
		$member = Member::fromJSON($this->l10n, $params['member']);

		switch ($event->getSubject()) {
			case 'member_invited':

				return $this->parseCircleMemberAdvancedEvent(
					$event, $circle, $member,
					$this->l10n->t('You invited {member} into {circle}'),
					$this->l10n->t('You have been invited into {circle} by {author}'),
					$this->l10n->t('{member} have been invited into {circle} by {author}')
				);

			case 'member_level':
				$level = [$this->l10n->t($member->getLevelString())];

				return $this->parseCircleMemberAdvancedEvent(
					$event, $circle, $member,
					$this->l10n->t('You changed {member}\'s level in {circle} to %1$s', $level),
					$this->l10n->t('{author} changed your level in {circle} to %1$s', $level),
					$this->l10n->t('{author} changed {member}\'s level in {circle} to %1$s', $level)
				);

			case 'member_request_invitation':

				return $this->parseMemberEvent(
					$event, $circle, $member,
					$this->l10n->t('You requested an invitation into {circle}'),
					$this->l10n->t(
						'{member} has requested an invitation into {circle}'
					)
				);

			case 'member_owner':

				return $this->parseMemberEvent(
					$event, $circle, $member,
					$this->l10n->t('You are the new owner of {circle}'),
					$this->l10n->t('{member} is the new owner of {circle}')
				);
		}

		throw new InvalidArgumentException();
	}


	/**
	 * @param Circle $circle
	 * @param IEvent $event
	 *
	 * @return IEvent
	 */
	private function parseLinkAsModerator(IEvent &$event, Circle $circle) {

		$params = $event->getSubjectParameters();
		$remote = FederatedLink::fromJSON($params['link']);

		switch ($event->getSubject()) {
			case 'link_request_sent':

				return $this->parseCircleEvent(
					$event, $circle, $remote,
					$this->l10n->t('You sent a request to link {circle} with {remote}'),
					$this->l10n->t('{author} sent a request to link {circle} with {remote}')
				);

			case 'link_request_received';
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				return $this->parseLinkEvent(
					$event, $circle, $remote,
					$this->l10n->t('{remote} requested a link with {circle}')
				);

			case 'link_request_rejected';
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
				return $this->parseLinkEvent(
					$event, $circle, $remote, $this->l10n->t(
					'The request to link {circle} with {remote} has been rejected'
				)
				);

			case 'link_request_canceled':
				return $this->parseLinkEvent(
					$event, $circle, $remote,
					$this->l10n->t(
						'The request to link {remote} with {circle} has been canceled remotely'
					)
				);

			case 'link_request_accepted':
				return $this->parseLinkEvent(
					$event, $circle, $remote,
					$this->l10n->t('The request to link {circle} with {remote} has been accepted')
				);

			case 'link_request_removed':

				return $this->parseCircleEvent(
					$event, $circle, $remote,
					$this->l10n->t('You dismissed the request to link {remote} with {circle}'),
					$this->l10n->t('{author} dismissed the request to link {remote} with {circle}')
				);

			case 'link_request_canceling':

				return $this->parseCircleEvent(
					$event, $circle, $remote,
					$this->l10n->t('You canceled the request to link {circle} with {remote}'),
					$this->l10n->t('{author} canceled the request to link {circle} with {remote}')
				);

			case 'link_request_accepting':

				return $this->parseCircleEvent(
					$event, $circle, $remote,
					$this->l10n->t('You accepted the request to link {remote} with {circle}'),
					$this->l10n->t('{author} accepted the request to link {remote} with {circle}')
				);

			case 'link_up':
				return $this->parseLinkEvent(
					$event, $circle, $remote,
					$this->l10n->t('A link between {circle} and {remote} is now up and running')
				);

			case 'link_down':
				return $this->parseLinkEvent(
					$event, $circle, $remote,
					$this->l10n->t(
						'The link between {circle} and {remote} has been shutdown remotely'
					)
				);

			case 'link_remove':

				return $this->parseCircleEvent(
					$event, $circle, $remote,
					$this->l10n->t('You closed the link between {circle} and {remote}'),
					$this->l10n->t('{author} closed the link between {circle} and {remote}')
				);
		}

		throw new InvalidArgumentException();
	}


	/**
	 * general function to generate Circle event.
	 *
	 * @param IEvent $event
	 * @param Circle $circle
	 * @param FederatedLink $remote
	 * @param string $ownEvent
	 * @param string $othersEvent
	 *
	 * @return IEvent
	 */
	private 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())) {
			return $event->setRichSubject($ownEvent, $data);
		}

		return $event->setRichSubject($othersEvent, $data);
	}


	/**
	 * general function to generate Member event.
	 *
	 * @param Circle $circle
	 * @param $member
	 * @param IEvent $event
	 * @param $ownEvent
	 * @param $othersEvent
	 *
	 * @return IEvent
	 */
	private function parseMemberEvent(

		IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
	) {
		$data = [
			'circle' => $this->generateCircleParameter($circle),
			'member' => $this->generateMemberParameter($member)
		];

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

		return $event->setRichSubject($othersEvent, $data);
	}


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

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


	/**
	 * general function to generate Circle+Member event.
	 *
	 * @param Circle $circle
	 * @param Member $member
	 * @param IEvent $event
	 * @param string $ownEvent
	 * @param string $othersEvent
	 *
	 * @return IEvent
	 */
	private function parseCircleMemberEvent(

		IEvent &$event, Circle $circle, Member $member, $ownEvent, $othersEvent
	) {
		$data = [
			'circle' => $this->generateCircleParameter($circle),
			'member' => $this->generateMemberParameter($member)
		];

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

		return $event->setRichSubject($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
	 *
	 * @return IEvent
	 */
	private function parseCircleMemberAdvancedEvent(
		IEvent &$event, Circle $circle, Member $member, $ownEvent, $targetEvent, $othersEvent
	) {

		$data = [
			'author' => $this->generateViewerParameter($circle),
			'circle' => $this->generateCircleParameter($circle),
			'member' => $this->generateMemberParameter($member)
		];

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

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

		return $event->setRichSubject($othersEvent, $data);
	}


	/**
	 * @param IEvent $event
	 */
	private function generateParsedSubject(IEvent &$event) {
		$subject = $event->getRichSubject();
		$params = $event->getRichSubjectParameters();
		$ak = array_keys($params);
		foreach ($ak as $k) {
			if (is_array($params[$k])) {
				$subject = str_replace('{' . $k . '}', $params[$k]['parsed'], $subject);
			}
		}

		$event->setParsedSubject($subject);
	}


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

		if ($circle->getViewer()

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

		return false;
	}


	/**
	 * @param Member $member
	 *
	 * @return array<string,string|integer>
	 */
	private function generateMemberParameter(Member $member) {
		return $this->generateUserParameter($member->getUserId());
	}

	/**
	 * @param Circle $circle
	 *
	 * @return array <string,string|integer>

	 */
	private function generateViewerParameter(Circle $circle) {
		if ($circle->getViewer() === null) {
			return '';
		}

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


	/**
	 * @param Circle $circle
	 *
	 * @return array<string,string|integer>
	 */
	private 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>

	 */
	private function generateRemoteCircleParameter(FederatedLink $link) {
		return [
			'type'   => 'circle',
			'id'     => $link->getUniqueId(),
			'name'   => $link->getToken() . '@' . $link->getAddress(),
			'parsed' => $link->getToken() . '@' . $link->getAddress()
		];
//			'link' => Circles::generateRemoteLink($link)

	}


	/**
	 * @param $userId
	 *
	 * @return array<string,string|integer>
	 */
	private function generateUserParameter($userId) {
		return [
			'type'   => 'user',
			'id'     => $userId,
			'name'   => \OC::$server->getUserManager()
									->get($userId)
									->getDisplayName(),
			'parsed' => \OC::$server->getUserManager()
									->get($userId)
									->getDisplayName()
		];
	}
}

1			<?php
2
3
4			namespace OCA\Circles\Activity;
5
6
7			use Exception;
8			use InvalidArgumentException;
9			use OCA\Circles\Api\v1\Circles;
10			use OCA\Circles\Model\Circle;
11			use OCA\Circles\Model\FederatedLink;
12			use OCA\Circles\Model\Member;
13			use OCA\Circles\Service\CirclesService;
14			use OCA\Circles\Service\MiscService;
15			use OCP\Activity\IEvent;
16			use OCP\Activity\IManager;
17			use OCP\Activity\IProvider;
18			use OCP\IL10N;
19			use OCP\IURLGenerator;
20			use OpenCloud\Common\Exceptions\InvalidArgumentError;
21
22
23			class Provider implements IProvider {
24
25			/** @var MiscService */
26			protected $miscService;
27
28			/** @var IL10N */
29			protected $l10n;
30
31			/** @var IURLGenerator */
32			protected $url;
33
34			/** @var IManager */
35			protected $activityManager;
36
37			public function __construct(
38			IURLGenerator $url, IManager $activityManager, IL10N $l10n, MiscService $miscService
39			) {
40			$this->url = $url;
nextcloud / circles

Pull Request — master (#105)

Provider::generateViewerParameter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
