Files
edx-platform/openedx/core/djangoapps/certificates/api.py
Christie Rice cf3a6c16d6 fix: Stop showing course certificate buttons to beta testers (#28416)
Beta testers can’t earn course certificates, so they should not see a “Request Certificate” button or other info describing how they can earn a cert.

MICROBA-992
2021-08-10 09:06:14 -04:00

111 lines
3.7 KiB
Python

"""
The public API for certificates.
"""
import logging
from datetime import datetime
from pytz import UTC
from django.conf import settings
from lms.djangoapps.certificates import api as certs_api
from lms.djangoapps.certificates.data import CertificateStatuses
from lms.djangoapps.instructor import access
from openedx.core.djangoapps.certificates.config import waffle
from common.djangoapps.student.models import CourseEnrollment
from xmodule.data import CertificatesDisplayBehaviors
log = logging.getLogger(__name__)
SWITCHES = waffle.waffle()
def auto_certificate_generation_enabled():
return SWITCHES.is_enabled(waffle.AUTO_CERTIFICATE_GENERATION)
def _enabled_and_instructor_paced(course):
if auto_certificate_generation_enabled():
return not course.self_paced
return False
def can_show_certificate_message(course, student, course_grade, certificates_enabled_for_course):
"""
Returns True if a course certificate message can be shown
"""
auto_cert_gen_enabled = auto_certificate_generation_enabled()
has_active_enrollment = CourseEnrollment.is_enrolled(student, course.id)
certificates_are_viewable = certs_api.certificates_viewable_for_course(course)
is_beta_tester = access.is_beta_tester(student, course.id)
has_passed_or_is_allowlisted = _has_passed_or_is_allowlisted(course, student, course_grade)
return (
(auto_cert_gen_enabled or certificates_enabled_for_course) and
has_active_enrollment and
certificates_are_viewable and
has_passed_or_is_allowlisted and
(not is_beta_tester)
)
def can_show_certificate_available_date_field(course):
return _enabled_and_instructor_paced(course)
def _course_uses_available_date(course):
"""Returns if the course has an certificate_available_date set and that it should be used"""
if settings.FEATURES.get("ENABLE_V2_CERT_DISPLAY_SETTINGS"):
display_behavior_is_valid = course.certificates_display_behavior == CertificatesDisplayBehaviors.END_WITH_DATE
else:
display_behavior_is_valid = True
return (
can_show_certificate_available_date_field(course)
and course.certificate_available_date
and display_behavior_is_valid
)
def available_date_for_certificate(course, certificate, certificate_available_date=None):
"""
Returns the available date to use with a certificate
Arguments:
course (CourseOverview or course descriptor): The course we're checking
certificate (GeneratedCertificate): The certificate we're getting the date for
certificate_available_date (datetime): An optional date to override the from the course overview.
"""
if _course_uses_available_date(course):
return certificate_available_date or course.certificate_available_date
return certificate.modified_date
def display_date_for_certificate(course, certificate):
"""
Returns the display date that a certificate should display.
Arguments:
course (CourseOverview or course descriptor): The course we're getting the date for
Returns:
datetime.date
"""
if _course_uses_available_date(course) and course.certificate_available_date < datetime.now(UTC):
return course.certificate_available_date
return certificate.modified_date
def is_valid_pdf_certificate(cert_data):
return cert_data.cert_status == CertificateStatuses.downloadable and cert_data.download_url
def _has_passed_or_is_allowlisted(course, student, course_grade):
"""
Returns True if the student has passed this course run, or is on the allowlist for this course run
"""
is_allowlisted = certs_api.is_on_allowlist(student, course.id)
has_passed = course_grade and course_grade.passed
return has_passed or is_allowlisted