Skip to content

Admin

GuardedModelAdmin

Bases: GuardedModelAdminMixin, ModelAdmin

Provide views for managing object permissions on the Django admin panel.

Extends the django.contrib.admin.ModelAdmin class. It uses 'admin/guardian/model/change_form.html' as the default change_form_template attribute which is required for proper url (object permissions related) being shown at the model pages.

Attributes:

Name Type Description
obj_perms_manage_template str

Defaults to admin/guardian/model/obj_perms_manage.html

obj_perms_manage_user_template str

Defaults to admin/guardian/model/obj_perms_manage_user.html

obj_perms_manage_group_template str

Defaults to admin/guardian/model/obj_perms_manage_group.html

user_can_access_owned_objects_only bool

Defaults to False. If True, request.user would be used to filter out objects they don't own checking user field of used model - field name may be overridden by the user_owned_objects_field option.

user_can_access_owned_by_group_objects_only bool

Default: False If True, request.user is used to filter out objects her or his group doesn't own (checking if any group the user belongs to is set as group field of the object; name of the field can be changed by overriding group_owned_objects_field).

group_owned_objects_field str

Default: group Name of the field to check for group ownership.

include_object_permissions_urls bool

Default: True Added in version 1.2. If False guardian-specific URLs are NOT included in the admin

Warning

Setting user_can_access_owned_objects_only to True will NOT affect superusers! Admins would still see all items.

Warning

Setting user_can_access_owned_by_group_objects_only to True will NOT affect superusers! Admins would still see all items.

Example
# Just use GuardedModelAdmin instead of django.contrib.admin.ModelAdmin.

from django.contrib import admin
from guardian.admin import GuardedModelAdmin
from myapp.models import Author

class AuthorAdmin(GuardedModelAdmin):
    pass

admin.site.register(Author, AuthorAdmin)
Source code in guardian/admin.py
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
class GuardedModelAdmin(GuardedModelAdminMixin, admin.ModelAdmin):
    """Provide views for managing object permissions on the Django admin panel.

    Extends the `django.contrib.admin.ModelAdmin` class.
    It uses `'admin/guardian/model/change_form.html'` as the
    default `change_form_template` attribute which is required for proper
    url (object permissions related) being shown at the model pages.

    Attributes:
        obj_perms_manage_template (str): Defaults to `admin/guardian/model/obj_perms_manage.html`
        obj_perms_manage_user_template (str): Defaults to `admin/guardian/model/obj_perms_manage_user.html`
        obj_perms_manage_group_template (str): Defaults to `admin/guardian/model/obj_perms_manage_group.html`
        user_can_access_owned_objects_only (bool): Defaults to `False`.
            If `True`, `request.user` would be used to filter out objects they don't own
            checking `user` field of used model -
            field name may be overridden by the `user_owned_objects_field` option.
        user_can_access_owned_by_group_objects_only (bool): *Default*: `False`
            If `True`, `request.user` is used to filter out objects her or his group doesn't own
            (checking if any group the user belongs to is set as `group` field of the object;
            name of the field can be changed by overriding `group_owned_objects_field`).
        group_owned_objects_field (str): *Default*: `group`
            Name of the field to check for group ownership.
        include_object_permissions_urls (bool): *Default*: `True`
            Added in version 1.2.
            If `False` guardian-specific URLs are **NOT** included in the admin

    Warning:
       Setting `user_can_access_owned_objects_only` to `True` will **NOT** affect superusers!
       Admins would still see all items.

    Warning:
       Setting `user_can_access_owned_by_group_objects_only` to `True` will **NOT** affect superusers!
       Admins would still see all items.


    Example:
        ```python
        # Just use GuardedModelAdmin instead of django.contrib.admin.ModelAdmin.

        from django.contrib import admin
        from guardian.admin import GuardedModelAdmin
        from myapp.models import Author

        class AuthorAdmin(GuardedModelAdmin):
            pass

        admin.site.register(Author, AuthorAdmin)
        ```
    """

GuardedModelAdminMixin

Mixin helper for custom subclassing admin.ModelAdmin.

