Completed
Pull Request — master (#99)
by Joas
02:54
created

Push::pushToDevice()   D

Complexity

Conditions 23
Paths 183

Size

Total Lines 98
Code Lines 59

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 57
CRAP Score 23

Importance

Changes 0
Metric Value
dl 0
loc 98
ccs 57
cts 57
cp 1
rs 4.3705
c 0
b 0
f 0
cc 23
eloc 59
nc 183
nop 1
crap 23

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * @copyright Copyright (c) 2017 Joas Schilling <[email protected]>
4
 *
5
 * @license GNU AGPL version 3 or any later version
6
 *
7
 * This program is free software: you can redistribute it and/or modify
8
 * it under the terms of the GNU Affero General Public License as
9
 * published by the Free Software Foundation, either version 3 of the
10
 * License, or (at your option) any later version.
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
18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 *
20
 */
21
22
namespace OCA\Notifications;
23
24
25
use OC\Authentication\Exceptions\InvalidTokenException;
26
use OC\Authentication\Token\IProvider;
27
use OC\Security\IdentityProof\Key;
28
use OC\Security\IdentityProof\Manager;
29
use OCP\AppFramework\Http;
30
use OCP\DB\QueryBuilder\IQueryBuilder;
31
use OCP\Http\Client\IClientService;
32
use OCP\IConfig;
33
use OCP\IDBConnection;
34
use OCP\ILogger;
35
use OCP\IUser;
36
use OCP\IUserManager;
37
use OCP\Notification\IManager as INotificationManager;
38
use OCP\Notification\INotification;
39
40
class Push {
41
	/** @var IDBConnection */
42
	protected $db;
43
	/** @var INotificationManager */
44
	protected $notificationManager;
45
	/** @var IConfig */
46
	protected $config;
47
	/** @var IProvider */
48
	protected $tokenProvider;
49
	/** @var Manager */
50
	private $keyManager;
51
	/** @var IUserManager */
52
	private $userManager;
53
	/** @var IClientService */
54
	protected $clientService;
55
	/** @var ILogger */
56
	protected $log;
57
58 19
	public function __construct(IDBConnection $connection, INotificationManager $notificationManager, IConfig $config, IProvider $tokenProvider, Manager $keyManager, IUserManager $userManager, IClientService $clientService, ILogger $log) {
59 19
		$this->db = $connection;
60 19
		$this->notificationManager = $notificationManager;
61 19
		$this->config = $config;
62 19
		$this->tokenProvider = $tokenProvider;
63 19
		$this->keyManager = $keyManager;
64 19
		$this->userManager = $userManager;
65 19
		$this->clientService = $clientService;
66 19
		$this->log = $log;
67 19
	}
68
69
	/**
70
	 * @param INotification $notification
71
	 */
72 15
	public function pushToDevice(INotification $notification) {
73 15
		$user = $this->userManager->get($notification->getUser());
74 15
		if (!($user instanceof IUser)) {
0 ignored issues
show
Bug introduced by
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...
75 1
			return;
76
		}
77
78 14
		$devices = $this->getDevicesForUser($notification->getUser());
79 14
		if (empty($devices)) {
80 1
			return;
81
		}
82
83 13
		$language = $this->config->getUserValue($notification->getUser(), 'core', 'lang', 'en');
84
		try {
85 13
			$notification = $this->notificationManager->prepare($notification, $language);
86 1
		} catch (\InvalidArgumentException $e) {
87 1
			return;
88
		}
89
90 12
		$userKey = $this->keyManager->getKey($user);
91
92 12
		$isTalkNotification = in_array($notification->getApp(), ['spreed', 'talk'], true)
93 12
			&& in_array($notification->getSubject(), ['invitation', 'call'], true);
94 12
		$talkApps = array_filter($devices, function($device) {
95 12
			return $device['apptype'] === 'talk';
96 12
		});
97 12
		$hasTalkApps = !empty($talkApps);
98
99 12
		$pushNotifications = [];
100 12
		foreach ($devices as $device) {
101 12
			if (!$isTalkNotification && $device['apptype'] === 'talk') {
102
				// The iOS app can not kill notifications,
103
				// therefor we should only send relevant notifications to the Talk
104
				// app, so it does not pollute the notifications bar with useless
105
				// notifications, especially when the Sync client app is also installed.
106 3
				continue;
107
			}
108 11
			if ($isTalkNotification && $hasTalkApps && $device['apptype'] !== 'talk') {
109
				// Similar to the previous case, we also don't send Talk notifications
110
				// to the Sync client app, when there is a Talk app installed. We only
111
				// do this, when you don't have a Talk app on your device, so you still
112
				// get the push notification.
113 2
				continue;
114
			}
115
116
			try {
117 11
				$payload = json_encode($this->encryptAndSign($userKey, $device, $notification, $isTalkNotification));
118
119 9
				$proxyServer = rtrim($device['proxyserver'], '/');
120 9
				if (!isset($pushNotifications[$proxyServer])) {
121 9
					$pushNotifications[$proxyServer] = [];
122
				}
123 9
				$pushNotifications[$proxyServer][] = $payload;
124 2
			} catch (InvalidTokenException $e) {
0 ignored issues
show
Bug introduced by
The class OC\Authentication\Exceptions\InvalidTokenException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
125
				// Token does not exist anymore, should drop the push device entry
126 1
				$this->deletePushToken($device['token']);
127 1
			} catch (\InvalidArgumentException $e) {
128
				// Failed to encrypt message for device: public key is invalid
129 11
				$this->deletePushToken($device['token']);
130
			}
131
		}
132
133 12
		if (empty($pushNotifications)) {
134 3
			return;
135
		}
136
137 9
		$client = $this->clientService->newClient();
138 9
		foreach ($pushNotifications as $proxyServer => $notifications) {
139
			try {
140 9
				$response = $client->post($proxyServer . '/notifications', [
141
					'body' => [
142 9
						'notifications' => $notifications,
143
					],
144
				]);
145 2
			} catch (\Exception $e) {
146 2
				$this->log->logException($e, [
147 2
					'app' => 'notifications',
148
				]);
149 2
				continue;
150
			}
151
152 9
			$status = $response->getStatusCode();
153 9
			if ($status !== Http::STATUS_OK && $status !== Http::STATUS_SERVICE_UNAVAILABLE) {
154 9
				$body = $response->getBody();
155 9
				$this->log->error('Could not send notification to push server [{url}]: {error}',[
156 9
					'error' => is_string($body) ? $body : 'no reason given',
157 9
					'url' => $proxyServer,
158 9
					'app' => 'notifications',
159
				]);
160 2
			} else if ($status === Http::STATUS_SERVICE_UNAVAILABLE && $this->config->getSystemValue('debug', false)) {
161 1
				$body = $response->getBody();
162 1
				$this->log->debug('Could not send notification to push server [{url}]: {error}',[
163 1
					'error' => is_string($body) ? $body : 'no reason given',
164 1
					'url' => $proxyServer,
165 9
					'app' => 'notifications',
166
				]);
167
			}
168
		}
169 9
	}
170
171
	/**
172
	 * @param Key $userKey
173
	 * @param array $device
174
	 * @param INotification $notification
175
	 * @param bool $isTalkNotification
176
	 * @return array
177
	 * @throws InvalidTokenException
178
	 * @throws \InvalidArgumentException
179
	 */
180
	protected function encryptAndSign(Key $userKey, array $device, INotification $notification, $isTalkNotification) {
181
		// Check if the token is still valid...
182
		$this->tokenProvider->getTokenById($device['token']);
183
184
		$data = [
185
			'app' => $notification->getApp(),
186
			'subject' => $notification->getParsedSubject(),
187
		];
188
189
		if ($isTalkNotification) {
190
			$data['type'] = $notification->getObjectType();
191
			$data['id'] = $notification->getObjectId();
192
		}
193
194
		if (!openssl_public_encrypt(json_encode($data), $encryptedSubject, $device['devicepublickey'], OPENSSL_PKCS1_PADDING)) {
195
			$this->log->error(openssl_error_string(), ['app' => 'notifications']);
196
			throw new \InvalidArgumentException('Failed to encrypt message for device');
197
		}
198
199
		openssl_sign($encryptedSubject, $signature, $userKey->getPrivate(), OPENSSL_ALGO_SHA512);
200
		$base64EncryptedSubject = base64_encode($encryptedSubject);
201
		$base64Signature = base64_encode($signature);
202
203
		return [
204
			'deviceIdentifier' => $device['deviceidentifier'],
205
			'pushTokenHash' => $device['pushtokenhash'],
206
			'subject' => $base64EncryptedSubject,
207
			'signature' => $base64Signature,
208
		];
209
	}
210
211
	/**
212
	 * @param string $uid
213
	 * @return array[]
214
	 */
215
	protected function getDevicesForUser($uid) {
216
		$query = $this->db->getQueryBuilder();
217
		$query->select('*')
218
			->from('notifications_pushtokens')
219
			->where($query->expr()->eq('uid', $query->createNamedParameter($uid)));
220
221
		$result = $query->execute();
222
		$devices = $result->fetchAll();
223
		$result->closeCursor();
224
225
		return $devices;
226
	}
227
228
	/**
229
	 * @param int $tokenId
230
	 * @return bool
231
	 */
232
	protected function deletePushToken($tokenId) {
233
		$query = $this->db->getQueryBuilder();
234
		$query->delete('notifications_pushtokens')
235
			->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT)));
236
237
		return $query->execute() !== 0;
238
	}
239
}
240