Changeset 2655

Timestamp:

27/06/07 22:18:24 (12 years ago)

Author:

lawrence

Message:

Limited support for discovery and DIF viewing in the ows stack.

Location:

TI05-delivery/ows_framework/trunk/ows_server/ows_server

Files:

• config/ndgDiscovery.config (modified) (4 diffs)
• controllers/discovery.py (modified) (1 diff)
• controllers/retrieve.py (modified) (3 diffs)
• lib/ndg/DiscoveryTemplate.py (modified) (2 diffs)
• models/ndgObject.py (modified) (1 diff)
• models/ndgObject.py~ (deleted)
• models/ndgRetrieve.py (modified) (4 diffs)
• templates/dif.kid (modified) (1 diff)
• templates/ndgPage.kid (modified) (1 diff)
• templates/stubB.kid (modified) (1 diff)

TI05-delivery/ows_framework/trunk/ows_server/ows_server/config/ndgDiscovery.config

@@ -28 +28 @@
 mailserver:       outbox.rl.ac.uk
 metadataMaintainer: b.n.lawrence@rl.ac.uk
-repository:       glue.badc.rl.ac.uk
+repository:       http://localhost:8080
 
 
 [SEARCH]
-advancedURL:        %(ndgServer)s/discovery?advanced=1
+advancedURL:        %(ndgServer)s/discovery
 discoveryURL:       %(ndgServer)s/discovery
 helpURL:            %(ndgServer)s/discovery?help=1
@@ -74 +74 @@
 #where repository is the NDG identifier ....
 #
-neodc.nerc.ac.uk: glue.badc.rl.ac.uk
-badc.nerc.ac.uk: glue.badc.rl.ac.uk
+neodc.nerc.ac.uk: %(server)s
+badc.nerc.ac.uk: %(server)s
 npm.ac.uk: wwwdev.npm.ac.uk/rsdas/projects/ndg
 #grid.bodc.nerc.ac.uk: glue.badc.rl.ac.uk
@@ -84 +84 @@
 icon_title: Links to a METADATA BROWSE view of this dataset
 service_name: B
-instance: http://SERVICEHOST/view/URI
+instance: SERVICEHOST/view/URI
 
 [NDG_EXIST]
@@ -113 +113 @@
 icon_alt: Catalogue
 service_name: Catalogue
-default: %(server)s/retrieve?repository=ndg
+default: %(server)s
 formatDefault=DIF
 icon_title: Links to the DISCOVERY RECORD for this dataset

TI05-delivery/ows_framework/trunk/ows_server/ows_server/controllers/discovery.py

@@ -1 +1 @@
 from ows_server.lib.base import *
+from paste.request import parse_querystring
+from ows_server.lib.Date import *
+from ows_server.templates import DiscoveryTemplate
+from ows_server.models import ndgSearch as NS
+from ows_server.models.DIF import DIF
+from ows_server.templates.renderDiscoverySet import renderDiscoverySet
+from ows_server.models.DiscoveryState import DiscoveryState
+from ows_server.models.ndgObject import ndgObject
+from ows_server.models.Utilities import myConfig
+from ows_server.lib.mailer import mailHandler
+
+# Note that this code has not been ported to kid yet, it's pretty much the old
+# code ported into this environment ...
 
 class DiscoveryController(BaseController):
     ''' Provides the pylons controller for NDG discovery '''
+    
+    def __setup(self):
+        ''' Common setup for controller methods '''
+        self.cf=request.environ['ndgConfig']
+        self.inputs=dict(parse_querystring(request.environ))
+        self.message=''
+    
     def index(self):
+        
+        self.__setup()
         # parse the query string and hand off to a discovery engine