Source code in guardian/admin.py
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
class GuardedModelAdminMixin:
    """Mixin helper for custom subclassing `admin.ModelAdmin`."""

    change_form_template: str = "admin/guardian/model/change_form.html"
    obj_perms_manage_template: str = "admin/guardian/model/obj_perms_manage.html"
    obj_perms_manage_user_template: str = "admin/guardian/model/obj_perms_manage_user.html"
    obj_perms_manage_group_template: str = "admin/guardian/model/obj_perms_manage_group.html"
    user_can_access_owned_objects_only: bool = False
    user_owned_objects_field: str = "user"
    user_can_access_owned_by_group_objects_only: bool = False
    group_owned_objects_field: str = "group"
    include_object_permissions_urls: bool = True

    def get_queryset(self, request):
        qs = super().get_queryset(request)

        if request.user.is_superuser:
            return qs

        if self.user_can_access_owned_objects_only:
            filters = {self.user_owned_objects_field: request.user}
            qs = qs.filter(**filters)
        if self.user_can_access_owned_by_group_objects_only:
            qs_key = f"{self.group_owned_objects_field}__in"
            filters = {qs_key: request.user.groups.all()}
            qs = qs.filter(**filters)
        return qs

    def get_urls(self):
        """

        Extends standard admin model urls with the following:
        - `.../permissions/` under `app_mdodel_permissions` url name (params: object_pk)
        - `.../permissions/user-manage/<user_id>/` under `app_model_permissions_manage_user` url name (params: object_pk, user_pk)
        - `.../permissions/group-manage/<group_id>/` under `app_model_permissions_manage_group` url name (params: object_pk, group_pk)

        Note:
           `...` above are standard, instance detail url (i.e. `/admin/flatpages/1/`)

        """
        urls = super().get_urls()
        if self.include_object_permissions_urls:
            info = self.model._meta.app_label, self.model._meta.model_name
            myurls = [
                path(
                    "<object_pk>/permissions/",
                    view=self.admin_site.admin_view(self.obj_perms_manage_view),
                    name="%s_%s_permissions" % info,
                ),
                path(
                    "<object_pk>/permissions/user-manage/<user_id>/",
                    view=self.admin_site.admin_view(self.obj_perms_manage_user_view),
                    name="%s_%s_permissions_manage_user" % info,
                ),
                path(
                    "<object_pk>/permissions/group-manage/<group_id>/",
                    view=self.admin_site.admin_view(self.obj_perms_manage_group_view),
                    name="%s_%s_permissions_manage_group" % info,
                ),
            ]
            urls = myurls + urls
        return urls

    def get_obj_perms_base_context(self, request, obj):
        """Get context dict with common admin and object permissions related content.

        Returns context dictionary with common admin and object permissions
        related content. It uses AdminSite.each_context,
        making sure all required template vars are in the context.

        Returns:
            django template context
        """
        context = self.admin_site.each_context(request)
        context.update(
            {
                "adminform": {"model_admin": self},
                "media": self.media,
                "object": obj,
                "app_label": self.model._meta.app_label,
                "opts": self.model._meta,
                "original": str(obj),
                "has_change_permission": self.has_change_permission(request, obj),
                "model_perms": get_perms_for_model(obj),
                "title": _("Object permissions"),
            }
        )
        return context

    def obj_perms_manage_view(self, request, object_pk):
        """Main object permissions view.

        Presents all users and groups with any object permissions for the current model *instance*.
        Users or groups without object permissions for related *instance* would **not** be shown.
        To add or manage user or group, one should use links or forms presented within the page.
        """
        if not self.has_change_permission(request, None):
            post_url = reverse("admin:index", current_app=self.admin_site.name)
            return redirect(post_url)

        from django.contrib.admin.utils import unquote

        obj = get_object_or_404(self.get_queryset(request), pk=unquote(object_pk))
        users_perms = OrderedDict(
            sorted(
                get_users_with_perms(obj, attach_perms=True, with_group_users=False).items(),
                key=lambda user: getattr(user[0], get_user_model().USERNAME_FIELD),
            )
        )

        groups_perms = OrderedDict(
            sorted(get_groups_with_perms(obj, attach_perms=True).items(), key=lambda group: group[0].name)
        )

        if request.method == "POST" and "submit_manage_user" in request.POST:
            user_form = self.get_obj_perms_user_select_form(request)(request.POST)
            group_form = self.get_obj_perms_group_select_form(request)(request.POST)
            info = (
                self.admin_site.name,
                self.model._meta.app_label,
                self.model._meta.model_name,
            )
            if user_form.is_valid():
                user_id = user_form.cleaned_data["user"].pk
                url = reverse("%s:%s_%s_permissions_manage_user" % info, args=[obj.pk, user_id])
                return redirect(url)
        elif request.method == "POST" and "submit_manage_group" in request.POST:
            user_form = self.get_obj_perms_user_select_form(request)(request.POST)
            group_form = self.get_obj_perms_group_select_form(request)(request.POST)
            info = (
                self.admin_site.name,
                self.model._meta.app_label,
                self.model._meta.model_name,
            )
            if group_form.is_valid():
                group_id = group_form.cleaned_data["group"].id
                url = reverse("%s:%s_%s_permissions_manage_group" % info, args=[obj.pk, group_id])
                return redirect(url)
        else:
            user_form = self.get_obj_perms_user_select_form(request)()
            group_form = self.get_obj_perms_group_select_form(request)()

        context = self.get_obj_perms_base_context(request, obj)
        context["users_perms"] = users_perms
        context["groups_perms"] = groups_perms
        context["user_form"] = user_form
        context["group_form"] = group_form

        # https://github.com/django/django/commit/cf1f36bb6eb34fafe6c224003ad585a647f6117b
        request.current_app = self.admin_site.name

        return render(request, self.get_obj_perms_manage_template(), context)

    def get_obj_perms_manage_template(self):
        """
        Returns main object permissions admin template.  May be overridden if
        need to change it dynamically.

        Note:
           If `INSTALLED_APPS` contains `grappelli` this function would
           return `"admin/guardian/grappelli/obj_perms_manage.html"`.

        """
        if "grappelli" in settings.INSTALLED_APPS:
            return "admin/guardian/contrib/grappelli/obj_perms_manage.html"
        return self.obj_perms_manage_template

    def obj_perms_manage_user_view(self, request, object_pk, user_id):
        """Manages selected users' permissions for the current object."""
        if not self.has_change_permission(request, None):
            post_url = reverse("admin:index", current_app=self.admin_site.name)
            return redirect(post_url)

        user = get_object_or_404(get_user_model(), pk=user_id)
        obj = get_object_or_404(self.get_queryset(request), pk=object_pk)
        form_class = self.get_obj_perms_manage_user_form(request)
        form = form_class(user, obj, request.POST or None)

        if request.method == "POST" and form.is_valid():
            form.save_obj_perms()
            msg = gettext("Permissions saved.")
            messages.success(request, msg)
            info = (
                self.admin_site.name,
                self.model._meta.app_label,
                self.model._meta.model_name,
            )
            url = reverse("%s:%s_%s_permissions_manage_user" % info, args=[obj.pk, user.pk])
            return redirect(url)

        context = self.get_obj_perms_base_context(request, obj)
        context["user_obj"] = user
        context["user_perms"] = get_user_perms(user, obj)
        context["form"] = form

        request.current_app = self.admin_site.name

        return render(request, self.get_obj_perms_manage_user_template(), context)

    def get_obj_perms_manage_user_template(self) -> str:
        """Returns object permissions for user admin template.

        May be overridden if dynamic behavior is needed.

        Note:
           If `INSTALLED_APPS` contains "grappelli" this function returns
           `"admin/guardian/grappelli/obj_perms_manage_user.html"`.
           Else, it returns `self.obj_perms_manage_user_template`.
        """
        if "grappelli" in settings.INSTALLED_APPS:
            return "admin/guardian/contrib/grappelli/obj_perms_manage_user.html"
        return self.obj_perms_manage_user_template

    def get_obj_perms_user_select_form(self, request: HttpRequest) -> Type[forms.Form]:
        """Get the form class for selecting a user for permissions management.

        Parameters:
            request (HttpRequest): The HTTP request object.

        Returns:
            The form class for selecting a user for permissions management.
                Default is `UserManage`
        """
        return UserManage

    def get_obj_perms_group_select_form(self, request: HttpRequest) -> Type[forms.Form]:
        """Get the form class for group object permissions management.
        Parameters:
            request (HttpRequest): The HTTP request object.

        Returns:
            The form class for group object permissions management.
                Default is `GroupManage`
        """
        return GroupManage

    def get_obj_perms_manage_user_form(self, request: HttpRequest) -> Type[forms.Form]:
        """Get the form class for user object permissions management.

        Parameters:
            request (HttpRequest): The HTTP request object.

        Returns:
            The form class for user object permissions management.
                Default is `AdminUserObjectPermissionsForm`.
        """
        return AdminUserObjectPermissionsForm

    def obj_perms_manage_group_view(self, request, object_pk, group_id):
        """Manages selected groups' permissions for the current object."""
        if not self.has_change_permission(request, None):
            post_url = reverse("admin:index", current_app=self.admin_site.name)
            return redirect(post_url)

        obj = get_object_or_404(self.get_queryset(request), pk=object_pk)
        GroupModel = get_group_obj_perms_model(obj).group.field.related_model
        group = get_object_or_404(GroupModel, id=group_id)
        form_class = self.get_obj_perms_manage_group_form(request)
        form = form_class(group, obj, request.POST or None)

        if request.method == "POST" and form.is_valid():
            form.save_obj_perms()
            msg = gettext("Permissions saved.")
            messages.success(request, msg)
            info = (
                self.admin_site.name,
                self.model._meta.app_label,
                self.model._meta.model_name,
            )
            url = reverse("%s:%s_%s_permissions_manage_group" % info, args=[obj.pk, group.id])
            return redirect(url)

        context = self.get_obj_perms_base_context(request, obj)
        context["group_obj"] = group
        context["group_perms"] = get_group_perms(group, obj)
        context["form"] = form

        request.current_app = self.admin_site.name

        return render(request, self.get_obj_perms_manage_group_template(), context)

    def get_obj_perms_manage_group_template(self):
        """Returns object permissions for group admin template.

        May be overridden if dynamic behavior is needed.

        Returns:
            template name

        Note:
           If `INSTALLED_APPS` contains `grappelli` this function would
           return `"admin/guardian/grappelli/obj_perms_manage_group.html"`.
        """
        if "grappelli" in settings.INSTALLED_APPS:
            return "admin/guardian/contrib/grappelli/obj_perms_manage_group.html"
        return self.obj_perms_manage_group_template

    def get_obj_perms_manage_group_form(self, request):
        """Get the form class for group object permissions management.

        Parameters:
            request (HttpRequest): The HTTP request object.

        Returns:
            The form class for group object permissions management.
                Default is `AdminGroupObjectPermissionsForm`.
        """
        return AdminGroupObjectPermissionsForm

