database

package
v0.0.22-beta Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2022 License: GPL-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Permissions = []Permission{
		{

			Permission:  PermissionPower,
			Name:        "Power",
			Description: "Interact with switches",
		},
		{

			Permission:  PermissionLogs,
			Name:        "Manage Logging",
			Description: "Use and manage the internal logging system",
		},
		{

			Permission:  PermissionDebug,
			Name:        "Debug Features",
			Description: "Obtain debug information about the system",
		},
		{

			Permission:  PermissionManageUsers,
			Name:        "Manage Users",
			Description: "Create / remove and manage users and manage their permissions",
		},
		{

			Permission:  PermissionHomescript,
			Name:        "Use Homescript",
			Description: "List, add, delete, run, and modify Homescripts",
		},
		{

			Permission:  PermissionAutomation,
			Name:        "Use Automations",
			Description: "List, add, delete, and modify automations",
		},
		{

			Permission:  PermissionScheduler,
			Name:        "Use the Scheduler",
			Description: "List, add, delete, and modify schedules",
		},
		{

			Permission:  PermissionReminder,
			Name:        "Use Reminders",
			Description: "List, add, delete, and modify reminders",
		},
		{

			Permission:  PermissionModifyServerConfig,
			Name:        "Manage Server Config",
			Description: "Change global server configuration values",
		},
		{

			Permission:  PermissionWildCard,
			Name:        "Permission Wildcard *",
			Description: "Allows all permissions",
		},
	}
)

Functions

func AddLogEvent 

func AddLogEvent(name string, description string, level int) error

Add a logged internal event based on `name, description, and level`

func AddNotification 

func AddNotification(receiverUsername string, name string, description string, priority uint8) error

Adds a new notification to a user's `inbox`, can return an error if the database fails

func AddUser 

func AddUser(user FullUser) error

Helper function to create a User which is given a set of basic permissions Will return an error if the database fails TODO: Remove business logic from here, move to core/user

func AddUserPermission 

func AddUserPermission(username string, permission PermissionType) (bool, error)

Adds a permission to a user, if database fails, then an error is returned Does not check for username so additional checks should be completed beforehand

func AddUserSwitchPermission 

func AddUserSwitchPermission(username string, switchId string) (bool, error)

Adds a given switchId to a given user The existence of the switch should be validated beforehand If this permission already resides inside the table, it is ignored and modified=false, error=nil is returned TODO: Remove useless check if user already has permission

func CheckDatabase 

func CheckDatabase() error

Executes a ping to the database in order to check if it is online

func CreateHardwareNode 

func CreateHardwareNode(node HardwareNode) error

Adds a new hardware node to the database, if the node already exists (same url), its name will be updated

func CreateNewAutomation 

func CreateNewAutomation(automation Automation) (uint, error)

Creates a new automation item, does not check the validity of the user or the homescript Id

func CreateNewHomescript 

func CreateNewHomescript(homescript Homescript) error

Creates a new homescript entry

func CreateNewReminder 

func CreateNewReminder(name string, description string, dueDate time.Time, owner string, priority NotificationPriority) (uint, error)

Creates a new reminder in the database

func CreateNewSchedule 

func CreateNewSchedule(schedule Schedule) (uint, error)

Creates a new schedule which represents a job of the scheduler

func CreateRoom 

func CreateRoom(RoomId string, Name string, Description string) error

Creates a new room

func CreateSwitch 

func CreateSwitch(id string, name string, roomId string, watts uint16) error

Creates a new switch Will return an error if the database fails

func DeleteAllAutomationsFromUser 

func DeleteAllAutomationsFromUser(username string) error

Deletes all automations from a given user

func DeleteAllHomescriptsOfUser 

func DeleteAllHomescriptsOfUser(username string) error

Deletes all Homescripts of a given user

func DeleteAllNotificationsFromUser 

func DeleteAllNotificationsFromUser(username string) error

If the user requests to empty their notification area, all hist notifications will be deleted

func DeleteAllRemindersFromUser 

func DeleteAllRemindersFromUser(username string) error

Deletes all reminders of a given user

func DeleteAllSchedulesFromUser 

func DeleteAllSchedulesFromUser(username string) error

Deletes all schedules from a given user

func DeleteAutomationById 

func DeleteAutomationById(id uint) error

Deletes an automation item given its Id Does not validate the validity of the provided Id

func DeleteHardwareNode 

func DeleteHardwareNode(url string) error

Deletes a node given its url

func DeleteHomescriptById 

func DeleteHomescriptById(homescriptId string) error

Deletes a homescript by its Id, does not check if the user has access to the homescript

