Merge pull request #7335 from specify/issue-7334

[reorganization]:Move inheritance logic to its own app

Author: CarolineDenis

specifyweb/backend/inheritance/api.py

@@ -0,0 +1,61 @@
+from specifyweb.backend.inheritance.utils import get_cat_num_inheritance_setting, get_parent_cat_num_inheritance_setting
+from specifyweb.specify.models import Collectionobject, Collectionobjectgroupjoin
+
+def parent_inheritance_post_query_processing(query, tableid, field_specs, collection, user, should_list_query=True): # pragma: no cover
+    if tableid == 1 and 'catalogNumber' in [fs.fieldspec.join_path[0].name for fs in field_specs if fs.fieldspec.join_path]:
+        if not get_parent_cat_num_inheritance_setting(collection, user):
+            return list(query)
+
+        # Get the catalogNumber field index
+        catalog_number_field_index = [fs.fieldspec.join_path[0].name for fs in field_specs].index('catalogNumber') + 1
+
+        if field_specs[catalog_number_field_index - 1].op_num != 1:
+            return list(query)
+
+        results = list(query)
+        updated_results = []
+
+        # Map results, replacing null catalog numbers with the parent catalog number
+        for result in results:
+            result = list(result)
+            if result[catalog_number_field_index] is None or result[catalog_number_field_index] == '':
+                component_id = result[0]  # Assuming the first column is the child's ID
+                component_obj = Collectionobject.objects.filter(id=component_id).first()
+                if component_obj and component_obj.componentParent:
+                    result[catalog_number_field_index] = component_obj.componentParent.catalognumber
+            updated_results.append(tuple(result))
+
+        return updated_results
+
+    return query
+
+def cog_inheritance_post_query_processing(query, tableid, field_specs, collection, user):
+    if tableid == 1 and 'catalogNumber' in [fs.fieldspec.join_path[0].name for fs in field_specs if fs.fieldspec.join_path]:
+        if not get_cat_num_inheritance_setting(collection, user):
+            # query = query.filter(collectionobjectgroupjoin_1.isprimary == 1)
+            return list(query)
+
+        # Get the catalogNumber field index
+        catalog_number_field_index = [fs.fieldspec.join_path[0].name for fs in field_specs if fs.fieldspec.join_path].index('catalogNumber') + 1
+
+        if field_specs[catalog_number_field_index - 1].op_num != 1:
+            return list(query)
+
+        results = list(query)
+        updated_results = []
+
+        # Map results, replacing null catalog numbers with the collection object group primary collection catalog number
+        for result in results:
+            result = list(result)
+            if result[catalog_number_field_index] is None or result[catalog_number_field_index] == '':
+                cojo = Collectionobjectgroupjoin.objects.filter(childco_id=result[0]).first()
+                if cojo:
+                    primary_cojo = Collectionobjectgroupjoin.objects.filter(
+                        parentcog=cojo.parentcog, isprimary=True).first()
+                    if primary_cojo:
+                        result[catalog_number_field_index] = primary_cojo.childco.catalognumber
+            updated_results.append(tuple(result))
+
+        return updated_results
+
+    return query

specifyweb/specify/tests/test_catalog_number_for_sibling.py renamed to specifyweb/backend/inheritance/tests/test_catalog_number_for_sibling.py

@@ -16,7 +16,7 @@ def setUp(self):
     def test_no_id_error(self):
         co = self.collectionobjects[0]
         response = self.c.post(
-            "/api/specify/catalog_number_for_sibling/",
+            "/inheritance/catalog_number_for_sibling/",
             json.dumps(dict(catalognumber=co.catalognumber)),
             content_type="application/json"
         )
@@ -27,7 +27,7 @@ def test_no_id_error(self):
     def test_invalid_body(self):
         co = self.collectionobjects[0]
         response = self.c.post(
-            "/api/specify/catalog_number_for_sibling/",
+            "/inheritance/catalog_number_for_sibling/",
             "Not a JSON: Value",
             content_type="application/json"
         )
@@ -38,7 +38,7 @@ def test_invalid_body(self):
     def test_simple_co(self):
         co = self.collectionobjects[0]
         response = self.c.post(
-            "/api/specify/catalog_number_for_sibling/",
+            "/inheritance/catalog_number_for_sibling/",
             json.dumps(dict(id=co.id)),
             content_type="application/json"
         )
