""" 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 badges.models import CourseEventBadgesConfiguration, BadgeClass from 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 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 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)