153 lines
5.6 KiB
Python
153 lines
5.6 KiB
Python
"""
|
|
VerticalBlock - an XBlock which renders its children in a column.
|
|
"""
|
|
import logging
|
|
from copy import copy
|
|
from lxml import etree
|
|
from xblock.core import XBlock
|
|
from xblock.fragment import Fragment
|
|
from xmodule.mako_module import MakoTemplateBlockBase
|
|
from xmodule.progress import Progress
|
|
from xmodule.seq_module import SequenceFields
|
|
from xmodule.studio_editable import StudioEditableBlock
|
|
from xmodule.x_module import STUDENT_VIEW, XModuleFields
|
|
from xmodule.xml_module import XmlParserMixin
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
# HACK: This shouldn't be hard-coded to two types
|
|
# OBSOLETE: This obsoletes 'type'
|
|
CLASS_PRIORITY = ['video', 'problem']
|
|
|
|
|
|
class VerticalBlock(SequenceFields, XModuleFields, StudioEditableBlock, XmlParserMixin, MakoTemplateBlockBase, XBlock):
|
|
"""
|
|
Layout XBlock for rendering subblocks vertically.
|
|
"""
|
|
mako_template = 'widgets/sequence-edit.html'
|
|
js_module_name = "VerticalBlock"
|
|
|
|
has_children = True
|
|
|
|
show_in_read_only_mode = True
|
|
|
|
def student_view(self, context):
|
|
"""
|
|
Renders the student view of the block in the LMS.
|
|
"""
|
|
fragment = Fragment()
|
|
contents = []
|
|
|
|
child_context = {} if not context else copy(context)
|
|
child_context['child_of_vertical'] = True
|
|
|
|
# pylint: disable=no-member
|
|
for child in self.get_display_items():
|
|
rendered_child = child.render(STUDENT_VIEW, child_context)
|
|
fragment.add_frag_resources(rendered_child)
|
|
|
|
contents.append({
|
|
'id': child.location.to_deprecated_string(),
|
|
'content': rendered_child.content
|
|
})
|
|
|
|
fragment.add_content(self.system.render_template('vert_module.html', {
|
|
'items': contents,
|
|
'xblock_context': context,
|
|
}))
|
|
return fragment
|
|
|
|
def author_view(self, context):
|
|
"""
|
|
Renders the Studio preview view, which supports drag and drop.
|
|
"""
|
|
fragment = Fragment()
|
|
root_xblock = context.get('root_xblock')
|
|
is_root = root_xblock and root_xblock.location == self.location # pylint: disable=no-member
|
|
|
|
# For the container page we want the full drag-and-drop, but for unit pages we want
|
|
# a more concise version that appears alongside the "View =>" link-- unless it is
|
|
# the unit page and the vertical being rendered is itself the unit vertical (is_root == True).
|
|
if is_root or not context.get('is_unit_page'):
|
|
self.render_children(context, fragment, can_reorder=True, can_add=True)
|
|
return fragment
|
|
|
|
def get_progress(self):
|
|
"""
|
|
Returns the progress on this block and all children.
|
|
"""
|
|
# TODO: Cache progress or children array?
|
|
children = self.get_children()
|
|
progresses = [child.get_progress() for child in children]
|
|
progress = reduce(Progress.add_counts, progresses, None)
|
|
return progress
|
|
|
|
def get_icon_class(self):
|
|
"""
|
|
Returns the highest priority icon class.
|
|
"""
|
|
child_classes = set(child.get_icon_class() for child in self.get_children())
|
|
new_class = 'other'
|
|
for higher_class in CLASS_PRIORITY:
|
|
if higher_class in child_classes:
|
|
new_class = higher_class
|
|
return new_class
|
|
|
|
@classmethod
|
|
def definition_from_xml(cls, xml_object, system):
|
|
children = []
|
|
for child in xml_object:
|
|
try:
|
|
child_block = system.process_xml(etree.tostring(child, encoding='unicode')) # pylint: disable=no-member
|
|
children.append(child_block.scope_ids.usage_id)
|
|
except Exception as exc: # pylint: disable=broad-except
|
|
log.exception("Unable to load child when parsing Vertical. Continuing...")
|
|
if system.error_tracker is not None:
|
|
system.error_tracker(u"ERROR: {0}".format(exc))
|
|
continue
|
|
return {}, children
|
|
|
|
def definition_to_xml(self, resource_fs):
|
|
xml_object = etree.Element('vertical') # pylint: disable=no-member
|
|
for child in self.get_children():
|
|
self.runtime.add_block_as_child_node(child, xml_object)
|
|
return xml_object
|
|
|
|
@property
|
|
def non_editable_metadata_fields(self):
|
|
"""
|
|
Gather all fields which can't be edited.
|
|
"""
|
|
non_editable_fields = super(VerticalBlock, self).non_editable_metadata_fields
|
|
non_editable_fields.extend([
|
|
self.fields['due'],
|
|
])
|
|
return non_editable_fields
|
|
|
|
def studio_view(self, context):
|
|
fragment = super(VerticalBlock, self).studio_view(context)
|
|
# This continues to use the old XModuleDescriptor javascript code to enabled studio editing.
|
|
# TODO: Remove this when studio better supports editing of pure XBlocks.
|
|
fragment.add_javascript('VerticalBlock = XModule.Descriptor;')
|
|
return fragment
|
|
|
|
def index_dictionary(self):
|
|
"""
|
|
Return dictionary prepared with module content and type for indexing.
|
|
"""
|
|
# return key/value fields in a Python dict object
|
|
# values may be numeric / string or dict
|
|
# default implementation is an empty dict
|
|
xblock_body = super(VerticalBlock, self).index_dictionary()
|
|
index_body = {
|
|
"display_name": self.display_name,
|
|
}
|
|
if "content" in xblock_body:
|
|
xblock_body["content"].update(index_body)
|
|
else:
|
|
xblock_body["content"] = index_body
|
|
# We use "Sequence" for sequentials and verticals
|
|
xblock_body["content_type"] = "Sequence"
|
|
|
|
return xblock_body
|