@@ -49,7 +49,7 @@ def test_simple_co(self):
     def test_simple_co_catalognumber(self):
         co = self.collectionobjects[0]
         response = self.c.post(
-            "/api/specify/catalog_number_for_sibling/",
+            "/inheritance/catalog_number_for_sibling/",
             json.dumps(dict(id=co.id)),
             content_type="application/json"
         )
@@ -65,7 +65,7 @@ def test_self_is_primary(self):
 
         co = self.collectionobjects[0]
         response = self.c.post(
-            "/api/specify/catalog_number_for_sibling/",
+            "/inheritance/catalog_number_for_sibling/",
             json.dumps(dict(id=co.id, catalognumber=None)),
             content_type="application/json"
         )
@@ -81,7 +81,7 @@ def test_other_is_primary(self):
 
         for co in self.collectionobjects[1:3]:
             response = self.c.post(
-                "/api/specify/catalog_number_for_sibling/",
+                "/inheritance/catalog_number_for_sibling/",
                 json.dumps(dict(id=co.id)),
                 content_type="application/json"
             )
@@ -97,7 +97,7 @@ def test_none_is_primary(self):
 
         for co in self.collectionobjects[1:3]:
             response = self.c.post(
-                "/api/specify/catalog_number_for_sibling/",
+                "/inheritance/catalog_number_for_sibling/",
                 json.dumps(dict(id=co.id)),
                 content_type="application/json"
             )

specifyweb/specify/tests/test_utils/test_get_cat_num_inheritance_setting.py renamed to specifyweb/backend/inheritance/tests/test_get_cat_num_inheritance_setting.py

@@ -1,5 +1,5 @@
+from specifyweb.backend.inheritance.utils import get_cat_num_inheritance_setting
 from specifyweb.specify.tests.test_utils.test_collection_preference_context import TestCollectionPreferenceContext
-from specifyweb.specify.utils import get_cat_num_inheritance_setting
 
 class TestCatNumInheritanceSetting(TestCollectionPreferenceContext):
 

specifyweb/specify/tests/test_utils/test_get_parent_cat_num_inheritance_setting.py renamed to specifyweb/backend/inheritance/tests/test_get_parent_cat_num_inheritance_setting.py

@@ -1,5 +1,5 @@
+from specifyweb.backend.inheritance.utils import get_parent_cat_num_inheritance_setting
 from specifyweb.specify.tests.test_utils.test_collection_preference_context import TestCollectionPreferenceContext
-from specifyweb.specify.utils import get_parent_cat_num_inheritance_setting
 
 class TestCatNumInheritanceSetting(TestCollectionPreferenceContext):
 

specifyweb/backend/inheritance/urls.py

@@ -0,0 +1,12 @@
+
+from django.urls import include, path, re_path
+
+from specifyweb.backend.inheritance import views
+
+urlpatterns = [
+    # cat num for siblings
+    re_path(r'^catalog_number_for_sibling/$', views.catalog_number_for_sibling),
+
+    # cat num for parent
+    re_path(r'^catalog_number_from_parent/$', views.catalog_number_from_parent), 
+]

specifyweb/backend/inheritance/utils.py

@@ -0,0 +1,64 @@
+import json
+import logging
+
+from django.conf import settings
+
+logger = logging.getLogger(__name__)
+
+def get_parent_cat_num_inheritance_setting(collection, user) -> bool:
+    import specifyweb.backend.context.app_resource as app_resource
+
+    parent_inheritance_enabled: bool = False  
+
+    try:
+        collection_prefs_json, _, __ = app_resource.get_app_resource(collection, user, 'CollectionPreferences')
+
+        if collection_prefs_json is not None:
+            collection_prefs_dict = json.loads(collection_prefs_json)
+
+            catalog_number_parent_inheritance = collection_prefs_dict.get('catalogNumberParentInheritance', {})
+            behavior = catalog_number_parent_inheritance.get('behavior', {}) \
+                if isinstance(catalog_number_parent_inheritance, dict) else {}
+            parent_inheritance_enabled = behavior.get('inheritance', False) if isinstance(behavior, dict) else False
+
+            if not isinstance(parent_inheritance_enabled, bool):
+                parent_inheritance_enabled = False
+
+    except json.JSONDecodeError:
+        logger.warning(f"Error: Could not decode JSON for collection preferences")
+    except TypeError as e:
+        logger.warning(f"Error: Unexpected data structure in collection preferences: {e}")
+    except Exception as e:
+        logger.warning(f"An unexpected error occurred: {e}")
+    
+    return parent_inheritance_enabled
+
+
+def get_cat_num_inheritance_setting(collection, user) -> bool:
+    import specifyweb.backend.context.app_resource as app_resource
+
+    inheritance_enabled: bool = False
+
+    try:
+        collection_prefs_json, _, __ = app_resource.get_app_resource(collection, user, 'CollectionPreferences')
+
+        if collection_prefs_json is not None:
+            collection_prefs_dict = json.loads(collection_prefs_json)
+
+            catalog_number_inheritance = collection_prefs_dict.get('catalogNumberInheritance', {})
+            behavior = catalog_number_inheritance.get('behavior', {}) \
+                if isinstance(catalog_number_inheritance, dict) else {}
+            inheritance_enabled = behavior.get('inheritance', False) if isinstance(behavior, dict) else False
+
+            if not isinstance(inheritance_enabled, bool):
+                inheritance_enabled = False
+
+    except json.JSONDecodeError:
+        logger.warning(f"Error: Could not decode JSON for collection preferences")
+    except TypeError as e:
+        logger.warning(f"Error: Unexpected data structure in collection preferences: {e}")
+    except Exception as e:
+        logger.warning(f"An unexpected error occurred: {e}")
+
+    return inheritance_enabled
+

