model

type Audit struct {
	gorm.Model

	User    *User // if nil -> system
	UserID  *uint
	Message string
	Type    AuditType
}

type AuditType uint

type AutoSkipSetting struct {
	Enabled bool `json:"enabled"`
}

type Bookmark struct {
	gorm.Model

	Description string `gorm:"not null" json:"description"`
	Hours       uint   `gorm:"not null" json:"hours"`
	Minutes     uint   `gorm:"not null" json:"minutes"`
	Seconds     uint   `gorm:"not null" json:"seconds"`
	UserID      uint   `gorm:"not null" json:"-"`
	StreamID    uint   `gorm:"not null" json:"-"`
}

type CameraPreset struct {
	Name          string `gorm:"not null"`
	PresetID      int    `gorm:"primaryKey;autoIncrement:false"`
	Image         string
	LectureHallID uint `gorm:"primaryKey;autoIncrement:false"`
	IsDefault     bool // this will be selected if there's no preference
}

type CameraPresetPreference struct {
	LectureHallID uint `json:"lecture_hall_id"`
	PresetID      int  `json:"preset_id"`
}

type CameraType uint

type Chat struct {
	gorm.Model

	UserID           string `gorm:"not null" json:"userId"`
	UserName         string `gorm:"not null" json:"name"`
	Message          string `gorm:"type:text;not null;index:,class:FULLTEXT" json:"-"`
	SanitizedMessage string `gorm:"-" json:"message"` // don't store the sanitized message in the database
	StreamID         uint   `gorm:"not null" json:"-"`
	Admin            bool   `gorm:"not null;default:false" json:"admin"`
	Color            string `gorm:"not null;default:'#368bd6'" json:"color"`

	Visible   sql.NullBool `gorm:"not null;default:true" json:"-"`
	IsVisible bool         `gorm:"-" json:"visible"` // IsVisible is .Bool value of Visible for simplicity

	Reactions []ChatReaction `gorm:"foreignKey:chat_id;" json:"reactions"`

	AddressedToUsers []User `gorm:"many2many:chat_user_addressedto" json:"-"`
	AddressedToIds   []uint `gorm:"-" json:"addressedTo"`

	Replies []Chat        `gorm:"foreignkey:ReplyTo" json:"replies"`
	ReplyTo sql.NullInt64 `json:"replyTo"`

	Resolved bool `gorm:"not null;default:false" json:"resolved"`
}

type ChatReaction struct {
	ChatID   uint   `gorm:"primaryKey; not null" json:"chatID"`
	UserID   uint   `gorm:"primaryKey; not null" json:"userID"`
	Username string `gorm:"not null" json:"username"`
	Emoji    string `gorm:"primaryKey; not null" json:"emoji"`
}

type Course struct {
	gorm.Model

	UserID                  uint   `gorm:"not null"` // Owner of the course
	Name                    string `gorm:"not null"`
	Slug                    string `gorm:"not null"` // eg. eidi
	Year                    int    `gorm:"not null"` // eg. 2021
	TeachingTerm            string `gorm:"not null"` // eg. Summer/Winter
	TUMOnlineIdentifier     string
	VODEnabled              bool `gorm:"default:true"`
	DownloadsEnabled        bool `gorm:"default:false"`
	ChatEnabled             bool `gorm:"default:false"`
	AnonymousChatEnabled    bool `gorm:"not null;default:true"`
	ModeratedChatEnabled    bool `gorm:"not null;default:false"`
	VodChatEnabled          bool
	Visibility              string `gorm:"default:loggedin"` // public, loggedin or enrolled
	Streams                 []Stream
	Users                   []User `gorm:"many2many:course_users;"`
	Admins                  []User `gorm:"many2many:course_admins;"`
	Token                   string
	UserCreatedByToken      bool   `gorm:"default:false"`
	CameraPresetPreferences string // json encoded. e.g. [{lectureHallID:1, presetID:4}, ...]
	SourcePreferences       string // json encoded. e.g. [{lectureHallID:1, sourceMode:0}, ...]
	Language                sql.NullString

	Pinned      bool `gorm:"-"`                       // Used to determine if the course is pinned when loaded for a specific user.
	LivePrivate bool `gorm:"not null; default:false"` // whether Livestreams are private
	VodPrivate  bool `gorm:"not null; default:false"` // Whether VODs are made private after livestreams
}

type CourseDTO struct {
	ID               uint
	Name             string
	Slug             string
	Visibility       string
	TeachingTerm     string
	Year             int
	DownloadsEnabled bool
	NextLecture      StreamDTO
	LastRecording    StreamDTO
	Streams          []StreamDTO
	IsAdmin          bool // Set in API handler
}

