etesync-server/etebase_server/django/utils.py

import typing as t
from dataclasses import dataclass

from django.db.models import QuerySet
from django.core.exceptions import PermissionDenied
from etebase_server.myauth.models import UserType, get_typed_user_model

from . import app_settings


User = get_typed_user_model()


@dataclass
class CallbackContext:
    """Class for passing extra context to callbacks"""

    url_kwargs: t.Dict[str, t.Any]
    user: t.Optional[UserType] = None


def get_user_queryset(queryset: QuerySet[UserType], context: CallbackContext) -> QuerySet[UserType]:
    custom_func = app_settings.GET_USER_QUERYSET_FUNC
    if custom_func is not None:
        return custom_func(queryset, context)
    return queryset


def create_user(context: CallbackContext, *args, **kwargs) -> UserType:
    custom_func = app_settings.CREATE_USER_FUNC
    if custom_func is not None:
        return custom_func(context, *args, **kwargs)
    return User.objects.create_user(*args, **kwargs)


def create_user_blocked(*args, **kwargs):
    raise PermissionDenied("Signup is disabled for this server. Please refer to the README for more information.")