EndpointController::deleteAllNotifications() - Code Metrics - Inspection of ""Dismiss all notifications" button" - nextcloud/notifications - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#112)

by Joas

created 2018-01-30 11:34 UTC

EndpointController::deleteAllNotifications() A

↳ Parent: EndpointController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0
crap	1

<?php
/**
 * @author Joas Schilling <[email protected]>
 *
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @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\Notifications\Controller;

use OCA\Notifications\Handler;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserSession;
use OCP\Notification\IAction;
use OCP\Notification\IManager;
use OCP\Notification\INotification;

class EndpointController extends OCSController {
	/** @var Handler */
	private $handler;

	/** @var IManager */
	private $manager;

	/** @var IUserSession */
	private $session;

	/** @var IConfig */
	private $config;

	/**
	 * @param string $appName
	 * @param IRequest $request
	 * @param Handler $handler
	 * @param IManager $manager
	 * @param IConfig $config
	 * @param IUserSession $session
	 */
	public function __construct($appName, IRequest $request, Handler $handler, IManager $manager, IConfig $config, IUserSession $session) {
		parent::__construct($appName, $request);

		$this->handler = $handler;
		$this->manager = $manager;
		$this->config = $config;
		$this->session = $session;
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @param string $apiVersion
	 * @return DataResponse
	 */
	public function listNotifications($apiVersion) {
		// When there are no apps registered that use the notifications
		// We stop polling for them.
		if (!$this->manager->hasNotifiers()) {
			return new DataResponse(null, Http::STATUS_NO_CONTENT);
		}

		$filter = $this->manager->createNotification();
		$filter->setUser($this->getCurrentUser());
		$language = $this->config->getUserValue($this->getCurrentUser(), 'core', 'lang', null);

		$notifications = $this->handler->get($filter);

		$data = [];
		$notificationIds = [];
		foreach ($notifications as $notificationId => $notification) {
			/** @var INotification $notification */
			try {
				$notification = $this->manager->prepare($notification, $language);
			} catch (\InvalidArgumentException $e) {
				// The app was disabled, skip the notification
				continue;
			}

			$notificationIds[] = $notificationId;
			$data[] = $this->notificationToArray($notificationId, $notification, $apiVersion);
		}

		$etag = $this->generateEtag($notificationIds);
		if ($apiVersion !== 'v1' && $this->request->getHeader('If-None-Match') === $etag) {
			return new DataResponse([], Http::STATUS_NOT_MODIFIED);
		}

		return new DataResponse($data, Http::STATUS_OK, ['ETag' => $etag]);
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @param string $apiVersion
	 * @param int $id
	 * @return DataResponse
	 */
	public function getNotification($apiVersion, $id) {
		if (!$this->manager->hasNotifiers()) {
			return new DataResponse(null, Http::STATUS_NOT_FOUND);
		}

		if (!is_int($id) || $id === 0) {

			return new DataResponse(null, Http::STATUS_NOT_FOUND);
		}

		$notification = $this->handler->getById($id, $this->getCurrentUser());

		if (!($notification instanceof INotification)) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return new DataResponse(null, Http::STATUS_NOT_FOUND);
		}

		$language = $this->config->getUserValue($this->getCurrentUser(), 'core', 'lang', null);

		try {
			$notification = $this->manager->prepare($notification, $language);
		} catch (\InvalidArgumentException $e) {
			// The app was disabled
			return new DataResponse(null, Http::STATUS_NOT_FOUND);
		}

		return new DataResponse($this->notificationToArray($id, $notification, $apiVersion));
	}

	/**
	 * @NoAdminRequired
	 *
	 * @param int $id
	 * @return DataResponse
	 */
	public function deleteNotification($id = 0) {
		if (!is_int($id) || $id === 0) {

			return new DataResponse(null, Http::STATUS_NOT_FOUND);
		}
		$id = (int) $id;

		$this->handler->deleteById($id, $this->getCurrentUser());
		return new DataResponse();
	}

	/**
	 * @NoAdminRequired
	 *
	 * @return DataResponse
	 */
	public function deleteAllNotifications(): DataResponse {
		$this->handler->deleteByUser($this->getCurrentUser());
		return new DataResponse();
	}

	/**
	 * Get an Etag for the notification ids
	 *
	 * @param array $notifications
	 * @return string
	 */
	protected function generateEtag(array $notifications) {
		return md5(json_encode($notifications));
	}

	/**
	 * @param int $notificationId
	 * @param INotification $notification
	 * @param string $apiVersion
	 * @return array
	 */
	protected function notificationToArray($notificationId, INotification $notification, $apiVersion) {
		$data = [
			'notification_id' => $notificationId,
			'app' => $notification->getApp(),
			'user' => $notification->getUser(),
			'datetime' => $notification->getDateTime()->format('c'),
			'object_type' => $notification->getObjectType(),
			'object_id' => $notification->getObjectId(),
			'subject' => $notification->getParsedSubject(),
			'message' => $notification->getParsedMessage(),
			'link' => $notification->getLink(),
		];

		if ($apiVersion !== 'v1') {
			$data = array_merge($data, [
				'subjectRich' => $notification->getRichSubject(),
				'subjectRichParameters' => $notification->getRichSubjectParameters(),
				'messageRich' => $notification->getRichMessage(),
				'messageRichParameters' => $notification->getRichMessageParameters(),
				'icon' => $notification->getIcon(),
			]);
		}

		$data['actions'] = [];
		foreach ($notification->getParsedActions() as $action) {
			$data['actions'][] = $this->actionToArray($action);
		}

		return $data;
	}

	/**
	 * @param IAction $action
	 * @return array
	 */
	protected function actionToArray(IAction $action) {
		return [
			'label' => $action->getParsedLabel(),
			'link' => $action->getLink(),
			'type' => $action->getRequestType(),
			'primary' => $action->isPrimary(),
		];
	}

	/**
	 * @return string
	 */
	protected function getCurrentUser() {
		$user = $this->session->getUser();
		if ($user instanceof IUser) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			$user = $user->getUID();
		}

		return (string) $user;
	}
}


