summaryrefslogtreecommitdiffstats
path: root/users/models/follow.py
blob: 94ad40f927463a78eefb44abbe1f73e9beddb7cc (plain)
1
2
3
4
5
6
7
8
9
10
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
38
39
40
41
42
43
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
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
174
175
176
177
178
179
180
181
182
183
184
185
from typing import Optional

from django.db import models

from core.ld import canonicalise
from core.signatures import HttpSignature
from stator.models import State, StateField, StateGraph, StatorModel


class FollowStates(StateGraph):
    unrequested = State(try_interval=30)
    local_requested = State(try_interval=24 * 60 * 60)
    remote_requested = State(try_interval=24 * 60 * 60)
    accepted = State(externally_progressed=True)
    undone_locally = State(try_interval=60 * 60)
    undone_remotely = State()

    unrequested.transitions_to(local_requested)
    unrequested.transitions_to(remote_requested)
    local_requested.transitions_to(accepted)
    remote_requested.transitions_to(accepted)
    accepted.transitions_to(undone_locally)
    undone_locally.transitions_to(undone_remotely)

    @classmethod
    async def handle_unrequested(cls, instance: "Follow"):
        # Re-retrieve the follow with more things linked
        follow = await Follow.objects.select_related(
            "source", "source__domain", "target"
        ).aget(pk=instance.pk)
        # Remote follows should not be here
        if not follow.source.local:
            return cls.remote_requested
        # Construct the request
        request = canonicalise(
            {
                "@context": "https://www.w3.org/ns/activitystreams",
                "id": follow.uri,
                "type": "Follow",
                "actor": follow.source.actor_uri,
                "object": follow.target.actor_uri,
            }
        )
        # Sign it and send it
        await HttpSignature.signed_request(
            follow.target.inbox_uri, request, follow.source
        )
        return cls.local_requested

    @classmethod
    async def handle_local_requested(cls, instance: "Follow"):
        # TODO: Resend follow requests occasionally
        pass

    @classmethod
    async def handle_remote_requested(cls, instance: "Follow"):
        # Re-retrieve the follow with more things linked
        follow = await Follow.objects.select_related(
            "source", "source__domain", "target"
        ).aget(pk=instance.pk)
        # Send an accept
        request = canonicalise(
            {
                "@context": "https://www.w3.org/ns/activitystreams",
                "id": follow.target.actor_uri + f"follow/{follow.pk}/#accept",
                "type": "Follow",
                "actor": follow.source.actor_uri,
                "object": {
                    "id": follow.uri,
                    "type": "Follow",
                    "actor": follow.source.actor_uri,
                    "object": follow.target.actor_uri,
                },
            }
        )
        # Sign it and send it
        await HttpSignature.signed_request(
            follow.source.inbox_uri,
            request,
            identity=follow.target,
        )
        return cls.accepted

    @classmethod
    async def handle_undone_locally(cls, instance: "Follow"):
        follow = Follow.objects.select_related(
            "source", "source__domain", "target"
        ).get(pk=instance.pk)
        # Construct the request
        request = canonicalise(
            {
                "@context": "https://www.w3.org/ns/activitystreams",
                "id": follow.uri + "#undo",
                "type": "Undo",
                "actor": follow.source.actor_uri,
                "object": {
                    "id": follow.uri,
                    "type": "Follow",
                    "actor": follow.source.actor_uri,
                    "object": follow.target.actor_uri,
                },
            }
        )
        # Sign it and send it
        await HttpSignature.signed_request(
            follow.target.inbox_uri, request, follow.source
        )
        return cls.undone_remotely


class Follow(StatorModel):
    """
    When one user (the source) follows other (the target)
    """

    source = models.ForeignKey(
        "users.Identity",
        on_delete=models.CASCADE,
        related_name="outbound_follows",
    )
    target = models.ForeignKey(
        "users.Identity",
        on_delete=models.CASCADE,
        related_name="inbound_follows",
    )

    uri = models.CharField(blank=True, null=True, max_length=500)
    note = models.TextField(blank=True, null=True)

    state = StateField(FollowStates)

    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)

    class Meta:
        unique_together = [("source", "target")]

    @classmethod
    def maybe_get(cls, source, target) -> Optional["Follow"]:
        """
        Returns a follow if it exists between source and target
        """
        try:
            return Follow.objects.get(source=source, target=target)
        except Follow.DoesNotExist:
            return None

    @classmethod
    def create_local(cls, source, target):
        """
        Creates a Follow from a local Identity to the target
        (which can be local or remote).
        """
        if not source.local:
            raise ValueError("You cannot initiate follows from a remote Identity")
        try:
            follow = Follow.objects.get(source=source, target=target)
        except Follow.DoesNotExist:
            follow = Follow.objects.create(source=source, target=target, uri="")
            follow.uri = source.actor_uri + f"follow/{follow.pk}/"
            # TODO: Local follow approvals
            if target.local:
                follow.state = FollowStates.accepted
            follow.save()
        return follow

    @classmethod
    def remote_created(cls, source, target, uri):
        follow = cls.maybe_get(source=source, target=target)
        if follow is None:
            follow = Follow.objects.create(source=source, target=target, uri=uri)
        if follow.state == FollowStates.unrequested:
            follow.transition_perform(FollowStates.remote_requested)

    @classmethod
    def remote_accepted(cls, source, target):
        print(f"accepted follow source {source} target {target}")
        follow = cls.maybe_get(source=source, target=target)
        print(f"accepting follow {follow}")
        if follow and follow.state in [
            FollowStates.unrequested,
            FollowStates.local_requested,
        ]:
            follow.transition_perform(FollowStates.accepted)
            print("accepted")