Add Co-applicants feature to submissions (#4492)

Fixes #3919

Author: sandeepsajan0

hypha/apply/activity/adapters/base.py

@@ -11,6 +11,7 @@
     MESSAGES.TRANSITION: "old_phase",
     MESSAGES.BATCH_TRANSITION: "transitions",
     MESSAGES.APPLICANT_EDIT: "revision",
+    MESSAGES.INVITE_COAPPLICANT: "co_applicant_invite",
     MESSAGES.EDIT_SUBMISSION: "revision",
     MESSAGES.COMMENT: "comment",
     MESSAGES.SCREENING: "old_status",

hypha/apply/activity/adapters/emails.py

@@ -10,6 +10,7 @@
 
 from hypha.apply.activity import tasks
 from hypha.apply.activity.models import ALL, APPLICANT_PARTNERS, PARTNER
+from hypha.apply.funds.models.co_applicants import COMMENT, EDIT
 from hypha.apply.projects.models.payment import (
     APPROVED_BY_FINANCE,
     CHANGES_REQUESTED_BY_FINANCE,
@@ -49,6 +50,7 @@ class EmailAdapter(AdapterBase):
     messages = {
         MESSAGES.NEW_SUBMISSION: "messages/email/submission_confirmation.html",
         MESSAGES.DRAFT_SUBMISSION: "messages/email/submission_confirmation.html",
+        MESSAGES.INVITE_COAPPLICANT: "handle_co_applicant_invite",
         MESSAGES.COMMENT: "notify_comment",
         MESSAGES.EDIT_SUBMISSION: "messages/email/submission_edit.html",
         MESSAGES.TRANSITION: "handle_transition",
@@ -96,6 +98,8 @@ def get_subject(self, message_type, source):
                 subject = _(
                     "Reminder: Application ready to review: {source.title_text_display}"
                 ).format(source=source)
+            elif message_type == MESSAGES.INVITE_COAPPLICANT:
+                subject = _("You are invited as a co-applicant")
             elif message_type in [
                 MESSAGES.SENT_TO_COMPLIANCE,
                 MESSAGES.APPROVE_PAF,
@@ -173,6 +177,25 @@ def handle_transition(self, old_phase, source, **kwargs):
                 **kwargs,
             )
 
+    def handle_co_applicant_invite(self, source, related, **kwargs):
+        from hypha.apply.funds.utils import generate_invite_path
+
+        invited_user = User.objects.filter(email=related.invited_user_email).first()
+        can_accept = True
+        if invited_user and (invited_user.is_org_faculty):
+            can_accept = False
+
+        accept_link = generate_invite_path(invite=related)
+        return self.render_message(
+            "messages/email/invite_co_applicant.html",
+            source=source,
+            can_accept=can_accept,
+            accept_link=accept_link,
+            related=related,
+            invited_user=invited_user,
+            **kwargs,
+        )
+
     def handle_batch_transition(self, transitions, sources, **kwargs):
         submissions = sources
         kwargs.pop("source")
@@ -295,6 +318,10 @@ def recipients(self, message_type, source, user, **kwargs):
             if not source.phase.permissions.can_view(source.user):
                 return []
 
+        if message_type == MESSAGES.INVITE_COAPPLICANT:
+            related = kwargs.get("related", None)
+            return [related.invited_user_email]
+
         if message_type == MESSAGES.PARTNERS_UPDATED_PARTNER:
             partners = kwargs["added"]
             return [partner.email for partner in partners]
@@ -430,7 +457,11 @@ def recipients(self, message_type, source, user, **kwargs):
         if message_type == MESSAGES.COMMENT:
             # Comment handling for Submissions
             if isinstance(source, ApplicationSubmission):
-                recipients: List[str] = [source.user.email]
+                # add co-applicants with Comment or edit access
+                co_applicants = source.co_applicants.filter(
+                    role__in=[COMMENT, EDIT]
+                ).values_list("user__email", flat=True)
+                recipients: List[str] = [source.user.email, *co_applicants]
 
                 comment = kwargs["related"]
                 if partners := list(source.partners.values_list("email", flat=True)):
@@ -450,6 +481,12 @@ def recipients(self, message_type, source, user, **kwargs):
             if isinstance(source, Project) and user == source.user:
                 return []
 
+        if isinstance(source, ApplicationSubmission):
+            # co-applicants edit/full-access access
+            co_applicants = source.co_applicants.filter(role__in=[EDIT]).values_list(
+                "user__email", flat=True
+            )
+            return [source.user.email, *co_applicants]
         return [source.user.email]
 
     def batch_recipients(self, message_type, sources, **kwargs):

hypha/apply/activity/migrations/0087_alter_event_type.py

@@ -0,0 +1,83 @@
+# Generated by Django 4.2.20 on 2025-04-30 05:35
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("activity", "0086_remove_django_messages_adapter"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="event",
+            name="type",
+            field=models.CharField(
+                choices=[
+                    ("UPDATE_LEAD", "updated lead"),
+                    ("BATCH_UPDATE_LEAD", "batch updated lead"),
+                    ("EDIT_SUBMISSION", "edited submission"),
+                    ("APPLICANT_EDIT", "edited applicant"),
+                    ("NEW_SUBMISSION", "submitted new submission"),
+                    ("DRAFT_SUBMISSION", "submitted new draft submission"),
+                    ("SCREENING", "screened"),
+                    ("TRANSITION", "transitioned"),
+                    ("BATCH_TRANSITION", "batch transitioned"),
+                    ("DETERMINATION_OUTCOME", "sent determination outcome"),
+                    ("BATCH_DETERMINATION_OUTCOME", "sent batch determination outcome"),
+                    ("INVITED_TO_PROPOSAL", "invited to proposal"),
+                    ("REVIEWERS_UPDATED", "updated reviewers"),
+                    ("BATCH_REVIEWERS_UPDATED", "batch updated reviewers"),
+                    ("PARTNERS_UPDATED", "updated partners"),
+                    ("PARTNERS_UPDATED_PARTNER", "partners updated partner"),
+                    ("READY_FOR_REVIEW", "marked ready for review"),
+                    ("BATCH_READY_FOR_REVIEW", "marked batch ready for review"),
+                    ("NEW_REVIEW", "added new review"),
+                    ("COMMENT", "added comment"),
+                    ("PROPOSAL_SUBMITTED", "submitted proposal"),
+                    ("OPENED_SEALED", "opened sealed submission"),
+                    ("REVIEW_OPINION", "reviewed opinion"),
+                    ("DELETE_SUBMISSION", "deleted submission"),
+                    ("DELETE_REVIEW", "deleted review"),
+                    ("DELETE_REVIEW_OPINION", "deleted review opinion"),
+                    ("CREATED_PROJECT", "created project"),
+                    ("UPDATE_PROJECT_LEAD", "updated project lead"),
+                    ("UPDATE_PROJECT_TITLE", "updated project title"),
+                    ("EDIT_REVIEW", "edited review"),
+                    ("SEND_FOR_APPROVAL", "sent for approval"),
+                    ("APPROVE_PROJECT", "approved project"),
+                    ("ASSIGN_PAF_APPROVER", "assign project form approver"),
+                    ("APPROVE_PAF", "approved project form"),
+                    ("PROJECT_TRANSITION", "transitioned project"),
+                    ("REQUEST_PROJECT_CHANGE", "requested project change"),
+                    ("SUBMIT_CONTRACT_DOCUMENTS", "submitted contract documents"),
+                    ("UPLOAD_DOCUMENT", "uploaded document to project"),
+                    ("UPLOAD_CONTRACT", "uploaded contract to project"),
+                    ("APPROVE_CONTRACT", "approved contract"),
+                    ("CREATE_INVOICE", "created invoice for project"),
+                    ("UPDATE_INVOICE_STATUS", "updated invoice status"),
+                    ("APPROVE_INVOICE", "approve invoice"),
+                    ("DELETE_INVOICE", "deleted invoice"),
+                    ("SENT_TO_COMPLIANCE", "sent project to compliance"),
+                    ("UPDATE_INVOICE", "updated invoice"),
+                    ("SUBMIT_REPORT", "submitted report"),
+                    ("SKIPPED_REPORT", "skipped report"),
+                    ("REPORT_FREQUENCY_CHANGED", "changed report frequency"),
+                    ("DISABLED_REPORTING", "disabled reporting"),
+                    ("REPORT_NOTIFY", "notified report"),
+                    ("REVIEW_REMINDER", "reminder to review"),
+                    ("BATCH_DELETE_SUBMISSION", "batch deleted submissions"),
+                    ("BATCH_ARCHIVE_SUBMISSION", "batch archive submissions"),
+                    ("BATCH_INVOICE_STATUS_UPDATE", "batch update invoice status"),
+                    ("STAFF_ACCOUNT_CREATED", "created new account"),
+                    ("STAFF_ACCOUNT_EDITED", "edited account"),
+                    ("ARCHIVE_SUBMISSION", "archived submission"),
+                    ("UNARCHIVE_SUBMISSION", "unarchived submission"),
+                    ("REMOVE_TASK", "remove task"),
+                    ("INVITE_COAPPLICANT", "invite co-applicant"),
+                ],
+                max_length=50,
+                verbose_name="verb",
+            ),
+        ),
+    ]

hypha/apply/activity/options.py

@@ -79,3 +79,4 @@ class MESSAGES(TextChoices):
     ARCHIVE_SUBMISSION = "ARCHIVE_SUBMISSION", _("archived submission")
     UNARCHIVE_SUBMISSION = "UNARCHIVE_SUBMISSION", _("unarchived submission")
     REMOVE_TASK = "REMOVE_TASK", _("remove task")
+    INVITE_COAPPLICANT = "INVITE_COAPPLICANT", _("invite co-applicant")

hypha/apply/activity/templates/messages/email/invite_co_applicant.html

@@ -0,0 +1,21 @@
+{% extends "messages/email/base.html" %}
+{% load i18n activity_tags %}
+
+{% block salutation %}
+    {% if invited_user %}
+        {% blocktrans with name=invited_user.get_display_name %}Dear {{ name }},{% endblocktrans %}
+    {% else %}
+        {% blocktrans with name=related.invited_user_email|email_name %}Dear {{ name }},{% endblocktrans %}
+    {% endif %}
+{% endblock %}
+
+{% block content %}{# fmt:off #}
+{% blocktrans %}You have been invited as a co-applicant to an application on {{ ORG_SHORT_NAME }} by {{ user }}.{% endblocktrans %}
+{% if not can_accept %}
+{% trans "But You can't accept this invite because you already hold a responsible position in" %} {{ ORG_SHORT_NAME }}
+{% else %}
+{% blocktrans %}Click on link if you want to accept it.{% endblocktrans %}
+
+{% trans "Link" %}: {{ request.scheme }}://{{ request.get_host }}{{ accept_link }}
+{% endif %}
+{% endblock %}{# fmt:on #}

hypha/apply/activity/templatetags/activity_tags.py

@@ -199,3 +199,10 @@ def get_project_creation_message(project) -> str | None:
 
     # If a project is created in any other state that wouldn't be useful to have a message for
     return None
+
+
+@register.filter
+def email_name(email):
+    if isinstance(email, str) and "@" in email:
+        return email.split("@")[0]
+    return email

hypha/apply/dashboard/views.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from django.db.models import Q
 from django.http import HttpResponseForbidden, HttpResponseRedirect
 from django.shortcuts import render
 from django.urls import reverse, reverse_lazy
@@ -462,7 +463,7 @@ class ApplicantDashboardView(TemplateView):
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context["my_submissions_exists"] = ApplicationSubmission.objects.filter(
-            user=self.request.user
+            Q(user=self.request.user) | Q(co_applicants__user=self.request.user)
         ).exists()
 
         # Number of items to show in skeleton in each section of lazy loading

hypha/apply/dashboard/views_partials.py

@@ -1,6 +1,6 @@
 from django.contrib.auth.decorators import login_required
 from django.core.paginator import Paginator
-from django.db.models import Case, When
+from django.db.models import Case, Q, When
 from django.shortcuts import render
 from django.views.decorators.http import require_GET
 
@@ -12,13 +12,14 @@
 def my_active_submissions(user):
     active_subs = (
         ApplicationSubmission.objects.filter(
-            user=user,
+            Q(user=user) | Q(co_applicants__user=user),
         )
         .annotate(
             is_active=Case(When(status__in=active_statuses, then=True), default=False)
         )
         .select_related("draft_revision")
         .order_by("-is_active", "-submit_time")
+        .distinct()
     )
     for submission in active_subs:
         yield submission.from_draft()

hypha/apply/determinations/views.py

@@ -615,7 +615,10 @@ def dispatch(self, request, *args, **kwargs):
         )
         determination = self.get_object()
 
-        if request.user != self.submission.user:
+        if (
+            request.user != self.submission.user
+            and not self.submission.co_applicants.filter(user=request.user).exists
+        ):
             raise PermissionDenied
 
         if determination.is_draft:

hypha/apply/funds/forms.py

@@ -16,9 +16,12 @@
 from .models import (
     ApplicationSubmission,
     AssignedReviewers,
+    CoApplicant,
+    CoApplicantInvite,
     Reminder,
     ReviewerRole,
 )
+from .models.co_applicants import COAPPLICANT_ROLE_CHOICES
 from .permissions import can_change_external_reviewers
 from .utils import model_form_initial, render_icon
 from .widgets import MetaTermWidget, MultiCheckboxesWidget
@@ -456,3 +459,39 @@ def save(self, *args, **kwargs):
     class Meta:
         model = Reminder
         fields = ["title", "description", "time", "action"]
+
+
+class InviteCoApplicantForm(forms.ModelForm):
+    invited_user_email = forms.EmailField(required=True, label="Email")
+    role = forms.ChoiceField(
+        choices=COAPPLICANT_ROLE_CHOICES, label="Role", required=False
+    )
+
+    submission = forms.ModelChoiceField(
+        queryset=ApplicationSubmission.objects.filter(),
+        widget=forms.HiddenInput(),
+    )
+
+    def __init__(self, *args, submission, user=None, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.invited_by = user
+
+        if submission:
+            self.fields["submission"].initial = submission.id
+
+    class Meta:
+        model = CoApplicantInvite
+        fields = ["invited_user_email", "submission"]
+
+
+class EditCoApplicantForm(forms.ModelForm):
+    role = forms.ChoiceField(
+        choices=COAPPLICANT_ROLE_CHOICES, label="Role", required=False
+    )
+
+    def __int__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    class Meta:
+        model = CoApplicant
+        fields = ("role",)