# coding=utf-8
"""
Permission logic module for collaborators based permission system
"""
__author__ = 'Alisue <lambdalisue@hashnote.net>'
from permission.conf import settings
from permission.logics.base import PermissionLogic
from permission.utils.permissions import get_perm_codename
[docs]class CollaboratorsPermissionLogic(PermissionLogic):
"""
Permission logic class for collaborators based permission system
"""
def __init__(self,
field_name=None,
any_permission=None,
change_permission=None,
delete_permission=None):
"""
Constructor
Parameters
----------
field_name : string
A field name of object which store the collaborators as django
relational fields for django user model
Default value will be taken from
``PERMISSION_DEFAULT_COLLABORATORS_PERMISSION_LOGIC_FIELD_NAME`` in
settings.
any_permission : boolean
True for give any permission of the specified object to the
collaborators.
Default value will be taken from
``PERMISSION_DEFAULT_COLLABORATORS_PERMISSION_LOGIC_ANY_PERMISSION``
in settings.
change_permission : boolean
True for give change permission of the specified object to the
collaborators.
It will be ignored if :attr:`any_permission` is True.
Default value will be taken from
``PERMISSION_DEFAULT_COLLABORATORS_PERMISSION_LOGIC_CHANGE_PERMISSION``
in settings.
delete_permission : boolean
True for give delete permission of the specified object to the
collaborators.
It will be ignored if :attr:`any_permission` is True.
Default value will be taken from
``PERMISSION_DEFAULT_COLLABORATORS_PERMISSION_LOGIC_DELETE_PERMISSION``
in settings.
"""
self.field_name = field_name
self.any_permission = any_permission
self.change_permission = change_permission
self.delete_permission = delete_permission
if self.field_name is None:
self.field_name = \
settings.PERMISSION_DEFAULT_CPL_FIELD_NAME
if self.any_permission is None:
self.any_permission = \
settings.PERMISSION_DEFAULT_CPL_ANY_PERMISSION
if self.change_permission is None:
self.change_permission = \
settings.PERMISSION_DEFAULT_CPL_CHANGE_PERMISSION
if self.delete_permission is None:
self.delete_permission = \
settings.PERMISSION_DEFAULT_CPL_DELETE_PERMISSION
[docs] def has_perm(self, user_obj, perm, obj=None):
"""
Check if user have permission (of object)
If no object is specified, it always return ``False`` so you need to
add *add* permission to users in normal way.
If an object is specified, it will return ``True`` if the user is
found in ``field_name`` of the object (e.g. ``obj.collaborators``).
So once the object store the user as a collaborator in
``field_name`` attribute (default: ``collaborators``), the collaborator
can change or delete the object (you can change this behavior to set
``any_permission``, ``change_permission`` or ``delete_permission``
attributes of this instance).
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
Wheter the specified user have specified permission (of specified
object).
"""
codename = get_perm_codename(perm)
if obj is None:
return False
elif user_obj.is_active:
collaborators = getattr(obj, self.field_name, None)
if collaborators and user_obj in collaborators.all():
if self.any_permission:
# have any kind of permissions to the obj
return True
if (self.change_permission and
codename.startswith('change_')):
return True
if (self.delete_permission and
codename.startswith('delete_')):
return True
return False