Allow configuring uniqueness rules

specifyweb/businessrules/attachment_rules.py

@@ -16,36 +16,44 @@
 tables_with_attachments = {getattr(models, model.__name__.replace('attachment', ''))
                            for model in attachment_tables}
 
+
 @orm_signal_handler('pre_save')
 def attachment_jointable_save(sender, obj):
-    if sender not in attachment_tables: return
+    if sender not in attachment_tables:
+        return
 
-    if obj.attachment_id is None: raise AbortSave()
+    if obj.attachment_id is None:
+        raise AbortSave()
 
     attachee = get_attachee(obj)
     obj.attachment.tableid = attachee.specify_model.tableId
-    obj.attachment.scopetype, obj.attachment.scopeid = Scoping(attachee)()
+    scopetype, scope = Scoping(attachee)()
+    obj.attachment.scopetype, obj.attachment.scopeid = scopetype, scope.id
     obj.attachment.save()
 
+
 @orm_signal_handler('post_delete')
 def attachment_jointable_deletion(sender, obj):
     if sender in attachment_tables:
         obj.attachment.delete()
 
+
 @orm_signal_handler('pre_save', 'Attachment')
 def attachment_save(attachment):
     if attachment.id is None and attachment.tableid is None:
         # since tableid cannot be null, use Attachment table id as placeholder.
         # the actual table id will be set when the join row is saved. (see above)
         attachment.tableid = models.Attachment.specify_model.tableId
 
+
 @orm_signal_handler('post_delete', 'Attachment')
 def attachment_deletion(attachment):
     from specifyweb.attachment_gw.views import delete_attachment_file
     if attachment.attachmentlocation is not None:
         delete_attachment_file(attachment.attachmentlocation)
 
+
 def get_attachee(jointable_inst):
-    main_table_name = JOINTABLE_NAME_RE.match(jointable_inst.__class__.__name__).group(1)
+    main_table_name = JOINTABLE_NAME_RE.match(
+        jointable_inst.__class__.__name__).group(1)
     return getattr(jointable_inst, main_table_name.lower())
-

specifyweb/businessrules/migrations/0001_initial.py

@@ -0,0 +1,40 @@
+# Generated by Django 3.2.15 on 2023-12-28 22:48
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('specify', '__first__'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='UniquenessRule',
+            fields=[
+                ('id', models.AutoField(db_column='uniquenessruleid', primary_key=True, serialize=False, verbose_name='uniquenessruleid')),
+                ('isDatabaseConstraint', models.BooleanField(db_column='isDatabaseConstraint', default=False)),
+                ('modelName', models.CharField(max_length=256)),
+                ('discipline', models.ForeignKey(db_column='DisciplineID', on_delete=django.db.models.deletion.PROTECT, to='specify.discipline')),
+            ],
+            options={
+                'db_table': 'uniquenessrule',
+            },
+        ),
+        migrations.CreateModel(
+            name='UniquenessRule_Field',
+            fields=[
+                ('uniquenessrule_fieldid', models.AutoField(primary_key=True, serialize=False, verbose_name='uniquenessrule_fieldsid')),
+                ('fieldPath', models.TextField(blank=True, null=True)),
+                ('isScope', models.BooleanField(default=False)),
+                ('uniquenessrule', models.ForeignKey(db_column='uniquenessruleid', on_delete=django.db.models.deletion.CASCADE, to='businessrules.uniquenessrule')),
+            ],
+            options={
+                'db_table': 'uniquenessrule_fields',
+            },
+        ),
+    ]

specifyweb/businessrules/migrations/0002_default_unique_rules.py

@@ -0,0 +1,22 @@
+from django.db import migrations
+
+from specifyweb.specify import models as spmodels
+from specifyweb.businessrules.uniqueness_rules import apply_default_uniqueness_rules
+
+
+def apply_rules_to_discipline(apps, schema_editor):
+    for disp in spmodels.Discipline.objects.all():
+        apply_default_uniqueness_rules(disp)
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ('specify', '__first__'),
+        ('businessrules', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RunPython(apply_rules_to_discipline),
+    ]

