Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

added message for permission denied exceptions #720

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

added message for permission denied exceptions #720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion guardian/mixins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,12 @@ class SecureView(PermissionRequiredMixin, View):
`permission_required` - the permission to check of form "<app_label>.<permission codename>"
i.e. 'polls.can_vote' for a permission on a model in the polls application.


``PermissionRequiredMixin.permission_denied_message``

*Default*: ``None``. A string to pass to the ``PermisssionDenied`` exception.
Will be available in the 403 template context as ``exception``.

``PermissionRequiredMixin.accept_global_perms``

*Default*: ``False``, If accept_global_perms would be set to True, then
Expand All @@ -138,6 +144,7 @@ class SecureView(PermissionRequiredMixin, View):
return_403 = False
return_404 = False
raise_exception = False
permission_denied_message = None
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can make this be blank str '', and it would help with the get_permission_denied_message function to be simple.

accept_global_perms = False
any_perm = False

Expand All @@ -160,6 +167,16 @@ def get_required_permissions(self, request=None):
% self.permission_required)
return perms

def get_permission_denied_message(self):
"""
Returns the message to be passed to the ``PermissionDenied`` exception. By default,
it returns the value from the ``permission_denied_message`` attribute.
"""
message = ""
if isinstance(self.permission_denied_message, str):
message = self.permission_denied_message
return message
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And I think this function is a little complex.
In django.contrib.auth.mixins.PermissionRequiredMixin, we can find that it just return the self.permission_denied_message.

# in django/contrib/auth/mixins/PermissionRequiredMixin
    def get_permission_denied_message(self):
        """
        Override this method to override the permission_denied_message attribute.
        """
        return self.permission_denied_message


def get_permission_object(self):
if hasattr(self, 'permission_object'):
return self.permission_object
Expand All @@ -185,11 +202,12 @@ def check_permissions(self, request):
return_404=self.return_404,
accept_global_perms=self.accept_global_perms,
any_perm=self.any_perm,
permission_denied_message=self.get_permission_denied_message(),
)
if forbidden:
self.on_permission_check_fail(request, forbidden, obj=obj)
if forbidden and self.raise_exception:
raise PermissionDenied()
raise PermissionDenied(self.get_permission_denied_message())
return forbidden

def on_permission_check_fail(self, request, response, obj=None):
Expand Down
4 changes: 2 additions & 2 deletions guardian/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def get_identity(identity):
def get_40x_or_None(request, perms, obj=None, login_url=None,
redirect_field_name=None, return_403=False,
return_404=False, accept_global_perms=False,
any_perm=False):
any_perm=False, permission_denied_message=""):
login_url = login_url or settings.LOGIN_URL
redirect_field_name = redirect_field_name or REDIRECT_FIELD_NAME

Expand All @@ -121,7 +121,7 @@ def get_40x_or_None(request, perms, obj=None, login_url=None,
response.status_code = 403
return response
elif guardian_settings.RAISE_403:
raise PermissionDenied
raise PermissionDenied(permission_denied_message)
return HttpResponseForbidden()
if return_404:
if guardian_settings.RENDER_404:
Expand Down