¡@

Home 

OpenStack Study: __init__.py

OpenStack Index

**** CubicPower OpenStack Study ****

# Copyright (c) 2013 OpenStack Foundation

#

# All Rights Reserved.

#

# Licensed under the Apache License, Version 2.0 (the "License"); you may

# not use this file except in compliance with the License. You may obtain

# a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

# License for the specific language governing permissions and limitations

# under the License.

"""

WSGI middleware for OpenStack API controllers.

"""

import routes

from cinder.api.openstack import wsgi

from cinder.openstack.common import log as logging

from cinder import wsgi as base_wsgi

LOG = logging.getLogger(__name__)

**** CubicPower OpenStack Study ****

class APIMapper(routes.Mapper):

**** CubicPower OpenStack Study ****

    def routematch(self, url=None, environ=None):

        if url is "":

            result = self._match("", environ)

            return result[0], result[1]

        return routes.Mapper.routematch(self, url, environ)

**** CubicPower OpenStack Study ****

class ProjectMapper(APIMapper):

**** CubicPower OpenStack Study ****

    def resource(self, member_name, collection_name, **kwargs):

        if 'parent_resource' not in kwargs:

            kwargs['path_prefix'] = '{project_id}/'

        else:

            parent_resource = kwargs['parent_resource']

            p_collection = parent_resource['collection_name']

            p_member = parent_resource['member_name']

            kwargs['path_prefix'] = '{project_id}/%s/:%s_id' % (p_collection,

                                                                p_member)

        routes.Mapper.resource(self,

                               member_name,

                               collection_name,

                               **kwargs)

**** CubicPower OpenStack Study ****

class APIRouter(base_wsgi.Router):

"""Routes requests on the API to the appropriate controller and method."""

ExtensionManager = None # override in subclasses

@classmethod

**** CubicPower OpenStack Study ****

    def factory(cls, global_config, **local_config):

        """Simple paste factory, :class:`cinder.wsgi.Router` doesn't have."""

        return cls()

**** CubicPower OpenStack Study ****

    def __init__(self, ext_mgr=None):

        if ext_mgr is None:

            if self.ExtensionManager:

                ext_mgr = self.ExtensionManager()

            else:

                raise Exception(_("Must specify an ExtensionManager class"))

        mapper = ProjectMapper()

        self.resources = {}

        self._setup_routes(mapper, ext_mgr)

        self._setup_ext_routes(mapper, ext_mgr)

        self._setup_extensions(ext_mgr)

        super(APIRouter, self).__init__(mapper)

**** CubicPower OpenStack Study ****

    def _setup_ext_routes(self, mapper, ext_mgr):

        for resource in ext_mgr.get_resources():

            LOG.debug(_('Extended resource: %s'),

                      resource.collection)

            wsgi_resource = wsgi.Resource(resource.controller)

            self.resources[resource.collection] = wsgi_resource

            kargs = dict(

                controller=wsgi_resource,

                collection=resource.collection_actions,

                member=resource.member_actions)

            if resource.parent:

                kargs['parent_resource'] = resource.parent

            mapper.resource(resource.collection, resource.collection, **kargs)

            if resource.custom_routes_fn:

                resource.custom_routes_fn(mapper, wsgi_resource)

**** CubicPower OpenStack Study ****

    def _setup_extensions(self, ext_mgr):

        for extension in ext_mgr.get_controller_extensions():

            collection = extension.collection

            controller = extension.controller

            if collection not in self.resources:

                LOG.warning(_('Extension %(ext_name)s: Cannot extend '

                              'resource %(collection)s: No such resource'),

                            {'ext_name': extension.extension.name,

                             'collection': collection})

                continue

            LOG.debug(_('Extension %(ext_name)s extending resource: '

                        '%(collection)s'),

                      {'ext_name': extension.extension.name,

                       'collection': collection})

            resource = self.resources[collection]

            resource.register_actions(controller)

            resource.register_extensions(controller)

**** CubicPower OpenStack Study ****

    def _setup_routes(self, mapper, ext_mgr):

        raise NotImplementedError

**** CubicPower OpenStack Study ****

class FaultWrapper(base_wsgi.Middleware):

**** CubicPower OpenStack Study ****

    def __init__(self, application):

        LOG.warn(_('cinder.api.openstack:FaultWrapper is deprecated. Please '

                   'use cinder.api.middleware.fault:FaultWrapper instead.'))

        # Avoid circular imports from here. Can I just remove this class?

        from cinder.api.middleware import fault

        super(FaultWrapper, self).__init__(fault.FaultWrapper(application))