type CustomSpeeds []float32

type DefaultModeSetting struct {
	Beta bool `json:"beta"`
}

type DownloadableVod struct {
	FriendlyName, DownloadURL string
}

type Email struct {
	gorm.Model

	From    string    `gorm:"not null"`
	To      string    `gorm:"not null"`
	Subject string    `gorm:"not null"`
	Body    string    `gorm:"longtext;not null"`
	Success bool      `gorm:"not null;default:false"`
	Retries int       `gorm:"not null;default:0"`
	LastTry time.Time `gorm:"default:null"`
	Errors  string    `gorm:"longtext;default:null"`
}

type File struct {
	gorm.Model

	StreamID uint   `gorm:"not null"`
	Path     string `gorm:"not null"`
	Filename string
	Type     FileType `gorm:"not null; default: 1"`
}

type FileType uint

type InfoPage struct {
	gorm.Model

	Name       string       `gorm:"not null"` // e.g. 'privacy', 'imprint',...
	RawContent string       `gorm:"text; not null"`
	Type       InfoPageType `gorm:"not null; default: 1"`
}

type InfoPageType uint

type IngestServer struct {
	gorm.Model  `json:"gorm_model"`
	Url         string       `json:"url"`                // e.g. rtmp://user:[email protected]
	OutUrl      string       `gorm:"not null"`           // e.g. https://out.server.com/streams/%s/playlist.m3u8 where %s is the stream name
	Workload    int          `json:"workload,omitempty"` // # of streams currently ingesting to this server
	StreamNames []StreamName // array of stream names that will be assigned to this server
}

type LectureHall struct {
	gorm.Model

	Name           string         `gorm:"not null"`            // as in smp (e.g. room_00_13_009A)
	FullName       string         `gorm:"not null"`            // e.g. '5613.EG.009A (00.13.009A, Seminarraum), Boltzmannstr. 3(5613), 85748 Garching b. München'
	StreamProtocol StreamProtocol `gorm:"not null; default:1"` // 1 = rtsp, 2 = srt
	CombIP         string
	PresIP         string
	CamIP          string
	CameraIP       string     // ip of the actual camera (not smp)
	CameraType     CameraType `gorm:"not null; default:1"`
	Streams        []Stream
	CameraPresets  []CameraPreset
	RoomID         int    // used by TUMOnline
	PwrCtrlIp      string // power control api for red live light
	ExternalURL    string

	// Legacy is true if a stream is handled by a worker, false if handled by a runner.
	// todo: remove with worker code
	Legacy bool `gorm:"not null; default:true"`
}

type LectureHallDTO struct {
	ID          uint
	Name        string
	ExternalURL string
}

type Model struct {
	ID        uint           `gorm:"primarykey" json:"id"`
	CreatedAt time.Time      `json:"createdAt"`
	UpdatedAt time.Time      `json:"-"`
	DeletedAt gorm.DeletedAt `gorm:"index" json:"-"`
}

type Notification struct {
	Model
	Title  *string            `json:"title,omitempty"`
	Body   string             `json:"-" gorm:"not null"`
	Target NotificationTarget `json:"target" gorm:"not null; default:1"`

	// SanitizedBody is the body of the notification, converted from markdown to HTML
	SanitizedBody string `json:"body" gorm:"-"`
}

type NotificationTarget int

type PlaybackSpeedSetting struct {
	Speed   float32 `json:"speed"`
	Enabled bool    `json:"enabled"`
}

type PlaybackSpeedSettings []PlaybackSpeedSetting

