Newer
Older
# -*- coding: utf-8 -*-
__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"
__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
Dong Zhuang
committed
from django.utils.translation import (
from course.models import (
Participation, ParticipationPermission,
ParticipationRole, ParticipationRolePermission,
ParticipationPreapproval,
FlowSession, FlowPageData,
FlowPageVisit, FlowPageVisitGrade,
GradingOpportunity, GradeChange, InstantMessage,
Exam, ExamTicket)
from django import forms
from relate.utils import string_concat
from course.enrollment import (approve_enrollment, deny_enrollment)
Andreas Klöckner
committed
from course.constants import (
participation_permission as pperm,
exam_ticket_states
)
from typing import Any, Text, Tuple # noqa
def _filter_courses_for_user(queryset, user):
if user.is_superuser:
return queryset
participations__roles__permissions__permission=pperm.use_admin_interface)
return z
def _filter_course_linked_obj_for_user(queryset, user):
if user.is_superuser:
return queryset
return queryset.filter(
course__participations__user=user,
course__participations__roles__permissions__permission # noqa
=pperm.use_admin_interface
)
def _filter_participation_linked_obj_for_user(queryset, user):
if user.is_superuser:
return queryset
return queryset.filter(
participation__course__participations__user=user,
participation__course__participations__roles__permissions__permission # noqa
Andreas Klöckner
committed
=pperm.use_admin_interface)
# {{{ list filter helper
def _filter_related_only(filter_arg):
# type: (Text) -> Tuple[Text, Any]
return (filter_arg, admin.RelatedOnlyFieldListFilter)
# }}}
class UnsafePasswordInput(forms.TextInput):
# This sends passwords back to the user--not ideal, but OK for the XMPP
# password.
input_type = "password"
class CourseAdminForm(forms.ModelForm):
class Meta:
model = Course
widgets = {
"course_xmpp_password": UnsafePasswordInput
}
exclude = ()
list_display = (
"identifier",
"number",
"name",
"time_period",
"start_date",
"end_date",
"hidden",
"listed",
"accepts_enrollment")
list_editable = (
"number",
"name",
"time_period",
"start_date",
"end_date",
"hidden",
"listed",
"accepts_enrollment")
list_filter = (
"number",
"time_period",
"hidden",
"listed",
"accepts_enrollment")
date_hierarchy = "start_date"
search_fields = (
"identifier",
"number",
"name",
"time_period")
form = CourseAdminForm
# {{{ permissions
def has_add_permission(self, request):
# These are created only through the course creation form.
return False
def get_queryset(self, request):
qs = super(CourseAdmin, self).get_queryset(request)
return _filter_courses_for_user(qs, request.user)
list_display = (
"course",
"kind",
"ordinal",
"time",
"end_time",
"shown_in_calendar")
list_filter = (_filter_related_only("course"), "kind", "shown_in_calendar")
date_hierarchy = "time"
search_fields = (
"course__identifier",
"kind",
)
def __unicode__(self): # pragma: no cover # not used
return u"%s%s in %s" % (
self.kind,
" (%s)" % str(self.ordinal) if self.ordinal is not None else "",
self.course)
list_editable = ("ordinal", "time", "end_time", "shown_in_calendar")
# {{{ permissions
def get_queryset(self, request):
qs = super(EventAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(EventAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
# {{{ participation tags
class ParticipationTagAdmin(admin.ModelAdmin):
list_filter = (_filter_related_only("course"),)
# {{{ permissions
def get_queryset(self, request):
qs = super(ParticipationTagAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(ParticipationTagAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
admin.site.register(ParticipationTag, ParticipationTagAdmin)
# }}}
# {{{ participations
class ParticipationRolePermissionInline(admin.TabularInline):
model = ParticipationRolePermission
extra = 3
class ParticipationRoleAdmin(admin.ModelAdmin):
inlines = (ParticipationRolePermissionInline,)
list_filter = (_filter_related_only("course"), "identifier")
def get_queryset(self, request):
qs = super(ParticipationRoleAdmin, self).get_queryset(request)
if request.user.is_superuser:
return qs
return _filter_course_linked_obj_for_user(qs, request.user)
admin.site.register(ParticipationRole, ParticipationRoleAdmin)
class ParticipationPermissionInline(admin.TabularInline):
model = ParticipationPermission
extra = 3
class ParticipationForm(forms.ModelForm):
super(ParticipationForm, self).clean()
for tag in self.cleaned_data.get("tags", []):
if tag.course != self.cleaned_data.get("course"):
from django.core.exceptions import ValidationError
raise ValidationError(
{"tags": _("Tags must belong to same course as "
"participation.")})
for role in self.cleaned_data.get("roles", []):
if role.course != self.cleaned_data.get("course"):
from django.core.exceptions import ValidationError
raise ValidationError(
{"roles": _("Role must belong to same course as "
"participation.")})
form = ParticipationForm
return ", ".join(str(role.name) for role in obj.roles.all())
get_roles.short_description = _("Roles") # type: ignore
return ", ".join(str(tag.name) for tag in obj.tags.all())
get_tags.short_description = _("Tags") # type: ignore
# Fixme: This can be misleading when Non-superuser click on the
# link of a user who also attend other courses.
def get_user(self, obj):
from django.urls import reverse
from django.conf import settings
from django.utils.html import mark_safe
return mark_safe(string_concat(
"<a href='%(link)s'>", "%(user_fullname)s",
"link": reverse(
"admin:%s_change"
% settings.AUTH_USER_MODEL.replace(".", "_")
.lower(),
args=(obj.user.id,)),
"user_fullname": obj.user.get_full_name(
force_verbose_blank=True),
Andreas Klöckner
committed
get_user.short_description = pgettext("real name of a user", "Name") # type:ignore # noqa
get_user.admin_order_field = "user__last_name" # type: ignore
get_user.allow_tags = True # type: ignore
"get_user",
def get_list_filter(self, request):
if request is not None and request.user.is_superuser:
return ("course",
"roles__name",
"status",
"tags")
return (_filter_related_only("course"),
_filter_related_only("roles"),
"status",
_filter_related_only("tags"))
raw_id_fields = ("user",)
filter_horizontal = ("tags", "roles",)
search_fields = (
"course__identifier",
"user__username",
"user__first_name",
"user__last_name",
)
actions = [approve_enrollment, deny_enrollment]
inlines = (ParticipationPermissionInline,)
# {{{ permissions
def get_queryset(self, request):
qs = super(ParticipationAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
# Fixme: This seems not to be not reachable
if db_field.name == "tags":
kwargs["queryset"] = _filter_course_linked_obj_for_user(
ParticipationTag.objects, request.user)
return super(ParticipationAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
admin.site.register(Participation, ParticipationAdmin)
class ParticipationPreapprovalAdmin(admin.ModelAdmin):
return ", ".join(str(role.name) for role in obj.roles.all())
get_roles.short_description = _("Roles") # type: ignore
list_display = ("email", "institutional_id", "course", "get_roles",
list_filter = (_filter_related_only("course"), _filter_related_only("roles"))
"email", "institutional_id",
# {{{ permissions
def get_queryset(self, request):
qs = super(ParticipationPreapprovalAdmin, self).get_queryset(request)
if request.user.is_superuser:
return qs
return _filter_course_linked_obj_for_user(qs, request.user)
exclude = ("creator", "creation_time", "role")
def save_model(self, request, obj, form, change):
obj.creator = request.user
obj.save()
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(ParticipationPreapprovalAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
admin.site.register(ParticipationPreapproval, ParticipationPreapprovalAdmin)
class AuthenticationTokenAdmin(admin.ModelAdmin):
list_display = ("id", "participation", "restrict_to_participation_role",
"description", "valid_until", "revocation_time")
date_hierarchy = "creation_time"
search_fields = (
"id", "description", "participation__user__username"
)
admin.site.register(AuthenticationToken, AuthenticationTokenAdmin)
list_display = ("course", "flow_id", "start_time", "end_time", "cancelled")
list_filter = (_filter_related_only("course"),)
date_hierarchy = "start_time"
search_fields = (
"email",
)
admin.site.register(InstantFlowRequest, InstantFlowRequestAdmin)
class FlowPageDataInline(admin.TabularInline):
model = FlowPageData
extra = 0
class FlowSessionAdmin(admin.ModelAdmin):
Andreas Klöckner
committed
if obj.participation is None:
return None
Andreas Klöckner
committed
Andreas Klöckner
committed
get_participant.short_description = _("Participant") # type: ignore
get_participant.admin_order_field = "participation__user" # type: ignore
"participation__user__username",
"participation__user__first_name",
"participation__user__last_name",
"user__username",
"user__first_name",
"user__last_name",
)
list_display_links = (
"flow_id",
"get_participant",
)
date_hierarchy = "start_time"
list_filter = (
_filter_related_only("course"),
inlines = (FlowPageDataInline,)
Andreas Klöckner
committed
raw_id_fields = ("participation", "user")
# {{{ permissions
def has_add_permission(self, request):
# These are only created automatically.
def get_queryset(self, request):
qs = super(FlowSessionAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(FlowSessionAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
admin.site.register(FlowSession, FlowSessionAdmin)
# {{{ flow page visit
class FlowPageVisitGradeInline(admin.TabularInline):
model = FlowPageVisitGrade
extra = 0
class HasAnswerListFilter(admin.SimpleListFilter):
title = "has answer"
parameter_name = "has_answer"
def lookups(self, request, model_admin):
return (
("y", _("Yes")),
("n", _("No")),
)
def queryset(self, request, queryset):
if self.value() is None:
return queryset
return queryset.filter(answer__isnull=self.value() != "y")
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
class FlowIdListFilter(admin.SimpleListFilter):
"""
This is only necessary when flow_id is only accessible by FlowSession, which is
a ForeignKey in the model
"""
title = _("Flow ID")
parameter_name = "flow_id"
def lookups(self, request, model_admin):
qs = model_admin.get_queryset(request)
if not request.user.is_superuser:
qs = qs.filter(
flow_session__course__participations__user=request.user,
flow_session__course__participations__roles__permissions__permission # noqa
=pperm.use_admin_interface)
flow_ids = qs.values_list("flow_session__flow_id", flat=True).distinct()
return zip(flow_ids, flow_ids)
def queryset(self, request, queryset):
if self.value():
return queryset.filter(flow_session__flow_id=self.value())
else:
return queryset
class FlowPageVisitAdmin(admin.ModelAdmin):
def get_course(self, obj):
return obj.flow_session.course
Andreas Klöckner
committed
get_course.short_description = _("Course") # type: ignore
get_course.admin_order_field = "flow_session__course" # type: ignore
def get_flow_id(self, obj):
return obj.flow_session.flow_id
Andreas Klöckner
committed
get_flow_id.short_description = _("Flow ID") # type: ignore
get_flow_id.admin_order_field = "flow_session__flow_id" # type: ignore
def get_page_id(self, obj):
if obj.page_data.page_ordinal is None:
return string_concat("%s/%s (", _("not in use"), ")") % (
obj.page_data.group_id,
obj.page_data.page_id)
else:
return "%s/%s (%s)" % (
obj.page_data.group_id,
obj.page_data.page_id,
Andreas Klöckner
committed
get_page_id.short_description = _("Page ID") # type: ignore
get_page_id.admin_order_field = "page_data__page_id" # type: ignore
def get_participant(self, obj):
if obj.flow_session.participation:
return obj.flow_session.participation.user
else:
return string_concat("(", _("anonymous"), ")")
Andreas Klöckner
committed
get_participant.short_description = _("Owner") # type: ignore
get_participant.admin_order_field = "flow_session__participation" # type: ignore
def get_answer_is_null(self, obj):
return obj.answer is not None
Andreas Klöckner
committed
get_answer_is_null.short_description = _("Has answer") # type: ignore
get_answer_is_null.boolean = True # type: ignore
def get_flow_session_id(self, obj):
return obj.flow_session.id
Andreas Klöckner
committed
get_flow_session_id.short_description = _("Flow Session ID") # type: ignore
get_flow_session_id.admin_order_field = "flow_session__id" # type: ignore
list_filter = (
"is_submitted_answer",
"is_synthetic",
_filter_related_only("flow_session__participation__course"),
FlowIdListFilter,
)
date_hierarchy = "visit_time"
list_display = (
"get_course",
"get_flow_id",
"get_page_id",
"get_participant",
"visit_time",
"is_submitted_answer",
"user",
"impersonated_by",
)
list_display_links = (
)
search_fields = (
"flow_session__flow_id",
"page_data__group_id",
"page_data__page_id",
"flow_session__participation__user__username",
"flow_session__participation__user__first_name",
"flow_session__participation__user__last_name",
)
raw_id_fields = ("flow_session", "page_data")
inlines = (FlowPageVisitGradeInline,)
# {{{ permissions
def has_add_permission(self, request):
# These are created only automatically.
return False
def get_queryset(self, request):
qs = super(FlowPageVisitAdmin, self).get_queryset(request)
if request.user.is_superuser:
return qs
return qs.filter(
flow_session__course__participations__user=request.user,
flow_session__course__participations__roles__permissions__permission # noqa
Andreas Klöckner
committed
=pperm.use_admin_interface)
admin.site.register(FlowPageVisit, FlowPageVisitAdmin)
# }}}
class FlowRuleExceptionAdmin(admin.ModelAdmin):
def get_course(self, obj):
return obj.participation.course
Andreas Klöckner
committed
get_course.short_description = _("Course") # type: ignore
get_course.admin_order_field = "participation__course" # type: ignore
def get_participant(self, obj):
return obj.participation.user
Andreas Klöckner
committed
get_participant.short_description = _("Participant") # type: ignore
get_participant.admin_order_field = "participation__user" # type: ignore
search_fields = (
"flow_id",
"participation__user__username",
"participation__user__first_name",
"participation__user__last_name",
list_display = (
"get_participant",
"get_course",
"flow_id",
"expiration",
"creation_time",
)
list_display_links = (
"get_participant",
"flow_id",
)
list_filter = (
_filter_related_only("participation__course"),
)
date_hierarchy = "creation_time"
raw_id_fields = ("participation",)
def has_add_permission(self, request):
# These are only created automatically.
def get_queryset(self, request):
qs = super(FlowRuleExceptionAdmin, self).get_queryset(request)
return _filter_participation_linked_obj_for_user(qs, request.user)
exclude = ("creator", "creation_time")
def save_model(self, request, obj, form, change): # pragma: no cover
# This won't work since it's not allowed to add
obj.creator = request.user
obj.save()
# }}}
admin.site.register(FlowRuleException, FlowRuleExceptionAdmin)
# }}}
# {{{ grading
class GradingOpportunityAdmin(admin.ModelAdmin):
Andreas Klöckner
committed
"shown_in_participant_grade_book",
_filter_related_only("course"),
Andreas Klöckner
committed
"shown_in_participant_grade_book",
list_editable = (
"shown_in_grade_book",
Andreas Klöckner
committed
"shown_in_participant_grade_book",
# {{{ permissions
exclude = ("creation_time",)
def get_queryset(self, request):
qs = super(GradingOpportunityAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(GradingOpportunityAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
admin.site.register(GradingOpportunity, GradingOpportunityAdmin)
class GradeChangeAdmin(admin.ModelAdmin):
def get_course(self, obj):
return obj.participation.course
Andreas Klöckner
committed
get_course.short_description = _("Course") # type: ignore
get_course.admin_order_field = "participation__course" # type: ignore
def get_opportunity(self, obj):
return obj.opportunity.name
Andreas Klöckner
committed
get_opportunity.short_description = _("Opportunity") # type: ignore
get_opportunity.admin_order_field = "opportunity" # type: ignore
def get_participant(self, obj):
return obj.participation.user
Andreas Klöckner
committed
get_participant.short_description = _("Participant") # type: ignore
get_participant.admin_order_field = "participation__user" # type: ignore
if obj.points is None or obj.max_points is None:
return None
else:
return round(100*obj.points/obj.max_points)
Andreas Klöckner
committed
get_percentage.short_description = "%" # type: ignore
list_display = (
"get_opportunity",
"get_participant",
"get_course",
"state",
"points",
"grade_time",
)
list_display_links = (
"get_opportunity",
"get_participant",
)
date_hierarchy = "grade_time"
search_fields = (
"opportunity__name",
"opportunity__identifier",
"participation__user__username",
"participation__user__first_name",
"participation__user__last_name",
_filter_related_only("opportunity__course"),
_filter_related_only("opportunity"),
raw_id_fields = ("participation", "flow_session", "opportunity")
# {{{ permission
def get_queryset(self, request):
qs = super(GradeChangeAdmin, self).get_queryset(request)
return _filter_participation_linked_obj_for_user(qs, request.user)
exclude = ("creator", "grade_time")
def save_model(self, request, obj, form, change):
obj.creator = request.user
obj.save()
# }}}
admin.site.register(GradeChange, GradeChangeAdmin)
# }}}
# {{{ instant message
class InstantMessageAdmin(admin.ModelAdmin):
def get_course(self, obj):
return obj.participation.course
Andreas Klöckner
committed
get_course.short_description = _("Course") # type: ignore
get_course.admin_order_field = "participation__course" # type: ignore
def get_participant(self, obj):
return obj.participation.user
Andreas Klöckner
committed
get_participant.short_description = _("Participant") # type: ignore
get_participant.admin_order_field = "participation__user" # type: ignore
list_filter = (_filter_related_only("participation__course"),)
list_display = (
"get_course",
"get_participant",
"time",
"text",
)
date_hierarchy = "time"
search_fields = (
"text",
"participation__user__username",
"participation__user__first_name",
"participation__user__last_name",
)
raw_id_fields = ("participation",)
# {{{ permissions
def has_add_permission(self, request):
# These are created only automatically.
return False
def get_queryset(self, request):
qs = super(InstantMessageAdmin, self).get_queryset(request)
return _filter_participation_linked_obj_for_user(qs, request.user)
admin.site.register(InstantMessage, InstantMessageAdmin)
# }}}
# {{{ exam tickets
class ExamAdmin(admin.ModelAdmin):
list_filter = (
_filter_related_only("course"),
)
search_fields = (
"flow_id",
)
# {{{ permissions
def get_queryset(self, request):
qs = super(ExamAdmin, self).get_queryset(request)
return _filter_course_linked_obj_for_user(qs, request.user)
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "course":
kwargs["queryset"] = _filter_courses_for_user(
Course.objects, request.user)
return super(ExamAdmin, self).formfield_for_foreignkey(
db_field, request, **kwargs)
# }}}
admin.site.register(Exam, ExamAdmin)
class ExamTicketAdmin(admin.ModelAdmin):
def get_course(self, obj):
return obj.participation.course
get_course.short_description = _("Course") # type: ignore
Andreas Klöckner
committed
get_course.admin_order_field = "participation__course" # type: ignore
_filter_related_only("participation__course"),