feat(webportal): Add export to Web Portal function

specifyweb/backend/inheritance/api.py

@@ -1,63 +1,92 @@
+from typing import Any, Callable
+
+from collections.abc import Generator
+
 from specifyweb.backend.inheritance.utils import get_cat_num_inheritance_setting, get_parent_cat_num_inheritance_setting
-from specifyweb.specify.models import Collectionobject, Collectionobjectgroupjoin, Component
-
-def parent_inheritance_post_query_processing(query, tableid, field_specs, collection, user):
-    if tableid == 1029 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 if fs.fieldspec.join_path].index('catalogNumber') + 1
-
-        # op_num 1 is refering to the filter equal, the inheritance will only work if we have cat num equal, other operators will not function
-        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 = Component.objects.filter(id=component_id).first()
-                if component_obj and component_obj.collectionobject:
-                    result[catalog_number_field_index] = component_obj.collectionobject.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
-
-        # op_num 1 is refering to the filter equal, the inheritance will only work if we have cat num equal, other operators will not function
-        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
+from specifyweb.specify.models import Collectionobjectgroupjoin, Component
+
+
+def do_nothing[T](items: T) -> T:
+    return items
+
+
+def parent_inheritance_query_processor(tableid, field_specs, collection, user) -> Callable[[list], list]:
+    first_field_names = [fs.fieldspec.join_path[0].name for fs in field_specs if fs.fieldspec.join_path]
+    if tableid != 1029 or 'catalogNumber' not in first_field_names:
+        return do_nothing
+
+    if not get_parent_cat_num_inheritance_setting(collection, user):
+        return do_nothing
+
+    # Get the catalogNumber field index
+    catalog_number_field_index = first_field_names.index('catalogNumber') + 1
+
+    # op_num 1 is refering to the filter equal, the inheritance will only work if we have cat num equal, other operators will not function
+    if field_specs[catalog_number_field_index - 1].op_num != 1:
+        return do_nothing
+
+    def _processor(row: list):
+        modified_row = list(row)
+        if modified_row[catalog_number_field_index] is None or modified_row[catalog_number_field_index] == '':
+            component_id = row[0]
+            # REFACTOR:(perf) This is relatively pretty slow, we make a
+            # database query for every item in the iterable we're processing
+            component_obj = Component.objects.filter(
+                id=component_id).select_related("collectionobject").first()
+            if component_obj and component_obj.collectionobject:
+                modified_row[catalog_number_field_index] = component_obj.collectionobject.catalognumber
+
+        return modified_row
+
+    return _processor
+
+
+def cog_inheritance_query_processor(tableid, field_specs, collection, user) -> Callable[[list], list]:
+    first_field_names = [fs.fieldspec.join_path[0].name for fs in field_specs if fs.fieldspec.join_path]
+    if tableid != 1 and 'catalogNumber' not in first_field_names:
+        return do_nothing
+
+    if not get_cat_num_inheritance_setting(collection, user):
+        return do_nothing
+
+    # Get the catalogNumber field index
+    catalog_number_field_index = first_field_names.index('catalogNumber') + 1
+
+    # op_num 1 is refering to the filter equal, the inheritance will only work if we have cat num equal, other operators will not function
+    if field_specs[catalog_number_field_index - 1].op_num != 1:
+        return do_nothing
+
+    # For a given result, replace null catalog numbers with the collection
+    # object group primary collection catalog number
+    def _processor(row: list):
+        modified_row = list(row)
+        if modified_row[catalog_number_field_index] is None or modified_row[catalog_number_field_index] == '':
+            child_co_id = modified_row[0]
+            # REFACTOR:(perf) We should be able to combine the queries for cojo
+            # and primary cojo to make one explict database query rather than
+            # two.
+            # Like parent_inheritance_query_processor, this is slow and
+            # makes multiple queries for each item that needs processed
+            cojo = Collectionobjectgroupjoin.objects.filter(
+                childco_id=child_co_id).select_related("parentcog").first()
+            if cojo:
+                primary_cojo = Collectionobjectgroupjoin.objects.filter(
+                    parentcog=cojo.parentcog, isprimary=True).select_related("childco").first()
+                if primary_cojo:
+                    modified_row[catalog_number_field_index] = primary_cojo.childco.catalognumber
+        return modified_row
+
+    return _processor
+
+
+def DefaultQueryProcessors(tableid, field_specs, collection, user) -> list[Callable[[list], list]]:
+    kwargs = {
+        "tableid": tableid,
+        "field_specs": field_specs,
+        "collection": collection,
+        "user": user
+    }
+    return [
+        parent_inheritance_query_processor(**kwargs),
+        cog_inheritance_query_processor(**kwargs)
+    ]