Pull Request — master (#112)

EndpointController::deleteAllNotifications() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* @author Joas Schilling <[email protected]>
4			*
5			* @copyright Copyright (c) 2016, ownCloud, Inc.
6			* @license AGPL-3.0
7			*
8			* This code is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU Affero General Public License, version 3,
10			* as published by the Free Software Foundation.
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, version 3,
18			* along with this program. If not, see <http://www.gnu.org/licenses/>
19			*
20			*/
21
22			namespace OCA\Notifications\Controller;
23
24			use OCA\Notifications\Handler;
25			use OCP\AppFramework\Http;
26			use OCP\AppFramework\Http\DataResponse;
27			use OCP\AppFramework\OCSController;
28			use OCP\IConfig;
29			use OCP\IRequest;
30			use OCP\IUser;
31			use OCP\IUserSession;
32			use OCP\Notification\IAction;
33			use OCP\Notification\IManager;
34			use OCP\Notification\INotification;
35
36			class EndpointController extends OCSController {
37			/** @var Handler */
38			private $handler;
39
40			/** @var IManager */
41			private $manager;
42
43			/** @var IUserSession */
44			private $session;
45
46			/** @var IConfig */
47			private $config;
48
49			/**
50			* @param string $appName
51			* @param IRequest $request
52			* @param Handler $handler
53			* @param IManager $manager
54			* @param IConfig $config
55			* @param IUserSession $session
56			*/
57	25		public function __construct($appName, IRequest $request, Handler $handler, IManager $manager, IConfig $config, IUserSession $session) {
58	25		parent::__construct($appName, $request);
59
60	25		$this->handler = $handler;
61	25		$this->manager = $manager;
62	25		$this->config = $config;
63	25		$this->session = $session;
64	25		}
65
66			/**
67			* @NoAdminRequired
68			* @NoCSRFRequired
69			*
70			* @param string $apiVersion
71			* @return DataResponse
72			*/
73	6		public function listNotifications($apiVersion) {
74			// When there are no apps registered that use the notifications
75			// We stop polling for them.
76	6		if (!$this->manager->hasNotifiers()) {
77	2		return new DataResponse(null, Http::STATUS_NO_CONTENT);
78			}
79
80	4		$filter = $this->manager->createNotification();
81	4		$filter->setUser($this->getCurrentUser());
82	4		$language = $this->config->getUserValue($this->getCurrentUser(), 'core', 'lang', null);
83
84	4		$notifications = $this->handler->get($filter);
85
86	4		$data = [];
87	4		$notificationIds = [];
88	4		foreach ($notifications as $notificationId => $notification) {
89			/** @var INotification $notification */
90			try {
91	3		$notification = $this->manager->prepare($notification, $language);
92	1		} catch (\InvalidArgumentException $e) {
93			// The app was disabled, skip the notification
94	1		continue;
95			}
96
97	3		$notificationIds[] = $notificationId;
98	3		$data[] = $this->notificationToArray($notificationId, $notification, $apiVersion);
99			}
100
101	4		$etag = $this->generateEtag($notificationIds);
102	4		if ($apiVersion !== 'v1' && $this->request->getHeader('If-None-Match') === $etag) {
103			return new DataResponse([], Http::STATUS_NOT_MODIFIED);
104			}
105
106	4		return new DataResponse($data, Http::STATUS_OK, ['ETag' => $etag]);
107			}
108
109			/**
110			* @NoAdminRequired
111			* @NoCSRFRequired
112			*
113			* @param string $apiVersion
114			* @param int $id
115			* @return DataResponse
116			*/
117	6		public function getNotification($apiVersion, $id) {
118	6		if (!$this->manager->hasNotifiers()) {
119	1		return new DataResponse(null, Http::STATUS_NOT_FOUND);
120			}
121
122	5	View Code Duplication	if (!is_int($id) \|\| $id === 0) {
			0 ignored issues – show Duplication introduced 2016-09-05 15:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
123			return new DataResponse(null, Http::STATUS_NOT_FOUND);
124			}
125
126	5		$notification = $this->handler->getById($id, $this->getCurrentUser());
127
128	5		if (!($notification instanceof INotification)) {
			0 ignored issues – show Bug introduced 2016-07-01 11:27 UTC by Report Bug Copy Issue Report The class `OCP\Notification\INotification` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
129	1		return new DataResponse(null, Http::STATUS_NOT_FOUND);
130			}
131
132	4		$language = $this->config->getUserValue($this->getCurrentUser(), 'core', 'lang', null);
133
134			try {
135	4		$notification = $this->manager->prepare($notification, $language);
136	2		} catch (\InvalidArgumentException $e) {
137			// The app was disabled
138	2		return new DataResponse(null, Http::STATUS_NOT_FOUND);
139			}
140
141	2		return new DataResponse($this->notificationToArray($id, $notification, $apiVersion));
142			}
143
144			/**
145			* @NoAdminRequired
146			*
147			* @param int $id
148			* @return DataResponse
149			*/
150	3		public function deleteNotification($id = 0) {
151	3	View Code Duplication	if (!is_int($id) \|\| $id === 0) {
			0 ignored issues – show Duplication introduced 2016-09-05 15:20 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
152	1		return new DataResponse(null, Http::STATUS_NOT_FOUND);
153			}
154	2		$id = (int) $id;
155
156	2		$this->handler->deleteById($id, $this->getCurrentUser());
157	2		return new DataResponse();
158			}
159
160			/**
161			* @NoAdminRequired
162			*
163			* @return DataResponse
164			*/
165	2		public function deleteAllNotifications(): DataResponse {
166	2		$this->handler->deleteByUser($this->getCurrentUser());
167	2		return new DataResponse();
168			}
169
170			/**
171			* Get an Etag for the notification ids
172			*
173			* @param array $notifications
174			* @return string
175			*/
176	4		protected function generateEtag(array $notifications) {
177	4		return md5(json_encode($notifications));
178			}
179
180			/**
181			* @param int $notificationId
182			* @param INotification $notification
183			* @param string $apiVersion
184			* @return array
185			*/
186	4		protected function notificationToArray($notificationId, INotification $notification, $apiVersion) {
187			$data = [
188	4		'notification_id' => $notificationId,
189	4		'app' => $notification->getApp(),
190	4		'user' => $notification->getUser(),
191	4		'datetime' => $notification->getDateTime()->format('c'),
192	4		'object_type' => $notification->getObjectType(),
193	4		'object_id' => $notification->getObjectId(),
194	4		'subject' => $notification->getParsedSubject(),
195	4		'message' => $notification->getParsedMessage(),
196	4		'link' => $notification->getLink(),
197			];
198
199	4		if ($apiVersion !== 'v1') {
200	2		$data = array_merge($data, [
201	2		'subjectRich' => $notification->getRichSubject(),
202	2		'subjectRichParameters' => $notification->getRichSubjectParameters(),
203	2		'messageRich' => $notification->getRichMessage(),
204	2		'messageRichParameters' => $notification->getRichMessageParameters(),
205	2		'icon' => $notification->getIcon(),
206			]);
207			}
208
209	4		$data['actions'] = [];
210	4		foreach ($notification->getParsedActions() as $action) {
211	2		$data['actions'][] = $this->actionToArray($action);
212			}
213
214	4		return $data;
215			}
216
217			/**
218			* @param IAction $action
219			* @return array
220			*/
221	2		protected function actionToArray(IAction $action) {
222			return [
223	2		'label' => $action->getParsedLabel(),
224	2		'link' => $action->getLink(),
225	2		'type' => $action->getRequestType(),
226	2		'primary' => $action->isPrimary(),
227			];
228			}
229
230			/**
231			* @return string
232			*/
233	13		protected function getCurrentUser() {
234	13		$user = $this->session->getUser();
235	13		if ($user instanceof IUser) {
			0 ignored issues – show Bug introduced 2016-07-01 11:27 UTC by Report Bug Copy Issue Report The class `OCP\IUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
236	13		$user = $user->getUID();
237			}
238
239	13		return (string) $user;
240			}
241			}
242

nextcloud / notifications

Pull Request — master (#112)

EndpointController::deleteAllNotifications() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like