mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-31 08:32:25 -05:00
54 lines
2.6 KiB
Go
54 lines
2.6 KiB
Go
/*
|
|
GoToSocial
|
|
Copyright (C) 2021-2022 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/>.
|
|
*/
|
|
|
|
package db
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
// Admin contains functions related to instance administration (new signups etc).
|
|
type Admin interface {
|
|
// IsUsernameAvailable checks whether a given username is available on our domain.
|
|
// Returns an error if the username is already taken, or something went wrong in the db.
|
|
IsUsernameAvailable(ctx context.Context, username string) (bool, Error)
|
|
|
|
// IsEmailAvailable checks whether a given email address for a new account is available to be used on our domain.
|
|
// Return an error if:
|
|
// A) the email is already associated with an account
|
|
// B) we block signups from this email domain
|
|
// C) something went wrong in the db
|
|
IsEmailAvailable(ctx context.Context, email string) (bool, Error)
|
|
|
|
// NewSignup creates a new user in the database with the given parameters.
|
|
// By the time this function is called, it should be assumed that all the parameters have passed validation!
|
|
NewSignup(ctx context.Context, username string, reason string, requireApproval bool, email string, password string, signUpIP net.IP, locale string, appID string, emailVerified bool, admin bool) (*gtsmodel.User, Error)
|
|
|
|
// CreateInstanceAccount creates an account in the database with the same username as the instance host value.
|
|
// Ie., if the instance is hosted at 'example.org' the instance user will have a username of 'example.org'.
|
|
// This is needed for things like serving files that belong to the instance and not an individual user/account.
|
|
CreateInstanceAccount(ctx context.Context) Error
|
|
|
|
// CreateInstanceInstance creates an instance in the database with the same domain as the instance host value.
|
|
// Ie., if the instance is hosted at 'example.org' the instance will have a domain of 'example.org'.
|
|
// This is needed for things like serving instance information through /api/v1/instance
|
|
CreateInstanceInstance(ctx context.Context) Error
|
|
}
|