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

Revision 1199, 16.9 KB (checked in by j.saito@…, 3 years ago)

Further streamlined CommunicationManager?. It now builds fetches its URL from config.modules and is further minimized.

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