Skip to content

Models

hypha.apply.activity.models

COMMENT module-attribute 

COMMENT = 'comment'

ACTION module-attribute 

ACTION = 'action'

ACTIVITY_TYPES module-attribute 

ACTIVITY_TYPES = {COMMENT: _('Comment'), ACTION: _('Action')}

APPLICANT module-attribute 

APPLICANT = 'applicant'

TEAM module-attribute 

TEAM = 'team'

REVIEWER module-attribute 

REVIEWER = 'reviewers'

ALL module-attribute 

ALL = 'all'

VISIBILITY module-attribute 

VISIBILITY = {APPLICANT: _('Applicants'), TEAM: _('Staff only'), REVIEWER: _('Reviewers'), ALL: _('All')}

BaseActivityQuerySet

Bases: QuerySet

visible_to 

visible_to(user)

Get a QuerySet of all items that are visible to the given user.

Parameters:

  • user –

    User to filter visibility of

Returns:

  • QuerySet –

    A QuerySet containing all items visible to the specified user

Source code in hypha/apply/activity/models.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def visible_to(self, user) -> models.QuerySet:
    """Get a QuerySet of all items that are visible to the given user.

    Args:
        user:
            [`User`][hypha.apply.users.models.User] to filter visibility of

    Returns:
        A QuerySet containing all items visible to the specified user
    """

    # To hide reviews from the applicant's activity feed
    # Todo: It is just for historic data and not be needed for new data after this.
    from .messaging import ActivityAdapter

    messages = ActivityAdapter.messages

    user_qs = Q(user=user)

    if user.is_applicant:
        # Handle the edge case where a reviewer is also an
        # applicant. Ensures that any applications/projects the user
        # authored will have comment visibility of applicant while others
        # will get the appropriate role.
        if user.is_reviewer:
            ApplicationSubmission = apps.get_model("funds", "ApplicationSubmission")
            Project = apps.get_model("application_projects", "Project")

            app_content_type = ContentType.objects.get_for_model(
                ApplicationSubmission
            )
            proj_content_type = ContentType.objects.get_for_model(Project)

            authored_apps = ApplicationSubmission.objects.filter(user_qs).values(
                "id"
            )
            authored_projs = Project.objects.filter(user_qs).values("id")

            proj_app_qs = (
                Q(source_content_type=app_content_type)
                & Q(source_object_id__in=authored_apps)
            ) | (
                Q(source_content_type=proj_content_type)
                & Q(source_object_id__in=authored_projs)
            )

            # Activities the user is the author of the source submission
            applicant_activity = self.filter(
                proj_app_qs
                & Q(
                    Q(visibility__in=self.model.visibility_for(user, True))
                    | user_qs
                )
            )
            # All other activities
            other_activity = self.exclude(
                Q(message=messages.get(MESSAGES.NEW_REVIEW)) | proj_app_qs
            ).filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)
            return applicant_activity | other_activity
        else:
            return self.exclude(message=messages.get(MESSAGES.NEW_REVIEW)).filter(
                Q(visibility__in=self.model.visibility_for(user)) | user_qs
            )

    return self.filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)

newer 

newer(activity)
Source code in hypha/apply/activity/models.py 
110
111
def newer(self, activity):
    return self.filter(timestamp__gt=activity.timestamp)

ActivityQuerySet

Bases: BaseActivityQuerySet

comments 

comments()
Source code in hypha/apply/activity/models.py 
115
116
def comments(self):
    return self.filter(type=COMMENT)

actions 

actions()
Source code in hypha/apply/activity/models.py 
118
119
def actions(self):
    return self.filter(type=ACTION)

latest 

latest()
Source code in hypha/apply/activity/models.py 
121
122
123
124
def latest(self):
    return self.filter(
        timestamp__gte=(timezone.now() - timezone.timedelta(days=30))
    )

visible_to 

visible_to(user)

Get a QuerySet of all items that are visible to the given user.

Parameters:

  • user –

    User to filter visibility of

Returns:

  • QuerySet –

    A QuerySet containing all items visible to the specified user

