Implemented institution feature.

Signed-off-by: Connor Brock <BrockC2@cardiff.ac.uk>

Author: co505

coldfront/config/core.py

@@ -120,3 +120,9 @@
 
 PROJECT_CODE = ENV.str("PROJECT_CODE", default=None)
 PROJECT_CODE_PADDING = ENV.int("PROJECT_CODE_PADDING", default=None)
+
+# ------------------------------------------------------------------------------
+# Enable project institution code feature.
+# ------------------------------------------------------------------------------
+
+PROJECT_INSTITUTION_EMAIL_MAP = ENV.dict("PROJECT_INSTITUTION_EMAIL_MAP", default={})

coldfront/core/project/admin.py

@@ -25,6 +25,7 @@
 from coldfront.core.utils.common import import_from_settings
 
 PROJECT_CODE = import_from_settings("PROJECT_CODE", False)
+PROJECT_INSTITUTION_EMAIL_MAP = import_from_settings("PROJECT_INSTITUTION_EMAIL_MAP", False)
 
 
 @admin.register(ProjectStatusChoice)
@@ -363,12 +364,18 @@ def get_inline_instances(self, request, obj=None):
             return super().get_inline_instances(request)
 
     def get_list_display(self, request):
+        if not (PROJECT_CODE or PROJECT_INSTITUTION_EMAIL_MAP):
+            return self.list_display
+
+        list_display = list(self.list_display)
+
         if PROJECT_CODE:
-            list_display = list(self.list_display)
             list_display.insert(1, "project_code")
-            return tuple(list_display)
 
-        return self.list_display
+        if PROJECT_INSTITUTION_EMAIL_MAP:
+            list_display.insert(2, "institution")
+
+        return tuple(list_display)
 
     def save_formset(self, request, form, formset, change):
         if formset.model in [ProjectAdminComment, ProjectUserMessage]:

coldfront/core/project/management/commands/add_institutions.py

@@ -0,0 +1,71 @@
+# SPDX-FileCopyrightText: (C) ColdFront Authors
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+from django.core.management.base import BaseCommand
+
+from coldfront.core.project.models import Project
+from coldfront.core.project.utils import determine_automated_institution_choice
+from coldfront.core.utils.common import import_from_settings
+
+PROJECT_INSTITUTION_EMAIL_MAP = import_from_settings("PROJECT_INSTITUTION_EMAIL_MAP", False)
+
+
+class Command(BaseCommand):
+    help = "Update existing projects with institutions based on PIs email address"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--dry-run",
+            action="store_true",
+            help="Outputs each project, followed by the assigned institution, without making changes.",
+        )
+
+    def update_project_institution(self, projects):
+        if not PROJECT_INSTITUTION_EMAIL_MAP:
+            self.stdout.write(
+                "Error, no changes made. Please set PROJECT_INSTITUTION_EMAIL_MAP as a dictionary value inside configuration file."
+            )
+            return
+
+    def _update_project_institution(self, projects):
+        user_input = input(
+            "Assign all existing projects with institutions? You can use the --dry-run flag to preview changes first. [y/N] "
+        )
+
+        try:
+            if user_input == "y" or user_input == "Y":
+                for project in projects:
+                    project.institution = determine_automated_institution_choice(project, PROJECT_INSTITUTION_EMAIL_MAP)
+                    project.save(update_fields=["institution"])
+                self.stdout.write(f"Updated {projects.count()} projects with institutions.")
+            else:
+                self.stdout.write("No changes made")
+        except Exception as e:
+            self.stdout.write(f"Error: {e}")
+
+    def _institution_dry_run(self, projects):
+        try:
+            for project in projects:
+                new_institution = determine_automated_institution_choice(project, PROJECT_INSTITUTION_EMAIL_MAP)
+                self.stdout.write(
+                    f"Project {project.pk}, called {project.title}. Institution would be '{new_institution}'"
+                )
+        except Exception as e:
+            self.stdout.write(f"Error: {e}")
+
+    def handle(self, *args, **options):
+        dry_run = options["dry_run"]
+
+        if not PROJECT_INSTITUTION_EMAIL_MAP:
+            self.stdout.write(
+                "Error, no changes made. Please set PROJECT_INSTITUTION_EMAIL_MAP as a dictionary value inside configuration file."
+            )
+            return
+
+        projects_without_institution = Project.objects.filter(institution="None")
+
+        if dry_run:
+            self._institution_dry_run(projects_without_institution)
+        else:
+            self._update_project_institution(projects_without_institution)