specifyweb/businessrules/models.py

@@ -1,5 +1,8 @@
+from django.db import models
+
+from specifyweb.specify import models as spmodels
+
 from . import (
-    uniqueness_rules,
     recordset_rules,
     collector_rules,
     author_rules,
@@ -21,4 +24,67 @@
     fundingagent_rules,
     determiner_rules,
     extractor_rules,
+    preparation_rules
 )
+
+
+class PsuedoManyToManyManager(models.Manager):
+    def __init__(self, base_instance, through_model, through_field) -> None:
+        self.base_instance = base_instance
+        self.through_model = through_model
+        self.through_field = through_field.field.name
+
+        self._related_field_name = [
+            field.name for field in through_model._meta.fields if field.related_model is not None][0]
+
+    def all(self) -> models.QuerySet:
+        return self.through_model.objects.filter(**{self._related_field_name: self.base_instance})
+
+    def filter(self, *args, **kwargs) -> models.QuerySet:
+        return self.all().filter(*args, **kwargs)
+
+    def clear(self):
+        return self.all().delete()
+
+    def add(self, *args, through_defaults={}):
+        for item in args:
+            to_create = {
+                self._related_field_name: self.base_instance,
+                self.through_field: item}
+
+            for field, value in through_defaults.items():
+                to_create[field] = value
+            self.through_model.objects.create(**to_create)
+
+    def set(self, iterable, through_defaults={}):
+        self.clear()
+        self.add(*iterable, through_defaults=through_defaults)
+
+
+class UniquenessRule(models.Model):
+    id = models.AutoField('uniquenessruleid',
+                          primary_key=True, db_column='uniquenessruleid')
+    isDatabaseConstraint = models.BooleanField(
+        default=False, db_column='isDatabaseConstraint')
+    modelName = models.CharField(max_length=256)
+    discipline = models.ForeignKey(
+        spmodels.Discipline, on_delete=models.PROTECT, db_column="DisciplineID")
+
+    @property
+    def fields(self):
+        return PsuedoManyToManyManager(self, UniquenessRule_Field, UniquenessRule_Field.fieldPath)
+
+    class Meta:
+        db_table = 'uniquenessrule'
+
+
+class UniquenessRule_Field(models.Model):
+    uniquenessrule_fieldid = models.AutoField(
+        'uniquenessrule_fieldsid', primary_key=True)
+    uniquenessrule = models.ForeignKey(
+        UniquenessRule, on_delete=models.CASCADE, db_column='uniquenessruleid')
+    fieldPath = models.TextField(null=True, blank=True)
+    isScope = models.BooleanField(default=False)
+
+    class Meta:
+        db_table = "uniquenessrule_fields"

specifyweb/businessrules/orm_signal_handler.py

@@ -1,22 +1,44 @@
+from typing import Callable, Literal, Optional, Hashable
+
 from django.db.models import signals
 from django.dispatch import receiver
 
 from specifyweb.specify import models
 
-def orm_signal_handler(signal, model=None):
+# See https://docs.djangoproject.com/en/3.2/ref/signals/#module-django.db.models.signals
+MODEL_SIGNAL = Literal["pre_init", "post_init", "pre_save",
+                       "post_save", "pre_delete", "post_delete", "m2m_changed"]
+
+
+def orm_signal_handler(signal: MODEL_SIGNAL, model: Optional[str] = None, **kwargs):
     def _dec(rule):
-        receiver_kwargs = {}
+        receiver_kwargs = kwargs
         if model is not None:
             receiver_kwargs['sender'] = getattr(models, model)
+
             def handler(sender, **kwargs):
-                if kwargs.get('raw', False): return
+                if kwargs.get('raw', False):
+                    return
                 # since the rule knows what model the signal comes from
                 # the sender value is redundant.
                 rule(kwargs['instance'])
         else:
             def handler(sender, **kwargs):
-                if kwargs.get('raw', False): return
+                if kwargs.get('raw', False):
+                    return
                 rule(sender, kwargs['instance'])
 
         return receiver(getattr(signals, signal), **receiver_kwargs)(handler)
     return _dec
