forked from dmm-com/pagoda
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathviews.py
945 lines (789 loc) · 35.9 KB
/
views.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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
import json
import re
from collections import Counter
from copy import deepcopy
from datetime import datetime, timedelta
from django.conf import settings
from django.db.models import Prefetch, Q
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import OpenApiParameter, extend_schema
from rest_framework import generics, serializers, status, viewsets
from rest_framework.exceptions import NotFound, PermissionDenied
from rest_framework.pagination import LimitOffsetPagination
from rest_framework.permissions import BasePermission, IsAuthenticated
from rest_framework.request import Request
from rest_framework.response import Response
from airone.exceptions import ElasticsearchException
from airone.lib import custom_view
from airone.lib.acl import ACLType
from airone.lib.drf import (
DuplicatedObjectExistsError,
FrequentImportError,
IncorrectTypeError,
ObjectNotExistsError,
RequiredParameterError,
YAMLParser,
)
from airone.lib.elasticsearch import (
AdvancedSearchResultRecord,
AdvancedSearchResults,
AttrHint,
FilterKey,
)
from airone.lib.types import AttrType
from api_v1.entry.serializer import EntrySearchChainSerializer
from entity.models import Entity, EntityAttr
from entry.api_v2.pagination import EntryReferralPagination
from entry.api_v2.serializers import (
AdvancedSearchJoinAttrInfo,
AdvancedSearchJoinAttrInfoList,
AdvancedSearchResultExportSerializer,
AdvancedSearchResultSerializer,
AdvancedSearchSerializer,
EntryAliasSerializer,
EntryAttributeValueRestoreSerializer,
EntryBaseSerializer,
EntryCopySerializer,
EntryExportSerializer,
EntryHistoryAttributeValueSerializer,
EntryImportSerializer,
EntryRetrieveSerializer,
EntrySearchSerializer,
EntryUpdateSerializer,
GetEntryAttrReferralSerializer,
)
from entry.models import AliasEntry, Attribute, AttributeValue, Entry
from entry.services import AdvancedSearchService
from entry.settings import CONFIG
from entry.settings import CONFIG as ENTRY_CONFIG
from entry.tasks import ExportTaskParams
from group.models import Group
from job.models import Job, JobOperation, JobStatus
from role.models import Role
from user.models import User
class EntryPermission(BasePermission):
def has_object_permission(self, request: Request, view, obj) -> bool:
user: User = request.user
permisson = {
"retrieve": ACLType.Readable,
"update": ACLType.Writable,
"destroy": ACLType.Writable,
"restore": ACLType.Writable,
"copy": ACLType.Writable,
"list_histories": ACLType.Readable,
"list_alias": ACLType.Readable,
}
if not user.has_permission(obj, permisson.get(view.action)):
return False
return True
class EntryAPI(viewsets.ModelViewSet):
queryset = Entry.objects.all()
permission_classes = [IsAuthenticated & EntryPermission]
pagination_class = LimitOffsetPagination
def get_serializer_class(self):
serializer = {
"retrieve": EntryRetrieveSerializer,
"update": serializers.Serializer,
"restore": serializers.Serializer,
"copy": EntryCopySerializer,
"list_histories": EntryHistoryAttributeValueSerializer,
"list_alias": EntryAliasSerializer,
}
return serializer.get(self.action, EntryBaseSerializer)
@extend_schema(request=EntryUpdateSerializer)
def update(self, request: Request, *args, **kwargs) -> Response:
user: User = request.user
entry: Entry = self.get_object()
serializer = EntryUpdateSerializer(
instance=entry, data=request.data, context={"_user": user}
)
serializer.is_valid(raise_exception=True)
job = Job.new_edit_entry_v2(user, entry, params=request.data)
job.run()
return Response(status=status.HTTP_202_ACCEPTED)
def destroy(self, request: Request, *args, **kwargs) -> Response:
entry: Entry = self.get_object()
if not entry.is_active:
raise ObjectNotExistsError("specified entry has already been deleted")
user: User = request.user
if custom_view.is_custom("before_delete_entry_v2", entry.schema.name):
custom_view.call_custom("before_delete_entry_v2", entry.schema.name, user, entry)
job: Job = Job.new_delete_entry_v2(user, entry)
job.run()
return Response(status=status.HTTP_204_NO_CONTENT)
def restore(self, request: Request, *args, **kwargs) -> Response:
entry: Entry = self.get_object()
if entry.is_active:
raise ObjectNotExistsError("specified entry has not deleted")
# checks that a same name entry corresponding to the entity is existed, or not.
if Entry.objects.filter(
schema=entry.schema, name=re.sub(r"_deleted_[0-9_]*$", "", entry.name), is_active=True
).exists():
raise DuplicatedObjectExistsError("specified entry has already exist other")
if not entry.schema.is_available(re.sub(r"_deleted_[0-9_]*$", "", entry.name)):
raise DuplicatedObjectExistsError("specified entry has already exist alias")
user: User = request.user
if custom_view.is_custom("before_restore_entry_v2", entry.schema.name):
custom_view.call_custom("before_restore_entry_v2", entry.schema.name, user, entry)
entry.set_status(Entry.STATUS_CREATING)
# restore entry
entry.restore()
if custom_view.is_custom("after_restore_entry_v2", entry.schema.name):
custom_view.call_custom("after_restore_entry_v2", entry.schema.name, user, entry)
# remove status flag which is set before calling this
entry.del_status(Entry.STATUS_CREATING)
# Send notification to the webhook URL
job_notify_event = Job.new_notify_create_entry(user, entry)
job_notify_event.run()
return Response({}, status=status.HTTP_201_CREATED)
def copy(self, request: Request, *args, **kwargs) -> Response:
src_entry: Entry = self.get_object()
if not src_entry.is_active:
raise ObjectNotExistsError("specified entry is not active")
# validate post parameter
serializer = self.get_serializer(src_entry, data=request.data)
serializer.is_valid(raise_exception=True)
# TODO Conversion to support the old UI
params = {
"new_name_list": request.data["copy_entry_names"],
"post_data": request.data,
}
# run copy job
job = Job.new_copy(request.user, src_entry, text="Preparing to copy entry", params=params)
job.run()
return Response({}, status=status.HTTP_200_OK)
@extend_schema(responses=EntryAliasSerializer(many=True))
def list_alias(self, request: Request, *args, **kwargs) -> Response:
entry: Entry = self.get_object()
self.queryset = AliasEntry.objects.filter(entry=entry, entry__is_active=True)
return super(EntryAPI, self).list(request, *args, **kwargs)
@extend_schema(responses=EntryHistoryAttributeValueSerializer(many=True))
def list_histories(self, request: Request, *args, **kwargs) -> Response:
user: User = self.request.user
entry: Entry = self.get_object()
# check permission for attribute
target_attrs = []
for attr in entry.attrs.filter(schema__is_active=True):
if user.has_permission(attr, ACLType.Readable):
target_attrs.append(attr)
self.queryset = (
AttributeValue.objects.filter(
parent_attr__in=target_attrs,
parent_attrv__isnull=True,
)
.order_by("-created_time")
.select_related("parent_attr__schema", "created_user")
)
return super(EntryAPI, self).list(request, *args, **kwargs)
@extend_schema(
parameters=[
OpenApiParameter("query", OpenApiTypes.STR, OpenApiParameter.QUERY),
],
)
class searchAPI(viewsets.ReadOnlyModelViewSet):
serializer_class = EntrySearchSerializer
def get_queryset(self):
queryset = []
query = self.request.query_params.get("query", None)
if not query:
return queryset
results = AdvancedSearchService.search_entries_for_simple(
query, limit=ENTRY_CONFIG.MAX_SEARCH_ENTRIES
)
return results["ret_values"]
class AdvancedSearchAPI(generics.GenericAPIView):
serializer_class = AdvancedSearchSerializer
"""
NOTE for now it's just copied from /api/v1/entry/search, but it should be
rewritten with DRF components.
Join Attrs implementation notes:
- Pagination is applied at root level first, then join & filter operations
- This may result in fewer items than requested limit
- Each join triggers a new ES query (N+1 pattern)
"""
@extend_schema(
request=AdvancedSearchSerializer,
responses=AdvancedSearchResultSerializer,
)
def post(self, request: Request) -> Response:
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
hint_entities = serializer.validated_data["entities"]
hint_entry_name = serializer.validated_data["entry_name"]
hint_attrs = [
AttrHint(
name=x["name"],
keyword=x.get("keyword"),
filter_key=x.get("filter_key"),
exact_match=x.get("exact_match"),
)
for x in serializer.validated_data["attrinfo"]
]
hint_referral = serializer.validated_data.get("referral_name")
has_referral = serializer.validated_data["has_referral"]
is_output_all = serializer.validated_data["is_output_all"]
is_all_entities = serializer.validated_data["is_all_entities"]
entry_limit = serializer.validated_data["entry_limit"]
entry_offset = serializer.validated_data["entry_offset"]
join_attrs = AdvancedSearchJoinAttrInfoList.model_validate(
serializer.validated_data.get("join_attrs", [])
).root
def _get_joined_resp(
prev_results: list[AdvancedSearchResultRecord], join_attr: AdvancedSearchJoinAttrInfo
) -> tuple[bool, AdvancedSearchResults]:
"""
Process join operation for a single attribute.
Flow:
1. Get related entities from prev_results
2. Extract referral IDs and names
3. Execute new ES query for joined entities
4. Apply filters if specified
Note:
- Each call triggers new ES query
- Results may be reduced by join filters
- Pagination from root level may lead to incomplete results
"""
entities = Entity.objects.filter(
id__in=[result.entity["id"] for result in prev_results]
).prefetch_related(
Prefetch(
"attrs",
queryset=EntityAttr.objects.filter(
name=join_attr.name, is_active=True
).prefetch_related(
Prefetch(
"referral", queryset=Entity.objects.filter(is_active=True).only("id")
)
),
)
)
entity_dict: dict[int, Entity] = {entity.id: entity for entity in entities}
# set hint_entity_ids for joining Items search and get item names
# that specified attribute refers
item_names: list[str] = []
hint_entity_ids: list[str] = []
for result in prev_results:
entity = entity_dict.get(result.entity["id"])
if entity is None:
continue
attr: Attribute | None = next(
(a for a in entity.attrs.all() if a.name == join_attr.name), None
)
if attr is None:
continue
if attr.type & AttrType.OBJECT:
# set hint Model ID
hint_entity_ids.extend([x.id for x in attr.referral.all()])
# set Item name
attrinfo = result.attrs[join_attr.name]
if attr.type == AttrType.OBJECT and attrinfo["value"]["name"] not in item_names:
item_names.append(attrinfo["value"]["name"])
if attr.type == AttrType.NAMED_OBJECT:
for co_info in attrinfo["value"].values():
if co_info["name"] not in item_names:
item_names.append(co_info["name"])
if attr.type == AttrType.ARRAY_OBJECT:
for r in attrinfo["value"]:
if r["name"] not in item_names:
item_names.append(r["name"])
if attr.type == AttrType.ARRAY_NAMED_OBJECT:
for r in attrinfo["value"]:
[co_info] = r.values()
if co_info["name"] not in item_names:
item_names.append(co_info["name"])
# set parameters to filter joining search results
hint_attrs = [
AttrHint(
name=info.name,
keyword=info.keyword,
filter_key=info.filter_key,
)
for info in join_attr.attrinfo
]
# search Items from elasticsearch to join
return (
# This represents whether user want to narrow down results by keyword of joined attr
any([x.keyword or (x.filter_key or 0) > 0 for x in join_attr.attrinfo]),
AdvancedSearchService.search_entries(
request.user,
hint_entity_ids=list(set(hint_entity_ids)), # this removes depulicated IDs
hint_attrs=hint_attrs,
limit=entry_limit,
entry_name="|".join(item_names),
hint_referral=None,
is_output_all=is_output_all,
hint_referral_entity_id=None,
offset=join_attr.offset,
),
)
# === End of Function: _get_joined_resp() ===
def _get_ref_id_from_es_result(attrinfo) -> list[int | None]:
match attrinfo["type"]:
case AttrType.OBJECT if attrinfo.get("value") is not None:
return [attrinfo["value"].get("id")]
case AttrType.NAMED_OBJECT if attrinfo.get("value") is not None:
[ref_info] = attrinfo["value"].values()
return [ref_info.get("id")]
case AttrType.ARRAY_OBJECT:
return [x.get("id") for x in attrinfo["value"]]
case AttrType.ARRAY_NAMED_OBJECT:
return sum([[y["id"] for y in x.values()] for x in attrinfo["value"]], [])
return []
# === End of Function: _get_ref_id_from_es_result() ===
if not has_referral:
hint_referral = None
if is_all_entities:
attr_names = [x.name for x in hint_attrs]
hint_entities = list(
EntityAttr.objects.filter(
name__in=attr_names, is_active=True, parent_entity__is_active=True
)
.order_by("parent_entity__name")
.values_list("parent_entity__id", flat=True)
.distinct()
)
if not hint_entities:
return Response("Invalid value for attribute parameter", status=400)
hint_entity_ids = []
for hint_entity in hint_entities:
entity = None
if isinstance(hint_entity, int):
entity = Entity.objects.filter(id=hint_entity, is_active=True).first()
elif isinstance(hint_entity, str):
if hint_entity.isnumeric():
entity = Entity.objects.filter(
Q(id=hint_entity) | Q(name=hint_entity), Q(is_active=True)
).first()
else:
entity = Entity.objects.filter(name=hint_entity, is_active=True).first()
if entity and request.user.has_permission(entity, ACLType.Readable):
hint_entity_ids.append(entity.id)
if settings.ENABLE_ESLESS_ADVANCED_SEARCH:
resp = AdvancedSearchService.search_entries_v2(
request.user,
hint_entity_ids,
hint_attrs,
entry_limit,
hint_entry_name,
hint_referral,
is_output_all,
offset=entry_offset,
)
else:
resp = AdvancedSearchService.search_entries(
request.user,
hint_entity_ids,
hint_attrs,
entry_limit,
hint_entry_name,
hint_referral,
is_output_all,
offset=entry_offset,
)
# save total population number
total_count = deepcopy(resp.ret_count)
for join_attr in join_attrs:
# Note: Each iteration here represents a potential N+1 query
# The trade-off is between query performance and result accuracy
(will_filter_by_joined_attr, joined_resp) = _get_joined_resp(resp.ret_values, join_attr)
# This is needed to set result as blank value
blank_joining_info = {
"%s.%s" % (join_attr.name, k.name): {
"is_readable": True,
"type": AttrType.STRING,
"value": "",
}
for k in join_attr.attrinfo
}
# convert search result to dict to be able to handle it without loop
joined_resp_info = {
x.entry["id"]: {
"%s.%s" % (join_attr.name, k): v
for k, v in x.attrs.items()
if any(_x.name == k for _x in join_attr.attrinfo)
}
for x in joined_resp.ret_values
}
# this inserts result to previous search result
new_ret_values: list[AdvancedSearchResultRecord] = []
joined_ret_values: list[AdvancedSearchResultRecord] = []
for resp_result in resp.ret_values:
# joining search result to original one
ref_info = resp_result.attrs.get(join_attr.name)
# This get referral Item-ID from joined search result
ref_list = _get_ref_id_from_es_result(ref_info)
for ref_id in ref_list:
if ref_id and ref_id in joined_resp_info: # type: ignore
# join valid value
resp_result.attrs |= joined_resp_info[ref_id]
# collect only the result that matches with keyword of joined_attr parameter
copied_result = deepcopy(resp_result)
new_ret_values.append(copied_result)
joined_ret_values.append(copied_result)
else:
# join EMPTY value
resp_result.attrs |= blank_joining_info # type: ignore
joined_ret_values.append(deepcopy(resp_result))
if len(ref_list) == 0:
# join EMPTY value
resp_result.attrs |= blank_joining_info # type: ignore
joined_ret_values.append(deepcopy(resp_result))
if will_filter_by_joined_attr:
resp.ret_values = new_ret_values
resp.ret_count = len(new_ret_values)
else:
resp.ret_values = joined_ret_values
resp.ret_count = len(joined_ret_values)
# convert field values to fit entry retrieve API data type, as a workaround.
# FIXME should be replaced with DRF serializer etc
for entry in resp.ret_values:
for name, attr in entry.attrs.items():
def _get_typed_value(type: int) -> str:
if type & AttrType._ARRAY:
if type & AttrType.STRING:
return "as_array_string"
elif type & AttrType._NAMED:
return "as_array_named_object"
elif type & AttrType.OBJECT:
return "as_array_object"
elif type & AttrType.GROUP:
return "as_array_group"
elif type & AttrType.ROLE:
return "as_array_role"
elif type & AttrType.STRING or type & AttrType.TEXT:
return "as_string"
elif type & AttrType._NAMED:
return "as_named_object"
elif type & AttrType.OBJECT:
return "as_object"
elif type & AttrType.BOOLEAN:
return "as_boolean"
elif type & AttrType.DATE:
return "as_string"
elif type & AttrType.GROUP:
return "as_group"
elif type & AttrType.ROLE:
return "as_role"
elif type & AttrType.DATETIME:
return "as_string"
raise IncorrectTypeError(f"unexpected type: {type}")
entry.attrs[name] = {
"is_readable": attr["is_readable"],
"type": attr["type"],
"value": {
_get_typed_value(attr["type"]): attr.get("value", ""),
},
}
# "asString" is a string type and does not allow None
if (
_get_typed_value(attr["type"]) == "as_string"
and entry.attrs[name]["value"]["as_string"] is None
):
entry.attrs[name]["value"]["as_string"] = ""
# "asNamedObject", "as_array_named_object" converts types
if _get_typed_value(attr["type"]) == "as_named_object":
value = entry.attrs[name]["value"]["as_named_object"]
entry.attrs[name]["value"]["as_named_object"] = {
"name": list(value.keys())[0],
"object": list(value.values())[0],
}
if _get_typed_value(attr["type"]) == "as_array_named_object":
values = entry.attrs[name]["value"]["as_array_named_object"]
entry.attrs[name]["value"]["as_array_named_object"] = [
{
"name": list(value.keys())[0],
"object": list(value.values())[0],
}
for value in values
]
serializer = AdvancedSearchResultSerializer(
data={
"count": resp.ret_count,
"values": [x.dict() for x in resp.ret_values],
"total_count": total_count,
}
)
# TODO validate response data strictly, like below.
# it'll fail because the data format will be different with EntryAttributeValueSerializer
# serializer.is_valid(raise_exception=True)
# return Response(serializer.validated_data)
return Response(serializer.initial_data)
class AdvancedSearchChainAPI(generics.GenericAPIView):
serializer_class = EntrySearchChainSerializer
"""
NOTE For now, it's just copied from /api/v1/entry/search_chain.
And the AttributeValue is missing from the response.
"""
@extend_schema(
request=EntrySearchChainSerializer,
responses=EntryBaseSerializer(many=True),
)
def post(self, request: Request) -> Response:
serializer = EntrySearchChainSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
try:
(_, ret_data) = serializer.search_entries(request.user)
except ElasticsearchException:
return Response(
{
"reason": (
"Data overflow was happened. Please narrow down intermediate conditions"
)
},
status=status.HTTP_400_BAD_REQUEST,
)
entries = Entry.objects.filter(id__in=[x["id"] for x in ret_data])
return Response(EntryBaseSerializer(entries, many=True).data)
class AdvancedSearchResultAPI(generics.GenericAPIView):
serializer_class = AdvancedSearchResultExportSerializer
def post(self, request: Request) -> Response:
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
serializer.save()
return Response(serializer.validated_data)
@extend_schema(
parameters=[
OpenApiParameter("keyword", OpenApiTypes.STR, OpenApiParameter.QUERY),
],
)
class EntryReferralAPI(viewsets.ReadOnlyModelViewSet):
serializer_class = EntryBaseSerializer
pagination_class = EntryReferralPagination
def get_queryset(self):
entry_id = self.kwargs["pk"]
keyword = self.request.query_params.get("keyword", None)
entry = Entry.objects.filter(pk=entry_id).first()
if not entry:
return []
ids = AttributeValue.objects.filter(
Q(referral=entry, is_latest=True) | Q(referral=entry, parent_attrv__is_latest=True)
).values_list("parent_attr__parent_entry", flat=True)
# if entity_name param exists, add schema name to reduce filter execution time
query = Q(pk__in=ids, is_active=True)
if keyword:
query &= Q(name__iregex=r"%s" % keyword)
return Entry.objects.filter(query).select_related("schema")
class EntryExportAPI(generics.GenericAPIView):
serializer_class = EntryExportSerializer
def post(self, request: Request, entity_id: int) -> Response:
if not Entity.objects.filter(id=entity_id).exists():
return Response(
"Failed to get entity of specified id", status=status.HTTP_400_BAD_REQUEST
)
serializer = self.get_serializer(data=request.data)
if not serializer.is_valid():
return Response(
"Parameters in post body is invalid", status=status.HTTP_400_BAD_REQUEST
)
job_params = ExportTaskParams(
export_format=serializer.validated_data["format"], target_id=entity_id
)
# check whether same job is sent
job_status_not_finished = [JobStatus.PREPARING, JobStatus.PROCESSING]
if (
Job.get_job_with_params(request.user, job_params.dict())
.filter(status__in=job_status_not_finished)
.exists()
):
return Response(
"Same export processing is under execution", status=status.HTTP_400_BAD_REQUEST
)
entity = Entity.objects.get(id=entity_id)
if not request.user.has_permission(entity, ACLType.Readable):
return Response(
'Permission denied to _value "%s"' % entity.name, status=status.HTTP_400_BAD_REQUEST
)
# create a job to export search result and run it
job = Job.new_export_v2(
request.user,
**{
"text": "entry_%s.%s" % (entity.name, str(job_params.export_format)),
"target": entity,
"params": job_params.dict(),
},
)
job.run()
return Response(
{"result": "Succeed in registering export processing. " + "Please check Job list."},
status=status.HTTP_200_OK,
)
@extend_schema(
parameters=[
OpenApiParameter("keyword", OpenApiTypes.STR, OpenApiParameter.QUERY),
],
)
class EntryAttrReferralsAPI(viewsets.ReadOnlyModelViewSet):
serializer_class = GetEntryAttrReferralSerializer
def get_queryset(self):
attr_id = self.kwargs["attr_id"]
keyword = self.request.query_params.get("keyword", None)
attr = Attribute.objects.filter(id=attr_id).first()
if attr:
entity_attr = attr.schema
else:
entity_attr = EntityAttr.objects.filter(id=attr_id).first()
if not entity_attr:
raise NotFound(f"not found matched attribute or entity attr: {attr_id}")
conditions = {"is_active": True}
if keyword:
conditions["name__icontains"] = keyword
# TODO support natural sort?
if entity_attr.type & AttrType.OBJECT:
return Entry.objects.filter(
**conditions, schema__in=entity_attr.referral.all()
).order_by("name")[0 : CONFIG.MAX_LIST_REFERRALS]
elif entity_attr.type & AttrType.GROUP:
return Group.objects.filter(**conditions).order_by("name")[
0 : CONFIG.MAX_LIST_REFERRALS
]
elif entity_attr.type & AttrType.ROLE:
return Role.objects.filter(**conditions).order_by("name")[0 : CONFIG.MAX_LIST_REFERRALS]
else:
raise IncorrectTypeError(f"unsupported attr type: {entity_attr.type}")
@extend_schema(
parameters=[
OpenApiParameter("force", OpenApiTypes.BOOL, OpenApiParameter.QUERY, default=False),
],
)
class EntryImportAPI(generics.GenericAPIView):
parser_classes = [YAMLParser]
serializer_class = serializers.Serializer
def get_queryset(self):
import_data = self.request.data
entity_names = [d["entity"] for d in import_data]
return Entity.objects.filter(name__in=entity_names, is_active=True)
def post(self, request: Request) -> Response:
import_datas = request.data
user: User = request.user
serializer = EntryImportSerializer(data=import_datas)
serializer.is_valid(raise_exception=True)
entities = self.get_queryset()
# limit import job to deny accidental frequent import for same entity
if request.query_params.get("force", "") not in ["true", "True"]:
valid_statuses: list[JobStatus] = [
JobStatus.PREPARING,
JobStatus.PROCESSING,
JobStatus.DONE,
]
yesterday = datetime.now() - timedelta(days=1)
if Job.objects.filter(
status__in=valid_statuses,
operation=JobOperation.IMPORT_ENTRY_V2,
target__in=entities,
created_at__gte=yesterday,
).exists():
raise FrequentImportError("Import job for each entity can apply once a day.")
job_ids: list[int] = []
error_list: list[str] = []
for import_data in import_datas:
entity: Entity | None = next(
(e for e in entities if e.name == import_data["entity"]), None
)
if not entity:
error_list.append("%s: Entity does not exists." % import_data["entity"])
continue
if not user.has_permission(entity, ACLType.Writable):
error_list.append("%s: Entity is permission denied." % import_data["entity"])
continue
job = Job.new_import_v2(
user, entity, text="Preparing to import data", params=import_data
)
job.run()
job_ids.append(job.id)
return Response(
{"result": {"job_ids": job_ids, "error": error_list}}, status=status.HTTP_200_OK
)
class EntryAttributeValueRestoreAPI(generics.UpdateAPIView):
queryset = AttributeValue.objects.all()
serializer_class = EntryAttributeValueRestoreSerializer
permission_classes = [IsAuthenticated]
@extend_schema(
parameters=[
OpenApiParameter(
"ids", {"type": "array", "items": {"type": "number"}}, OpenApiParameter.QUERY
),
OpenApiParameter("isAll", OpenApiTypes.BOOL, OpenApiParameter.QUERY),
OpenApiParameter("attrinfo", OpenApiTypes.STR, OpenApiParameter.QUERY),
],
)
class EntryBulkDeleteAPI(generics.DestroyAPIView):
# (Execuse)
# Specifying serializer_class is necessary for passing processing
# of npm run generate
serializer_class = EntryUpdateSerializer
internal_limit = 10000
def _validate_attrinfo(self):
attrinfo_raw = self.request.query_params.get("attrinfo", "[]")
try:
json_loaded_value = json.loads(attrinfo_raw)
for info in json_loaded_value:
if not any(x in info for x in ["name", "filterKey", "keyword"]):
raise RequiredParameterError("(00)Invalid attrinfo was specified")
if not FilterKey.isin(int(info["filterKey"])):
raise RequiredParameterError("(01)Invalid attrinfo was specified")
except Exception as e:
raise RequiredParameterError(e)
return json_loaded_value
def delete(self, request: Request, *args, **kwargs) -> Response:
# validate "attrinfo" parameter and save it before deleting item processing
attrinfo = self._validate_attrinfo()
ids: list[str] = self.request.query_params.getlist("ids", [])
if len(ids) == 0 or not all([id.isdecimal() for id in ids]):
raise RequiredParameterError("some ids are invalid")
entries = Entry.objects.filter(id__in=ids, is_active=True)
if len(ids) != entries.count():
raise NotFound("some specified entries don't exist")
user: User = request.user
if not all([user.has_permission(e, ACLType.Writable) for e in entries]):
raise PermissionDenied("deleting some entries is not allowed")
# Run jobs that delete user specified Items
target_model = entries.first().schema if entries.first() else None
for entry in entries:
job: Job = Job.new_delete_entry_v2(user, entry)
job.run()
# Run jobs that delete rest of Items of same Model
isAll: bool = self.request.query_params.get("isAll", False)
if isinstance(isAll, str):
isAll = isAll.lower() == "true"
if isAll and target_model is not None:
results = AdvancedSearchService.search_entries(
request.user,
hint_entity_ids=list(set([e.schema.id for e in entries])),
hint_attrs=[
AttrHint(
**{
"name": x["name"],
"filter_key": FilterKey(int(x["filterKey"])),
"keyword": x["keyword"],
}
)
for x in attrinfo
],
limit=self.internal_limit,
)
entries = Entry.objects.filter(
id__in=[x.entry["id"] for x in results.ret_values],
schema=target_model,
is_active=True,
).exclude(id__in=ids)
for entry in entries:
another_job: Job = Job.new_delete_entry_v2(user, entry)
another_job.run()
return Response(status=status.HTTP_204_NO_CONTENT)
class EntryAliasAPI(viewsets.ModelViewSet):
permission_classes = [IsAuthenticated]
pagination_class = LimitOffsetPagination
serializer_class = EntryAliasSerializer
queryset = AliasEntry.objects.filter(entry__is_active=True)
def bulk_create(self, request, *args, **kwargs):
# refuse input that has duplicated name
counter = Counter([x["name"] for x in request.data])
if any([c > 1 for c in counter.values()]):
raise DuplicatedObjectExistsError(
"Duplicated names(%s) were specified"
% (str([name for (name, count) in counter.items() if count > 1]))
)
serializer = self.get_serializer(data=request.data, many=True)
serializer.is_valid(raise_exception=True)
serializer.save()
return Response(serializer.data)