¡@
OpenStack Study: context.py**** CubicPower OpenStack Study ****
# vim: tabstop=4 shiftwidth=4 softtabstop=4 # Copyright 2012 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. """Context: context for security/db session.""" import copy from datetime import datetime from neutron.db import api as db_api from neutron.openstack.common import context as common_context from neutron.openstack.common import local from neutron.openstack.common import log as logging from neutron import policy LOG = logging.getLogger(__name__)
**** CubicPower OpenStack Study **** class ContextBase(common_context.RequestContext): """Security context and request information. Represents the user taking a given action within the system. """
**** CubicPower OpenStack Study **** def __init__(self, user_id, tenant_id, is_admin=None, read_deleted="no", roles=None, timestamp=None, load_admin_roles=True, request_id=None, tenant_name=None, user_name=None, overwrite=True, **kwargs): """Object initialization. :param read_deleted: 'no' indicates deleted records are hidden, 'yes' indicates deleted records are visible, 'only' indicates that *only* deleted records are visible. :param overwrite: Set to False to ensure that the greenthread local copy of the index is not overwritten. :param kwargs: Extra arguments that might be present, but we ignore because they possibly came in from older rpc messages. """ super(ContextBase, self).__init__(user=user_id, tenant=tenant_id, is_admin=is_admin, request_id=request_id) self.user_name = user_name self.tenant_name = tenant_name self.read_deleted = read_deleted if not timestamp: timestamp = datetime.utcnow() self.timestamp = timestamp self._session = None self.roles = roles or [] if self.is_admin is None: self.is_admin = policy.check_is_admin(self) elif self.is_admin and load_admin_roles: # Ensure context is populated with admin roles admin_roles = policy.get_admin_roles() if admin_roles: self.roles = list(set(self.roles) | set(admin_roles)) # Allow openstack.common.log to access the context if overwrite or not hasattr(local.store, 'context'): local.store.context = self # Log only once the context has been configured to prevent # format errors. if kwargs: LOG.debug(_('Arguments dropped when creating ' 'context: %s'), kwargs) @property
**** CubicPower OpenStack Study **** def project_id(self): return self.tenant @property
**** CubicPower OpenStack Study **** def tenant_id(self): return self.tenant @tenant_id.setter
**** CubicPower OpenStack Study **** def tenant_id(self, tenant_id): self.tenant = tenant_id @property
**** CubicPower OpenStack Study **** def user_id(self): return self.user @user_id.setter
**** CubicPower OpenStack Study **** def user_id(self, user_id): self.user = user_id
**** CubicPower OpenStack Study **** def _get_read_deleted(self): return self._read_deleted
**** CubicPower OpenStack Study **** def _set_read_deleted(self, read_deleted): if read_deleted not in ('no', 'yes', 'only'): raise ValueError(_("read_deleted can only be one of 'no', " "'yes' or 'only', not %r") % read_deleted) self._read_deleted = read_deleted
**** CubicPower OpenStack Study **** def _del_read_deleted(self): del self._read_deleted read_deleted = property(_get_read_deleted, _set_read_deleted, _del_read_deleted)
**** CubicPower OpenStack Study **** def to_dict(self): return {'user_id': self.user_id, 'tenant_id': self.tenant_id, 'project_id': self.project_id, 'is_admin': self.is_admin, 'read_deleted': self.read_deleted, 'roles': self.roles, 'timestamp': str(self.timestamp), 'request_id': self.request_id, 'tenant': self.tenant, 'user': self.user, 'tenant_name': self.tenant_name, 'project_name': self.tenant_name, 'user_name': self.user_name, } @classmethod
**** CubicPower OpenStack Study **** def from_dict(cls, values): return cls(**values)
**** CubicPower OpenStack Study **** def elevated(self, read_deleted=None): """Return a version of this context with admin flag set.""" context = copy.copy(self) context.is_admin = True if 'admin' not in [x.lower() for x in context.roles]: context.roles.append('admin') if read_deleted is not None: context.read_deleted = read_deleted return context
**** CubicPower OpenStack Study **** class Context(ContextBase): @property
**** CubicPower OpenStack Study **** def session(self): if self._session is None: self._session = db_api.get_session() return self._session def get_admin_context(read_deleted="no", load_admin_roles=True): return Context(user_id=None, tenant_id=None, is_admin=True, read_deleted=read_deleted, load_admin_roles=load_admin_roles, overwrite=False) def get_admin_context_without_session(read_deleted="no"): return ContextBase(user_id=None, tenant_id=None, is_admin=True, read_deleted=read_deleted)
**** CubicPower OpenStack Study **** def get_admin_context(read_deleted="no", load_admin_roles=True): return Context(user_id=None, tenant_id=None, is_admin=True, read_deleted=read_deleted, load_admin_roles=load_admin_roles, overwrite=False)
**** CubicPower OpenStack Study **** def get_admin_context_without_session(read_deleted="no"): return ContextBase(user_id=None, tenant_id=None, is_admin=True, read_deleted=read_deleted)
|