Notifier::prepare() - Code Metrics - Inspection of "Merge pull request #11891 from stweil/scrutinizer" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5cdc85...37718d )

by Morris

created 2018-10-24 12:02 UTC

Notifier::prepare() B

↳ Parent: Notifier

Complexity

Conditions	9
Paths	17

Size

Total Lines	84
Code Lines	59

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	59
nc	17
nop	2
dl	0
loc	84
rs	7.3389
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Arthur Schiwon <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Comments\Notification;

use OCP\Comments\ICommentsManager;
use OCP\Comments\NotFoundException;
use OCP\Files\IRootFolder;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Notification\INotification;
use OCP\Notification\INotifier;

class Notifier implements INotifier {

	/** @var IFactory */
	protected $l10nFactory;

	/** @var IRootFolder  */
	protected $rootFolder;

	/** @var ICommentsManager  */
	protected $commentsManager;

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

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

	public function __construct(
		IFactory $l10nFactory,
		IRootFolder $rootFolder,
		ICommentsManager $commentsManager,
		IURLGenerator $url,
		IUserManager $userManager
	) {
		$this->l10nFactory = $l10nFactory;
		$this->rootFolder = $rootFolder;
		$this->commentsManager = $commentsManager;
		$this->url = $url;
		$this->userManager = $userManager;
	}

