| 1 |
from urllib.parse import urlsplit |
| 2 |
|
| 3 |
from django.conf import settings |
| 4 |
from django.contrib.auth import REDIRECT_FIELD_NAME |
| 5 |
from django.contrib.auth.views import redirect_to_login |
| 6 |
from django.core.exceptions import ImproperlyConfigured, PermissionDenied |
| 7 |
from django.shortcuts import resolve_url |
| 8 |
|
| 9 |
|
| 10 |
class AccessMixin: |
| 11 |
""" |
| 12 |
Abstract CBV mixin that gives access mixins the same customizable |
| 13 |
functionality. |
| 14 |
""" |
| 15 |
|
| 16 |
login_url = None |
| 17 |
permission_denied_message = "" |
| 18 |
raise_exception = False |
| 19 |
redirect_field_name = REDIRECT_FIELD_NAME |
| 20 |
|
| 21 |
def get_login_url(self): |
| 22 |
""" |
| 23 |
Override this method to override the login_url attribute. |
| 24 |
""" |
| 25 |
login_url = self.login_url or settings.LOGIN_URL |
| 26 |
if not login_url: |
| 27 |
raise ImproperlyConfigured( |
| 28 |
f"{self.__class__.__name__} is missing the login_url attribute. Define " |
| 29 |
f"{self.__class__.__name__}.login_url, settings.LOGIN_URL, or override " |
| 30 |
f"{self.__class__.__name__}.get_login_url()." |
| 31 |
) |
| 32 |
return str(login_url) |
| 33 |
|
| 34 |
def get_permission_denied_message(self): |
| 35 |
""" |
| 36 |
Override this method to override the permission_denied_message attribute. |
| 37 |
""" |
| 38 |
return self.permission_denied_message |
| 39 |
|
| 40 |
def get_redirect_field_name(self): |
| 41 |
""" |
| 42 |
Override this method to override the redirect_field_name attribute. |
| 43 |
""" |
| 44 |
return self.redirect_field_name |
| 45 |
|
| 46 |
def handle_no_permission(self): |
| 47 |
if self.raise_exception or self.request.user.is_authenticated: |
| 48 |
raise PermissionDenied(self.get_permission_denied_message()) |
| 49 |
|
| 50 |
path = self.request.build_absolute_uri() |
| 51 |
resolved_login_url = resolve_url(self.get_login_url()) |
| 52 |
# If the login url is the same scheme and net location then use the |
| 53 |
# path as the "next" url. |
| 54 |
login_scheme, login_netloc = urlsplit(resolved_login_url)[:2] |
| 55 |
current_scheme, current_netloc = urlsplit(path)[:2] |
| 56 |
if (not login_scheme or login_scheme == current_scheme) and ( |
| 57 |
not login_netloc or login_netloc == current_netloc |
| 58 |
): |
| 59 |
path = self.request.get_full_path() |
| 60 |
return redirect_to_login( |
| 61 |
path, |
| 62 |
resolved_login_url, |
| 63 |
self.get_redirect_field_name(), |
| 64 |
) |
| 65 |
|
| 66 |
|
| 67 |
class LoginRequiredMixin(AccessMixin): |
| 68 |
"""Verify that the current user is authenticated.""" |
| 69 |
|
| 70 |
def dispatch(self, request, *args, **kwargs): |
| 71 |
if not request.user.is_authenticated: |
| 72 |
return self.handle_no_permission() |
| 73 |
return super().dispatch(request, *args, **kwargs) |
| 74 |
|
| 75 |
|
| 76 |
class PermissionRequiredMixin(AccessMixin): |
| 77 |
"""Verify that the current user has all specified permissions.""" |
| 78 |
|
| 79 |
permission_required = None |
| 80 |
|
| 81 |
def get_permission_required(self): |
| 82 |
""" |
| 83 |
Override this method to override the permission_required attribute. |
| 84 |
Must return an iterable. |
| 85 |
""" |
| 86 |
if self.permission_required is None: |
| 87 |
raise ImproperlyConfigured( |
| 88 |
f"{self.__class__.__name__} is missing the " |
| 89 |
f"permission_required attribute. Define " |
| 90 |
f"{self.__class__.__name__}.permission_required, or override " |
| 91 |
f"{self.__class__.__name__}.get_permission_required()." |
| 92 |
) |
| 93 |
if isinstance(self.permission_required, str): |
| 94 |
perms = (self.permission_required,) |
| 95 |
else: |
| 96 |
perms = self.permission_required |
| 97 |
return perms |
| 98 |
|
| 99 |
def has_permission(self): |
| 100 |
""" |
| 101 |
Override this method to customize the way permissions are checked. |
| 102 |
""" |
| 103 |
perms = self.get_permission_required() |
| 104 |
return self.request.user.has_perms(perms) |
| 105 |
|
| 106 |
def dispatch(self, request, *args, **kwargs): |
| 107 |
if not self.has_permission(): |
| 108 |
return self.handle_no_permission() |
| 109 |
return super().dispatch(request, *args, **kwargs) |
| 110 |
|
| 111 |
|
| 112 |
class UserPassesTestMixin(AccessMixin): |
| 113 |
""" |
| 114 |
Deny a request with a permission error if the test_func() method returns |
| 115 |
False. |
| 116 |
""" |
| 117 |
|
| 118 |
def test_func(self): |
| 119 |
raise NotImplementedError( |
| 120 |
"{} is missing the implementation of the test_func() method.".format( |
| 121 |
self.__class__.__name__ |
| 122 |
) |
| 123 |
) |
| 124 |
|
| 125 |
def get_test_func(self): |
| 126 |
""" |
| 127 |
Override this method to use a different test_func method. |
| 128 |
""" |
| 129 |
return self.test_func |
| 130 |
|
| 131 |
def dispatch(self, request, *args, **kwargs): |
| 132 |
user_test_result = self.get_test_func()() |
| 133 |
if not user_test_result: |
| 134 |
return self.handle_no_permission() |
| 135 |
return super().dispatch(request, *args, **kwargs) |