Skip to content

.activity_pub.models

cattle_grid.activity_pub.models

Data model used to describe ActivityPub related objects

Actor

Bases: Model

Actors administrated by cattle_grid

Source code in cattle_grid/activity_pub/models.py 
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
class Actor(Model):
    """Actors administrated by cattle_grid"""

    id = fields.IntField(primary_key=True)
    actor_id = fields.CharField(max_length=255, unique=True)
    """The id of the actor"""

    inbox_uri = fields.CharField(max_length=255, unique=True)
    """The uri of the inbox"""
    outbox_uri = fields.CharField(max_length=255, unique=True)
    """The uri of the outbox"""
    following_uri = fields.CharField(max_length=255, unique=True)
    """The uri of the following collection"""
    followers_uri = fields.CharField(max_length=255, unique=True)
    """The uri of the followers collection"""

    preferred_username = fields.CharField(max_length=255, null=True)
    """The preferred username, used as the username part of the
    acct-uri of the actor, i.e. `acct:${preferred_username}@domain`.
    See [RFC 7565 The 'acct' URI Scheme](https://www.rfc-editor.org/rfc/rfc7565.html)."""

    public_key_name = fields.CharField(max_length=255)
    """The name given to the public key, i.e. the id will be
    `${actor_id}#${public_key_name}."""
    public_key = fields.TextField()
    """The public key"""

    automatically_accept_followers = fields.BooleanField()
    """Set to true to indicate cattle_grid should automatically
    accept follow requests"""
    profile: Dict[str, Any] = fields.JSONField()  # type:ignore
    """Additional profile values"""

    status = fields.CharEnumField(ActorStatus, default=ActorStatus.active)
    """Represents the status of the actor"""

    created_at = fields.DatetimeField(auto_now_add=True)

    followers: fields.ReverseRelation["Follower"]
    following: fields.ReverseRelation["Following"]
    identifiers: fields.ReverseRelation["PublicIdentifier"]

actor_id class-attribute instance-attribute 

actor_id = CharField(max_length=255, unique=True)

The id of the actor

automatically_accept_followers class-attribute instance-attribute 

automatically_accept_followers = BooleanField()

Set to true to indicate cattle_grid should automatically accept follow requests

followers_uri class-attribute instance-attribute 

followers_uri = CharField(max_length=255, unique=True)

The uri of the followers collection

following_uri class-attribute instance-attribute 

following_uri = CharField(max_length=255, unique=True)

The uri of the following collection

inbox_uri class-attribute instance-attribute 

inbox_uri = CharField(max_length=255, unique=True)

The uri of the inbox

outbox_uri class-attribute instance-attribute 

outbox_uri = CharField(max_length=255, unique=True)

The uri of the outbox

preferred_username class-attribute instance-attribute 

preferred_username = CharField(max_length=255, null=True)

The preferred username, used as the username part of the acct-uri of the actor, i.e. acct:${preferred_username}@domain. See RFC 7565 The ‘acct’ URI Scheme.

profile class-attribute instance-attribute 

profile: Dict[str, Any] = JSONField()

Additional profile values

public_key class-attribute instance-attribute 

public_key = TextField()

The public key

public_key_name class-attribute instance-attribute 

public_key_name = CharField(max_length=255)

