Skip to content

Replace visibility checks with dedicated methods #1615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlobortolan merged 3 commits into from
Sep 12, 2025
Merged

Replace visibility checks with dedicated methods #1615

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de4981e
replace visibility checks with dedicated methods
carlobortolan Jul 10, 2025
391dd9f
fix: linting
carlobortolan Jul 10, 2025
300112f
Merge branch 'dev' into fix/cleanup-course-visibility-methods
carlobortolan Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/courses.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,17 +147,17 @@ func (r coursesRoutes) getLive(c *gin.Context) {
courseForLiveStream, _ := r.GetCourseById(context.Background(), stream.CourseID)

// only show streams for logged-in users if they are logged in
if courseForLiveStream.Visibility == "loggedin" && tumLiveContext.User == nil {
if courseForLiveStream.IsLoggedIn() && tumLiveContext.User == nil {
continue
}
// only show "enrolled" streams to users which are enrolled or admins
if courseForLiveStream.Visibility == "enrolled" {
if courseForLiveStream.IsEnrolled() {
if !tumLiveContext.User.IsAllowedToWatchPrivateCourse(courseForLiveStream) {
continue
}
}
// Only show hidden streams to course admins
if courseForLiveStream.Visibility == "hidden" && (tumLiveContext.User == nil || !tumLiveContext.User.IsAdminOfCourse(courseForLiveStream)) {
if courseForLiveStream.IsHidden() && (tumLiveContext.User == nil || !tumLiveContext.User.IsAdminOfCourse(courseForLiveStream)) {
continue
}
// Only show private streams to course admins
Expand Down
4 changes: 2 additions & 2 deletions api/download.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@ func (r downloadRoutes) download(c *gin.Context) {
_ = c.Error(dlErr)
return
}
if course.Visibility == "loggedin" || course.Visibility == "enrolled" {
if course.IsLoggedIn() || course.IsEnrolled() {
if tumLiveContext.User == nil {
_ = c.Error(dlErr)
return
}
if course.Visibility == "enrolled" {
if course.IsEnrolled() {
if !tumLiveContext.User.IsEligibleToWatchCourse(course) {
_ = c.Error(dlErr)
return
Expand Down
6 changes: 3 additions & 3 deletions apiv2/server/course.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,17 @@ func (a *API) GetLiveCourses(ctx context.Context, req *emptypb.Empty) (*protobuf
courseForLiveStream, _ := a.dao.GetCourseById(context.Background(), stream.CourseID)

// only show streams for logged-in users if they are logged in
if courseForLiveStream.Visibility == "loggedin" && user == nil {
if courseForLiveStream.IsLoggedIn() && user == nil {
continue
}
// only show "enrolled" streams to users which are enrolled or admins
if courseForLiveStream.Visibility == "enrolled" {
if courseForLiveStream.IsEnrolled() {
if !user.IsAllowedToWatchPrivateCourse(courseForLiveStream) {
continue
}
}
// Only show hidden streams to course admins
if courseForLiveStream.Visibility == "hidden" && (user == nil || !user.IsAdminOfCourse(courseForLiveStream)) {
if courseForLiveStream.IsHidden() && (user == nil || !user.IsAdminOfCourse(courseForLiveStream)) {
continue
}
// Only show private streams to course admins
Expand Down
5 changes: 5 additions & 0 deletions model/course.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,3 +331,8 @@ func (c Course) IsLoggedIn() bool {
func (c Course) IsEnrolled() bool {
return c.Visibility == "enrolled"
}

// IsPublic returns true if visibility is set to 'public' and false if not
func (c Course) IsPublic() bool {
return c.Visibility == "public"
}
6 changes: 3 additions & 3 deletions model/user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,9 +285,9 @@ func (u *User) IsAllowedToWatchPrivateCourse(course Course) bool {
// IsEligibleToWatchCourse checks if the user is allowed to access the course
func (u *User) IsEligibleToWatchCourse(course Course) bool {
if u == nil {
return course.Visibility == "public" || course.Visibility == "hidden"
return course.IsPublic() || course.IsHidden()
}
if course.Visibility == "public" || course.Visibility == "hidden" || course.Visibility == "loggedin" {
if course.IsPublic() || course.IsHidden() || course.IsLoggedIn() {
return true
}
for _, invCourse := range u.Courses {
Expand All @@ -300,7 +300,7 @@ func (u *User) IsEligibleToWatchCourse(course Course) bool {

// IsEligibleToSearchForCourse is a stricter version of IsEligibleToWatchCourse; in case of hidden course, it returns true only when the user is an admin of the course
func (u *User) IsEligibleToSearchForCourse(course Course) bool {
return u.IsEligibleToWatchCourse(course) && course.Visibility != "hidden" || u.IsAdminOfCourse(course)
return u.IsEligibleToWatchCourse(course) && !course.IsHidden() || u.IsAdminOfCourse(course)
}

func (u *User) CoursesForSemester(year int, term string, context context.Context) []Course {
Expand Down
11 changes: 6 additions & 5 deletions tools/middlewares.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,15 @@ func InitCourse(wrapper dao.DaoWrapper) gin.HandlerFunc {
return
}
// check if course is accessible by user:
if course.Visibility == "public" || course.Visibility == "hidden" || (tumLiveContext.User != nil && tumLiveContext.User.IsEligibleToWatchCourse(course)) {
switch {
case course.IsPublic(), course.IsHidden(), tumLiveContext.User != nil && tumLiveContext.User.IsEligibleToWatchCourse(course):
tumLiveContext.Course = &course
c.Set("TUMLiveContext", tumLiveContext)
} else if tumLiveContext.User == nil {
case tumLiveContext.User == nil:
c.Redirect(http.StatusFound, "/login?return="+url.QueryEscape(c.Request.RequestURI))
c.Abort()
return
} else {
default:
c.Status(http.StatusForbidden)
RenderErrorPage(c, http.StatusForbidden, ForbiddenCourseAccess)
}
Expand Down Expand Up @@ -217,7 +218,7 @@ func InitStream(wrapper dao.DaoWrapper) gin.HandlerFunc {
c.Abort()
return
}
if course.Visibility != "public" && course.Visibility != "hidden" {
if !course.IsPublic() && !course.IsHidden() {
if tumLiveContext.User == nil {
c.Redirect(http.StatusFound, "/login?return="+url.QueryEscape(c.Request.RequestURI))
c.Abort()
Expand Down Expand Up @@ -277,7 +278,7 @@ func InitStreamRealtime() realtime.SubscriptionMiddleware {
if stream.Private && (tumLiveContext.User == nil || !tumLiveContext.User.IsAdminOfCourse(course)) {
return realtime.NewError(http.StatusForbidden, "forbidden to see course")
}
if course.Visibility != "public" && course.Visibility != "hidden" {
if !course.IsPublic() && !course.IsHidden() {
if tumLiveContext.User == nil {
return realtime.NewError(http.StatusForbidden, "course only visible for logged in users")
} else if tumLiveContext.User == nil || !tumLiveContext.User.IsEligibleToWatchCourse(course) {
Expand Down
6 changes: 3 additions & 3 deletions web/index.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,17 +189,17 @@ func (d *IndexData) LoadLivestreams(c *gin.Context, daoWrapper dao.DaoWrapper) {
courseForLiveStream, _ := daoWrapper.GetCourseById(context.Background(), stream.CourseID)

// only show streams for logged in users if they are logged in
if courseForLiveStream.Visibility == "loggedin" && tumLiveContext.User == nil {
if courseForLiveStream.IsLoggedIn() && tumLiveContext.User == nil {
continue
}
// only show "enrolled" streams to users which are enrolled or admins
if courseForLiveStream.Visibility == "enrolled" {
if courseForLiveStream.IsEnrolled() {
if !tumLiveContext.User.IsAllowedToWatchPrivateCourse(courseForLiveStream) {
continue
}
}
// Only show hidden streams to admins
if courseForLiveStream.Visibility == "hidden" && (tumLiveContext.User == nil || tumLiveContext.User.Role != model.AdminType) {
if courseForLiveStream.IsHidden() && (tumLiveContext.User == nil || tumLiveContext.User.Role != model.AdminType) {
continue
}
var lectureHall *model.LectureHall
Expand Down
Loading