a99fd08004
that are not present in a given student's gradeset. General code cleanup and addition of comments. Instructor dashboard API unit tests. LMS-58
212 lines
8.8 KiB
Python
212 lines
8.8 KiB
Python
"""
|
|
Instructor Dashboard Views
|
|
"""
|
|
from functools import partial
|
|
|
|
from django.utils.translation import ugettext as _
|
|
from django_future.csrf import ensure_csrf_cookie
|
|
from django.views.decorators.cache import cache_control
|
|
from mitxmako.shortcuts import render_to_response
|
|
from django.core.urlresolvers import reverse
|
|
from django.utils.html import escape
|
|
from django.http import Http404
|
|
from django.conf import settings
|
|
|
|
from xmodule_modifiers import wrap_xblock
|
|
from xmodule.html_module import HtmlDescriptor
|
|
from xmodule.modulestore import MONGO_MODULESTORE_TYPE
|
|
from xmodule.modulestore.django import modulestore
|
|
from xblock.field_data import DictFieldData
|
|
from xblock.fields import ScopeIds
|
|
from courseware.access import has_access
|
|
from courseware.courses import get_course_by_id, get_cms_course_link
|
|
from django_comment_client.utils import has_forum_access
|
|
from django_comment_common.models import FORUM_ROLE_ADMINISTRATOR
|
|
from student.models import CourseEnrollment
|
|
from bulk_email.models import CourseAuthorization
|
|
from lms.lib.xblock.runtime import handler_prefix
|
|
|
|
|
|
@ensure_csrf_cookie
|
|
@cache_control(no_cache=True, no_store=True, must_revalidate=True)
|
|
def instructor_dashboard_2(request, course_id):
|
|
"""Display the instructor dashboard for a course."""
|
|
|
|
course = get_course_by_id(course_id, depth=None)
|
|
is_studio_course = (modulestore().get_modulestore_type(course_id) == MONGO_MODULESTORE_TYPE)
|
|
|
|
access = {
|
|
'admin': request.user.is_staff,
|
|
'instructor': has_access(request.user, course, 'instructor'),
|
|
'staff': has_access(request.user, course, 'staff'),
|
|
'forum_admin': has_forum_access(
|
|
request.user, course_id, FORUM_ROLE_ADMINISTRATOR
|
|
),
|
|
}
|
|
|
|
if not access['staff']:
|
|
raise Http404()
|
|
|
|
sections = [
|
|
_section_course_info(course_id, access),
|
|
_section_membership(course_id, access),
|
|
_section_student_admin(course_id, access),
|
|
_section_data_download(course_id, access),
|
|
_section_analytics(course_id, access),
|
|
]
|
|
|
|
# Gate access to course email by feature flag & by course-specific authorization
|
|
if settings.MITX_FEATURES['ENABLE_INSTRUCTOR_EMAIL'] and \
|
|
is_studio_course and CourseAuthorization.instructor_email_enabled(course_id):
|
|
sections.append(_section_send_email(course_id, access, course))
|
|
|
|
studio_url = None
|
|
if is_studio_course:
|
|
studio_url = get_cms_course_link(course)
|
|
|
|
enrollment_count = sections[0]['enrollment_count']
|
|
disable_buttons = False
|
|
max_enrollment_for_buttons = settings.MITX_FEATURES.get("MAX_ENROLLMENT_INSTR_BUTTONS")
|
|
if max_enrollment_for_buttons is not None:
|
|
disable_buttons = enrollment_count > max_enrollment_for_buttons
|
|
|
|
context = {
|
|
'course': course,
|
|
'old_dashboard_url': reverse('instructor_dashboard', kwargs={'course_id': course_id}),
|
|
'studio_url': studio_url,
|
|
'sections': sections,
|
|
'disable_buttons': disable_buttons,
|
|
}
|
|
|
|
return render_to_response('instructor/instructor_dashboard_2/instructor_dashboard_2.html', context)
|
|
|
|
|
|
"""
|
|
Section functions starting with _section return a dictionary of section data.
|
|
|
|
The dictionary must include at least {
|
|
'section_key': 'circus_expo'
|
|
'section_display_name': 'Circus Expo'
|
|
}
|
|
|
|
section_key will be used as a css attribute, javascript tie-in, and template import filename.
|
|
section_display_name will be used to generate link titles in the nav bar.
|
|
""" # pylint: disable=W0105
|
|
|
|
|
|
def _section_course_info(course_id, access):
|
|
""" Provide data for the corresponding dashboard section """
|
|
course = get_course_by_id(course_id, depth=None)
|
|
|
|
course_org, course_num, course_name = course_id.split('/')
|
|
|
|
section_data = {
|
|
'section_key': 'course_info',
|
|
'section_display_name': _('Course Info'),
|
|
'access': access,
|
|
'course_id': course_id,
|
|
'course_org': course_org,
|
|
'course_num': course_num,
|
|
'course_name': course_name,
|
|
'course_display_name': course.display_name,
|
|
'enrollment_count': CourseEnrollment.objects.filter(course_id=course_id, is_active=1).count(),
|
|
'has_started': course.has_started(),
|
|
'has_ended': course.has_ended(),
|
|
'list_instructor_tasks_url': reverse('list_instructor_tasks', kwargs={'course_id': course_id}),
|
|
}
|
|
|
|
try:
|
|
advance = lambda memo, (letter, score): "{}: {}, ".format(letter, score) + memo
|
|
section_data['grade_cutoffs'] = reduce(advance, course.grade_cutoffs.items(), "")[:-2]
|
|
except Exception:
|
|
section_data['grade_cutoffs'] = "Not Available"
|
|
# section_data['offline_grades'] = offline_grades_available(course_id)
|
|
|
|
try:
|
|
section_data['course_errors'] = [(escape(a), '') for (a, _unused) in modulestore().get_item_errors(course.location)]
|
|
except Exception:
|
|
section_data['course_errors'] = [('Error fetching errors', '')]
|
|
|
|
return section_data
|
|
|
|
|
|
def _section_membership(course_id, access):
|
|
""" Provide data for the corresponding dashboard section """
|
|
section_data = {
|
|
'section_key': 'membership',
|
|
'section_display_name': _('Membership'),
|
|
'access': access,
|
|
'enroll_button_url': reverse('students_update_enrollment', kwargs={'course_id': course_id}),
|
|
'unenroll_button_url': reverse('students_update_enrollment', kwargs={'course_id': course_id}),
|
|
'list_course_role_members_url': reverse('list_course_role_members', kwargs={'course_id': course_id}),
|
|
'modify_access_url': reverse('modify_access', kwargs={'course_id': course_id}),
|
|
'list_forum_members_url': reverse('list_forum_members', kwargs={'course_id': course_id}),
|
|
'update_forum_role_membership_url': reverse('update_forum_role_membership', kwargs={'course_id': course_id}),
|
|
}
|
|
return section_data
|
|
|
|
|
|
def _section_student_admin(course_id, access):
|
|
""" Provide data for the corresponding dashboard section """
|
|
section_data = {
|
|
'section_key': 'student_admin',
|
|
'section_display_name': _('Student Admin'),
|
|
'access': access,
|
|
'get_student_progress_url_url': reverse('get_student_progress_url', kwargs={'course_id': course_id}),
|
|
'enrollment_url': reverse('students_update_enrollment', kwargs={'course_id': course_id}),
|
|
'reset_student_attempts_url': reverse('reset_student_attempts', kwargs={'course_id': course_id}),
|
|
'rescore_problem_url': reverse('rescore_problem', kwargs={'course_id': course_id}),
|
|
'list_instructor_tasks_url': reverse('list_instructor_tasks', kwargs={'course_id': course_id}),
|
|
}
|
|
return section_data
|
|
|
|
|
|
def _section_data_download(course_id, access):
|
|
""" Provide data for the corresponding dashboard section """
|
|
section_data = {
|
|
'section_key': 'data_download',
|
|
'section_display_name': _('Data Download'),
|
|
'access': access,
|
|
'get_grading_config_url': reverse('get_grading_config', kwargs={'course_id': course_id}),
|
|
'get_students_features_url': reverse('get_students_features', kwargs={'course_id': course_id}),
|
|
'get_anon_ids_url': reverse('get_anon_ids', kwargs={'course_id': course_id}),
|
|
'list_instructor_tasks_url': reverse('list_instructor_tasks', kwargs={'course_id': course_id}),
|
|
'list_grade_downloads_url': reverse('list_grade_downloads', kwargs={'course_id': course_id}),
|
|
'calculate_grades_csv_url': reverse('calculate_grades_csv', kwargs={'course_id': course_id}),
|
|
}
|
|
return section_data
|
|
|
|
|
|
def _section_send_email(course_id, access, course):
|
|
""" Provide data for the corresponding bulk email section """
|
|
html_module = HtmlDescriptor(
|
|
course.system,
|
|
DictFieldData({'data': ''}),
|
|
ScopeIds(None, None, None, 'i4x://dummy_org/dummy_course/html/dummy_name')
|
|
)
|
|
fragment = course.system.render(html_module, 'studio_view')
|
|
fragment = wrap_xblock(partial(handler_prefix, course_id), html_module, 'studio_view', fragment, None)
|
|
email_editor = fragment.content
|
|
section_data = {
|
|
'section_key': 'send_email',
|
|
'section_display_name': _('Email'),
|
|
'access': access,
|
|
'send_email': reverse('send_email', kwargs={'course_id': course_id}),
|
|
'editor': email_editor,
|
|
'list_instructor_tasks_url': reverse('list_instructor_tasks', kwargs={'course_id': course_id}),
|
|
'email_background_tasks_url': reverse('list_background_email_tasks', kwargs={'course_id': course_id}),
|
|
}
|
|
return section_data
|
|
|
|
|
|
def _section_analytics(course_id, access):
|
|
""" Provide data for the corresponding dashboard section """
|
|
section_data = {
|
|
'section_key': 'analytics',
|
|
'section_display_name': _('Analytics'),
|
|
'access': access,
|
|
'get_distribution_url': reverse('get_distribution', kwargs={'course_id': course_id}),
|
|
'proxy_legacy_analytics_url': reverse('proxy_legacy_analytics', kwargs={'course_id': course_id}),
|
|
}
|
|
return section_data
|