Changeset 3481 for TI05-delivery/ows_framework

Timestamp:

20/02/08 17:01:58 (12 years ago)

Author:

spascoe

Message:

WMS 1.1.1 capabilities improved

Location:

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common

Files:

• builder.py (modified) (1 diff)
• operations_metadata.py (modified) (1 diff)
• pylons/genshi_util.py (added)
• pylons/ows_controller.py (modified) (10 diffs)
• pylons/templates/wms_capabilities_1_1_1.xml (modified) (5 diffs)
• test/test_genshi_util.py (added)
• util.py (modified) (2 diffs)

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/builder.py

@@ -61 +61 @@
         abstract = siConfig.get('abstract')
 
-        keywords = siConfig.get('keywords', []).split()
+        keywords = siConfig.get('keywords', '').split()
 
         return ServiceIdentification(serviceType=type,

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/operations_metadata.py

@@ -60 +60 @@
     @ivar name
     @type name: None or str
+
+    @todo: Do we need name now?  It duplicates OperationsMetadata.operationDict keys.
+    
     """
     def __init__(self, get=None, post=None, constraints={}, parameters={}, name=None):

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/pylons/ows_controller.py

@@ -8 +8 @@
 
 
-from pylons import request, response, config
+from pylons import request, response, config, c
 from pylons.controllers import WSGIController
 from pylons.templating import render
+from webhelpers import url_for
 
 from ows_common import exceptions as OWS_E
 from ows_common.util import negotiate_version, check_updatesequence
+from ows_common.builder import loadConfigFile
+from ows_common import helpers
+from ows_common.operations_metadata import *
 
 from genshi.template import TemplateLoader
+from pkg_resources import resource_filename
 
 try:
@@ -27 +32 @@
 # Instantiate Genshi template loader
 genshiLoader = TemplateLoader(
-    resource_filename('ows_common.pylons', 'templates')
-    auto_reload=True
+    resource_filename('ows_common.pylons', 'templates'),
+    auto_reload=True,
     )
 
@@ -43 +48 @@
         Initially these comes from the query string but could come from
         a HTTP POST in future.
-    @cvar owsOperations: A dictionary of operation configuration options.
+    @cvar owsOperations: A list of operation names
    
     """
 
-    owsOperations = {}
+    owsOperations = []
     
     def __call__(self, environ, start_response):
@@ -83 +88 @@
 
         # Check action is a method in self and is defined as an OWS operation
-        try:
-            self.opConfig = self.owsOperations[action]
-        except AttributeError:
+        if action not in self.owsOperations:
             raise OWS_E.InvalidParameterValue('request=%s not supported' % action,
                                               'REQUEST')
@@ -112 +115 @@
     Adds basic GetCapabilities response to OwsControllerBase.
 
-    @ivar service: If None does not enforce the SERVICE parameter.  Otherwise
+    @cvar service: If None does not enforce the SERVICE parameter.  Otherwise
         raises exception if SERVICE is not correct on GetCapabilities request.
-    @ivar validCapabilitiesFormats: Sequence of supported Capabilities
-        mime-types.
     @cvar validVersions: A list of supported version numbers.  Automatic
         version negotiation is performed according to this attribute.
@@ -124 +125 @@
     """
 
+    owsOperations = ['GetCapabilities']
+
     # Override these attributes to control how OwsController responds to
     # GetCapabilities
@@ -129 +132 @@
     validVersions = NotImplemented
 
-    owsOperations = dict(
-        GetCapabilities = dict(formats=('text/xml',))
-        )
-
+    # To enable cache control set this instance attribute in self.__before__().
     updateSequence = None
-
     
     def GetCapabilities(self):
@@ -142 +141 @@
         version = self.getOwsParam('version', default=None)
         format = self.getOwsParam('format', default='text/xml')
-        updatesequence = self.getOwsParam('updatesequence', default=None)
+        updateSequence = self.getOwsParam('updatesequence', default=None)
 
         # Check update sequence
@@ -148 +147 @@
 
         # Do version negotiation
-        version = negotiate_version(version, self.validVersions)
+        version = negotiate_version(self.validVersions, version)
 
         # Get information required for the capabilities document
-        self._loadCapabilities
+        self._initCapabilities()
+        self._loadCapabilities()
         
         # Render the capabilities document        
@@ -157 +157 @@
         return self._renderCapabilities(version, format)
 
+    def _initCapabilities(self):
+        """
+        Initialise the capabilities object c.capabilities.
+
+        By default the server-wide configuration file is loaded and
+        used to populate some standard metadata.  The GetCapabilites
+        operation is added.
+
+        """
+        # Load the basic ServiceMetadata from a config file
+        configFile = config.get('ows_server.capabilities_config')
+        c.capabilities = loadConfigFile(configFile)
+
+        getCap = helpers.operation(url_for(), formats=['text/xml'])
+        om = OperationsMetadata(operationDict=dict(GetCapabilities=getCap))
+        c.capabilities.operationsMetadata = om
+
+    def _loadCapabilities(self):
+        """
+        Override in subclasses to populate c.capabilities with
+        operation and contents metadata.
+
+        """
+        pass
 
     def _renderCapabilities(self, version, format):
         """
         Override in subclases to render the capabilities document.
-        The response mime-type will already have been set.
+        The response mime-type will already have been set.  Raise an
+        OWS exception if the format is not supported.
 
         @param version: the version as a string

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/pylons/templates/wms_capabilities_1_1_1.xml

@@ -6 +6 @@
 
 from genshi.builder import tag, Element
+from ows_common.pylons.genshi_util import RenameElementFilter
+from genshi import QName
 
 ?>
@@ -19 +21 @@
   -->
 
-  <Operation py:def="_opContent(op)" py:strip="True">
+  <Operation py:def="_opContent(op)">
     <Format py:for="f in op.parameters['Format'].possibleValues.allowedValues" py:content="f"/>
     <DCPType><HTTP>
-      <Get>OnlineResource xlink:href="${h.url_for()}?"</Get>
+      <Get><OnlineResource xlink:href="${op.get.href}"/></Get>
     </HTTP></DCPType>
   </Operation>
   <?python
   
-  def markupOperation(op):
+  def markupOperation(opName, op):
     """Render an OWS operation description for the Capabilities section.
     """
-    return Element(op.name)(_opContent(op).generate())
+
+    return RenameElementFilter(QName(opName))(_opContent(op))
 
   ?>
@@ -65 +68 @@
 
 
-  <Service py:with="sm=c.service_metadata; si=c.service_metadata.serviceIdentification">
+  <Service py:with="sm=c.capabilities; si=c.capabilities.serviceIdentification">
     <Name>WMS</Name>
     <Title py:content="si.titles[0]"/>
@@ -86 +89 @@
         <ContactAddress py:if="cn.address is not None">
           <AddressType>postal</AddressType>
-          <Address py:for="d in cn.address.deliveryPoints" py:content="d"/>
+          <Address>
+            <py:for each="d in cn.address.deliveryPoints">${d}</py:for>
+          </Address>
           <City py:content="cn.address.city"/>
           <StateOrProvince py:content="cn.address.administrativeArea"/>
@@ -106 +111 @@
   
   <!--! These fields are represented in ows_common as service constraints -->
-  <Capability py:with="sm=c.service_metadata; om=sm.operationsMetadata">
+  <Capability py:with="sm=c.capabilities; om=sm.operationsMetadata">
     <py:if test="om is not None">
       <py:for each="opName, op in om.operationDict.items()">

TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/util.py

@@ -4 +4 @@
 # http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt
 """
-Utilities for constructing ows_common objects
+Utilities for OWS protocol processing.
 
 @author: Stephen Pascoe
 """
 
-from ows_common.domain import Domain, PossibleValues
 from ows_common import exceptions as OWS_E
-
-def make_domain(value=None, possibleValues=None, **kwargs):
-    """
-    Construct a domain object.
-
-    @param value: The defaultValue of the domain
-    @param possibleValues: Either a list of possible values,
-        a PossibleValues object or None to represent any value
-    @param kwargs: all other arguments passed to the Domain constructor.
-    """
-    if possibleValues is None:
-        pv = PossibleValues.fromAnyValue()
-    elif isinstance(possibleValues, PossibleValues):
-        pv = possibleValues
-    else:
-        pv = PossibleValues.fromAllowedValues(possibleValues)
-
-    return Domain(defaultValue=value, possibleValues=pv, **kwargs)
-
-
 
 
@@ -80 +59 @@
             raise OWS_E.InvalidUpdateSequence
     
-
+                     
 
 #-----------------------------------------------------------------------------