-        c.query=''
-        c.hits=''
-        c.time=''
-        c.scope=''
-        c.start=''
-        c.end=''
-        c.stride''
-        c.links=[]
+        if self.inputs=={}: return self.__advancedPrompt()
+        
+        #the following need to be defined
+        continuations={'start':1,'howmany':10}
+        for i in continuations:
+            if i not in self.inputs: self.inputs[i]=continuations[i]
+            
+            
+        # the simplest query we might get is a text search, in which case
+        # the inputs should be start, howmany and searchString (although
+        # maybe not in that order. The next simplest is one with
+        # a specified textTarget, after that we need all the inputs.
+        
+        if len(self.inputs)==3 and 'searchString' in self.inputs:
+            # it's a simple text search
+            self.inputs['textTarget']='All'
+            
+        # the next simplest is one that includes texttarget as well ...
+        expected=['searchString','textTarget','start','howmany']
+        self.__checkform(expected)
+    
+        if self.message!='':
+            c.xml=self.message 
+            return render_response('content')
+        
+        if len(self.inputs)==4:
+            response=self.doText(self.inputs['searchString'],self.inputs['textTarget'],
+                        self.inputs['start'],self.inputs['howmany'])
+        else:
+            #check advanced search options
+            expected=['startDateDay','startDateMon','startDateYear',
+                            'endDateDay','endDateMon','endDateYear',
+                            'bboxN','bboxE','bboxS','bboxW','searchString','textTarget'] 
+            self.__checkform(expected)
+            if self.message!='': 
+                c.xml=self.message
+                return render_response('content')
+            
+            # ------------- Handle scope from radio button on form -------
+            if 'source' in self.inputs:
+                # the WSDL expects a list, we're just providing one ... via a radio ...
+                scope=[self.inputs['source']]
+                if scope==['All']: scope=None
+            else:
+                scope=None
+            
+            # ------------- Handle Location Bounding --------
+            # default form has a global bounding box
+            bbox=[self.inputs['bboxN'],self.inputs['bboxS'],self.inputs['bboxW'],self.inputs['bboxE']]
+            self.__checkbox(bbox)
+            if self.message!='': 
+                c.xml=self.message
+                return render_response('content')
+
+            # ------------- Handle Date Ranges ---------------
+            try:
+                dateRange=[(self.inputs['startDateDay'],iMonth(self.inputs['startDateMon']),self.inputs['startDateYear']),
+                           (self.inputs['endDateDay'],iMonth(self.inputs['endDateMon']),self.inputs['endDateYear'])]
+                #default form has blanks, in which case we don't want to check for date range
+                if dateRange<>[("","",""),("","","")]:
+                   self.__checkdates(dateRange)
+                else: dateRange=None           
+            except:
+                self.message='Invalid date provided'
+            if self.message!='': 
+                c.xml=self.message
+                return render_response('content')
+                        
+            # ------------- ok, now go do the search -----------
+            response=self.doText(self.inputs['searchString'],self.inputs['textTarget'],
+                 self.inputs['start'],self.inputs['howmany'],scope=scope,dateRange=dateRange,bbox=bbox)
+           
+        return response
+
+    def doText(self,searchString,textTarget,start,howmany,scope=None,dateRange=None,bbox=None):
+        
+        ''' Carry out a text search for <searchString> 
+        in the <textTarget> where the accepted text target values are controlled
+        by the DiscoveryTemplate GUI, and are: All, Authors, Parameters '''
+        
+        start,howmany=int(start),int(howmany)  # url arguments need conversion ...
+        
+        ws=NS.ndgSearch(logger=logger)
+        documents=ws.search(searchString,start=start,howmany=howmany,target=textTarget,
+                            scope=scope,dateRange=dateRange,bbox=bbox)
+        if ws.error !=None:
+            m=''
+            for i in ws.error:m+='<p>%s</p>'%i
+            c.xml=m
+            return render_response('content')
+        
+        #build constraints info for report
+        constraints=self.__buildconstraints(dateRange,bbox,scope)
+        
+        hits=ws.hits
+        id=ws.serverSessionID
+        
+        if hits<howmany:howmany=hits
+        state=DiscoveryState(id,searchString,request.environ,hits,constraints,start,howmany)
+        
+        if hits==0: 
+            c.xml='<p>No records found [%s]</p>>'%state.constraints
+            return render_response('content')
        
