summaryrefslogtreecommitdiffstats
path: root/idrop-web/grails-app/controllers/org/irods/mydrop/controller/MetadataSearchController.groovy
blob: 68a20fb0d87a062345e47a59bbd6699ced3e7f9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
package org.irods.mydrop.controller

import org.apache.commons.collections.FactoryUtils
import org.apache.commons.collections.ListUtils
import org.irods.jargon.core.connection.IRODSAccount
import org.irods.jargon.core.pub.CollectionAO
import org.irods.jargon.core.pub.CollectionAndDataObjectListAndSearchAO;
import org.irods.jargon.core.pub.IRODSAccessObjectFactory
import org.irods.jargon.core.query.AVUQueryElement
import org.irods.jargon.core.query.AVUQueryOperatorEnum
import org.irods.jargon.core.query.CollectionAndDataObjectListingEntry;
import org.irods.jargon.core.query.MetaDataAndDomainData
import org.irods.jargon.core.query.AVUQueryElement.AVUQueryPart
import org.irods.jargon.core.pub.DataObjectAO;



import java.util.ArrayList;

class MetadataSearchController {

    IRODSAccessObjectFactory irodsAccessObjectFactory
    IRODSAccount irodsAccount

    /**
     * Interceptor grabs IRODSAccount from the SecurityContextHolder
     */
    def beforeInterceptor = [action:this.&auth]

    def auth() {
        if(!session["SPRING_SECURITY_CONTEXT"]) {
            redirect(controller:"login", action:"login")
            return false
        }
        irodsAccount = session["SPRING_SECURITY_CONTEXT"]
    }


    def afterInterceptor = {
        log.debug("closing the session")
        irodsAccessObjectFactory.closeSession()
    }
	
    def index = {
		
    }

    /**
     * Search iRODS metadata
     * Here the data from inputs is posted. 
     */
    def search (MetadataSearchCommand metadataSearchCommand) {

        CollectionAndDataObjectListAndSearchAO collectionAndDataObjectListAndSearchAO = irodsAccessObjectFactory.getCollectionAndDataObjectListAndSearchAO(irodsAccount)
        DataObjectAO dataObjAO = irodsAccessObjectFactory.getDataObjectAO(irodsAccount) //dataObjects
        CollectionAO collectionAO = irodsAccessObjectFactory.getCollectionAO(irodsAccount) //folders
        
        List<CollectionAndDataObjectListingEntry> results = new ArrayList<CollectionAndDataObjectListingEntry>()
        List<MetaDataAndDomainData> queryResults = new ArrayList<MetaDataAndDomainData>()
        List<MetaDataAndDomainData> finalResults = new ArrayList<MetaDataAndDomainData>()
       
        int counter = -1
        
        for(AVUNode avuNode in metadataSearchCommand.AVUNodes) { //for every condition node do:
            if(avuNode.andOr == "Every") { //if every condition has to be fulfilled
                queryResults = connectedByAnd(avuNode, dataObjAO, collectionAO)           
            } else { //if at least one condition has to be fulfilled
                queryResults = connectedByOr(avuNode, dataObjAO, collectionAO)
            }
            if(counter >= 0) { //if there's more than one node, check operator between nodes
                log.info("OPERATOR:" + metadataSearchCommand.AVUOps[counter])
                if (metadataSearchCommand.AVUOps[counter] == "AND") {
                    finalResults = intersectLists(finalResults, queryResults)
                } else {
                    finalResults = sumOfLists(finalResults, queryResults)
                }
            } else {
                finalResults = sumOfLists(finalResults, queryResults)
            }
            counter++
        }
        
        
        
        for (MetaDataAndDomainData data : finalResults){
            results.add(collectionAndDataObjectListAndSearchAO.getCollectionAndDataObjectListingEntryAtGivenAbsolutePath(data.domainObjectUniqueName))
        }
    
       
        render(view:"/search/searchResult", model:[results:results])
    }
    //method used to finding files as well as folders matching every metadata query, final result is the sum of these results
    private def connectedByAnd(AVUNode avuNode, DataObjectAO dataObjAO, CollectionAO collectionAO) {
        List<MetaDataAndDomainData> queryRes1 = collectionAO.findMetadataValuesByMetadataQuery(createAVUQ(avuNode), true) //match folders names
        List<MetaDataAndDomainData> queryRes2 = dataObjAO.findMetadataValuesByMetadataQuery(createAVUQ(avuNode)) //match dataObj names 
        List<MetaDataAndDomainData> queryResults = ListUtils.sum(queryRes1, queryRes2) //connect lists  
        
        queryResults
    }
    
