models

type Affiliations []string

type CalendarEvent struct {
	ID         int            `db:"id"`
	CourseID   int            `db:"course_id"`
	Title      string         `db:"title"`
	Annotation sql.NullString `db:"annotation"`

	//loaded week
	Monday time.Time
	Week   int
	Year   int

	//day templates for this week [0...6]
	Days Days

	//all upcoming exceptions
	Exceptions Exceptions

	//exeptions of this week
	ExceptionsOfWeek ExceptionsOfWeek
	//transformed schedule for easy front end usage
	ScheduleWeek []Schedule

	//used for enrollment
	NoEnroll      bool
	NoUnsubscribe bool
	EnrollMsg     string
}

type CalendarEvents []CalendarEvent

type Categories []Category

type Category struct {
	ID         int           `db:"id, primarykey, autoincrement"`
	Name       string        `db:"name"`
	LastEditor sql.NullInt32 `db:"last_editor"`
	LastEdited string        `db:"last_edited"`

	Entries HelpPageEntries ``
}

type ChildHasCourseLimit struct{}

type Course struct {
	ID                int             `db:"id, primarykey, autoincrement"`
	Title             string          `db:"title"`
	Creator           sql.NullInt32   `db:"creator"`
	Subtitle          sql.NullString  `db:"subtitle"`
	Visible           bool            `db:"visible"`
	Active            bool            `db:"active"`
	OnlyLDAP          bool            `db:"only_ldap"`
	CreationDate      time.Time       `db:"creation_date"`
	Description       sql.NullString  `db:"description"`
	Speaker           sql.NullString  `db:"speaker"`
	Fee               sql.NullFloat64 `db:"fee"`
	CustomEMail       sql.NullString  `db:"custom_email"`
	EnrollLimitEvents sql.NullInt32   `db:"enroll_limit_events"`
	EnrollmentStart   time.Time       `db:"enrollment_start"`
	EnrollmentEnd     time.Time       `db:"enrollment_end"`
	UnsubscribeEnd    sql.NullTime    `db:"unsubscribe_end"`
	ExpirationDate    time.Time       `db:"expiration_date"`
	ParentID          sql.NullInt32   `db:"parent_id"`

	//course data of different tables
	Events         Events         ``
	CalendarEvents CalendarEvents ``
	Editors        UserList       ``
	Instructors    UserList       ``
	Blocklist      UserList       ``
	Allowlist      UserList       ``
	Restrictions   Restrictions   ``

	//additional information required when displaying the course
	CreatorData User ``

	//path to the course entry in the groups tree
	Path Groups ``

	//used for correct template rendering
	CreatorID string
	Expired   bool

	//used to add/edit course restrictions
	CoursesOfStudies CoursesOfStudies
	Degrees          Degrees

	//used for enrollment
	CourseStatus CourseStatus
	Manage       bool

	//used to render buttons for redirect
	CanEdit               bool `db:"can_edit"`
	CanManageParticipants bool `db:"can_manage_participants"`
	IsCreator             bool

	//used for pretty timestamp rendering
	CreationDateStr    string         `db:"creation_date_str"`
	EnrollmentStartStr string         `db:"enrollment_start_str"`
	EnrollmentEndStr   string         `db:"enrollment_end_str"`
	UnsubscribeEndStr  sql.NullString `db:"unsubscribe_end_str"`
	ExpirationDateStr  string         `db:"expiration_date_str"`
}

type CourseList []CourseListInfo

type CourseListInfo struct {
	ID              int       `db:"id, primarykey, autoincrement"`
	Title           string    `db:"title"`
	CreationDate    time.Time `db:"creation_date"`
	CreationDateStr string    `db:"creation_date_str"`
	EMail           string    `db:"email"` //e-mail address of either the creator or the editor
}

type CourseOfStudies struct {
	ID   int    `db:"id, primarykey, autoincrement"`
	Name string `db:"name"`
}