coldfront/core/project/migrations/0006_historicalproject_institution_project_institution.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: (C) ColdFront Authors
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+# Generated by Django 4.2.11 on 2025-04-27 19:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("project", "0005_alter_historicalproject_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalproject",
+            name="institution",
+            field=models.CharField(blank=True, default="None", max_length=10),
+        ),
+        migrations.AddField(
+            model_name="project",
+            name="institution",
+            field=models.CharField(blank=True, default="None", max_length=10),
+        ),
+    ]

coldfront/core/project/models.py

@@ -106,6 +106,7 @@ def get_by_natural_key(self, title, pi_username):
     history = HistoricalRecords()
     objects = ProjectManager()
     project_code = models.CharField(max_length=10, blank=True)
+    institution = models.CharField(max_length=80, blank=True, default="None")
 
     def clean(self):
         """Validates the project and raises errors if the project is invalid."""

coldfront/core/project/templates/project/project_archived_list.html

@@ -86,6 +86,9 @@ <h2>Archived Projects</h2>
               <br> <strong>Description: </strong>{{ project.description }}</td>
             <td>{{ project.field_of_science.description }}</td>
             <td>{{ project.status.name }}</td>
+            {% if PROJECT_INSTITUTION_EMAIL_MAP %}
+                <p class="card-text text-justify"><strong>Institution: </strong>{{ project.institution }}</p>
+            {% endif %}
           </tr>
         {% endfor %}
       </tbody>

coldfront/core/project/templates/project/project_detail.html

@@ -81,6 +81,9 @@ <h3 class="card-title">
           <span class="badge badge-pill badge-info">project review pending</span>
         {% endif %}
     </p>
+    {% if PROJECT_INSTITUTION_EMAIL_MAP %}
+        <p class="card-text text-justify"><strong>Institution: </strong>{{ project.institution }}</p>
+    {% endif %}
     <p class="card-text text-justify"><strong>Created: </strong>{{ project.created|date:"M. d, Y" }}</p>
   </div>
 </div>

coldfront/core/project/templates/project/project_list.html

@@ -71,6 +71,13 @@ <h2>Projects</h2>
             <a href="?order_by=status&direction=asc&{{filter_parameters}}"><i class="fas fa-sort-up" aria-hidden="true"></i><span class="sr-only">Sort Status asc</span></a>
             <a href="?order_by=status&direction=des&{{filter_parameters}}"><i class="fas fa-sort-down" aria-hidden="true"></i><span class="sr-only">Sort Status desc</span></a>
           </th>
+          {% if PROJECT_INSTITUTION_EMAIL_MAP %}
+              <th scope="col" class="text-nowrap">
+                  Institution
+                  <a href="?order_by=id&direction=asc&{{filter_parameters}}"><i class="fas fa-sort-up" aria-hidden="true"></i><span class="sr-only">Sort Institution asc</span></a>
+                  <a href="?order_by=id&direction=des&{{filter_parameters}}"><i class="fas fa-sort-down" aria-hidden="true"></i><span class="sr-only">Sort Institution desc</span></a>
+              </th>
+          {% endif %}
         </tr>
       </thead>
       <tbody>
@@ -85,6 +92,9 @@ <h2>Projects</h2>
             <td style="text-align: justify; text-justify: inter-word;">{{ project.title }}</td>
             <td>{{ project.field_of_science.description }}</td>
             <td>{{ project.status.name }}</td>
+            {% if PROJECT_INSTITUTION_EMAIL_MAP %}
+                <td>{{ project.institution }}</td>
+            {% endif %}
           </tr>
         {% endfor %}
       </tbody>

coldfront/core/project/tests.py

@@ -13,7 +13,10 @@
     ProjectAttribute,
     ProjectAttributeType,
 )
