73 lines
2.6 KiB
Python
73 lines
2.6 KiB
Python
"""
|
|
View logic for handling course welcome messages.
|
|
"""
|
|
|
|
from django.core.urlresolvers import reverse
|
|
from django.http import HttpResponse, HttpResponseBadRequest
|
|
from django.template.loader import render_to_string
|
|
from django.views.decorators.csrf import ensure_csrf_cookie
|
|
from opaque_keys.edx.keys import CourseKey
|
|
from web_fragments.fragment import Fragment
|
|
|
|
from course_updates import get_ordered_updates
|
|
from courseware.courses import get_course_info_section_module, get_course_with_access
|
|
from openedx.core.djangoapps.plugin_api.views import EdxFragmentView
|
|
from openedx.core.djangoapps.user_api.course_tag.api import set_course_tag, get_course_tag
|
|
|
|
PREFERENCE_KEY = 'view-welcome-message'
|
|
|
|
|
|
class WelcomeMessageFragmentView(EdxFragmentView):
|
|
"""
|
|
A fragment that displays a course's welcome message.
|
|
"""
|
|
def render_to_fragment(self, request, course_id=None, **kwargs):
|
|
"""
|
|
Renders the welcome message fragment for the specified course.
|
|
|
|
Returns: A fragment, or None if there is no welcome message.
|
|
"""
|
|
course_key = CourseKey.from_string(course_id)
|
|
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
|
|
welcome_message_html = self.welcome_message_html(request, course)
|
|
if not welcome_message_html:
|
|
return None
|
|
|
|
dismiss_url = reverse(
|
|
'openedx.course_experience.dismiss_welcome_message', kwargs={'course_id': unicode(course_key)}
|
|
)
|
|
|
|
context = {
|
|
'dismiss_url': dismiss_url,
|
|
'welcome_message_html': welcome_message_html,
|
|
}
|
|
|
|
if get_course_tag(request.user, course_key, PREFERENCE_KEY) == 'False':
|
|
return None
|
|
else:
|
|
html = render_to_string('course_experience/welcome-message-fragment.html', context)
|
|
return Fragment(html)
|
|
|
|
@classmethod
|
|
def welcome_message_html(cls, request, course):
|
|
"""
|
|
Returns the course's welcome message or None if it doesn't have one.
|
|
"""
|
|
# Return the course update with the most recent publish date
|
|
ordered_updates = get_ordered_updates(request, course)
|
|
content = None
|
|
if ordered_updates:
|
|
content = ordered_updates[0]['content']
|
|
|
|
return content
|
|
|
|
|
|
@ensure_csrf_cookie
|
|
def dismiss_welcome_message(request, course_id):
|
|
"""
|
|
Given the course_id in the request, disable displaying the welcome message for the user.
|
|
"""
|
|
course_key = CourseKey.from_string(course_id)
|
|
set_course_tag(request.user, course_key, PREFERENCE_KEY, 'False')
|
|
return HttpResponse()
|