get_obj_perms_base_context(request, obj)

Get context dict with common admin and object permissions related content.

Returns context dictionary with common admin and object permissions related content. It uses AdminSite.each_context, making sure all required template vars are in the context.

Returns:

Type Description

django template context

Source code in guardian/admin.py
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def get_obj_perms_base_context(self, request, obj):
    """Get context dict with common admin and object permissions related content.

    Returns context dictionary with common admin and object permissions
    related content. It uses AdminSite.each_context,
    making sure all required template vars are in the context.

    Returns:
        django template context
    """
    context = self.admin_site.each_context(request)
    context.update(
        {
            "adminform": {"model_admin": self},
            "media": self.media,
            "object": obj,
            "app_label": self.model._meta.app_label,
            "opts": self.model._meta,
            "original": str(obj),
            "has_change_permission": self.has_change_permission(request, obj),
            "model_perms": get_perms_for_model(obj),
            "title": _("Object permissions"),
        }
    )
    return context

get_obj_perms_group_select_form(request)

Get the form class for group object permissions management. Parameters: request (HttpRequest): The HTTP request object.

Returns:

Type Description
Type[Form]

The form class for group object permissions management. Default is GroupManage

Source code in guardian/admin.py
342
343
344
345
346
347
348
349
350
351
def get_obj_perms_group_select_form(self, request: HttpRequest) -> Type[forms.Form]:
    """Get the form class for group object permissions management.
    Parameters:
        request (HttpRequest): The HTTP request object.

    Returns:
        The form class for group object permissions management.
            Default is `GroupManage`
    """
    return GroupManage

