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

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@2978
Revision 2978, 15.2 KB checked in by domlowe, 12 years ago (diff)

couple of minor template changes

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