-from coldfront.core.project.utils import generate_project_code
+from coldfront.core.project.utils import (
+    determine_automated_institution_choice,
+    generate_project_code,
+)
 from coldfront.core.test_helpers.factories import (
     FieldOfScienceFactory,
     PAttributeTypeFactory,
@@ -276,3 +279,103 @@ def test_different_prefix_padding(self):
         # Test the generated project codes
         self.assertEqual(project_with_code_padding1, "BFO001")
         self.assertEqual(project_with_code_padding2, "BFO002")
+
+
+class TestInstitution(TestCase):
+    def setUp(self):
+        self.user = UserFactory(username="capeo")
+        self.field_of_science = FieldOfScienceFactory(description="Physics")
+        self.status = ProjectStatusChoiceFactory(name="Active")
+
+    def create_project_with_institution(self, title, institution_dict=None):
+        """Helper method to create a project and assign a institution value based on the argument passed"""
+        # Project Creation
+        project = Project.objects.create(
+            title=title,
+            pi=self.user,
+            status=self.status,
+            field_of_science=self.field_of_science,
+        )
+
+        if institution_dict:
+            determine_automated_institution_choice(project, institution_dict)
+
+        project.save()
+
+        return project.institution
+
+    @patch(
+        "coldfront.config.core.PROJECT_INSTITUTION_EMAIL_MAP",
+        {"inst.ac.com": "AC", "inst.edu.com": "EDU", "bfo.ac.uk": "BFO"},
+    )
+    def test_institution_is_none(self):
+        from coldfront.config.core import PROJECT_INSTITUTION_EMAIL_MAP
+
+        """Test to check if institution is none after both env vars are enabled. """
+
+        # Create project with both institution
+        project_institution = self.create_project_with_institution("Project 1", PROJECT_INSTITUTION_EMAIL_MAP)
+
+        # Create the first project
+        self.assertEqual(project_institution, "None")
+
+    @patch(
+        "coldfront.config.core.PROJECT_INSTITUTION_EMAIL_MAP",
+        {"inst.ac.com": "AC", "inst.edu.com": "EDU", "bfo.ac.uk": "BFO"},
+    )
+    def test_institution_multiple_users(self):
+        from coldfront.config.core import PROJECT_INSTITUTION_EMAIL_MAP
+
+        """Test to check multiple projects with different user email addresses, """
+
+        # Create project for user 1
+        self.user.email = "user@inst.ac.com"
+        self.user.save()
+        project_institution_one = self.create_project_with_institution("Project 1", PROJECT_INSTITUTION_EMAIL_MAP)
+        self.assertEqual(project_institution_one, "AC")
+
+        # Create project for user 2
+        self.user.email = "user@bfo.ac.uk"
+        self.user.save()
+        project_institution_two = self.create_project_with_institution("Project 2", PROJECT_INSTITUTION_EMAIL_MAP)
+        self.assertEqual(project_institution_two, "BFO")
+
+        # Create project for user 3
+        self.user.email = "user@inst.edu.com"
+        self.user.save()
+        project_institution_three = self.create_project_with_institution("Project 3", PROJECT_INSTITUTION_EMAIL_MAP)
+        self.assertEqual(project_institution_three, "EDU")
+
+    @patch(
+        "coldfront.config.core.PROJECT_INSTITUTION_EMAIL_MAP",
+        {"inst.ac.com": "AC", "inst.edu.com": "EDU", "bfo.ac.uk": "BFO"},
+    )
+    def test_determine_automated_institution_choice_does_not_save_to_database(self):
+        from coldfront.config.core import PROJECT_INSTITUTION_EMAIL_MAP
+
+        """Test that the function only modifies project in memory, not in database"""
+
+        self.user.email = "user@inst.ac.com"
+        self.user.save()
+
+        # Create project, similar to create_project_with_institution, but without the save function.
+        project = Project.objects.create(
+            title="Test Project",
+            pi=self.user,
+            status=self.status,
+            field_of_science=self.field_of_science,
+            institution="Default",
+        )
+
+        original_db_project = Project.objects.get(id=project.id)
+        self.assertEqual(original_db_project.institution, "Default")
+
+        # Call the function and check object was modified in memory.
+        determine_automated_institution_choice(project, PROJECT_INSTITUTION_EMAIL_MAP)
+        self.assertEqual(project.institution, "AC")
+
+        # Check that database was NOT modified
+        current_db_project = Project.objects.get(id=project.id)
+        self.assertEqual(original_db_project.institution, "Default")
+
+        self.assertNotEqual(project.institution, current_db_project.institution)

coldfront/core/project/utils.py

@@ -48,3 +48,35 @@ def generate_project_code(project_code: str, project_pk: int, padding: int = 0)
     """
 
     return f"{project_code.upper()}{str(project_pk).zfill(padding)}"
+
+
+def determine_automated_institution_choice(project, institution_map: dict):
+    """
+    Determine automated institution choice for a project. Taking PI email of current project
+    and comparing to domain key from institution_map. Will first try to match a domain exactly
+    as provided in institution_map, if a direct match cannot be found an indirect match will be
+    attempted by looking for the first occurrence of an institution domain that occurs as a substring
+    in the PI's email address. This does not save changes to the database. The project object in
+    memory will have the institution field modified.
+    :param project: Project to add automated institution choice to.
+    :param institution_map: Dictionary of institution keys, values.
+    """
+    email: str = project.pi.email
+
+    try:
+        _, pi_email_domain = email.split("@")
+    except ValueError:
+        pi_email_domain = None
+
+    direct_institution_match = institution_map.get(pi_email_domain)
+
+    if direct_institution_match:
+        project.institution = direct_institution_match
+        return direct_institution_match
+    else:
+        for institution_email_domain, indirect_institution_match in institution_map.items():
+            if institution_email_domain in pi_email_domain:
+                project.institution = indirect_institution_match
+                return indirect_institution_match
+
+    return project.institution