get_obj_perms_manage_group_form(request)

Get the form class for group object permissions management.

Parameters:

Name Type Description Default
request HttpRequest

The HTTP request object.

required

Returns:

Type Description

The form class for group object permissions management. Default is AdminGroupObjectPermissionsForm.

Source code in guardian/admin.py
414
415
416
417
418
419
420
421
422
423
424
def get_obj_perms_manage_group_form(self, request):
    """Get the form class for group object permissions management.

    Parameters:
        request (HttpRequest): The HTTP request object.

    Returns:
        The form class for group object permissions management.
            Default is `AdminGroupObjectPermissionsForm`.
    """
    return AdminGroupObjectPermissionsForm

get_obj_perms_manage_group_template()

Returns object permissions for group admin template.

May be overridden if dynamic behavior is needed.

Returns:

Type Description

template name

Note

If INSTALLED_APPS contains grappelli this function would return "admin/guardian/grappelli/obj_perms_manage_group.html".

Source code in guardian/admin.py
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
def get_obj_perms_manage_group_template(self):
    """Returns object permissions for group admin template.

    May be overridden if dynamic behavior is needed.

    Returns:
        template name

    Note:
       If `INSTALLED_APPS` contains `grappelli` this function would
       return `"admin/guardian/grappelli/obj_perms_manage_group.html"`.
    """
    if "grappelli" in settings.INSTALLED_APPS:
        return "admin/guardian/contrib/grappelli/obj_perms_manage_group.html"
    return self.obj_perms_manage_group_template

