Skip to content

feat: allow django permissions in actions #1230

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions docs/actions/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,43 @@ class UserAdmin(ModelAdmin):
pass
```

## Permissions

Unfold provides two distinct ways to handle permissions for actions:

1. **ModelAdmin Method-based Permissions**
- Define a permission check method in your ModelAdmin class
- The method name should follow the pattern `has_{permission_name}_permission`
- This method receives the request and can optionally receive the object instance
- Example: `has_custom_action_permission` for a permission named "custom_action"

2. **Django Built-in Permissions**
- Use Django's permission system with the format `app_label.permission_codename`
- These are standard Django permissions defined in your models
- **Note:** When using built-in permissions (containing a dot in the string), the permission check will not receive the object instance during detail view checks

```python
from django.contrib import admin
from django.contrib.auth.models import User

from unfold.admin import ModelAdmin
from unfold.decorators import action


@admin.register(User)
class UserAdmin(ModelAdmin):
@action(
description="Custom action",
permissions=["custom_action", "auth.view_user"] # Using both permission types
)
def custom_action(self, request, queryset):
pass

def has_custom_action_permission(self, request, obj=None):
# Custom permission logic here
return request.user.is_superuser
```

## Icon support

Unfold supports custom icons for actions. Icons are supported for all actions types. You can set the icon for an action by providing `icon` parameter to the `@action` decorator.
Expand Down
26 changes: 24 additions & 2 deletions src/unfold/checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

from django.contrib.admin.checks import ModelAdminChecks
from django.contrib.admin.options import BaseModelAdmin
from django.contrib.auth.models import Permission
from django.core import checks

from .dataclasses import UnfoldAction
from unfold.dataclasses import UnfoldAction


class UnfoldModelAdminChecks(ModelAdminChecks):
Expand All @@ -29,14 +30,35 @@ def _check_unfold_action_permission_methods(self, obj: Any) -> list[checks.Error
for action in actions:
if not hasattr(action.method, "allowed_permissions"):
continue

for permission in action.method.allowed_permissions:
# Check the existence of Django permission
if "." in permission:
app_label, codename = permission.split(".")

if not Permission.objects.filter(
content_type__app_label=app_label,
codename=codename,
).exists():
errors.append(
checks.Error(
f"@action decorator on {action.method.original_function_name}() in class {obj.__class__.__name__} specifies permission {permission} which does not exists.",
obj=obj.__class__,
id="admin.E129",
)
)

continue

# Check the permission method existence
method_name = f"has_{permission}_permission"
if not hasattr(obj, method_name):
errors.append(
checks.Error(
f"{obj.__class__.__name__} must define a {method_name}() method for the {action.method.__name__} action.",
f"{obj.__class__.__name__} must define a {method_name}() method for the {action.method.original_function_name}() action.",
obj=obj.__class__,
id="admin.E129",
)
)

return errors
43 changes: 28 additions & 15 deletions src/unfold/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
from django.http import HttpRequest, HttpResponse

from unfold.enums import ActionVariant

from .typing import ActionFunction
from unfold.typing import ActionFunction


def action(
Expand All @@ -30,13 +29,19 @@ def inner(
**kwargs,
) -> Optional[HttpResponse]:
if permissions:
permission_checks = (
getattr(model_admin, f"has_{permission}_permission")
for permission in permissions
)
# Permissions methods have following syntax: has_<some>_permission(self, request, obj=None):
# But obj is not examined by default in django admin and it would also require additional
# fetch from database, therefore it is not supported yet
permission_rules = []

for permission in permissions:
if "." in permission:
permission_rules.append(permission)
else:
# Permissions methods have following syntax: has_<some>_permission(self, request, obj=None):
# But obj is not examined by default in django admin and it would also require additional
# fetch from database, therefore it is not supported yet
permission_rules.append(
getattr(model_admin, f"has_{permission}_permission")
)

has_detail_action = func.__name__ in model_admin._extract_action_names(
model_admin.actions_detail
)
Expand All @@ -47,12 +52,19 @@ def inner(
)
)

if not all(
has_permission(request, kwargs.get("object_id"))
if has_detail_action or has_submit_line_action
else has_permission(request)
for has_permission in permission_checks
):
permission_checks = []

for permission_rule in permission_rules:
if isinstance(permission_rule, str) and "." in permission_rule:
permission_checks.append(request.user.has_perm(permission_rule))
elif has_detail_action or has_submit_line_action:
permission_checks.append(
permission_rule(request, kwargs.get("object_id"))
)
else:
permission_checks.append(permission_rule(request))

if not all(permission_checks):
raise PermissionDenied
return func(model_admin, request, *args, **kwargs)

Expand All @@ -74,6 +86,7 @@ def inner(
inner.variant = ActionVariant.DEFAULT

inner.attrs = attrs or {}
inner.original_function_name = func.__name__
return inner

if function is None:
Expand Down
36 changes: 22 additions & 14 deletions src/unfold/mixins/action_model_admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -316,19 +316,27 @@ def _filter_unfold_actions_by_permissions(
filtered_actions.append(action)
continue

permission_checks = (
getattr(self, f"has_{permission}_permission")
for permission in action.method.allowed_permissions
)

if object_id:
if all(
has_permission(request, object_id)
for has_permission in permission_checks
):
filtered_actions.append(action)
else:
if all(has_permission(request) for has_permission in permission_checks):
filtered_actions.append(action)
permission_rules = []

for permission in action.method.allowed_permissions:
if "." in permission:
permission_rules.append(permission)
else:
permission_rules.append(
getattr(self, f"has_{permission}_permission")
)

permission_checks = []

for permission_rule in permission_rules:
if isinstance(permission_rule, str) and "." in permission_rule:
permission_checks.append(request.user.has_perm(permission_rule))
elif object_id:
permission_checks.append(permission_rule(request, object_id))
else:
permission_checks.append(permission_rule(request))

if all(permission_checks):
filtered_actions.append(action)

return filtered_actions
Loading