1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
|
"""Converters from Django models to data interchange formats and back."""
from rest_framework.serializers import ModelSerializer, PrimaryKeyRelatedField, ValidationError
from rest_framework.validators import UniqueTogetherValidator
from rest_framework_bulk import BulkSerializerMixin
from .models import (
AllowList,
BotSetting,
DeletedMessage,
DocumentationLink,
Infraction,
LogEntry,
MessageDeletionContext,
Nomination,
OffTopicChannelName,
OffensiveMessage,
Reminder,
Role,
Tag,
User,
)
class BotSettingSerializer(ModelSerializer):
"""A class providing (de-)serialization of `BotSetting` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = BotSetting
fields = ('name', 'data')
class DeletedMessageSerializer(ModelSerializer):
"""
A class providing (de-)serialization of `DeletedMessage` instances.
The serializer generally requires a valid `deletion_context` to be
given, which should be created beforehand. See the `DeletedMessage`
model for more information.
"""
author = PrimaryKeyRelatedField(
queryset=User.objects.all()
)
deletion_context = PrimaryKeyRelatedField(
queryset=MessageDeletionContext.objects.all(),
# This will be overridden in the `create` function
# of the deletion context serializer.
required=False
)
class Meta:
"""Metadata defined for the Django REST Framework."""
model = DeletedMessage
fields = (
'id', 'author',
'channel_id', 'content',
'embeds', 'deletion_context',
'attachments'
)
class MessageDeletionContextSerializer(ModelSerializer):
"""A class providing (de-)serialization of `MessageDeletionContext` instances."""
actor = PrimaryKeyRelatedField(queryset=User.objects.all(), allow_null=True)
deletedmessage_set = DeletedMessageSerializer(many=True)
class Meta:
"""Metadata defined for the Django REST Framework."""
model = MessageDeletionContext
fields = ('actor', 'creation', 'id', 'deletedmessage_set')
depth = 1
def create(self, validated_data: dict) -> MessageDeletionContext:
"""
Return a `MessageDeletionContext` based on the given data.
In addition to the normal attributes expected by the `MessageDeletionContext` model
itself, this serializer also allows for passing the `deletedmessage_set` element
which contains messages that were deleted as part of this context.
"""
messages = validated_data.pop('deletedmessage_set')
deletion_context = MessageDeletionContext.objects.create(**validated_data)
for message in messages:
DeletedMessage.objects.create(
deletion_context=deletion_context,
**message
)
return deletion_context
class DocumentationLinkSerializer(ModelSerializer):
"""A class providing (de-)serialization of `DocumentationLink` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = DocumentationLink
fields = ('package', 'base_url', 'inventory_url')
class AllowListSerializer(ModelSerializer):
"""A class providing (de-)serialization of `AllowList` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = AllowList
fields = ('id', 'created_at', 'updated_at', 'type', 'allowed', 'content')
class InfractionSerializer(ModelSerializer):
"""A class providing (de-)serialization of `Infraction` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = Infraction
fields = (
'id', 'inserted_at', 'expires_at', 'active', 'user', 'actor', 'type', 'reason', 'hidden'
)
validators = [
UniqueTogetherValidator(
queryset=Infraction.objects.filter(active=True),
fields=['user', 'type', 'active'],
message='This user already has an active infraction of this type.',
)
]
def validate(self, attrs: dict) -> dict:
"""Validate data constraints for the given data and abort if it is invalid."""
infr_type = attrs.get('type')
active = attrs.get('active')
if active and infr_type in ('note', 'warning', 'kick'):
raise ValidationError({'active': [f'{infr_type} infractions cannot be active.']})
expires_at = attrs.get('expires_at')
if expires_at and infr_type in ('kick', 'warning'):
raise ValidationError({'expires_at': [f'{infr_type} infractions cannot expire.']})
hidden = attrs.get('hidden')
if hidden and infr_type in ('superstar', 'warning'):
raise ValidationError({'hidden': [f'{infr_type} infractions cannot be hidden.']})
if not hidden and infr_type in ('note', ):
raise ValidationError({'hidden': [f'{infr_type} infractions must be hidden.']})
return attrs
class ExpandedInfractionSerializer(InfractionSerializer):
"""
A class providing expanded (de-)serialization of `Infraction` instances.
In addition to the fields of `Infraction` objects themselves, this
serializer also attaches the `user` and `actor` fields when serializing.
"""
def to_representation(self, instance: Infraction) -> dict:
"""Return the dictionary representation of this infraction."""
ret = super().to_representation(instance)
user = User.objects.get(id=ret['user'])
user_data = UserSerializer(user).data
ret['user'] = user_data
actor = User.objects.get(id=ret['actor'])
actor_data = UserSerializer(actor).data
ret['actor'] = actor_data
return ret
class LogEntrySerializer(ModelSerializer):
"""A class providing (de-)serialization of `LogEntry` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = LogEntry
fields = (
'application', 'logger_name', 'timestamp',
'level', 'module', 'line', 'message'
)
class OffTopicChannelNameSerializer(ModelSerializer):
"""A class providing (de-)serialization of `OffTopicChannelName` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = OffTopicChannelName
fields = ('name',)
def to_representation(self, obj: OffTopicChannelName) -> str:
"""
Return the representation of this `OffTopicChannelName`.
This only returns the name of the off topic channel name. As the model
only has a single attribute, it is unnecessary to create a nested dictionary.
Additionally, this allows off topic channel name routes to simply return an
array of names instead of objects, saving on bandwidth.
"""
return obj.name
class ReminderSerializer(ModelSerializer):
"""A class providing (de-)serialization of `Reminder` instances."""
author = PrimaryKeyRelatedField(queryset=User.objects.all())
class Meta:
"""Metadata defined for the Django REST Framework."""
model = Reminder
fields = ('active', 'author', 'jump_url', 'channel_id', 'content', 'expiration', 'id')
class RoleSerializer(ModelSerializer):
"""A class providing (de-)serialization of `Role` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = Role
fields = ('id', 'name', 'colour', 'permissions', 'position')
class TagSerializer(ModelSerializer):
"""A class providing (de-)serialization of `Tag` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = Tag
fields = ('title', 'embed')
class UserSerializer(BulkSerializerMixin, ModelSerializer):
"""A class providing (de-)serialization of `User` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = User
fields = ('id', 'name', 'discriminator', 'roles', 'in_guild')
depth = 1
class NominationSerializer(ModelSerializer):
"""A class providing (de-)serialization of `Nomination` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = Nomination
fields = (
'id', 'active', 'actor', 'reason', 'user',
'inserted_at', 'end_reason', 'ended_at')
class OffensiveMessageSerializer(ModelSerializer):
"""A class providing (de-)serialization of `OffensiveMessage` instances."""
class Meta:
"""Metadata defined for the Django REST Framework."""
model = OffensiveMessage
fields = ('id', 'channel_id', 'delete_date')
|
