0d88379eeb
This commit adds all of cms. These keys are now objects with a limited interface, and the particular internal representation is managed by the data storage layer (the modulestore). For the LMS, there should be no outward-facing changes to the system. The keys are, for now, a change to internal representation only. For Studio, the new serialized form of the keys is used in urls, to allow for further migration in the future. Co-Author: Andy Armstrong <andya@edx.org> Co-Author: Christina Roberts <christina@edx.org> Co-Author: David Baumgold <db@edx.org> Co-Author: Diana Huang <dkh@edx.org> Co-Author: Don Mitchell <dmitchell@edx.org> Co-Author: Julia Hansbrough <julia@edx.org> Co-Author: Nimisha Asthagiri <nasthagiri@edx.org> Co-Author: Sarina Canelake <sarina@edx.org> [LMS-2370]
102 lines
3.1 KiB
Python
102 lines
3.1 KiB
Python
import logging
|
|
|
|
from django.http import HttpResponse
|
|
from django.shortcuts import redirect
|
|
from edxmako.shortcuts import render_to_string, render_to_response
|
|
from xmodule.modulestore.django import modulestore
|
|
from contentstore.utils import reverse_course_url, reverse_usage_url
|
|
|
|
__all__ = ['edge', 'event', 'landing']
|
|
|
|
EDITING_TEMPLATES = [
|
|
"basic-modal", "modal-button", "edit-xblock-modal", "editor-mode-button", "upload-dialog", "image-modal"
|
|
]
|
|
|
|
# points to the temporary course landing page with log in and sign up
|
|
def landing(request, org, course, coursename):
|
|
return render_to_response('temp-course-landing.html', {})
|
|
|
|
|
|
# points to the temporary edge page
|
|
def edge(request):
|
|
return redirect('/')
|
|
|
|
|
|
def event(request):
|
|
'''
|
|
A noop to swallow the analytics call so that cms methods don't spook and poor developers looking at
|
|
console logs don't get distracted :-)
|
|
'''
|
|
return HttpResponse(status=204)
|
|
|
|
|
|
def render_from_lms(template_name, dictionary, context=None, namespace='main'):
|
|
"""
|
|
Render a template using the LMS MAKO_TEMPLATES
|
|
"""
|
|
return render_to_string(template_name, dictionary, context, namespace="lms." + namespace)
|
|
|
|
|
|
def _xmodule_recurse(item, action):
|
|
for child in item.get_children():
|
|
_xmodule_recurse(child, action)
|
|
|
|
action(item)
|
|
|
|
|
|
def get_parent_xblock(xblock):
|
|
"""
|
|
Returns the xblock that is the parent of the specified xblock, or None if it has no parent.
|
|
"""
|
|
locator = xblock.location
|
|
parent_locations = modulestore().get_parent_locations(locator,)
|
|
|
|
if len(parent_locations) == 0:
|
|
return None
|
|
elif len(parent_locations) > 1:
|
|
logging.error('Multiple parents have been found for %s', unicode(locator))
|
|
return modulestore().get_item(parent_locations[0])
|
|
|
|
|
|
def _xblock_has_studio_page(xblock):
|
|
"""
|
|
Returns true if the specified xblock has an associated Studio page. Most xblocks do
|
|
not have their own page but are instead shown on the page of their parent. There
|
|
are a few exceptions:
|
|
1. Courses
|
|
2. Verticals
|
|
3. XBlocks with children, except for:
|
|
- subsections (aka sequential blocks)
|
|
- chapters
|
|
"""
|
|
category = xblock.category
|
|
if category in ('course', 'vertical'):
|
|
return True
|
|
elif category in ('sequential', 'chapter'):
|
|
return False
|
|
elif xblock.has_children:
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
|
|
def xblock_studio_url(xblock):
|
|
"""
|
|
Returns the Studio editing URL for the specified xblock.
|
|
"""
|
|
if not _xblock_has_studio_page(xblock):
|
|
return None
|
|
category = xblock.category
|
|
parent_xblock = get_parent_xblock(xblock)
|
|
if parent_xblock:
|
|
parent_category = parent_xblock.category
|
|
else:
|
|
parent_category = None
|
|
if category == 'course':
|
|
return reverse_course_url('course_handler', xblock.location.course_key)
|
|
elif category == 'vertical' and parent_category == 'sequential':
|
|
# only show the unit page for verticals directly beneath a subsection
|
|
return reverse_usage_url('unit_handler', xblock.location)
|
|
else:
|
|
return reverse_usage_url('container_handler', xblock.location)
|