source: MILK/trunk/milk_server/milk_server/controllers/discovery.py @ 4476

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

Remove the viewItems controller - for visualising WCS/WMS data - and remove associated code.

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