|
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)) { |
|
|
|
|
|
|
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->getSystemValue('force_language', false); |
|
84
|
13 |
|
$language = \is_string($language) ? $language : $this->config->getUserValue($notification->getUser(), 'core', 'lang', null); |
|
85
|
13 |
|
$language = $language ?? $this->config->getSystemValue('default_language', 'en'); |
|
86
|
|
|
try { |
|
87
|
13 |
|
$this->notificationManager->setPreparingPushNotification(true); |
|
88
|
13 |
|
$notification = $this->notificationManager->prepare($notification, $language); |
|
89
|
1 |
|
} catch (\InvalidArgumentException $e) { |
|
90
|
1 |
|
return; |
|
91
|
12 |
|
} finally { |
|
92
|
13 |
|
$this->notificationManager->setPreparingPushNotification(false); |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
12 |
|
$userKey = $this->keyManager->getKey($user); |
|
96
|
|
|
|
|
97
|
12 |
|
$isTalkNotification = \in_array($notification->getApp(), ['spreed', 'talk'], true) |
|
98
|
12 |
|
&& \in_array($notification->getSubject(), ['invitation', 'call', 'mention'], true); |
|
99
|
12 |
|
$talkApps = array_filter($devices, function($device) { |
|
100
|
12 |
|
return $device['apptype'] === 'talk'; |
|
101
|
12 |
|
}); |
|
102
|
12 |
|
$hasTalkApps = !empty($talkApps); |
|
103
|
|
|
|
|
104
|
12 |
|
$pushNotifications = []; |
|
105
|
12 |
|
foreach ($devices as $device) { |
|
106
|
12 |
|
if (!$isTalkNotification && $device['apptype'] === 'talk') { |
|
107
|
|
|
// The iOS app can not kill notifications, |
|
108
|
|
|
// therefor we should only send relevant notifications to the Talk |
|
109
|
|
|
// app, so it does not pollute the notifications bar with useless |
|
110
|
|
|
// notifications, especially when the Sync client app is also installed. |
|
111
|
3 |
|
continue; |
|
112
|
|
|
} |
|
113
|
11 |
|
if ($isTalkNotification && $hasTalkApps && $device['apptype'] !== 'talk') { |
|
114
|
|
|
// Similar to the previous case, we also don't send Talk notifications |
|
115
|
|
|
// to the Sync client app, when there is a Talk app installed. We only |
|
116
|
|
|
// do this, when you don't have a Talk app on your device, so you still |
|
117
|
|
|
// get the push notification. |
|
118
|
2 |
|
continue; |
|
119
|
|
|
} |
|
120
|
|
|
|
|
121
|
|
|
try { |
|
122
|
11 |
|
$payload = json_encode($this->encryptAndSign($userKey, $device, $notification, $isTalkNotification)); |
|
123
|
|
|
|
|
124
|
9 |
|
$proxyServer = rtrim($device['proxyserver'], '/'); |
|
125
|
9 |
|
if (!isset($pushNotifications[$proxyServer])) { |
|
126
|
9 |
|
$pushNotifications[$proxyServer] = []; |
|
127
|
|
|
} |
|
128
|
9 |
|
$pushNotifications[$proxyServer][] = $payload; |
|
129
|
2 |
|
} catch (InvalidTokenException $e) { |
|
|
|
|
|
|
130
|
|
|
// Token does not exist anymore, should drop the push device entry |
|
131
|
1 |
|
$this->deletePushToken($device['token']); |
|
132
|
1 |
|
} catch (\InvalidArgumentException $e) { |
|
133
|
|
|
// Failed to encrypt message for device: public key is invalid |
|
134
|
11 |
|
$this->deletePushToken($device['token']); |
|
135
|
|
|
} |
|
136
|
|
|
} |
|
137
|
|
|
|
|
138
|
12 |
|
if (empty($pushNotifications)) { |
|
139
|
3 |
|
return; |
|
140
|
|
|
} |
|
141
|
|
|
|
|
142
|
9 |
|
$client = $this->clientService->newClient(); |
|
143
|
9 |
|
foreach ($pushNotifications as $proxyServer => $notifications) { |
|
144
|
|
|
try { |
|
145
|
9 |
|
$response = $client->post($proxyServer . '/notifications', [ |
|
146
|
|
|
'body' => [ |
|
147
|
9 |
|
'notifications' => $notifications, |
|
148
|
|
|
], |
|
149
|
|
|
]); |
|
150
|
2 |
|
} catch (\Exception $e) { |
|
151
|
2 |
|
$this->log->logException($e, [ |
|
152
|
2 |
|
'app' => 'notifications', |
|
153
|
|
|
]); |
|
154
|
2 |
|
continue; |
|
155
|
|
|
} |
|
156
|
|
|
|
|
157
|
9 |
|
$status = $response->getStatusCode(); |
|
158
|
9 |
|
if ($status !== Http::STATUS_OK && $status !== Http::STATUS_SERVICE_UNAVAILABLE) { |
|
159
|
9 |
|
$body = $response->getBody(); |
|
160
|
9 |
|
$this->log->error('Could not send notification to push server [{url}]: {error}',[ |
|
161
|
9 |
|
'error' => \is_string($body) ? $body : 'no reason given', |
|
162
|
9 |
|
'url' => $proxyServer, |
|
163
|
9 |
|
'app' => 'notifications', |
|
164
|
|
|
]); |
|
165
|
2 |
|
} else if ($status === Http::STATUS_SERVICE_UNAVAILABLE && $this->config->getSystemValue('debug', false)) { |
|
166
|
1 |
|
$body = $response->getBody(); |
|
167
|
1 |
|
$this->log->debug('Could not send notification to push server [{url}]: {error}',[ |
|
168
|
1 |
|
'error' => \is_string($body) ? $body : 'no reason given', |
|
169
|
1 |
|
'url' => $proxyServer, |
|
170
|
9 |
|
'app' => 'notifications', |
|
171
|
|
|
]); |
|
172
|
|
|
} |
|
173
|
|
|
} |
|
174
|
9 |
|
} |
|
175
|
|
|
|
|
176
|
|
|
/** |
|
177
|
|
|
* @param Key $userKey |
|
178
|
|
|
* @param array $device |
|
179
|
|
|
* @param INotification $notification |
|
180
|
|
|
* @param bool $isTalkNotification |
|
181
|
|
|
* @return array |
|
182
|
|
|
* @throws InvalidTokenException |
|
183
|
|
|
* @throws \InvalidArgumentException |
|
184
|
|
|
*/ |
|
185
|
|
|
protected function encryptAndSign(Key $userKey, array $device, INotification $notification, bool $isTalkNotification): array { |
|
186
|
|
|
// Check if the token is still valid... |
|
187
|
|
|
$this->tokenProvider->getTokenById($device['token']); |
|
188
|
|
|
|
|
189
|
|
|
$data = [ |
|
190
|
|
|
'app' => $notification->getApp(), |
|
191
|
|
|
'subject' => $notification->getParsedSubject(), |
|
192
|
|
|
'type' => $notification->getObjectType(), |
|
193
|
|
|
'id' => $notification->getObjectId(), |
|
194
|
|
|
]; |
|
195
|
|
|
|
|
196
|
|
|
if ($isTalkNotification) { |
|
197
|
|
|
$priority = 'high'; |
|
198
|
|
|
} else { |
|
199
|
|
|
$priority = 'normal'; |
|
200
|
|
|
} |
|
201
|
|
|
|
|
202
|
|
|
if (!openssl_public_encrypt(json_encode($data), $encryptedSubject, $device['devicepublickey'], OPENSSL_PKCS1_PADDING)) { |
|
203
|
|
|
$this->log->error(openssl_error_string(), ['app' => 'notifications']); |
|
204
|
|
|
throw new \InvalidArgumentException('Failed to encrypt message for device'); |
|
205
|
|
|
} |
|
206
|
|
|
|
|
207
|
|
|
openssl_sign($encryptedSubject, $signature, $userKey->getPrivate(), OPENSSL_ALGO_SHA512); |
|
208
|
|
|
$base64EncryptedSubject = base64_encode($encryptedSubject); |
|
209
|
|
|
$base64Signature = base64_encode($signature); |
|
210
|
|
|
|
|
211
|
|
|
return [ |
|
212
|
|
|
'deviceIdentifier' => $device['deviceidentifier'], |
|
213
|
|
|
'pushTokenHash' => $device['pushtokenhash'], |
|
214
|
|
|
'subject' => $base64EncryptedSubject, |
|
215
|
|
|
'signature' => $base64Signature, |
|
216
|
|
|
'priority' => $priority, |
|
217
|
|
|
]; |
|
218
|
|
|
} |
|
219
|
|
|
|
|
220
|
|
|
/** |
|
221
|
|
|
* @param string $uid |
|
222
|
|
|
* @return array[] |
|
223
|
|
|
*/ |
|
224
|
|
|
protected function getDevicesForUser(string $uid): array { |
|
225
|
|
|
$query = $this->db->getQueryBuilder(); |
|
226
|
|
|
$query->select('*') |
|
227
|
|
|
->from('notifications_pushtokens') |
|
228
|
|
|
->where($query->expr()->eq('uid', $query->createNamedParameter($uid))); |
|
229
|
|
|
|
|
230
|
|
|
$result = $query->execute(); |
|
231
|
|
|
$devices = $result->fetchAll(); |
|
232
|
|
|
$result->closeCursor(); |
|
233
|
|
|
|
|
234
|
|
|
return $devices; |
|
235
|
|
|
} |
|
236
|
|
|
|
|
237
|
|
|
/** |
|
238
|
|
|
* @param int $tokenId |
|
239
|
|
|
* @return bool |
|
240
|
|
|
*/ |
|
241
|
|
|
protected function deletePushToken(int $tokenId): bool { |
|
242
|
|
|
$query = $this->db->getQueryBuilder(); |
|
243
|
|
|
$query->delete('notifications_pushtokens') |
|
244
|
|
|
->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT))); |
|
245
|
|
|
|
|
246
|
|
|
return $query->execute() !== 0; |
|
247
|
|
|
} |
|
248
|
|
|
} |
|
249
|
|
|
|
nextcloud /
notifications
Loading history...
This error could be the result of:
1. Missing dependencies
PHP Analyzer uses your
composer.jsonfile (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects thecomposer.jsonto 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
requireorrequire-devsection?2. Missing use statement
PHP does not complain about undefined classes in
ìnstanceofchecks. For example, the following PHP code will work perfectly fine:If you have not tested against this specific condition, such errors might go unnoticed.