	/**
	 * @param INotification $notification
	 * @param string $languageCode The code of the language that should be used to prepare the notification
	 * @return INotification
	 * @throws \InvalidArgumentException When the notification was not prepared by a notifier
	 */
	public function prepare(INotification $notification, $languageCode) {
		if($notification->getApp() !== 'comments') {
			throw new \InvalidArgumentException();
		}
		try {
			$comment = $this->commentsManager->get($notification->getObjectId());
		} catch(NotFoundException $e) {
			// needs to be converted to InvalidArgumentException, otherwise none Notifications will be shown at all
			throw new \InvalidArgumentException('Comment not found', 0, $e);
		}
		$l = $this->l10nFactory->get('comments', $languageCode);
		$displayName = $comment->getActorId();
		$isDeletedActor = $comment->getActorType() === ICommentsManager::DELETED_USER;
		if($comment->getActorType() === 'users') {
			$commenter = $this->userManager->get($comment->getActorId());
			if(!is_null($commenter)) {
				$displayName = $commenter->getDisplayName();
			}
		}

		switch($notification->getSubject()) {
			case 'mention':
				$parameters = $notification->getSubjectParameters();
				if($parameters[0] !== 'files') {
					throw new \InvalidArgumentException('Unsupported comment object');
				}
				$userFolder = $this->rootFolder->getUserFolder($notification->getUser());
				$nodes = $userFolder->getById((int)$parameters[1]);
				if(empty($nodes)) {
					throw new \InvalidArgumentException('Cannot resolve file ID to node instance');
				}
				$node = $nodes[0];

				if ($isDeletedActor) {
					$notification->setParsedSubject($l->t(
							'You were mentioned on “%s”, in a comment by a user that has since been deleted',
							[$node->getName()]
						))
						->setRichSubject(
							$l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted'),
							[
								'file' => [
									'type' => 'file',
									'id' => $comment->getObjectId(),
									'name' => $node->getName(),
									'path' => $node->getPath(),
									'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
								],
							]
						);
				} else {
					$notification->setParsedSubject($l->t(
							'%1$s mentioned you in a comment on “%2$s”',
							[$displayName, $node->getName()]
						))
						->setRichSubject(
							$l->t('{user} mentioned you in a comment on “{file}”'),
							[
								'user' => [
									'type' => 'user',
									'id' => $comment->getActorId(),
									'name' => $displayName,
								],
								'file' => [
									'type' => 'file',
									'id' => $comment->getObjectId(),
									'name' => $node->getName(),
									'path' => $node->getPath(),
									'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
								],
							]
						);
				}
				$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
					->setLink($this->url->linkToRouteAbsolute(
						'comments.Notifications.view',
						['id' => $comment->getId()])
					);

				return $notification;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

			default:
				throw new \InvalidArgumentException('Invalid subject');
		}

	}
}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Arthur Schiwon <[email protected]>
6			* @author Joas Schilling <[email protected]>
7			* @author Roeland Jago Douma <[email protected]>
8			*
9			* @license AGPL-3.0
10			*
11			* This code is free software: you can redistribute it and/or modify
12			* it under the terms of the GNU Affero General Public License, version 3,
13			* as published by the Free Software Foundation.
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, version 3,
21			* along with this program. If not, see <http://www.gnu.org/licenses/>
22			*
23			*/
24
25			namespace OCA\Comments\Notification;
26
27			use OCP\Comments\ICommentsManager;
28			use OCP\Comments\NotFoundException;
29			use OCP\Files\IRootFolder;
30			use OCP\IURLGenerator;
31			use OCP\IUserManager;
32			use OCP\L10N\IFactory;
33			use OCP\Notification\INotification;
34			use OCP\Notification\INotifier;
35
36			class Notifier implements INotifier {
37
38			/** @var IFactory */
39			protected $l10nFactory;
40
41			/** @var IRootFolder */
42			protected $rootFolder;
43
44			/** @var ICommentsManager */
45			protected $commentsManager;
46
47			/** @var IURLGenerator */
48			protected $url;
49
50			/** @var IUserManager */
51			protected $userManager;
52
53			public function __construct(
54			IFactory $l10nFactory,
55			IRootFolder $rootFolder,
56			ICommentsManager $commentsManager,
57			IURLGenerator $url,
58			IUserManager $userManager
59			) {
60			$this->l10nFactory = $l10nFactory;
61			$this->rootFolder = $rootFolder;
62			$this->commentsManager = $commentsManager;
63			$this->url = $url;
64			$this->userManager = $userManager;
65			}
66
67			/**
68			* @param INotification $notification
69			* @param string $languageCode The code of the language that should be used to prepare the notification
70			* @return INotification
71			* @throws \InvalidArgumentException When the notification was not prepared by a notifier
72			*/
73			public function prepare(INotification $notification, $languageCode) {
74			if($notification->getApp() !== 'comments') {
75			throw new \InvalidArgumentException();
76			}
77			try {
78			$comment = $this->commentsManager->get($notification->getObjectId());
79			} catch(NotFoundException $e) {
80			// needs to be converted to InvalidArgumentException, otherwise none Notifications will be shown at all
81			throw new \InvalidArgumentException('Comment not found', 0, $e);
82			}
83			$l = $this->l10nFactory->get('comments', $languageCode);
84			$displayName = $comment->getActorId();
85			$isDeletedActor = $comment->getActorType() === ICommentsManager::DELETED_USER;
86			if($comment->getActorType() === 'users') {
87			$commenter = $this->userManager->get($comment->getActorId());
88			if(!is_null($commenter)) {
89			$displayName = $commenter->getDisplayName();
90			}
91			}
92
93			switch($notification->getSubject()) {
94			case 'mention':
95			$parameters = $notification->getSubjectParameters();
96			if($parameters[0] !== 'files') {
97			throw new \InvalidArgumentException('Unsupported comment object');
98			}
99			$userFolder = $this->rootFolder->getUserFolder($notification->getUser());
100			$nodes = $userFolder->getById((int)$parameters[1]);
101			if(empty($nodes)) {
102			throw new \InvalidArgumentException('Cannot resolve file ID to node instance');
103			}
104			$node = $nodes[0];
105
106			if ($isDeletedActor) {
107			$notification->setParsedSubject($l->t(
108			'You were mentioned on “%s”, in a comment by a user that has since been deleted',
109			[$node->getName()]
110			))
111			->setRichSubject(
112			$l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted'),
113			[
114			'file' => [
115			'type' => 'file',
116			'id' => $comment->getObjectId(),
117			'name' => $node->getName(),
118			'path' => $node->getPath(),
119			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
120			],
121			]
122			);
123			} else {
124			$notification->setParsedSubject($l->t(
125			'%1$s mentioned you in a comment on “%2$s”',
126			[$displayName, $node->getName()]
127			))
128			->setRichSubject(
129			$l->t('{user} mentioned you in a comment on “{file}”'),
130			[
131			'user' => [
132			'type' => 'user',
133			'id' => $comment->getActorId(),
134			'name' => $displayName,
135			],
136			'file' => [
137			'type' => 'file',
138			'id' => $comment->getObjectId(),
139			'name' => $node->getName(),
140			'path' => $node->getPath(),
141			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
142			],
143			]
144			);
145			}
146			$notification->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
147			->setLink($this->url->linkToRouteAbsolute(
148			'comments.Notifications.view',
149			['id' => $comment->getId()])
150			);
151
152			return $notification;
153			break;
			0 ignored issues – show Unused Code introduced 2018-10-24 12:40 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
154
155			default:
156			throw new \InvalidArgumentException('Invalid subject');
157			}
158
159			}
160			}
161

nextcloud / server

Push — master ( 5cdc85...37718d )

Notifier::prepare() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like