157 lines
7.8 KiB
Python
157 lines
7.8 KiB
Python
"""
|
|
Progress Tab Views
|
|
"""
|
|
|
|
from rest_framework.generics import RetrieveAPIView
|
|
from rest_framework.permissions import IsAuthenticated
|
|
from rest_framework.response import Response
|
|
|
|
from edx_django_utils import monitoring as monitoring_utils
|
|
from opaque_keys.edx.keys import CourseKey
|
|
|
|
from lms.djangoapps.course_home_api.progress.v1.serializers import ProgressTabSerializer
|
|
|
|
from student.models import CourseEnrollment
|
|
from lms.djangoapps.course_api.blocks.transformers.blocks_api import BlocksAPITransformer
|
|
from lms.djangoapps.courseware.context_processor import user_timezone_locale_prefs
|
|
from lms.djangoapps.courseware.courses import get_course_with_access, get_studio_url
|
|
from lms.djangoapps.courseware.masquerade import setup_masquerade
|
|
from lms.djangoapps.courseware.access import has_access
|
|
|
|
import lms.djangoapps.course_blocks.api as course_blocks_api
|
|
from lms.djangoapps.courseware.views.views import credit_course_requirements, get_cert_data
|
|
from lms.djangoapps.grades.api import CourseGradeFactory
|
|
from lms.djangoapps.verify_student.services import IDVerificationService
|
|
from openedx.core.djangoapps.content.block_structure.transformers import BlockStructureTransformers
|
|
|
|
CREDIT_SUPPORT_URL = 'https://support.edx.org/hc/en-us/sections/115004154688-Purchasing-Academic-Credit'
|
|
|
|
|
|
class ProgressTabView(RetrieveAPIView):
|
|
"""
|
|
**Use Cases**
|
|
|
|
Request details for the Progress Tab
|
|
|
|
**Example Requests**
|
|
|
|
GET api/course_home/v1/progress/{course_key}
|
|
|
|
**Response Values**
|
|
|
|
Body consists of the following fields:
|
|
|
|
certificate_data: Object containing information about the user's certificate status
|
|
cert_web_view_url: (str) the url to view the certificate
|
|
download_url: (str) the url to download the certificate
|
|
is_downloadable: (bool) true if the status is downloadable and the download url is not None
|
|
is_requestable: (bool) true if status is requesting and request_cert_url is not None
|
|
msg: (str) message for the certificate status
|
|
title: (str) title of the certificate status
|
|
credit_course_requirements: An object containing the following fields
|
|
dashboard_url: (str) the url to the user's dashboard
|
|
eligibility_status: (str) the user's eligibility to receive a course credit
|
|
requirements: object containing the following fields
|
|
display_name: (str) the name of the requirement that should be displayed
|
|
namespace: (str) the type that the requirement is
|
|
min_grade: (float) the percentage formatted minimum grade needed for this requirement
|
|
status: (str) the status of the requirement
|
|
status_date: (str) the date the status was set
|
|
credit_support_url: (str) the url to the support docs for purchasing a credit
|
|
courseware_summary: List of serialized Chapters. each Chapter has the following fields:
|
|
display_name: (str) a str of what the name of the Chapter is for displaying on the site
|
|
subsections: List of serialized Subsections, each has the following fields:
|
|
display_name: (str) a str of what the name of the Subsection is for displaying on the site
|
|
due: (str) a DateTime string for when the Subsection is due
|
|
format: (str) the format, if any, of the Subsection (Homework, Exam, etc)
|
|
graded: (bool) whether or not the Subsection is graded
|
|
graded_total: an object containing the following fields
|
|
earned: (float) the amount of points the user earned
|
|
possible: (float) the amount of points the user could have earned
|
|
percent_graded: (float) the percentage of the points the user received for the subsection
|
|
show_correctness: (str) a str representing whether to show the problem/practice scores based on due date
|
|
show_grades: (bool) a bool for whether to show grades based on the access the user has
|
|
url: (str) the absolute path url to the Subsection
|
|
enrollment_mode: (str) a str representing the enrollment the user has ('audit', 'verified', ...)
|
|
studio_url: (str) a str of the link to the grading in studio for the course
|
|
user_timezone: (str) The user's preferred timezone
|
|
verification_data: an object containing
|
|
link: (str) the link to either start or retry verification
|
|
status: (str) the status of the verification
|
|
status_date: (str) the date time string of when the verification status was set
|
|
|
|
|
|
|
|
**Returns**
|
|
|
|
* 200 on success with above fields.
|
|
* 302 if the user is not enrolled.
|
|
* 403 if the user is not authenticated.
|
|
* 404 if the course is not available or cannot be seen.
|
|
"""
|
|
|
|
permission_classes = (IsAuthenticated,)
|
|
serializer_class = ProgressTabSerializer
|
|
|
|
def get(self, request, *args, **kwargs):
|
|
course_key_string = kwargs.get('course_key_string')
|
|
course_key = CourseKey.from_string(course_key_string)
|
|
|
|
# Enable NR tracing for this view based on course
|
|
monitoring_utils.set_custom_metric('course_id', course_key_string)
|
|
monitoring_utils.set_custom_metric('user_id', request.user.id)
|
|
monitoring_utils.set_custom_metric('is_staff', request.user.is_staff)
|
|
|
|
_, request.user = setup_masquerade(
|
|
request,
|
|
course_key,
|
|
staff_access=has_access(request.user, 'staff', course_key),
|
|
reset_masquerade_data=True
|
|
)
|
|
|
|
user_timezone_locale = user_timezone_locale_prefs(request)
|
|
user_timezone = user_timezone_locale['user_timezone']
|
|
|
|
transformers = BlockStructureTransformers()
|
|
transformers += course_blocks_api.get_course_block_access_transformers(request.user)
|
|
transformers += [
|
|
BlocksAPITransformer(None, None, depth=3),
|
|
]
|
|
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
|
|
|
|
enrollment_mode, _ = CourseEnrollment.enrollment_mode_for_user(request.user, course_key)
|
|
|
|
course_grade = CourseGradeFactory().read(request.user, course)
|
|
courseware_summary = course_grade.chapter_grades.values()
|
|
|
|
verification_status = IDVerificationService.user_status(request.user)
|
|
verification_link = None
|
|
if verification_status['status'] is None or verification_status['status'] == 'expired':
|
|
verification_link = IDVerificationService.get_verify_location('verify_student_verify_now',
|
|
course_id=course_key)
|
|
elif verification_status['status'] == 'must_reverify':
|
|
verification_link = IDVerificationService.get_verify_location('verify_student_reverify',
|
|
course_id=course_key)
|
|
verification_data = {
|
|
'link': verification_link,
|
|
'status': verification_status['status'],
|
|
'status_date': verification_status['status_date'],
|
|
}
|
|
|
|
data = {
|
|
'certificate_data': get_cert_data(request.user, course, enrollment_mode, course_grade),
|
|
'courseware_summary': courseware_summary,
|
|
'credit_course_requirements': credit_course_requirements(course_key, request.user),
|
|
'credit_support_url': CREDIT_SUPPORT_URL,
|
|
'enrollment_mode': enrollment_mode,
|
|
'studio_url': get_studio_url(course, 'settings/grading'),
|
|
'user_timezone': user_timezone,
|
|
'verification_data': verification_data,
|
|
}
|
|
context = self.get_serializer_context()
|
|
context['staff_access'] = bool(has_access(request.user, 'staff', course))
|
|
context['course_key'] = course_key
|
|
serializer = self.get_serializer_class()(data, context=context)
|
|
|
|
return Response(serializer.data)
|