d1a775d3cd
* Use full LMS imports paths in LMS settings and urls modules * Use full LMS import paths in Studio settings and urls modules * Import from lms.djangoapps.badges instead of badges * Import from lms.djangoapps.branding instead of branding * Import from lms.djangoapps.bulk_email instead of bulk_email * Import from lms.djangoapps.bulk_enroll instead of bulk_enroll * Import from lms.djangoapps.ccx instead of ccx * Import from lms.djangoapps.course_api instead of course_api * Import from lms.djangoapps.course_blocks instead of course_blocks * Import from lms.djangoapps.course_wiki instead of course_wiki * Import from lms.djangoapps.courseware instead of courseware * Import from lms.djangoapps.dashboard instead of dashboard * Import from lms.djangoapps.discussion import discussion * Import from lms.djangoapps.email_marketing instead of email_marketing * Import from lms.djangoapps.experiments instead of experiments * Import from lms.djangoapps.gating instead of gating * Import from lms.djangoapps.grades instead of grades * Import from lms.djangoapps.instructor_analytics instead of instructor_analytics * Import form lms.djangoapps.lms_xblock instead of lms_xblock * Import from lms.djangoapps.lti_provider instead of lti_provider * Import from lms.djangoapps.mobile_api instead of mobile_api * Import from lms.djangoapps.rss_proxy instead of rss_proxy * Import from lms.djangoapps.static_template_view instead of static_template_view * Import from lms.djangoapps.survey instead of survey * Import from lms.djangoapps.verify_student instead of verify_student * Stop suppressing EdxPlatformDeprecatedImportWarnings
83 lines
2.9 KiB
Python
83 lines
2.9 KiB
Python
"""
|
|
Events which have to do with a user doing something with more than one course, such
|
|
as enrolling in a certain number, completing a certain number, or completing a specific set of courses.
|
|
"""
|
|
|
|
|
|
from lms.djangoapps.badges.models import BadgeClass, CourseEventBadgesConfiguration
|
|
from lms.djangoapps.badges.utils import requires_badges_enabled
|
|
|
|
|
|
def award_badge(config, count, user):
|
|
"""
|
|
Given one of the configurations for enrollments or completions, award
|
|
the appropriate badge if one is configured.
|
|
|
|
config is a dictionary with integer keys and course keys as values.
|
|
count is the key to retrieve from this dictionary.
|
|
user is the user to award the badge to.
|
|
|
|
Example config:
|
|
{3: 'slug_for_badge_for_three_enrollments', 5: 'slug_for_badge_with_five_enrollments'}
|
|
"""
|
|
slug = config.get(count)
|
|
if not slug:
|
|
return
|
|
badge_class = BadgeClass.get_badge_class(
|
|
slug=slug, issuing_component='openedx__course', create=False,
|
|
)
|
|
if not badge_class:
|
|
return
|
|
if not badge_class.get_for_user(user):
|
|
badge_class.award(user)
|
|
|
|
|
|
def award_enrollment_badge(user):
|
|
"""
|
|
Awards badges based on the number of courses a user is enrolled in.
|
|
"""
|
|
config = CourseEventBadgesConfiguration.current().enrolled_settings
|
|
enrollments = user.courseenrollment_set.filter(is_active=True).count()
|
|
award_badge(config, enrollments, user)
|
|
|
|
|
|
@requires_badges_enabled
|
|
def completion_check(user):
|
|
"""
|
|
Awards badges based upon the number of courses a user has 'completed'.
|
|
Courses are never truly complete, but they can be closed.
|
|
|
|
For this reason we use checks on certificates to find out if a user has
|
|
completed courses. This badge will not work if certificate generation isn't
|
|
enabled and run.
|
|
"""
|
|
from lms.djangoapps.certificates.models import CertificateStatuses
|
|
config = CourseEventBadgesConfiguration.current().completed_settings
|
|
certificates = user.generatedcertificate_set.filter(status__in=CertificateStatuses.PASSED_STATUSES).count()
|
|
award_badge(config, certificates, user)
|
|
|
|
|
|
@requires_badges_enabled
|
|
def course_group_check(user, course_key):
|
|
"""
|
|
Awards a badge if a user has completed every course in a defined set.
|
|
"""
|
|
from lms.djangoapps.certificates.models import CertificateStatuses
|
|
config = CourseEventBadgesConfiguration.current().course_group_settings
|
|
awards = []
|
|
for slug, keys in config.items():
|
|
if course_key in keys:
|
|
certs = user.generatedcertificate_set.filter(
|
|
status__in=CertificateStatuses.PASSED_STATUSES,
|
|
course_id__in=keys,
|
|
)
|
|
if len(certs) == len(keys):
|
|
awards.append(slug)
|
|
|
|
for slug in awards:
|
|
badge_class = BadgeClass.get_badge_class(
|
|
slug=slug, issuing_component='openedx__course', create=False,
|
|
)
|
|
if badge_class and not badge_class.get_for_user(user):
|
|
badge_class.award(user)
|