-
+
@@ -13,8 +13,11 @@ describe "XBlock", ->
describe "initializeBlock", ->
beforeEach ->
- XBlock.runtime.vA = jasmine.createSpy().andReturn('runtimeA')
- XBlock.runtime.vZ = jasmine.createSpy().andReturn('runtimeZ')
+ window.TestRuntime = {}
+ @runtimeA = {name: 'runtimeA'}
+ @runtimeZ = {name: 'runtimeZ'}
+ TestRuntime.vA = jasmine.createSpy().andReturn(@runtimeA)
+ TestRuntime.vZ = jasmine.createSpy().andReturn(@runtimeZ)
window.initFnA = jasmine.createSpy()
window.initFnZ = jasmine.createSpy()
@@ -28,12 +31,12 @@ describe "XBlock", ->
@missingInitBlock = XBlock.initializeBlock($('#missing-init')[0])
it "loads the right runtime version", ->
- expect(XBlock.runtime.vA).toHaveBeenCalledWith($('#vA')[0], @fakeChildren)
- expect(XBlock.runtime.vZ).toHaveBeenCalledWith($('#vZ')[0], @fakeChildren)
+ expect(TestRuntime.vA).toHaveBeenCalledWith($('#vA')[0], @fakeChildren)
+ expect(TestRuntime.vZ).toHaveBeenCalledWith($('#vZ')[0], @fakeChildren)
it "loads the right init function", ->
- expect(window.initFnA).toHaveBeenCalledWith('runtimeA', $('#vA')[0])
- expect(window.initFnZ).toHaveBeenCalledWith('runtimeZ', $('#vZ')[0])
+ expect(window.initFnA).toHaveBeenCalledWith(@runtimeA, $('#vA')[0])
+ expect(window.initFnZ).toHaveBeenCalledWith(@runtimeZ, $('#vZ')[0])
it "loads when missing versions", ->
expect(@missingVersionBlock.element).toBe($('#missing-version'))
diff --git a/common/static/coffee/spec/xblock/runtime.v1_spec.coffee b/common/static/coffee/spec/xblock/runtime.v1_spec.coffee
index e9c71e9b32..f13d69154c 100644
--- a/common/static/coffee/spec/xblock/runtime.v1_spec.coffee
+++ b/common/static/coffee/spec/xblock/runtime.v1_spec.coffee
@@ -1,4 +1,4 @@
-describe "XBlock.runtime.v1", ->
+describe "XBlock.Runtime.v1", ->
beforeEach ->
setFixtures """
@@ -10,9 +10,7 @@ describe "XBlock.runtime.v1", ->
@element = $('.xblock')[0]
- @runtime = XBlock.runtime.v1(@element, @children)
- it "provides a handler url", ->
- expect(@runtime.handlerUrl(@element, 'foo')).toBe('/xblock/fake-usage-id/handler/foo')
+ @runtime = new XBlock.Runtime.v1(@element, @children)
it "provides a list of children", ->
expect(@runtime.children).toBe(@children)
diff --git a/common/static/coffee/src/xblock/core.coffee b/common/static/coffee/src/xblock/core.coffee
index 71fbfd291e..9c5cc0961c 100644
--- a/common/static/coffee/src/xblock/core.coffee
+++ b/common/static/coffee/src/xblock/core.coffee
@@ -1,18 +1,19 @@
@XBlock =
- runtime: {}
+ Runtime: {}
initializeBlock: (element) ->
$element = $(element)
children = @initializeBlocks($element)
+ runtime = $element.data("runtime-class")
version = $element.data("runtime-version")
initFnName = $element.data("init")
- if version? and initFnName?
- runtime = @runtime["v#{version}"](element, children)
+ if runtime? and version? and initFnName?
+ runtime = new window[runtime]["v#{version}"](element, children)
initFn = window[initFnName]
block = initFn(runtime, element) ? {}
else
elementTag = $('
').append($element.clone()).html();
- console.log("Block #{elementTag} is missing data-runtime-version or data-init, and can't be initialized")
+ console.log("Block #{elementTag} is missing data-runtime, data-runtime-version or data-init, and can't be initialized")
block = {}
block.element = element
diff --git a/common/static/coffee/src/xblock/runtime.v1.coffee b/common/static/coffee/src/xblock/runtime.v1.coffee
index efb9944bd2..b3f28242ab 100644
--- a/common/static/coffee/src/xblock/runtime.v1.coffee
+++ b/common/static/coffee/src/xblock/runtime.v1.coffee
@@ -1,24 +1,5 @@
-@XBlock.runtime.v1 = (element, children) ->
- childMap = {}
- $.each children, (idx, child) ->
- childMap[child.name] = child
-
- return {
- # Generate the handler url for the specified handler.
- #
- # element is the html element containing the xblock requesting the url
- # handlerName is the name of the handler
- # suffix is the optional url suffix to include in the handler url
- # query is an optional query-string (note, this should not include a preceding ? or &)
- handlerUrl: (element, handlerName, suffix, query) ->
- handlerPrefix = $(element).data("handler-prefix")
- suffix = if suffix? then "/#{suffix}" else ''
- query = if query? then "?#{query}" else ''
- "#{handlerPrefix}/#{handlerName}#{suffix}#{query}"
-
- # A list of xblock children of this element
- children: children
-
- # A map of name -> child for the xblock children of this element
- childMap: childMap
- }
+class XBlock.Runtime.v1
+ constructor: (@element, @children) ->
+ @childMap = {}
+ $.each @children, (idx, child) =>
+ @childMap[child.name] = child
diff --git a/lms/djangoapps/courseware/module_render.py b/lms/djangoapps/courseware/module_render.py
index 207e46f638..952d3734df 100644
--- a/lms/djangoapps/courseware/module_render.py
+++ b/lms/djangoapps/courseware/module_render.py
@@ -21,7 +21,7 @@ from courseware.access import has_access, get_user_role
from courseware.masquerade import setup_masquerade
from courseware.model_data import FieldDataCache, DjangoKeyValueStore
from lms.lib.xblock.field_data import LmsFieldData
-from lms.lib.xblock.runtime import LmsModuleSystem, handler_prefix, unquote_slashes
+from lms.lib.xblock.runtime import LmsModuleSystem, unquote_slashes
from edxmako.shortcuts import render_to_string
from psychometrics.psychoanalyze import make_psychometrics_data_update_handler
from student.models import anonymous_id_for_user, user_by_anonymous_id
@@ -339,7 +339,7 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours
# Wrap the output display in a single div to allow for the XModule
# javascript to be bound correctly
if wrap_xmodule_display is True:
- block_wrappers.append(partial(wrap_xblock, partial(handler_prefix, course_id)))
+ block_wrappers.append(partial(wrap_xblock, 'LmsRuntime', extra_data={'course-id': course_id}))
# TODO (cpennington): When modules are shared between courses, the static
# prefix is going to have to be specific to the module, not the directory
@@ -379,7 +379,8 @@ def get_module_for_descriptor_internal(user, descriptor, field_data_cache, cours
# As we have the time to manually test more modules, we can add to the list
# of modules that get the per-course anonymized id.
is_pure_xblock = isinstance(descriptor, XBlock) and not isinstance(descriptor, XModuleDescriptor)
- is_lti_module = not is_pure_xblock and issubclass(descriptor.module_class, LTIModule)
+ module_class = getattr(descriptor, 'module_class', None)
+ is_lti_module = not is_pure_xblock and issubclass(module_class, LTIModule)
if is_pure_xblock or is_lti_module:
anonymous_student_id = anonymous_id_for_user(user, course_id)
else:
diff --git a/lms/djangoapps/instructor/views/instructor_dashboard.py b/lms/djangoapps/instructor/views/instructor_dashboard.py
index c22a774fdf..94fb3658eb 100644
--- a/lms/djangoapps/instructor/views/instructor_dashboard.py
+++ b/lms/djangoapps/instructor/views/instructor_dashboard.py
@@ -24,7 +24,6 @@ from django_comment_client.utils import has_forum_access
from django_comment_common.models import FORUM_ROLE_ADMINISTRATOR
from student.models import CourseEnrollment
from bulk_email.models import CourseAuthorization
-from lms.lib.xblock.runtime import handler_prefix
from .tools import get_units_with_due_date, title_or_url
@@ -206,7 +205,7 @@ def _section_send_email(course_id, access, course):
ScopeIds(None, None, None, 'i4x://dummy_org/dummy_course/html/dummy_name')
)
fragment = course.system.render(html_module, 'studio_view')
- fragment = wrap_xblock(partial(handler_prefix, course_id), html_module, 'studio_view', fragment, None)
+ fragment = wrap_xblock('LmsRuntime', html_module, 'studio_view', fragment, None, extra_data={"course-id": course_id})
email_editor = fragment.content
section_data = {
'section_key': 'send_email',
diff --git a/lms/djangoapps/instructor/views/legacy.py b/lms/djangoapps/instructor/views/legacy.py
index 6e8e39a374..a656ac7187 100644
--- a/lms/djangoapps/instructor/views/legacy.py
+++ b/lms/djangoapps/instructor/views/legacy.py
@@ -61,7 +61,6 @@ import track.views
from xblock.field_data import DictFieldData
from xblock.fields import ScopeIds
from django.utils.translation import ugettext as _u
-from lms.lib.xblock.runtime import handler_prefix
from microsite_configuration.middleware import MicrositeConfiguration
@@ -848,7 +847,7 @@ def instructor_dashboard(request, course_id):
ScopeIds(None, None, None, 'i4x://dummy_org/dummy_course/html/dummy_name')
)
fragment = html_module.render('studio_view')
- fragment = wrap_xblock(partial(handler_prefix, course_id), html_module, 'studio_view', fragment, None)
+ fragment = wrap_xblock('LmsRuntime', html_module, 'studio_view', fragment, None, extra_data={"course-id": course_id})
email_editor = fragment.content
# Enable instructor email only if the following conditions are met:
diff --git a/lms/envs/common.py b/lms/envs/common.py
index 479080dd42..5748f65cb8 100644
--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -750,6 +750,7 @@ main_vendor_js = [
'js/vendor/ova/ova.js',
'js/vendor/ova/catch/js/catch.js',
'js/vendor/ova/catch/js/handlebars-1.1.2.js'
+ 'js/vendor/URI.min.js'
]
discussion_js = sorted(rooted_glob(COMMON_ROOT / 'static', 'coffee/src/discussion/**/*.js'))
@@ -815,17 +816,18 @@ PIPELINE_CSS = {
}
+common_js = set(rooted_glob(COMMON_ROOT / 'static', 'coffee/src/**/*.js')) - set(courseware_js + discussion_js + staff_grading_js + open_ended_js + notes_js + instructor_dash_js)
+project_js = set(rooted_glob(PROJECT_ROOT / 'static', 'coffee/src/**/*.js')) - set(courseware_js + discussion_js + staff_grading_js + open_ended_js + notes_js + instructor_dash_js)
+
+
+
# test_order: Determines the position of this chunk of javascript on
# the jasmine test page
PIPELINE_JS = {
'application': {
# Application will contain all paths not in courseware_only_js
- 'source_filenames': sorted(
- set(rooted_glob(COMMON_ROOT / 'static', 'coffee/src/**/*.js') +
- rooted_glob(PROJECT_ROOT / 'static', 'coffee/src/**/*.js')) -
- set(courseware_js + discussion_js + staff_grading_js + open_ended_js + notes_js + instructor_dash_js)
- ) + [
+ 'source_filenames': sorted(common_js) + sorted(project_js) + [
'js/form.ext.js',
'js/my_courses_dropdown.js',
'js/toggle_login_modal.js',
diff --git a/lms/lib/xblock/runtime.py b/lms/lib/xblock/runtime.py
index 74066a6af1..a339a0a98a 100644
--- a/lms/lib/xblock/runtime.py
+++ b/lms/lib/xblock/runtime.py
@@ -58,63 +58,6 @@ def unquote_slashes(text):
return re.sub(r'(;;|;_)', _unquote_slashes, text)
-def handler_url(course_id, block, handler, suffix='', query='', thirdparty=False):
- """
- Return an XBlock handler url for the specified course, block and handler.
-
- If handler is an empty string, this function is being used to create a
- prefix of the general URL, which is assumed to be followed by handler name
- and suffix.
-
- If handler is specified, then it is checked for being a valid handler
- function, and ValueError is raised if not.
-
- """
- view_name = 'xblock_handler'
- if handler:
- # Be sure this is really a handler.
- func = getattr(block, handler, None)
- if not func:
- raise ValueError("{!r} is not a function name".format(handler))
- if not getattr(func, "_is_xblock_handler", False):
- raise ValueError("{!r} is not a handler name".format(handler))
-
- if thirdparty:
- view_name = 'xblock_handler_noauth'
-
- url = reverse(view_name, kwargs={
- 'course_id': course_id,
- 'usage_id': quote_slashes(unicode(block.scope_ids.usage_id).encode('utf-8')),
- 'handler': handler,
- 'suffix': suffix,
- })
-
- # If suffix is an empty string, remove the trailing '/'
- if not suffix:
- url = url.rstrip('/')
-
- # If there is a query string, append it
- if query:
- url += '?' + query
-
- return url
-
-
-def handler_prefix(course_id, block):
- """
- Returns a prefix for use by the Javascript handler_url function.
-
- The prefix is a valid handler url after the handler name is slash-appended
- to it.
- """
- # This depends on handler url having the handler_name as the final piece of the url
- # so that leaving an empty handler_name really does leave the opportunity to append
- # the handler_name on the frontend
-
- # This is relied on by the xblock/runtime.v1.coffee frontend handlerUrl function
- return handler_url(course_id, block, '').rstrip('/?')
-
-
class LmsHandlerUrls(object):
"""
A runtime mixin that provides a handler_url function that routes
@@ -127,7 +70,34 @@ class LmsHandlerUrls(object):
# pylint: disable=no-member
def handler_url(self, block, handler_name, suffix='', query='', thirdparty=False):
"""See :method:`xblock.runtime:Runtime.handler_url`"""
- return handler_url(self.course_id, block, handler_name, suffix='', query='', thirdparty=thirdparty)
+ view_name = 'xblock_handler'
+ if handler_name:
+ # Be sure this is really a handler.
+ func = getattr(block, handler_name, None)
+ if not func:
+ raise ValueError("{!r} is not a function name".format(handler_name))
+ if not getattr(func, "_is_xblock_handler", False):
+ raise ValueError("{!r} is not a handler name".format(handler_name))
+
+ if thirdparty:
+ view_name = 'xblock_handler_noauth'
+
+ url = reverse(view_name, kwargs={
+ 'course_id': self.course_id,
+ 'usage_id': quote_slashes(unicode(block.scope_ids.usage_id).encode('utf-8')),
+ 'handler': handler_name,
+ 'suffix': suffix,
+ })
+
+ # If suffix is an empty string, remove the trailing '/'
+ if not suffix:
+ url = url.rstrip('/')
+
+ # If there is a query string, append it
+ if query:
+ url += '?' + query
+
+ return url
class LmsModuleSystem(LmsHandlerUrls, ModuleSystem): # pylint: disable=abstract-method
diff --git a/lms/lib/xblock/test/test_runtime.py b/lms/lib/xblock/test/test_runtime.py
index 5b3efc171c..14987a87d3 100644
--- a/lms/lib/xblock/test/test_runtime.py
+++ b/lms/lib/xblock/test/test_runtime.py
@@ -6,7 +6,7 @@ from ddt import ddt, data
from mock import Mock
from unittest import TestCase
from urlparse import urlparse
-from lms.lib.xblock.runtime import quote_slashes, unquote_slashes, handler_url
+from lms.lib.xblock.runtime import quote_slashes, unquote_slashes, LmsModuleSystem
TEST_STRINGS = [
'',
@@ -41,23 +41,31 @@ class TestHandlerUrl(TestCase):
def setUp(self):
self.block = Mock()
self.course_id = "org/course/run"
+ self.runtime = LmsModuleSystem(
+ static_url='/static',
+ track_function=Mock(),
+ get_module=Mock(),
+ render_template=Mock(),
+ replace_urls=str,
+ course_id=self.course_id,
+ )
def test_trailing_characters(self):
- self.assertFalse(handler_url(self.course_id, self.block, 'handler').endswith('?'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler').endswith('/'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler').endswith('?'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler').endswith('/'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix').endswith('?'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix').endswith('/'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', 'suffix').endswith('?'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', 'suffix').endswith('/'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix', 'query').endswith('?'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', 'suffix', 'query').endswith('/'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', 'suffix', 'query').endswith('?'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', 'suffix', 'query').endswith('/'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', query='query').endswith('?'))
- self.assertFalse(handler_url(self.course_id, self.block, 'handler', query='query').endswith('/'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', query='query').endswith('?'))
+ self.assertFalse(self.runtime.handler_url(self.block, 'handler', query='query').endswith('/'))
def _parsed_query(self, query_string):
"""Return the parsed query string from a handler_url generated with the supplied query_string"""
- return urlparse(handler_url(self.course_id, self.block, 'handler', query=query_string)).query
+ return urlparse(self.runtime.handler_url(self.block, 'handler', query=query_string)).query
def test_query_string(self):
self.assertIn('foo=bar', self._parsed_query('foo=bar'))
@@ -66,7 +74,7 @@ class TestHandlerUrl(TestCase):
def _parsed_path(self, handler_name='handler', suffix=''):
"""Return the parsed path from a handler_url with the supplied handler_name and suffix"""
- return urlparse(handler_url(self.course_id, self.block, handler_name, suffix=suffix)).path
+ return urlparse(self.runtime.handler_url(self.block, handler_name, suffix=suffix)).path
def test_suffix(self):
self.assertTrue(self._parsed_path(suffix="foo").endswith('foo'))
diff --git a/lms/static/coffee/src/xblock/lms.runtime.v1.coffee b/lms/static/coffee/src/xblock/lms.runtime.v1.coffee
new file mode 100644
index 0000000000..9a999727a3
--- /dev/null
+++ b/lms/static/coffee/src/xblock/lms.runtime.v1.coffee
@@ -0,0 +1,18 @@
+@LmsRuntime = {}
+
+class LmsRuntime.v1 extends XBlock.Runtime.v1
+ handlerUrl: (element, handlerName, suffix, query, thirdparty) ->
+ courseId = $(@element).data("course-id")
+ usageId = $(@element).data("usage-id")
+ handlerAuth = if thirdparty then "handler_noauth" else "handler"
+
+ uri = URI('/courses').segment(courseId)
+ .segment('xblock')
+ .segment(usageId)
+ .segment(handlerAuth)
+ .segment(handlerName)
+
+ if suffix? then uri.segment(suffix)
+ if query? then uri.search(query)
+
+ uri.toString()
diff --git a/lms/static/js_test.yml b/lms/static/js_test.yml
index 6fa88250ff..4cec8c06e7 100644
--- a/lms/static/js_test.yml
+++ b/lms/static/js_test.yml
@@ -40,6 +40,7 @@ lib_paths:
- xmodule_js/common_static/js/vendor/jquery.cookie.js
- xmodule_js/common_static/js/vendor/flot/jquery.flot.js
- xmodule_js/common_static/js/vendor/CodeMirror/codemirror.js
+ - xmodule_js/common_static/js/vendor/URI.min.js
- xmodule_js/common_static/coffee/src/jquery.immediateDescendents.js
- xmodule_js/common_static/coffee/src/xblock
- xmodule_js/src/capa/