Previously, dismissing one course update would disable all future updates. But that feels a bit limiting. Instead, these are the new rules: - If the newest update has not been dismissed yet, it gets displayed. - If the newest update has been dismissed, we display nothing. - Editing the newest update will cause it to be displayed again. - New updates get displayed, even if previous updates were dismissed. This commit includes a light refactoring and addition of some utility methods to help manage the above. It also notes that the learning MFE does not use the "latest_update" waffle option, which controls the labeling of the update message.
51 lines
1.7 KiB
Python
51 lines
1.7 KiB
Python
"""
|
|
View logic for handling latest course updates.
|
|
|
|
Although the welcome message fragment also displays the latest update,
|
|
this fragment dismisses the message for a limited time so new updates
|
|
will continue to appear, where the welcome message gets permanently
|
|
dismissed.
|
|
"""
|
|
|
|
|
|
from django.template.loader import render_to_string
|
|
from opaque_keys.edx.keys import CourseKey
|
|
from web_fragments.fragment import Fragment
|
|
|
|
from lms.djangoapps.courseware.courses import get_course_with_access
|
|
from openedx.core.djangoapps.plugin_api.views import EdxFragmentView
|
|
from openedx.features.course_experience.course_updates import get_current_update_for_user
|
|
|
|
|
|
class LatestUpdateFragmentView(EdxFragmentView):
|
|
"""
|
|
A fragment that displays the latest course update.
|
|
"""
|
|
|
|
def render_to_fragment(self, request, course_id=None, **kwargs):
|
|
"""
|
|
Renders the latest update message fragment for the specified course.
|
|
|
|
Returns: A fragment, or None if there is no latest update message.
|
|
"""
|
|
course_key = CourseKey.from_string(course_id)
|
|
course = get_course_with_access(request.user, 'load', course_key, check_if_enrolled=True)
|
|
|
|
update_html = self.latest_update_html(request, course)
|
|
if not update_html:
|
|
return None
|
|
|
|
context = {
|
|
'update_html': update_html,
|
|
}
|
|
html = render_to_string('course_experience/latest-update-fragment.html', context)
|
|
return Fragment(html)
|
|
|
|
@classmethod
|
|
def latest_update_html(cls, request, course):
|
|
"""
|
|
Returns the course's latest update message or None if it doesn't have one.
|
|
"""
|
|
# Return the course update with the most recent publish date
|
|
return get_current_update_for_user(request, course)
|