distrybute

type FileEntry struct {
	// Id holds a unique ID which identifies the Entry inside the backend. This is mandatory because the CallReference
	// can be changed by the user.
	Id uuid.UUID
	// CallReference is a unique string identifying the entry inside the database and resolving it
	// via web.
	CallReference string
	// DeleteReference is a unique string which can be used to delete the file entry with a simple
	// GET request to allow simple deletion links.
	DeleteReference string
	// Author holds a unique UserId which can be used to identify the uploader.
	Author uuid.UUID
	// Filename is the name of the file with its extension (e.g. no-virus.exe).
	Filename string
	// ContentType is the MIME-Type of the uploaded file (e.g. image/png).
	ContentType string
	// UploadDate is the exact time of when the file was uploaded.
	UploadDate time.Time
	// Reader allows to read the file entry`s content.
	ReadCloseSeeker ReadCloseSeeker
	// Size holds the total size of the file entry`s content in bytes.
	Size int64
}

type FileService interface {
	// Store saves the entry data to the storage. If something went wrong, an error is returned.
	Store(filename, contentType string, size int64, author uuid.UUID, reader io.Reader) (entry *FileEntry, err error)
	// Request searches for an entry by using the specified CallReference. It returns an error if something goes wrong.
	Request(callReference string) (entry *FileEntry, err error)
	// Delete deletes an entry using the provided delete reference. It returns an error if something goes wrong.
	Delete(deleteReference string) (err error)
}

type PasswordHashAlgorithm string

type ReadCloseSeeker interface {
	io.ReadCloser
	io.Seeker
}

type User struct {
	// ID is a unqiue ID which can be used to identify the user.
	ID uuid.UUID
	// Username is the name of the user to e.g. login with.
	Username string
	// AuthorizationToken holds the auth token for the user to use when uploading file entries.
	AuthorizationToken string
	// PasswordHashAlgorithm indicates the hashing algorithm which this user entry is using.
	PasswordHashAlgorithm PasswordHashAlgorithm
}

type UserService interface {
	// CreateNewUser creates a new user by using the specified Username. After a successful creation, a user instance
	// is returned. It returns an error (err) if something went wrong.
	CreateNewUser(username string, password []byte) (user *User, err error)
	// CheckPassword checks the user`s password and whether the username is existent inside the database. Ok is true if
	// the check was successful. If the user could not be found a ErrUserNotFound is returned.
	CheckPassword(username string, password []byte) (ok bool, user *User, err error)
	// UpdateUsername updates the user`s username and sets the value of the user instance. It
	// returns an error (err) if something went wrong.
	UpdateUsername(id uuid.UUID, newUsername string) (err error)
	// ResolveAuthorizationToken resolves the authorization token and sets the value of the user
	// instance. It returns an error (err) if something went wrong.
	ResolveAuthorizationToken(id uuid.UUID) (token string, err error)
	// RefreshAuthorizationToken updates the user`s authorization token and returns the fresh one. It returns an error
	// (err) if something went wrong.
	RefreshAuthorizationToken(id uuid.UUID) (token string, err error)
	// ListUsers returns all users who exist in the database. It returns an error (err) if something goes wrong.
	ListUsers() (users []*User, err error)
	// GetUserByAuthorizationToken retrieves the user by using the passed authorization token. It returns an error (err)
	// if something went wrong.
	GetUserByAuthorizationToken(token string) (ok bool, user *User, err error)
	// GetUserByUsername retrieves the user by using the provided username. It returns an error (err) if something goes wrong.
	GetUserByUsername(username string) (user *User, err error)
	// DeleteUser deletes the user by searching for the user`s ID. It returns an error (err) if
	// something went wrong.
	DeleteUser(id uuid.UUID) (err error)
	// UpdatePassword updates the user`s password. It returns an error (err) if something went wrong.
	UpdatePassword(id uuid.UUID, password []byte) (err error)
}