class Course(object):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory, plugin_manager, task_dispensers):
self._id = courseid
self._content = content
self._fs = course_fs
self._task_factory = task_factory
self._plugin_manager = plugin_manager
self._translations = {}
translations_fs = self._fs.from_subfolder("$i18n")
if translations_fs.exists():
for f in translations_fs.list(folders=False, files=True, recursive=False):
lang = f[0:len(f) - 3]
if translations_fs.exists(lang + ".mo"):
self._translations[lang] = gettext.GNUTranslations(translations_fs.get_fd(lang + ".mo"))
else:
self._translations[lang] = gettext.NullTranslations()
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
if self._content.get('nofrontend', False):
raise Exception("That course is not allowed to be displayed directly in the webapp")
_migrate_from_v_0_6(content, self._task_factory.get_all_tasks(self))
try:
self._admins = self._content.get('admins', [])
self._tutors = self._content.get('tutors', [])
self._description = self._content.get('description', '')
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", "binding", "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._allow_unregister = self._content.get('allow_unregister', True)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_url = self._content.get('lti_url', '')
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get('lti_send_back_grade', False)
self._tags = {key: Tag(key, tag_dict, self.gettext) for key, tag_dict in self._content.get("tags", {}).items()}
task_dispenser_class = task_dispensers.get(self._content.get('task_dispenser', 'toc'), TableOfContents)
# Here we use a lambda to encourage the task dispenser to pass by the task_factory to fetch course tasks
# to avoid them to be cached along with the course object. Passing the task factory as argument
# would require to pass the course too, and have a useless reference back.
self._task_dispenser = task_dispenser_class(lambda: self._task_factory.get_all_tasks(self), self._content.get("dispenser_data", ''))
except:
raise Exception("Course has an invalid YAML spec: " + self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_url = ''
self._lti_send_back_grade = False
# Build the regex for the ACL, allowing for fast matching. Only used internally.
self._registration_ac_regex = self._build_ac_regex(self._registration_ac_list)
def get_translation_obj(self, language):
return self._translations.get(language, gettext.NullTranslations())
def gettext(self, language, *args, **kwargs):
return self.get_translation_obj(language).gettext(*args, **kwargs)
def get_id(self):
""" Return the _id of this course """
return self._id
def get_fs(self):
""" Returns a FileSystemProvider which points to the folder of this course """
return self._fs
def get_task(self, taskid):
""" Returns a Task object """
return self._task_factory.get_task(self, taskid)
def get_descriptor(self):
""" Get (a copy) the description of the course """
return copy.deepcopy(self._content)
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info: UserInfo):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
def get_accessibility(self, plugin_override=True):
""" Return the AccessibleTime object associated with the accessibility of this course """
vals = self._plugin_manager.call_hook('course_accessibility', course=self, default=self._accessible)
return vals[0] if len(vals) and plugin_override else self._accessible
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self, ordered=False):
return self._task_dispenser.get_ordered_tasks() if ordered else self._task_factory.get_all_tasks(self)
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self) -> List[str]:
""" Returns the list of all users/emails/binding methods/... (see get_access_control_method) allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_url(self):
""" Returns the URL to the external platform the course is hosted on """
return self._lti_url
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info: UserInfo):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
keys_per_access_control_method = {
"username": (lambda: [user_info.username]),
"email": (lambda: [user_info.email]),
"binding": (lambda: user_info.bindings.keys())
}
if not user_info or self.get_access_control_method() not in keys_per_access_control_method:
return False
# check that at least one key matches in the list
keys = keys_per_access_control_method[self.get_access_control_method()]()
return any(self._registration_ac_regex.match(key) for key in keys)
def allow_preview(self):
return self._allow_preview
def allow_unregister(self, plugin_override=True):
""" Returns True if students can unregister from course """
vals = self._plugin_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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(language, self._description) if self._description else ''
return ParsableText(description, "rst", translation=self.get_translation_obj(language))
def get_tags(self):
return self._tags
def get_task_dispenser(self):
"""
:return: the structure of the course
"""
return self._task_dispenser
def _build_ac_regex(self, list_ac):
""" Build a regex for the AC list, allowing for fast matching. The regex is only used internally """
return re.compile('|'.join(re.escape(x).replace("\\*", ".*") for x in list_ac))
class WebAppCourse(Course):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory, hook_manager):
super(WebAppCourse, self).__init__(courseid, content, course_fs, task_factory, hook_manager)
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
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._description = self._content.get('description', '')
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", "binding", "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._allow_unregister = self._content.get('allow_unregister', True)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_url = self._content.get('lti_url', '')
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get('lti_send_back_grade', False)
self._tags = {key: Tag(key, tag_dict, self.gettext) for key, tag_dict in self._content.get("tags", {}).items()}
except:
raise Exception("Course has an invalid YAML spec: " + self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_url = ''
self._lti_send_back_grade = False
self.course_page = "course"
self.admin_page = "admin"
self.has_student = True
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
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
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self):
return OrderedDict(sorted(list(Course.get_tasks(self).items()), key=lambda t: (t[1].get_order(), t[1].get_id())))
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_url(self):
""" Returns the URL to the external platform the course is hosted on """
return self._lti_url
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif not user_info:
return False
elif self.get_access_control_method() == "username":
return user_info["username"] in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return user_info["email"] in self.get_access_control_list()
elif self.get_access_control_method() == "binding":
return set(user_info["bindings"].keys()).intersection(set(self.get_access_control_list()))
return False
def allow_preview(self):
return self._allow_preview
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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(language, self._description) if self._description else ''
return ParsableText(description, "rst", translation=self.get_translation_obj(language))
def get_tags(self):
return self._tags
def get_admin_menu(self, plugin_manager, user_manager):
""" Return the element to display in the admin menu of the course """
default_entries = []
if user_manager.has_admin_rights_on_course(self):
default_entries += [("settings", "<i class='fa fa-cog fa-fw'></i> " + _("Course settings"))]
default_entries += [("stats", "<i class='fa fa-area-chart fa-fw'></i> " + _("Stats")),
("students", "<i class='fa fa-user fa-fw'></i> " + _("Students")),
("audiences", "<i class='fa fa-group fa-fw'></i> " + _("Audiences"))]
if not self.is_lti():
default_entries += [("groups", "<i class='fa fa-group fa-fw'></i> " + _("Groups"))]
default_entries += [("tasks", "<i class='fa fa-tasks fa-fw'></i> " + _("Tasks")),
("tags", "<i class='fa fa-tags fa-fw'></i> " + _("Tags")),
("submissions", "<i class='fa fa-search fa-fw'></i> " + _("View submissions")),
("download", "<i class='fa fa-download fa-fw'></i> " + _("Download submissions"))]
if user_manager.has_admin_rights_on_course(self):
default_entries += [("replay", "<i class='fa fa-refresh fa-fw'></i> " + _("Replay submissions")),
("danger", "<i class='fa fa-bomb fa-fw'></i> " + _("Danger zone"))]
# Hook should return a tuple (link,name) where link is the relative link from the index of the course administration.
additional_entries = [entry for entry in plugin_manager.call_hook('course_admin_menu', course=self) if
entry is not None]
return default_entries + additional_entries
class WebAppCourse(Course):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory,
hook_manager):
super(WebAppCourse, self).__init__(courseid, content, course_fs,
task_factory, hook_manager)
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
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._description = self._content.get('description', '')
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", "binding", "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)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get(
'lti_send_back_grade', False)
except:
raise Exception("Course has an invalid YAML spec: " +
self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._use_classrooms = True
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_send_back_grade = False
# Caches for tag lists
self._all_tags_cache = None
self._all_tags_cache_list = {}
self._all_tags_cache_list_admin = {}
self._organisational_tags_to_task = {}
self.update_all_tags_cache()
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
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
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self):
return OrderedDict(
sorted(list(Course.get_tasks(self).items()),
key=lambda t: (t[1].get_order(), t[1].get_id())))
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def use_classrooms(self):
""" Returns True if classrooms are used """
return self._use_classrooms
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif not user_info:
return False
elif self.get_access_control_method() == "username":
return user_info["username"] in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return user_info["email"] in self.get_access_control_list()
elif self.get_access_control_method() == "binding":
return set(user_info["bindings"].keys()).intersection(
set(self.get_access_control_list()))
return False
def allow_preview(self):
return self._allow_preview
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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(
language, self._description) if self._description else ''
return ParsableText(
description, "rst",
self._translations.get(language, gettext.NullTranslations()))
def get_all_tags(self):
"""
Return a tuple of lists ([common_tags], [anti_tags], [organisational_tags]) all tags of all tasks of this course
Since this is an heavy procedure, we use a cache to cache results. Cache should be updated when a task is modified.
"""
if self._all_tags_cache != None:
return self._all_tags_cache
tag_list_common = set()
tag_list_misconception = set()
tag_list_org = set()
tasks = self.get_tasks()
for id, task in tasks.items():
for tag in task.get_tags()[0]:
tag_list_common.add(tag)
for tag in task.get_tags()[1]:
tag_list_misconception.add(tag)
for tag in task.get_tags()[2]:
tag_list_org.add(tag)
tag_list_common = natsorted(tag_list_common,
key=lambda y: y.get_name().lower())
tag_list_misconception = natsorted(tag_list_misconception,
key=lambda y: y.get_name().lower())
tag_list_org = natsorted(tag_list_org,
key=lambda y: y.get_name().lower())
self._all_tags_cache = (list(tag_list_common),
list(tag_list_misconception),
list(tag_list_org))
return self._all_tags_cache
def get_all_tags_names_as_list(self, admin=False, language="en"):
""" Computes and cache two list containing all tags name sorted by natural order on name """
if admin:
if self._all_tags_cache_list_admin != {} and language in self._all_tags_cache_list_admin:
return self._all_tags_cache_list_admin[language] #Cache hit
else:
if self._all_tags_cache_list != {} and language in self._all_tags_cache_list:
return self._all_tags_cache_list[language] #Cache hit
#Cache miss, computes everything
s_stud = set()
s_admin = set()
(common, _, org) = self.get_all_tags()
for tag in common + org:
# Is tag_name_with_translation correct by doing that like that ?
tag_name_with_translation = self.gettext(
language, tag.get_name()) if tag.get_name() else ""
s_admin.add(tag_name_with_translation)
if tag.is_visible_for_student():
s_stud.add(tag_name_with_translation)
self._all_tags_cache_list_admin[language] = natsorted(
s_admin, key=lambda y: y.lower())
self._all_tags_cache_list[language] = natsorted(
s_stud, key=lambda y: y.lower())
if admin:
return self._all_tags_cache_list_admin[language]
return self._all_tags_cache_list[language]
def get_organisational_tags_to_task(self):
""" This build a dict for fast retrive tasks id based on organisational tags. The form of the dict is:
{ 'org_tag_1': ['task_id', 'task_id', ...],
'org_tag_2' : ['task_id', 'task_id', ...],
... }
"""
if self._organisational_tags_to_task != {}:
return self._organisational_tags_to_task
for taskid, task in self.get_tasks().items():
for tag in task.get_tags()[2]:
self._organisational_tags_to_task.setdefault(
tag.get_name(), []).append(taskid)
return self._organisational_tags_to_task
def update_all_tags_cache(self):
""" Force the cache refreshing """
self._all_tags_cache = None
self._all_tags_cache_list = {}
self._all_tags_cache_list_admin = {}
self._organisational_tags_to_task = {}
self.get_all_tags()
self.get_all_tags_names_as_list()
self.get_organisational_tags_to_task()
class WebAppCourse(Course):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory,
hook_manager):
super(WebAppCourse, self).__init__(courseid, content, course_fs,
task_factory, hook_manager)
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
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._description = self._content.get('description', '')
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", "binding", "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._allow_unregister = self._content.get('allow_unregister',
True)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get(
'lti_send_back_grade', False)
self._tags = {
key: Tag(key, tag_dict, self.gettext)
for key, tag_dict in self._content.get("tags", {}).items()
}
except:
raise Exception("Course has an invalid YAML spec: " +
self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_send_back_grade = False
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
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
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self):
return OrderedDict(
sorted(list(Course.get_tasks(self).items()),
key=lambda t: (t[1].get_order(), t[1].get_id())))
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif not user_info:
return False
elif self.get_access_control_method() == "username":
return user_info["username"] in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return user_info["email"] in self.get_access_control_list()
elif self.get_access_control_method() == "binding":
return set(user_info["bindings"].keys()).intersection(
set(self.get_access_control_list()))
return False
def allow_preview(self):
return self._allow_preview
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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(
language, self._description) if self._description else ''
return ParsableText(description,
"rst",
translation=self.get_translation_obj(language))
def get_tags(self):
return self._tags
class WebAppCourse(Course):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory, hook_manager):
super(WebAppCourse, self).__init__(courseid, content, course_fs, task_factory, hook_manager)
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
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._description = self._content.get('description', '')
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", "binding", "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)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get('lti_send_back_grade', False)
except:
raise Exception("Course has an invalid YAML spec: " + self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._use_classrooms = True
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_send_back_grade = False
# Caches for tag lists
self._all_tags_cache = None
self._all_tags_cache_list = {}
self._all_tags_cache_list_admin = {}
self._organisational_tags_to_task = {}
self.update_all_tags_cache()
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
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
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self):
return OrderedDict(sorted(list(Course.get_tasks(self).items()), key=lambda t: (t[1].get_order(), t[1].get_id())))
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def use_classrooms(self):
""" Returns True if classrooms are used """
return self._use_classrooms
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif not user_info:
return False
elif self.get_access_control_method() == "username":
return user_info["username"] in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return user_info["email"] in self.get_access_control_list()
elif self.get_access_control_method() == "binding":
return set(user_info["bindings"].keys()).intersection(set(self.get_access_control_list()))
return False
def allow_preview(self):
return self._allow_preview
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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(language, self._description) if self._description else ''
return ParsableText(description, "rst", self._translations.get(language, gettext.NullTranslations()))
def get_all_tags(self):
"""
Return a tuple of lists ([common_tags], [anti_tags], [organisational_tags]) all tags of all tasks of this course
Since this is an heavy procedure, we use a cache to cache results. Cache should be updated when a task is modified.
"""
if self._all_tags_cache != None:
return self._all_tags_cache
tag_list_common = set()
tag_list_misconception = set()
tag_list_org = set()
tasks = self.get_tasks()
for id, task in tasks.items():
for tag in task.get_tags()[0]:
tag_list_common.add(tag)
for tag in task.get_tags()[1]:
tag_list_misconception.add(tag)
for tag in task.get_tags()[2]:
tag_list_org.add(tag)
tag_list_common = natsorted(tag_list_common, key=lambda y: y.get_name().lower())
tag_list_misconception = natsorted(tag_list_misconception, key=lambda y: y.get_name().lower())
tag_list_org = natsorted(tag_list_org, key=lambda y: y.get_name().lower())
self._all_tags_cache = (list(tag_list_common), list(tag_list_misconception), list(tag_list_org))
return self._all_tags_cache
def get_all_tags_names_as_list(self, admin=False, language="en"):
""" Computes and cache two list containing all tags name sorted by natural order on name """
if admin:
if self._all_tags_cache_list_admin != {} and language in self._all_tags_cache_list_admin:
return self._all_tags_cache_list_admin[language] #Cache hit
else:
if self._all_tags_cache_list != {} and language in self._all_tags_cache_list:
return self._all_tags_cache_list[language] #Cache hit
#Cache miss, computes everything
s_stud = set()
s_admin = set()
(common, _, org) = self.get_all_tags()
for tag in common + org:
# Is tag_name_with_translation correct by doing that like that ?
tag_name_with_translation = self.gettext(language, tag.get_name()) if tag.get_name() else ""
s_admin.add(tag_name_with_translation)
if tag.is_visible_for_student():
s_stud.add(tag_name_with_translation)
self._all_tags_cache_list_admin[language] = natsorted(s_admin, key=lambda y: y.lower())
self._all_tags_cache_list[language] = natsorted(s_stud, key=lambda y: y.lower())
if admin:
return self._all_tags_cache_list_admin[language]
return self._all_tags_cache_list[language]
def get_organisational_tags_to_task(self):
""" This build a dict for fast retrive tasks id based on organisational tags. The form of the dict is:
{ 'org_tag_1': ['task_id', 'task_id', ...],
'org_tag_2' : ['task_id', 'task_id', ...],
... }
"""
if self._organisational_tags_to_task != {}:
return self._organisational_tags_to_task
for taskid, task in self.get_tasks().items():
for tag in task.get_tags()[2]:
self._organisational_tags_to_task.setdefault(tag.get_name(), []).append(taskid)
return self._organisational_tags_to_task
def update_all_tags_cache(self):
""" Force the cache refreshing """
self._all_tags_cache = None
self._all_tags_cache_list = {}
self._all_tags_cache_list_admin = {}
self._organisational_tags_to_task = {}
self.get_all_tags()
self.get_all_tags_names_as_list()
self.get_organisational_tags_to_task()
class Course(object):
""" A course with some modification for users """
def __init__(self, courseid, content, course_fs, task_factory,
plugin_manager):
self._id = courseid
self._content = content
self._fs = course_fs
self._task_factory = task_factory
self._plugin_manager = plugin_manager
self._translations = {}
translations_fs = self._fs.from_subfolder("$i18n")
if translations_fs.exists():
for f in translations_fs.list(folders=False,
files=True,
recursive=False):
lang = f[0:len(f) - 3]
if translations_fs.exists(lang + ".mo"):
self._translations[lang] = gettext.GNUTranslations(
translations_fs.get_fd(lang + ".mo"))
else:
self._translations[lang] = gettext.NullTranslations()
try:
self._name = self._content['name']
except:
raise Exception("Course has an invalid name: " + self.get_id())
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._description = self._content.get('description', '')
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", "binding", "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._allow_unregister = self._content.get('allow_unregister',
True)
self._allow_preview = self._content.get('allow_preview', False)
self._is_lti = self._content.get('is_lti', False)
self._lti_url = self._content.get('lti_url', '')
self._lti_keys = self._content.get('lti_keys', {})
self._lti_send_back_grade = self._content.get(
'lti_send_back_grade', False)
self._tags = {
key: Tag(key, tag_dict, self.gettext)
for key, tag_dict in self._content.get("tags", {}).items()
}
if 'toc' in self._content:
self._toc = SectionsList(self._content['toc'])
else:
tasks = self._task_factory.get_all_tasks(self)
ordered_task_list = OrderedDict(
sorted(list(tasks.items()),
key=lambda t:
(t[1].get_old_order(), t[1].get_id())))
indexed_task_list = {
taskid: rank
for rank, taskid in enumerate(ordered_task_list.keys())
}
self._toc = SectionsList([{
"id": "tasks-list",
"title": _("List of exercises"),
"rank": 0,
"tasks_list": indexed_task_list
}])
except:
raise Exception("Course has an invalid YAML spec: " +
self.get_id())
# Force some parameters if LTI is active
if self.is_lti():
self._accessible = AccessibleTime(True)
self._registration = AccessibleTime(False)
self._registration_password = None
self._registration_ac = None
self._registration_ac_list = []
self._groups_student_choice = False
self._allow_unregister = False
else:
self._lti_keys = {}
self._lti_url = ''
self._lti_send_back_grade = False
def get_translation_obj(self, language):
return self._translations.get(language, gettext.NullTranslations())
def gettext(self, language, *args, **kwargs):
return self.get_translation_obj(language).gettext(*args, **kwargs)
def get_id(self):
""" Return the _id of this course """
return self._id
def get_fs(self):
""" Returns a FileSystemProvider which points to the folder of this course """
return self._fs
def get_task(self, taskid):
""" Returns a Task object """
return self._task_factory.get_task(self, taskid)
def get_descriptor(self):
""" Get (a copy) the description of the course """
return copy.deepcopy(self._content)
def get_staff(self):
""" Returns a list containing the usernames of all the staff users """
return list(set(self.get_tutors() + self.get_admins()))
def get_admins(self):
""" Returns a list containing the usernames of the administrators of this course """
return self._admins
def get_tutors(self):
""" Returns a list containing the usernames of the tutors assigned to this course """
return self._tutors
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()
def is_registration_possible(self, user_info):
""" 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(user_info)
def is_password_needed_for_registration(self):
""" Returns true if a password is needed for registration """
return self._registration_password is not None
def get_registration_password(self):
""" Returns the password needed for registration (None if there is no password) """
return self._registration_password
def get_accessibility(self, plugin_override=True):
""" Return the AccessibleTime object associated with the accessibility of this course """
vals = self._plugin_manager.call_hook('course_accessibility',
course=self,
default=self._accessible)
return vals[0] if len(vals) and plugin_override else self._accessible
def get_registration_accessibility(self):
""" Return the AccessibleTime object associated with the registration """
return self._registration
def get_tasks(self):
tasks = self._task_factory.get_all_tasks(self)
return OrderedDict(
sorted(list(tasks.items()),
key=lambda t: (t[1].get_order(), t[1].get_id())))
def get_access_control_method(self):
""" Returns either None, "username", "binding", or "email", depending on the method used to verify that users can register to the course """
return self._registration_ac
def get_access_control_list(self):
""" Returns the list of all users allowed by the AC list """
return self._registration_ac_list
def can_students_choose_group(self):
""" Returns True if the students can choose their groups """
return self._groups_student_choice
def is_lti(self):
""" True if the current course is in LTI mode """
return self._is_lti
def lti_keys(self):
""" {name: key} for the LTI customers """
return self._lti_keys if self._is_lti else {}
def lti_url(self):
""" Returns the URL to the external platform the course is hosted on """
return self._lti_url
def lti_send_back_grade(self):
""" True if the current course should send back grade to the LTI Tool Consumer """
return self._is_lti and self._lti_send_back_grade
def is_user_accepted_by_access_control(self, user_info):
""" Returns True if the user is allowed by the ACL """
if self.get_access_control_method() is None:
return True
elif not user_info:
return False
elif self.get_access_control_method() == "username":
return user_info["username"] in self.get_access_control_list()
elif self.get_access_control_method() == "email":
return user_info["email"] in self.get_access_control_list()
elif self.get_access_control_method() == "binding":
return set(user_info["bindings"].keys()).intersection(
set(self.get_access_control_list()))
return False
def allow_preview(self):
return self._allow_preview
def allow_unregister(self, plugin_override=True):
""" Returns True if students can unregister from course """
vals = self._plugin_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
def get_name(self, language):
""" Return the name of this course """
return self.gettext(language, self._name) if self._name else ""
def get_description(self, language):
"""Returns the course description """
description = self.gettext(
language, self._description) if self._description else ''
return ParsableText(description,
"rst",
translation=self.get_translation_obj(language))
def get_tags(self):
return self._tags
def get_toc(self):
"""
:return: the structure of the course
"""
return self._toc