+
+
+def disconnect_signal(signal: MODEL_SIGNAL, model_name: Optional[str] = None, dispatch_uid: Optional[Hashable] = None) -> bool:
+    fetched_signal = getattr(signals, signal)
+    django_model = None if model_name is None else getattr(models, model_name)
+    return fetched_signal.disconnect(
+        sender=django_model, dispatch_uid=dispatch_uid)
+
+def connect_signal(signal: MODEL_SIGNAL, callback: Callable, model_name: Optional[str] = None, dispatch_uid: Optional[Hashable] = None):
+    fetched_signal = getattr(signals, signal)
+    django_model = None if model_name is None else getattr(models, model_name)
+    return fetched_signal.connect(callback, sender=django_model, dispatch_uid=dispatch_uid)

specifyweb/businessrules/preparation_rules.py

@@ -0,0 +1,7 @@
+from .orm_signal_handler import orm_signal_handler
+
+
+@orm_signal_handler('pre_save', 'Preparation')
+def preparation_pre_save(preparation):
+    if preparation.collectionmemberid is None:
+        preparation.collectionmemberid = preparation.collectionobject.collectionmemberid

specifyweb/businessrules/tests/__init__.py

@@ -34,4 +34,5 @@
 from .storagetreedefitem import *
 from .taxon import *
 from .taxontreedefitem import *
-
+from .preparation import *
+from .uniqueness_rules import *

specifyweb/businessrules/tests/accessionagent.py

@@ -4,6 +4,7 @@
 from specifyweb.specify.api_tests import ApiTests
 from ..exceptions import BusinessRuleException
 
+
 class AccessionAgentTests(ApiTests):
     @skip("rule was removed in 17e82c6157")
     def test_no_duped_agents_in_accession(self):

specifyweb/businessrules/tests/permit.py

@@ -3,6 +3,7 @@
 from specifyweb.specify.api_tests import ApiTests
 from ..exceptions import BusinessRuleException
 
+
 class PermitTests(ApiTests):
     def test_number_is_unique(self):
         models.Permit.objects.create(
@@ -11,6 +12,7 @@ def test_number_is_unique(self):
 
         with self.assertRaises(BusinessRuleException):
             models.Permit.objects.create(
+                institution=self.institution,
                 permitnumber='1')
 
         models.Permit.objects.create(

specifyweb/businessrules/tests/preparation.py

@@ -0,0 +1,57 @@
+from specifyweb.specify import models
+from specifyweb.specify.api_tests import ApiTests
+from ..exceptions import BusinessRuleException
+
+
+class PreparationTests(ApiTests):
+    def test_barcode_unique_to_collection(self):
+        prep_type = models.Preptype.objects.create(
+            name='testPrepType',
+            isloanable=False,
+            collection=self.collection,
+        )
+
+        models.Preparation.objects.create(
+            collectionobject=self.collectionobjects[0],
+            barcode='1',
+            preptype=prep_type
+        )
+        with self.assertRaises(BusinessRuleException):
+            models.Preparation.objects.create(
+                collectionobject=self.collectionobjects[0],
+                barcode='1',
+                preptype=prep_type
+            )
+        with self.assertRaises(BusinessRuleException):
+            models.Preparation.objects.create(
+                collectionobject=self.collectionobjects[1],
+                barcode='1',
+                preptype=prep_type
+            )
+        models.Preparation.objects.create(
+            collectionobject=self.collectionobjects[0],
+            barcode='2',
+            preptype=prep_type
+        )
+
+        other_collection = models.Collection.objects.create(
+            catalognumformatname='test',
+            collectionname='OtherCollection',
+            isembeddedcollectingevent=False,
+            discipline=self.discipline)
+
+        other_co = models.Collectionobject.objects.create(
+            catalognumber='num-1',
+            collection=other_collection,
+        )
+        other_preptype = models.Preptype.objects.create(
+            name='otherPrepType',
+            isloanable=False,
+            collection=other_collection,
+        )
+
+        models.Preparation.objects.create(
+            collectionobject=other_co,
+            barcode='1',
+            preptype=other_preptype
+        )