PermissionHandler.excludes() - Code Metrics - lambdalisue/django-permission - Measure and Improve Code Quality continuously with Scrutinizer

PermissionHandler.excludes() A
last analyzed 2017-03-28 05:50 UTC

↳ Parent: PermissionHandler

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
c	2
b	0
f	0
dl	0
loc	3
rs	10

# coding=utf-8
import collections
from permission.utils.permissions import get_app_perms
from permission.utils.permissions import get_model_perms


class PermissionHandler(object):
    """
    Abstract permission handler class
    """
    _includes = None
    _excludes = None

    @property
    def includes(self):
        return self._includes

    @includes.setter
    def includes(self, value):
        # clear cache
        if hasattr(self, '_perms_cache'):
            del self._perms_cache
        self._includes = value

    @property
    def excludes(self):
        return self._excludes

    @excludes.setter
    def excludes(self, value):
        # clear cache
        if hasattr(self, '_perms_cache'):
            del self._perms_cache
        self._excludes = value

    def __init__(self, model_or_app_label):
        """
        Constructor

        Parameters
        ----------
        model_or_app_label : django model class or string
            A django model class or application label string.
            Use django model class for model level permission and application
            label for application level permission.
        """
        if isinstance(model_or_app_label, str):
            self.app_label = model_or_app_label
            self.model = None
            if self.includes is None:
                self.includes = self._get_app_perms
        else:
            self.app_label = model_or_app_label._meta.app_label
            self.model = model_or_app_label
            self.model._permission_handler = self
            if self.includes is None:
                self.includes = self._get_model_perms

    def _get_app_perms(self, *args):
        """
        Get permissions related to the application specified in constructor

        Returns
        -------
        set
            A set instance of `app_label.codename` formatted permission strings
        """
        if not hasattr(self, '_app_perms_cache'):
            self._app_perms_cache = get_app_perms(self.app_label)
        return self._app_perms_cache

    def _get_model_perms(self, *args):
        """
        Get permissions related to the model specified in constructor

        Returns
        -------
        set
            A set instance of `app_label.codename` formatted permission strings
        """
        if not hasattr(self, '_model_perms_cache'):
            if self.model is None:
                self._model_perms_cache = set()
            else:
                self._model_perms_cache = get_model_perms(self.model)
        return self._model_perms_cache

    def get_supported_permissions(self):
        """
        Get permissions which this handler can treat.
        Specified with :attr:`includes` and :attr:`excludes` of this instance.

        Returns
        -------
        set
            A set instance of `app_label.codename` formatted permission strings
        """
        if not hasattr(self, '_perms_cache'):
            if (self.includes and
                    isinstance(self.includes, collections.Callable)):
                includes = self.includes(self)
            else:
                includes = self.includes or []
            if (self.excludes and
                    isinstance(self.excludes, collections.Callable)):
                excludes = self.excludes(self)
            else:
                excludes = self.excludes or []
            includes = set(includes)
            excludes = set(excludes)
            includes = includes.difference(excludes)
            self._perms_cache = includes
        return self._perms_cache

    def get_supported_app_labels(self):
        """
        Get app labels which this handler can treat.
        Specified with :attr:`includes` and :attr:`excludes` of this instance.

        Returns
        -------
        set
            A set instance of app_label
        """
        get_app_label = lambda x: x.split(".", 1)[0]
        if not hasattr(self, '_app_labels_cache'):
            perms = self.get_supported_permissions()
            self._app_labels_cache = set([get_app_label(x) for x in perms])
        return self._app_labels_cache

    def has_perm(self, user_obj, perm, obj=None):
        """
        Check if user have permission (of object)

        Parameters
        ----------
        user_obj : django user model instance
            A django user model instance which be checked
        perm : string
            `app_label.codename` formatted permission string
        obj : None or django model instance
            None or django model instance for object permission

        Returns
        -------
        boolean
            Whether the specified user have specified permission (of specified
            object).

        .. note::
            Sub class must override this method.
        """
        raise NotImplementedError((
            "'%s' does not override `has_perm(user_obj, perm, obj=None)` "
            "method. Sub class must override this method."
        ) % self.__class__)

    def has_module_perms(self, user_obj, app_label):
        """
        Check if user have permission of specified app

        Parameters
        ----------
        user_obj : django user model instance
            A django user model instance which be checked
        app_label : string
            Django application name

        Returns
        -------
        boolean
            Whether the specified user have any permissions of specified app

        """
        cache_name = "_has_module_perms_%s_%s_cache" % (app_label, user_obj.pk)
        if hasattr(self, cache_name):
            return getattr(self, cache_name)
        if self.app_label != app_label:
            setattr(self, cache_name, False)
        else:
            for permission in self.get_supported_permissions():
                if user_obj.has_perm(permission):
                    setattr(self, cache_name, True)
                    return True
        setattr(self, cache_name, False)
        return False


