383 lines
15 KiB
Python
383 lines
15 KiB
Python
"""Conditional module is the xmodule, which you can use for disabling
|
|
some xmodules by conditions.
|
|
"""
|
|
|
|
from __future__ import absolute_import
|
|
|
|
import json
|
|
import logging
|
|
|
|
import six
|
|
from lazy import lazy
|
|
from lxml import etree
|
|
from opaque_keys.edx.locator import BlockUsageLocator
|
|
from pkg_resources import resource_string
|
|
from six import text_type
|
|
from web_fragments.fragment import Fragment
|
|
from xblock.fields import ReferenceList, Scope, String
|
|
|
|
from openedx.core.djangolib.markup import HTML, Text
|
|
from xmodule.modulestore.exceptions import ItemNotFoundError
|
|
from xmodule.seq_module import SequenceDescriptor
|
|
from xmodule.studio_editable import StudioEditableDescriptor, StudioEditableModule
|
|
from xmodule.validation import StudioValidation, StudioValidationMessage
|
|
from xmodule.x_module import STUDENT_VIEW, XModule
|
|
|
|
log = logging.getLogger('edx.' + __name__)
|
|
|
|
# Make '_' a no-op so we can scrape strings
|
|
_ = lambda text: text
|
|
|
|
|
|
class ConditionalFields(object):
|
|
has_children = True
|
|
display_name = String(
|
|
display_name=_("Display Name"),
|
|
help=_("The display name for this component."),
|
|
scope=Scope.settings,
|
|
default=_('Conditional')
|
|
)
|
|
|
|
show_tag_list = ReferenceList(
|
|
help=_("List of urls of children that are references to external modules"),
|
|
scope=Scope.content
|
|
)
|
|
|
|
sources_list = ReferenceList(
|
|
display_name=_("Source Components"),
|
|
help=_("The component location IDs of all source components that are used to determine whether a learner is "
|
|
"shown the content of this conditional module. Copy the component location ID of a component from its "
|
|
"Settings dialog in Studio."),
|
|
scope=Scope.content
|
|
)
|
|
|
|
conditional_attr = String(
|
|
display_name=_("Conditional Attribute"),
|
|
help=_("The attribute of the source components that determines whether a learner is shown the content of this "
|
|
"conditional module."),
|
|
scope=Scope.content,
|
|
default='correct',
|
|
values=lambda: [{'display_name': xml_attr, 'value': xml_attr}
|
|
for xml_attr in ConditionalModule.conditions_map.keys()]
|
|
)
|
|
|
|
conditional_value = String(
|
|
display_name=_("Conditional Value"),
|
|
help=_("The value that the conditional attribute of the source components must match before a learner is shown "
|
|
"the content of this conditional module."),
|
|
scope=Scope.content,
|
|
default='True'
|
|
)
|
|
|
|
conditional_message = String(
|
|
display_name=_("Blocked Content Message"),
|
|
help=_("The message that is shown to learners when not all conditions are met to show the content of this "
|
|
"conditional module. Include {link} in the text of your message to give learners a direct link to "
|
|
"required units. For example, 'You must complete {link} before you can access this unit'."),
|
|
scope=Scope.content,
|
|
default=_('You must complete {link} before you can access this unit.')
|
|
)
|
|
|
|
|
|
class ConditionalModule(ConditionalFields, XModule, StudioEditableModule):
|
|
"""
|
|
Blocks child module from showing unless certain conditions are met.
|
|
|
|
Example:
|
|
|
|
<conditional sources="i4x://.../problem_1; i4x://.../problem_2" completed="True">
|
|
<show sources="i4x://.../test_6; i4x://.../Avi_resources"/>
|
|
<video url_name="secret_video" />
|
|
</conditional>
|
|
|
|
<conditional> tag attributes:
|
|
sources - location id of required modules, separated by ';'
|
|
|
|
submitted - map to `is_submitted` module method.
|
|
(pressing RESET button makes this function to return False.)
|
|
|
|
attempted - map to `is_attempted` module method
|
|
correct - map to `is_correct` module method
|
|
poll_answer - map to `poll_answer` module attribute
|
|
voted - map to `voted` module attribute
|
|
|
|
<show> tag attributes:
|
|
sources - location id of required modules, separated by ';'
|
|
|
|
You can add you own rules for <conditional> tag, like
|
|
"completed", "attempted" etc. To do that yo must extend
|
|
`ConditionalModule.conditions_map` variable and add pair:
|
|
my_attr: my_property/my_method
|
|
|
|
After that you can use it:
|
|
<conditional my_attr="some value" ...>
|
|
...
|
|
</conditional>
|
|
|
|
And my_property/my_method will be called for required modules.
|
|
|
|
"""
|
|
|
|
js = {
|
|
'js': [
|
|
resource_string(__name__, 'js/src/conditional/display.js'),
|
|
resource_string(__name__, 'js/src/javascript_loader.js'),
|
|
resource_string(__name__, 'js/src/collapsible.js'),
|
|
]
|
|
}
|
|
|
|
js_module_name = "Conditional"
|
|
css = {'scss': [resource_string(__name__, 'css/capa/display.scss')]}
|
|
|
|
# Map
|
|
# key: <tag attribute in xml>
|
|
# value: <name of module attribute>
|
|
conditions_map = {
|
|
'poll_answer': 'poll_answer', # poll_question attr
|
|
|
|
# problem was submitted (it can be wrong)
|
|
# if student will press reset button after that,
|
|
# state will be reverted
|
|
'submitted': 'is_submitted', # capa_problem attr
|
|
|
|
# if student attempted problem
|
|
'attempted': 'is_attempted', # capa_problem attr
|
|
|
|
# if problem is full points
|
|
'correct': 'is_correct',
|
|
|
|
'voted': 'voted' # poll_question attr
|
|
}
|
|
|
|
@lazy
|
|
def required_modules(self):
|
|
return [self.system.get_module(descriptor) for
|
|
descriptor in self.descriptor.get_required_module_descriptors()]
|
|
|
|
def is_condition_satisfied(self):
|
|
attr_name = self.conditions_map[self.conditional_attr]
|
|
|
|
if self.conditional_value and self.required_modules:
|
|
for module in self.required_modules:
|
|
if not hasattr(module, attr_name):
|
|
# We don't throw an exception here because it is possible for
|
|
# the descriptor of a required module to have a property but
|
|
# for the resulting module to be a (flavor of) ErrorModule.
|
|
# So just log and return false.
|
|
if module is not None:
|
|
# We do not want to log when module is None, and it is when requester
|
|
# does not have access to the requested required module.
|
|
log.warn('Error in conditional module: \
|
|
required module {module} has no {module_attr}'.format(module=module, module_attr=attr_name))
|
|
return False
|
|
|
|
attr = getattr(module, attr_name)
|
|
if callable(attr):
|
|
attr = attr()
|
|
|
|
if self.conditional_value != str(attr):
|
|
break
|
|
else:
|
|
return True
|
|
return False
|
|
|
|
def get_html(self):
|
|
# Calculate html ids of dependencies
|
|
self.required_html_ids = [descriptor.location.html_id() for
|
|
descriptor in self.descriptor.get_required_module_descriptors()]
|
|
|
|
return self.system.render_template('conditional_ajax.html', {
|
|
'element_id': self.location.html_id(),
|
|
'ajax_url': self.system.ajax_url,
|
|
'depends': ';'.join(self.required_html_ids)
|
|
})
|
|
|
|
def author_view(self, context):
|
|
"""
|
|
Renders the Studio preview by rendering each child so that they can all be seen and edited.
|
|
"""
|
|
fragment = Fragment()
|
|
root_xblock = context.get('root_xblock')
|
|
is_root = root_xblock and root_xblock.location == self.location
|
|
if is_root:
|
|
# User has clicked the "View" link. Show a preview of all possible children:
|
|
self.render_children(context, fragment, can_reorder=True, can_add=True)
|
|
# else: When shown on a unit page, don't show any sort of preview -
|
|
# just the status of this block in the validation area.
|
|
|
|
return fragment
|
|
|
|
def handle_ajax(self, _dispatch, _data):
|
|
"""This is called by courseware.moduleodule_render, to handle
|
|
an AJAX call.
|
|
"""
|
|
if not self.is_condition_satisfied():
|
|
context = {'module': self,
|
|
'message': self.conditional_message}
|
|
html = self.system.render_template('conditional_module.html',
|
|
context)
|
|
return json.dumps({'fragments': [{'content': html}], 'message': bool(self.conditional_message)})
|
|
|
|
fragments = [child.render(STUDENT_VIEW).to_dict() for child in self.get_display_items()]
|
|
|
|
return json.dumps({'fragments': fragments})
|
|
|
|
def get_icon_class(self):
|
|
new_class = 'other'
|
|
# HACK: This shouldn't be hard-coded to two types
|
|
# OBSOLETE: This obsoletes 'type'
|
|
class_priority = ['video', 'problem']
|
|
|
|
child_classes = [self.system.get_module(child_descriptor).get_icon_class()
|
|
for child_descriptor in self.descriptor.get_children()]
|
|
for c in class_priority:
|
|
if c in child_classes:
|
|
new_class = c
|
|
return new_class
|
|
|
|
def validate(self):
|
|
"""
|
|
Message for either error or warning validation message/s.
|
|
|
|
Returns message and type. Priority given to error type message.
|
|
"""
|
|
return self.descriptor.validate()
|
|
|
|
|
|
class ConditionalDescriptor(ConditionalFields, SequenceDescriptor, StudioEditableDescriptor):
|
|
"""Descriptor for conditional xmodule."""
|
|
_tag_name = 'conditional'
|
|
|
|
module_class = ConditionalModule
|
|
|
|
resources_dir = None
|
|
|
|
filename_extension = "xml"
|
|
|
|
has_score = False
|
|
|
|
show_in_read_only_mode = True
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""
|
|
Create an instance of the conditional module.
|
|
"""
|
|
super(ConditionalDescriptor, self).__init__(*args, **kwargs)
|
|
|
|
# Convert sources xml_attribute to a ReferenceList field type so Location/Locator
|
|
# substitution can be done.
|
|
if not self.sources_list:
|
|
if 'sources' in self.xml_attributes and isinstance(self.xml_attributes['sources'], six.string_types):
|
|
self.sources_list = [
|
|
# TODO: it is not clear why we are replacing the run here (which actually is a no-op
|
|
# for old-style course locators. However, this is the implementation of
|
|
# CourseLocator.make_usage_key_from_deprecated_string, which was previously
|
|
# being called in this location.
|
|
BlockUsageLocator.from_string(item).replace(run=self.location.course_key.run)
|
|
for item in ConditionalDescriptor.parse_sources(self.xml_attributes)
|
|
]
|
|
|
|
@staticmethod
|
|
def parse_sources(xml_element):
|
|
""" Parse xml_element 'sources' attr and return a list of location strings. """
|
|
sources = xml_element.get('sources')
|
|
if sources:
|
|
return [location.strip() for location in sources.split(';')]
|
|
|
|
def get_required_module_descriptors(self):
|
|
"""Returns a list of XModuleDescriptor instances upon
|
|
which this module depends.
|
|
"""
|
|
descriptors = []
|
|
for location in self.sources_list:
|
|
try:
|
|
descriptor = self.system.load_item(location)
|
|
descriptors.append(descriptor)
|
|
except ItemNotFoundError:
|
|
msg = "Invalid module by location."
|
|
log.exception(msg)
|
|
self.system.error_tracker(msg)
|
|
|
|
return descriptors
|
|
|
|
@classmethod
|
|
def definition_from_xml(cls, xml_object, system):
|
|
children = []
|
|
show_tag_list = []
|
|
definition = {}
|
|
for conditional_attr in six.iterkeys(ConditionalModule.conditions_map):
|
|
conditional_value = xml_object.get(conditional_attr)
|
|
if conditional_value is not None:
|
|
definition.update({
|
|
'conditional_attr': conditional_attr,
|
|
'conditional_value': str(conditional_value),
|
|
})
|
|
for child in xml_object:
|
|
if child.tag == 'show':
|
|
locations = ConditionalDescriptor.parse_sources(child)
|
|
for location in locations:
|
|
children.append(location)
|
|
show_tag_list.append(location)
|
|
else:
|
|
try:
|
|
descriptor = system.process_xml(etree.tostring(child, encoding='unicode'))
|
|
children.append(descriptor.scope_ids.usage_id)
|
|
except:
|
|
msg = "Unable to load child when parsing Conditional."
|
|
log.exception(msg)
|
|
system.error_tracker(msg)
|
|
definition.update({
|
|
'show_tag_list': show_tag_list,
|
|
'conditional_message': xml_object.get('message', '')
|
|
})
|
|
return definition, children
|
|
|
|
def definition_to_xml(self, resource_fs):
|
|
xml_object = etree.Element(self._tag_name)
|
|
for child in self.get_children():
|
|
if child.location not in self.show_tag_list:
|
|
self.runtime.add_block_as_child_node(child, xml_object)
|
|
|
|
if self.show_tag_list:
|
|
show_str = HTML(u'<show sources="{sources}" />').format(
|
|
sources=Text(';'.join(text_type(location) for location in self.show_tag_list)))
|
|
xml_object.append(etree.fromstring(show_str))
|
|
|
|
# Overwrite the original sources attribute with the value from sources_list, as
|
|
# Locations may have been changed to Locators.
|
|
stringified_sources_list = [text_type(loc) for loc in self.sources_list]
|
|
self.xml_attributes['sources'] = ';'.join(stringified_sources_list)
|
|
self.xml_attributes[self.conditional_attr] = self.conditional_value
|
|
self.xml_attributes['message'] = self.conditional_message
|
|
return xml_object
|
|
|
|
def validate(self):
|
|
validation = super(ConditionalDescriptor, self).validate()
|
|
if not self.sources_list:
|
|
conditional_validation = StudioValidation(self.location)
|
|
conditional_validation.add(
|
|
StudioValidationMessage(
|
|
StudioValidationMessage.NOT_CONFIGURED,
|
|
_(u"This component has no source components configured yet."),
|
|
action_class='edit-button',
|
|
action_label=_(u"Configure list of sources")
|
|
)
|
|
)
|
|
validation = StudioValidation.copy(validation)
|
|
validation.summary = conditional_validation.messages[0]
|
|
return validation
|
|
|
|
@property
|
|
def non_editable_metadata_fields(self):
|
|
non_editable_fields = super(ConditionalDescriptor, self).non_editable_metadata_fields
|
|
non_editable_fields.extend([
|
|
ConditionalDescriptor.due,
|
|
ConditionalDescriptor.is_practice_exam,
|
|
ConditionalDescriptor.is_proctored_enabled,
|
|
ConditionalDescriptor.is_time_limited,
|
|
ConditionalDescriptor.default_time_limit_minutes,
|
|
ConditionalDescriptor.show_tag_list,
|
|
ConditionalDescriptor.exam_review_rules,
|
|
])
|
|
return non_editable_fields
|