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

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@2933
Revision 2933, 15.4 KB checked in by domlowe, 14 years ago (diff)

changed parameter names for 1.0.0 getCoverage request

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        else:
120            csmlbbox=c.dataset.getCSMLBoundingBox()
121            bbox=csmlbbox.getBox()
122        #crs= csmlbbox.getCRSName()
123        crs=feature.getNativeCRS()
124        crslist=[crs] #TODO, get these crs from the csml features
125        return WcsDatasetSummary(identifier=feature.id,
126                                 titles=cvgTitle,
127                                 boundingBoxes=[BoundingBox([bbox[0],bbox[1]], [bbox[2],bbox[3]],
128                                 crs='CRS:84')], description=cvgDescription,abstracts=cvgAbstract, formats=['application/cf-netcdf'],
129                                 supportedCRSs=crslist
130                                 )
131
132    def _loadCapabilities(self):
133        """
134        Overriding subclass to add layer capabilities
135
136        """
137        # Get default capabilities from superclass
138        sm = super(CsmlWcs100Controller, self)._loadCapabilities()
139        ds = WcsDatasetSummary(titles=['Root Dataset'], datasetSummaries=[], CRSs=['CRS:84'])
140        # Add a DatasetSummary for each feature
141        for f_n in c.dataset.getFeatureList():
142            feature_ds = self._loadFeatureSummary(c.dataset.getFeature(f_n))
143            ds.datasetSummaries.append(feature_ds)
144        sm.contents = Contents(datasetSummaries=[ds])
145        return sm
146
147    def _buildCoverageDescriptions(self):
148        """ builds a collection of CoverageDescription objects - used for DescribeCoverage """
149        CoverageDescriptions=[]
150        csmlbbox=c.dataset.getCSMLBoundingBox()
151        dsbbox=csmlbbox.getBox()
152        dstimes=csmlbbox.getTimeLimits()
153        dscrs=csmlbbox.getCRSName()
154        for f in self.features:
155            feature = self.features[f]
156            csmlbbox=feature.getCSMLBoundingBox()
157            if csmlbbox is None: #use the bounding box of the  dataset.
158                bbox=dsbbox 
159                timeLimits=dstimes
160                crsname=dscrs
161            else: #use the feature's bounding box info
162                bbox=csmlbbox.getBox()
163                timeLimits=csmlbbox.getTimeLimits()
164                crsname=csmlbbox.getCRSName()               
165            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)], timeDomain=timeLimits)
166            CoverageDescriptions.append(cd)
167        return CoverageDescriptions
168
169    @operation
170    @parameter('Format', possibleValues=['text/xml'])
171    @parameter('Service', possibleValues=['WCS'], required=True)
172    @parameter('Version', possibleValues=['1.0.0'])
173    def GetCapabilities(self, uri, service=None, version=None):
174        """
175        @note: format and updatesequence parameters are not supported
176            by this WMS.
177
178        """
179        # Populate the context object with information required by the template
180
181        #get doc from cache or disk:
182        try:
183            rstatus,c.dataset=interface.GetParsedCSML(uri)               
184            if not rstatus: 
185                c.xml='<div class="error">%s</div>'%c.dataset
186                resp=render_response('error')
187                return resp
188   
189            if type(c.dataset) is str:
190                #If not a csml datset is some message from exist such as 'access denied'
191                return Response(c.dataset)
192            return self._renderCapabilities('wcs1_0_0_Capabilities')
193        except Exception, e:
194            if isinstance(e, OWS_E.OwsError):
195               raise e
196            elif isinstance(e, ValueError):
197                c.xml='<div class="error">%s</div>'%e
198                return render_response('error')
199            else:
200                raise OWS_E.NoApplicableCode(e)
201           
202    @operation
203    @parameter('Service', possibleValues=['WCS'], required=True)
204    @parameter('Version', possibleValues=['1.0.0'])
205    @parameter('Coverage', required=True)
206    @parameter('Format', possibleValues=['text/xml'], required=True)  #IS THIS MANDATORY
207    def DescribeCoverage(self, uri, version, service, coverage, format='text/xml'):
208        """
209        WCS DescribeCoverage operation
210        """
211        identifiers=coverage
212        try:
213            self.features={} #dictionary to hold requested coverages
214            rstatus,c.dataset=interface.GetParsedCSML(uri)
215            if not rstatus: raise ValueError(c.dataset)
216            for ident in identifiers.split(','):
217                feature = c.dataset.getFeature(ident)
218                if feature is None:
219                    raise OWS_E.InvalidParameterValue('Coverage  with name=%s not found'%ident, 'identifiers')
220                self.features[ident]=feature
221            c.covDescs=self._buildCoverageDescriptions()
222            r=render_response('wcs1_0_0_DescribeCoverageResponse', format='xml')
223            r.headers['content-type'] = 'text/xml'
224            return r
225        except Exception, e:
226            if isinstance(e, OWS_E.OwsError):
227               raise e
228            elif isinstance(e, ValueError):
229                c.xml='<div class="error">%s</div>'%e
230                return render_response('error')
231            else:
232               raise OWS_E.NoApplicableCode(e)
233
234    @operation
235    @parameter('Version', possibleValues=['1.0.0'], required=True)
236    @parameter('Coverage', required=True)
237    @parameter('BBox', required=True, validator=V.bbox_2or3d)
238    @parameter('Time',required=True, validator=V.iso8601_time)
239    @parameter('Format', possibleValues=['application/netcdf'], required=True)
240    @parameter('Store', validator = V.boolean('Store'))
241    @parameter('Status', validator = V.boolean('Status'))
242    #TODO some more parameters to add here
243    # Dimension parameters Time, Elevation, etc. are handled separately
244    def GetCoverage(self, uri, version, format, coverage, bbox, time, exceptions='application/vnd.ogc.se_xml',store=False, status=False):
245        # Retrieve dataset and selected feature         
246        identifier=coverage
247        boundingbox=bbox
248        try:
249            rstatus,dataset=interface.GetParsedCSML(uri)               
250            if not rstatus: 
251                c.xml='<div class="error">%s</div>'%dataset
252                resp=render_response('error')
253                return resp
254            feature = dataset.getFeature(identifier)
255            if feature is None:
256                raise OWS_E.InvalidParameterValue('Coverage not found', 'identifier')
257           
258                       
259            #set bounding box
260           
261            lon=feature.getLongitudeAxis()
262            lat=feature.getLatitudeAxis()
263            t=feature.getTimeAxis()
264            print '%s %s %s'%(lon,lat,t)
265            if None in [lon, lat, t]:
266                #TODO need to return a suitable wcs error.
267                print 'warning, could not get correct axis info'
268           
269            #create selection dictionary:
270            sel={}
271            sel[lat]=(boundingbox[1], boundingbox[3])
272            sel[lon]=(boundingbox[0], boundingbox[2])
273            if  type(time) is unicode:
274                sel[t]=str(time)
275            else:
276                sel[t]=time
277           
278            #z is the 4th axis (eg height or pressure).
279            #NOTE, need to decide whether bounding box is of form: x1,y1,z1,x2,y2,z2 or x1,y1,x2,y2,z1,z2
280            #currently the latter is implemented.
281           
282            if len(boundingbox)  == 6:
283                for ax in feature.getAxisLabels():
284                    if ax not in [lat, lon, t]:
285                        #must be Z 
286                        z=str(ax)
287                        sel[z]=(boundingbox[4], boundingbox[5])
288           
289           
290            axisNames=feature.getAxisLabels()
291   
292            # Extract via CSML.subsetToGridSeries()
293            if store:
294                #need to farm off to WPS
295                #but for now...
296                filename = extractToNetCDF(feature, sel, publish = True) 
297            else:
298                filename = extractToNetCDF(feature, sel)
299       
300               
301            #use the randomly allocated filename as a basis for an identifier           
302            f=os.path.basename(filename)
303            c.fileID=os.path.splitext(f)[0]
304           
305            #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.
306                       
307            if store:
308                if status:
309                    #STORE = true, STATUS = true:
310                    #hand off file "id" to StatusController to determine correct ExectuteResponse type response.
311                    status=StatusController()
312                    jobID=os.path.splitext(os.path.basename(filename)[9:])[0] #remove the 'csml_wxs_' prefix and file extension to create a jobID
313                    return status.getStatus(jobID)                   
314                else:
315                    #STORE=true, STATUS = false: Return Coverage XML document with link to file.
316                    #use the temp file name (minus extension) as an ID
317
318                    try:
319                        hostname=request.environ['paste.config']['app_conf']['proxyname']
320                    except:
321                        hostname=hostname=request.environ['HTTP_HOST']                   
322                    c.hyperlink ='http://'+hostname+'/'+os.path.basename(request.environ['paste.config']['app_conf']['publish_dir'])+'/'+os.path.basename(filename)
323                    r=render_response('wcs_getCoverageResponse', format='xml')
324                    r.headers['content-type'] = 'text/xml'
325                    #write ndgSec to text file and store with coverage file:
326                    textName=request.environ['paste.config']['app_conf']['publish_dir']+'/'+os.path.splitext(os.path.basename(filename))[0]+'.txt'
327                    secText=open(textName, 'w')
328                    if 'ndgSec' in session:
329                        username=str(session['ndgSec']['u'])
330                        securityinfo=username
331                    else:
332                        securityinfo='No Security'
333                    secText.write(securityinfo)
334                    secText.close()                 
335                    return r                                 
336            else:               
337                #STORE = FALSE, STATUS therefore irrelevant, return file
338                fileToReturn=open(filename, 'r')
339                if os.path.splitext(filename)[1]=='.nc':
340                    mType='application/cf-netcdf'
341                else:
342                    mType='application/unknown'
343                 #Differnce in how Content-Types are handled between pylons 0.9.5 and 0.9.6
344            try:
345                #0.9.6
346                pylons.response.headers['Content-Type']=mType               
347                pylons.response.headers['Content-Disposition'] = paste.httpheaders.CONTENT_DISPOSITION(attachment=True, filename=f)
348                return pylons.response(content=fileToReturn)
349            except:
350                #0.9.5               
351                r=Response(content=fileToReturn, mimetype=mType)     
352                r.headers['Content-Disposition'] = paste.httpheaders.CONTENT_DISPOSITION(attachment=True, filename=f)               
353                return r
354        except Exception, e:
355            if isinstance(e, OWS_E.OwsError):
356               raise e
357            elif isinstance(e, ValueError):
358                c.xml='<div class="error">%s</div>'%e
359                return render_response('error')
360            else:
361               raise OWS_E.NoApplicableCode(e)
362       
363       
Note: See TracBrowser for help on using the repository browser.