32bbb0e71a
This commit pulls in changes from #4487 that implements keyword substitution for bulk emails. With these changes, an instructor can include keywords in their bulk emails which will be automatically substituted with the corresponding value for the recepient of the email. Keywords are of the form %%keyword%%, and the keywords implemented in this commit include: %%USER_ID%% => anonymous_user_id %%USER_FULLNAME%% => user profile name %%COURSE_DISPLAY_NAME%% => display name of the course %%COURSE_END_DATE%% => end date of the course Client-side validations have also been implemented to ensure that only emails with well-formed keywords can be sent. The architecture is designed such that adding in new keywords in the future would be relatively straight-forward.
83 lines
2.6 KiB
Python
83 lines
2.6 KiB
Python
"""
|
|
keyword_substitution.py
|
|
|
|
Contains utility functions to help substitute keywords in a text body with
|
|
the appropriate user / course data.
|
|
|
|
Supported:
|
|
LMS:
|
|
- %%USER_ID%% => anonymous user id
|
|
- %%USER_FULLNAME%% => User's full name
|
|
- %%COURSE_DISPLAY_NAME%% => display name of the course
|
|
- %%COURSE_END_DATE%% => end date of the course
|
|
|
|
Usage:
|
|
KEYWORD_FUNCTION_MAP must be supplied in startup.py, so that it lives
|
|
above other modules in the dependency tree and acts like a global var.
|
|
Then we can call substitute_keywords_with_data where substitution is
|
|
needed. Currently called in:
|
|
- LMS: Announcements + Bulk emails
|
|
- CMS: Not called
|
|
"""
|
|
|
|
from django.contrib.auth.models import User
|
|
from xmodule.modulestore.django import modulestore
|
|
|
|
KEYWORD_FUNCTION_MAP = {}
|
|
|
|
|
|
def keyword_function_map_is_empty():
|
|
"""
|
|
Checks if the keyword function map has been filled
|
|
"""
|
|
return not bool(KEYWORD_FUNCTION_MAP)
|
|
|
|
|
|
def add_keyword_function_map(mapping):
|
|
"""
|
|
Attaches the given keyword-function mapping to the existing one
|
|
"""
|
|
KEYWORD_FUNCTION_MAP.update(mapping)
|
|
|
|
|
|
def substitute_keywords(string, user=None, course=None):
|
|
"""
|
|
Replaces all %%-encoded words using KEYWORD_FUNCTION_MAP mapping functions
|
|
|
|
Iterates through all keywords that must be substituted and replaces
|
|
them by calling the corresponding functions stored in KEYWORD_FUNCTION_MAP.
|
|
|
|
Functions stored in KEYWORD_FUNCTION_MAP must return a replacement string.
|
|
Also, functions imported from other modules must be wrapped in a
|
|
new function if they don't take in user_id and course_id. This simplifies
|
|
the loop below, and reduces the need for piling up if elif else statements
|
|
when the keyword pool grows.
|
|
"""
|
|
if user is None or course is None:
|
|
# Cannot proceed without course and user information
|
|
return string
|
|
|
|
for key, func in KEYWORD_FUNCTION_MAP.iteritems():
|
|
if key in string:
|
|
substitutor = func(user, course)
|
|
string = string.replace(key, substitutor)
|
|
|
|
return string
|
|
|
|
|
|
def substitute_keywords_with_data(string, user_id=None, course_id=None):
|
|
"""
|
|
Given user and course ids, replaces all %%-encoded words in the given string
|
|
"""
|
|
|
|
# Do not proceed without parameters: Compatibility check with existing tests
|
|
# that do not supply these parameters
|
|
if user_id is None or course_id is None:
|
|
return string
|
|
|
|
# Grab user objects
|
|
user = User.objects.get(id=user_id)
|
|
course = modulestore().get_course(course_id, depth=0)
|
|
|
|
return substitute_keywords(string, user, course)
|