96f1397872
This PR addresses the renaming of the contentstore/xblock_services folder to contentstore/xblock_storage_handlers as a follow-up to PR #32282. The renaming is done to prevent naming conflicts with xblock runtime services and to make the purpose of the files more understandable. The file xblock_service.py has been renamed to view_handlers.py to better reflect its functionality. Justification and Future Refactoring Outlook: The xblock_storage_handlers folder contains service methods that implement the business logic for view endpoints located in contentstore/views/block.py. It is renamed to xblock_storage_handlers to reflect its responsibility of handling storage-related operations of xblocks, such as creation, retrieval, and deletion. The view_handlers.py file includes business methods called by the view endpoints. These methods, such as handle_xblock, delete_orphans, etc., interact with the required modulestore methods, handle any errors, and aggregate and serialize data for the response. The term 'handler' in the context of 'view_handlers.py' represents methods that facilitate business logic for view endpoints. It is critical to note the distinction between these 'handler methods' and the xblock_handler method. The xblock_handler is a view endpoint itself, residing in contentstore/views/block.py, and is well known in this context. Although its name might suggest otherwise, it is not a handler in the sense of the 'handler methods' we've defined in 'view_handlers.py'. To maintain consistency with existing naming conventions, it remains as xblock_handler.
283 lines
11 KiB
Python
283 lines
11 KiB
Python
"""
|
|
Entrance Exams view block -- handles all requests related to entrance exam management via Studio
|
|
Intended to be utilized as an AJAX callback handler, versus a proper view/screen
|
|
"""
|
|
|
|
|
|
import logging
|
|
from functools import wraps
|
|
|
|
from django.conf import settings
|
|
from django.contrib.auth.decorators import login_required
|
|
from django.http import HttpResponse, HttpResponseBadRequest
|
|
from django.utils.translation import gettext as _
|
|
from django.views.decorators.csrf import ensure_csrf_cookie
|
|
from opaque_keys import InvalidKeyError
|
|
from opaque_keys.edx.keys import CourseKey, UsageKey
|
|
|
|
from cms.djangoapps.models.settings.course_metadata import CourseMetadata
|
|
from common.djangoapps.student.auth import has_course_author_access
|
|
from common.djangoapps.util import milestones_helpers
|
|
from openedx.core import toggles as core_toggles
|
|
from openedx.core.djangolib.js_utils import dump_js_escaped_json
|
|
from xmodule.modulestore.django import modulestore # lint-amnesty, pylint: disable=wrong-import-order
|
|
from xmodule.modulestore.exceptions import ItemNotFoundError # lint-amnesty, pylint: disable=wrong-import-order
|
|
|
|
from ..helpers import remove_entrance_exam_graders
|
|
from cms.djangoapps.contentstore.xblock_storage_handlers.create_xblock import create_xblock
|
|
from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import delete_item
|
|
|
|
__all__ = ['entrance_exam', ]
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
def _get_default_entrance_exam_minimum_pct():
|
|
"""
|
|
Helper method to return the default value from configuration
|
|
Converts integer values to decimals, since that what we use internally
|
|
"""
|
|
entrance_exam_minimum_score_pct = float(settings.ENTRANCE_EXAM_MIN_SCORE_PCT)
|
|
if entrance_exam_minimum_score_pct.is_integer():
|
|
entrance_exam_minimum_score_pct = entrance_exam_minimum_score_pct / 100
|
|
return entrance_exam_minimum_score_pct
|
|
|
|
|
|
def check_entrance_exams_enabled(view_func):
|
|
"""
|
|
Ensure the entrance exams feature is turned on. Return an HTTP 400 code if not.
|
|
"""
|
|
def _decorator(request, *args, **kwargs):
|
|
# Deny access if the entrance exam feature is disabled
|
|
if not core_toggles.ENTRANCE_EXAMS.is_enabled():
|
|
return HttpResponseBadRequest()
|
|
return view_func(request, *args, **kwargs)
|
|
return wraps(view_func)(_decorator)
|
|
|
|
|
|
@login_required
|
|
@ensure_csrf_cookie
|
|
@check_entrance_exams_enabled
|
|
def entrance_exam(request, course_key_string):
|
|
"""
|
|
The restful handler for entrance exams.
|
|
It allows retrieval of all the assets (as an HTML page), as well as uploading new assets,
|
|
deleting assets, and changing the "locked" state of an asset.
|
|
|
|
GET
|
|
Retrieves the entrance exam block (metadata) for the specified course
|
|
POST
|
|
Adds an entrance exam block to the specified course.
|
|
DELETE
|
|
Removes the entrance exam from the course
|
|
"""
|
|
course_key = CourseKey.from_string(course_key_string)
|
|
|
|
# Deny access if the user is valid, but they lack the proper object access privileges
|
|
if not has_course_author_access(request.user, course_key):
|
|
return HttpResponse(status=403)
|
|
|
|
# Retrieve the entrance exam block for the specified course (returns 404 if none found)
|
|
if request.method == 'GET':
|
|
return _get_entrance_exam(request, course_key)
|
|
|
|
# Create a new entrance exam for the specified course (returns 201 if created)
|
|
elif request.method == 'POST':
|
|
response_format = request.POST.get('format', 'html')
|
|
http_accept = request.META.get('http_accept')
|
|
if response_format == 'json' or 'application/json' in http_accept:
|
|
ee_min_score = request.POST.get('entrance_exam_minimum_score_pct', None)
|
|
|
|
# if request contains empty value or none then save the default one.
|
|
entrance_exam_minimum_score_pct = _get_default_entrance_exam_minimum_pct()
|
|
if ee_min_score != '' and ee_min_score is not None:
|
|
entrance_exam_minimum_score_pct = float(ee_min_score)
|
|
return create_entrance_exam(request, course_key, entrance_exam_minimum_score_pct)
|
|
return HttpResponse(status=400)
|
|
|
|
# Remove the entrance exam block for the specified course (returns 204 regardless of existence)
|
|
elif request.method == 'DELETE':
|
|
return delete_entrance_exam(request, course_key)
|
|
|
|
# No other HTTP verbs/methods are supported at this time
|
|
else:
|
|
return HttpResponse(status=405)
|
|
|
|
|
|
@check_entrance_exams_enabled
|
|
def create_entrance_exam(request, course_key, entrance_exam_minimum_score_pct):
|
|
"""
|
|
api method to create an entrance exam.
|
|
First clean out any old entrance exams.
|
|
"""
|
|
_delete_entrance_exam(request, course_key)
|
|
return _create_entrance_exam(
|
|
request=request,
|
|
course_key=course_key,
|
|
entrance_exam_minimum_score_pct=entrance_exam_minimum_score_pct
|
|
)
|
|
|
|
|
|
def _create_entrance_exam(request, course_key, entrance_exam_minimum_score_pct=None):
|
|
"""
|
|
Internal workflow operation to create an entrance exam
|
|
"""
|
|
# Provide a default value for the minimum score percent if nothing specified
|
|
if entrance_exam_minimum_score_pct is None:
|
|
entrance_exam_minimum_score_pct = _get_default_entrance_exam_minimum_pct()
|
|
|
|
# Confirm the course exists
|
|
course = modulestore().get_course(course_key)
|
|
if course is None:
|
|
return HttpResponse(status=400)
|
|
|
|
# Create the entrance exam item (currently it's just a chapter)
|
|
parent_locator = str(course.location)
|
|
created_block = create_xblock(
|
|
parent_locator=parent_locator,
|
|
user=request.user,
|
|
category='chapter',
|
|
display_name=_('Entrance Exam'),
|
|
is_entrance_exam=True
|
|
)
|
|
|
|
# Set the entrance exam metadata flags for this course
|
|
# Reload the course so we don't overwrite the new child reference
|
|
course = modulestore().get_course(course_key)
|
|
metadata = {
|
|
'entrance_exam_enabled': True,
|
|
'entrance_exam_minimum_score_pct': entrance_exam_minimum_score_pct,
|
|
'entrance_exam_id': str(created_block.location),
|
|
}
|
|
CourseMetadata.update_from_dict(metadata, course, request.user)
|
|
|
|
# Create the entrance exam section item.
|
|
create_xblock(
|
|
parent_locator=str(created_block.location),
|
|
user=request.user,
|
|
category='sequential',
|
|
display_name=_('Entrance Exam - Subsection')
|
|
)
|
|
add_entrance_exam_milestone(course.id, created_block)
|
|
|
|
return HttpResponse(status=201)
|
|
|
|
|
|
def _get_entrance_exam(request, course_key):
|
|
"""
|
|
Internal workflow operation to retrieve an entrance exam
|
|
"""
|
|
course = modulestore().get_course(course_key)
|
|
if course is None:
|
|
return HttpResponse(status=400)
|
|
if not course.entrance_exam_id:
|
|
return HttpResponse(status=404)
|
|
try:
|
|
exam_key = UsageKey.from_string(course.entrance_exam_id)
|
|
except InvalidKeyError:
|
|
return HttpResponse(status=404)
|
|
try:
|
|
exam_block = modulestore().get_item(exam_key)
|
|
return HttpResponse( # lint-amnesty, pylint: disable=http-response-with-content-type-json
|
|
dump_js_escaped_json({'locator': str(exam_block.location)}),
|
|
status=200, content_type='application/json')
|
|
except ItemNotFoundError:
|
|
return HttpResponse(status=404)
|
|
|
|
|
|
@check_entrance_exams_enabled
|
|
def update_entrance_exam(request, course_key, exam_data):
|
|
"""
|
|
Operation to update course fields pertaining to entrance exams
|
|
The update operation is not currently exposed directly via the API
|
|
Because the operation is not exposed directly, we do not return a 200 response
|
|
But we do return a 400 in the error case because the workflow is executed in a request context
|
|
"""
|
|
course = modulestore().get_course(course_key)
|
|
if course:
|
|
metadata = exam_data
|
|
CourseMetadata.update_from_dict(metadata, course, request.user)
|
|
|
|
|
|
@check_entrance_exams_enabled
|
|
def delete_entrance_exam(request, course_key):
|
|
"""
|
|
api method to delete an entrance exam
|
|
"""
|
|
return _delete_entrance_exam(request=request, course_key=course_key)
|
|
|
|
|
|
def _delete_entrance_exam(request, course_key):
|
|
"""
|
|
Internal workflow operation to remove an entrance exam
|
|
"""
|
|
store = modulestore()
|
|
course = store.get_course(course_key)
|
|
if course is None:
|
|
return HttpResponse(status=400)
|
|
|
|
remove_entrance_exam_milestone_reference(request, course_key)
|
|
|
|
# Reset the entrance exam flags on the course
|
|
# Reload the course so we have the latest state
|
|
course = store.get_course(course_key)
|
|
if course.entrance_exam_id:
|
|
metadata = {
|
|
'entrance_exam_enabled': False,
|
|
'entrance_exam_minimum_score_pct': None,
|
|
'entrance_exam_id': None,
|
|
}
|
|
CourseMetadata.update_from_dict(metadata, course, request.user)
|
|
|
|
# Clean up any pre-existing entrance exam graders
|
|
remove_entrance_exam_graders(course_key, request.user)
|
|
|
|
return HttpResponse(status=204)
|
|
|
|
|
|
def add_entrance_exam_milestone(course_id, x_block): # lint-amnesty, pylint: disable=missing-function-docstring
|
|
# Add an entrance exam milestone if one does not already exist for given xBlock
|
|
# As this is a standalone method for entrance exam, We should check that given xBlock should be an entrance exam.
|
|
if x_block.is_entrance_exam:
|
|
namespace_choices = milestones_helpers.get_namespace_choices()
|
|
milestone_namespace = milestones_helpers.generate_milestone_namespace(
|
|
namespace_choices.get('ENTRANCE_EXAM'),
|
|
course_id
|
|
)
|
|
milestones = milestones_helpers.get_milestones(milestone_namespace)
|
|
if len(milestones): # lint-amnesty, pylint: disable=len-as-condition
|
|
milestone = milestones[0]
|
|
else:
|
|
description = f'Autogenerated during {str(course_id)} entrance exam creation.'
|
|
milestone = milestones_helpers.add_milestone({
|
|
'name': _('Completed Course Entrance Exam'),
|
|
'namespace': milestone_namespace,
|
|
'description': description
|
|
})
|
|
relationship_types = milestones_helpers.get_milestone_relationship_types()
|
|
milestones_helpers.add_course_milestone(
|
|
str(course_id),
|
|
relationship_types['REQUIRES'],
|
|
milestone
|
|
)
|
|
milestones_helpers.add_course_content_milestone(
|
|
str(course_id),
|
|
str(x_block.location),
|
|
relationship_types['FULFILLS'],
|
|
milestone
|
|
)
|
|
|
|
|
|
def remove_entrance_exam_milestone_reference(request, course_key):
|
|
"""
|
|
Remove content reference for entrance exam.
|
|
"""
|
|
course_children = modulestore().get_items(
|
|
course_key,
|
|
qualifiers={'category': 'chapter'}
|
|
)
|
|
for course_child in course_children:
|
|
if course_child.is_entrance_exam:
|
|
delete_item(request, course_child.scope_ids.usage_id)
|
|
milestones_helpers.remove_content_references(str(course_child.scope_ids.usage_id))
|