func DeleteNotificationFromUserById 

func DeleteNotificationFromUserById(notificationId uint, username string) error

Deletes a given notification, can return an error

func DeleteScheduleById 

func DeleteScheduleById(id uint) error

Deletes a schedule item given its Id Does not validate the validity of the provided Id

func DeleteSwitch 

func DeleteSwitch(switchId string) error

Delete a given switch after all data which depends on this switch has been deleted

func DeleteTables 

func DeleteTables() error

func DeleteUser 

func DeleteUser(username string) error

Deletes a User based on a given Username, can return an error if the database fails The function does not validate the existence of this username itself, so additional checks should be done beforehand The avatar is removed in `core/user/user`

func DeleteUserReminderById 

func DeleteUserReminderById(owner string, id uint) error

Delete a single reminder, for example if its task is finished

func DoesHomescriptExist 

func DoesHomescriptExist(homescriptId string) (bool, error)

TODO: remove and intigrate into get user homescript Checks if a Homescript with an id exists in the database

func DoesPermissionExist 

func DoesPermissionExist(permission string) bool

Checks the validity of a given permission string TODO: Can also be abolished because of ENUM type

func DoesSwitchExist 

func DoesSwitchExist(switchId string) (bool, error)

Returns (exists, error), err when the database fails TODO: abolish this function, create GetSwitchById

func FlushAllLogs 

func FlushAllLogs() error

func FlushOldLogs 

func FlushOldLogs() error

Deletes log events older than 30 days in order to save storage space This function will later be used by a scheduler for daily jobs

func GetAvatarPathByUsername 

func GetAvatarPathByUsername(username string) (string, error)

Returns the path of the avatar image of a given user, does not check if the user exists, additional checks needed beforehand

func GetPowerStateOfSwitch 

func GetPowerStateOfSwitch(switchId string) (bool, error)

Returns the power state of a given switch as a boolean Does not check if the switch exists. If the switch does not exist, an error is returned TODO: also remove this, add GetSwitchById

func GetUserNotificationCount 

func GetUserNotificationCount(username string) (uint16, error)

Used for displaying the notification count for a given user Used in the frontend before the actual permissions are fetched

func GetUserPasswordHash 

func GetUserPasswordHash(username string) (string, error)

Returns the password of a given user

func GetUserPermissions 

func GetUserPermissions(username string) ([]string, error)

Returns a list of permissions assigned to a given user, if it exists

func GetUserSwitchPermissions 

func GetUserSwitchPermissions(username string) ([]string, error)

Returns a list of strings which resemble switch permissions

func Init 

func Init(databaseConfig DatabaseConfig, adminPassword string) error

func InitLogger 

func InitLogger(logger *logrus.Logger)

func InsertUser 

func InsertUser(user FullUser) error

Creates a new user based on a the supplied `User` struct Won't panic if user already exists, but will change password

func ModifyAutomation 

func ModifyAutomation(id uint, newItem AutomationWithoutIdAndUsername) error

Modifies the metadata of a given automation item Does not validate the provided metadata

func ModifyHardwareNode 

func ModifyHardwareNode(url string, node HardwareNode) error

Changes the metadata of a given node Does not affect the online boolean For changing the online status, use `SetNodeOnline`

func ModifyHomescriptById 

func ModifyHomescriptById(id string, homescript HomescriptFrontend) error

Modifies the metadata of a given homescript Does not check the validity of the homescript's id

func ModifyReminder 

func ModifyReminder(id uint, name string, description string, dueDate time.Time, priority NotificationPriority) error

Modifies a given reminder to possess the new metadata

func ModifySchedule 

func ModifySchedule(id uint, newItem ScheduleWithoudIdAndUsername) error

Modifies the metadata of a given schedule Does not validate the provided metadata

func RemoveAllPermissionsOfUser 

func RemoveAllPermissionsOfUser(username string) error

Removes all permissions of a given user, used when deleting a user in order to prevent foreign key failure Does not validate username, additional checks required, returns an error if the database fails

func RemoveAllSwitchPermissionsOfUser 

func RemoveAllSwitchPermissionsOfUser(username string) error

Removes all switch permission of a given user, used when deleing a user Does not validate the existence of said user

func RemoveSwitchFromPermissions 

func RemoveSwitchFromPermissions(switchId string) error

Deletes all occurrences of a given switch, used if a certain switch is deleted completely

func RemoveUserPermission 

func RemoveUserPermission(username string, permission PermissionType) (bool, error)

