Skip to content

Services

hypha.apply.activity.services

edit_comment 

edit_comment(activity, message)

Edit a comment by creating a clone of the original comment with the updated message.

Parameters:

  • activity (Activity) –

    The original comment activity to be edited.

  • message (str) –

    The new message to replace the original comment's message.

Returns:

  • Activity ( Activity ) –

    The edited comment activity with the updated message.

Source code in hypha/apply/activity/services.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def edit_comment(activity: Activity, message: str) -> Activity:
    """
    Edit a comment by creating a clone of the original comment with the updated message.

    Args:
        activity (Activity): The original comment activity to be edited.
        message (str): The new message to replace the original comment's message.

    Returns:
        Activity: The edited comment activity with the updated message.
    """
    if message == activity.message:
        return activity

    # Create a clone of the comment to edit
    previous = Activity.objects.get(pk=activity.pk)
    previous.pk = None
    previous.current = False
    previous.save()

    activity.previous = previous
    activity.edited = timezone.now()
    activity.message = message
    activity.current = True
    activity.save()

    return activity

get_related_actions_for_user(obj, user)

Return Activity objects related to an object, esp. useful with ApplicationSubmission and Project.

Parameters:

  • obj –

    instance of a model class

  • user –

    user who these actions are visible to.

Returns:

Source code in hypha/apply/activity/services.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def get_related_actions_for_user(obj, user):
    """Return Activity objects related to an object, esp. useful with
    ApplicationSubmission and Project.

    Args:
        obj: instance of a model class
        user: user who these actions are visible to.

    Returns:
        [`Activity`][hypha.apply.activity.models.Activity] queryset
    """
    related_query = type(obj).activities.rel.related_query_name

    return (
        Activity.actions.filter(**{related_query: obj})
        .select_related("user")
        .prefetch_related(
            "related_object",
        )
        .visible_to(user)
    )

get_related_comments_for_user(obj, user)

Return comments/communications related to an object, esp. useful with ApplicationSubmission and Project.

Parameters:

  • obj –

    instance of a model class

  • user –

    user who these actions are visible to.

Returns:

Source code in hypha/apply/activity/services.py 
 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
def get_related_comments_for_user(obj, user):
    """Return comments/communications related to an object, esp. useful with
    ApplicationSubmission and Project.

    Args:
        obj: instance of a model class
        user: user who these actions are visible to.

    Returns:
        [`Activity`][hypha.apply.activity.models.Activity] queryset
    """
    related_query = type(obj).activities.rel.related_query_name

    queryset = (
        Activity.objects.filter(**{related_query: obj})
        .exclude(current=False)
        .select_related("user")
        .prefetch_related(
            "related_object",
        )
        .visible_to(user)
    )

    if user.is_apply_staff:
        assigned_to_subquery = (
            Task.objects.filter(
                related_content_type=ContentType.objects.get_for_model(Activity),
                related_object_id=OuterRef("id"),
            )
            .select_related("user")
            .values(
                json=JSONObject(
                    full_name="user__full_name", email="user__email", id="user__id"
                )
            )
        )

        queryset = queryset.annotate(assigned_to=Subquery(assigned_to_subquery))

    return queryset

get_comment_count 

get_comment_count(obj, user)
Source code in hypha/apply/activity/services.py 
105
106
107
108
109
110
111
112
def get_comment_count(obj, user):
    related_query = type(obj).activities.rel.related_query_name

    return (
        Activity.comments.filter(**{related_query: obj})
        .exclude(current=False)
        .visible_to(user)
    ).count()