type CourseStatus struct {
	AtBlocklist             bool
	AtAllowlist             bool
	UnsubscribeOver         bool `db:"unsubscribe_over"`
	NoEnrollmentPeriod      bool `db:"no_enrollment_period"`
	NotSatisfyRestrictions  bool
	NotLDAP                 bool
	MaxEnrollCoursesReached bool
	MaxEnrollCourses        int `db:"limit"`
}

type Courses []Course

type CoursesOfStudies []CourseOfStudies

type Credentials struct {
	Username     string
	EMail        string
	Password     string
	StayLoggedIn bool
}

type CustomEMailData struct {
	Salutation    Salutation     `db:"salutation"`
	Title         sql.NullString `db:"title"`
	NameAffix     sql.NullString `db:"name_affix"`
	AcademicTitle sql.NullString `db:"academic_title"`
	LastName      string         `db:"last_name"`
	FirstName     string         `db:"first_name"`
	CourseID      int            `db:"course_id"`
	CourseTitle   string         `db:"course_title"`
	EventTitle    string         `db:"event_title"`
	MeetingCount  int            `db:"meeting_count"`
	EMailCreator  string         `db:"email_creator"`
	Start         string         `db:"start"`
	End           string         `db:"end"`
	URL           string
}

type CustomTime struct {
	Value string
	Hour  int
	Min   int
}

type Day struct {
	Date     string
	DayTmpls DayTmpls
}

type DayTmpl struct {
	ID              int    `db:"id"`
	CalendarEventID int    `db:"calendar_event_id"`
	StartTime       string `db:"start_time"`
	EndTime         string `db:"end_time"`
	Interval        int    `db:"interval"`
	DayOfWeek       int    `db:"day_of_week"` //must be an integer between [0, 6]

	Slots Slots
}

type DayTmpls []DayTmpl

type Days []Day

type Degree struct {
	ID   int    `db:"id, primarykey, autoincrement"`
	Name string `db:"name"`
}

type Degrees []Degree

type EMailData struct {

	//used for salutation, user specific changes (new pw, role, activation, ...)
	User User

	//used for linking to the page
	URL string

	//used for enrollment
	CourseTitle string         `db:"course_title"`
	EventTitle  string         `db:"event_title"`
	CourseID    int            `db:"course_id"`
	CustomEMail sql.NullString `db:"custom_email"`

	//used for changing the enrollment status
	Status EnrollmentStatus

	//new course role type
	CourseRole string
	ViewMatrNr bool

	//used for slot enrollments
	Start  string `db:"start"`
	End    string `db:"end"`
	UserID int    `db:"user_id"`

	//used for notifying users about edits
	Field string

	//used for the custom enrollment e-mail
	CustomEMailData CustomEMailData
}

type EMailsData []EMailData

type EditEMailConfig struct {
	OptionUsers     int
	OptionEditors   int
	ID              int
	IsEvent         bool
	IsCalendarEvent bool

	Users              Users
	EditorsInstructors Users

	CourseTitle string `db:"course_title"`
	EventTitle  string `db:"event_title"`
	CourseID    int    `db:"course_id"`

	Field string
}

type EnrollOption int

type Enrolled struct {
	UserID           int              `db:"user_id, primarykey"`
	EventID          int              `db:"event_id, primarykey"`
	Status           EnrollmentStatus `db:"status"`
	TimeOfEnrollment time.Time        `db:"time_of_enrollment"`
	Comment          sql.NullString   `db:"comment"`

	//used for pretty timestamp rendering
	TimeOfEnrollmentStr string `db:"time_of_enrollment_str"`

	//used for profile page
	CourseID    int    `db:"course_id"`
	CourseTitle string `db:"course_title"`
	EventTitle  string `db:"event_title"`

	Start string `db:"start"`
	End   string `db:"end"`
}

type EnrollmentStatus int

type Enrollments []Enrolled

type Entries []Entry

type Entry struct {
	User
	Enrolled
}