-        c.repository=''
-        c.title=''
-        c.summary=''
-        c.morelink=''
-        c.spatial=[,,,]
-        c.temporal=[,]
-        
-        return Response('not yet implemented')
+        try:
+            results=ws.getLabelledDocs(format='DIF')
+            difs=[]
+            errors=[]
+            for result in results: 
+                obj=ndgObject(result[0])
+                obj.setConfig(self.cf)
+                try:
+                    difs.append(DIF(result[1],ndgObj=obj))
+                except ValueError,e:
+                    errors.append((result[0],str(e)))
+            if results==[]:
+                c.xml='<p> No results for "%s"!</p>'%searchString
+                return render_response('content')
+            elif difs==[]:
+                c.xml='<p>No usable results for "%s"!</p>'%searchString
+                return render_response('content')
+            else:
+                if errors<>[]:
+                    c.xml='<p>Search results for "%s"'%searchString
+                    dp=[]
+                    for e in errors:
+                        n=ndgObject(e[0])
+                        if n.repository not in dp: dp.append(n.repository)
+                    if len(dp)<>1: 
+                        dp='[Various Data Providers]'
+                    else:
+                        dp='[%s]'%dp[0] 
+                    c.xml+=' (unfortunately %s hits matched unformattable documents from %s, an internal error has been logged):</p>'%(len(errors),dp)
+                    status,message=mailHandler(['b.n.lawrence@rl.ac.uk'],'DIF errors',str(errors),
+                                    server=self.cf.get('DEFAULT',mailsever))
+                    if not status:
+                        c.xml+='<p> Actually, not even an internal error has been logged. <br/>'
+                        c.xml+='Internal sending of mail failed with error [%s]</p>'%message
+                    return render_response('content')
+                c.xml='<div>%s%s</div>'%(self.oneLineSearch(),renderDiscoverySet(difs,state,self.cf))
+                print self.oneLineSearch()
+                f=file('debug-dif.xml','w')
+                f.write(c.xml)
+                f.close()
+                return render_response('content')
+        except ValueError,e:
+            if debug: 
+                raise ValueError,str(e)
+            else:
+                c.xml='<p> Error retrieving documents for %s hits is [%s]</p>'%(hits,e)
+                return render_response('content')
+                               
+        return
+    def __advancedPrompt(self):
+        ''' This provides the advanced search input page '''
+        try:
+            discoveryURL=self.cf.get('SEARCH','discoveryURL')
+            advancedURL=self.cf.get('SEARCH','advancedURL')
+            oneLiner=DiscoveryTemplate.oneLiner
+        except:
+            return 'Error, invalid configuration for search interface'
+        bboxN,bboxW,bboxE,bboxS='+90.0','-180.0','+180.0','-90.0'
+        startDateDay,startDateMon,startDateYear='','',''
+        endDateDay,endDateMon,endDateYear='','',''
+        c.xml=DiscoveryTemplate.revisedAdvancedSearch%locals()
+        return render_response('content')
+        
+    def __checkbox(self,bbox):
+        if float(bbox[0])>90.0 or float(bbox[1])<-90. or float(bbox[2])<-180. or float(bbox[3])>180.:
+            self.message='Invalid bounding box dimensions entered (limits 90,-90,-180,180)'
+            
+    def __checkform(self,expected):
+        ''' Simply checks the inputs to make sure the elements in expected are present '''
+        message="An incomplete NDG search form was received: "
+        for i in expected:
+            if i not in self.inputs: 
+                self.message=message+i
+                self.html='<p>%s</p>'%self.message
+                
+    def __checkdates(self,dateRange):
+        ''' Check input dates for sanity '''
+        if not ValidDate(dateRange[0])*ValidDate(dateRange[1]):
+            self.message='Input dates are not valid'
+        elif JulDay(dateRange[0])>=JulDay(dateRange[1]):
+            self.message='Second date must be after first date'
+        
+    def __buildconstraints(self,dateRange,bbox,scope):
+        ''' Just build a constraint string '''
+        constraints=' ('
+        if dateRange is not None: 
+            constraints+='Including&nbsp;%s&nbsp;to&nbsp;%s; '%('%s,%s,%s'%dateRange[0],'%s,%s,%s'%dateRange[1])
+        if bbox is None or bbox==['+90.0','-90.0','-180.0','+180.0']:
+            constraints+='Global; '
+        else: constraints+='Bounding&nbsp;Box:&nbsp;%s,%s,%s,%s; '%tuple(bbox)
+        if scope is not None:
+            constraints+='Restricted to %s; '%scope[0]
+        constraints=constraints[:-2]+')'
+        logger.info(constraints)
+        return constraints
+        
+    def oneLineSearch(self):
+        try:
+            discoveryURL=self.cf.get('SEARCH','discoveryURL')
+            oneLiner=DiscoveryTemplate.oneLiner
+        except:
+            return 'Error, invalid configuration for search interface'
+        return DiscoveryTemplate.searchTextOneLine%locals()  