specifyweb/backend/inheritance/views.py

@@ -0,0 +1,89 @@
+import json
+from django import http
+from specifyweb.specify import models
+from specifyweb.specify.views import login_maybe_required
+from django.views.decorators.http import require_POST
+
+
+@login_maybe_required
+@require_POST
+def catalog_number_for_sibling(request: http.HttpRequest):
+    """
+    Returns the catalog number of the primary CO of a COG if one is present 
+    """
+    try:
+        request_data = json.loads(request.body)
+        object_id = request_data.get('id')
+        provided_catalog_number = request_data.get('catalognumber')
+    except json.JSONDecodeError:
+        return http.JsonResponse({'error': 'Invalid JSON body.'}, status=400)
+
+    if object_id is None:
+        return http.JsonResponse({'error': "'id' field is required."}, status=400)
+
+    if provided_catalog_number is not None:
+        return http.JsonResponse(None, safe=False)
+
+    try:
+        # Find the join record for the requesting object and its parent group ID
+        requesting_cojo = models.Collectionobjectgroupjoin.objects.filter(
+            childco_id=object_id
+        ).values('parentcog_id').first()
+
+        if not requesting_cojo:
+            return http.JsonResponse(None, safe=False)
+
+        parent_cog_id = requesting_cojo['parentcog_id']
+
+        primary_cojo = models.Collectionobjectgroupjoin.objects.filter(
+            parentcog_id=parent_cog_id,
+            isprimary=True
+        ).select_related('childco').first()
+
+        # Extract the catalog number if a primary sibling CO exists
+        primary_catalog_number = None
+        if primary_cojo and primary_cojo.childco:
+            primary_catalog_number = primary_cojo.childco.catalognumber
+
+        return http.JsonResponse(primary_catalog_number, safe=False)
+
+    except Exception as e:
+        print(f"Error processing request: {e}")
+        return http.JsonResponse({'error': 'An internal server error occurred.'}, status=500)                  
+                                
+
+@login_maybe_required
+@require_POST
+def catalog_number_from_parent(request: http.HttpRequest):
+    """
+    Returns the catalog number of the parent component
+    """
+    try:
+        request_data = json.loads(request.body)
+        object_id = request_data.get('id')
+        provided_catalog_number = request_data.get('catalognumber')
+    except json.JSONDecodeError:
+        return http.JsonResponse({'error': 'Invalid JSON body.'}, status=400)
+
+    if object_id is None:
+        return http.JsonResponse({'error': "'id' field is required."}, status=400)
+
+    if provided_catalog_number is not None:
+        return http.JsonResponse(None, safe=False)
+
+    try:
+        # Get the child CO
+        child = models.Collectionobject.objects.get(id=object_id)
+
+        # Get the parent CO
+        parent = child.componentParent
+
+        if parent and parent.catalognumber:
+            return http.JsonResponse(parent.catalognumber, safe=False)
+        else:
+            return http.JsonResponse({'error': 'Parent or parent catalog number not found.'}, status=404)
+
+    except Exception as e:
+        print(f"Error processing request: {e}")
+        return http.JsonResponse({'error': 'An internal server error occurred.'}, status=500)  
+