/
views.py
450 lines (389 loc) · 14.5 KB
/
views.py
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
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
import datetime
import logging
from django.utils.translation import gettext_lazy as _
from django.core.cache import cache
from django.db.models.signals import post_save, post_delete
from dry_rest_permissions.generics import DRYPermissions
from rest_framework import filters
from rest_framework import status
from rest_framework.generics import (
ListAPIView,
ListCreateAPIView,
RetrieveUpdateAPIView,
RetrieveAPIView,
get_object_or_404,
)
from rest_framework.permissions import IsAuthenticatedOrReadOnly, AllowAny, IsAuthenticated
from rest_framework.response import Response
from rest_framework_extensions.cache.decorators import cache_response
from rest_framework_extensions.etag.decorators import etag
from rest_framework_extensions.key_constructor import bits
from rest_framework_extensions.key_constructor.constructors import DefaultKeyConstructor
from zds.api.bits import DJRF3xPaginationKeyBit, UpdatedAtKeyBit
from zds.member.api.serializers import (
ProfileListSerializer,
ProfileCreateSerializer,
ProfileDetailSerializer,
ProfileValidatorSerializer,
)
from zds.member.api.permissions import IsOwnerOrReadOnly
from zds.member.api.generics import CreateDestroyMemberSanctionAPIView
from zds.member.commons import (
TemporaryReadingOnlySanction,
ReadingOnlySanction,
DeleteReadingOnlySanction,
TemporaryBanSanction,
BanSanction,
DeleteBanSanction,
ProfileCreate,
TokenGenerator,
)
from zds.member.models import Profile
class PagingSearchListKeyConstructor(DefaultKeyConstructor):
pagination = DJRF3xPaginationKeyBit()
search = bits.QueryParamsKeyBit(["search"])
list_sql_query = bits.ListSqlQueryKeyBit()
unique_view_id = bits.UniqueViewIdKeyBit()
user = bits.UserKeyBit()
updated_at = UpdatedAtKeyBit("api_updated_profile")
class DetailKeyConstructor(DefaultKeyConstructor):
format = bits.FormatKeyBit()
language = bits.LanguageKeyBit()
retrieve_sql_query = bits.RetrieveSqlQueryKeyBit()
unique_view_id = bits.UniqueViewIdKeyBit()
user = bits.UserKeyBit()
updated_at = UpdatedAtKeyBit("api_updated_profile")
class MyDetailKeyConstructor(DefaultKeyConstructor):
format = bits.FormatKeyBit()
language = bits.LanguageKeyBit()
user = bits.UserKeyBit()
updated_at = UpdatedAtKeyBit("api_updated_profile")
def change_api_profile_updated_at(sender=None, instance=None, *args, **kwargs):
cache.set("api_updated_profile", datetime.datetime.utcnow())
post_save.connect(receiver=change_api_profile_updated_at, sender=Profile)
post_delete.connect(receiver=change_api_profile_updated_at, sender=Profile)
class MemberListAPI(ListCreateAPIView, ProfileCreate, TokenGenerator):
"""
Profile resource to list and register.
"""
filter_backends = (filters.SearchFilter,)
search_fields = ("user__username",)
list_key_func = PagingSearchListKeyConstructor()
def get_queryset(self):
return Profile.objects.contactable_members()
@etag(list_key_func)
@cache_response(key_func=list_key_func)
def get(self, request, *args, **kwargs):
"""
Lists all users in the system.
---
parameters:
- name: page
description: Restricts output to the given page number.
required: false
paramType: query
- name: page_size
description: Sets the number of profiles per page.
required: false
paramType: query
- name: search
description: Filters by username.
required: false
paramType: query
responseMessages:
- code: 404
message: Not Found
"""
return self.list(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
"""
Registers a new user. User will need to act on confirmation email.
---
responseMessages:
- code: 400
message: Bad Request
"""
serializer = self.get_serializer_class()(data=request.data, context={"request": self.request})
serializer.is_valid(raise_exception=True)
profile = serializer.save()
token = self.generate_token(profile.user)
try:
self.send_email(token, profile.user)
except Exception as e:
logging.getLogger(__name__).warning("Mail not sent", exc_info=e)
return Response({"error": _("Impossible d'envoyer l'email")}, status=status.HTTP_400_BAD_REQUEST)
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
def get_serializer_class(self):
if self.request.method == "GET":
return ProfileListSerializer
elif self.request.method == "POST":
return ProfileCreateSerializer
def get_permissions(self):
permission_classes = [
AllowAny,
]
if self.request.method == "GET" or self.request.method == "POST":
permission_classes.append(DRYPermissions)
return [permission() for permission in permission_classes]
class MemberExistsAPI(ListAPIView):
"""
Profile resource to get if a username exists.
"""
filter_backends = (filters.SearchFilter,)
search_fields = ("=user__username",)
list_key_func = PagingSearchListKeyConstructor()
serializer_class = ProfileDetailSerializer
def get_queryset(self):
return Profile.objects.contactable_members()
@etag(list_key_func)
@cache_response(key_func=list_key_func)
def get(self, request, *args, **kwargs):
"""
Get if a username exists.
---
parameters:
- name: page
description: Restricts output to the given page number.
required: false
paramType: query
- name: page_size
description: Sets the number of profiles per page.
required: false
paramType: query
- name: search
description: Filters by username.
required: false
paramType: query
responseMessages:
- code: 404
user doesn't exists.
"""
r = self.list(request, *args, **kwargs)
if r.data["count"] == 0:
return Response(r.data, status=status.HTTP_404_NOT_FOUND)
return r
def get_permissions(self):
permission_classes = [
AllowAny,
]
if self.request.method == "GET":
permission_classes.append(DRYPermissions)
return [permission() for permission in permission_classes]
class MemberMyDetailAPI(RetrieveAPIView):
"""
Profile resource for member details.
"""
obj_key_func = MyDetailKeyConstructor()
serializer_class = ProfileDetailSerializer
@etag(obj_key_func)
@cache_response(key_func=obj_key_func)
def get(self, request, *args, **kwargs):
"""
Gets information for a user account.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
responseMessages:
- code: 401
message: Not Authenticated
"""
profile = self.get_object()
serializer = self.get_serializer(profile, show_email=True, is_authenticated=True)
return Response(serializer.data)
def get_object(self):
return get_object_or_404(Profile, user=self.request.user)
def get_permissions(self):
permission_classes = [
IsAuthenticated,
]
if self.request.method == "GET":
permission_classes.append(DRYPermissions)
return [permission() for permission in permission_classes]
class MemberDetailAPI(RetrieveUpdateAPIView):
"""
Profile resource to display or update details of a member.
"""
queryset = Profile.objects.all()
lookup_field = "user__id"
obj_key_func = DetailKeyConstructor()
@etag(obj_key_func)
@cache_response(key_func=obj_key_func)
def get(self, request, *args, **kwargs):
"""
Gets a user given by its identifier.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: false
paramType: header
responseMessages:
- code: 404
message: Not Found
"""
profile = self.get_object()
serializer = self.get_serializer(
profile, show_email=profile.show_email, is_authenticated=self.request.user.is_authenticated
)
return Response(serializer.data)
@etag(obj_key_func, rebuild_after_method_evaluation=True)
def put(self, request, *args, **kwargs):
"""
Updates a user given by its identifier.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
responseMessages:
- code: 400
message: Bad Request
- code: 401
message: Not Authenticated
- code: 403
message: Insufficient rights to call this procedure. Source and target users must be equal.
- code: 404
message: Not Found
"""
return self.update(request, *args, **kwargs)
def get_serializer_class(self):
if self.request.method == "GET":
return ProfileDetailSerializer
elif self.request.method == "PUT":
return ProfileValidatorSerializer
else: # used only for API documentation
return ProfileDetailSerializer
def get_permissions(self):
permission_classes = []
if self.request.method == "GET":
permission_classes.append(DRYPermissions)
elif self.request.method == "PUT":
permission_classes.append(DRYPermissions)
permission_classes.append(IsAuthenticatedOrReadOnly)
permission_classes.append(IsOwnerOrReadOnly)
return [permission() for permission in permission_classes]
class MemberDetailReadingOnly(CreateDestroyMemberSanctionAPIView):
"""
Profile resource to apply or remove read only sanction.
"""
lookup_field = "user__id"
def post(self, request, *args, **kwargs):
"""
Applies a read only sanction to the given user.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
- name: ls-jrs
description: Sanction duration in days.
required: false
paramType: form
- name: ls-text
description: Description of the sanction.
required: false
paramType: form
omit_parameters:
- body
responseMessages:
- code: 401
message: Not Authenticated
- code: 403
message: Insufficient rights to call this procedure. Needs staff status.
- code: 404
message: Not Found
"""
return super().post(request, args, kwargs)
def delete(self, request, *args, **kwargs):
"""
Removes a read only sanction from the given user.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
responseMessages:
- code: 401
message: Not Authenticated
- code: 403
message: Insufficient rights to call this procedure. Needs staff status.
- code: 404
message: Not Found
"""
return super().delete(request, args, kwargs)
def get_state_instance(self, request):
if request.method == "POST":
if "ls-jrs" in request.data:
return TemporaryReadingOnlySanction(request.data)
else:
return ReadingOnlySanction(request.data)
elif request.method == "DELETE":
return DeleteReadingOnlySanction(request.data)
raise ValueError(f"Method {request.method} is not supported in this API route.")
class MemberDetailBan(CreateDestroyMemberSanctionAPIView):
"""
Profile resource to apply or remove ban sanction.
"""
lookup_field = "user__id"
def post(self, request, *args, **kwargs):
"""
Applies a ban sanction to a given user.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
- name: ban-jrs
description: Sanction duration in days.
required: false
paramType: form
- name: ban-text
description: Description of the sanction.
required: false
paramType: form
omit_parameters:
- body
responseMessages:
- code: 401
message: Not Authenticated
- code: 403
message: Insufficient rights to call this procedure. Needs staff status.
- code: 404
message: Not Found
"""
return super().post(request, args, kwargs)
def delete(self, request, *args, **kwargs):
"""
Removes a ban sanction from a given user.
---
parameters:
- name: Authorization
description: Bearer token to make an authenticated request.
required: true
paramType: header
responseMessages:
- code: 401
message: Not Authenticated
- code: 403
message: Insufficient rights to call this procedure. Needs staff status.
- code: 404
message: Not Found
"""
return super().delete(request, args, kwargs)
def get_state_instance(self, request):
if request.method == "POST":
if "ban-jrs" in request.data:
return TemporaryBanSanction(request.data)
else:
return BanSanction(request.POST)
elif request.method == "DELETE":
return DeleteBanSanction(request.data)
raise ValueError(f"Method {request.method} is not supported in this API route.")