type Event struct {
	ID            int            `db:"id, primarykey, autoincrement"`
	CourseID      int            `db:"course_id"`
	Capacity      int            `db:"capacity"`
	HasWaitlist   bool           `db:"has_waitlist"`
	HasComments   bool           `db:"has_comments"`
	Title         string         `db:"title"`
	Annotation    sql.NullString `db:"annotation"`
	EnrollmentKey sql.NullString `db:"enrollment_key"`
	Meetings      Meetings       ``

	//Fullness is the number of users that enrolled in this event
	Fullness int ``
	//Percentage is (Fullness * 100) / Capacity
	Percentage int ``

	//comments of enrolled users (if enabled)
	Comments []sql.NullString

	//used for enrollment
	EventStatus  EventStatus
	EnrollOption EnrollOption
	EnrollMsg    string
}

type EventStatus struct {
	Enrolled           bool
	Full               bool
	EnrollLimitReached bool //important to evaluate EnrollLimitEvents
	OnWaitlist         bool
	InOtherEvent       bool
}

type Events []Event

type Exception struct {
	ID               int            `db:"id"`
	CalendarEventID  int            `db:"calendar_event_id"`
	ExceptionStartDB time.Time      `db:"exception_start"`
	ExceptionEndDB   time.Time      `db:"exception_end"`
	Annotation       sql.NullString `db:"annotation"`

	//used to get the front end values
	ExceptionStart     string `db:"exception_start_str"`
	ExceptionEnd       string `db:"exception_end_str"`
	ExceptionStartTime string ``
	ExceptionEndTime   string ``
}

type Exceptions []Exception

type ExceptionsOfWeek []Exception

type Group struct {
	ID          int           `db:"id, primarykey, autoincrement"`
	ParentID    sql.NullInt32 `db:"parent_id"`
	Name        string        `db:"name"`
	CourseLimit sql.NullInt32 `db:"course_limit"`
	LastEditor  sql.NullInt32 `db:"last_editor"`
	LastEdited  string        `db:"last_edited"`
	Groups      []Group       `` //not a field in the respective table

	//used to ensure unique IDs if more than one group tree is present at a page
	IDPrefix string ``
	//identifies whether any parent/child has a course limit
	InheritsLimits bool ``
	ChildHasLimits bool ``
	//used to open courses
	CourseID int `db:"course_id"`
}

type Groups []Group

type HelpPageEntries []HelpPageEntry

type HelpPageEntry struct {
	ID         int           `db:"id, primarykey, autoincrement"`
	CategoryID int           `db:"category_id"`
	LastEditor sql.NullInt32 `db:"last_editor"`
	LastEdited string        `db:"last_edited"`

	//determine the entry type
	IsFAQ bool

	//NewsFeed value
	Content string `db:"content"`

	//FAQ values
	Question string `db:"question"`
	Answer   string `db:"answer"`
}

type IsTimestamp struct{}

type LanguageValidator struct{}

type ListConf struct {

	//specify which users are downloaded/e-mailed
	AllEvents    bool
	EventIDs     []int
	Participants bool
	WaitList     bool
	Unsubscribed bool

	//used for downloading the participants list
	UseComma bool
	Filename string

	//used for sending an e-mail
	Subject string
	Content string

	//used to specify a time interval for calendar events
	Start     string
	End       string
	StartTime string
	EndTime   string
}

type LogEntries []LogEntry

type LogEntry struct {
	ID             int       `db:"id, primarykey, autoincrement"`
	TimeOfCreation time.Time `db:"time_of_creation"`
	JSON           string    `db:"json"`
	Solved         bool      `db:"solved"`

	TimeOfCreationStr string `db:"time_of_creation_str"`
}

type Meeting struct {
	ID              int             `db:"id, primarykey, autoincrement"`
	EventID         int             `db:"event_id"`
	MeetingInterval MeetingInterval `db:"meeting_interval"`
	WeekDay         sql.NullInt32   `db:"weekday"`
	Place           sql.NullString  `db:"place"`
	Annotation      sql.NullString  `db:"annotation"`
	MeetingStart    time.Time       `db:"meeting_start"`
	MeetingEnd      time.Time       `db:"meeting_end"`

	//used to get the front end values
	MeetingStartTime string ``
	MeetingEndTime   string ``

	//used for pretty timestamp rendering
	MeetingStartStr string `db:"meeting_start_str"`
	MeetingEndStr   string `db:"meeting_end_str"`
}

