daisycloud-core/code/daisy/daisy/api/v1/services.py

# Copyright 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.

"""
/services endpoint for Daisy v1 API
"""

from oslo_log import log as logging
from webob.exc import HTTPBadRequest
from webob.exc import HTTPConflict
from webob.exc import HTTPForbidden
from webob.exc import HTTPNotFound
from webob import Response

from daisy.api import policy
import daisy.api.v1
from daisy.api.v1 import controller
from daisy.api.v1 import filters
from daisy.common import exception
from daisy.common import utils
from daisy.common import wsgi
from daisy import i18n
from daisy import notifier
import daisy.registry.client.v1.api as registry

LOG = logging.getLogger(__name__)
_ = i18n._
_LE = i18n._LE
_LI = i18n._LI
_LW = i18n._LW
SUPPORTED_PARAMS = daisy.api.v1.SUPPORTED_PARAMS
SUPPORTED_FILTERS = daisy.api.v1.SUPPORTED_FILTERS
ACTIVE_IMMUTABLE = daisy.api.v1.ACTIVE_IMMUTABLE


class Controller(controller.BaseController):
    """
    WSGI controller for services resource in Daisy v1 API

    The services resource API is a RESTful web service for service data.
    The API is as follows::

        GET  /services -- Returns a set of brief metadata about services
        GET  /services/detail -- Returns a set of detailed metadata about
                              services
        HEAD /services/<ID> -- Return metadata about an service with id <ID>
        GET  /services/<ID> -- Return service data for service with id <ID>
        POST /services -- Store service data and return metadata about the
                        newly-stored service
        PUT  /services/<ID> -- Update service metadata and/or upload service
                            data for a previously-reserved service
        DELETE /services/<ID> -- Delete the service with id <ID>
    """

    def __init__(self):
        self.notifier = notifier.Notifier()
        registry.configure_registry_client()
        self.policy = policy.Enforcer()

    def _enforce(self, req, action, target=None):
        """Authorize an action against our policies"""
        if target is None:
            target = {}
        try:
            self.policy.enforce(req.context, action, target)
        except exception.Forbidden:
            raise HTTPForbidden()

    def _get_filters(self, req):
        """
        Return a dictionary of query param filters from the request

        :param req: the Request object coming from the wsgi layer
        :retval a dict of key/value filters
        """
        query_filters = {}
        for param in req.params:
            if param in SUPPORTED_FILTERS:
                query_filters[param] = req.params.get(param)
                if not filters.validate(param, query_filters[param]):
                    raise HTTPBadRequest(_('Bad value passed to filter '
                                           '%(filter)s got %(val)s')
                                         % {'filter': param,
                                            'val': query_filters[param]})
        return query_filters

    def _get_query_params(self, req):
        """
        Extracts necessary query params from request.

        :param req: the WSGI Request object
        :retval dict of parameters that can be used by registry client
        """
        params = {'filters': self._get_filters(req)}

        for PARAM in SUPPORTED_PARAMS:
            if PARAM in req.params:
                params[PARAM] = req.params.get(PARAM)
        return params

    def _raise_404_if_component_deleted(self, req, component_id):
        component = self.get_component_meta_or_404(req, component_id)
        if component['deleted']:
            msg = _("Component with identifier %s has been deleted.") % \
                component_id
            raise HTTPNotFound(msg)

    @utils.mutating
    def add_service(self, req, service_meta):
        """
        Adds a new service to Daisy.

        :param req: The WSGI/Webob Request object
        :param image_meta: Mapping of metadata about service

        :raises HTTPBadRequest if x-service-name is missing
        """
        self._enforce(req, 'add_service')
        service_name = service_meta["name"]
        service_description = service_meta["description"]

        if 'component_id' in service_meta:
            orig_component_id = str(service_meta['component_id'])
            self._raise_404_if_component_deleted(req, orig_component_id)

        print service_name
        print service_description
        service_meta = registry.add_service_metadata(req.context, service_meta)

        return {'service_meta': service_meta}

    @utils.mutating
    def delete_service(self, req, id):
        """
        Deletes a service from Daisy.

        :param req: The WSGI/Webob Request object
        :param image_meta: Mapping of metadata about service

        :raises HTTPBadRequest if x-service-name is missing
        """
        self._enforce(req, 'delete_service')

        # service = self.get_service_meta_or_404(req, id)
        print "delete_service:%s" % id
        try:
            registry.delete_service_metadata(req.context, id)
        except exception.NotFound as e:
            msg = (_("Failed to find service to delete: %s") %
                   utils.exception_to_str(e))
            LOG.warning(msg)
            raise HTTPNotFound(explanation=msg,
                               request=req,
                               content_type="text/plain")
        except exception.Forbidden as e:
            msg = (_("Forbidden to delete service: %s") %
                   utils.exception_to_str(e))
            LOG.warning(msg)
            raise HTTPForbidden(explanation=msg,
                                request=req,
                                content_type="text/plain")
        except exception.InUseByStore as e:
            msg = (_("service %(id)s could not be deleted "
                     "because it is in use: "
                     "%(exc)s") % {"id": id, "exc": utils.exception_to_str(e)})
            LOG.warning(msg)
            raise HTTPConflict(explanation=msg,
                               request=req,
                               content_type="text/plain")
        else:
            # self.notifier.info('service.delete', service)
            return Response(body='', status=200)

    @utils.mutating
    def get_service(self, req, id):
        """
        Returns metadata about an service in the HTTP headers of the
        response object

        :param req: The WSGI/Webob Request object
        :param id: The opaque service identifier

        :raises HTTPNotFound if service metadata is not available to user
        """
        self._enforce(req, 'get_service')
        service_meta = self.get_service_meta_or_404(req, id)
        return {'service_meta': service_meta}

    def detail(self, req):
        """
        Returns detailed information for all available services

        :param req: The WSGI/Webob Request object
        :retval The response body is a mapping of the following form::

            {'services': [
                {'id': <ID>,
                 'name': <NAME>,
                 'description': <DESCRIPTION>,
                 'created_at': <TIMESTAMP>,
                 'updated_at': <TIMESTAMP>,
                 'deleted_at': <TIMESTAMP>|<NONE>,}, ...
            ]}
        """
        self._enforce(req, 'get_services')
        params = self._get_query_params(req)
        try:
            services = registry.get_services_detail(req.context, **params)
        except exception.Invalid as e:
            raise HTTPBadRequest(explanation=e.msg, request=req)
        return dict(services=services)

    @utils.mutating
    def update_service(self, req, id, service_meta):
        """
        Updates an existing service with the registry.

        :param request: The WSGI/Webob Request object
        :param id: The opaque image identifier

        :retval Returns the updated image information as a mapping
        """
        self._enforce(req, 'modify_image')
        orig_service_meta = self.get_service_meta_or_404(req, id)

        # Do not allow any updates on a deleted image.
        # Fix for LP Bug #1060930
        if orig_service_meta['deleted']:
            msg = _("Forbidden to update deleted service.")
            raise HTTPForbidden(explanation=msg,
                                request=req,
                                content_type="text/plain")
        try:
            service_meta = registry.update_service_metadata(req.context,
                                                            id,
                                                            service_meta)

        except exception.Invalid as e:
            msg = (_("Failed to update service metadata. Got error: %s") %
                   utils.exception_to_str(e))
            LOG.warning(msg)
            raise HTTPBadRequest(explanation=msg,
                                 request=req,
                                 content_type="text/plain")
        except exception.NotFound as e:
            msg = (_("Failed to find service to update: %s") %
                   utils.exception_to_str(e))
            LOG.warning(msg)
            raise HTTPNotFound(explanation=msg,
                               request=req,
                               content_type="text/plain")
        except exception.Forbidden as e:
            msg = (_("Forbidden to update service: %s") %
                   utils.exception_to_str(e))
            LOG.warning(msg)
            raise HTTPForbidden(explanation=msg,
                                request=req,
                                content_type="text/plain")
        except (exception.Conflict, exception.Duplicate) as e:
            LOG.warning(utils.exception_to_str(e))
            raise HTTPConflict(body=_('Host operation conflicts'),
                               request=req,
                               content_type='text/plain')
        else:
            self.notifier.info('service.update', service_meta)

        return {'service_meta': service_meta}