Attempts to remove a provided permission from a provided user Fails if permission does not exist or if the database fails Warns and returns `false` for the `modified` boolean the user does not have the permission TODO: the business logic will need to be put to user

func RemoveUserSwitchPermission 

func RemoveUserSwitchPermission(username string, switchId string) (bool, error)

TODO: Remove useless check if user already has permission TODO: check naming consistency of `ADD / CREATE` and `DELETE / REMOVE` Removes a switch permission from a user, but does not delete if from the switch permission list

func SetAutomationSystemActivation 

func SetAutomationSystemActivation(enabled bool) error

Change the state of the automation system

func SetNodeOnline 

func SetNodeOnline(nodeUrl string, online bool) error

Updates the online / offline state of a given node (url)

func SetPowerState 

func SetPowerState(switchId string, isPoweredOn bool) (bool, error)

Used when marking a power state of a switch Does not check the validity of the switch Id The returned boolean indicates if the power state had changed

func SetReminderUserWasNotified 

func SetReminderUserWasNotified(id uint, wasNotified bool, wasNotifiedAt time.Time) error

Modifies the reminders status its owner has been informed about urgency

func SetServerConfiguration 

func SetServerConfiguration(config ServerConfig) error

Updates the servers configuration

func SetUserAvatarPath 

func SetUserAvatarPath(username string, avatarPath string) error

Sets the path of the avatar for a given user, does not check if the user exists, additional checks needed beforehand

func SetUserDarkThemeEnabled 

func SetUserDarkThemeEnabled(username string, useDarkTheme bool) error

Set whether the user uses the dark theme or the light theme

func SetUserSchedulerEnabled 

func SetUserSchedulerEnabled(username string, enabled bool) error

Set whether the scheduler is enabled for the current user

func Shutdown 

func Shutdown() error

Closes the database

func UpdateLocation 

func UpdateLocation(lat float32, lon float32) error

Changes the location of the server

func UpdateUserMetadata 

func UpdateUserMetadata(username string, forename string, surname string, primaryColorDark string, primaryColorLight string) error

Sets the users primary colors

func UserHasPermission 

func UserHasPermission(username string, permission PermissionType) (bool, error)

Checks if a provided user is in possession of a provided permission, can return an error, if the database fails

func UserHasSwitchPermission 

func UserHasSwitchPermission(username string, switchId string) (bool, error)

Will return a boolean if a user has a switch permission TODO: Replace with QueryRow

Types

type Automation 

type Automation struct {
	Id             uint       `json:"id"`
	Name           string     `json:"name"`
	Description    string     `json:"description"`
	CronExpression string     `json:"cronExpression"`
	HomescriptId   string     `json:"homescriptId"`
	Owner          string     `json:"owner"`
	Enabled        bool       `json:"enabled"`
	TimingMode     TimingMode `json:"timingMode"`
}

func GetAutomationById 

func GetAutomationById(id uint) (Automation, bool, error)

Returns a Automation struct which matches the given Id If the id does not match a struct, a `false“ is returned

func GetAutomations 

func GetAutomations() ([]Automation, error)

Returns a list with automations of all users Used for activating persistent automations when the server starts

func GetUserAutomations 

func GetUserAutomations(username string) ([]Automation, error)

Returns a list containing automations of a given user Does not check the validity of the user

type AutomationWithoutIdAndUsername 

type AutomationWithoutIdAndUsername struct {
	Name           string     `json:"name"`
	Description    string     `json:"description"`
	CronExpression string     `json:"cronExpression"`
	HomescriptId   string     `json:"homescriptId"`
	Enabled        bool       `json:"enabled"`
	TimingMode     TimingMode `json:"timingMode"`
}

type Camera 

type Camera struct {
	Id     int    `json:"id"`
	RoomId string `json:"roomId"`
	Url    string `json:"url"`
	Name   string `json:"name"`
}

Camera struct, used in `config.rooms.cameras“

type DBStatus 

type DBStatus struct {
	OpenConnections int `json:"openConnections"`
	InUse           int `json:""`
	Idle            int `json:""`
}

func GetDatabaseStats 

func GetDatabaseStats() DBStatus

type DatabaseConfig 

type DatabaseConfig struct {
	Username string `json:"username"`
	Password string `json:"password"`
	Hostname string `json:"hostname"`
	Database string `json:"database"`
	Port     int    `json:"port"`
}

type FullUser 

type FullUser struct {
	Username          string `json:"username"`
	Forename          string `json:"forename"`
	Surname           string `json:"surname"`
	PrimaryColorDark  string `json:"primaryColorDark"`
	PrimaryColorLight string `json:"primaryColorLight"`
	Password          string `json:"password"`
	AvatarPath        string `json:"avatarPath"`
	SchedulerEnabled  bool   `json:"schedulerEnabled"`
	DarkTheme         bool   `json:"darkTheme"`
}