type Poll struct {
	gorm.Model

	StreamID uint   // used by gorm
	Stream   Stream `gorm:"foreignKey:stream_id;not null;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
	Question string `gorm:"not null" json:"question"`
	Active   bool   `gorm:"not null;default:true" json:"active"`

	PollOptions []PollOption `gorm:"many2many:chat_poll_options" json:"pollOptions"`
}

type PollOption struct {
	gorm.Model

	Answer string `gorm:"not null" json:"answer"`
	Votes  []User `gorm:"many2many:poll_option_user_votes" json:"-"`
}

type RegisterLink struct {
	gorm.Model

	UserID         uint   `gorm:"not null"`
	RegisterSecret string `gorm:"not null"`
}

type Runner struct {
	// Hostname is the hostname of the runner
	Hostname string `gorm:"column:hostname;primaryKey;unique;not null"`
	// Port is the port, the runners gRPC server listens on.
	Port uint32 `gorm:"column:port;not null"`
	// LastSeen is the timestamp of the last successful heartbeat.
	// if the runner wasn't seen in more than 5 seconds, it's considered dead
	// and won't be assigned further jobs.
	LastSeen time.Time `gorm:"column:last_seen;"`
	// TimeOfRegister is the timestamp of the register message.
	TimeOfRegister time.Time `gorm:"column:time_of_register;"`
	// Draining is true if the runner is shutting down.
	// In this case, no further jobs will be assigned.
	Draining bool `gorm:"column:draining;not null;default:false"`
	// JobCount is the number of currently running jobs.
	// It's updated through heartbeats and used to select
	// the runner with the least workload for new jobs.
	JobCount uint64 `gorm:"column:job_count;not null;default:0"`
	// Version is the version of the runner.
	Version string `gorm:"column:version;not null;default:'dev'"`
}

type Semester struct {
	TeachingTerm string
	Year         int
}

type ServerNotification struct {
	gorm.Model

	Text    string    `gorm:"not null"`
	Warn    bool      `gorm:"not null;default:false"` // if false -> Info
	Start   time.Time `gorm:"not null"`
	Expires time.Time `gorm:"not null"`
}

type ShortLink struct {
	gorm.Model

	Link     string `gorm:"type:varchar(256); unique; not null"`
	CourseId uint   `gorm:"not null"`
}

type Silence struct {
	gorm.Model `json:"omitempty"`

	Start    uint `json:"start"`
	End      uint `json:"end"`
	StreamID uint `json:"stream_id,omitempty"`
}

type SourceMode int

type SourcePreference struct {
	LectureHallID uint       `json:"lecture_hall_id"`
	SourceMode    SourceMode `json:"source_mode"`
}

type Stat struct {
	gorm.Model

	Time     time.Time `gorm:"not null"`
	StreamID uint      `gorm:"not null"`
	Viewers  uint      `gorm:"not null;default:0"`
	Live     bool      `gorm:"not null;default:false"`
}

type Stream struct {
	gorm.Model

	Name                  string `gorm:"index:,class:FULLTEXT"`
	Description           string `gorm:"type:text;index:,class:FULLTEXT"`
	CourseID              uint
	Start                 time.Time `gorm:"not null"`
	End                   time.Time `gorm:"not null"`
	ChatEnabled           bool      `gorm:"default:null"`
	RoomName              string
	RoomCode              string
	EventTypeName         string
	TUMOnlineEventID      uint
	SeriesIdentifier      string `gorm:"default:null"`
	StreamKey             string `gorm:"not null"`
	PlaylistUrl           string
	PlaylistUrlPRES       string
	PlaylistUrlCAM        string
	LiveNow               bool      `gorm:"not null"`
	LiveNowTimestamp      time.Time `gorm:"default:null;column:live_now_timestamp"`
	Recording             bool
	Premiere              bool `gorm:"default:null"`
	Ended                 bool `gorm:"default:null"`
	Chats                 []Chat
	Stats                 []Stat
	Units                 []StreamUnit
	VodViews              uint `gorm:"default:0"` // todo: remove me before next semester
	StartOffset           uint `gorm:"default:null"`
	EndOffset             uint `gorm:"default:null"`
	LectureHallID         uint `gorm:"default:null"`
	Silences              []Silence
	Files                 []File `gorm:"foreignKey:StreamID"`
	ThumbInterval         uint32 `gorm:"default:null"`
	StreamName            string
	Duration              sql.NullInt32    `gorm:"default:null"`
	StreamWorkers         []Worker         `gorm:"many2many:stream_workers;"`
	StreamProgresses      []StreamProgress `gorm:"foreignKey:StreamID"`
	VideoSections         []VideoSection
	TranscodingProgresses []TranscodingProgress `gorm:"foreignKey:StreamID"`
	Private               bool                  `gorm:"not null;default:false"`

	Watched bool `gorm:"-"` // Used to determine if stream is watched when loaded for a specific user.
}

type StreamDTO struct {
	ID                uint
	Name              string
	Description       string
	IsRecording       bool
	IsPlanned         bool
	IsComingUp        bool
	HLSUrl            string
	Downloads         []DownloadableVod
	Start             time.Time
	End               time.Time
	Duration          int32
	LectureHall       string
	IsPubliclyVisible bool
}

type StreamName struct {
	gorm.Model

	StreamName     string    `gorm:"type:varchar(64); unique; not null"`
	IsTranscoding  bool      `gorm:"not null;default:false"`
	IngestServerID uint      `gorm:"not null"`
	StreamID       uint      // Is null when the slot is not used
	FreedAt        time.Time `gorm:"not null;default:0"`
}

type StreamProgress struct {
	Progress float64 `gorm:"not null" json:"progress"`              // The progress of the stream as represented as a floating point value between 0 and 1.
	Watched  bool    `gorm:"not null;default:false" json:"watched"` // Whether the user has marked the stream as watched.

	// We need to use a primary key in order to use ON CONFLICT in dao/progress.go, same as e.g. https://www.sqlite.org/lang_conflict.html.
	StreamID uint `gorm:"primaryKey" json:"streamId"`
	UserID   uint `gorm:"primaryKey" json:"-"`
}

type StreamProtocol uint

type StreamUnit struct {
	gorm.Model

	UnitName        string
	UnitDescription string
	UnitStart       uint `gorm:"not null"`
	UnitEnd         uint `gorm:"not null"`
	StreamID        uint `gorm:"not null"`
}

type StreamVersion string

type Subtitles struct {
	gorm.Model

	StreamID uint   `gorm:"not null"`
	Content  string `gorm:"not null"` // the .srt content provided by the voice-service
	Language string `gorm:"not null"`
}

type Token struct {
	gorm.Model
	UserID  uint         // used by gorm
	User    User         `gorm:"foreignKey:user_id;not null;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"` // creator of the token
	Token   string       `json:"token" gorm:"not null"`                                                     // secret token
	Expires sql.NullTime `json:"expires"`                                                                   // expiration date (null if none)
	Scope   string       `json:"scope" gorm:"not null"`                                                     // scope of the token, currently only admin
	LastUse sql.NullTime `json:"last_use"`                                                                  // last time the token was used
}

type TranscodingFailure struct {
	gorm.Model

	StreamID uint `gorm:"not null"`
	Stream   Stream
	Version  StreamVersion `gorm:"not null"`
	Logs     string        `gorm:"not null"`
	ExitCode int
	FilePath string `gorm:"not null"` // the source file that could not be transcoded
	Hostname string `gorm:"not null"` // the hostname of the worker that failed

	// Ignored by gorm:
	FriendlyTime string `gorm:"-"`
}

type TranscodingProgress struct {
	StreamID uint          `gorm:"primaryKey" json:"streamID"`
	Version  StreamVersion `gorm:"primaryKey" json:"version"`

	Progress int `gorm:"not null; default:0" json:"progress"`
}

type UploadKey struct {
	gorm.Model
	UploadKey string `gorm:"not null"`
	Stream    Stream
	StreamID  uint
	VideoType VideoType `gorm:"not null"`
}

type User struct {
	gorm.Model

	Name                string         `gorm:"type:varchar(80); not null" json:"name"`
	LastName            *string        `json:"-"`
	Email               sql.NullString `gorm:"type:varchar(256); uniqueIndex; default:null" json:"-"`
	MatriculationNumber string         `gorm:"type:varchar(256); uniqueIndex; default:null" json:"-"`
	LrzID               string         `json:"-"`
	Role                uint           `gorm:"default:4" json:"-"` // AdminType = 1, LecturerType = 2, GenericType = 3, StudentType  = 4
	Password            string         `gorm:"default:null" json:"-"`
	Courses             []Course       `gorm:"many2many:course_users" json:"-"` // courses a lecturer invited this user to
	AdministeredCourses []Course       `gorm:"many2many:course_admins"`         // courses this user is an admin of
	PinnedCourses       []Course       `gorm:"many2many:pinned_courses"`

	Settings  []UserSetting `gorm:"foreignkey:UserID"`
	Bookmarks []Bookmark    `gorm:"foreignkey:UserID" json:"-"`
}

type UserSetting struct {
	gorm.Model

	UserID uint            `gorm:"not null"`
	Type   UserSettingType `gorm:"not null"`
	Value  string          `gorm:"not null"` // json encoded setting
}

type UserSettingType int

type VideoSection struct {
	gorm.Model

	Description  string `gorm:"not null;index:,class:FULLTEXT" json:"description"`
	StartHours   uint   `gorm:"not null" json:"startHours"`
	StartMinutes uint   `gorm:"not null" json:"startMinutes"`
	StartSeconds uint   `gorm:"not null" json:"startSeconds"`

	StreamID uint `gorm:"not null" json:"streamID"`
	FileID   uint `gorm:"not null" json:"fileID"`
}

type VideoSeekChunk struct {
	ChunkIndex uint `gorm:"primaryKey;autoIncrement:false" json:"chunkIndex"`
	Hits       uint `gorm:"not null" json:"hits"`
	StreamID   uint `gorm:"primaryKey;autoIncrement:false" json:"streamID"`
}

type VideoType string

type Worker struct {
	WorkerID string `gorm:"primaryKey"`
	Host     string
	Status   string
	Workload uint // How much the worker has to do. +1 per silence detection job, +2 per converting job, +3 per streaming job
	LastSeen time.Time

	// VM stats:
	CPU    string
	Memory string
	Disk   string
	Uptime string

	Version string
}