// GoToSocial // Copyright (C) GoToSocial Authors admin@gotosocial.org // SPDX-License-Identifier: AGPL-3.0-or-later // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package gtsmodel import ( "slices" "time" ) // Status represents a user-created 'post' or 'status' in the database, either remote or local type Status struct { ID string `bun:"type:CHAR(26),pk,nullzero,notnull,unique"` // id of this item in the database CreatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item created UpdatedAt time.Time `bun:"type:timestamptz,nullzero,notnull,default:current_timestamp"` // when was item last updated FetchedAt time.Time `bun:"type:timestamptz,nullzero"` // when was item (remote) last fetched. PinnedAt time.Time `bun:"type:timestamptz,nullzero"` // Status was pinned by owning account at this time. URI string `bun:",unique,nullzero,notnull"` // activitypub URI of this status URL string `bun:",nullzero"` // web url for viewing this status Content string `bun:""` // content of this status; likely html-formatted but not guaranteed AttachmentIDs []string `bun:"attachments,array"` // Database IDs of any media attachments associated with this status Attachments []*MediaAttachment `bun:"attached_media,rel:has-many"` // Attachments corresponding to attachmentIDs TagIDs []string `bun:"tags,array"` // Database IDs of any tags used in this status Tags []*Tag `bun:"attached_tags,m2m:status_to_tags"` // Tags corresponding to tagIDs. https://bun.uptrace.dev/guide/relations.html#many-to-many-relation MentionIDs []string `bun:"mentions,array"` // Database IDs of any mentions in this status Mentions []*Mention `bun:"attached_mentions,rel:has-many"` // Mentions corresponding to mentionIDs EmojiIDs []string `bun:"emojis,array"` // Database IDs of any emojis used in this status Emojis []*Emoji `bun:"attached_emojis,m2m:status_to_emojis"` // Emojis corresponding to emojiIDs. https://bun.uptrace.dev/guide/relations.html#many-to-many-relation Local *bool `bun:",nullzero,notnull,default:false"` // is this status from a local account? AccountID string `bun:"type:CHAR(26),nullzero,notnull"` // which account posted this status? Account *Account `bun:"rel:belongs-to"` // account corresponding to accountID AccountURI string `bun:",nullzero,notnull"` // activitypub uri of the owner of this status InReplyToID string `bun:"type:CHAR(26),nullzero"` // id of the status this status replies to InReplyToURI string `bun:",nullzero"` // activitypub uri of the status this status is a reply to InReplyToAccountID string `bun:"type:CHAR(26),nullzero"` // id of the account that this status replies to InReplyTo *Status `bun:"-"` // status corresponding to inReplyToID InReplyToAccount *Account `bun:"rel:belongs-to"` // account corresponding to inReplyToAccountID BoostOfID string `bun:"type:CHAR(26),nullzero"` // id of the status this status is a boost of BoostOfURI string `bun:"-"` // URI of the status this status is a boost of; field not inserted in the db, just for dereferencing purposes. BoostOfAccountID string `bun:"type:CHAR(26),nullzero"` // id of the account that owns the boosted status BoostOf *Status `bun:"-"` // status that corresponds to boostOfID BoostOfAccount *Account `bun:"rel:belongs-to"` // account that corresponds to boostOfAccountID ThreadID string `bun:"type:CHAR(26),nullzero"` // id of the thread to which this status belongs; only set for remote statuses if a local account is involved at some point in the thread, otherwise null PollID string `bun:"type:CHAR(26),nullzero"` // Poll *Poll `bun:"-"` // ContentWarning string `bun:",nullzero"` // cw string for this status Visibility Visibility `bun:",nullzero,notnull"` // visibility entry for this status Sensitive *bool `bun:",nullzero,notnull,default:false"` // mark the status as sensitive? Language string `bun:",nullzero"` // what language is this status written in? CreatedWithApplicationID string `bun:"type:CHAR(26),nullzero"` // Which application was used to create this status? CreatedWithApplication *Application `bun:"rel:belongs-to"` // application corresponding to createdWithApplicationID ActivityStreamsType string `bun:",nullzero,notnull"` // What is the activitystreams type of this status? See: https://www.w3.org/TR/activitystreams-vocabulary/#object-types. Will probably almost always be Note but who knows!. Text string `bun:""` // Original text of the status without formatting Federated *bool `bun:",notnull"` // This status will be federated beyond the local timeline(s) InteractionPolicy *InteractionPolicy `bun:""` // InteractionPolicy for this status. If null then the default InteractionPolicy should be assumed for this status's Visibility. Always null for boost wrappers. PendingApproval *bool `bun:",nullzero,notnull,default:false"` // If true then status is a reply or boost wrapper that must be Approved by the reply-ee or boost-ee before being fully distributed. PreApproved bool `bun:"-"` // If true, then status is a reply to or boost wrapper of a status on our instance, has permission to do the interaction, and an Accept should be sent out for it immediately. Field not stored in the DB. ApprovedByURI string `bun:",nullzero"` // URI of an Accept Activity that approves the Announce or Create Activity that this status was/will be attached to. } // GetID implements timeline.Timelineable{}. func (s *Status) GetID() string { return s.ID } // GetAccountID implements timeline.Timelineable{}. func (s *Status) GetAccountID() string { return s.AccountID } // GetBoostID implements timeline.Timelineable{}. func (s *Status) GetBoostOfID() string { return s.BoostOfID } // GetBoostOfAccountID implements timeline.Timelineable{}. func (s *Status) GetBoostOfAccountID() string { return s.BoostOfAccountID } // AttachmentsPopulated returns whether media attachments are populated according to current AttachmentIDs. func (s *Status) AttachmentsPopulated() bool { if len(s.AttachmentIDs) != len(s.Attachments) { // this is the quickest indicator. return false } for i, id := range s.AttachmentIDs { if s.Attachments[i].ID != id { return false } } return true } // TagsPopulated returns whether tags are populated according to current TagIDs. func (s *Status) TagsPopulated() bool { if len(s.TagIDs) != len(s.Tags) { // this is the quickest indicator. return false } for i, id := range s.TagIDs { if s.Tags[i].ID != id { return false } } return true } // MentionsPopulated returns whether mentions are populated according to current MentionIDs. func (s *Status) MentionsPopulated() bool { if len(s.MentionIDs) != len(s.Mentions) { // this is the quickest indicator. return false } for i, id := range s.MentionIDs { if s.Mentions[i].ID != id { return false } } return true } // EmojisPopulated returns whether emojis are populated according to current EmojiIDs. func (s *Status) EmojisPopulated() bool { if len(s.EmojiIDs) != len(s.Emojis) { // this is the quickest indicator. return false } for i, id := range s.EmojiIDs { if s.Emojis[i].ID != id { return false } } return true } // EmojissUpToDate returns whether status emoji attachments of receiving status are up-to-date // according to emoji attachments of the passed status, by comparing their emoji URIs. We don't // use IDs as this is used to determine whether there are new emojis to fetch. func (s *Status) EmojisUpToDate(other *Status) bool { if len(s.Emojis) != len(other.Emojis) { // this is the quickest indicator. return false } for i := range s.Emojis { if s.Emojis[i].URI != other.Emojis[i].URI { return false } } return true } // GetAttachmentByRemoteURL searches status for MediaAttachment{} with remote URL. func (s *Status) GetAttachmentByRemoteURL(url string) (*MediaAttachment, bool) { for _, media := range s.Attachments { if media.RemoteURL == url { return media, true } } return nil, false } // GetMentionByTargetURI searches status for Mention{} with target URI. func (s *Status) GetMentionByTargetURI(uri string) (*Mention, bool) { for _, mention := range s.Mentions { if mention.TargetAccountURI == uri { return mention, true } } return nil, false } // GetTagByName searches status for Tag{} with name. func (s *Status) GetTagByName(name string) (*Tag, bool) { for _, tag := range s.Tags { if tag.Name == name { return tag, true } } return nil, false } // MentionsAccount returns whether status mentions the given account ID. func (s *Status) MentionsAccount(accountID string) bool { return slices.ContainsFunc(s.Mentions, func(m *Mention) bool { return m.TargetAccountID == accountID }) } // BelongsToAccount returns whether status belongs to the given account ID. func (s *Status) BelongsToAccount(accountID string) bool { return s.AccountID == accountID } // IsLocal returns true if this is a local // status (ie., originating from this instance). func (s *Status) IsLocal() bool { return s.Local != nil && *s.Local } // IsLocalOnly returns true if this status // is "local-only" ie., unfederated. func (s *Status) IsLocalOnly() bool { return s.Federated == nil || !*s.Federated } // StatusToTag is an intermediate struct to facilitate the many2many relationship between a status and one or more tags. type StatusToTag struct { StatusID string `bun:"type:CHAR(26),unique:statustag,nullzero,notnull"` Status *Status `bun:"rel:belongs-to"` TagID string `bun:"type:CHAR(26),unique:statustag,nullzero,notnull"` Tag *Tag `bun:"rel:belongs-to"` } // StatusToEmoji is an intermediate struct to facilitate the many2many relationship between a status and one or more emojis. type StatusToEmoji struct { StatusID string `bun:"type:CHAR(26),unique:statusemoji,nullzero,notnull"` Status *Status `bun:"rel:belongs-to"` EmojiID string `bun:"type:CHAR(26),unique:statusemoji,nullzero,notnull"` Emoji *Emoji `bun:"rel:belongs-to"` } // Visibility represents the visibility granularity of a status. type Visibility string const ( // VisibilityNone means nobody can see this. // It's only used for web status visibility. VisibilityNone Visibility = "none" // VisibilityPublic means this status will be visible to everyone on all timelines. VisibilityPublic Visibility = "public" // VisibilityUnlocked means this status will be visible to everyone, but will only show on home timeline to followers, and in lists. VisibilityUnlocked Visibility = "unlocked" // VisibilityFollowersOnly means this status is viewable to followers only. VisibilityFollowersOnly Visibility = "followers_only" // VisibilityMutualsOnly means this status is visible to mutual followers only. VisibilityMutualsOnly Visibility = "mutuals_only" // VisibilityDirect means this status is visible only to mentioned recipients. VisibilityDirect Visibility = "direct" // VisibilityDefault is used when no other setting can be found. VisibilityDefault Visibility = VisibilityUnlocked ) // Content models the simple string content // of a status along with its ContentMap, // which contains content entries keyed by // BCP47 language tag. // // Content and/or ContentMap may be zero/nil. type Content struct { Content string ContentMap map[string]string }