source: TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/pylons/wms_controller.py @ 3671

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/pylons/wms_controller.py@3671
Revision 3671, 10.8 KB checked in by spascoe, 11 years ago (diff)

Resupporting WMS 1.3.0

Line 
1"""
2WMS controller for OGC Web Services (OWS).
3
4@author: Stephen Pascoe
5"""
6
7from cStringIO import StringIO
8
9from matplotlib.cm import get_cmap
10from pylons import request, response, c
11
12import logging
13log = logging.getLogger(__name__)
14
15import Image
16
17from ows_common.model.wms import WmsDatasetSummary, Dimension
18from ows_common.model import PossibleValues, BoundingBox, Contents
19from ows_common.pylons import ows_controller
20from ows_common.exceptions import *
21from ows_common import bbox_util
22
23class WMSController(ows_controller.OWSController):
24    """
25    Subclass this controller in a pylons application and set the layerMapper
26    class attribute to implement a WMS.
27
28    @cvar layerMapper: an ows_common.service.wms_iface.ILayerMapper object.
29
30    """
31    layerMapper = None
32   
33    _pilImageFormats = {
34        'image/png': 'PNG',
35        'image/jpg': 'JPEG',
36        'image/gif': 'GIF',
37        'image/tiff': 'TIFF'
38        }
39    _layerSlabCache = {}
40
41    #-------------------------------------------------------------------------
42    # Attributes required by OWSController
43
44    service = 'WMS'
45    owsOperations = ows_controller.OWSController.owsOperations + ['GetMap', 'GetContext',
46                                                                  'GetLegend',
47                                                                  'GetInfo']
48    validVersions = ['1.1.1', '1.3.0']
49
50    #-------------------------------------------------------------------------
51
52    def __before__(self, **kwargs):
53        """
54        This default implementation of __before__() will pass all routes
55        arguments to the layer mapper to retrieve a list of layers for
56        this WMS.
57
58        It will be called automatically by pylons before each action method.
59
60        @todo: The layer mapper needs to come from somewhere.
61
62        """
63        self.layers = self.layerMapper.map(**kwargs)
64
65    #-------------------------------------------------------------------------
66    # Methods implementing stubs in OWSController
67
68    def _renderCapabilities(self, version, format):
69        if version == '1.1.1':
70            t = ows_controller.templateLoader.load('wms_capabilities_1_1_1.xml')
71        elif version == '1.3.0':
72            t = ows_controller.templateLoader.load('wms_capabilities_1_3_0.xml')
73        else:
74            # We should never get here!  The framework should raise an exception before now.
75            raise RuntimeError("Version %s not supported" % version)
76       
77        return t.generate(c=c).render()
78
79    def _loadCapabilities(self):
80        """
81        @note: Assumes self.layers has already been created by __before__().
82
83        """
84        ows_controller.addOperation('GetMap', formats=self._pilImageFormats.keys())
85        ows_controller.addOperation('GetContext')
86        ows_controller.addOperation('GetLegend',
87                                    formats=['image/png'])
88        ows_controller.addOperation('GetInfo')
89        log.debug('Loading capabilities contents')
90        c.capabilities.contents = Contents()
91        for layerName, layer in self.layers.items():
92            log.debug('Loading layer %s' % layerName)
93
94            # Get CRS/BBOX pairs
95            bboxObjs = []
96            for crs in layer.crss:
97                bbox = layer.getBBox(crs)
98                bboxObjs.append(BoundingBox(bbox[:2], bbox[2:], crs=crs))
99            # Get dimensions
100            dims = {}
101            for dimName, dim in layer.dimensions.items():
102                dims[dimName] = Dimension(valuesUnit=dim.units,
103                                          unitSymbol=dim.units,
104                                          possibleValues=
105                                            PossibleValues.fromAllowedValues(dim.extent))
106            # Create the ows_common object
107            ds = WmsDatasetSummary(identifier=layerName,
108                                   titles=[layer.title],
109                                   CRSs=layer.crss,
110                                   boundingBoxes=bboxObjs,
111                                   abstracts=[layer.abstract],
112                                   dimensions=dims)
113
114            # Stuff that should go in the capabilities tree eventually
115            ds.legendSize = layer.legendSize
116            ds.legendFormats = ['image/png']
117
118            c.capabilities.contents.datasetSummaries.append(ds)
119
120
121
122    def _getLayerParam(self):
123        """
124        Retrieve the layers parameter enforcing the rule of only
125        selecting one layer.
126
127        """
128        layerName = self.getOwsParam('layers')
129
130        # Select the first layer if several are requested.
131        # This plays nicer with mapClient.
132        if ',' in layerName:
133            layerName = layerName.split(',')[0]
134            #raise InvalidParameterValue(
135            #    'Multi-layer GetMap requests are not supported', 'layers')
136        try:
137            layerObj = self.layers[layerName]
138        except KeyError:
139            raise InvalidParameterValue('Layer %s not found' % layerName, 'layers')
140
141        return layerName, layerObj
142
143    def _getFormatParam(self):
144        format = self.getOwsParam('format', default='image/png')
145        if format not in self._pilImageFormats:
146            raise InvalidParameterValue(
147                'Format %s not supported' % format, 'format')
148
149        return format
150   
151    #-------------------------------------------------------------------------
152    # OWS Operation methods
153   
154    def GetMap(self):
155
156        # Housekeeping
157        version = self.getOwsParam('version', default=self.validVersions[0])
158        if version not in self.validVersions:
159            raise InvalidParameterValue('Version %s not supported' % version,
160                                        'version')
161        styles = self.getOwsParam('styles', default='')
162        transparent = self.getOwsParam('transparent', default='FALSE')
163        bgcolor = self.getOwsParam('bgcolor', default='0xFFFFFF')
164
165        # Layer handling
166        layerName, layerObj = self._getLayerParam()
167       
168        # Coordinate parameters
169        bbox = tuple(float(x) for x in self.getOwsParam('bbox').split(','))
170        width = int(self.getOwsParam('width'))
171        height = int(self.getOwsParam('height'))
172
173        if version == '1.1.1':
174            srs = self.getOwsParam('srs')
175        else:
176            srs = self.getOwsParam('crs')
177
178        if srs not in layerObj.crss:
179            raise InvalidParameterValue('Layer %s does not support SRS %s' % (layerName, srs))
180
181        # Get format
182        format = self.getOwsParam('format')
183        if format not in self._pilImageFormats:
184            raise InvalidParameterValue(
185                'Format %s not supported' % format, 'format')
186
187        # Dimension handling
188        dimValues = {}
189        for dimName, dim in layerObj.dimensions.items():
190            defaultValue = dim.extent[0]
191            dimValues[dimName] = self.getOwsParam(dimName, default=defaultValue)
192           
193        #---------------------------------------------------------------------
194        # The real work
195        #!TODO: Minimum and maximum values
196       
197        # Find the slab in the cache first
198        cacheKey = layerObj.getCacheKey(srs, dimValues)
199
200        slab = self._layerSlabCache.get(cacheKey)
201        if slab is None:
202            slab = layerObj.getSlab(srs, dimValues, dict(minValue=0, maxValue=100))
203            if cacheKey is not None:
204                self._layerSlabCache[cacheKey] = slab
205
206        # We must request a bbox within the layer's bbox.
207        lbbox = layerObj.getBBox(srs)
208        ibbox = bbox_util.intersection(bbox, lbbox)
209
210        log.debug('bbox = %s' % (bbox,))
211        log.debug('lbbox = %s' % (lbbox,))
212        log.debug('ibbox = %s' % (ibbox,))
213
214        # If bbox is not within layerObj.bbox then we need to calculate the
215        # pixel offset of the inner bbox, request the right width/height
216        # and paste the image into a blank background
217        if bbox == ibbox:
218            img = slab.getImage(bbox, width, height)
219            log.debug('slab image.size = %s' % (img.size,))
220        else:
221            sx, sy = bbox_util.relativeSize(ibbox, bbox)
222            log.debug('scaling: %s,%s' % (sx, sy))
223            img1 = slab.getImage(ibbox, int(width*sx), int(height*sy))
224            log.debug('inner image.size = %s' % (img1.size,))
225
226            img = Image.new('RGBA', (width, height))
227            pxOrigin = bbox_util.geoToPixel(ibbox[0], ibbox[3], bbox, width, height)
228            log.debug('pxOrigin = %s' % (pxOrigin,))
229            img.paste(img1, pxOrigin)
230           
231
232        # IE < 7 doesn't display the alpha layer right.  Here we sniff the
233        # user agent and remove the alpha layer if necessary.
234        try:
235            ua = request.headers['User-Agent']
236        except:
237            pass
238        else:
239            if 'MSIE' in ua and 'MSIE 7' not in ua:
240                img = img.convert('RGB')
241
242        buf = StringIO()
243        img.save(buf, self._pilImageFormats[format])
244
245        response.headers['Content-Type'] = format
246        response.write(buf.getvalue())
247
248        return request
249
250    def GetContext(self):
251        """
252        Return a WebMap Context document for a given set of layers.
253
254        """
255        # Parameters
256        layers = self.getOwsParam('layers', default=None)
257
258        # Filter self.layers for selected layers
259        if layers is not None:
260            newLayerMap = {}
261            for layerName in layers.split(','):
262                try:
263                    newLayerMap[layerName] = self.layers[layerName]
264                except KeyError:
265                    raise InvalidParameterValue('Layer %s not found' % layerName,
266                                                'layers')
267                   
268            self.layers = newLayerMap
269
270        # Automatically select the first bbox/crs for the first layer
271        aLayer = self.layers.values()[0]
272        crs = aLayer.crss[0]
273        bb = aLayer.getBBox(crs)
274        c.bbox = BoundingBox(bb[:2], bb[2:], crs)
275
276        # Initialise as if doing GetCapabilities
277        ows_controller.initCapabilities()
278        self._loadCapabilities()
279
280        response.headers['Content-Type'] = 'text/xml'
281        t = ows_controller.templateLoader.load('wms_context_1_1_1.xml')
282        return t.generate(c=c).render()
283
284    def GetLegend(self):
285        """
286        Return an image of the legend.
287
288        """
289        # Parameters
290        layerName, layerObj = self._getLayerParam()
291        format = self._getFormatParam()
292
293        img = layerObj.getLegendImage()
294
295        buf = StringIO()
296        img.save(buf, self._pilImageFormats[format])
297
298        response.headers['Content-Type'] = format
299        response.write(buf.getvalue())
300
301
302    def GetInfo(self):
303        from pprint import pformat
304        request.headers['Content-Type'] = 'text/ascii'
305        response.write('Some info about this service\n')
306        for layer in model.ukcip02.layers:
307            response.write('Layer %s: %s\n' % (layer, pformat(g.ukcip02_layers[layer].__dict__)))
308
309           
Note: See TracBrowser for help on using the repository browser.