account.go (16460B)
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 "strings" 27 "time" 28 29 "github.com/superseriousbusiness/gotosocial/internal/config" 30 "github.com/superseriousbusiness/gotosocial/internal/log" 31 ) 32 33 // Account represents either a local or a remote fediverse account, gotosocial or otherwise (mastodon, pleroma, etc). 34 type Account struct { 35 ID string `validate:"required,ulid" bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database 36 CreatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created. 37 UpdatedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item was last updated. 38 FetchedAt time.Time `validate:"required_with=Domain" bun:"type:timestamptz,nullzero"` // when was item (remote) last fetched. 39 Username string `validate:"required" bun:",nullzero,notnull,unique:usernamedomain"` // 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 40 Domain string `validate:"omitempty,fqdn" bun:",nullzero,unique:usernamedomain"` // Domain of the account, will be null if this is a local account, otherwise something like ``example.org``. Should be unique with username. 41 AvatarMediaAttachmentID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // Database ID of the media attachment, if present 42 AvatarMediaAttachment *MediaAttachment `validate:"-" bun:"rel:belongs-to"` // MediaAttachment corresponding to avatarMediaAttachmentID 43 AvatarRemoteURL string `validate:"omitempty,url" bun:",nullzero"` // For a non-local account, where can the header be fetched? 44 HeaderMediaAttachmentID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // Database ID of the media attachment, if present 45 HeaderMediaAttachment *MediaAttachment `validate:"-" bun:"rel:belongs-to"` // MediaAttachment corresponding to headerMediaAttachmentID 46 HeaderRemoteURL string `validate:"omitempty,url" bun:",nullzero"` // For a non-local account, where can the header be fetched? 47 DisplayName string `validate:"-" bun:""` // DisplayName for this account. Can be empty, then just the Username will be used for display purposes. 48 EmojiIDs []string `validate:"dive,ulid" bun:"emojis,array"` // Database IDs of any emojis used in this account's bio, display name, etc 49 Emojis []*Emoji `validate:"-" bun:"attached_emojis,m2m:account_to_emojis"` // Emojis corresponding to emojiIDs. https://bun.uptrace.dev/guide/relations.html#many-to-many-relation 50 Fields []*Field `validate:"-"` // A slice of of fields that this account has added to their profile. 51 FieldsRaw []*Field `validate:"-"` // The raw (unparsed) content of fields that this account has added to their profile, without conversion to HTML, only available when requester = target 52 Note string `validate:"-" bun:""` // A note that this account has on their profile (ie., the account's bio/description of themselves) 53 NoteRaw string `validate:"-" bun:""` // The raw contents of .Note without conversion to HTML, only available when requester = target 54 Memorial *bool `validate:"-" bun:",default:false"` // Is this a memorial account, ie., has the user passed away? 55 AlsoKnownAs string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // This account is associated with x account id (TODO: migrate to be AlsoKnownAsID) 56 MovedToAccountID string `validate:"omitempty,ulid" bun:"type:CHAR(26),nullzero"` // This account has moved this account id in the database 57 Bot *bool `validate:"-" bun:",default:false"` // Does this account identify itself as a bot? 58 Reason string `validate:"-" bun:""` // What reason was given for signing up when this account was created? 59 Locked *bool `validate:"-" bun:",default:true"` // Does this account need an approval for new followers? 60 Discoverable *bool `validate:"-" bun:",default:false"` // Should this account be shown in the instance's profile directory? 61 Privacy Visibility `validate:"required_without=Domain,omitempty,oneof=public unlocked followers_only mutuals_only direct" bun:",nullzero"` // Default post privacy for this account 62 Sensitive *bool `validate:"-" bun:",default:false"` // Set posts from this account to sensitive by default? 63 Language string `validate:"omitempty,bcp47_language_tag" bun:",nullzero,notnull,default:'en'"` // What language does this account post in? 64 StatusContentType string `validate:"required_without=Domain,omitempty,oneof=text/plain text/markdown" bun:",nullzero"` // What is the default format for statuses posted by this account (only for local accounts). 65 CustomCSS string `validate:"-" bun:",nullzero"` // Custom CSS that should be displayed for this Account's profile and statuses. 66 URI string `validate:"required,url" bun:",nullzero,notnull,unique"` // ActivityPub URI for this account. 67 URL string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Web URL for this account's profile 68 InboxURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Address of this account's ActivityPub inbox, for sending activity to 69 SharedInboxURI *string `validate:"-" bun:""` // Address of this account's ActivityPub sharedInbox. Gotcha warning: this is a string pointer because it has three possible states: 1. We don't know yet if the account has a shared inbox -- null. 2. We know it doesn't have a shared inbox -- empty string. 3. We know it does have a shared inbox -- url string. 70 OutboxURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // Address of this account's activitypub outbox 71 FollowingURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URI for getting the following list of this account 72 FollowersURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URI for getting the followers list of this account 73 FeaturedCollectionURI string `validate:"required_without=Domain,omitempty,url" bun:",nullzero,unique"` // URL for getting the featured collection list of this account 74 ActorType string `validate:"oneof=Application Group Organization Person Service" bun:",nullzero,notnull"` // What type of activitypub actor is this account? 75 PrivateKey *rsa.PrivateKey `validate:"required_without=Domain" bun:""` // Privatekey for validating activitypub requests, will only be defined for local accounts 76 PublicKey *rsa.PublicKey `validate:"required" bun:",notnull"` // Publickey for encoding activitypub requests, will be defined for both local and remote accounts 77 PublicKeyURI string `validate:"required,url" bun:",nullzero,notnull,unique"` // Web-reachable location of this account's public key 78 SensitizedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero"` // When was this account set to have all its media shown as sensitive? 79 SilencedAt time.Time `validate:"-" bun:"type:timestamptz,nullzero"` // When was this account silenced (eg., statuses only visible to followers, not public)? 80 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) 81 HideCollections *bool `validate:"-" bun:",default:false"` // Hide this account's collections 82 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 83 EnableRSS *bool `validate:"-" bun:",default:false"` // enable RSS feed subscription for this account's public posts at [URL]/feed 84 } 85 86 // IsLocal returns whether account is a local user account. 87 func (a *Account) IsLocal() bool { 88 return a.Domain == "" || a.Domain == config.GetHost() || a.Domain == config.GetAccountDomain() 89 } 90 91 // IsRemote returns whether account is a remote user account. 92 func (a *Account) IsRemote() bool { 93 return !a.IsLocal() 94 } 95 96 // IsInstance returns whether account is an instance internal actor account. 97 func (a *Account) IsInstance() bool { 98 if a.IsLocal() { 99 // Check if our instance account. 100 return a.Username == config.GetHost() 101 } 102 103 // Check if remote instance account. 104 return a.Username == a.Domain || 105 a.FollowersURI == "" || 106 a.FollowingURI == "" || 107 (a.Username == "internal.fetch" && strings.Contains(a.Note, "internal service actor")) || 108 a.Username == "instance.actor" // <- misskey 109 } 110 111 // EmojisPopulated returns whether emojis are populated according to current EmojiIDs. 112 func (a *Account) EmojisPopulated() bool { 113 if len(a.EmojiIDs) != len(a.Emojis) { 114 // this is the quickest indicator. 115 return false 116 } 117 118 // Emojis must be in same order. 119 for i, id := range a.EmojiIDs { 120 if a.Emojis[i] == nil { 121 log.Warnf(nil, "nil emoji in slice for account %s", a.URI) 122 continue 123 } 124 if a.Emojis[i].ID != id { 125 return false 126 } 127 } 128 129 return true 130 } 131 132 // AccountToEmoji is an intermediate struct to facilitate the many2many relationship between an account and one or more emojis. 133 type AccountToEmoji struct { 134 AccountID string `validate:"ulid,required" bun:"type:CHAR(26),unique:accountemoji,nullzero,notnull"` 135 Account *Account `validate:"-" bun:"rel:belongs-to"` 136 EmojiID string `validate:"ulid,required" bun:"type:CHAR(26),unique:accountemoji,nullzero,notnull"` 137 Emoji *Emoji `validate:"-" bun:"rel:belongs-to"` 138 } 139 140 // Field represents a key value field on an account, for things like pronouns, website, etc. 141 // VerifiedAt is optional, to be used only if Value is a URL to a webpage that contains the 142 // username of the user. 143 type Field struct { 144 Name string `validate:"required"` // Name of this field. 145 Value string `validate:"required"` // Value of this field. 146 VerifiedAt time.Time `validate:"-" bun:",nullzero"` // This field was verified at (optional). 147 } 148 149 // Relationship describes a requester's relationship with another account. 150 type Relationship struct { 151 ID string // The account id. 152 Following bool // Are you following this user? 153 ShowingReblogs bool // Are you receiving this user's boosts in your home timeline? 154 Notifying bool // Have you enabled notifications for this user? 155 FollowedBy bool // Are you followed by this user? 156 Blocking bool // Are you blocking this user? 157 BlockedBy bool // Is this user blocking you? 158 Muting bool // Are you muting this user? 159 MutingNotifications bool // Are you muting notifications from this user? 160 Requested bool // Do you have a pending follow request for this user? 161 DomainBlocking bool // Are you blocking this user's domain? 162 Endorsed bool // Are you featuring this user on your profile? 163 Note string // Your note on this account. 164 }