The name given to the public key, i.e. the id will be `${actor_id}#${public_key_name}.

status class-attribute instance-attribute 

status = CharEnumField(ActorStatus, default=active)

Represents the status of the actor

ActorStatus

Bases: StrEnum

Represents the status of the actor

Source code in cattle_grid/activity_pub/models.py 
15
16
17
18
19
class ActorStatus(StrEnum):
    """Represents the status of the actor"""

    active = auto()
    deleted = auto()

Blocking

Bases: Model

The people the actor is blocking

Source code in cattle_grid/activity_pub/models.py 
172
173
174
175
176
177
178
179
180
181
182
183
class Blocking(Model):
    """The people the actor is blocking"""

    id = fields.IntField(primary_key=True)

    actor: fields.ForeignKeyRelation[Actor] = fields.ForeignKeyField(
        "ap_models.Actor", related_name="blocking"
    )

    blocking = fields.CharField(max_length=255)
    request = fields.CharField(max_length=255)
    active = fields.BooleanField()

Credential

Bases: Model

The secrets of the actor

Source code in cattle_grid/activity_pub/models.py 
144
145
146
147
148
149
150
151
152
class Credential(Model):
    """The secrets of the actor"""

    id = fields.IntField(primary_key=True)

    actor_id = fields.CharField(max_length=255)
    identifier = fields.CharField(max_length=255)

    secret = fields.TextField()

Follower

Bases: Model

The people that follow the actor

Source code in cattle_grid/activity_pub/models.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class Follower(Model):
    """The people that follow the actor"""

    id = fields.IntField(primary_key=True)

    actor: fields.ForeignKeyRelation[Actor] = fields.ForeignKeyField(
        "ap_models.Actor", related_name="followers"
    )

    follower = fields.CharField(max_length=255)
    request = fields.CharField(max_length=255)
    accepted = fields.BooleanField()

Following

Bases: Model

The people the actor is following

Source code in cattle_grid/activity_pub/models.py 
107
108
109
110
111
112
113
114
115
116
117
118
class Following(Model):
    """The people the actor is following"""

    id = fields.IntField(primary_key=True)

    actor: fields.ForeignKeyRelation[Actor] = fields.ForeignKeyField(
        "ap_models.Actor", related_name="following"
    )

    following = fields.CharField(max_length=255)
    request = fields.CharField(max_length=255)
    accepted = fields.BooleanField()

InboxLocation

Bases: Model

Describes the location of an inbox. Used to send ActivityPub Activities addressed to the actor to the corresponding inbox.

This information is also collected for remote actors.

Source code in cattle_grid/activity_pub/models.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
class InboxLocation(Model):
    """Describes the location of an inbox. Used to send
    ActivityPub Activities addressed to the actor to the
    corresponding inbox.

    This information is also collected for remote actors.
    """

    id = fields.IntField(primary_key=True)
    actor = fields.CharField(max_length=255, unique=True)
    """The id of the remote actor"""
    inbox = fields.CharField(max_length=255)
    """The inbox of the remote actor"""

actor class-attribute instance-attribute 

actor = CharField(max_length=255, unique=True)

The id of the remote actor

inbox class-attribute instance-attribute 

inbox = CharField(max_length=255)

The inbox of the remote actor

PublicIdentifier

Bases: Model

Public identifiers

Source code in cattle_grid/activity_pub/models.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
class PublicIdentifier(Model):
    """Public identifiers"""

    id = fields.IntField(primary_key=True)

    actor: fields.ForeignKeyRelation[Actor] = fields.ForeignKeyField(
        "ap_models.Actor", related_name="identifiers"
    )
    """The actor the public key belongs to"""

    name = fields.CharField(max_length=255)
    """name of public identifier"""
    identifier = fields.CharField(max_length=255, unique=True)
    """The public identifier, e.g. an acct-uri"""
    preference = fields.IntField(default=0)
    """Determines the order of identifiers in the `identifiers` field of the actor profile"""

    status = fields.CharEnumField(
        PublicIdentifierStatus, default=PublicIdentifierStatus.verified
    )
    """Represents the status of the public identifier"""

actor class-attribute instance-attribute 

actor: ForeignKeyRelation[Actor] = ForeignKeyField(
    "ap_models.Actor", related_name="identifiers"
)

The actor the public key belongs to

identifier class-attribute instance-attribute 

identifier = CharField(max_length=255, unique=True)

The public identifier, e.g. an acct-uri

name class-attribute instance-attribute 

name = CharField(max_length=255)

name of public identifier

preference class-attribute instance-attribute 

preference = IntField(default=0)

Determines the order of identifiers in the identifiers field of the actor profile

status class-attribute instance-attribute 

status = CharEnumField(
    PublicIdentifierStatus, default=verified
)

Represents the status of the public identifier

PublicIdentifierStatus

Bases: StrEnum

Represents the status of the public identifier

Source code in cattle_grid/activity_pub/models.py 
22
23
24
25
26
27
28
29
30
31
32
class PublicIdentifierStatus(StrEnum):
    """Represents the status of the public identifier"""

    unverified = auto()
    """This identifier could not be verified"""

    verified = auto()
    """This identifier was verified"""

    owned = auto()
    """This is an identifier owned by the cattle_grid instance"""

owned class-attribute instance-attribute 

owned = auto()

This is an identifier owned by the cattle_grid instance

unverified class-attribute instance-attribute 

unverified = auto()

This identifier could not be verified

verified class-attribute instance-attribute 

verified = auto()

This identifier was verified

StoredActivity

Bases: Model

cattle_grid generates activities under some circumstances (see FIXME). These will be stored in this table

Source code in cattle_grid/activity_pub/models.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
class StoredActivity(Model):
    """cattle_grid generates activities under some
    circumstances (see FIXME). These will be stored
    in this table"""

    id = fields.CharField(max_length=255, primary_key=True)

    actor: fields.ForeignKeyRelation[Actor] = fields.ForeignKeyField("ap_models.Actor")
    """The actor this activity orginates from"""

    data: dict = fields.JSONField()  # type: ignore
    """The activity"""

    published = fields.DatetimeField()
    """When the activity was published"""

actor class-attribute instance-attribute 

actor: ForeignKeyRelation[Actor] = ForeignKeyField(
    "ap_models.Actor"
)

The actor this activity orginates from

data class-attribute instance-attribute 

data: dict = JSONField()

The activity

published class-attribute instance-attribute 

published = DatetimeField()

When the activity was published