summaryrefslogtreecommitdiff
path: root/internal/db/bundb/migrations/20250415111056_thread_all_statuses/old/status.go
blob: 8cfce2e6be567bd560aaa96fa37040ed9f226337 (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
// 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 <http://www.gnu.org/licenses/>.

package gtsmodel

import (
	"time"
)

// Status represents a user-created 'post' or 'status' in the database, either remote or local.
//
// Note: this model differs from an exact representation of the old model at the time of migration,
// as it includes the intermediate field "ThreadIDNew", which is only used during the migration.
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
	EditedAt                 time.Time         `bun:"type:timestamptz,nullzero"`                                   // when this status was last edited (if set)
	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 HTML for this status.
	AttachmentIDs            []string          `bun:"attachments,array"`                                           // Database IDs of any media attachments associated with this status
	TagIDs                   []string          `bun:"tags,array"`                                                  // Database IDs of any tags used in this status
	MentionIDs               []string          `bun:"mentions,array"`                                              // Database IDs of any mentions in this status
	EmojiIDs                 []string          `bun:"emojis,array"`                                                // Database IDs of any emojis used in this status
	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?
	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
	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
	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
	EditIDs                  []string          `bun:"edits,array"`                                                 //
	PollID                   string            `bun:"type:CHAR(26),nullzero"`                                      //
	ContentWarning           string            `bun:",nullzero"`                                                   // Content warning HTML for this status.
	ContentWarningText       string            `bun:""`                                                            // Original text of the content warning without formatting
	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?
	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
	ContentType              StatusContentType `bun:",nullzero"`                                                   // Content type used to process the original text of the status
	Federated                *bool             `bun:",notnull"`                                                    // This status will be federated beyond the local timeline(s)
	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.

	// This field is *only* used during the migration, it was not on the original status model.
	ThreadIDNew string `bun:"type:CHAR(26),nullzero,notnull,default:'00000000000000000000000000'"`
}

// enumType is the type we (at least, should) use
// for database enum types. it is the largest size
// supported by a PostgreSQL SMALLINT, since an
// SQLite SMALLINT is actually variable in size.
type enumType int16

// Visibility represents the
// visibility granularity of a status.
type Visibility enumType

const (
	// VisibilityNone means nobody can see this.
	// It's only used for web status visibility.
	VisibilityNone Visibility = 1

	// VisibilityPublic means this status will
	// be visible to everyone on all timelines.
	VisibilityPublic Visibility = 2

	// VisibilityUnlocked means this status will be visible to everyone,
	// but will only show on home timeline to followers, and in lists.
	VisibilityUnlocked Visibility = 3

	// VisibilityFollowersOnly means this status is viewable to followers only.
	VisibilityFollowersOnly Visibility = 4

	// VisibilityMutualsOnly means this status
	// is visible to mutual followers only.
	VisibilityMutualsOnly Visibility = 5

	// VisibilityDirect means this status is
	// visible only to mentioned recipients.
	VisibilityDirect Visibility = 6

	// VisibilityDefault is used when no other setting can be found.
	VisibilityDefault Visibility = VisibilityUnlocked
)

// String returns a stringified, frontend API compatible form of Visibility.
func (v Visibility) String() string {
	switch v {
	case VisibilityNone:
		return "none"
	case VisibilityPublic:
		return "public"
	case VisibilityUnlocked:
		return "unlocked"
	case VisibilityFollowersOnly:
		return "followers_only"
	case VisibilityMutualsOnly:
		return "mutuals_only"
	case VisibilityDirect:
		return "direct"
	default:
		panic("invalid visibility")
	}
}

// StatusContentType is the content type with which a status's text is
// parsed. Can be either plain or markdown. Empty will default to plain.
type StatusContentType enumType

const (
	StatusContentTypePlain    StatusContentType = 1
	StatusContentTypeMarkdown StatusContentType = 2
	StatusContentTypeDefault                    = StatusContentTypePlain
)