database

Documentation

Index

• type AuthTokenEntry
• type Middleware
• type SoundLogEntry
• type SoundStatsEntry
• type Timestamp
  • func (t Timestamp) ToTime(format string) (time.Time, error)

Types

type AuthTokenEntry

type AuthTokenEntry struct {
	UserID    string    `json:"user_id"`
	TokenHash string    `json:"token_hash"`
	Created   time.Time `json:"created"`
	Expires   time.Time `json:"expires"`
}

AuthTokenEntry is the database entity to store a user authorization token as hash.

type Middleware

type Middleware interface {
	// Connect to the database server or file or
	// whatever you are about to use.
	Connect(params ...interface{}) error
	// Close the connection to the database.
	Close()
	GetConfigStructure() interface{}

	// GetUserPermissionLevel returns the individual
	// permission level by the users ID and/or the
	// users role IDs.
	GetUserPermissionLevel(userID string, roles []string) (int, error)
	// GetGuildPrefix returns the individual prefix
	// for a guild by its ID.
	GetGuildPrefix(guildID string) (string, error)

	// SetGuildPrefix sets the custom prefix
	// for a guild in the DB.
	SetGuildPrefix(guildID, prefix string) error

	// SetFastTrigger gets the sound value used
	// for fast trigger. If this is an empty
	// string, this must be interpreted as
	// 'random sound'.
	GetFastTrigger(userID string) (string, error)
	// SetFastTrigger sets the sound which will
	// be triggered by using fast trigger.
	SetFastTrigger(userID, val string) error
	// GetFavorites gets the set favorites
	// set by the specified user. This should
	// return an empty array when no favorite
	// was set.
	GetFavorites(userID string) ([]string, error)
	// SetFavorite sets a sound as favorite.
	// This should not return an error if the
	// specified sound is already set as favorite.
	SetFavorite(userID, sound string) error
	// UnsetFavorite unsets a favorite for the
	// specified user. If the sound was not
	// set as favorite yet, this should not
	// return an error.
	UnsetFavorite(userID, sound string) error

	// GetAuthToken returns the token hash of the
	// token of the user´, if existent. This must return
	// an empty stirng if no token entry exists.
	GetAuthToken(userID string) (*AuthTokenEntry, error)
	// SetAuthToken creates a new token for the specified user
	// or updates tokenHash and/or expire time of an already
	// generated token.
	SetAuthToken(userID, tokenHash string, expires ...time.Time) error

	// AllLogEntry appends the log list by the
	// passed log data.
	AddLogEntry(sle *SoundLogEntry) error
	// GetLogEntries returns the log entries in
	// between the passed bounds. This list must
	// be ordered descending by time.
	GetLogEntries(guildID string, from, limit int) ([]*SoundLogEntry, error)
	// GetLogLen returns the ammount of entries
	// in the log wether per guildID, if passed
	// or of all entries.
	GetLogLen(guildID string) (int, error)
	// AddSoundStatsCount increases the play counter
	// of the sound for the specified guildID by one.
	AddSoundStatsCount(guildID, sound string) error
	// GetSoundStats returns the stats ordered
	// descending by play count.
	GetSoundStats(guildID string, limit int) ([]*SoundStatsEntry, error)
	// SetGuildVolume sets the volume the player will
	// be set to on the specified guild.
	SetGuildVolume(guildID string, volume int) error
	// GetGuildVolume gets the volume the player will
	// be set to on the specified guild.
	GetGuildVolume(guildID string) (int, error)
}

Middleware describes the structure of a database middleware.

type SoundLogEntry

type SoundLogEntry struct {
	Time    time.Time `json:"time"`
	UserID  string    `json:"user_id"`
	UserTag string    `json:"user_tag"`
	GuildID string    `json:"guild_id"`
	Source  string    `json:"source"`
	Sound   string    `json:"sound"`
}

SoundLogEntry is the data entity stored in the database as log entry when a sound was played.

type SoundStatsEntry

type SoundStatsEntry struct {
	Sound string `json:"sound"`
	Count int    `json:"count"`
}

SoundStatsEntry is the data entity stored in the database to count and get the playing stats of a local sound file.

type Timestamp

type Timestamp []uint8

Timestamp is a uint8 array typed timetsmap which can be transformed to time.Time

func (Timestamp) ToTime

func (t Timestamp) ToTime(format string) (time.Time, error)

ToTime parses the timestamp to a time object