Source code in hypha/apply/activity/models.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def visible_to(self, user) -> models.QuerySet:
    """Get a QuerySet of all items that are visible to the given user.

    Args:
        user:
            [`User`][hypha.apply.users.models.User] to filter visibility of

    Returns:
        A QuerySet containing all items visible to the specified user
    """

    # To hide reviews from the applicant's activity feed
    # Todo: It is just for historic data and not be needed for new data after this.
    from .messaging import ActivityAdapter

    messages = ActivityAdapter.messages

    user_qs = Q(user=user)

    if user.is_applicant:
        # Handle the edge case where a reviewer is also an
        # applicant. Ensures that any applications/projects the user
        # authored will have comment visibility of applicant while others
        # will get the appropriate role.
        if user.is_reviewer:
            ApplicationSubmission = apps.get_model("funds", "ApplicationSubmission")
            Project = apps.get_model("application_projects", "Project")

            app_content_type = ContentType.objects.get_for_model(
                ApplicationSubmission
            )
            proj_content_type = ContentType.objects.get_for_model(Project)

            authored_apps = ApplicationSubmission.objects.filter(user_qs).values(
                "id"
            )
            authored_projs = Project.objects.filter(user_qs).values("id")

            proj_app_qs = (
                Q(source_content_type=app_content_type)
                & Q(source_object_id__in=authored_apps)
            ) | (
                Q(source_content_type=proj_content_type)
                & Q(source_object_id__in=authored_projs)
            )

            # Activities the user is the author of the source submission
            applicant_activity = self.filter(
                proj_app_qs
                & Q(
                    Q(visibility__in=self.model.visibility_for(user, True))
                    | user_qs
                )
            )
            # All other activities
            other_activity = self.exclude(
                Q(message=messages.get(MESSAGES.NEW_REVIEW)) | proj_app_qs
            ).filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)
            return applicant_activity | other_activity
        else:
            return self.exclude(message=messages.get(MESSAGES.NEW_REVIEW)).filter(
                Q(visibility__in=self.model.visibility_for(user)) | user_qs
            )

    return self.filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)

newer 

newer(activity)
Source code in hypha/apply/activity/models.py 
110
111
def newer(self, activity):
    return self.filter(timestamp__gt=activity.timestamp)

ActivityBaseManager

Bases: Manager

create 

create(**kwargs)
Source code in hypha/apply/activity/models.py 
128
129
130
def create(self, **kwargs):
    kwargs.update(type=self.type)
    return super().create(**kwargs)

get_queryset 

get_queryset()
Source code in hypha/apply/activity/models.py 
132
133
134
135
136
137
138
139
140
def get_queryset(self):
    return (
        super()
        .get_queryset()
        .filter(
            type=self.type,
            current=True,
        )
    )

CommentQueryset

Bases: BaseActivityQuerySet

visible_to 

visible_to(user)

Get a QuerySet of all items that are visible to the given user.

Parameters:

  • user –

    User to filter visibility of

Returns:

  • QuerySet –

    A QuerySet containing all items visible to the specified user

Source code in hypha/apply/activity/models.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def visible_to(self, user) -> models.QuerySet:
    """Get a QuerySet of all items that are visible to the given user.

    Args:
        user:
            [`User`][hypha.apply.users.models.User] to filter visibility of

    Returns:
        A QuerySet containing all items visible to the specified user
    """

    # To hide reviews from the applicant's activity feed
    # Todo: It is just for historic data and not be needed for new data after this.
    from .messaging import ActivityAdapter

    messages = ActivityAdapter.messages

    user_qs = Q(user=user)

    if user.is_applicant:
        # Handle the edge case where a reviewer is also an
        # applicant. Ensures that any applications/projects the user
        # authored will have comment visibility of applicant while others
        # will get the appropriate role.
        if user.is_reviewer:
            ApplicationSubmission = apps.get_model("funds", "ApplicationSubmission")
            Project = apps.get_model("application_projects", "Project")

            app_content_type = ContentType.objects.get_for_model(
                ApplicationSubmission
            )
            proj_content_type = ContentType.objects.get_for_model(Project)

            authored_apps = ApplicationSubmission.objects.filter(user_qs).values(
                "id"
            )
            authored_projs = Project.objects.filter(user_qs).values("id")

            proj_app_qs = (
                Q(source_content_type=app_content_type)
                & Q(source_object_id__in=authored_apps)
            ) | (
                Q(source_content_type=proj_content_type)
                & Q(source_object_id__in=authored_projs)
            )

            # Activities the user is the author of the source submission
            applicant_activity = self.filter(
                proj_app_qs
                & Q(
                    Q(visibility__in=self.model.visibility_for(user, True))
                    | user_qs
                )
            )
            # All other activities
            other_activity = self.exclude(
                Q(message=messages.get(MESSAGES.NEW_REVIEW)) | proj_app_qs
            ).filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)
            return applicant_activity | other_activity
        else:
            return self.exclude(message=messages.get(MESSAGES.NEW_REVIEW)).filter(
                Q(visibility__in=self.model.visibility_for(user)) | user_qs
            )

    return self.filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)