    //method used to finding files as well as folders matching AT LEAST ONE metadata query
    private def connectedByOr(AVUNode avuNode, DataObjectAO dataObjAO, CollectionAO collectionAO) {
        List<AVUQueryElement> metadataQuery = new ArrayList<AVUQueryElement>()
        List<MetaDataAndDomainData> finalResult = new ArrayList<MetaDataAndDomainData>()
        List<MetaDataAndDomainData> queryRes1 = new ArrayList<MetaDataAndDomainData>()
        List<MetaDataAndDomainData> queryRes2 = new ArrayList<MetaDataAndDomainData>()
        List<MetaDataAndDomainData> queryResults = new ArrayList<MetaDataAndDomainData>()
        
        for(AVUCommand avu in avuNode.AVUs) {
            metadataQuery.clear() 
            metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.ATTRIBUTE, AVUQueryOperatorEnum.EQUAL, avu.attribute));
            metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.VALUE, chooseOperator(avu.operator), avu.value));
            if(!avu.unit.empty){
                metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.UNITS, AVUQueryOperatorEnum.EQUAL, avu.unit));
            }
       
            queryRes1 = collectionAO.findMetadataValuesByMetadataQuery(metadataQuery, true)
            queryRes2 = dataObjAO.findMetadataValuesByMetadataQuery(metadataQuery)
            queryResults = ListUtils.sum(queryRes1, queryRes2)
       
            finalResult = sumOfLists(finalResult, queryResults)
        }
        
        finalResult  //return list without duplicates
                
    }
    
    def createAVUQ(AVUNode avuNode) { //create list of metadata queries 
        
        List<AVUQueryElement> metadataQuery = new ArrayList<AVUQueryElement>()
        
        for(AVUCommand avu in avuNode.AVUs){
            metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.ATTRIBUTE, AVUQueryOperatorEnum.EQUAL, avu.attribute));
            metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.VALUE, chooseOperator(avu.operator), avu.value));
            if(!avu.unit.empty){
                metadataQuery.add(AVUQueryElement.instanceForValueQuery(AVUQueryPart.UNITS, AVUQueryOperatorEnum.EQUAL, avu.unit));
            }
        }
            
        metadataQuery
    }	
 
    //create one list from two ones without duplicates
    private def sumOfLists(List<MetaDataAndDomainData> list1, List<MetaDataAndDomainData> list2) {
            
        boolean alreadyEx = false

        for(MetaDataAndDomainData elem1 in list1) {
            alreadyEx = false
            for(MetaDataAndDomainData elem2 in list2) {
                if(elem1.getDomainObjectUniqueName() == elem2.getDomainObjectUniqueName())
                alreadyEx = true
            }
            if(!alreadyEx) list2.add(elem1)
        }
        list2
    }
    
    
    //create list in which there are files  and collections occured in both input lists 
    private def intersectLists(List<MetaDataAndDomainData> list1, List<MetaDataAndDomainData> list2) {
        
        List<MetaDataAndDomainData> finalList = new ArrayList<MetaDataAndDomainData>()
        boolean ex = false

        for(MetaDataAndDomainData elem1 in list1) {
            ex = false
            for(MetaDataAndDomainData elem2 in list2) {
                if(elem1.getDomainObjectUniqueName() == elem2.getDomainObjectUniqueName())
                ex = true
            }
            if(ex) finalList.add(elem1)
        }
        finalList
    }

    
    
    def chooseOperator(String op) {
        switch(op){
        case "=":
            AVUQueryOperatorEnum.EQUAL;
            break
        case ">":
            AVUQueryOperatorEnum.GREATER_THAN;
            break
        case "<":
            AVUQueryOperatorEnum.LESS_THAN;
            break
        case ">=":
            AVUQueryOperatorEnum.GREATER_OR_EQUAL;
            break
        case "<=":
            AVUQueryOperatorEnum.LESS_OR_EQUAL;
            break
        case "<>":
            AVUQueryOperatorEnum.NOT_EQUAL;
            break
        case "like":
            AVUQueryOperatorEnum.LIKE;
            break
        case "not like":
            AVUQueryOperatorEnum.NOT_LIKE;
            break
        }
    }

}


//Class which constists of the list of condition nodes and list of operators connecting them
class MetadataSearchCommand { 
    List <AVUNode> AVUNodes = ListUtils.lazyList([], FactoryUtils.instantiateFactory(AVUNode))
    List <String> AVUOps = ListUtils.lazyList([], FactoryUtils.instantiateFactory(String))
    
}

//class consisted of AVU + operator
class AVUCommand {
    String attribute
    String operator //=, <, >, <=, >=, <>, like, not like
    String value
    String unit 

    static constraints = {
        attribute(blank:false)
        value(blank:false)
    }
    
}

//Class consisted of list of conditions and the option (in GUI radiobutton), decripted below
class AVUNode {
    List <AVUCommand> AVUs  = ListUtils.lazyList([], FactoryUtils.instantiateFactory(AVUCommand))
    String andOr //every condition fulfilled or at least one
}