class LogicalPermissionHandler(PermissionHandler):
    """
    Permission handler class which use permission logics to determine the
    permission
    """

    def __init__(self, model):
        """
        Constructor

        Parameters
        ----------
        model : django model class
            A django model class.

        .. note::
            LogicalPermissionHandler cannot treat application level permission
        """
        # logical permission handler cannot treat application level permission
        if isinstance(model, str):
            raise AttributeError((
                "'%s' cannot treat application level permission."
            ) % self.__class__)
        super(LogicalPermissionHandler, self).__init__(model)

    def has_perm(self, user_obj, perm, obj=None):
        """
        Check if user have permission (of object) based on
        specified models's ``_permission_logics`` attribute.

        The result will be stored in user_obj as a cache to reduce method call.

        Parameters
        ----------
        user_obj : django user model instance
            A django user model instance which be checked
        perm : string
            `app_label.codename` formatted permission string
        obj : None or django model instance
            None or django model instance for object permission

        Returns
        -------
        boolean
            Whether the specified user have specified permission (of specified
            object).
        """
        if perm not in self.get_supported_permissions():
            return False
        # use cache to reduce method call
        CACHE_NAME = '_logical_perms_cache'
        if not hasattr(user_obj, CACHE_NAME):
            setattr(user_obj, CACHE_NAME, {})
        cache = getattr(user_obj, CACHE_NAME)
        cachekey = "%s %s" % (perm, hash(obj))
        if cachekey not in cache:
            cache[cachekey] = self._has_perm(user_obj, perm, obj)
        return cache[cachekey]

    def _has_perm(self, user_obj, perm, obj=None):
        if perm not in self.get_supported_permissions():
            return False
        for permission_logic in getattr(self.model,
                                        '_permission_logics', set()):
            if permission_logic.has_perm(user_obj, perm, obj):
                return True
        return False