get_obj_perms_manage_template()

Returns main object permissions admin template. May be overridden if need to change it dynamically.

Note

If INSTALLED_APPS contains grappelli this function would return "admin/guardian/grappelli/obj_perms_manage.html".

Source code in guardian/admin.py
270
271
272
273
274
275
276
277
278
279
280
281
282
def get_obj_perms_manage_template(self):
    """
    Returns main object permissions admin template.  May be overridden if
    need to change it dynamically.

    Note:
       If `INSTALLED_APPS` contains `grappelli` this function would
       return `"admin/guardian/grappelli/obj_perms_manage.html"`.

    """
    if "grappelli" in settings.INSTALLED_APPS:
        return "admin/guardian/contrib/grappelli/obj_perms_manage.html"
    return self.obj_perms_manage_template

get_obj_perms_manage_user_form(request)

Get the form class for user object permissions management.

Parameters:

Name Type Description Default
request HttpRequest

The HTTP request object.

required

Returns:

Type Description
Type[Form]

The form class for user object permissions management. Default is AdminUserObjectPermissionsForm.

Source code in guardian/admin.py
353
354
355
356
357
358
359
360
361
362
363
def get_obj_perms_manage_user_form(self, request: HttpRequest) -> Type[forms.Form]:
    """Get the form class for user object permissions management.

    Parameters:
        request (HttpRequest): The HTTP request object.

    Returns:
        The form class for user object permissions management.
            Default is `AdminUserObjectPermissionsForm`.
    """
    return AdminUserObjectPermissionsForm

get_obj_perms_manage_user_template()

Returns object permissions for user admin template.

May be overridden if dynamic behavior is needed.

Note

If INSTALLED_APPS contains "grappelli" this function returns "admin/guardian/grappelli/obj_perms_manage_user.html". Else, it returns self.obj_perms_manage_user_template.

Source code in guardian/admin.py
316
317
318
319
320
321
322
323
324
325
326
327
328
def get_obj_perms_manage_user_template(self) -> str:
    """Returns object permissions for user admin template.

    May be overridden if dynamic behavior is needed.

    Note:
       If `INSTALLED_APPS` contains "grappelli" this function returns
       `"admin/guardian/grappelli/obj_perms_manage_user.html"`.
       Else, it returns `self.obj_perms_manage_user_template`.
    """
    if "grappelli" in settings.INSTALLED_APPS:
        return "admin/guardian/contrib/grappelli/obj_perms_manage_user.html"
    return self.obj_perms_manage_user_template