newer 

newer(activity)
Source code in hypha/apply/activity/models.py 
110
111
def newer(self, activity):
    return self.filter(timestamp__gt=activity.timestamp)

CommentManger

Bases: ActivityBaseManager

type class-attribute instance-attribute 

type = COMMENT

create 

create(**kwargs)
Source code in hypha/apply/activity/models.py 
128
129
130
def create(self, **kwargs):
    kwargs.update(type=self.type)
    return super().create(**kwargs)

get_queryset 

get_queryset()
Source code in hypha/apply/activity/models.py 
132
133
134
135
136
137
138
139
140
def get_queryset(self):
    return (
        super()
        .get_queryset()
        .filter(
            type=self.type,
            current=True,
        )
    )

ActionQueryset

Bases: BaseActivityQuerySet

visible_to 

visible_to(user)

Get a QuerySet of all items that are visible to the given user.

Parameters:

  • user –

    User to filter visibility of

Returns:

  • QuerySet –

    A QuerySet containing all items visible to the specified user

Source code in hypha/apply/activity/models.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def visible_to(self, user) -> models.QuerySet:
    """Get a QuerySet of all items that are visible to the given user.

    Args:
        user:
            [`User`][hypha.apply.users.models.User] to filter visibility of

    Returns:
        A QuerySet containing all items visible to the specified user
    """

    # To hide reviews from the applicant's activity feed
    # Todo: It is just for historic data and not be needed for new data after this.
    from .messaging import ActivityAdapter

    messages = ActivityAdapter.messages

    user_qs = Q(user=user)

    if user.is_applicant:
        # Handle the edge case where a reviewer is also an
        # applicant. Ensures that any applications/projects the user
        # authored will have comment visibility of applicant while others
        # will get the appropriate role.
        if user.is_reviewer:
            ApplicationSubmission = apps.get_model("funds", "ApplicationSubmission")
            Project = apps.get_model("application_projects", "Project")

            app_content_type = ContentType.objects.get_for_model(
                ApplicationSubmission
            )
            proj_content_type = ContentType.objects.get_for_model(Project)

            authored_apps = ApplicationSubmission.objects.filter(user_qs).values(
                "id"
            )
            authored_projs = Project.objects.filter(user_qs).values("id")

            proj_app_qs = (
                Q(source_content_type=app_content_type)
                & Q(source_object_id__in=authored_apps)
            ) | (
                Q(source_content_type=proj_content_type)
                & Q(source_object_id__in=authored_projs)
            )

            # Activities the user is the author of the source submission
            applicant_activity = self.filter(
                proj_app_qs
                & Q(
                    Q(visibility__in=self.model.visibility_for(user, True))
                    | user_qs
                )
            )
            # All other activities
            other_activity = self.exclude(
                Q(message=messages.get(MESSAGES.NEW_REVIEW)) | proj_app_qs
            ).filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)
            return applicant_activity | other_activity
        else:
            return self.exclude(message=messages.get(MESSAGES.NEW_REVIEW)).filter(
                Q(visibility__in=self.model.visibility_for(user)) | user_qs
            )

    return self.filter(Q(visibility__in=self.model.visibility_for(user)) | user_qs)

newer 

newer(activity)
Source code in hypha/apply/activity/models.py 
110
111
def newer(self, activity):
    return self.filter(timestamp__gt=activity.timestamp)

ActionManager

Bases: ActivityBaseManager

type class-attribute instance-attribute 

type = ACTION

create 

create(**kwargs)
Source code in hypha/apply/activity/models.py 
128
129
130
def create(self, **kwargs):
    kwargs.update(type=self.type)
    return super().create(**kwargs)

get_queryset 

get_queryset()
Source code in hypha/apply/activity/models.py 
132
133
134
135
136
137
138
139
140
def get_queryset(self):
    return (
        super()
        .get_queryset()
        .filter(
            type=self.type,
            current=True,
        )
    )

ActivityAttachment

Bases: Model

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

uuid class-attribute instance-attribute 

uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)

activity class-attribute instance-attribute 

activity = models.ForeignKey('Activity', on_delete=models.CASCADE, related_name='attachments')

file class-attribute instance-attribute 

