source: TI05-delivery/ows_framework/branches/ows_framework-refactor/ows_common/ows_common/builder.py @ 3553

# Copyright (C) 2007 STFC & NERC (Science and Technology Facilities Council).
# This software may be distributed under the terms of the
# Q Public License, version 1.0 or later.
# http://ndg.nerc.ac.uk/public_docs/QPublic_license.txt
"""
Construct a ServiceMetadata instance with a simplified interface.

"""

import ConfigParser
from cStringIO import StringIO

from ows_common.model import *

class ServiceMetadataBuilder(object):
    def __init__(self, serviceMetadata=None):
        if serviceMetadata is None:
            self.clear()
        else:
            self.serviceMetadata = serviceMetadata

    def clear(self):
        """
        Clear the serviceMetadata instance.

        """
        self.serviceMetadata = ServiceMetadata()

    def fromConfig(self, config):
        """
        Load ServiceIdentification and ServiceProvider information from a
        config file.

        """

        self.serviceMetadata.serviceIdentification =  self._siFromConfig(config)
        self.serviceMetadata.serviceProvider = self._spFromConfig(config)


    #-------------------------------------------------------------------------

    def _siFromConfig(self, config):

        siConfig = dict(config.items('serviceIdentification'))

        # serviceType and versions are typically populated from the framework
        # They are included here for completeness and because serviceType is
        # required in the data model
        type = siConfig.get('type', 'OWS')
        versions = siConfig.get('versions', '').split()
        
        profiles = siConfig.get('profiles', '').split()
        fees = siConfig.get('fees')
        accessConstraints = siConfig.get('accessConstraints')

        # Only one title & abstract supported
        title = siConfig.get('title')
        abstract = siConfig.get('abstract')

        keywords = siConfig.get('keywords', '').split()

        return ServiceIdentification(serviceType=type,
                                     serviceTypeVersions=versions,
                                     profiles=profiles,
                                     fees=fees,
                                     accessConstraints=accessConstraints,
                                     titles=[title],
                                     abstracts=[abstract],
                                     keywords=keywords)

    def _spFromConfig(self, config):
        spConfig = dict(config.items('serviceProvider'))

        provider = spConfig['provider']
        site = spConfig.get('site')

        # Contact info
        name = spConfig.get('contact.name')
        position = spConfig.get('contact.position')
        role = spConfig.get('contact.role')
        hos = spConfig.get('contact.hoursOfService')
        instr = spConfig.get('contact.instructions')

        # Look for all address fields of name contact.address<n>
        address = []
        for i in range(1, 8):
            k = 'contact.address%d' % i
            try:
                address.append(spConfig[k])
            except KeyError:
                break
        city = spConfig.get('contact.city')
        adminArea = spConfig.get('contact.administrativeArea')
        postalCode = spConfig.get('contact.postalCode')
        country = spConfig.get('contact.country')
        email = spConfig.get('contact.email')
        phone = spConfig.get('contact.phone')
        fax = spConfig.get('contact.faxcimile')
        onlineResource = spConfig.get('contact.onlineResource')

        a = Address(deliveryPoints=address, city=city,
                    administrativeArea=adminArea, postalCode=postalCode,
                    country=country, electronicMailAddress=email)
        t = Telephone(voice=phone, facsimile=fax)
        c = Contact(hoursOfService=hos,
                    contactInstructions=instr,
                    address=a,
                    phone=t,
                    onlineResource=onlineResource)
        rp = ResponsibleParty(individualName=name,
                              positionName=position,
                              role=role,
                              contactInfo=c)

        return ServiceProvider(providerName=provider,
                               serviceContact=rp,
                               providerSite=site)
    
    
#
# Simple functional interface
#

def loadConfigFile(filename):
    b = ServiceMetadataBuilder()

    config = ConfigParser.SafeConfigParser()
    config.read([filename])

    b.fromConfig(config)

    return b.serviceMetadata

def loadConfig(configString):
    b = ServiceMetadataBuilder()

    config = ConfigParser.SafeConfigParser()
    fp = StringIO(configString)
    config.readfp(fp)

    b.fromConfig(config)

    return b.serviceMetadata


#-------------------------------------------------------------------------------

def test_loadConfig():
    sm = loadConfig("""
[serviceIdentification]
type: WMS
versions: 1.1.1 1.3.0
fees: Loadsamoney
accessConstraints: byebye
title: The quick brown fox jumps
  over the lazy dog
abstract: None
keywords: foo bar baz
  spud

[serviceProvider]
provider: Superman
site: http://example.com
contact.name: Joe Blogs
contact.address1: foo
contact.address2: bar
contact.email: foo@bar.baz

""")

    from genshi.template import TemplateLoader
    from pkg_resources import resource_filename
    loader = TemplateLoader(
               [resource_filename('ows_common.pylons.templates', '')])
    t = loader.load('wms_capabilities_1_1_1.xml')

    # Mock objects
    class C:
        service_metadata = sm
    c = C()

    class H:
        def url_for(self): return 'http://example.com/'
    h=H()

    print t.generate(c=c, h=h).render()