get_obj_perms_user_select_form(request)

Get the form class for selecting a user for permissions management.

Parameters:

Name Type Description Default
request HttpRequest

The HTTP request object.

required

Returns:

Type Description
Type[Form]

The form class for selecting a user for permissions management. Default is UserManage

Source code in guardian/admin.py
330
331
332
333
334
335
336
337
338
339
340
def get_obj_perms_user_select_form(self, request: HttpRequest) -> Type[forms.Form]:
    """Get the form class for selecting a user for permissions management.

    Parameters:
        request (HttpRequest): The HTTP request object.

    Returns:
        The form class for selecting a user for permissions management.
            Default is `UserManage`
    """
    return UserManage

get_urls()

Extends standard admin model urls with the following: - .../permissions/ under app_mdodel_permissions url name (params: object_pk) - .../permissions/user-manage/<user_id>/ under app_model_permissions_manage_user url name (params: object_pk, user_pk) - .../permissions/group-manage/<group_id>/ under app_model_permissions_manage_group url name (params: object_pk, group_pk)

Note

... above are standard, instance detail url (i.e. /admin/flatpages/1/)

Source code in guardian/admin.py
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
def get_urls(self):
    """

    Extends standard admin model urls with the following:
    - `.../permissions/` under `app_mdodel_permissions` url name (params: object_pk)
    - `.../permissions/user-manage/<user_id>/` under `app_model_permissions_manage_user` url name (params: object_pk, user_pk)
    - `.../permissions/group-manage/<group_id>/` under `app_model_permissions_manage_group` url name (params: object_pk, group_pk)

    Note:
       `...` above are standard, instance detail url (i.e. `/admin/flatpages/1/`)

    """
    urls = super().get_urls()
    if self.include_object_permissions_urls:
        info = self.model._meta.app_label, self.model._meta.model_name
        myurls = [
            path(
                "<object_pk>/permissions/",
                view=self.admin_site.admin_view(self.obj_perms_manage_view),
                name="%s_%s_permissions" % info,
            ),
            path(
                "<object_pk>/permissions/user-manage/<user_id>/",
                view=self.admin_site.admin_view(self.obj_perms_manage_user_view),
                name="%s_%s_permissions_manage_user" % info,
            ),
            path(
                "<object_pk>/permissions/group-manage/<group_id>/",
                view=self.admin_site.admin_view(self.obj_perms_manage_group_view),
                name="%s_%s_permissions_manage_group" % info,
            ),
        ]
        urls = myurls + urls
    return urls

obj_perms_manage_group_view(request, object_pk, group_id)

Manages selected groups' permissions for the current object.

Source code in guardian/admin.py
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
def obj_perms_manage_group_view(self, request, object_pk, group_id):
    """Manages selected groups' permissions for the current object."""
    if not self.has_change_permission(request, None):
        post_url = reverse("admin:index", current_app=self.admin_site.name)
        return redirect(post_url)

    obj = get_object_or_404(self.get_queryset(request), pk=object_pk)
    GroupModel = get_group_obj_perms_model(obj).group.field.related_model
    group = get_object_or_404(GroupModel, id=group_id)
    form_class = self.get_obj_perms_manage_group_form(request)
    form = form_class(group, obj, request.POST or None)

    if request.method == "POST" and form.is_valid():
        form.save_obj_perms()
        msg = gettext("Permissions saved.")
        messages.success(request, msg)
        info = (
            self.admin_site.name,
            self.model._meta.app_label,
            self.model._meta.model_name,
        )
        url = reverse("%s:%s_%s_permissions_manage_group" % info, args=[obj.pk, group.id])
        return redirect(url)

    context = self.get_obj_perms_base_context(request, obj)
    context["group_obj"] = group
    context["group_perms"] = get_group_perms(group, obj)
    context["form"] = form

    request.current_app = self.admin_site.name

    return render(request, self.get_obj_perms_manage_group_template(), context)

obj_perms_manage_user_view(request, object_pk, user_id)

