Move the is_locked field on the ProductStatus model #310

Signed-off-by: tdruez <[email protected]>

Author: tdruez

component_catalog/forms.py

@@ -624,9 +624,10 @@ def __init__(self, user, *args, **kwargs):
         super().__init__(user, *args, **kwargs)
 
         product_field = self.fields["product"]
-        perms = ["view_product", "change_product"]
-        product_field.queryset = Product.objects.get_queryset(user, perms=perms).filter(
-            is_locked=False
+        product_field.queryset = Product.objects.get_queryset(
+            user=user,
+            perms=["view_product", "change_product"],
+            exclude_locked=True,
         )
 
         if relation_instance:
@@ -710,11 +711,11 @@ def __init__(self, request, model, relation_model, *args, **kwargs):
         self.model = model
         self.relation_model = relation_model
         self.dataspace = request.user.dataspace
-        product_qs = Product.objects.get_queryset(
+        self.fields["product"].queryset = Product.objects.get_queryset(
             user=request.user,
             perms=["view_product", "change_product"],
+            exclude_locked=True,
         )
-        self.fields["product"].queryset = product_qs.filter(is_locked=False)
 
     def get_selected_objects(self):
         ids = self.initial.get("ids") or self.cleaned_data["ids"]

dje/tests/testfiles/test_dataset_pp_only.json

@@ -61,7 +61,8 @@
     "default_on_addition": false,
     "label": "Approved",
     "text": "Approved",
-    "request_to_generate": null
+    "request_to_generate": null,
+    "is_locked": false
   }
 },
 {
@@ -94,7 +95,6 @@
     "notice_text": "Starship Widget Framework (SWF) \nis an adaptation of the open source\nOZONE Widget Framework (OWF)\n\nPortions of this software were developed under contract to the U.S. Government, and are made available pursuant to the DFARS clauses cited below.\n\nCopyright 2009-2012, Next Century Corporation.\nThe U.S. Government has Unlimited Rights in this computer software pursuant to\nthe clause DFARS 252.227-7014 of contract no. H98230-07-C-0614. Any\nreproduction of this computer software, or portions thereof, marked with this\nlegend must also reproduce these markings.\n\nCopyright 2009-2010, Texeltek Inc.\nThe U.S. Government has Unlimited Rights in this computer software pursuant to\nthe clause DFARS 252.227-7014 of contract no. H98230-07-C-0046. Any\nreproduction of this computer software, or portions thereof, marked with this\nlegend must also reproduce these markings.\n\nThis product further may include software developed by other individuals, entities, or agencies.  These groups have granted rights to the OWFGOSS Board to apply that code in the OWF or Marketplace code baselines, without further claim or copyright.\n\nThe product further references the following libraries or capabilities which are NOT included as part of this copyright statement, and are hereby listed with their license terms.\n* Ext JS, developed by Sencha, licensed under GNU General Public License, Version 3, http://www.gnu.org/licenses/gpl.html \n* Grails and its supporting capabilities, including Groovy, Hibernate, and Spring.  Available at grails.org, licensed Apache License, Version 2.0, http://grails.org/License\n* YUI Compressor Javascript/CSS compressor , http://yuilibrary.com/license/ (based on BSD license)\n* Dojo cross-domain library, Dojo BSD License, http://dojotoolkit.org/license\n* Shindig messaging library, http://shindig.apache.org/, Apache License, Version 2.0, http://www.apache.org/licenses/\n* JQuery Ajax/eventing library, http://jquery.com, based on MIT License, https://raw.github.com/jquery/jquery/master/MIT-LICENSE.txt\n* Spring Security jars, licensed under Apache License, Version 2, http://www.apache.org/licenses/ \n* log4javascript logging library, http://log4javascript.org,  Apache License, Version 2.0, http://www.apache.org/licenses/\n* stubconsole logging utility, http://getfirebug.com/firebug/firebugx.js, Firebug BSD License, http://fbug.googlecode.com/svn/trunk/license.txt\n* UXMedia, Ext Flash / Flex components, see http://code.google.com/p/uxmedia.  GNU General Public License, Version 3, http://www.gnu.org/licenses/gpl.html \n",
     "license_expression": "commercial-option",
     "is_active": true,
-    "is_locked": false,
     "configuration_status": [
       "nexB",
       "addd9c5d-a5ec-48ec-a565-ddb81092f49d"

product_portfolio/admin.py

@@ -88,6 +88,7 @@ class ProductStatusAdmin(BaseStatusAdmin):
         "label",
         "text",
         "default_on_addition",
+        "is_locked",
         "request_to_generate",
         "get_dataspace",
     )
@@ -99,6 +100,7 @@ class ProductStatusAdmin(BaseStatusAdmin):
                     "label",
                     "text",
                     "default_on_addition",
+                    "is_locked",
                     "request_to_generate",
                     "dataspace",
                     "uuid",
@@ -317,7 +319,6 @@ class ProductAdmin(
         AsLink("owner"),
         AsJoinList("keywords", "<br>", short_description="Keywords"),
         "is_active",
-        "is_locked",
         "configuration_status",
         "primary_language",
         "contact",
@@ -333,7 +334,6 @@ class ProductAdmin(
         ReportingQueryListFilter,
         ("configuration_status", LimitToDataspaceListFilter),
         "is_active",
-        "is_locked",
     )
     search_fields = (
         "name",
@@ -366,7 +366,6 @@ class ProductAdmin(
                     "primary_language",
                     "admin_notes",
                     "is_active",
-                    "is_locked",
                     "configuration_status",
                     "contact",
                     "vulnerabilities_risk_threshold",

product_portfolio/api.py

@@ -119,7 +119,6 @@ class Meta:
             "name",
             "version",
             "owner",
-            "is_locked",
             "configuration_status",
             "license_expression",
             "licenses",

product_portfolio/filters.py

@@ -126,7 +126,6 @@ class Meta:
             "primary_language",
             "configuration_status",
             "keywords",
-            "is_locked",
         ]
 
 

product_portfolio/forms.py

@@ -123,7 +123,6 @@ class Meta:
             "homepage_url",
             "primary_language",
             "is_active",
-            "is_locked",
             "configuration_status",
             "contact",
             "keywords",
@@ -178,7 +177,7 @@ def helper(self):
                 Group("description", "keywords"),
                 Group("primary_language", "homepage_url", "contact"),
                 HTML("<hr>"),
-                Group("is_active", "is_locked", "configuration_status", "release_date"),
+                Group("is_active", "configuration_status", "release_date"),
                 HTML("<hr>"),
                 Group("vulnerabilities_risk_threshold", HTML(""), HTML("")),
                 HTML("<hr>"),
@@ -251,7 +250,6 @@ class Meta:
             "primary_language",
             "admin_notes",
             "is_active",
-            "is_locked",
             "configuration_status",
             "contact",
             "vcs_url",

…tions/0013_product_is_locked_and_more.py …0013_productstatus_is_locked_and_more.pyproduct_portfolio/migrations/0013_product_is_locked_and_more.py renamed to product_portfolio/migrations/0013_productstatus_is_locked_and_more.py product_portfolio/migrations/0013_product_is_locked_and_more.py renamed to product_portfolio/migrations/0013_productstatus_is_locked_and_more.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.1.9 on 2025-05-30 07:11
+# Generated by Django 5.1.9 on 2025-05-30 14:30
 
 import django.db.models.deletion
 from django.db import migrations, models
@@ -13,9 +13,9 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.AddField(
-            model_name='product',
+            model_name='productstatus',
             name='is_locked',
-            field=models.BooleanField(db_index=True, default=False, help_text='Marks this product version as read-only, preventing any modifications to its inventory.', verbose_name='Locked'),
+            field=models.BooleanField(db_index=True, default=False, help_text='Marks this product version as read-only, preventing any modifications to its inventory.', verbose_name='Locked inventory'),
         ),
         migrations.AlterField(
             model_name='productdependency',

product_portfolio/models.py

@@ -115,6 +115,15 @@ class ProductStatus(BaseStatusMixin, DataspacedModel):
             "fields, since DejaCode will be creating the Request automatically."
         ),
     )
+    is_locked = models.BooleanField(
+        verbose_name=_("Locked inventory"),
+        default=False,
+        db_index=True,
+        help_text=_(
+            "Marks this product version as read-only, preventing any modifications to "
+            "its inventory."
+        ),
+    )
 
     class Meta(BaseStatusMixin.Meta):
         verbose_name_plural = _("product status")
@@ -141,7 +150,9 @@ def get_by_natural_key(self, dataspace_name, uuid):
         """
         return self.model.unsecured_objects.get(dataspace__name=dataspace_name, uuid=uuid)
 
-    def get_queryset(self, user=None, perms="view_product", include_inactive=False):
+    def get_queryset(
+        self, user=None, perms="view_product", include_inactive=False, exclude_locked=False
+    ):
         """
         Force the object level protection at the QuerySet level.
         Always Return an empty QuerySet unless a `user` is provided.
@@ -162,6 +173,9 @@ def get_queryset(self, user=None, perms="view_product", include_inactive=False):
             user, perms, klass=queryset_class, accept_global_perms=False
         ).scope(user.dataspace)
 
+        if exclude_locked:
+            queryset = queryset.exclude(configuration_status__is_locked=True)
+
         if include_inactive:
             return queryset
 
@@ -221,16 +235,6 @@ class Product(BaseProductMixin, FieldChangesMixin, KeywordsMixin, DataspacedMode
         ),
     )
 
-    is_locked = models.BooleanField(
-        verbose_name=_("Locked"),
-        default=False,
-        db_index=True,
-        help_text=_(
-            "Marks this product version as read-only, preventing any modifications to "
-            "its inventory."
-        ),
-    )
-
     configuration_status = models.ForeignKey(
         to="product_portfolio.ProductStatus",
         on_delete=models.PROTECT,
@@ -360,6 +364,11 @@ def actions_on_status_change(self):
                 object_id=self.id,
             )
 
+    @cached_property
+    def is_locked(self):
+        if self.configuration_status_id:
+            return self.configuration_status.is_locked
+
     @cached_property
     def all_packages(self):
         return Package.objects.filter(

product_portfolio/views.py

@@ -194,7 +194,6 @@ def get_queryset(self):
                 "primary_language",
                 "keywords",
                 "configuration_status",
-                "is_locked",
                 "request_count",
                 "dataspace",
             )