99220e0967
This lets the user import a block from a blockstore-based content library into a (modulestore based) course, by copying the block into the course.
128 lines
5.1 KiB
Python
128 lines
5.1 KiB
Python
"""
|
|
Library Sourced Content XBlock
|
|
"""
|
|
import logging
|
|
|
|
from copy import copy
|
|
from web_fragments.fragment import Fragment
|
|
from xblock.core import XBlock
|
|
from xblock.fields import Scope, String
|
|
from xblockutils.resources import ResourceLoader
|
|
from xblockutils.studio_editable import StudioEditableXBlockMixin
|
|
from webob import Response
|
|
|
|
from cms.lib.xblock.runtime import handler_url
|
|
from xmodule.studio_editable import StudioEditableBlock as EditableChildrenMixin
|
|
from xmodule.validation import StudioValidation, StudioValidationMessage
|
|
|
|
log = logging.getLogger(__name__)
|
|
loader = ResourceLoader(__name__)
|
|
|
|
# Make '_' a no-op so we can scrape strings. Using lambda instead of
|
|
# `django.utils.translation.ugettext_noop` because Django cannot be imported in this file
|
|
_ = lambda text: text
|
|
|
|
|
|
@XBlock.wants('library_tools') # Only needed in studio
|
|
class LibrarySourcedBlock(StudioEditableXBlockMixin, EditableChildrenMixin, XBlock):
|
|
"""
|
|
Library Sourced Content XBlock
|
|
|
|
Allows copying specific XBlocks from a Blockstore-based content library into
|
|
a modulestore-based course. The selected blocks are copied and become
|
|
children of this block.
|
|
|
|
When we implement support for Blockstore-based courses, it's expected we'll
|
|
use a different mechanism for importing library content into a course.
|
|
"""
|
|
display_name = String(
|
|
help=_("The display name for this component."),
|
|
default="Library Sourced Content",
|
|
display_name=_("Display Name"),
|
|
scope=Scope.content,
|
|
)
|
|
source_block_id = String(
|
|
display_name=_("Library Block"),
|
|
help=_("Enter the IDs of the library XBlock that you wish to use."),
|
|
scope=Scope.content,
|
|
)
|
|
editable_fields = ("display_name", "source_block_id")
|
|
has_children = True
|
|
has_author_view = True
|
|
resources_dir = 'assets/library_source_block'
|
|
|
|
def __str__(self):
|
|
return "LibrarySourcedBlock: {}".format(self.display_name)
|
|
|
|
def author_view(self, context):
|
|
"""
|
|
Renders the Studio preview view.
|
|
"""
|
|
fragment = Fragment()
|
|
root_xblock = context.get('root_xblock')
|
|
is_root = root_xblock and root_xblock.location == self.location # pylint: disable=no-member
|
|
# If block ID is not defined, ask user for the component ID in the author_view itself.
|
|
# We don't display the editor if is_root as that page should represent the student_view without any ambiguity
|
|
if not self.source_block_id and not is_root:
|
|
fragment.add_content(
|
|
loader.render_django_template('templates/library-sourced-block-author-view.html', {
|
|
'save_url': handler_url(self, 'submit_studio_edits')
|
|
})
|
|
)
|
|
fragment.add_javascript_url(self.runtime.local_resource_url(self, 'public/js/library_source_block.js'))
|
|
fragment.initialize_js('LibrarySourceBlockAuthorView')
|
|
return fragment
|
|
|
|
context = {} if not context else copy(context) # Isolate context - without this there are weird bugs in Studio
|
|
# EditableChildrenMixin.render_children will render HTML that allows instructors to make edits to the children
|
|
context['can_move'] = False
|
|
self.render_children(context, fragment, can_reorder=False, can_add=False)
|
|
return fragment
|
|
|
|
def student_view(self, context):
|
|
"""
|
|
Renders the view that learners see.
|
|
"""
|
|
result = Fragment()
|
|
child_frags = self.runtime.render_children(self, context=context)
|
|
result.add_resources(child_frags)
|
|
result.add_content('<div class="library-sourced-content">')
|
|
for frag in child_frags:
|
|
result.add_content(frag.content)
|
|
result.add_content('</div>')
|
|
return result
|
|
|
|
def validate(self):
|
|
"""
|
|
Validates the state of this library_sourced_xblock Instance. This is the override of the general XBlock method,
|
|
and it will also ask its superclass to validate.
|
|
"""
|
|
validation = super().validate()
|
|
validation = StudioValidation.copy(validation)
|
|
|
|
if not self.source_block_id:
|
|
validation.set_summary(
|
|
StudioValidationMessage(
|
|
StudioValidationMessage.NOT_CONFIGURED,
|
|
_(u"No XBlock has been configured for this component. Enter the target ID below or in the editor"),
|
|
action_class='edit-button',
|
|
action_label=_(u"Open Editor")
|
|
)
|
|
)
|
|
return validation
|
|
|
|
@XBlock.handler
|
|
def submit_studio_edits(self, data, suffix=''):
|
|
"""
|
|
Save changes to this block, applying edits made in Studio.
|
|
"""
|
|
response = super().submit_studio_edits(data, suffix)
|
|
# Replace our current children with the latest ones from the libraries.
|
|
lib_tools = self.runtime.service(self, 'library_tools')
|
|
try:
|
|
lib_tools.import_from_blockstore(self, self.source_block_id)
|
|
except Exception as err: # pylint: disable=broad-except
|
|
log.exception(err)
|
|
return Response(_(u"Importing Library Block failed - are the IDs valid and readable?"), status=400)
|
|
return response
|