e9a00ffc5a
Also: Render all XModuleDescriptors in the cms the same way Default them to editing raw xml, if there is no specific module for them
138 lines
4.6 KiB
Python
138 lines
4.6 KiB
Python
import json
|
|
import logging
|
|
|
|
from lxml import etree
|
|
|
|
from x_module import XModule
|
|
from mako_module import MakoModuleDescriptor
|
|
from xmodule.progress import Progress
|
|
|
|
log = logging.getLogger("mitx.common.lib.seq_module")
|
|
|
|
# HACK: This shouldn't be hard-coded to two types
|
|
# OBSOLETE: This obsoletes 'type'
|
|
class_priority = ['video', 'problem']
|
|
|
|
class Module(XModule):
|
|
''' Layout module which lays out content in a temporal sequence
|
|
'''
|
|
id_attribute = 'id'
|
|
|
|
def get_state(self):
|
|
return json.dumps({ 'position':self.position })
|
|
|
|
@classmethod
|
|
def get_xml_tags(c):
|
|
obsolete_tags = ["sequential", 'tab']
|
|
modern_tags = ["videosequence"]
|
|
return obsolete_tags + modern_tags
|
|
|
|
def get_html(self):
|
|
self.render()
|
|
return self.content
|
|
|
|
def get_init_js(self):
|
|
self.render()
|
|
return self.init_js
|
|
|
|
def get_destroy_js(self):
|
|
self.render()
|
|
return self.destroy_js
|
|
|
|
def get_progress(self):
|
|
''' Return the total progress, adding total done and total available.
|
|
(assumes that each submodule uses the same "units" for progress.)
|
|
'''
|
|
# TODO: Cache progress or children array?
|
|
children = self.get_children()
|
|
progresses = [child.get_progress() for child in children]
|
|
progress = reduce(Progress.add_counts, progresses)
|
|
return progress
|
|
|
|
def handle_ajax(self, dispatch, get): # TODO: bounds checking
|
|
''' get = request.POST instance '''
|
|
if dispatch=='goto_position':
|
|
self.position = int(get['position'])
|
|
return json.dumps({'success':True})
|
|
raise self.system.exception404
|
|
|
|
def render(self):
|
|
if self.rendered:
|
|
return
|
|
## Returns a set of all types of all sub-children
|
|
child_classes = [set([i.tag for i in e.iter()]) for e in self.xmltree]
|
|
|
|
titles = ["\n".join([i.get("name").strip() for i in e.iter() if i.get("name") is not None]) \
|
|
for e in self.xmltree]
|
|
|
|
children = self.get_children()
|
|
progresses = [child.get_progress() for child in children]
|
|
|
|
self.contents = self.rendered_children()
|
|
|
|
for contents, title, progress in zip(self.contents, titles, progresses):
|
|
contents['title'] = title
|
|
contents['progress_status'] = Progress.to_js_status_str(progress)
|
|
contents['progress_detail'] = Progress.to_js_detail_str(progress)
|
|
|
|
for (content, element_class) in zip(self.contents, child_classes):
|
|
new_class = 'other'
|
|
for c in class_priority:
|
|
if c in element_class:
|
|
new_class = c
|
|
content['type'] = new_class
|
|
|
|
# Split </script> tags -- browsers handle this as end
|
|
# of script, even if it occurs mid-string. Do this after json.dumps()ing
|
|
# so that we can be sure of the quotations being used
|
|
params={'items': json.dumps(self.contents).replace('</script>', '<"+"/script>'),
|
|
'id': self.item_id,
|
|
'position': self.position,
|
|
'titles': titles,
|
|
'tag': self.xmltree.tag}
|
|
|
|
if self.xmltree.tag in ['sequential', 'videosequence']:
|
|
self.content = self.system.render_template('seq_module.html', params)
|
|
if self.xmltree.tag == 'tab':
|
|
self.content = self.system.render_template('tab_module.html', params)
|
|
log.debug("rendered content: %s", content)
|
|
self.rendered = True
|
|
|
|
def __init__(self, system, xml, item_id, state=None):
|
|
XModule.__init__(self, system, xml, item_id, state)
|
|
self.xmltree = etree.fromstring(xml)
|
|
|
|
self.position = 1
|
|
|
|
if state is not None:
|
|
state = json.loads(state)
|
|
if 'position' in state: self.position = int(state['position'])
|
|
|
|
# if position is specified in system, then use that instead
|
|
if system.get('position'):
|
|
self.position = int(system.get('position'))
|
|
|
|
self.rendered = False
|
|
|
|
|
|
class SequenceDescriptor(MakoModuleDescriptor):
|
|
mako_template = 'widgets/sequence-edit.html'
|
|
|
|
@classmethod
|
|
def from_xml(cls, xml_data, system, org=None, course=None):
|
|
xml_object = etree.fromstring(xml_data)
|
|
|
|
children = [
|
|
system.process_xml(etree.tostring(child_module))
|
|
for child_module in xml_object
|
|
]
|
|
|
|
return cls(
|
|
system, {'children': children},
|
|
location=['i4x',
|
|
org,
|
|
course,
|
|
xml_object.tag,
|
|
xml_object.get('name')]
|
|
)
|