-
-
Notifications
You must be signed in to change notification settings - Fork 21
Expand file tree
/
Copy pathviews.py
More file actions
2529 lines (2146 loc) · 89.2 KB
/
views.py
File metadata and controls
2529 lines (2146 loc) · 89.2 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
#
# Copyright (c) nexB Inc. and others. All rights reserved.
# DejaCode is a trademark of nexB Inc.
# SPDX-License-Identifier: AGPL-3.0-only
# See https://github.com/aboutcode-org/dejacode for support or download.
# See https://aboutcode.org for more information about AboutCode FOSS projects.
#
import csv
import json
from collections import OrderedDict
from collections import defaultdict
from collections import namedtuple
from operator import attrgetter
from urllib.parse import unquote_plus
from django.conf import settings
from django.contrib import messages
from django.contrib.auth.decorators import login_required
from django.contrib.auth.mixins import LoginRequiredMixin
from django.contrib.auth.mixins import PermissionRequiredMixin
from django.core import signing
from django.core.exceptions import ImproperlyConfigured
from django.core.exceptions import ValidationError
from django.core.paginator import Paginator
from django.db import transaction
from django.db.models import Count
from django.db.models import OuterRef
from django.db.models import Prefetch
from django.db.models import Subquery
from django.db.models.functions import Lower
from django.forms import modelformset_factory
from django.http import Http404
from django.http import HttpResponse
from django.http import JsonResponse
from django.shortcuts import get_object_or_404
from django.shortcuts import redirect
from django.shortcuts import render
from django.template.context_processors import csrf
from django.template.response import TemplateResponse
from django.urls import reverse
from django.utils.decorators import method_decorator
from django.utils.html import format_html
from django.utils.translation import gettext_lazy as _
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_POST
from django.views.generic import DetailView
from django.views.generic import FormView
from django.views.generic import TemplateView
from crispy_forms.utils import render_crispy_form
from guardian.shortcuts import get_perms as guardian_get_perms
from openpyxl import Workbook
from openpyxl.styles import Alignment
from openpyxl.styles import Border
from openpyxl.styles import Font
from openpyxl.styles import NamedStyle
from openpyxl.styles import Side
from component_catalog.forms import ComponentAjaxForm
from component_catalog.license_expression_dje import build_licensing
from component_catalog.license_expression_dje import parse_expression
from component_catalog.models import Component
from component_catalog.models import Package
from component_catalog.models import Subcomponent
from dejacode_toolkit.purldb import PurlDB
from dejacode_toolkit.scancodeio import ScanCodeIO
from dejacode_toolkit.scancodeio import get_hash_uid
from dejacode_toolkit.scancodeio import get_package_download_url
from dejacode_toolkit.scancodeio import get_scan_results_as_file_url
from dejacode_toolkit.utils import sha1
from dejacode_toolkit.vulnerablecode import VulnerableCode
from dje import tasks
from dje.client_data import add_client_data
from dje.filters import BooleanChoiceFilter
from dje.filters import HasCountFilter
from dje.models import DejacodeUser
from dje.models import History
from dje.templatetags.dje_tags import urlize_target_blank
from dje.utils import chunked
from dje.utils import get_help_text
from dje.utils import get_object_compare_diff
from dje.utils import group_by_simple
from dje.utils import is_uuid4
from dje.views import DataspacedCreateView
from dje.views import DataspacedDeleteView
from dje.views import DataspacedFilterView
from dje.views import DataspacedModelFormMixin
from dje.views import DataspacedUpdateView
from dje.views import DataspaceScopeMixin
from dje.views import ExportCycloneDXBOMView
from dje.views import ExportSPDXDocumentView
from dje.views import GetDataspacedObjectMixin
from dje.views import Header
from dje.views import LicenseDataForBuilderMixin
from dje.views import ObjectDetailsView
from dje.views import PreviousNextPaginationMixin
from dje.views import SendAboutFilesView
from dje.views import TabContentView
from dje.views import TabField
from dje.views import TableHeaderMixin
from dje.views_formset import FormSetView
from license_library.filters import LicenseFilterSet
from license_library.models import License
from license_library.models import LicenseAssignedTag
from product_portfolio.filters import CodebaseResourceFilterSet
from product_portfolio.filters import DependencyFilterSet
from product_portfolio.filters import ProductComponentFilterSet
from product_portfolio.filters import ProductFilterSet
from product_portfolio.filters import ProductPackageFilterSet
from product_portfolio.forms import AttributionConfigurationForm
from product_portfolio.forms import BaseProductRelationshipInlineFormSet
from product_portfolio.forms import ComparisonExcludeFieldsForm
from product_portfolio.forms import ImportFromScanForm
from product_portfolio.forms import ImportManifestsForm
from product_portfolio.forms import LoadSBOMsForm
from product_portfolio.forms import ProductComponentForm
from product_portfolio.forms import ProductComponentInlineForm
from product_portfolio.forms import ProductCustomComponentForm
from product_portfolio.forms import ProductForm
from product_portfolio.forms import ProductGridConfigurationForm
from product_portfolio.forms import ProductPackageForm
from product_portfolio.forms import ProductPackageInlineForm
from product_portfolio.forms import PullProjectDataForm
from product_portfolio.forms import TableInlineFormSetHelper
from product_portfolio.models import RELATION_LICENSE_EXPRESSION_HELP_TEXT
from product_portfolio.models import CodebaseResource
from product_portfolio.models import Product
from product_portfolio.models import ProductComponent
from product_portfolio.models import ProductDependency
from product_portfolio.models import ProductPackage
from product_portfolio.models import ProductRelationshipMixin
from product_portfolio.models import ScanCodeProject
from vulnerabilities.filters import ProductVulnerabilityFilterSet
from vulnerabilities.forms import VulnerabilityAnalysisForm
from vulnerabilities.models import AffectedByVulnerabilityMixin
from vulnerabilities.models import Vulnerability
from vulnerabilities.models import VulnerabilityAnalysis
class BaseProductViewMixin:
model = Product
slug_url_kwarg = ("name", "version")
def get_queryset(self):
return self.model.objects.get_queryset(
user=self.request.user,
perms="view_product",
)
class ProductListView(
LoginRequiredMixin,
DataspacedFilterView,
):
model = Product
filterset_class = ProductFilterSet
template_name = "product_portfolio/product_list.html"
template_list_table = "product_portfolio/includes/product_list_table.html"
paginate_by = 50
put_results_in_session = False
group_name_version = True
table_headers = (
Header("name", "Product name"),
Header("version", "Version"),
Header("license_expression", "License", filter="licenses"),
Header("primary_language", "Language", filter="primary_language"),
Header("owner", "Owner"),
Header("configuration_status", "Status", filter="configuration_status"),
Header("productinventoryitem_count", "Inventory", help_text="Inventory count"),
Header("keywords", "Keywords", filter="keywords"),
)
def get_queryset(self):
return (
self.model.objects.get_queryset(
user=self.request.user,
perms="view_product",
)
.only(
"uuid",
"name",
"version",
"license_expression",
"owner",
"primary_language",
"keywords",
"configuration_status",
"request_count",
"dataspace",
)
.select_related(
"owner",
"configuration_status",
)
.prefetch_related(
"licenses__usage_policy",
)
.annotate(
productinventoryitem_count=Count("productinventoryitem"),
)
.order_by(
"name",
"version",
)
)
def get_extra_add_urls(self):
extra_add_urls = super().get_extra_add_urls()
user = self.request.user
if user.has_perm("product_portfolio.add_productcomponent"):
extra_add_urls.append(
(
"Import product components",
reverse("admin:product_portfolio_productcomponent_import"),
)
)
if user.has_perm("product_portfolio.add_productpackage"):
extra_add_urls.append(
(
"Import product packages",
reverse("admin:product_portfolio_productpackage_import"),
)
)
if user.has_perm("product_portfolio.add_codebaseresource"):
extra_add_urls.append(
(
"Import codebase resources",
reverse("admin:product_portfolio_codebaseresource_import"),
)
)
return extra_add_urls
class ProductDetailsView(
LoginRequiredMixin,
BaseProductViewMixin,
ObjectDetailsView,
):
template_name = "product_portfolio/product_details.html"
include_reference_dataspace = False
show_previous_and_next_object_links = False
tabset = {
"essentials": {
"fields": [
"display_name",
"name",
"version",
"owner",
"description",
"configuration_status",
"copyright",
"homepage_url",
"keywords",
"primary_language",
"release_date",
"contact",
"vcs_url",
"code_view_url",
"bug_tracking_url",
"dataspace",
],
},
"inventory": {
"fields": [
"components",
"packages",
],
},
"codebase": {
"fields": [
"path",
"is_deployment_path",
"components",
"packages",
"deployed_from",
"deployed_to",
],
},
"hierarchy": {
"fields": [
"components",
],
},
"notice": {
"fields": [
"notice_text",
],
},
"license": {
"fields": [
"license_expression",
"licenses",
],
},
"owner": {
"fields": [
"owner",
],
},
"vulnerabilities": {},
"dependencies": {
"fields": [
"dependencies",
],
},
"activity": {},
"imports": {},
"history": {
"fields": [
"created_date",
"created_by",
"last_modified_date",
"last_modified_by",
],
},
}
def get_queryset(self):
licenses_prefetch = Prefetch("licenses", License.objects.select_related("usage_policy"))
productcomponent_qs = ProductComponent.objects.select_related(
"component__dataspace",
"component__owner__dataspace",
"component__usage_policy",
"review_status",
"purpose",
).prefetch_related(
"component__packages",
"component__children",
licenses_prefetch,
)
productpackage_qs = ProductPackage.objects.select_related(
"package__dataspace",
"package__usage_policy",
"review_status",
"purpose",
).prefetch_related(
licenses_prefetch,
)
return (
super()
.get_queryset()
.select_related(
"owner",
"configuration_status",
)
.prefetch_related(
"licenses__category",
"licenses__usage_policy",
"scancodeprojects",
LicenseAssignedTag.prefetch_for_license_tab(),
Prefetch("productcomponents", queryset=productcomponent_qs),
Prefetch("productpackages", queryset=productpackage_qs),
)
)
def get_tabsets(self):
self.filter_productpackage = ProductPackageFilterSet(
self.request.GET,
queryset=self.object.productpackages,
dataspace=self.object.dataspace,
prefix="inventory",
anchor="#inventory",
)
self.filter_productcomponent = ProductComponentFilterSet(
self.request.GET,
queryset=self.object.productcomponents,
dataspace=self.object.dataspace,
prefix="inventory",
anchor="#inventory",
)
return super().get_tabsets()
def tab_essentials(self):
tab_fields = [
TabField("name"),
TabField("version"),
TabField("owner", source="owner.get_absolute_link"),
TabField("description"),
TabField("configuration_status"),
TabField("copyright"),
TabField("homepage_url", value_func=urlize_target_blank),
TabField("keywords", source="keywords", value_func=lambda x: "\n".join(x)),
TabField("primary_language"),
TabField("release_date"),
TabField("contact"),
TabField("vcs_url", value_func=urlize_target_blank),
TabField("code_view_url", value_func=urlize_target_blank),
TabField("bug_tracking_url", value_func=urlize_target_blank),
TabField("dataspace"),
]
return {"fields": self.get_tab_fields(tab_fields)}
def tab_notice(self):
if self.object.notice_text:
return {"fields": self.get_tab_fields([TabField("notice_text")])}
def tab_hierarchy(self):
template = "product_portfolio/tabs/tab_hierarchy.html"
product = self.object
productcomponent_qs = (
product.productcomponents.select_related(
"component",
)
.prefetch_related(
"component__licenses",
)
.annotate(
children_count=Count("component__children"),
vulnerability_count=Count("component__affected_by_vulnerabilities"),
)
.order_by(
"feature",
"component__name",
"component__version",
"name",
"version",
)
)
declared_dependencies_prefetch = Prefetch(
"package__declared_dependencies", ProductDependency.objects.product(product)
)
productpackage_qs = (
product.productpackages.select_related(
"package",
)
.prefetch_related(
"package__licenses",
declared_dependencies_prefetch,
)
.annotate(
vulnerability_count=Count("package__affected_by_vulnerabilities"),
)
.order_by(
"feature",
"package__type",
"package__namespace",
"package__name",
"package__version",
"package__filename",
)
)
is_deployed = self.request.GET.get("hierarchy-is_deployed")
if is_deployed:
is_deployed_filter = BooleanChoiceFilter(field_name="is_deployed")
productcomponent_qs = is_deployed_filter.filter(productcomponent_qs, is_deployed)
productpackage_qs = is_deployed_filter.filter(productpackage_qs, is_deployed)
is_vulnerable = self.request.GET.get("hierarchy-is_vulnerable")
if is_vulnerable:
is_vulnerable_filter = HasCountFilter(field_name="vulnerability")
productcomponent_qs = is_vulnerable_filter.filter(productcomponent_qs, is_vulnerable)
productpackage_qs = is_vulnerable_filter.filter(productpackage_qs, is_vulnerable)
if not (productcomponent_qs or productpackage_qs or is_deployed):
return
relations_feature_grouped = defaultdict(list)
for relation_qs in [productcomponent_qs, productpackage_qs]:
for feature, relation in relation_qs.group_by("feature").items():
relations_feature_grouped[feature].extend(relation)
context = {
"verbose_name": self.model._meta.verbose_name,
"verbose_name_plural": self.model._meta.verbose_name_plural,
"relations_feature_grouped": dict(sorted(relations_feature_grouped.items())),
"is_deployed": is_deployed,
"is_vulnerable": is_vulnerable,
}
return {"fields": [(None, context, None, template)]}
def tab_inventory(self):
productcomponents_count = self.object.productcomponents.count()
productpackages_count = self.object.productpackages.count()
inventory_count = productcomponents_count + productpackages_count
if not inventory_count:
return
label = f'Inventory <span class="badge text-bg-primary">{inventory_count}</span>'
template = "tabs/tab_async_loader.html"
# Pass the current request query context to the async request
tab_view_url = self.object.get_url("tab_inventory")
if full_query_string := self.request.META["QUERY_STRING"]:
tab_view_url += f"?{full_query_string}"
tab_context = {
"tab_view_url": tab_view_url,
"tab_object_name": "inventory",
}
return {
"label": format_html(label),
"fields": [(None, tab_context, None, template)],
}
def tab_dependencies(self):
dependencies_count = self.object.dependencies.count()
if not dependencies_count:
return
label = f'Dependencies <span class="badge text-bg-primary">{dependencies_count}</span>'
template = "tabs/tab_async_loader.html"
# Pass the current request query context to the async request
tab_view_url = self.object.get_url("tab_dependencies")
if full_query_string := self.request.META["QUERY_STRING"]:
tab_view_url += f"?{full_query_string}"
tab_context = {
"tab_view_url": tab_view_url,
"tab_object_name": "dependencies",
}
return {
"label": format_html(label),
"fields": [(None, tab_context, None, template)],
}
def tab_vulnerabilities(self):
dataspace = self.object.dataspace
vulnerablecode = VulnerableCode(self.object.dataspace)
display_tab_contions = [
dataspace.enable_vulnerablecodedb_access,
vulnerablecode.is_configured(),
]
if not all(display_tab_contions):
return
vulnerability_count = self.object.vulnerability_count
if not vulnerability_count:
label = 'Vulnerabilities <span class="badge bg-secondary">0</span>'
return {
"label": format_html(label),
"fields": [],
"disabled": True,
"tooltip": "No vulnerabilities found in this Product",
}
label = (
f'Vulnerabilities <span class="badge badge-vulnerability">{vulnerability_count}</span>'
)
# Pass the current request query context to the async request
tab_view_url = self.object.get_url("tab_vulnerabilities")
if full_query_string := self.request.META["QUERY_STRING"]:
tab_view_url += f"?{full_query_string}"
template = "tabs/tab_async_loader.html"
tab_context = {
"tab_view_url": tab_view_url,
"tab_object_name": "vulnerabilities",
}
return {
"label": format_html(label),
"fields": [(None, tab_context, None, template)],
}
def tab_codebase(self):
codebaseresources_count = self.object.codebaseresources.count()
if not codebaseresources_count:
return
label = f'Codebase <span class="badge text-bg-primary">{codebaseresources_count}</span>'
template = "tabs/tab_async_loader.html"
# Pass the current request query context to the async request
tab_view_url = self.object.get_url("tab_codebase")
if full_query_string := self.request.META["QUERY_STRING"]:
tab_view_url += f"?{full_query_string}"
tab_context = {
"tab_view_url": tab_view_url,
"tab_object_name": "codebase resources",
}
return {
"label": format_html(label),
"fields": [(None, tab_context, None, template)],
}
def tab_activity(self, exclude_product_context=False):
return super().tab_activity(exclude_product_context=True)
def tab_imports(self):
scancodeprojects_count = self.object.scancodeprojects.count()
if not scancodeprojects_count:
return
label = f'Imports <span class="badge text-bg-primary">{scancodeprojects_count}</span>'
template = "tabs/tab_async_loader.html"
# Pass the current request query context to the async request
tab_view_url = self.object.get_url("tab_imports")
if full_query_string := self.request.META["QUERY_STRING"]:
tab_view_url += f"?{full_query_string}"
tab_context = {
"tab_view_url": tab_view_url,
"tab_object_name": "imports",
}
return {
"label": format_html(label),
"fields": [(None, tab_context, None, template)],
}
def get_context_data(self, **kwargs):
user = self.request.user
dataspace = user.dataspace
# This behavior does not works well in the context of getting informed about
# tasks completion on the Product.
if user.is_authenticated:
self.object.mark_all_notifications_as_read(user)
context = super().get_context_data(**kwargs)
context["has_change_codebaseresource_permission"] = user.has_perm(
"product_portfolio.change_codebaseresource"
)
context["filter_productcomponent"] = self.filter_productcomponent
context["filter_productpackage"] = self.filter_productpackage
# The reference data label and help does not make sense in the Product context
context["is_reference_data"] = None
perms = guardian_get_perms(user, self.object)
context["has_change_permission"] = "change_product" in perms
context["has_delete_permission"] = "delete_product" in perms
context["has_edit_productpackage"] = all(
[
user.has_perm("product_portfolio.change_productpackage"),
context["has_change_permission"],
]
)
context["has_delete_productpackage"] = user.has_perm(
"product_portfolio.delete_productpackage"
)
context["has_add_productcomponent"] = all(
[
user.has_perm("product_portfolio.add_productcomponent"),
context["has_change_permission"],
]
)
context["has_edit_productcomponent"] = all(
[
user.has_perm("product_portfolio.change_productcomponent"),
context["has_change_permission"],
]
)
context["has_delete_productcomponent"] = user.has_perm(
"product_portfolio.delete_productcomponent"
)
if context["has_edit_productpackage"] or context["has_edit_productcomponent"]:
all_licenses = License.objects.scope(dataspace).filter(is_active=True)
add_client_data(self.request, license_data=all_licenses.data_for_expression_builder())
scancodeio = ScanCodeIO(dataspace)
include_scancodeio_features = all(
[
scancodeio.is_configured(),
user.is_superuser,
dataspace.enable_package_scanning,
context["is_user_dataspace"],
]
)
context["has_scan_all_packages"] = include_scancodeio_features
if include_scancodeio_features:
context["pull_project_data_form"] = PullProjectDataForm()
context["display_scan_features"] = True
context["purldb_enabled"] = all(
[
PurlDB(user.dataspace).is_configured(),
user.dataspace.enable_purldb_access,
context["is_user_dataspace"],
]
)
return context
class ProductTabInventoryView(
LoginRequiredMixin,
BaseProductViewMixin,
PreviousNextPaginationMixin,
TabContentView,
):
template_name = "product_portfolio/tabs/tab_inventory.html"
paginate_by = settings.TAB_PAGINATE_BY
query_dict_page_param = "inventory-page"
tab_id = "inventory"
def get_context_data(self, **kwargs):
context = super().get_context_data(**kwargs)
user = self.request.user
dataspace = user.dataspace
context["inventory_count"] = self.object.productinventoryitem_set.count()
license_qs = License.objects.select_related("usage_policy")
declared_dependencies_qs = ProductDependency.objects.product(self.object)
package_qs = (
Package.objects.select_related(
"dataspace",
"usage_policy",
)
.prefetch_related(Prefetch("declared_dependencies", declared_dependencies_qs))
.with_vulnerability_count()
)
component_qs = Component.objects.select_related(
"dataspace",
"owner__dataspace",
"usage_policy",
).with_vulnerability_count()
productpackage_qs = (
self.object.productpackages.select_related(
"review_status",
"purpose",
)
.prefetch_related(
Prefetch("licenses", license_qs),
Prefetch("package", package_qs),
)
.order_by(
"feature",
"package__type",
"package__namespace",
"package__name",
"package__version",
"package__filename",
)
)
filter_productpackage = ProductPackageFilterSet(
self.request.GET,
queryset=productpackage_qs,
dataspace=self.object.dataspace,
prefix=self.tab_id,
anchor="#inventory",
)
productcomponent_qs = (
self.object.productcomponents.select_related(
"review_status",
"purpose",
)
.prefetch_related(
Prefetch("component", component_qs),
Prefetch("licenses", license_qs),
"component__packages",
"component__children",
)
.order_by(
"feature",
"component__name",
"component__version",
"name",
"version",
)
)
filter_productcomponent = ProductComponentFilterSet(
self.request.GET,
queryset=productcomponent_qs,
dataspace=self.object.dataspace,
prefix=self.tab_id,
anchor="#inventory",
)
productcomponent_qs = filter_productcomponent.qs
productpackage_qs = filter_productpackage.qs
# 1. Combine components and packages into a single list of object
filtered_inventory_items = list(productcomponent_qs) + list(productpackage_qs)
display_tab = any(
[
filtered_inventory_items,
filter_productcomponent.is_active(),
filter_productpackage.is_active(),
]
)
if not display_tab:
return
# 2. Paginate the inventory list
paginator = Paginator(filtered_inventory_items, self.paginate_by)
page_number = self.request.GET.get(self.query_dict_page_param)
page_obj = paginator.get_page(page_number)
# 3. Group objects by features
object_list = page_obj.object_list
objects_by_feature = defaultdict(list)
for feature, items in group_by_simple(object_list, "feature").items():
objects_by_feature[feature].extend(items)
# Sort the dictionary by features, so "no-features" items are first
objects_by_feature = dict(sorted(objects_by_feature.items()))
# 4. Inject the Scan data when activated
scancodeio = ScanCodeIO(dataspace)
display_scan_features = all(
[
scancodeio.is_configured(),
dataspace.enable_package_scanning,
productpackage_qs,
]
)
if display_scan_features:
context["display_scan_features"] = True
self.inject_scan_data(scancodeio, objects_by_feature, dataspace.uuid)
# 5. Display the compliance alert based on license policies
if self.show_licenses_policy:
context["show_licenses_policy"] = True
compliance_alerts = set(
alert
for inventory_item in filtered_inventory_items
for alert in inventory_item.compliance_alerts
)
if "error" in compliance_alerts:
context["compliance_errors"] = True
context.update(
{
"filter_productcomponent": filter_productcomponent,
"inventory_items": dict(objects_by_feature.items()),
"page_obj": page_obj,
"search_query": self.request.GET.get("inventory-q", ""),
}
)
perms = guardian_get_perms(user, self.object)
has_product_change_permission = "change_product" in perms
context["has_edit_productcomponent"] = all(
[
has_product_change_permission,
user.has_perm("product_portfolio.change_productcomponent"),
]
)
context["has_edit_productpackage"] = all(
[
has_product_change_permission,
user.has_perm("product_portfolio.change_productpackage"),
]
)
context["has_delete_productpackage"] = user.has_perm(
"product_portfolio.delete_productpackage"
)
context["has_delete_productcomponent"] = user.has_perm(
"product_portfolio.delete_productcomponent"
)
if page_obj:
previous_url, next_url = self.get_previous_next(page_obj)
context.update(
{
"previous_url": (previous_url or "") + f"#{self.tab_id}",
"next_url": (next_url or "") + f"#{self.tab_id}",
}
)
context["help_texts"] = {
"purpose": get_help_text(Subcomponent, "purpose"),
"license_expression": RELATION_LICENSE_EXPRESSION_HELP_TEXT,
"review_status": get_help_text(ProductRelationshipMixin, "review_status"),
"is_deployed": get_help_text(ProductRelationshipMixin, "is_deployed"),
"is_modified": get_help_text(ProductRelationshipMixin, "is_modified"),
"risk_score": get_help_text(AffectedByVulnerabilityMixin, "risk_score"),
}
return context
@staticmethod
def inject_scan_data(scancodeio, feature_grouped, dataspace_uuid):
download_urls = [
product_package.package.download_url
for product_packages in feature_grouped.values()
for product_package in product_packages
if isinstance(product_package, ProductPackage)
]
# WARNING: Do not trigger a Request for an empty list of download_urls
if not download_urls:
return
scoped_url_uids = [
f"{get_hash_uid(url)}.{get_hash_uid(dataspace_uuid)}" for url in download_urls
]
scans = []
max_results_per_page = 50
for names in chunked(scoped_url_uids, chunk_size=max_results_per_page):
scan_list_data = scancodeio.fetch_scan_list(names=",".join(names))
if scan_list_data:
scans.extend(scan_list_data.get("results", []))
if not scans:
return
scans_by_uri = {get_package_download_url(scan): scan for scan in scans}
injected_feature_grouped = {}
for feature_label, productpackages in feature_grouped.items():
injected_productpackages = []
for productpackage in productpackages:
if not isinstance(productpackage, ProductPackage):
continue
scan = scans_by_uri.get(productpackage.package.download_url)
if scan:
scan["download_result_url"] = get_scan_results_as_file_url(scan)
productpackage.scan = scan
injected_productpackages.append(productpackage)
if injected_productpackages:
injected_feature_grouped[feature_label] = injected_productpackages
return injected_feature_grouped
class ProductTabCodebaseView(
LoginRequiredMixin,
BaseProductViewMixin,
PreviousNextPaginationMixin,
TabContentView,
):
template_name = "product_portfolio/tabs/tab_codebase.html"
paginate_by = 25
query_dict_page_param = "codebase-page"
tab_id = "codebase"
def get_context_data(self, **kwargs):
context_data = super().get_context_data(**kwargs)
codebaseresource_qs = CodebaseResource.objects.filter(
product=self.object
).default_select_prefetch()
filter_codebaseresource = CodebaseResourceFilterSet(
self.request.GET,
queryset=codebaseresource_qs,
dataspace=self.object.dataspace,
prefix=self.tab_id,
)
paginator = Paginator(filter_codebaseresource.qs, self.paginate_by)
page_number = self.request.GET.get(self.query_dict_page_param)
page_obj = paginator.get_page(page_number)
fields = [
"path",
"is_deployment_path",
"product_component",
"product_package",
"additional_details",
"deployed_from_paths",
"deployed_to_paths",
]
codebase_resources = [
{field: getattr(resource, field, None) for field in fields}
for resource in page_obj.object_list
]
def has_any_values(field_name):
filter_is_active = field_name in filter_codebaseresource.form.changed_data
if filter_is_active:
return True
return any(
[
resource.get(field_name)
for resource in codebase_resources
if resource.get(field_name)
]
)
context_data.update(
{
"filter_codebaseresource": filter_codebaseresource,