Skip to content

Index

hypha.apply.activity.adapters

ActivityAdapter

Bases: AdapterBase

adapter_type class-attribute instance-attribute 

adapter_type = 'Activity Feed'

always_send class-attribute instance-attribute 

always_send = True

messages class-attribute instance-attribute 

messages = {MESSAGES.TRANSITION: 'handle_transition', MESSAGES.BATCH_TRANSITION: 'handle_batch_transition', MESSAGES.NEW_SUBMISSION: _('Submitted {source.title_text_display} for {source.page.title}'), MESSAGES.EDIT_SUBMISSION: _('edited the submission'), MESSAGES.APPLICANT_EDIT: _('edited the submission'), MESSAGES.UPDATE_LEAD: _('updated Lead from {old_lead} to {source.lead}'), MESSAGES.BATCH_UPDATE_LEAD: _('batch updated Lead to {new_lead}'), MESSAGES.DETERMINATION_OUTCOME: _('sent a determination. Outcome: {determination.clean_outcome}'), MESSAGES.BATCH_DETERMINATION_OUTCOME: 'batch_determination', MESSAGES.INVITED_TO_PROPOSAL: _('Invited to submit a proposal'), MESSAGES.REVIEWERS_UPDATED: 'reviewers_updated', MESSAGES.BATCH_REVIEWERS_UPDATED: 'batch_reviewers_updated', MESSAGES.NEW_REVIEW: _('Submitted a review'), MESSAGES.OPENED_SEALED: _('Opened the submission while still sealed'), MESSAGES.SCREENING: 'handle_screening_statuses', MESSAGES.REVIEW_OPINION: _('{opinion.opinion_display}s with {opinion.review.author}s review of {source}'), MESSAGES.DELETE_REVIEW_OPINION: _('deleted the opinion for review: {review_opinion.review}'), MESSAGES.CREATED_PROJECT: _('Created project with initial status of "{status}"'), MESSAGES.CREATED_SOW: _('Created SOW for project "{related.project}"'), MESSAGES.EDITED_SOW: _('Edited SOW for project "{related.project}"'), MESSAGES.CREATED_PF: _('Created project form for project "{related.project}"'), MESSAGES.EDITED_PF: _('Edited project form for project "{related.project}"'), MESSAGES.PROJECT_TRANSITION: 'handle_project_transition', MESSAGES.UPDATE_PROJECT_TITLE: _('updated the project title from {old_title} to {source.title}'), MESSAGES.UPDATE_PROJECT_CONTRACT_NUMBER: _('updated contract number to {source.contract_number}'), MESSAGES.UPDATE_PROJECT_LEAD: _('update Lead from {old_lead} to {source.lead}'), MESSAGES.SEND_FOR_APPROVAL: _('Requested approval'), MESSAGES.APPROVE_PAF: 'handle_paf_assignment', MESSAGES.APPROVE_PROJECT: _('Approved'), MESSAGES.REQUEST_PROJECT_CHANGE: _('requested changes for acceptance'), MESSAGES.SUBMIT_CONTRACT_DOCUMENTS: _('Submitted Contract Documents'), MESSAGES.UPLOAD_CONTRACT: _('Uploaded a {contract.state} contract'), MESSAGES.APPROVE_CONTRACT: _('Approved contract'), MESSAGES.UPDATE_INVOICE_STATUS: 'handle_update_invoice_status', MESSAGES.CREATE_INVOICE: _('Invoice added'), MESSAGES.SUBMIT_REPORT: _('Submitted a report'), MESSAGES.DELETE_REPORT: _('deleted a report'), MESSAGES.SKIPPED_REPORT: 'handle_skipped_report', MESSAGES.REPORT_FREQUENCY_CHANGED: 'handle_report_frequency', MESSAGES.DISABLED_REPORTING: _('disabled reporting'), MESSAGES.BATCH_DELETE_SUBMISSION: 'handle_batch_delete_submission', MESSAGES.BATCH_ARCHIVE_SUBMISSION: 'handle_batch_archive_submission', MESSAGES.BATCH_UPDATE_INVOICE_STATUS: 'handle_batch_update_invoice_status', MESSAGES.ARCHIVE_SUBMISSION: _('archived this submission'), MESSAGES.UNARCHIVE_SUBMISSION: _('un-archived this submission'), MESSAGES.DELETE_INVOICE: _('deleted an invoice'), MESSAGES.REMOVE_TASK: 'handle_task_removal', MESSAGES.UPDATE_AUTHOR: _('updated author from {old_author} to {source.user}')}

message 

