-
Notifications
You must be signed in to change notification settings - Fork 670
Expand file tree
/
Copy pathviews.py
More file actions
15037 lines (13195 loc) · 569 KB
/
views.py
File metadata and controls
15037 lines (13195 loc) · 569 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
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from django.db.utils import IntegrityError, OperationalError, ProgrammingError
from openpyxl import Workbook
from openpyxl.utils import get_column_letter
from openpyxl.styles import Alignment
import copy
import csv
import json
import mimetypes
import re
import yaml
from django_filters.filterset import filterset_factory
from django_filters.utils import try_dbfield
import regex
import os
import uuid
import zipfile
import tempfile
from datetime import date, datetime, timedelta
from typing import Dict, Any, List, Tuple
import time
from django.db.models import (
F,
CharField,
Count,
Q,
ExpressionWrapper,
FloatField,
IntegerField,
Value,
Min,
Subquery,
OuterRef,
When,
Case,
Exists,
ForeignKey,
OneToOneField,
ManyToManyField,
QuerySet,
Prefetch,
)
from django.db.models.functions import Greatest, Coalesce
from collections import defaultdict
import pytz
from uuid import UUID
from itertools import chain, cycle
import django_filters as df
import shutil
from pathlib import Path
import humanize
from wsgiref.util import FileWrapper
import pandas as pd
import io
import random
from django.db.models.functions import Lower
from docxtpl import DocxTemplate
from integrations.models import SyncMapping
from integrations.tasks import sync_object_to_integrations
from webhooks.service import dispatch_webhook_event
from .generators import gen_audit_context
from .serializer_fields import FieldsRelatedField
from django.utils import timezone
from django.utils.text import slugify
from django.utils.decorators import method_decorator
from django.views.decorators.cache import cache_page
from django.views.decorators.vary import vary_on_cookie
from django.core.cache import cache
from django.apps import apps
from django.contrib.auth.models import Permission
from django.conf import settings
from django.core.exceptions import FieldDoesNotExist
from django.core.files.storage import default_storage
from django.db import models, transaction
from django.forms import ValidationError
from django.http import FileResponse, HttpResponse, StreamingHttpResponse
from django.middleware import csrf
from django.template.loader import render_to_string
from django.utils.functional import Promise
from django.shortcuts import get_object_or_404
from django_filters.rest_framework import DjangoFilterBackend
from iam.models import Folder, RoleAssignment, User, UserGroup
from rest_framework import filters, generics, permissions, status, viewsets
from django.utils.translation import gettext_lazy as _, get_language
from rest_framework.decorators import (
action,
api_view,
permission_classes,
renderer_classes,
)
from rest_framework.parsers import (
FileUploadParser,
)
from rest_framework.renderers import JSONRenderer
from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework.utils.serializer_helpers import ReturnDict
from rest_framework.views import APIView
from rest_framework.exceptions import NotFound, PermissionDenied
from weasyprint import HTML
from core.helpers import *
from core.models import (
AppliedControl,
ComplianceAssessment,
RequirementMappingSet,
RiskAssessment,
RiskMatrix,
RiskScenario,
AssetClass,
Terminology,
)
from core.serializers import ComplianceAssessmentReadSerializer
from core.utils import (
compare_schema_versions,
get_auditee_filtered_folder_ids,
_generate_occurrences,
_create_task_dict,
)
from dateutil import relativedelta as rd
from ebios_rm.models import (
EbiosRMStudy,
FearedEvent,
RoTo,
StrategicScenario,
Stakeholder,
AttackPath,
)
from tprm.models import Entity, Solution, Contract
from privacy.models import Processing, DataBreach, RightRequest
from resilience.models import BusinessImpactAnalysis
from .models import *
from .serializers import *
from .models import Severity
from . import dora
from serdes.utils import (
get_domain_export_objects,
import_export_serializer_class,
topological_sort,
build_dependency_graph,
get_self_referencing_field,
sort_objects_by_self_reference,
)
from serdes.serializers import ExportSerializer
from django.contrib.admin.utils import NestedObjects
from django.db import router
from global_settings.models import GlobalSettings
from global_settings.utils import ff_is_enabled
import structlog
logger = structlog.get_logger(__name__)
SHORT_CACHE_TTL = 2 # mn
MED_CACHE_TTL = 5 # mn
LONG_CACHE_TTL = 60 # mn
MAPPING_MAX_DEPTH = 3
SETTINGS_MODULE = __import__(os.environ.get("DJANGO_SETTINGS_MODULE"))
MODULE_PATHS = SETTINGS_MODULE.settings.MODULE_PATHS
class NullableChoiceFilter(df.MultipleChoiceFilter):
"""
A filter that supports filtering for null values using '--' as a special value.
When '--' is in the filter values, it matches records where the field is null.
"""
def __init__(self, *args, **kwargs):
# Add "--" to the choices
if "choices" in kwargs:
original_choices = kwargs["choices"]
# Add ("--", "--") to the beginning of choices
kwargs["choices"] = [("--", "--")] + list(original_choices)
super().__init__(*args, **kwargs)
def filter(self, qs, value):
if not value:
return qs
# Convert single value to list if needed
if not isinstance(value, list):
value = [value]
# Separate "--" (null) from other actual values
has_null = "--" in value
real_values = [v for v in value if v != "--"]
if has_null and real_values:
# Both null and specific values: OR condition
return qs.filter(
Q(**{f"{self.field_name}__isnull": True})
| Q(**{f"{self.field_name}__in": real_values})
)
elif has_null:
# Only null values
return qs.filter(**{f"{self.field_name}__isnull": True})
elif real_values:
# Only real values - filter by those values
return qs.filter(**{f"{self.field_name}__in": real_values})
else:
# No valid values, return empty queryset
return qs.none()
def add_unset_option(choices):
"""Add '--' (unset) option to choices dictionary or list"""
# Handle both dict and list of tuples format
if isinstance(choices, dict):
# For dict format {value: label}, prepend with "--": "--"
return {"--": "--", **choices}
else:
# For list of tuples like [(value, label), ...]
return [("--", "--")] + list(choices)
def get_mapping_max_depth():
"""Get mapping max depth from general settings at runtime; safe during migrations."""
try:
gs = GlobalSettings.objects.filter(name="general").only("value").first()
if not gs or not isinstance(getattr(gs, "value", None), dict):
return MAPPING_MAX_DEPTH
raw = gs.value.get("mapping_max_depth", MAPPING_MAX_DEPTH)
try:
val = int(raw)
except (TypeError, ValueError):
return MAPPING_MAX_DEPTH
# Clamp to UI constraints
return max(2, min(5, val))
except (OperationalError, ProgrammingError):
# DB not ready (e.g., migrate, makemigrations)
return MAPPING_MAX_DEPTH
def escape_excel_formula(value):
"""
Escape Excel formula injection by prefixing dangerous characters.
Prevents CSV/Formula injection (OWASP) when values start with =+-@
"""
if value is None:
return ""
s = str(value)
if not s:
return ""
stripped = s.lstrip(" \t\r\n")
if stripped and stripped[0] in ("=", "+", "-", "@"):
return "'" + s
return s
def create_xlsx_response(entries, filename, wrap_columns=None):
"""
DRY helper to create XLSX response with consistent formatting.
Args:
entries: List of dictionaries with data
filename: Output filename
wrap_columns: List of column names to wrap text (default: ["name", "description"])
Returns:
HttpResponse with XLSX file
"""
if wrap_columns is None:
wrap_columns = ["name", "description"]
df = pd.DataFrame(entries)
buffer = io.BytesIO()
with pd.ExcelWriter(buffer, engine="openpyxl") as writer:
df.to_excel(writer, index=False)
worksheet = writer.sheets["Sheet1"]
wrap_indices = [
df.columns.get_loc(col) + 1 for col in wrap_columns if col in df.columns
]
for col_idx in wrap_indices:
for row_idx in range(2, len(df) + 2):
cell = worksheet.cell(row=row_idx, column=col_idx)
cell.alignment = Alignment(wrap_text=True)
for idx, col in enumerate(df.columns):
column_width = 20
if col in wrap_columns:
column_width = 40
worksheet.column_dimensions[
worksheet.cell(row=1, column=idx + 1).column_letter
].width = column_width
buffer.seek(0)
response = HttpResponse(
buffer.getvalue(),
content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
)
response["Content-Disposition"] = f'attachment; filename="{filename}"'
return response
class ExportMixin:
"""
Generic export mixin for CSV/XLSX exports.
ViewSets define export_config with fields, formatting, and query optimization hints.
"""
export_config = None
def _get_export_queryset(self):
"""Get filtered queryset with permissions applied."""
(viewable_ids, _, _) = RoleAssignment.get_accessible_object_ids(
Folder.get_root_folder(), self.request.user, self.model
)
queryset = self.model.objects.filter(id__in=viewable_ids)
if self.export_config:
if self.export_config.get("select_related"):
queryset = queryset.select_related(
*self.export_config["select_related"]
)
if self.export_config.get("prefetch_related"):
queryset = queryset.prefetch_related(
*self.export_config["prefetch_related"]
)
return queryset
def _resolve_field_value(self, obj, field_config):
"""Resolve field value from object using dot notation or callable."""
source = field_config.get("source")
if not source:
return ""
parts = source.split(".")
value = obj
for part in parts:
if value is None:
return ""
value = getattr(value, part, "")
# Call methods but keep managers for format functions
if callable(value):
# Check if it's a Django manager/queryset (has .all() method)
is_manager = hasattr(value, "all")
# Call methods, but pass managers as-is
if not is_manager:
try:
value = value()
except TypeError:
pass
# Always apply if formatter exists, let formatter handle empties
format_func = field_config.get("format")
if format_func:
value = format_func(value)
if isinstance(value, str):
if field_config.get("escape", True):
value = escape_excel_formula(value)
return value if value is not None else ""
@action(detail=False, name="Export as CSV")
def export_csv(self, request):
if not self.export_config:
return HttpResponse(
status=501, content="Export not configured for this model"
)
try:
queryset = self._get_export_queryset()
response = HttpResponse(content_type="text/csv")
filename = f"{self.export_config.get('filename', 'export')}.csv"
response["Content-Disposition"] = f'attachment; filename="{filename}"'
writer = csv.writer(response, delimiter=";")
fields = self.export_config["fields"]
writer.writerow([f.get("label", name) for name, f in fields.items()])
has_prefetch = bool(self.export_config.get("prefetch_related"))
if has_prefetch:
for obj in queryset:
row = [
self._resolve_field_value(obj, field_config)
for field_config in fields.values()
]
writer.writerow(row)
else:
for obj in queryset.iterator():
row = [
self._resolve_field_value(obj, field_config)
for field_config in fields.values()
]
writer.writerow(row)
return response
except Exception as e:
logger.error(f"Error exporting {self.model.__name__} to CSV: {str(e)}")
return HttpResponse(
status=500, content="An error occurred while generating the CSV export."
)
@action(detail=False, name="Export as XLSX")
def export_xlsx(self, request):
if not self.export_config:
return HttpResponse(
status=501, content="Export not configured for this model"
)
queryset = self._get_export_queryset()
entries = []
fields = self.export_config["fields"]
for obj in queryset:
entry = {}
for field_name, field_config in fields.items():
entry[field_config.get("label", field_name)] = (
self._resolve_field_value(obj, field_config)
)
entries.append(entry)
filename = f"{self.export_config.get('filename', 'export')}.xlsx"
wrap_columns = self.export_config.get("wrap_columns", ["name", "description"])
return create_xlsx_response(entries, filename, wrap_columns)
def _create_multi_sheet_xlsx(self, queryset, main_fields, detail_config):
"""
Create multi-sheet XLSX with main summary sheet and per-object detail sheets.
Args:
queryset: Main objects queryset
main_fields: Fields config for summary sheet
detail_config: Dict with 'fields', 'related_queryset_method', 'sheet_name_field'
Returns:
HttpResponse with XLSX file
"""
wb = Workbook()
wb.remove(wb.active) # Remove default sheet
# Create summary sheet
summary_ws = wb.create_sheet(title="Summary")
main_headers = [f.get("label", name) for name, f in main_fields.items()]
summary_ws.append(main_headers)
# Wrap text alignment for summary sheet
wrap_alignment = Alignment(wrap_text=True, vertical="top")
wrap_columns = self.export_config.get("wrap_columns", ["name", "description"])
for col_idx, header in enumerate(main_headers, 1):
if header.lower() in wrap_columns:
for row_idx in range(1, summary_ws.max_row + 1):
summary_ws.cell(
row=row_idx, column=col_idx
).alignment = wrap_alignment
# Track sheet names to avoid duplicates
used_sheet_names = {"Summary"}
for obj in queryset:
# Add row to summary sheet
row = [
self._resolve_field_value(obj, field_config)
for field_config in main_fields.values()
]
summary_ws.append(row)
# Get related objects for detail sheet
related_getter = detail_config.get("related_queryset_method")
if related_getter:
related_objects = getattr(obj, related_getter)()
# Skip empty detail sheets if configured
if not related_objects and detail_config.get("skip_empty", True):
continue
# Create unique sheet name
sheet_name_field = detail_config.get("sheet_name_field", "name")
base_name = str(
self._resolve_field_value(obj, {"source": sheet_name_field})
)
if not base_name:
base_name = f"Object_{obj.pk}"
# Truncate and ensure uniqueness
sheet_name = base_name[:31]
counter = 1
while sheet_name in used_sheet_names:
suffix = f" ({counter})"
sheet_name = base_name[: 31 - len(suffix)] + suffix
counter += 1
used_sheet_names.add(sheet_name)
# Create detail sheet
detail_ws = wb.create_sheet(title=sheet_name)
detail_fields = detail_config.get("fields", {})
detail_headers = [
f.get("label", name) for name, f in detail_fields.items()
]
detail_ws.append(detail_headers)
# Add related objects
for related_obj in related_objects:
detail_row = [
self._resolve_field_value(related_obj, field_config)
for field_config in detail_fields.values()
]
detail_ws.append(detail_row)
# Apply wrap text to detail sheet
for col_idx, header in enumerate(detail_headers, 1):
if header.lower() in wrap_columns:
for row_idx in range(1, detail_ws.max_row + 1):
detail_ws.cell(
row=row_idx, column=col_idx
).alignment = wrap_alignment
# Save to buffer
buffer = io.BytesIO()
wb.save(buffer)
buffer.seek(0)
filename = f"{self.export_config.get('filename', 'export')}_multi_sheet.xlsx"
response = HttpResponse(
buffer.getvalue(),
content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
)
response["Content-Disposition"] = f'attachment; filename="{filename}"'
return response
class GenericFilterSet(df.FilterSet):
class UUIDInFilter(df.BaseInFilter, df.UUIDFilter):
pass
id = UUIDInFilter(field_name="id", lookup_expr="in")
@classmethod
def filter_for_lookup(cls, field, lookup_type):
DEFAULTS = dict(cls.FILTER_DEFAULTS)
if hasattr(cls, "_meta"):
DEFAULTS.update(cls._meta.filter_overrides)
data = try_dbfield(DEFAULTS.get, field.__class__) or {}
filter_class = data.get("filter_class")
params = data.get("extra", lambda field: {})(field)
# if there is no filter class, exit early
if not filter_class:
return None, {}
# perform lookup specific checks
if lookup_type == "exact" and getattr(field, "choices", None):
return df.MultipleChoiceFilter, {"choices": field.choices, **params}
if lookup_type == "isnull":
data = try_dbfield(DEFAULTS.get, models.BooleanField)
filter_class = data.get("filter_class")
params = data.get("extra", lambda field: {})(field)
return filter_class, params
if lookup_type == "in":
class ConcreteInFilter(df.BaseInFilter, filter_class):
pass
ConcreteInFilter.__name__ = cls._csv_filter_class_name(
filter_class, lookup_type
)
return ConcreteInFilter, params
if lookup_type == "range":
class ConcreteRangeFilter(df.BaseRangeFilter, filter_class):
pass
ConcreteRangeFilter.__name__ = cls._csv_filter_class_name(
filter_class, lookup_type
)
return ConcreteRangeFilter, params
return filter_class, params
class Meta:
model = None # This will be set dynamically via filterset_factory.
filter_overrides = {
models.ForeignKey: {
"filter_class": df.ModelMultipleChoiceFilter,
"extra": lambda f: {
"queryset": f.remote_field.model.objects.all(),
},
},
models.ManyToManyField: {
"filter_class": df.ModelMultipleChoiceFilter,
"extra": lambda f: {
"queryset": f.remote_field.model.objects.all(),
},
},
}
class FolderOrderingFilter(filters.OrderingFilter):
def get_ordering(self, request, queryset, view):
ordering = super().get_ordering(request, queryset, view)
if ordering:
return [
"folder__name"
if f == "folder"
else "-folder__name"
if f == "-folder"
else f
for f in ordering
]
return ordering
class BaseModelViewSet(viewsets.ModelViewSet):
filter_backends = [
DjangoFilterBackend,
filters.SearchFilter,
FolderOrderingFilter,
]
ordering = ["created_at"]
ordering_fields = "__all__"
search_fields = ["name", "description"]
filterset_fields = []
model: type[models.Model] | None = None
serializers_module = "core.serializers"
@property
def filterset_class(self):
# If you have defined filterset_fields, build the FilterSet on the fly.
if self.filterset_fields:
return filterset_factory(
model=self.model,
filterset=GenericFilterSet,
fields=self.filterset_fields,
)
return None
def get_queryset(self) -> models.query.QuerySet:
if not self.model:
return None
object_ids_view = None
if self.request.method == "GET":
if q := re.match(
r"/api/[\w-]+/([\w-]+/)?([0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12})+)",
self.request.path,
):
""""get_queryset is called by Django even for an individual object via get_object
https://stackoverflow.com/questions/74048193/why-does-a-retrieve-request-end-up-calling-get-queryset"""
id = UUID(q.group(1))
if RoleAssignment.is_object_readable(self.request.user, self.model, id):
object_ids_view = [id]
if not object_ids_view:
object_ids_view = RoleAssignment.get_accessible_object_ids(
Folder.get_root_folder(), self.request.user, self.model
)[0]
queryset = self.model.objects.filter(id__in=object_ids_view)
field_names = {f.name for f in self.model._meta.get_fields()}
if "parent_folder" in field_names:
queryset = queryset.select_related("parent_folder")
if "filtering_labels" in field_names:
queryset = queryset.prefetch_related("filtering_labels")
return queryset
def get_serializer_context(self):
context = super().get_serializer_context()
context["action"] = self.action
return context
def get_serializer_class(self, **kwargs):
serializer_factory = SerializerFactory(
self.serializers_module, MODULE_PATHS.get("serializers", [])
)
serializer_class = serializer_factory.get_serializer(
self.model.__name__, kwargs.get("action", self.action)
)
logger.debug(
"Serializer class",
serializer_class=serializer_class,
action=kwargs.get("action", self.action),
viewset=self,
module_paths=MODULE_PATHS,
)
return serializer_class
COMMA_SEPARATED_UUIDS_REGEX = r"^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}(,[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12})*$"
def _process_request_data(self, request: Request) -> None:
"""
Process the request data to split comma-separated UUIDs into a list
and handle empty list scenarios.
"""
for field in request.data:
# NOTE: This is due to sveltekit-superforms not coercing the value into a list when
# the form's dataType is "form", rather than "json".
# Typically, dataType is "form" when the form contains a file input (e.g. for evidence attachments).
# I am not ruling out the possibility that I am doing something wrong in the frontend. (Nassim)
# TODO: Come back to this once superForms v2 is out of alpha. https://github.com/ciscoheat/sveltekit-superforms/releases
if isinstance(request.data[field], list) and len(request.data[field]) == 1:
if isinstance(request.data[field][0], str) and re.match(
self.COMMA_SEPARATED_UUIDS_REGEX, request.data[field][0]
):
request.data[field] = request.data[field][0].split(",")
elif not request.data[field][0]:
request.data[field] = []
def _process_labels(self, labels):
"""
Creates a FilteringLabel and replaces the value with the ID of the newly created label.
"""
new_labels = []
for label in labels:
try:
uuid.UUID(label, version=4)
new_labels.append(label)
except ValueError:
new_label = FilteringLabel(label=label)
new_label.full_clean()
new_label.save()
new_labels.append(str(new_label.id))
return new_labels
def _process_evidences(self, evidences, folder):
new_evidences = []
for value in evidences or []:
try:
uuid.UUID(str(value), version=4)
new_evidences.append(str(value))
except ValueError:
new_evidence = Evidence(name=value, folder=folder)
new_evidence.full_clean()
new_evidence.save()
new_evidences.append(str(new_evidence.id))
return new_evidences
def _resolve_related_model(self, source: str):
"""Resolve a dotted source path (e.g. 'asset.folder') to its related model."""
model = self.model
for part in source.split("."):
if not model:
return None
try:
field = model._meta.get_field(part)
except FieldDoesNotExist:
return None
model = getattr(field, "related_model", None)
return model
def _get_fieldsrelated_map(self, serializer):
"""Map FieldsRelatedField serializer fields to their related models."""
if hasattr(serializer, "child"):
serializer = serializer.child
if not hasattr(serializer, "fields"):
return {}
field_models = {}
for name, field in serializer.fields.items():
is_fields_related = isinstance(field, FieldsRelatedField)
if not is_fields_related and hasattr(field, "child_relation"):
is_fields_related = isinstance(field.child_relation, FieldsRelatedField)
if not is_fields_related:
continue
source = field.source if field.source not in (None, "*") else name
related_model = self._resolve_related_model(source)
if related_model:
field_models[name] = related_model
return field_models
def _get_accessible_ids_map(self, related_models):
"""Return visible object IDs per related model for the current user."""
root_folder = Folder.get_root_folder()
allowed = {}
for model in related_models:
try:
ids = RoleAssignment.get_accessible_object_ids(
root_folder, self.request.user, model
)[0]
except (NotImplementedError, Permission.DoesNotExist):
# Model does not support IAM scoping; skip filtering
allowed[model] = None
continue
allowed[model] = {str(item_id) for item_id in ids}
return allowed
def _extract_related_id(self, item):
"""Extract a related object ID from a field payload."""
if isinstance(item, dict):
value = item.get("id")
else:
value = item
if value is None:
return None
return str(value)
def _placeholder_for(self, item):
"""Create a placeholder for a hidden related object."""
if isinstance(item, dict):
return {}
return ""
def _filter_related_fields(self, data, field_models, allowed_ids):
"""Mask related fields the current user is not allowed to see."""
if isinstance(data, list):
return [
self._filter_related_fields(item, field_models, allowed_ids)
for item in data
]
if not isinstance(data, dict):
return data
current_user_id = (
str(self.request.user.id) if self.request.user.is_authenticated else None
)
for field_name, related_model in field_models.items():
allowed = allowed_ids.get(related_model)
if allowed is None:
continue
value = data.get(field_name)
if isinstance(value, list):
filtered = []
for item in value:
item_id = self._extract_related_id(item)
# Always include current user
if (
not item_id
or item_id in allowed
or (
related_model.__name__ == "User"
and item_id == current_user_id
)
):
filtered.append(item)
else:
filtered.append(self._placeholder_for(item))
data[field_name] = filtered
elif isinstance(value, dict):
item_id = self._extract_related_id(value)
# Always include current user
if (
item_id
and item_id not in allowed
and not (
related_model.__name__ == "User" and item_id == current_user_id
)
):
data[field_name] = self._placeholder_for(value)
return data
def list(self, request, *args, **kwargs):
"""
Override the list method to inject optimized data into the serializer context.
"""
queryset = self.filter_queryset(self.get_queryset())
page = self.paginate_queryset(queryset)
objects = page if page is not None else queryset
# 1. Perform the bulk calculation for the current page (or entire set if not paginated)
optimized_data = self._get_optimized_object_data(objects)
# 2. Pass the data to the serializer via context
context = self.get_serializer_context()
context["optimized_data"] = optimized_data
if page is not None:
serializer = self.get_serializer(page, many=True, context=context)
data = serializer.data
field_models = self._get_fieldsrelated_map(serializer)
if field_models:
allowed_ids = self._get_accessible_ids_map(set(field_models.values()))
data = self._filter_related_fields(data, field_models, allowed_ids)
return self.get_paginated_response(data)
serializer = self.get_serializer(queryset, many=True, context=context)
data = serializer.data
field_models = self._get_fieldsrelated_map(serializer)
if field_models:
allowed_ids = self._get_accessible_ids_map(set(field_models.values()))
data = self._filter_related_fields(data, field_models, allowed_ids)
return Response(data)
def retrieve(self, request, *args, **kwargs):
"""Return a single object with unauthorized related fields masked."""
instance = self.get_object()
serializer = self.get_serializer(instance)
data = serializer.data
field_models = self._get_fieldsrelated_map(serializer)
if field_models:
allowed_ids = self._get_accessible_ids_map(set(field_models.values()))
data = self._filter_related_fields(data, field_models, allowed_ids)
return Response(data)
def perform_create(self, serializer):
instance = serializer.save()
dispatch_webhook_event(instance, "created", serializer=serializer)
return instance
def perform_update(self, serializer):
instance = serializer.save()
dispatch_webhook_event(instance, "updated", serializer=serializer)
return instance
def perform_destroy(self, instance):
serializer = self.get_serializer(instance)
serializer.delete(instance)
try:
dispatch_webhook_event(instance, "deleted")
except Exception:
logger.error("Webhook dispatch failed on delete", exc_info=True)
def create(self, request: Request, *args, **kwargs) -> Response:
self._process_request_data(request)
if request.data.get("filtering_labels"):
request.data["filtering_labels"] = self._process_labels(
request.data["filtering_labels"]
)
# Experimental: process evidences on TaskTemplate creation
if request.data.get("evidences") and self.model == TaskTemplate:
folder = Folder.objects.get(id=request.data.get("folder"))
request.data["evidences"] = self._process_evidences(
request.data.get("evidences"), folder=folder
)
return super().create(request, *args, **kwargs)
def update(self, request: Request, *args, **kwargs) -> Response:
# Experimental: process evidences on TaskTemplate update
if request.data.get("evidences") and self.model == TaskTemplate:
folder = Folder.objects.get(id=request.data.get("folder"))
request.data["evidences"] = self._process_evidences(
request.data["evidences"], folder=folder
)
# NOTE: Handle filtering_labels field - SvelteKit SuperForms behavior inconsistency:
# Forms with file inputs (like Evidence attachments) use dataType="form" and omit empty fields
# Forms without file inputs use dataType="json" and send empty arrays []
# When the field is missing, we need to explicitly clear the labels by passing empty list to serializer
if hasattr(self.model, "_meta") and "filtering_labels" in [
f.name for f in self.model._meta.get_fields()
]:
if "filtering_labels" in request.data:
labels = request.data.get("filtering_labels")
if labels:
# Make request.data mutable if needed (e.g., for multipart/form-data)
if hasattr(request.data, "_mutable"):
request.data._mutable = True
request.data["filtering_labels"] = self._process_labels(labels)
return super().update(request, *args, **kwargs)
def partial_update(self, request: Request, *args, **kwargs) -> Response:
self._process_request_data(request)
return super().partial_update(request, *args, **kwargs)
def destroy(self, request: Request, *args, **kwargs) -> Response:
self._process_request_data(request)
return super().destroy(request, *args, **kwargs)
@action(detail=False, methods=["post"], url_path="batch-action")
def batch_action(self, request):
"""
Perform a batch action on multiple objects.
Uses the IAM-filtered queryset and serializers to respect permissions
and validation, mirroring the standard partial_update / destroy flows.
Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder",
"ids": [...], "field": "<field_name>", "value": ... }
"""
action_type = request.data.get("action")
ids = request.data.get("ids", [])
value = request.data.get("value")
field_name = request.data.get("field")
valid_actions = ("delete", "change_field", "change_m2m", "change_folder")
if action_type not in valid_actions:
return Response(
{"error": "Invalid action type"},