Manages selected users' permissions for the current object.

Source code in guardian/admin.py
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
def obj_perms_manage_user_view(self, request, object_pk, user_id):
    """Manages selected users' permissions for the current object."""
    if not self.has_change_permission(request, None):
        post_url = reverse("admin:index", current_app=self.admin_site.name)
        return redirect(post_url)

    user = get_object_or_404(get_user_model(), pk=user_id)
    obj = get_object_or_404(self.get_queryset(request), pk=object_pk)
    form_class = self.get_obj_perms_manage_user_form(request)
    form = form_class(user, obj, request.POST or None)

    if request.method == "POST" and form.is_valid():
        form.save_obj_perms()
        msg = gettext("Permissions saved.")
        messages.success(request, msg)
        info = (
            self.admin_site.name,
            self.model._meta.app_label,
            self.model._meta.model_name,
        )
        url = reverse("%s:%s_%s_permissions_manage_user" % info, args=[obj.pk, user.pk])
        return redirect(url)

    context = self.get_obj_perms_base_context(request, obj)
    context["user_obj"] = user
    context["user_perms"] = get_user_perms(user, obj)
    context["form"] = form

    request.current_app = self.admin_site.name

    return render(request, self.get_obj_perms_manage_user_template(), context)

obj_perms_manage_view(request, object_pk)

Main object permissions view.

Presents all users and groups with any object permissions for the current model instance. Users or groups without object permissions for related instance would not be shown. To add or manage user or group, one should use links or forms presented within the page.

Source code in guardian/admin.py
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def obj_perms_manage_view(self, request, object_pk):
    """Main object permissions view.

    Presents all users and groups with any object permissions for the current model *instance*.
    Users or groups without object permissions for related *instance* would **not** be shown.
    To add or manage user or group, one should use links or forms presented within the page.
    """
    if not self.has_change_permission(request, None):
        post_url = reverse("admin:index", current_app=self.admin_site.name)
        return redirect(post_url)

    from django.contrib.admin.utils import unquote

    obj = get_object_or_404(self.get_queryset(request), pk=unquote(object_pk))
    users_perms = OrderedDict(
        sorted(
            get_users_with_perms(obj, attach_perms=True, with_group_users=False).items(),
            key=lambda user: getattr(user[0], get_user_model().USERNAME_FIELD),
        )
    )

    groups_perms = OrderedDict(
        sorted(get_groups_with_perms(obj, attach_perms=True).items(), key=lambda group: group[0].name)
    )

    if request.method == "POST" and "submit_manage_user" in request.POST:
        user_form = self.get_obj_perms_user_select_form(request)(request.POST)
        group_form = self.get_obj_perms_group_select_form(request)(request.POST)
        info = (
            self.admin_site.name,
            self.model._meta.app_label,
            self.model._meta.model_name,
        )
        if user_form.is_valid():
            user_id = user_form.cleaned_data["user"].pk
            url = reverse("%s:%s_%s_permissions_manage_user" % info, args=[obj.pk, user_id])
            return redirect(url)
    elif request.method == "POST" and "submit_manage_group" in request.POST:
        user_form = self.get_obj_perms_user_select_form(request)(request.POST)
        group_form = self.get_obj_perms_group_select_form(request)(request.POST)
        info = (
            self.admin_site.name,
            self.model._meta.app_label,
            self.model._meta.model_name,
        )
        if group_form.is_valid():
            group_id = group_form.cleaned_data["group"].id
            url = reverse("%s:%s_%s_permissions_manage_group" % info, args=[obj.pk, group_id])
            return redirect(url)
    else:
        user_form = self.get_obj_perms_user_select_form(request)()
        group_form = self.get_obj_perms_group_select_form(request)()

    context = self.get_obj_perms_base_context(request, obj)
    context["users_perms"] = users_perms
    context["groups_perms"] = groups_perms
    context["user_form"] = user_form
    context["group_form"] = group_form

    # https://github.com/django/django/commit/cf1f36bb6eb34fafe6c224003ad585a647f6117b
    request.current_app = self.admin_site.name

    return render(request, self.get_obj_perms_manage_template(), context)