-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathviews.py
More file actions
903 lines (801 loc) · 37.1 KB
/
Copy pathviews.py
File metadata and controls
903 lines (801 loc) · 37.1 KB
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
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
import csv
import logging
from collections import defaultdict
import django.utils.timezone as timezone
from django.contrib.auth.models import Permission
from django.contrib.gis.db.models import Count, Exists, OuterRef, Q
from django.db import models, transaction
from django.db.models.query import Prefetch
from django.http import HttpResponse
from django.templatetags.static import static
from django.utils.translation import gettext
from drf_spectacular.utils import OpenApiParameter, extend_schema
from rest_framework import (
mixins,
permissions,
response,
serializers,
status,
views,
viewsets,
)
from rest_framework.decorators import action
from reversion.views import RevisionMixin
from api.models import Appeal, AppealFilter
from api.utils import get_model_name
from dref.filter_set import (
ActiveDrefFilterSet,
CompletedDrefOperationsFilterSet,
DrefFilter,
DrefOperationalUpdateFilter,
DrefShareUserFilterSet,
)
from dref.models import Dref, DrefFile, DrefFinalReport, DrefOperationalUpdate
from dref.permissions import ApproveDrefPermission
from dref.serializers import (
AddDrefUserSerializer,
CompletedDrefOperationsSerializer,
Dref3Serializer,
DrefFileInputSerializer,
DrefFileSerializer,
DrefFinalReport3Serializer,
DrefFinalReportSerializer,
DrefGlobalFilesSerializer,
DrefOperationalUpdate3Serializer,
DrefOperationalUpdateSerializer,
DrefSerializer,
DrefShareUserSerializer,
MiniDrefSerializer,
)
from dref.tasks import process_dref_translation
from main.permissions import DenyGuestUserPermission
logger = logging.getLogger(__name__)
def filter_dref_queryset_by_user_access(user, queryset: models.QuerySet) -> models.QuerySet[Dref]:
if user.is_superuser:
return queryset
# Check if regional admin
dref_admin_regions_id = [
codename.replace("dref_region_admin_", "")
for codename in Permission.objects.filter(
group__user=user,
codename__startswith="dref_region_admin_",
).values_list("codename", flat=True)
]
if len(dref_admin_regions_id):
return queryset.filter(
models.Q(created_by=user) | models.Q(country__region__in=dref_admin_regions_id) | models.Q(users=user)
).distinct()
# Normal access
return queryset.model.get_for(user)
class DrefViewSet(RevisionMixin, viewsets.ModelViewSet):
serializer_class = DrefSerializer
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
filterset_class = DrefFilter
def get_queryset(self):
user = self.request.user
queryset = (
Dref.objects.prefetch_related(
"planned_interventions", "needs_identified", "national_society_actions", "users", "proposed_action"
)
.order_by("-created_at")
.distinct()
)
return filter_dref_queryset_by_user_access(user, queryset)
@extend_schema(request=None, responses=DrefSerializer)
@action(
detail=True,
url_path="approve",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, ApproveDrefPermission, DenyGuestUserPermission],
)
def get_approved(self, request, pk=None, version=None):
dref = self.get_object()
if dref.status == Dref.Status.APPROVED:
raise serializers.ValidationError(gettext("This Dref has already been approved."))
if dref.status != Dref.Status.FINALIZED:
raise serializers.ValidationError(gettext("Must be finalized before it can be approved"))
dref.status = Dref.Status.APPROVED
dref.save(update_fields=["status"])
serializer = DrefSerializer(dref, context={"request": request})
return response.Response(serializer.data)
@extend_schema(request=None, responses=DrefSerializer)
@action(
detail=True,
url_path="finalize",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, DenyGuestUserPermission],
)
def finalize(self, request, pk=None, version=None):
dref = self.get_object()
if dref.status in [Dref.Status.FINALIZED, Dref.Status.APPROVED]:
raise serializers.ValidationError(gettext("Cannot be finalized because it is already %s") % dref.get_status_display())
if dref.translation_module_original_language == "en":
dref.status = Dref.Status.FINALIZED
dref.save(update_fields=["status"])
serializer = DrefSerializer(dref, context={"request": request})
return response.Response(serializer.data)
model_name = get_model_name(type(dref))
dref.status = Dref.Status.FINALIZING
dref.save(update_fields=["status"])
transaction.on_commit(lambda: process_dref_translation.delay(model_name, dref.pk))
return response.Response(
{"detail": gettext("The translation is currently being processed. Please wait a little while before trying again.")},
status=status.HTTP_202_ACCEPTED,
)
@extend_schema(request=None, responses=DrefGlobalFilesSerializer)
@action(
detail=False,
url_path="global-files",
methods=["get"],
serializer_class=DrefGlobalFilesSerializer,
permission_classes=[permissions.IsAuthenticated, DenyGuestUserPermission],
)
def get_global_files(self, request, pk=None, version=None):
"""
Dref global files url
"""
return response.Response(
DrefGlobalFilesSerializer(
{"budget_template_url": request.build_absolute_uri(static("files/dref/budget_template.xlsm"))}
).data
)
class DrefOperationalUpdateViewSet(RevisionMixin, viewsets.ModelViewSet):
serializer_class = DrefOperationalUpdateSerializer
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
filterset_class = DrefOperationalUpdateFilter
def get_queryset(self):
user = self.request.user
queryset = (
DrefOperationalUpdate.objects.select_related(
"national_society",
"national_society",
"disaster_type",
"event_map",
"cover_image",
"budget_file",
"assessment_report",
)
.prefetch_related(
"dref",
"planned_interventions",
"needs_identified",
"national_society_actions",
"users",
"images",
"photos",
)
.order_by("-created_at")
.distinct()
)
return filter_dref_queryset_by_user_access(user, queryset)
@extend_schema(request=None, responses=DrefOperationalUpdateSerializer)
@action(
detail=True,
url_path="approve",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, ApproveDrefPermission, DenyGuestUserPermission],
)
def get_approved(self, request, pk=None, version=None):
operational_update = self.get_object()
if operational_update.status == Dref.Status.APPROVED:
raise serializers.ValidationError(gettext("This Operational update has already been approved."))
if operational_update.status != Dref.Status.FINALIZED:
raise serializers.ValidationError(gettext("Must be finalized before it can be approved."))
operational_update.status = Dref.Status.APPROVED
operational_update.save(update_fields=["status"])
serializer = DrefOperationalUpdateSerializer(operational_update, context={"request": request})
return response.Response(serializer.data)
@extend_schema(request=None, responses=DrefOperationalUpdateSerializer)
@action(
detail=True,
url_path="finalize",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, DenyGuestUserPermission],
)
def finalize(self, request, pk=None, version=None):
operational_update = self.get_object()
if operational_update.status in [Dref.Status.FINALIZED, Dref.Status.APPROVED]:
raise serializers.ValidationError(
gettext("Cannot be finalized because it is already %s") % operational_update.get_status_display()
)
if operational_update.translation_module_original_language == "en":
operational_update.status = Dref.Status.FINALIZED
operational_update.save(update_fields=["status"])
serializer = DrefOperationalUpdateSerializer(operational_update, context={"request": request})
return response.Response(serializer.data)
model_name = get_model_name(type(operational_update))
operational_update.status = Dref.Status.FINALIZING
operational_update.save(update_fields=["status"])
transaction.on_commit(lambda: process_dref_translation.delay(model_name, operational_update.pk))
return response.Response(
{"detail": gettext("The translation is currently being processed. Please wait a little while before trying again.")},
status=status.HTTP_202_ACCEPTED,
)
class DrefFinalReportViewSet(RevisionMixin, viewsets.ModelViewSet):
serializer_class = DrefFinalReportSerializer
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
def get_queryset(self):
user = self.request.user
queryset = (
DrefFinalReport.objects.prefetch_related(
"dref__planned_interventions",
"dref__needs_identified",
)
.order_by("-created_at")
.distinct()
)
return filter_dref_queryset_by_user_access(user, queryset)
@extend_schema(request=None, responses=DrefFinalReportSerializer)
@action(
detail=True,
url_path="approve",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, ApproveDrefPermission, DenyGuestUserPermission],
)
def get_approved(self, request, pk=None, version=None):
final_report = self.get_object()
if final_report.status == Dref.Status.APPROVED:
raise serializers.ValidationError(gettext("This Final Report has already been approved."))
if final_report.status != Dref.Status.FINALIZED:
raise serializers.ValidationError(gettext("Must be finalized before it can be approved."))
final_report.status = Dref.Status.APPROVED
final_report.save(update_fields=["status"])
final_report.dref.is_active = False
final_report.date_of_approval = timezone.now().date()
final_report.dref.save(update_fields=["is_active", "date_of_approval"])
serializer = DrefFinalReportSerializer(final_report, context={"request": request})
return response.Response(serializer.data)
@extend_schema(request=None, responses=DrefFinalReportSerializer)
@action(
detail=True,
url_path="finalize",
methods=["post"],
permission_classes=[permissions.IsAuthenticated, DenyGuestUserPermission],
)
def finalize(self, request, pk=None, version=None):
final_report = self.get_object()
if final_report.status in [Dref.Status.FINALIZED, Dref.Status.APPROVED]:
raise serializers.ValidationError(
gettext("Cannot be finalized because it is already %s") % final_report.get_status_display()
)
if final_report.translation_module_original_language == "en":
final_report.status = Dref.Status.FINALIZED
final_report.save(update_fields=["status"])
serializer = DrefFinalReportSerializer(final_report, context={"request": request})
return response.Response(serializer.data)
model_name = get_model_name(type(final_report))
final_report.status = Dref.Status.FINALIZING
final_report.save(update_fields=["status"])
transaction.on_commit(lambda: process_dref_translation.delay(model_name, final_report.pk))
return response.Response(
{"detail": gettext("The translation is currently being processed. Please wait a little while before trying again.")},
status=status.HTTP_202_ACCEPTED,
)
class DrefFileViewSet(mixins.ListModelMixin, mixins.CreateModelMixin, viewsets.GenericViewSet):
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
serializer_class = DrefFileSerializer
def get_queryset(self):
if self.request is None:
return DrefFile.objects.none()
return DrefFile.objects.filter(created_by=self.request.user)
@extend_schema(request=DrefFileInputSerializer, responses=DrefFileSerializer(many=True))
@action(
detail=False,
url_path="multiple",
methods=["POST"],
permission_classes=[permissions.IsAuthenticated, DenyGuestUserPermission],
)
def multiple_file(self, request, pk=None, version=None):
# converts querydict to original dict
files = [files[0] for files in dict((request.data).lists()).values()]
data = [{"file": file} for file in files]
file_serializer = DrefFileSerializer(data=data, context={"request": request}, many=True)
if file_serializer.is_valid():
file_serializer.save()
return response.Response(file_serializer.data, status=status.HTTP_201_CREATED)
return response.Response(file_serializer.errors, status=status.HTTP_400_BAD_REQUEST)
class CompletedDrefOperationsViewSet(viewsets.ReadOnlyModelViewSet):
serializer_class = CompletedDrefOperationsSerializer
permission_classes = [
permissions.IsAuthenticated,
DenyGuestUserPermission,
]
filterset_class = CompletedDrefOperationsFilterSet
queryset = DrefFinalReport.objects.filter(status=Dref.Status.APPROVED).order_by("-created_at").distinct()
def get_queryset(self):
user = self.request.user
return filter_dref_queryset_by_user_access(user, super().get_queryset())
class ActiveDrefOperationsViewSet(viewsets.ReadOnlyModelViewSet):
serializer_class = MiniDrefSerializer
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
filterset_class = ActiveDrefFilterSet
queryset = (
Dref.objects.select_related(
"country",
)
.prefetch_related(
Prefetch(
"drefoperationalupdate_set",
queryset=DrefOperationalUpdate.objects.select_related("country").order_by("-created_at"),
to_attr="prefetched_operational_updates",
),
"dreffinalreport__country",
)
.order_by("-created_at")
.filter(is_active=True)
)
def get_queryset(self):
return filter_dref_queryset_by_user_access(
self.request.user,
super().get_queryset(),
).annotate(
has_ops_update=Exists(
DrefOperationalUpdate.objects.filter(dref=OuterRef("pk")),
),
unpublished_op_update_count=Count(
"drefoperationalupdate",
filter=~Q(drefoperationalupdate__status=Dref.Status.APPROVED),
),
has_final_report=Exists(
DrefFinalReport.objects.filter(dref=OuterRef("pk")),
),
unpublished_final_report_count=Count(
"dreffinalreport",
filter=~Q(dreffinalreport__status=Dref.Status.APPROVED),
),
)
class DrefShareView(views.APIView):
permission_classes = [permissions.IsAuthenticated, DenyGuestUserPermission]
@extend_schema(request=AddDrefUserSerializer, responses=None)
def post(self, request):
serializer = AddDrefUserSerializer(
data=request.data,
)
serializer.is_valid(raise_exception=True)
serializer.save()
return response.Response(status=status.HTTP_200_OK)
class DrefShareUserViewSet(viewsets.ReadOnlyModelViewSet):
permission_classes = [
permissions.IsAuthenticated,
DenyGuestUserPermission,
]
serializer_class = DrefShareUserSerializer
filterset_class = DrefShareUserFilterSet
def get_queryset(self):
return (
Dref.objects.prefetch_related("planned_interventions", "needs_identified", "national_society_actions", "users")
.order_by("-created_at")
.distinct()
)
class Dref3ViewSet(RevisionMixin, viewsets.ModelViewSet): # type: ignore[misc]
# Allow unauthenticated access; we'll filter published-only for anonymous users below
permission_classes = [permissions.AllowAny]
# Previous: [permissions.IsAuthenticated, DenyGuestUserPermission, UseBySuperAdminOnly]
lookup_field = "appeal_code"
def _excluded_codes(self):
if not hasattr(self, "_excluded_codes_cache"):
self._excluded_codes_cache = self.get_nonsuperusers_excluded_codes()
return self._excluded_codes_cache
def _has_full_access(self, user):
if not user:
return False
if getattr(user, "is_superuser", False):
return True
return user.groups.filter(name="DREF3 Admins").exists()
def get_queryset(self): # type: ignore[override]
# just to give something to rest_framework/generics.py:63 – not used in retrieve
return Dref.objects.none()
def get_nonsuperusers_excluded_codes(self):
"""Return a set of appeal_codes that should be hidden from non-superusers.
Accepts CSV values in AppealFilter.value like "MDRXX019,MDRYY036".
"""
try:
if AppealFilter.objects.values_list("value", flat=True).filter(name="ingestAppealFilter").count() > 0:
codes_exc = AppealFilter.objects.values_list("value", flat=True).filter(name="ingestAppealFilter")[0].split(",")
else:
codes_exc = []
except Exception:
# If model/app not available, fail open (no extra exclusions)
return set()
excluded = set()
for code in codes_exc:
c = code.strip().upper()
if c:
excluded.add(c)
return excluded
def _parse_stage_filter(self, raw):
"""Return canonical stage names (application, operational_update, final_report) from input string.
Accepts comma-separated values; case-insensitive; supports short forms: app, op, final.
"""
if not raw:
return None
mapping = {
"application": "application",
"app": "application",
"dref": "application",
"operational_update": "operational_update",
"operationalupdate": "operational_update",
"op_update": "operational_update",
"op": "operational_update",
"update": "operational_update",
"final_report": "final_report",
"finalreport": "final_report",
"final": "final_report",
"report": "final_report",
}
stages = set()
for part in str(raw).split(","):
key = part.strip().lower()
if key in mapping:
stages.add(mapping[key])
return stages or None
def _status_to_int(self, raw):
if raw is None or raw == "":
return None
try:
return int(raw)
except ValueError:
pass
label_map = {s.label.lower(): s.value for s in Dref.Status}
name_map = {s.name.lower(): s.value for s in Dref.Status}
return label_map.get(str(raw).lower()) or name_map.get(str(raw).lower())
def _order_codes(self, codes, request):
order_by = request.query_params.get("order_by")
if order_by not in ("created_at", "-created_at"):
return sorted(codes)
created_map = {
row["appeal_code"]: row["first_created_at"]
for row in Dref.objects.filter(appeal_code__in=codes)
.values("appeal_code")
.annotate(first_created_at=models.Min("created_at"))
}
present = [code for code in codes if created_map.get(code) is not None]
missing = sorted([code for code in codes if created_map.get(code) is None])
present_sorted = sorted(present, key=lambda code: (created_map.get(code), code), reverse=order_by == "-created_at")
return present_sorted + missing
def _paginate_codes(self, codes, request):
try:
limit = int(request.query_params.get("limit")) if request.query_params.get("limit") else None
except ValueError:
limit = None
try:
offset = int(request.query_params.get("offset")) if request.query_params.get("offset") else 0
except ValueError:
offset = 0
if not offset and limit is None:
return codes
end = offset + limit if limit is not None else None
return codes[offset:end]
@extend_schema(
parameters=[
OpenApiParameter(
name="order_by",
description=(
"Ordering for paged appeal codes. Use 'created_at' or '-created_at' to sort by the first "
"DREF application created_at per appeal_code; any other value defaults to appeal_code ordering."
),
required=False,
type=str,
)
]
)
def list(self, request):
# === First approach – would be nice to work like this, but recent definitons are more complex than that:
# # Aggregate all appeal-codes from the three models
# drefs = Dref.objects.all()
# ops = DrefOperationalUpdate.objects.all()
# finals = DrefFinalReport.objects.all()
# data = Dref3Serializer(list(drefs) + list(ops) + list(finals), many=True).data
# return response.Response(data)
# === Second approach:
# Get appeal_codes – then self.retrieve
stage_filter = self._parse_stage_filter(request.query_params.get("stage"))
codes_qs_dref = Dref.objects.exclude(appeal_code="").values_list("appeal_code", flat=True).distinct()
codes_qs_op = DrefOperationalUpdate.objects.exclude(appeal_code="").values_list("appeal_code", flat=True).distinct()
codes_qs_final = DrefFinalReport.objects.exclude(appeal_code="").values_list("appeal_code", flat=True).distinct()
# Filtering by appeal_code prefix
appeal_code_prefix = request.query_params.get("appeal_code_prefix")
if appeal_code_prefix:
codes_qs_dref = codes_qs_dref.filter(appeal_code__startswith=appeal_code_prefix)
codes_qs_op = codes_qs_op.filter(appeal_code__startswith=appeal_code_prefix)
codes_qs_final = codes_qs_final.filter(appeal_code__startswith=appeal_code_prefix)
# region filter
region_param = request.query_params.get("region")
if region_param:
try:
region_id = int(region_param)
except ValueError:
region_id = None
if region_id:
codes_qs_dref = codes_qs_dref.filter(national_society__region_id=region_id)
codes_qs_op = codes_qs_op.filter(national_society__region_id=region_id)
codes_qs_final = codes_qs_final.filter(national_society__region_id=region_id)
# country iso3
iso3_param = request.query_params.get("country_iso3")
if iso3_param:
iso3 = iso3_param.strip().upper()
codes_qs_dref = codes_qs_dref.filter(national_society__iso3__iexact=iso3)
codes_qs_op = codes_qs_op.filter(national_society__iso3__iexact=iso3)
codes_qs_final = codes_qs_final.filter(national_society__iso3__iexact=iso3)
# appeal_type => type_of_dref
appeal_type_param = request.query_params.get("appeal_type")
if appeal_type_param:
try:
appeal_type_int = int(appeal_type_param)
codes_qs_dref = codes_qs_dref.filter(type_of_dref=appeal_type_int)
codes_qs_op = codes_qs_op.filter(dref__type_of_dref=appeal_type_int)
codes_qs_final = codes_qs_final.filter(dref__type_of_dref=appeal_type_int)
except ValueError:
pass
# operation_status => status
op_status_int = self._status_to_int(request.query_params.get("operation_status"))
if op_status_int is not None:
codes_qs_dref = codes_qs_dref.filter(status=op_status_int)
codes_qs_op = codes_qs_op.filter(status=op_status_int)
codes_qs_final = codes_qs_final.filter(status=op_status_int)
# start/end date of operation
start_date_param = request.query_params.get("start_date_of_operation")
if start_date_param:
# Dref has no operation_start_date; approximate with date_of_approval for application stage records.
codes_qs_dref = codes_qs_dref.filter(date_of_approval__gte=start_date_param)
codes_qs_op = codes_qs_op.filter(new_operational_start_date__gte=start_date_param)
codes_qs_final = codes_qs_final.filter(operation_start_date__gte=start_date_param)
end_date_param = request.query_params.get("end_date_of_operation")
if end_date_param:
codes_qs_dref = codes_qs_dref.filter(end_date__lte=end_date_param)
codes_qs_op = codes_qs_op.filter(new_operational_end_date__lte=end_date_param)
codes_qs_final = codes_qs_final.filter(operation_end_date__lte=end_date_param)
# appeal_id direct (DB primary key)
appeal_id_param = request.query_params.get("appeal_id")
if appeal_id_param:
try:
pk_val = int(appeal_id_param)
except ValueError:
pk_val = None
codes = []
if pk_val:
for model in (Dref, DrefOperationalUpdate, DrefFinalReport):
obj = model.objects.filter(pk=pk_val).only("appeal_code").first()
if obj and obj.appeal_code:
codes = [obj.appeal_code]
break
else:
codes_sets = []
if not stage_filter or "application" in stage_filter:
codes_sets.append(set(codes_qs_dref))
if not stage_filter or "operational_update" in stage_filter:
codes_sets.append(set(codes_qs_op))
if not stage_filter or "final_report" in stage_filter:
codes_sets.append(set(codes_qs_final))
combined = set()
for s in codes_sets:
combined.update([c for c in s if c])
codes = list(combined)
# Additional date range filters (applied to root Dref only where fields exist)
date_range_fields = [
"event_date",
"ns_respond_date",
"government_requested_assistance_date",
"ns_request_date",
"submission_to_geneva",
"date_of_approval",
"publishing_date",
"hazard_date_and_location",
"end_date",
]
for field in date_range_fields:
from_param = request.query_params.get(f"{field}_from")
to_param = request.query_params.get(f"{field}_to")
if from_param:
codes_qs_dref = codes_qs_dref.filter(**{f"{field}__gte": from_param})
if to_param:
codes_qs_dref = codes_qs_dref.filter(**{f"{field}__lte": to_param})
# Exclude codes for non-superusers
if not self._has_full_access(self.request.user):
excluded_codes = self._excluded_codes()
if excluded_codes:
codes = [c for c in codes if c and c.upper() not in excluded_codes]
# NOTE: Ordering and pagination are applied to the appeal codes, not the response objects.
# As a result, the number of response items may vary. This is expected behavior.
# This is a temporary limitation. In the future, we plan to apply standard
# ordering and pagination to the response objects table once an optimized
# layer is available to support it.
codes = self._order_codes(codes, request)
codes = self._paginate_codes(codes, request)
data = []
old_kwargs = getattr(self, "kwargs", {}).copy()
self.kwargs = {self.lookup_field: codes}
resp = self.retrieve(request)
if resp.status_code == 200:
for item in resp.data if isinstance(resp.data, list) else [resp.data]:
if stage_filter:
stage_val = None
if isinstance(item, dict):
stage_val = item.get("stage") or item.get("Stage")
if stage_val:
normalized_stage = stage_val.lower()
if normalized_stage.startswith("operational update"):
normalized_stage = "operational_update"
elif normalized_stage == "final report":
normalized_stage = "final_report"
elif normalized_stage == "application":
normalized_stage = "application"
if normalized_stage not in stage_filter:
continue
else:
# If stage filter present and we cannot determine stage, skip
continue
data.append(item)
self.kwargs = old_kwargs # Restore old kwargs
silents = self._excluded_codes()
# TODO: Is this required, isn't this already done?
for row in data:
row["public"] = row["appeal_id"] not in silents
# numeric id filter (?id=3 or ?id=3,7)
id_param = request.query_params.get("id")
if id_param:
if wanted_ids := {i.strip() for i in str(id_param).split(",")}:
data = [row for row in data if row.get("id") in wanted_ids]
data_paginated = data
export_param = request.query_params.get("export")
if export_param and export_param.lower() == "csv":
header = []
seen = set()
for row in data_paginated:
for k in row.keys():
if k not in seen:
seen.add(k)
header.append(k)
resp = HttpResponse(content_type="text/csv")
resp["Content-Disposition"] = 'attachment; filename="dref3_export.csv"'
writer = csv.writer(resp)
writer.writerow(header)
for row in data_paginated:
writer.writerow([row.get(k, "") for k in header])
return resp
return response.Response(data_paginated)
def get_serializer_class(self): # type: ignore[override]
# just to give something to rest_framework/generics.py:122 – not used in retrieve
return Dref3Serializer
# def get_renderers(self):
# return [renderer() for renderer in tuple(api_settings.DEFAULT_RENDERER_CLASSES)]
def get_objects_by_appeal_code(self, appeal_codes):
user = self.request.user
select_related_fields = (
# FK
"country",
)
prefetch_related_fields = (
# M2M
"planned_interventions",
"district",
# FK – these fields are not included to select_related, because that way run time just increases
"country__region",
"disaster_type",
)
# Strong users: allow more access
global_filters = {
"appeal_code__in": appeal_codes,
}
if not self._has_full_access(user):
# Light users: only published records are visible
global_filters["status"] = Dref.Status.APPROVED
# If code is in the excluded list, return no results for anonymous users
excluded_codes = self._excluded_codes()
global_filters["appeal_code__in"] = [
appeal_code for appeal_code in appeal_codes if appeal_code.upper() not in excluded_codes
]
if not global_filters["appeal_code__in"]:
return {}
drefs = (
Dref.objects.filter(**global_filters)
.select_related(*select_related_fields)
.prefetch_related(*prefetch_related_fields)
.order_by("created_at")
)
operational_updates = (
DrefOperationalUpdate.objects.filter(**global_filters)
.select_related(*select_related_fields)
.prefetch_related(*prefetch_related_fields)
.order_by("created_at")
)
final_reports = (
DrefFinalReport.objects.filter(**global_filters)
.select_related(*select_related_fields)
.prefetch_related(*prefetch_related_fields)
.order_by("created_at")
)
if self._has_full_access(user):
drefs = filter_dref_queryset_by_user_access(user, drefs)
operational_updates = filter_dref_queryset_by_user_access(user, operational_updates)
final_reports = filter_dref_queryset_by_user_access(user, final_reports)
results_by_appeal_code = defaultdict(list)
for items_list in [drefs, operational_updates, final_reports]:
for item in items_list:
results_by_appeal_code[item.appeal_code].append(item)
return results_by_appeal_code
def handle_retrieve(self, code, instances, prefetched_appeal_by_code):
serialized_data = []
ops_update_count = 0
allocation_count = 1 # Dref Application is always the first allocation
public = code not in self._excluded_codes()
a = ["First", "Second", "Third", "Fourth", "Fifth", "Sixth", "Seventh", "Eighth", "Ninth", "Tenth"]
# is_latest_stage: the last APPROVED-status instance and next instance either absent or not APPROVED
latest_index = None
for i, inst in enumerate(instances):
if getattr(inst, "status", None) == Dref.Status.APPROVED:
next_inst = instances[i + 1] if i + 1 < len(instances) else None
if next_inst is None or getattr(next_inst, "status", None) != Dref.Status.APPROVED:
latest_index = i
# Build serialized rows with flag
for i, instance in enumerate(instances):
is_latest_stage = i == latest_index
if isinstance(instance, Dref):
serializer = Dref3Serializer(
instance,
context={
"stage": "Application",
"allocation": a[0],
"public": public,
"is_latest_stage": is_latest_stage,
"prefetched_appeal_by_code": prefetched_appeal_by_code,
},
)
elif isinstance(instance, DrefOperationalUpdate):
ops_update_count += 1
if instance.additional_allocation and len(a) > allocation_count:
allocation = a[allocation_count]
allocation_count += 1
else:
allocation = "No allocation"
serializer = DrefOperationalUpdate3Serializer(
instance,
context={
"stage": f"Operational Update {ops_update_count}",
"allocation": allocation,
"public": public,
"is_latest_stage": is_latest_stage,
"prefetched_appeal_by_code": prefetched_appeal_by_code,
},
)
elif isinstance(instance, DrefFinalReport):
serializer = DrefFinalReport3Serializer(
instance,
context={
"stage": "Final Report",
"allocation": "No allocation",
"public": public,
"is_latest_stage": is_latest_stage,
"prefetched_appeal_by_code": prefetched_appeal_by_code,
},
)
else:
continue
serialized_data.append(serializer.data)
return serialized_data
def retrieve(self, request, *args, **kwargs):
codes = self.kwargs.get(self.lookup_field)
if isinstance(codes, str):
codes = [codes]
instances_by_appeal_code = self.get_objects_by_appeal_code(codes)
if not instances_by_appeal_code:
logger.warning("No Dref, Operational Update, or Final Report found with codes '%s'.", codes)
return response.Response([])
prefetched_appeal_by_code = {
appeal.code: appeal for appeal in Appeal.objects.only("code", "event_id").filter(code__in=codes).all()
}
return response.Response(
[
item
for code, instances in instances_by_appeal_code.items()
for item in self.handle_retrieve(code, instances, prefetched_appeal_by_code)
]
)
def get_renderer_context(self):
context = super().get_renderer_context()
context["header"] = Dref3Serializer.Meta.fields
return context
def dispatch(self, request, *args, **kwargs):
if request.method in ("GET", "HEAD"):
return super().dispatch(request, *args, **kwargs)
return response.Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)