qugalet/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-25 21:26:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

formatting,comments

Browse source
This commit is contained in:
tsmethurst 2021-03-20 19:04:27 +01:00
parent 0abe01ea22
commit 81760963b0
5 changed files with 212 additions and 87 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
internal/config/config.go
View file

@ -48,7 +48,7 @@ func Default() *Config {
// TODO: find a way of doing this without code repetition, because having to // TODO: find a way of doing this without code repetition, because having to
// repeat all values here and elsewhere is annoying and gonna be prone to mistakes. // repeat all values here and elsewhere is annoying and gonna be prone to mistakes.
return &Config{ return &Config{
DBConfig: &DBConfig{}, DBConfig: &DBConfig{},
TemplateConfig: &TemplateConfig{}, TemplateConfig: &TemplateConfig{},
} }
} }
@ -56,7 +56,7 @@ func Default() *Config {
// Empty just returns an empty config // Empty just returns an empty config
func Empty() *Config { func Empty() *Config {
return &Config{ return &Config{
DBConfig: &DBConfig{}, DBConfig: &DBConfig{},
TemplateConfig: &TemplateConfig{}, TemplateConfig: &TemplateConfig{},
} }
} }

158
internal/gtsmodel/account.go
View file

@ -26,60 +26,130 @@
"time" "time"
) )
// Account represents a GoToSocial user account // Account represents either a local or a remote fediverse account, gotosocial or otherwise (mastodon, pleroma, etc)
type Account struct { type Account struct {
/*
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
// Domain of the account, will be empty if this is a local account, otherwise something like ``example.org`` or ``mastodon.social``. Should be unique with username.
Domain string `pg:",unique:userdomain"` // username and domain
/*
ACCOUNT METADATA
*/
// Avatar image for this account
Avatar Avatar
// Header image for this account
Header Header
URI string // DisplayName for this account. Can be empty, then just the Username will be used for display purposes.
URL string DisplayName string
ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"` // a key/value map of fields that this account has added to their profile
Username string Fields map[string]string
Domain string // A note that this account has on their profile (ie., the account's bio/description of themselves)
Secret string Note string
PrivateKey string // Is this a memorial account, ie., has the user passed away?
PublicKey string Memorial bool
RemoteURL string // This account has moved this account id in the database
CreatedAt time.Time `pg:"type:timestamp,notnull"` MovedToAccountID int
UpdatedAt time.Time `pg:"type:timestamp,notnull"` // When was this account created?
Note string CreatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
DisplayName string // When was this account last updated?
UpdatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
// When should this account function until
SubscriptionExpiresAt time.Time `pg:"type:timestamp"` SubscriptionExpiresAt time.Time `pg:"type:timestamp"`
Locked bool
LastWebfingeredAt time.Time `pg:"type:timestamp"` /*
InboxURL string PRIVACY SETTINGS
OutboxURL string */
SharedInboxURL string
FollowersURL string // Does this account need an approval for new followers?
Protocol int Locked bool
Memorial bool // Should this account be shown in the instance's profile directory?
MovedToAccountID int Discoverable bool
FeaturedCollectionURL string
Fields map[string]string /*
ActorType string ACTIVITYPUB THINGS
Discoverable bool */
AlsoKnownAs string
SilencedAt time.Time `pg:"type:timestamp"` // What is the activitypub URI for this account discovered by webfinger?
SuspendedAt time.Time `pg:"type:timestamp"` URI string `pg:",unique"`
TrustLevel int // At which URL can we see the user account in a web browser?
HideCollections bool URL string `pg:",unique"`
SensitizedAt time.Time `pg:"type:timestamp"` // RemoteURL where this account is located. Will be empty if this is a local account.
SuspensionOrigin int RemoteURL 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?
ActorType string
// This account is associated with x account id
AlsoKnownAs string
/*
CRYPTO FIELDS
*/
Secret string
// Privatekey for validating activitypub requests, will obviously only be defined for local accounts
PrivateKey string
// Publickey for encoding activitypub requests, will be defined for both local and remote accounts
PublicKey string
/*
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"`
// How much do we trust this account 🤔
TrustLevel int
// Should we hide this account's collections?
HideCollections bool
// id of the user that suspended this account through an admin action
SuspensionOrigin int
} }
// Avatar represents the avatar for the account for display purposes
type Avatar struct { type Avatar struct {
AvatarFileName string // File name of the avatar on local storage
AvatarContentType string AvatarFileName string
AvatarFileSize int // Gif? png? jpeg?
AvatarUpdatedAt *time.Time `pg:"type:timestamp"` AvatarContentType string
AvatarRemoteURL *url.URL `pg:"type:text"` AvatarFileSize int
AvatarUpdatedAt *time.Time `pg:"type:timestamp"`
// Where can we retrieve the avatar?
AvatarRemoteURL *url.URL `pg:"type:text"`
AvatarStorageSchemaVersion int AvatarStorageSchemaVersion int
} }
// Header represents the header of the account for display purposes
type Header struct { type Header struct {
HeaderFileName string // File name of the header on local storage
HeaderContentType string HeaderFileName string
HeaderFileSize int // Gif? png? jpeg?
HeaderUpdatedAt *time.Time `pg:"type:timestamp"` HeaderContentType string
HeaderRemoteURL *url.URL `pg:"type:text"` HeaderFileSize int
HeaderUpdatedAt *time.Time `pg:"type:timestamp"`
// Where can we retrieve the header?
HeaderRemoteURL *url.URL `pg:"type:text"`
HeaderStorageSchemaVersion int HeaderStorageSchemaVersion int
} }

8
internal/gtsmodel/status.go
View file

@ -22,11 +22,11 @@
type Status struct { type Status struct {
ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"` ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"`
URI string URI string `pg:",unique"`
URL string URL string `pg:",unique"`
Content string Content string
CreatedAt time.Time `pg:"type:timestamp,notnull"` CreatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
UpdatedAt time.Time `pg:"type:timestamp,notnull"` UpdatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
Local bool Local bool
AccountID string AccountID string
InReplyToID string InReplyToID string

121
internal/gtsmodel/user.go
View file

@ -23,43 +23,98 @@
"time" "time"
) )
// User represents an actual human user of gotosocial. Note, this is a LOCAL gotosocial user, not a remote account.
// To cross reference this local user with their account (which can be local or remote), use the AccountID field.
type User struct { type User struct {
ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull"` /*
Email string `pg:",notnull"` BASIC INFO
CreatedAt time.Time `pg:"type:timestamp,notnull"` */
UpdatedAt time.Time `pg:"type:timestamp,notnull"`
EncryptedPassword string `pg:",notnull"` // id of this user in the local database; the end-user will never need to know this, it's strictly internal
ResetPasswordToken string ID string `pg:"type:uuid,default:gen_random_uuid(),pk,notnull,unique"`
ResetPasswordSentAt time.Time `pg:"type:timestamp"` // confirmed email address for this user, this should be unique -- only one email address registered per instance, multiple users per email are not supported
SignInCount int Email string `pg:",notnull,unique"`
CurrentSignInAt time.Time `pg:"type:timestamp"` // The id of the local gtsmodel.Account entry for this user, if it exists (unconfirmed users don't have an account yet)
LastSignInAt time.Time `pg:"type:timestamp"` AccountID string `pg:"default:'',notnull,unique"`
CurrentSignInIP net.IP // The encrypted password of this user, generated using https://pkg.go.dev/golang.org/x/crypto/bcrypt#GenerateFromPassword. A salt is included so we're safe against 🌈 tables
LastSignInIP net.IP EncryptedPassword string `pg:",notnull"`
Admin bool
ConfirmationToken string /*
ConfirmedAt time.Time `pg:"type:timestamp"` USER METADATA
ConfirmationSentAt time.Time `pg:"type:timestamp"` */
UnconfirmedEmail string
Locale string // When was this user created?
CreatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
// From what IP was this user created?
SignUpIP net.IP
// When was this user updated (eg., password changed, email address changed)?
UpdatedAt time.Time `pg:"type:timestamp,notnull,default:now()"`
// When did this user sign in for their current session?
CurrentSignInAt time.Time `pg:"type:timestamp"`
// What's the most recent IP of this user
CurrentSignInIP net.IP
// When did this user last sign in?
LastSignInAt time.Time `pg:"type:timestamp"`
// What's the previous IP of this user?
LastSignInIP net.IP
// How many times has this user signed in?
SignInCount int
// id of the user who invited this user (who let this guy in?)
InviteID string
// What languages does this user want to see?
ChosenLanguages []string
// What languages does this user not want to see?
FilteredLanguages []string
// In what timezone/locale is this user located?
Locale string
// Which application id created this user? See gtsmodel.Application
CreatedByApplicationID string
// When did we last contact this user
LastEmailedAt time.Time `pg:"type:timestamp"`
/*
USER CONFIRMATION
*/
// What confirmation token did we send this user/what are we expecting back?
ConfirmationToken string
// When did the user confirm their email address
ConfirmedAt time.Time `pg:"type:timestamp"`
// When did we send email confirmation to this user?
ConfirmationSentAt time.Time `pg:"type:timestamp"`
// Email address that hasn't yet been confirmed
UnconfirmedEmail string
/*
ACL FLAGS
*/
// Is this user a moderator?
Moderator bool
// Is this user an admin?
Admin bool
// Is this user disabled from posting?
Disabled bool
// Has this user been approved by a moderator?
Approved bool
/*
USER SECURITY
*/
// The generated token that the user can use to reset their password
ResetPasswordToken string
// When did we email the user their reset-password email?
ResetPasswordSentAt time.Time `pg:"type:timestamp"`
EncryptedOTPSecret string EncryptedOTPSecret string
EncryptedOTPSecretIv string EncryptedOTPSecretIv string
EncryptedOTPSecretSalt string EncryptedOTPSecretSalt string
ConsumedTimestamp int
OTPRequiredForLogin bool OTPRequiredForLogin bool
LastEmailedAt time.Time `pg:"type:timestamp"`
OTPBackupCodes []string OTPBackupCodes []string
FilteredLanguages []string ConsumedTimestamp int
AccountID string `pg:",notnull"` RememberToken string
Disabled bool SignInToken string
Moderator bool SignInTokenSentAt time.Time `pg:"type:timestamp"`
InviteID string WebauthnID string
RememberToken string
ChosenLanguages []string
CreatedByApplicationID string
Approved bool
SignInToken string
SignInTokenSentAt time.Time `pg:"type:timestamp"`
WebauthnID string
SignUpIP net.IP
} }

