-
Notifications
You must be signed in to change notification settings - Fork 17
/
MiscController.groovy
246 lines (226 loc) · 10.2 KB
/
MiscController.groovy
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
package au.org.ala.bie
import au.ala.org.ws.security.RequireApiKey
import au.org.ala.plugins.openapi.Path
import grails.converters.JSON
import grails.converters.XML
import io.swagger.v3.oas.annotations.Operation
import io.swagger.v3.oas.annotations.Parameter
import io.swagger.v3.oas.annotations.headers.Header
import io.swagger.v3.oas.annotations.media.Schema
import io.swagger.v3.oas.annotations.responses.ApiResponse
import io.swagger.v3.oas.annotations.security.SecurityRequirement
import org.apache.http.HttpStatus
import javax.ws.rs.Produces
import static grails.web.http.HttpHeaders.CONTENT_DISPOSITION
import static grails.web.http.HttpHeaders.LAST_MODIFIED
import static io.swagger.v3.oas.annotations.enums.ParameterIn.HEADER
import static io.swagger.v3.oas.annotations.enums.ParameterIn.QUERY
class MiscController {
def speciesGroupService, indexService, bieAuthService, importService, imageService, wikiUrlService
def speciesGroups() {
try {
def details = speciesGroupService.configFileDetails()
details.is.withStream { is ->
response.contentLength = details.size
response.contentType = 'application/json'
// next line causes link to download file to downloads folder, is this needed? (NdR)
response.setHeader(CONTENT_DISPOSITION, "attachment; filename=subgroups.json")
response.setDateHeader(LAST_MODIFIED, details.lastModified)
response.outputStream << is
}
} catch (FileNotFoundException e) {
response.sendError(404)
}
return
}
@Operation(
method = "GET",
tags = "rank",
operationId = "ranks",
summary = "Gets a description of the ranks used to classify levels of taxa",
responses = [
@ApiResponse(
responseCode = "200",
description = "Success",
headers = [
@Header(name = 'Access-Control-Allow-Headers', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Methods', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Origin', description = "CORS header", schema = @Schema(type = "string"))
]
)
]
)
@Path("/ranks")
@Produces("application/json")
def ranks() {
def indexedFields = indexService.getIndexFieldDetails().collect {
it.name.replaceAll("^[^_]+_", "")
}
def activeRanks = importService.ranks().findAll {
indexedFields.contains(it.value.rank)
}
render activeRanks as JSON
}
@Operation(
method = "GET",
tags = "fields",
operationId = "fields",
summary = "Gets the list of indexed fields",
responses = [
@ApiResponse(
responseCode = "200",
description = "Success",
headers = [
@Header(name = 'Access-Control-Allow-Headers', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Methods', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Origin', description = "CORS header", schema = @Schema(type = "string"))
]
)
]
)
@Path("/indexFields")
@Produces("application/json")
def indexFields() {
def fields = indexService.getIndexFieldDetails(null)
withFormat {
'*' { render fields as JSON }
json { render fields as JSON }
html { render fields as JSON }
xml { render fields as XML }
}
}
def updateImages() {
def checkRequest = bieAuthService.checkApiKey(request.getHeader("Authorization"))
if (checkRequest.valid) {
try {
// contain list of guids and images
List<Map> preferredImagesList = request.getJSON()
def updatedTaxa = importService.updateDocsWithPreferredImage(preferredImagesList)
asJson(HttpStatus.SC_OK, [success: true, updatedTaxa: updatedTaxa])
} catch (Exception e) {
asJson(HttpStatus.SC_INTERNAL_SERVER_ERROR, [success: false, message: "Internal error occurred: " + e.getMessage() ])
}
} else {
asJson(HttpStatus.SC_INTERNAL_SERVER_ERROR, [success: false, message: "Unauthorised access. Failed to update Image in Bie" ])
}
}
/**
* Do logouts through this app so we can invalidate the session.
*
* @param casUrl the url for logging out of cas
* @param appUrl the url to redirect back to after the logout
*/
def logout = {
session.invalidate()
redirect(url:"${params.casUrl}?url=${params.appUrl}")
}
private def asJson = { status, model ->
response.status = status
response.setContentType("application/json;charset=UTF-8")
model as JSON
}
@Operation(
method = "GET",
tags = "admin webservices",
operationId = "setImages",
summary = "Set the preferred and hidden images for a taxon",
security = [@SecurityRequirement(name = 'openIdConnect')],
parameters= [
@Parameter(
name = "name",
in = QUERY,
description = "Scientific Name",
schema = @Schema(implementation = String),
required = true
),
@Parameter(
name = "guid",
in = QUERY,
description = "Taxon ID",
schema = @Schema(implementation = String),
required = true
),
@Parameter(
name = "prefer",
in = QUERY,
description = "Comma delimited preferred Image IDs",
schema = @Schema(implementation = String),
required = true
),
@Parameter(
name = "hide",
in = QUERY,
description = "Comma delimited hidden Image IDs",
schema = @Schema(implementation = String),
required = true
),
@Parameter(name = "Authorization", in = HEADER, schema = @Schema(implementation = String), required = true)
],
responses = [
@ApiResponse(
responseCode = "200",
description = "Success",
headers = [
@Header(name = 'Access-Control-Allow-Headers', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Methods', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Origin', description = "CORS header", schema = @Schema(type = "string"))
]
)
]
)
@Path("/api/setImages")
@Produces("application/json")
@RequireApiKey
def setImages() {
imageService.prefer(params.name, params.guid, params.prefer)
imageService.hide(params.name, params.guid, params.hide)
}
@Operation(
method = "GET",
tags = "admin webservices",
operationId = "setWikiUrl",
summary = "Set the preferred wiki URL for a taxon",
security = [@SecurityRequirement(name = 'openIdConnect')],
parameters= [
@Parameter(
name = "name",
in = QUERY,
description = "Scientific Name",
schema = @Schema(implementation = String),
required = true
),
@Parameter(
name = "guid",
in = QUERY,
description = "Taxon ID",
schema = @Schema(implementation = String),
required = true
),
@Parameter(
name = "url",
in = QUERY,
description = "URL",
schema = @Schema(implementation = String),
required = true
),
@Parameter(name = "Authorization", in = HEADER, schema = @Schema(implementation = String), required = true)
],
responses = [
@ApiResponse(
responseCode = "200",
description = "Success",
headers = [
@Header(name = 'Access-Control-Allow-Headers', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Methods', description = "CORS header", schema = @Schema(type = "string")),
@Header(name = 'Access-Control-Allow-Origin', description = "CORS header", schema = @Schema(type = "string"))
]
)
]
)
@Path("/api/setUrl")
@Produces("application/json")
@RequireApiKey
def setWikiUrl() {
wikiUrlService.add(params.name, params.guid, params.url)
}
}