Debian Codegraph @

django/contrib/contenttypes/admin.py

raw
1 from functools import partial
2
3 from django.contrib.admin.checks import InlineModelAdminChecks
4 from django.contrib.admin.options import InlineModelAdmin, flatten_fieldsets
5 from django.contrib.contenttypes.fields import GenericForeignKey
6 from django.contrib.contenttypes.forms import (
7 BaseGenericInlineFormSet,
8 generic_inlineformset_factory,
9 )
10 from django.core import checks
11 from django.core.exceptions import FieldDoesNotExist
12 from django.forms import ALL_FIELDS
13 from django.forms.models import modelform_defines_fields
14
15
16 class GenericInlineModelAdminChecks(InlineModelAdminChecks):
17 def _check_exclude_of_parent_model(self, obj, parent_model):
18 # There's no FK to exclude, so no exclusion checks are required.
19 return []
20
21 def _check_relation(self, obj, parent_model):
22 # There's no FK, but we do need to confirm that the ct_field and
23 # ct_fk_field are valid, and that they are part of a GenericForeignKey.
24
25 gfks = [
26 f
27 for f in obj.model._meta.private_fields
28 if isinstance(f, GenericForeignKey)
29 ]
30 if not gfks:
31 return [
32 checks.Error(
33 "'%s' has no GenericForeignKey." % obj.model._meta.label,
34 obj=obj.__class__,
35 id="admin.E301",
36 )
37 ]
38 else:
39 # Check that the ct_field and ct_fk_fields exist
40 try:
41 obj.model._meta.get_field(obj.ct_field)
42 except FieldDoesNotExist:
43 return [
44 checks.Error(
45 "'ct_field' references '%s', which is not a field on '%s'."
46 % (
47 obj.ct_field,
48 obj.model._meta.label,
49 ),
50 obj=obj.__class__,
51 id="admin.E302",
52 )
53 ]
54
55 try:
56 obj.model._meta.get_field(obj.ct_fk_field)
57 except FieldDoesNotExist:
58 return [
59 checks.Error(
60 "'ct_fk_field' references '%s', which is not a field on '%s'."
61 % (
62 obj.ct_fk_field,
63 obj.model._meta.label,
64 ),
65 obj=obj.__class__,
66 id="admin.E303",
67 )
68 ]
69
70 # There's one or more GenericForeignKeys; make sure that one of them
71 # uses the right ct_field and ct_fk_field.
72 for gfk in gfks:
73 if gfk.ct_field == obj.ct_field and gfk.fk_field == obj.ct_fk_field:
74 return []
75
76 return [
77 checks.Error(
78 "'%s' has no GenericForeignKey using content type field '%s' and "
79 "object ID field '%s'."
80 % (
81 obj.model._meta.label,
82 obj.ct_field,
83 obj.ct_fk_field,
84 ),
85 obj=obj.__class__,
86 id="admin.E304",
87 )
88 ]
89
90
91 class GenericInlineModelAdmin(InlineModelAdmin):
92 ct_field = "content_type"
93 ct_fk_field = "object_id"
94 formset = BaseGenericInlineFormSet
95
96 checks_class = GenericInlineModelAdminChecks
97
98 def get_formset(self, request, obj=None, **kwargs):
99 if "fields" in kwargs:
100 fields = kwargs.pop("fields")
101 else:
102 fields = flatten_fieldsets(self.get_fieldsets(request, obj))
103 exclude = [*(self.exclude or []), *self.get_readonly_fields(request, obj)]
104 if (
105 self.exclude is None
106 and hasattr(self.form, "_meta")
107 and self.form._meta.exclude
108 ):
109 # Take the custom ModelForm's Meta.exclude into account only if the
110 # GenericInlineModelAdmin doesn't define its own.
111 exclude.extend(self.form._meta.exclude)
112 exclude = exclude or None
113 can_delete = self.can_delete and self.has_delete_permission(request, obj)
114 defaults = {
115 "ct_field": self.ct_field,
116 "fk_field": self.ct_fk_field,
117 "form": self.form,
118 "formfield_callback": partial(self.formfield_for_dbfield, request=request),
119 "formset": self.formset,
120 "extra": self.get_extra(request, obj),
121 "can_delete": can_delete,
122 "can_order": False,
123 "fields": fields,
124 "min_num": self.get_min_num(request, obj),
125 "max_num": self.get_max_num(request, obj),
126 "exclude": exclude,
127 **kwargs,
128 }
129
130 base_model_form = defaults["form"]
131 can_change = self.has_change_permission(request, obj) if request else True
132 can_add = self.has_add_permission(request, obj) if request else True
133
134 class PermissionProtectedModelForm(base_model_form):
135 def has_changed(self):
136 # Protect against unauthorized edits.
137 if not can_change and not self.instance._state.adding:
138 return False
139 if not can_add and self.instance._state.adding:
140 return False
141 return super().has_changed()
142
143 defaults["form"] = PermissionProtectedModelForm
144
145 if defaults["fields"] is None and not modelform_defines_fields(
146 defaults["form"]
147 ):
148 defaults["fields"] = ALL_FIELDS
149
150 return generic_inlineformset_factory(self.model, **defaults)
151
152
153 class GenericStackedInline(GenericInlineModelAdmin):
154 template = "admin/edit_inline/stacked.html"
155
156
157 class GenericTabularInline(GenericInlineModelAdmin):
158 template = "admin/edit_inline/tabular.html"