Files
edx-platform/openedx/core/djangoapps/notifications/admin.py

113 lines
3.9 KiB
Python

"""
Django Admin for Notifications
"""
from django.contrib import admin
from django.utils.translation import gettext_lazy as _
from .base_notification import COURSE_NOTIFICATION_APPS, COURSE_NOTIFICATION_TYPES
from .models import CourseNotificationPreference, Notification
class NotificationAppNameListFilter(admin.SimpleListFilter):
"""
Shows list filter in django admin of notification apps
"""
title = _("Notification App")
parameter_name = "app_name"
def lookups(self, request, model_admin):
lookup_list = [
(app_name, app_name)
for app_name in COURSE_NOTIFICATION_APPS.keys()
]
return lookup_list
def queryset(self, request, queryset):
app_name = self.value()
if app_name not in COURSE_NOTIFICATION_APPS.keys():
return queryset
return queryset.filter(app_name=app_name)
class NotificationTypeListFilter(admin.SimpleListFilter):
"""
Shows list filter in django admin of notification types
"""
title = _("Notification Type")
parameter_name = "notification_type"
def lookups(self, request, model_admin):
lookup_list = [
(notification_type, notification_type)
for notification_type in COURSE_NOTIFICATION_TYPES.keys()
]
return lookup_list
def queryset(self, request, queryset):
notification_type = self.value()
if notification_type not in COURSE_NOTIFICATION_TYPES.keys():
return queryset
return queryset.filter(notification_type=notification_type)
class NotificationAdmin(admin.ModelAdmin):
"""
Admin for Notifications
"""
raw_id_fields = ('user',)
search_fields = ('course_id', 'app_name', 'notification_type', 'user__username')
list_filter = (NotificationAppNameListFilter, NotificationTypeListFilter)
class CourseNotificationPreferenceAdmin(admin.ModelAdmin):
"""
Admin for Course Notification Preferences
"""
model = CourseNotificationPreference
raw_id_fields = ('user',)
list_display = ('get_username', 'course_id')
search_fields = ('course_id', 'user__username')
search_help_text = _('Search by username, course_id. '
'Specify fields with username: or course_id: prefixes. '
'If no prefix is specified, search will be done on username. \n'
'Examples: \n'
' - testuser (default username search) \n'
' - username:testuser (username keyword search) \n'
' - course_id:course-v1:edX+DemoX+Demo_Course (course_id keyword search) \n'
' - username:testuser, course_id:course-v1:edX+DemoX+Demo_Course (combined keyword search) \n'
)
@admin.display(description='Username', ordering='user__username')
def get_username(self, obj):
return obj.user.username
def get_search_results(self, request, queryset, search_term):
"""
Custom search for CourseNotificationPreference model
"""
if search_term:
criteria = search_term.split(',')
for criterion in criteria:
criterion = criterion.strip()
if criterion.startswith('username:'):
queryset = queryset.filter(user__username=criterion.split(':')[1])
elif criterion.startswith('course_id:'):
criteria = criterion.split(':')
course_id = ':'.join(criteria[1:]).strip()
queryset = queryset.filter(course_id=course_id)
else:
queryset = queryset.filter(user__username=search_term)
else:
queryset = queryset.all()
return queryset, True
admin.site.register(Notification, NotificationAdmin)
admin.site.register(CourseNotificationPreference, CourseNotificationPreferenceAdmin)