-
Notifications
You must be signed in to change notification settings - Fork 18
/
GroupsResponderADM.scala
578 lines (519 loc) · 22.2 KB
/
GroupsResponderADM.scala
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
/*
* Copyright © 2021 - 2024 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
* SPDX-License-Identifier: Apache-2.0
*/
package org.knora.webapi.responders.admin
import com.typesafe.scalalogging.LazyLogging
import zio.*
import zio.macros.accessible
import java.util.UUID
import dsp.errors.*
import dsp.valueobjects.Group.GroupStatus
import org.knora.webapi.*
import org.knora.webapi.core.MessageHandler
import org.knora.webapi.core.MessageRelay
import org.knora.webapi.messages.IriConversions.*
import org.knora.webapi.messages.OntologyConstants
import org.knora.webapi.messages.OntologyConstants.KnoraAdmin.*
import org.knora.webapi.messages.ResponderRequest
import org.knora.webapi.messages.SmartIri
import org.knora.webapi.messages.StringFormatter
import org.knora.webapi.messages.admin.responder.groupsmessages.*
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectGetADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectIdentifierADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectIdentifierADM.*
import org.knora.webapi.messages.admin.responder.usersmessages.*
import org.knora.webapi.messages.store.triplestoremessages.SparqlExtendedConstructResponse.ConstructPredicateObjects
import org.knora.webapi.messages.store.triplestoremessages.*
import org.knora.webapi.messages.twirl.queries.sparql
import org.knora.webapi.messages.util.KnoraSystemInstances
import org.knora.webapi.responders.IriLocker
import org.knora.webapi.responders.IriService
import org.knora.webapi.responders.Responder
import org.knora.webapi.slice.admin.AdminConstants
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupCreateRequest
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupStatusUpdateRequest
import org.knora.webapi.slice.admin.api.GroupsRequests.GroupUpdateRequest
import org.knora.webapi.slice.admin.domain.model.GroupIri
import org.knora.webapi.slice.admin.domain.model.KnoraProject.Shortcode
import org.knora.webapi.slice.admin.domain.model.User
import org.knora.webapi.slice.admin.domain.model.UserIri
import org.knora.webapi.store.triplestore.api.TriplestoreService
import org.knora.webapi.store.triplestore.api.TriplestoreService.Queries.*
import org.knora.webapi.util.ZioHelper
/**
* Returns information about groups.
*/
@accessible
trait GroupsResponderADM {
/**
* Gets all the groups (without built-in groups) and returns them as a sequence of [[GroupADM]].
*
* @return all the groups as a sequence of [[GroupADM]].
*/
def groupsGetADM: Task[Seq[GroupADM]]
/**
* Gets the group with the given group IRI and returns the information as a [[GroupADM]].
*
* @param groupIri the IRI of the group requested.
* @return information about the group as a [[GroupADM]]
*/
def groupGetADM(groupIri: IRI): Task[Option[GroupADM]]
/**
* Gets the groups with the given IRIs and returns a set of [[GroupGetResponseADM]] objects.
*
* @param groupIris the IRIs of the groups being requested
* @return information about the group as a set of [[GroupGetResponseADM]] objects.
*/
def multipleGroupsGetRequestADM(groupIris: Set[IRI]): Task[Set[GroupGetResponseADM]]
/**
* Gets the group members with the given group IRI and returns the information as a [[GroupMembersGetResponseADM]].
* Only project and system admins are allowed to access this information.
*
* @param groupIri the IRI of the group.
* @param requestingUser the user initiating the request.
* @return A [[GroupMembersGetResponseADM]]
*/
def groupMembersGetRequestADM(groupIri: IRI, requestingUser: User): Task[GroupMembersGetResponseADM]
final def groupMembersGetRequest(iri: GroupIri, user: User): Task[GroupMembersGetResponseADM] =
groupMembersGetRequestADM(iri.value, user)
/**
* Create a new group.
*
* @param request the create request information.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]]
*/
def createGroup(
request: GroupCreateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM]
/**
* Change group's basic information.
*
* @param groupIri the IRI of the group we want to change.
* @param request the change request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
def updateGroup(
groupIri: GroupIri,
request: GroupUpdateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM]
/**
* Change group's status.
*
* @param groupIri the IRI of the group we want to change.
* @param request the change request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
def updateGroupStatus(
groupIri: GroupIri,
request: GroupStatusUpdateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM]
/**
* Change group's basic information.
*
* @param groupIri the IRI of the group we want to change.
* @param changeGroupRequest the change request.
* @param requestingUser the user making the request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
def changeGroupStatusRequestADM(
groupIri: IRI,
changeGroupRequest: ChangeGroupApiRequestADM,
requestingUser: User,
apiRequestID: UUID
): Task[GroupGetResponseADM]
}
final case class GroupsResponderADMLive(
triplestore: TriplestoreService,
messageRelay: MessageRelay,
iriService: IriService,
implicit val stringFormatter: StringFormatter
) extends GroupsResponderADM
with MessageHandler
with GroupsADMJsonProtocol
with LazyLogging {
override def isResponsibleFor(message: ResponderRequest): Boolean = message.isInstanceOf[GroupsResponderRequestADM]
/**
* Receives a message extending [[GroupsResponderRequestADM]], and returns an appropriate response message
*/
def handle(msg: ResponderRequest): Task[Any] = msg match {
case _: GroupsGetADM => groupsGetADM
case r: GroupGetADM => groupGetADM(r.groupIri)
case r: MultipleGroupsGetRequestADM => multipleGroupsGetRequestADM(r.groupIris)
case r: GroupMembersGetRequestADM => groupMembersGetRequestADM(r.groupIri, r.requestingUser)
case r: GroupChangeStatusRequestADM =>
changeGroupStatusRequestADM(
r.groupIri,
r.changeGroupRequest,
r.requestingUser,
r.apiRequestID
)
case other => Responder.handleUnexpectedMessage(other, this.getClass.getName)
}
/**
* Gets all the groups (without built-in groups) and returns them as a sequence of [[GroupADM]].
*
* @return all the groups as a sequence of [[GroupADM]].
*/
override def groupsGetADM: Task[Seq[GroupADM]] = {
val query = Construct(sparql.admin.txt.getGroups(None))
for {
groupsResponse <- triplestore.query(query).flatMap(_.asExtended)
groups = groupsResponse.statements.map(convertStatementsToGroupADM)
result <- ZioHelper.sequence(groups.toSeq)
} yield result.sorted
}
private def convertStatementsToGroupADM(statements: (SubjectV2, ConstructPredicateObjects)): Task[GroupADM] = {
val groupIri: SubjectV2 = statements._1
val propertiesMap: ConstructPredicateObjects = statements._2
def getOption[A <: LiteralV2](key: IRI): UIO[Option[Seq[A]]] =
ZIO.succeed(propertiesMap.get(key.toSmartIri).map(_.map(_.asInstanceOf[A])))
def getOrFail[A <: LiteralV2](key: IRI): Task[Seq[A]] =
getOption[A](key)
.flatMap(ZIO.fromOption(_))
.orElseFail(InconsistentRepositoryDataException(s"Project: $groupIri has no $key defined."))
def getFirstValueOrFail[A <: LiteralV2](key: IRI): Task[A] = getOrFail[A](key).map(_.head)
for {
projectIri <- getFirstValueOrFail[IriLiteralV2](BelongsToProject).map(_.value)
projectADM <- findProjectByIriOrFail(
projectIri,
InconsistentRepositoryDataException(
s"Project $projectIri was referenced by $groupIri but was not found in the triplestore."
)
)
name <- getFirstValueOrFail[StringLiteralV2](GroupName).map(_.value)
descriptions <- getOrFail[StringLiteralV2](GroupDescriptions)
status <- getFirstValueOrFail[BooleanLiteralV2](StatusProp).map(_.value)
selfjoin <- getFirstValueOrFail[BooleanLiteralV2](HasSelfJoinEnabled).map(_.value)
} yield GroupADM(groupIri.toString, name, descriptions, projectADM, status, selfjoin)
}
private def findProjectByIriOrFail(iri: String, failReason: Throwable): Task[ProjectADM] =
for {
id <- IriIdentifier.fromString(iri).toZIO.mapError(e => BadRequestException(e.getMessage))
result <- findProjectByIdOrFail(id, failReason)
} yield result
private def findProjectByIdOrFail(id: ProjectIdentifierADM, failReason: Throwable): Task[ProjectADM] =
findProjectById(id).flatMap(ZIO.fromOption(_)).orElseFail(failReason)
private def findProjectById(id: ProjectIdentifierADM) =
messageRelay.ask[Option[ProjectADM]](ProjectGetADM(id))
/**
* Gets the group with the given group IRI and returns the information as a [[GroupADM]].
*
* @param groupIri the IRI of the group requested.
* @return information about the group as a [[GroupADM]]
*/
override def groupGetADM(groupIri: IRI): Task[Option[GroupADM]] = {
val query = Construct(sparql.admin.txt.getGroups(maybeIri = Some(groupIri)))
for {
statements <- triplestore.query(query).flatMap(_.asExtended).map(_.statements.headOption)
maybeGroup <- statements.map(convertStatementsToGroupADM).map(_.map(Some(_))).getOrElse(ZIO.succeed(None))
} yield maybeGroup
}
/**
* Gets the groups with the given IRIs and returns a set of [[GroupGetResponseADM]] objects.
*
* @param groupIris the IRIs of the groups being requested
* @return information about the group as a set of [[GroupGetResponseADM]] objects.
*/
override def multipleGroupsGetRequestADM(groupIris: Set[IRI]): Task[Set[GroupGetResponseADM]] =
ZioHelper.sequence(groupIris.map { iri =>
groupGetADM(iri)
.flatMap(ZIO.fromOption(_))
.mapBoth(_ => NotFoundException(s"Group <$iri> not found."), GroupGetResponseADM)
})
/**
* Gets the members with the given group IRI and returns the information as a sequence of [[User]].
*
* @param groupIri the IRI of the group.
* @param requestingUser the user initiating the request.
* @return A sequence of [[User]]
*/
private def groupMembersGetADM(
groupIri: IRI,
requestingUser: User
): Task[Seq[User]] =
for {
group <- groupGetADM(groupIri)
.flatMap(ZIO.fromOption(_))
.orElseFail(NotFoundException(s"Group <$groupIri> not found"))
// check if the requesting user is allowed to access the information
_ <- ZIO
.fail(ForbiddenException("Project members can only be retrieved by a project or system admin."))
.when {
val userPermissions = requestingUser.permissions
!userPermissions.isProjectAdmin(group.project.id) &&
!userPermissions.isSystemAdmin && !requestingUser.isSystemUser
}
groupMembersResponse <- triplestore.query(Select(sparql.admin.txt.getGroupMembersByIri(groupIri)))
// get project member IRI from results rows
groupMemberIris =
if (groupMembersResponse.results.bindings.nonEmpty) {
groupMembersResponse.results.bindings.map(_.rowMap("s"))
} else {
Seq.empty[IRI]
}
usersMaybeTasks: Seq[Task[Option[User]]] =
groupMemberIris.map { userIri =>
messageRelay
.ask[Option[User]](
UserGetByIriADM(
UserIri.unsafeFrom(userIri),
UserInformationType.Restricted,
KnoraSystemInstances.Users.SystemUser
)
)
}
users <- ZioHelper.sequence(usersMaybeTasks).map(_.flatten)
} yield users
/**
* Gets the group members with the given group IRI and returns the information as a [[GroupMembersGetResponseADM]].
* Only project and system admins are allowed to access this information.
*
* @param groupIri the IRI of the group.
* @param requestingUser the user initiating the request.
* @return A [[GroupMembersGetResponseADM]]
*/
override def groupMembersGetRequestADM(groupIri: IRI, requestingUser: User): Task[GroupMembersGetResponseADM] =
groupMembersGetADM(groupIri, requestingUser).map(GroupMembersGetResponseADM)
/**
* Create a new group.
*
* @param request the create request information.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]]
*/
override def createGroup(
request: GroupCreateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM] = {
val task = for {
nameExists <- groupByNameAndProjectExists(request.name.value, request.project.value)
_ <- ZIO
.fail(DuplicateValueException(s"Group with the name '${request.name.value}' already exists"))
.when(nameExists)
projectADM <-
findProjectByIriOrFail(
request.project.value,
NotFoundException(s"Cannot create group inside project <${request.project}>. The project was not found.")
)
// check the custom IRI; if not given, create an unused IRI
customGroupIri: Option[SmartIri] = request.id.map(_.value).map(iri => iri.toSmartIri)
groupIri <- iriService.checkOrCreateEntityIri(
customGroupIri,
GroupIri.makeNew(Shortcode.unsafeFrom(projectADM.shortcode)).value
)
/* create the group */
createNewGroupSparqlString =
sparql.admin.txt
.createNewGroup(
AdminConstants.adminDataNamedGraph.value,
groupIri,
groupClassIri = OntologyConstants.KnoraAdmin.UserGroup,
name = request.name.value,
descriptions = request.descriptions.value,
projectIri = request.project.value,
status = request.status.value,
hasSelfJoinEnabled = request.selfjoin.value
)
_ <- triplestore.query(Update(createNewGroupSparqlString))
/* Verify that the group was created and updated */
createdGroup <-
groupGetADM(groupIri)
.someOrFail(UpdateNotPerformedException("Group was not created. Please report this as a possible bug."))
} yield GroupGetResponseADM(createdGroup)
IriLocker.runWithIriLock(apiRequestID, "http://rdfh.ch/groups", task)
}
/**
* Change group's basic information.
*
* @param groupIri the IRI of the group we want to change.
* @param request the change request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
override def updateGroup(
groupIri: GroupIri,
request: GroupUpdateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM] = {
val task = for {
result <- updateGroupHelper(groupIri, request)
} yield result
IriLocker.runWithIriLock(apiRequestID, groupIri.value, task)
}
/**
* Change group's status.
*
* @param groupIri the IRI of the group we want to change.
* @param request the change request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
override def updateGroupStatus(
groupIri: GroupIri,
request: GroupStatusUpdateRequest,
apiRequestID: UUID
): Task[GroupGetResponseADM] = {
val task = for {
// update group status
updated <- updateGroupHelper(groupIri, GroupUpdateRequest(None, None, Some(request.status), None))
// remove all members from group if status is false
result <- removeGroupMembersIfNecessary(updated.group)
} yield result
IriLocker.runWithIriLock(apiRequestID, groupIri.value, task)
}
/**
* Change group's basic information.
*
* @param groupIri the IRI of the group we want to change.
* @param changeGroupRequest the change request.
* @param requestingUser the user making the request.
* @param apiRequestID the unique request ID.
* @return a [[GroupGetResponseADM]].
*/
override def changeGroupStatusRequestADM(
groupIri: IRI,
changeGroupRequest: ChangeGroupApiRequestADM,
requestingUser: User,
apiRequestID: UUID
): Task[GroupGetResponseADM] = {
/**
* The actual change group task run with an IRI lock.
*/
def changeGroupStatusTask(
groupIri: IRI,
changeGroupRequest: ChangeGroupApiRequestADM,
requestingUser: User
): Task[GroupGetResponseADM] =
for {
/* Get the project IRI which also verifies that the group exists. */
groupADM <- groupGetADM(groupIri)
.someOrFail(NotFoundException(s"Group <$groupIri> not found. Aborting update request."))
/* check if the requesting user is allowed to perform updates */
_ <- ZIO
.fail(ForbiddenException("Group's status can only be changed by a project or system admin."))
.when {
val userPermissions = requestingUser.permissions
!userPermissions.isProjectAdmin(groupADM.project.id) &&
!userPermissions.isSystemAdmin
}
maybeStatus = changeGroupRequest.status.map(GroupStatus.from)
/* create the update request */
groupUpdatePayload = GroupUpdateRequest(status = maybeStatus)
iri <- ZIO.fromEither(GroupIri.from(groupIri)).mapError(BadRequestException(_))
// update group status
updateGroupResult <- updateGroupHelper(iri, groupUpdatePayload)
// remove all members from group if status is false
operationResponse <-
removeGroupMembersIfNecessary(changedGroup = updateGroupResult.group)
} yield operationResponse
val task = changeGroupStatusTask(groupIri, changeGroupRequest, requestingUser)
IriLocker.runWithIriLock(apiRequestID, groupIri, task)
}
/**
* Main group update method.
*
* @param groupIri the IRI of the group we are updating.
* @param request the payload holding the information which we want to update.
* @return a [[GroupGetResponseADM]]
*/
private def updateGroupHelper(groupIri: GroupIri, request: GroupUpdateRequest) =
for {
_ <- ZIO
.fail(BadRequestException("No data would be changed. Aborting update request."))
.when(
// parameter list is empty
List(
request.name,
request.descriptions,
request.status,
request.selfjoin
).flatten.isEmpty
)
/* Verify that the group exists. */
groupADM <-
groupGetADM(groupIri.value)
.someOrFail(NotFoundException(s"Group <${groupIri.value}> not found. Aborting update request."))
/* Verify that the potentially new name is unique */
groupByNameAlreadyExists <-
if (request.name.nonEmpty)
groupByNameAndProjectExists(request.name.get.value, groupADM.project.id)
else ZIO.succeed(false)
_ <- ZIO
.fail(BadRequestException(s"Group with the name '${request.name.get.value}' already exists."))
.when(groupByNameAlreadyExists)
/* Update group */
updateGroupSparqlString =
sparql.admin.txt
.updateGroup(
adminNamedGraphIri = "http://www.knora.org/data/admin",
groupIri.value,
maybeName = request.name.map(_.value),
maybeDescriptions = request.descriptions.map(_.value),
maybeProject = None, // maybe later we want to allow moving of a group to another project
maybeStatus = request.status.map(_.value),
maybeSelfjoin = request.selfjoin.map(_.value)
)
_ <- triplestore.query(Update(updateGroupSparqlString))
/* Verify that the project was updated. */
updatedGroup <-
groupGetADM(groupIri.value)
.someOrFail(UpdateNotPerformedException("Group was not updated. Please report this as a possible bug."))
} yield GroupGetResponseADM(updatedGroup)
////////////////////
// Helper Methods //
////////////////////
/**
* Helper method for checking if a group identified by name / project IRI exists.
*
* @param name the name of the group.
* @param projectIri the IRI of the project.
* @return a [[Boolean]].
*/
private def groupByNameAndProjectExists(name: String, projectIri: IRI): Task[Boolean] =
triplestore.query(Ask(sparql.admin.txt.checkGroupExistsByName(projectIri, name)))
/**
* In the case that the group was deactivated (status = false), the
* group members need to be removed from the group.
*
* @param changedGroup the group with the new status.
* @return a [[GroupGetResponseADM]]
*/
private def removeGroupMembersIfNecessary(changedGroup: GroupADM) =
if (changedGroup.status) {
// group active. no need to remove members.
logger.debug("removeGroupMembersIfNecessary - group active. no need to remove members.")
ZIO.succeed(GroupGetResponseADM(changedGroup))
} else {
// group deactivated. need to remove members.
logger.debug("removeGroupMembersIfNecessary - group deactivated. need to remove members.")
for {
members <- groupMembersGetADM(changedGroup.id, KnoraSystemInstances.Users.SystemUser)
_ <- ZIO.foreachDiscard(members)(user =>
messageRelay.ask[UserResponseADM](UserGroupMembershipRemoveRequestADM(user, changedGroup))
)
} yield GroupGetResponseADM(group = changedGroup)
}
}
object GroupsResponderADMLive {
val layer: URLayer[
MessageRelay & StringFormatter & IriService & TriplestoreService,
GroupsResponderADM
] = ZLayer.fromZIO {
for {
ts <- ZIO.service[TriplestoreService]
iris <- ZIO.service[IriService]
sf <- ZIO.service[StringFormatter]
mr <- ZIO.service[MessageRelay]
handler <- mr.subscribe(GroupsResponderADMLive(ts, mr, iris, sf))
} yield handler
}
}