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

Revision 1357, 19.5 KB (checked in by robert@…, 3 years ago)

Implemented module notification when a study changes (#259)

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