class ServiceDeserializer(wsgi.JSONRequestDeserializer):
    """Handles deserialization of specific controller method requests."""

    def _deserialize(self, request):
        result = {}
        result["service_meta"] = utils.get_service_meta(request)
        return result

    def add_service(self, request):
        return self._deserialize(request)

    def update_service(self, request):
        return self._deserialize(request)


class ServiceSerializer(wsgi.JSONResponseSerializer):
    """Handles serialization of specific controller method responses."""

    def __init__(self):
        self.notifier = notifier.Notifier()

    def add_service(self, response, result):
        service_meta = result['service_meta']
        response.status = 201
        response.headers['Content-Type'] = 'application/json'
        response.body = self.to_json(dict(service=service_meta))
        return response

    def delete_service(self, response, result):
        service_meta = result['service_meta']
        response.status = 201
        response.headers['Content-Type'] = 'application/json'
        response.body = self.to_json(dict(service=service_meta))
        return response

    def get_service(self, response, result):
        service_meta = result['service_meta']
        response.status = 201
        response.headers['Content-Type'] = 'application/json'
        response.body = self.to_json(dict(service=service_meta))
        return response


def create_resource():
    """Services resource factory method"""
    deserializer = ServiceDeserializer()
    serializer = ServiceSerializer()
    return wsgi.Resource(Controller(), deserializer, serializer)