Store additional license fields #63 (#130)

Signed-off-by: tdruez <tdruez@nexb.com>
aboutcode-org · Jul 3, 2024 · 9ba5da0 · 9ba5da0
1 parent 5367624
commit 9ba5da0
Show file tree

Hide file tree

Showing 38 changed files with 1,728 additions and 323 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -28,6 +28,29 @@ Release notes
 - Populate the Package notice_text using "*NOTICE*" file content from Scan "key files".
   https://github.com/nexB/dejacode/issues/136
 
+- Added 2 new license related fields on the Component and Package models:
+  * declared_license_expression
+  * other_license_expression
+  https://github.com/nexB/dejacode/issues/63
+
+- Added 2 properties on the Component and Package models:
+  * declared_license_expression_spdx (computed from declared_license_expression)
+  * other_license_expression_spdx (computed from other_license_expression)
+  https://github.com/nexB/dejacode/issues/63
+
+- Removed 2 fields: Package.declared_license and Component.concluded_license
+  https://github.com/nexB/dejacode/issues/63
+
+- The new license fields are automatically populated from the Package scan
+  "Update packages automatically from scan".
+  The new license fields are pre-filled in the Package form when using the
+  "Add Package" from a PurlDB entry.
+  The new license fields are pre-filled in the Component form when using the
+  "Add Component from Package data".
+  The license expression values provided in the form for the new field is now
+  properly checked and return a validation error when incorrect.
+  https://github.com/nexB/dejacode/issues/63
+
 ### Version 5.1.0
 
 - Upgrade Python version to 3.12 and Django to 5.0.x

