OpenSlides/openslides/utils/auth.py

90 lines
3.2 KiB
Python
Raw Normal View History

2017-08-23 20:51:06 +02:00
from typing import Optional, Union
from django.contrib.auth import get_user_model
from django.contrib.auth.models import AnonymousUser
2017-08-23 20:51:06 +02:00
from django.db.models import Model
from .collection import CollectionElement
2017-08-23 20:51:06 +02:00
def has_perm(user: Optional[CollectionElement], perm: str) -> bool:
"""
Checks that user has a specific permission.
2017-01-26 21:15:35 +01:00
User can be a CollectionElement of a user or None.
"""
2017-01-26 21:15:35 +01:00
group_collection_string = 'users/group' # This is the hard coded collection string for openslides.users.models.Group
# Convert user to right type
user = user_to_collection_user(user)
if user is None and not anonymous_is_enabled():
has_perm = False
elif user is None:
2017-01-26 21:15:35 +01:00
# Use the permissions from the default group with id 1.
default_group = CollectionElement.from_values(group_collection_string, 1)
has_perm = perm in default_group.get_full_data()['permissions']
else:
# Get all groups of the user and then see, if one group has the required
# permission. If the user has no groups, then use group 1.
group_ids = user.get_full_data()['groups_id'] or [1]
for group_id in group_ids:
2017-01-26 21:15:35 +01:00
group = CollectionElement.from_values(group_collection_string, group_id)
if perm in group.get_full_data()['permissions']:
has_perm = True
break
else:
has_perm = False
return has_perm
2017-08-23 20:51:06 +02:00
def anonymous_is_enabled() -> bool:
"""
2017-01-26 21:15:35 +01:00
Returns True if the anonymous user is enabled in the settings.
"""
return (CollectionElement.from_values('core/config', 'general_system_enable_anonymous')
.get_full_data()['value'])
2017-08-23 20:51:06 +02:00
AnyUser = Union[Model, CollectionElement, int, AnonymousUser, None]
def user_to_collection_user(user: AnyUser) -> Optional[CollectionElement]:
"""
2017-01-26 21:15:35 +01:00
Takes an object, that represents a user and converts it to a CollectionElement
or to None, if it is an anonymous user.
User can be
2017-01-26 21:15:35 +01:00
* an user object,
* a CollectionElement of an user,
* an user id or
* an anonymous user.
2017-01-26 21:15:35 +01:00
Raises an TypeError, if the given user object can not be converted.
"""
2017-01-26 21:15:35 +01:00
User = get_user_model()
if user is None:
# Nothing to do
pass
2017-01-26 21:15:35 +01:00
elif isinstance(user, CollectionElement) and user.collection_string == User.get_collection_string():
# Nothing to do
pass
elif isinstance(user, CollectionElement):
raise TypeError(
"Unsupported type for user. Only CollectionElements for users can be"
"used. Not {}".format(user.collection_string))
elif isinstance(user, int):
2017-01-26 21:15:35 +01:00
user = CollectionElement.from_values(User.get_collection_string(), user)
elif isinstance(user, AnonymousUser):
user = None
2017-01-26 21:15:35 +01:00
elif isinstance(user, User):
# Converts a user object to a collection element.
# from_instance can not be used because the user serializer loads
2017-01-26 21:15:35 +01:00
# the group from the db. So each call to from_instance(user) costs
# one db query.
2017-01-26 21:15:35 +01:00
user = CollectionElement.from_values(User.get_collection_string(), user.id)
else:
raise TypeError(
"Unsupported type for user. User {} has type {}.".format(user, type(user)))
return user