# -*- coding: utf-8 -*-
#
# This file is part of INGInious. See the LICENSE and the COPYRIGHTS files for
# more information about the licensing of this file.
""" A course class with some modification for users """
from collections import OrderedDict
from inginious.common.courses import Course
from inginious.frontend.common.courses import FrontendCourse
from inginious.frontend.webapp.accessible_time import AccessibleTime
[docs]class WebAppCourse(FrontendCourse):
""" A course with some modification for users """
def __init__(self, courseid, content, task_factory, hook_manager):
super(WebAppCourse, self).__init__(courseid, content, task_factory, hook_manager)
if self._content.get('nofrontend', False):
raise Exception("That course is not allowed to be displayed directly in the webapp")
try:
self._admins = self._content.get('admins', [])
self._tutors = self._content.get('tutors', [])
self._accessible = AccessibleTime(self._content.get("accessible", None))
self._registration = AccessibleTime(self._content.get("registration", None))
self._registration_password = self._content.get('registration_password', None)
self._registration_ac = self._content.get('registration_ac', None)
if self._registration_ac not in [None, "username", "realname", "email"]:
raise Exception("Course has an invalid value for registration_ac: " + self.get_id())
self._registration_ac_list = self._content.get('registration_ac_list', [])
self._groups_student_choice = self._content.get("groups_student_choice", False)
self._use_classrooms = self._content.get('use_classrooms', True)
self._allow_unregister = self._content.get('allow_unregister', True)
except:
raise Exception("Course has an invalid description: " + self.get_id())
[docs] def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
[docs] def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
[docs] def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
[docs] def is_open_to_non_staff(self):
""" Returns true if the course is accessible by users that are not administrator of this course """
return self.get_accessibility().is_open()
[docs] def is_registration_possible(self, username, realname, email):
""" Returns true if users can register for this course """
return self.get_accessibility().is_open() and self._registration.is_open() and self.is_user_accepted_by_access_control(username, realname, email)
[docs] def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
[docs] def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
[docs] def get_accessibility(self, plugin_override=True):
""" Return the AccessibleTime object associated with the accessibility of this course """
vals = self._hook_manager.call_hook('course_accessibility', course=self, default=self._accessible)
return vals[0] if len(vals) and plugin_override else self._accessible
[docs] def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
[docs] def get_tasks(self):
return OrderedDict(sorted(list(Course.get_tasks(self).items()), key=lambda t: t[1].get_order()))
[docs] def get_access_control_method(self):
""" Returns either None, "username", "realname", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
[docs] def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
[docs] def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
[docs] def use_classrooms(self):
""" Returns True if classrooms are used """
return self._use_classrooms
[docs] def is_user_accepted_by_access_control(self, username, realname, email):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif self.get_access_control_method() == "username":
return username in self.get_access_control_list()
elif self.get_access_control_method() == "realname":
return realname in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return email in self.get_access_control_list()
return False
[docs] def allow_unregister(self, plugin_override=True):
""" Returns True if students can unregister from course """
vals = self._hook_manager.call_hook('course_allow_unregister', course=self, default=self._allow_unregister)
return vals[0] if len(vals) and plugin_override else self._allow_unregister