aboutsummaryrefslogtreecommitdiff
path: root/src/main/scala/xyz/driver/common/acl/ACL.scala
blob: 35c26614f7e05fbfc9510659a4826ec568d66e6c (plain) (blame)
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
package xyz.driver.common.acl

import xyz.driver.common.logging._
import xyz.driver.common.auth.AuthenticatedRequestContext

/**
  * @see https://driverinc.atlassian.net/wiki/display/RA/User+permissions#UserPermissions-AccessControlList
  */
object ACL extends PhiLogging {

  import xyz.driver.common.domain.User.Role
  import Role._

  type AclCheck = Role => Boolean

  val Forbid: AclCheck = _ => false

  val Allow: AclCheck = _ => true

  // Common

  object User extends BaseACL(
    label = "user",
    create = Set(RecordAdmin, TrialAdmin, TreatmentMatchingAdmin),
    read = Allow,
    update = Allow,
    delete = Set(RecordAdmin, TrialAdmin, TreatmentMatchingAdmin)
  )

  object Label extends BaseACL(
    label = "label",
    read = RepRoles ++ TcRoles ++ TreatmentMatchingRoles
  )

  // REP

  object MedicalRecord extends BaseACL(
    label = "medical record",
    read = RepRoles + RoutesCurator + TreatmentMatchingAdmin,
    update = RepRoles - DocumentExtractor
  )

  object Document extends BaseACL(
    label = "document",
    create = Set(RecordOrganizer, RecordAdmin),
    read = RepRoles - RecordCleaner + RoutesCurator + TreatmentMatchingAdmin,
    update = RepRoles - RecordCleaner,
    delete = Set(RecordOrganizer, RecordAdmin)
  )

  object ExtractedData extends BaseACL(
    label = "extracted data",
    create = Set(DocumentExtractor, RecordAdmin),
    read = Set(DocumentExtractor, RecordAdmin, RoutesCurator, TreatmentMatchingAdmin),
    update = Set(DocumentExtractor, RecordAdmin),
    delete = Set(DocumentExtractor, RecordAdmin)
  )

  object Keyword extends BaseACL(
    label = "keyword",
    read = Set(DocumentExtractor, RecordAdmin)
  )

  object ProviderType extends BaseACL(
    label = "provider type",
    read = RepRoles + RoutesCurator + TreatmentMatchingAdmin
  )

  object DocumentType extends BaseACL(
    label = "document type",
    read = RepRoles + RoutesCurator + TreatmentMatchingAdmin
  )

  object Message extends BaseACL(
    label = "message",
    create = RepRoles ++ TreatmentMatchingRoles ++ TcRoles,
    read = RepRoles ++ TreatmentMatchingRoles ++ TcRoles,
    update = RepRoles ++ TreatmentMatchingRoles ++ TcRoles,
    delete = RepRoles ++ TreatmentMatchingRoles ++ TcRoles
  )

  // TC

  object Trial extends BaseACL(
    label = "trial",
    read = TcRoles + RoutesCurator + TreatmentMatchingAdmin,
    update = TcRoles
  )

  object StudyDesign extends BaseACL(
    label = "study design",
    read = Set(TrialSummarizer, TrialAdmin)
  )

  object Hypothesis extends BaseACL(
    label = "hypothesis",
    read = Set(TrialSummarizer, TrialAdmin) ++ TreatmentMatchingRoles
  )

  object Criterion extends BaseACL(
    label = "criterion",
    create = Set(CriteriaCurator, TrialAdmin),
    read = Set(CriteriaCurator, TrialAdmin, RoutesCurator, TreatmentMatchingAdmin),
    update = Set(CriteriaCurator, TrialAdmin),
    delete = Set(CriteriaCurator, TrialAdmin)
  )

  object Arm extends BaseACL(
    label = "arm",
    create = Set(TrialSummarizer, TrialAdmin),
    read = TcRoles,
    update = Set(TrialSummarizer, TrialAdmin),
    delete = Set(TrialSummarizer, TrialAdmin)
  )

  object Category extends BaseACL(
    label = "category",
    read = Set(DocumentExtractor, RecordAdmin, CriteriaCurator, TrialAdmin)
  )

  object Intervention extends BaseACL(
    label = "intervention",
    read = Set(TrialSummarizer, TrialAdmin),
    update = Set(TrialSummarizer, TrialAdmin)
  )

  object InterventionType extends BaseACL(
    label = "intervention type",
    read = Set(TrialSummarizer, TrialAdmin)
  )

  // EV

  object Patient extends BaseACL(
    label = "patient",
    read = TreatmentMatchingRoles,
    update = TreatmentMatchingRoles
  )

  object PatientLabel extends BaseACL(
    label = "patient label",
    read = TreatmentMatchingRoles,
    update = TreatmentMatchingRoles
  )

  object PatientCriterion extends BaseACL(
    label = "patient criterion",
    read = TreatmentMatchingRoles,
    update = TreatmentMatchingRoles
  )

  object PatientLabelEvidence extends BaseACL(
    label = "patient label evidence",
    read = TreatmentMatchingRoles
  )

  object EligibleTrial extends BaseACL(
    label = "eligible trial",
    read = Set(RoutesCurator, TreatmentMatchingAdmin),
    update = Set(RoutesCurator, TreatmentMatchingAdmin)
  )

  object PatientHypothesis extends BaseACL(
    label = "patient hypothesis",
    read = Set(RoutesCurator, TreatmentMatchingAdmin),
    update = Set(RoutesCurator, TreatmentMatchingAdmin)
  )

  // Utility code

  abstract class BaseACL(label: String,
                         create: AclCheck = Forbid,
                         read: AclCheck = Forbid,
                         update: AclCheck = Forbid,
                         delete: AclCheck = Forbid) {

    def isCreateAllow()(implicit requestContext: AuthenticatedRequestContext): Boolean = {
      check("create", create)(requestContext.executor.role)
    }

    def isReadAllow()(implicit requestContext: AuthenticatedRequestContext): Boolean = {
      check("read", read)(requestContext.executor.role)
    }

    def isUpdateAllow()(implicit requestContext: AuthenticatedRequestContext): Boolean = {
      check("update", update)(requestContext.executor.role)
    }

    def isDeleteAllow()(implicit requestContext: AuthenticatedRequestContext): Boolean = {
      check("delete", delete)(requestContext.executor.role)
    }

    private def check(action: String, isAllowed: AclCheck)(executorRole: Role): Boolean = {
      loggedError(
        isAllowed(executorRole),
        phi"$executorRole has no access to ${Unsafe(action)} a ${Unsafe(label)}"
      )
    }

  }

}