message(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def message(self, message_type, **kwargs):
    try:
        message = self.messages[message_type]
    except KeyError:
        # We don't know how to handle that message type
        return

    try:
        # see if its a method on the adapter
        method = getattr(self, message)
    except AttributeError:
        return self.render_message(message, **kwargs)
    else:
        # Delegate all responsibility to the custom method
        return method(**kwargs)

render_message 

render_message(message, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
72
73
def render_message(self, message, **kwargs):
    return message.format(**kwargs)

get_neat_related(message_type, related)
Source code in hypha/apply/activity/adapters/base.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_neat_related(self, message_type, related):
    # We translate the related kwarg into something we can understand
    try:
        neat_name = neat_related[message_type]
    except KeyError:
        # Message type doesn't expect a related object
        if related:
            raise ValueError(
                f"Unexpected 'related' kwarg provided for {message_type}"
            ) from None
        return {}
    else:
        if not related:
            raise ValueError(f"{message_type} expects a 'related' kwarg")
        return {neat_name: related}

batch_recipients 

batch_recipients(message_type, sources, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
 97
 98
 99
100
101
102
103
104
105
106
def batch_recipients(self, message_type, sources, **kwargs):
    # Default batch recipients is to send a message to each of the recipients that would
    # receive a message under normal conditions
    return [
        {
            "recipients": self.recipients(message_type, source=source, **kwargs),
            "sources": [source],
        }
        for source in sources
    ]

process_batch 

process_batch(message_type, events, request, user, sources, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def process_batch(
    self, message_type, events, request, user, sources, related=None, **kwargs
):
    events_by_source = {event.source.id: event for event in events}
    for recipient in self.batch_recipients(
        message_type, sources, user=user, **kwargs
    ):
        recipients = recipient["recipients"]
        sources = recipient["sources"]
        events = [events_by_source[source.id] for source in sources]
        self.process_send(
            message_type,
            recipients,
            events,
            request,
            user,
            sources=sources,
            source=None,
            related=related,
            **kwargs,
        )

process 

process(message_type, event, request, user, source, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def process(
    self, message_type, event, request, user, source, related=None, **kwargs
):
    recipients = self.recipients(
        message_type,
        source=source,
        related=related,
        user=user,
        request=request,
        **kwargs,
    )
    self.process_send(
        message_type,
        recipients,
        [event],
        request,
        user,
        source,
        related=related,
        **kwargs,
    )

process_send 

process_send(message_type, recipients, events, request, user, source, sources=None, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def process_send(
    self,
    message_type,
    recipients,
    events,
    request,
    user,
    source,
    sources=None,
    related=None,
    **kwargs,
):
    if sources is None:
        sources = []
    try:
        # If this was a batch action we want to pull out the submission
        source = sources[0]
    except IndexError:
        pass

    kwargs = {
        "request": request,
        "user": user,
        "source": source,
        "sources": sources,
        "related": related,
        **kwargs,
    }
    kwargs.update(self.get_neat_related(message_type, related))
    kwargs.update(self.extra_kwargs(message_type, **kwargs))

    for recipient in recipients:
        # Allow for customization of message based on recipient string (will vary based on adapter)
        message_kwargs = {**kwargs, "recipient": recipient}
        message = self.message(message_type, **message_kwargs)
        if not message:
            continue

        message_logs = self.create_logs(message, recipient, *events)

        if settings.SEND_MESSAGES or self.always_send:
            status = self.send_message(
                message, recipient=recipient, logs=message_logs, **kwargs
            )
        else:
            status = "Message not sent as SEND_MESSAGES==FALSE"

        message_logs.update_status(status)

        if not settings.SEND_MESSAGES:
            if recipient:
                debug_message = _("{adapter} [to: {recipient}]: {message}").format(
                    adapter=self.adapter_type, recipient=recipient, message=message
                )
            else:
                debug_message = _("{adapter}: {message}").format(
                    adapter=self.adapter_type, message=message
                )
            messages.add_message(request, messages.DEBUG, debug_message)

create_logs 

create_logs(message, recipient, *events)
Source code in hypha/apply/activity/adapters/base.py 
212
213
214
215
216
217
218
def create_logs(self, message, recipient, *events):
    from ..models import Message

    messages = Message.objects.bulk_create(
        Message(**self.log_kwargs(message, recipient, event)) for event in events
    )
    return Message.objects.filter(id__in=[message.id for message in messages])

log_kwargs 

log_kwargs(message, recipient, event)
Source code in hypha/apply/activity/adapters/base.py 
220
221
222
223
224
225
226
def log_kwargs(self, message, recipient, event):
    return {
        "type": self.adapter_type,
        "content": message,
        "recipient": recipient or "",
        "event": event,
    }

recipients 

recipients(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
88
89
def recipients(self, message_type, **kwargs):
    return [None]

extra_kwargs 

extra_kwargs(message_type, source, sources, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def extra_kwargs(self, message_type, source, sources, **kwargs):
    if message_type in [
        MESSAGES.OPENED_SEALED,
        MESSAGES.REVIEWERS_UPDATED,
        MESSAGES.SCREENING,
        MESSAGES.REVIEW_OPINION,
        MESSAGES.DELETE_REVIEW_OPINION,
        MESSAGES.BATCH_REVIEWERS_UPDATED,
        MESSAGES.APPROVE_PROJECT,
        MESSAGES.CREATED_SOW,
        MESSAGES.EDITED_SOW,
        MESSAGES.CREATED_PF,
        MESSAGES.EDITED_PF,
        MESSAGES.REQUEST_PROJECT_CHANGE,
        MESSAGES.SEND_FOR_APPROVAL,
        MESSAGES.APPROVE_PAF,
        MESSAGES.NEW_REVIEW,
        MESSAGES.UPDATE_PROJECT_LEAD,
        MESSAGES.UPDATE_LEAD,
        MESSAGES.BATCH_UPDATE_LEAD,
        MESSAGES.ARCHIVE_SUBMISSION,
        MESSAGES.UNARCHIVE_SUBMISSION,
        MESSAGES.BATCH_ARCHIVE_SUBMISSION,
        MESSAGES.REMOVE_TASK,
        MESSAGES.UPDATE_AUTHOR,
    ]:
        return {"visibility": TEAM}

    if message_type in [
        MESSAGES.CREATED_PROJECT,
        MESSAGES.APPROVE_CONTRACT,
        MESSAGES.UPLOAD_CONTRACT,
        MESSAGES.SUBMIT_CONTRACT_DOCUMENTS,
        MESSAGES.DELETE_INVOICE,
        MESSAGES.CREATE_INVOICE,
        MESSAGES.DELETE_REPORT,
    ]:
        return {"visibility": APPLICANT}

    source = source or sources[0]
    if is_transition(message_type) and not source.phase.permissions.can_view(
        source.user
    ):
        # User's shouldn't see status activity changes for stages that aren't visible to the them
        return {"visibility": TEAM}

    if message_type == MESSAGES.UPDATE_INVOICE_STATUS:
        invoice = kwargs.get("invoice", None)
        if invoice and not is_invoice_public_transition(invoice):
            return {"visibility": TEAM}
        return {"visibility": APPLICANT}
    return {}

reviewers_updated 

reviewers_updated(added=None, removed=None, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
144
145
146
147
148
149
150
151
152
153
154
def reviewers_updated(self, added=None, removed=None, **kwargs):
    message = [_("Reviewers updated.")]
    if added:
        message.append(_("Added:"))
        message.extend(reviewers_message(added))

    if removed:
        message.append(_("Removed:"))
        message.extend(reviewers_message(removed))

    return " ".join(message)

batch_reviewers_updated 

batch_reviewers_updated(added, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
156
157
158
159
160
161
162
163
164
165
def batch_reviewers_updated(self, added, **kwargs):
    base = [_("Batch reviewers updated:")]
    base.extend(
        [
            _("{user} as {name}.").format(user=str(user), name=role.name)
            for role, user in added
            if user
        ]
    )
    return " ".join(base)

batch_determination 

batch_determination(sources, determinations, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
167
168
169
170
171
172
def batch_determination(self, sources, determinations, **kwargs):
    submission = sources[0]
    determination = determinations[submission.id]
    return self.messages[MESSAGES.DETERMINATION_OUTCOME].format(
        determination=determination,
    )

handle_batch_delete_submission 

handle_batch_delete_submission(sources, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
174
175
176
177
178
179
180
181
def handle_batch_delete_submission(self, sources, **kwargs):
    submissions = sources
    submissions_text = ", ".join(
        [submission.title_text_display for submission in submissions]
    )
    return _("Successfully deleted submissions: {title}").format(
        title=submissions_text
    )

handle_batch_archive_submission 

handle_batch_archive_submission(sources, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
183
184
185
186
187
188
189
190
def handle_batch_archive_submission(self, sources, **kwargs):
    submissions = sources
    submissions_text = ", ".join(
        [submission.title_text_display for submission in submissions]
    )
    return _("Successfully archived submissions: {title}").format(
        title=submissions_text
    )

handle_batch_update_invoice_status 

handle_batch_update_invoice_status(sources, invoices, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def handle_batch_update_invoice_status(self, sources, invoices, **kwargs):
    invoice_numbers = ", ".join(
        [
            invoice.invoice_number if invoice.invoice_number else ""
            for invoice in invoices
        ]
    )
    invoice_status = invoices[0].status if invoices else ""
    return _(
        "Successfully updated status to {invoice_status} for invoices: {invoice_numbers}"
    ).format(
        invoice_status=get_invoice_status_display_value(invoice_status),
        invoice_numbers=invoice_numbers,
    )

handle_paf_assignment 

handle_paf_assignment(source, paf_approvals, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
207
208
209
210
211
212
213
214
215
216
217
218
219
def handle_paf_assignment(self, source, paf_approvals, **kwargs):
    if hasattr(paf_approvals, "__iter__"):  # paf_approvals has to be iterable
        users = ", ".join(
            [
                paf_approval.user.full_name
                if paf_approval.user.full_name
                else paf_approval.user.username
                for paf_approval in paf_approvals
            ]
        )
        users_sentence = " and".join(users.rsplit(",", 1))
        return _("assigned Project form to {}").format(users_sentence)
    return None

handle_task_removal 

handle_task_removal(source, task, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def handle_task_removal(self, source, task, **kwargs):
    if task.user:
        return _(
            "removed the task {task.code} for {source} from the task list".format(
                task=task, source=source
            )
        )
    return _(
        "removed the task {task.code} for {source} from whole team's{user_groups} task list.".format(
            task=task,
            source=source,
            user_groups=list(task.user_group.all().values_list("name", flat=True)),
        )
    )

handle_transition 

handle_transition(old_phase, source, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
def handle_transition(self, old_phase, source, **kwargs):
    def wrap_in_color_class(phase, text):
        return f'<span class="rounded-full inline-block px-2 py-0.5 font-medium text-gray-800 {phase.bg_color}">{text}</span>'

    submission = source
    base_message = _("Progressed from {old_display} to {new_display}")

    new_phase = submission.phase

    staff_message = base_message.format(
        old_display=wrap_in_color_class(old_phase, old_phase.display_name),
        new_display=wrap_in_color_class(new_phase, new_phase.display_name),
    )

    if new_phase.permissions.can_view(submission.user):
        # we need to provide a different message to the applicant
        if not old_phase.permissions.can_view(submission.user):
            old_phase = submission.workflow.previous_visible(
                old_phase, submission.user
            )

        applicant_message = base_message.format(
            old_display=wrap_in_color_class(old_phase, old_phase.public_name),
            new_display=wrap_in_color_class(new_phase, new_phase.public_name),
        )

        return json.dumps(
            {
                TEAM: staff_message,
                ALL: applicant_message,
            }
        )

    return staff_message

handle_project_transition 

handle_project_transition(old_stage, source, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
def handle_project_transition(self, old_stage, source, **kwargs):
    project = source
    base_message = _("Progressed from {old_display} to {new_display}")

    staff_message = base_message.format(
        old_display=get_project_status_display_value(old_stage),
        new_display=project.status_display,
    )

    applicant_message = base_message.format(
        old_display=get_project_public_status(project_status=old_stage),
        new_display=get_project_public_status(project_status=project.status),
    )

    return json.dumps(
        {
            TEAM: staff_message,
            ALL: applicant_message,
        }
    )

handle_batch_transition 

handle_batch_transition(transitions, sources, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
292
293
294
295
296
297
298
299
def handle_batch_transition(self, transitions, sources, **kwargs):
    submissions = sources
    kwargs.pop("source")
    for submission in submissions:
        old_phase = transitions[submission.id]
        return self.handle_transition(
            old_phase=old_phase, source=submission, **kwargs
        )

handle_report_frequency 

handle_report_frequency(config, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
301
302
303
304
305
def handle_report_frequency(self, config, **kwargs):
    new_schedule = config.get_frequency_display()
    return _(
        "Updated reporting frequency. New schedule is: {new_schedule} starting on {schedule_start}"
    ).format(new_schedule=new_schedule, schedule_start=config.schedule_start)

handle_skipped_report 

handle_skipped_report(report, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
307
308
309
310
311
def handle_skipped_report(self, report, **kwargs):
    if report.skipped:
        return _("Skipped a Report")
    else:
        return _("Marked a Report as required")

handle_update_invoice_status 

handle_update_invoice_status(invoice, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
313
314
315
316
317
318
319
320
321
322
def handle_update_invoice_status(self, invoice, **kwargs):
    base_message = _("Updated Invoice status to: {invoice_status}.")
    staff_message = base_message.format(invoice_status=invoice.get_status_display())

    if is_invoice_public_transition(invoice):
        public_status = get_invoice_public_status(invoice_status=invoice.status)
        applicant_message = base_message.format(invoice_status=public_status)
        return json.dumps({TEAM: staff_message, ALL: applicant_message})

    return staff_message

send_message 

send_message(message, user, source, sources, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
def send_message(self, message, user, source, sources, **kwargs):
    from ..models import Activity

    visibility = kwargs.get("visibility", ALL)

    related = kwargs["related"]
    if isinstance(related, dict):
        try:
            related = related[source.id]
        except KeyError:
            pass

    has_correct_fields = all(
        hasattr(related, attr) for attr in ["get_absolute_url"]
    )
    isnt_source = source != related
    is_model = isinstance(related, DjangoModel)
    if has_correct_fields and isnt_source and is_model:
        related_object = related
    else:
        related_object = None

    Activity.actions.create(
        user=user,
        source=source,
        timestamp=timezone.now(),
        message=message,
        visibility=visibility,
        related_object=related_object,
    )

handle_screening_statuses 

handle_screening_statuses(source, old_status, **kwargs)
Source code in hypha/apply/activity/adapters/activity_feed.py 
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
def handle_screening_statuses(self, source, old_status, **kwargs):
    new_status = source.get_current_screening_status()

    if str(new_status) == old_status:
        return

    if new_status and old_status != "-":
        return _(
            'Updated screening decision from "{old_status}" to "{new_status}"'
        ).format(old_status=old_status, new_status=new_status)
    elif new_status:
        return _('Added screening decision to "{new_status}"').format(
            new_status=new_status
        )
    elif old_status != "-":
        return _('Removed "{old_status}" screening decision.').format(
            old_status=old_status
        )

AdapterBase

messages class-attribute instance-attribute 

messages = {}

always_send class-attribute instance-attribute 

always_send = False

message 

message(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def message(self, message_type, **kwargs):
    try:
        message = self.messages[message_type]
    except KeyError:
        # We don't know how to handle that message type
        return

    try:
        # see if its a method on the adapter
        method = getattr(self, message)
    except AttributeError:
        return self.render_message(message, **kwargs)
    else:
        # Delegate all responsibility to the custom method
        return method(**kwargs)

render_message 

render_message(message, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
72
73
def render_message(self, message, **kwargs):
    return message.format(**kwargs)

extra_kwargs 

extra_kwargs(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
75
76
def extra_kwargs(self, message_type, **kwargs):
    return {}

get_neat_related(message_type, related)
Source code in hypha/apply/activity/adapters/base.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_neat_related(self, message_type, related):
    # We translate the related kwarg into something we can understand
    try:
        neat_name = neat_related[message_type]
    except KeyError:
        # Message type doesn't expect a related object
        if related:
            raise ValueError(
                f"Unexpected 'related' kwarg provided for {message_type}"
            ) from None
        return {}
    else:
        if not related:
            raise ValueError(f"{message_type} expects a 'related' kwarg")
        return {neat_name: related}

recipients 

recipients(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
94
95
def recipients(self, message_type, **kwargs):
    raise NotImplementedError()

batch_recipients 

batch_recipients(message_type, sources, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
 97
 98
 99
100
101
102
103
104
105
106
def batch_recipients(self, message_type, sources, **kwargs):
    # Default batch recipients is to send a message to each of the recipients that would
    # receive a message under normal conditions
    return [
        {
            "recipients": self.recipients(message_type, source=source, **kwargs),
            "sources": [source],
        }
        for source in sources
    ]

process_batch 

process_batch(message_type, events, request, user, sources, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def process_batch(
    self, message_type, events, request, user, sources, related=None, **kwargs
):
    events_by_source = {event.source.id: event for event in events}
    for recipient in self.batch_recipients(
        message_type, sources, user=user, **kwargs
    ):
        recipients = recipient["recipients"]
        sources = recipient["sources"]
        events = [events_by_source[source.id] for source in sources]
        self.process_send(
            message_type,
            recipients,
            events,
            request,
            user,
            sources=sources,
            source=None,
            related=related,
            **kwargs,
        )

process 

process(message_type, event, request, user, source, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def process(
    self, message_type, event, request, user, source, related=None, **kwargs
):
    recipients = self.recipients(
        message_type,
        source=source,
        related=related,
        user=user,
        request=request,
        **kwargs,
    )
    self.process_send(
        message_type,
        recipients,
        [event],
        request,
        user,
        source,
        related=related,
        **kwargs,
    )

process_send 

process_send(message_type, recipients, events, request, user, source, sources=None, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def process_send(
    self,
    message_type,
    recipients,
    events,
    request,
    user,
    source,
    sources=None,
    related=None,
    **kwargs,
):
    if sources is None:
        sources = []
    try:
        # If this was a batch action we want to pull out the submission
        source = sources[0]
    except IndexError:
        pass

    kwargs = {
        "request": request,
        "user": user,
        "source": source,
        "sources": sources,
        "related": related,
        **kwargs,
    }
    kwargs.update(self.get_neat_related(message_type, related))
    kwargs.update(self.extra_kwargs(message_type, **kwargs))

    for recipient in recipients:
        # Allow for customization of message based on recipient string (will vary based on adapter)
        message_kwargs = {**kwargs, "recipient": recipient}
        message = self.message(message_type, **message_kwargs)
        if not message:
            continue

        message_logs = self.create_logs(message, recipient, *events)

        if settings.SEND_MESSAGES or self.always_send:
            status = self.send_message(
                message, recipient=recipient, logs=message_logs, **kwargs
            )
        else:
            status = "Message not sent as SEND_MESSAGES==FALSE"

        message_logs.update_status(status)

        if not settings.SEND_MESSAGES:
            if recipient:
                debug_message = _("{adapter} [to: {recipient}]: {message}").format(
                    adapter=self.adapter_type, recipient=recipient, message=message
                )
            else:
                debug_message = _("{adapter}: {message}").format(
                    adapter=self.adapter_type, message=message
                )
            messages.add_message(request, messages.DEBUG, debug_message)

create_logs 

create_logs(message, recipient, *events)
Source code in hypha/apply/activity/adapters/base.py 
212
213
214
215
216
217
218
def create_logs(self, message, recipient, *events):
    from ..models import Message

    messages = Message.objects.bulk_create(
        Message(**self.log_kwargs(message, recipient, event)) for event in events
    )
    return Message.objects.filter(id__in=[message.id for message in messages])

log_kwargs 

log_kwargs(message, recipient, event)
Source code in hypha/apply/activity/adapters/base.py 
220
221
222
223
224
225
226
def log_kwargs(self, message, recipient, event):
    return {
        "type": self.adapter_type,
        "content": message,
        "recipient": recipient or "",
        "event": event,
    }

send_message 

send_message(message, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
228
229
230
231
def send_message(self, message, **kwargs):
    # Process the message, should return the result of the send
    # Returning None will not record this action
    raise NotImplementedError()

EmailAdapter

Bases: AdapterBase

always_send class-attribute instance-attribute 

always_send = False

adapter_type class-attribute instance-attribute 

adapter_type = 'Email'

messages class-attribute instance-attribute 

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', MESSAGES.BATCH_TRANSITION: 'handle_batch_transition', MESSAGES.DETERMINATION_OUTCOME: 'handle_determination', MESSAGES.BATCH_DETERMINATION_OUTCOME: 'handle_batch_determination', MESSAGES.INVITED_TO_PROPOSAL: 'messages/email/invited_to_proposal.html', MESSAGES.BATCH_READY_FOR_REVIEW: 'handle_batch_ready_for_review', MESSAGES.READY_FOR_REVIEW: 'handle_ready_for_review', MESSAGES.REVIEWERS_UPDATED: 'handle_ready_for_review', MESSAGES.BATCH_REVIEWERS_UPDATED: 'handle_batch_ready_for_review', MESSAGES.UPLOAD_CONTRACT: 'messages/email/contract_uploaded.html', MESSAGES.SUBMIT_CONTRACT_DOCUMENTS: 'messages/email/submit_contract_documents.html', MESSAGES.CREATED_PROJECT: 'messages/email/project_created.html', MESSAGES.SENT_TO_COMPLIANCE: 'messages/email/sent_to_compliance.html', MESSAGES.REQUEST_PROJECT_CHANGE: 'messages/email/project_request_change.html', MESSAGES.ASSIGN_PAF_APPROVER: 'messages/email/assign_paf_approvers.html', MESSAGES.APPROVE_PAF: 'messages/email/paf_for_approval.html', MESSAGES.CREATE_INVOICE: 'messages/email/invoice_created.html', MESSAGES.UPDATE_INVOICE: 'handle_invoice_updated', MESSAGES.UPDATE_INVOICE_STATUS: 'handle_invoice_status_updated', MESSAGES.APPROVE_INVOICE: 'messages/email/invoice_approved.html', MESSAGES.SUBMIT_REPORT: 'messages/email/report_submitted.html', MESSAGES.SKIPPED_REPORT: 'messages/email/report_skipped.html', MESSAGES.REPORT_FREQUENCY_CHANGED: 'messages/email/report_frequency.html', MESSAGES.REPORT_NOTIFY: 'messages/email/report_notify.html', MESSAGES.REVIEW_REMINDER: 'messages/email/ready_to_review.html', MESSAGES.PROJECT_TRANSITION: 'handle_project_transition', MESSAGES.UPDATE_AUTHOR: 'messages/email/author_updated.html', MESSAGES.COMMENT_ASSIGNED: 'messages/email/comment_assigned.html'}

message 

message(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def message(self, message_type, **kwargs):
    try:
        message = self.messages[message_type]
    except KeyError:
        # We don't know how to handle that message type
        return

    try:
        # see if its a method on the adapter
        method = getattr(self, message)
    except AttributeError:
        return self.render_message(message, **kwargs)
    else:
        # Delegate all responsibility to the custom method
        return method(**kwargs)

get_neat_related(message_type, related)
Source code in hypha/apply/activity/adapters/base.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_neat_related(self, message_type, related):
    # We translate the related kwarg into something we can understand
    try:
        neat_name = neat_related[message_type]
    except KeyError:
        # Message type doesn't expect a related object
        if related:
            raise ValueError(
                f"Unexpected 'related' kwarg provided for {message_type}"
            ) from None
        return {}
    else:
        if not related:
            raise ValueError(f"{message_type} expects a 'related' kwarg")
        return {neat_name: related}

process_batch 

process_batch(message_type, events, request, user, sources, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def process_batch(
    self, message_type, events, request, user, sources, related=None, **kwargs
):
    events_by_source = {event.source.id: event for event in events}
    for recipient in self.batch_recipients(
        message_type, sources, user=user, **kwargs
    ):
        recipients = recipient["recipients"]
        sources = recipient["sources"]
        events = [events_by_source[source.id] for source in sources]
        self.process_send(
            message_type,
            recipients,
            events,
            request,
            user,
            sources=sources,
            source=None,
            related=related,
            **kwargs,
        )

process 

process(message_type, event, request, user, source, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def process(
    self, message_type, event, request, user, source, related=None, **kwargs
):
    recipients = self.recipients(
        message_type,
        source=source,
        related=related,
        user=user,
        request=request,
        **kwargs,
    )
    self.process_send(
        message_type,
        recipients,
        [event],
        request,
        user,
        source,
        related=related,
        **kwargs,
    )

process_send 

process_send(message_type, recipients, events, request, user, source, sources=None, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def process_send(
    self,
    message_type,
    recipients,
    events,
    request,
    user,
    source,
    sources=None,
    related=None,
    **kwargs,
):
    if sources is None:
        sources = []
    try:
        # If this was a batch action we want to pull out the submission
        source = sources[0]
    except IndexError:
        pass

    kwargs = {
        "request": request,
        "user": user,
        "source": source,
        "sources": sources,
        "related": related,
        **kwargs,
    }
    kwargs.update(self.get_neat_related(message_type, related))
    kwargs.update(self.extra_kwargs(message_type, **kwargs))

    for recipient in recipients:
        # Allow for customization of message based on recipient string (will vary based on adapter)
        message_kwargs = {**kwargs, "recipient": recipient}
        message = self.message(message_type, **message_kwargs)
        if not message:
            continue

        message_logs = self.create_logs(message, recipient, *events)

        if settings.SEND_MESSAGES or self.always_send:
            status = self.send_message(
                message, recipient=recipient, logs=message_logs, **kwargs
            )
        else:
            status = "Message not sent as SEND_MESSAGES==FALSE"

        message_logs.update_status(status)

        if not settings.SEND_MESSAGES:
            if recipient:
                debug_message = _("{adapter} [to: {recipient}]: {message}").format(
                    adapter=self.adapter_type, recipient=recipient, message=message
                )
            else:
                debug_message = _("{adapter}: {message}").format(
                    adapter=self.adapter_type, message=message
                )
            messages.add_message(request, messages.DEBUG, debug_message)

create_logs 

create_logs(message, recipient, *events)
Source code in hypha/apply/activity/adapters/base.py 
212
213
214
215
216
217
218
def create_logs(self, message, recipient, *events):
    from ..models import Message

    messages = Message.objects.bulk_create(
        Message(**self.log_kwargs(message, recipient, event)) for event in events
    )
    return Message.objects.filter(id__in=[message.id for message in messages])

log_kwargs 

log_kwargs(message, recipient, event)
Source code in hypha/apply/activity/adapters/base.py 
220
221
222
223
224
225
226
def log_kwargs(self, message, recipient, event):
    return {
        "type": self.adapter_type,
        "content": message,
        "recipient": recipient or "",
        "event": event,
    }

get_subject 

get_subject(message_type, source)
Source code in hypha/apply/activity/adapters/emails.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def get_subject(self, message_type, source):
    if source and hasattr(source, "title"):
        if is_ready_for_review(message_type) or is_reviewer_update(message_type):
            subject = _(
                "Application ready to review: {source.title_text_display}"
            ).format(source=source)
            if message_type in {
                MESSAGES.BATCH_READY_FOR_REVIEW,
                MESSAGES.BATCH_REVIEWERS_UPDATED,
            }:
                subject = _("Multiple applications are now ready for your review")
        elif message_type in {MESSAGES.REVIEW_REMINDER}:
            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,
        ]:
            subject = _("Project is waiting for approval: {source.title}").format(
                source=source
            )
        elif message_type == MESSAGES.UPLOAD_CONTRACT:
            subject = _("Contract uploaded for the project: {source.title}").format(
                source=source
            )
        elif message_type == MESSAGES.SUBMIT_CONTRACT_DOCUMENTS:
            subject = _(
                "Contract Documents required approval for the project: {source.title}"
            ).format(source=source)
        elif message_type == MESSAGES.PROJECT_TRANSITION:
            from hypha.apply.projects.models.project import (
                CONTRACTING,
                INVOICING_AND_REPORTING,
            )

            if source.status == CONTRACTING:
                subject = _(
                    "Project is waiting for the contract: {source.title}"
                ).format(source=source)
            elif source.status == INVOICING_AND_REPORTING:
                subject = _(
                    "Project is ready for invoicing: {source.title}"
                ).format(source=source)
            else:
                subject = _(
                    "Project status has changed to {project_status}: {source.title}"
                ).format(
                    project_status=display_project_status(source, source.user),
                    source=source,
                )
        elif message_type == MESSAGES.REQUEST_PROJECT_CHANGE:
            subject = _("Project has been rejected, please update and resubmit")
        elif message_type == MESSAGES.ASSIGN_PAF_APPROVER:
            subject = _(
                "Project documents are ready to be assigned for approval: {source.title}".format(
                    source=source
                )
            )
        elif message_type == MESSAGES.COMMENT:
            subject = _(
                "New comment on application to {ORG_LONG_NAME}: {source.title}"
            ).format(ORG_LONG_NAME=settings.ORG_LONG_NAME, source=source)
        elif message_type in {
            MESSAGES.DETERMINATION_OUTCOME,
            MESSAGES.BATCH_DETERMINATION_OUTCOME,
        }:
            subject = _(
                "Your application to {ORG_LONG_NAME} has been reviewed: {source.title_text_display}"
            ).format(ORG_LONG_NAME=settings.ORG_LONG_NAME, source=source)
        elif message_type == MESSAGES.DRAFT_SUBMISSION:
            subject = _(
                "Draft saved – application to {ORG_LONG_NAME}: {source.title}"
            ).format(ORG_LONG_NAME=settings.ORG_LONG_NAME, source=source)
        else:
            try:
                subject = source.page.specific.subject or _(
                    "Your application to {ORG_LONG_NAME}: {source.title_text_display}"
                ).format(ORG_LONG_NAME=settings.ORG_LONG_NAME, source=source)
            except AttributeError:
                subject = _("Your {ORG_LONG_NAME} project: {source.title}").format(
                    ORG_LONG_NAME=settings.ORG_LONG_NAME, source=source
                )
        return subject

extra_kwargs 

extra_kwargs(message_type, source, sources, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
175
176
177
178
def extra_kwargs(self, message_type, source, sources, **kwargs):
    return {
        "subject": self.get_subject(message_type, source),
    }

handle_transition 

handle_transition(old_phase, source, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
def handle_transition(self, old_phase, source, **kwargs):
    if not settings.SEND_TRANSITION_EMAIL:
        return

    from hypha.apply.funds.workflows import PHASES

    submission = source

    # Retrieve status index to see if we are going forward or backward.
    old_index = list(dict(PHASES).keys()).index(old_phase.name)
    target_index = list(dict(PHASES).keys()).index(submission.status)
    is_forward = old_index < target_index

    kwargs["old_phase"] = old_phase.public_name
    kwargs["new_phase"] = submission.phase.public_name

    if is_forward:
        return self.render_message(
            "messages/email/transition.html",
            source=submission,
            **kwargs,
        )

handle_co_applicant_invite 

handle_co_applicant_invite(source, related, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
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,
    )

handle_batch_transition 

handle_batch_transition(transitions, sources, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
222
223
224
225
226
227
228
229
def handle_batch_transition(self, transitions, sources, **kwargs):
    submissions = sources
    kwargs.pop("source")
    for submission in submissions:
        old_phase = transitions[submission.id]
        return self.handle_transition(
            old_phase=old_phase, source=submission, **kwargs
        )

handle_project_transition 

handle_project_transition(source, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
def handle_project_transition(self, source, **kwargs):
    from hypha.apply.projects.models.project import (
        CONTRACTING,
        INVOICING_AND_REPORTING,
    )

    if source.status == CONTRACTING:
        return self.render_message(
            "messages/email/ready_for_contracting.html",
            source=source,
            **kwargs,
        )

    if source.status == INVOICING_AND_REPORTING:
        return self.render_message(
            "messages/email/ready_for_invoicing.html",
            source=source,
            **kwargs,
        )

handle_invoice_status_updated 

handle_invoice_status_updated(related, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def handle_invoice_status_updated(self, related, **kwargs):
    if kwargs.get("recipient") and (
        user := User.objects.get(email=kwargs["recipient"])
    ):
        if user.is_applicant:
            return self.render_message(
                "messages/email/invoice_status_updated_applicant.html",
                has_changes_requested=related.has_changes_requested,
                **kwargs,
            )
        elif user.is_org_faculty:
            kwargs["source_user"] = kwargs["user"]
            kwargs["user"] = user
            return self.render_message(
                "messages/email/invoice_status_updated_staff.html",
                has_changes_requested=related.has_changes_requested,
                **kwargs,
            )

handle_invoice_updated 

handle_invoice_updated(**kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
270
271
272
273
274
def handle_invoice_updated(self, **kwargs):
    return self.render_message(
        "messages/email/invoice_updated.html",
        **kwargs,
    )

handle_determination 

handle_determination(determination, source, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
276
277
278
279
280
281
282
283
284
def handle_determination(self, determination, source, **kwargs):
    submission = source
    if determination.send_notice:
        return self.render_message(
            "messages/email/determination.html",
            source=submission,
            determination=determination,
            **kwargs,
        )

handle_batch_determination 

handle_batch_determination(determinations, sources, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
286
287
288
289
290
291
292
293
294
295
296
def handle_batch_determination(self, determinations, sources, **kwargs):
    submissions = sources
    kwargs.pop("source")
    for submission in submissions:
        determination = determinations[submission.id]
        return self.render_message(
            "messages/email/determination.html",
            source=submission,
            determination=determination,
            **kwargs,
        )

handle_ready_for_review 

handle_ready_for_review(request, source, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
298
299
300
301
302
303
304
305
def handle_ready_for_review(self, request, source, **kwargs):
    if settings.SEND_READY_FOR_REVIEW:
        return self.render_message(
            "messages/email/ready_to_review.html",
            source=source,
            request=request,
            **kwargs,
        )

handle_batch_ready_for_review 

handle_batch_ready_for_review(request, sources, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
307
308
309
310
311
312
313
314
def handle_batch_ready_for_review(self, request, sources, **kwargs):
    if settings.SEND_READY_FOR_REVIEW:
        return self.render_message(
            "messages/email/batch_ready_to_review.html",
            sources=sources,
            request=request,
            **kwargs,
        )

notify_comment 

notify_comment(**kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
316
317
318
319
320
321
322
323
def notify_comment(self, **kwargs):
    comment = kwargs["comment"]
    recipient = kwargs["recipient"]
    # Pass the user object to render_message rather than the email string
    recipient_obj = User.objects.get(email__exact=recipient)
    kwargs["recipient"] = recipient_obj
    if not comment.privileged:
        return self.render_message("messages/email/comment.html", **kwargs)

recipients 

recipients(message_type, source, user, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
def recipients(self, message_type, source, user, **kwargs):
    if is_ready_for_review(message_type):
        return self.reviewers(source)

    if is_reviewer_update(message_type):
        # Notify newly added reviewers only if they can review in the current phase
        reviewers = self.reviewers(source)
        added = kwargs.get("added", [])
        return [
            assigned_reviewer.reviewer.email
            for assigned_reviewer in added
            if assigned_reviewer.reviewer.email in reviewers
        ]

    if is_transition(message_type):
        # Only notify the applicant if the new phase can be seen within the workflow
        if not source.phase.permissions.can_view(source.user):
            return []

    if message_type == MESSAGES.COMMENT_ASSIGNED:
        assignee = kwargs.get("assignee")
        return [assignee.email]

    if message_type == MESSAGES.INVITE_COAPPLICANT:
        related = kwargs.get("related", None)
        return [related.invited_user_email]

    if message_type == MESSAGES.APPROVE_PAF:
        from hypha.apply.projects.models.project import ProjectSettings

        # notify the assigned approvers
        request = kwargs.get("request")
        project_settings = ProjectSettings.for_request(request)
        if project_settings.paf_approval_sequential:
            next_paf_approval = source.paf_approvals.filter(approved=False).first()
            if next_paf_approval and next_paf_approval.user:
                return [next_paf_approval.user.email]
        return list(
            filter(
                lambda approver: approver is not None,
                source.paf_approvals.filter(approved=False).values_list(
                    "user__email", flat=True
                ),
            )
        )

    if message_type == MESSAGES.ASSIGN_PAF_APPROVER:
        from hypha.apply.projects.models.project import ProjectSettings

        # notify PAFReviewerRole's groups' users to assign approvers
        request = kwargs.get("request")
        project_settings = ProjectSettings.for_request(request)
        if project_settings.paf_approval_sequential:
            next_paf_approval = source.paf_approvals.filter(approved=False).first()
            if next_paf_approval and not next_paf_approval.user:
                assigners = get_users_for_groups(
                    list(next_paf_approval.paf_reviewer_role.user_roles.all()),
                    exact_match=True,
                )
                return [assigner.email for assigner in assigners]

        assigners_emails = []
        if user == source.lead:
            for approval in source.paf_approvals.filter(
                approved=False, user__isnull=True
            ):
                assigners_emails.extend(
                    [
                        assigner.email
                        for assigner in get_users_for_groups(
                            list(approval.paf_reviewer_role.user_roles.all()),
                            exact_match=True,
                        )
                    ]
                )
        else:
            assigners_emails.extend(
                [
                    assigner.email
                    for assigner in get_users_for_groups(
                        list(user.groups.all()), exact_match=True
                    )
                ]
            )
        return set(assigners_emails)

    if message_type == MESSAGES.REQUEST_PROJECT_CHANGE:
        return [source.lead.email]

    if message_type == MESSAGES.SENT_TO_COMPLIANCE:
        return get_compliance_email(
            target_user_gps=[
                CONTRACTING_GROUP_NAME,
                FINANCE_GROUP_NAME,
                STAFF_GROUP_NAME,
            ]
        )

    if message_type == MESSAGES.SUBMIT_CONTRACT_DOCUMENTS:
        return get_compliance_email(target_user_gps=[STAFF_GROUP_NAME])

    if message_type in {MESSAGES.SUBMIT_REPORT, MESSAGES.UPDATE_INVOICE}:
        # Don't tell the user if they did these activities
        if user.is_applicant:
            return []

    if message_type in {MESSAGES.REVIEW_REMINDER}:
        return self.reviewers(source)

    if message_type == MESSAGES.UPDATE_INVOICE_STATUS:
        related = kwargs.get("related", None)
        if related and (status := related.status):
            if status in {
                CHANGES_REQUESTED_BY_STAFF,
                DECLINED,
                PAID,
                APPROVED_BY_FINANCE,
                PAYMENT_FAILED,
            }:
                co_applicants = source.submission.co_applicants.filter(
                    project_permission__contains=[
                        CoApplicantProjectPermission.INVOICES
                    ],
                    role__in=[CoApplicantRole.EDIT],
                ).values_list("user__email", flat=True)
                return [source.user.email, *co_applicants]
            elif status in {CHANGES_REQUESTED_BY_FINANCE, RESUBMITTED}:
                return [source.lead.email]
        return []

    if message_type == MESSAGES.PROJECT_TRANSITION:
        from hypha.apply.projects.models.project import (
            CONTRACTING,
            INVOICING_AND_REPORTING,
        )

        if source.status == CONTRACTING:
            if settings.STAFF_UPLOAD_CONTRACT:
                return get_compliance_email(
                    target_user_gps=[CONTRACTING_GROUP_NAME, STAFF_GROUP_NAME]
                )
            return get_compliance_email(target_user_gps=[CONTRACTING_GROUP_NAME])
        if source.status == INVOICING_AND_REPORTING:
            co_applicants = source.submission.co_applicants.filter(
                project_permission__contains=[
                    CoApplicantProjectPermission.INVOICES
                ],
                role__in=[CoApplicantRole.EDIT],
            ).values_list("user__email", flat=True)
            return [source.user.email, *co_applicants]

    if message_type == MESSAGES.APPROVE_INVOICE:
        if user.is_apply_staff:
            return get_compliance_email(target_user_gps=[FINANCE_GROUP_NAME])
        return []

    if message_type == MESSAGES.CREATE_INVOICE:
        if user == source.user:
            return [source.lead.email]
        else:
            co_applicants = source.submission.co_applicants.filter(
                project_permission__contains=[
                    CoApplicantProjectPermission.INVOICES
                ],
                role__in=[CoApplicantRole.EDIT],
            ).values_list("user__email", flat=True)
            return [source.user.email, *co_applicants]

    if isinstance(source, get_user_model()):
        return user.email

    ApplicationSubmission = apps.get_model("funds", "ApplicationSubmission")
    Project = apps.get_model("application_projects", "Project")
    if message_type == MESSAGES.COMMENT:
        # Comment handling for Submissions
        comment = kwargs["related"]
        if isinstance(source, ApplicationSubmission):
            # add co-applicants with Comment or edit access
            co_applicants = source.co_applicants.filter(
                role__in=[CoApplicantRole.COMMENT, CoApplicantRole.EDIT]
            ).values_list("user__email", flat=True)
            recipients: List[str] = [source.user.email, *co_applicants]

        # Comment handling for Projects
        elif isinstance(source, Project):
            # co_applciants with Comment permission
            co_applicants = (
                source.submission.co_applicants.filter(
                    role__in=[CoApplicantRole.COMMENT, CoApplicantRole.EDIT]
                )
                .exclude(project_permission=[])
                .values_list("user__email", flat=True)
            )
            recipients = [source.user.email, *co_applicants]
        try:
            recipients.remove(comment.user.email)
        except ValueError:
            pass

        return recipients

    if isinstance(source, ApplicationSubmission):
        # co-applicants edit/full-access access
        co_applicants = source.co_applicants.filter(
            role__in=[CoApplicantRole.EDIT]
        ).values_list("user__email", flat=True)
        return [source.user.email, *co_applicants]
    elif isinstance(source, Project):
        # co-applicants edit access
        co_applicants = (
            source.submission.co_applicants.exclude(project_permission=[])
            .filter(role__in=[CoApplicantRole.EDIT])
            .values_list("user__email", flat=True)
        )
        return [source.user.email, *co_applicants]
    return [source.user.email]

batch_recipients 

batch_recipients(message_type, sources, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
def batch_recipients(self, message_type, sources, **kwargs):
    if not (is_ready_for_review(message_type) or is_reviewer_update(message_type)):
        return super().batch_recipients(message_type, sources, **kwargs)

    added = [reviewer.email for _, reviewer in kwargs.get("added", []) if reviewer]

    reviewers_to_message = defaultdict(list)
    for source in sources:
        reviewers = self.reviewers(source)
        for reviewer in reviewers:
            if not is_reviewer_update(message_type) or reviewer in added:
                reviewers_to_message[reviewer].append(source)

    return [
        {
            "recipients": [reviewer],
            "sources": sources,
        }
        for reviewer, sources in reviewers_to_message.items()
    ]

reviewers 

reviewers(source)
Source code in hypha/apply/activity/adapters/emails.py 
563
564
565
566
567
568
569
def reviewers(self, source):
    return [
        reviewer.email
        for reviewer in source.missing_reviewers.all()
        if source.phase.permissions.can_review(reviewer)
        and not reviewer.is_apply_staff
    ]

render_message 

render_message(template, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
571
572
573
574
575
def render_message(self, template, **kwargs):
    with language(settings.LANGUAGE_CODE):
        text = render_to_string(template, kwargs, kwargs["request"])

    return remove_extra_empty_lines(text)

send_message 

send_message(message, source, subject, recipient, logs, **kwargs)
Source code in hypha/apply/activity/adapters/emails.py 
577
578
579
580
581
582
583
584
585
586
587
588
589
def send_message(self, message, source, subject, recipient, logs, **kwargs):
    try:
        from_email = source.page.specific.from_address
    except AttributeError:  # we're dealing with a project
        from_email = source.submission.page.specific.from_address
    except Exception as e:
        from_email = None
        logger.exception(e)

    try:
        tasks.send_mail(subject, message, from_email, [recipient], logs=logs)
    except Exception as e:
        return "Error: " + str(e)

SlackAdapter 

SlackAdapter()

Bases: AdapterBase

Notification Adaptor for internal staff on the configured slack channels.

Source code in hypha/apply/activity/adapters/slack.py 
155
156
157
158
159
160
def __init__(self):
    super().__init__()
    self.destination = settings.SLACK_ENDPOINT_URL
    self.target_room = settings.SLACK_DESTINATION_ROOM
    self.comments_room = settings.SLACK_DESTINATION_ROOM_COMMENTS
    self.comments_type = settings.SLACK_TYPE_COMMENTS

adapter_type class-attribute instance-attribute 

adapter_type = 'Slack'

always_send class-attribute instance-attribute 

always_send = True

messages class-attribute instance-attribute 

messages = {MESSAGES.NEW_SUBMISSION: _('A new submission has been submitted for {source.page.title}: <{link}|{source.title_text_display}> by {user}'), MESSAGES.UPDATE_LEAD: _('The lead of <{link}|{source.title_text_display}> has been updated from {old_lead} to {source.lead} by {user}'), MESSAGES.BATCH_UPDATE_LEAD: 'handle_batch_lead', MESSAGES.COMMENT: _('A new {comment.visibility} comment has been posted on <{link}|{source.title}> by {user}'), MESSAGES.EDIT_SUBMISSION: _('{user} has edited <{link}|{source.title_text_display}>'), MESSAGES.APPLICANT_EDIT: _('{user} has edited <{link}|{source.title_text_display}>'), MESSAGES.REVIEWERS_UPDATED: 'reviewers_updated', MESSAGES.BATCH_REVIEWERS_UPDATED: 'handle_batch_reviewers', MESSAGES.TRANSITION: _('{user} has updated the status of <{link}|{source.title_text_display}>: {old_phase.display_name} → {source.phase.display_name}'), MESSAGES.BATCH_TRANSITION: 'handle_batch_transition', MESSAGES.DETERMINATION_OUTCOME: 'handle_determination', MESSAGES.BATCH_DETERMINATION_OUTCOME: 'handle_batch_determination', MESSAGES.PROPOSAL_SUBMITTED: _('A proposal has been submitted for review: <{link}|{source.title_text_display}>'), MESSAGES.INVITED_TO_PROPOSAL: _('<{link}|{source.title_text_display}> by {source.user} has been invited to submit a proposal'), MESSAGES.NEW_REVIEW: _('{user} has submitted a review for <{link}|{source.title_text_display}>. Outcome: {review.outcome},  Score: {review.get_score_display}'), MESSAGES.READY_FOR_REVIEW: 'notify_reviewers', MESSAGES.OPENED_SEALED: _('{user} has opened the sealed submission: <{link}|{source.title_text_display}>'), MESSAGES.REVIEW_OPINION: _('{user} {opinion.opinion_display}s with {opinion.review.author}s review of <{link}|{source.title_text_display}>'), MESSAGES.BATCH_READY_FOR_REVIEW: 'batch_notify_reviewers', MESSAGES.DELETE_SUBMISSION: _('{user} has deleted {source.title_text_display}'), MESSAGES.ANONYMIZE_SUBMISSION: _('{user} has anonymized {source.title_text_display}'), MESSAGES.DELETE_REVIEW: _('{user} has deleted {review.author} review for <{link}|{source.title_text_display}>'), MESSAGES.DELETE_REVIEW_OPINION: _('{user} has deleted {review_opinion.author} review opinion for <{link}|{source.title_text_display}>'), MESSAGES.CREATED_PROJECT: _('{user} has created a Project: <{link}|{source.title}>'), MESSAGES.UPDATE_PROJECT_LEAD: _('The lead of project <{link}|{source.title}> has been updated from {old_lead} to {source.lead} by {user}'), MESSAGES.UPDATE_PROJECT_TITLE: _('The project title has been updated from <{link}|{old_title}> to <{link}|{source.title}> by {user}'), MESSAGES.UPDATE_PROJECT_CONTRACT_NUMBER: _('The contract number of project <{link}|{source.title}> has been updated to {source.contract_number} by {user}'), MESSAGES.EDIT_REVIEW: _('{user} has edited {review.author} review for <{link}|{source.title_text_display}>'), MESSAGES.SEND_FOR_APPROVAL: _('{user} has requested approval on project <{link}|{source.title}>'), MESSAGES.APPROVE_PROJECT: _('{user} has approved project <{link}|{source.title}>'), MESSAGES.REQUEST_PROJECT_CHANGE: _('{user} has requested changes for project acceptance on <{link}|{source.title}>'), MESSAGES.UPLOAD_CONTRACT: _('{user} has uploaded a contract for <{link}|{source.title}>'), MESSAGES.SUBMIT_CONTRACT_DOCUMENTS: _('{user} has submitted the contracting document for project <{link}|{source.title}>'), MESSAGES.APPROVE_CONTRACT: _('{user} has approved contract for <{link}|{source.title}>'), MESSAGES.CREATE_INVOICE: _('{user} has created invoice for <{link}|{source.title}>'), MESSAGES.UPDATE_INVOICE_STATUS: _('{user} has changed the status of <{link_related}|invoice> on <{link}|{source.title}> to {invoice.status_display}'), MESSAGES.DELETE_INVOICE: _('{user} has deleted invoice from <{link}|{source.title}>'), MESSAGES.UPDATE_INVOICE: _('{user} has updated invoice for <{link}|{source.title}>'), MESSAGES.SUBMIT_REPORT: _('{user} has submitted a report for <{link}|{source.title}>'), MESSAGES.DELETE_REPORT: _('{user} has deleted a report for <{link}|{source.title}>'), MESSAGES.BATCH_DELETE_SUBMISSION: 'handle_batch_delete_submission', MESSAGES.BATCH_ANONYMIZE_SUBMISSION: 'handle_batch_anonymize_submission', MESSAGES.STAFF_ACCOUNT_CREATED: _('{user} has created a new account for <{link}|{source}>'), MESSAGES.STAFF_ACCOUNT_EDITED: _('{user} has edited account for <{link}|{source}> that now has following roles: {roles}'), MESSAGES.BATCH_ARCHIVE_SUBMISSION: 'handle_batch_archive_submission', MESSAGES.ARCHIVE_SUBMISSION: _('{user} has archived the submission: {source.title_text_display}'), MESSAGES.UNARCHIVE_SUBMISSION: _('{user} has unarchived the submission: {source.title_text_display}'), MESSAGES.UPDATE_AUTHOR: _('{user} has updated author from {old_author} to {source.user} for submission <{link}|{source}>'), MESSAGES.COMMENT_ASSIGNED: _('A new comment has been assigned to {assignee} by {user} on submission <{link}|{source}>')}

destination instance-attribute 

destination = settings.SLACK_ENDPOINT_URL

target_room instance-attribute 

target_room = settings.SLACK_DESTINATION_ROOM

comments_room instance-attribute 

comments_room = settings.SLACK_DESTINATION_ROOM_COMMENTS

comments_type instance-attribute 

comments_type = settings.SLACK_TYPE_COMMENTS

message 

message(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def message(self, message_type, **kwargs):
    try:
        message = self.messages[message_type]
    except KeyError:
        # We don't know how to handle that message type
        return

    try:
        # see if its a method on the adapter
        method = getattr(self, message)
    except AttributeError:
        return self.render_message(message, **kwargs)
    else:
        # Delegate all responsibility to the custom method
        return method(**kwargs)

render_message 

render_message(message, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
72
73
def render_message(self, message, **kwargs):
    return message.format(**kwargs)

get_neat_related(message_type, related)
Source code in hypha/apply/activity/adapters/base.py 
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def get_neat_related(self, message_type, related):
    # We translate the related kwarg into something we can understand
    try:
        neat_name = neat_related[message_type]
    except KeyError:
        # Message type doesn't expect a related object
        if related:
            raise ValueError(
                f"Unexpected 'related' kwarg provided for {message_type}"
            ) from None
        return {}
    else:
        if not related:
            raise ValueError(f"{message_type} expects a 'related' kwarg")
        return {neat_name: related}

process_batch 

process_batch(message_type, events, request, user, sources, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def process_batch(
    self, message_type, events, request, user, sources, related=None, **kwargs
):
    events_by_source = {event.source.id: event for event in events}
    for recipient in self.batch_recipients(
        message_type, sources, user=user, **kwargs
    ):
        recipients = recipient["recipients"]
        sources = recipient["sources"]
        events = [events_by_source[source.id] for source in sources]
        self.process_send(
            message_type,
            recipients,
            events,
            request,
            user,
            sources=sources,
            source=None,
            related=related,
            **kwargs,
        )

process 

process(message_type, event, request, user, source, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
def process(
    self, message_type, event, request, user, source, related=None, **kwargs
):
    recipients = self.recipients(
        message_type,
        source=source,
        related=related,
        user=user,
        request=request,
        **kwargs,
    )
    self.process_send(
        message_type,
        recipients,
        [event],
        request,
        user,
        source,
        related=related,
        **kwargs,
    )

process_send 

process_send(message_type, recipients, events, request, user, source, sources=None, related=None, **kwargs)
Source code in hypha/apply/activity/adapters/base.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
def process_send(
    self,
    message_type,
    recipients,
    events,
    request,
    user,
    source,
    sources=None,
    related=None,
    **kwargs,
):
    if sources is None:
        sources = []
    try:
        # If this was a batch action we want to pull out the submission
        source = sources[0]
    except IndexError:
        pass

    kwargs = {
        "request": request,
        "user": user,
        "source": source,
        "sources": sources,
        "related": related,
        **kwargs,
    }
    kwargs.update(self.get_neat_related(message_type, related))
    kwargs.update(self.extra_kwargs(message_type, **kwargs))

    for recipient in recipients:
        # Allow for customization of message based on recipient string (will vary based on adapter)
        message_kwargs = {**kwargs, "recipient": recipient}
        message = self.message(message_type, **message_kwargs)
        if not message:
            continue

        message_logs = self.create_logs(message, recipient, *events)

        if settings.SEND_MESSAGES or self.always_send:
            status = self.send_message(
                message, recipient=recipient, logs=message_logs, **kwargs
            )
        else:
            status = "Message not sent as SEND_MESSAGES==FALSE"

        message_logs.update_status(status)

        if not settings.SEND_MESSAGES:
            if recipient:
                debug_message = _("{adapter} [to: {recipient}]: {message}").format(
                    adapter=self.adapter_type, recipient=recipient, message=message
                )
            else:
                debug_message = _("{adapter}: {message}").format(
                    adapter=self.adapter_type, message=message
                )
            messages.add_message(request, messages.DEBUG, debug_message)

create_logs 

create_logs(message, recipient, *events)
Source code in hypha/apply/activity/adapters/base.py 
212
213
214
215
216
217
218
def create_logs(self, message, recipient, *events):
    from ..models import Message

    messages = Message.objects.bulk_create(
        Message(**self.log_kwargs(message, recipient, event)) for event in events
    )
    return Message.objects.filter(id__in=[message.id for message in messages])

log_kwargs 

log_kwargs(message, recipient, event)
Source code in hypha/apply/activity/adapters/base.py 
220
221
222
223
224
225
226
def log_kwargs(self, message, recipient, event):
    return {
        "type": self.adapter_type,
        "content": message,
        "recipient": recipient or "",
        "event": event,
    }

slack_links(links, sources)
Source code in hypha/apply/activity/adapters/slack.py 
162
163
164
165
166
def slack_links(self, links, sources):
    return ", ".join(
        f"<{links[source.id]}|{getattr(source, 'title_text_display', source.title)}>"
        for source in sources
    )

extra_kwargs 

extra_kwargs(message_type, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
def extra_kwargs(self, message_type, **kwargs):
    source = kwargs["source"]
    sources = kwargs["sources"]
    request = kwargs["request"]
    related = kwargs["related"]
    link = link_to(source, request)
    link_related = link_to(related, request)
    links = {source.id: link_to(source, request) for source in sources}
    return {
        "link": link,
        "link_related": link_related,
        "links": links,
    }

recipients 

recipients(message_type, source, related, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
def recipients(self, message_type, source, related, **kwargs):
    if message_type in [
        MESSAGES.STAFF_ACCOUNT_CREATED,
        MESSAGES.STAFF_ACCOUNT_EDITED,
    ]:
        return [self.slack_id(kwargs["user"])]

    if message_type == MESSAGES.SEND_FOR_APPROVAL:
        return [
            self.slack_id(user)
            for user in User.objects.approvers()
            if self.slack_id(user)
        ]

    if message_type == MESSAGES.COMMENT_ASSIGNED:
        assignee = kwargs.get("assignee")
        return [self.slack_id(assignee)]

    recipients = [self.slack_id(source.lead)]
    # Notify second reviewer when first reviewer is done.
    if message_type in [MESSAGES.NEW_REVIEW, MESSAGES.REVIEW_OPINION] and related:
        submission = source
        role_reviewers = [
            role_reviewer.reviewer
            for role_reviewer in submission.assigned.with_roles()
        ]
        if related.author.reviewer in role_reviewers:
            for reviewer in role_reviewers:
                if reviewer != related.author.reviewer:
                    recipients.append(self.slack_id(reviewer))

    if message_type == MESSAGES.UPDATE_INVOICE_STATUS:
        if related.status in [
            SUBMITTED,
            RESUBMITTED,
            CHANGES_REQUESTED_BY_FINANCE,
            PAID,
            PAYMENT_FAILED,
        ]:
            # Notify project lead/staff
            return recipients
        if related.status in [APPROVED_BY_STAFF]:
            # Notify finance 1
            return [
                self.slack_id(user)
                for user in User.objects.finances()
                if self.slack_id(user)
            ]
        return []
    return recipients

batch_recipients 

batch_recipients(message_type, sources, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
233
234
235
236
237
238
239
240
241
242
def batch_recipients(self, message_type, sources, **kwargs):
    # We group the messages by lead
    leads = User.objects.filter(id__in=sources.values("lead"))
    return [
        {
            "recipients": [self.slack_id(lead)],
            "sources": sources.filter(lead=lead),
        }
        for lead in leads
    ]

reviewers_updated 

reviewers_updated(source, link, user, added=None, removed=None, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
def reviewers_updated(self, source, link, user, added=None, removed=None, **kwargs):
    if added is None:
        added = []
    if removed is None:
        removed = []
    submission = source
    message = [
        _("{user} has updated the reviewers on <{link}|{title}>").format(
            user=user, link=link, title=submission.title_text_display
        )
    ]

    if added:
        message.append(_("Added:"))
        message.extend(reviewers_message(added))

    if removed:
        message.append(_("Removed:"))
        message.extend(reviewers_message(removed))

    return " ".join(message)

handle_batch_lead 

handle_batch_lead(sources, links, user, new_lead, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
266
267
268
269
270
271
272
273
274
275
def handle_batch_lead(self, sources, links, user, new_lead, **kwargs):
    submissions = sources
    submissions_text = self.slack_links(links, submissions)
    return _(
        "{user} has batch changed lead to {new_lead} on: {submissions_text}"
    ).format(
        user=user,
        submissions_text=submissions_text,
        new_lead=new_lead,
    )

handle_batch_reviewers 

handle_batch_reviewers(sources, links, user, added, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
def handle_batch_reviewers(self, sources, links, user, added, **kwargs):
    submissions = sources
    submissions_text = self.slack_links(links, submissions)
    reviewers_text = " ".join(
        [
            _("{user} as {name},").format(user=str(user), name=role.name)
            for role, user in added
            if user
        ]
    )
    return _(
        "{user} has batch added {reviewers_text} as reviewers on: {submissions_text}"
    ).format(
        user=user,
        submissions_text=submissions_text,
        reviewers_text=reviewers_text,
    )

handle_batch_transition 

handle_batch_transition(user, links, sources, transitions, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
def handle_batch_transition(self, user, links, sources, transitions, **kwargs):
    submissions = sources
    submissions_text = [
        ": ".join(
            [
                self.slack_links(links, [submission]),
                f"{transitions[submission.id].display_name} → {submission.phase}",
            ]
        )
        for submission in submissions
    ]
    submissions_links = ",".join(submissions_text)
    return _(
        "{user} has transitioned the following submissions: {submissions_links}"
    ).format(
        user=user,
        submissions_links=submissions_links,
    )

handle_determination 

handle_determination(source, link, determination, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
def handle_determination(self, source, link, determination, **kwargs):
    submission = source
    if determination.send_notice:
        return _(
            "A determination for <{link}|{submission_title}> was sent by email. Outcome: {determination_outcome}"
        ).format(
            link=link,
            submission_title=submission.title_text_display,
            determination_outcome=determination.clean_outcome,
        )
    return _(
        "A determination for <{link}|{submission_title}> was saved without sending an email. Outcome: {determination_outcome}"
    ).format(
        link=link,
        submission_title=submission.title_text_display,
        determination_outcome=determination.clean_outcome,
    )

handle_batch_determination 

handle_batch_determination(sources, links, determinations, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
332
333
334
335
336
337
338
339
340
341
342
343
344
345
def handle_batch_determination(self, sources, links, determinations, **kwargs):
    submissions = sources
    submissions_links = ",".join(
        [self.slack_links(links, [submission]) for submission in submissions]
    )

    outcome = determinations[submissions[0].id].clean_outcome

    return _(
        "Determinations of {outcome} was sent for: {submissions_links}"
    ).format(
        outcome=outcome,
        submissions_links=submissions_links,
    )

handle_batch_delete_submission 

handle_batch_delete_submission(sources, links, user, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
347
348
349
350
351
352
353
354
def handle_batch_delete_submission(self, sources, links, user, **kwargs):
    submissions = sources
    submissions_text = ", ".join(
        [submission.title_text_display for submission in submissions]
    )
    return _("{user} has deleted submissions: {title}").format(
        user=user, title=submissions_text
    )

handle_batch_anonymize_submission 

handle_batch_anonymize_submission(sources, links, user, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
356
357
358
359
360
361
362
363
def handle_batch_anonymize_submission(self, sources, links, user, **kwargs):
    submissions = sources
    submissions_text = ", ".join(
        [submission.title_text_display for submission in submissions]
    )
    return _("{user} has anonymized submissions: {title}").format(
        user=user, title=submissions_text
    )

handle_batch_archive_submission 

handle_batch_archive_submission(sources, links, user, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
365
366
367
368
369
370
def handle_batch_archive_submission(self, sources, links, user, **kwargs):
    submissions = sources
    submissions_text = ", ".join([submission.title for submission in submissions])
    return _("{user} has archived submissions: {title}").format(
        user=user, title=submissions_text
    )

notify_reviewers 

notify_reviewers(source, link, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
def notify_reviewers(self, source, link, **kwargs):
    submission = source
    reviewers_to_notify = []
    for reviewer in submission.reviewers.all():
        if submission.phase.permissions.can_review(reviewer):
            reviewers_to_notify.append(reviewer)

    reviewers = ", ".join(str(reviewer) for reviewer in reviewers_to_notify)

    return _(
        "<{link}|{title}> is ready for review. The following are assigned as reviewers: {reviewers}"
    ).format(
        link=link,
        reviewers=reviewers,
        title=submission.title_text_display,
    )

batch_notify_reviewers 

batch_notify_reviewers(sources, links, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
389
390
391
392
393
394
395
def batch_notify_reviewers(self, sources, links, **kwargs):
    kwargs.pop("source")
    kwargs.pop("link")
    return ". ".join(
        self.notify_reviewers(source, link=links[source.id], **kwargs)
        for source in sources
    )

slack_id 

slack_id(user)
Source code in hypha/apply/activity/adapters/slack.py 
397
398
399
400
401
402
403
404
def slack_id(self, user):
    if user is None:
        return ""

    if not user.slack:
        return ""

    return f"<{user.slack}>"

slack_channels 

slack_channels(source, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
def slack_channels(self, source, **kwargs):
    # Set the default room as a start.
    target_rooms = [self.target_room]
    try:
        fund_slack_channel = source.get_from_parent("slack_channel").split(",")
    except AttributeError:
        # Not a submission object.
        pass
    else:
        # If there are custom rooms, set them in place of the default room
        custom_rooms = [channel for channel in fund_slack_channel if channel]
        if len(custom_rooms) > 0:
            target_rooms = custom_rooms

    try:
        comment = kwargs["comment"]
    except KeyError:
        # Not a comment, no extra rooms.
        pass
    else:
        if self.comments_room:
            if any(self.comments_type):
                if comment.visibility in self.comments_type:
                    target_rooms.extend([self.comments_room])
            else:
                target_rooms.extend([self.comments_room])

    # Make sure each channel name starts with a "#".
    target_rooms = [
        room.strip() if room.startswith("#") else "#" + room.strip()
        for room in target_rooms
        if room
    ]

    return target_rooms

send_message 

send_message(message, recipient, source, **kwargs)
Source code in hypha/apply/activity/adapters/slack.py 
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
def send_message(self, message, recipient, source, **kwargs):
    target_rooms = self.slack_channels(source, **kwargs)

    if not any(target_rooms) or not settings.SLACK_TOKEN:
        errors = []
        if not target_rooms:
            errors.append("Room ID")
        if not settings.SLACK_TOKEN:
            errors.append("Slack Token")
        return "Missing configuration: {}".format(", ".join(errors))

    message = " ".join([recipient, message]).strip()

    data = {
        "message": message,
    }
    for room in target_rooms:
        try:
            slack_message("messages/slack_message.html", data, channel=room)
        except Exception as e:
            logger.exception(e)
            return "400: Bad Request"
    return "200: OK"