8
pkg/mastotypes/oauth.go
View file

@ -22,16 +22,16 @@
// See here: https://docs.joinmastodon.org/methods/apps/oauth/ // See here: https://docs.joinmastodon.org/methods/apps/oauth/
type OAuthAuthorize struct { type OAuthAuthorize struct {
// Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance. // Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
ForceLogin string `form:"force_login,omitempty"` ForceLogin string `form:"force_login,omitempty"`
// Should be set equal to `code`. // Should be set equal to `code`.
ResponseType string `form:"response_type"` ResponseType string `form:"response_type"`
// Client ID, obtained during app registration. // Client ID, obtained during app registration.
ClientID string `form:"client_id"` ClientID string `form:"client_id"`
// Set a URI to redirect the user to. // Set a URI to redirect the user to.
// If this parameter is set to urn:ietf:wg:oauth:2.0:oob then the authorization code will be shown instead. // If this parameter is set to urn:ietf:wg:oauth:2.0:oob then the authorization code will be shown instead.
// Must match one of the redirect URIs declared during app registration. // Must match one of the redirect URIs declared during app registration.
RedirectURI string `form:"redirect_uri"` RedirectURI string `form:"redirect_uri"`
// List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). // List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters).
// Must be a subset of scopes declared during app registration. If not provided, defaults to read. // Must be a subset of scopes declared during app registration. If not provided, defaults to read.
Scope string `form:"scope,omitempty"` Scope string `form:"scope,omitempty"`
} }