2021-03-05 20:31:12 +03:00
/ *
GoToSocial
Copyright ( C ) 2021 GoToSocial Authors admin @ gotosocial . org
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/>.
* /
2021-04-19 20:42:19 +03:00
// Package gtsmodel contains types used *internally* by GoToSocial and added/removed/selected from the database.
2021-03-15 18:15:14 +03:00
// These types should never be serialized and/or sent out via public APIs, as they contain sensitive information.
2021-04-01 21:46:45 +03:00
// The annotation used on these structs is for handling them via the go-pg ORM (hence why they're in this db subdir).
// See here for more info on go-pg model annotations: https://pg.uptrace.dev/models/
2021-04-19 20:42:19 +03:00
package gtsmodel
2021-03-05 20:31:12 +03:00
import (
2021-04-01 21:46:45 +03:00
"crypto/rsa"
2021-03-05 20:31:12 +03:00
"time"
)
2021-03-20 21:04:27 +03:00
// Account represents either a local or a remote fediverse account, gotosocial or otherwise (mastodon, pleroma, etc)
2021-03-16 01:05:24 +03:00
type Account struct {
2021-03-20 21:04:27 +03:00
/ *
BASIC INFO
* /
// id of this account in the local database; the end-user will never need to know this, it's strictly internal
ID string ` pg:"type:uuid,default:gen_random_uuid(),pk,notnull,unique" `
// Username of the account, should just be a string of [a-z0-9_]. Can be added to domain to create the full username in the form ``[username]@[domain]`` eg., ``user_96@example.org``
Username string ` pg:",notnull,unique:userdomain" ` // username and domain should be unique *with* each other
2021-04-19 20:42:19 +03:00
// Domain of the account, will be null if this is a local account, otherwise something like ``example.org`` or ``mastodon.social``. Should be unique with username.
2021-04-01 21:46:45 +03:00
Domain string ` pg:",unique:userdomain" ` // username and domain should be unique *with* each other
2021-03-20 21:04:27 +03:00
/ *
ACCOUNT METADATA
* /
2021-04-19 20:42:19 +03:00
// ID of the avatar as a media attachment
AvatarMediaAttachmentID string
// ID of the header as a media attachment
HeaderMediaAttachmentID string
2021-03-20 21:04:27 +03:00
// DisplayName for this account. Can be empty, then just the Username will be used for display purposes.
DisplayName string
// a key/value map of fields that this account has added to their profile
2021-04-01 21:46:45 +03:00
Fields [ ] Field
2021-03-20 21:04:27 +03:00
// A note that this account has on their profile (ie., the account's bio/description of themselves)
Note string
// Is this a memorial account, ie., has the user passed away?
Memorial bool
// This account has moved this account id in the database
2021-04-19 20:42:19 +03:00
MovedToAccountID string
2021-03-20 21:04:27 +03:00
// When was this account created?
CreatedAt time . Time ` pg:"type:timestamp,notnull,default:now()" `
// When was this account last updated?
UpdatedAt time . Time ` pg:"type:timestamp,notnull,default:now()" `
2021-04-01 21:46:45 +03:00
// Does this account identify itself as a bot?
Bot bool
// What reason was given for signing up when this account was created?
Reason string
2021-03-20 21:04:27 +03:00
/ *
2021-04-01 21:46:45 +03:00
USER AND PRIVACY PREFERENCES
2021-03-20 21:04:27 +03:00
* /
// Does this account need an approval for new followers?
Locked bool
// Should this account be shown in the instance's profile directory?
Discoverable bool
2021-04-01 21:46:45 +03:00
// Default post privacy for this account
2021-04-19 20:42:19 +03:00
Privacy Visibility
2021-04-01 21:46:45 +03:00
// Set posts from this account to sensitive by default?
Sensitive bool
// What language does this account post in?
Language string
2021-03-20 21:04:27 +03:00
/ *
ACTIVITYPUB THINGS
* /
// What is the activitypub URI for this account discovered by webfinger?
URI string ` pg:",unique" `
// At which URL can we see the user account in a web browser?
URL string ` pg:",unique" `
// Last time this account was located using the webfinger API.
LastWebfingeredAt time . Time ` pg:"type:timestamp" `
// Address of this account's activitypub inbox, for sending activity to
InboxURL string ` pg:",unique" `
// Address of this account's activitypub outbox
OutboxURL string ` pg:",unique" `
// Don't support shared inbox right now so this is just a stub for a future implementation
SharedInboxURL string ` pg:",unique" `
// URL for getting the followers list of this account
FollowersURL string ` pg:",unique" `
// URL for getting the featured collection list of this account
FeaturedCollectionURL string ` pg:",unique" `
// What type of activitypub actor is this account?
2021-04-19 20:42:19 +03:00
ActorType ActivityStreamsActor
2021-03-20 21:04:27 +03:00
// This account is associated with x account id
AlsoKnownAs string
/ *
CRYPTO FIELDS
* /
// Privatekey for validating activitypub requests, will obviously only be defined for local accounts
2021-04-01 21:46:45 +03:00
PrivateKey * rsa . PrivateKey
2021-03-20 21:04:27 +03:00
// Publickey for encoding activitypub requests, will be defined for both local and remote accounts
2021-04-01 21:46:45 +03:00
PublicKey * rsa . PublicKey
2021-03-20 21:04:27 +03:00
/ *
ADMIN FIELDS
* /
// When was this account set to have all its media shown as sensitive?
SensitizedAt time . Time ` pg:"type:timestamp" `
// When was this account silenced (eg., statuses only visible to followers, not public)?
SilencedAt time . Time ` pg:"type:timestamp" `
// When was this account suspended (eg., don't allow it to log in/post, don't accept media/posts from this account)
SuspendedAt time . Time ` pg:"type:timestamp" `
// Should we hide this account's collections?
HideCollections bool
// id of the user that suspended this account through an admin action
2021-04-19 20:42:19 +03:00
SuspensionOrigin string
2021-03-05 20:31:12 +03:00
}
2021-04-01 21:46:45 +03:00
// Field represents a key value field on an account, for things like pronouns, website, etc.
// VerifiedAt is optional, to be used only if Value is a URL to a webpage that contains the
// username of the user.
type Field struct {
Name string
Value string
VerifiedAt time . Time ` pg:"type:timestamp" `
2021-03-07 15:05:33 +03:00
}