diff --git a/component_catalog/admin.py b/component_catalog/admin.py
@@ -324,6 +324,8 @@ class ComponentAdmin(
                     "copyright",
                     "holder",
                     "license_expression",
+                    "declared_license_expression",
+                    "other_license_expression",
                     "reference_notes",
                     "release_date",
                     "description",
@@ -394,7 +396,6 @@ class ComponentAdmin(
                     "ip_sensitivity_approved",
                     "affiliate_obligations",
                     "affiliate_obligation_triggers",
-                    "concluded_license",
                     "legal_comments",
                     "sublicense_allowed",
                     "express_patent_grant",
@@ -418,7 +419,10 @@ class ComponentAdmin(
     autocomplete_lookup_fields = {"fk": ["owner"]}
     # We have to use 'completion_level' rather than the 'completion_level_pct'
     # callable to keep the help_text available during render in the template.
-    readonly_fields = DataspacedAdmin.readonly_fields + ("urn_link", "completion_level")
+    readonly_fields = DataspacedAdmin.readonly_fields + (
+        "urn_link",
+        "completion_level",
+    )
     form = ComponentAdminForm
     inlines = [
         SubcomponentChildInline,
@@ -826,6 +830,8 @@ class PackageAdmin(
             {
                 "fields": (
                     "license_expression",
+                    "declared_license_expression",
+                    "other_license_expression",
                     "copyright",
                     "holder",
                     "author",
@@ -864,7 +870,6 @@ class PackageAdmin(
             "Others",
             {
                 "fields": (
-                    "declared_license",
                     "parties",
                     "datasource_id",
                     "file_references",
@@ -880,7 +885,10 @@ class PackageAdmin(
         ),
         get_additional_information_fieldset(),
     ]
-    readonly_fields = DataspacedAdmin.readonly_fields + ("package_url", "inferred_url")
+    readonly_fields = DataspacedAdmin.readonly_fields + (
+        "package_url",
+        "inferred_url",
+    )
     form = PackageAdminForm
     importer_class = PackageImporter
     mass_update_form = PackageMassUpdateForm

diff --git a/component_catalog/api.py b/component_catalog/api.py
@@ -140,6 +140,8 @@ class Meta:
             "holder",
             "author",
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "reference_notes",
             "homepage_url",
             "vcs_url",
@@ -305,7 +307,6 @@ class Meta:
             "ip_sensitivity_approved",
             "affiliate_obligations",
             "affiliate_obligation_triggers",
-            "concluded_license",
             "legal_comments",
             "sublicense_allowed",
             "express_patent_grant",
@@ -323,6 +324,8 @@ class Meta:
             "licenses_summary",
             "license_choices_expression",
             "license_choices",
+            "declared_license_expression",
+            "other_license_expression",
             "created_date",
             "last_modified_date",
         )
@@ -524,6 +527,8 @@ class Meta(ComponentSerializer.Meta):
             "copyright",
             "holder",
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "reference_notes",
             "release_date",
             "description",
@@ -551,7 +556,6 @@ class Meta(ComponentSerializer.Meta):
             "ip_sensitivity_approved",
             "affiliate_obligations",
             "affiliate_obligation_triggers",
-            "concluded_license",
             "legal_comments",
             "sublicense_allowed",
             "express_patent_grant",
@@ -639,6 +643,8 @@ class Meta:
             "licenses_summary",
             "license_choices_expression",
             "license_choices",
+            "declared_license_expression",
+            "other_license_expression",
             "reference_notes",
             "homepage_url",
             "vcs_url",
@@ -656,7 +662,6 @@ class Meta:
             "version",
             "qualifiers",
             "subpath",
-            "declared_license",
             "parties",
             "datasource_id",
             "file_references",

diff --git a/component_catalog/forms.py b/component_catalog/forms.py
@@ -14,6 +14,7 @@
 from django.urls import reverse
 from django.urls import reverse_lazy
 from django.utils.functional import cached_property
+from django.utils.text import Truncator
 
 import packageurl
 from crispy_forms.helper import FormHelper
@@ -82,6 +83,11 @@ class ComponentForm(
     DataspacedModelForm,
 ):
     default_on_addition_fields = ["configuration_status"]
+    expression_field_names = [
+        "license_expression",
+        "declared_license_expression",
+        "other_license_expression",
+    ]
     save_as = True
     clone_m2m_classes = [
         ComponentAssignedPackage,
@@ -106,6 +112,8 @@ class Meta:
             "holder",
             "notice_text",
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "release_date",
             "description",
             "homepage_url",
@@ -130,6 +138,8 @@ class Meta:
             "owner": OwnerChoiceField,
         }
         widgets = {
+            "declared_license_expression": forms.Textarea(attrs={"rows": 2}),
+            "other_license_expression": forms.Textarea(attrs={"rows": 2}),
             "copyright": forms.Textarea(attrs={"rows": 2}),
             "notice_text": forms.Textarea(attrs={"rows": 2}),
             "description": forms.Textarea(attrs={"rows": 2}),
@@ -188,6 +198,7 @@ def helper(self):
                 Group("name", "version", "owner"),
                 HTML("<hr>"),
                 "license_expression",
+                Group("declared_license_expression", "other_license_expression"),
                 Group("copyright", "holder"),
                 "notice_text",
                 Group("notice_filename", "notice_url"),
@@ -267,6 +278,11 @@ class PackageForm(
     PackageFieldsValidationMixin,
     DataspacedModelForm,
 ):
+    expression_field_names = [
+        "license_expression",
+        "declared_license_expression",
+        "other_license_expression",
+    ]
     save_as = True
     color_initial = True
 
@@ -299,6 +315,8 @@ class Meta:
             "notes",
             "usage_policy",
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "copyright",
             "holder",
             "author",
@@ -320,6 +338,8 @@ class Meta:
             "collect_data",
         ]
         widgets = {
+            "declared_license_expression": forms.Textarea(attrs={"rows": 2}),
+            "other_license_expression": forms.Textarea(attrs={"rows": 2}),
             "description": forms.Textarea(attrs={"rows": 2}),
             "notes": forms.Textarea(attrs={"rows": 2}),
             "copyright": forms.Textarea(attrs={"rows": 2}),
@@ -377,6 +397,7 @@ def helper(self):
                 Group("version", "qualifiers", "subpath"),
                 HTML("<hr>"),
                 "license_expression",
+                Group("declared_license_expression", "other_license_expression"),
                 Group("copyright", "notice_text"),
                 Group("holder", "author"),
                 HTML("<hr>"),
@@ -429,6 +450,12 @@ def save(self, *args, **kwargs):
 
 
 class BaseScanToPackageForm(LicenseExpressionFormMixin, DataspacedModelForm):
+    expression_field_names = [
+        "license_expression",
+        "declared_license_expression",
+        "other_license_expression",
+    ]
+
     @property
     def helper(self):
         helper = FormHelper()
@@ -451,6 +478,8 @@ class Meta:
         fields = [
             "package_url",
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "copyright",
             "primary_language",
             "description",
@@ -482,14 +511,20 @@ def __init__(self, *args, **kwargs):
     def fields_with_initial_value(self):
         kept_fields = {}
 
+        # Duplicate the declared_license_expression into the license_expression field
+        # if currently empty on the Package instance.
+        if not self.instance.license_expression:
+            if declared_license_expression := self.initial.get("declared_license_expression"):
+                self.initial["license_expression"] = declared_license_expression
+
         for field_name, field in self.fields.items():
             if not self.initial.get(field_name):
                 continue
 
             instance_value = getattr(self.instance, field_name, None)
             help_text = "No current value"
             if instance_value:
-                help_text = f"Current value: {instance_value}"
+                help_text = f"Current value: {Truncator(instance_value).chars(200)}"
             field.help_text = help_text
 
             kept_fields[field_name] = field
@@ -524,6 +559,8 @@ class Meta:
         model = Package
         fields = [
             "license_expression",
+            "declared_license_expression",
+            "other_license_expression",
             "primary_language",
             "holder",
         ]
@@ -542,7 +579,7 @@ def set_help_text_with_initial_value(self):
             instance_value = getattr(self.instance, field_name, None)
             help_text = "No current value"
             if instance_value:
-                help_text = f"Current value: {instance_value}"
+                help_text = f"Current value: {Truncator(instance_value).chars(200)}"
             field.help_text = help_text
 
 
@@ -922,6 +959,12 @@ class ComponentAdminForm(
     SetKeywordsChoicesFormMixin,
     DataspacedAdminForm,
 ):
+    expression_field_names = [
+        "license_expression",
+        "declared_license_expression",
+        "other_license_expression",
+    ]
+
     keywords = JSONListField(
         required=False,
         widget=AdminAwesompleteInputWidget(attrs=autocomplete_placeholder),
@@ -956,6 +999,12 @@ class PackageAdminForm(
     SetKeywordsChoicesFormMixin,
     DataspacedAdminForm,
 ):
+    expression_field_names = [
+        "license_expression",
+        "declared_license_expression",
+        "other_license_expression",
+    ]
+
     keywords = JSONListField(
         required=False,
         widget=AdminAwesompleteInputWidget(attrs=autocomplete_placeholder),
@@ -1043,7 +1092,6 @@ class Meta:
             "ip_sensitivity_approved",
             "affiliate_obligations",
             "affiliate_obligation_triggers",
-            "concluded_license",
             "legal_comments",
             "sublicense_allowed",
             "express_patent_grant",