Identified by a username, has a password and an avatar path

type HardwareNode 

type HardwareNode struct {
	Name    string `json:"name"`
	Online  bool   `json:"online"`
	Enabled bool   `json:"enabled"` // Can be used to temporarely deactivate a node in case of maintenance
	Url     string `json:"url"`
	Token   string `json:"token"`
}

Hardware node

func GetHardwareNodeByUrl 

func GetHardwareNodeByUrl(url string) (HardwareNode, bool, error)

Returns a hardware node given its url

func GetHardwareNodes 

func GetHardwareNodes() ([]HardwareNode, error)

Returns a list of hardware nodes

type Homescript 

type Homescript struct {
	Id                  string `json:"id"`
	Owner               string `json:"owner"`
	Name                string `json:"name"`
	Description         string `json:"description"`
	QuickActionsEnabled bool   `json:"quickActionsEnabled"`
	SchedulerEnabled    bool   `json:"schedulerEnabled"`
	Code                string `json:"code"`
}

func GetUserHomescriptById 

func GetUserHomescriptById(homescriptId string, username string) (Homescript, bool, error)

Returns a Homescript given its id Returns Homescript, has been found, error TODO: replace with query row

func ListHomescriptFiles 

func ListHomescriptFiles() ([]Homescript, error)

Lists all Homescript files in the database

func ListHomescriptOfUser 

func ListHomescriptOfUser(username string) ([]Homescript, error)

Returns a list of homescripts owned by a given user

type HomescriptFrontend 

type HomescriptFrontend struct {
	Name                string `json:"name"`
	Description         string `json:"description"`
	QuickActionsEnabled bool   `json:"quickActionsEnabled"`
	SchedulerEnabled    bool   `json:"schedulerEnabled"`
	Code                string `json:"code"`
}

type LogEvent 

type LogEvent struct {
	Id          uint      `json:"id"`
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Level       int       `json:"level"`
	Date        time.Time `json:"date"`
}

internal logging-related

func GetLogs 

func GetLogs() ([]LogEvent, error)

type Notification 

type Notification struct {
	Id          uint      `json:"id"`
	Priority    uint8     `json:"priority"` // Includes 1: info, 2: warning, 3: alert
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Date        time.Time `json:"date"`
}

User notification

func GetUserNotifications 

func GetUserNotifications(username string) ([]Notification, error)

Used when requesting the user's permissions in the frontend Returns a list containing the permissions of a given user

type NotificationPriority 

type NotificationPriority uint
const (
	Low NotificationPriority = iota
	Normal
	Medium
	High
	Urgent
)

type Permission 

type Permission struct {
	Permission  PermissionType `json:"permission"`
	Name        string         `json:"name"`
	Description string         `json:"description"`
}

This file defines which permissions exists and describes their attributes

type PermissionType 

type PermissionType string
const (
	PermissionPower              PermissionType = "setPower"
	PermissionLogs               PermissionType = "logs"
	PermissionManageUsers        PermissionType = "manageUsers"
	PermissionDebug              PermissionType = "debug"
	PermissionHomescript         PermissionType = "homescript"
	PermissionAutomation         PermissionType = "automation"
	PermissionScheduler          PermissionType = "scheduler"
	PermissionReminder           PermissionType = "reminder"
	PermissionModifyServerConfig PermissionType = "modifyServerConfig"
	PermissionModifyRooms        PermissionType = "modifyRooms"

	// Dangerous
	PermissionWildCard PermissionType = "*"
)

Different types of permissions

type PowerState 

type PowerState struct {
	Switch  string `json:"switch"`
	PowerOn bool   `json:"powerOn"`
}

Contains the switch id and a matching boolean Used when requesting global power states

func GetPowerStates 

func GetPowerStates() ([]PowerState, error)

Returns a list of PowerStates Can return a database error TODO: not really needed

type Reminder 

type Reminder struct {
	Id                uint                 `json:"id"`
	Name              string               `json:"name"`
	Description       string               `json:"description"`
	Priority          NotificationPriority `json:"priority"`
	CreatedDate       time.Time            `json:"createdDate"`
	DueDate           time.Time            `json:"dueDate"`
	Owner             string               `json:"owner"`
	UserWasNotified   bool                 `json:"userWasNotified"` // Saves if the ownere has been notified about the current urgency of the task
	UserWasNotifiedAt time.Time            `json:"userWasNotifiedAt"`
}

