account.go (13228B)
1 // GoToSocial 2 // Copyright (C) GoToSocial Authors admin@gotosocial.org 3 // SPDX-License-Identifier: AGPL-3.0-or-later 4 // 5 // This program is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Affero General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // This program is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Affero General Public License for more details. 14 // 15 // You should have received a copy of the GNU Affero General Public License 16 // along with this program. If not, see <http://www.gnu.org/licenses/>. 17 18 // Package gtsmodel contains types used *internally* by GoToSocial and added/removed/selected from the database. 19 // These types should never be serialized and/or sent out via public APIs, as they contain sensitive information. 20 // The annotation used on these structs is for handling them via the bun-db ORM. 21 // See here for more info on bun model annotations: https://bun.uptrace.dev/guide/models.html 22 package gtsmodel 23 24 import ( 25 "crypto/rsa" 26 "time" 27 ) 28 29 // Account represents either a local or a remote fediverse account, gotosocial or otherwise (mastodon, pleroma, etc). 30 type Account struct { 31 ID string `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database 32 CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created 33 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated 34 Username string `validate:"required" bun:",nullzero,notnull,unique:userdomain"` // Username of the account, should just be a string of [a-zA-Z0-9_]. Can be added to domain to create the full username in the form ``[username]@[domain]`` eg., ``user_96@example.org``. Username and domain should be unique *with* each other 35 Domain string `validate:"omitempty,fqdn" bun:",nullzero,unique:userdomain"` // Domain of the account, will be null if this is a local account, otherwise something like ``example.org``. Should be unique with username. 36 AvatarMediaAttachmentID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // Database ID of the media attachment, if present 37 AvatarMediaAttachment *MediaAttachment `validate:"-" bun:"rel:belongs-to"` // MediaAttachment corresponding to avatarMediaAttachmentID 38 AvatarRemoteURL string `validate:"omitempty,url" bun:",nullzero"` // For a non-local account, where can the header be fetched? 39 HeaderMediaAttachmentID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // Database ID of the media attachment, if present 40 HeaderMediaAttachment *MediaAttachment `validate:"-" bun:"rel:belongs-to"` // MediaAttachment corresponding to headerMediaAttachmentID 41 HeaderRemoteURL string `validate:"omitempty,url" bun:",nullzero"` // For a non-local account, where can the header be fetched? 42 DisplayName string `validate:"-" bun:""` // DisplayName for this account. Can be empty, then just the Username will be used for display purposes. 43 Fields []Field `validate:"-"` // a key/value map of fields that this account has added to their profile 44 Note string `validate:"-" bun:""` // A note that this account has on their profile (ie., the account's bio/description of themselves) 45 Memorial bool `validate:"-" bun:",default:false"` // Is this a memorial account, ie., has the user passed away? 46 AlsoKnownAs string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // This account is associated with x account id (TODO: migrate to be AlsoKnownAsID) 47 MovedToAccountID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // This account has moved this account id in the database 48 Bot bool `validate:"-" bun:",default:false"` // Does this account identify itself as a bot? 49 Reason string `validate:"-" bun:""` // What reason was given for signing up when this account was created? 50 Locked bool `validate:"-" bun:",default:true"` // Does this account need an approval for new followers? 51 Discoverable bool `validate:"-" bun:",default:false"` // Should this account be shown in the instance's profile directory? 52 Privacy Visibility `validate:"required_without=Domain,omitempty,oneof=public unlocked followers_only mutuals_only direct" bun:",nullzero"` // Default post privacy for this account 53 Sensitive bool `validate:"-" bun:",default:false"` // Set posts from this account to sensitive by default? 54 Language string `validate:"omitempty,bcp47_language_tag" bun:",nullzero,notnull,default:'en'"` // What language does this account post in? 55 URI string `validate:"required,url" bun:",nullzero,notnull,unique"` // ActivityPub URI for this account. 56 URL string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Web URL for this account's profile 57 LastWebfingeredAt time.Time `validate:"required_with=Domain" bun:"type:timestamptz,nullzero"` // Last time this account was refreshed/located with webfinger. 58 InboxURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Address of this account's ActivityPub inbox, for sending activity to 59 OutboxURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Address of this account's activitypub outbox 60 FollowingURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URI for getting the following list of this account 61 FollowersURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URI for getting the followers list of this account 62 FeaturedCollectionURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URL for getting the featured collection list of this account 63 ActorType string `validate:"oneof=Application Group Organization Person Service" bun:",nullzero,notnull"` // What type of activitypub actor is this account? 64 PrivateKey *rsa.PrivateKey `validate:"required_without=Domain"` // Privatekey for validating activitypub requests, will only be defined for local accounts 65 PublicKey *rsa.PublicKey `validate:"required"` // Publickey for encoding activitypub requests, will be defined for both local and remote accounts 66 PublicKeyURI string `validate:"required,url" bun:",nullzero,notnull,unique"` // Web-reachable location of this account's public key 67 SensitizedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero"` // When was this account set to have all its media shown as sensitive? 68 SilencedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero"` // When was this account silenced (eg., statuses only visible to followers, not public)? 69 SuspendedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero"` // When was this account suspended (eg., don't allow it to log in/post, don't accept media/posts from this account) 70 HideCollections bool `validate:"-" bun:",default:false"` // Hide this account's collections 71 SuspensionOrigin string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // id of the database entry that caused this account to become suspended -- can be an account ID or a domain block ID 72 } 73 74 // Field represents a key value field on an account, for things like pronouns, website, etc. 75 // VerifiedAt is optional, to be used only if Value is a URL to a webpage that contains the 76 // username of the user. 77 type Field struct { 78 Name string `validate:"required"` // Name of this field. 79 Value string `validate:"required"` // Value of this field. 80 VerifiedAt time.Time `validate:"-" bun:",nullzero"` // This field was verified at (optional). 81 } 82 83 // Relationship describes a requester's relationship with another account. 84 type Relationship struct { 85 ID string // The account id. 86 Following bool // Are you following this user? 87 ShowingReblogs bool // Are you receiving this user's boosts in your home timeline? 88 Notifying bool // Have you enabled notifications for this user? 89 FollowedBy bool // Are you followed by this user? 90 Blocking bool // Are you blocking this user? 91 BlockedBy bool // Is this user blocking you? 92 Muting bool // Are you muting this user? 93 MutingNotifications bool // Are you muting notifications from this user? 94 Requested bool // Do you have a pending follow request for this user? 95 DomainBlocking bool // Are you blocking this user's domain? 96 Endorsed bool // Are you featuring this user on your profile? 97 Note string // Your note on this account. 98 } 99 100 // Visibility represents the visibility granularity of a status. 101 type Visibility string 102 103 const ( 104 // VisibilityPublic means this status will be visible to everyone on all timelines. 105 VisibilityPublic Visibility = "public" 106 // VisibilityUnlocked means this status will be visible to everyone, but will only show on home timeline to followers, and in lists. 107 VisibilityUnlocked Visibility = "unlocked" 108 // VisibilityFollowersOnly means this status is viewable to followers only. 109 VisibilityFollowersOnly Visibility = "followers_only" 110 // VisibilityMutualsOnly means this status is visible to mutual followers only. 111 VisibilityMutualsOnly Visibility = "mutuals_only" 112 // VisibilityDirect means this status is visible only to mentioned recipients. 113 VisibilityDirect Visibility = "direct" 114 // VisibilityDefault is used when no other setting can be found. 115 VisibilityDefault Visibility = VisibilityUnlocked 116 )