source: MILK/trunk/milk_server/milk_server/controllers/browse/discovery.py @ 4979

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/MILK/trunk/milk_server/milk_server/controllers/browse/discovery.py@4979
Revision 4979, 17.4 KB checked in by cbyrom, 11 years ago (diff)

Update discovery client to cope with atom docs properly - interpreting
their ids correctly to create the necessary browse URL.

Line 
1'''
2Controller for the discovery search functionality
3'''
4import socket, logging
5from paste.request import parse_querystring
6from ndg.common.src.clients.ws.discoveryserviceclient import DiscoveryServiceClient
7from ndg.common.src.clients.xmldb.eXist.searchclient import SearchClient
8from ndg.common.src.dal.DocumentRetrieve import ndgVocabPOX as VS
9from ndg.common.src.models.ndgObject import ndgObject
10from ndg.common.src.models.DIF import DIF
11from milk_server.lib.base import *
12from milk_server.lib.Date import *
13from milk_server.models.DiscoveryState import DiscoveryState,constraints
14from milk_server.lib.mailer import mailHandler
15
16logging.basicConfig(level=logging.DEBUG,
17   format='%(asctime)s %(filename)s:%(lineno)d %(levelname)s %(message)s')
18
19debug=0
20
21class DiscoveryController(BaseController):
22    ''' Provides the pylons controller for NDG discovery '''
23   
24    def __setup(self):
25        ''' Common setup for controller methods '''
26        self.cf=request.environ['ndgConfig']
27        self.exist=(self.cf.get('NDG_EXIST','local'),\
28                    g.pwFile)
29        self.inputs=dict(parse_querystring(request.environ))
30        self.message=''
31               
32   
33    def index(self):
34       
35        self.__setup()
36        # parse the query string and hand off to a discovery engine
37       
38        if self.inputs=={} or 'ClearForm' in self.inputs: 
39            return self.__advancedPrompt()
40       
41        # see if this is a discovery search or a more complicated search
42        if 'searchTarget' not in self.inputs: 
43            self.inputs['searchTarget']='Discovery'
44       
45        #the following need to be defined
46        continuations={'start':1,'howmany':10}
47        for i in continuations:
48            if i not in self.inputs: self.inputs[i]=continuations[i]
49           
50           
51        # the simplest query we might get is a text search, in which case
52        # the inputs should be start, howmany and searchString (although
53        # maybe not in that order. The next simplest is one with
54        # a specified textTarget, after that we need all the inputs.
55       
56        if 'searchString' in self.inputs and 'textTarget' not in self.inputs:
57            # it's a simple text search
58            self.inputs['textTarget']='All'
59           
60        # the next simplest is one that includes texttarget as well ...
61        expected=['searchString','textTarget','start','howmany','searchTarget']
62        self.__checkform(expected)
63   
64        if self.message!='':
65            c.xml='Simple %s:'%self.message
66            return render('content')
67       
68       
69        if 'geoSearchType' not in self.inputs:self.inputs['geoSearchType']='overlaps'
70        if len(self.inputs)==6:
71           
72            # now we add the defaults ...
73            # this is kind of historical ...
74            bbox=None
75            dateRange=None
76            scope=None
77           
78        else:
79       
80            # ------------- Handle scope from radio button on form -------
81            if 'source' in self.inputs:
82                # the WSDL expects a list, we're just providing one ... via a radio ...
83                scope=[self.inputs['source']]
84                if scope==['All']: scope=None
85            else:
86                scope=None
87               
88            expected=['bboxN','bboxE','bboxS','bboxW','geoSearchType']
89            self.__checkform(expected)
90            if self.message!='': 
91                self.message=''
92                bbox=None
93            else:
94                # default form has a global bounding box, NB, internal to this routine we use bbox=[N,W,E,S], not [W,S,E,N]!
95                bbox=[self.inputs['bboxN'],self.inputs['bboxW'],self.inputs['bboxE'],self.inputs['bboxS']]
96               
97                self.__checkbox(bbox)
98                if self.message!='': 
99                    c.xml=self.message
100                    return render('content')
101                   
102           
103            expected=['startDateDay','startDateMon','startDateYear',
104                            'endDateDay','endDateMon','endDateYear']
105            self.__checkform(expected)
106            if self.message!='': 
107                self.message=''
108                dateRange=None
109            else:
110                try:
111                    dateRange=[(self.inputs['startDateDay'],self.inputs['startDateMon'],self.inputs['startDateYear']),
112                                (self.inputs['endDateDay'],self.inputs['endDateMon'],self.inputs['endDateYear'])]
113                    #default form has blanks, in which case we don't want to check for date range
114                    if dateRange<>[("","",""),("","","")]:
115                        self.__checkdates(dateRange)
116                    else: dateRange=None           
117                except:
118                    self.message='Invalid date provided'
119                if self.message!='': 
120                    c.xml=self.message
121                    return render('content')
122       
123        if 'constrained' in self.inputs: 
124            con=self.__buildconstraints(dateRange,bbox,scope,self.inputs['searchString'],self.inputs['geoSearchType'])
125            return self.__advancedPrompt(searchConstraints=con)
126        else:
127            # ------------- ok, now go do the search -----------
128            response=self.doText(self.inputs['searchString'],self.inputs['textTarget'],
129                self.inputs['start'],self.inputs['howmany'],scope=scope,dateRange=dateRange,bbox=bbox,
130                geoSearch=self.inputs['geoSearchType'])
131            return response
132
133
134    def doText(self,searchString,textTarget,start, \
135               howmany,scope=None,dateRange=None,bbox=None,geoSearch='overlaps'):
136       
137        ''' Carry out a text search for <searchString>
138        in the <textTarget> where the accepted text target values are controlled
139        by the DiscoveryTemplate GUI, and are: All, Authors, Parameters '''
140        logging.info("'doText' invoke with string, '%s'" %searchString)
141        start,howmany=int(start),int(howmany)  # url arguments need conversion ...
142       
143        if self.inputs['searchTarget']=='Discovery':
144            logging.info(" - use Discovery service to complete search")
145            url = None
146            if hasattr(g, 'discoveryServiceURL'):
147                url = g.discoveryServiceURL
148            ws = DiscoveryServiceClient(HostAndPort=url)
149        elif self.inputs['searchTarget'] in ['Browse','NumSim']:
150            logging.info(" - use Browse service to complete search")
151            ws = SearchClient(dbHostName = self.exist[0],
152                              configFileName = self.exist[1])
153            #overriding text target which is ignored currently ... yuck ...
154            textTarget=self.inputs['searchTarget']
155            if textTarget=='Browse':textTarget='ndg_B_metadata'
156        else:
157            logging.error("Unrecognised search type, '%s'" \
158                          %self.inputs['searchTarget'])
159            c.xml='Unknown searchTarget %s'%self.inputs['searchTarget']
160            return render('error')
161           
162        # PJK 04/09/08 Handle errors more gracefully
163        #
164        # http://proj.badc.rl.ac.uk/ndg/ticket/984
165        try:
166            documents=ws.search(searchString,
167                                start=start,
168                                howmany=howmany,
169                                target=textTarget,
170                                scope=scope,
171                                dateRange=dateRange,
172                                bbox=bbox,
173                                geoSearchType=geoSearch)
174        except socket.error, e:
175            logging.error("Socket error for discovery service search: %s" % e)
176            c.xml='The Discovery Service is unavailable.  Please check with '+\
177                    'your system administrator'
178            return render('error')
179        except Exception, e:
180            logging.error("Calling discovery service search: %s" % e)
181            c.xml='An internal error occured.  Please check with ' + \
182                    'your system administrator'
183            return render('error')
184           
185        logging.info("'doText()' returned - now processing results")
186        if ws.error !=None:
187            logging.error("Error encountered whilst running search: %s" %ws.error)
188            m=''
189            for i in ws.error:m+='<p>%s</p>'%i
190            c.xml=m
191            return render('content')
192       
193        #build constraints info for report
194        searchConstraints=self.__buildconstraints(dateRange,bbox,scope,\
195                                                  searchString,geoSearch)
196        hits=ws.hits
197        if hits==0:
198            outMessage = 'No records found [contraints: %s]' %searchConstraints
199            logging.info(outMessage) 
200            c.xml='<p>' + outMessage + '</p>'
201            return render('content')
202       
203        id=ws.serverSessionID
204       
205        if hits < howmany:
206            howmany = hits
207       
208        # DiscoveryState object is a wrapper to the various search config
209        # variables
210        c.state=DiscoveryState(id,searchString,request.environ,\
211                               hits,searchConstraints,start,howmany)
212        c.querystring=request.environ['QUERY_STRING']
213     
214        try:
215            if self.inputs['searchTarget']=='Discovery':
216                results=ws.getLabelledDocs(format='DIF')
217            else:
218                return self.moreSearch(ws)
219
220            if results==[]:
221                c.xml='<p> No results for "%s"!</p>'%searchString
222                return render('content')
223
224            difs=[]
225            errors=[]
226            for result in results: 
227                obj=ndgObject(result[0], config = self.cf)
228                try:
229                    difs.append(DIF(result[1],ndgObj=obj))
230                except ValueError,e:
231                    errors.append((result[0],str(e)))
232
233            if difs==[]:
234                c.xml='<p>No usable results for "%s"!</p>'%searchString
235                return render('content')
236            elif errors:
237                c.xml='<p>Search results for "%s"'%searchString
238                dp=[]
239                for e in errors:
240                    n=ndgObject(e[0])
241                    if n.repository not in dp: dp.append(n.repository)
242                if len(dp)<>1: 
243                    dp='[Various Data Providers]'
244                else:
245                    dp='[%s]'%dp[0] 
246                c.xml+=' (unfortunately %s hits matched unformattable documents from %s, an internal error has been logged):</p>'%(len(errors),dp)
247                status,message=mailHandler(['b.n.lawrence@rl.ac.uk'],'DIF errors',str(errors),
248                                server=self.cf.get('DEFAULT','mailserver'))
249                if not status:
250                    c.xml+='<p> Actually, not even an internal error has been logged. <br/>'
251                    c.xml+='Internal sending of mail failed with error [%s]</p>'%message
252                return render('content')
253            else:
254                c.difs=difs
255                session['results']=h.current_url()
256                session.save()
257               
258                # set up the displayed tabs
259                if len(c.pageTabs)==1: 
260                    c.pageTabs.append(('Results',session['results']))
261                    c.pageTabs.append(('Selections',
262                                       h.url_for(controller='browse/selectedItems',
263                                                 action='index')))
264                elif c.pageTabs[1][0]!='Results':
265                        c.pageTabs.insert(1,('Results',session['results']))
266                        selectionsNeeded=1
267                        for tab in c.pageTabs[0]:
268                            if tab == 'Selections':
269                                selectionsNeeded=0
270                        if selectionsNeeded:
271                            c.pageTabs.append(('Selections',
272                                       h.url_for(controller='browse/selectedItems',
273                                                 action='index')))
274                           
275                return render('browse/results')
276               
277        except ValueError,e:
278            if debug: 
279                raise ValueError,str(e)
280            else:
281                c.xml='<p> Error retrieving documents for %s hits is [%s]</p>'%(hits,e)
282                return render('content')
283        except Exception,e:
284                c.xml='Unknown error %s,%s'%(str(Exception),e)
285                return render('error')                       
286       
287    def __advancedPrompt(self,searchConstraints=None):
288        ''' This provides the advanced search input page '''
289        try:
290            discoveryURL=self.cf.get('SEARCH','discoveryURL')
291            advancedURL=self.cf.get('SEARCH','advancedURL')
292        except:
293            return 'Error, invalid configuration for search interface'
294        #defaults
295        c.bbox='90.0','-180.0','180.0','-90.0'
296        c.startDateDay,c.startDateMon,c.startDateYear='','',''
297        c.endDateDay,c.endDateMon,c.endDateYear='','',''
298        c.textTarget='All'
299        c.searchString=''
300        c.source=['All']
301        c.geoSearchType='overlaps'
302        #constraints
303
304        if searchConstraints is not None:
305            if searchConstraints['dateRange'] is not None:
306                c.startDateDay,c.startDateMon,c.startDateYear=searchConstraints['dateRange'][0]
307                c.endDateDay,c.endDateMon,c.endDateYear=searchConstraints['dateRange'][1]
308            if searchConstraints['bbox'] is not None:
309                c.bbox=searchConstraints['bbox']
310            if searchConstraints['textTarget'] is not None:
311                c.textTarget=searchConstraints['textTarget']
312            if searchConstraints['searchString'] is not None:
313                c.searchString=searchConstraints['searchString']
314            if searchConstraints['scope'] is not None:
315                c.source=searchConstraints['scope']
316            c.geoSearchType=(searchConstraints['geoSearchType'] or 'overlaps')
317        return render('browse/advanced')
318       
319    def __checkbox(self,bbox):
320        m='Invalid bounding box dimensions entered - limits are '
321        if float(bbox[0])>90.0 or float(bbox[3])<-90.:
322            self.message=m+'+90 (N), -90 (S)!'
323        if float(bbox[1])<-180. or float(bbox[2])>180.:
324            if self.message=='':self.message=m
325            self.message=self.message[:-1]+' -180 (W), 180 (E)!'
326           
327    def __checkform(self,expected):
328        ''' Simply checks the inputs to make sure the elements in expected are present '''
329        message="An incomplete NDG search form was received: "
330        for i in expected:
331            if i not in self.inputs: 
332                self.message=message+i
333        if self.message!='':self.message+='[%s]'%self.inputs
334               
335    def __checkdates(self,dateRange):
336        ''' Check input dates for sanity '''
337       
338        if not ValidDate(dateRange[0])*ValidDate(dateRange[1]):
339            self.message='Input dates are not valid [%s]'%dateRange
340        elif JulDay(dateRange[0])>=JulDay(dateRange[1]):
341            self.message='Second date must be after first date'
342       
343    def __buildconstraints(self,dateRange,bbox,scope,searchString,geoSearch):
344        ''' Just build a constraint string '''
345        return constraints(dateRange=dateRange,bbox=bbox,scope=scope,searchString=searchString,geoSearchType=geoSearch)
346       
347
348    def semantic(self):
349        self.__setup()
350        vs=VS(proxyServer=self.cf.get('DEFAULT','proxyServer'))
351        if 'searchString' in self.inputs:
352            try:
353                [broader,narrower,synonyms]=vs.getRelated(self.inputs['searchString'])
354                #get a base string for the links to new searches
355                if 'start' in self.inputs: del self.inputs['start']
356                if 'howmany' in self.inputs: del self.inputs['howmany']
357                self.inputs['searchString']='###SEARCHSSTRING###'
358                q='%s/discovery?'%g.server
359                for i in self.inputs: q+='%s=%s&'%(i,self.inputs[i])
360                url=q[0:-1]
361                # and now build the links
362                c.narrower=[]
363                c.broader=[]
364                c.synonyms=[]
365                for i in narrower:
366                    c.narrower.append((i,url.replace('###SEARCHSSTRING###',i)))
367                for i in broader:
368                    c.broader.append((i,url.replace('###SEARCHSSTRING###',i)))
369                for i in synonyms:
370                    c.synonyms.append((i,url.replace('###SEARCHSSTRING###',i)))
371                if c.narrower!=[] or c.broader!=[] or c.synonyms!=[]: c.semAvailable=1
372            except IOError,e:
373                c.semAvailable=0
374                c.semError=' (No valid reply from vocabulary service)'
375                #This should go in a log file ...
376                print 'ERROR: Vocabulary Service: %s (for search [%s])'%(str(e),self.inputs['searchString'])
377        else:
378            broader,narrower,synonyms=[],[],[]
379            c.semAvailable=0
380            c.semError='.'
381       
382        return render('browse/semantic',fragment=True)
383   
384    def moreSearch(self,ws):
385        ''' Provides the search on Browse and NumSim content '''
386        c.results=ws.results
387        c.searchTarget=self.inputs['searchTarget']
388        for r in c.results:
389            id = r.id
390                # cope with atom docs
391            if id.startswith('tag'):
392                id = id.split('/')[-1]
393            n=ndgObject(id,config=self.cf)
394            r.link={'Browse':n.BURL,'NumSim':n.URL}[c.searchTarget]
395       
396        return render('browse/short_results')
397           
398    def clearSession(self):
399        ''' Clear out all session variables - to help when these change in development '''
400        session.clear()
401        session.save()           
402     
Note: See TracBrowser for help on using the repository browser.