106 lines
3.8 KiB
Python
106 lines
3.8 KiB
Python
""" Events for notification app. """
|
|
|
|
from eventtracking import tracker
|
|
from common.djangoapps.track import contexts
|
|
|
|
|
|
NOTIFICATION_PREFERENCES_VIEWED = 'edx.notifications.preferences.viewed'
|
|
NOTIFICATION_GENERATED = 'edx.notifications.generated'
|
|
NOTIFICATION_READ = 'edx.notifications.read'
|
|
NOTIFICATION_PREFERENCES_UPDATED = 'edx.notifications.preferences.updated'
|
|
|
|
|
|
def get_user_forums_roles(user, course_id):
|
|
"""
|
|
Get the user's roles in the course forums.
|
|
"""
|
|
if course_id:
|
|
return list(user.roles.filter(course_id=course_id).values_list('name', flat=True))
|
|
return []
|
|
|
|
|
|
def get_user_course_roles(user, course_id):
|
|
"""
|
|
Get the user's roles in the course.
|
|
"""
|
|
if course_id:
|
|
return list(user.courseaccessrole_set.filter(course_id=course_id).values_list('role', flat=True))
|
|
return []
|
|
|
|
|
|
def notification_event_context(user, course_id, notification):
|
|
return {
|
|
'user_id': str(user.id),
|
|
'course_id': str(course_id),
|
|
'notification_type': notification.notification_type,
|
|
'notification_app': notification.app_name,
|
|
'notification_metadata': {
|
|
'notification_id': notification.id,
|
|
'notification_content': notification.content,
|
|
},
|
|
'user_forum_roles': get_user_forums_roles(user, course_id),
|
|
'user_course_roles': get_user_course_roles(user, course_id),
|
|
}
|
|
|
|
|
|
def notification_preferences_viewed_event(request, course_id):
|
|
"""
|
|
Emit an event when a user views their notification preferences.
|
|
"""
|
|
context = contexts.course_context_from_course_id(course_id)
|
|
with tracker.get_tracker().context(NOTIFICATION_PREFERENCES_VIEWED, context):
|
|
tracker.emit(
|
|
NOTIFICATION_PREFERENCES_VIEWED,
|
|
{
|
|
'user_id': str(request.user.id),
|
|
'course_id': str(course_id),
|
|
'user_forum_roles': get_user_forums_roles(request.user, course_id),
|
|
'user_course_roles': get_user_course_roles(request.user, course_id),
|
|
}
|
|
)
|
|
|
|
|
|
def notification_generated_event(user, notification):
|
|
"""
|
|
Emit an event when a notification is generated.
|
|
"""
|
|
context = contexts.course_context_from_course_id(notification.course_id)
|
|
with tracker.get_tracker().context(NOTIFICATION_GENERATED, context):
|
|
tracker.emit(
|
|
NOTIFICATION_GENERATED,
|
|
notification_event_context(user, notification.course_id, notification)
|
|
)
|
|
|
|
|
|
def notification_read_event(user, notification):
|
|
"""
|
|
Emit an event when a notification is read.
|
|
"""
|
|
context = contexts.course_context_from_course_id(notification.course_id)
|
|
with tracker.get_tracker().context(NOTIFICATION_READ, context):
|
|
tracker.emit(
|
|
NOTIFICATION_READ,
|
|
notification_event_context(user, notification.course_id, notification)
|
|
)
|
|
|
|
|
|
def notification_preference_update_event(user, course_id, updated_preference):
|
|
"""
|
|
Emit an event when a notification preference is updated.
|
|
"""
|
|
context = contexts.course_context_from_course_id(course_id)
|
|
with tracker.get_tracker().context(NOTIFICATION_PREFERENCES_UPDATED, context):
|
|
tracker.emit(
|
|
NOTIFICATION_PREFERENCES_UPDATED,
|
|
{
|
|
'user_id': str(user.id),
|
|
'course_id': str(course_id),
|
|
'user_forum_roles': get_user_forums_roles(user, course_id),
|
|
'user_course_roles': get_user_course_roles(user, course_id),
|
|
'notification_app': updated_preference.get('notification_app', ''),
|
|
'notification_type': updated_preference.get('notification_type', ''),
|
|
'notification_channel': updated_preference.get('notification_channel', ''),
|
|
'value': updated_preference.get('value', ''),
|
|
}
|
|
)
|