root/trunk/grails-app/controllers/RestController.groovy @ 1821

Revision 1821, 20.5 KB (checked in by robert@…, 3 years ago)

Added HTTP status 500 when getAssays is called without proper parameters

  • Property svn:keywords set to Rev Author Date
Line 
1/**
2 * RestController
3 *
4 * This controler provides a REST service.
5 * The names of the RESET resources are the same as the names of this
6 * controller's actions. E.g., the resources called getStudies simply
7 * corresponds to the action getStudies. Some of the resources are parameterized.
8 * The parameters are passed as parameters in the url and are available in the
9 * params respecting Grails' conventions. In this file, we adher to the javadoc 
10 * convention for describing parameters ("@param"), but actually we mean
11 * key-value pairs in the params object of each Grails action we comment on.
12 *
13 * @author      Jahn-Takeshi Saito
14 * @since       20100601
15 *
16 */
17
18import dbnp.studycapturing.Study
19import dbnp.studycapturing.Assay
20import dbnp.authentication.SecUser
21import grails.converters.*
22import nl.metabolomicscentre.dsp.http.BasicAuthentication
23import dbnp.rest.common.CommunicationManager
24import org.springframework.security.core.context.SecurityContextHolder;
25
26class RestController {
27
28        /**************************************************/
29        /** Rest resources for Simple Assay Module (SAM) **/
30        /**************************************************/
31
32        def authenticationService
33        def beforeInterceptor = [action:this.&auth,except:["isUser"]]
34        def credentials
35        def requestUser
36
37        /**
38         * Authorization closure, which is run before executing any of the REST resource actions
39         * It fetches a consumer/token combination from the url and checks whether
40         * that is a correct and known combination
41         *
42         * @param       consumer        consumer name of the calling module
43         * @param       token           token for the authenticated user (e.g. session_id)
44         * @return  true if the user is remotely logged in, false otherwise
45         */
46        private def auth() {
47                if( !authenticationService.isRemotelyLoggedIn( params.consumer, params.token ) ) {
48                        response.sendError(403)
49                        return false
50                } else {
51                        return true
52                }
53        }
54
55        /**
56         * REST resource for data modules.
57         * Consumer and token should be supplied via URL parameters.
58         * Determines whether the given user/password combination is a valid GSCF account.
59         *
60         * @param       consumer        consumer name of the calling module
61         * @param       token           token for the authenticated user (e.g. session_id)
62         * @return bool {"authenticated":true} when user/password is a valid GSCF account, {"authenticated":false} otherwise.
63         */
64        def isUser = {
65                boolean isUser = authenticationService.isRemotelyLoggedIn( params.consumer, params.token )
66                def reply = ['authenticated':isUser]
67
68                // set output header to json
69                response.contentType = 'application/json'
70
71                render reply as JSON
72        }
73
74        /**
75         * REST resource for data modules.
76         * Consumer and token should be supplied via URL parameters.
77         * Provides the details of the user that has logged in
78         *
79         * @param       consumer        consumer name of the calling module
80         * @param       token           token for the authenticated user (e.g. session_id)
81         * @return bool {"username": "...", "id": ... } when user/password is logged in.
82         */
83        def getUser = {
84                SecUser user = authenticationService.getRemotelyLoggedInUser( params.consumer, params.token )
85                def reply = [username: user.username, id: user.id, isAdministrator: user.hasAdminRights() ]
86
87                // set output header to json
88                response.contentType = 'application/json'
89
90                render reply as JSON
91        }
92
93        /**
94         * REST resource for data modules.
95         * Consumer and token should be supplied via URL parameters.
96         * Provide a list of all studies owned by the supplied user.
97         *
98         * @param       studyToken  optional parameter. If no studyToken is given, all studies available to user are returned.
99         *                      Otherwise, the studies for which the studyTokens are given are be returned.
100         * @param       consumer        consumer name of the calling module
101         * @param       token           token for the authenticated user (e.g. session_id)
102         * @return  JSON object list containing 'studyToken', and 'name' (title) for each study
103         *
104         * If one study is requested, a 404 error might occur if the study doesn't exist, and a 401 error if the user is not
105         * authorized to access this study. If multiple studies are requrested, non-existing studies or studies for which the
106         * user is not authorized are not returned in the list (so the list might be empty).
107         *
108         * Example 1. REST call without studyToken.
109         *
110         * Call: http://localhost:8080/gscf/rest/getStudies/query
111         *
112         * Result: [{"title":"NuGO PPS3 mouse study leptin module","studyToken":"PPS3_leptin_module",
113         *                      "startDate":"2008-01-01T23:00:00Z","published":false,"Description":"C57Bl/6 mice were fed a high fat (45 en%)
114         *                      or low fat (10 en%) diet after a four week run-in on low fat diet.","Objectives":null,"Consortium":null,
115         *                      "Cohort name":null,"Lab id":null,"Institute":null,"Study protocol":null},
116         *                      {"title":"NuGO PPS human study","studyToken":"PPSH","startDate":"2008-01-13T23:00:00Z","published":false,
117         *                      "Description":"Human study performed at RRI; centres involved: RRI, IFR, TUM, Maastricht U.","Objectives":null,
118         *                      "Consortium":null,"Cohort name":null,"Lab id":null,"Institute":null,"Study protocol":null}]
119         *
120         *
121         * Example 2. REST call with one studyToken.
122         *
123         * Call: http://localhost:8080/gscf/rest/getStudies/query?studyToken=PPSH
124         *
125         * Result: [{"title":"NuGO PPS human study","studyToken":"PPSH","startDate":"2008-01-13T23:00:00Z",
126         *              "published":false,"Description":"Human study performed at RRI; centres involved: RRI, IFR, TUM, Maastricht U.",
127         *              "Objectives":null,"Consortium":null,"Cohort name":null,"Lab id":null,"Institute":null,"Study protocol":null}]
128         *
129         *
130         *
131         * Example 2. REST call with two studyTokens.
132         *
133         * http://localhost:8080/gscf/rest/getStudies/query?studyToken=PPSH&studyToken=PPS3_leptin_module
134         *
135         * Result: same as result of Example 1.
136         */
137        def getStudies = {
138
139                List returnStudies = []
140                List studies = []
141
142                if( !params.studyToken ) {
143                        studies = Study.findAll()
144                }
145                else if( params.studyToken instanceof String ) {
146                        def study = Study.findByStudyUUID( params.studyToken )
147                        if( study ) {
148                                if( !study.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token )) ) {
149                                        response.sendError(401)
150                                        return false
151                                }
152
153                                studies.push study
154                        } else {
155                                response.sendError(404)
156                                return false
157                        }
158
159                }
160                else {
161                        params.studyToken.each{ studyToken ->
162                                def study = Study.findByStudyUUID( studyToken );
163                                if( study )
164                                        studies.push study
165                        }
166                }
167
168
169                studies.each { study ->
170                        if(study) {
171                                def user = authenticationService.getRemotelyLoggedInUser( params.consumer, params.token )
172                                // Check whether the person is allowed to read the data of this study
173                                if( study.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ))) {
174
175                                        def items = [studyToken:study.giveUUID()]
176                                        study.giveFields().each { field ->
177                                                def name = field.name
178                                                def value = study.getFieldValue( name )
179                                                items[name] = value
180                                        }
181
182                                        // Add study version number
183                                        items['version'] = study.version;
184
185                                        returnStudies.push items
186                                }
187                        }
188                }
189
190                // set output header to json
191                response.contentType = 'application/json'
192
193                render returnStudies as JSON
194        }
195
196        /**
197         * REST resource for data modules.
198         * Consumer and token should be supplied via URL parameters.
199         * Provides the version number of the specified study
200         *
201         * @param       studyToken  optional parameter. If no studyToken is given, a 400 error is given
202         * @param       consumer        consumer name of the calling module
203         * @param       token           token for the authenticated user (e.g. session_id)
204         * @return  JSON object list containing 'studyToken', and 'version'
205         *
206         * A 404 error might occur if the study doesn't exist, and a 401 error if the user is not
207         * authorized to access this study.
208         *
209         * Example. REST call with one studyToken.
210         *
211         * Call: http://localhost:8080/gscf/rest/getStudyVersion?studyToken=PPSH
212         *
213         * Result: {"studyToken":"PPSH","version":31}
214         */
215        def getStudyVersion = {
216
217                def versionInfo = [:];
218                def study
219
220                if( !params.studyToken || !(params.studyToken instanceof String)) {
221                        response.sendError(400)
222                        return false
223                } else {
224                        study = Study.findByStudyUUID( params.studyToken )
225                        if( study ) {
226                                if( !study.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token )) ) {
227                                        response.sendError(401)
228                                        return false
229                                }
230                        } else {
231                                response.sendError(404)
232                                return false
233                        }
234                }
235
236                versionInfo[ 'studyToken' ] = params.studyToken;
237                versionInfo[ 'version' ] = study.version;
238
239                // set output header to json
240                response.contentType = 'application/json'
241
242                render versionInfo as JSON
243        }
244
245        /**
246         * REST resource for data modules.
247         * Consumer and token should be supplied via URL parameters.
248         * Provide a list of all subjects belonging to a study.
249         *
250         * If the user is not allowed to read the study contents, a 401 error is given. If the study doesn't exist, a 404 error is given
251         *
252         * @param       studyToken      String The external study id (code) of the target GSCF Study object
253         * @param       consumer        consumer name of the calling module
254         * @param       token           token for the authenticated user (e.g. session_id)
255         * @return JSON object list of subject names
256         */
257        def getSubjects = {
258                List subjects = []
259                if( params.studyToken ) {
260                        def study = Study.findByStudyUUID( params.studyToken)
261
262                        if(study) {
263                                // Check whether the person is allowed to read the data of this study
264                                if( !study.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ))) {
265                                        response.sendError(401)
266                                        return false
267                                }
268
269                                study.subjects.each { subjects.push it.name }
270                        } else {
271                                response.sendError(404)
272                                return false
273                        }
274                }
275
276                // set output header to json
277                response.contentType = 'application/json'
278
279                render subjects as JSON
280        }
281
282
283        /**
284         * REST resource for data modules.
285         * Consumer and token should be supplied via URL parameters.
286         * Provide a list of all assays for a given study.
287         *
288         * If the user is not allowed to read the study contents, a 401 error is given. If the study doesn't exist, a 404 error is given
289         *
290         * @param       studyToken      String The external study id (code) of the target GSCF Study object
291         * @param       consumer        consumer name of the calling module
292         * @return list of assays in the study as JSON object list, filtered to only contain assays
293         *         for the specified module, with 'assayToken' and 'name' for each assay
294         *
295         *
296         * Example 1. REST call without assayToken
297         *            http://localhost:8080/gscf/rest/getAssays/aas?studyToken=PPSH
298         *                              &consumer=http://localhost:8182/sam
299         *
300         * Result: [{"name":"Glucose assay after",
301         *                      "module":{"class":"dbnp.studycapturing.AssayModule","id":1,"name":"SAM module for clinical data",
302         *                              "platform":"clinical measurements","url":"http://localhost:8182/sam"},
303         *                      "externalAssayID":"PPSH-Glu-A", "Description":null,"parentStudyToken":"PPSH"},
304         *                      {"name":"Glucose assay before",
305         *                              "module":{"class":"dbnp.studycapturing.AssayModule","id":1,"name":"SAM module for clinical data",
306         *                              "platform":"clinical measurements","url":"http://localhost:8182/sam"},
307         *                              "externalAssayID":"PPSH-Glu-B","Description":null,"parentStudyToken":"PPSH"}]
308         *
309         *
310         * Example 2. REST call with one assayToken
311         *                        http://localhost:8080/gscf/rest/getAssays/queryOneTokenz?studyToken=PPSH
312         *                              &consumer=http://localhost:8182/sam&assayToken=PPSH-Glu-A
313         *
314         * Result: [{"name":"Glucose assay after","module":{"class":"dbnp.studycapturing.AssayModule","id":1,
315         *                      "name":"SAM module for clinical data","platform":"clinical measurements","url":"http://localhost:8182/sam"},
316         *                      "externalAssayID":"PPSH-Glu-A","Description":null,"parentStudyToken":"PPSH"}]
317         *
318         *
319         * Example 3. REST call with two assayTokens.
320         *
321         * Result: Same as result in Example 1.
322         */
323        def getAssays = {
324                // set output header to json
325                response.contentType = 'application/json'
326
327                List returnList = []    // return list of hashes each containing fields and values belonging to an assay
328
329                // Check if required parameters are present
330                def validCall = CommunicationManager.hasValidParams( params, "consumer" )
331                if( !validCall ) {
332                        response.status = 500;
333                        render "Error. Wrong or insufficient parameters." as JSON
334                        return
335                }
336               
337                def assays = []
338               
339                if( params.studyToken ) {
340
341                        def study = Study.findByStudyUUID(params.studyToken)
342
343                        if(study) {
344                                // Check whether the person is allowed to read the data of this study
345                                if( !study.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ))) {
346                                        response.sendError(401)
347                                        return false
348                                }
349
350                                if(params.assayToken==null) {
351                                        assays = study.assays
352                                }
353                                else if( params.assayToken instanceof String ) {
354                                        def assay = study.assays.find{ it.giveUUID() == params.assayToken }
355                                        if( assay ) {
356                                                assays.push assay
357                                        }
358                                }
359                                else {                                                                                                  // there are multiple assayTokens instances
360                                        params.assayToken.each { assayToken ->
361                                                def assay = study.assays.find{ it.giveUUID() == assayToken }
362                                                if(assay) {
363                                                        assays.push assay
364                                                }
365                                        }
366                                }
367
368                        } else {
369                                response.sendError(404)
370                                return false
371                        }
372
373                } else {
374                        // Return all assays for the given module
375                        assays = Assay.list().findAll{ it.parent.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ) ) }
376                }
377
378                // Create data for all assays
379                assays.each{ assay ->
380                        if (assay.module?.url && assay.module.url.equals(params.moduleURL)) {
381                                if(assay) {
382                                        def map = [assayToken : assay.giveUUID()]
383                                        assay.giveFields().each { field ->
384                                                def name = field.name
385                                                def value = assay.getFieldValue( name )
386                                                map[name] = value
387                                        }
388                                        map["parentStudyToken"] = assay.parent.giveUUID()
389                                        returnList.push( map )
390                                }
391                        }
392                }
393
394                render returnList as JSON
395        }
396
397        /**
398         * REST resource for data modules.
399         * Provide all samples of a given Assay. The result is an enriched list with additional information for each sample.
400         *
401         * If the user is not allowed to read the study contents, a 401 error is given. If the assay doesn't exist, a 404 error is given
402         *
403         * @param       assayToken      String (assayToken of some Assay in GSCF)
404         * @param       sampleToken Optional parameter. One or more sampleTokens to specify what sample to give exectly.
405         *                      If not given, return all samples for specified assay.
406         * @param       consumer        consumer name of the calling module
407         * @param       token           token for the authenticated user (e.g. session_id)
408         * @return As a JSON object list, for each sample in that assay:
409         * @return 'name' (Sample name, which is unique)
410         * @return 'material' (Sample material)
411         * @return 'subject' (The name of the subject from which the sample was taken)
412         * @return 'event' (the name of the template of the SamplingEvent describing the sampling)
413         * @return 'startTime' (the time the sample was taken relative to the start of the study, as a string)
414         * @return additional template fields are returned
415         *
416         *
417         *
418         * Example 1: no sampleTokens given.
419         * Query:
420         * http://localhost:8080/gscf/rest/getSamples/query?assayToken=PPSH-Glu-A
421         *
422         * Result:
423         * [{"sampleToken":"5_A","material":"blood plasma","subject":"5","event":"Blood extraction","startTime":"4 days, 6 hours"},
424         * {"sampleToken":"6_A","material":"blood plasma","subject":"6","event":"Blood extraction","startTime":"4 days, 6 hours"},
425         * {"sampleToken":"10_A","material":"blood plasma","subject":"10","event":"Blood extraction","startTime":"4 days, 6 hours"},
426         * {"sampleToken":"2_A","material":"blood plasma","subject":"2","event":"Blood extraction","startTime":"4 days, 6 hours"},
427         * {"sampleToken":"11_A","material":"blood plasma","subject":"11","event":"Blood extraction","startTime":"4 days, 6 hours"},
428         * {"sampleToken":"1_A","material":"blood plasma","subject":"1","event":"Blood extraction","startTime":"4 days, 6 hours"},
429         * {"sampleToken":"9_A","material":"blood plasma","subject":"9","event":"Blood extraction","startTime":"4 days, 6 hours"},
430         * {"sampleToken":"4_A","material":"blood plasma","subject":"4","event":"Blood extraction","startTime":"4 days, 6 hours"},
431         * {"sampleToken":"8_A","material":"blood plasma","subject":"8","event":"Blood extraction","startTime":"4 days, 6 hours"},
432         * {"sampleToken":"7_A","material":"blood plasma","subject":"7","event":"Blood extraction","startTime":"4 days, 6 hours"},
433         * {"sampleToken":"3_A","material":"blood plasma","subject":"3","event":"Blood extraction","startTime":"4 days, 6 hours"}]
434         *
435         *
436         *
437         * Example 2: one sampleToken given.
438         * Query:
439         * http://localhost:8080/gscf/rest/getSamples/query?assayToken=PPSH-Glu-A&sampleToken=5_A
440         *
441         * Result:
442         * [{"sampleToken":"5_A","material":"blood plasma","subject":"5","event":"Blood extraction","startTime":"4 days, 6 hours"}]
443         *
444         *
445         *
446         * Example 3: two sampleTokens given.
447         * Query:
448         * http://localhost:8080/gscf/rest/getSamples/query?assayToken=PPSH-Glu-A&sampleToken=5_A&sampleToken=6_A
449         *
450         * Result:
451         * [{"sampleToken":"5_A","material":"blood plasma","subject":"5","event":"Blood extraction","startTime":"4 days, 6 hours"},
452         *  {"sampleToken":"6_A","material":"blood plasma","subject":"6","event":"Blood extraction","startTime":"4 days, 6 hours"}]
453         *
454         *
455         * Example 4: no assaytoken given
456         * Query:
457         * http://localhost:8080/gscf/rest/getSamples/query?sampleToken=5_A&sampleToken=6_A
458         *
459         * Result:
460         * [{"sampleToken":"5_A","material":"blood plasma","subject":"5","event":"Blood extraction","startTime":"4 days, 6 hours"},
461         *  {"sampleToken":"6_A","material":"blood plasma","subject":"6","event":"Blood extraction","startTime":"4 days, 6 hours"}]
462         *
463         */
464        def getSamples = {
465                def items = []
466                def samples
467                if( params.assayToken ) {
468                        def assay = Assay.findByAssayUUID( params.assayToken );
469
470                        if( assay )  {
471                                // Check whether the person is allowed to read the data of this study
472                                if( !assay.parent.canRead(authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ))) {
473                                        response.sendError(401)
474                                        return false
475                                }
476
477                                samples = assay.getSamples() // on all samples
478                        } else {
479                                // Assay not found
480                                response.sendError(404)
481                                return false
482                        }
483                } else {
484                        // Find all samples from studies the user can read
485                        def studies = Study.list().findAll { it.canRead( authenticationService.getRemotelyLoggedInUser( params.consumer, params.token ) ) };
486                        samples = studies*.getSamples().flatten();
487                }
488
489                // Check whether only a subset of samples should be returned
490                if( params.sampleToken ) {
491                        def sampleTokens = params.list( "sampleToken" );
492                        samples = samples.findAll { sampleTokens.contains( it.giveUUID() ) }
493                }
494
495                samples.each { sample ->
496
497                        def item = [
498                                                'sampleToken' : sample.giveUUID(),
499                                                'material'        : sample.material?.name,
500                                                'subject'         : sample.parentSubject?.name,
501                                                'event'           : sample.parentEvent?.template?.name,
502                                                'startTime'       : sample.parentEvent?.getStartTimeString()
503                                        ]
504
505                        sample.giveFields().each { field ->
506                                def name = field.name
507                                def value = sample.getFieldValue( name )
508                                if(name!='material')
509                                {
510                                        item[name]=value
511                                }
512                        }
513
514                        if(sample.parentEvent) {
515                                def parentEvent = sample.parentEvent
516                                def eventHash = [:]
517                                parentEvent.giveFields().each { field ->
518                                        def name = field.name
519                                        if( name !='sampleTemplate' && name != 'fields') {
520                                                def value = parentEvent.getFieldValue( name )
521                                                eventHash[name]=value
522                                        }
523                                }
524                                item['eventObject'] = eventHash
525                        }
526
527                        if(sample.parentSubject) {
528                                def parentSubject = sample.parentSubject
529                                def subject = [:]
530                                parentSubject.giveFields().each { field ->
531                                        def name = field.name
532                                        if( name!='fields') {
533                                                def value = parentSubject.getFieldValue( name )
534                                                subject[name]=value
535                                        }
536                                }
537                                item['subjectObject'] = subject
538                        }
539
540                        items.push item
541                }
542
543                // set output header to json
544                response.contentType = 'application/json'
545
546                render items as JSON
547        }
548
549        /**
550         * Returns the authorization level the user has for a given study.
551         *
552         * If no studyToken is given, a 400 (Bad Request) error is given.
553         * If the given study doesn't exist, a 404 (Not found) error is given.
554         *
555         * @param       consumer        consumer name of the calling module
556         * @param       token           token for the authenticated user (e.g. session_id)
557         * @return      JSON Object
558         * @return  { isOwner: true/false, 'canRead': true/false, 'canWrite': true/false }
559         */
560        def getAuthorizationLevel = {
561                if( params.studyToken ) {
562                        def study = Study.findByStudyUUID(params.studyToken)
563
564                        if( !study ) {
565                                response.sendError(404)
566                                return false
567                        }
568
569                        def user = authenticationService.getRemotelyLoggedInUser( params.consumer, params.token );
570                        def auth = ['isOwner': study.isOwner(user), 'canRead': study.canRead(user), 'canWrite': study.canWrite(user)];
571                        log.trace "Authorization for study " + study.title + " and user " + user.username + ": " + auth
572
573                        // set output header to json
574                        response.contentType = 'application/json'
575
576                        render auth as JSON;
577                } else {
578                        response.sendError(400)
579                        return false
580                }
581        }
582}
Note: See TracBrowser for help on using the browser.