Debian Codegraph @

django/contrib/admin/models.py

raw
1 import json
2 import warnings
3
4 from django.conf import settings
5 from django.contrib.admin.utils import quote
6 from django.contrib.contenttypes.models import ContentType
7 from django.db import models
8 from django.urls import NoReverseMatch, reverse
9 from django.utils import timezone
10 from django.utils.deprecation import RemovedInDjango60Warning
11 from django.utils.text import get_text_list
12 from django.utils.translation import gettext
13 from django.utils.translation import gettext_lazy as _
14
15 ADDITION = 1
16 CHANGE = 2
17 DELETION = 3
18
19 ACTION_FLAG_CHOICES = [
20 (ADDITION, _("Addition")),
21 (CHANGE, _("Change")),
22 (DELETION, _("Deletion")),
23 ]
24
25
26 class LogEntryManager(models.Manager):
27 use_in_migrations = True
28
29 def log_action(
30 self,
31 user_id,
32 content_type_id,
33 object_id,
34 object_repr,
35 action_flag,
36 change_message="",
37 ):
38 warnings.warn(
39 "LogEntryManager.log_action() is deprecated. Use log_actions() instead.",
40 RemovedInDjango60Warning,
41 stacklevel=2,
42 )
43 if isinstance(change_message, list):
44 change_message = json.dumps(change_message)
45 return self.model.objects.create(
46 user_id=user_id,
47 content_type_id=content_type_id,
48 object_id=str(object_id),
49 object_repr=object_repr[:200],
50 action_flag=action_flag,
51 change_message=change_message,
52 )
53
54 def log_actions(
55 self, user_id, queryset, action_flag, change_message="", *, single_object=False
56 ):
57 # RemovedInDjango60Warning.
58 if type(self).log_action != LogEntryManager.log_action:
59 warnings.warn(
60 "The usage of log_action() is deprecated. Implement log_actions() "
61 "instead.",
62 RemovedInDjango60Warning,
63 stacklevel=2,
64 )
65 return [
66 self.log_action(
67 user_id=user_id,
68 content_type_id=ContentType.objects.get_for_model(
69 obj, for_concrete_model=False
70 ).id,
71 object_id=obj.pk,
72 object_repr=str(obj),
73 action_flag=action_flag,
74 change_message=change_message,
75 )
76 for obj in queryset
77 ]
78
79 if isinstance(change_message, list):
80 change_message = json.dumps(change_message)
81
82 log_entry_list = [
83 self.model(
84 user_id=user_id,
85 content_type_id=ContentType.objects.get_for_model(
86 obj, for_concrete_model=False
87 ).id,
88 object_id=obj.pk,
89 object_repr=str(obj)[:200],
90 action_flag=action_flag,
91 change_message=change_message,
92 )
93 for obj in queryset
94 ]
95
96 if len(log_entry_list) == 1:
97 instance = log_entry_list[0]
98 instance.save()
99 if single_object:
100 return instance
101 return [instance]
102
103 return self.model.objects.bulk_create(log_entry_list)
104
105
106 class LogEntry(models.Model):
107 action_time = models.DateTimeField(
108 _("action time"),
109 default=timezone.now,
110 editable=False,
111 )
112 user = models.ForeignKey(
113 settings.AUTH_USER_MODEL,
114 models.CASCADE,
115 verbose_name=_("user"),
116 )
117 content_type = models.ForeignKey(
118 ContentType,
119 models.SET_NULL,
120 verbose_name=_("content type"),
121 blank=True,
122 null=True,
123 )
124 object_id = models.TextField(_("object id"), blank=True, null=True)
125 # Translators: 'repr' means representation
126 # (https://docs.python.org/library/functions.html#repr)
127 object_repr = models.CharField(_("object repr"), max_length=200)
128 action_flag = models.PositiveSmallIntegerField(
129 _("action flag"), choices=ACTION_FLAG_CHOICES
130 )
131 # change_message is either a string or a JSON structure
132 change_message = models.TextField(_("change message"), blank=True)
133
134 objects = LogEntryManager()
135
136 class Meta:
137 verbose_name = _("log entry")
138 verbose_name_plural = _("log entries")
139 db_table = "django_admin_log"
140 ordering = ["-action_time"]
141
142 def __repr__(self):
143 return str(self.action_time)
144
145 def __str__(self):
146 if self.is_addition():
147 return gettext("Added “%(object)s”.") % {"object": self.object_repr}
148 elif self.is_change():
149 return gettext("Changed “%(object)s” — %(changes)s") % {
150 "object": self.object_repr,
151 "changes": self.get_change_message(),
152 }
153 elif self.is_deletion():
154 return gettext("Deleted “%(object)s.”") % {"object": self.object_repr}
155
156 return gettext("LogEntry Object")
157
158 def is_addition(self):
159 return self.action_flag == ADDITION
160
161 def is_change(self):
162 return self.action_flag == CHANGE
163
164 def is_deletion(self):
165 return self.action_flag == DELETION
166
167 def get_change_message(self):
168 """
169 If self.change_message is a JSON structure, interpret it as a change
170 string, properly translated.
171 """
172 if self.change_message and self.change_message[0] == "[":
173 try:
174 change_message = json.loads(self.change_message)
175 except json.JSONDecodeError:
176 return self.change_message
177 messages = []
178 for sub_message in change_message:
179 if "added" in sub_message:
180 if sub_message["added"]:
181 sub_message["added"]["name"] = gettext(
182 sub_message["added"]["name"]
183 )
184 messages.append(
185 gettext("Added {name} “{object}”.").format(
186 **sub_message["added"]
187 )
188 )
189 else:
190 messages.append(gettext("Added."))
191
192 elif "changed" in sub_message:
193 sub_message["changed"]["fields"] = get_text_list(
194 [
195 gettext(field_name)
196 for field_name in sub_message["changed"]["fields"]
197 ],
198 gettext("and"),
199 )
200 if "name" in sub_message["changed"]:
201 sub_message["changed"]["name"] = gettext(
202 sub_message["changed"]["name"]
203 )
204 messages.append(
205 gettext("Changed {fields} for {name} “{object}”.").format(
206 **sub_message["changed"]
207 )
208 )
209 else:
210 messages.append(
211 gettext("Changed {fields}.").format(
212 **sub_message["changed"]
213 )
214 )
215
216 elif "deleted" in sub_message:
217 sub_message["deleted"]["name"] = gettext(
218 sub_message["deleted"]["name"]
219 )
220 messages.append(
221 gettext("Deleted {name} “{object}”.").format(
222 **sub_message["deleted"]
223 )
224 )
225
226 change_message = " ".join(msg[0].upper() + msg[1:] for msg in messages)
227 return change_message or gettext("No fields changed.")
228 else:
229 return self.change_message
230
231 def get_edited_object(self):
232 """Return the edited object represented by this log entry."""
233 return self.content_type.get_object_for_this_type(pk=self.object_id)
234
235 def get_admin_url(self):
236 """
237 Return the admin URL to edit the object represented by this log entry.
238 """
239 if self.content_type and self.object_id:
240 url_name = "admin:%s_%s_change" % (
241 self.content_type.app_label,
242 self.content_type.model,
243 )
244 try:
245 return reverse(url_name, args=(quote(self.object_id),))
246 except NoReverseMatch:
247 pass
248 return None