1			# coding=utf-8
2			import collections
3			from permission.utils.permissions import get_app_perms
4			from permission.utils.permissions import get_model_perms
5
6
7			class PermissionHandler(object):
8			"""
9			Abstract permission handler class
10			"""
11			_includes = None
12			_excludes = None
13
14			@property
15			def includes(self):
16			return self._includes
17
18			@includes.setter
19			def includes(self, value):
20			# clear cache
21			if hasattr(self, '_perms_cache'):
22			del self._perms_cache
23			self._includes = value
24
25			@property
26			def excludes(self):
27			return self._excludes
28
29			@excludes.setter
30			def excludes(self, value):
31			# clear cache
32			if hasattr(self, '_perms_cache'):
33			del self._perms_cache
34			self._excludes = value
35
36			def __init__(self, model_or_app_label):
37			"""
38			Constructor
39
40			Parameters
41			----------
42			model_or_app_label : django model class or string
43			A django model class or application label string.
44			Use django model class for model level permission and application
45			label for application level permission.
46			"""
47			if isinstance(model_or_app_label, str):
48			self.app_label = model_or_app_label
49			self.model = None
50			if self.includes is None:
51			self.includes = self._get_app_perms
52			else:
53			self.app_label = model_or_app_label._meta.app_label
54			self.model = model_or_app_label
55			self.model._permission_handler = self
56			if self.includes is None:
57			self.includes = self._get_model_perms
58
59			def _get_app_perms(self, *args):
60			"""
61			Get permissions related to the application specified in constructor
62
63			Returns
64			-------
65			set
66			A set instance of `app_label.codename` formatted permission strings
67			"""
68			if not hasattr(self, '_app_perms_cache'):
69			self._app_perms_cache = get_app_perms(self.app_label)
70			return self._app_perms_cache
71
72			def _get_model_perms(self, *args):
73			"""
74			Get permissions related to the model specified in constructor
75
76			Returns
77			-------
78			set
79			A set instance of `app_label.codename` formatted permission strings
80			"""
81			if not hasattr(self, '_model_perms_cache'):
82			if self.model is None:
83			self._model_perms_cache = set()
84			else:
85			self._model_perms_cache = get_model_perms(self.model)
86			return self._model_perms_cache
87
88			def get_supported_permissions(self):
89			"""
90			Get permissions which this handler can treat.
91			Specified with :attr:`includes` and :attr:`excludes` of this instance.
92
93			Returns
94			-------
95			set
96			A set instance of `app_label.codename` formatted permission strings
97			"""
98			if not hasattr(self, '_perms_cache'):
99			if (self.includes and
100			isinstance(self.includes, collections.Callable)):
101			includes = self.includes(self)
102			else:
103			includes = self.includes or []
104			if (self.excludes and
105			isinstance(self.excludes, collections.Callable)):
106			excludes = self.excludes(self)
107			else:
108			excludes = self.excludes or []
109			includes = set(includes)
110			excludes = set(excludes)
111			includes = includes.difference(excludes)
112			self._perms_cache = includes
113			return self._perms_cache
114
115			def get_supported_app_labels(self):
116			"""
117			Get app labels which this handler can treat.
118			Specified with :attr:`includes` and :attr:`excludes` of this instance.
119
120			Returns
121			-------
122			set
123			A set instance of app_label
124			"""
125			get_app_label = lambda x: x.split(".", 1)[0]
126			if not hasattr(self, '_app_labels_cache'):
127			perms = self.get_supported_permissions()
128			self._app_labels_cache = set([get_app_label(x) for x in perms])
129			return self._app_labels_cache
130
131			def has_perm(self, user_obj, perm, obj=None):
132			"""
133			Check if user have permission (of object)
134
135			Parameters
136			----------
137			user_obj : django user model instance
138			A django user model instance which be checked
139			perm : string
140			`app_label.codename` formatted permission string
141			obj : None or django model instance
142			None or django model instance for object permission
143
144			Returns
145			-------
146			boolean
147			Whether the specified user have specified permission (of specified
148			object).
149
150			.. note::
151			Sub class must override this method.
152			"""
153			raise NotImplementedError((
154			"'%s' does not override `has_perm(user_obj, perm, obj=None)` "
155			"method. Sub class must override this method."
156			) % self.__class__)
157
158			def has_module_perms(self, user_obj, app_label):
159			"""
160			Check if user have permission of specified app
161
162			Parameters
163			----------
164			user_obj : django user model instance
165			A django user model instance which be checked
166			app_label : string
167			Django application name
168
169			Returns
170			-------
171			boolean
172			Whether the specified user have any permissions of specified app
173
174			"""
175			cache_name = "_has_module_perms_%s_%s_cache" % (app_label, user_obj.pk)
176			if hasattr(self, cache_name):
177			return getattr(self, cache_name)
178			if self.app_label != app_label:
179			setattr(self, cache_name, False)
180			else:
181			for permission in self.get_supported_permissions():
182			if user_obj.has_perm(permission):
183			setattr(self, cache_name, True)
184			return True
185			setattr(self, cache_name, False)
186			return False
187
188
189			class LogicalPermissionHandler(PermissionHandler):
190			"""
191			Permission handler class which use permission logics to determine the
192			permission
193			"""
194
195			def __init__(self, model):
196			"""
197			Constructor
198
199			Parameters
200			----------
201			model : django model class
202			A django model class.
203
204			.. note::
205			LogicalPermissionHandler cannot treat application level permission
206			"""
207			# logical permission handler cannot treat application level permission
208			if isinstance(model, str):
209			raise AttributeError((
210			"'%s' cannot treat application level permission."
211			) % self.__class__)
212			super(LogicalPermissionHandler, self).__init__(model)
213
214			def has_perm(self, user_obj, perm, obj=None):
215			"""
216			Check if user have permission (of object) based on
217			specified models's ``_permission_logics`` attribute.
218
219			The result will be stored in user_obj as a cache to reduce method call.
220
221			Parameters
222			----------
223			user_obj : django user model instance
224			A django user model instance which be checked
225			perm : string
226			`app_label.codename` formatted permission string
227			obj : None or django model instance
228			None or django model instance for object permission
229
230			Returns
231			-------
232			boolean
233			Whether the specified user have specified permission (of specified
234			object).
235			"""
236			if perm not in self.get_supported_permissions():
237			return False
238			# use cache to reduce method call
239			CACHE_NAME = '_logical_perms_cache'
240			if not hasattr(user_obj, CACHE_NAME):
241			setattr(user_obj, CACHE_NAME, {})
242			cache = getattr(user_obj, CACHE_NAME)
243			cachekey = "%s %s" % (perm, hash(obj))
244			if cachekey not in cache:
245			cache[cachekey] = self._has_perm(user_obj, perm, obj)
246			return cache[cachekey]
247
248			def _has_perm(self, user_obj, perm, obj=None):
249			if perm not in self.get_supported_permissions():
250			return False
251			for permission_logic in getattr(self.model,
252			'_permission_logics', set()):
253			if permission_logic.has_perm(user_obj, perm, obj):
254			return True
255			return False
256

lambdalisue / django-permission

GitHub Access Token became invalid

PermissionHandler.excludes() A last analyzed 2017-03-28 05:50 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PermissionHandler.excludes() A
last analyzed 2017-03-28 05:50 UTC