file = models.FileField(upload_to=get_attachment_upload_path, storage=PrivateStorage())

filename property 

filename

Meta

verbose_name class-attribute instance-attribute 
verbose_name = _('activity attachment')
verbose_name_plural class-attribute instance-attribute 
verbose_name_plural = _('activity attachments')

get_absolute_url 

get_absolute_url()
Source code in hypha/apply/activity/models.py 
186
187
def get_absolute_url(self):
    return reverse("activity:attachment", kwargs={"file_pk": str(self.uuid)})

Activity

Bases: Model

timestamp class-attribute instance-attribute 

timestamp = models.DateTimeField()

type class-attribute instance-attribute 

type = models.CharField(choices=ACTIVITY_TYPES.items(), max_length=30)

user class-attribute instance-attribute 

user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)

source_content_type class-attribute instance-attribute 

source_content_type = models.ForeignKey(ContentType, blank=True, null=True, on_delete=models.CASCADE, related_name='activity_source')

source_object_id class-attribute instance-attribute 

source_object_id = models.PositiveIntegerField(blank=True, null=True, db_index=True)

source class-attribute instance-attribute 

source = GenericForeignKey('source_content_type', 'source_object_id')

message class-attribute instance-attribute 

message = models.TextField(_('message'))

visibility class-attribute instance-attribute 

visibility = models.CharField(_('visibility'), choices=list(VISIBILITY.items()), default=APPLICANT, max_length=30)

edited class-attribute instance-attribute 

edited = models.DateTimeField(default=None, null=True)

deleted class-attribute instance-attribute 

deleted = models.DateTimeField(default=None, null=True)

current class-attribute instance-attribute 

current = models.BooleanField(default=True)

previous class-attribute instance-attribute 

previous = models.ForeignKey('self', on_delete=models.CASCADE, null=True)

related_content_type class-attribute instance-attribute 

related_content_type = models.ForeignKey(ContentType, blank=True, null=True, on_delete=models.CASCADE, related_name='activity_related')

related_object_id class-attribute instance-attribute 

related_object_id = models.PositiveIntegerField(blank=True, null=True)

related_object class-attribute instance-attribute 

related_object = GenericForeignKey('related_content_type', 'related_object_id')

objects class-attribute instance-attribute 

objects = models.Manager.from_queryset(ActivityQuerySet)()

comments class-attribute instance-attribute 

comments = CommentManger.from_queryset(CommentQueryset)()

actions class-attribute instance-attribute 

actions = ActionManager.from_queryset(ActionQueryset)()

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

privileged property 

privileged

private property 

private

Meta

ordering class-attribute instance-attribute 
ordering = ['-timestamp']
base_manager_name class-attribute instance-attribute 
base_manager_name = 'objects'
verbose_name class-attribute instance-attribute 
verbose_name = _('activity')
verbose_name_plural class-attribute instance-attribute 
verbose_name_plural = _('activities')

get_absolute_url 

get_absolute_url()
Source code in hypha/apply/activity/models.py 
242
243
244
245
246
247
248
249
def get_absolute_url(self):
    # coverup for both submission and project as source.
    submission_id = (
        self.source.submission_id
        if hasattr(self.source, "submission")
        else self.source.id
    )
    return f"{reverse('funds:submissions:comments', args=[submission_id])}#communications--{self.id}"

visibility_for classmethod 

visibility_for(user, is_submission_author=False)

Gets activity visibility for a specified user

Takes an optional boolean that is used to determine the visibility of an application comment.

Parameters:

  • user –

    User to get visibility for

  • is_submission_author (Optional[bool], default: False ) –

    boolean used when the user is the applicant of the source activity

Returns:

  • List[str] –

    A list of visibility strings

Source code in hypha/apply/activity/models.py 
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
@classmethod
def visibility_for(
    cls, user, is_submission_author: Optional[bool] = False
) -> List[str]:
    """Gets activity visibility for a specified user

    Takes an optional boolean that is used to determine the visibility of
    an application comment.

    Args:
        user:
            [`User`][hypha.apply.users.models.User] to get visibility for
        is_submission_author:
            boolean used when the `user` is the applicant of the source activity

    Returns:
        A list of visibility strings
    """
    if user.is_apply_staff or user.is_finance or user.is_contracting:
        return [TEAM, APPLICANT, REVIEWER, ALL]
    if user.is_reviewer and not is_submission_author:
        return [REVIEWER, ALL]
    if user.is_applicant:
        return [APPLICANT, ALL]

    return [ALL]

