00653433a5
Scheduled emails show "unsubscribe" link if waffle switch `schedules.course_update_show_unsubscribe` is enabled, and settings.ACE_ENABLED_POLICIES respects `bulk_email_optout`. API endpoint allows GET/POST requests, which: * GET asks for confirmation of opt-out * POST accepts "unsubscribe" or "cancel", where "unsubscribe" creates the Optout entry, and "cancel" does nothing. Fixes flaky tests: * The resolvers handle users in "bins", which are groups that depend on the user ID. * The test user ID varies depending on the test order. * This change ensures that the bin requested matches the user for the test.
73 lines
2.1 KiB
Python
73 lines
2.1 KiB
Python
"""
|
|
Views to support bulk email functionalities like opt-out.
|
|
"""
|
|
|
|
from __future__ import division
|
|
|
|
import logging
|
|
|
|
from six import text_type
|
|
|
|
from django.contrib.auth.models import User
|
|
from django.http import Http404
|
|
|
|
from bulk_email.models import Optout
|
|
from courseware.courses import get_course_by_id
|
|
from edxmako.shortcuts import render_to_response
|
|
from lms.djangoapps.discussion.notification_prefs.views import (
|
|
UsernameCipher,
|
|
UsernameDecryptionException,
|
|
)
|
|
|
|
from opaque_keys import InvalidKeyError
|
|
from opaque_keys.edx.keys import CourseKey
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
def opt_out_email_updates(request, token, course_id):
|
|
"""
|
|
A view that let users opt out of any email updates.
|
|
|
|
This meant is meant to be the target of an opt-out link or button.
|
|
The `token` parameter must decrypt to a valid username.
|
|
The `course_id` is the string course key of any course.
|
|
|
|
Raises a 404 if there are any errors parsing the input.
|
|
"""
|
|
try:
|
|
username = UsernameCipher().decrypt(token.encode())
|
|
user = User.objects.get(username=username)
|
|
course_key = CourseKey.from_string(course_id)
|
|
course = get_course_by_id(course_key, depth=0)
|
|
except UnicodeDecodeError:
|
|
raise Http404("base64url")
|
|
except UsernameDecryptionException as exn:
|
|
raise Http404(text_type(exn))
|
|
except User.DoesNotExist:
|
|
raise Http404("username")
|
|
except InvalidKeyError:
|
|
raise Http404("course")
|
|
|
|
context = {
|
|
'course': course,
|
|
'cancelled': False,
|
|
'confirmed': False,
|
|
}
|
|
|
|
if request.method == 'POST':
|
|
if request.POST.get('submit') == 'confirm':
|
|
Optout.objects.get_or_create(user=user, course_id=course.id)
|
|
log.info(
|
|
u"User %s (%s) opted out of receiving emails from course %s",
|
|
user.username,
|
|
user.email,
|
|
course_id,
|
|
)
|
|
context['confirmed'] = True
|
|
else:
|
|
context['cancelled'] = True
|
|
|
|
return render_to_response('bulk_email/unsubscribe.html', context)
|