func GetReminderById 

func GetReminderById(id uint, owner string) (Reminder, bool, error)

Given its id and owner, the function returns a reminder, if it was found and an error

func GetUserReminders 

func GetUserReminders(username string) ([]Reminder, error)

Returns a slice of reminders which were set up by a given user

type Room 

type Room struct {
	Id          string   `json:"id"`
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Switches    []Switch `json:"switches"`
	Cameras     []Camera `json:"cameras"`
}

Identified by a unique Id, has a Name and Description When used in config file, the Switches slice is also populated

func ListPersonalRoomsAll 

func ListPersonalRoomsAll(username string) ([]Room, error)

TODO: Move to business layer Returns a complete list of rooms, includes metadata like switches

func ListRooms 

func ListRooms() ([]Room, error)

Returns a list of rooms, excludes metadata like switches and cameras

type Schedule 

type Schedule struct {
	Id             uint   `json:"id"`
	Name           string `json:"name"`
	Owner          string `json:"owner"`
	Hour           uint   `json:"hour"`
	Minute         uint   `json:"minute"`
	HomescriptCode string `json:"homescriptCode"` // Will be executed if the scheduler runs the job
}

func GetScheduleById 

func GetScheduleById(id uint) (Schedule, bool, error)

Returns a schedule struct which matches the given id If the id does not match a struct, a `false“ is returned

func GetSchedules 

func GetSchedules() ([]Schedule, error)

Returns a list of schedules of all users, used for activating schedules at the start of the server

func GetUserSchedules 

func GetUserSchedules(username string) ([]Schedule, error)

Returns a list containing schedules of a given user

type ScheduleWithoudIdAndUsername 

type ScheduleWithoudIdAndUsername struct {
	Name           string `json:"name"`
	Hour           uint   `json:"hour"`
	Minute         uint   `json:"minute"`
	HomescriptCode string `json:"homescriptCode"`
}

type ServerConfig 

type ServerConfig struct {
	AutomationEnabled bool    `json:"automationEnabled"` // Sets the global state of the server's automation system
	LockDownMode      bool    `json:"lockDownMode"`      // If enabled, the server is unable to change power states and will not allow power actions
	Latitude          float32 `json:"latitude"`          // Used for calculating the sunset / sunrise and for openweathermap
	Longitude         float32 `json:"longitude"`
}

func GetServerConfiguration 

func GetServerConfiguration() (ServerConfig, bool, error)

Retrieves the servers configuration

type Switch 

type Switch struct {
	Id      string `json:"id"`
	Name    string `json:"name"`
	RoomId  string `json:"roomId"`
	PowerOn bool   `json:"powerOn"`
	Watts   uint16 `json:"watts"`
}

Identified by a Switch Id, has a name and belongs to a room

func ListSwitches 

func ListSwitches() ([]Switch, error)

Returns a list of available switches with their attributes

func ListUserSwitches 

func ListUserSwitches(username string) ([]Switch, error)

Same as `ListSwitches()` but takes a user sting as a filter

type TimingMode 

type TimingMode string
const (
	TimingNormal  TimingMode = "normal"  // Will not change, automation will always execute based on this time
	TimingSunrise TimingMode = "sunrise" // Uses the local time for sunrise, each run of a set automation will update the actual time and regenerate a cron expression
	TimingSunset  TimingMode = "sunset"  // Same as above, just for sunset
)

type User 

type User struct {
	Username          string `json:"username"`
	Forename          string `json:"forename"`
	Surname           string `json:"surname"`
	PrimaryColorDark  string `json:"primaryColorDark"`
	PrimaryColorLight string `json:"primaryColorLight"`
	SchedulerEnabled  bool   `json:"schedulerEnabled"`
	DarkTheme         bool   `json:"darkTheme"`
}

func GetUserByUsername 

func GetUserByUsername(username string) (User, bool, error)

Returns a user struct based on a username, does not check if the user exists, additional checks needed beforehand

func ListUsers 

func ListUsers() ([]User, error)

Lists users which are currently in the Database Returns an empty list with an error when failing

type UserDetails 

type UserDetails struct {
	User        User     `json:"user"`
	Permissions []string `json:"permissions"`
}

Used in the frontend, includes most of the important details of the current user

func GetUserDetails 

func GetUserDetails(username string) (UserDetails, bool, error)

Returns the users information and their permissions

func ListUsersWithPermission 

func ListUsersWithPermission() ([]UserDetails, error)

Lists users which are currently in the Database Returns an empty list with an error when failing

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.