visibility_choices_for classmethod 

visibility_choices_for(user, has_coapplicants=False)

Gets activity visibility choices for the specified user

Parameters:

  • user –

    The User being given visibility choices

Returns:

  • List[Tuple[str, str]] –

    A list of tuples in the format of:

  • List[Tuple[str, str]] –

    [(, ), ...]

Source code in hypha/apply/activity/models.py 
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
@classmethod
def visibility_choices_for(
    cls, user, has_coapplicants=False
) -> List[Tuple[str, str]]:
    """Gets activity visibility choices for the specified user

    Args:
        user: The [`User`][hypha.apply.users.models.User] being given visibility choices

    Returns:
        A list of tuples in the format of:
        [(<visibility string>, <visibility display string>), ...]
    """

    if user.is_apply_staff:
        return [
            (TEAM, VISIBILITY[TEAM]),
            (APPLICANT, VISIBILITY[APPLICANT]),
            (REVIEWER, VISIBILITY[REVIEWER]),
            (ALL, VISIBILITY[ALL]),
        ]

    if user.is_applicant:
        applicant_choices = [(APPLICANT, VISIBILITY[APPLICANT])]
        if has_coapplicants:
            applicant_choices.append((TEAM, VISIBILITY[TEAM]))
        return applicant_choices

    if user.is_reviewer:
        return [(REVIEWER, VISIBILITY[REVIEWER])]

    if user.is_finance or user.is_contracting:
        return [(TEAM, VISIBILITY[TEAM]), (APPLICANT, VISIBILITY[APPLICANT])]

    return [(ALL, VISIBILITY[ALL])]

Event

Bases: Model

Model to track when messages are triggered

wagtail_reference_index_ignore class-attribute instance-attribute 

wagtail_reference_index_ignore = True

when class-attribute instance-attribute 

when = models.DateTimeField(auto_now_add=True)

type class-attribute instance-attribute 

type = models.CharField(_('verb'), choices=MESSAGES.choices, max_length=50)

by class-attribute instance-attribute 

by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, null=True)

content_type class-attribute instance-attribute 

content_type = models.ForeignKey(ContentType, blank=True, null=True, on_delete=models.CASCADE)

object_id class-attribute instance-attribute 

object_id = models.PositiveIntegerField(blank=True, null=True)

source class-attribute instance-attribute 

source = GenericForeignKey('content_type', 'object_id')

Meta

verbose_name class-attribute instance-attribute 
verbose_name = _('event')
verbose_name_plural class-attribute instance-attribute 
verbose_name_plural = _('events')

MessagesQueryset

Bases: QuerySet

update_status 

update_status(status)
Source code in hypha/apply/activity/models.py 
356
357
358
359
360
361
362
363
364
def update_status(self, status):
    if status:
        return self.update(
            status=Case(
                When(status="", then=Value(status)),
                default=Concat("status", Value("<br />" + status)),
                output_field=models.TextField(),
            ),
        )

Message

Bases: Model

Model to track content of messages sent from an event

type class-attribute instance-attribute 

type = models.CharField(max_length=15)

content class-attribute instance-attribute 

content = models.TextField()

recipient class-attribute instance-attribute 

recipient = models.CharField(max_length=250)

event class-attribute instance-attribute 

event = models.ForeignKey(Event, on_delete=models.CASCADE)

status class-attribute instance-attribute 

status = models.TextField()

external_id class-attribute instance-attribute 

external_id = models.CharField(max_length=75, null=True, blank=True)

sent_in_email_digest class-attribute instance-attribute 

sent_in_email_digest = models.BooleanField(default=False)

objects class-attribute instance-attribute 

objects = MessagesQueryset.as_manager()

Meta

verbose_name class-attribute instance-attribute 
verbose_name = _('message')
verbose_name_plural class-attribute instance-attribute 
verbose_name_plural = _('messages')

update_status 

update_status(status)
Source code in hypha/apply/activity/models.py 
390
391
392
393
394
395
396
397
def update_status(self, status):
    if status:
        self.status = Case(
            When(status="", then=Value(status)),
            default=Concat("status", Value("<br />" + status)),
            output_field=models.TextField(),
        )
        self.save()

get_attachment_upload_path 

get_attachment_upload_path(instance, filename)
Source code in hypha/apply/activity/models.py 
159
160
def get_attachment_upload_path(instance, filename):
    return f"activity/attachments/{instance.id}/{get_valid_filename(filename)}"