[\w\-.]+)/inline$', 'inline_discussion', name='inline_discussion'),
+ url(
+ r'discussion_board_fragment_view$',
+ DiscussionBoardFragmentView.as_view(),
+ name='discussion_board_fragment_view'
+ ),
url(r'', 'forum_form_discussion', name='forum_form_discussion'),
)
diff --git a/lms/djangoapps/discussion/views.py b/lms/djangoapps/discussion/views.py
index b70c72b113..db5df8d243 100644
--- a/lms/djangoapps/discussion/views.py
+++ b/lms/djangoapps/discussion/views.py
@@ -4,22 +4,33 @@ Views handling read (GET) requests for the Discussion tab and inline discussions
from functools import wraps
import logging
+from sets import Set
+from django.conf import settings
from django.contrib.auth.decorators import login_required
from django.core.context_processors import csrf
from django.core.urlresolvers import reverse
from django.contrib.auth.models import User
-from django.http import Http404, HttpResponseBadRequest
+from django.contrib.staticfiles.storage import staticfiles_storage
+from django.http import Http404, HttpResponseServerError
from django.shortcuts import render_to_response
+from django.template.loader import render_to_string
+from django.utils.translation import get_language_bidi
from django.views.decorators.http import require_GET
import newrelic.agent
+from rest_framework import status
+
+from web_fragments.fragment import Fragment
from courseware.courses import get_course_with_access
+from courseware.views.views import CourseTabView
from openedx.core.djangoapps.course_groups.cohorts import (
is_course_cohorted,
get_cohort_id,
get_course_cohorts,
)
+from openedx.core.djangoapps.plugin_api.views import EdxFragmentView
+
from courseware.access import has_access
from student.models import CourseEnrollment
from xmodule.modulestore.django import modulestore
@@ -51,8 +62,7 @@ def make_course_settings(course, user):
Generate a JSON-serializable model for course settings, which will be used to initialize a
DiscussionCourseSettings object on the client.
"""
-
- obj = {
+ return {
'is_cohorted': is_course_cohorted(course.id),
'allow_anonymous': course.allow_anonymous,
'allow_anonymous_to_peers': course.allow_anonymous_to_peers,
@@ -60,8 +70,6 @@ def make_course_settings(course, user):
'category_map': utils.get_discussion_category_map(course, user)
}
- return obj
-
@newrelic.agent.function_trace()
def get_threads(request, course, user_info, discussion_id=None, per_page=THREADS_PER_PAGE):
@@ -185,7 +193,7 @@ def inline_discussion(request, course_key, discussion_id):
try:
threads, query_params = get_threads(request, course, user_info, discussion_id, per_page=INLINE_THREADS_PER_PAGE)
except ValueError:
- return HttpResponseBadRequest("Invalid group_id")
+ return HttpResponseServerError("Invalid group_id")
with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
annotated_content_info = utils.get_metadata_for_threads(course_key, threads, request.user, user_info)
@@ -214,31 +222,25 @@ def forum_form_discussion(request, course_key):
nr_transaction = newrelic.agent.current_transaction()
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
- course_settings = make_course_settings(course, request.user)
-
- user = cc.User.from_django_user(request.user)
- user_info = user.to_dict()
-
- try:
- unsafethreads, query_params = get_threads(request, course, user_info) # This might process a search query
- is_staff = has_permission(request.user, 'openclose_thread', course.id)
- threads = [utils.prepare_content(thread, course_key, is_staff) for thread in unsafethreads]
- except cc.utils.CommentClientMaintenanceError:
- log.warning("Forum is in maintenance mode")
- return render_to_response('discussion/maintenance.html', {
- 'disable_courseware_js': True,
- 'uses_pattern_library': True,
- })
- except ValueError:
- return HttpResponseBadRequest("Invalid group_id")
-
- with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
- annotated_content_info = utils.get_metadata_for_threads(course_key, threads, request.user, user_info)
-
- with newrelic.agent.FunctionTrace(nr_transaction, "add_courseware_context"):
- add_courseware_context(threads, course, request.user)
-
if request.is_ajax():
+ user = cc.User.from_django_user(request.user)
+ user_info = user.to_dict()
+
+ try:
+ unsafethreads, query_params = get_threads(request, course, user_info) # This might process a search query
+ is_staff = has_permission(request.user, 'openclose_thread', course.id)
+ threads = [utils.prepare_content(thread, course_key, is_staff) for thread in unsafethreads]
+ except cc.utils.CommentClientMaintenanceError:
+ return HttpResponseServerError('Forum is in maintenance mode', status=status.HTTP_503_SERVICE_UNAVAILABLE)
+ except ValueError:
+ return HttpResponseServerError("Invalid group_id")
+
+ with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
+ annotated_content_info = utils.get_metadata_for_threads(course_key, threads, request.user, user_info)
+
+ with newrelic.agent.FunctionTrace(nr_transaction, "add_courseware_context"):
+ add_courseware_context(threads, course, request.user)
+
return utils.JsonResponse({
'discussion_data': threads, # TODO: Standardize on 'discussion_data' vs 'threads'
'annotated_content_info': annotated_content_info,
@@ -247,39 +249,9 @@ def forum_form_discussion(request, course_key):
'corrected_text': query_params['corrected_text'],
})
else:
- with newrelic.agent.FunctionTrace(nr_transaction, "get_cohort_info"):
- user_cohort_id = get_cohort_id(request.user, course_key)
-
- context = {
- 'csrf': csrf(request)['csrf_token'],
- 'course': course,
- #'recent_active_threads': recent_active_threads,
- 'staff_access': bool(has_access(request.user, 'staff', course)),
- 'threads': threads,
- 'thread_pages': query_params['num_pages'],
- 'user_info': user_info,
- 'can_create_comment': has_permission(request.user, "create_comment", course.id),
- 'can_create_subcomment': has_permission(request.user, "create_sub_comment", course.id),
- 'can_create_thread': has_permission(request.user, "create_thread", course.id),
- 'flag_moderator': bool(
- has_permission(request.user, 'openclose_thread', course.id) or
- has_access(request.user, 'staff', course)
- ),
- 'annotated_content_info': annotated_content_info,
- 'course_id': course.id.to_deprecated_string(),
- 'roles': utils.get_role_ids(course_key),
- 'is_moderator': has_permission(request.user, "see_all_cohorts", course_key),
- 'cohorts': course_settings["cohorts"], # still needed to render _thread_list_template
- 'user_cohort': user_cohort_id, # read from container in NewPostView
- 'is_course_cohorted': is_course_cohorted(course_key), # still needed to render _thread_list_template
- 'sort_preference': user.default_sort_key,
- 'category_map': course_settings["category_map"],
- 'course_settings': course_settings,
- 'disable_courseware_js': True,
- 'uses_pattern_library': True,
- }
- # print "start rendering.."
- return render_to_response('discussion/discussion_board.html', context)
+ course_id = unicode(course.id)
+ tab_view = CourseTabView()
+ return tab_view.get(request, course_id, 'discussion')
@require_GET
@@ -296,37 +268,16 @@ def single_thread(request, course_key, discussion_id, thread_id):
nr_transaction = newrelic.agent.current_transaction()
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
- course_settings = make_course_settings(course, request.user)
- cc_user = cc.User.from_django_user(request.user)
- user_info = cc_user.to_dict()
- is_moderator = has_permission(request.user, "see_all_cohorts", course_key)
- is_staff = has_permission(request.user, 'openclose_thread', course.id)
-
- try:
- thread = cc.Thread.find(thread_id).retrieve(
- with_responses=request.is_ajax(),
- recursive=request.is_ajax(),
- user_id=request.user.id,
- response_skip=request.GET.get("resp_skip"),
- response_limit=request.GET.get("resp_limit")
- )
- except cc.utils.CommentClientRequestError as error:
- if error.status_code == 404:
- raise Http404
- raise
-
- # Verify that the student has access to this thread if belongs to a course discussion module
- thread_context = getattr(thread, "context", "course")
- if thread_context == "course" and not utils.discussion_category_id_access(course, request.user, discussion_id):
- raise Http404
-
- # verify that the thread belongs to the requesting student's cohort
- if is_commentable_cohorted(course_key, discussion_id) and not is_moderator:
- user_group_id = get_cohort_id(request.user, course_key)
- if getattr(thread, "group_id", None) is not None and user_group_id != thread.group_id:
- raise Http404
if request.is_ajax():
+ cc_user = cc.User.from_django_user(request.user)
+ user_info = cc_user.to_dict()
+ is_staff = has_permission(request.user, 'openclose_thread', course.id)
+
+ thread = _find_thread(request, course, discussion_id=discussion_id, thread_id=thread_id)
+ if not thread:
+ raise Http404
+
with newrelic.agent.FunctionTrace(nr_transaction, "get_annotated_content_infos"):
annotated_content_info = utils.get_annotated_content_infos(
course_key,
@@ -344,57 +295,136 @@ def single_thread(request, course_key, discussion_id, thread_id):
'annotated_content_info': annotated_content_info,
})
else:
+ course_id = unicode(course.id)
+ tab_view = CourseTabView()
+ return tab_view.get(request, course_id, 'discussion', discussion_id=discussion_id, thread_id=thread_id)
+
+
+def _find_thread(request, course, discussion_id, thread_id):
+ """
+ Finds the discussion thread with the specified ID.
+
+ Args:
+ request: The Django request.
+ course_id: The ID of the owning course.
+ discussion_id: The ID of the owning discussion.
+ thread_id: The ID of the thread.
+
+ Returns:
+ The thread in question if the user can see it, else None.
+ """
+ try:
+ thread = cc.Thread.find(thread_id).retrieve(
+ with_responses=request.is_ajax(),
+ recursive=request.is_ajax(),
+ user_id=request.user.id,
+ response_skip=request.GET.get("resp_skip"),
+ response_limit=request.GET.get("resp_limit")
+ )
+ except cc.utils.CommentClientRequestError:
+ return None
+
+ # Verify that the student has access to this thread if belongs to a course discussion module
+ thread_context = getattr(thread, "context", "course")
+ if thread_context == "course" and not utils.discussion_category_id_access(course, request.user, discussion_id):
+ return None
+
+ # verify that the thread belongs to the requesting student's cohort
+ is_moderator = has_permission(request.user, "see_all_cohorts", course.id)
+ if is_commentable_cohorted(course.id, discussion_id) and not is_moderator:
+ user_group_id = get_cohort_id(request.user, course.id)
+ if getattr(thread, "group_id", None) is not None and user_group_id != thread.group_id:
+ return None
+
+ return thread
+
+
+def _create_base_discussion_view_context(request, course_key):
+ """
+ Returns the default template context for rendering any discussion view.
+ """
+ user = request.user
+ cc_user = cc.User.from_django_user(user)
+ user_info = cc_user.to_dict()
+ course = get_course_with_access(user, 'load', course_key, check_if_enrolled=True)
+ course_settings = make_course_settings(course, user)
+ return {
+ 'csrf': csrf(request)['csrf_token'],
+ 'course': course,
+ 'user': user,
+ 'user_info': user_info,
+ 'staff_access': bool(has_access(user, 'staff', course)),
+ 'roles': utils.get_role_ids(course_key),
+ 'can_create_comment': has_permission(user, "create_comment", course.id),
+ 'can_create_subcomment': has_permission(user, "create_sub_comment", course.id),
+ 'can_create_thread': has_permission(user, "create_thread", course.id),
+ 'flag_moderator': bool(
+ has_permission(user, 'openclose_thread', course.id) or
+ has_access(user, 'staff', course)
+ ),
+ 'course_settings': course_settings,
+ 'disable_courseware_js': True,
+ 'uses_pattern_library': True,
+ }
+
+
+def _create_discussion_board_context(request, course_key, discussion_id=None, thread_id=None):
+ """
+ Returns the template context for rendering the discussion board.
+ """
+ nr_transaction = newrelic.agent.current_transaction()
+ context = _create_base_discussion_view_context(request, course_key)
+ course = context['course']
+ course_settings = context['course_settings']
+ user = context['user']
+ cc_user = cc.User.from_django_user(user)
+ user_info = context['user_info']
+ if thread_id:
+ thread = _find_thread(request, course, discussion_id=discussion_id, thread_id=thread_id)
+ if not thread:
+ raise Http404
+
# Since we're in page render mode, and the discussions UI will request the thread list itself,
# we need only return the thread information for this one.
threads = [thread.to_dict()]
- with newrelic.agent.FunctionTrace(nr_transaction, "add_courseware_context"):
- add_courseware_context(threads, course, request.user)
-
for thread in threads:
# patch for backward compatibility with comments service
if "pinned" not in thread:
thread["pinned"] = False
+ thread_pages = 1
+ root_url = reverse('forum_form_discussion', args=[unicode(course.id)])
+ else:
+ threads, query_params = get_threads(request, course, user_info) # This might process a search query
+ thread_pages = query_params['num_pages']
+ root_url = request.path
+ is_staff = has_permission(user, 'openclose_thread', course.id)
+ threads = [utils.prepare_content(thread, course_key, is_staff) for thread in threads]
- threads = [utils.prepare_content(thread, course_key, is_staff) for thread in threads]
+ with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
+ annotated_content_info = utils.get_metadata_for_threads(course_key, threads, user, user_info)
- with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
- annotated_content_info = utils.get_metadata_for_threads(course_key, threads, request.user, user_info)
+ with newrelic.agent.FunctionTrace(nr_transaction, "add_courseware_context"):
+ add_courseware_context(threads, course, user)
- with newrelic.agent.FunctionTrace(nr_transaction, "get_cohort_info"):
- user_cohort = get_cohort_id(request.user, course_key)
+ with newrelic.agent.FunctionTrace(nr_transaction, "get_cohort_info"):
+ user_cohort_id = get_cohort_id(user, course_key)
- context = {
- 'discussion_id': discussion_id,
- 'csrf': csrf(request)['csrf_token'],
- 'init': '', # TODO: What is this?
- 'user_info': user_info,
- 'can_create_comment': has_permission(request.user, "create_comment", course.id),
- 'can_create_subcomment': has_permission(request.user, "create_sub_comment", course.id),
- 'can_create_thread': has_permission(request.user, "create_thread", course.id),
- 'annotated_content_info': annotated_content_info,
- 'course': course,
- #'recent_active_threads': recent_active_threads,
- 'course_id': course.id.to_deprecated_string(), # TODO: Why pass both course and course.id to template?
- 'thread_id': thread_id,
- 'threads': threads,
- 'roles': utils.get_role_ids(course_key),
- 'is_moderator': is_moderator,
- 'thread_pages': 1,
- 'is_course_cohorted': is_course_cohorted(course_key),
- 'flag_moderator': bool(
- has_permission(request.user, 'openclose_thread', course.id) or
- has_access(request.user, 'staff', course)
- ),
- 'cohorts': course_settings["cohorts"],
- 'user_cohort': user_cohort,
- 'sort_preference': cc_user.default_sort_key,
- 'category_map': course_settings["category_map"],
- 'course_settings': course_settings,
- 'disable_courseware_js': True,
- 'uses_pattern_library': True,
- }
- return render_to_response('discussion/discussion_board.html', context)
+ context.update({
+ 'root_url': root_url,
+ 'discussion_id': discussion_id,
+ 'thread_id': thread_id,
+ 'threads': threads,
+ 'thread_pages': thread_pages,
+ 'annotated_content_info': annotated_content_info,
+ 'is_moderator': has_permission(user, "see_all_cohorts", course_key),
+ 'cohorts': course_settings["cohorts"], # still needed to render _thread_list_template
+ 'user_cohort': user_cohort_id, # read from container in NewPostView
+ 'sort_preference': cc_user.default_sort_key,
+ 'category_map': course_settings["category_map"],
+ 'course_settings': course_settings,
+ })
+ return context
@require_GET
@@ -409,9 +439,7 @@ def user_profile(request, course_key, user_id):
nr_transaction = newrelic.agent.current_transaction()
user = cc.User.from_django_user(request.user)
- user_info = user.to_dict()
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
- course_settings = make_course_settings(course, request.user)
try:
# If user is not enrolled in the course, do not proceed.
@@ -427,7 +455,7 @@ def user_profile(request, course_key, user_id):
try:
group_id = get_group_id_for_comments_service(request, course_key)
except ValueError:
- return HttpResponseBadRequest("Invalid group_id")
+ return HttpResponseServerError("Invalid group_id")
if group_id is not None:
query_params['group_id'] = group_id
profiled_user = cc.User(id=user_id, course_id=course_key, group_id=group_id)
@@ -437,9 +465,9 @@ def user_profile(request, course_key, user_id):
threads, page, num_pages = profiled_user.active_threads(query_params)
query_params['page'] = page
query_params['num_pages'] = num_pages
- user_info = cc.User.from_django_user(request.user).to_dict()
with newrelic.agent.FunctionTrace(nr_transaction, "get_metadata_for_threads"):
+ user_info = cc.User.from_django_user(request.user).to_dict()
annotated_content_info = utils.get_metadata_for_threads(course_key, threads, request.user, user_info)
is_staff = has_permission(request.user, 'openclose_thread', course.id)
@@ -461,32 +489,19 @@ def user_profile(request, course_key, user_id):
with newrelic.agent.FunctionTrace(nr_transaction, "get_cohort_info"):
user_cohort_id = get_cohort_id(request.user, course_key)
- context = {
- 'course': course,
- 'user': request.user,
+ context = _create_base_discussion_view_context(request, course_key)
+ context.update({
'django_user': django_user,
'django_user_roles': user_roles,
'profiled_user': profiled_user.to_dict(),
'threads': threads,
- 'user_info': user_info,
- 'roles': utils.get_role_ids(course_key),
- 'can_create_comment': has_permission(request.user, "create_comment", course.id),
- 'can_create_subcomment': has_permission(request.user, "create_sub_comment", course.id),
- 'can_create_thread': has_permission(request.user, "create_thread", course.id),
- 'flag_moderator': bool(
- has_permission(request.user, 'openclose_thread', course.id) or
- has_access(request.user, 'staff', course)
- ),
'user_cohort': user_cohort_id,
'annotated_content_info': annotated_content_info,
'page': query_params['page'],
'num_pages': query_params['num_pages'],
'sort_preference': user.default_sort_key,
- 'course_settings': course_settings,
'learner_profile_page_url': reverse('learner_profile', kwargs={'username': django_user.username}),
- 'disable_courseware_js': True,
- 'uses_pattern_library': True,
- }
+ })
return render_to_response('discussion/discussion_profile_page.html', context)
except User.DoesNotExist:
@@ -531,7 +546,7 @@ def followed_threads(request, course_key, user_id):
try:
group_id = get_group_id_for_comments_service(request, course_key)
except ValueError:
- return HttpResponseBadRequest("Invalid group_id")
+ return HttpResponseServerError("Invalid group_id")
if group_id is not None:
query_params['group_id'] = group_id
@@ -574,3 +589,81 @@ def followed_threads(request, course_key, user_id):
return render_to_response('discussion/user_profile.html', context)
except User.DoesNotExist:
raise Http404
+
+
+class DiscussionBoardFragmentView(EdxFragmentView):
+ """
+ Component implementation of the discussion board.
+ """
+ def render_to_fragment(self, request, course_id=None, discussion_id=None, thread_id=None, **kwargs):
+ """
+ Render the discussion board to a fragment.
+
+ Args:
+ request: The Django request.
+ course_id: The id of the course in question.
+ discussion_id: An optional discussion ID to be focused upon.
+ thread_id: An optional ID of the thread to be shown.
+
+ Returns:
+ Fragment: The fragment representing the discussion board
+ """
+ course_key = CourseKey.from_string(course_id)
+ try:
+ context = _create_discussion_board_context(
+ request,
+ course_key,
+ discussion_id=discussion_id,
+ thread_id=thread_id,
+ )
+ html = render_to_string('discussion/discussion_board_fragment.html', context)
+ inline_js = render_to_string('discussion/discussion_board_js.template', context)
+
+ fragment = Fragment(html)
+ self.add_fragment_resource_urls(fragment)
+ fragment.add_javascript(inline_js)
+ if not settings.REQUIRE_DEBUG:
+ fragment.add_javascript_url(staticfiles_storage.url('discussion/js/discussion_board_factory.js'))
+ return fragment
+ except cc.utils.CommentClientMaintenanceError:
+ log.warning('Forum is in maintenance mode')
+ html = render_to_response('discussion/maintenance_fragment.html', {
+ 'disable_courseware_js': True,
+ 'uses_pattern_library': True,
+ })
+ return Fragment(html)
+
+ def vendor_js_dependencies(self):
+ """
+ Returns list of vendor JS files that this view depends on.
+
+ The helper function that it uses to obtain the list of vendor JS files
+ works in conjunction with the Django pipeline to ensure that in development mode
+ the files are loaded individually, but in production just the single bundle is loaded.
+ """
+ dependencies = Set()
+ dependencies.update(self.get_js_dependencies('discussion_vendor'))
+ return list(dependencies)
+
+ def js_dependencies(self):
+ """
+ Returns list of JS files that this view depends on.
+
+ The helper function that it uses to obtain the list of JS files
+ works in conjunction with the Django pipeline to ensure that in development mode
+ the files are loaded individually, but in production just the single bundle is loaded.
+ """
+ return self.get_js_dependencies('discussion')
+
+ def css_dependencies(self):
+ """
+ Returns list of CSS files that this view depends on.
+
+ The helper function that it uses to obtain the list of CSS files
+ works in conjunction with the Django pipeline to ensure that in development mode
+ the files are loaded individually, but in production just the single bundle is loaded.
+ """
+ if get_language_bidi():
+ return self.get_css_dependencies('style-discussion-main-rtl')
+ else:
+ return self.get_css_dependencies('style-discussion-main')
diff --git a/lms/djangoapps/django_comment_client/base/views.py b/lms/djangoapps/django_comment_client/base/views.py
index 994e585e84..31cc366c26 100644
--- a/lms/djangoapps/django_comment_client/base/views.py
+++ b/lms/djangoapps/django_comment_client/base/views.py
@@ -8,7 +8,7 @@ import urlparse
from django.contrib.auth.decorators import login_required
from django.contrib.auth.models import User
from django.core import exceptions
-from django.http import Http404, HttpResponseBadRequest, HttpResponse
+from django.http import Http404, HttpResponse, HttpResponseServerError
from django.utils.translation import ugettext as _
from django.views.decorators import csrf
from django.views.decorators.http import require_GET, require_POST
@@ -243,7 +243,7 @@ def create_thread(request, course_id, commentable_id):
try:
group_id = get_group_id_for_comments_service(request, course_key, commentable_id)
except ValueError:
- return HttpResponseBadRequest("Invalid cohort id")
+ return HttpResponseServerError("Invalid cohort id")
if group_id is not None:
thread.group_id = group_id
diff --git a/lms/djangoapps/django_comment_client/tests/group_id.py b/lms/djangoapps/django_comment_client/tests/group_id.py
index b25e6d091e..3c7b30d045 100644
--- a/lms/djangoapps/django_comment_client/tests/group_id.py
+++ b/lms/djangoapps/django_comment_client/tests/group_id.py
@@ -94,8 +94,11 @@ class CohortedTopicGroupIdTestMixin(GroupIdAssertionMixin):
def test_cohorted_topic_moderator_with_invalid_group_id(self, mock_request):
invalid_id = self.student_cohort.id + self.moderator_cohort.id
- response = self.call_view(mock_request, "cohorted_topic", self.moderator, invalid_id)
- self.assertEqual(response.status_code, 400)
+ try:
+ response = self.call_view(mock_request, "cohorted_topic", self.moderator, invalid_id)
+ self.assertEqual(response.status_code, 500)
+ except ValueError:
+ pass # In mock request mode, server errors are not captured
class NonCohortedTopicGroupIdTestMixin(GroupIdAssertionMixin):
diff --git a/lms/envs/common.py b/lms/envs/common.py
index 5181035365..fb4dfab1e1 100644
--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -544,6 +544,9 @@ TEMPLATES = [
]
DEFAULT_TEMPLATE_ENGINE = TEMPLATES[0]
+# The template used to render a web fragment as a standalone page
+STANDALONE_FRAGMENT_VIEW_TEMPLATE = 'fragment-view-chromeless.html'
+
###############################################################################################
# use the ratelimit backend to prevent brute force attacks
@@ -1927,6 +1930,10 @@ INSTALLED_APPS = (
'pipeline',
'static_replace',
+ # For user interface plugins
+ 'web_fragments',
+ 'openedx.core.djangoapps.plugin_api',
+
# For content serving
'openedx.core.djangoapps.contentserver',
diff --git a/lms/templates/courseware/error-message.html b/lms/templates/courseware/error-message.html
index 391476569d..27bb43202f 100644
--- a/lms/templates/courseware/error-message.html
+++ b/lms/templates/courseware/error-message.html
@@ -1,3 +1,5 @@
+## mako
+
<%! from django.utils.translation import ugettext as _ %>
<%
tech_support_email='{tech_support_email}'.format(tech_support_email=settings.TECH_SUPPORT_EMAIL)
diff --git a/lms/templates/courseware/static_tab.html b/lms/templates/courseware/static_tab.html
index efb1691431..ab18be3961 100644
--- a/lms/templates/courseware/static_tab.html
+++ b/lms/templates/courseware/static_tab.html
@@ -1,7 +1,5 @@
## mako
-
-
<%page expression_filter="h"/>
<%!
from openedx.core.djangolib.markup import HTML
@@ -11,19 +9,18 @@ from openedx.core.djangolib.markup import HTML
<%block name="bodyclass">view-in-course view-statictab ${course.css_class or ''}
<%namespace name='static' file='/static_content.html'/>
-<%block name="headextra">
+<%block name="head_extra">
<%static:css group='style-course-vendor'/>
<%static:css group='style-course'/>
${HTML(fragment.head_html())}
-<%block name="js_extra">
+<%block name="footer_extra">
<%include file="/mathjax_include.html" args="disable_fast_preview=True"/>
${HTML(fragment.foot_html())}
-
-<%block name="pagetitle">${tab['name']} | ${course.display_number_with_default | h}
+<%block name="pagetitle">${tab['name']} | ${course.display_number_with_default}
<%include file="/courseware/course_navigation.html" args="active_page=active_page" />
diff --git a/lms/templates/courseware/tab-view.html b/lms/templates/courseware/tab-view.html
new file mode 100644
index 0000000000..cbef28204f
--- /dev/null
+++ b/lms/templates/courseware/tab-view.html
@@ -0,0 +1,32 @@
+## mako
+
+<%! main_css = "style-main-v2" %>
+
+<%page expression_filter="h"/>
+<%!
+from openedx.core.djangolib.markup import HTML
+%>
+
+<%inherit file="/main.html" />
+<%namespace name='static' file='/static_content.html'/>
+
+<%block name="bodyclass">${tab['body_class']}
+
+<%def name="online_help_token()"><% return "${tab['online_help_token']}" %>
+
+<%block name="pagetitle">${tab['name']} | ${course.display_number_with_default}
+
+<%include file="/courseware/course_navigation.html" args="active_page=active_page" />
+
+<%block name="head_extra">
+${HTML(fragment.head_html())}
+
+
+<%block name="footer_extra">
+<%include file="/mathjax_include.html" args="disable_fast_preview=True"/>
+${HTML(fragment.foot_html())}
+
+
+<%block name="content">
+ ${HTML(fragment.body_html())}
+
diff --git a/lms/templates/fragment-view-chromeless.html b/lms/templates/fragment-view-chromeless.html
new file mode 100644
index 0000000000..68a13c355d
--- /dev/null
+++ b/lms/templates/fragment-view-chromeless.html
@@ -0,0 +1,24 @@
+## mako
+
+<%! main_css = "style-main-v2" %>
+
+<%page expression_filter="h"/>
+<%inherit file="/main.html" />
+
+<%namespace name='static' file='static_content.html'/>
+
+<%! from openedx.core.djangolib.markup import HTML %>
+
+<% header_file = None %>
+
+<%block name="head_extra">
+ ${HTML(fragment.head_html())}
+
+
+<%block name="footer_extra">
+ ${HTML(fragment.foot_html())}
+
+
+
+ ${HTML(fragment.body_html())}
+
diff --git a/lms/templates/main.html b/lms/templates/main.html
index 41369b42d1..5c3d01e2ff 100644
--- a/lms/templates/main.html
+++ b/lms/templates/main.html
@@ -96,6 +96,7 @@ from pipeline_mako import render_require_js_path_overrides
% endif
<%block name="headextra"/>
+ <%block name="head_extra"/>
<%static:optional_include_mako file="head-extra.html" is_theming_enabled="True" />
@@ -148,6 +149,7 @@ from pipeline_mako import render_require_js_path_overrides
% endif
+ <%block name="footer_extra"/>
<%block name="js_extra"/>
<%include file="widgets/segment-io-footer.html" />
diff --git a/lms/urls.py b/lms/urls.py
index 92c00768bf..13ad85f5ec 100644
--- a/lms/urls.py
+++ b/lms/urls.py
@@ -8,7 +8,7 @@ from django.views.generic.base import RedirectView
from ratelimitbackend import admin
from django.conf.urls.static import static
-from courseware.views.views import EnrollStaffView
+from courseware.views.views import CourseTabView, EnrollStaffView, StaticCourseTabView
from config_models.views import ConfigurationModelCurrentAPIView
from courseware.views.index import CoursewareIndex
from openedx.core.djangoapps.auth_exchange.views import LoginWithAccessTokenView
@@ -691,8 +691,8 @@ urlpatterns += (
r'^courses/{}/tab/(?P[^/]+)/$'.format(
settings.COURSE_ID_PATTERN,
),
- 'courseware.views.views.content_tab',
- name='content_tab',
+ CourseTabView.as_view(),
+ name='course_tab_view',
),
)
@@ -702,7 +702,7 @@ urlpatterns += (
r'^courses/{}/(?P[^/]+)/$'.format(
settings.COURSE_ID_PATTERN,
),
- 'courseware.views.views.static_tab',
+ StaticCourseTabView.as_view(),
name='static_tab',
),
)
diff --git a/openedx/core/djangoapps/plugin_api/__init__.py b/openedx/core/djangoapps/plugin_api/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/openedx/core/djangoapps/plugin_api/views.py b/openedx/core/djangoapps/plugin_api/views.py
new file mode 100644
index 0000000000..668eea6caa
--- /dev/null
+++ b/openedx/core/djangoapps/plugin_api/views.py
@@ -0,0 +1,99 @@
+"""
+Views for building plugins.
+"""
+
+from abc import abstractmethod
+import logging
+
+from django.conf import settings
+from django.contrib.staticfiles.storage import staticfiles_storage
+from django.shortcuts import render_to_response
+from web_fragments.views import FragmentView
+
+log = logging.getLogger('plugin_api')
+
+
+class EdxFragmentView(FragmentView):
+ """
+ The base class of all Open edX fragment views.
+ """
+ USES_PATTERN_LIBRARY = True
+
+ page_title = None
+
+ @staticmethod
+ def get_css_dependencies(group):
+ """
+ Returns list of CSS dependencies belonging to `group` in settings.PIPELINE_JS.
+
+ Respects `PIPELINE_ENABLED` setting.
+ """
+ if settings.PIPELINE_ENABLED:
+ return [settings.PIPELINE_CSS[group]['output_filename']]
+ else:
+ return settings.PIPELINE_CSS[group]['source_filenames']
+
+ @staticmethod
+ def get_js_dependencies(group):
+ """
+ Returns list of JS dependencies belonging to `group` in settings.PIPELINE_JS.
+
+ Respects `PIPELINE_ENABLED` setting.
+ """
+ if settings.PIPELINE_ENABLED:
+ return [settings.PIPELINE_JS[group]['output_filename']]
+ else:
+ return settings.PIPELINE_JS[group]['source_filenames']
+
+ @abstractmethod
+ def vendor_js_dependencies(self):
+ """
+ Returns list of the vendor JS files that this view depends on.
+ """
+ return []
+
+ @abstractmethod
+ def js_dependencies(self):
+ """
+ Returns list of the JavaScript files that this view depends on.
+ """
+ return []
+
+ @abstractmethod
+ def css_dependencies(self):
+ """
+ Returns list of the CSS files that this view depends on.
+ """
+ return []
+
+ def add_fragment_resource_urls(self, fragment):
+ """
+ Adds URLs for JS and CSS resources needed by this fragment.
+ """
+ # Head dependencies
+ for vendor_js_file in self.vendor_js_dependencies():
+ fragment.add_resource_url(staticfiles_storage.url(vendor_js_file), 'application/javascript', 'head')
+
+ for css_file in self.css_dependencies():
+ fragment.add_css_url(staticfiles_storage.url(css_file))
+
+ # Body dependencies
+ for js_file in self.js_dependencies():
+ fragment.add_javascript_url(staticfiles_storage.url(js_file))
+
+ def render_to_standalone_html(self, request, fragment, **kwargs):
+ """
+ Renders this fragment to HTML for a standalone page.
+ """
+ context = {
+ 'uses-pattern-library': self.USES_PATTERN_LIBRARY,
+ 'settings': settings,
+ 'fragment': fragment,
+ 'disable_accordion': True,
+ 'allow_iframing': True,
+ 'disable_header': True,
+ 'disable_footer': True,
+ 'disable_window_wrap': True,
+ 'disable_preview_menu': True,
+ }
+ return render_to_response(settings.STANDALONE_FRAGMENT_VIEW_TEMPLATE, context)
diff --git a/openedx/core/lib/tests/test_course_tab_api.py b/openedx/core/lib/tests/test_course_tab_api.py
index 54b7639f44..44537e295b 100644
--- a/openedx/core/lib/tests/test_course_tab_api.py
+++ b/openedx/core/lib/tests/test_course_tab_api.py
@@ -10,9 +10,9 @@ from openedx.core.lib.course_tabs import CourseTabPluginManager
@attr(shard=2)
-class TestPluginApi(TestCase):
+class TestCourseTabApi(TestCase):
"""
- Unit tests for the plugin API
+ Unit tests for the course tab plugin API
"""
def test_get_plugin(self):
diff --git a/requirements/edx/base.txt b/requirements/edx/base.txt
index f8cdc5516a..5f89005797 100644
--- a/requirements/edx/base.txt
+++ b/requirements/edx/base.txt
@@ -206,5 +206,9 @@ py2neo==3.1.2
# for calculating coverage
-r coverage.txt
+# Support for plugins
+web-fragments==0.2.1
+xblock==0.4.14
+
# Third Party XBlocks
edx-sga==0.6.2
diff --git a/requirements/edx/github.txt b/requirements/edx/github.txt
index 8601272362..1e81644d2f 100644
--- a/requirements/edx/github.txt
+++ b/requirements/edx/github.txt
@@ -71,7 +71,6 @@ git+https://github.com/edx/rfc6266.git@v0.0.5-edx#egg=rfc6266==0.0.5-edx
git+https://github.com/edx/lettuce.git@0.2.20.002#egg=lettuce==0.2.20.002
# Our libraries:
-git+https://github.com/edx/XBlock.git@xblock-0.4.13#egg=XBlock==0.4.13
-e git+https://github.com/edx/codejail.git@a320d43ce6b9c93b17636b2491f724d9e433be47#egg=codejail==0.0
-e git+https://github.com/edx/event-tracking.git@0.2.1#egg=event-tracking==0.2.1
-e git+https://github.com/edx/django-splash.git@v0.2#egg=django-splash==0.2