TI05-delivery/ows_framework/trunk/ows_server/ows_server/controllers/retrieve.py

@@ -3 +3 @@
 from ows_server.models import ndgObject,  ndgRetrieve, Utilities
 from paste.request import parse_querystring
-from ows_server.models import stubB 
+from ows_server.models import stubB,DIF
 from ows_server.lib import mailer
 
@@ -74 +74 @@
             elif self.uri.schema=='DIF':
                 r='dif'
+                c.doc=DIF.DIF(x.tree,et=1)
+                name=c.doc.name
+                print c.doc.parameters
             elif self.uri.schema=='NumSim':
                 r='numsim'
@@ -97 +100 @@
             r='content'
             
-        if 'ndgSec' in session:
+        if status and 'ndgSec' in session:
             #we can update the history
             if 'history' not in session:

TI05-delivery/ows_framework/trunk/ows_server/ows_server/lib/ndg/DiscoveryTemplate.py

@@ -149 +149 @@
 </div>'''
 
-oneLiner='''<input type="text" size="60" name="searchString"/><input type="hidden" value="0" name="advanced"/>
+oneLiner='''<input type="text" size="60" name="searchString"/>
             (Target:&nbsp;<select name="textTarget">
             <option value="Authors">Authors</option>
@@ -213 +213 @@
                 <tr><td align="center"><input type="submit"/></td></tr>
             </tbody></table>
-            <input type="hidden" value="1" name="advanced"/>
          </form>
     </div>'''

TI05-delivery/ows_framework/trunk/ows_server/ows_server/models/ndgObject.py

@@ -58 +58 @@
             # This NDG object may itself be a discovery record, which makes life easy, but
             # it might not be, in which case we have to build up all the possible views upon it.
