forked from learningequality/kolibri
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.py
866 lines (734 loc) · 30.4 KB
/
api.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
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
from __future__ import absolute_import
from __future__ import print_function
from __future__ import unicode_literals
import time
from datetime import datetime
from datetime import timedelta
from itertools import groupby
from uuid import uuid4
from django.contrib.auth import authenticate
from django.contrib.auth import login
from django.contrib.auth import logout
from django.contrib.auth import update_session_auth_hash
from django.contrib.auth.models import AnonymousUser
from django.core.exceptions import ObjectDoesNotExist
from django.core.exceptions import PermissionDenied
from django.db import transaction
from django.db.models import Func
from django.db.models import OuterRef
from django.db.models import Q
from django.db.models import Subquery
from django.db.models import TextField
from django.db.models import Value
from django.db.models.functions import Cast
from django.http import Http404
from django.http import HttpResponseForbidden
from django.utils.decorators import method_decorator
from django.utils.timezone import now
from django.views.decorators.csrf import ensure_csrf_cookie
from django_filters.rest_framework import CharFilter
from django_filters.rest_framework import ChoiceFilter
from django_filters.rest_framework import DjangoFilterBackend
from django_filters.rest_framework import FilterSet
from django_filters.rest_framework import ModelChoiceFilter
from morango.api.permissions import BasicMultiArgumentAuthentication
from morango.models import TransferSession
from rest_framework import decorators
from rest_framework import filters
from rest_framework import permissions
from rest_framework import status
from rest_framework import views
from rest_framework import viewsets
from rest_framework.permissions import IsAuthenticated
from rest_framework.response import Response
from rest_framework.serializers import ValidationError
from .constants import collection_kinds
from .constants import role_kinds
from .models import Classroom
from .models import Collection
from .models import Facility
from .models import FacilityDataset
from .models import FacilityUser
from .models import LearnerGroup
from .models import Membership
from .models import Role
from .serializers import ClassroomSerializer
from .serializers import FacilityDatasetSerializer
from .serializers import FacilitySerializer
from .serializers import FacilityUserSerializer
from .serializers import LearnerGroupSerializer
from .serializers import MembershipSerializer
from .serializers import PublicFacilitySerializer
from .serializers import PublicFacilityUserSerializer
from .serializers import RoleSerializer
from kolibri.core import error_constants
from kolibri.core.api import ReadOnlyValuesViewset
from kolibri.core.api import ValuesViewset
from kolibri.core.auth.permissions.general import _user_is_admin_for_own_facility
from kolibri.core.device.utils import allow_guest_access
from kolibri.core.device.utils import allow_other_browsers_to_connect
from kolibri.core.device.utils import valid_app_key_on_request
from kolibri.core.logger.models import UserSessionLog
from kolibri.core.mixins import BulkCreateMixin
from kolibri.core.mixins import BulkDeleteMixin
from kolibri.core.query import annotate_array_aggregate
from kolibri.core.query import SQCount
from kolibri.core.utils.pagination import ValuesViewsetPageNumberPagination
from kolibri.plugins.app.utils import interface
class OptionalPageNumberPagination(ValuesViewsetPageNumberPagination):
"""
Pagination class that allows for page number-style pagination, when requested.
To activate, the `page_size` argument must be set. For example, to request the first 20 records:
`?page_size=20&page=1`
"""
page_size = None
page_size_query_param = "page_size"
class KolibriAuthPermissionsFilter(filters.BaseFilterBackend):
"""
A Django REST Framework filter backend that limits results to those where the
requesting user has read object level permissions. This filtering is delegated
to the ``filter_readable`` method on ``KolibriAbstractBaseUser``.
"""
def filter_queryset(self, request, queryset, view):
if request.method == "GET":
# If a 'GET' method only return readable items to filter down the queryset.
return request.user.filter_readable(queryset)
# otherwise, return the full queryset, as permission checks will happen object-by-object
# (and filtering here then leads to 404's instead of the more correct 403's)
return queryset
def _ensure_raw_dict(d):
if hasattr(d, "dict"):
d = d.dict()
return dict(d)
class KolibriAuthPermissions(permissions.BasePermission):
"""
A Django REST Framework permissions class that defers to Kolibri's permissions
system to determine object-level permissions.
"""
def validator(self, request, view, datum):
model = view.get_serializer_class().Meta.model
validated_data = view.get_serializer().to_internal_value(
_ensure_raw_dict(datum)
)
return request.user.can_create(model, validated_data)
def has_permission(self, request, view):
# as `has_object_permission` isn't called for POST/create, we need to check here
if request.method == "POST" and request.data:
if type(request.data) is list:
data = request.data
else:
data = [request.data]
return all(self.validator(request, view, datum) for datum in data)
# for other methods, we return True, as their permissions get checked below
return True
def has_object_permission(self, request, view, obj):
# note that there is no entry for POST here, as creation is handled by `has_permission`, above
if request.method in permissions.SAFE_METHODS: # 'GET', 'OPTIONS' or 'HEAD'
return request.user.can_read(obj)
if request.method in ["PUT", "PATCH"]:
return request.user.can_update(obj)
if request.method == "DELETE":
return request.user.can_delete(obj)
return False
class FacilityDatasetViewSet(ValuesViewset):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter,)
serializer_class = FacilityDatasetSerializer
values = (
"id",
"learner_can_edit_username",
"learner_can_edit_name",
"learner_can_edit_password",
"learner_can_sign_up",
"learner_can_delete_account",
"learner_can_login_with_no_password",
"show_download_button_in_learn",
"description",
"location",
"registered",
"preset",
)
field_map = {"allow_guest_access": lambda x: allow_guest_access()}
def get_queryset(self):
queryset = FacilityDataset.objects.filter(
collection__kind=collection_kinds.FACILITY
)
facility_id = self.request.query_params.get("facility_id", None)
if facility_id is not None:
queryset = queryset.filter(collection__id=facility_id)
return queryset
@decorators.action(methods=["post"], detail=True)
def resetsettings(self, request, pk):
try:
dataset = FacilityDataset.objects.get(pk=pk)
if not request.user.can_update(dataset):
raise PermissionDenied("You cannot reset this facility's settings")
dataset.reset_to_default_settings()
data = FacilityDatasetSerializer(dataset).data
return Response(data)
except FacilityDataset.DoesNotExist:
raise Http404("Facility does not exist")
class FacilityUserFilter(FilterSet):
USER_TYPE_CHOICES = (
("learner", "learner"),
("superuser", "superuser"),
) + role_kinds.choices
member_of = ModelChoiceFilter(
method="filter_member_of", queryset=Collection.objects.all()
)
user_type = ChoiceFilter(
choices=USER_TYPE_CHOICES,
method="filter_user_type",
)
exclude_member_of = ModelChoiceFilter(
method="filter_exclude_member_of", queryset=Collection.objects.all()
)
exclude_coach_for = ModelChoiceFilter(
method="filter_exclude_coach_for", queryset=Collection.objects.all()
)
exclude_user_type = ChoiceFilter(
choices=USER_TYPE_CHOICES,
method="filter_exclude_user_type",
)
def filter_member_of(self, queryset, name, value):
return queryset.filter(Q(memberships__collection=value) | Q(facility=value))
def filter_user_type(self, queryset, name, value):
if value == "learner":
return queryset.filter(roles__isnull=True)
if value == "superuser":
return queryset.filter(devicepermissions__is_superuser=True)
return queryset.filter(roles__kind=value)
def filter_exclude_member_of(self, queryset, name, value):
return queryset.exclude(Q(memberships__collection=value) | Q(facility=value))
def filter_exclude_coach_for(self, queryset, name, value):
return queryset.exclude(
Q(roles__in=Role.objects.filter(kind=role_kinds.COACH, collection=value))
)
def filter_exclude_user_type(self, queryset, name, value):
if value == "learner":
return queryset.exclude(roles__isnull=True)
if value == "superuser":
return queryset.exclude(devicepermissions__is_superuser=True)
return queryset.exclude(roles__kind=value)
class Meta:
model = FacilityUser
fields = ["member_of", "user_type", "exclude_member_of", "exclude_user_type"]
class PublicFacilityUserViewSet(ReadOnlyValuesViewset):
queryset = FacilityUser.objects.all()
serializer_class = PublicFacilityUserSerializer
authentication_classes = [BasicMultiArgumentAuthentication]
permission_classes = [IsAuthenticated]
values = (
"id",
"username",
"full_name",
"facility",
"roles__kind",
"devicepermissions__is_superuser",
)
field_map = {
"is_superuser": lambda x: bool(x.pop("devicepermissions__is_superuser")),
}
def get_queryset(self):
facility_id = self.request.query_params.get("facility_id", None)
if facility_id is None:
facility_id = self.request.user.facility_id
# if user has admin rights for the facility returns the list of users
queryset = self.queryset.filter(facility_id=facility_id)
# otherwise, the endpoint returns only the user information
if not self.request.user.is_superuser or not _user_is_admin_for_own_facility(
self.request.user
):
queryset = queryset.filter(id=self.request.user.id)
return queryset
def consolidate(self, items, queryset):
output = []
items = sorted(items, key=lambda x: x["id"])
for key, group in groupby(items, lambda x: x["id"]):
roles = []
for item in group:
role = item.pop("roles__kind")
if role is not None:
roles.append(role)
item["roles"] = roles
output.append(item)
return output
class FacilityUserViewSet(ValuesViewset):
permission_classes = (KolibriAuthPermissions,)
pagination_class = OptionalPageNumberPagination
filter_backends = (
KolibriAuthPermissionsFilter,
DjangoFilterBackend,
filters.SearchFilter,
)
order_by_field = "username"
queryset = FacilityUser.objects.all()
serializer_class = FacilityUserSerializer
filter_class = FacilityUserFilter
search_fields = ("username", "full_name")
values = (
"id",
"username",
"full_name",
"facility",
"roles__kind",
"roles__collection",
"roles__id",
"devicepermissions__is_superuser",
"id_number",
"gender",
"birth_year",
)
field_map = {
"is_superuser": lambda x: bool(x.pop("devicepermissions__is_superuser"))
}
def consolidate(self, items, queryset):
output = []
items = sorted(items, key=lambda x: x["id"])
for key, group in groupby(items, lambda x: x["id"]):
roles = []
for item in group:
role = {
"collection": item.pop("roles__collection"),
"kind": item.pop("roles__kind"),
"id": item.pop("roles__id"),
}
if role["collection"]:
# Our values call will return null for users with no assigned roles
# So filter them here.
roles.append(role)
item["roles"] = roles
output.append(item)
output = sorted(output, key=lambda x: x[self.order_by_field])
return output
def set_password_if_needed(self, instance, serializer):
with transaction.atomic():
if serializer.validated_data.get("password", ""):
if serializer.validated_data.get("password", "") != "NOT_SPECIFIED":
instance.set_password(serializer.validated_data["password"])
instance.save()
return instance
def perform_update(self, serializer):
instance = serializer.save()
self.set_password_if_needed(instance, serializer)
# if the user is updating their own password, ensure they don't get logged out
if self.request.user == instance:
update_session_auth_hash(self.request, instance)
def perform_create(self, serializer):
instance = serializer.save()
self.set_password_if_needed(instance, serializer)
class ExistingUsernameView(views.APIView):
def get(self, request):
username = request.GET.get("username")
facility_id = request.GET.get("facility")
if not username or not facility_id:
return Response(
"Must specify username, and facility",
status=status.HTTP_400_BAD_REQUEST,
)
try:
Facility.objects.get(id=facility_id)
except (ValueError, ObjectDoesNotExist):
return Response(
"Facility not found",
status=status.HTTP_404_NOT_FOUND,
)
try:
FacilityUser.objects.get(username__iexact=username, facility=facility_id)
return Response({"username_exists": True}, status=status.HTTP_200_OK)
except ObjectDoesNotExist:
return Response({"username_exists": False}, status=status.HTTP_200_OK)
class FacilityUsernameViewSet(ReadOnlyValuesViewset):
filter_backends = (DjangoFilterBackend, filters.SearchFilter)
filter_fields = ("facility",)
search_fields = ("^username",)
values = ("username",)
def get_queryset(self):
if valid_app_key_on_request(self.request):
# Special case for app context to return usernames for
# the list display
return FacilityUser.objects.all()
return FacilityUser.objects.filter(
dataset__learner_can_login_with_no_password=True, roles=None
).filter(
Q(devicepermissions__is_superuser=False) | Q(devicepermissions__isnull=True)
)
class MembershipFilter(FilterSet):
user_ids = CharFilter(method="filter_user_ids")
def filter_user_ids(self, queryset, name, value):
return queryset.filter(user_id__in=value.split(","))
class Meta:
model = Membership
fields = ["user", "collection", "user_ids"]
class MembershipViewSet(BulkDeleteMixin, BulkCreateMixin, viewsets.ModelViewSet):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter, DjangoFilterBackend)
queryset = Membership.objects.all()
serializer_class = MembershipSerializer
filter_class = MembershipFilter
filter_fields = ["user", "collection", "user_ids"]
class RoleFilter(FilterSet):
user_ids = CharFilter(method="filter_user_ids")
def filter_user_ids(self, queryset, name, value):
return queryset.filter(user_id__in=value.split(","))
class Meta:
model = Role
fields = ["user", "collection", "kind", "user_ids"]
class RoleViewSet(BulkDeleteMixin, BulkCreateMixin, viewsets.ModelViewSet):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter, DjangoFilterBackend)
queryset = Role.objects.all()
serializer_class = RoleSerializer
filter_class = RoleFilter
filter_fields = ["user", "collection", "kind", "user_ids"]
dataset_keys = [
"dataset__id",
"dataset__learner_can_edit_username",
"dataset__learner_can_edit_name",
"dataset__learner_can_edit_password",
"dataset__learner_can_sign_up",
"dataset__learner_can_delete_account",
"dataset__learner_can_login_with_no_password",
"dataset__show_download_button_in_learn",
"dataset__description",
"dataset__location",
"dataset__registered",
"dataset__preset",
]
# map function to pop() all of the dataset__ items into an dict
# then assign that new dict to the `dataset` key of the facility
def _map_dataset(facility):
dataset = {}
for dataset_key in dataset_keys:
stripped_key = dataset_key.replace("dataset__", "")
dataset[stripped_key] = facility.pop(dataset_key)
return dataset
class FacilityViewSet(ValuesViewset):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter,)
queryset = Facility.objects.all()
serializer_class = FacilitySerializer
facility_values = ["id", "name", "num_classrooms", "num_users", "last_synced"]
values = tuple(facility_values + dataset_keys)
field_map = {"dataset": _map_dataset}
def annotate_queryset(self, queryset):
return (
queryset.annotate(
num_users=SQCount(
FacilityUser.objects.filter(facility=OuterRef("id")), field="id"
)
)
.annotate(
num_classrooms=SQCount(
Classroom.objects.filter(parent=OuterRef("id")), field="id"
)
)
.annotate(
last_synced=Subquery(
TransferSession.objects.filter(
filter=Func(
Cast(OuterRef("dataset"), TextField()),
Value("-"),
Value(""),
function="replace",
output_field=TextField(),
)
)
.order_by("-last_activity_timestamp")
.values("last_activity_timestamp")[:1]
)
)
)
class PublicFacilityViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Facility.objects.all()
serializer_class = PublicFacilitySerializer
class ClassroomFilter(FilterSet):
role = CharFilter(method="filter_has_role_for")
parent = ModelChoiceFilter(queryset=Facility.objects.all())
def filter_has_role_for(self, queryset, name, value):
requesting_user = self.request.user
if requesting_user.is_superuser:
return queryset
if requesting_user.is_anonymous():
return queryset.none()
# filter queryset by admin role and coach role
roles = requesting_user.roles.exclude(kind=role_kinds.ASSIGNABLE_COACH)
if roles.filter(
collection_id=requesting_user.facility_id, kind=role_kinds.ADMIN
).exists():
return queryset
if value == role_kinds.COACH:
roles = roles.filter(kind=value)
return queryset.filter(
Q(id__in=roles.values("collection_id"))
| Q(parent_id__in=roles.values("collection_id"))
)
class Meta:
model = Classroom
fields = ["role", "parent"]
class ClassroomViewSet(ValuesViewset):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter, DjangoFilterBackend)
queryset = Classroom.objects.all()
serializer_class = ClassroomSerializer
filter_class = ClassroomFilter
values = (
"id",
"name",
"parent",
"learner_count",
"role__user__id",
"role__user__devicepermissions__is_superuser",
"role__user__full_name",
"role__user__username",
)
def annotate_queryset(self, queryset):
return queryset.annotate(
learner_count=SQCount(
FacilityUser.objects.filter(memberships__collection=OuterRef("id")),
field="id",
)
)
def consolidate(self, items, queryset):
output = []
items = sorted(items, key=lambda x: x["id"])
coach_ids = list(
set(
[
item["role__user__id"]
for item in items
if item["role__user__id"] is not None
]
)
)
facility_roles = {
obj.pop("user"): obj
for obj in Role.objects.filter(
user_id__in=coach_ids, collection__kind=collection_kinds.FACILITY
).values("user", "kind", "collection", "id")
}
for key, group in groupby(items, lambda x: x["id"]):
coaches = []
for item in group:
user_id = item.pop("role__user__id")
if (
user_id in facility_roles
and facility_roles[user_id]["collection"] == item["parent"]
):
roles = [facility_roles[user_id]]
else:
roles = []
coach = {
"id": user_id,
"facility": item["parent"],
# Coerce to bool if None
"is_superuser": bool(
item.pop("role__user__devicepermissions__is_superuser")
),
"full_name": item.pop("role__user__full_name"),
"username": item.pop("role__user__username"),
"roles": roles,
}
if coach["id"]:
coaches.append(coach)
item["coaches"] = coaches
output.append(item)
return output
class LearnerGroupViewSet(ValuesViewset):
permission_classes = (KolibriAuthPermissions,)
filter_backends = (KolibriAuthPermissionsFilter, DjangoFilterBackend)
queryset = LearnerGroup.objects.all()
serializer_class = LearnerGroupSerializer
filter_fields = ("parent",)
values = ("id", "name", "parent", "user_ids")
def annotate_queryset(self, queryset):
return annotate_array_aggregate(queryset, user_ids="membership__user__id")
class SignUpViewSet(viewsets.ViewSet):
serializer_class = FacilityUserSerializer
def extract_request_data(self, request):
return {
"username": request.data.get("username", ""),
"full_name": request.data.get("full_name", ""),
"password": request.data.get("password", ""),
"facility": request.data.get("facility"),
"gender": request.data.get("gender", ""),
"birth_year": request.data.get("birth_year", ""),
}
def create(self, request):
data = self.extract_request_data(request)
facility_id = data["facility"]
if facility_id is None:
facility = Facility.get_default_facility()
data["facility"] = facility.id
else:
try:
facility = Facility.objects.select_related("dataset").get(
id=facility_id
)
except Facility.DoesNotExist:
raise ValidationError(
"Facility does not exist.",
code=error_constants.FACILITY_DOES_NOT_EXIST,
)
if not facility.dataset.learner_can_sign_up:
return HttpResponseForbidden("Cannot sign up to this facility")
# we validate the user's input, and if valid, login as user
serialized_user = self.serializer_class(data=data)
if serialized_user.is_valid(raise_exception=True):
if (
data["password"] == "NOT_SPECIFIED"
and not facility.dataset.learner_can_login_with_no_password
):
raise ValidationError(
"No password specified and it is required",
code=error_constants.PASSWORD_NOT_SPECIFIED,
)
serialized_user.save()
if data["password"] != "NOT_SPECIFIED":
serialized_user.instance.set_password(data["password"])
serialized_user.instance.save()
authenticated_user = authenticate(
username=data["username"],
password=data["password"],
facility=data["facility"],
)
login(request, authenticated_user)
return Response(serialized_user.data, status=status.HTTP_201_CREATED)
class SetNonSpecifiedPasswordView(views.APIView):
def post(self, request):
username = request.data.get("username", "")
password = request.data.get("password", "")
facility_id = request.data.get("facility", None)
if not username or not password or not facility_id:
return Response(
"Must specify username, password, and facility",
status=status.HTTP_400_BAD_REQUEST,
)
error_message = "Suitable user does not exist"
try:
user = FacilityUser.objects.get(username=username, facility=facility_id)
except ObjectDoesNotExist:
raise Http404(error_message)
if user.password != "NOT_SPECIFIED":
raise Http404(error_message)
user.set_password(password)
user.save()
return Response()
@method_decorator(ensure_csrf_cookie, name="dispatch")
class SessionViewSet(viewsets.ViewSet):
def create(self, request):
username = request.data.get("username", "")
password = request.data.get("password", "")
facility_id = request.data.get("facility", None)
# Only enforce this when running in an app
if (
interface.enabled
and not allow_other_browsers_to_connect()
and not valid_app_key_on_request(request)
):
return Response(
[{"id": error_constants.INVALID_CREDENTIALS, "metadata": {}}],
status=status.HTTP_401_UNAUTHORIZED,
)
# Find the FacilityUser we're looking for use later on
try:
unauthenticated_user = FacilityUser.objects.get(
username__iexact=username, facility=facility_id
)
except ObjectDoesNotExist:
unauthenticated_user = None
user = authenticate(username=username, password=password, facility=facility_id)
if user is not None and user.is_active:
# Correct password, and the user is marked "active"
login(request, user)
# Success!
return self.get_session_response(request)
if (
unauthenticated_user is not None
and unauthenticated_user.password == "NOT_SPECIFIED"
):
# Here - we have a Learner whose password is "NOT_SPECIFIED" because they were created
# while the "Require learners to log in with password" setting was disabled - but now
# it is enabled again.
return Response(
[
{
"id": error_constants.PASSWORD_NOT_SPECIFIED,
"metadata": {
"field": "password",
"message": "Username is valid, but password needs to be set before login.",
},
}
],
status=status.HTTP_400_BAD_REQUEST,
)
if (
not password
and FacilityUser.objects.filter(
username__iexact=username, facility=facility_id
).exists()
):
# Password was missing, but username is valid, prompt to give password
return Response(
[
{
"id": error_constants.MISSING_PASSWORD,
"metadata": {
"field": "password",
"message": "Username is valid, but password is missing.",
},
}
],
status=status.HTTP_400_BAD_REQUEST,
)
# Respond with error
return Response(
[{"id": error_constants.INVALID_CREDENTIALS, "metadata": {}}],
status=status.HTTP_401_UNAUTHORIZED,
)
def destroy(self, request, pk=None):
logout(request)
return Response([])
def update(self, request, pk=None):
return self.get_session_response(request)
def get_session_response(self, request):
user = request.user
session_key = "current"
server_time = now()
session = user.session_data
session.update(
{
"id": session_key,
"server_time": server_time,
"app_context": valid_app_key_on_request(request),
}
)
visitor_cookie_expiry = datetime.utcnow() + timedelta(days=365)
if isinstance(user, AnonymousUser):
response = Response(session)
if not request.COOKIES.get("visitor_id"):
visitor_id = str(uuid4().hex)
response.set_cookie(
"visitor_id", visitor_id, expires=visitor_cookie_expiry
)
else:
response.set_cookie(
"visitor_id",
request.COOKIES.get("visitor_id"),
expires=visitor_cookie_expiry,
)
return response
# Set last activity on session to the current time to prevent session timeout
# Only do this for logged in users, as anonymous users cannot get logged out!
request.session["last_session_request"] = int(time.time())
# Default to active, only assume not active when explicitly set.
active = request.data.get("active", False)
# Can only record user session log data for FacilityUsers.
if active and isinstance(user, FacilityUser):
UserSessionLog.update_log(
user,
os_info=request.data.get("os"),
browser_info=request.data.get("browser"),
)
response = Response(session)
return response