type MeetingInterval int

type Meetings []Meeting

type NewCourseParam struct {
	Title    string
	Option   Option
	CourseID int
	JSON     []byte
}

type NoActiveChildren struct{}

type NotRequired struct{}

type NotUnique struct{}

type NullAffiliations struct {
	Affiliations Affiliations
	Valid        bool //Valid is true if Affiliations is not NULL
}

type Option int

type ParentHasCourseLimit struct{}

type ParticipantList struct {

	//general event information
	Event

	//all participant lists of the event
	Participants Entries
	Waitlist     Entries
	Unsubscribed Entries

	//additional calendar event information
	IsCalendarEvent bool `db:"is_calendar_event"`
	Monday          time.Time
	Week            int
	Year            int
	//day templates for this week [0...6]
	Days Days

	//all slots of a calendar event
	Slots Slots
}

type ParticipantLists []ParticipantList

type Participants struct {
	ID                 int            `db:"id, primarykey, autoincrement"`
	Title              string         `db:"title"`
	Active             bool           `db:"active"`
	EnrollmentStartStr string         `db:"enrollment_start_str"`
	EnrollmentEndStr   string         `db:"enrollment_end_str"`
	UnsubscribeEndStr  sql.NullString `db:"unsubscribe_end_str"`
	ExpirationDateStr  string         `db:"expiration_date_str"`
	ViewMatrNr         bool           `db:"view_matr_nr"`
	UserEMail          string         `db:"user_email"`

	Expired bool
	Lists   ParticipantLists
}

type Restriction struct {
	ID                int           `db:"id, primarykey, autoincrement"`
	CourseID          int           `db:"course_id"`
	MinimumSemester   sql.NullInt64 `db:"minimum_semester"`
	DegreeID          sql.NullInt64 `db:"degree_id"`
	CourseOfStudiesID sql.NullInt64 `db:"courses_of_studies_id"`

	//for usability
	DegreeName  sql.NullString `db:"degree_name"`
	StudiesName sql.NullString `db:"studies_name"`
}

type Restrictions []Restriction

type Role int

type Salutation int

type Schedule struct {
	Date    string
	Entries []ScheduleEntry
	InPast  bool
	Today   bool
}

type ScheduleEntry struct {
	StartTime string
	EndTime   string //should be the same as the subsequent start time
	Interval  int
	Type      ScheduleEntryType

	UserID string
	SlotID int
}

type ScheduleEntryType int

type Slot struct {
	ID        int `db:"id"`
	DayTmplID int `db:"day_tmpl_id"`
	UserID    int `db:"user_id"`

	//date + time
	Start time.Time `db:"start_time"`
	End   time.Time `db:"end_time"`

	//used for participants management
	User     User
	StartStr string `db:"start_str"`
	EndStr   string `db:"end_str"`
}

type Slots []Slot

type Studies []Study

type Study struct {
	UserID            int    `db:"user_id, primarykey"`
	Semester          int    `db:"semester"`
	DegreeID          int    `db:"degree_id, primarykey"`
	CourseOfStudiesID int    `db:"course_of_studies_id, primarykey"`
	Degree            string `db:"degree"`            //not a field in the studies table
	CourseOfStudies   string `db:"course_of_studies"` //not a field in the studies table
}

type Unique struct{}

type Unsubscribed struct {
	UserID  int `db:"user_id, primarykey"`
	EventID int `db:"event_id, primarykey"`
}

