source: trunk/grails-app/controllers/dbnp/query/AdvancedQueryController.groovy @ 1512

Last change on this file since 1512 was 1512, checked in by robert@…, 9 years ago

Improved query views

  • Property svn:keywords set to Rev Author Date
File size: 17.5 KB
Line 
1package dbnp.query
2
3import dbnp.modules.*
4import org.dbnp.gdt.*
5
6// TODO: Make use of the searchable-plugin or Lucene possibilities instead of querying the database directly
7
8/**
9 * Basic web interface for searching within studies
10 *
11 * @author Robert Horlings (robert@isdat.nl)
12 */
13class AdvancedQueryController {
14        def moduleCommunicationService;
15        def authenticationService
16
17        def entitiesToSearchFor = [ 'Study': 'Studies', 'Sample': 'Samples']
18
19        /**
20         * Shows search screen
21         */
22        def index = {
23                // Check whether criteria have been given before
24                def criteria = [];
25                if( params.criteria ) {
26                        criteria = parseCriteria( params.criteria, false )
27                }
28                [searchModes: SearchMode.values(), entitiesToSearchFor: entitiesToSearchFor, searchableFields: getSearchableFields(), criteria: criteria]
29        }
30
31        /**
32         * Searches for studies or samples based on the user parameters.
33         *
34         * @param       entity          The entity to search for ( 'Study' or 'Sample' )
35         * @param       criteria        HashMap with the values being hashmaps with field, operator and value.
36         *                                              [ 0: [ field: 'Study.name', operator: 'equals', value: 'term' ], 1: [..], .. ]
37         */
38        def search = {
39                if( !params.criteria ) {
40                        flash.error = "No criteria given to search for. Please try again.";
41                        redirect( action: 'index' )
42                }
43
44                if( !params.entity || !entitiesToSearchFor*.key.contains( params.entity ) ) {
45                        flash.error = "No or incorrect entity given to search for. Please try again.";
46                        redirect( action: 'index', params: [ criteria: parseCriteria( params.criteria ) ] )
47                }
48
49                // Create a search object and let it do the searching
50                Search search = determineSearch( params.entity );
51                String view = determineView( params.entity );
52
53                // Choose between AND and OR search. Default is given by the Search class itself.
54                switch( params.operator?.toString()?.toLowerCase() ) {
55                        case "or":
56                                search.searchMode = SearchMode.or;
57                                break;
58                        case "and":
59                                search.searchMode = SearchMode.and;
60                                break;
61                }
62
63                search.execute( parseCriteria( params.criteria ) );
64
65                // Save search in session
66                def queryId = saveSearch( search );
67                render( view: view, model: [search: search, queryId: queryId, actions: determineActions(search)] );
68        }
69
70        /**
71         * Removes a specified search from session
72         * @param       id      queryId of the search to discard
73         */
74        def discard = {
75                def queryIds = params.list( 'id' );
76                queryIds = queryIds.findAll { it.isInteger() }.collect { Integer.valueOf( it ) }
77
78                if( queryIds.size() == 0 ) {
79                        flash.error = "Incorrect search ID given to discard"
80                        redirect( action: "index" );
81                        return
82                }
83
84                queryIds.each { queryId ->
85                        discardSearch( queryId );
86                }
87
88                if( queryIds.size() > 1 ) {
89                        flash.message = "Searches have been discarded"
90                } else {
91                        flash.message = "Search has been discarded"
92                }
93                redirect( action: "list" );
94        }
95
96        /**
97         * Shows a specified search from session
98         * @param       id      queryId of the search to show
99         */
100        def show = {
101                def queryId = params.int( 'id' );
102
103                if( !queryId ) {
104                        flash.error = "Incorrect search ID given to show"
105                        redirect( action: "index" );
106                        return
107                }
108
109                // Retrieve the search from session
110                Search s = retrieveSearch( queryId );
111                if( !s ) {
112                        flash.message = "Specified search could not be found"
113                        redirect( action: "index" );
114                        return;
115                }
116               
117                // Attach all objects to the current hibernate thread, because the
118                // object might be attached to an old thread, since the results are
119                // saved in session
120                s.getResults().each {
121                        it.attach();
122                }
123
124                // Determine which view to show
125                def view = determineView( s.entity );
126                render( view: view, model: [search: s, queryId: queryId, actions: determineActions(s)] );
127        }
128
129        /**
130         * Performs an action on specific searchResults
131         * @param       queryId         queryId of the search to show
132         * @param       id                      list with the ids of the results to perform the action on
133         * @param       actionName      Name of the action to perform
134         */
135        def performAction = {
136                def queryId = params.int( 'queryId' );
137                def selectedIds = params.list( 'id' ).findAll { it.isLong() }.collect { Long.parseLong(it) }
138                def actionName = params.actionName;
139                def moduleName = params.moduleName;
140
141                if( !queryId ) {
142                        flash.error = "Incorrect search ID given to show"
143                        redirect( action: "index" );
144                        return
145                }
146               
147                // Retrieve the search from session
148                Search s = retrieveSearch( queryId );
149                if( !s ) {
150                        flash.message = "Specified search could not be found"
151                        redirect( action: "list" );
152                        return;
153                }
154
155                // Determine the possible actions
156                def actions = determineActions(s, selectedIds );
157
158                // Find the right action to perform
159                def redirectUrl;
160                for( action in actions ) {
161                        if( action.module == moduleName && action.name == actionName ) {
162                                redirectUrl = action.url;
163                                break;
164                        }
165                }
166               
167                if( !redirectUrl ) {
168                        flash.error = "No valid action is given to perform";
169                        redirect( action: "show", id: queryId );
170                        return;
171                }
172               
173                redirect( url: redirectUrl );
174        }
175       
176        /**
177         * Shows a list of searches that have been saved in session
178         * @param       id      queryId of the search to show
179         */
180        def list = {
181                def searches = listSearches();
182
183                if( !searches || searches.size() == 0 ) {
184                        flash.message = "No previous searches found";
185                        redirect( action: "index" );
186                        return;
187                }
188                [searches: searches]
189        }
190
191        /**
192         * Shows a search screen where the user can search within the results of another search
193         * @param       id      queryId of the search to search in
194         */
195        def searchIn = {
196                def queryIds = params.list( 'id' );
197                queryIds = queryIds.findAll { it.isInteger() }.collect { Integer.valueOf( it ) }
198
199                if( queryIds.size() == 0 ) {
200                        flash.error = "Incorrect search ID given to show"
201                        redirect( action: "index" );
202                        return
203                }
204
205                // Retrieve the searches from session
206                def params = [:]
207                queryIds.eachWithIndex { queryId, idx ->
208                        Search s = retrieveSearch( queryId );
209                        if( !s ) {
210                                flash.message = "Specified search " + queryId + " could not be found"
211                                return;
212                        } else {
213                                params[ "criteria." + idx + ".entityfield" ] = s.entity;
214                                params[ "criteria." + idx + ".operator" ] = "in";
215                                params[ "criteria." + idx + ".value" ] = queryId;
216                        }
217                }
218
219                redirect( action: "index", params: params)
220        }
221
222        /**
223         * Combines the results of multiple searches
224         * @param       id      queryIds of the searches to combine
225         */
226        def combine = {
227                def queryIds = params.list( 'id' );
228                queryIds = queryIds.findAll { it.isInteger() }.collect { Integer.valueOf( it ) }
229
230                if( queryIds.size() == 0 ) {
231                        flash.error = "Incorrect search ID given to combine"
232                        redirect( action: "index" );
233                        return
234                }
235
236                // First determine whether the types match
237                def searches = [];
238                def type = "";
239                flash.error = "";
240                queryIds.eachWithIndex { queryId, idx ->
241                        Search s = retrieveSearch( queryId );
242                        if( !s ) {
243                                return;
244                        }
245
246                        if( type ) {
247                                if( type != s.entity ) {
248                                        flash.error = type + " and " + s.entity.toLowerCase() + " queries can't be combined. Selected queries of one type.";
249                                        return
250                                }
251                        } else {
252                                type = s.entity
253                        }
254                }
255
256                if( flash.error ) {
257                        redirect( action: "list" );
258                        return;
259                }
260
261                if( !type ) {
262                        flash.error = "No correct query ids were given."
263                        redirect( action: "list" );
264                        return;
265                }
266
267                // Retrieve the searches from session
268                Search combined = determineSearch( type );
269                combined.searchMode = SearchMode.or;
270
271                queryIds.eachWithIndex { queryId, idx ->
272                        Search s = retrieveSearch( queryId );
273                        if( s ) {
274                                combined.addCriterion( new Criterion( entity: type, field: null, operator: Operator.insearch, value: s ) );
275                        }
276                }
277
278                // Execute search to combine the results
279                combined.execute();
280
281                def queryId = saveSearch( combined );
282                redirect( action: "show", id: queryId );
283        }
284
285        protected String determineView( String entity ) {
286                switch( entity ) {
287                        case "Study":   return "studyresults";  break;
288                        case "Sample":  return "sampleresults"; break;
289                        default:                return "results"; break;
290                }
291        }
292
293        /**
294         * Returns the search object used for searching
295         */
296        protected Search determineSearch( String entity ) {
297                switch( entity ) {
298                        case "Study":   return new StudySearch();
299                        case "Sample":  return new SampleSearch();
300
301                        // This exception will only be thrown if the entitiesToSearchFor contains more entities than
302                        // mentioned in this switch structure.
303                        default:                throw new Exception( "Can't search for entities of type " + entity );
304                }
305        }
306
307        /**
308         * Returns a map of entities with the names of the fields the user can search on
309         * @return
310         */
311        protected def getSearchableFields() {
312                def fields = [:];
313
314                // Retrieve all local search fields
315                getEntities().each {
316                        def entity = getEntity( 'dbnp.studycapturing.' + it );
317
318                        if( entity ) {
319                                def domainFields = entity.giveDomainFields();
320                                def templateFields = TemplateField.findAllByEntity( entity )
321
322                                def fieldNames = ( domainFields + templateFields ).collect { it.name }.unique() + 'Template'
323
324                                fields[ it ] = fieldNames.sort { a, b -> a[0].toUpperCase() + a[1..-1] <=> b[0].toUpperCase() + b[1..-1] };
325                        }
326                }
327
328                // Loop through all modules and check which fields are searchable
329                // Right now, we just combine the results for different entities
330                AssayModule.list().each { module ->
331                        def callUrl = module.url + '/rest/getQueryableFields'
332                        try {
333                                def json = moduleCommunicationService.callModuleRestMethodJSON( module.url, callUrl );
334                                def moduleFields = [];
335                                entitiesToSearchFor.each { entity ->
336                                        if( json[ entity.key ] ) {
337                                                json[ entity.key ].each { field ->
338                                                        moduleFields << field.toString();
339                                                }
340                                        }
341                                }
342
343                                // Remove 'module' from module name
344                                def moduleName = module.name.replace( 'module', '' ).trim()
345
346                                fields[ moduleName ] = moduleFields.unique();
347                        } catch( Exception e ) {
348                                log.error( "Error while retrieving queryable fields from " + module.name + ": " + e.getMessage() )
349                        }
350                }
351
352                return fields;
353        }
354
355        /**
356         * Parses the criteria from the query form given by the user
357         * @param       c       Data from the input form and had a form like
358         *
359         *      [
360         *              0: [entityfield:a.b, operator: b, value: c],
361         *              0.entityfield: a.b,
362         *              0.operator: b,
363         *              0.field: c
364         *              1: [entityfield:f.q, operator: e, value: d],
365         *              1.entityfield: f.q,
366         *              1.operator: e,
367         *              1.field: d
368         *      ]
369         * @param parseSearchIds        Determines whether searches are returned instead of their ids
370         * @return                                      List with Criterion objects
371         */
372        protected List parseCriteria( def formCriteria, def parseSearchIds = true ) {
373                ArrayList list = [];
374                flash.error = "";
375                // Loop through all keys of c and remove the non-numeric ones
376                for( c in formCriteria ) {
377                        if( c.key ==~ /[0-9]+/ ) {
378                                def formCriterion = c.value;
379
380                                Criterion criterion = new Criterion();
381
382                                // Split entity and field
383                                def field = formCriterion.entityfield?.split( /\./ );
384                                if( field.size() > 1 ) {
385                                        criterion.entity = field[0].toString();
386                                        criterion.field = field[1].toString();
387                                } else {
388                                        criterion.entity = field[0];
389                                        criterion.field = null;
390                                }
391
392                                // Convert operator string to Operator-enum field
393                                try {
394                                        criterion.operator = Criterion.parseOperator( formCriterion.operator );
395                                } catch( Exception e) {
396                                        println "Operator " + formCriterion.operator + " could not be parsed: " + e.getMessage();
397                                        flash.error += "Criterion could not be used: operator " + formCriterion.operator + " is not valid.<br />\n";
398                                        continue;
399                                }
400
401                                // Special case of the 'in' operator
402                                if( criterion.operator == Operator.insearch ) {
403                                        Search s
404                                        try {
405                                                s = retrieveSearch( Integer.parseInt( formCriterion.value ) );
406                                        } catch( Exception e ) {}
407
408                                        if( !s ) {
409                                                flash.error += "Can't search within previous query: query not found";
410                                                continue;
411                                        }
412
413                                        if( parseSearchIds ) {
414                                                criterion.value = s
415                                        } else {
416                                                criterion.value = s.id
417                                        }
418                                } else {
419                                        // Copy value
420                                        criterion.value = formCriterion.value;
421                                }
422
423                                list << criterion;
424                        }
425                }
426
427                return list;
428        }
429
430        /**
431         * Returns all entities for which criteria can be entered
432         * @return
433         */
434        protected def getEntities() {
435                return [ 'Study', 'Subject', 'Sample', 'Event', 'SamplingEvent', 'Assay' ]
436        }
437
438        /**
439         * Creates an object of the given entity.
440         *
441         * @return False if the entity is not a subclass of TemplateEntity
442         */
443        protected def getEntity( entityName ) {
444                // Find the templates
445                def entity
446                try {
447                        entity = Class.forName(entityName, true, this.getClass().getClassLoader())
448
449                        // succes, is entity an instance of TemplateEntity?
450                        if (entity.superclass =~ /TemplateEntity$/ || entity.superclass.superclass =~ /TemplateEntity$/) {
451                                return entity;
452                        } else {
453                                return false;
454                        }
455                } catch( ClassNotFoundException e ) {
456                        log.error "Class " + entityName + " not found: " + e.getMessage()
457                        return null;
458                }
459
460        }
461
462
463        /***************************************************************************
464         *
465         * Methods for saving results in session
466         *
467         ***************************************************************************/
468
469        /**
470         * Saves the given search in session. Any search with the same criteria will be overwritten
471         * 
472         * @param s             Search to save
473         * @return              Id of the search for later reference
474         */
475        protected int saveSearch( Search s ) {
476                if( !session.queries )
477                        session.queries = [:]
478
479                // First check whether a search with the same criteria is already present
480                def previousSearch = retrieveSearchByCriteria( s.getCriteria() );
481
482                def id
483                if( previousSearch ) {
484                        id = previousSearch.id;
485                } else {
486                        // Determine unique id
487                        id = ( session.queries*.key.max() ?: 0 ) + 1;
488                }
489
490                s.id = id;
491                session.queries[ id ] = s;
492
493                return id;
494        }
495
496        /**
497         * Retrieves a search from session with the same criteria as given
498         * @param criteria      List of criteria to search for
499         * @return                      Search that has this criteria, or null if no such search is found.
500         */
501        protected Search retrieveSearchByCriteria( List criteria ) {
502                if( !session.queries )
503                        return null
504
505                if( !criteria )
506                        return null
507
508                for( query in session.queries ) {
509                        def key = query.key;
510                        def value = query.value;
511
512                        if( value.criteria && value.criteria.containsAll( criteria ) && criteria.containsAll( value.criteria ) ) {
513                                return value;
514                        }
515                }
516
517                return null;
518        }
519
520
521        /**
522         * Retrieves a search from session
523         * @param id    Id of the search
524         * @return              Search that belongs to this ID or null if no search is found
525         */
526        protected Search retrieveSearch( int id ) {
527                if( !session.queries || !session.queries[ id ] )
528                        return null
529
530                if( !( session.queries[ id ] instanceof Search ) )
531                        return null;
532
533                return (Search) session.queries[ id ]
534        }
535
536        /**
537         * Removes a search from session
538         * @param id    Id of the search
539         * @return      Search that belonged to this ID or null if no search is found
540         */
541        protected Search discardSearch( int id ) {
542                if( !session.queries || !session.queries[ id ] )
543                        return null
544
545                def sessionSearch = session.queries[ id ];
546
547                session.queries.remove( id );
548
549                if( !( sessionSearch instanceof Search ) )
550                        return null;
551
552                return (Search) sessionSearch
553        }
554
555        /**
556         * Retrieves a list of searches from session
557         * @return      List of searches from session
558         */
559        protected List listSearches() {
560                if( !session.queries )
561                        return []
562
563                return session.queries*.value.toList()
564        }
565
566        /**
567         * Determine a list of actions that can be performed on specific entities
568         * @param entity                Name of the entity that the actions could be performed on
569         * @param selectedIds   List with ids of the selected items to perform an action on
570         * @return
571         */
572        protected List determineActions( Search s, def selectedIds = null ) {
573                return gscfActions( s, selectedIds ) + moduleActions( s, selectedIds );
574        }
575
576        /**
577         * Determine a list of actions that can be performed on specific entities by GSCF
578         * @param entity        Name of the entity that the actions could be performed on
579         * @param selectedIds   List with ids of the selected items to perform an action on
580         */
581        protected List gscfActions(Search s, def selectedIds = null) {
582                switch(s.entity) {
583                        case "Study":
584                                def exportParams = [:]
585                                s.filterResults(selectedIds).each {
586                                        exportParams[ it.code ] = it.id;
587                                }
588                                return [[
589                                                module: "gscf",
590                                                name:"simpletox",
591                                                description: "Export as SimpleTox",
592                                                url: createLink( controller: "exporter", action: "export", params: exportParams )
593                                        ]]
594                        case "Sample":
595                                return []
596                        default:
597                                return [];
598                }
599        }
600
601        /**
602         * Determine a list of actions that can be performed on specific entities by other modules
603         * @param entity        Name of the entity that the actions could be performed on
604         */
605        protected List moduleActions(Search s, def selectedIds = null) {
606                def actions = []
607
608                if( !s.getResults() || s.getResults().size() == 0 )
609                        return []
610
611                // Loop through all modules and check which actions can be performed on the
612                AssayModule.list().each { module ->
613                        // Remove 'module' from module name
614                        def moduleName = module.name.replace( 'module', '' ).trim()
615                        try {
616                                def callUrl = module.url + "/rest/getPossibleActions?entity=" + s.entity
617                                def json = moduleCommunicationService.callModuleRestMethodJSON( module.url, callUrl );
618
619                                // Check whether the entity is present in the return value
620                                if( json[ s.entity ] ) {
621                                        json[ s.entity ].each { action ->
622                                                def url = action.url ?: module.url + "/action/" + action.name
623                                               
624                                                if( url.find( /\?/ ) )
625                                                        url += "&"
626                                                else
627                                                        url += "?"
628                                               
629                                                url += "entity=" + s.entity
630                                                url += "&" + s.filterResults(selectedIds).collect { "tokens=" + it.giveUUID() }.join( "&" )
631                                                actions << [
632                                                                        module: moduleName,
633                                                                        name: action.name,
634                                                                        description: action.description + " (" + moduleName + ")",
635                                                                        url: url
636                                                                ];
637                                        }
638                                }
639                        } catch( Exception e ) {
640                                // Exception is thrown when the call to the module fails. No problems though.
641                                log.error "Error while fetching possible actions from " + module.name + ": " + e.getMessage()
642                        }
643                }
644
645                return actions;
646        }
647
648}
Note: See TracBrowser for help on using the repository browser.