source: TI05-delivery/ows_framework/trunk/ows_server/ows_server/controllers/csml_wcs1_1_0.py @ 2964

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

more corrections to pass cite tests

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
36
37
38import logging
39logger = logging.getLogger('ows_server.controllers.csml_wcs')
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 CsmlWcs110Controller(OwsController):
57    _ows_parameters = {
58        'Format': make_domain(['text/xml']),
59        'ExceptionFormat': make_domain(['text/xml']),
60        }
61
62    #def __call__(self, environ, start_response):
63            #return super(CsmlWcsController, self).__call__(environ, start_response)
64
65
66    def _createMultipartMime(self, xml, netcdf):
67        #returns a multipart mime file containing the coverage xml + a netcdf file
68
69        # Create the container (outer) email message.
70        msg=MIMEMultipart()
71
72        xmlfile =StringIO.StringIO(xml)
73        xmlfile.readline(), xmlfile.readline() #don't read in first 2 lines (the content type) as MIMEBase also provides it.
74
75
76        #add the XML part
77        submsg=MIMEText(xmlfile.read(), _subtype='xml')
78        submsg.add_header('Content-ID', '<coverage.xml>')
79        submsg.add_header('Content-Disposition', 'attachment; filename="coverage.xml"')
80        #submsg.set_type('text/xml; name="coverage.xml"')
81        msg.attach(submsg)
82
83
84        #add the NetCDF part
85        submsg= MIMEBase('application', 'CF-netcdf') #check in ogc docs
86        submsg.set_payload(netcdf.read())
87        submsg.set_type('application/CF-netcdf')
88        submsg.add_header('Content-Disposition', 'attachment; filename="coverage.nc"')
89        submsg.add_header('Content-ID', '<coverage.nc>')
90        netcdf.close()
91        # Encode the payload using Base64
92        encoders.encode_base64(submsg)
93        msg.attach(submsg)
94
95        #return the message
96        return  msg
97
98
99    def _loadFeatureDimensions(self, feature):
100        dims = {}
101        lon=feature.getLongitudeAxis()
102        lat=feature.getLongitudeAxis()
103        domain=feature.getDomain()
104        for axis_name, axis in domain.iteritems():
105            if axis_name in [lon,lat]:
106                continue
107            dims[axis_name] =            Domain(possibleValues=PossibleValues.fromAllowedValues(axis),
108                                 #!TODO: this is a fudge until we can deduce UOM.
109                                 valuesUnit=ValuesUnit(uoms=[''],
110                                                       referenceSystems=['']))
111        return dims
112
113    def _loadFeatureSummary(self, feature):
114        dims = self._loadFeatureDimensions(feature)
115        #TODO - need to ensure proper values for Name. ID and Description are populated.
116        cvgTitle=[feature.description.CONTENT]
117        cvgDescription=feature.description.CONTENT
118        cvgAbstract=[feature.description.CONTENT]
119        csmlbbox=feature.getCSMLBoundingBox()
120        if csmlbbox is not None:
121            bbox=csmlbbox.getBox()       
122        else:
123            csmlbbox=c.dataset.getCSMLBoundingBox()
124            bbox=csmlbbox.getBox()
125        #crs= csmlbbox.getCRSName()
126        crs=feature.getNativeCRS()
127        crslist=[crs] #TODO, get these crs from the csml features
128        return WcsDatasetSummary(identifier=feature.id,
129                                 titles=cvgTitle,
130                                 boundingBoxes=[BoundingBox([bbox[0],bbox[1]], [bbox[2],bbox[3]],
131                                 crs='CRS:84')], description=cvgDescription,abstracts=cvgAbstract, formats=['application/cf-netcdf'],
132                                 supportedCRSs=crslist
133                                 )
134
135    def _loadCapabilities(self):
136        """
137        Overriding subclass to add layer capabilities
138
139        """
140        # Get default capabilities from superclass
141        sm = super(CsmlWcs110Controller, self)._loadCapabilities()
142        ds = WcsDatasetSummary(titles=['Root Dataset'], datasetSummaries=[], CRSs=['CRS:84'])
143        # Add a DatasetSummary for each feature
144        for f_n in c.dataset.getFeatureList():
145            feature_ds = self._loadFeatureSummary(c.dataset.getFeature(f_n))
146            ds.datasetSummaries.append(feature_ds)
147        sm.contents = Contents(datasetSummaries=[ds])
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        dsbbox=csmlbbox.getBox()
155        dstimes=csmlbbox.getTimeLimits()
156        dscrs=csmlbbox.getCRSName()
157        for f in self.features:
158            feature = self.features[f]
159            csmlbbox=feature.getCSMLBoundingBox()
160            if csmlbbox is None: #use the bounding box of the  dataset.
161                bbox=dsbbox 
162                timeLimits=dstimes
163                crsname=dscrs
164            else: #use the feature's bounding box info
165                bbox=csmlbbox.getBox()
166                timeLimits=csmlbbox.getTimeLimits()
167                crsname=csmlbbox.getCRSName()               
168            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)
169            CoverageDescriptions.append(cd)
170        return CoverageDescriptions
171
172    @operation
173    @parameter('Format', possibleValues=['text/xml'])
174    @parameter('Service', possibleValues=['WCS'], required=True)
175    @parameter('Version', possibleValues=['1.1.0'])
176    def GetCapabilities(self, uri, service=None, version='1.1.0'):
177        """
178        @note: format and updatesequence parameters are not supported
179            by this WMS.
180
181        """
182        # Populate the context object with information required by the template
183
184        #get doc from cache or disk:
185        try:
186            rstatus,c.dataset=interface.GetParsedCSML(uri)               
187            if not rstatus: 
188                c.xml='<div class="error">%s</div>'%c.dataset
189                resp=render_response('error')
190                return resp
191   
192            if type(c.dataset) is str:
193                #If not a csml datset is some message from exist such as 'access denied'
194                return Response(c.dataset)
195            return self._renderCapabilities('ows/wcs_capabilities')
196        except Exception, e:
197            if isinstance(e, OWS_E.OwsError):
198                raise e               
199            elif isinstance(e, ValueError):
200                c.xml='<div class="error">%s</div>'%e
201                return render_response('error')
202            else:
203                raise OWS_E.NoApplicableCode(e)
204           
205    @operation
206    @parameter('Service', possibleValues=['WCS'], required=True)
207    @parameter('Version', possibleValues=['1.1.0'])
208    @parameter('Identifiers', required=True)
209    @parameter('Format', possibleValues=['text/xml'], required=True)  #IS THIS MANDATORY
210    def DescribeCoverage(self, uri, version, service, identifiers, format='text/xml'):
211        """
212        WCS DescribeCoverage operation
213        """
214        try:
215            self.features={} #dictionary to hold requested coverages
216            rstatus,c.dataset=interface.GetParsedCSML(uri)
217            if not rstatus: raise ValueError(c.dataset)
218            for ident in identifiers.split(','):
219                feature = c.dataset.getFeature(ident)
220                if feature is None:
221                    raise OWS_E.InvalidParameterValue('Coverage  with id=%s not found'%ident, 'identifiers')
222                self.features[ident]=feature
223            c.covDescs=self._buildCoverageDescriptions()
224            r=render_response('wcs_DescribeCoverageResponse', format='xml')
225            r.headers['content-type'] = 'text/xml'
226            return r
227        except Exception, e:
228            if isinstance(e, OWS_E.OwsError):
229                raise e
230            elif isinstance(e, ValueError):
231                c.xml='<div class="error">%s</div>'%e
232                return render_response('error')
233            else:
234                raise OWS_E.NoApplicableCode(e)
235
236    @operation
237    @parameter('Version', possibleValues=['1.1.0'], required=True)
238    @parameter('Identifier', required=True)
239    @parameter('BoundingBox', required=True, validator=V.bbox_2or3d)
240    @parameter('TimeSequence',required=True, validator=V.iso8601_time)
241    @parameter('Format', possibleValues=['application/netcdf'], required=True)
242    @parameter('Store', validator = V.boolean('Store'))
243    @parameter('Status', validator = V.boolean('Status'))
244    #TODO some more parameters to add here
245    # Dimension parameters Time, Elevation, etc. are handled separately
246    def GetCoverage(self, uri, version, format, identifier, boundingbox, timesequence, store=False, status=False):
247        # Retrieve dataset and selected feature         
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, time]:
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(timesequence) is unicode:
274                sel[t]=str(timesequence)
275            else:
276                sel[t]=timesequence
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           
294            if store:
295                #need to farm off to WPS
296                #but for now...
297                filename = extractToNetCDF(feature, sel, publish = True) 
298            else:
299                filename = extractToNetCDF(feature, sel)
300       
301               
302            #use the randomly allocated filename as a basis for an identifier           
303            f=os.path.basename(filename)
304            c.fileID=os.path.splitext(f)[0]
305           
306            #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.
307                       
308            if store:
309                if status:
310                    #STORE = true, STATUS = true:
311                    #hand off file "id" to StatusController to determine correct ExectuteResponse type response.
312                    status=StatusController()
313                    jobID=os.path.splitext(os.path.basename(filename)[9:])[0] #remove the 'csml_wxs_' prefix and file extension to create a jobID
314                    return status.getStatus(jobID)                   
315                else:
316                    #STORE=true, STATUS = false: Return Coverage XML document with link to file.
317                    #use the temp file name (minus extension) as an ID
318
319                    try:
320                        hostname=request.environ['paste.config']['app_conf']['proxyname']
321                    except:
322                        hostname=hostname=request.environ['HTTP_HOST']                   
323                    c.hyperlink ='http://'+hostname+'/'+os.path.basename(request.environ['paste.config']['app_conf']['publish_dir'])+'/'+os.path.basename(filename)
324                    r=render_response('wcs_getCoverageResponse', format='xml')
325                    r.headers['content-type'] = 'text/xml'
326                    #write ndgSec to text file and store with coverage file:
327                    textName=request.environ['paste.config']['app_conf']['publish_dir']+'/'+os.path.splitext(os.path.basename(filename))[0]+'.txt'
328                    secText=open(textName, 'w')
329                    if 'ndgSec' in session:
330                        username=str(session['ndgSec']['u'])
331                        securityinfo=username
332                    else:
333                        securityinfo='No Security'
334                    secText.write(securityinfo)
335                    secText.close()                 
336                    return r                                 
337            else:               
338                #STORE = FALSE, STATUS therefore irrelevant, return Multipart Mime.
339                netcdfFile=open(filename, 'r')
340                c.hyperlink="cid:coverage.nc"
341                xmlfile=render_response('wcs_getCoverageResponse', format='xml')
342                xmlfile.headers['content-type'] = 'text/xml'
343                multipart=self._createMultipartMime(xmlfile, netcdfFile)       
344                msg=multipart
345                try:
346                    #0.9.6
347                    pylons.response.headers['Content-Type']='multipart'
348                    return pylons.response(content=msg)
349                except:
350                    #0.9.5
351                    return Response(content=msg, mimetype='multipart')                     
352        except Exception, e:
353            if isinstance(e, OWS_E.OwsError):
354               raise e
355            elif isinstance(e, ValueError):
356                c.xml='<div class="error">%s</div>'%e
357                return render_response('error')
358            else:
359               raise OWS_E.NoApplicableCode(e)
360       
361       
Note: See TracBrowser for help on using the repository browser.