1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016 Bjoern Schiessle <bjoern@schiessle.org>
* @copyright Copyright (c) 2019 Joas Schilling <coding@schilljs.com>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bjoern Schiessle <bjoern@schiessle.org>
* @author Joas Schilling <coding@schilljs.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\LookupServerConnector\BackgroundJobs;
use OC\Security\IdentityProof\Signer;
use OCP\Accounts\IAccountManager;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\BackgroundJob\Job;
use OCP\Http\Client\IClientService;
use OCP\IConfig;
use OCP\ILogger;
use OCP\IUser;
use OCP\IUserManager;
class RetryJob extends Job {
/** @var IClientService */
private $clientService;
/** @var string */
private $lookupServer;
/** @var IConfig */
private $config;
/** @var IUserManager */
private $userManager;
/** @var IAccountManager */
private $accountManager;
/** @var Signer */
private $signer;
/** @var int */
protected $retries = 0;
/** @var bool */
protected $retainJob = false;
/**
* @param ITimeFactory $time
* @param IClientService $clientService
* @param IConfig $config
* @param IUserManager $userManager
* @param IAccountManager $accountManager
* @param Signer $signer
*/
public function __construct(ITimeFactory $time,
IClientService $clientService,
IConfig $config,
IUserManager $userManager,
IAccountManager $accountManager,
Signer $signer) {
parent::__construct($time);
$this->clientService = $clientService;
$this->config = $config;
$this->userManager = $userManager;
$this->accountManager = $accountManager;
$this->signer = $signer;
$this->lookupServer = $config->getSystemValue('lookup_server', 'https://lookup.nextcloud.com');
if (!empty($this->lookupServer)) {
$this->lookupServer = rtrim($this->lookupServer, '/');
$this->lookupServer .= '/users';
}
}
/**
* run the job, then remove it from the jobList
*
* @param IJobList $jobList
* @param ILogger|null $logger
*/
public function execute($jobList, ILogger $logger = null): void {
if (!isset($this->argument['userId'])) {
// Old background job without user id, just drop it.
$jobList->remove($this, $this->argument);
return;
}
$this->retries = (int) $this->config->getUserValue($this->argument['userId'], 'lookup_server_connector', 'update_retries', 0);
if ($this->shouldRemoveBackgroundJob()) {
$jobList->remove($this, $this->argument);
return;
}
if ($this->shouldRun()) {
parent::execute($jobList, $logger);
if (!$this->retainJob) {
$jobList->remove($this, $this->argument);
}
}
}
/**
* Check if we should kill the background job:
*
* - internet connection is disabled
* - no valid lookup server URL given
* - lookup server was disabled by the admin
* - max retries are reached (set to 5)
*
* @return bool
*/
protected function shouldRemoveBackgroundJob(): bool {
return $this->config->getSystemValueBool('has_internet_connection', true) === false ||
$this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') === '' ||
$this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes') !== 'yes' ||
$this->retries >= 5;
}
protected function shouldRun(): bool {
$delay = 100 * 6 ** $this->retries;
return ($this->time->getTime() - $this->lastRun) > $delay;
}
protected function run($argument): void {
$user = $this->userManager->get($this->argument['userId']);
if (!$user instanceof IUser) {
// User does not exist anymore
return;
}
$data = $this->getUserAccountData($user);
$signedData = $this->signer->sign('lookupserver', $data, $user);
$client = $this->clientService->newClient();
try {
if (count($data) === 1) {
// No public data, just the federation Id
$client->delete($this->lookupServer,
[
'body' => json_encode($signedData),
'timeout' => 10,
'connect_timeout' => 3,
]
);
} else {
$client->post($this->lookupServer,
[
'body' => json_encode($signedData),
'timeout' => 10,
'connect_timeout' => 3,
]
);
}
// Reset retry counter
$this->config->deleteUserValue(
$user->getUID(),
'lookup_server_connector',
'update_retries'
);
} catch (\Exception $e) {
// An error occurred, retry later
$this->retainJob = true;
$this->config->setUserValue(
$user->getUID(),
'lookup_server_connector',
'update_retries',
$this->retries + 1
);
}
}
protected function getUserAccountData(IUser $user): array {
$account = $this->accountManager->getAccount($user);
$publicData = [];
foreach ($account->getProperties() as $property) {
if ($property->getScope() === IAccountManager::VISIBILITY_PUBLIC) {
$publicData[$property->getName()] = $property->getValue();
}
}
$data = ['federationId' => $user->getCloudId()];
if (!empty($publicData)) {
$data['name'] = $publicData[IAccountManager::PROPERTY_DISPLAYNAME]['value'] ?? '';
$data['email'] = $publicData[IAccountManager::PROPERTY_EMAIL]['value'] ?? '';
$data['address'] = $publicData[IAccountManager::PROPERTY_ADDRESS]['value'] ?? '';
$data['website'] = $publicData[IAccountManager::PROPERTY_WEBSITE]['value'] ?? '';
$data['twitter'] = $publicData[IAccountManager::PROPERTY_TWITTER]['value'] ?? '';
$data['phone'] = $publicData[IAccountManager::PROPERTY_PHONE]['value'] ?? '';
$data['twitter_signature'] = $publicData[IAccountManager::PROPERTY_TWITTER]['signature'] ?? '';
$data['website_signature'] = $publicData[IAccountManager::PROPERTY_WEBSITE]['signature'] ?? '';
$data['verificationStatus'] = [
IAccountManager::PROPERTY_WEBSITE => $publicData[IAccountManager::PROPERTY_WEBSITE]['verified'] ?? '',
IAccountManager::PROPERTY_TWITTER => $publicData[IAccountManager::PROPERTY_TWITTER]['verified'] ?? '',
];
}
return $data;
}
}
|