-            discoveryBASE='%s&uri=%s__%s__%s'%(
+            discoveryBASE='%s/view/%s__%s__%s'%(
                 self.config.get('DISCOVERY','default'),self.repository,self.schema,self.localID)
             fmt=self.config.get('DISCOVERY','formatDefault','DIF')
             # We'll build the following even if it can't be used (as would be the case for
             # a non data entity B record or an A record) because it's a useful template.
-            self.discoveryURL=discoveryBASE+'&format=%s&type=html'%fmt
+            self.discoveryURL=discoveryBASE
             # If this record is itself a discovery record, then we don't have much more to do
             if self.schema in ['DIF','DC','MDIP','ISO19139']:
-                self.xmlURL=self.discoveryURL.replace('html','xml')
-                self.printableURL=self.discoveryURL.replace('html','print')
+                self.xmlURL=self.discoveryURL+'&format=raw'
+                self.printableURL=self.discoveryURL+'&format=xml'
                 self.gettable=1
                 self.URL=self.discoveryURL

TI05-delivery/ows_framework/trunk/ows_server/ows_server/models/ndgRetrieve.py

@@ -4 +4 @@
 from ndgSecurity import HandleSecurity
 
-debug=1
+debug=0
 def ndgRetrieve(uri,config,logger=0,requestor='test',format='',securityTokens=None):
     
@@ -55 +55 @@
                 f=str('ows_server/examples/%s.xml'%uri.uri)
                 r=file(f,'r').read()
-            else:
-                r=ws.get(uri.repository,uri.schema,uri.localID,format=format,targetCollection=target)
+        else:
+            r=ws.get(uri.repository,uri.schema,uri.localID,format=format,targetCollection=target)
         time2=time.time()-time1
         logString='Document retrieve [%s] for [%s] took [%ss]'%(uri,requestor,time2)
@@ -123 +123 @@
         self.setup()
         doc='badc.nerc.ac.uk__NDG-B0__activity_activity_cwvc'
+        doc='neodc.nerc.ac.uk__NDG-B1__NEODC_NCAVEO_LCM2000'
         uri=ndgObject.ndgObject(doc)
         status,xml=ndgRetrieve(uri,self.c)
@@ -165 +166 @@
         self.assertEqual(status,0)
         
+        
 if __name__=="__main__":
+
     unittest.main()

TI05-delivery/ows_framework/trunk/ows_server/ows_server/templates/dif.kid

@@ -12 +12 @@
         ?> 
         <div id="${id}">
-            <p>DIF viewing not fully implemented</p><hr/>
+            <div class="metadata">
+                <div class="headingblock">
+                    <div id="title" class="heading">$c.doc.name</div>
+                    <div id="abstract">$c.doc.abstract</div>
+                </div>
+                <div py:replace="ParameterList(c.doc.parameters)"/> 
+            </div>
         </div>
+        <center>
+            <p>Not all information in this record may be rendered in this view. Please see the XML version for complete
+                content </p>
+        </center>
         <div py:replace="footer()"/>
     </div>

TI05-delivery/ows_framework/trunk/ows_server/ows_server/templates/ndgPage.kid

@@ -61 +61 @@
     </div>
     
+    <!-- Parameter list class, used in StubB and DIF -->
+    
+    <div py:def="ParameterList(params)" class="ParameterList">
+        <table cellspacing="0" cellpadding="3" border="0" width="100%"><tbody>
+            <tr><td class="linehead"><span class="heading0"> Parameters</span></td></tr>
+            <span py:for="item in params">
+                <tr><td class="rowhead">$item</td></tr>
+                <?python
+                #need to make sure keyword with spaces are not split inappropriately
+                keywords=[]
+                for word in params[item]:
+                    keywords.append(word.replace(' ','&nbsp;'))
+                keywords='; '.join(keywords)
+                ?>
+                <tr py:if="params[item]!=[]"><td>$keywords</td></tr>
+            </span>
+        </tbody></table>
+    </div>
+    
+    
     <!-- Page Footer follows -->
 

TI05-delivery/ows_framework/trunk/ows_server/ows_server/templates/stubB.kid

@@ -32 +32 @@
                 </div>
                 
-                <div class="ParameterList">
-                    <table cellspacing="0" cellpadding="3" border="0" width="100%"><tbody>
-                        <tr><td class="linehead"><span class="heading0"> Parameters</span></td></tr>
-                        <span py:for="item in c.doc.parameters">
-                            <tr><td class="rowhead">$item</td></tr>
-                            <?python
-                            #need to make sure keyword with spaces are not split inappropriately
-                            keywords=[]
-                            for word in c.doc.parameters[item]:
-                                keywords.append(word.replace(' ','&nbsp;'))
-                            keywords='; '.join(keywords)
-                            ?>
-                            <tr py:if="c.doc.parameters[item]!=[]"><td>$keywords</td></tr>
-                        </span>
-                    </tbody></table>
-                </div>
+                <div py:replace="ParameterList(c.doc.parameters)"/>
                 
                 <div py:if="c.doc.granules!=[]" id="Granules">