1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
|
6
|
|
|
/** |
7
|
|
|
* Circles - Bring cloud-users closer together. |
8
|
|
|
* |
9
|
|
|
* This file is licensed under the Affero General Public License version 3 or |
10
|
|
|
* later. See the COPYING file. |
11
|
|
|
* |
12
|
|
|
* @author Maxence Lange <[email protected]> |
13
|
|
|
* @copyright 2021 |
14
|
|
|
* @license GNU AGPL version 3 or any later version |
15
|
|
|
* |
16
|
|
|
* This program is free software: you can redistribute it and/or modify |
17
|
|
|
* it under the terms of the GNU Affero General Public License as |
18
|
|
|
* published by the Free Software Foundation, either version 3 of the |
19
|
|
|
* License, or (at your option) any later version. |
20
|
|
|
* |
21
|
|
|
* This program is distributed in the hope that it will be useful, |
22
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
23
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
24
|
|
|
* GNU Affero General Public License for more details. |
25
|
|
|
* |
26
|
|
|
* You should have received a copy of the GNU Affero General Public License |
27
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
28
|
|
|
* |
29
|
|
|
*/ |
30
|
|
|
|
31
|
|
|
|
32
|
|
|
namespace OCA\Circles\Command; |
33
|
|
|
|
34
|
|
|
use daita\MySmallPhpTools\Exceptions\InvalidItemException; |
35
|
|
|
use daita\MySmallPhpTools\Exceptions\ItemNotFoundException; |
36
|
|
|
use daita\MySmallPhpTools\Exceptions\RequestNetworkException; |
37
|
|
|
use daita\MySmallPhpTools\Exceptions\SignatoryException; |
38
|
|
|
use daita\MySmallPhpTools\Exceptions\UnknownTypeException; |
39
|
|
|
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21TreeNode; |
40
|
|
|
use daita\MySmallPhpTools\Model\SimpleDataStore; |
41
|
|
|
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21ConsoleTree; |
42
|
|
|
use daita\MySmallPhpTools\Traits\TArrayTools; |
43
|
|
|
use OC\Core\Command\Base; |
44
|
|
|
use OCA\Circles\Db\MemberRequest; |
45
|
|
|
use OCA\Circles\Db\MembershipRequest; |
46
|
|
|
use OCA\Circles\Exceptions\CircleNotFoundException; |
47
|
|
|
use OCA\Circles\Exceptions\FederatedUserException; |
48
|
|
|
use OCA\Circles\Exceptions\FederatedUserNotFoundException; |
49
|
|
|
use OCA\Circles\Exceptions\MemberNotFoundException; |
50
|
|
|
use OCA\Circles\Exceptions\OwnerNotFoundException; |
51
|
|
|
use OCA\Circles\Exceptions\RemoteInstanceException; |
52
|
|
|
use OCA\Circles\Exceptions\RemoteNotFoundException; |
53
|
|
|
use OCA\Circles\Exceptions\RemoteResourceNotFoundException; |
54
|
|
|
use OCA\Circles\Exceptions\UnknownRemoteException; |
55
|
|
|
use OCA\Circles\Exceptions\UserTypeNotFoundException; |
56
|
|
|
use OCA\Circles\Model\FederatedUser; |
57
|
|
|
use OCA\Circles\Model\Member; |
58
|
|
|
use OCA\Circles\Model\ModelManager; |
59
|
|
|
use OCA\Circles\Service\ConfigService; |
60
|
|
|
use OCA\Circles\Service\FederatedUserService; |
61
|
|
|
use OCA\Circles\Service\MembershipService; |
62
|
|
|
use OCP\IUserManager; |
63
|
|
|
use Symfony\Component\Console\Input\InputArgument; |
64
|
|
|
use Symfony\Component\Console\Input\InputInterface; |
65
|
|
|
use Symfony\Component\Console\Input\InputOption; |
66
|
|
|
use Symfony\Component\Console\Output\OutputInterface; |
67
|
|
|
|
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Class CirclesMembershipsIndex |
71
|
|
|
* |
72
|
|
|
* @package OCA\Circles\Command |
73
|
|
|
*/ |
74
|
|
|
class CirclesMemberships extends Base { |
75
|
|
|
|
76
|
|
|
|
77
|
|
|
use TArrayTools; |
78
|
|
|
use TNC21ConsoleTree; |
79
|
|
|
|
80
|
|
|
|
81
|
|
|
/** @var IUserManager */ |
82
|
|
|
private $userManager; |
83
|
|
|
|
84
|
|
|
/** @var MemberRequest */ |
85
|
|
|
private $memberRequest; |
86
|
|
|
|
87
|
|
|
/** @var MembershipRequest */ |
88
|
|
|
private $membershipRequest; |
89
|
|
|
|
90
|
|
|
/** @var ModelManager */ |
91
|
|
|
private $modelManager; |
92
|
|
|
|
93
|
|
|
/** @var FederatedUserService */ |
94
|
|
|
private $federatedUserService; |
95
|
|
|
|
96
|
|
|
/** @var MembershipService */ |
97
|
|
|
private $membershipsService; |
98
|
|
|
|
99
|
|
|
/** @var ConfigService */ |
100
|
|
|
private $configService; |
101
|
|
|
|
102
|
|
|
|
103
|
|
|
/** @var array */ |
104
|
|
|
private $memberships = []; |
105
|
|
|
|
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* CirclesList constructor. |
109
|
|
|
* |
110
|
|
|
* @param IUserManager $userManager |
111
|
|
|
* @param MembershipRequest $membershipRequest |
112
|
|
|
* @param MemberRequest $memberRequest |
113
|
|
|
* @param ModelManager $modelManager |
114
|
|
|
* @param MembershipService $membershipsService |
115
|
|
|
* @param FederatedUserService $federatedUserService |
116
|
|
|
* @param ConfigService $configService |
117
|
|
|
*/ |
118
|
|
|
public function __construct( |
119
|
|
|
IUserManager $userManager, |
120
|
|
|
MembershipRequest $membershipRequest, |
121
|
|
|
MemberRequest $memberRequest, |
122
|
|
|
ModelManager $modelManager, |
123
|
|
|
MembershipService $membershipsService, |
124
|
|
|
FederatedUserService $federatedUserService, |
125
|
|
|
ConfigService $configService |
126
|
|
|
) { |
127
|
|
|
parent::__construct(); |
128
|
|
|
$this->userManager = $userManager; |
129
|
|
|
$this->memberRequest = $memberRequest; |
130
|
|
|
$this->membershipRequest = $membershipRequest; |
131
|
|
|
$this->modelManager = $modelManager; |
132
|
|
|
$this->membershipsService = $membershipsService; |
133
|
|
|
$this->federatedUserService = $federatedUserService; |
134
|
|
|
$this->configService = $configService; |
135
|
|
|
} |
136
|
|
|
|
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* |
140
|
|
|
*/ |
141
|
|
|
protected function configure() { |
142
|
|
|
parent::configure(); |
143
|
|
|
$this->setName('circles:memberships') |
144
|
|
|
->setDescription('index and display memberships for local and federated users') |
145
|
|
|
->addArgument('userId', InputArgument::REQUIRED, 'userId to generate memberships') |
146
|
|
|
->addOption( |
147
|
|
|
'type', '', InputOption::VALUE_REQUIRED, 'type of the user', |
148
|
|
|
Member::$DEF_TYPE[Member::TYPE_USER] |
149
|
|
|
); |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
|
153
|
|
|
/** |
154
|
|
|
* @param InputInterface $input |
155
|
|
|
* @param OutputInterface $output |
156
|
|
|
* |
157
|
|
|
* @return int |
158
|
|
|
* @throws CircleNotFoundException |
159
|
|
|
* @throws FederatedUserException |
160
|
|
|
* @throws FederatedUserNotFoundException |
161
|
|
|
* @throws InvalidItemException |
162
|
|
|
* @throws MemberNotFoundException |
163
|
|
|
* @throws OwnerNotFoundException |
164
|
|
|
* @throws RemoteInstanceException |
165
|
|
|
* @throws RemoteNotFoundException |
166
|
|
|
* @throws RemoteResourceNotFoundException |
167
|
|
|
* @throws RequestNetworkException |
168
|
|
|
* @throws SignatoryException |
169
|
|
|
* @throws UnknownRemoteException |
170
|
|
|
* @throws UserTypeNotFoundException |
171
|
|
|
*/ |
172
|
|
|
protected function execute(InputInterface $input, OutputInterface $output): int { |
173
|
|
|
$userId = $input->getArgument('userId'); |
174
|
|
|
|
175
|
|
|
$type = Member::parseTypeString($input->getOption('type')); |
176
|
|
|
$federatedUser = $this->federatedUserService->getFederatedUser($userId, (int)$type); |
177
|
|
|
|
178
|
|
|
$output->writeln('Id: <info>' . $federatedUser->getUserId() . '</info>'); |
179
|
|
|
$output->writeln('Instance: <info>' . $federatedUser->getInstance() . '</info>'); |
180
|
|
|
$output->writeln('Type: <info>' . Member::$DEF_TYPE[$federatedUser->getUserType()] . '</info>'); |
181
|
|
|
$output->writeln('SingleId: <info>' . $federatedUser->getSingleId() . '</info>'); |
182
|
|
|
|
183
|
|
|
|
184
|
|
|
$output->writeln(''); |
185
|
|
|
$output->writeln('Memberships:'); |
186
|
|
|
$count = $this->membershipsService->onMemberUpdate($federatedUser); |
187
|
|
|
if ($count === 0) { |
188
|
|
|
$output->writeln('(database not updated)'); |
189
|
|
|
} else { |
190
|
|
|
$output->writeln('(' . $count . ' entries generated/updated in the database)'); |
191
|
|
|
} |
192
|
|
|
|
193
|
|
|
foreach ($federatedUser->getMemberships() as $membership) { |
194
|
|
|
$this->memberships[$membership->getCircleId()] = $membership; |
195
|
|
|
$output->writeln( |
196
|
|
|
'- <info>' . $membership->getCircleId() . '</info> (' |
197
|
|
|
. Member::$DEF_LEVEL[$membership->getLevel()] . ')' |
198
|
|
|
); |
199
|
|
|
} |
200
|
|
|
|
201
|
|
|
$output->writeln(''); |
202
|
|
|
|
203
|
|
|
$tree = new NC21TreeNode(null, new SimpleDataStore(['federatedUser' => $federatedUser])); |
204
|
|
|
$this->generateTree($federatedUser->getSingleId(), $tree); |
205
|
|
|
$this->drawTree( |
206
|
|
|
$tree, [$this, 'displayLeaf'], |
207
|
|
|
[ |
208
|
|
|
'height' => 3, |
209
|
|
|
'node-spacing' => 0, |
210
|
|
|
'item-spacing' => 1, |
211
|
|
|
] |
212
|
|
|
); |
213
|
|
|
|
214
|
|
|
return 0; |
215
|
|
|
} |
216
|
|
|
|
217
|
|
|
|
218
|
|
|
/** |
219
|
|
|
* @param string $id |
220
|
|
|
* @param NC21TreeNode $tree |
221
|
|
|
* @param array $knownIds |
222
|
|
|
*/ |
223
|
|
|
private function generateTree(string $id, NC21TreeNode $tree, array $knownIds = []) { |
224
|
|
|
if (in_array($id, $knownIds)) { |
225
|
|
|
return; |
226
|
|
|
} |
227
|
|
|
$knownIds[] = $id; |
228
|
|
|
|
229
|
|
|
$members = $this->memberRequest->getMembersBySingleId($id); |
230
|
|
|
foreach ($members as $member) { |
231
|
|
|
$item = new NC21TreeNode( |
232
|
|
|
$tree, new SimpleDataStore( |
233
|
|
|
[ |
234
|
|
|
'member' => $member, |
235
|
|
|
'cycling' => in_array($member->getCircleId(), $knownIds) |
236
|
|
|
] |
237
|
|
|
) |
238
|
|
|
); |
239
|
|
|
$this->generateTree($member->getCircleId(), $item, $knownIds); |
240
|
|
|
} |
241
|
|
|
} |
242
|
|
|
|
243
|
|
|
|
244
|
|
|
/** |
245
|
|
|
* @param SimpleDataStore $data |
246
|
|
|
* @param int $lineNumber |
247
|
|
|
* |
248
|
|
|
* @return string |
249
|
|
|
* @throws OwnerNotFoundException |
250
|
|
|
*/ |
251
|
|
|
public function displayLeaf(SimpleDataStore $data, int $lineNumber): string { |
252
|
|
|
if ($lineNumber === 3) { |
253
|
|
|
return ($data->gBool('cycling')) ? '<comment>(loop detected)</comment>' : ''; |
254
|
|
|
} |
255
|
|
|
|
256
|
|
|
try { |
257
|
|
|
$line = ''; |
258
|
|
|
if ($data->hasKey('federatedUser')) { |
259
|
|
|
/** @var FederatedUser $federatedUser */ |
260
|
|
|
$federatedUser = $data->gObj('federatedUser', FederatedUser::class); |
261
|
|
|
|
262
|
|
|
if ($lineNumber === 2) { |
263
|
|
|
return ''; |
264
|
|
|
} |
265
|
|
|
$line .= '<info>' . $federatedUser->getSingleId() . '</info>'; |
266
|
|
|
if (!$this->configService->isLocalInstance($federatedUser->getInstance())) { |
267
|
|
|
$line .= '@' . $federatedUser->getInstance(); |
268
|
|
|
} |
269
|
|
|
|
270
|
|
|
return $line; |
271
|
|
|
} |
272
|
|
|
|
273
|
|
|
if ($data->hasKey('member')) { |
274
|
|
|
/** @var Member $member */ |
275
|
|
|
$member = $data->gObj('member', Member::class); |
276
|
|
|
$circle = $member->getCircle(); |
277
|
|
|
|
278
|
|
|
if ($lineNumber === 1) { |
279
|
|
|
$line .= '<info>' . $circle->getId() . '</info>'; |
280
|
|
|
if (!$this->configService->isLocalInstance($circle->getInstance())) { |
281
|
|
|
$line .= '@' . $circle->getInstance(); |
282
|
|
|
} |
283
|
|
|
$line .= ' (' . $circle->getName() . ')'; |
284
|
|
|
$line .= ' <info>Level</info>: ' . Member::$DEF_LEVEL[$member->getLevel()]; |
285
|
|
|
|
286
|
|
|
$knownMembership = $this->memberships[$member->getCircleId()]; |
287
|
|
|
if ($member->getLevel() !== $knownMembership->getLevel()) { |
288
|
|
|
$line .= ' (' . Member::$DEF_LEVEL[$knownMembership->getLevel()] . ')'; |
289
|
|
|
} |
290
|
|
|
} |
291
|
|
|
|
292
|
|
|
if ($lineNumber === 2) { |
293
|
|
|
$owner = $circle->getOwner(); |
294
|
|
|
$line .= '<info>Owner</info>: ' . $owner->getUserId() . '@' . $owner->getInstance() . ' '; |
295
|
|
|
$type = |
296
|
|
|
implode(", ", $this->modelManager->getCircleTypes($circle, ModelManager::TYPES_LONG)); |
297
|
|
|
$line .= ($type === '') ? '' : '<info>Config</info>: ' . $type; |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
return $line; |
301
|
|
|
} |
302
|
|
|
} catch (InvalidItemException | ItemNotFoundException | UnknownTypeException $e) { |
303
|
|
|
} |
304
|
|
|
|
305
|
|
|
return ''; |
306
|
|
|
} |
307
|
|
|
|
308
|
|
|
} |
309
|
|
|
|
310
|
|
|
|