orcid validation, migration edits

Author: klpoland

gateway/sds_gateway/users/migrations/0011_user_orcid_id_alter_user_is_approved.py

@@ -1,6 +1,7 @@
 # Generated by Django 4.2.14 on 2025-09-04 12:52
 
 from django.db import migrations, models
+from ..validators import validate_orcid_id
 
 
 class Migration(migrations.Migration):
@@ -13,11 +14,11 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='user',
             name='orcid_id',
-            field=models.CharField(blank=True, max_length=255, verbose_name='ORCID ID'),
-        ),
-        migrations.AlterField(
-            model_name='user',
-            name='is_approved',
-            field=models.BooleanField(default=True, help_text='Designates whether this user has been approved to use the API by an Admin.', verbose_name='Approved'),
+            field=models.CharField(
+                blank=True, 
+                max_length=19, 
+                validators=[validate_orcid_id],
+                verbose_name='ORCID ID'
+            ),
         ),
     ]

gateway/sds_gateway/users/models.py

@@ -13,6 +13,7 @@
 
 from .managers import APIKeyUserManager
 from .managers import UserManager
+from .validators import validate_orcid_id
 
 
 class User(AbstractUser):
@@ -28,7 +29,9 @@ class User(AbstractUser):
     username: str | None = None
     name = models.CharField(_("Name of User"), blank=True, max_length=255)
     email = models.EmailField(_("Email address"), unique=True)
-    orcid_id = models.CharField(_("ORCID ID"), blank=True, max_length=255)
+    orcid_id = models.CharField(
+        _("ORCID ID"), blank=True, max_length=19, validators=[validate_orcid_id]
+    )
     is_approved = models.BooleanField(
         _("Approved"),
         default=settings.SDS_NEW_USERS_APPROVED_ON_CREATION,
@@ -38,7 +41,7 @@ class User(AbstractUser):
     )
 
     USERNAME_FIELD = "email"
-    REQUIRED_FIELDS = []
+    REQUIRED_FIELDS: list[str] = []
 
     objects = UserManager()
 

gateway/sds_gateway/users/validators.py

@@ -0,0 +1,17 @@
+"""Custom validators for the users app."""
+
+import re
+
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+
+def validate_orcid_id(value):
+    """Validate the ORCID ID format."""
+    if not value:
+        return value
+
+    if not re.match(r"^\d{4}-\d{4}-\d{4}-\d{4}$", value):
+        raise ValidationError(_("ORCID ID must be in the format 0000-0000-0000-0000."))
+
+    return value