type User struct {
	ID         int            `db:"id, primarykey, autoincrement"`
	LastName   string         `db:"last_name"`
	FirstName  string         `db:"first_name"`
	EMail      string         `db:"email, unique"`
	Salutation Salutation     `db:"salutation"`
	Role       Role           `db:"role"`
	LastLogin  string         `db:"last_login"`
	FirstLogin string         `db:"first_login"`
	Language   sql.NullString `db:"language"`

	//ldap user fields
	MatrNr        sql.NullInt32    `db:"matr_nr, unique"`
	AcademicTitle sql.NullString   `db:"academic_title"`
	Title         sql.NullString   `db:"title"`
	NameAffix     sql.NullString   `db:"name_affix"`
	Affiliations  NullAffiliations `db:"affiliations"`
	Studies       Studies          ``

	//external user fields
	Password       sql.NullString `db:"password"`
	PasswordRepeat string         `` //not a field in the respective table
	ActivationCode sql.NullString `db:"activation_code"`

	//not a field in the resprective table
	IsEditor     bool
	IsInstructor bool

	//used for event enrollment
	IsLDAP bool `db:"is_ldap"`

	//used for profile page
	ActiveEnrollments  Enrollments
	ExpiredEnrollments Enrollments
	ActiveSlots        Enrollments
	ExpiredSlots       Enrollments
}

type UserDetails struct {
	User User

	//all groups created by this user
	Groups Groups

	//all (former) enrollments of the user
	Enrollments       []Enrolled
	FormerEnrollments []Unsubscribed

	//all courses in which the user was directly involved
	CreatedCourses []Course
	EditorOf       []Course
	InstructorOf   []Course

	//all courses of which the user was on the allowlist/blocklist
	OnAllowlist []Course
	OnBlocklist []Course

	//all categories, faqs and news created by this user
	Categories []Category
	FAQs       []HelpPageEntries
	News       []HelpPageEntries
}

type UserList []UserListEntry

type UserListEntry struct {
	UserID     int  `db:"user_id, primarykey"`
	CourseID   int  `db:"course_id, primarykey"`
	ViewMatrNr bool `db:"view_matr_nr"` //only a field in the tables editor and instructor

	//identifies whether a user is already on a user list
	OnList bool `db:"on_list"`

	//used for showing users at user searches
	EMail string `db:"email, unique"`

	//used for showing users properly
	AcademicTitle  sql.NullString `db:"academic_title"`
	Title          sql.NullString `db:"title"`
	NameAffix      sql.NullString `db:"name_affix"`
	LastName       string         `db:"last_name"`
	FirstName      string         `db:"first_name"`
	Salutation     Salutation     `db:"salutation"`
	ActivationCode sql.NullString `db:"activation_code"`
}

type Users []User

type ValidateUniqueData struct {
	Column string
	Table  string
	Value  string
	Tx     *sqlx.Tx
}

type Version2Course struct {
	CourseName             string
	Subtitle               string
	CourseLeader           []Version2UserList
	Limitation             []Version2Limitations
	EnrollmentStartDate    string
	EnrollmentEndDate      string
	EnrollmentStartTime    string
	EnrollmentEndTime      string
	DisenrollmentStartDate string
	DisenrollmentStartTime string
	ExpirationDate         string
	ExpirationTime         string
	Public                 string
	PaymentAmount          string
	Description            string
	Event                  []Version2Event
	Blacklist              []Version2UserList
	Whitelist              []Version2UserList
	Parent                 string
	Prioid                 int
	EnrollLimitEvents      int
	WelcomeMail            string
}

type Version2Event struct {
	WaitingList         string
	Description         string
	MaximumParticipants string
	EnrollmentKey1      string
	EnrollmentKey2      string
	InitEnrollmentKey   string
	Meeting             []Version2Meeting
}

type Version2Limitations struct {
	OnlyLDAP        string
	Degree          string
	CourseOfStudies string
	Semester        string
}

type Version2Meeting struct {
	MeetingRegularity string
	Day               string
	WeeklyInterval    string
	MeetingDate       string
	MeetingStartTime  string
	MeetingEndTime    string
	Location          string
	Annotation        string
}

type Version2UserList struct {
	Uid       int
	Firstname string
	Lastname  string
	Email     string
}

type Version3Course struct {
	Course
	Blacklist UserList ``
	Whitelist UserList ``
}