source: TI05-delivery/ows_framework/trunk/ows_server/ows_server/controllers/csml_wcs1_0_0.py @ 3770

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/ows_framework/trunk/ows_server/ows_server/controllers/csml_wcs1_0_0.py@3770
Revision 3770, 16.2 KB checked in by domlowe, 12 years ago (diff)

fixing DescribeCoverage? response

Line 
1# Copyright (C) 2007 STFC & NERC (Science and Technology Facilities Council).
2# This software may be distributed under the terms of the
3# Q Public License, version 1.0 or later.
4# http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt
5"""
6WCS controller driven by CSML.
7
8@author: DominicLowe, Stephen Pascoe
9"""
10
11
12try: #python 2.5
13    from xml.etree import ElementTree as ET
14except ImportError:
15    try:
16        # if you've installed it yourself it comes this way
17        import ElementTree as ET
18    except ImportError:
19        # if you've egged it this is the way it comes
20        from elementtree import ElementTree as ET
21
22import os, time, string, StringIO
23
24from ows_server.lib.base import *
25from ows_server.lib.decorators import *
26import ows_server.lib.validators as V
27
28from ows_common import exceptions as OWS_E
29from ows_common.wcs import *
30from ows_common.common import BoundingBox
31from ows_common.domain import ValuesUnit, PossibleValues
32
33from ows_server.lib.csml_util import get_csml_doc, extractToNetCDF
34from ows_server.lib.ndgInterface import interface
35from ows_server.models.wcs_CoverageDescription import CoverageDescription
36import paste
37
38import logging
39logger = logging.getLogger('ows_server.controllers.csml_wcs_1_0')
40
41
42try:
43    #python 2.5
44    from email.mime.text import MIMEText
45    from email.mime.multipart import MIMEMultipart
46    from email.MIMEBase import MIMEBase
47    from email import encoders
48except:
49    #python 2.4
50    from email.MIMEText import MIMEText
51    from email.MIMEMultipart import MIMEMultipart
52    from email.MIMEBase import MIMEBase
53    from email import Encoders as encoders
54
55
56class CsmlWcs100Controller(OwsController):
57    _ows_parameters = {
58        'Format': make_domain(['text/xml']),
59        'ExceptionFormat': make_domain(['text/xml']),
60        }
61
62       
63    def _createMultipartMime(self, xml, netcdf):
64        #returns a multipart mime file containing the coverage xml + a netcdf file
65
66        # Create the container (outer) email message.
67        msg=MIMEMultipart()
68
69        xmlfile =StringIO.StringIO(xml)
70        xmlfile.readline(), xmlfile.readline() #don't read in first 2 lines (the content type) as MIMEBase also provides it.
71
72
73        #add the XML part
74        submsg=MIMEText(xmlfile.read(), _subtype='xml')
75        submsg.add_header('Content-ID', '<coverage.xml>')
76        submsg.add_header('Content-Disposition', 'attachment; filename="coverage.xml"')
77        #submsg.set_type('text/xml; name="coverage.xml"')
78        msg.attach(submsg)
79
80
81        #add the NetCDF part
82        submsg= MIMEBase('application', 'CF-netcdf') #check in ogc docs
83        submsg.set_payload(netcdf.read())
84        submsg.set_type('application/CF-netcdf')
85        submsg.add_header('Content-Disposition', 'attachment; filename="coverage.nc"')
86        submsg.add_header('Content-ID', '<coverage.nc>')
87        netcdf.close()
88        # Encode the payload using Base64
89        encoders.encode_base64(submsg)
90        msg.attach(submsg)
91
92        #return the message
93        return  msg
94
95
96    def _loadFeatureDimensions(self, feature):
97        dims = {}
98        lon=feature.getLongitudeAxis()
99        lat=feature.getLongitudeAxis()
100        domain=feature.getDomain()
101        for axis_name, axis in domain.iteritems():
102            if axis_name in [lon,lat]:
103                continue
104            dims[axis_name] =            Domain(possibleValues=PossibleValues.fromAllowedValues(axis),
105                                 #!TODO: this is a fudge until we can deduce UOM.
106                                 valuesUnit=ValuesUnit(uoms=[''],
107                                                       referenceSystems=['']))
108        return dims
109
110    def _loadFeatureSummary(self, feature):
111        dims = self._loadFeatureDimensions(feature)
112        #TODO - need to ensure proper values for Name. ID and Description are populated.
113        cvgTitle=[feature.description.CONTENT]
114        cvgDescription=feature.description.CONTENT
115        cvgAbstract=[feature.description.CONTENT]
116        csmlbbox=feature.getCSMLBoundingBox()
117        if csmlbbox is not None:
118            bbox=csmlbbox.getBox()                   
119            timeLimits=csmlbbox.getTimeLimits()
120        else:
121            csmlbbox=c.dataset.getCSMLBoundingBox()
122            bbox=csmlbbox.getBox()         
123            timeLimits=csmlbbox.getTimeLimits()
124        #crs= csmlbbox.getCRSName()
125        crs=feature.getNativeCRS()
126        crslist=[crs] #TODO, get these crs from the csml features
127        return WcsDatasetSummary(identifier=feature.id,
128                                 titles=cvgTitle,
129                                 boundingBoxes=[BoundingBox([bbox[0],bbox[1]], [bbox[2],bbox[3]],
130                                 crs='CRS:84')], description=cvgDescription,abstracts=cvgAbstract, formats=['application/cf-netcdf'],
131                                 supportedCRSs=crslist, timelimits=timeLimits
132                                 )
133
134    def _loadCapabilities(self):
135        """
136        Overriding subclass to add layer capabilities
137
138        """
139        # Get default capabilities from superclass
140        sm = super(CsmlWcs100Controller, self)._loadCapabilities()
141        ds = WcsDatasetSummary(titles=['Root Dataset'], datasetSummaries=[], CRSs=['CRS:84'])
142        # Add a DatasetSummary for each feature
143        for f_n in c.dataset.getFeatureList():
144            feature_ds = self._loadFeatureSummary(c.dataset.getFeature(f_n))
145            ds.datasetSummaries.append(feature_ds)
146        sm.contents = Contents(datasetSummaries=[ds])
147        sm.sectionrequested = self.sectionrequested
148        return sm
149
150    def _buildCoverageDescriptions(self):
151        """ builds a collection of CoverageDescription objects - used for DescribeCoverage """
152        CoverageDescriptions=[]
153        csmlbbox=c.dataset.getCSMLBoundingBox()
154        if csmlbbox is not None:
155            dsbbox=csmlbbox.getBox()
156            dstimes=csmlbbox.getTimeLimits()
157            dscrs=csmlbbox.getCRSName()
158        else:
159            dsbbox, dstimes, dscrs = None, None, None
160        for f in self.features:
161            feature = self.features[f]
162            csmlbbox=feature.getCSMLBoundingBox()
163            if csmlbbox is None: #use the bounding box of the  dataset.
164                bbox=dsbbox 
165                timeLimits=dstimes
166                crsname=dscrs
167            else: #use the feature's bounding box info
168                bbox=csmlbbox.getBox()
169                timeLimits=csmlbbox.getTimeLimits()
170                crsname=csmlbbox.getCRSName()                         
171            cd=CoverageDescription(identifier=f,titles=feature.name.CONTENT, keywords=None, abstracts=feature.description.CONTENT, boundingBoxes=[BoundingBox([bbox[0],bbox[1]], [bbox[2],bbox[3]], crs=crsname)], crs=crsname, timeDomain=timeLimits)
172            CoverageDescriptions.append(cd)
173        return CoverageDescriptions
174
175    @operation
176    @parameter('Format', possibleValues=['text/xml'])
177    @parameter('Service', possibleValues=['WCS'], required=True)
178    @parameter('Version', possibleValues=['','1.0.0'])
179    @parameter('Section', possibleValues=['/','/Service', '/Capability', '/ContentMetadata'])
180    def GetCapabilities(self, uri, service=None, version='1.0.0', section=None):
181        """
182        @note: format and updatesequence parameters are not supported
183            by this WMS.
184
185        """
186        # Populate the context object with information required by the template
187
188        #get doc from cache or disk:
189        self.sectionrequested=section
190        try:
191            rstatus,c.dataset=interface.GetParsedCSML(uri)               
192            if not rstatus: 
193                c.xml='<div class="error">%s</div>'%c.dataset
194                resp=render('error')
195                return resp
196   
197            if type(c.dataset) is str:
198                #If not a csml datset is some message from exist such as 'access denied'
199                return response(c.dataset)
200            return self._renderCapabilities('wcs1_0_0_Capabilities')
201        except Exception, e:
202            if isinstance(e, OWS_E.OwsError):
203               c.ex=e.report               
204               r=render('ogc_se', format='xml')
205               r.headers['content-type'] = 'text/xml'
206               return r
207            elif isinstance(e, ValueError):
208                c.xml='<div class="error">%s</div>'%e
209                return render('error')
210            else:
211                raise OWS_E.NoApplicableCode(e)
212           
213    @operation
214    @parameter('Service', possibleValues=['WCS'], required=True)
215    @parameter('Version', possibleValues=['','1.0.0'], required=True)
216    @parameter('Coverage', required=True)
217    @parameter('Format', possibleValues=['text/xml'])  #IS THIS MANDATORY
218    def DescribeCoverage(self, uri=None, version=None, service=None, coverage=None, format='text/xml'):
219        """
220        WCS DescribeCoverage operation
221        """
222        identifiers=coverage
223        try:
224            self.features={} #dictionary to hold requested coverages
225            rstatus,c.dataset=interface.GetParsedCSML(uri)
226            if not rstatus: raise ValueError(c.dataset)
227            for ident in identifiers.split(','):
228                feature = c.dataset.getFeature(ident)
229                if feature is None:
230                    raise OWS_E.InvalidParameterValue('Coverage  with name=%s not found'%ident, 'identifiers')
231                self.features[ident]=feature
232            if not hasattr(self,'covDescs'):
233                self.covDescs=self._buildCoverageDescriptions()
234            c.covDescs=self.covDescs
235            response.headers['content-type'] = 'text/xml'
236            return render('wcs1_0_0_DescribeCoverageResponse', format='xml')
237        except Exception, e:
238            if isinstance(e, OWS_E.OwsError):
239                c.ex=e.report               
240                r=render('ogc_se', format='xml')
241                r.headers['content-type'] = 'application/vnd.ogc.se_xml'
242                return r
243            elif isinstance(e, ValueError):
244                c.xml='<div class="error">%s</div>'%e
245                return render('error')
246            else:
247               raise OWS_E.NoApplicableCode(e)
248
249    @operation
250    @parameter('Version', possibleValues=['','1.0.0'], required=True)
251    @parameter('Coverage', required=True)
252    @parameter('CRS')
253    @parameter('Response_CRS')
254    @parameter('BBox', required=True, validator=V.bbox_2or3d)
255    @parameter('Time', validator=V.iso8601_time)
256    @parameter('Format', possibleValues=['cf-netcdf'], required=True)
257    @parameter('Store', validator = V.boolean('Store'))
258    @parameter('Status', validator = V.boolean('Status'))
259    #TODO some more parameters to add here
260    # Dimension parameters Time, Elevation, etc. are handled separately
261    def GetCoverage(self, uri, version, format, coverage, bbox, time =None, crs=None, response_crs=None, exceptions='application/vnd.ogc.se_xml',store=False, status=False):
262        # Retrieve dataset and selected feature         
263        identifier=coverage
264        boundingbox=bbox
265        try:
266            rstatus,dataset=interface.GetParsedCSML(uri)               
267            if not rstatus: 
268                c.xml='<div class="error">%s</div>'%dataset
269                resp=render('error')
270                return resp
271            feature = dataset.getFeature(identifier)
272            if feature is None:
273                raise OWS_E.InvalidParameterValue('Coverage not found', 'identifier')
274           
275                       
276            #set bounding box
277           
278            lon=feature.getLongitudeAxis()
279            lat=feature.getLatitudeAxis()
280            t=feature.getTimeAxis()
281            if None in [lon, lat, t]:
282                #TODO need to return a suitable wcs error.
283                print 'warning, could not get correct axis info'
284                #best guess!
285                if t is None:
286                    t='time'
287                if lon is None:
288                    lon = 'longitude'
289                if lat is None:
290                    lat = 'latitude'
291            #create selection dictionary:
292            sel={}
293            sel[lat]=(boundingbox[1], boundingbox[3])
294            sel[lon]=(boundingbox[0], boundingbox[2])
295            if time is not None:
296                if  type(time) is unicode:
297                    sel[t]=str(time)
298                else:
299                    sel[t]=time
300            #z is the 4th axis (eg height or pressure).
301            #NOTE, need to decide whether bounding box is of form: x1,y1,z1,x2,y2,z2 or x1,y1,x2,y2,z1,z2
302            #currently the latter is implemented.
303           
304            if len(boundingbox)  == 6:
305                for ax in feature.getAxisLabels():
306                    if ax not in [lat, lon, t]:
307                        #must be Z 
308                        z=str(ax)
309                        sel[z]=(boundingbox[4], boundingbox[5])
310           
311           
312            axisNames=feature.getAxisLabels()
313   
314                # Extract via CSML.subsetToGridSeries()
315            if store:
316                #need to farm off to WPS
317                #but for now...
318                filename = extractToNetCDF(feature, sel, publish = True) 
319            else:
320                filename = extractToNetCDF(feature, sel)
321       
322               
323            #use the randomly allocated filename as a basis for an identifier           
324            f=os.path.basename(filename)
325            c.fileID=os.path.splitext(f)[0]
326           
327            #Depending on if the 'store' parameter is set, either return the netcdf file + coverage xml as a multipart mime or return a coverage document containing a link.
328                       
329            if store:
330                if status:
331                    #STORE = true, STATUS = true:
332                    #hand off file "id" to StatusController to determine correct ExectuteResponse type response.
333                    status=StatusController()
334                    jobID=os.path.splitext(os.path.basename(filename)[9:])[0] #remove the 'csml_wxs_' prefix and file extension to create a jobID
335                    return status.getStatus(jobID)                   
336                else:
337                    #STORE=true, STATUS = false: Return Coverage XML document with link to file.
338                    #use the temp file name (minus extension) as an ID
339   
340                    try:
341                        hostname=request.environ['paste.config']['app_conf']['proxyname']
342                    except:
343                        hostname=hostname=request.environ['HTTP_HOST']                   
344                    c.hyperlink ='http://'+hostname+'/'+os.path.basename(request.environ['paste.config']['app_conf']['publish_dir'])+'/'+os.path.basename(filename)
345                    r=render('wcs_getCoverageResponse', format='xml')
346                    r.headers['content-type'] = 'text/xml'
347                    #write ndgSec to text file and store with coverage file:
348                    textName=request.environ['paste.config']['app_conf']['publish_dir']+'/'+os.path.splitext(os.path.basename(filename))[0]+'.txt'
349                    secText=open(textName, 'w')
350                    if 'ndgSec' in session:
351                        username=str(session['ndgSec']['u'])
352                        securityinfo=username
353                    else:
354                        securityinfo='No Security'
355                    secText.write(securityinfo)
356                    secText.close()                 
357                    return r                                 
358            else:               
359                #STORE = FALSE, STATUS therefore irrelevant, return file
360                fileToReturn=open(filename, 'r')
361                if os.path.splitext(filename)[1]=='.nc':
362                    mType='application/cf-netcdf'
363                else:
364                    mType='application/unknown'
365
366            response.headers['Content-Type']=mType
367            response.headers['Content-Disposition'] = paste.httpheaders.CONTENT_DISPOSITION(attachment=True, filename=f)
368            return response.write(fileToReturn)
369
370        except Exception, e:
371            if isinstance(e, OWS_E.OwsError):
372                c.ex=e.report               
373                r=render('ogc_se', format='xml')
374                #r.headers['content-type'] = 'text/xml'
375                r.headers['content-type'] = 'application/vnd.ogc.se_xml'
376                return r
377            elif isinstance(e, ValueError):
378                c.xml='<div class="error">%s</div>'%e
379                return render('error')
380            else:
381               raise OWS_E.NoApplicableCode(e)
382       
383       
Note: See TracBrowser for help on using the repository browser.